diff options
Diffstat (limited to 'doc/misc/org.texi')
| -rw-r--r-- | doc/misc/org.texi | 2053 |
1 files changed, 1041 insertions, 1012 deletions
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index af7a4b48032..5a676786fdd 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi @@ -4,8 +4,8 @@ @setfilename ../../info/org @settitle The Org Manual -@set VERSION 7.3 -@set DATE November 2010 +@set VERSION 7.4 +@set DATE December 2010 @c Use proper quote and backtick for code sections in PDF output @c Cf. Texinfo manual 14.2 @@ -21,41 +21,237 @@ @c %**end of header @finalout -@c Macro definitions + +@c ----------------------------------------------------------------------------- + +@c Macro definitions for commands and keys +@c ======================================= + +@c The behavior of the key/command macros will depend on the flag cmdnames +@c When set, commands names are shown. When clear, they are not shown. + +@set cmdnames + +@c Below we define the following macros for Org key tables: + +@c orgkey{key} A key item +@c orgcmd{key,cmd} Key with command name +@c xorgcmd{key,cmmand} Key with command name as @itemx +@c orgcmdnki{key,cmd} Like orgcmd, but do not index the key +@c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key +@c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or" +@c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but +@c different functions, so format as @itemx +@c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short" +@c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx +@c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands + +@c a key but no command +@c Inserts: @item key +@macro orgkey{key} +@kindex \key\ +@item @kbd{\key\} +@end macro + +@macro xorgkey{key} +@kindex \key\ +@itemx @kbd{\key\} +@end macro + +@c one key with a command +@c Inserts: @item KEY COMMAND @macro orgcmd{key,command} -@iftex +@ifset cmdnames @kindex \key\ @findex \command\ +@iftex @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\} @end iftex @ifnottex +@item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) +@end ifnottex +@end ifset +@ifclear cmdnames +@kindex \key\ +@item @kbd{\key\} +@end ifclear +@end macro + +@c One key with one command, formatted using @itemx +@c Inserts: @itemx KEY COMMAND +@macro xorgcmd{key,command} +@ifset cmdnames +@kindex \key\ +@findex \command\ +@iftex +@itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\} +@end iftex +@ifnottex +@itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) +@end ifnottex +@end ifset +@ifclear cmdnames @kindex \key\ +@itemx @kbd{\key\} +@end ifclear +@end macro + +@c one key with a command, bit do not index the key +@c Inserts: @item KEY COMMAND +@macro orgcmdnki{key,command} +@ifset cmdnames @findex \command\ +@iftex +@item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\} +@end iftex +@ifnottex @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) @end ifnottex +@end ifset +@ifclear cmdnames +@item @kbd{\key\} +@end ifclear @end macro -@macro orgkey{key} +@c one key with a command, and special text to replace key in item +@c Inserts: @item TEXT COMMAND +@macro orgcmdtkc{text,key,command} +@ifset cmdnames @kindex \key\ -@item @kbd{\key\} +@findex \command\ +@iftex +@item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\} +@end iftex +@ifnottex +@item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) +@end ifnottex +@end ifset +@ifclear cmdnames +@kindex \key\ +@item @kbd{\text\} +@end ifclear @end macro +@c two keys with one command +@c Inserts: @item KEY1 or KEY2 COMMAND +@macro orgcmdkkc{key1,key2,command} +@ifset cmdnames +@kindex \key1\ +@kindex \key2\ +@findex \command\ @iftex -@c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed} +@item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} @end iftex -@macro Ie {} -I.e., +@ifnottex +@item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) +@end ifnottex +@end ifset +@ifclear cmdnames +@kindex \key1\ +@kindex \key2\ +@item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} +@end ifclear @end macro -@macro ie {} -i.e., + +@c Two keys with one command name, but different functions, so format as +@c @itemx +@c Inserts: @item KEY1 +@c @itemx KEY2 COMMAND +@macro orgcmdkxkc{key1,key2,command} +@ifset cmdnames +@kindex \key1\ +@kindex \key2\ +@findex \command\ +@iftex +@item @kbd{\key1\} +@itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} +@end iftex +@ifnottex +@item @kbd{\key1\} +@itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) +@end ifnottex +@end ifset +@ifclear cmdnames +@kindex \key1\ +@kindex \key2\ +@item @kbd{\key1\} +@itemx @kbd{\key2\} +@end ifclear @end macro -@macro Eg {} -E.g., + +@c Same as previous, but use "or short" +@c Inserts: @item KEY1 or short KEY2 COMMAND +@macro orgcmdkskc{key1,key2,command} +@ifset cmdnames +@kindex \key1\ +@kindex \key2\ +@findex \command\ +@iftex +@item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} +@end iftex +@ifnottex +@item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) +@end ifnottex +@end ifset +@ifclear cmdnames +@kindex \key1\ +@kindex \key2\ +@item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} +@end ifclear @end macro -@macro eg {} -e.g., + +@c Same as previous, but use @itemx +@c Inserts: @itemx KEY1 or short KEY2 COMMAND +@macro xorgcmdkskc{key1,key2,command} +@ifset cmdnames +@kindex \key1\ +@kindex \key2\ +@findex \command\ +@iftex +@itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\} +@end iftex +@ifnottex +@itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\}) +@end ifnottex +@end ifset +@ifclear cmdnames +@kindex \key1\ +@kindex \key2\ +@itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} +@end ifclear @end macro +@c two keys with two commands +@c Inserts: @item KEY1 COMMAND1 +@c @itemx KEY2 COMMAND2 +@macro orgcmdkkcc{key1,key2,command1,command2} +@ifset cmdnames +@kindex \key1\ +@kindex \key2\ +@findex \command1\ +@findex \command2\ +@iftex +@item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\} +@itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\} +@end iftex +@ifnottex +@item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\}) +@itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\}) +@end ifnottex +@end ifset +@ifclear cmdnames +@kindex \key1\ +@kindex \key2\ +@item @kbd{\key1\} +@itemx @kbd{\key2\} +@end ifclear +@end macro +@c ----------------------------------------------------------------------------- + +@iftex +@c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed} +@end iftex + @c Subheadings inside a table. @macro tsubheading{text} @ifinfo @@ -260,7 +456,6 @@ Dates and times * Creating timestamps:: Commands which insert timestamps * Deadlines and scheduling:: Planning your work * Clocking work time:: Tracking how long you spend on a task -* Resolving idle time:: Resolving time if you've been idle * Effort estimates:: Planning work effort in advance * Relative timer:: Notes with a running timer * Countdown timer:: Starting a countdown timer for a task @@ -275,6 +470,12 @@ Deadlines and scheduling * Inserting deadline/schedule:: Planning items * Repeated tasks:: Items that show up again and again +Clocking work time + +* Clocking commands:: Starting and stopping a clock +* The clock table:: Detailed reports +* Resolving idle time:: Resolving time when you've been idle + Capture - Refile - Archive * Capture:: Capturing new stuff @@ -355,7 +556,7 @@ Structural markup elements * Horizontal rules:: Make a line * Comment lines:: What will *not* be exported -Embedded La@TeX{} +Embedded @LaTeX{} * Special symbols:: Greek letters and other symbols * Subscripts and superscripts:: Simple syntax for raising/lowering text @@ -370,7 +571,7 @@ Exporting * The export dispatcher:: How to access exporter commands * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding * HTML export:: Exporting to HTML -* LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF +* LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF * DocBook export:: Exporting to DocBook * TaskJuggler export:: Exporting to TaskJuggler * Freemind export:: Exporting to Freemind mind maps @@ -389,13 +590,13 @@ HTML export * CSS support:: Changing the appearance of the output * JavaScript support:: Info and Folding in a web browser -La@TeX{} and PDF export +@LaTeX{} and PDF export * LaTeX/PDF export commands:: Which key invokes which commands * Header and sectioning:: Setting up the export file structure -* Quoting LaTeX code:: Incorporating literal La@TeX{} code -* Tables in LaTeX export:: Options for exporting tables to La@TeX{} -* Images in LaTeX export:: How to insert figures into La@TeX{} output +* Quoting LaTeX code:: Incorporating literal @LaTeX{} code +* Tables in LaTeX export:: Options for exporting tables to @LaTeX{} +* Images in LaTeX export:: How to insert figures into @LaTeX{} output * Beamer class export:: Turning the file into a presentation DocBook export @@ -506,7 +707,7 @@ Hacking * Add-on packages:: Available extensions * Adding hyperlink types:: New custom link types * Context-sensitive commands:: How to add functionality to such commands -* Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs +* Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs * Dynamic blocks:: Automatically filled blocks * Special agenda views:: Customized views * Extracting agenda information:: Postprocessing of agenda information @@ -567,14 +768,14 @@ As a project planning environment, Org works by adding metadata to outline nodes. Based on this data, specific entries can be extracted in queries and create dynamic @i{agenda views}. -Org mode contains the Org Babel environment which allows to work with -embedded source code block in a file, to facilitate code evaluation, +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. Org's automatic, context-sensitive table editor with spreadsheet capabilities can be integrated into any major mode by activating the minor Orgtbl mode. Using a translation step, it can be used to maintain -tables in arbitrary file types, for example in La@TeX{}. The structure +tables in arbitrary file types, for example in @LaTeX{}. The structure editing and list creation capabilities can be used outside Org with the minor Orgstruct mode. @@ -591,7 +792,7 @@ ends, for example: @r{@bullet{} a full agenda and planner with deadlines and work scheduling} @pindex GTD, Getting Things Done @r{@bullet{} an environment in which to implement David Allen's GTD system} -@r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export} +@r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export} @r{@bullet{} a publishing tool to create a set of interlinked webpages} @r{@bullet{} an environment for literate programming} @end example @@ -742,7 +943,7 @@ to the mailing list, in order to minimize the work the mailing list moderators have to do.}. For bug reports, please first try to reproduce the bug with the latest -version of Org available - if you are running an outdated version, it is +version of Org available---if you are running an outdated version, it is quite possible that the bug has been fixed already. If the bug persists, prepare a report and provide as much information as possible, including the version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org @@ -819,6 +1020,18 @@ User-defined properties are capitalized; built-in properties with special meaning are written with all capitals. @end table +The manual lists both the keys and the corresponding commands for accessing +functionality. Org mode often uses the same key for different functions, +depending on context. The command that is bound to such keys has a generic +name, like @code{org-metaright}. In the manual we will, wherever possible, +give the function that is internally called by the generic command. For +example, in the chapter on document structure, @kbd{M-@key{right}} will be +listed to call @code{org-do-demote}, while in the chapter on tables, it will +be listed to call org-table-move-column-right. + +If you prefer, you can compile the manual without the command names by +unsetting the flag @code{cmdnames} in @file{org.texi}. + @node Document Structure, Tables, Introduction, Top @chapter Document structure @cindex document structure @@ -1199,8 +1412,7 @@ commands can be accessed through a dispatcher: @table @asis @orgcmd{C-c /,org-sparse-tree} This prompts for an extra key to select a sparse-tree creating command. -@kindex C-c / r -@item C-c / r +@orgcmd{C-c / r,org-occur} @vindex org-remove-highlights-with-change Occur. Prompts for a regexp and shows a sparse tree with all matches. If the match is in a headline, the headline is made visible. If the match is in @@ -1270,7 +1482,7 @@ as bullets. @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 a different value (e.g. 20), start +@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 @@ -1325,7 +1537,7 @@ XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on, 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 of a list +blocks can be indented to signal that they should be considered as a list item. @vindex org-list-demote-modify-bullet @@ -1336,7 +1548,7 @@ the current list-level) improves readability, customize the variable @vindex org-list-automatic-rules The following commands act on items when the cursor is in the first line of an item (the line with the bullet or number). Some of them imply the -application of automatic rules to keep list structure in tact. If some of +application of automatic rules to keep list structure intact. If some of these actions get in your way, configure @code{org-list-automatic-rules} to disable them individually. @@ -1345,8 +1557,9 @@ to disable them individually. @vindex org-cycle-include-plain-lists Items can be folded just like headline levels. Normally this works only if the cursor is on a plain list item. For more details, see the variable -@code{org-cycle-include-plain-lists}. to @code{integrate}, plain list items -will be treated like low-level. The level of an item is then given by the +@code{org-cycle-include-plain-lists}. If this variable is set to +@code{integrate}, plain list items will be treated like low-level +headlines. The level of an item is then given by the indentation of the bullet/number. Items are always subordinate to real headlines, however; the hierarchies remain completely separated. @orgcmd{M-@key{RET},org-insert-heading} @@ -1357,7 +1570,7 @@ 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 -item's body}, the new item is created @emph{before} the current item. If the +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. @@ -1369,7 +1582,7 @@ the structure, or return an error. Insert a new item with a checkbox (@pxref{Checkboxes}). @orgcmd{@key{TAB},org-cycle} In a new item with no text yet, the first @key{TAB} demotes the item to -become a child of the previous one. Subsequents @key{TAB} move the item to +become a child of the previous one. Subsequent @key{TAB}s move the item to meaningful levels in the list and eventually get it back to its initial position. @kindex S-@key{down} @@ -1475,8 +1688,7 @@ press @key{TAB} there. Org-mode uses the @code{PROPERTIES} drawer for storing properties (@pxref{Properties and Columns}), and you can also arrange for state change notes (@pxref{Tracking TODO state changes}) and clock times (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you -want to store a quick note in the LOGBOOK drawer, in a similar way as this is -done by state changes, use +want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use @table @kbd @kindex C-c C-z @@ -1513,7 +1725,7 @@ 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 defined in a paragraph that is started by a footnote marker in square brackets in column 0, no indentation allowed. If you need a paragraph break -inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference +inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference is simply the marker in square brackets, inside text. For example: @example @@ -1525,7 +1737,7 @@ The Org homepage[fn:1] now looks a lot better than it used to. Org-mode extends the number-based syntax to @emph{named} footnotes and optional inline definition. Using plain numbers as markers (as @file{footnote.el} does) is supported for backward compatibility, but not -encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded +encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded LaTeX}). Here are the valid references: @table @code @@ -1537,7 +1749,7 @@ snippet. A named footnote reference, where @code{name} is a unique label word, or, for simplicity of automatic creation, a number. @item [fn:: This is the inline definition of this footnote] -A La@TeX{}-like anonymous footnote where the definition is given directly at the +A @LaTeX{}-like anonymous footnote where the definition is given directly at the reference point. @item [fn:name: a definition] An inline definition of a footnote, which also specifies a name for the note. @@ -1548,7 +1760,7 @@ Since Org allows multiple references to the same note, you can then use @vindex org-footnote-auto-label Footnote labels can be created automatically, or you can create names yourself. This is handled by the variable @code{org-footnote-auto-label} and its -corresponding @code{#+STARTUP} keywords, see the docstring of that variable +corresponding @code{#+STARTUP} keywords. See the docstring of that variable for details. @noindent The following command handles footnotes: @@ -1631,7 +1843,7 @@ When this mode is active and the cursor is on a line that looks to Org like a headline or the first line of a list item, most structure editing commands will work, even if the same keys normally have different functionality in the major mode you are using. If the cursor is not in one of those special -lines, Orgstruct mode lurks silently in the shadow. When you use +lines, Orgstruct mode lurks silently in the shadows. When you use @code{orgstruct++-mode}, Org will also export indentation and autofill settings into that mode, and detect item context after the first line of an item. @@ -1642,8 +1854,7 @@ item. @cindex editing tables Org comes with a fast and intuitive table editor. Spreadsheet-like -calculations are supported in connection with the Emacs @file{calc} -package +calculations are supported using the Emacs @file{calc} package @ifinfo (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}). @end ifinfo @@ -1722,70 +1933,55 @@ table. But it's easier just to start typing, like @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. @tsubheading{Re-aligning and field motion} -@orgcmd{C-c C-c,org-ctrl-c-ctrl-c} +@orgcmd{C-c C-c,org-table-align} Re-align the table without moving the cursor. @c -@orgcmd{<TAB>,org-cycle} +@orgcmd{<TAB>,org-table-next-field} Re-align the table, move to the next field. Creates a new row if necessary. @c -@orgcmd{S-@key{TAB},org-shifttab} +@orgcmd{S-@key{TAB},org-table-previous-field} Re-align, move to previous field. @c -@orgcmd{@key{RET},org-return} +@orgcmd{@key{RET},org-table-next-row} Re-align the table and move down to next row. Creates a new row if necessary. At the beginning or end of a line, @key{RET} still does NEWLINE, so it can be used to split a table. @c -@kindex M-a -@item M-a +@orgcmd{M-a,org-table-beginning-of-field} Move to beginning of the current table field, or on to the previous field. -@kindex M-e -@item M-e +@orgcmd{M-e,org-table-end-of-field} Move to end of the current table field, or on to the next field. @tsubheading{Column and row editing} -@kindex M-@key{left} -@kindex M-@key{right} -@item M-@key{left} -@itemx M-@key{right} +@orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right} Move the current column left/right. @c -@kindex M-S-@key{left} -@item M-S-@key{left} +@orgcmd{M-S-@key{left},org-table-delete-column} Kill the current column. @c -@kindex M-S-@key{right} -@item M-S-@key{right} +@orgcmd{M-S-@key{right},org-table-insert-column} Insert a new column to the left of the cursor position. @c -@kindex M-@key{up} -@kindex M-@key{down} -@item M-@key{up} -@itemx M-@key{down} +@orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down} Move the current row up/down. @c -@kindex M-S-@key{up} -@item M-S-@key{up} +@orgcmd{M-S-@key{up},org-table-kill-row} Kill the current row or horizontal line. @c -@kindex M-S-@key{down} -@item M-S-@key{down} +@orgcmd{M-S-@key{down},org-table-insert-row} Insert a new row above the current row. With a prefix argument, the line is created below the current one. @c -@kindex C-c - -@item C-c - +@orgcmd{C-c -,org-table-insert-hline} Insert a horizontal line below current row. With a prefix argument, the line is created above the current line. @c -@kindex C-c @key{RET} -@item C-c @key{RET} +@orgcmd{C-c @key{RET},org-table-hline-and-move} Insert a horizontal line below current row, and move the cursor into the row below that line. @c -@kindex C-c ^ -@item C-c ^ +@orgcmd{C-c ^,org-table-sort-lines} Sort the table lines in the region. The position of point indicates the column to be used for sorting, and the range of lines is the range between the nearest horizontal separator lines, or the entire table. If @@ -1797,35 +1993,30 @@ included into the sorting. The command prompts for the sorting type argument, alphabetic sorting will be case-sensitive. @tsubheading{Regions} -@kindex C-c C-x M-w -@item C-c C-x M-w +@orgcmd{C-c C-x M-w,org-table-copy-region} Copy a rectangular region from a table to a special clipboard. Point and mark determine edge fields of the rectangle. If there is no active region, copy just the current field. The process ignores horizontal separator lines. @c -@kindex C-c C-x C-w -@item C-c C-x C-w +@orgcmd{C-c C-x C-w,org-table-cut-region} Copy a rectangular region from a table to a special clipboard, and blank all fields in the rectangle. So this is the ``cut'' operation. @c -@kindex C-c C-x C-y -@item C-c C-x C-y +@orgcmd{C-c C-x C-y,org-table-paste-rectangle} Paste a rectangular region into a table. The upper left corner ends up in the current field. All involved fields will be overwritten. If the rectangle does not fit into the present table, the table is enlarged as needed. The process ignores horizontal separator lines. @c -@kindex M-@key{RET} -@itemx M-@kbd{RET} -Wrap several fields in a column like a paragraph. If there is an active -region, and both point and mark are in the same column, the text in the -column is wrapped to minimum width for the given number of lines. A numeric -prefix argument may be used to change the number of desired lines. If there -is no region, the current field is split at the cursor position and the text -fragment to the right of the cursor is prepended to the field one line -down. If there is no region, but you specify a prefix argument, the current -field is made blank, and the content is appended to the field above. +@orgcmd{M-@key{RET},org-table-wrap-region} +Split the current field at the cursor position and move the rest to the line +below. If there is an active region, and both point and mark are in the same +column, the text in the column is wrapped to minimum width for the given +number of lines. A numeric prefix argument may be used to change the number +of desired lines. If there is no region, but you specify a prefix argument, +the current field is made blank, and the content is appended to the field +above. @tsubheading{Calculations} @cindex formula, in tables @@ -1833,14 +2024,12 @@ field is made blank, and the content is appended to the field above. @cindex region, active @cindex active region @cindex transient mark mode -@kindex C-c + -@item C-c + +@orgcmd{C-c +,org-table-sum} Sum the numbers in the current column, or in the rectangle defined by the active region. The result is shown in the echo area and can be inserted with @kbd{C-y}. @c -@kindex S-@key{RET} -@item S-@key{RET} +@orgcmd{S-@key{RET},org-table-copy-down} @vindex org-table-copy-increment When current field is empty, copy from first non-empty field above. When not empty, copy current field down to next row and move cursor along with it. @@ -1851,8 +2040,7 @@ increment. This key is also used by shift-selection and related modes (@pxref{Conflicts}). @tsubheading{Miscellaneous} -@kindex C-c ` -@item C-c ` +@orgcmd{C-c `,org-table-edit-field} Edit the current field in a separate window. This is useful for fields that are not fully visible (@pxref{Column width and alignment}). When called with a @kbd{C-u} prefix, just make the full field visible, so that it can be @@ -1866,12 +2054,13 @@ TAB-separated text files. This command works by inserting the file into the buffer and then converting the region to a table. Any prefix argument is passed on to the converter, which uses it to determine the separator. -@item C-c | +@orgcmd{C-c |,org-table-create-or-convert-from-region} Tables can also be imported by pasting tabular text into the Org buffer, selecting the pasted text with @kbd{C-x C-x} and then using the @kbd{C-c |} command (see above under @i{Creation and conversion}). @c @item M-x org-table-export +@findex org-table-export @vindex org-table-export-default-format Export the table, by default as a TAB-separated file. Use for data exchange with, for example, spreadsheet or database programs. The format @@ -1926,7 +2115,7 @@ will then set the width of this column to this value. @noindent Fields that are wider become clipped and end in the string @samp{=>}. -Note that the full text is still in the buffer, it is only invisible. +Note that the full text is still in the buffer but is hidden. To see the full text, hold the mouse over the field---a tool-tip window will show the full content. To edit such a field, use the command @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will @@ -1947,7 +2136,7 @@ on a per-file basis with: @end example If you would like to overrule the automatic alignment of number-rich columns -to the right and of string-rich column to the left, you and use @samp{<r>}, +to the right and of string-rich column to the left, you can use @samp{<r>}, @samp{c}@footnote{Centering does not work inside Emacs, but it does have an effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may also combine alignment and field width like this: @samp{<l10>}. @@ -2007,7 +2196,7 @@ example in mail mode, use Furthermore, with some special setup, it is possible to maintain tables in arbitrary syntax with Orgtbl mode. For example, it is possible to -construct La@TeX{} tables with the underlying ease and power of +construct @LaTeX{} tables with the underlying ease and power of Orgtbl mode, including spreadsheet capabilities. For details, see @ref{Tables in arbitrary syntax}. @@ -2280,7 +2469,7 @@ tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1} sin($1);Dp3%.1e @r{Same, but use printf specifier for display} vmean($2..$7) @r{Compute column range mean, using vector function} vmean($2..$7);EN @r{Same, but treat empty fields as 0} -taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} +taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree} @end example Calc also contains a complete set of logical operations. For example @@ -2293,24 +2482,23 @@ if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty} @subsection Emacs Lisp forms as formulas @cindex Lisp forms, as table formulas -It is also possible to write a formula in Emacs Lisp; this can be useful -for string manipulation and control structures, if Calc's -functionality is not enough. If a formula starts with a single-quote -followed by an opening parenthesis, then it is evaluated as a Lisp form. -The evaluation should return either a string or a number. Just as with -@file{calc} formulas, you can specify modes and a printf format after a -semicolon. With Emacs Lisp forms, you need to be conscious about the way -field references are interpolated into the form. By default, a -reference will be interpolated as a Lisp string (in double-quotes) -containing the field. If you provide the @samp{N} mode switch, all -referenced elements will be numbers (non-number fields will be zero) and -interpolated as Lisp numbers, without quotes. If you provide the -@samp{L} flag, all fields will be interpolated literally, without quotes. -I.e., if you want a reference to be interpreted as a string by the Lisp -form, enclose the reference operator itself in double-quotes, like -@code{"$3"}. Ranges are inserted as space-separated fields, so you can -embed them in list or vector syntax. A few examples, note how the -@samp{N} mode is used when we do computations in Lisp. +It is also possible to write a formula in Emacs Lisp; this can be useful for +string manipulation and control structures, if Calc's functionality is not +enough. If a formula starts with a single-quote followed by an opening +parenthesis, then it is evaluated as a Lisp form. The evaluation should +return either a string or a number. Just as with @file{calc} formulas, you +can specify modes and a printf format after a semicolon. With Emacs Lisp +forms, you need to be conscious about the way field references are +interpolated into the form. By default, a reference will be interpolated as +a Lisp string (in double-quotes) containing the field. If you provide the +@samp{N} mode switch, all referenced elements will be numbers (non-number +fields will be zero) and interpolated as Lisp numbers, without quotes. If +you provide the @samp{L} flag, all fields will be interpolated literally, +without quotes. I.e., if you want a reference to be interpreted as a string +by the Lisp form, enclose the reference operator itself in double-quotes, +like @code{"$3"}. Ranges are inserted as space-separated fields, so you can ++embed them in list or vector syntax. Here are a few examples---note how the +@samp{N} mode is used when we do computations in Lisp: @example @r{Swap the first two characters of the content of column 1} @@ -2334,7 +2522,7 @@ evaluated, and the current field replaced with the result. @cindex #+TBLFM Formulas are stored in a special line starting with @samp{#+TBLFM:} -directly below the table. If you typed the equation in the 4th field of +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 @@ -2348,8 +2536,7 @@ Instead of typing an equation into the field, you may also use the following command @table @kbd -@kindex C-u C-c = -@item C-u C-c = +@orgcmd{C-u C-c =,org-table-eval-formula} Install a new formula for the current field. The command prompts for a formula with default taken from the @samp{#+TBLFM:} line, applies it to the current field, and stores it. @@ -2382,8 +2569,7 @@ Instead of typing an equation into the field, you may also use the following command: @table @kbd -@kindex C-c = -@item C-c = +@orgcmd{C-c =,org-table-eval-formula} Install a new formula for the current column and replace current field with the result of the formula. The command prompts for a formula, with default taken from the @samp{#+TBLFM} line, applies it to the current field and @@ -2406,32 +2592,29 @@ if possible. If you prefer to only work with the internal format (like @code{org-table-use-standard-references}. @table @kbd -@kindex C-c = -@kindex C-u C-c = -@item C-c = -@itemx C-u C-c = +@orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula} Edit the formula associated with the current column/field in the minibuffer. See @ref{Column formulas}, and @ref{Field formulas}. -@kindex C-u C-u C-c = -@item C-u C-u C-c = +@orgcmd{C-u C-u C-c =,org-table-eval-formula} Re-insert the active formula (either a field formula, or a column formula) into the current field, so that you can edit it directly in the field. The advantage over editing in the minibuffer is that you can use the command @kbd{C-c ?}. -@kindex C-c ? -@item C-c ? +@orgcmd{C-c ?,org-table-field-info} While editing a formula in a table field, highlight the field(s) referenced by the reference at the cursor position in the formula. @kindex C-c @} +@findex org-table-toggle-coordinate-overlays @item C-c @} -Toggle the display of row and column numbers for a table, using -overlays. These are updated each time the table is aligned; you can -force it with @kbd{C-c C-c}. +Toggle the display of row and column numbers for a table, using overlays +(@command{org-table-toggle-coordinate-overlays}). These are updated each +time the table is aligned; you can force it with @kbd{C-c C-c}. @kindex C-c @{ +@findex org-table-toggle-formula-debugger @item C-c @{ -Toggle the formula debugger on and off. See below. -@kindex C-c ' -@item C-c ' +Toggle the formula debugger on and off +(@command{org-table-toggle-formula-debugger}). See below. +@orgcmd{C-c ',org-table-edit-formulas} Edit all formulas for the current table in a special buffer, where the formulas will be displayed one per line. If the current field has an active formula, the cursor in the formula editor will mark it. @@ -2439,46 +2622,40 @@ While inside the special buffer, Org will automatically highlight any field or range reference at the cursor position. You may edit, remove and add formulas, and use the following commands: @table @kbd -@kindex C-c C-c -@kindex C-x C-s -@item C-c C-c -@itemx C-x C-s +@orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish} Exit the formula editor and store the modified formulas. With @kbd{C-u} prefix, also apply the new formulas to the entire table. -@kindex C-c C-q -@item C-c C-q +@orgcmd{C-c C-q,org-table-fedit-abort} Exit the formula editor without installing changes. -@kindex C-c C-r -@item C-c C-r +@orgcmd{C-c C-r,org-table-fedit-toggle-ref-type} Toggle all references in the formula editor between standard (like @code{B3}) and internal (like @code{@@3$2}). -@kindex @key{TAB} -@item @key{TAB} +@orgcmd{@key{TAB},org-table-fedit-lisp-indent} Pretty-print or indent Lisp formula at point. When in a line containing a Lisp formula, format the formula according to Emacs Lisp rules. Another @key{TAB} collapses the formula back again. In the open formula, @key{TAB} re-indents just like in Emacs Lisp mode. -@kindex M-@key{TAB} -@item M-@key{TAB} +@orgcmd{M-@key{TAB},lisp-complete-symbol} Complete Lisp symbols, just like in Emacs Lisp mode. @kindex S-@key{up} @kindex S-@key{down} @kindex S-@key{left} @kindex S-@key{right} +@findex org-table-fedit-ref-up +@findex org-table-fedit-ref-down +@findex org-table-fedit-ref-left +@findex org-table-fedit-ref-right @item S-@key{up}/@key{down}/@key{left}/@key{right} Shift the reference at point. For example, if the reference is @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}. This also works for relative references and for hline references. -@kindex M-S-@key{up} -@kindex M-S-@key{down} -@item M-S-@key{up}/@key{down} +@orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down} Move the test line for column formulas in the Org buffer up and down. -@kindex M-@key{up} -@kindex M-@key{down} -@item M-@key{up}/@key{down} +@orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up} Scroll the window displaying the table. @kindex C-c @} +@findex org-table-toggle-coordinate-overlays @item C-c @} Turn the coordinate grid in the table on and off. @end table @@ -2518,8 +2695,7 @@ In order to recalculate a line of a table or the entire table, use the following commands: @table @kbd -@kindex C-c * -@item C-c * +@orgcmd{C-c *,org-table-recalculate} Recalculate the current row by first applying the stored column formulas from left to right, and all field formulas in the current row. @c @@ -2530,16 +2706,15 @@ from left to right, and all field formulas in the current row. Recompute the entire table, line by line. Any lines before the first hline are left alone, assuming that these are part of the table header. @c -@kindex C-u C-u C-c * -@kindex C-u C-u C-c C-c -@item C-u C-u C-c * -@itemx C-u C-u C-c C-c +@orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate} Iterate the table by recomputing it until no further changes occur. This may be necessary if some computed fields use the value of other fields that are computed @i{later} in the calculation sequence. @item M-x org-table-recalculate-buffer-tables +@findex org-table-recalculate-buffer-tables Recompute all tables in the current buffer. @item M-x org-table-iterate-buffer-tables +@findex org-table-iterate-buffer-tables Iterate all tables in the current buffer, in order to converge table-to-table dependencies. @end table @@ -2551,8 +2726,7 @@ If you want the recalculation of fields to happen automatically, or if you want to be able to assign @i{names} to fields and columns, you need to reserve the first column of the table for special marking characters. @table @kbd -@kindex C-# -@item C-# +@orgcmd{C-#,org-table-rotate-recalc-marks} Rotate the calculation mark in first column through the states @samp{ }, @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region, change all marks in the region. @@ -2708,8 +2882,8 @@ Defaults to @code{lines}. If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}. @item labels -List of labels to be used for the deps (defaults to the column headers if -they exist). +List of labels to be used for the @code{deps} (defaults to the column headers +if they exist). @item line Specify an entire line to be inserted in the Gnuplot script. @@ -2821,7 +2995,7 @@ a link targeting a headline, in-buffer completion can be used. Just type a star followed by a few optional letters into the buffer and press @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as completions.}. In non-Org files, the search will look for the words in the -link text, in the above example the search would be for @samp{my target}. +link text. In the above example the search would be for @samp{my target}. Following a link pushes a mark onto Org's own mark ring. You can return to the previous position with @kbd{C-c &}. Using this command @@ -2939,9 +3113,8 @@ Org provides methods to create a link in the correct syntax, to insert it into an Org file, and to follow the link. @table @kbd -@kindex C-c l +@orgcmd{C-c l,org-store-link} @cindex storing links -@item C-c l Store a link to the current location. This is a @emph{global} command (you must create the key binding yourself) which can be used in any buffer to create a link. The link will be stored for later insertion into an Org @@ -2997,11 +3170,10 @@ When the cursor is in an agenda view, the created link points to the entry referenced by the current line. @c -@kindex C-c C-l +@orgcmd{C-c C-l,org-insert-link} @cindex link completion @cindex completion, of links @cindex inserting links -@item C-c C-l @vindex org-keep-stored-link-after-insertion Insert a link@footnote{ Note that you don't have to use this command to insert a link. Links in Org are plain text, and you can type or paste them @@ -3031,10 +3203,9 @@ calling a special function @code{org-PREFIX-complete-link}.} For example, if you type @kbd{file @key{RET}}, file name completion (alternative access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb @key{RET}} you can complete contact names. -@kindex C-u C-c C-l +@orgkey C-u C-c C-l @cindex file name completion @cindex completion, of file names -@item C-u C-c C-l When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to a file will be inserted and you may use file name completion to select the name of the file. The path to the file is inserted relative to the @@ -3049,9 +3220,7 @@ When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the link and description parts of the link. @c @cindex following links -@kindex C-c C-o -@kindex @key{RET} -@item C-c C-o @ @r{(or, if @code{org-return-follows-link} is set, also} @key{RET} +@orgcmd{C-c C-o,org-open-at-point} @vindex org-file-apps Open link at point. This will launch a web browser for URLs (using @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for @@ -3067,13 +3236,17 @@ visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid opening in Emacs, use a @kbd{C-u C-u} prefix.@* If the cursor is on a headline, but not on a link, offer all links in the headline and entry text. +@orgkey @key{RET} +@vindex org-return-follows-link +When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow +the link at point. @c @kindex mouse-2 @kindex mouse-1 @item mouse-2 @itemx mouse-1 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o} -would. Under Emacs 22, @kbd{mouse-1} will also follow a link. +would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link. @c @kindex mouse-3 @item mouse-3 @@ -3082,13 +3255,12 @@ Like @kbd{mouse-2}, but force file links to be opened with Emacs, and internal links to be displayed in another window@footnote{See the variable @code{org-display-internal-link-with-indirect-buffer}}. @c +@orgcmd{C-c C-x C-v,org-toggle-inline-images} @cindex inlining images @cindex images, inlining -@kindex C-c C-x C-v @vindex org-startup-with-inline-images @cindex @code{inlineimages}, STARTUP keyword @cindex @code{noinlineimages}, STARTUP keyword -@item C-c C-x C-v Toggle the inline display of linked images. Normally this will only inline images that have no description part in the link, i.e. images that will also be inlined during export. When called with a prefix argument, also display @@ -3096,28 +3268,23 @@ images that do have a link description. You can ask for inline images to be displayed at startup by configuring the variable @code{org-startup-with-inline-images}@footnote{with corresponding @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}. +@orgcmd{C-c %,org-mark-ring-push} @cindex mark ring -@kindex C-c % -@item C-c % Push the current position onto the mark ring, to be able to return easily. Commands following an internal link do this automatically. @c +@orgcmd{C-c &,org-mark-ring-goto} @cindex links, returning to -@kindex C-c & -@item C-c & Jump back to a recorded position. A position is recorded by the commands following internal links, and by @kbd{C-c %}. Using this command several times in direct succession moves through a ring of previously recorded positions. @c -@kindex C-c C-x C-n -@kindex C-c C-x C-p +@orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link} @cindex links, finding next/previous -@item C-c C-x C-n -@itemx C-c C-x C-p Move forward/backward to the next link in the buffer. At the limit of the buffer, the search fails once, and then wraps around. The key -bindings for this are really too long, you might want to bind this also +bindings for this are really too long; you might want to bind this also to @kbd{C-n} and @kbd{C-p} @lisp (add-hook 'org-load-hook @@ -3316,9 +3483,8 @@ Any headline becomes a TODO item when it starts with the word The most important commands to work with TODO entries are: @table @kbd -@kindex C-c C-t +@orgcmd{C-c C-t,org-todo} @cindex cycling, of TODO states -@item C-c C-t Rotate the TODO state of the current item among @example @@ -3329,8 +3495,7 @@ Rotate the TODO state of the current item among The same rotation can also be done ``remotely'' from the timeline and agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). -@kindex C-u C-c C-t -@item C-u C-c C-t +@orgkey{C-u C-c C-t} Select a specific keyword using completion or (if it has been set up) the fast selection interface. For the latter, you need to assign keys to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for @@ -3338,17 +3503,15 @@ more information. @kindex S-@key{right} @kindex S-@key{left} +@item S-@key{right} @ @r{/} @ S-@key{left} @vindex org-treat-S-cursor-todo-selection-as-state-change -@item S-@key{right} -@itemx S-@key{left} Select the following/preceding TODO state, similar to cycling. Useful mostly if more than two TODO states are possible (@pxref{TODO extensions}). See also @ref{Conflicts}, for a discussion of the interaction with @code{shift-selection-mode}. See also the variable @code{org-treat-S-cursor-todo-selection-as-state-change}. -@kindex C-c / t +@orgcmd{C-c / t,org-show-todo-key} @cindex sparse tree, for TODO -@itemx C-c / t @vindex org-todo-keywords View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the entire buffer, but shows all TODO items (with not-DONE state) and the @@ -3359,15 +3522,13 @@ entries that match any one of these keywords. With numeric prefix argument N, show the tree for the Nth keyword in the variable @code{org-todo-keywords}. With two prefix arguments, find all TODO states, both un-done and done. -@kindex C-c a t -@item C-c a t +@orgcmd{C-c a t,org-todo-list} Show the global TODO list. Collects the TODO items (with not-DONE states) from all agenda files (@pxref{Agenda Views}) into a single buffer. The new buffer will be in @code{agenda-mode}, which provides commands to examine and manipulate the TODO entries from the new buffer (@pxref{Agenda commands}). @xref{Global TODO list}, for more information. -@kindex S-M-@key{RET} -@item S-M-@key{RET} +@orgcmd{S-M-@key{RET},org-insert-todo-heading} Insert a new TODO entry below the current one. @end table @@ -3644,8 +3805,7 @@ example: @end example @table @kbd -@kindex C-c C-x o -@item C-c C-x o +@orgcmd{C-c C-x o,org-toggle-ordered-property} @vindex org-track-ordered-property-with-tag @cindex property, ORDERED Toggle the @code{ORDERED} property of the current entry. A property is used @@ -3653,8 +3813,7 @@ for this behavior because this should be local to the current entry, not inherited like a tag. However, if you would like to @i{track} the value of this property with a tag for better visibility, customize the variable @code{org-track-ordered-property-with-tag}. -@kindex C-u C-u C-u C-c C-t -@item C-u C-u C-u C-c C-t +@orgkey{C-u C-u C-u C-c C-t} Change TODO state, circumventing any state blocking. @end table @@ -3698,7 +3857,7 @@ work time}. The most basic logging is to keep track of @emph{when} a certain TODO item was finished. This is achieved with@footnote{The corresponding -in-buffer setting is: @code{#+STARTUP: logdone}}. +in-buffer setting is: @code{#+STARTUP: logdone}} @lisp (setq org-log-done 'time) @@ -3928,18 +4087,16 @@ Priorities can be attached to any outline node; they do not need to be TODO items. @table @kbd -@kindex @kbd{C-c ,} @item @kbd{C-c ,} -Set the priority of the current headline. The command prompts for a -priority character @samp{A}, @samp{B} or @samp{C}. When you press -@key{SPC} instead, the priority cookie is removed from the headline. -The priorities can also be changed ``remotely'' from the timeline and -agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). +@kindex @kbd{C-c ,} +@findex org-priority +Set the priority of the current headline (@command{org-priority}). The +command prompts for a priority character @samp{A}, @samp{B} or @samp{C}. +When you press @key{SPC} instead, the priority cookie is removed from the +headline. The priorities can also be changed ``remotely'' from the timeline +and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). @c -@kindex S-@key{up} -@kindex S-@key{down} -@item S-@key{up} -@itemx S-@key{down} +@orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down} @vindex org-priority-start-cycle-with-default Increase/decrease priority of current headline@footnote{See also the option @code{org-priority-start-cycle-with-default}.}. Note that these keys are @@ -4089,13 +4246,11 @@ off a box while there are unchecked boxes above it. @noindent The following commands work with checkboxes: @table @kbd -@kindex C-c C-c -@item C-c C-c +@orgcmd{C-c C-c,org-toggle-checkbox} Toggle checkbox status or (with prefix arg) checkbox presence at point. With double prefix argument, set it to @samp{[-]}, which is considered to be an intermediate state. -@kindex C-c C-x C-b -@item C-c C-x C-b +@orgcmd{C-c C-x C-b,org-toggle-checkbox} Toggle checkbox status or (with prefix arg) checkbox presence at point. With double prefix argument, set it to @samp{[-]}, which is considered to be an intermediate state. @@ -4110,13 +4265,11 @@ this headline and the next (so @emph{not} the entire subtree). @item If there is no active region, just toggle the checkbox at point. @end itemize -@kindex M-S-@key{RET} -@item M-S-@key{RET} +@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}). -@kindex C-c C-x o -@item C-c C-x o +@orgcmd{C-c C-x o,org-toggle-ordered-property} @vindex org-track-ordered-property-with-tag @cindex property, ORDERED Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must @@ -4125,8 +4278,7 @@ this should be local to the current entry, not inherited like a tag. However, if you would like to @i{track} the value of this property with a tag for better visibility, customize the variable @code{org-track-ordered-property-with-tag}. -@kindex C-c # -@item C-c # +@orgcmd{C-c #,org-update-statistics-cookies} Update the statistics cookie in the current outline entry. When called with a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make @@ -4220,8 +4372,7 @@ After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is also a special command for inserting tags: @table @kbd -@kindex C-c C-q -@item C-c C-q +@orgcmd{C-c C-q,org-set-tags-command} @cindex completion, of tags @vindex org-tags-column Enter new tags for the current headline. Org-mode will either offer @@ -4231,8 +4382,7 @@ to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all tags in the current buffer will be aligned to that column, just to make things look nice. TAGS are automatically realigned after promotion, demotion, and TODO state changes (@pxref{TODO basics}). -@kindex C-c C-c -@item C-c C-c +@orgcmd{C-c C-c,org-set-tags-command} When the cursor is in a headline, this does the same as @kbd{C-c C-q}. @end table @@ -4399,18 +4549,13 @@ Once a system of tags has been set up, it can be used to collect related information into special lists. @table @kbd -@kindex C-c \ -@kindex C-c / m -@item C-c \ -@itemx C-c / m +@orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree} Create a sparse tree with all headlines matching a tags search. With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. -@kindex C-c a m -@item C-c a m +@orgcmd{C-c a m,org-tags-view} Create a global list of tag matches from all agenda files. @xref{Matching tags and properties}. -@kindex C-c a M -@item C-c a M +@orgcmd{C-c a M,org-tags-view} @vindex org-tags-match-list-sublevels Create a global list of tag matches from all agenda files, but check only TODO items and force checking subitems (see variable @@ -4511,33 +4656,29 @@ Org files. The following commands help to work with properties: @table @kbd -@kindex M-@key{TAB} -@item M-@key{TAB} +@orgcmd{M-@key{TAB},org-complete} After an initial colon in a line, complete property keys. All keys used in the current file will be offered as possible completions. -@kindex C-c C-x p -@item C-c C-x p +@orgcmd{C-c C-x p,org-set-property} Set a property. This prompts for a property name and a value. If necessary, the property drawer is created as well. @item M-x org-insert-property-drawer +@findex org-insert-property-drawer Insert a property drawer into the current entry. The drawer will be inserted early in the entry, but after the lines with planning information like deadlines. -@kindex C-c C-c -@item C-c C-c +@orgcmd{C-c C-c,org-property-action} With the cursor in a property drawer, this executes property commands. -@item C-c C-c s +@orgcmd{C-c C-c s,org-set-property} Set a property in the current entry. Both the property and the value can be inserted using completion. -@kindex S-@key{right} -@kindex S-@key{left} -@item S-@key{left}/@key{right} +@orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value} Switch property at point to the next/previous allowed value. -@item C-c C-c d +@orgcmd{C-c C-c d,org-delete-property} Remove a property from the current entry. -@item C-c C-c D +@orgcmd{C-c C-c D,org-delete-property-globally} Globally remove a property, from all entries in the current file. -@item C-c C-c c +@orgcmd{C-c C-c c,org-compute-property-at-point} Compute the property at point, using the operator and scope from the nearest column format definition. @end table @@ -4592,18 +4733,13 @@ ITEM @r{The content of the entry.} To create sparse trees and special lists with selection based on properties, the same commands are used as for tag searches (@pxref{Tag searches}). @table @kbd -@kindex C-c \ -@kindex C-c / m -@item C-c \ -@itemx C-c / m +@orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree} Create a sparse tree with all matching entries. With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. -@kindex C-c a m -@item C-c a m +@orgcmd{C-c a m,org-tags-view} Create a global list of tag/property matches from all agenda files. @xref{Matching tags and properties}. -@kindex C-c a M -@item C-c a M +@orgcmd{C-c a M,org-tags-view} @vindex org-tags-match-list-sublevels Create a global list of tag matches from all agenda files, but check only TODO items and force checking of subitems (see variable @@ -4617,12 +4753,11 @@ There is also a special command for creating sparse trees based on a single property: @table @kbd -@kindex C-c / p -@item C-c / p +@orgkey{C-c / p} Create a sparse tree based on the value of a property. This first prompts for the name of a property, and then for a value. A sparse tree is created with all entries that define this property with the given -value. If you enclose the value into curly braces, it is interpreted as +value. If you enclose the value in curly braces, it is interpreted as a regular expression and matched against the property values. @end table @@ -4632,7 +4767,7 @@ a regular expression and matched against the property values. @cindex inheritance, of properties @vindex org-use-property-inheritance -The outline structure of Org-mode documents lends itself for an +The outline structure of Org-mode documents lends itself to an inheritance model of properties: if the parent in a tree has a certain property, the children can inherit this property. Org-mode does not turn this on by default, because it can slow down property searches @@ -4642,7 +4777,7 @@ useful, you can turn it on by setting the variable all properties inherited from the parent, to a list of properties that should be inherited, or to a regular expression that matches inherited properties. If a property has the value @samp{nil}, this is -interpreted as an explicit undefine of he property, so that inheritance +interpreted as an explicit undefine of the property, so that inheritance search will stop at this value and return @code{nil}. Org-mode has a few properties for which inheritance is hard-coded, at @@ -4784,7 +4919,7 @@ same summary information. The @code{est+} summary type requires further explanation. It is used for combining estimates, expressed as low-high ranges. For example, instead of estimating a particular task will take 5 days, you might estimate it as -5-6 days if you're fairly confident you know how much woark is required, or +5-6 days if you're fairly confident you know how much work is required, or 1-10 days if you don't really know what needs to be done. Both ranges average at 5.5 days, but the first represents a more predictable delivery. @@ -4829,8 +4964,7 @@ in the subtree. @table @kbd @tsubheading{Turning column view on and off} -@kindex C-c C-x C-c -@item C-c C-x C-c +@orgcmd{C-c C-x C-c,org-columns} @vindex org-columns-default-format Turn on column view. If the cursor is before the first headline in the file, column view is turned on for the entire file, using the @code{#+COLUMNS} @@ -4841,14 +4975,11 @@ for the tree starting at the entry that contains the @code{:COLUMNS:} property. If no such property is found, the format is taken from the @code{#+COLUMNS} line or from the variable @code{org-columns-default-format}, and column view is established for the current entry and its subtree. -@kindex r -@item r +@orgcmd{r,org-columns-redo} Recreate the column view, to include recent changes made in the buffer. -@kindex g -@item g +@orgcmd{g,org-columns-redo} Same as @kbd{r}. -@kindex q -@item q +@orgcmd{q,org-columns-quit} Exit column view. @tsubheading{Editing values} @item @key{left} @key{right} @key{up} @key{down} @@ -4859,40 +4990,30 @@ Move through the column view from field to field. Switch to the next/previous allowed value of the field. For this, you have to have specified allowed values for a property. @item 1..9,0 -Directly select the nth allowed value, @kbd{0} selects the 10th value. -@kindex n -@kindex p -@itemx n / p +Directly select the Nth allowed value, @kbd{0} selects the 10th value. +@orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value} Same as @kbd{S-@key{left}/@key{right}} -@kindex e -@item e +@orgcmd{e,org-columns-edit-value} Edit the property at point. For the special properties, this will invoke the same interface that you normally use to change that property. For example, when editing a TAGS property, the tag completion or fast selection interface will pop up. -@kindex C-c C-c -@item C-c C-c +@orgcmd{C-c C-c,org-columns-set-tags-or-toggle} When there is a checkbox at point, toggle it. -@kindex v -@item v +@orgcmd{v,org-columns-show-value} View the full value of this property. This is useful if the width of the column is smaller than that of the value. -@kindex a -@item a +@orgcmd{a,org-columns-edit-allowed} Edit the list of allowed values for this property. If the list is found in the hierarchy, the modified values is stored there. If no list is found, the new value is stored in the first entry that is part of the current column view. @tsubheading{Modifying the table structure} -@kindex < -@kindex > -@item < / > +@orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen} Make the column narrower/wider by one character. -@kindex S-M-@key{right} -@item S-M-@key{right} +@orgcmd{S-M-@key{right},org-columns-new} Insert a new column, to the left of the current column. -@kindex S-M-@key{left} -@item S-M-@key{left} +@orgcmd{S-M-@key{left},org-columns-delete} Delete the current column. @end table @@ -4948,20 +5069,16 @@ column view is @code{ITEM}. The following commands insert or update the dynamic block: @table @kbd -@kindex C-c C-x i -@item C-c C-x i +@orgcmd{C-c C-x i,org-insert-columns-dblock} Insert a dynamic block capturing a column view. You will be prompted for the scope or ID of the view. -@kindex C-c C-c -@item C-c C-c -@kindex C-c C-x C-u -@itemx C-c C-x C-u +@orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update} Update dynamic block at point. The cursor needs to be in the @code{#+BEGIN} line of the dynamic block. -@kindex C-u C-c C-x C-u -@item C-u C-c C-x C-u +@orgcmd{C-u C-c C-x C-u,org-update-all-dblocks} Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if -you have several clock table blocks in a buffer. +you have several clock table blocks, column-capturing blocks or other dynamic +blocks in a buffer. @end table You can add formulas to the column view table and you may add plotting @@ -5006,7 +5123,6 @@ is used in a much wider sense. * Creating timestamps:: Commands which insert timestamps * Deadlines and scheduling:: Planning your work * Clocking work time:: Tracking how long you spend on a task -* Resolving idle time:: Resolving time if you've been idle * Effort estimates:: Planning work effort in advance * Relative timer:: Notes with a running timer * Countdown timer:: Starting a countdown timer for a task @@ -5130,17 +5246,11 @@ instead. Access the agenda for the date given by the timestamp or -range at point (@pxref{Weekly/daily agenda}). @c -@kindex S-@key{left} -@kindex S-@key{right} -@item S-@key{left} -@itemx S-@key{right} +@orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day} Change date at cursor by one day. These key bindings conflict with shift-selection and related modes (@pxref{Conflicts}). @c -@kindex S-@key{up} -@kindex S-@key{down} -@item S-@key{up} -@itemx S-@key{down} +@orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down} Change the item under the cursor in a timestamp. The cursor can be on a year, month, day, hour or minute. When the timestamp contains a time range like @samp{15:30-16:30}, modifying the first time will also shift the second, @@ -5150,9 +5260,8 @@ timestamp, these same keys modify the priority of an item. (@pxref{Priorities}). The key bindings also conflict with shift-selection and related modes (@pxref{Conflicts}). @c -@kindex C-c C-y +@orgcmd{C-c C-y,org-evaluate-time-range} @cindex evaluate time range -@item C-c C-y Evaluate a time range by computing the difference between start and end. With a prefix argument, insert result after the time range (in a table: into the following column). @@ -5215,7 +5324,7 @@ letter ([dwmy]) to indicate change in days, weeks, months, or years. With a single plus or minus, the date is always relative to today. With a double plus or minus, it is relative to the default date. If instead of a single letter, you use the abbreviation of day name, the date will be -the nth such day. E.g. +the Nth such day. E.g. @example +0 --> today @@ -5234,7 +5343,7 @@ you want to use unabbreviated names and/or other languages, configure the variables @code{parse-time-months} and @code{parse-time-weekdays}. 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 +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. @example @@ -5298,8 +5407,7 @@ customizing the variables @code{org-display-custom-times} and @code{org-time-stamp-custom-formats}. @table @kbd -@kindex C-c C-x C-t -@item C-c C-x C-t +@orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays} Toggle the display of custom formats for dates and times. @end table @@ -5320,7 +5428,7 @@ just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the time will be changed by one minute. @item If the timestamp contains a range of clock times or a repeater, these -will not be overlayed, but remain in the buffer as they were. +will not be overlaid, but remain in the buffer as they were. @item When you delete a timestamp character-by-character, it will only disappear from the buffer after @emph{all} (invisible) characters @@ -5372,8 +5480,8 @@ The headline will be listed under the given date@footnote{It will still be listed on that date after it has been marked DONE. If you don't like this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In addition, a reminder that the scheduled date has passed will be present -in the compilation for @emph{today}, until the entry is marked DONE. -I.e. the task will automatically be forwarded until completed. +in the compilation for @emph{today}, until the entry is marked DONE, i.e. +the task will automatically be forwarded until completed. @example *** TODO Call Trillian for a date on New Years Eve. @@ -5415,8 +5523,7 @@ an item: @table @kbd @c -@kindex C-c C-d -@item C-c C-d +@orgcmd{C-c C-d,org-deadline} Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen in the line directly following the headline. When called with a prefix arg, an existing deadline will be removed from the entry. Depending on the @@ -5426,8 +5533,7 @@ and @code{nologredeadline}}, a note will be taken when changing an existing deadline. @c FIXME Any CLOSED timestamp will be removed.???????? @c -@kindex C-c C-s -@item C-c C-s +@orgcmd{C-c C-s,org-schedule} Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will happen in the line directly following the headline. Any CLOSED timestamp will be removed. When called with a prefix argument, remove the scheduling @@ -5437,18 +5543,16 @@ keywords @code{logredeadline}, @code{lognoteredeadline}, and @code{nologredeadline}}, a note will be taken when changing an existing scheduling time. @c -@kindex C-c C-x C-k +@orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action} @kindex k a @kindex k s -@item C-c C-x C-k Mark the current entry for agenda action. After you have marked the entry like this, you can open the agenda or the calendar to find an appropriate date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to schedule the marked item. @c -@kindex C-c / d +@orgcmd{C-c / d,org-check-deadlines} @cindex sparse tree, for deadlines -@item C-c / d @vindex org-deadline-warning-days Create a sparse tree with all deadlines that are either past-due, or which will become due within @code{org-deadline-warning-days}. @@ -5456,12 +5560,10 @@ With @kbd{C-u} prefix, show all deadlines in the file. With a numeric prefix, check that many days. For example, @kbd{C-1 C-c / d} shows all deadlines due tomorrow. @c -@kindex C-c / b -@item C-c / b +@orgcmd{C-c / b,org-check-before-date} Sparse tree for deadlines and scheduled items before a given date. @c -@kindex C-c / a -@item C-c / a +@orgcmd{C-c / a,org-check-after-date} Sparse tree for deadlines and scheduled items after a given date. @end table @@ -5520,11 +5622,11 @@ With the @samp{+1m} cookie, the date shift will always be exactly one month. So if you have not paid the rent for three months, marking this entry DONE will still keep it as an overdue deadline. Depending on the task, this may not be the best way to handle it. For example, if you -forgot to call you father for 3 weeks, it does not make sense to call +forgot to call your father for 3 weeks, it does not make sense to call him 3 times in a single day to make up for it. Finally, there are tasks like changing batteries which should always repeat a certain time @i{after} the last time you did it. For these tasks, Org-mode has -special repeaters markers with @samp{++} and @samp{.+}. For example: +special repeaters @samp{++} and @samp{.+}. For example: @example ** TODO Call Father @@ -5547,8 +5649,10 @@ subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was created for this purpose, it is described in @ref{Structure editing}. -@node Clocking work time, Resolving idle time, Deadlines and scheduling, Dates and Times +@node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times @section Clocking work time +@cindex clocking time +@cindex time clocking Org-mode allows you to clock the time you spend on specific tasks in a project. When you start working on an item, you can start the clock. @@ -5569,9 +5673,17 @@ on this task while outside Emacs, use @code{(setq org-clock-persist t)}.} will be found (@pxref{Resolving idle time}) and you will be prompted about what to do with it. +@menu +* Clocking commands:: Starting and stopping a clock +* The clock table:: Detailed reports +* Resolving idle time:: Resolving time when you've been idle +@end menu + +@node Clocking commands, The clock table, Clocking work time, Clocking work time +@subsection Clocking commands + @table @kbd -@kindex C-c C-x C-i -@item C-c C-x C-i +@orgcmd{C-c C-x C-i,org-clock-in} @vindex org-clock-into-drawer 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 @@ -5601,8 +5713,8 @@ show all time clocked on this tasks today (see also the variable @code{auto} which is the default@footnote{See also the variable @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the mode line entry will pop up a menu with clocking options. -@kindex C-c C-x C-o -@item C-c C-x C-o +@c +@orgcmd{C-c C-x C-o,org-clock-out} @vindex org-log-note-clock-out Stop the clock (clock-out). This inserts another timestamp at the same location where the clock was last started. It also directly computes @@ -5611,29 +5723,24 @@ HH:MM}. See the variable @code{org-log-note-clock-out} for the possibility to record an additional note together with the clock-out timestamp@footnote{The corresponding in-buffer setting is: @code{#+STARTUP: lognoteclock-out}}. -@kindex C-c C-x C-e -@item C-c C-x C-e +@orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate} Update the effort estimate for the current clock task. @kindex C-c C-y @kindex C-c C-c -@item C-c C-y @ @ @r{or}@ @ C-c C-c +@orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range} Recompute the time interval after changing one of the timestamps. This is only necessary if you edit the timestamps directly. If you change them with @kbd{S-@key{cursor}} keys, the update is automatic. -@kindex C-c C-t -@item C-c C-t +@orgcmd{C-c C-t,org-todo} Changing the TODO state of an item to DONE automatically stops the clock if it is running in this same item. -@kindex C-c C-x C-x -@item C-c C-x C-x +@orgcmd{C-c C-x C-x,org-clock-cancel} Cancel the current clock. This is useful if a clock was started by mistake, or if you ended up working on something else. -@kindex C-c C-x C-j -@item C-c C-x C-j +@orgcmd{C-c C-x C-j,org-clock-goto} Jump to the headline of the currently clocked in task. With a @kbd{C-u} prefix arg, select the target task from a list of recently clocked tasks. -@kindex C-c C-x C-d -@item C-c C-x C-d +@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 @@ -5641,24 +5748,60 @@ recorded under that heading, including the time of any subheadings. You can use visibility cycling to study the tree, but the overlays disappear when you change the buffer (see variable @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}. -@kindex C-c C-x C-r -@item C-c C-x C-r +@end table + +The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in +the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been +worked on or closed during a day. + +@node The clock table, Resolving idle time, Clocking commands, Clocking work time +@subsection The clock table +@cindex clocktable, dynamic block +@cindex report, of clocked time + +Org mode can produce quite complex reports based on the time clocking +information. Such a report is called a @emph{clock table}, because it is +formatted as one or several Org tables. + +@table @kbd +@orgcmd{C-c C-x C-r,org-clock-report} Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock report as an Org-mode table into the current file. When the cursor is at an existing clock table, just update it. When called with a prefix argument, jump to the first clock report in the current document and update it. +@orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update} +Update dynamic block at point. The cursor needs to be in the +@code{#+BEGIN} line of the dynamic block. +@orgkey{C-u C-c C-x C-u} +Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if +you have several clock table blocks in a buffer. +@orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift} +Shift the current @code{:block} interval and update the table. The cursor +needs to be in the @code{#+BEGIN: clocktable} line for this command. If +@code{:block} is @code{today}, it will be shifted to @code{today-1} etc. +@end table + + +Here is an example of the frame for a clock table as it is inserted into the +buffer with the @kbd{C-c C-x C-r} command: + @cindex #+BEGIN, clocktable @example #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file #+END: clocktable @end example @noindent -If such a block already exists at point, its content is replaced by the -new table. The @samp{BEGIN} line can specify options: +@vindex org-clocktable-defaults +The @samp{BEGIN} line and specify a number of options to define the scope, +structure, and formatting of the report. Defaults for all these options can +be configured in the variable @code{org-clocktable-defaults}. + +@noindent First there are options that determine which clock entries are to +be selected: @example :maxlevel @r{Maximum level depth to which times are listed in the table.} -:emphasize @r{When @code{t}, emphasize level one and level two items.} + @r{Clocks at deeper levels will be summed into the upper level.} :scope @r{The scope to consider. This can be any of the following:} nil @r{the current buffer or narrowed region} file @r{the full current buffer} @@ -5675,6 +5818,7 @@ new table. The @samp{BEGIN} line can specify options: 2007-12-31 @r{New year eve 2007} 2007-12 @r{December 2007} 2007-W50 @r{ISO-week 50 in 2007} + 2007-Q2 @r{2nd quarter in 2007} 2007 @r{the year 2007} today, yesterday, today-@var{N} @r{a relative day} thisweek, lastweek, thisweek-@var{N} @r{a relative week} @@ -5685,15 +5829,33 @@ new table. The @samp{BEGIN} line can specify options: :tend @r{A time string specifying when to stop considering times.} :step @r{@code{week} or @code{day}, to split the table into chunks.} @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.} -:stepskip0 @r{Don't show steps that have zero time} -:tags @r{A tags match to select entries that should contribute} +: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}. +@end example + +Then there are options which determine the formatting of the table. There +options are interpreted by the function @code{org-clocktable-write-default}, +but you can specify your own function using the @code{:formatter} parameter. +@example +:emphasize @r{When @code{t}, emphasize level one and level two items.} :link @r{Link the item headlines in the table to their origins.} +:narrow @r{An integer to limit the width of the headline column in} + @r{the org table. If you write it like @samp{50!}, then the} + @r{headline will also be shortened in export.} +:indent @r{Indent each headline field according to its level.} +:tcolumns @r{Number of columns to be used for times. If this is smaller} + @r{than @code{:maxlevel}, lower levels will be lumped into one column.} +:level @r{Should a level number column be included?} +:compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}} + @r{All are overwritten except if there is an explicit @code{:narrow}} +:timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,} + @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.} :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.} @r{As a special case, @samp{:formula %} adds a column with % time.} - @r{If you do not specify a formula here, any existing formula.} + @r{If you do not specify a formula here, any existing formula} @r{below the clock table will survive updates and be evaluated.} -:timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,} - @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.} +:formatter @r{A function to format clock data and insert it into the buffer.} @end example To get a clock summary of the current level 1 tree, for the current day, you could write @@ -5715,31 +5877,15 @@ A summary of the current subtree with % times would be #+BEGIN: clocktable :scope subtree :link t :formula % #+END: clocktable @end example -@kindex C-c C-c -@item C-c C-c -@kindex C-c C-x C-u -@itemx C-c C-x C-u -Update dynamic block at point. The cursor needs to be in the -@code{#+BEGIN} line of the dynamic block. -@kindex C-u C-c C-x C-u -@item C-u C-c C-x C-u -Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if -you have several clock table blocks in a buffer. -@kindex S-@key{left} -@kindex S-@key{right} -@item S-@key{left} -@itemx S-@key{right} -Shift the current @code{:block} interval and update the table. The cursor -needs to be in the @code{#+BEGIN: clocktable} line for this command. If -@code{:block} is @code{today}, it will be shifted to @code{today-1} etc. -@end table - -The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in -the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been -worked on or closed during a day. +A horizontally compact representation of everything clocked during last week +would be +@example +#+BEGIN: clocktable :scope agenda :block lastweek :compact t +#+END: clocktable +@end example -@node Resolving idle time, Effort estimates, Clocking work time, Dates and Times -@section Resolving idle time +@node Resolving idle time, , The clock table, Clocking work time +@subsection Resolving idle time @cindex resolve idle time @cindex idle, resolve, dangling @@ -5800,13 +5946,13 @@ If you restart Emacs and clock into any task, Org will notice that you have a 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's just happening due to a recovery event rather than a set amount of idle time. You can also check all the files visited by your Org agenda for dangling clocks at any time using @kbd{M-x org-resolve-clocks}. -@node Effort estimates, Relative timer, Resolving idle time, Dates and Times +@node Effort estimates, Relative timer, Clocking work time, Dates and Times @section Effort estimates @cindex effort estimates @@ -5822,13 +5968,11 @@ used with the variable @code{org-effort-property}.}. You can set the effort for an entry with the following commands: @table @kbd -@kindex C-c C-x e -@item C-c C-x e +@orgcmd{C-c C-x e,org-set-effort} Set the effort estimate for the current entry. With a numeric prefix -argument, set it to the NTH allowed value (see below). This command is also +argument, set it to the Nth allowed value (see below). This command is also accessible from the agenda with the @kbd{e} key. -@kindex C-c C-x C-e -@item C-c C-x C-e +@orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate} Modify the effort estimate of the item currently being clocked. @end table @@ -5880,29 +6024,27 @@ be useful to have access to times relative to a starting time. Org provides such a relative timer and make it easy to create timed notes. @table @kbd -@kindex C-c C-x . -@item C-c C-x . +@orgcmd{C-c C-x .,org-timer} Insert a relative time into the buffer. The first time you use this, the timer will be started. When called with a prefix argument, the timer is restarted. -@kindex C-c C-x - -@item C-c C-x - +@orgcmd{C-c C-x -,org-timer-item} Insert a description list item with the current relative time. With a prefix argument, first reset the timer to 0. -@kindex M-@key{RET} -@item M-@key{RET} +@orgcmd{M-@key{RET},org-insert-heading} Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert new timer items. +@c for key sequences with a comma, command name macros fail :( @kindex C-c C-x , @item C-c C-x , -Pause the timer, or continue it if it is already paused. +Pause the timer, or continue it if it is already paused +(@command{org-timer-pause-or-continue}). @c removed the sentence because it is redundant to the following item @kindex C-u C-c C-x , @item C-u C-c C-x , Stop the timer. After this, you can only start a new timer, not continue the old one. This command also removes the timer from the mode line. -@kindex C-c C-x 0 -@item C-c C-x 0 +@orgcmd{C-c C-x 0,org-timer-start} Reset the timer without inserting anything into the buffer. By default, the timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to specific starting offset. The user is prompted for the offset, with a @@ -5994,31 +6136,31 @@ suggestion.} for capturing new material. @subsection Using capture @table @kbd -@kindex C-c c -@item C-c c -Call the command @code{org-capture}. If you have templates defined -@pxref{Capture templates}, it will offer these templates for selection or use -a new Org outline node as the default template. It will insert the template -into the target file and switch to an indirect buffer narrowed to this new -node. You may then insert the information you want. - -@kindex C-c C-c -@item C-c C-c -Once you have finished entering information into the capture buffer, -@kbd{C-c C-c} will return you to the window configuration before the capture -process, so that you can resume your work without further distraction. - -@kindex C-c C-w -@item C-c C-w +@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 +defined @pxref{Capture templates}, it will offer these templates for +selection or use a new Org outline node as the default template. It will +insert the template into the target file and switch to an indirect buffer +narrowed to this new node. You may then insert the information you want. + +@orgcmd{C-c C-c,org-capture-finalize} +Once you have finished entering information into the capture buffer, @kbd{C-c +C-c} will return you to the window configuration before the capture process, +so that you can resume your work without further distraction. When called +with a prefix arg, finalize and then jump to the captured item. + +@orgcmd{C-c C-w,org-capture-refile} Finalize the capture process by refiling (@pxref{Refiling notes}) the note to a different place. Please realize that this is a normal refiling command -that will be executed - so the cursor position at the moment you run this +that will be executed---so the cursor position at the moment you run this command is important. If you have inserted a tree with a parent and -children, first move the cursor back to the parent. +children, first move the cursor back to the parent. Any prefix argument +given to this command will be passed on to the @code{org-refile} command. -@kindex C-c C-k -@item C-c C-k +@orgcmd{C-c C-k,org-capture-kill} Abort the capture process and return to the previous state. + @end table You can also call @code{org-capture} in a special way from the agenda, using @@ -6026,6 +6168,17 @@ the @kbd{k c} key combination. With this access, any timestamps inserted by the selected capture template will default to the cursor date in the agenda, rather than to the current date. +To find the locations of the last stored capture, use @code{org-capture} with +prefix commands: + +@table @kbd +@orgkey{C-u C-c c} +Visit the target location of a cpature template. You get to select the +template in the usual way. +@orgkey{C-u C-u C-c c} +Visit the last stored capture item in its buffer. +@end table + @node Capture templates, , Using capture, Capture @subsection Capture templates @cindex templates, for Capture @@ -6035,8 +6188,7 @@ for different target locations. The easiest way to create such templates is through the customize interface. @table @kbd -@kindex C-c c C -@item C-c c C +@orgkey{C-c c C} Customize the variable @code{org-capture-templates}. @end table @@ -6124,7 +6276,7 @@ Text to be inserted as it is. @vindex org-default-notes-file Specification of where the captured item should be placed. In Org-mode files, targets usually define a node. Entries will become children of this -node, other types will be added to the table or list in the body of this +node. 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}. @@ -6146,7 +6298,10 @@ For non-unique headings, the full path is safer. Use a regular expression to position the cursor. @item (file+datetree "path/to/file") -Will create a heading in a date tree. +Will create a heading in a date tree for today's date. + +@item (file+datetree+prompt "path/to/file") +Will create a heading in a date tree, but will prompt for the date. @item (file+function "path/to/file" function-finding-location) A function to find the right location in the file. @@ -6302,15 +6457,13 @@ directory. @table @kbd -@kindex C-c C-a -@item C-c C-a +@orgcmd{C-c C-a,org-attach} The dispatcher for commands related to the attachment system. After these keys, a list of commands is displayed and you must press an additional key to select a command: @table @kbd -@kindex C-c C-a a -@item a +@orgcmdtkc{a,C-c C-a a,org-attach-attach} @vindex org-attach-method Select a file and move it into the task's attachment directory. The file will be copied, moved, or linked, depending on @code{org-attach-method}. @@ -6323,52 +6476,42 @@ Note that hard links are not supported on all systems. Attach a file using the copy/move/link method. Note that hard links are not supported on all systems. -@kindex C-c C-a n -@item n +@orgcmdtkc{n,C-c C-a n,org-attach-new} Create a new attachment as an Emacs buffer. -@kindex C-c C-a z -@item z +@orgcmdtkc{z,C-c C-a z,org-attach-sync} Synchronize the current task with its attachment directory, in case you added attachments yourself. -@kindex C-c C-a o -@item o +@orgcmdtkc{p,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}. For more details, see the information on following hyperlinks (@pxref{Handling links}). -@kindex C-c C-a O -@item O +@orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs} Also open the attachment, but force opening the file in Emacs. -@kindex C-c C-a f -@item f +@orgcmdtkc{f,C-c C-a f,org-attach-reveal} Open the current task's attachment directory. -@kindex C-c C-a F -@item F +@orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs} Also open the directory, but force using @command{dired} in Emacs. -@kindex C-c C-a d -@item d +@orgcmdtkc{d,C-c C-a d,org-attach-delete-one} Select and delete a single attachment. -@kindex C-c C-a D -@item D +@orgcmdtkc{D,C-c C-a D,org-attach-delete-all} Delete all of a task's attachments. A safer way is to open the directory in @command{dired} and delete from there. -@kindex C-c C-a s -@item C-c C-a s +@orgcmdtkc{s,C-c C-a s,org-attach-set-directory} @cindex property, ATTACH_DIR Set a specific directory as the entry's attachment directory. This works by putting the directory path into the @code{ATTACH_DIR} property. -@kindex C-c C-a i -@item C-c C-a i +@orgcmdtkc{i,C-c C-a i,org-attach-set-inherit} @cindex property, ATTACH_DIR_INHERIT Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the same directory for attachments as the parent does. @@ -6401,12 +6544,11 @@ will configure that new items from the feed provided by the following command is used: @table @kbd -@kindex C-c C-x g +@orgcmd{C-c C-x g,org-feed-update-all} @item C-c C-x g Collect items from the feeds configured in @code{org-feed-alist} and act upon them. -@kindex C-c C-x G -@item C-c C-x G +@orgcmd{C-c C-x G,org-feed-goto-inbox} Prompt for a feed name and go to the inbox configured for this feed. @end table @@ -6446,8 +6588,7 @@ right location, and then pasting the note is cumbersome. To simplify this process, you can use the following special command: @table @kbd -@kindex C-c C-w -@item C-c C-w +@orgcmd{C-c C-w,org-refile} @vindex org-reverse-note-order @vindex org-refile-targets @vindex org-refile-use-outline-path @@ -6472,17 +6613,18 @@ 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 recorded when an entry has been refiled. -@kindex C-u C-c C-w -@item C-u C-c C-w +@orgkey{C-u C-c C-w} Use the refile interface to jump to a heading. -@kindex C-u C-u C-c C-w -@item C-u C-u C-c C-w +@orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored} Jump to the location where @code{org-refile} last moved a tree to. @item C-2 C-c C-w Refile as the child of the item currently being clocked. @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w + +@orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C-w,org-refile-cache-clear} + Clear the target cache. Caching of refile targets can be turned on by -setting @code{org-refile-use-cache}. To make the command seen new possible +setting @code{org-refile-use-cache}. To make the command see new possible targets, you have to clear the cache with this command. @end table @@ -6496,8 +6638,7 @@ agenda. Archiving is important to keep your working files compact and global searches like the construction of agenda views fast. @table @kbd -@kindex C-c C-x C-a -@item C-c C-x C-a +@orgcmd{C-c C-x C-a,org-archive-subtree-default} @vindex org-archive-default-command Archive the current entry using the command specified in the variable @code{org-archive-default-command}. @@ -6516,14 +6657,11 @@ The most common archiving action is to move a project tree to another file, the archive file. @table @kbd -@kindex C-c $ -@kindex C-c C-x C-s -@item C-c C-x C-s@ @r{or short} @ C-c $ +@orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree} @vindex org-archive-location Archive the subtree starting at the cursor position to the location given by @code{org-archive-location}. -@kindex C-u C-c C-x C-s -@item C-u C-c C-x C-s +@orgkey{C-u C-c C-x C-s} Check if any direct children of the current headline could be moved to the archive. To do this, each subtree is checked for open TODO entries. If none are found, the command offers to move it to the archive @@ -6606,23 +6744,19 @@ Archived trees are excluded from column view unless the variable The following commands help manage the ARCHIVE tag: @table @kbd -@kindex C-c C-x a -@item C-c C-x a +@orgcmd{C-c C-x a,org-toggle-archive-tag} Toggle the ARCHIVE tag for the current headline. When the tag is set, the headline changes to a shadowed face, and the subtree below it is hidden. -@kindex C-u C-c C-x a -@item C-u C-c C-x a +@orgkey{C-u C-c C-x a} Check if any direct children of the current headline should be archived. To do this, each subtree is checked for open TODO entries. If none are found, the command offers to set the ARCHIVE tag for the child. If the cursor is @emph{not} on a headline when this command is invoked, the level 1 trees will be checked. -@kindex C-@kbd{TAB} -@item C-@kbd{TAB} +@orgcmd{C-@kbd{TAB},org-force-cycle-archived} Cycle a tree even if it is tagged with ARCHIVE. -@kindex C-c C-x A -@item C-c C-x A +@orgcmd{C-c C-x A,org-archive-to-archive-sibling} Move the current entry to the @emph{Archive Sibling}. This is a sibling of the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The entry becomes a child of that sibling and in this way retains a lot of its @@ -6715,18 +6849,15 @@ the easiest way to maintain it is through the following commands @cindex files, adding to agenda list @table @kbd -@kindex C-c [ -@item C-c [ +@orgcmd{C-c [,org-agenda-to-front} Add current file to the list of agenda files. The file is added to the front of the list. If it was already in the list, it is moved to the front. With a prefix argument, file is added/moved to the end. -@kindex C-c ] -@item C-c ] +@orgcmd{C-c ],org-remove-file} Remove current file from the list of agenda files. @kindex C-, -@kindex C-' -@item C-, -@itemx C-' +@orgcmd{C-',org-cycle-agenda-files} +@itemx C-, Cycle through agenda file list, visiting one file after the other. @kindex M-x org-iswitchb @item M-x org-iswitchb @@ -6746,16 +6877,14 @@ you may press @kbd{<} once or several times in the dispatcher extended period, use the following commands: @table @kbd -@kindex C-c C-x < -@item C-c C-x < +@orgcmd{C-c C-x <,org-agenda-set-restriction-lock} Permanently restrict the agenda to the current subtree. When with a prefix argument, or with the cursor before the first headline in a file, the agenda scope is set to the entire file. This restriction remains in effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<} or @kbd{>} in the agenda dispatcher. If there is a window displaying an agenda view, the new restriction takes effect immediately. -@kindex C-c C-x > -@item C-c C-x > +@orgcmd{C-c C-x >,org-agenda-remove-restriction-lock} Remove the permanent restriction created by @kbd{C-c C-x <}. @end table @@ -6763,14 +6892,12 @@ Remove the permanent restriction created by @kbd{C-c C-x <}. When working with @file{speedbar.el}, you can use the following commands in the Speedbar frame: @table @kbd -@kindex < -@item < @r{in the speedbar frame} +@orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction} Permanently restrict the agenda to the item---either an Org file or a subtree in such a file---at the cursor in the Speedbar frame. If there is a window displaying an agenda view, the new restriction takes effect immediately. -@kindex > -@item > @r{in the speedbar frame} +@orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock} Lift the restriction. @end table @@ -6850,18 +6977,23 @@ paper agenda, showing all the tasks for the current week or day. @table @kbd @cindex org-agenda, command -@kindex C-c a a -@item C-c a a -@vindex org-agenda-ndays +@orgcmd{C-c a a,org-agenda-list} Compile an agenda for the current week from a list of Org files. The agenda shows the entries for each day. With a numeric prefix@footnote{For backward compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be listed before the agenda. This feature is deprecated, use the dedicated TODO list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1 -C-c a a}) you may set the number of days to be displayed (see also the -variable @code{org-agenda-ndays}) +C-c a a}) you may set the number of days to be displayed. @end table +@vindex org-agenda-span +@vindex org-agenda-ndays +The default number of days displayed in the agenda is set by the variable +@code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This +variable can be set to any number of days you want to see by default in the +agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or +@code{year}. + Remote editing from the agenda buffer means, for example, that you can change the dates of deadlines and appointments from the agenda buffer. The commands available in the Agenda buffer are listed in @ref{Agenda @@ -6972,22 +7104,20 @@ The global TODO list contains all unfinished TODO items formatted and collected into a single place. @table @kbd -@kindex C-c a t -@item C-c a t +@orgcmd{C-c a t,org-todo-list} Show the global TODO list. This collects the TODO items from all agenda files (@pxref{Agenda Views}) into a single buffer. By default, this lists items with a state the is not a DONE state. The buffer is in @code{agenda-mode}, so there are commands to examine and manipulate the TODO entries directly from that buffer (@pxref{Agenda commands}). -@kindex C-c a T -@item C-c a T +@orgcmd{C-c a T,org-todo-list} @cindex TODO keyword matching @vindex org-todo-keywords Like the above, but allows selection of a specific TODO keyword. You can also do this by specifying a prefix argument to @kbd{C-c a t}. You are prompted for a keyword, and you may also specify several keywords by separating them with @samp{|} as the boolean OR operator. With a numeric -prefix, the nth keyword in @code{org-todo-keywords} is selected. +prefix, the Nth keyword in @code{org-todo-keywords} is selected. @kindex r The @kbd{r} key in the agenda buffer regenerates it, and you can give a prefix argument to this command to change the selected TODO keyword, @@ -7009,13 +7139,15 @@ it more compact: @item @vindex org-agenda-todo-ignore-scheduled @vindex org-agenda-todo-ignore-deadlines +@vindex org-agenda-todo-ignore-timestamp @vindex org-agenda-todo-ignore-with-date Some people view a TODO item that has been @emph{scheduled} for execution or have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}. Configure the variables @code{org-agenda-todo-ignore-scheduled}, -@code{org-agenda-todo-ignore-deadlines}, and/or -@code{org-agenda-todo-ignore-with-date} to exclude such items from the -global TODO list. +@code{org-agenda-todo-ignore-deadlines}, +@code{org-agenda-todo-ignore-timestamp} and/or +@code{org-agenda-todo-ignore-with-date} to exclude such items from the global +TODO list. @item @vindex org-agenda-todo-list-sublevels TODO items may have sublevels to break up the task into subtasks. In @@ -7038,15 +7170,13 @@ syntax described here also applies when creating sparse trees with @kbd{C-c / m}. @table @kbd -@kindex C-c a m -@item C-c a m +@orgcmd{C-c a m,org-tags-view} Produce a list of all headlines that match a given set of tags. The command prompts for a selection criterion, which is a boolean logic expression with tags, like @samp{+work+urgent-withboss} or @samp{work|home} (@pxref{Tags}). If you often need a specific search, define a custom command for it (@pxref{Agenda dispatcher}). -@kindex C-c a M -@item C-c a M +@orgcmd{C-c a M,org-tags-view} @vindex org-tags-match-list-sublevels @vindex org-agenda-tags-todo-honor-ignore-options Like @kbd{C-c a m}, but only select headlines that are also TODO items in a @@ -7197,8 +7327,7 @@ file in a @emph{time-sorted view}. The main purpose of this command is to give an overview over events in a project. @table @kbd -@kindex C-c a L -@item C-c a L +@orgcmd{C-c a L,org-timeline} Show a time-sorted view of the Org file, with all time-stamped items. When called with a @kbd{C-u} prefix, all unfinished TODO entries (scheduled or not) are also listed under the current date. @@ -7218,8 +7347,7 @@ This agenda view is a general text search facility for Org-mode entries. It is particularly useful to find notes. @table @kbd -@kindex C-c a s -@item C-c a s +@orgcmd{C-c a s,org-search-view} This is a special search that lets you select entries by matching a substring or specific words using a boolean logic. @end table @@ -7250,8 +7378,7 @@ Org-mode produces. During the review, you need to identify such projects and define next actions for them. @table @kbd -@kindex C-c a # -@item C-c a # +@orgcmd{C-c a #,org-agenda-list-stuck-projects} List projects that are stuck. @kindex C-c a ! @item C-c a ! @@ -7336,6 +7463,10 @@ special category you want to apply as the value. The display in the agenda buffer looks best if the category is not longer than 10 characters. +@noindent +You can set up icons for category by customizing the +@code{org-agenda-category-icon-alist} variable. + @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting @subsection Time-of-day specifications @cindex time-of-day specification @@ -7438,40 +7569,26 @@ the other commands, the cursor needs to be in the desired line. @table @kbd @tsubheading{Motion} @cindex motion commands in agenda -@kindex n -@item n +@orgcmd{n,org-agenda-next-line} Next line (same as @key{up} and @kbd{C-p}). -@kindex p -@item p +@orgcmd{p,org-agenda-previous-line} Previous line (same as @key{down} and @kbd{C-n}). @tsubheading{View/Go to Org file} -@kindex mouse-3 -@kindex @key{SPC} -@item mouse-3 -@itemx @key{SPC} +@orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up} Display the original location of the item in another window. With prefix arg, make sure that the entire entry is made visible in the outline, not only the heading. @c -@kindex L -@item L +@orgcmd{L,org-agenda-recenter} Display original location and recenter that window. @c -@kindex mouse-2 -@kindex mouse-1 -@kindex @key{TAB} -@item mouse-2 -@itemx mouse-1 -@itemx @key{TAB} -Go to the original location of the item in another window. Under Emacs -22, @kbd{mouse-1} will also works for this. +@orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto} +Go to the original location of the item in another window. @c -@kindex @key{RET} -@itemx @key{RET} +@orgcmd{@key{RET},org-agenda-switch-to} Go to the original location of the item and delete other windows. @c -@kindex F -@item F +@orgcmd{F,org-agenda-follow-mode} @vindex org-agenda-start-with-follow-mode Toggle Follow mode. In Follow mode, as you move the cursor through the agenda buffer, the other window always shows the corresponding @@ -7479,15 +7596,13 @@ location in the Org file. The initial setting for this mode in new agenda buffers can be set with the variable @code{org-agenda-start-with-follow-mode}. @c -@kindex C-c C-x b -@item C-c C-x b +@orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer} Display the entire subtree of the current item in an indirect buffer. With a numeric prefix argument N, go up to level N and then take that tree. If N is negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the previously used indirect buffer. -@kindex C-c C-o -@item C-c C-o +@orgcmd{C-c C-o,org-agenda-open-link} Follow a link in the entry. This will offer a selection of any links in the text belonging to the referenced Org node. If there is only one link, it will be followed without a selection prompt. @@ -7498,16 +7613,20 @@ will be followed without a selection prompt. @item o Delete other windows. @c -@kindex v d -@kindex d -@kindex v w -@kindex w -@kindex v m -@kindex v y -@item v d @ @r{or short} @ d -@itemx v w @ @r{or short} @ w -@itemx v m -@itemx v y +@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. @@ -7519,37 +7638,28 @@ 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. @c -@kindex f -@item f -@vindex org-agenda-ndays -Go forward in time to display the following @code{org-agenda-ndays} days. +@orgcmd{f,org-agenda-later} +Go forward in time to display the following @code{org-agenda-current-span} days. For example, if the display covers a week, switch to the following week. -With prefix arg, go forward that many times @code{org-agenda-ndays} days. +With prefix arg, go forward that many times @code{org-agenda-current-span} days. @c -@kindex b -@item b +@orgcmd{b,org-agenda-earlier} Go backward in time to display earlier dates. @c -@kindex . -@item . +@orgcmd{.,org-agenda-goto-today} Go to today. @c -@kindex j -@item j +@orgcmd{j,org-agenda-goto-date} Prompt for a date and go there. @c -@kindex J -@item J -Go to the currently clocked in task in the agenda buffer. +@orgcmd{J,org-agenda-clock-goto} +Go to the currently clocked-in task @i{in the agenda buffer}. @c -@kindex D -@item D +@orgcmd{D,org-agenda-toggle-diary} Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. @c -@kindex v l +@orgcmdkskc{v l,l,org-agenda-log-mode} @kindex v L -@kindex l -@item v l @ @r{or short} @ l @vindex org-log-done @vindex org-agenda-log-mode-items Toggle Logbook mode. In Logbook mode, entries that were marked DONE while @@ -7561,34 +7671,29 @@ all possible logbook entries, including state changes. When called with two prefix args @kbd{C-u C-u}, show only logging information, nothing else. @kbd{v L} is equivalent to @kbd{C-u v l}. @c -@kindex v [ -@kindex [ -@item v [ @ @r{or short} @ [ +@orgcmdkskc{v [,[,org-agenda-manipulate-query-add} Include inactive timestamps into the current view. Only for weekly/daily agenda and timeline views. @c -@kindex v a -@kindex v A -@item v a -@itemx v A +@orgcmd{v a,org-agenda-archives-mode} +@xorgcmd{v A,org-agenda-archives-mode 'files} Toggle Archives mode. In Archives mode, trees that are marked @code{ARCHIVED} are also scanned when producing the agenda. When you use the capital @kbd{A}, even all archive files are included. To exit archives mode, press @kbd{v a} again. @c -@kindex v R -@kindex R -@item v R @ @r{or short} @ R +@orgcmdkskc{v R,R,org-agenda-clockreport-mode} @vindex org-agenda-start-with-clockreport-mode Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will always show a table with the clocked times for the timespan and file scope covered by the current agenda view. The initial setting for this mode in new agenda buffers can be set with the variable -@code{org-agenda-start-with-clockreport-mode}. +@code{org-agenda-start-with-clockreport-mode}. By using a prefix argument +when toggling this mode (i.e. @kbd{C-u R}), the clock table will not show +contributions from entries that are hidden by agenda filtering@footnote{Only +tags filtering will be respected here, effort filtering is ignored.}. @c -@kindex v E -@kindex E -@item v E @ @r{or short} @ E +@orgcmdkskc{v E,E,org-agenda-entry-text-mode} @vindex org-agenda-start-with-entry-text-mode @vindex org-agenda-entry-text-maxlines Toggle entry text mode. In entry text mode, a number of lines from the Org @@ -7597,33 +7702,26 @@ The maximum number of lines is given by the variable @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric prefix argument will temporarily modify that number to the prefix value. @c -@kindex G -@item G +@orgcmd{G,org-agenda-toggle-time-grid} @vindex org-agenda-use-time-grid @vindex org-agenda-time-grid Toggle the time grid on and off. See also the variables @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. @c -@kindex r -@item r +@orgcmd{r,org-agenda-rodo} Recreate the agenda buffer, for example to reflect the changes after modification of the timestamps of items with @kbd{S-@key{left}} and @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix argument is interpreted to create a selective list for a specific TODO keyword. -@kindex g -@item g +@orgcmd{g,org-agenda-rodo} Same as @kbd{r}. @c -@kindex s -@kindex C-x C-s -@item s -@itemx C-x C-s +@orgcmdkskc{C-x C-s,s,org-save-all-org-buffers} Save all Org buffers in the current Emacs session, and also the locations of IDs. @c -@kindex C-c C-x C-c -@item C-c C-x C-c +@orgcmd{C-c C-x C-c,org-agenda-columns} @vindex org-columns-default-format Invoke column view (@pxref{Column view}) in the agenda buffer. The column view format is taken from the entry at point, or (if there is no entry at @@ -7632,8 +7730,7 @@ that entry would be in the original buffer (taken from a property, from a @code{#+COLUMNS} line, or from the default variable @code{org-columns-default-format}), will be used in the agenda. -@kindex C-c C-x > -@item C-c C-x > +@orgcmd{C-c C-x >,org-agenda-remove-restriction-lock} Remove the restriction lock on the agenda, if it is currently restricted to a file or subtree (@pxref{Agenda files}). @@ -7643,20 +7740,19 @@ file or subtree (@pxref{Agenda files}). @cindex effort filtering, in agenda @cindex query editing, in agenda -@kindex / -@item / +@orgcmd{/,org-agenda-filter-by-tag} @vindex org-agenda-filter-preset Filter the current agenda view with respect to a tag and/or effort estimates. The difference between this and a custom agenda command is that filtering is very fast, so that you can switch quickly between different filters without -having to recreate the agenda@footnote{Custom commands can preset a filter by +having to recreate the agenda.@footnote{Custom commands can preset a filter by binding the variable @code{org-agenda-filter-preset} as an option. This filter will then be applied to the view and persist as a basic filter through refreshes and more secondary filtering. The filter is a global property of -the entire agenda view - in a block agenda, you should only set this in the +the entire agenda view---in a block agenda, you should only set this in the global options section, not in the section of an individual block.} -You will be prompted for a tag selection letter, SPC will mean any tag at +You will be prompted for a tag selection letter; @key{SPC} will mean any tag at all. Pressing @key{TAB} at that prompt will offer use completion to select a tag (including any tags that do not have a selection character). The command then hides all entries that do not contain or inherit this tag. When called @@ -7668,7 +7764,7 @@ Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\} command. @vindex org-sort-agenda-noeffort-is-high -In order to filter for effort estimates, you should set-up allowed +In order to filter for effort estimates, you should set up allowed efforts globally, for example @lisp (setq org-global-properties @@ -7711,13 +7807,13 @@ Internet, and outside of business hours, with something like this: @end group @end lisp -@kindex \ -@item \ +@orgcmd{\,org-agenda-filter-by-tag-refine} Narrow the current agenda filter by an additional condition. When called with prefix arg, remove the entries that @emph{do} have the tag, or that do match the effort criterion. You can achieve the same effect by pressing @kbd{+} or @kbd{-} as the first key after the @kbd{/} command. +@c @kindex [ @kindex ] @kindex @{ @@ -7733,7 +7829,6 @@ negative search term which @i{must not} occur/match in the entry for it to be selected. @end table -@page @tsubheading{Remote editing} @cindex remote editing, from agenda @@ -7742,115 +7837,89 @@ Digit argument. @c @cindex undoing remote-editing events @cindex remote editing, undo -@kindex C-_ -@item C-_ +@orgcmd{C-_,org-agenda-undo} Undo a change due to a remote editing command. The change is undone both in the agenda buffer and in the remote buffer. @c -@kindex t -@item t +@orgcmd{t,org-agenda-todo} Change the TODO state of the item, both in the agenda and in the original org file. @c -@kindex C-S-@key{right} -@kindex C-S-@key{left} -@item C-S-@key{right}@r{/}@key{left} +@orgcmd{C-S-@key{right},org-agenda-todo-nextset} +@orgcmd{C-S-@key{left},org-agenda-todo-previousset} Switch to the next/previous set of TODO keywords. @c -@kindex C-k -@item C-k +@orgcmd{C-k,org-agenda-kill} @vindex org-agenda-confirm-kill Delete the current agenda item along with the entire subtree belonging to it in the original Org file. If the text to be deleted remotely is longer than one line, the kill needs to be confirmed by the user. See variable @code{org-agenda-confirm-kill}. @c -@kindex C-c C-w -@item C-c C-w +@orgcmd{C-c C-w,org-agenda-refile} Refile the entry at point. @c -@kindex C-c C-x C-a -@kindex a -@item C-c C-x C-a @ @r{or short} @ a +@orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation} @vindex org-archive-default-command Archive the subtree corresponding to the entry at point using the default archiving command set in @code{org-archive-default-command}. When using the @code{a} key, confirmation will be required. @c -@kindex C-c C-x a -@item C-c C-x a +@orgcmd{C-c C-x a,org-agenda-toggle-archive-tag} Toggle the ARCHIVE tag for the current headline. @c -@kindex C-c C-x A -@item C-c C-x A +@orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling} Move the subtree corresponding to the current entry to its @emph{archive sibling}. @c -@kindex $ -@kindex C-c C-x C-s -@item C-c C-x C-s @ @r{or short} @ $ +@orgcmdkskc{C-c C-x C-s,$,org-agenda-archive} Archive the subtree corresponding to the current headline. This means the entry will be moved to the configured archive location, most likely a different file. @c -@kindex T -@item T +@orgcmd{T,org-agenda-show-tags} @vindex org-agenda-show-inherited-tags Show all tags associated with the current item. This is useful if you have turned off @code{org-agenda-show-inherited-tags}, but still want to see all tags of a headline occasionally. @c -@kindex : -@item : +@orgcmd{:,org-agenda-set-tags} Set tags for the current headline. If there is an active region in the agenda, change a tag for all headings in the region. @c @kindex , @item , -Set the priority for the current item. Org-mode prompts for the -priority character. If you reply with @key{SPC}, the priority cookie -is removed from the entry. +Set the priority for the current item (@command{org-agenda-priority}). +Org-mode prompts for the priority character. If you reply with @key{SPC}, the +priority cookie is removed from the entry. @c -@kindex P -@item P +@orgcmd{P,org-agenda-show-priority} Display weighted priority of current item. @c -@kindex + -@kindex S-@key{up} -@item + -@itemx S-@key{up} +@orgcmdkkc{+,S-@key{up},org-agenda-priority-up} Increase the priority of the current item. The priority is changed in the original buffer, but the agenda is not resorted. Use the @kbd{r} key for this. @c -@kindex - -@kindex S-@key{down} -@item - -@itemx S-@key{down} +@orgcmdkkc{-,S-@key{down},org-agenda-priority-down} Decrease the priority of the current item. @c -@kindex C-c C-z -@kindex z -@item z @ @r{or also} @ C-c C-z +@orgcmdkkc{z,C-c C-z,org-agenda-add-note} @vindex org-log-into-drawer -Add a note to the entry. This note will be recorded, and then files to the +Add a note to the entry. This note will be recorded, and then filed to the same location where state change notes are put. Depending on -@code{org-log-into-drawer}, this maybe inside a drawer. +@code{org-log-into-drawer}, this may be inside a drawer. @c -@kindex C-c C-a -@item C-c C-a +@orgcmd{C-c C-a,org-attach} Dispatcher for all command related to attachments. @c -@kindex C-c C-s -@item C-c C-s -Schedule this item, with prefix arg remove the scheduling timestamp +@orgcmd{C-c C-s,org-agenda-schedule} +Schedule this item. With prefix arg remove the scheduling timestamp @c -@kindex C-c C-d -@item C-c C-d -Set a deadline for this item, with prefix arg remove the deadline. +@orgcmd{C-c C-d,org-agenda-deadline} +Set a deadline for this item. With prefix arg remove the deadline. @c -@kindex k -@item k +@orgcmd{k,org-agenda-action} Agenda actions, to set dates for selected items to the cursor date. This command also works in the calendar! The command prompts for an additional key: @@ -7865,8 +7934,7 @@ r @r{Call @code{org-capture} with the cursor date as default date.} Press @kbd{r} afterward to refresh the agenda and see the effect of the command. @c -@kindex S-@key{right} -@item S-@key{right} +@orgcmd{S-@key{right},org-agenda-do-date-later} Change the timestamp associated with the current line by one day into the future. With a numeric prefix argument, change it by that many days. For example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a @@ -7876,57 +7944,48 @@ a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp is changed in the original Org file, but the change is not directly reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer. @c -@kindex S-@key{left} -@item S-@key{left} +@orgcmd{S-@key{left},org-agenda-do-date-earlier} Change the timestamp associated with the current line by one day into the past. @c -@kindex > -@item > +@orgcmd{>,org-agenda-date-prompt} Change the timestamp associated with the current line. The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} on my keyboard. @c -@kindex I -@item I +@orgcmd{I,org-agenda-clock-in} Start the clock on the current item. If a clock is running already, it is stopped first. @c -@kindex O -@item O +@orgcmd{O,org-agenda-clock-out} Stop the previously started clock. @c -@kindex X -@item X +@orgcmd{X,org-agenda-clock-cancel} Cancel the currently running clock. - -@kindex J -@item J +@c +@orgcmd{J,org-agenda-clock-goto} Jump to the running clock in another window. @tsubheading{Bulk remote editing selected entries} @cindex remote editing, bulk, from agenda -@kindex m -@item m -Mark the entry at point for bulk action. - -@kindex u -@item u +@orgcmd{m,org-agenda-bulk-mark} +Mark the entry at point for bulk action. With prefix arg, mark that many +successive entries. +@c +@orgcmd{u,org-agenda-bulk-unmark} Unmark entry for bulk action. - -@kindex U -@item U +@c +@orgcmd{U,org-agenda-bulk-remove-all-marks} Unmark all marked entries for bulk action. - -@kindex B -@item B +@c +@orgcmd{B,org-agenda-bulk-action} Bulk action: act on all marked entries in the agenda. This will prompt for another key to select the action to be applied. The prefix arg to @kbd{B} will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove these special timestamps. @example r @r{Prompt for a single refile target and move all entries. The entries} - @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.} + @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.} $ @r{Archive all selected entries.} A @r{Archive entries by moving them to their respective archive siblings.} t @r{Change TODO state. This prompts for a single TODO keyword and} @@ -7937,23 +7996,24 @@ t @r{Change TODO state. This prompts for a single TODO keyword and} 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.} d @r{Set deadline to a specific date.} @end example @tsubheading{Calendar commands} @cindex calendar commands, from agenda -@kindex c -@item c + +@orgcmd{c,org-agenda-goto-calendar} Open the Emacs calendar and move to the date at the agenda cursor. @c -@item c +@orgcmd{c,org-calendar-goto-agenda} When in the calendar, compute and show the Org-mode agenda for the date at the cursor. @c @cindex diary entries, creating from agenda -@kindex i -@item i +@orgcmd{i,org-agenda-diary-entry} @vindex org-agenda-diary-file Insert a new entry into the diary, using the date at the cursor and (for block entries) the date at the mark. This will add to the Emacs diary @@ -7967,28 +8027,24 @@ Org will create entries (in org-mode syntax) in that file instead. Most entries will be stored in a date-based outline tree that will later make it easy to archive appointments from previous months/years. The tree will be built under an entry with a @code{DATE_TREE} property, or else with years as -top-level entries. Emacs will prompt you for the entry text - if you specify +top-level entries. Emacs will prompt you for the entry text---if you specify it, the entry will be created in @code{org-agenda-diary-file} without further interaction. If you directly press @key{RET} at the prompt without typing text, the target file will be shown in another window for you to finish the entry there. See also the @kbd{k r} command. @c -@kindex M -@item M +@orgcmd{M,org-agenda-phases-of-moon} Show the phases of the moon for the three months around current date. @c -@kindex S -@item S +@orgcmd{S,org-agenda-sunrise-sunset} Show sunrise and sunset times. The geographical location must be set with calendar variables, see the documentation for the Emacs calendar. @c -@kindex C -@item C +@orgcmd{C,org-agenda-convert-date} Convert the date at cursor into many other cultural and historic calendars. @c -@kindex H -@item H +@orgcmd{H,org-agenda-holidays} Show holidays for three months around the cursor date. @item M-x org-export-icalendar-combine-agenda-files @@ -7996,8 +8052,7 @@ Export a single iCalendar file containing entries from all agenda files. This is a globally available command, and also available in the agenda menu. @tsubheading{Exporting to a file} -@kindex C-x C-w -@item C-x C-w +@orgcmd{C-x C-w,org-write-agenda} @cindex exporting agenda views @cindex agenda views, exporting @vindex org-agenda-exporter-settings @@ -8010,13 +8065,11 @@ argument, immediately open the newly created file. Use the variable for @file{htmlize} to be used during export. @tsubheading{Quit and Exit} -@kindex q -@item q +@orgcmd{q,org-agenda-quit} Quit agenda, remove the agenda buffer. @c -@kindex x @cindex agenda files, removing buffers -@item x +@orgcmd{x,org-agenda-exit} Exit agenda, remove the agenda buffer and all buffers loaded by Emacs for the compilation of the agenda. Buffers created by the user to visit Org files will not be removed. @@ -8182,7 +8235,7 @@ For command sets creating a block agenda, @code{org-agenda-custom-commands} has two separate spots for setting options. You can add options that should be valid for just a single command in the set, and options that should be valid for all commands in -the set. The former are just added to the command entry, the latter +the set. The former are just added to the command entry; the latter must come after the list of command entries. Going back to the block agenda example (@pxref{Block agenda}), let's change the sorting strategy for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort @@ -8226,8 +8279,7 @@ a PDF file with also create the postscript file.}, and iCalendar files. If you want to do this only occasionally, use the command @table @kbd -@kindex C-x C-w -@item C-x C-w +@orgcmd{C-x C-w,org-write-agenda} @cindex exporting agenda views @cindex agenda views, exporting @vindex org-agenda-exporter-settings @@ -8297,8 +8349,7 @@ Instead, there is a special command to produce @emph{all} specified files in one step: @table @kbd -@kindex C-c a e -@item C-c a e +@orgcmd{C-c a e,org-store-agenda-views} Export all agenda views that have export file names associated with them. @end table @@ -8338,7 +8389,7 @@ or, if you need to modify some parameters@footnote{Quoting depends on the system you use, please check the FAQ for examples.} @example emacs -eval '(org-batch-store-agenda-views \ - org-agenda-ndays 30 \ + org-agenda-span month \ org-agenda-start-day "2007-11-01" \ org-agenda-include-diary nil \ org-agenda-files (quote ("~/org/project.org")))' \ @@ -8365,8 +8416,7 @@ quite useful to use column view also from the agenda, where entries are collected by certain criteria. @table @kbd -@kindex C-c C-x C-c -@item C-c C-x C-c +@orgcmd{C-c C-x C-c,org-agenda-columns} Turn on column view in the agenda. @end table @@ -8393,7 +8443,7 @@ turning on column view in the agenda will visit all relevant agenda files and make sure that the computations of this property are up to date. This is also true for the special @code{CLOCKSUM} property. Org will then sum the values displayed in the agenda. In the daily/weekly agenda, the sums will -cover a single day, in all other views they cover the entire block. It is +cover a single day; in all other views they cover the entire block. It is vital to realize that the agenda may show the same entry @emph{twice} (for example as scheduled and as a deadline), and it may show two entries from the same hierarchy (for example a @emph{parent} and its @emph{child}). In these @@ -8416,7 +8466,7 @@ the agenda). When exporting Org-mode documents, the exporter tries to reflect the structure of the document as accurately as possible in the backend. Since -export targets like HTML, La@TeX{}, or DocBook allow much richer formatting, +export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting, Org-mode has rules on how to prepare text for rich export. This section summarizes the markup rules used in an Org-mode buffer. @@ -8512,7 +8562,7 @@ the table of contents entirely, by configuring the variable Org-mode normally exports the text before the first headline, and even uses the first line as the document title. The text will be fully marked up. If -you need to include literal HTML, La@TeX{}, or DocBook code, use the special +you need to include literal HTML, @LaTeX{}, or DocBook code, use the special constructs described below in the sections for the individual exporters. @vindex org-export-skip-text-before-1st-heading @@ -8605,7 +8655,7 @@ different backends support this to varying degrees. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=} and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text in the code and verbatim string is not processed for Org-mode specific -syntax, it is exported verbatim. +syntax; it is exported verbatim. @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements @subheading Horizontal rules @@ -8653,7 +8703,7 @@ the object with @code{\ref@{tab:basic-data@}}: @end example @cindex inlined images, markup rules -Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include +Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include images into the exported document. Org does this, if a link to an image files does not have a description part, for example @code{[[./img/a.jpg]]}. If you wish to define a caption for the image and maybe a label for internal @@ -8704,7 +8754,7 @@ If the example is source code from a programming language, or any other text that can be marked up by font-lock in Emacs, you can ask for the example to look like the fontified Emacs buffer@footnote{This works automatically for the HTML backend (it requires version 1.34 of the @file{htmlize.el} package, -which is distributed with Org.) Fontified code chunks in LaTeX can be +which is distributed with Org). Fontified code chunks in LaTeX can be achieved using either the listings or the @url{http://code.google.com/p/minted, minted,} package. To use listings, turn on the variable @code{org-export-latex-listings} and ensure that the listings @@ -8773,7 +8823,7 @@ switching to a temporary buffer with the source code. You need to exit by pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to keep them from being interpreted by Org as outline nodes or special comments. These commas will be stripped -for editing with @kbd{C-c '}, and also for export.}, the edited version will +for editing with @kbd{C-c '}, and also for export.}. The edited version will then replace the old version in the Org buffer. Fixed-width regions (where each line starts with a colon followed by a space) will be edited using @code{artist-mode}@footnote{You may select a different-mode with the @@ -8783,7 +8833,7 @@ fixed-width region. @kindex C-c l @item C-c l Calling @code{org-store-link} while editing a source code example in a -temporary buffer created with @kbd{C-c '} will prompt for a label, make sure +temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure that it is unique in the current buffer, and insert it with the proper formatting like @samp{(ref:label)} at the end of the current line. Then the label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}. @@ -8804,12 +8854,14 @@ include your @file{.emacs} file, you could use: @noindent 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 +language for formatting the contents. The markup is optional; if it is not given, the text will be assumed to be in Org-mode format and will be processed normally. The include line will also allow additional keyword parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the -first line and for each following line, as well as any options accepted by -the selected markup. For example, to include a file as an item, use +first line and for each following line, @code{:minlevel} in order to get +org-mode content demoted to a specified level, as well as any options +accepted by the selected markup. For example, to include a file as an item, +use @example #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " " @@ -8865,20 +8917,19 @@ construct complex HTML code. @node Embedded LaTeX, , Macro replacement, Markup -@section Embedded La@TeX{} +@section Embedded @LaTeX{} @cindex @TeX{} interpretation -@cindex La@TeX{} interpretation - -Plain ASCII is normally sufficient for almost all note taking. One -exception, however, are scientific notes which need to be able to contain -mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{} -is a macro system based on Donald E. Knuth's @TeX{} system. Many of the -features described here as ``La@TeX{}'' are really from @TeX{}, but for -simplicity I am blurring this distinction.} is widely used to typeset -scientific documents. Org-mode supports embedding La@TeX{} code into its -files, because many academics are used to writing and reading La@TeX{} source -code, and because it can be readily processed to produce pretty output for a -number of export backends. +@cindex @LaTeX{} interpretation + +Plain ASCII is normally sufficient for almost all note taking. Exceptions +include scientific notes, which often require mathematical symbols and the +occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on +Donald E. Knuth's @TeX{} system. Many of the features described here as +``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this +distinction.} is widely used to typeset scientific documents. Org-mode +supports embedding @LaTeX{} code into its files, because many academics are +used to writing and reading @LaTeX{} source code, and because it can be +readily processed to produce pretty output for a number of export backends. @menu * Special symbols:: Greek letters and other symbols @@ -8893,14 +8944,14 @@ number of export backends. @cindex math symbols @cindex special symbols @cindex @TeX{} macros -@cindex La@TeX{} fragments, markup rules +@cindex @LaTeX{} fragments, markup rules @cindex HTML entities -@cindex La@TeX{} entities +@cindex @LaTeX{} entities -You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to +You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion for these macros is available, just type @samp{\} and maybe a few letters, -and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{} +and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{} code, Org-mode allows these macros to be present without surrounding math delimiters, for example: @@ -8911,13 +8962,13 @@ Angles are written as Greek letters \alpha, \beta and \gamma. @vindex org-entities During export, these symbols will be transformed into the native format of the exporter backend. Strings like @code{\alpha} will be exported as -@code{α} in the HTML output, and as @code{$\alpha$} in the La@TeX{} +@code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{} output. Similarly, @code{\nbsp} will become @code{ } in HTML and -@code{~} in La@TeX{}. If you need such a symbol inside a word, terminate it +@code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it like this: @samp{\Aacute@{@}stor}. A large number of entities is provided, with names taken from both HTML and -La@TeX{}, see the variable @code{org-entities} for the complete list. +@LaTeX{}; see the variable @code{org-entities} for the complete list. @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and @samp{...} are all converted into special commands creating hyphens of different lengths or a compact set of dots. @@ -8930,8 +8981,8 @@ variable @code{org-pretty-entities}, or on a per-file base with the @table @kbd @kindex C-c C-x \ @item C-c C-x \ -Toggle display of entities as UTF8 characters. This does not change the -buffer content which remains plain ASCII, but it overlays the UTF8 character +Toggle display of entities as UTF-8 characters. This does not change the +buffer content which remains plain ASCII, but it overlays the UTF-8 character for display purposes only. @end table @@ -8940,14 +8991,14 @@ for display purposes only. @cindex subscript @cindex superscript -Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super- +Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and subscripts. Again, these can be used without embedding them in math-mode delimiters. To increase the readability of ASCII text, it is not necessary (but OK) to surround multi-character sub- and superscripts with curly braces. For example @example -The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of +The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of the sun is R_@{sun@} = 6.96 x 10^8 m. @end example @@ -8969,42 +9020,43 @@ subscript, but @samp{a_@{b@}} will. @table @kbd @kindex C-c C-x \ @item C-c C-x \ -In addition to showing entities as UTF8 characters, this command will also +In addition to showing entities as UTF-8 characters, this command will also format sub- and superscripts in a WYSIWYM way. @end table @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX -@subsection La@TeX{} fragments -@cindex La@TeX{} fragments +@subsection @LaTeX{} fragments +@cindex @LaTeX{} fragments @vindex org-format-latex-header Going beyond symbols and sub- and superscripts, a full formula language is -needed. Org-mode can contain La@TeX{} math fragments, and it supports ways -to process these for several export backends. When exporting to La@TeX{}, +needed. Org-mode can contain @LaTeX{} math fragments, and it supports ways +to process these for several export backends. When exporting to @LaTeX{}, the code is obviously left as it is. When exporting to HTML, Org invokes the @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in HTML export}) to process and display the math@footnote{If you plan to use this regularly or on pages with significant page views, you should install -@file{MathJax} on your own server in order to limit the load of our server.}. -Finally, it can also process the mathematical expressions into -images@footnote{For this to work you need to be on a system with a working -La@TeX{} installation. You also need the @file{dvipng} program, available at -@url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that will +@file{MathJax} on your own +server in order to limit the load of our server.}. Finally, it can also +process the mathematical expressions into images@footnote{For this to work +you need to be on a system with a working @LaTeX{} installation. You also +need the @file{dvipng} program, available at +@url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will be used when processing a fragment can be configured with the variable @code{org-format-latex-header}.} that can be displayed in a browser or in DocBook documents. -La@TeX{} fragments don't need any special marking at all. The following -snippets will be identified as La@TeX{} source code: +@LaTeX{} fragments don't need any special marking at all. The following +snippets will be identified as @LaTeX{} source code: @itemize @bullet @item Environments of any kind@footnote{When @file{MathJax} is used, only the -environment recognized by @file{MathJax} will be processed. When dvipng is -used to create images, any La@TeX{} environments will be handled.}. The only -requirement is that the @code{\begin} statement appears on a new line, -preceded by only whitespace. +environment recognized by @file{MathJax} will be processed. When +@file{dvipng} is used to create images, any @LaTeX{} environments will be +handled.}. The only requirement is that the @code{\begin} statement appears +on a new line, preceded by only whitespace. @item -Text within the usual La@TeX{} math delimiters. To avoid conflicts with +Text within the usual @LaTeX{} math delimiters. To avoid conflicts with currency specifications, single @samp{$} characters are only recognized as math delimiters if the enclosed text contains at most two line breaks, is directly attached to the @samp{$} characters with no whitespace in between, @@ -9028,7 +9080,7 @@ either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. @vindex org-format-latex-options If you need any of the delimiter ASCII sequences for other purposes, you can configure the option @code{org-format-latex-options} to deselect the -ones you do not wish to have interpreted by the La@TeX{} converter. +ones you do not wish to have interpreted by the @LaTeX{} converter. @vindex org-export-with-LaTeX-fragments LaTeX processing can be configured with the variable @@ -9040,7 +9092,7 @@ of these lines: @example #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)} #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images} -#+OPTIONS: LaTeX:nil @r{Do not process La@TeX{} fragments at all} +#+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all} #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so} @end example @@ -9048,13 +9100,13 @@ of these lines: @subsection Previewing LaTeX fragments @cindex LaTeX fragments, preview -If you have @file{dvipng} installed, La@TeX{} fragments can be processed to +If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to produce preview images of the typeset expressions: @table @kbd @kindex C-c C-x C-l @item C-c C-x C-l -Produce a preview image of the La@TeX{} fragment at point and overlay it +Produce a preview image of the @LaTeX{} fragment at point and overlay it over the source code. If there is no fragment at point, process all fragments in the current entry (between two headlines). When called with a prefix argument, process the entire subtree. When called with @@ -9076,7 +9128,7 @@ preview images. @cindex CDLa@TeX{} CDLa@TeX{} mode is a minor mode that is normally used in combination with a -major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of +major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of environments and math templates. Inside Org-mode, you can make use of some of the features of CDLa@TeX{} mode. You need to install @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with @@ -9099,7 +9151,7 @@ Environment templates can be inserted with @kbd{C-c @{}. @item @kindex @key{TAB} The @key{TAB} key will do template expansion if the cursor is inside a -La@TeX{} fragment@footnote{Org-mode has a method to test if the cursor is +@LaTeX{} fragment@footnote{Org-mode has a method to test if the cursor is inside such a fragment, see the documentation of the function @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor @@ -9113,7 +9165,7 @@ To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}. @kindex _ @kindex ^ @vindex cdlatex-simplify-sub-super-scripts -Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these +Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these characters together with a pair of braces. If you use @key{TAB} to move out of the braces, and if the braces surround only a single character or macro, they are removed again (depending on the variable @@ -9121,14 +9173,14 @@ macro, they are removed again (depending on the variable @item @kindex ` Pressing the backquote @kbd{`} followed by a character inserts math -macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds +macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds after the backquote, a help window will pop up. @item @kindex ' Pressing the single-quote @kbd{'} followed by another character modifies the symbol before point with an accent or a font. If you wait more than -1.5 seconds after the backquote, a help window will pop up. Character -modification will work only inside La@TeX{} fragments, outside the quote +1.5 seconds after the single-quote, a help window will pop up. Character +modification will work only inside @LaTeX{} fragments; outside the quote is normal. @end itemize @@ -9140,8 +9192,8 @@ Org-mode documents can be exported into a variety of other formats. For printing and sharing of notes, ASCII export produces a readable and simple version of an Org file. HTML export allows you to publish a notes file on the web, while the XOXO format provides a solid base for exchange with a -broad range of other applications. La@TeX{} export lets you use Org-mode and -its structured editing functions to easily create La@TeX{} files. DocBook +broad range of other applications. @LaTeX{} export lets you use Org-mode and +its structured editing functions to easily create @LaTeX{} files. DocBook export makes it possible to convert Org files to many other formats using DocBook tools. For project management you can create gantt and resource charts by using TaskJuggler export. To incorporate entries with associated @@ -9158,7 +9210,7 @@ enabled (default in Emacs 23). * The export dispatcher:: How to access exporter commands * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding * HTML export:: Exporting to HTML -* LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF +* LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF * DocBook export:: Exporting to DocBook * TaskJuggler export:: Exporting to TaskJuggler * Freemind export:: Exporting to Freemind mind maps @@ -9205,8 +9257,7 @@ In particular, note that you can place commonly-used (export) options in a separate file which can be included using @code{#+SETUPFILE}. @table @kbd -@kindex C-c C-e t -@item C-c C-e t +@orgcmd{C-c C-e t,org-insert-export-options-template} Insert template with export options, see example below. @end table @@ -9232,7 +9283,7 @@ Insert template with export options, see example below. @example #+TITLE: the title to be shown (default is the buffer name) #+AUTHOR: the author (default taken from @code{user-full-name}) -#+DATE: a date, fixed, of a format string for @code{format-time-string} +#+DATE: a date, fixed, or a format string for @code{format-time-string} #+EMAIL: his/her email address (default from @code{user-mail-address}) #+DESCRIPTION: the page description, e.g. for the XHTML meta tag #+KEYWORDS: the page keywords, e.g. for the XHTML meta tag @@ -9252,8 +9303,8 @@ Insert template with export options, see example below. @noindent The OPTIONS line is a compact@footnote{If you want to configure many options -this way, you can use several OPTIONS lines.} form to specify export settings. Here -you can: +this way, you can use several OPTIONS lines.} form to specify export +settings. Here you can: @cindex headline levels @cindex section-numbers @cindex table of contents @@ -9266,7 +9317,7 @@ you can: @cindex special strings @cindex emphasized text @cindex @TeX{} macros -@cindex La@TeX{} fragments +@cindex @LaTeX{} fragments @cindex author info, in export @cindex time info, in export @example @@ -9288,7 +9339,7 @@ tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}} <: @r{turn on/off inclusion of any time/date stamps like DEADLINES} *: @r{turn on/off emphasized text (bold, italic, underlined)} TeX: @r{turn on/off simple @TeX{} macros in plain text} -LaTeX: @r{configure export of La@TeX{} fragments. Default @code{auto}} +LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}} skip: @r{turn on/off skipping the text before the first heading} author: @r{turn on/off inclusion of author name/email into exported file} email: @r{turn on/off inclusion of author email into exported file} @@ -9297,9 +9348,12 @@ timestamp: @r{turn on/off inclusion creation time into exported file} d: @r{turn on/off inclusion of drawers} @end example @noindent -These options take effect in both the HTML and La@TeX{} export, except -for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and -@code{nil} for the La@TeX{} export. +These options take effect in both the HTML and @LaTeX{} export, except for +@code{TeX} and @code{LaTeX}, 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 @@ -9318,8 +9372,7 @@ contains one outline tree, the first heading is used as document title and the subtrees are exported. @table @kbd -@kindex C-c C-e -@item C-c C-e +@orgcmd{C-c C-e,org-export} @vindex org-export-run-in-background Dispatcher for export and publishing commands. Displays a help-window listing the additional key(s) needed to launch an export or publishing @@ -9327,14 +9380,12 @@ command. The prefix arg is passed through to the exporter. A double prefix @kbd{C-u C-u} causes most commands to be executed in the background, in a separate Emacs process@footnote{To make this behavior the default, customize the variable @code{org-export-run-in-background}.}. -@kindex C-c C-e v -@item C-c C-e v +@orgcmd{C-c C-e v,org-export-visible} Like @kbd{C-c C-e}, but only export the text that is currently visible (i.e. not hidden by outline visibility). -@kindex C-u C-u C-c C-e -@item C-u C-u C-c C-e +@orgcmd{C-u C-u C-c C-e,org-export} @vindex org-export-run-in-background -Call an the exporter, but reverse the setting of +Call the exporter, but reverse the setting of @code{org-export-run-in-background}, i.e. request background processing if not set, or force processing in the current Emacs process if set. @end table @@ -9353,8 +9404,7 @@ with special characters and symbols available in these encodings. @cindex active region @cindex transient-mark-mode @table @kbd -@kindex C-c C-e a -@item C-c C-e a +@orgcmd{C-c C-e a,org-export-as-ascii} @cindex property, EXPORT_FILE_NAME Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file will be @file{myfile.txt}. The file will be overwritten without @@ -9365,21 +9415,15 @@ current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the export. -@kindex C-c C-e A -@item C-c C-e A -Export to a temporary buffer, do not create a file. -@kindex C-c C-e n -@kindex C-c C-e N -@item C-c C-e n @ @ @r{and} @ @ C-c C-e N +@orgcmd{C-c C-e A,org-export-as-ascii-to-buffer} +Export to a temporary buffer. Do not create a file. +@orgcmd{C-c C-e n,org-export-as-latin1} +@xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer} Like the above commands, but use Latin-1 encoding. -@kindex C-c C-e u -@kindex C-c C-e U -@item C-c C-e u @ @ @r{and} @ @ C-c C-e U +@orgcmd{C-c C-e u,org-export-as-utf8} +@xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer} Like the above commands, but use UTF-8 encoding. -@kindex C-c C-e v a -@kindex C-c C-e v n -@kindex C-c C-e v u -@item C-c C-e v a @ @ @r{and} @ @ C-c C-e v n @ @ @r{and} @ @ C-c C-e v u +@item C-c C-e v a/n/u Export only the visible part of the document. @end table @@ -9434,8 +9478,7 @@ language, but with additional support for tables. @cindex active region @cindex transient-mark-mode @table @kbd -@kindex C-c C-e h -@item C-c C-e h +@orgcmd{C-c C-e h,org-export-as-html} @cindex property, EXPORT_FILE_NAME Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org}, the ASCII file will be @file{myfile.html}. The file will be overwritten @@ -9445,25 +9488,15 @@ exported. If the selected region is a single tree@footnote{To select the current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the export. -@kindex C-c C-e b -@item C-c C-e b +@orgcmd{C-c C-e b,org-export-as-html-and-open} Export as HTML file and immediately open it with a browser. -@kindex C-c C-e H -@item C-c C-e H -Export to a temporary buffer, do not create a file. -@kindex C-c C-e R -@item C-c C-e R +@orgcmd{C-c C-e H,org-export-as-html-to-buffer} +Export to a temporary buffer. Do not create a file. +@orgcmd{C-c C-e R,org-export-region-as-html} Export the active region to a temporary buffer. With a prefix argument, do not produce the file header and footer, but just the plain HTML section for the region. This is good for cut-and-paste operations. -@kindex C-c C-e v h -@kindex C-c C-e v b -@kindex C-c C-e v H -@kindex C-c C-e v R -@item C-c C-e v h -@item C-c C-e v b -@item C-c C-e v H -@item C-c C-e v R +@item C-c C-e v h/b/H/R Export only the visible part of the document. @item M-x org-export-region-as-html Convert the region to HTML under the assumption that it was Org-mode @@ -9599,16 +9632,18 @@ and you could use @code{http} addresses just as well. @cindex MathJax @cindex dvipng -La@TeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two +@LaTeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two different ways on HTML pages. The default is to use the @uref{http://www.mathjax.org, MathJax system} which should work out of the box with Org mode installation because @code{http://orgmode.org} serves @file{MathJax} for Org-mode users for small applications and for testing purposes. @b{If you plan to use this regularly or on pages with significant -page views, you should install MathJax on your own server in order to limit -the load of our server.} To configure @file{MathJax}, use the variable -@code{org-export-html-mathjax-options} or insert something like the following -into the buffer: +page views, you should install@footnote{Installation instructions can be +found on the MathJax website, see +@uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on +your own server in order to limit the load of our server.} To configure +@file{MathJax}, use the variable @code{org-export-html-mathjax-options} or +insert something like the following into the buffer: @example #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js" @@ -9618,11 +9653,11 @@ into the buffer: @code{org-export-html-mathjax-options} for the meaning of the parameters in this line. -If you prefer, you can also request that La@TeX{} are processed into small -images that will be inserted into the browser page. Before the availability -of MathJax, this was the default method for Org files. This method requires -that the @file{dvipng} program is available on your system. You can still -get this processing with +If you prefer, you can also request that @LaTeX{} fragments are processed +into small images that will be inserted into the browser page. Before the +availability of MathJax, this was the default method for Org files. This +method requires that the @file{dvipng} program is available on your system. +You can still get this processing with @example #+OPTIONS: LaTeX:dvipng @@ -9705,7 +9740,7 @@ inclusion of these defaults off, customize @code{org-export-html-style-include-default}}. You may overwrite these settings, or add to them by using the variables @code{org-export-html-style} (for Org-wide settings) and @code{org-export-html-style-extra} (for more -granular settings, like file-local settings). To set the latter variable +fine-grained settings, like file-local settings). To set the latter variable individually for each file, you can use @cindex #+STYLE @@ -9773,11 +9808,11 @@ sdepth: @r{Maximum headline level that will still become an independent} @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).} @r{If this is smaller than in @code{org-export-headline-levels}, each} @r{info/folding section can still contain child headlines.} -toc: @r{Should the table of content @emph{initially} be visible?} +toc: @r{Should the table of contents @emph{initially} be visible?} @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.} tdepth: @r{The depth of the table of contents. The defaults are taken from} @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.} -ftoc: @r{Does the css of the page specify a fixed position for the "toc"?} +ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?} @r{If yes, the toc will never be displayed as a section.} ltoc: @r{Should there be short contents (children) in each section?} @r{Make this @code{above} if the section should be above initial text.} @@ -9794,41 +9829,40 @@ You can choose default values for these options by customizing the variable pages, configure the variable @code{org-export-html-use-infojs}. @node LaTeX and PDF export, DocBook export, HTML export, Exporting -@section La@TeX{} and PDF export -@cindex La@TeX{} export +@section @LaTeX{} and PDF export +@cindex @LaTeX{} export @cindex PDF export @cindex Guerry, Bastien -Org-mode contains a La@TeX{} exporter written by Bastien Guerry. With +Org-mode contains a @LaTeX{} exporter written by Bastien Guerry. With further processing@footnote{The default LaTeX output is designed for processing with pdftex or latex. It includes packages that are not compatible with xetex and possibly luatex. See the variables @code{org-export-latex-default-packages-alist} and @code{org-export-latex-packages-alist}.}, this backend is also used to -produce PDF output. Since the La@TeX{} output uses @file{hyperref} 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. @menu * LaTeX/PDF export commands:: Which key invokes which commands * Header and sectioning:: Setting up the export file structure -* Quoting LaTeX code:: Incorporating literal La@TeX{} code -* Tables in LaTeX export:: Options for exporting tables to La@TeX{} -* Images in LaTeX export:: How to insert figures into La@TeX{} output +* Quoting LaTeX code:: Incorporating literal @LaTeX{} code +* Tables in LaTeX export:: Options for exporting tables to @LaTeX{} +* Images in LaTeX export:: How to insert figures into @LaTeX{} output * Beamer class export:: Turning the file into a presentation @end menu @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export -@subsection La@TeX{} export commands +@subsection @LaTeX{} export commands @cindex region, active @cindex active region @cindex transient-mark-mode @table @kbd -@kindex C-c C-e l -@item C-c C-e l +@orgcmd{C-c C-e l,org-export-as-latex} @cindex property EXPORT_FILE_NAME -Export as La@TeX{} file @file{myfile.tex}. For an Org file +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 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 @@ -9836,27 +9870,21 @@ exported. If the selected region is a single tree@footnote{To select the current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the export. -@kindex C-c C-e L -@item C-c C-e L -Export to a temporary buffer, do not create a file. -@kindex C-c C-e v l -@kindex C-c C-e v L -@item C-c C-e v l -@item C-c C-e v L +@orgcmd{C-c C-e L,org-export-as-latex-to-buffer} +Export to a temporary buffer. Do not create a file. +@item C-c C-e v l/L Export only the visible part of the document. @item M-x org-export-region-as-latex -Convert the region to La@TeX{} under the assumption that it was Org-mode +Convert the region to @LaTeX{} under the assumption that it was Org-mode syntax before. This is a global command that can be invoked in any buffer. @item M-x org-replace-region-by-latex -Replace the active region (assumed to be in Org-mode syntax) by La@TeX{} +Replace the active region (assumed to be in Org-mode syntax) by @LaTeX{} code. -@kindex C-c C-e p -@item C-c C-e p -Export as La@TeX{} and then process to PDF. -@kindex C-c C-e d -@item C-c C-e d -Export as La@TeX{} and then process to PDF, then open the resulting PDF file. +@orgcmd{C-c C-e p,org-export-as-pdf} +Export as @LaTeX{} and then process to PDF. +@orgcmd{C-c C-e d,org-export-as-pdf-and-open} +Export as @LaTeX{} and then process to PDF, then open the resulting PDF file. @end table @cindex headline levels, for exporting @@ -9879,13 +9907,13 @@ creates two levels of headings and does the rest as items. @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export @subsection Header and sectioning structure -@cindex La@TeX{} class -@cindex La@TeX{} sectioning structure -@cindex La@TeX{} header +@cindex @LaTeX{} class +@cindex @LaTeX{} sectioning structure +@cindex @LaTeX{} header @cindex header, for LaTeX files @cindex sectioning structure, for LaTeX export -By default, the La@TeX{} output uses the class @code{article}. +By default, the @LaTeX{} output uses the class @code{article}. @vindex org-export-latex-default-class @vindex org-export-latex-classes @@ -9912,12 +9940,12 @@ header. See the docstring of @code{org-export-latex-classes} for more information. @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export -@subsection Quoting La@TeX{} code +@subsection Quoting @LaTeX{} code -Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly -inserted into the La@TeX{} file. This includes simple macros like +Embedded @LaTeX{} as described in @ref{Embedded LaTeX}, will be correctly +inserted into the @LaTeX{} file. This includes simple macros like @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore, -you can add special code that should only be present in La@TeX{} export with +you can add special code that should only be present in @LaTeX{} export with the following constructs: @cindex #+LaTeX @@ -9937,10 +9965,10 @@ All lines between these markers are exported literally @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export -@subsection Tables in La@TeX{} export -@cindex tables, in La@TeX{} export +@subsection Tables in @LaTeX{} export +@cindex tables, in @LaTeX{} export -For La@TeX{} export of a table, you can specify a label and a caption +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 @@ -9960,13 +9988,13 @@ Finally, you can set the alignment string: @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export -@subsection Images in La@TeX{} export -@cindex images, inline in La@TeX{} -@cindex inlining images in La@TeX{} +@subsection Images in @LaTeX{} export +@cindex images, inline in @LaTeX{} +@cindex inlining images in @LaTeX{} Images that are linked to without a description part in the link, like @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF -output file resulting from La@TeX{} processing. Org will use an +output file resulting from @LaTeX{} processing. Org will use an @code{\includegraphics} macro to insert the image. If you have specified a caption and/or a label as described in @ref{Images and tables}, the figure will be wrapped into a @code{figure} environment and thus become a floating @@ -9997,7 +10025,7 @@ for @code{\includegraphics} and @code{wrapfigure}. @end example If you need references to a label created in this way, write -@samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}. +@samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}. @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export @subsection Beamer class export @@ -10014,7 +10042,7 @@ exportable as a beamer presentation. By default, the top-level entries (or the first level below the selected subtree heading) will be turned into frames, and the outline structure below this level will become itemize lists. You can also configure the variable @code{org-beamer-frame-level} to a -different level - then the hierarchy above frames will produce the sectioning +different level---then the hierarchy above frames will produce the sectioning structure of the presentation. A template for useful in-buffer settings or properties can be inserted into @@ -10037,7 +10065,8 @@ The beamer-special arguments that should be used for the environment, like @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col} property is also set, something like @code{C[t]} can be added here as well to set an options argument for the implied @code{columns} environment. -@code{c[t]} will set an option for the implied @code{column} environment. +@code{c[t]} or @code{c<2->} will set an options for the implied @code{column} +environment. @item BEAMER_col The width of a column that should start with this entry. If this property is set, the entry will also get a @code{:BMCOL:} property to make this visible. @@ -10076,8 +10105,7 @@ support with @end example @table @kbd -@kindex C-c C-b -@item C-c C-b +@orgcmd{C-c C-b,org-beamer-select-environment} In @code{org-beamer-mode}, this key offers fast selection of a beamer environment or the @code{BEAMER_col} property. @end table @@ -10155,8 +10183,7 @@ Currently DocBook exporter only supports DocBook V5.0. @cindex active region @cindex transient-mark-mode @table @kbd -@kindex C-c C-e D -@item C-c C-e D +@orgcmd{C-c C-e D,org-export-as-docbook} @cindex property EXPORT_FILE_NAME Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML file will be @file{myfile.xml}. The file will be overwritten without @@ -10166,8 +10193,7 @@ exported. If the selected region is a single tree@footnote{To select the current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the export. -@kindex C-c C-e V -@item C-c C-e V +@orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open} Export as DocBook file, process to PDF, then open the resulting PDF file. @vindex org-export-docbook-xslt-proc-command @@ -10184,8 +10210,7 @@ variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by the user. You can also overrule this global setting on a per-file basis by adding an in-buffer setting @code{#+XSLT:} to the Org file. -@kindex C-c C-e v D -@item C-c C-e v D +@orgkey{C-c C-e v D} Export only the visible part of the document. @end table @@ -10220,7 +10245,7 @@ exported DocBook XML files invalid by not quoting DocBook code correctly. #+BEGIN_DOCBOOK <warning> <para>You should know what you are doing when quoting DocBook XML code - in your Org file. Invalid DocBook XML file may be generated by + in your Org file. Invalid DocBook XML may be generated by DocBook exporter if you are not careful!</para> </warning> #+END_DOCBOOK @@ -10349,12 +10374,10 @@ all the nodes. @subsection TaskJuggler export commands @table @kbd -@kindex C-c C-e j -@item C-c C-e j +@orgcmd{C-c C-e j,org-export-as-taskjuggler} Export as TaskJuggler file. -@kindex C-c C-e J -@item C-c C-e J +@orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open} Export as TaskJuggler file and then open the file with TaskJugglerUI. @end table @@ -10381,7 +10404,7 @@ with @code{:taskjuggler_resource:} (or whatever you customized 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 +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 @@ -10407,7 +10430,7 @@ resource or resource node which is known to TaskJuggler, such as 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 org-depend.el) or alternatively with a +@samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends} attribute can be either @samp{previous-sibling} or a reference to an identifier (named @samp{task_id}) which is defined for another task in the @@ -10464,8 +10487,7 @@ For more information and examples see the Org-taskjuggler tutorial at The Freemind exporter was written by Lennart Borgman. @table @kbd -@kindex C-c C-e m -@item C-c C-e m +@orgcmd{C-c C-e m,org-export-as-freemind} Export as Freemind mind map @file{myfile.mm}. @end table @@ -10478,11 +10500,9 @@ Currently, this exporter only handles the general outline structure and does not interpret any additional Org-mode features. @table @kbd -@kindex C-c C-e x -@item C-c C-e x +@orgcmd{C-c C-e x,org-export-as-xoxo} Export as XOXO file @file{myfile.html}. -@kindex C-c C-e v -@item C-c C-e v x +@orgkey{C-c C-e v x} Export only the visible part of the document. @end table @@ -10525,18 +10545,15 @@ In this way the UID remains unique, but a synchronization program can still figure out from which entry all the different instances originate. @table @kbd -@kindex C-c C-e i -@item C-c C-e i +@orgcmd{C-c C-e i,org-export-icalendar-this-file} Create iCalendar entries for the current file and store them in the same directory, using a file extension @file{.ics}. -@kindex C-c C-e I -@item C-c C-e I +@orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files} @vindex org-agenda-files Like @kbd{C-c C-e i}, but do this for all files in @code{org-agenda-files}. For each of these files, a separate iCalendar file will be written. -@kindex C-c C-e c -@item C-c C-e c +@orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files} @vindex org-combined-agenda-icalendar-file Create a single large iCalendar file from all files in @code{org-agenda-files} and write it to the file given by @@ -10674,6 +10691,9 @@ extension. @item @code{:include} @tab List of files to be included regardless of @code{:base-extension} and @code{:exclude}. + +@item @code{:recursive} +@tab Non-nil means, check base-directory recursively for files to publish. @end multitable @node Publishing action, Publishing options, Selecting files, Configuration @@ -10694,10 +10714,10 @@ produce @file{file.org} and @file{file.org.html} in the publishing directory@footnote{@file{file-source.org} and @file{file-source.org.html} if source and publishing directories are equal. Note that with this kind of setup, you need to add @code{:exclude "-source\\.org"} to the project -definition in @code{org-publish-project-alist} to avoid that the published -source files will be considered as new org files the next time the project is -published.}. Other files like images only need to be copied to the -publishing destination, for this you may use @code{org-publish-attachment}. +definition in @code{org-publish-project-alist} to prevent the published +source files from being considered as new org files the next time the project +is published.}. Other files like images only need to be copied to the +publishing destination; for this you may use @code{org-publish-attachment}. For non-Org files, you always need to specify the publishing function: @multitable @columnfractions 0.3 0.7 @@ -10717,11 +10737,11 @@ should take the specified file, make the necessary transformation (if any) and place the result into the destination folder. @node Publishing options, Publishing links, Publishing action, Configuration -@subsection Options for the HTML/La@TeX{} exporters +@subsection Options for the HTML/@LaTeX{} exporters @cindex options, for publishing The property list can be used to set many export options for the HTML -and La@TeX{} exporters. In most cases, these properties correspond to user +and @LaTeX{} exporters. In most cases, these properties correspond to user variables in Org. The table below lists these properties along with the variable they belong to. See the documentation string for the respective variable for details. @@ -10826,9 +10846,9 @@ respective variable for details. @end multitable Most of the @code{org-export-with-*} variables have the same effect in -both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and +both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the -La@TeX{} export. +@LaTeX{} export. @vindex org-publish-project-alist When a property is given a value in @code{org-publish-project-alist}, @@ -11048,17 +11068,13 @@ right place on the web server, and publishing images to it. Once properly configured, Org can publish with the following commands: @table @kbd -@kindex C-c C-e C -@item C-c C-e C +@orgcmd{C-c C-e X,org-publish} Prompt for a specific project and publish all files that belong to it. -@kindex C-c C-e P -@item C-c C-e P +@orgcmd{C-c C-e P,org-publish-current-project} Publish the project containing the current file. -@kindex C-c C-e F -@item C-c C-e F +@orgcmd{C-c C-e F,org-publish-current-file} Publish only the current file. -@kindex C-c C-e E -@item C-c C-e E +@orgcmd{C-c C-e E,org-publish-all} Publish every project. @end table @@ -11192,7 +11208,7 @@ can be used to map arbitrary language names to existing major modes. Controls the way Emacs windows are rearranged when the edit buffer is created. @item org-src-preserve-indentation This variable is especially useful for tangling languages such as -python, in which whitespace indentation in the output is critical. +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. @@ -11234,7 +11250,7 @@ Neither the code block nor its results will be exported. @end table It is possible to inhibit the evaluation of code blocks during export. -Setting the the @code{org-export-babel-evaluate} variable to @code{nil} will +Setting the @code{org-export-babel-evaluate} variable to @code{nil} will ensure that no code blocks are evaluated as part of the export process. This can be useful in situations where potentially untrusted Org-mode files are exported in an automated fashion, for example when Org-mode is used as the @@ -11361,17 +11377,17 @@ Code blocks in the following languages are supported. @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier} @item Asymptote @tab asymptote @tab C @tab C @item C++ @tab C++ @tab Clojure @tab clojure -@item css @tab css @tab ditaa @tab ditaa +@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 LaTeX @tab latex @tab MATLAB @tab matlab @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml -@item Octave @tab octave @tab OZ @tab oz +@item Octave @tab octave @tab Oz @tab oz @item Perl @tab perl @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 SQLite @tab sqlite @end multitable Language-specific documentation is available for some languages. If @@ -11771,8 +11787,8 @@ another by commas, as shown in the following example. @node results, file, var, Specific header arguments @subsubsection @code{:results} -There are three classes of @code{:results} header argument. Only one option of -each type may be supplied per code block. +There are three classes of @code{:results} header argument. Only one option +per class may be supplied per code block. @itemize @bullet @item @@ -11795,7 +11811,7 @@ should be collected from the code block. @item @code{value} This is the default. The result is the value of the last statement in the code block. This header argument places the evaluation in functional -mode. Note that in some languages, e.g., python, use of this result type +mode. Note that in some languages, e.g., Python, use of this result type requires that a @code{return} statement be included in the body of the source code block. E.g., @code{:results value}. @item @code{output} @@ -11815,6 +11831,9 @@ table or scalar depending on their value. The results should be interpreted as an Org-mode table. If a single value is returned, it will be converted into a table with one row and one column. E.g., @code{:results value table}. +@item @code{list} +The results should be interpreted as an Org-mode list. If a single scalar +value is returned it will be converted into a list with only one element. @item @code{scalar}, @code{verbatim} The results should be interpreted literally---they will not be converted into a table. The results will be inserted into the Org-mode @@ -11837,7 +11856,7 @@ Result are assumed to be parseable code and are enclosed in a code block. E.g., @code{:results value code}. @item @code{pp} The result is converted to pretty-printed code and is enclosed in a code -block. This option currently supports Emacs Lisp, python, and ruby. E.g., +block. This option currently supports Emacs Lisp, Python, and Ruby. E.g., @code{:results value pp}. @end itemize @@ -11875,7 +11894,7 @@ 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 +as Python and Ruby require that the code explicitly create output corresponding to the path indicated by @code{:file}. @@ -11894,8 +11913,8 @@ When using @code{:dir}, you should supply a relative path for file output (e.g. @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which case that path will be interpreted relative to the default directory. -In other words, if you want your plot to go into a folder called Work in your -home directory, you could use +In other words, if you want your plot to go into a folder called @file{Work} +in your home directory, you could use @example #+begin_src R :file myplot.png :dir ~/Work @@ -11928,7 +11947,7 @@ and a link of the following form will be inserted in the org buffer: Most of this functionality follows immediately from the fact that @code{:dir} sets the value of the Emacs variable @code{default-directory}, thanks to tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to -install tramp separately in order for the these features to work correctly. +install tramp separately in order for these features to work correctly. @subsubheading Further points @@ -11974,7 +11993,7 @@ The @code{:tangle} header argument specifies whether or not the code block should be included in tangled extraction of source code files. @itemize @bullet -@item @code{yes} +@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}. @@ -12047,7 +12066,7 @@ expanded before the block is evaluated, tangled or exported. The default. No ``noweb'' syntax specific action is taken on evaluating code blocks, However, noweb references will still be expanded during tangling. -@item @code{yes} +@item @code{tangle} All ``noweb'' syntax references in the body of the code block will be expanded before the block is tangled, however ``noweb'' references will not be expanded when the block is evaluated or exported. @@ -12091,7 +12110,7 @@ values: @code{yes} or @code{no}. The default. No caching takes place, and the code block will be evaluated every time it is called. @item @code{yes} -Every time the code block is run a sha1 hash of the code and arguments +Every time the code block is run a SHA1 hash of the code and arguments passed to the block will be generated. This hash is packed into the @code{#+results:} line and will be checked on subsequent executions of the code block. If the code block has not @@ -12269,9 +12288,9 @@ vector of strings or numbers) when appropriate. 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. 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. +@samp{return} statement will usually be required in Python. This is the only one of the four evaluation contexts in which the code is automatically wrapped in a function definition. @@ -12282,12 +12301,12 @@ 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 @code{:session} +@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 +manner: the value of the variable @code{_} in Python and Ruby, and the value of @code{.Last.value} in R). @subsubsection @code{:results output} @@ -12310,7 +12329,7 @@ process. For example, compare the following two blocks: : bye @end example -In non-session mode, the '2' is not printed and does not appear. +In non-session mode, the `2' is not printed and does not appear. @example #+begin_src python :results output :session print "hello" @@ -12324,8 +12343,8 @@ In non-session mode, the '2' is not printed and does not appear. : bye @end example -But in @code{:session} mode, the interactive interpreter receives input '2' -and prints out its value, '2'. (Indeed, the other print statements are +But in @code{:session} mode, the interactive interpreter receives input `2' +and prints out its value, `2'. (Indeed, the other print statements are unnecessary here). @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code @@ -12573,7 +12592,7 @@ 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}. Refer 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 @@ -12588,7 +12607,7 @@ beginning of a headline, i.e. before the first star. Configure the variable pre-defined list of commands, and you can add more such commands using the variable @code{org-speed-commands-user}. Speed keys do not only speed up navigation and other commands, but they also provide an alternative way to -execute commands bound to keys that are not or not easily available on a tty, +execute commands bound to keys that are not or not easily available on a TTY, or on a small mobile device with a limited keyboard. To see which commands are available, activate the feature and press @kbd{?} @@ -12617,7 +12636,7 @@ Source code blocks can be evaluated during export, or when pressing @kbd{C-c C-c} in the block. The most important thing to realize here is that Org mode files which contain code snippets are, in a certain sense, like executable files. So you should accept them and load them into Emacs only from trusted -sources - just like you would do with a program you install on your computer. +sources---just like you would do with a program you install on your computer. Make sure you know what you are doing before customizing the variables which take off the default security brakes. @@ -12692,7 +12711,7 @@ applies. @vindex org-table-formula-constants @vindex org-table-formula Set file-local values for constants to be used in table formulas. This -line set the local variable @code{org-table-formula-constants-local}. +line sets the local variable @code{org-table-formula-constants-local}. The global version of this variable is @code{org-table-formula-constants}. @item #+FILETAGS: :tag1:tag2:tag3: @@ -12713,7 +12732,7 @@ These lines (several are allowed) specify link abbreviations. @vindex org-default-priority This line sets the limits and the default for the priorities. All three must be either letters A-Z or numbers 0-9. The highest priority must -have a lower ASCII number that the lowest priority. +have a lower ASCII number than the lowest priority. @item #+PROPERTY: Property_Name Value This line sets a default inheritance value for entries in the current buffer, most useful for specifying the allowed values of a property. @@ -12894,12 +12913,12 @@ hideblocks @r{Hide all begin/end blocks on startup} nohideblocks @r{Do not hide blocks on startup} @end example @cindex org-pretty-entities -The the display of entities as UTF8 characters is governed by the variable +The display of entities as UTF-8 characters is governed by the variable @code{org-pretty-entities} and the keywords @cindex @code{entitiespretty}, STARTUP keyword @cindex @code{entitiesplain}, STARTUP keyword @example -entitiespretty @r{Show entities as UTF8 characters where possible} +entitiespretty @r{Show entities as UTF-8 characters where possible} entitiesplain @r{Leave entities plain} @end example @item #+TAGS: TAG1(c1) TAG2(c2) @@ -13023,7 +13042,7 @@ individual files using #+STARTUP: indent @end example -If you want a similar effect in earlier version of Emacs and/or Org, or if +If you want a similar effect in an earlier version of Emacs and/or Org, or if you want the indentation to be hard space characters so that the plain text file looks as similar as possible to the Emacs display, Org supports you in the following way: @@ -13181,7 +13200,7 @@ setup. See the installation instructions in the file @cindex @file{cdlatex.el} @cindex Dominik, Carsten Org-mode can make use of the CDLa@TeX{} package to efficiently enter -La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}. +@LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg @cindex @file{imenu.el} Imenu allows menu access to an index of items in a file. Org-mode @@ -13221,12 +13240,10 @@ these tables directly in the buffer. Instead, you need to use the command @kbd{C-c '} to edit them, similar to source code snippets. @table @kbd -@kindex C-c ' -@item C-c ' +@orgcmd{C-c ',org-edit-special} Edit a @file{table.el} table. Works when the cursor is in a table.el table. @c -@kindex C-c ~ -@item C-c ~ +@orgcmd{C-c ~,org-table-create-with-table.el} Insert a @file{table.el} table. If there is already a table at point, this command converts it between the @file{table.el} format and the Org-mode format. See the documentation string of the command @@ -13288,7 +13305,7 @@ to have other replacement keys, look at the variable @item @file{yasnippet.el} @cindex @file{yasnippet.el} The way Org-mode binds the TAB key (binding to @code{[tab]} instead of -@code{"\t"}) overrules yasnippets' access to this key. The following code +@code{"\t"}) overrules YASnippet's access to this key. The following code fixed this problem: @lisp @@ -13341,7 +13358,7 @@ Org. * Add-on packages:: Available extensions * Adding hyperlink types:: New custom link types * Context-sensitive commands:: How to add functionality to such commands -* Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs +* Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs * Dynamic blocks:: Automatically filled blocks * Special agenda views:: Customized views * Extracting agenda information:: Postprocessing of agenda information @@ -13470,7 +13487,7 @@ can also set the @code{:description} property to provide a default for the link description when the link is later inserted into an Org buffer with @kbd{C-c C-l}. -When is makes sense for your new link type, you may also define a function +When it makes sense for your new link type, you may also define a function @code{org-PREFIX-complete-link} that implements special (e.g. completion) support for inserting such a link with @kbd{C-c C-l}. Such a function should not accept any arguments, and return the full link with prefix. @@ -13521,7 +13538,7 @@ contexts. If the function finds it should do nothing locally, it returns @code{ Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a frequent feature request has been to make it work with native tables in -specific languages, for example La@TeX{}. However, this is extremely +specific languages, for example @LaTeX{}. However, this is extremely hard to do in a general way, would lead to a customization nightmare, and would take away much of the simplicity of the Orgtbl-mode table editor. @@ -13536,7 +13553,7 @@ for a very flexible system. Bastien added the ability to do the same with lists, in Orgstruct mode. You can use Org's facilities to edit and structure lists by turning @code{orgstruct-mode} on, then locally exporting such lists in another format -(HTML, La@TeX{} or Texinfo.) +(HTML, @LaTeX{} or Texinfo.) @menu @@ -13594,7 +13611,7 @@ additional columns. @noindent The one problem remaining is how to keep the source table in the buffer without disturbing the normal workings of the file, for example during -compilation of a C file or processing of a La@TeX{} file. There are a +compilation of a C file or processing of a @LaTeX{} file. There are a number of different solutions: @itemize @bullet @@ -13605,7 +13622,7 @@ language. For example, in C mode you could wrap the table between @item Sometimes it is possible to put the table after some kind of @i{END} statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}} -in La@TeX{}. +in @LaTeX{}. @item You can just comment the table line-by-line whenever you want to process the file, and uncomment it whenever you need to edit the table. This @@ -13615,14 +13632,14 @@ key. @end itemize @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax -@subsection A La@TeX{} example of radio tables -@cindex La@TeX{}, and Orgtbl mode +@subsection A @LaTeX{} example of radio tables +@cindex @LaTeX{}, and Orgtbl mode -The best way to wrap the source table in La@TeX{} is to use the +The best way to wrap the source table in @LaTeX{} is to use the @code{comment} environment provided by @file{comment.sty}. It has to be activated by placing @code{\usepackage@{comment@}} into the document header. Orgtbl mode can insert a radio table skeleton@footnote{By -default this works only for La@TeX{}, HTML, and Texinfo. Configure the +default this works only for @LaTeX{}, HTML, and Texinfo. Configure the variable @code{orgtbl-radio-tables} to install templates for other modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will be prompted for a table name, let's say we use @samp{salesfigures}. You @@ -13639,13 +13656,13 @@ will then get the following template: @end example @noindent -@vindex La@TeX{}-verbatim-environments +@vindex @LaTeX{}-verbatim-environments The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function -@code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it +@code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it into the receiver location with name @code{salesfigures}. You may now -fill in the table, feel free to use the spreadsheet features@footnote{If +fill in the table---feel free to use the spreadsheet features@footnote{If the @samp{#+TBLFM} line contains an odd number of dollar characters, -this may cause problems with font-lock in La@TeX{} mode. As shown in the +this may cause problems with font-lock in @LaTeX{} mode. As shown in the example you can fix this by adding an extra line inside the @code{comment} environment that is used to balance the dollar expressions. If you are using AUC@TeX{} with the font-latex library, a @@ -13695,7 +13712,7 @@ Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ \end@{comment@} @end example -The La@TeX{} translator function @code{orgtbl-to-latex} is already part of +The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of Orgtbl mode. It uses a @code{tabular} environment to typeset the table and marks horizontal lines with @code{\hline}. Furthermore, it interprets the following parameters (see also @pxref{Translator functions}): @@ -13759,7 +13776,7 @@ 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 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you -would like to use the La@TeX{} translator, but wanted the line endings to +would like to use the @LaTeX{} translator, but wanted the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you could just overrule the default with @@ -13768,7 +13785,7 @@ overrule the default with @end example For a new language, you can either write your own converter function in -analogy with the La@TeX{} translator, or you can use the generic function +analogy with the @LaTeX{} translator, or you can use the generic function directly. For example, if you have a language where a table is started with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are started with @samp{!BL!}, ended with @samp{!EL!}, and where the field @@ -13802,9 +13819,9 @@ others can benefit from your work. @cindex radio lists @cindex org-list-insert-radio-list -Sending and receiving radio lists works exactly the same way than sending and +Sending and receiving radio lists works exactly the same way as sending and receiving radio tables (@pxref{Radio tables}). As for radio tables, you can -insert radio lists templates in HTML, La@TeX{} and Texinfo modes by calling +insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling @code{org-list-insert-radio-list}. Here are the differences with radio tables: @@ -13821,8 +13838,8 @@ parameters. @kbd{C-c C-c} will work when pressed on the first item of the list. @end itemize -Here is a La@TeX{} example. Let's say that you have this in your -La@TeX{} file: +Here is a @LaTeX{} example. Let's say that you have this in your +@LaTeX{} file: @cindex #+ORGLST @example @@ -13839,7 +13856,7 @@ La@TeX{} file: @end example Pressing `C-c C-c' on @code{a new house} and will insert the converted -La@TeX{} list between the two marker lines. +@LaTeX{} list between the two marker lines. @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking @section Dynamic blocks @@ -13850,11 +13867,11 @@ specially marked regions that are updated by some user-written function. A good example for such a block is the clock table inserted by the command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). -Dynamic block are enclosed by a BEGIN-END structure that assigns a name +Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name to the block and can also specify parameters for the function producing the content of the block. -#+BEGIN:dynamic block +@cindex #+BEGIN:dynamic block @example #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... @@ -13864,11 +13881,9 @@ the content of the block. Dynamic blocks are updated with the following commands @table @kbd -@kindex C-c C-x C-u -@item C-c C-x C-u +@orgcmd{C-c C-x C-u,org-dblock-update} Update dynamic block at point. -@kindex C-u C-c C-x C-u -@item C-u C-c C-x C-u +@orgkey{C-u C-c C-x C-u} Update all dynamic blocks in the current file. @end table @@ -14037,7 +14052,7 @@ You may also modify parameters on the fly like this: @example emacs -batch -l ~/.emacs \ -eval '(org-batch-agenda "a" \ - org-agenda-ndays 30 \ + org-agenda-span month \ org-agenda-include-diary nil \ org-agenda-files (quote ("~/org/project.org")))' \ | lpr @@ -14115,7 +14130,7 @@ properties. Get all properties of the entry at point-or-marker POM.@* This includes the TODO keyword, the tags, time strings for deadline, scheduled, and clocking, and any additional properties defined in the -entry. The return value is an alist, keys may occur multiple times +entry. The return value is an alist. Keys may occur multiple times if the property key was used several times.@* POM may also be nil, in which case the current entry is used. If WHICH is nil or `all', get all properties. If WHICH is @@ -14173,7 +14188,7 @@ values and check if VALUE is in this list. @end defun @defopt org-property-allowed-value-functions -Hook for functions supplying allowed values for specific. +Hook for functions supplying allowed values for a specific property. The functions must take a single argument, the name of the property, and return a flat list of allowed values. If @samp{:ETC} is one of the values, use the values as completion help, but allow also other values @@ -14252,12 +14267,12 @@ information about the entry, or in order to change metadata in the entry. Here are a couple of functions that might be handy: @defun org-todo &optional arg -Change the TODO state of the entry, see the docstring of the functions for +Change the TODO state of the entry. See the docstring of the functions for the many possible values for the argument ARG. @end defun @defun org-priority &optional action -Change the priority of the entry, see the docstring of this function for the +Change the priority of the entry. See the docstring of this function for the possible values for ACTION. @end defun @@ -14325,7 +14340,7 @@ in-buffer settings, but it will understand the logistics of TODO state @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg @section Setting up the staging area -MobileOrg needs to interact with Emacs through directory on a server. If you +MobileOrg needs to interact with Emacs through a directory on a server. If you are using a public server, you should consider to encrypt the files that are uploaded to the server. This can be done with Org-mode 7.02 and with @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl} @@ -14340,8 +14355,7 @@ variable. Note that encryption will apply only to the contents of the The easiest way to create that directory is to use a free @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use Dropbox, or if your version of MobileOrg does not support it, you can use a -webdav server. For more information, check out the the documentation of -MobileOrg and also this +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}.}. When MobileOrg first connects to your Dropbox, it will create a directory @i{MobileOrg} inside the Dropbox. After the directory has been created, tell @@ -14361,7 +14375,7 @@ This operation copies all files currently listed in @code{org-mobile-files} to the directory @code{org-mobile-directory}. By default this list contains all agenda files (as listed in @code{org-agenda-files}), but additional files can be included by customizing @code{org-mobiles-files}. File names will be -staged with path relative to @code{org-directory}, so all files should be +staged with paths relative to @code{org-directory}, so all files should be inside this directory. The push operation also creates a special Org file @file{agendas.org} with all custom agenda view defined by the user@footnote{While creating the agendas, Org-mode will force ID properties @@ -14415,7 +14429,7 @@ another window and also push it onto the kill ring. So you could use @kbd{? z C-y C-c C-c} to store that flagging note as a normal note in the entry. Pressing @kbd{?} twice in succession will offer to remove the @code{:FLAGGED:} tag along with the recorded flagging note (which is stored -in a property). In this way you indicate, that the intended processing for +in a property). In this way you indicate that the intended processing for this flagged entry is finished. @end table @end enumerate @@ -14475,12 +14489,12 @@ Eric and Dan are jointly responsible for the Org-babel system, which turns Org into a multi-language environment for evaluating code and doing literate programming and reproducible research. @item John Wiegley -John has also contributed a number of great ideas and patches -directly to Org, including the attachment system (@file{org-attach.el}), -integration with Apple Mail (@file{org-mac-message.el}), hierarchical -dependencies of TODO items, habit tracking (@file{org-habits.el}), and -encryption (@file{org-crypt.el}). Also, the capture system is really an -extended copy of his great @file{remember.el}. +John has contributed a number of great ideas and patches directly to Org, +including the attachment system (@file{org-attach.el}), integration with +Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO +items, habit tracking (@file{org-habits.el}), and encryption +(@file{org-crypt.el}). Also, the capture system is really an extended copy +of his great @file{remember.el}. @item Sebastian Rose Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work of an ignorant amateur. Sebastian has pushed this part of Org onto a much @@ -14537,8 +14551,9 @@ asked for a way to narrow wide table columns. @i{Thomas S. Dye} contributed documentation on Worg and helped integrating the Org-Babel documentation into the manual. @item -@i{Christian Egli} converted the documentation into Texinfo format, -patched CSS formatting into the HTML exporter, and inspired the agenda. +@i{Christian Egli} converted the documentation into Texinfo format, inspired +the agenda, patched CSS formatting into the HTML exporter, and wrote +@file{org-taskjuggler.el}. @item @i{David Emery} provided a patch for custom CSS support in exported HTML agendas. @@ -14556,12 +14571,21 @@ around a match in a hidden outline tree. @item @i{Austin Frank} works as a mailing list moderator. @item +@i{Eric Fraga} drove the development of BEAMER export with ideas and +testing. +@item +@i{Barry Gidden} did proofreading the manual in preparation for the book +publication through Network Theory Ltd. +@item @i{Niels Giesen} had the idea to automatically archive DONE trees. @item @i{Nicolas Goaziou} rewrote much of the plain list code. @item @i{Kai Grossjohann} pointed out key-binding conflicts with other packages. @item +@i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a +book. +@item @i{Bernt Hansen} has driven much of the support for auto-repeating tasks, task state change logging, and the clocktable. His clear explanations have been critical when we started to adopt the Git version control system. @@ -14578,7 +14602,7 @@ folded entries, and column view for properties. @item @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}. @item -@i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also +@i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also provided frequent feedback and some patches. @item @i{Matt Lundin} has proposed last-row references for table formulas and named @@ -14610,7 +14634,7 @@ and being able to quickly restrict the agenda to a subtree. @i{Tim O'Callaghan} suggested in-file links, search options for general file links, and TAGS. @item -@i{Osamu Okano} wrote @file{orgcard2ref.pl}, a perl program to create a text +@i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text version of the reference card. @item @i{Takeshi Okano} translated the manual and David O'Toole's tutorial @@ -14680,6 +14704,9 @@ with links transformation to Org syntax. @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual chapter about publishing. @item +@i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and +enabled source code highlighling in Gnus. +@item @i{Stefan Vollmar} organized a video-recorded talk at the Max-Planck-Institute for Neurology. He also inspired the creation of a concept index for HTML export. @@ -14739,6 +14766,8 @@ org-customize @key{RET}} and then click yourself through the tree. @c Local variables: @c fill-column: 77 @c indent-tabs-mode: nil +@c paragraph-start: "\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$" +@c paragraph-separate: "\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$" @c End: |