@setfilename ../../info/org
@settitle The Org Manual
-@set VERSION 7.4
-@set DATE December 2010
+@set VERSION 7.7
+@set DATE July 2011
@c Use proper quote and backtick for code sections in PDF output
@c Cf. Texinfo manual 14.2
@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 orgcmdnki{key,cmd} Like orgcmd, but do not index the key
@copying
This manual is for Org version @value{VERSION}.
-Copyright @copyright{} 2004-2011 Free Software Foundation, Inc.
+Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
+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
* 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
* 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
* HTML export:: Exporting to HTML
* LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
* DocBook export:: Exporting to DocBook
+* OpenDocumentText export:: Exporting to OpenDocumentText
* TaskJuggler export:: Exporting to TaskJuggler
* Freemind export:: Exporting to Freemind mind maps
* XOXO export:: Exporting to XOXO
HTML export
* HTML Export commands:: How to invoke HTML export
+* 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 DocBook export:: How to insert figures into DocBook output
* Special characters:: How to handle special characters
+OpenDocument export
+
+* OpenDocumentText export commands:: How to invoke OpenDocumentText export
+* Applying Custom Styles:: How to apply custom styles to the output
+* Converting to Other formats:: How to convert to formats like doc, docx etc
+* Links in OpenDocumentText export:: How links will be interpreted and formatted
+* Tables in OpenDocumentText export:: How Tables are handled
+* Images in OpenDocumentText export:: How to insert figures
+* Additional Documentation:: How to handle special characters
+
Publishing
* Configuration:: Defining projects
* Sources and destinations:: From here to there
* Selecting files:: What files are part of the project?
* Publishing action:: Setting the function doing the publishing
-* Publishing options:: Tweaking HTML export
+* Publishing options:: Tweaking HTML/@LaTeX{} export
* Publishing links:: Which links keep working after publishing?
* Sitemap:: Generating a list of all pages
* Generating an index:: An index that reaches across pages
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
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
@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
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
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}
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
@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.
@kindex M-S-@key{RET}
@item M-S-@key{RET}
Insert a new item with a checkbox (@pxref{Checkboxes}).
@itemx S-@key{down}
@cindex shift-selection-mode
@vindex org-support-shift-select
-Jump to the previous/next item in the current list, but only if
+@vindex org-list-use-circular-motion
+Jump to the previous/next item in the current list@footnote{If you want to
+cycle around items that way, you may customize
+@code{org-list-use-circular-motion}.}, but only if
@code{org-support-shift-select} is off. If not, you can still use paragraph
jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
similar effect.
-@kindex M-S-@key{up}
-@kindex M-S-@key{down}
-@item M-S-@key{up}
-@itemx M-S-@key{down}
-Move the item including subitems up/down (swap with previous/next item
-of same indentation). If the list is ordered, renumbering is
-automatic.
+@kindex M-@key{up}
+@kindex M-@key{down}
+@item M-@key{up}
+@itemx M-@key{down}
+Move the item including subitems up/down@footnote{See
+@code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
+previous/next item of same indentation). If the list is ordered, renumbering
+is automatic.
@kindex M-@key{left}
@kindex M-@key{right}
@item M-@key{left}
@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}
** 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
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
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}
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
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 *
If you want the recalculation of fields to happen automatically, or if
you want to be able to assign @i{names} to fields and columns, you need
to reserve the first column of the table for special marking characters.
+
@table @kbd
@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
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>>
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%20links @r{Info node link (with encoded space)}
shell:ls *.org @r{A shell command}
elisp:org-agenda @r{Interactive Elisp command}
elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
@end example
+For customizing Org to add new link types @ref{Adding hyperlink types}.
+
A link should be enclosed in double brackets and may contain a
descriptive text to be displayed instead of the URL (@pxref{Link
format}), for example:
@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 @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
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.
@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
* Parent
:PROPERTIES:
- :ORDERED: t
+ :ORDERED: t
:END:
** TODO a
** TODO b, needs to wait for (a)
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.
@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
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
@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
@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}
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
@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
@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
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}
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
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
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
know enough about the internals of each sexp function to issue early and
@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
@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
@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}
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 ;
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.
+timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everwhere 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
@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.
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.
@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
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 allways 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
You can then go ahead and define anniversaries for a BBDB record. Basically,
you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
-record and then add the date in the format @code{YYYY-MM-DD}, followed by a
-space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
-a format string). If you omit the class, it will default to @samp{birthday}.
-Here are a few examples, the header for the file @file{org-bbdb.el} contains
-more detailed information.
+record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
+followed by a space and the class of the anniversary (@samp{birthday} or
+@samp{wedding}, or a format string). If you omit the class, it will default to
+@samp{birthday}. Here are a few examples, the header for the file
+@file{org-bbdb.el} contains more detailed information.
@example
1973-06-22
+06-22
1955-08-02 wedding
2008-04-14 %s released version 6.01 of org-mode, %d years ago
@end example
the appointments of your agenda files, use the command
@code{org-agenda-to-appt}. This command also lets you filter through the
list of your appointments and add only those belonging to a specific category
-or matching a regular expression. See the docstring for details.
+or matching a regular expression. See the docstring for details.
@node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
@subsection The global TODO list
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.
@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
@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
@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}
@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.
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.}.
@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
@vindex org-agenda-entry-text-maxlines
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}
@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.
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
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
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
#+OPTIONS: skip:t
#+TEXT: This text will go before the *first* headline.
#+TEXT: [TABLE-OF-CONTENTS]
-#+TEXT: This goes between the table of contents and the first headline
+#+TEXT: This goes between the table of contents and the *first* headline
@end example
@node Lists, Paragraphs, Initial text, Structural markup elements
@cindex footnotes, markup rules
@cindex @file{footnote.el}
-Footnotes defined in the way described in @ref{Footnotes}, will be exported by
-all backends. Org allows multiple references to the same note, and
-different backends support this to varying degrees.
+Footnotes defined in the way described in @ref{Footnotes}, will be exported
+by all backends. Org allows multiple references to the same note, and
+multiple footnotes side by side.
@node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
@subheading Emphasis and monospace
@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.
|-----|----|
@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
the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
which is distributed with Org). Fontified code chunks in LaTeX can be
achieved using either the listings or the
-@url{http://code.google.com/p/minted, minted,} package. To use listings, turn
+@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
@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.}:
@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.
@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
#+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 '
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.
@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
@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.
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. OpenDocumentText export allows seamless colloboration 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).
* HTML export:: Exporting to HTML
* LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
* DocBook export:: Exporting to DocBook
+* OpenDocumentText export:: Exporting to OpenDocumentText
* TaskJuggler export:: Exporting to TaskJuggler
* Freemind export:: Exporting to Freemind mind maps
* XOXO export:: Exporting to XOXO
@node Selective export, Export options, Exporting, Exporting
@section Selective export
-@cindex export, selective by tags
+@cindex export, selective by tags or TODO keyword
@vindex org-export-select-tags
@vindex org-export-exclude-tags
+@cindex org-export-with-tasks
You may use tags to select the parts of a document that should be exported,
or to exclude parts from export. This behavior is governed by two variables:
@code{org-export-select-tags} and @code{org-export-exclude-tags}.
-Org first checks if any of the @emph{select} tags is present in the buffer.
-If yes, all trees that do not carry one of these tags will be excluded. If a
-selected tree is a subtree, the heading hierarchy above it will also be
-selected for export, but not the text below those headings.
+@enumerate
+@item
+Org first checks if any of the @emph{select} tags is present in the
+buffer. If yes, all trees that do not carry one of these tags will be
+excluded. If a selected tree is a subtree, the heading hierarchy above it
+will also be selected for export, but not the text below those headings.
-@noindent
+@item
If none of the select tags is found, the whole buffer will be selected for
export.
-@noindent
+@item
Finally, all subtrees that are marked by any of the @emph{exclude} tags will
be removed from the export buffer.
+@end enumerate
+
+The variable @code{org-export-with-tasks} can be configured to select which
+kind of tasks should be included for export. See the docstring of the
+variable for more information.
@node Export options, The export dispatcher, Selective export, Exporting
@section Export options
#+AUTHOR: the author (default taken from @code{user-full-name})
#+DATE: a date, fixed, or a format string for @code{format-time-string}
#+EMAIL: his/her email address (default from @code{user-mail-address})
-#+DESCRIPTION: the page description, e.g. for the XHTML meta tag
-#+KEYWORDS: the page keywords, e.g. for the XHTML meta tag
-#+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
+#+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
+#+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
+#+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
#+TEXT: Some descriptive text to be inserted at the beginning.
#+TEXT: Several lines may be given.
#+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
-#+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
+#+BIND: lisp-var lisp-val, e.g.@:: org-export-latex-low-levels itemize
@r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
#+LINK_UP: the ``up'' link of an exported page
#+LINK_HOME: the ``home'' link of an exported page
@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
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
@menu
* HTML Export commands:: How to invoke HTML export
+* 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
* 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.
@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
@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
p.creator @r{creator info, about org-mode version}
.title @r{document title}
.todo @r{TODO keywords, all not-done states}
-.done @r{the DONE keywords, all stated the count as done}
+.done @r{the DONE keywords, all states that count as done}
.WAITING @r{each TODO keyword also uses a class named after itself}
.timestamp @r{timestamp}
.timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
@code{org-export-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
@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
@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}
@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
@subsection Images in @LaTeX{} export
@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{}.
For more information, see the documentation on Worg.
-@node DocBook export, TaskJuggler export, LaTeX and PDF export, Exporting
+@node DocBook export, OpenDocumentText 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
"
@end example
-@node TaskJuggler export, Freemind export, DocBook export, Exporting
+@c begin opendocument
+
+@node OpenDocumentText export, TaskJuggler export, DocBook export, Exporting
+@section OpenDocumentText export
+@cindex OpenDocumentText export
+@cindex K, Jambunathan
+
+Org-mode 7.6 supports export to OpenDocumentText format using
+@file{org-odt.el} module contributed by Jambunathan K. This module can be
+enabled in one of the following ways based on your mode of installation.
+
+@enumerate
+@item
+If you have downloaded the Org from the Web, either as a distribution
+@file{.zip} or @file{.tar} file, or as a Git archive, enable the @code{odt}
+option in variable @code{org-modules}.
+@item
+If you are using Org that comes bundled with Emacs, then you can install the
+OpenDocumentText exporter using the package manager. To do this, customize
+the variable @code{package-archives} to include
+@uref{http://orgmode.org/pkg/releases/} as one of the package archives.
+@end enumerate
+
+@menu
+* OpenDocumentText export commands::How to invoke OpenDocumentText export
+* Applying Custom Styles:: How to apply custom styles to the output
+* Converting to Other formats:: How to convert to formats like doc, docx etc
+* Links in OpenDocumentText export:: How links will be interpreted and formatted
+* Tables in OpenDocumentText export:: Tables are exported as HTML tables
+* Images in OpenDocumentText export:: How to insert figures into DocBook output
+* Additional Documentation:: Where to find more information
+@end menu
+
+@node OpenDocumentText export commands, Applying Custom Styles, OpenDocumentText export, OpenDocumentText export
+@subsection OpenDocumentText export commands
+
+@cindex region, active
+@cindex active region
+@cindex transient-mark-mode
+@table @kbd
+@orgcmd{C-c C-e o,org-export-as-odt}
+@cindex property EXPORT_FILE_NAME
+Export as OpenDocumentText file. For an Org file, @file{myfile.org}, the
+OpenDocumentText file will be @file{myfile.odt}. The file will be
+overwritten without warning. If there is an active region@footnote{This
+requires @code{transient-mark-mode} to be turned on}, only the region will be
+exported. If the selected region is a single tree@footnote{To select the
+current subtree, use @kbd{C-c @@}.}, the tree head will become the document
+title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
+property, that name will be used for the export.
+@orgcmd{C-c C-e O,org-export-as-odt-and-open}
+Export as OpenDocumentText file and open the resulting file.
+@end table
+
+@node Applying Custom Styles, Converting to Other formats, OpenDocumentText export commands, OpenDocumentText export
+@subsection Applying Custom Styles
+@cindex styles, custom
+@cindex template, custom
+
+@vindex org-export-odt-styles-file
+
+OpenDocumentExporter ships with a custom @file{styles.xml} for formatting of
+the exported file. To customize the output to suit your needs you can use
+one of the following methods:
+
+@enumerate
+@item
+Customize the variable @code{org-export-odt-styles-file} to point to either a
+@file{styles.xml} file, a OpenDocument Text Template file @code{.ott} or a
+combination of Text or Template Document together with a set of member files.
+Use the first two options if the styles.xml has no references to additional
+set of files and use the last option if the @file{styles.xml} references
+additional files like header and footer images.
+@item
+Use an external tool like unoconv to apply custom templates.
+@end enumerate
+
+For best results, it is necessary that the style names used by
+OpenDocumentText exporter match that used in the @file{styles.xml}.
+
+@node Converting to Other formats, Links in OpenDocumentText export, Applying Custom Styles, OpenDocumentText export
+@subsection Converting to Other formats
+
+@cindex convert
+@cindex doc, docx
+
+@vindex org-export-odt-styles-file
+
+Often times there is a need to convert OpenDocumentText files to other
+formats like doc, docx or pdf. You can accomplish this by one of the
+following methods:
+
+@table @kbd
+@item M-x org-lparse
+Export the outline first to one of the native formats (like OpenDocumentText)
+and immediately post-process it to other formats using an external converter.
+
+@item M-x org-lparse-convert
+Export an existing document to other formats using an external converter.
+@end table
+
+You can choose the converter used for conversion by customizing the variable
+@code{org-lparse-convert-process}.
+
+@node Links in OpenDocumentText export, Tables in OpenDocumentText export, Converting to Other formats, OpenDocumentText export
+@subsection Links in OpenDocumentText export
+@cindex tables, in DocBook export
+
+OpenDocumentExporter creates cross-references (aka bookmarks) for links that
+are destined locally. It creates internet style links for all other links.
+
+@node Tables in OpenDocumentText export, Images in OpenDocumentText export, Links in OpenDocumentText export, OpenDocumentText export
+@subsection Tables in OpenDocumentText export
+@cindex tables, in DocBook export
+
+Export of @file{table.el} tables with row or column spanning is not
+supported. Such tables are stripped from the exported document.
+
+@node Images in OpenDocumentText export, Additional Documentation, Tables in OpenDocumentText export, OpenDocumentText export
+@subsection Images in OpenDocumentText export
+@cindex images, embedding in OpenDocumentText
+@cindex embedding images in OpenDocumentText
+
+OpenDocumentText exporter can embed images within the exported document. To
+embed images, provide a link to the desired image file with no link
+description. For example, the following links @samp{[[file:img.jpg]]} or
+@samp{[[./img.jpg]]}, will result in embedding of @samp{img.jpg} in the
+exported file.
+
+The exporter can also embed scaled and explicitly sized images within the
+exported document. The markup of the scale and size specifications has not
+been standardized yet and is hence conveniently skipped in this document.
+
+The exporter can also make an image the clickable part of a link. To create
+clickable images, provide a link whose description is a link to an image
+file. For example, the following link
+@samp{[[http://orgmode.org][./img.jpg]]}, will result in a clickable image
+that links to @uref{http://Orgmode.org} website.
+
+@node Additional Documentation, , Images in OpenDocumentText export, OpenDocumentText export
+@subsection Additional documentation
+
+The OpenDocumentText exporter is still in development. For up to date
+information, please follow Org mailing list @email{emacs-orgmode@@gnu.org}
+closely.
+
+@c end opendocument
+
+@node TaskJuggler export, Freemind export, OpenDocumentText export, Exporting
@section TaskJuggler export
@cindex TaskJuggler export
@cindex Project management
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
+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 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's easiest to do this in the column view). You
+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
+@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
+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
+@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
+@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
@subsection Export of properties
-The exporter also takes TODO state information into consideration, i.e. if a
+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
+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
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}
+@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
+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
:END:
** Markup Guidelines
:PROPERTIES:
- :Effort: 2.0
+ :Effort: 2d
:END:
** Workflow Guidelines
:PROPERTIES:
- :Effort: 2.0
+ :Effort: 2d
:END:
* Presentation
:PROPERTIES:
- :Effort: 2.0
+ :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
+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.php}.
+@uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
@node Freemind export, XOXO export, TaskJuggler export, Exporting
@section Freemind export
@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
@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
* 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 formated 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 formated 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 formated. 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
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
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 source code, working with
Source code can be included in Org-mode documents using a @samp{src} block,
-e.g.
+e.g.@:
@example
#+BEGIN_SRC emacs-lisp
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.
#+end_src
@end example
-code blocks can also be embedded in text as so called inline code blocks as
+Switches and header arguments are optional. Code can also be embedded in text
+inline using
@example
src_<language>@{<body>@}
@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}).
+formulas (see @ref{The spreadsheet}). Names are assumed to be unique by
+evaluation functions and the behavior of multiple blocks of the same name is
+undefined.
@item <language>
The language of the code in the block.
@item <switches>
-Switches controlling exportation of the code block (see switches discussion in
+Optional switches controlling exportation of the code block (see switches discussion in
@ref{Literal examples})
@item <header arguments>
Optional header arguments control many aspects of evaluation, export and
-tangling of code blocks. See the @ref{Header arguments}
-section. Header arguments can also be set on a per-buffer or per-subtree
+tangling of code blocks. See the @ref{Header arguments}.
+Header arguments can also be set on a per-buffer or per-subtree
basis using properties.
@item <body>
The source code.
@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
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
+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}.
@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
@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
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.
+(see @ref{Library of Babel}). These lines use the following syntax to place
+a call on a line by itself.
@example
-#+call: <name>(<arguments>) <header arguments>
-#+function: <name>(<arguments>) <header arguments>
-#+lob: <name>(<arguments>) <header arguments>
+#+call: <name>(<arguments>)
+#+call: <name>[<header args>](<arguments>) <header args>
+@end example
+
+The following syntax can be used to place these calls within a block of
+prose.
+
+@example
+...prose... call_<name>(<arguments>) ...prose...
+...prose... call_<name>[<header args>](<arguments>)[<header args>] ...prose...
@end example
@table @code
@item <name>
The name of the code block to be evaluated.
@item <arguments>
-Arguments specified in this section will be passed to the code block.
-@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 should relate to @code{:var} header arguments in the called code
+block expressed using standard function call syntax. For example if the
+original code block named @code{double} has the header argument @code{:var
+n=2}, then the call line passing the number four to that block would be
+written as @code{#+call: double(n=2)}.
+@item <header args>
+Header arguments can be placed either inside the call to the code block or at
+the end of the line as shown below.
+
+@example
+#+call: code_bloc_name[XXXX](arguments) YYYY
+@end example
+
+Header arguments located in these two locations are treated differently.
+
+@table @code
+@item XXXX
+Those placed in the @code{XXXX} location are passed through and applied to
+the code block being called. These header arguments affect how the code
+block is evaluated, for example @code{[:results output]} will collect the
+results from @code{STDOUT} of the called code block.
+@item YYYY
+Those placed in the @code{YYYY} location are applied to the call line and do
+not affect the code block being called. These header arguments affect how
+the results are incorporated into the Org-mode buffer when the call line is
+evaluated, and how the call line is exported. For example @code{:results
+org} at the end of the call line will insert the results of the call line
+inside of an Org-mode block.
@end table
+For more examples of passing header arguments to @code{#+call:} lines see
+@ref{Header arguments in function calls}.
+@end table
@node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
@section Library of Babel
@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
@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
+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
src_haskell[:exports both]@{fac 5@}
@end example
+Code block header arguments can span multiple lines using =#+header:= or
+=#+headers:= lines preceding a code block or nested in between the name and
+body of a named code block.
+
+Multi-line header arguments on an un-named code block:
+@example
+ #+headers: :var data1=1
+ #+begin_src emacs-lisp :var data2=2
+ (message "data1:%S, data2:%S" data1 data2)
+ #+end_src
+
+ #+results:
+ : data1:1, data2:2
+@end example
+
+Multi-line header arguments on a named code block:
+@example
+ #+source: named-block
+ #+header: :var data=2
+ #+begin_src emacs-lisp
+ (message "data:%S" data)
+ #+end_src
+
+ #+results: named-block
+ : data:2
+@end example
+
@node Header arguments in function calls, , Code block specific header arguments, Using header arguments
@comment node-name, next, previous, up
@subsubheading Header arguments in function calls
At the most specific level, header arguments for ``Library of Babel'' or
-function call lines can be set as shown below:
+function call lines can be set as shown in the two examples below. For more
+information on the structure of @code{#+call:} lines see @ref{Evaluating code
+blocks}.
+The following will apply the @code{:exports results} header argument to the
+evaluation of the @code{#+call:} line.
@example
#+call: factorial(n=5) :exports results
@end example
+The following will apply the @code{:session special} header argument to the
+evaluation of the @code{factorial} code block.
+@example
+#+call: factorial[:session special](n=5)
+@end example
+
@node Specific header arguments, , Using header arguments, Header arguments
@subsection Specific header arguments
The following header arguments are defined:
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
+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.
+and literal example blocks, the results of other code blocks, or Emacs Lisp
+code---see the ``Emacs Lisp evaluation of variables'' heading below.
These values can be indexed in a manner similar to arrays---see the
``indexable variable values'' heading below.
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}:
| 11 | 14 | 17 |
@end example
+@subsubheading Emacs Lisp evaluation of variables
+
+Emacs lisp code can be used to initialize variable values. When a variable
+value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be evaluated as
+Emacs Lisp and the result of the evaluation will be assigned as the variable
+value. The following example demonstrates use of this evaluation to reliably
+pass the file-name of the org-mode buffer to a code block---note that
+evaluation of header arguments is guaranteed to take place in the original
+org-mode file, while there is no such guarantee for evaluation of the code
+block body.
+
+@example
+#+begin_src sh :var filename=(buffer-file-name) :exports both
+ wc -w $filename
+#+end_src
+@end example
+
+Note that values read from tables and lists will not be evaluated as
+Emacs Lisp, as shown in the following example.
+
+@example
+#+results: table
+| (a b c) |
+
+#+headers: :var data=table[0,0]
+#+begin_src perl
+ $data
+#+end_src
+
+#+results:
+: (a b c)
+@end example
+
@node results, file, var, Specific header arguments
@subsubsection @code{:results}
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
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
@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}
@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:
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
+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
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
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 no-expand, session, comments, Specific header arguments
+@node padline, no-expand, comments, Specific header arguments
+@subsubsection @code{:padline}
+Control in insertion of padding lines around code block bodies in tangled
+code files. The default value is @code{yes} which results in insertion of
+newlines before and after each tangled code block. The following arguments
+are accepted.
+
+@itemize @bullet
+@item @code{yes}
+Insert newlines before and after each code block body in tangled code files.
+@item @code{no}
+Do not insert any newline padding in tangled output.
+@end itemize
+
+@node no-expand, session, padline, Specific header arguments
@subsubsection @code{:no-expand}
By default, code blocks are expanded with @code{org-babel-expand-src-block}
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.
+
+@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
+ #+srcname: random
+ #+begin_src R :cache yes
+ runif(1)
+ #+end_src
+
+ #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
+ 0.4659510825295
+
+ #+srcname: 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
@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
| 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
| 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.
execution of a code block regardless of the value of the
@code{org-confirm-babel-evaluate} variable.
+If this header argument is not set then evaluation is determined by the value
+of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
+security}.
+
@node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
@section Results of evaluation
@cindex code block, results of evaluation
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}
@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
@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
@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:
@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
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
@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
@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
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
@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}.
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:
(define-key yas/keymap [tab] 'yas/next-field-group)))
@end lisp
+The latest version of yasnippet doesn't play well with Org mode. If the
+above code does not fix the conflict, start by defining the following
+function:
+
+@lisp
+(defun yas/org-very-safe-expand ()
+ (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
+@end lisp
+
+Then, tell Org mode what to do with the new function:
+
+@lisp
+(add-hook 'org-mode-hook
+ (lambda ()
+ (make-variable-buffer-local 'yas/trigger-key)
+ (setq yas/trigger-key [tab])
+ (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
+ (define-key yas/keymap [tab] 'yas/next-field)))
+@end lisp
+
@item @file{windmove.el} by Hovav Shacham
@cindex @file{windmove.el}
This package also uses the @kbd{S-<cursor>} keys, so everything written
@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
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.
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
@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
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.
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
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://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:
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
@i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
chapter about publishing.
@item
+@i{Jambunathan K} contributed the OpenDocumentText exporter.
+@item
@i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and
enabled source code highlighling in Gnus.
@item
@item
@i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
and contributed various ideas and code snippets.
+@item
@end itemize
@bye
+@ignore
+ arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
+@end ignore
+
@c Local variables:
@c fill-column: 77
@c indent-tabs-mode: nil
projects / emacs.git / commitdiff