@setfilename ../../info/org
@settitle The Org Manual
-@set VERSION 7.4
-@set DATE December 2010
+@set VERSION 7.8.03
+@set DATE January 2012
@c Use proper quote and backtick for code sections in PDF output
@c Cf. Texinfo manual 14.2
@c Below we define the following macros for Org key tables:
-@c orgkey{key} A key item
+@c orgkey{key} A key item
@c orgcmd{key,cmd} Key with command name
-@c xorgcmd{key,cmmand} Key with command name as @itemx
+@c xorgcmd{key,cmd} 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"
@copying
This manual is for Org version @value{VERSION}.
-Copyright @copyright{} 2004-2011 Free Software Foundation, Inc.
+Copyright @copyright{} 2004-2012 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
@end quotation
@end copying
-@dircategory Emacs editing modes
+@dircategory Emacs
@direntry
* Org Mode: (org). Outline-based notes management and organizer
@end direntry
@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
+with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, Thomas Dye and Jambunathan K.
@c The following two commands start the copyright page.
@page
* 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
-* Advanced features:: Field names, parameters and automatic recalc
+* Advanced features:: Field and column names, parameters and automatic recalc
Hyperlinks
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
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
* 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
* 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
+* Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
Structural markup elements
* Special symbols:: Greek letters and other symbols
* Subscripts and superscripts:: Simple syntax for raising/lowering text
-* LaTeX fragments:: Complex formulas made easy
-* Previewing LaTeX fragments:: What will this snippet look like?
+* @LaTeX{} fragments:: Complex formulas made easy
+* Previewing @LaTeX{} fragments:: What will this snippet look like?
* CDLaTeX mode:: Speed up entering of formulas
Exporting
* The export dispatcher:: How to access exporter commands
* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
* HTML export:: Exporting to HTML
-* LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
+* @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
* DocBook export:: Exporting to DocBook
+* OpenDocument Text export:: Exporting to OpenDocument Text
* TaskJuggler export:: Exporting to TaskJuggler
* Freemind export:: Exporting to Freemind mind maps
* XOXO export:: Exporting to XOXO
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
@LaTeX{} and PDF export
-* LaTeX/PDF export commands:: Which key invokes which commands
+* @LaTeX{}/PDF export commands::
* 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
+* 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 Text export
+
+* Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on
+* @acronym{ODT} export commands:: How to invoke @acronym{ODT} export
+* Applying custom styles:: How to apply custom styles to the output
+* Links in @acronym{ODT} export:: How links will be interpreted and formatted
+* Tables in @acronym{ODT} export:: How Tables are exported
+* Images in @acronym{ODT} export:: How to insert images
+* Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted
+* Literal examples in @acronym{ODT} export:: How source and example blocks are formatted
+* Advanced topics in @acronym{ODT} export:: Read this if you are a power user
+
+Math formatting in @acronym{ODT} export
+
+* Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
+* Working with MathML or OpenDocument formula files:: How to embed equations in native format
+
+Advanced topics in @acronym{ODT} export
+
+* Exporting and converting to other formats:: How to produce @samp{pdf} and other formats
+* Working with OpenDocument style files:: Explore the internals
+* Creating one-off styles:: How to produce custom highlighting etc
+* Customizing tables in @acronym{ODT} export:: How to define and use Table templates
+* Validating OpenDocument XML:: How to debug corrupt OpenDocument files
+
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?
* Sitemap:: Generating a list of all pages
* Generating an index:: An index that reaches across pages
* 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
+* 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
+* 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
* 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
+* 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
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
* 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
Tables and lists in arbitrary syntax
* Radio tables:: Sending and receiving radio tables
-* A LaTeX example:: Step by step, almost a tutorial
+* A @LaTeX{} example:: Step by step, almost a tutorial
* Translator functions:: Copy and modify
* Radio lists:: Doing the same for lists
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 tangling.
+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
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
@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
Emacs can autoload functions that are located in files not immediately loaded
-when Org-mode starts.
+when Org mode starts.
@lisp
(require 'org-install)
@end lisp
@cindex global key bindings
@cindex key bindings, global
-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}.
that you only need to add your description. If you re not sending the Email
from within Emacs, please copy and paste the content into your Email program.
+Sometimes you might face a problem due to an error in your Emacs or Org mode
+setup. Before reporting a bug, it is very helpful to start Emacs with minimal
+customizations and reproduce the problem. Doing so often helps you determine
+if the problem is with your customization or with Org mode itself. You can
+start a typical minimal session with a command like the example below.
+
+@example
+$ emacs -Q -l /path/to/minimal-org.el
+@end example
+
+However if you are using Org mode as distributed with Emacs, a minimal setup
+is not necessary. In that case it is sufficient to start Emacs as @code{emacs
+-Q}. The @code{minimal-org.el} setup file can have contents as shown below.
+
+@example
+;;; Minimal setup to load latest `org-mode'
+
+;; activate debugging
+(setq debug-on-error t
+ debug-on-signal nil
+ debug-on-quit nil)
+
+;; add latest org-mode to load path
+(add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
+(add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp"))
+
+;; activate org
+(require 'org-install)
+@end example
+
If an error occurs, a backtrace can be very useful (see below on how to
create one). Often a small example file helps, along with clear information
about:
@enumerate
@item
-Reload uncompiled versions of all Org-mode Lisp files. The backtrace
+Reload uncompiled versions of all Org mode Lisp files. The backtrace
contains much more information if it is produced with uncompiled code.
To do this, use
@example
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. With double prefix arg, also show the entire
-subtree of the parent.
+level, all sibling headings. With a double prefix argument, 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}
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:
@code{all}.
@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
+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
@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.
+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
@orgcmd{M-S-@key{down},org-move-subtree-down}
Move subtree down (swap with next subtree of same level).
@orgcmd{C-c C-x C-w,org-cut-subtree}
-Kill subtree, i.e. remove it from buffer but save in kill ring.
+Kill subtree, i.e.@: remove it from buffer but save in kill ring.
With a numeric prefix argument N, kill N sequential subtrees.
@orgcmd{C-c C-x M-w,org-copy-subtree}
Copy subtree to kill ring. With a numeric prefix argument N, copy the N
entries will also be removed.
@orgcmd{C-x n s,org-narrow-to-subtree}
Narrow buffer to current subtree.
+@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.
@orgcmd{C-c *,org-toggle-heading}
@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 @asis
This prompts for an extra key to select a sparse-tree creating command.
@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
@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@footnote{You can filter out any of them by configuring
@code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
-@samp{1)}. 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.}. Those constructs
-can be used in any item of the list in order to enforce a particular
-numbering.
+@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
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.
+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
-before the next line that is indented like the bullet/number or less, or it
-ends before two blank lines@footnote{See also
-@code{org-empty-line-terminates-plain-lists}.}. In both cases, all levels of
-the list are closed@footnote{So you cannot have a sublist, some text and then
-another sublist while still in the same top-level list item. This used to be
-possible, but it was only supported in the HTML exporter and difficult to
-manage with automatic indentation.}. For finer control, you can end lists
-with any pattern set in @code{org-list-end-regexp}. Here is an example:
+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
- He makes a really funny face when it happens.
- 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:
- @b{Elijah Wood} :: He plays Frodo
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 considered as 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}.
+@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
@table @asis
@orgcmd{@key{TAB},org-cycle}
+@cindex cycling, in plain lists
@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}. 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.
+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. In a new item with no text yet, the
+first @key{TAB} demotes the item to 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.
@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 @emph{before
-an item's body}, 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.
-
-As a new item cannot be inserted in a structural construct (like an example
-or source code block) within a list, Org will instead insert it right before
-the structure, or return an error.
+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.
+@end table
+
+@table @kbd
@kindex M-S-@key{RET}
-@item M-S-@key{RET}
+@item M-S-RET
Insert a new item with a checkbox (@pxref{Checkboxes}).
-@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. 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}
+@item S-up
+@itemx S-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-up
+@itemx M-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}
+@item M-left
+@itemx M-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}
+@item M-S-left
+@itemx M-S-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
@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. Also, makes sure that all the
-items on this list level use the same bullet and that the numbering of list
-items (if applicable) is correct.
+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
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, all lines will be converted to list items.
-If the first line already was a list item, any item markers will be removed
-from the list. Finally, even without an active region, a normal line will be
+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}
+@item S-left/right
@vindex org-support-shift-select
This command also cycles bullet styles when the cursor in on the bullet or
anywhere in an item line, details depending on
@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}. If you
@vindex org-hide-block-startup
@cindex blocks, folding
-Org-mode uses begin...end blocks for various purposes from including source
+Org mode uses begin...end blocks for various purposes from including source
code examples (@pxref{Literal examples}) to capturing time logging
information (@pxref{Clocking work time}). These blocks can be folded and
unfolded by pressing TAB in the begin line. You can also get all 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 @LaTeX{} idiom @samp{\par}. The footnote reference
[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 @LaTeX{} snippets (@pxref{Embedded
-LaTeX}). Here are the valid references:
+@LaTeX{}}). Here are the valid references:
@table @code
@item [1]
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
@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}
@orgcmd{C-c |,org-table-create-or-convert-from-region}
-Convert the active region to table. If every line contains at least one
+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}
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
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
* 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
-* Advanced features:: Field names, parameters and automatic recalc
+* Advanced features:: Field and column names, parameters and automatic recalc
@end menu
@node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
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
@end example
@noindent For the second example, table FOO must have at least as many rows
-as the current table. Inefficient@footnote{The computation time scales as
+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.
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
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
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
+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
'(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 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. 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
@orgcmd{C-u C-c =,org-table-eval-formula}
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:
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
@table @kbd
@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}.
+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
@table @kbd
@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 *
@node Advanced features, , Updating the table, The spreadsheet
@subsection Advanced features
-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.
+If you want the recalculation of fields to happen automatically, or if you
+want to be able to assign @i{names}@footnote{Such names must start by an
+alphabetic character and use only alphanumeric/underscore characters.} to
+fields and columns, you need to reserve the first column of the table for
+special marking characters.
+
@table @kbd
@orgcmd{C-#,org-table-rotate-recalc-marks}
Rotate the calculation mark in first column through the states @samp{ },
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
flat mapping rather than a @code{3d} slope.
@item timefmt
-Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
+Specify format of Org mode timestamps as they will be parsed by Gnuplot.
Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
@item 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>>
./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:sometextfile::NNN @r{file, jump to line number}
file:projects.org @r{another Org file}
-file:projects.org::some words @r{text search in Org file}
+file:projects.org::some words @r{text search in Org file}@footnote{
+The actual behavior of the search will depend on the value of
+the variable @code{org-link-search-must-match-exact-headline}. If its value
+is nil, then a fuzzy text search will be done. If it is t, then only the
+exact headline will be matched. If the value is @code{'query-to-create},
+then an exact headline will be searched; if it is not found, then the user
+will be queried to create it.}
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}
+file+sys:/path/to/file @r{open via OS, like double-click}
+file+emacs:/path/to/file @r{force opening by Emacs}
+docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
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)}
+info:org#External links @r{Info node link}
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:
buffer (see below). What kind of link will be created depends on the current
buffer:
-@b{Org-mode buffers}@*
+@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
@cindex following links
@orgcmd{C-c C-o,org-open-at-point}
@vindex org-file-apps
+@vindex org-link-frame-setup
Open link at point. This will launch a web browser for URLs (using
@command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
the corresponding links, and execute the command in a shell link. When the
visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
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.
+headline and entry text. If you want to setup the frame configuration for
+following links, customize @code{org-link-frame-setup}.
+
@orgkey @key{RET}
@vindex org-return-follows-link
When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
@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
+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
@orgcmd{C-c %,org-mark-ring-push}
@cindex mark ring
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
@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
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
@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.
@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
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 numeric prefix argument
+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.
@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
(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
@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
+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.
* Parent
:PROPERTIES:
- :ORDERED: t
+ :ORDERED: t
:END:
** TODO a
** TODO b, needs to wait for (a)
@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
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
+adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
+with timestamp) in parentheses after each keyword. For example, with the
+setting
@lisp
(setq org-todo-keywords
'((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
@end lisp
+To record a timestamp without a note for TODO keywords configured with
+@samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
+
@noindent
@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
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
@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 with 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
@noindent
@vindex org-priority-faces
-By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
+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
+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 node; they do not need to be TODO
@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}
+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
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
@table @kbd
@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.
+Toggle checkbox status or (with prefix arg) checkbox presence at point.
+With a single prefix argument, add an empty checkbox or remove the current
+one@footnote{`C-u C-c C-c' on the @emph{first} item of a list with no checkbox
+will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
+considered to be an intermediate state.
@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
If there is no active region, just toggle the checkbox at point.
@end itemize
@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}).
+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
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
@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
@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
-@orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
+@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.
@orgcmd{C-c a m,org-tags-view}
@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 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
+A property is a key-value pair associated with an entry. Properties can be
+set so they are associated with a single entry, with every entry in a tree,
+or with every entry in an Org mode file.
+
+There are two main applications for properties in Org mode. First,
+properties are like tags, but with a value. Imagine maintaining a file where
you document bugs and plan releases for a piece of software. Instead of
-using tags like @code{:release_1:}, @code{:release_2:}, one can use a
+using tags like @code{:release_1:}, @code{:release_2:}, you can use a
property, say @code{:Release:}, that in different subtrees has different
-values, such as @code{1.0} or @code{2.0}. For an example of the second
-application of properties, imagine keeping track of your music CDs,
-where properties could be things such as the album, artist, date of
-release, number of tracks, and so on.
+values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
+implement (very basic) database capabilities in an Org buffer. Imagine
+keeping track of your music CDs, where properties could be things such as the
+album, artist, date of release, number of tracks, and so on.
Properties can be conveniently edited and viewed in column view
(@pxref{Column view}).
@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
@cindex property syntax
@cindex drawer, for properties
-Properties are key-value pairs. They need to be inserted into a special
+Properties are key-value pairs. When they are associated with a single entry
+or with a tree they need to be inserted into a special
drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
is specified on a single line, with the key (surrounded by colons)
first, and the value after it. Here is an example:
:END:
@end example
+Depending on the value of @code{org-use-property-inheritance}, a property set
+this way will either be associated with a single entry, or the sub-tree
+defined by the entry, see @ref{Property inheritance}.
+
You may define the allowed values for a particular property @samp{:Xyz:}
by setting a property @samp{:Xyz_ALL:}. This special property is
@emph{inherited}, so if you set it in a level 1 entry, it will apply to
#+PROPERTY: NDisks_ALL 1 2 3 4
@end example
+If you want to add to the value of an existing property, append a @code{+} to
+the property name. The following results in the property @code{var} having
+the value ``foo=1 bar=2''.
+@cindex property, +
+@example
+#+PROPERTY: var foo=1
+#+PROPERTY: var+ bar=2
+@end example
+
+It is also possible to add to the values of inherited properties. The
+following results in the @code{genres} property having the value ``Classic
+Baroque'' under the @code{Goldberg Variations} subtree.
+@cindex property, +
+@example
+* CD collection
+** Classic
+ :PROPERTIES:
+ :GENRES: Classic
+ :END:
+*** Goldberg Variations
+ :PROPERTIES:
+ :Title: Goldberg Variations
+ :Composer: J.S. Bach
+ :Artist: Glen Gould
+ :Publisher: Deutsche Grammophon
+ :NDisks: 1
+ :GENRES+: Baroque
+ :END:
+@end example
+Note that a property can only have one entry per Drawer.
+
@vindex org-global-properties
Property values set with the global variable
@code{org-global-properties} can be inherited by all entries in all
The following commands help to work with properties:
@table @kbd
-@orgcmd{M-@key{TAB},org-complete}
+@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.
@orgcmd{C-c C-x p,org-set-property}
@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, 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
@cindex inheritance, of properties
@vindex org-use-property-inheritance
-The outline structure of Org-mode documents lends itself to 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
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})}
-@var{title} @r{The header text for the column. If omitted, the property}
+@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.}
@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
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
+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
+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
@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
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
@cindex scheduling
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 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
-(@pxref{Weekly/daily agenda}). We distinguish:
+times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
+simplest form, the day name is optional when you type the date yourself.
+However, any dates inserted or modified by Org will add that day name, for
+reading convenience.} 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 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 (@pxref{Weekly/daily agenda}). We distinguish:
@table @var
@item Plain timestamp; Event; Appointment
@cindex timestamp
+@cindex appointment
A simple timestamp just assigns a date/time to an item. This is just
like writing down an appointment or event in a paper agenda. In the
timeline and agenda displays, the headline of an entry associated with a
@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.
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
+@orgkey{C-c C-c}
+Normalize timestamp, insert/fix day name if missing or wrong.
+@c
@orgcmd{C-c <,org-date-from-calendar}
Insert a timestamp corresponding to the cursor date in the Calendar.
@c
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
@orgcmd{C-c C-y,org-evaluate-time-range}
@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
-2/5/3 --> 2003-02-05
-14 --> @b{2006}-@b{06}-14
-12 --> @b{2006}-@b{07}-12
-2/5 --> @b{2007}-02-05
-Fri --> nearest Friday (default date 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 `-' or `-@{@}-' as the separator
-in the former case and use '+' as the separator in the latter case. E.g.
+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 --> 11:00-13:15
-11am--1:15pm --> same as above
-11am+2:15 --> same as above
+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-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
@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:
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.
+in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
the task will automatically be forwarded until completed.
@example
@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
@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
+
@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
@orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
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
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
+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
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
+@i{after} the last time you did it. For these tasks, Org mode has
special repeaters @samp{++} and @samp{.+}. For example:
@example
@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
@table @kbd
@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,
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.
+@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.
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}.
+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
@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
+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.
+update it. The clock table always includes also trees with
+@code{:ARCHIVE:} tag.
@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.
@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}.
+: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
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{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}
By customizing the variable @code{org-clock-idle-time} to some integer, such
as 10 or 15, Emacs can alert you when you get back to your computer after
being idle for that many minutes@footnote{On computers using Mac OS X,
-idleness is based on actual user idleness, not just Emacs' idle time. For
+idleness is based on actual user idleness, not just Emacs's idle time. For
X11, you can install a utility program @file{x11idle.c}, available in the
UTILITIES directory of the Org git distribution, to get the same general
treatment of idleness. On other systems, idle time refers to Emacs idle time
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
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
@kindex C-c C-x ;
@kindex ;
-Calling @code{org-timer-set-timer} from an Org-mode buffer runs a countdown
-timer. Use @key{;} from agenda buffers, @key{C-c C-x ;} everwhere else.
+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
* 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
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
+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}.
@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
@table @kbd
@orgkey{C-u C-c c}
-Visit the target location of a cpature template. You get to select the
+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.
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
@subsubsection Template elements
Now lets look at the elements of a template definition. Each entry in
-@code{org-capture-templates} is a list with the following items:
+@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
+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
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.
+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 target
@vindex org-default-notes-file
-Specification of where the captured item should be placed. In Org-mode
+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}.
+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 :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.
+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.
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:
+dynamic insertion of content. The templates are expanded in the order given here:
-@comment SJE: should these sentences terminate in period?
@smallexample
-%^@{@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}
+%[@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}
+%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.}
%^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}
+%^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
@vindex org-from-is-user-regexp
@smallexample
-Link type | Available keywords
--------------------+----------------------------------------------
+Link type | Available keywords
+------------------------+----------------------------------------------
bbdb | %:name %:company
irc | %:server %:port %:nick
vm, wl, mh, mew, rmail | %:type %:subject %:message-id
Synchronize the current task with its attachment directory, in case you added
attachments yourself.
-@orgcmdtkc{p,C-c C-a o,org-attach-open}
+@orgcmdtkc{o,C-c C-a o,org-attach-open}
@vindex org-file-apps
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}.
variable @code{org-refile-allow-creating-parent-nodes}.
When the variable @code{org-log-refile}@footnote{with corresponding
@code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
-and @code{nologrefile}} is set, a time stamp or a note will be
+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.
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
-@orgcmd{C-c [,org-agenda-to-front}
+@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.
@orgcmd{C-c ],org-remove-file}
Remove current file from the list of agenda files.
@kindex C-,
+@cindex cycling, of agenda files
@orgcmd{C-',org-cycle-agenda-files}
@itemx C-,
Cycle through agenda file list, visiting one file after the other.
@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
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 5 14 1956)@footnote{Note that the order of the arguments (month, day, year) depends on the setting of @code{calendar-date-style}.} Arthur Dent is %d years old
-%%(diary-anniversary 10 2 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
very likely prefer to store anniversaries in BBDB rather than in a
separate Org or diary file. Org supports this and will show BBDB
anniversaries as part of the agenda. All you need to do is to add the
-following to one your your agenda files:
+following to one of your agenda files:
@example
* Anniversaries
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
+2008-04-14 %s released version 6.01 of org mode, %d years ago
@end example
After a change to BBDB, or for the first agenda display during an Emacs
@subsubheading Appointment reminders
@cindex @file{appt.el}
@cindex appointment reminders
+@cindex appointment
+@cindex reminders
Org can interact with Emacs appointments notification facility. To add all
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
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.
@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.
@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
@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
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 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:
@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
-@c @kindex v d
-@c @kindex d
-@c @kindex v w
-@c @kindex w
-@c @kindex v m
-@c @kindex v y
-@c @item v d @ @r{or short} @ d
-@c @itemx v w @ @r{or short} @ w
-@c @itemx v m
-@c @itemx v y
-@orgcmdkskc{v d,d,org-aganda-day-view}
-@xorgcmdkskc{v w,w,org-aganda-day-view}
+@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}
-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.
+@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
@orgcmd{f,org-agenda-later}
Go forward in time to display the following @code{org-agenda-current-span} days.
@c
@orgcmdkskc{v R,R,org-agenda-clockreport-mode}
@vindex org-agenda-start-with-clockreport-mode
+@vindex org-clock-report-include-clocking-task
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}. By using a prefix argument
-when toggling this mode (i.e. @kbd{C-u R}), the clock table will not show
+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.}.
+tags filtering will be respected here, effort filtering is ignored.}. See
+also the variable @code{org-clock-report-include-clocking-task}.
+@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
@orgcmdkskc{v E,E,org-agenda-entry-text-mode}
@vindex org-agenda-start-with-entry-text-mode
Toggle the time grid on and off. See also the variables
@code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
@c
-@orgcmd{r,org-agenda-rodo}
+@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.
-@orgcmd{g,org-agenda-rodo}
+@orgcmd{g,org-agenda-redo}
Same as @kbd{r}.
@c
@orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
file or subtree (@pxref{Agenda files}).
@tsubheading{Secondary filtering and query editing}
-@cindex filtering, by tag and effort, in agenda
+@cindex filtering, by tag category and effort, in agenda
@cindex tag filtering, in agenda
+@cindex category filtering, in agenda
@cindex effort filtering, in agenda
@cindex query editing, in agenda
+@orgcmd{<,org-agenda-filter-by-category}
+@vindex org-agenda-category-filter-preset
+
+Filter the current agenda view with respect to the category of the item at
+point. Pressing @code{<} another time will remove this filter. You can add
+a filter preset through the option @code{org-agenda-category-filter-preset}
+(see below.)
+
@orgcmd{/,org-agenda-filter-by-tag}
-@vindex org-agenda-filter-preset
+@vindex org-agenda-tag-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
-binding the variable @code{org-agenda-filter-preset} as an option. This
+binding the variable @code{org-agenda-tag-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. The filter is a global property of
the entire agenda view---in a block agenda, you should only set this in the
@end group
@end lisp
-@orgcmd{\,org-agenda-filter-by-tag-refine}
+@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
@kindex ,
@item ,
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.
+Org mode prompts for the priority character. If you reply with @key{SPC},
+the priority cookie is removed from the entry.
@c
@orgcmd{P,org-agenda-show-priority}
Display weighted priority of current item.
@c
@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
-@kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
-command, it will continue to change hours even without the prefix arg. With
-a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
-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.
+future. If the date is in the past, the first call to this command will move
+it to today.@*
+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 @kbd{C-u} prefix,
+change the time by one hour. If you immediately repeat the command, it will
+continue to change hours even without the prefix arg. With a double @kbd{C-u
+C-u} prefix, do the same for changing minutes.@*
+The stamp 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
@orgcmd{S-@key{left},org-agenda-do-date-earlier}
Change the timestamp associated with the current line by one day
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.
@c
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 by N days. N will be prompted for. With prefix}
- @r{arg (@kbd{C-u B S}), scatter only accross weekdays.}
+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
Open the Emacs calendar and move to the date at the agenda cursor.
@c
@orgcmd{c,org-calendar-goto-agenda}
-When in the calendar, compute and show the Org-mode agenda for the
+When in the calendar, compute and show the Org mode agenda for the
date at the cursor.
@c
@cindex diary entries, creating from agenda
command in the calendar. The diary file will pop up in another window, where
you can add the entry.
-If you configure @code{org-agenda-diary-file} to point to an Org-mode file,
-Org will create entries (in org-mode syntax) in that file instead. Most
+If you configure @code{org-agenda-diary-file} to point to an Org mode file,
+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
built under an entry with a @code{DATE_TREE} property, or else with years as
@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
@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
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
@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
@noindent
From the command line you may also use
@example
-emacs -f org-batch-store-agenda-views -kill
+emacs -eval (org-batch-store-agenda-views) -kill
@end example
@noindent
or, if you need to modify some parameters@footnote{Quoting depends on the
system you use, please check the FAQ for examples.}
@example
emacs -eval '(org-batch-store-agenda-views \
- org-agenda-span month \
+ org-agenda-span (quote month) \
org-agenda-start-day "2007-11-01" \
org-agenda-include-diary nil \
org-agenda-files (quote ("~/org/project.org")))' \
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
@node Markup, Exporting, Agenda Views, Top
@chapter Markup for rich export
-When exporting Org-mode documents, the exporter tries to reflect the
+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, @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.
+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
* Structural markup elements:: The basic structure as seen by the exporter
* 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
+* Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
@end menu
@node Structural markup elements, Images and tables, Markup, Markup
@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, @LaTeX{}, or DocBook code, use the special
constructs described below in the sections for the individual exporters.
#+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
When quoting a passage from another document, it is customary to format this
as a paragraph that is indented on both the left and the right margin. You
-can include quotations in Org-mode documents like this:
+can include quotations in Org mode documents like this:
@cindex #+BEGIN_QUOTE
@example
@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
@cindex strike-through text, markup rules
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
+in the code and verbatim string is not processed for Org mode specific
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, and in the text you can refer to
|-----|----|
@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, @LaTeX{}, and DocBook) allow you to directly include
images into the exported document. Org does this, if a link to an image
that can be marked up by font-lock in Emacs, you can ask for the example to
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
+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
+@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
+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
+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-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:
+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.}, see @ref{Easy Templates} for
+shortcuts to easily insert code blocks.
@cindex #+BEGIN_SRC
@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.
You can also add a @code{-r} switch which @i{removes} the labels from the
source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
labels in the source code while using line numbers for the links, which might
-be useful to explain those in an org-mode example code.}. With the @code{-n}
+be useful to explain those in an Org mode example code.}. With the @code{-n}
switch, links to these references will be labeled by the line numbers from
the code listing, otherwise links will use the labels with no parentheses.
Here is an example:
@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 '
#+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
+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, @code{:minlevel} in order to get
-org-mode content demoted to a specified level, as well as any options
+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
#+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 '
-@node Macro replacement, Embedded LaTeX, Index entries, Markup
+@node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
@section Macro replacement
@cindex macro replacement, during export
@cindex #+MACRO
construct complex HTML code.
-@node Embedded LaTeX, , Macro replacement, Markup
+@node Embedded @LaTeX{}, , Macro replacement, Markup
@section Embedded @LaTeX{}
@cindex @TeX{} interpretation
@cindex @LaTeX{} interpretation
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
+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
* Subscripts and superscripts:: Simple syntax for raising/lowering text
-* LaTeX fragments:: Complex formulas made easy
-* Previewing LaTeX fragments:: What will this snippet look like?
+* @LaTeX{} fragments:: Complex formulas made easy
+* Previewing @LaTeX{} fragments:: What will this snippet look like?
* CDLaTeX mode:: Speed up entering of formulas
@end menu
-@node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
+@node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
@subsection Special symbols
@cindex math symbols
@cindex special symbols
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 @LaTeX{}
-code, Org-mode allows these macros to be present without surrounding math
+code, Org mode allows these macros to be present without surrounding math
delimiters, for example:
@example
for display purposes only.
@end table
-@node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
+@node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
@subsection Subscripts and superscripts
@cindex subscript
@cindex superscript
format sub- and superscripts in a WYSIWYM way.
@end table
-@node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
+@node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
@subsection @LaTeX{} fragments
@cindex @LaTeX{} fragments
@vindex org-format-latex-header
Going beyond symbols and sub- and superscripts, a full formula language is
-needed. Org-mode can contain @LaTeX{} math fragments, and it supports ways
+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
@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
+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 @LaTeX{} header that will
be used when processing a fragment can be configured with the variable
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
+@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
+@LaTeX{} backends. You can also set this variable on a per-file basis using one
of these lines:
@example
#+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
+@node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
+@subsection Previewing @LaTeX{} fragments
+@cindex @LaTeX{} fragments, preview
If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
produce preview images of the typeset expressions:
@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.
-@node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX
-@subsection Using CDLa@TeX{} to enter math
-@cindex CDLa@TeX{}
+@node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
+@subsection Using CD@LaTeX{} to enter math
+@cindex CD@LaTeX{}
-CDLa@TeX{} mode is a minor mode that is normally used in combination with a
+CD@LaTeX{} mode is a minor mode that is normally used in combination with a
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
+environments and math templates. Inside Org mode, you can make use of
+some of the features of CD@LaTeX{} 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 CD@LaTeX{} 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
@end lisp
When this mode is enabled, the following features are present (for more
-details see the documentation of CDLa@TeX{} mode):
+details see the documentation of CD@LaTeX{} mode):
@itemize @bullet
@kindex C-c @{
@item
@item
@kindex @key{TAB}
The @key{TAB} key will do template expansion if the cursor is inside a
-@LaTeX{} 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
@chapter Exporting
@cindex exporting
-Org-mode documents can be exported into a variety of other formats. For
+Org mode documents can be exported into a variety of other formats. For
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. @LaTeX{} export lets you use Org-mode and
+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. 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.
+DocBook tools. OpenDocument Text(@acronym{ODT}) 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).
* The export dispatcher:: How to access exporter commands
* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
* HTML export:: Exporting to HTML
-* LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
+* @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
* DocBook export:: Exporting to DocBook
+* OpenDocument Text export:: Exporting to OpenDocument Text
* TaskJuggler export:: Exporting to TaskJuggler
* Freemind export:: Exporting to Freemind mind maps
* XOXO export:: Exporting to XOXO
@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}.
+@code{org-export-select-tags} and @code{org-export-exclude-tags},
+respectively defaulting to @code{'(:export:)} and @code{'(:noexport:)}.
-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
@vindex user-full-name
@vindex user-mail-address
@vindex org-export-default-language
+@vindex org-export-date-timestamp-format
@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, or a format string for @code{format-time-string}
+#+DATE: a date, an Org timestamp@footnote{@code{org-export-date-timestamp-format} defines how this timestamp will be exported.}, 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.@:: @code{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@}
+#+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
+The @code{#+OPTIONS} line is a compact@footnote{If you want to configure many options
+this way, you can use several @code{#+OPTIONS} lines.} form to specify export
settings. Here you can:
@cindex headline levels
@cindex section-numbers
@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}
-: @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}
@end example
@noindent
These options take effect in both the HTML and @LaTeX{} export, except for
-@code{TeX} and @code{LaTeX}, 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}.
+@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
the variable @code{org-export-run-in-background}.}.
@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).
+(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 the exporter, but reverse the setting of
-@code{org-export-run-in-background}, i.e. request background processing if
+@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
@cindex Latin-1 export
@cindex UTF-8 export
-ASCII export produces a simple and very readable version of an Org-mode
+ASCII export produces a simple and very readable version of an Org mode
file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
with special characters and symbols available in these encodings.
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
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/Latin-1/UTF-8 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
* 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
@table @kbd
@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.
@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
+Convert the region to HTML under the assumption that it was Org mode
syntax before. This is a global command that can be invoked in any
buffer.
@item M-x org-replace-region-by-HTML
-Replace the active region (assumed to be in Org-mode syntax) by HTML
+Replace the active region (assumed to be in Org mode syntax) by HTML
code.
@end table
@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
@cindex #+ATTR_HTML
@example
-#+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
+#+ATTR_HTML: title="The Org mode homepage" style="color:red;"
[[http://orgmode.org]]
@end example
@cindex tables, in HTML
@vindex org-export-html-table-tag
-Org-mode tables are exported to HTML using the table tag defined in
+Org mode tables are exported to HTML using the table tag defined in
@code{org-export-html-table-tag}. The default setting makes tables without
cell borders and frame. If you would like to change this for individual
tables, place something like the following before the table:
@cindex #+ATTR_HTML
@example
#+CAPTION: This is a table with lines around and between cells
-#+ATTR_HTML: border="2" rules="all" frame="all"
+#+ATTR_HTML: border="2" rules="all" frame="border"
@end example
@node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
@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
+@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
+@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
@example
p.author @r{author information, including email}
p.date @r{publishing date}
-p.creator @r{creator info, about org-mode version}
+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-infojs-options}. If you always want to apply the script to your
pages, configure the variable @code{org-export-html-use-infojs}.
-@node LaTeX and PDF export, DocBook export, HTML export, Exporting
+@node @LaTeX{} and PDF export, DocBook export, HTML export, Exporting
@section @LaTeX{} and PDF export
@cindex @LaTeX{} export
@cindex PDF export
@cindex Guerry, Bastien
-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
+Org mode contains a @LaTeX{} exporter written by Bastien Guerry. With
+further processing@footnote{The default @LaTeX{} output is designed for
+processing with @code{pdftex} or @LaTeX{}. It includes packages that are not
+compatible with @code{xetex} and possibly @code{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.
+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
+* @LaTeX{}/PDF export commands::
* 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
+* 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, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
+@node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
@subsection @LaTeX{} export commands
@cindex region, active
@table @kbd
@orgcmd{C-c C-e l,org-export-as-latex}
@cindex property EXPORT_FILE_NAME
-Export as @LaTeX{} 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.
@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
+@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 @LaTeX{} 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 @LaTeX{}
+Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
code.
@orgcmd{C-c C-e p,org-export-as-pdf}
Export as @LaTeX{} and then process to PDF.
@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 Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
+@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
+@cindex header, for @LaTeX{} files
+@cindex sectioning structure, for @LaTeX{} export
By default, the @LaTeX{} output uses the class @code{article}.
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
+@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
+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 @LaTeX{} export with
@cindex #+LaTeX
@cindex #+BEGIN_LaTeX
@example
-#+LaTeX: Literal LaTeX code for export
+#+LaTeX: Literal @LaTeX{} code for export
@end example
@noindent or
@end example
-@node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF 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 @LaTeX{} 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 @code{longtable} environment for the table, so that it may span
-several pages, or provide the @code{multicolumn} keyword that will make the
-table span the page in a multicolumn environment (@code{table*} environment).
-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, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
+@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{}
@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.
+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
[[./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 @LaTeX{}.
-@node Beamer class export, , Images in LaTeX export, LaTeX and PDF export
+@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.
+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:
+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
For more information, see the documentation on Worg.
-@node DocBook export, TaskJuggler export, LaTeX and PDF export, Exporting
+@node DocBook export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
@section DocBook export
@cindex DocBook export
@cindex PDF export
@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
@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]]
"
@end example
-@node TaskJuggler export, Freemind export, DocBook export, Exporting
-@section TaskJuggler export
-@cindex TaskJuggler export
-@cindex Project management
+@c begin opendocument
+
+@node OpenDocument Text export, TaskJuggler export, DocBook export, Exporting
+@section OpenDocument Text export
+@cindex K, Jambunathan
+@cindex ODT
+@cindex OpenDocument
+@cindex export, OpenDocument
+@cindex LibreOffice
+@cindex org-odt.el
+@cindex org-modules
+
+Orgmode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
+(@acronym{ODT}) format using the @file{org-odt.el} module. Documents created
+by this exporter use the @cite{OpenDocument-v1.2
+specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
+Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
+are compatible with LibreOffice 3.4.
-@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.
+@menu
+* Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on
+* @acronym{ODT} export commands:: How to invoke @acronym{ODT} export
+* Applying custom styles:: How to apply custom styles to the output
+* Links in @acronym{ODT} export:: How links will be interpreted and formatted
+* Tables in @acronym{ODT} export:: How Tables are exported
+* Images in @acronym{ODT} export:: How to insert images
+* Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted
+* Literal examples in @acronym{ODT} export:: How source and example blocks are formatted
+* Advanced topics in @acronym{ODT} export:: Read this if you are a power user
+@end menu
-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.
+@node Pre-requisites for @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export, OpenDocument Text export
+@subsection Pre-requisites for @acronym{ODT} export
+@cindex zip
+The @acronym{ODT} exporter relies on the @file{zip} program to create the final
+output. Check the availability of this program before proceeding further.
-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.
+@node @acronym{ODT} export commands, Applying custom styles, Pre-requisites for @acronym{ODT} export, OpenDocument Text export
+@subsection @acronym{ODT} export commands
-@subsection TaskJuggler export commands
+@subsubheading Exporting to @acronym{ODT}
+@anchor{x-export-to-odt}
+@cindex region, active
+@cindex active region
+@cindex transient-mark-mode
@table @kbd
-@orgcmd{C-c C-e j,org-export-as-taskjuggler}
-Export as TaskJuggler file.
+@orgcmd{C-c C-e o,org-export-as-odt}
+@cindex property EXPORT_FILE_NAME
-@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
+Export as OpenDocument Text file.
+@vindex org-export-odt-preferred-output-format
+If @code{org-export-odt-preferred-output-format} is specified, automatically
+convert the exported file to that format.
+@xref{x-export-to-other-formats,,Automatically exporting to other formats}.
+
+For an Org file @file{myfile.org}, the @acronym{ODT} 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.
-@subsection Tasks
+@orgcmd{C-c C-e O,org-export-as-odt-and-open}
+Export as OpenDocument Text file and open the resulting file.
+@vindex org-export-odt-preferred-output-format
+If @code{org-export-odt-preferred-output-format} is specified, open the
+converted file instead.
+@xref{x-export-to-other-formats,,Automatically exporting to other formats}.
+@end table
-@vindex org-export-taskjuggler-project-tag
-Create your tasks as you usually do with Org-mode. Assign efforts to each
-task using properties (it's 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.
+@subsubheading Automatically exporting to other formats
+@anchor{x-export-to-other-formats}
+@vindex org-export-odt-preferred-output-format
+Very often, you will find yourself exporting to @acronym{ODT} format, only to
+immediately save the exported document to a different format like @samp{pdf}.
+In such cases, you will find it convenient to configure a converter
+(@pxref{Exporting and converting to other formats}) and specify your
+preferred output format by customizing the variable
+@code{org-export-odt-preferred-output-format}. This way, the export commands
+(@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to also export to
+the preferred format.
+
+@node Applying custom styles, Links in @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export
+@subsection Applying custom styles
+@cindex styles, custom
+@cindex template, custom
+
+The @acronym{ODT} exporter ships with a set of OpenDocument styles
+(@pxref{Working with OpenDocument style files}) that ensure a well-formatted
+output. These factory styles, however, may not cater to your specific
+tastes. To customize the output, you can either modify the above styles
+files directly, or generate the required styles using an application like
+LibreOffice. The latter method is suitable for expert and non-expert
+users alike, and is described here.
+
+@subsubsection Applying custom styles - the easy way
-@subsection Resources
+@enumerate
+@item
+Create a sample @file{example.org} file with the below settings and export it
+to @acronym{ODT} format.
-@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}}.
+@example
+#+OPTIONS: H:10 num:t
+@end example
-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.
+@item
+Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
+to locate the target styles - these typically have the @samp{Org} prefix -
+and modify those to your taste. Save the modified file either as an
+OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
-@subsection Export of properties
+@item
+@cindex #+ODT_STYLES_FILE
+@vindex org-export-odt-styles-file
+Customize the variable @code{org-export-odt-styles-file} and point it to the
+newly created file. For additional configuration options
+@pxref{x-overriding-factory-styles,,Overriding factory styles}.
-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.
+If you would like to choose a style on a per-file basis, you can use the
+@code{#+ODT_STYLES_FILE} option. A typical setting will look like
-@subsection Dependencies
+@example
+#+ODT_STYLES_FILE: "/path/to/example.ott"
+@end example
-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:
+or
@example
-* Preparation
- :PROPERTIES:
- :task_id: preparation
- :ORDERED: t
- :END:
-* Training material
- :PROPERTIES:
- :task_id: training_material
- :ORDERED: t
- :END:
-** Markup Guidelines
- :PROPERTIES:
- :Effort: 2.0
- :END:
-** Workflow Guidelines
- :PROPERTIES:
- :Effort: 2.0
- :END:
-* Presentation
- :PROPERTIES:
- :Effort: 2.0
- :BLOCKER: training_material @{ gapduration 1d @} preparation
- :END:
+#+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
@end example
-@subsection Reports
+@end enumerate
-@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}}.
+@subsubsection Using third-party styles and templates
-For more information and examples see the Org-taskjuggler tutorial at
-@uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.php}.
+You can use third-party styles and templates for customizing your output.
+This will produce the desired output only if the template provides all
+style names that the @samp{ODT} exporter relies on. Unless this condition is
+met, the output is going to be less than satisfactory. So it is highly
+recommended that you only work with templates that are directly derived from
+the factory settings.
-@node Freemind export, XOXO export, TaskJuggler export, Exporting
-@section Freemind export
-@cindex Freemind export
-@cindex mind map
+@node Links in @acronym{ODT} export, Tables in @acronym{ODT} export, Applying custom styles, OpenDocument Text export
+@subsection Links in @acronym{ODT} export
+@cindex tables, in DocBook export
+
+The @acronym{ODT} exporter creates cross-references (aka bookmarks) for
+internal links. It creates Internet-style links for all other links.
+
+@node Tables in @acronym{ODT} export, Images in @acronym{ODT} export, Links in @acronym{ODT} export, OpenDocument Text export
+@subsection Tables in @acronym{ODT} export
+@cindex tables, in DocBook export
+
+Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
+tables is supported. However, export of complex @file{table.el} tables -
+tables that have column or row spans - is not supported. Such tables are
+stripped from the exported document.
+
+By default, a table is exported with top and bottom frames and with
+rules separating row and column groups (@pxref{Column groups}). If the table
+specifies alignment and relative width for its columns (@pxref{Column width
+and alignment}) then these are honored on export.@footnote{The column widths
+are interpreted as weighted ratios with the default weight being 1}
+
+@cindex #+ATTR_ODT
+If you are not satisfied with the default formatting of tables, you can
+create custom table styles and associate them with a table using
+the @code{#+ATTR_ODT} line. @xref{Customizing tables in @acronym{ODT} export}.
+
+@node Images in @acronym{ODT} export, Math formatting in @acronym{ODT} export, Tables in @acronym{ODT} export, OpenDocument Text export
+@subsection Images in @acronym{ODT} export
+@cindex images, embedding in @acronym{ODT}
+@cindex embedding images in @acronym{ODT}
+
+@subsubheading Embedding images
+You can embed images within the exported document by providing a link to the
+desired image file with no link description. For example, to embed
+@samp{img.png} do either of the following:
+
+@example
+[[file:img.png]]
+@end example
+
+@example
+[[./img.png]]
+@end example
+
+@subsubheading Embedding clickable images
+You can create clickable images by providing a link whose description is a
+link to an image file. For example, to embed a image
+@file{org-mode-unicorn.png} which when clicked jumps to
+@uref{http://Orgmode.org} website, do the following
+
+@example
+[[http://orgmode.org][./org-mode-unicorn.png]]
+@end example
+
+@subsubheading Sizing and scaling of embedded images
+
+You can control the size and scale of the embedded images using the
+@code{#+ATTR_ODT} attribute.
+
+@vindex org-export-odt-pixels-per-inch
+Note that the exporter specifies the desired size of the image in the final
+document in units of centimeters. In order to scale the embedded images, the
+exporter needs to compute the size of the image. This is done by retrieving
+the image size in pixels and converting the pixel units to centimeters using
+@code{org-export-odt-pixels-per-inch}. The default value of this variable is
+set to @code{display-pixels-per-inch}. You can tweak this variable to
+achieve the best results.
+
+The examples below illustrate the various possibilities.
+
+@table @asis
+
+@item Explicitly size the image
+To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
+
+@example
+#+ATTR_ODT: :width 10 :height 10
+[[./img.png]]
+@end example
+
+@item Scale the image
+To embed @file{img.png} at half its size, do the following:
+
+@example
+#+ATTR_ODT: :scale 0.5
+[[./img.png]]
+@end example
+
+@item Scale the image to a specific width
+To embed @file{img.png} with a width of 10 cm while retaining the original
+height:width ratio, do the following:
+
+@example
+#+ATTR_ODT: :width 10
+[[./img.png]]
+@end example
+
+@item Scale the image to a specific height
+To embed @file{img.png} with a height of 10 cm while retaining the original
+height:width ratio, do the following
+
+@example
+#+ATTR_ODT: :height 10
+[[./img.png]]
+@end example
+@end table
+
+@node Math formatting in @acronym{ODT} export, Literal examples in @acronym{ODT} export, Images in @acronym{ODT} export, OpenDocument Text export
+@subsection Math formatting in @acronym{ODT} export
+
+The @acronym{ODT} exporter has special support for handling math.
+
+@menu
+* Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
+* Working with MathML or OpenDocument formula files:: How to embed equations in native format
+@end menu
+
+@node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in @acronym{ODT} export, Math formatting in @acronym{ODT} export
+@subsubsection Working with @LaTeX{} math snippets
+
+@LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
+document in one of the following ways:
+
+@cindex MathML
+@enumerate
+@item MathML
+
+This option is activated on a per-file basis with
+
+@example
+#+OPTIONS: LaTeX:t
+@end example
+
+With this option, @LaTeX{} fragments are first converted into MathML
+fragments using an external @LaTeX{}-to-MathML converter program. The
+resulting MathML fragments are then embedded as an OpenDocument Formula in
+the exported document.
+
+@vindex org-latex-to-mathml-convert-command
+@vindex org-latex-to-mathml-jar-file
+
+You can specify the @LaTeX{}-to-MathML converter by customizing the variables
+@code{org-latex-to-mathml-convert-command} and
+@code{org-latex-to-mathml-jar-file}.
+
+If you prefer to use @file{MathToWeb}@footnote{See
+@uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
+converter, you can configure the above variables as shown below.
+
+@lisp
+(setq org-latex-to-mathml-convert-command
+ "java -jar %j -unicode -force -df %o %I"
+ org-latex-to-mathml-jar-file
+ "/path/to/mathtoweb.jar")
+@end lisp
+
+You can use the following commands to quickly verify the reliability of
+the @LaTeX{}-to-MathML converter.
+
+@table @kbd
+
+@item M-x org-export-as-odf
+Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file.
+
+@item M-x org-export-as-odf-and-open
+Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file and
+open the formula file with the system-registered application.
+@end table
+
+@cindex dvipng
+@item PNG images
+
+This option is activated on a per-file basis with
+
+@example
+#+OPTIONS: LaTeX:dvipng
+@end example
+
+With this option, @LaTeX{} fragments are processed into PNG images and the
+resulting images are embedded in the exported document. This method requires
+that the @file{dvipng} program be available on your system.
+@end enumerate
+
+@node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in @acronym{ODT} export
+@subsubsection Working with MathML or OpenDocument formula files
+
+For various reasons, you may find embedding @LaTeX{} math snippets in an
+@acronym{ODT} document less than reliable. In that case, you can embed a
+math equation by linking to its MathML(@file{.mml}) source or its
+OpenDocument formula (@file{.odf}) file as shown below:
+
+@example
+[[./equation.mml]]
+@end example
+
+or
+
+@example
+[[./equation.odf]]
+@end example
+
+@node Literal examples in @acronym{ODT} export, Advanced topics in @acronym{ODT} export, Math formatting in @acronym{ODT} export, OpenDocument Text export
+@subsection Literal examples in @acronym{ODT} export
+
+Export of literal examples (@pxref{Literal examples}) with full fontification
+is supported. This feature is enabled by default and is activated
+automatically if an enhanced version of @file{htmlfontify.el} is available in
+the @code{load-path}.@footnote{The @file{htmlfontify.el} that ships with
+standard Emacs <= 24.1 has no support for @acronym{ODT} fontification. A
+copy of the proposed version is available as an attachment to
+@url{http://debbugs.gnu.org/cgi/bugreport.cgi?msg=5;filename=htmlfontify.el;att=9;bug=9914,
+Emacs Bug #9914}.}
+
+@vindex org-export-odt-fontify-srcblocks
+
+The character styles used for fontification of the literal blocks are
+auto-generated by the exporter in conjunction with @file{htmlfontify.el}
+library and need not be included in the default @file{styles.xml} file.
+These auto-generated styles have the @samp{OrgSrc} prefix and inherit their color
+based on the face used by Emacs @code{font-lock} library.
+
+@vindex org-export-odt-create-custom-styles-for-srcblocks
+If you prefer to use your own custom styles for fontification and disable
+their auto-generation altogether, you can do so by customizing the variable
+@code{org-export-odt-create-custom-styles-for-srcblocks}.
+
+You can turn off fontification support for literal examples by customizing
+the variable @code{org-export-odt-fontify-srcblocks}.
+
+
+@node Advanced topics in @acronym{ODT} export, , Literal examples in @acronym{ODT} export, OpenDocument Text export
+@subsection Advanced topics in @acronym{ODT} export
+
+If you rely heavily on @acronym{ODT} export, you may want to exploit the full
+set of features that the exporter offers. This section describes features
+that would be of interest to power users.
+
+@menu
+* Exporting and converting to other formats:: How to produce @samp{pdf} and other formats
+* Working with OpenDocument style files:: Explore the internals
+* Creating one-off styles:: How to produce custom highlighting etc
+* Customizing tables in @acronym{ODT} export:: How to define and use Table templates
+* Validating OpenDocument XML:: How to debug corrupt OpenDocument files
+@end menu
+
+@node Exporting and converting to other formats, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
+@subsubsection Exporting and converting to other formats
+@cindex convert
+@cindex doc, docx
+
+The @acronym{ODT} exporter adds support for exporting Org outlines to formats
+that are not supported natively by Org. It also adds support to convert
+document from one format to another. To use these features, you need to
+configure a command-line converter. Once a command-line converter is
+configured you can use it to extend the list of formats to which Org can
+export. @xref{x-export-to-other-formats,,Automatically exporting to other
+formats}. You can also use it to perform one-off document conversion as
+detailed below.
+
+@vindex org-export-odt-convert
+@table @kbd
+
+@item M-x org-export-odt-convert
+Convert an existing document from one format to another as determined by the
+variable @code{org-export-odt-convert-capabilities}
+(@pxref{x-odt-converter-capabilities,,Configure converter
+capabilities}). @strong{Please note} that you can use this command to even
+convert documents that are produced outside of Org and in other formats than
+@acronym{ODT} format.
+@end table
+
+@subsubheading Pre-configured converters
+
+@cindex converter
+The @acronym{ODT} exporter supports two converters out of the box:
+
+@enumerate
+
+@cindex @file{unoconv}
+@item @file{unoconv}
+
+This converter is available as an installable package in your favorite
+distribution.
+
+@cindex @file{BasicODConverter}
+@item @file{BasicODConverter}
+
+@vindex org-odt-data-dir
+This converter is distributed as a LibreOffice extension and can be found in
+your Org distribution. See the subdirectory pointed to by the variable
+@code{org-odt-data-dir}.
+
+@end enumerate
+
+@subsubheading Installing a new converter
+If you prefer to use a converter other than the two mentioned above, then you
+may have to do additional configuration. You can proceed as follows:
+
+@enumerate
+@item Register the converter
+
+@vindex org-export-odt-convert-processes
+Name your converter and add it to the list of known converters by customizing
+the variable @code{org-export-odt-convert-processes}. Also specify how the
+converter can be invoked via command-line to effect the conversion.
+
+@item Configure its capabilities
+@vindex org-export-odt-convert-capabilities
+
+@anchor{x-odt-converter-capabilities}
+
+Specify the set of formats the converter can handle by customizing the
+variable @code{org-export-odt-convert-capabilities}. Use the default value
+for this variable as a guide for configuring your converter. As suggested by
+the default setting, you can specify the full set of formats supported by the
+converter and not limit yourself to specifying formats that are related to
+just the OpenDocument Text format.
+
+@item Choose the converter
+
+@vindex org-export-odt-convert-process
+Select the newly added converter as the preferred one by customizing the
+variable @code{org-export-odt-convert-process}.
+@end enumerate
+
+@node Working with OpenDocument style files, Creating one-off styles, Exporting and converting to other formats, Advanced topics in @acronym{ODT} export
+@subsubsection Working with OpenDocument style files
+@cindex styles, custom
+@cindex template, custom
+
+This section explores the internals of the @acronym{ODT} exporter and the
+means by which it produces styled documents. Read this section if you are
+interested in exploring the automatic and custom OpenDocument styles used by
+the exporter.
+
+@anchor{x-factory-styles}
+@subsubheading Factory styles
+
+The @acronym{ODT} exporter relies on two files for generating its output.
+These files are bundled with the distribution under the directory pointed to
+by the variable @code{org-odt-styles-dir}. The two files are:
+
+@itemize
+@anchor{x-orgodtstyles-xml}
+@item
+@file{OrgOdtStyles.xml}
+
+This file contributes to the @file{styles.xml} file of the final @samp{ODT}
+document. This file gets modified for the following purposes:
+@enumerate
+
+@item
+To control outline numbering based on user settings.
+
+@item
+To add styles generated by @file{htmlfontify.el} for fontification of code
+blocks.
+@end enumerate
+
+@anchor{x-orgodtcontenttemplate-xml}
+@item
+@file{OrgOdtContentTemplate.xml}
+
+This file contributes to the @file{content.xml} file of the final @samp{ODT}
+document. The contents of the Org outline are inserted between the
+@samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
+
+Apart from serving as a template file for the final @file{content.xml}, the
+file serves the following purposes:
+@enumerate
+
+@item
+It contains automatic styles for formatting of tables which are referenced by
+the exporter.
+
+@item
+It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
+elements that control how various entities - tables, images, equations etc -
+are numbered.
+@end enumerate
+@end itemize
+
+@anchor{x-overriding-factory-styles}
+@subsubheading Overriding factory styles
+The following two variables control the location from which the @acronym{ODT}
+exporter picks up the custom styles and content template files. You can
+customize these variables to override the factory styles used by the
+exporter.
+
+@itemize
+@anchor{x-org-export-odt-styles-file}
+@item
+@code{org-export-odt-styles-file}
+
+Use this variable to specify the @file{styles.xml} that will be used in the
+final output. You can specify one of the following values:
+
+@enumerate
+@item A @file{styles.xml} file
+
+Use this file instead of the default @file{styles.xml}
+
+@item A @file{.odt} or @file{.ott} file
+
+Use the @file{styles.xml} contained in the specified OpenDocument Text or
+Template file
+
+@item A @file{.odt} or @file{.ott} file and a subset of files contained within them
+
+Use the @file{styles.xml} contained in the specified OpenDocument Text or
+Template file. Additionally extract the specified member files and embed
+those within the final @samp{ODT} document.
+
+Use this option if the @file{styles.xml} file references additional files
+like header and footer images.
+
+@item @code{nil}
+
+Use the default @file{styles.xml}
+@end enumerate
+
+@anchor{x-org-export-odt-content-template-file}
+@item
+@code{org-export-odt-content-template-file}
+
+Use this variable to specify the blank @file{content.xml} that will be used
+in the final output.
+@end itemize
+
+@node Creating one-off styles, Customizing tables in @acronym{ODT} export, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export
+@subsubsection Creating one-off styles
+
+There are times when you would want one-off formatting in the exported
+document. You can achieve this by embedding raw OpenDocument XML in the Org
+file. The use of this feature is better illustrated with couple of examples.
+
+@enumerate
+@item Embedding ODT tags as part of regular text
+
+You can include simple OpenDocument tags by prefixing them with
+@samp{@@}. For example, to highlight a region of text do the following:
+
+@example
+@@<text:span text:style-name="Highlight">This is a
+highlighted text@@</text:span>. But this is a
+regular text.
+@end example
+
+@strong{Hint:} To see the above example in action, edit your
+@file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
+custom @samp{Highlight} style as shown below.
+
+@example
+<style:style style:name="Highlight" style:family="text">
+ <style:text-properties fo:background-color="#ff0000"/>
+</style:style>
+@end example
+
+@item Embedding a one-line OpenDocument XML
+
+You can add a simple OpenDocument one-liner using the @code{#+ODT:}
+directive. For example, to force a page break do the following:
+
+@example
+#+ODT: <text:p text:style-name="PageBreak"/>
+@end example
+
+@strong{Hint:} To see the above example in action, edit your
+@file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
+custom @samp{PageBreak} style as shown below.
+
+@example
+<style:style style:name="PageBreak" style:family="paragraph"
+ style:parent-style-name="Text_20_body">
+ <style:paragraph-properties fo:break-before="page"/>
+</style:style>
+@end example
+
+@item Embedding a block of OpenDocument XML
+
+You can add a large block of OpenDocument XML using the
+@code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
+
+For example, to create a one-off paragraph that uses bold text, do the
+following:
+
+@example
+#+BEGIN_ODT
+<text:p text:style-name="Text_20_body_20_bold">
+This paragraph is specially formatted and uses bold text.
+</text:p>
+#+END_ODT
+@end example
+
+@end enumerate
+
+@node Customizing tables in @acronym{ODT} export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in @acronym{ODT} export
+@subsubsection Customizing tables in @acronym{ODT} export
+@cindex tables, in ODT export
+
+@cindex #+ATTR_ODT
+You can override the default formatting of the table by specifying a custom
+table style with the @code{#+ATTR_ODT} line. For a discussion on default
+formatting of tables @pxref{Tables in @acronym{ODT} export}.
+
+This feature closely mimics the way table templates are defined in the
+OpenDocument-v1.2
+specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
+OpenDocument-v1.2 Specification}}
+
+
+
+@subsubheading Custom table styles - an illustration
+
+To have a quick preview of this feature, install the below setting and export
+the table that follows.
+
+@lisp
+(setq org-export-odt-table-styles
+ (append org-export-odt-table-styles
+ '(("TableWithHeaderRowAndColumn" "Custom"
+ ((use-first-row-styles . t)
+ (use-first-column-styles . t)))
+ ("TableWithFirstRowandLastRow" "Custom"
+ ((use-first-row-styles . t)
+ (use-last-row-styles . t))))))
+@end lisp
+
+@example
+#+ATTR_ODT: TableWithHeaderRowAndColumn
+| Name | Phone | Age |
+| Peter | 1234 | 17 |
+| Anna | 4321 | 25 |
+@end example
+
+In the above example, you used a template named @samp{Custom} and installed
+two table styles with the names @samp{TableWithHeaderRowAndColumn} and
+@samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
+styles needed for producing the above template have been pre-defined for you.
+These styles are available under the section marked @samp{Custom Table
+Template} in @file{OrgOdtContentTemplate.xml}
+(@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
+additional templates you have to define these styles yourselves.
+
+@subsubheading Custom table styles - the nitty-gritty
+To use this feature proceed as follows:
+
+@enumerate
+@item
+Create a table template@footnote{See the @code{<table:table-template>}
+element of the OpenDocument-v1.2 specification}
+
+A table template is nothing but a set of @samp{table-cell} and
+@samp{paragraph} styles for each of the following table cell categories:
+
+@itemize @minus
+@item Body
+@item First column
+@item Last column
+@item First row
+@item Last row
+@item Even row
+@item Odd row
+@item Even column
+@item Odd Column
+@end itemize
+
+The names for the above styles must be chosen based on the name of the table
+template using a well-defined convention.
+
+The naming convention is better illustrated with an example. For a table
+template with the name @samp{Custom}, the needed style names are listed in
+the following table.
+
+@multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
+@headitem Table cell type
+@tab @code{table-cell} style
+@tab @code{paragraph} style
+@item
+@tab
+@tab
+@item Body
+@tab @samp{CustomTableCell}
+@tab @samp{CustomTableParagraph}
+@item First column
+@tab @samp{CustomFirstColumnTableCell}
+@tab @samp{CustomFirstColumnTableParagraph}
+@item Last column
+@tab @samp{CustomLastColumnTableCell}
+@tab @samp{CustomLastColumnTableParagraph}
+@item First row
+@tab @samp{CustomFirstRowTableCell}
+@tab @samp{CustomFirstRowTableParagraph}
+@item Last row
+@tab @samp{CustomLastRowTableCell}
+@tab @samp{CustomLastRowTableParagraph}
+@item Even row
+@tab @samp{CustomEvenRowTableCell}
+@tab @samp{CustomEvenRowTableParagraph}
+@item Odd row
+@tab @samp{CustomOddRowTableCell}
+@tab @samp{CustomOddRowTableParagraph}
+@item Even column
+@tab @samp{CustomEvenColumnTableCell}
+@tab @samp{CustomEvenColumnTableParagraph}
+@item Odd column
+@tab @samp{CustomOddColumnTableCell}
+@tab @samp{CustomOddColumnTableParagraph}
+@end multitable
+
+To create a table template with the name @samp{Custom}, define the above
+styles in the
+@code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
+of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
+styles}).
+
+@item
+Define a table style@footnote{See the attributes @code{table:template-name},
+@code{table:use-first-row-styles}, @code{table:use-last-row-styles},
+@code{table:use-first-column-styles}, @code{table:use-last-column-styles},
+@code{table:use-banding-rows-styles}, and
+@code{table:use-banding-column-styles} of the @code{<table:table>} element in
+the OpenDocument-v1.2 specification}
+
+@vindex org-export-odt-table-styles
+To define a table style, create an entry for the style in the variable
+@code{org-export-odt-table-styles} and specify the following:
+
+@itemize @minus
+@item the name of the table template created in step (1)
+@item the set of cell styles in that template that are to be activated
+@end itemize
+
+For example, the entry below defines two different table styles
+@samp{TableWithHeaderRowsAndColumns} and @samp{TableWithHeaderColumns} based
+on the same template @samp{Custom}. The styles achieve their intended effect
+by selectively activating the individual cell styles in that template.
+
+@lisp
+(setq org-export-odt-table-styles
+ (append org-export-odt-table-styles
+ '(("TableWithHeaderRowAndColumn" "Custom"
+ ((use-first-row-styles . t)
+ (use-first-column-styles . t)))
+ ("TableWithFirstRowandLastRow" "Custom"
+ ((use-first-row-styles . t)
+ (use-last-row-styles . t))))))
+@end lisp
+
+@item
+Associate a table with the table style
+
+To do this, specify the table style created in step (2) as part of
+the @code{ATTR_ODT} line as shown below.
+
+@example
+#+ATTR_ODT: TableWithHeaderRowAndColumn
+| Name | Phone | Age |
+| Peter | 1234 | 17 |
+| Anna | 4321 | 25 |
+@end example
+@end enumerate
+
+@node Validating OpenDocument XML, , Customizing tables in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
+@subsubsection Validating OpenDocument XML
+
+Occasionally, you will discover that the document created by the
+@acronym{ODT} exporter cannot be opened by your favorite application. One of
+the common reasons for this is that the @file{.odt} file is corrupt. In such
+cases, you may want to validate the document against the OpenDocument RELAX
+NG Compact Syntax (RNC) schema.
+
+For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
+nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
+general help with validation (and schema-sensitive editing) of XML files:
+@inforef{Introduction,,nxml-mode}.
+
+@vindex org-export-odt-schema-dir
+If you have ready access to OpenDocument @file{.rnc} files and the needed
+schema-locating rules in a single folder, you can customize the variable
+@code{org-export-odt-schema-dir} to point to that directory. The
+@acronym{ODT} exporter will take care of updating the
+@code{rng-schema-locating-files} for you.
+
+@c end opendocument
+
+@node TaskJuggler export, Freemind export, OpenDocument Text 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
+@code{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.
@table @kbd
@orgcmd{C-c C-e m,org-export-as-freemind}
-Export as Freemind mind map @file{myfile.mm}.
+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.
+does not interpret any additional Org mode features.
@table @kbd
@orgcmd{C-c C-e x,org-export-as-xoxo}
-Export as XOXO file @file{myfile.html}.
+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-scheduled
@vindex org-icalendar-categories
@vindex org-icalendar-alarm-time
-Some people use Org-mode for keeping track of projects, but still prefer a
+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,
* 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?
* Sitemap:: Generating a list of all pages
* Generating an index:: An index that reaches across pages
configures one project, and may be in one of the two following forms:
@lisp
- ("project-name" :property value :property value ...)
- @r{i.e. a well-formed property list with alternating keys and values}
+ ("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" ...))
@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
+@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}
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}, respectively @code{nil} and @code{t} in the
-@LaTeX{} export.
+@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},
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
+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
+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
or @code{org-publish-all}.
@item @code{:sitemap-filename}
-@tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
+@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.
+@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.
(default) or @code{last} to display folders first or last,
respectively. Any other value will mix files and folders.
-@item @code{:sitemap-alphabetically}
-@tab The site map is normally sorted alphabetically. Set this explicitly to
-@code{nil} to turn off sorting.
+@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.
+Org mode can generate an index across the files of a publishing project.
@multitable @columnfractions 0.25 0.75
@item @code{:makeindex}
publish it as @file{theindex.html}.
@end multitable
-The file will be create when first publishing a project with the
+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 built around this include statement by adding
-a title, style information etc.
+"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
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
+@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.
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
+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
+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
@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
+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
:table-of-contents nil
:style "<link rel=\"stylesheet\"
href=\"../other/mystyle.css\" type=\"text/css\"/>"
- :auto-preamble t
- :auto-postamble nil)
+ :html-preamble t)
("images"
:base-directory "~/images/"
@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
+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
@cindex Davison, Dan
@cindex source code, working with
-Source code can be included in Org-mode documents using a @samp{src} block,
-e.g.
+Source code can be included in Org mode documents using a @samp{src} block,
+e.g.@:
@example
#+BEGIN_SRC emacs-lisp
#+END_SRC
@end example
-Org-mode provides a number of features for working with live source code,
+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, tangling of code blocks, and exporting code blocks and their
+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.
+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
+* 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
+* 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
@section Structure of code blocks
@cindex code block, structure
@cindex source code, block structure
+@cindex #+NAME
+@cindex #+BEGIN_SRC
-The structure of code blocks is as follows:
+Live code blocks can be specified with a @samp{src} block or
+inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
+@ref{Easy Templates} system} The structure of a @samp{src} block is
@example
-#+srcname: <name>
-#+begin_src <language> <switches> <header arguments>
+#+NAME: <name>
+#+BEGIN_SRC <language> <switches> <header arguments>
<body>
-#+end_src
+#+END_SRC
@end example
-code blocks can also be embedded in text as so called inline code blocks as
+The @code{#+NAME:} line is optional, and can be used to name the code
+block. Live code blocks require that a language be specified on the
+@code{#+BEGIN_SRC} line. Switches and header arguments are optional.
+@cindex source code, inline
+
+Live code blocks can also be specified inline using
@example
src_<language>@{<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}).
+@item <#+NAME: name>
+This line associates a name with the code block. This is similar to the
+@code{#+TBLNAME: NAME} 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, from other files, or from Org mode
+table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
+and the behavior of Org mode when two or more blocks share the same name is
+undefined.
+@cindex #+NAME
@item <language>
-The language of the code in the block.
+The language of the code in the block (see @ref{Languages}).
+@cindex source code, language
@item <switches>
-Switches controlling exportation of the code block (see switches discussion in
+Optional switches control code block export (see the discussion of switches in
@ref{Literal examples})
+@cindex source code, switches
@item <header arguments>
Optional header arguments control many aspects of evaluation, export and
-tangling of code blocks. See the @ref{Header arguments}
-section. Header arguments can also be set on a per-buffer or per-subtree
+tangling of code blocks (see @ref{Header arguments}).
+Header arguments can also be set on a per-buffer or per-subtree
basis using properties.
+@item source code, header arguments
@item <body>
-The source code.
+Source code in the specified language.
@end table
@comment node-name, next, previous, up
@cindex source code, editing
@kindex C-c '
-Use @kbd{C-c '} to edit the current code block. This brings up
+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.
+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
+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
+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
+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.
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.
+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
@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}.
+It is possible to export the @emph{code} of code blocks, the @emph{results}
+of code block evaluation, @emph{both} the code and the results of code block
+evaluation, or @emph{none}. For most languages, the default exports code.
+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
+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
+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.
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
+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
@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
+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
@kindex C-c C-v t
@subsubheading Functions
@table @code
-@item org-babel-tangle
+@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}.
+Choose a file to tangle. Bound to @kbd{C-c C-v f}.
@end table
@subsubheading Hooks
@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.
+potential for that code to do harm. Org mode provides safeguards to ensure
+that code is only evaluated after explicit confirmation from the user. For
+information on these safeguards (and on how to disable them) see @ref{Code
+evaluation security}.} and the results of evaluation optionally placed in the
+Org mode buffer. By default, the evaluation facility is only enabled for
+Lisp code blocks specified as @code{emacs-lisp}. However, source code blocks
+in many languages can be evaluated within Org mode (see @ref{Languages} for a
+list of supported languages and @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
@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.
+its results into the Org mode buffer.
+@cindex #+CALL
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.
+Org mode buffer or an Org mode table. Live code blocks located in the current
+Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
+can be executed. Named code blocks can be executed with a separate
+@code{#+CALL:} line or inline within a block of text.
+
+The syntax of the @code{#+CALL:} line is
+
+@example
+#+CALL: <name>(<arguments>)
+#+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
+@end example
+
+The syntax for inline evaluation of named code blocks is
@example
-#+call: <name>(<arguments>) <header arguments>
-#+function: <name>(<arguments>) <header arguments>
-#+lob: <name>(<arguments>) <header arguments>
+... call_<name>(<arguments>) ...
+... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
@end example
@table @code
@item <name>
-The name of the code block to be evaluated.
+The name of the code block to be evaluated (see @ref{Structure of code blocks}).
@item <arguments>
-Arguments specified in this section will be passed to the code block.
-@item <header arguments>
-Header arguments can be placed after the function invocation. See
-@ref{Header arguments} for more information on header arguments.
+Arguments specified in this section will be passed to the code block. These
+arguments use standard function call syntax, rather than
+header argument syntax. For example, a @code{#+CALL:} line that passes the
+number four to a code block named @code{double}, which declares the header
+argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
+@item <inside header arguments>
+Inside header arguments are passed through and applied to the named code
+block. These arguments use header argument syntax rather than standard
+function call syntax. Inside header arguments affect how the code block is
+evaluated. For example, @code{[:results output]} will collect the results of
+everything printed to @code{STDOUT} during execution of the code block.
+@item <end header arguments>
+End header arguments are applied to the calling instance and do not affect
+evaluation of the named code block. They affect how the results are
+incorporated into the Org mode buffer and how the call line is exported. For
+example, @code{:results html} will insert the results of the call line
+evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
+
+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.
+The ``Library of Babel'' consists of code blocks that can be called from any
+Org mode file. 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).
+
+
+The central repository of code blocks in the ``Library of Babel'' is housed
+in an Org mode file located in the @samp{contrib} directory of Org mode.
+
+Users can add code blocks they believe to be generally useful to their
+``Library of Babel.'' The code blocks can be stored in any Org mode file and
+then loaded into the library with @code{org-babel-lob-ingest}.
-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
+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}.
@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 C @tab C
+@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 LaTeX @tab latex @tab MATLAB @tab matlab
+@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 Oz @tab oz
-@item Perl @tab perl @tab Python @tab python
+@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 GNU Screen @tab screen
-@item shell @tab sh @tab SQL @tab sql
-@item SQLite @tab sqlite
+@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
* 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
+* 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
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
+@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.
+Buffer-wide header arguments may be specified as properties through the use
+of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
+@ref{Property 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
inserted into the buffer.
@example
-#+BABEL: :session *R* :results silent
+#+PROPERTY: session *R*
+#+PROPERTY: 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
+@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
+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
+#+PROPERTY: tangle yes
@end example
+@vindex org-use-property-inheritance
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:
+with inheritance, regardless of the value of
+@code{org-use-property-inheritance}. In the following example 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 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.
+in Org mode documents.
-@node Code block specific header arguments, Header arguments in function calls, Header arguments in Org-mode properties, Using header arguments
+@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.
+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.
+preserved on export to HTML or @LaTeX{}.
@example
-#+source: factorial
-#+begin_src haskell :results silent :exports code :var n=0
+#+NAME: factorial
+#+BEGIN_SRC haskell :results silent :exports code :var n=0
fac 0 = 1
fac n = n * fac (n-1)
-#+end_src
+#+END_SRC
@end example
-Similarly, it is possible to set header arguments for inline code blocks:
+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 @code{#+HEADER:} or
+@code{#+HEADERS:} lines preceding a code block or nested between the
+@code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
+@cindex #+HEADER:
+@cindex #+HEADERS:
+
+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
+ #+NAME: 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 below:
+@code{#+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(n=5) :exports results
+#+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:
+Header arguments consist of an initial colon followed by the name of the
+argument in lowercase letters. The following header arguments are defined:
@menu
* var:: Pass arguments to code blocks
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
* 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, or the results of other code blocks.
+these are addressed in the language-specific documentation. However, the
+syntax used to specify arguments is the same across all languages. In every
+case, variables require a default value when they are declared.
+
+The values passed to arguments can either be literal values, references, or
+Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
+include anything in the Org mode file that takes a @code{#+NAME:},
+@code{#+TBLNAME:}, or @code{#+RESULTS:} line. This includes tables, lists,
+@code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
+code blocks.
-These values can be indexed in a manner similar to arrays---see the
-``indexable variable values'' heading below.
+Argument values can be indexed in a manner similar to arrays (see @ref{var,
+Indexable variable values}).
The following syntax is used to pass arguments to code blocks using the
@code{:var} header argument.
:var name=assign
@end example
-where @code{assign} can take one of the following forms
+The argument, @code{assign}, can either be a literal value, such as a string
+@samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
+literal example, another code block (with or without arguments), or the
+results of evaluating another code block.
-@itemize @bullet
-@item literal value
-either a string @code{"string"} or a number @code{9}.
-@item reference
-a table name:
+Here are examples of passing values by reference:
+
+@table @dfn
+@item table
+an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
@example
-#+tblname: example-table
+#+TBLNAME: example-table
| 1 |
| 2 |
| 3 |
| 4 |
-#+source: table-length
-#+begin_src emacs-lisp :var table=example-table
+#+NAME: table-length
+#+BEGIN_SRC emacs-lisp :var table=example-table
(length table)
-#+end_src
+#+END_SRC
#+results: table-length
: 4
@end example
-a code block name, as assigned by @code{#+srcname:}, followed by
-parentheses:
+@item list
+a simple list named with a @code{#+NAME:} line (note that nesting is not
+carried through to the source code block)
+
+@example
+#+NAME: example-list
+ - simple
+ - not
+ - nested
+ - list
+
+#+BEGIN_SRC emacs-lisp :var x=example-list
+ (print x)
+#+END_SRC
+
+#+results:
+| simple | list |
+@end example
+
+@item code block without arguments
+a code block name (from the example above), as assigned by @code{#+NAME:},
+optionally followed by parentheses
@example
-#+begin_src emacs-lisp :var length=table-length()
+#+BEGIN_SRC emacs-lisp :var length=table-length()
(* 2 length)
-#+end_src
+#+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:
+@item code block with arguments
+a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
+optional arguments passed within the parentheses following the
+code block name using standard function call syntax
@example
-#+source: double
-#+begin_src emacs-lisp :var input=8
+#+NAME: double
+#+BEGIN_SRC emacs-lisp :var input=8
(* 2 input)
-#+end_src
+#+END_SRC
#+results: double
: 16
-#+source: squared
-#+begin_src emacs-lisp :var input=double(input=1)
+#+NAME: squared
+#+BEGIN_SRC emacs-lisp :var input=double(input=1)
(* input input)
-#+end_src
+#+END_SRC
#+results: squared
: 4
@end example
-@end itemize
+
+@item literal example
+a literal example block named with a @code{#+NAME:} line
+
+@example
+#+NAME: literal-example
+#+BEGIN_EXAMPLE
+A literal example
+on two lines
+#+END_EXAMPLE
+
+#+NAME: read-literal-example
+#+BEGIN_SRC emacs-lisp :var x=literal-example
+ (concatenate 'string x " for you.")
+#+END_SRC
+
+#+results: read-literal-example
+: A literal example
+: on two lines for you.
+
+@end example
+
+@end table
@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,
+using the @code{#+NAME:} line of a code block. As in the following
+example, arguments can be packed inside of parentheses, separated by commas,
following the source name.
@example
-#+source: double(input=0, x=2)
-#+begin_src emacs-lisp
+#+NAME: double(input=0, x=2)
+#+BEGIN_SRC emacs-lisp
(* 2 (+ input x))
-#+end_src
+#+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. The
+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
+#+NAME: example-table
| 1 | a |
| 2 | b |
| 3 | c |
| 4 | d |
-#+begin_src emacs-lisp :var data=example-table[0,-1]
+#+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
data
-#+end_src
+#+END_SRC
#+results:
: a
to @code{data}.
@example
-#+results: example-table
+#+NAME: example-table
| 1 | a |
| 2 | b |
| 3 | c |
| 4 | d |
| 5 | 3 |
-#+begin_src emacs-lisp :var data=example-table[1:3]
+#+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
data
-#+end_src
+#+END_SRC
#+results:
| 2 | b |
column is referenced.
@example
-#+results: example-table
+#+NAME: example-table
| 1 | a |
| 2 | b |
| 3 | c |
| 4 | d |
-#+begin_src emacs-lisp :var data=example-table[,0]
+#+BEGIN_SRC emacs-lisp :var data=example-table[,0]
data
-#+end_src
+#+END_SRC
#+results:
| 1 | 2 | 3 | 4 |
another by commas, as shown in the following example.
@example
-#+source: 3D
-#+begin_src emacs-lisp
+#+NAME: 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
+#+END_SRC
-#+begin_src emacs-lisp :var data=3D[1,,1]
+#+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
data
-#+end_src
+#+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
+#+NAME: 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}
@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
+Org mode buffer
@item
@b{handling} header arguments specify how the results of evaluating the code
block should be handled.
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}.
+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
@itemize @bullet
@item @code{table}, @code{vector}
-The results should be interpreted as an Org-mode table. If a single value is
+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
+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
+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}.
+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
+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}.
+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.
+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.
+Result are assumed to be parsable 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
@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}.
+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.,
+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
@node file, dir, results, Specific header arguments
@subsubsection @code{:file}
-The header argument @code{:file} is used to specify a path for file output.
-An Org-mode style @code{file:} link is inserted into the buffer as the result
-(see @ref{Link format}). Common examples are graphical output from R,
-gnuplot, ditaa and LaTeX code blocks.
-
-Note that for some languages, including R, gnuplot, LaTeX and ditaa,
-graphical output is sent to the specified file without the file being
-referenced explicitly in the code block. See the documentation for the
-individual languages for details. In contrast, general purpose languages such
-as Python and Ruby require that the code explicitly create output
-corresponding to the path indicated by @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
+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
+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
+(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
+#+BEGIN_SRC R :file myplot.png :dir ~/Work
matplot(matrix(rnorm(100), 10), type="l")
-#+end_src
+#+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
+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:
+#+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
plot(1:10, main=system("hostname", intern=TRUE))
-#+end_src
+#+END_SRC
@end example
-Text results will be returned to the local Org-mode buffer as usual, and file
+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
+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,
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
+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
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
+@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
+links inserted into the buffer will @emph{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
@subsubsection @code{:exports}
The @code{:exports} header argument specifies what should be included in HTML
-or LaTeX exports of the Org-mode file.
+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.,
+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.,
+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, comments, exports, Specific header arguments
+@node tangle, mkdirp, exports, Specific header arguments
@subsubsection @code{:tangle}
The @code{:tangle} header argument specifies whether or not the code
@itemize @bullet
@item @code{tangle}
-The code block is exported to a source code file named after the
-basename (name w/o extension) of the Org-mode file. E.g., @code{:tangle
-yes}.
+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 file basename to which the block will be exported. E.g., @code{:tangle
-basename}.
+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 comments, no-expand, tangle, Specific header arguments
+@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
@item @code{yes}
A synonym for ``link'' to maintain backwards compatibility.
@item @code{org}
-Include text from the org-mode file as a comment.
+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, comments, Specific header arguments
+@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}
a name. This makes it possible to run concurrent sessions for each
interpreted language.
-@node noweb, cache, session, Specific header arguments
+@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}.
+argument can have one of three values: @code{yes}, @code{no}, or @code{tangle}.
@itemize @bullet
@item @code{yes}
be affected by this change, so it is still possible to use inline noweb
references.
-@node cache, hlines, noweb, Specific header arguments
+@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@footnote{(The example needs property inheritance
+to be turned on for the @code{noweb-ref} property, see @ref{Property
+inheritance}).}.
+
+@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
+
+ ** strip the header row
+ #+BEGIN_SRC sh
+ |sed '1d' \
+ #+END_SRC
+
+ ** sort by the percent full
+ #+BEGIN_SRC sh
+ |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
+ #+END_SRC
+
+ ** extract the mount point
+ #+BEGIN_SRC sh
+ |awk '@{print $2@}'
+ #+END_SRC
+@end example
+
+@node cache, sep, noweb-ref, Specific header arguments
@subsubsection @code{:cache}
The @code{:cache} header argument controls the use of in-buffer caching of
changed since the last time it was evaluated, it will not be re-evaluated.
@end itemize
-@node hlines, colnames, cache, Specific header arguments
+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.
+
+@example
+ #+NAME: random
+ #+BEGIN_SRC R :cache yes
+ runif(1)
+ #+END_SRC
+
+ #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
+ 0.4659510825295
+
+ #+NAME: caller
+ #+BEGIN_SRC emacs-lisp :var x=random :cache yes
+ x
+ #+END_SRC
+
+ #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
+ 0.254227238707244
+@end example
+
+@node sep, hlines, cache, Specific header arguments
+@subsubsection @code{:sep}
+
+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.
+
+By default, when @code{:sep} is not specified output tables are tab
+delimited.
+
+@node hlines, colnames, sep, Specific header arguments
@subsubsection @code{:hlines}
Tables are frequently represented with one or more horizontal lines, or
default value yields the following results.
@example
-#+tblname: many-cols
+#+TBLNAME: many-cols
| a | b | c |
|---+---+---|
| d | e | f |
|---+---+---|
| g | h | i |
-#+source: echo-table
-#+begin_src python :var tab=many-cols
+#+NAME: echo-table
+#+BEGIN_SRC python :var tab=many-cols
return tab
-#+end_src
+#+END_SRC
#+results: echo-table
| a | b | c |
@end example
@item @code{yes}
-Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
+Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
@example
-#+tblname: many-cols
+#+TBLNAME: many-cols
| a | b | c |
|---+---+---|
| d | e | f |
|---+---+---|
| g | h | i |
-#+source: echo-table
-#+begin_src python :var tab=many-cols :hlines yes
+#+NAME: echo-table
+#+BEGIN_SRC python :var tab=many-cols :hlines yes
return tab
-#+end_src
+#+END_SRC
#+results: echo-table
| a | b | c |
The @code{:colnames} header argument accepts the values @code{yes},
@code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
+Note that the behavior of the @code{:colnames} header argument may differ
+across languages. For example Emacs Lisp code blocks ignore the
+@code{:colnames} header argument entirely given the ease with which tables
+with column names may be handled directly in Emacs Lisp.
@itemize @bullet
@item @code{nil}
processing, then reapplied to the results.
@example
-#+tblname: less-cols
+#+TBLNAME: less-cols
| a |
|---|
| b |
| c |
-#+srcname: echo-table-again
-#+begin_src python :var tab=less-cols
+#+NAME: echo-table-again
+#+BEGIN_SRC python :var tab=less-cols
return [[val + '*' for val in row] for row in tab]
-#+end_src
+#+END_SRC
#+results: echo-table-again
| a |
| c* |
@end example
+Please note that column names are not removed before the table is indexed
+using variable indexing @xref{var, Indexable variable values}.
+
@item @code{no}
No column name pre-processing takes place
@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
+does not ``look like'' it has column names (i.e.@: the second row is not an
hline)
@end itemize
and is then reapplied to the results.
@example
-#+tblname: with-rownames
+#+TBLNAME: with-rownames
| one | 1 | 2 | 3 | 4 | 5 |
| two | 6 | 7 | 8 | 9 | 10 |
-#+srcname: echo-table-once-again
-#+begin_src python :var tab=with-rownames :rownames yes
+#+NAME: 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
+#+END_SRC
#+results: echo-table-once-again
| one | 11 | 12 | 13 | 14 | 15 |
| two | 16 | 17 | 18 | 19 | 20 |
@end example
+
+Please note that row names are not removed before the table is indexed using
+variable indexing @xref{var, Indexable variable values}.
+
@end itemize
@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
+(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.
+specific code blocks. The @code{:eval} header argument can be useful for
+protecting against the evaluation of dangerous code blocks or to ensure that
+evaluation will require a query regardless of the value of the
+@code{org-confirm-babel-evaluate} variable. The possible values of
+@code{:eval} and their effects are shown below.
+
+@table @code
+@item never or no
+The code block will not be evaluated under any circumstances.
+@item query
+Evaluation of the code block will require a query.
+@item never-export or no-export
+The code block will not be evaluated during export but may still be called
+interactively.
+@item query-export
+Evaluation of the code block during export will require a query.
+@end table
+
+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
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 possibilities:
+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}
@end multitable
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
+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
+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
+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.
@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
+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 the interpreter running as an interactive Emacs
-inferior process. 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).
+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
+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:
+process. For example, compare the following two blocks:
@example
-#+begin_src python :results output
+#+BEGIN_SRC python :results output
print "hello"
2
print "bye"
-#+end_src
+#+END_SRC
-#+resname:
+#+results:
: hello
: bye
@end example
In non-session mode, the `2' is not printed and does not appear.
@example
-#+begin_src python :results output :session
+#+BEGIN_SRC python :results output :session
print "hello"
2
print "bye"
-#+end_src
+#+END_SRC
-#+resname:
+#+results:
: 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
+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
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.
+expanded before evaluation. See the @ref{noweb-ref} header argument for
+a more flexible way to resolve noweb references.
Note: the default value, @code{:noweb no}, was chosen to ensure that
correct code is not broken in a language, such as Ruby, where
syntactically valid in languages that you use, then please consider setting
the default value.
+Note: if noweb tangling is slow in large Org-mode files consider setting the
+@code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
+This will result in faster noweb reference resolution at the expense of not
+correctly resolving inherited values of the @code{:noweb-ref} header
+argument.
+
@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
+Many common Org mode key sequences are re-bound depending on
the context.
Within a code block, the following key bindings
@multitable @columnfractions 0.25 0.75
@kindex C-c C-c
-@item @kbd{C-c C-c} @tab org-babel-execute-src-block
+@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 org-babel-open-src-block-result
+@item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
@kindex C-up
-@item @kbd{C-@key{up}} @tab org-babel-load-in-session
+@item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
@kindex M-down
-@item @kbd{M-@key{down}} @tab org-babel-pop-to-session
+@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:
+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 org-babel-sha1-hash
+@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 org-babel-execute-buffer
+@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 org-babel-tangle-file
+@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 org-babel-goto-named-source-block
+@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 org-babel-describe-bindings
+@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 org-babel-lob-ingest
+@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 org-babel-expand-src-block
+@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 org-babel-execute-subtree
+@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 org-babel-tangle
+@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 org-babel-switch-to-session
+@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
@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 org-babel-sha1-hash
-@c @item @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
-@c @item @kbd{C-c C-v C-f} @tab org-babel-tangle-file
-@c @item @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
-@c @item @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
-@c @item @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
-@c @item @kbd{C-c C-v C-t} @tab org-babel-tangle
-@c @item @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
+@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
* 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
@cindex tag completion
@cindex link abbreviations, completion of
-Emacs would not be Emacs without completion, and Org-mode uses it whenever it
+Emacs would not be Emacs without completion, and Org mode uses it whenever it
makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
some of the completion prompts, you can specify your preference by setting at
most one of the variables @code{org-completion-use-iswitchb}
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
@cindex template insertion
@cindex insertion, of templates
-Org-mode supports insertion of empty structural elements (like
+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
@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{#+include:} line
+@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
+@code{org-structure-template-alist}. See the docstring of the variable for
additional details.
@node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
@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
which take off the default security brakes.
@defopt org-confirm-babel-evaluate
-When set to t user is queried before code block evaluation
+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
@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
@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
@cindex @code{indent}, STARTUP keyword
@cindex @code{noindent}, STARTUP keyword
Dynamic virtual indentation is controlled by the variable
-@code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
+@code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
@example
indent @r{start with @code{org-indent-mode} turned on}
noindent @r{start with @code{org-indent-mode} turned off}
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
@item
If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
block is updated.
+@item
+If the cursor is at a timestamp, fix the day name in the timestamp.
@end itemize
@node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
@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
+Org mode can make use of the CD@LaTeX{} 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
@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.
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
+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.
@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
+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.
@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
+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:
(add-hook 'org-mode-hook
(lambda ()
(org-set-local 'yas/trigger-key [tab])
- (define-key yas/keymap [tab] 'yas/next-field-group)))
+ (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
+@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. If you want make
-the windmove function active in locations where Org-mode does not have
+the windmove function active in locations where Org mode does not have
special functionality on @kbd{S-@key{cursor}}, add this to your
configuration:
@cindex @file{viper.el}
@kindex C-c /
Viper uses @kbd{C-c /} and therefore makes this key not access the
-corresponding Org-mode command @code{org-sparse-tree}. You need to find
+corresponding Org mode command @code{org-sparse-tree}. You need to find
another key for this command, or override the key in
@code{viper-vi-global-user-map} with
@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
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/}.
buffer with @kbd{C-c C-l}.
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)
+@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.
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
-@footnote{@file{org-R.el} has been replaced by the org-mode functionality
+@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:}.
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
frequent feature request has been to make it work with native tables in
specific languages, for example @LaTeX{}. However, this is extremely
hard to do in a general way, would lead to a customization nightmare,
-and would take away much of the simplicity of the Orgtbl-mode table
+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
@menu
* Radio tables:: Sending and receiving radio tables
-* A LaTeX example:: Step by step, almost a tutorial
+* A @LaTeX{} example:: Step by step, almost a tutorial
* Translator functions:: Copy and modify
* Radio lists:: Doing the same for lists
@end menu
-@node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
+@node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
@subsection Radio tables
@cindex radio tables
@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
key.
@end itemize
-@node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
+@node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
@subsection A @LaTeX{} example of radio tables
@cindex @LaTeX{}, and Orgtbl mode
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
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.
supplied instead of strings.
@end table
-@node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
+@node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
@subsection Translator functions
@cindex HTML, and Orgtbl mode
@cindex translator function
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 @LaTeX{} translator, but wanted the line endings to
be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
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
+@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{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.
+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 'todo '("TODO" "WAITING"))
+@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)
+@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)
+@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-span month \
+ org-agenda-span (quote month) \
org-agenda-include-diary nil \
org-agenda-files (quote ("~/org/project.org")))' \
| lpr
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}
@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
+@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}
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
+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
@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.php#mobileorg_webdav, FAQ entry}.}.
+@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:
(setq org-mobile-directory "~/Dropbox/MobileOrg")
@end lisp
-Org-mode has commands to put files for @i{MobileOrg} into that directory,
+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
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
+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
+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
@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
+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
@i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
@item
@i{Christophe Bataillon} created the great unicorn logo that we use on the
-Org-mode website.
+Org mode website.
@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.
+@i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
@item
@i{Tom Breton} wrote @file{org-choose.el}.
@item
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.
+@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.
@i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
chapter about publishing.
@item
-@i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and
-enabled source code highlighling in Gnus.
+@i{Jambunathan K} contributed the @acronym{ODT} 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
@item
@i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
and contributed various ideas and code snippets.
+@item
@end itemize