Mercurial > emacs
changeset 81167:bf0c02ef2719
Large number of changes.
| author | Carsten Dominik <dominik@science.uva.nl> |
|---|---|
| date | Wed, 06 Jun 2007 15:14:14 +0000 |
| parents | 4c7d6994e8d6 |
| children | 240754224217 |
| files | man/org.texi |
| diffstat | 1 files changed, 1015 insertions(+), 440 deletions(-) [+] |
line wrap: on
line diff
--- a/man/org.texi Wed Jun 06 15:13:27 2007 +0000 +++ b/man/org.texi Wed Jun 06 15:14:14 2007 +0000 @@ -3,8 +3,8 @@ @setfilename ../info/org @settitle Org Mode Manual -@set VERSION 4.67 -@set DATE February 2007 +@set VERSION 4.77 +@set DATE June 2007 @dircategory Emacs @direntry @@ -89,7 +89,6 @@ * Miscellaneous:: All the rest which did not fit elsewhere * Extensions and Hacking:: It is possible to write add-on code * History and Acknowledgments:: How Org-mode came into being -* GNU Free Documentation License:: The license for this documentation. * Index:: The fast road to specific information * Key Index:: Key bindings and where they are described @@ -123,6 +122,7 @@ * Built-in table editor:: Simple tables * Narrow columns:: Stop wasting space in tables +* Column groups:: Grouping to trigger vertical lines * orgtbl-mode:: The table editor as minor mode * The spreadsheet:: The table editor has spreadsheet capabilities. @@ -163,26 +163,32 @@ * TODO basics:: Marking and displaying TODO entries * TODO extensions:: Workflow and assignments * Priorities:: Some things are more important than others -* Breaking down tasks:: Splitting a task into managable pieces +* Breaking down tasks:: Splitting a task into manageable pieces * Checkboxes:: Tick-off lists Extended use of TODO keywords * Workflow states:: From TODO to DONE in steps * TODO types:: I do this, Fred the rest +* Multiple sets in one file:: Mixing it all, and still finding your way * Per file keywords:: Different files, different requirements Timestamps * Time stamps:: Assigning a time to a tree entry * Creating timestamps:: Commands which insert timestamps -* Custom time format:: If you cannot work with the ISO format -* Repeating items:: Deadlines that come back again and again +* Deadlines and scheduling:: Planning your work * Progress logging:: Documenting when what work was done. Creating timestamps * The date/time prompt:: How org-mode helps you entering date and time +* Custom time format:: Making dates look differently + +Deadlines and Scheduling + +* Inserting deadline/schedule:: +* Repeated tasks:: Progress Logging @@ -224,7 +230,8 @@ * Storing searches:: Type once, use often * Block agenda:: All the stuff you need in a single buffer * Setting Options:: Changing the rules -* Batch processing:: Agenda views from the command line +* Exporting Agenda Views:: Writing agendas to files. +* Extracting Agenda Information for other programs:: Embedded LaTeX @@ -244,7 +251,7 @@ HTML export -* Export commands:: How to invode HTML export +* Export commands:: How to invoke HTML export * Quoting HTML tags:: Using direct HTML in Org-mode * Links:: How hyperlinks get transferred to HTML * Images:: To inline or not to inline? @@ -253,6 +260,8 @@ Text interpretation by the exporter * Comment lines:: Some lines will not be exported +* Initial text:: Text before the first headline +* Footnotes:: Numbers like [1] * Enhancing text:: Subscripts, symbols and more * Export options:: How to influence the export settings @@ -371,7 +380,7 @@ Org-mode's automatic, context sensitive table editor with spreadsheet capabilities can be integrated into any major mode by activating the minor Orgtbl-mode. Using a translation step, it can be used to maintain -tables in arbitray file types, for example in LaTeX. +tables in arbitrary file types, for example in LaTeX. @cindex FAQ There is a website for Org-mode which provides links to the newest @@ -578,8 +587,9 @@ @cindex outline tree Headlines define the structure of an outline tree. The headlines in -Org-mode start with one or more stars, on the left margin. For -example: +Org-mode start with one or more stars, on the left margin@footnote{See +the variable @code{org-special-ctrl-a} to configure special behavior of +@kbd{C-a} in headlines.}. For example: @example * Top level headline @@ -588,6 +598,7 @@ some text *** 3rd level more text + * Another top level headline @end example @@ -595,6 +606,12 @@ outline that has whitespace followed by a single star as headline starters. @ref{Clean view} describes a setup to realize this. +An empty line after the end of a subtree is considered part of it and +will be hidden when the subtree is folded. However, if you leave at +least two empty lines, one empty line will remain visible after folding +the subtree, in order to structure the collapsed view. See the +variable @code{org-cycle-separator-lines} for modifying this behavior. + @node Visibility cycling, Motion, Headlines, Document structure @section Visibility cycling @cindex cycling, visibility @@ -615,7 +632,7 @@ @table @kbd @kindex @key{TAB} @item @key{TAB} -@emph{Subtree cycling}: Rotate current subtree between the states +@emph{Subtree cycling}: Rotate current subtree among the states @example ,-> FOLDED -> CHILDREN -> SUBTREE --. @@ -637,7 +654,7 @@ @kindex S-@key{TAB} @item S-@key{TAB} @itemx C-u @key{TAB} -@emph{Global cycling}: Rotate the entire buffer between the states +@emph{Global cycling}: Rotate the entire buffer among the states @example ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. @@ -662,13 +679,19 @@ @kindex C-c C-x b @item C-c C-x b Show the current subtree in an indirect buffer@footnote{The indirect -buffer (@pxref{Indirect Buffers,Indirect Buffers,Indirect -Buffers,emacs,GNU Emacs Manual}) will contain the entire buffer, but -will be narrowed to the current tree. Editing the indirect buffer will -also change the original buffer, but without affecting visibility in -that buffer.}. With numerical prefix ARG, go up to this level and then -take that tree. If ARG is negative, go up that many levels. With -@kbd{C-u} prefix, do not remove the previously used indirect buffer. +buffer +@ifinfo +(@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) +@end ifinfo +@ifnotinfo +(see the Emacs manual for more information about indirect buffers) +@end ifnotinfo +will contain the entire buffer, but will be narrowed to the current +tree. Editing the indirect buffer will also change the original buffer, +but without affecting visibility in that buffer.}. With numerical +prefix ARG, go up to this level and then take that tree. If ARG is +negative, go up that many levels. With @kbd{C-u} prefix, do not remove +the previously used indirect buffer. @end table When Emacs first visits an Org-mode file, the global state is set to @@ -710,10 +733,16 @@ @item C-c C-j Jump to a different place without changing the current outline visibility. Shows the document structure in a temporary buffer, where -you can use visibility cycling (@key{TAB}) to find your destination. -After pressing @key{RET}, the cursor moves to the selected location in -the original buffer, and the headings hierarchy above it is made -visible. +you can use the following keys to find your destination: +@example +@key{TAB} @r{Cycle visibility.} +@key{down} / @key{up} @r{Next/previous visible headline.} +n / p @r{Next/previous visible headline.} +f / b @r{Next/previous headline same level.} +u @r{One level up.} +0-9 @r{Digit argument.} +@key{RET} @r{Select this location.} +@end example @end table @node Structure editing, Archiving, Motion, Document structure @@ -980,14 +1009,17 @@ headlines. Also, when you are hiding leading stars to get a clean outline view, plain list items starting with a star are visually indistinguishable from true headlines. In short: even though @samp{*} -is supported, it may be better not to use it for plain list items} as +is supported, it may be better not to use it for plain list items.} as bullets. Ordered list items start with @samp{1.} or @samp{1)}. Items belonging to the same list must have the same indentation on the first line. In particular, if an ordered list reaches number @samp{10.}, then the 2--digit numbers must be written left-aligned with the other numbers in the list. Indentation also determines the end of a list item. It ends before the next line that is indented like the bullet/number, or -less. For example: +less. Empty lines are part of the previous item, so you can have +several paragraphs in one item. If you would like an emtpy line to +terminate all currently open plain lists, configure the variable +@code{org-empty-line-terminates-plain-lists}. Here is an for example: @example @group @@ -1078,6 +1110,7 @@ @menu * Built-in table editor:: Simple tables * Narrow columns:: Stop wasting space in tables +* Column groups:: Grouping to trigger vertical lines * orgtbl-mode:: The table editor as minor mode * The spreadsheet:: The table editor has spreadsheet capabilities. @end menu @@ -1141,16 +1174,16 @@ @kindex C-c C-c @item C-c C-c Re-align the table without moving the cursor. - +@c @kindex @key{TAB} @item @key{TAB} Re-align the table, move to the next field. Creates a new row if necessary. - +@c @kindex S-@key{TAB} @item S-@key{TAB} Re-align, move to previous field. - +@c @kindex @key{RET} @item @key{RET} Re-align the table and move down to next row. Creates a new row if @@ -1163,34 +1196,34 @@ @item M-@key{left} @itemx M-@key{right} Move the current column left/right. - +@c @kindex M-S-@key{left} @item M-S-@key{left} Kill the current column. - +@c @kindex M-S-@key{right} @item M-S-@key{right} 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} Move the current row up/down. - +@c @kindex M-S-@key{up} @item M-S-@key{up} Kill the current row or horizontal line. - +@c @kindex M-S-@key{down} @item M-S-@key{down} Insert a new row above (with arg: below) the current row. - +@c @kindex C-c - @item C-c - Insert a horizontal line below current row. With prefix arg, the line is created above the current line. - +@c @kindex C-c ^ @item C-c ^ Sort the table lines in the region. The position of point indicates the @@ -1209,10 +1242,12 @@ Copy a rectangular region from a table to a special clipboard. Point and mark determine edge fields of the rectangle. The process ignores horizontal separator lines. +@c @kindex C-c C-x C-w @item C-c C-x C-w Copy a rectangular region from a table to a special clipboard, and blank all fields in the rectangle. So this is the ``cut'' operation. +@c @kindex C-c C-x C-y @item C-c C-x C-y Paste a rectangular region into a table. @@ -1220,6 +1255,7 @@ 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 C-c C-q @item C-c C-q Wrap several fields in a column like a paragraph. If there is an active @@ -1235,7 +1271,6 @@ @tsubheading{Calculations} @cindex formula, in tables @cindex calculations, in tables - @cindex region, active @cindex active region @cindex transient-mark-mode @@ -1244,7 +1279,7 @@ Sum the numbers in the current column, or in the rectangle defined by the active region. The result is shown in the echo area and can be inserted with @kbd{C-y}. - +@c @kindex S-@key{RET} @item S-@key{RET} When current field is empty, copy from first non-empty field above. @@ -1261,12 +1296,12 @@ that are not fully visible (@pxref{Narrow columns}). When called with a @kbd{C-u} prefix, just make the full field visible, so that it can be edited in place. - +@c @kindex C-c @key{TAB} @item C-c @key{TAB} This is an alias for @kbd{C-u C-c `} to make the current field fully visible. - +@c @item M-x org-table-import Import a file as a table. The table should be TAB- or whitespace separated. Useful, for example, to import an Excel table or data from a @@ -1274,11 +1309,14 @@ 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 | +Tables can also be imported by pasting tabular text into the org-mode +buffer, selecting the pasted text with @kbd{C-x C-x} and then using the +@kbd{C-c |} command (see above under @i{Creation and conversion}. +@c @item M-x org-table-export Export the table as a TAB-separated file. Useful for data exchange with, for example, Excel or database programs. - @end table If you don't like the automatic table editor because it gets in your @@ -1292,7 +1330,7 @@ @noindent Then the only table command that still works is @kbd{C-c C-c} to do a manual re-align. -@node Narrow columns, orgtbl-mode, Built-in table editor, Tables +@node Narrow columns, Column groups, Built-in table editor, Tables @section Narrow columns @cindex narrow columns in tables @@ -1320,7 +1358,7 @@ @noindent Fields that are wider become clipped and end in the string @samp{=>}. Note that the full text is still in the buffer, it is only invisible. -To see the full text, hold the mouse over the field - a tooltip window +To see the full text, hold the mouse over the field - a tool-tip window will show the full content. To edit such a field, use the command @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will open a new window with the full field. Edit it and finish with @kbd{C-c @@ -1338,7 +1376,42 @@ #+STARTUP: noalign @end example -@node orgtbl-mode, The spreadsheet, Narrow columns, Tables +@node Column groups, orgtbl-mode, Narrow columns, Tables +@section Column groups +@cindex grouping columns in tables + +When Org-mode exports tables, it does so by default without vertical +lines because that is visually more satisfying in general. Occasionally +however, vertical lines can be useful to structure a table into groups +of columns, much like horizontal lines can do for groups of rows. In +order to specify column groups, you can use a special row where the +first field contains only @samp{/}. The further fields can either +contain @samp{<} to indicate that this column should start a group, +@samp{>} to indicate the end of a column, or @samp{<>} to make a column +a group of its own. Boundaries between colum groups will upon export be +marked with vertical lines. Here is an example: + +@example +| | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | +|---+----+-----+-----+-----+---------+------------| +| / | <> | < | | > | < | > | +| # | 1 | 1 | 1 | 1 | 1 | 1 | +| # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | +| # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | +|---+----+-----+-----+-----+---------+------------| +#+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)) +@end example + +It is also sufficient to just insert the colum group starters after +every vertical line you'd like to have: + +@example +| N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | +|----+-----+-----+-----+---------+------------| +| / | < | | | < | | +@end example + +@node orgtbl-mode, The spreadsheet, Column groups, Tables @section The Orgtbl minor mode @cindex orgtbl-mode @cindex minor mode for tables @@ -1356,7 +1429,7 @@ Furthermore, with some special setup, it is possible to maintain tables in arbitrary syntax with Orgtbl-mode. For example, it is possible to construct LaTeX tables with the underlying ease and power of -Orgtbl-mode, including spreadsheet capabulities. For details, see +Orgtbl-mode, including spreadsheet capabilities. For details, see @ref{Tables in arbitrary syntax}. @node The spreadsheet, , orgtbl-mode, Tables @@ -1367,7 +1440,12 @@ The table editor makes use of the Emacs @file{calc} package to implement spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to -derive fields from other fields. +derive fields from other fields. While fully featured, Org-mode's +implementation is not identical to other spreadsheets. For example, +Org-mode knows the concept of a @emph{column formula} that will be +applied to all non-header fields in a column without having to copy the +formula to each relevant field. + @menu * References:: How to refer to another field or range * Formula syntax for Calc:: Using Calc to compute stuff @@ -1387,17 +1465,26 @@ reference other fields or ranges. In Org-mode, fields can be referenced by name, by absolute coordinates, and by relative coordinates. To find out what the coordinates of a field are, press @kbd{C-c ?} in that -field. +field, or press @kbd{C-c @}} to toggle the display of a grid. @subsubheading Field references @cindex field references @cindex references, to fields -Formulas can reference the value of another field with the operator +Formulas can reference the value of another field in two ways. Like in +any other spreadsheet, you may reference fields with a letter/number +combination like @code{B3}, meaning the 2nd field in the 3rd row. +@c Such references are always fixed to that field, they don't change +@c when you copy and paste a formula to a different field. So +@c Org-mode's @code{B3} behaves like @code{$B$3} in other spreadsheets. + +@noindent +Org-mode also uses another, more general operator that looks like this: @example @@row$column @end example +@noindent Column references can be absolute like @samp{1}, @samp{2},...@samp{N}, or relative to the current column like @samp{+1} or @samp{-2}. @@ -1417,18 +1504,20 @@ either the column or the row part of the reference, the current row/column is implied. -Org-mode's references with @emph{positive} numbers correspond to fixed -references in other spreadsheet programs. For example, @code{@@3$28} -corresponds to @code{$AB$3}. Org-mode's references with @emph{negative} -numbers behave similar to non-fixed references in other spreadsheet -programs, because when the same formula is used in several fields, -different fields are referenced each time. +Org-mode's references with @emph{unsigned} numbers are fixed references +in the sense that if you use the same reference in the formula for two +different fields, the same field will be referenced each time. +Org-mode's references with @emph{signed} numbers are floating +references because the same reference operator can reference different +fields depending on the field being calculated by the formula. Here are a few examples: @example @@2$3 @r{2nd row, 3rd column} +C2 @r{same as previous} $5 @r{column 5 in the current row} +E& @r{same as previous} @@2 @r{current column, row 2} @@-1$-3 @r{the field one row up, three columns to the left} @@-I$2 @r{field just under hline above current row, column 2} @@ -1449,6 +1538,7 @@ $1..$3 @r{First three fields in the current row.} $P..$Q @r{Range, using column names (see under Advanced)} @@2$1..@@4$3 @r{6 fields between these two fields.} +A2..C4 @r{Same as above.} @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row} @end example @@ -1466,12 +1556,18 @@ @samp{$name} is interpreted as the name of a column, parameter or constant. Constants are defined globally through the variable -@code{org-table-formula-constants}. If you have the -@file{constants.el} package, it will also be used to resolve -constants, including natural constants like @samp{$h} for Planck's -constant, and units like @samp{$km} for kilometers. Column names and -parameters can be specified in special table lines. These are -described below, see @ref{Advanced features}. +@code{org-table-formula-constants}. If you have the @file{constants.el} +package, it will also be used to resolve constants, including natural +constants like @samp{$h} for Planck's constant, and units like +@samp{$km} for kilometers@footnote{@file{Constant.el} can supply the +values of constants in two different unit systems, @code{SI} and +@code{cgs}. Which one is used depends on the value of the variable +@code{constants-unit-system}. You can use the @code{#+STARTUP} options +@code{constSI} and @code{constcgs} to set this value for the current +buffer.}. Column names and parameters can be specified in special table +lines. These are described below, see @ref{Advanced features}. All +names must start with a letter, and further consist of letters and +numbers. @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet @subsection Formula syntax for Calc @@ -1485,6 +1581,7 @@ evaluation by @code{calc-eval} (@pxref{Calling Calc from Your Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU Emacs Calc Manual}), +@c FIXME: The link to the calc manual in HTML does not work. variable substitution takes place according to the rules described above. @cindex vectors, in table calculations The range vectors can be directly fed into the calc vector functions @@ -1518,7 +1615,7 @@ $1+$2 @r{Sum of first and second field} $1+$2;%.2f @r{Same, format result to two decimals} exp($2)+exp($1) @r{Math functions can be used} -$;%.1f @r{Reformat current cell to 1 decimal} +$0;%.1f @r{Reformat current cell to 1 decimal} ($3-32)*5/9 @r{Degrees F -> C conversion} $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}} tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1} @@ -1528,21 +1625,28 @@ taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} @end example +Calc also contains a complete set of logical operations. For example + +@example +if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty} +@end example + @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet @subsection Emacs Lisp forms as formulas @cindex Lisp forms, as table formulas It is also possible to write a formula in Emacs Lisp; this can be useful -for string manipulation and control structures. If a formula starts -with a single quote followed by an opening parenthesis, then it is -evaluated as a lisp form. The evaluation should return either a string -or a number. Just as with @file{calc} formulas, you can specify modes -and a printf format after a semicolon. A reference will be replaced -with a string (in double quotes) containing the field. If you provide -the @samp{N} mode switch, all referenced elements will be numbers. -Ranges are inserted as space-separated fields, so you can embed them in -list or vector syntax. A few examples, note how the @samp{N} mode is -used when we do computations in lisp. +for string manipulation and control structures, if the Calc's +functionality is not enough. If a formula starts with a single quote +followed by an opening parenthesis, then it is evaluated as a lisp form. +The evaluation should return either a string or a number. Just as with +@file{calc} formulas, you can specify modes and a printf format after a +semicolon. A reference will be replaced with a string (in double +quotes) containing the field. If you provide the @samp{N} mode switch, +all referenced elements will be numbers. Ranges are inserted as +space-separated fields, so you can embed them in list or vector syntax. +A few examples, note how the @samp{N} mode is used when we do +computations in lisp. @example @r{Swap the first two characters of the content of column 1} @@ -1567,12 +1671,11 @@ Formulas are stored in a special line starting with @samp{#+TBLFM:} directly below the table. If you typed the equation in the 4th field of the 3rd data line in the table, the formula will look like -@samp{@@3$2=$1+$2}. When inserting/deleting/swapping column and rows +@samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows with the appropriate commands, @i{absolute references} (but not relative -ones) in stored formulas are modified in order to -still reference the same field. Of cause this is not true if you edit -the table structure with normal editing commands - then you must go and -fix equations yourself. +ones) in stored formulas are modified in order to still reference the +same field. Of cause this is not true if you edit the table structure +with normal editing commands - then you must fix the equations yourself. Instead of typing an equation into the field, you may also use the following command @@ -1593,7 +1696,9 @@ Often in a table, the same formula should be used for all fields in a particular column. Instead of having to copy the formula to all fields in that column, org-mode allows to assign a single formula to an entire -column. +column. If the table contains horizontal separator hlines, everything +before the first such line is considered part of the table @emph{header} +and will not be modified by column formulas. To assign a formula to a column, type it directly into any field in the column, preceded by an equal sign, like @samp{=$1+$2}. When you press @@ -1626,7 +1731,11 @@ You can edit individual formulas in the minibuffer or directly in the field. Org-mode can also prepare a special buffer with all active -formulas of a table. +formulas of a table. When offering a formula for editing, Org-mode +converts references to the standard format (like @code{B3} or @code{D&}) +if possible. If you prefer to only work with the internal format (like +@code{@@3$2} or @code{$4}), configure the variable +@code{org-table-use-standard-references}. @table @kbd @kindex C-c = @@ -1645,21 +1754,36 @@ @item C-c ? While editing a formula in a table field, highlight the field(s) referenced by the reference at the cursor position in the formula. +@kindex C-c @} +@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}. +@kindex C-c @{ +@item C-c @{ +Toggle the formula debugger on and off. See below. @kindex C-c ' @item C-c ' Edit all formulas for the current table in a special buffer, where the -formulas will be displayed one per line. +formulas will be displayed one per line. If the current field has an +active formula, the cursor in the formula editor will mark it. While inside the special buffer, Org-mode will automatically highlight any field or range reference at the cursor position. You may edit, remove and add formulas, and use the following commands: @table @kbd @kindex C-c C-c +@kindex C-x C-s @item C-c C-c -Exit the buffer and store the modified formulas. With @kbd{C-u} prefix, -also apply the new formulas to the entire table. +@itemx C-x C-s +Exit the formula editor and store the modified formulas. With @kbd{C-u} +prefix, also apply the new formulas to the entire table. @kindex C-c C-q @item C-c C-q -Exit the buffer without installing changes. +Exit the formula editor without installing changes. +@kindex C-c C-r +@item C-c C-r +Toggle all references in the formula editor between standard (like +@code{B3}) and internal (like @code{@@3$2}). @kindex @key{TAB} @item @key{TAB} Pretty-print or indent lisp formula at point. When in a line containing @@ -1671,23 +1795,25 @@ Complete Lisp symbols, just like in Emacs-lisp-mode. @kindex S-@key{up} @kindex S-@key{down} -@item S-@key{up}/@key{down} -Move the reference line in the Org-mode buffer up and down. This is -important for highlighting the references of column formulas for -different rows. +@kindex S-@key{left} +@kindex S-@key{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} +Move the test line for column formulas in the Org-mode buffer up and +down. @kindex M-@key{up} @kindex M-@key{down} @item M-@key{up}/@key{down} Scroll the window displaying the table. -@end table @kindex C-c @} @item C-c @} -Toggle the display of row and column numbers for a table, using -overlays. These are uptated each time the table is aligned, you can -force it with @kbd{C-c C-c}. -@kindex C-c @{ -@item C-c @{ -Toggle the formula debugger on and off. See below. +Turn the coordinate grid in the table on and off. +@end table @end table Making a table field blank does not remove the formula associated with @@ -1708,8 +1834,8 @@ becomes the string @samp{#ERROR}. If you would like see what is going on during variable substitution and calculation in order to find a bug, turn on formula debugging in the @code{Tbl} menu and repeat the -calculation, for example by pressing @kbd{C-c = @key{RET}} in a field. -Detailed information will be displayed. +calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a +field. Detailed information will be displayed. @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet @subsection Updating the Table @@ -1728,14 +1854,14 @@ @item C-c * Recalculate the current row by first applying the stored column formulas from left to right, and all field formulas in the current row. - +@c @kindex C-u C-c * @item C-u C-c * @kindex C-u C-c C-c @itemx C-u C-c C-c Recompute the entire table, line by line. Any lines before the first hline are left alone, assuming that these are part of the table header. - +@c @kindex C-u C-u C-c * @item C-u C-u C-c * Iterate the table by recomputing it until no further changes occur. @@ -1743,7 +1869,6 @@ fields that are computed @i{later} in the calculation sequence. @end table - @node Advanced features, , Updating the table, The spreadsheet @subsection Advanced features @@ -2058,7 +2183,7 @@ enough, you can write custom functions to select the search string and to do the search for particular file types - see @ref{Custom searches}. The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}. - +@c @kindex C-c C-l @cindex link completion @cindex completion, of links @@ -2068,24 +2193,26 @@ You can just type a link, using text for an internal link, or one of the link type prefixes mentioned in the examples above. All links stored during the current session are part of the history for this prompt, so -you can access them with @key{up} and @key{down}, or with -completion@footnote{After insertion of a stored link, the link will be -removed from the list of stored links. To keep it in the list later +you can access them with @key{up} and @key{down}. Completion, on the +other hand, will help you to insert valid link prefixes like +@samp{http:} or @samp{ftp:}, including the prefixes defined through link +abbreviations (@pxref{Link abbreviations}). The link will be inserted +into the buffer@footnote{After insertion of a stored link, the link will +be removed from the list of stored links. To keep it in the list later use, use a triple @kbd{C-u} prefix to @kbd{C-c C-l}, or configure the -option @code{org-keep-stored-link-after-insertion}.}. The link will be -inserted into the buffer, along with a descriptive text. If some text -was selected when this command is called, the selected text becomes the -default description.@* Note that you don't have to use this command to -insert a link. Links in Org-mode are plain text, and you can type or -paste them straight into the buffer. By using this command, the links -are automatically enclosed in double brackets, and you will be asked for -the optional descriptive text. - +option @code{org-keep-stored-link-after-insertion}.}, along with a +descriptive text. If some text was selected when this command is +called, the selected text becomes the default description.@* Note that +you don't have to use this command to insert a link. Links in Org-mode +are plain text, and you can type or paste them straight into the buffer. +By using this command, the links are automatically enclosed in double +brackets, and you will be asked for the optional descriptive text. +@c @c If the link is a @samp{file:} link and @c the linked file is located in the same directory as the current file or @c a subdirectory of it, the path of the file will be inserted relative to @c the current directory. - +@c @kindex C-u C-c C-l @cindex file name completion @cindex completion, of file names @@ -2098,11 +2225,11 @@ to the current directory using @samp{../}. Otherwise an absolute path is used, if possible with @samp{~/} for your home directory. You can force an absolute path with two @kbd{C-u} prefixes. - -@item C-c C-l @r{with cursor on existing link} +@c +@item C-c C-l @r{(with cursor on existing link)} When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the link and description parts of the link. - +@c @cindex following links @kindex C-c C-o @item C-c C-o @@ -2118,26 +2245,26 @@ is based on file extension only. See option @code{org-file-apps}. If you want to override the default application and visit the file with Emacs, use a @kbd{C-u} prefix. - +@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, also @kbd{mouse-1} will follow a link. - +@c @kindex mouse-3 @item mouse-3 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and internal links to be displayed in another window@footnote{See the variable @code{org-display-internal-link-with-indirect-buffer}}. - +@c @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 @cindex links, returning to @kindex C-c & @item C-c & @@ -2145,7 +2272,7 @@ commands following internal links, and by @kbd{C-c %}. Using this command several times in direct succession moves through a ring of previously recorded positions. - +@c @kindex C-c C-x C-n @kindex C-c C-x C-p @cindex links, finding next/previous @@ -2341,8 +2468,8 @@ @noindent In these entries, the character specifies how to select the template. The first string specifies the template. Two more (optional) strings give the file in which, and the headline under which the new -note should be stored. The file defaults to -@code{org-default-notes-file}, the heading to +note should be stored. The file defaults (if not present or @code{nil}) +to @code{org-default-notes-file}, the heading to @code{org-remember-default-headline}. Both defaults help to get to the storing location quickly, but you can change the location interactively while storing the note. @@ -2398,8 +2525,7 @@ @end example @noindent -If you would like to have the cursor in a specific position after the -template has been expanded: +To place the cursor after template expansion use: @example %? @r{After completing the template, position cursor here.} @@ -2408,7 +2534,7 @@ @noindent If you change you mind about which template to use, call @code{org-remember} in the remember buffer. You may then select a new -template that will be filled with the previoous context information. +template that will be filled with the previous context information. @node Storing notes, , Remember templates, Remember @subsection Storing notes @@ -2419,20 +2545,27 @@ template is used. Then the command offers the headings tree of the selected file, with the cursor position at the default headline (if you had specified one in the template). You can either immediately press -@key{RET} to get the note placed there. Or you can use vertical cursor -motion (@key{up} and @key{down}) and visibility cycling (@key{TAB}) to -find a better place. Pressing @key{RET} or @key{left} or @key{right} +@key{RET} to get the note placed there. Or you can use the following +keys to find a better location: +@example +@key{TAB} @r{Cycle visibility.} +@key{down} / @key{up} @r{Next/previous visible headline.} +n / p @r{Next/previous visible headline.} +f / b @r{Next/previous headline same level.} +u @r{One level up.} +@c 0-9 @r{Digit argument.} +@end example +@noindent +Pressing @key{RET} or @key{left} or @key{right} then leads to the following result. -@multitable @columnfractions 0.2 0.1 0.7 +@multitable @columnfractions 0.2 0.15 0.65 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted} @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor -@item @tab @key{left} @tab as same level, before current heading -@item @tab @key{right} @tab as same level, after current heading +@item @tab @key{left}/@key{right} @tab as same level, before/after current heading @item not on headline @tab @key{RET} @tab at cursor position, level taken from context. - Or use prefix arg to specify level manually. @end multitable So a fast way to store the note to its default location is to press @@ -2467,7 +2600,7 @@ * TODO basics:: Marking and displaying TODO entries * TODO extensions:: Workflow and assignments * Priorities:: Some things are more important than others -* Breaking down tasks:: Splitting a task into managable pieces +* Breaking down tasks:: Splitting a task into manageable pieces * Checkboxes:: Tick-off lists @end menu @@ -2488,7 +2621,7 @@ @kindex C-c C-t @cindex cycling, of TODO states @item C-c C-t -Rotate the TODO state of the current item between +Rotate the TODO state of the current item among @example ,-> (unmarked) -> TODO -> DONE --. @@ -2508,9 +2641,11 @@ @item C-c C-v View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the entire buffer, but shows all TODO items and the headings hierarchy -above them. With prefix arg, show also the DONE entries. With -numerical prefix N, show the tree for the Nth keyword in the variable -@code{org-todo-keywords}. +above them. With prefix arg, search for a specific TODO. You will be +prompted for the keyword, and you can also give a list of keywords like +@code{kwd1|kwd2|...}. With numerical prefix N, show the tree for the +Nth keyword in the variable @code{org-todo-keywords}. With two prefix +args, find all TODO and DONE entries. @kindex C-c a t @item C-c a t Show the global TODO list. This collects the TODO items from all @@ -2523,16 +2658,14 @@ @c agenda, customize the variable @code{org-agenda-include-all-todo}. @end table - @node TODO extensions, Priorities, TODO basics, TODO items @section Extended use of TODO keywords @cindex extended TODO keywords The default implementation of TODO entries is just two states: TODO and -DONE. You can, however, use the TODO feature for more complicated -things by configuring the variables @code{org-todo-keywords} and -@code{org-todo-interpretation}. Using special setup, you can even use -TODO keywords in different ways in different org files. +DONE. You can use the TODO feature for more complicated things by +configuring the variable @code{org-todo-keywords}. With special setup, +the TODO keyword system can work differently in different files. Note that @i{tags} are another way to classify headlines in general and TODO items in particular (@pxref{Tags}). @@ -2540,6 +2673,7 @@ @menu * Workflow states:: From TODO to DONE in steps * TODO types:: I do this, Fred the rest +* Multiple sets in one file:: Mixing it all, and still finding your way * Per file keywords:: Different files, different requirements @end menu @@ -2548,103 +2682,149 @@ @cindex TODO workflow @cindex workflow states as TODO keywords -You can use TODO keywords to indicate different states in the process -of working on an item, for example: +You can use TODO keywords to indicate different @emph{sequential} states +in the process of working on an item, for example@footnote{Changing +this variable only becomes effective after restarting Org-mode in a +buffer.}: @lisp -(setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE") - org-todo-interpretation 'sequence) +(setq org-todo-keywords + '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) @end lisp +The vertical bar separates the TODO keywords (states that @emph{need +action}) from the DONE states (which need @emph{no further action}. If +you don't provide the separator bar, the last state is used as the DONE +state. @cindex completion, of TODO keywords -Changing these variables only becomes effective in a new Emacs session. -With this setup, the command @kbd{C-c C-t} will cycle an entry from -TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may also -use a prefix argument to quickly select a specific state. For example -@kbd{C-3 C-c C-t} will change the state immediately to VERIFY. +With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO +to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may +also use a prefix argument to quickly select a specific state. For +example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. If you define many keywords, you can use in-buffer completion (see -@ref{Completion}) to insert these words into the buffer. Changing a todo -state can be logged with a timestamp, see @ref{Tracking TODO state +@ref{Completion}) to insert these words into the buffer. Changing a +todo state can be logged with a timestamp, see @ref{Tracking TODO state changes} for more information. -@node TODO types, Per file keywords, Workflow states, TODO extensions +@node TODO types, Multiple sets in one file, Workflow states, TODO extensions @subsection TODO keywords as types @cindex TODO types @cindex names as TODO keywords @cindex types as TODO keywords The second possibility is to use TODO keywords to indicate different -types of action items. For example, you might want to indicate that -items are for ``work'' or ``home''. If you are into David Allen's -@emph{Getting Things DONE}, you might want to use todo types -@samp{NEXTACTION}, @samp{WAITING}, @samp{MAYBE}. Or, when you work -with several people on a single project, you might want to assign -action items directly to persons, by using their names as TODO -keywords. This would be set up like this: +@emph{types} of action items. For example, you might want to indicate +that items are for ``work'' or ``home''. Or, when you work with several +people on a single project, you might want to assign action items +directly to persons, by using their names as TODO keywords. This would +be set up like this: + +@lisp +(setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE"))) +@end lisp + +In this case, different keywords do not indicate a sequence, but rather +different types. So the normal work flow would be to assign a task to a +person, and later to mark it DONE. Org-mode supports this style by +adapting the workings of the command @kbd{C-c C-t}@footnote{This is also +true for the @kbd{t} command in the timeline and agenda buffers.}. When +used several times in succession, it will still cycle through all names, +in order to first select the right type for a task. But when you return +to the item after some time and execute @kbd{C-c C-t} again, it will +switch from any name directly to DONE. Use prefix arguments or +completion to quickly select a specific name. You can also review the +items of a specific TODO type in a sparse tree by using a numeric prefix +to @kbd{C-c C-v}. For example, to see all things Lucy has to do, you +would use @kbd{C-3 C-c C-v}. To collect Lucy's items from all agenda +files into a single buffer, you would use the prefix arg as well when +creating the global todo list: @kbd{C-3 C-c t}. + +@node Multiple sets in one file, Per file keywords, TODO types, TODO extensions +@subsection Multiple keyword sets in one file +@cindex todo keyword sets + +Sometimes you may want to use different sets of TODO keywords in +parallel. For example, you may want to have the basic +@code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a +separate state indicating that an item has been canceled (so it is not +DONE, but also does not require action). Your setup would then look +like this: @lisp -(setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") - org-todo-interpretation 'type) +(setq org-todo-keywords + '((sequence "TODO" "|" "DONE") + (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED") + (sequence "|" "CANCELED"))) @end lisp -In this case, different keywords do not indicate a sequence, but -rather different types. So it is normally not useful to change from -one type to another. Therefore, in this case the behavior of the -command @kbd{C-c C-t} is changed slightly@footnote{This is also true -for the @kbd{t} command in the timeline and agenda buffers.}. When -used several times in succession, it will still cycle through all -names. But when you return to the item after some time and execute -@kbd{C-c C-t} again, it will switch from each name directly to DONE. -Use prefix arguments or completion to quickly select a specific name. -You can also review the items of a specific TODO type in a sparse tree -by using a numeric prefix to @kbd{C-c C-v}. For example, to see all -things Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect -Lucy's items from all agenda files into a single buffer, you -would use the prefix arg as well when creating the global todo list: -@kbd{C-3 C-c t}. - -@node Per file keywords, , TODO types, TODO extensions -@subsection Setting up TODO keywords for individual files +The keywords should all be different, this helps Org-mode to keep track +of which subsequence should be used for a given entry. In this setup, +@kbd{C-c C-t} only operates within a subsequence, so it switches from +@code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to +(nothing) to @code{REPORT}. Therefore you need a mechanism to initially +select the correct sequence. Besides the obvious ways like typing a +keyword or using completion, you may also apply the following commands: + +@table @kbd +@kindex C-S-@key{right} +@kindex C-S-@key{left} +@item C-S-@key{right} +@itemx C-S-@key{left} +These keys jump from one TODO subset to the next. In the above example, +@kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to +@code{REPORT}, and any of the words in the second row to @code{CANCELED}. +@kindex S-@key{right} +@kindex S-@key{left} +@item S-@key{right} +@itemx S-@key{left} +@kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through +@emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}} +would switch from @code{DONE} to @code{REPORT} in the example above. +@end table + +@node Per file keywords, , Multiple sets in one file, TODO extensions +@subsection Setting up keywords for individual files @cindex keyword options @cindex per file keywords -It can be very useful to use different aspects of the TODO mechanism -in different files, which is not possible with the global settings -described above. For file-local settings, you need to add special -lines to the file which set the keywords and interpretation for that -file only. For example, to set one of the two examples discussed -above, you need one of the following lines, starting in column zero -anywhere in the file: +It can be very useful to use different aspects of the TODO mechanism in +different files. For file-local settings, you need to add special lines +to the file which set the keywords and interpretation for that file +only. For example, to set one of the two examples discussed above, you +need one of the following lines, starting in column zero anywhere in the +file: @example -#+SEQ_TODO: TODO FEEDBACK VERIFY DONE -#+TYP_TODO: Fred Sara Lucy Mike DONE +#+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED +@end example +or +@example +#+TYP_TODO: Fred Sara Lucy Mike | DONE @end example +A setup for using several sets in parallel would be: + +@example +#+SEQ_TODO: "TODO" "|" "DONE" +#+SEQ_TODO: "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED" +#+SEQ_TODO: "|" "CANCELED" +@end example + + @cindex completion, of option keywords @kindex M-@key{TAB} @noindent To make sure you are using the correct keyword, type @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. @cindex DONE, final TODO keyword -Remember that the last keyword must always mean that the item is DONE -(although you may use a different word). Also note that in each file, -only one of the two aspects of TODO keywords can be used. After -changing one of these lines, use @kbd{C-c C-c} with the cursor still -in the line to make the changes known to Org-mode@footnote{Org-mode -parses these lines only when Org-mode is activated after visiting a -file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#+} -is simply restarting Org-mode for the current buffer.}. - -If you want to use very many keywords, for example when working with a -large group of people, you may split the names over several lines: - -@example -#+TYP_TODO: Fred Sara Lucy Mike -#+TYP_TODO: Luis George Jules Jessica -#+TYP_TODO: Kim Arnold Peter -#+TYP_TODO: DONE -@end example +Remember that the keywords after the vertical bar (or the last keyword +if no bar is there) must always mean that the item is DONE (although you +may use a different word). After changing one of these lines, use +@kbd{C-c C-c} with the cursor still in the line to make the changes +known to Org-mode@footnote{Org-mode parses these lines only when +Org-mode is activated after visiting a file. @kbd{C-c C-c} with the +cursor in a line starting with @samp{#+} is simply restarting Org-mode +for the current buffer.}. @node Priorities, Breaking down tasks, TODO extensions, TODO items @section Priorities @@ -2673,7 +2853,7 @@ @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} @@ -2683,11 +2863,22 @@ Furthermore, these keys are also used by CUA-mode (@pxref{Conflicts}). @end table +You can change the range of allowed priorities by setting the variables +@code{org-highest-priority}, @code{org-lowest-priority}, and +@code{org-default-priority}. For an individual buffer, you may set +these values (highest, lowest, default) like this (please make sure that +the highest priority is earlier in the alphabet than the lowest +priority): + +@example +#+PRIORITIES: A C B +@end example + @node Breaking down tasks, Checkboxes, Priorities, TODO items @section Breaking tasks down into subtasks @cindex tasks, breaking down -It is often advisable to break down large tasks into smaller, managable +It is often advisable to break down large tasks into smaller, manageable subtasks. You can do this by creating an outline tree below a TODO item, with detailed subtasks on the tree@footnote{To keep subtasks out of the global TODO list, see the @@ -2780,8 +2971,7 @@ @menu * Time stamps:: Assigning a time to a tree entry * Creating timestamps:: Commands which insert timestamps -* Custom time format:: If you cannot work with the ISO format -* Repeating items:: Deadlines that come back again and again +* Deadlines and scheduling:: Planning your work * Progress logging:: Documenting when what work was done. @end menu @@ -2799,7 +2989,7 @@ 09:39>}@footnote{This is the standard ISO date/time format. If you cannot get used to these, see @ref{Custom time format}}. A time stamp can appear anywhere in the headline or body of an org-tree entry. Its -presence allows entries to be shown on specific dates in the agenda +presence causes entries to be shown on specific dates in the agenda (@pxref{Weekly/Daily agenda}). We distinguish: @table @var @@ -2815,6 +3005,39 @@ * Meet Peter at the movies <2006-11-01 Wed 19:15> @end example +@item Time stamp with repeater interval +@cindex timestamp, with repeater interval +A time stamp may contain a @emph{repeater interval}, indicating that it +applies not only on the given date, but again and again after a certain +interval of N days (d), weeks (w), months(m), or years(y). The +following will show up in the agenda every Wednesday: + +@example +* Pick up Sam at school <2007-05-16 Wed 12:30 +1w> +@end example + +@item Diary-style sexp entries +For more complex date specifications, Org-mode supports using the +special sexp diary entries implemented in the Emacs calendar/diary +package. For example + +@example +* The nerd meeting on every 2nd Thursday of the month + <%%(diary-float t 4 2)> +@end example + +@item Time/Date range +@cindex timerange +@cindex date range +Two time stamps connected by @samp{--} denote a range. The headline +will be shown on the first and last day of the range, and on any dates +that are displayed and fall in the range. Here is an example: + +@example +** Meeting in Amsterdam + <2004-08-23 Mon>--<2004-08-26 Thu> +@end example + @item Inactive time stamp @cindex timestamp, inactive @cindex inactive timestamp @@ -2826,65 +3049,9 @@ * Gillian comes late for the fifth time [2006-11-01 Wed] @end example -@item Time stamp range -@cindex timerange -Two time stamps connected by @samp{--} denote a time range. The -headline will be shown on the first and last day of the range, and on -any dates that are displayed and fall in the range. Here is an -example: - -@example -** Meeting in Amsterdam - <2004-08-23 Mon>--<2004-08-26 Thu> -@end example - -@item Time stamp with SCHEDULED keyword -@cindex SCHEDULED keyword -If a time stamp is preceded by the word @samp{SCHEDULED:}, it means you -are planning to start working on that task on the given date. So this is -not about recording an event, but about planning your work. The -headline will be listed under the given 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. - -@example -*** TODO Call Trillian for a date on New Years Eve. - SCHEDULED: <2004-12-25 Sat> -@end example - -@item Time stamp with DEADLINE keyword -@cindex DEADLINE keyword -If a time stamp is preceded by the word @samp{DEADLINE:}, the task -(most likely a TODO item) is supposed to be finished on that date, and -it will be listed then. In addition, the compilation for @emph{today} -will carry a warning about the approaching or missed deadline, -starting @code{org-deadline-warning-days} before the due date, and -continuing until the entry is marked DONE. An example: - -@example -*** TODO write article about the Earth for the Guide - The editor in charge is [[bbdb:Ford Prefect]] - DEADLINE: <2004-02-29 Sun> -@end example -@item Time stamp with CLOSED keyword -@cindex CLOSED keyword -When @code{org-log-done} is non-nil, Org-mode will automatically insert -a special time stamp each time a TODO entry is marked done -(@pxref{Progress logging}). This time stamp is enclosed in square -brackets instead of angular brackets. - -@item Time range with CLOCK keyword -@cindex CLOCK keyword -When using the clock to time the work that is being done on specific -items, time ranges preceded by the CLOCK keyword are inserted -automatically into the file. The time stamps are enclosed in square -brackets instead of angular brackets. @xref{Clocking work time}. @end table -@node Creating timestamps, Custom time format, Time stamps, Timestamps +@node Creating timestamps, Deadlines and scheduling, Time stamps, Timestamps @section Creating timestamps @cindex creating timestamps @cindex timestamps, creating @@ -2899,61 +3066,40 @@ Prompt for a date and insert a corresponding time stamp. When the cursor is at a previously used time stamp, it is updated to NOW. When this command is used twice in succession, a time range is inserted. - +@c @kindex C-u C-c . @item C-u C-c . Like @kbd{C-c .}, but use the alternative format which contains date and time. The default time can be rounded to multiples of 5 minutes, see the option @code{org-time-stamp-rounding-minutes}. - +@c @kindex C-c ! @item C-c ! -Like @kbd{C-c .}, but insert an inactive time stamp not triggering the -agenda. - +Like @kbd{C-c .}, but insert an inactive time stamp that will not cause +an agenda entry. +@c @kindex C-c < @item C-c < Insert a time stamp corresponding to the cursor date in the Calendar. - +@c @kindex C-c > @item C-c > Access the Emacs calendar for the current date. If there is a timestamp in the current line, goto the corresponding date instead. - +@c @kindex C-c C-o @item C-c C-o Access the agenda for the date given by the time stamp or -range at point (@pxref{Weekly/Daily agenda}). - -@kindex C-c C-d -@item C-c C-d -Insert @samp{DEADLINE} keyword along with a stamp. The insertion will -happen in the line directly following the headline. -@c FIXME Any CLOSED timestamp will be removed.???????? - -@kindex C-c C-w -@cindex sparse tree, for deadlines -@item C-c C-w -Create a sparse tree with all deadlines that are either past-due, or -which will become due within @code{org-deadline-warning-days}. -With @kbd{C-u} prefix, show all deadlines in the file. With a numeric -prefix, check that many days. For example, @kbd{C-1 C-c C-w} shows -all deadlines due tomorrow. - -@kindex C-c C-s -@item C-c C-s -Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will -happen in the line directly following the headline. Any CLOSED -timestamp will be removed. - +@c @kindex S-@key{left} @kindex S-@key{right} @item S-@key{left} @itemx S-@key{right} Change date at cursor by one day. These key bindings conflict with CUA-mode (@pxref{Conflicts}). - +@c @kindex S-@key{up} @kindex S-@key{down} @item S-@key{up} @@ -2963,8 +3109,7 @@ headline and not at a time stamp, these same keys modify the priority of an item. (@pxref{Priorities}). The key bindings also conflict with CUA-mode (@pxref{Conflicts}). - - +@c @kindex C-c C-y @cindex evaluate time range @item C-c C-y @@ -2976,9 +3121,10 @@ @menu * The date/time prompt:: How org-mode helps you entering date and time +* Custom time format:: Making dates look differently @end menu -@node The date/time prompt, , Creating timestamps, Creating timestamps +@node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps @subsection The date/time prompt @cindex date, reading in minibuffer @cindex time, reading in minibuffer @@ -3047,8 +3193,8 @@ Choose date in calendar (only if nothing was typed into minibuffer). @end table -@node Custom time format, Repeating items, Creating timestamps, Timestamps -@section Custom time format +@node Custom time format, , The date/time prompt, Creating timestamps +@subsection Custom time format @cindex custom date/time format @cindex time format, custom @cindex date format, custom @@ -3090,48 +3236,119 @@ format is shorter, things do work as expected. @end itemize -@node Repeating items, Progress logging, Custom time format, Timestamps -@section Repeating items -@cindex TODO items, repeating -@cindex deadlines, repeating -@cindex scheduling, repeating - -Org-mode integrates with the Emacs calendar and diary to display cyclic -appointments, anniversaries and other special entries in the agenda -(@pxref{Weekly/Daily agenda}). However, it can be useful to have -certain deadlines and scheduling items to auto-repeat. The advantage of -a deadline or scheduled item is that the they produce warnings ahead of -time and automatically forward themselves in the agenda until they are -done. The abstract difference is therefore between cyclic -@i{appointments} and cyclic @i{action items}. For appointments you -should use the diary, for actions you can uses an org-mode deadline or -scheduling time stamp together with a REPEAT cookie. For example: + +@node Deadlines and scheduling, Progress logging, Creating timestamps, Timestamps +@section Deadlines and Scheduling + +A time stamp may be preceded by special keywords to facilitate planning +of work: + +@table @var +@item DEADLINE +@cindex DEADLINE keyword +The task (most likely a TODO item) is supposed to be finished on that +date, and it will be listed then. In addition, the compilation for +@emph{today} will carry a warning about the approaching or missed +deadline, starting @code{org-deadline-warning-days} before the due date, +and continuing until the entry is marked DONE. An example: + +@example +*** TODO write article about the Earth for the Guide + The editor in charge is [[bbdb:Ford Prefect]] + DEADLINE: <2004-02-29 Sun> +@end example + +@item SCHEDULED +@cindex SCHEDULED keyword +You are planning to start working on that task on the given date. 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. @example -* TODO Replace batteries in smoke detector REPEAT(+18m) - SCHEDULED: <2007-01-01 Mon> - -* TODO Get dentist appointment REPEAT(+6m) - SCHEDULED: <2006-12-19 Tue> - -* TODO Tax report to IRS REPEAT(+1y) - DEADLINE: <2007-04-01 Sun> +*** TODO Call Trillian for a date on New Years Eve. + SCHEDULED: <2004-12-25 Sat> @end example - -Each time you try to mark one of these entries DONE using @kbd{C-c C-t}, -they will automatically switch back to the state TODO, and the -deadline/scheduling will be shifted accordingly. The time units -recognized by org-mode are year (y), month (m), week (w), and day (d). -Org-mode will also prompt you for a note and record the fact that you -have closed this item in a note under the headline. - -One unusual property of these repeating items is that only one instance -of each exist at any given time. So if you look back or ahead in the -agenda, you will not find past and future instances, only the current -one will show up. Use a cyclic diary entry if you need all past and -future instances to be visible in the agenda. - -@node Progress logging, , Repeating items, Timestamps +@end table + +@menu +* Inserting deadline/schedule:: +* Repeated tasks:: +@end menu + +@node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling +@subsection Inserting deadline/schedule + +The following commands allow to quickly insert a deadline or to schedule +an item: + +@table @kbd +@c +@kindex C-c C-d +@item C-c C-d +Insert @samp{DEADLINE} keyword along with a stamp. The insertion will +happen in the line directly following the headline. +@c FIXME Any CLOSED timestamp will be removed.???????? +@c +@kindex C-c C-w +@cindex sparse tree, for deadlines +@item C-c C-w +Create a sparse tree with all deadlines that are either past-due, or +which will become due within @code{org-deadline-warning-days}. +With @kbd{C-u} prefix, show all deadlines in the file. With a numeric +prefix, check that many days. For example, @kbd{C-1 C-c C-w} shows +all deadlines due tomorrow. +@c +@kindex C-c C-s +@item C-c C-s +Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will +happen in the line directly following the headline. Any CLOSED +timestamp will be removed. +@end table + +@node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling +@subsection Repeated Tasks + +Some tasks need to be repeated again and again, and Org-mode therefore +allows to use a repeater in a DEADLINE or SCHEDULED time stamp, for +example: +@example +** TODO Pay the rent + DEADLINE: <2005-10-01 Sat +1m> +@end example + +Deadlines and scheduled items produce entries in the agenda when they +are over-due, so it is important to be able to mark such an entry as +completed once you have done so. When you mark a DEADLINE or a SCHEDULE +with the todo keyword DONE, it will no longer produce entries in the +agenda. The problem with this is, however, that then also the +@emph{next} instance of the repeated entry will not be active. Org-mode +deals with this in the following way: When you try to mark such an entry +DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating +time stamp by the repeater interval, and immediately set the entry state +back to TODO. In the example above, setting the state to DONE would +actually switch the date like this: + +@example +** TODO Pay the rent + DEADLINE: <2005-11-01 Tue +1m> +@end example + +You will also be prompted for a note that will be put under the DEADLINE +line to keep a record that you actually acted on the previous instance +of this deadline. + +As a consequence of shifting the base date, this entry will no longer be +visible in the agenda when checking past dates, but all future instances +will be visible. + +You may have both scheduling and deadline information for a specific +task - just make sure that the repeater intervals on both are the same. + +@node Progress logging, , Deadlines and scheduling, Timestamps @section Progress Logging @cindex progress logging @cindex logging, of progress @@ -3199,6 +3416,7 @@ #+STARTUP: lognotestate @end example + @node Clocking work time, , Tracking TODO state changes, Progress logging @subsection Clocking work time @@ -3743,6 +3961,23 @@ calendars, respectively. @kbd{c} can be used to switch back and forth between calendar and agenda. +If you are using the diary only for sexp entries and holidays, it is +faster to not use the above setting, but instead to copy or even move +the entries into an Org-mode file. Org-mode evaluates diary-style sexp +entries, and does it faster because there is no overhead for first +creating the diary display. Note that the sexp entries must start at +the left margin, no white space is allowed before them. For example, +the following segment of an Org-mode file will be processed and entries +will be made in the agenda: + +@example +* Birthdays and similar stuff +#+CATEGORY: Holiday +%%(org-calendar-holiday) ; special function for holiday names +#+CATEGORY: Ann +%%(diary-anniversary 14 5 1956) Artur Dent %d is years old +%%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old +@end example @node Global TODO list, Matching headline tags, Weekly/Daily agenda, Built-in agenda views @subsection The global TODO list @@ -3762,10 +3997,12 @@ @kindex C-c a T @item C-c a T @cindex TODO keyword matching -Like the above, but allows selection of a specific TODO keyword. You can -also do this by specifying a prefix argument to @kbd{C-c a t}. With a -@kbd{C-u} prefix you are prompted for a keyword. With a numeric -prefix, the Nth keyword in @code{org-todo-keywords} is selected. +Like the above, but allows selection of a specific TODO keyword. You +can also do this by specifying a prefix argument to @kbd{C-c a t}. With +a @kbd{C-u} prefix you are prompted for a keyword, and you may also +specify several keywords by separating them with @samp{|} as boolean OR +operator. With a numeric prefix, the Nth keyword in +@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, @@ -3875,16 +4112,18 @@ projects with a tag PROJECT, and that you use a todo keyword MAYBE to indicate a project that should not be considered yet. Lets further assume that the todo keyword DONE marks finished projects, and that NEXT -and TODO indicate next actions. Finally, the tag @@SHOP indicates -shopping and is a next action even without the NEXT tag. In this case -you would start by identifying eligible projects with a tags/todo match -@samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT and @@SHOP in -the subtree to identify projects that are not stuck. The correct -customization for this is +and TODO indicate next actions. The tag @@SHOP indicates shopping and +is a next action even without the NEXT tag. Finally, if the project +contains the special word IGNORE anywhere, it should not be listed +either. In this case you would start by identifying eligible projects +with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for +TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that +are not stuck. The correct customization for this is @lisp (setq org-stuck-projects - ("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP"))) + '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP") + "\\<IGNORE\\>")) @end lisp @@ -4031,11 +4270,11 @@ @item mouse-3 @itemx @key{SPC} Display the original location of the item in another window. - +@c @kindex L @item L Display original location and recenter that window. - +@c @kindex mouse-2 @kindex mouse-1 @kindex @key{TAB} @@ -4044,11 +4283,11 @@ @itemx @key{TAB} Go to the original location of the item in another window. Under Emacs 22, @kbd{mouse-1} will also works for this. - +@c @kindex @key{RET} @itemx @key{RET} Go to the original location of the item and delete other windows. - +@c @kindex f @item f Toggle Follow mode. In Follow mode, as you move the cursor through @@ -4056,14 +4295,14 @@ location in the org file. The initial setting for this mode in new agenda buffers can be set with the variable @code{org-agenda-start-with-follow-mode}. - +@c @kindex b @item b Display the entire subtree of the current item in an indirect buffer. With numerical prefix ARG, go up to this level and then take that tree. If ARG is negative, go up that many levels. With @kbd{C-u} prefix, do not remove the previously used indirect buffer. - +@c @kindex l @item l Toggle Logbook mode. In Logbook mode, entries that where marked DONE while @@ -4075,24 +4314,24 @@ @kindex o @item o Delete other windows. - +@c @kindex w @item w Switch to weekly view (7 days displayed together). - +@c @kindex d @item d Switch to daily view (just one day displayed). - +@c @kindex D @item D Toggle the inclusion of diary entries. See @ref{Weekly/Daily agenda}. - +@c @kindex g @item g 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 Recreate the agenda buffer, for example to reflect the changes @@ -4100,21 +4339,21 @@ 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. - +@c @kindex s @item s Save all Org-mode buffers in the current Emacs session. - +@c @kindex @key{right} @item @key{right} Display the following @code{org-agenda-ndays} days. For example, if the display covers a week, switch to the following week. With prefix arg, go forward that many times @code{org-agenda-ndays} days. - +@c @kindex @key{left} @item @key{left} Display the previous dates. - +@c @kindex . @item . Goto today. @@ -4124,53 +4363,53 @@ @item 0-9 Digit argument. - +@c @cindex undoing remote-editing events @cindex remote editing, undo @kindex C-_ @item C-_ Undo a change due to a remote editing command. The change is undone both in the agenda buffer and in the remote buffer. - +@c @kindex t @item t Change the TODO state of the item, both in the agenda and in the original org file. - +@c @kindex C-k @item C-k Delete the current agenda item along with the entire subtree belonging to it in the original Org-mode file. If the text to be deleted remotely is longer than one line, the kill needs to be confirmed by the user. See variable @code{org-agenda-confirm-kill}. - +@c @kindex $ @item $ Archive the subtree corresponding to the current headline. - +@c @kindex T @item T Show all tags associated with the current item. Because of inheritance, this may be more than the tags listed in the line itself. - +@c @kindex : @item : Set tags for the current headline. - +@c @kindex a @item a Toggle the ARCHIVE tag for the current headline. - +@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. - +@c @kindex P @item P Display weighted priority of current item. - +@c @kindex + @kindex S-@key{up} @item + @@ -4178,21 +4417,21 @@ Increase the priority of the current item. The priority is changed in the original buffer, but the agenda is not resorted. Use the @kbd{r} key for this. - +@c @kindex - @kindex S-@key{down} @item - @itemx S-@key{down} Decrease the priority of the current item. - +@c @kindex C-c C-s @item C-c C-s Schedule this item - +@c @kindex C-c C-d @item C-c C-d Set a deadline for this item. - +@c @kindex S-@key{right} @item S-@key{right} Change the time stamp associated with the current line by one day into @@ -4201,25 +4440,27 @@ stamp is changed in the original org file, but the change is not directly reflected in the agenda buffer. Use the @kbd{r} key to update the buffer. - +@c @kindex S-@key{left} @item S-@key{left} Change the time stamp associated with the current line by one day into the past. - +@c @kindex > @item > Change the time stamp associated with the current line to today. The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} on my keyboard. - +@c @kindex I @item I Start the clock on the current item. If a clock is running already, it is stopped first. +@c @kindex O @item O Stop the previously started clock. +@c @kindex X @item X Cancel the currently running clock. @@ -4229,11 +4470,11 @@ @kindex c @item c Open the Emacs calendar and move to the date at the agenda cursor. - +@c @item c When in the calendar, compute and show the Org-mode agenda for the date at the cursor. - +@c @cindex diary entries, creating from agenda @kindex i @item i @@ -4241,42 +4482,53 @@ (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new entry in the diary, just as @kbd{i d} etc. would do in the calendar. The date is taken from the cursor position. - +@c @kindex M @item M Show the phases of the moon for the three months around current date. - +@c @kindex S @item S Show sunrise and sunset times. The geographical location must be set with calendar variables, see documentation of the Emacs calendar. - +@c @kindex C @item C Convert the date at cursor into many other cultural and historic calendars. - +@c @kindex H @item H Show holidays for three month around the cursor date. - +@c @c FIXME: This should be a different key. @kindex C-c C-x C-c @item C-c C-x C-c Export a single iCalendar file containing entries from all agenda files. +@tsubheading{Exporting to a file} +@kindex C-x C-w +@item C-x C-w +@cindex exporting agenda views +@cindex agenda views, exporting +Write the agenda view to a file. Depending on the extension of the +selected file name, the view will be exported as HTML (extension +@file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or +plain text (any other extension). Use the variable +@code{org-agenda-exporter-settings} to set options for @file{ps-print} +and for @file{htmlize} to be used during export. + @tsubheading{Quit and Exit} @kindex q @item q Quit agenda, remove the agenda buffer. - +@c @kindex x @cindex agenda files, removing buffers @item x Exit agenda, remove the agenda buffer and all buffers loaded by Emacs for the compilation of the agenda. Buffers created by the user to visit org files will not be removed. - @end table @@ -4294,7 +4546,8 @@ * Storing searches:: Type once, use often * Block agenda:: All the stuff you need in a single buffer * Setting Options:: Changing the rules -* Batch processing:: Agenda views from the command line +* Exporting Agenda Views:: Writing agendas to files. +* Extracting Agenda Information for other programs:: @end menu @node Storing searches, Block agenda, Custom agenda views, Custom agenda views @@ -4386,7 +4639,7 @@ command @kbd{C-c a o} provides a similar view for office tasks. -@node Setting Options, Batch processing, Block agenda, Custom agenda views +@node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views @subsection Setting Options for custom commands @cindex options, for custom agenda views @@ -4434,7 +4687,8 @@ '(("h" "Agenda and Home-related tasks" ((agenda) (tags-todo "HOME") - (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up))))) + (tags "GARDEN" + ((org-agenda-sorting-strategy '(priority-up))))) ((org-agenda-sorting-strategy '(priority-down)))) ("o" "Agenda and Office-related tasks" ((agenda) @@ -4450,36 +4704,234 @@ value is a string, you need to add the double quotes around the value yourself. -@node Batch processing, , Setting Options, Custom agenda views -@subsection Creating agenda views in batch processing -@cindex agenda, batch production - -If you want to print or otherwise reprocess agenda views, it can be -useful to create an agenda from the command line. This is the purpose -of the function @code{org-batch-agenda}. It takes as a parameter one of -the strings that are the keys in @code{org-agenda-custom-commands}. For -example, to directly print the current TODO list, you could use + +@node Exporting Agenda Views, Extracting Agenda Information for other programs, Setting Options, Custom agenda views +@subsection Exporting Agenda Views +@cindex agenda views, exporting + +If you are away from your computer, it can be very useful to have a +printed version of some agenda views to carry around. Org-mode can +export custom agenda views as plain text, HTML@footnote{You need to +install Hrvoje Niksic' @file{htmlize.el}.} and postscript. If you want +to do this only occasionally, use the commend + +@table @kbd +@kindex C-x C-w +@item C-x C-w +@cindex exporting agenda views +@cindex agenda views, exporting +Write the agenda view to a file. Depending on the extension of the +selected file name, the view will be exported as HTML (extension +@file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or +plain text (any other extension). Use the variable +@code{org-agenda-exporter-settings} to set options for @file{ps-print} +and for @file{htmlize} to be used during export, for example +@lisp +(setq org-agenda-exporter-settings + '((ps-number-of-columns 2) + (ps-landscape-mode t) + (htmlize-output-type 'css))) +@end lisp +@end table + +If you need to export certain agenda views frequently, you can associate +any custom agenda command with a list of output file names +@footnote{If you want to store standard views like the weekly agenda +or the global TODO list as well, you need to define custom commands for +them in order to be able to specify filenames.}. Here is an example +that first does define custom commands for the agenda and the global +todo list, together with a number of files to which to export them. +Then we define two block agenda commands and specify filenames for them +as well. File names can be relative to the current working directory, +or absolute. + +@lisp +@group +(setq org-agenda-custom-commands + '(("X" agenda "" nil ("agenda.html" "agenda.ps")) + ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps")) + ("h" "Agenda and Home-related tasks" + ((agenda) + (tags-todo "HOME") + (tags "GARDEN")) + nil + ("~/views/home.html")) + ("o" "Agenda and Office-related tasks" + ((agenda) + (tags-todo "WORK") + (tags "OFFICE")) + nil + ("~/views/office.ps")))) +@end group +@end lisp + +The extension of the file name determines the type of export. If it is +@file{.html}, Org-mode will use the @file{htmlize.el} package to convert +the buffer to HTML and save it to this file name. If the extension is +@file{.ps}, @code{ps-print-buffer-with-faces} is used to produce +postscript output. Any other extension produces a plain ASCII file. + +The export files are @emph{not} created when you use one of those +commands interactively. 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 +Export all agenda views that have export filenames associated with +them. +@end table + +You can use the options section of the custom agenda commands to also +set options for the export commands. For example: + +@lisp +(setq org-agenda-custom-commands + '(("X" agenda "" + ((ps-number-of-columns 2) + (ps-landscape-mode t) + (org-agenda-prefix-format " [ ] ") + (org-agenda-with-colors nil) + (org-agenda-remove-tags t)) + ("theagenda.ps")))) +@end lisp + +@noindent +This command sets two options for the postscript exporter, to make it +print in two columns in landscape format - the resulting page can be cut +in two and then used in a paper agenda. The remaining settings modify +the agenda prefix to omit category and scheduling information, and +instead include a checkbox to check off items. We also remove the tags +to make the lines compact, and we don't want to use colors for the +black-and-white printer. Settings specified in +@code{org-agenda-exporter-settings} will also apply, but the settings +in @code{org-agenda-custom-commands} take precedence. + +@noindent +From the command line you may also use +@example +emacs -f org-batch-store-agenda-views -kill +@end example +@noindent +or, if you need to modify some parameters +@example +emacs -eval '(org-batch-store-agenda-views \ + org-agenda-ndays 30 \ + org-agenda-include-diary nil \ + org-agenda-files (quote ("~/org/project.org")))' \ + -kill +@end example +@noindent +which will create the agenda views restricted to the file +@file{~/org/project.org}, without diary entries and with 30 days +extent. + +@node Extracting Agenda Information for other programs, , Exporting Agenda Views, Custom agenda views +@subsection Extracting Agenda Information for other programs +@cindex agenda, pipe +@cindex Scripts, for agenda processing + +Org-mode provides commands to access agenda information for the command +line in emacs batch mode. This extracted information can be sent +directly to a printer, or it can be read by a program that does further +processing of the data. The first of these commands is the function +@code{org-batch-agenda}, that produces an agenda view and sends it as +ASCII text to STDOUT. The command takes a single string as parameter. +If the string has length 1, it is used as a key to one of the commands +you have configured in @code{org-agenda-custom-commands}, basically any +key you can use after @kbd{C-c a}. For example, to directly print the +current TODO list, you could use @example emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr @end example +If the parameter is a string with 2 or more characters, it is used as a +tags/todo match string. For example, to print your local shopping list +(all items with the tag @samp{shop}, but excluding the tag +@samp{NewYork}), you could use + +@example +emacs -batch -l ~/.emacs \ + -eval '(org-batch-agenda "+shop-NewYork")' | lpr +@end example + @noindent You may also modify parameters on the fly like this: @example emacs -batch -l ~/.emacs \ -eval '(org-batch-agenda "a" \ - org-agenda-ndays 300 \ + org-agenda-ndays 30 \ org-agenda-include-diary nil \ org-agenda-files (quote ("~/org/project.org")))' \ | lpr @end example @noindent -which will produce a 300 day agenda, fully restricted to the Org file +which will produce a 30 day agenda, fully restricted to the Org file @file{~/org/projects.org}, not even including the diary. +If you want to process the agenda data in more sophisticated ways, you +can use the command @code{org-batch-agenda-csv} to get a comma-separated +list of values for each agenda item. Each line in the output will +contain a number of fields separated by commas. The fields in a line +are: + +@example +category @r{The category of the item} +head @r{The headline, without TODO kwd, TAGS and PRIORITY} +type @r{The type of the agenda entry, can be} + todo @r{selected in TODO match} + tagsmatch @r{selected in tags match} + diary @r{imported from diary} + deadline @r{a deadline} + scheduled @r{scheduled} + timestamp @r{appointment, selected by timestamp} + closed @r{entry was closed on date} + upcoming-deadline @r{warning about nearing deadline} + past-scheduled @r{forwarded scheduled item} + block @r{entry has date block including date} +todo @r{The todo keyword, if any} +tags @r{All tags including inherited ones, separated by colons} +date @r{The relevant date, like 2007-2-14} +time @r{The time, like 15:00-16:50} +extra @r{String with extra planning info} +priority-l @r{The priority letter if any was given} +priority-n @r{The computed numerical priority} +@end example + +@noindent +Time and date will only be given if a timestamp (or deadline/scheduled) +lead to the selection of the item. + +A CSV list like this is very easy to use in a post processing script. +For example, here is a Perl program that gets the TODO list from +Emacs/org-mode and prints all the items, preceded by a checkbox: + +@example +@group +#!/usr/bin/perl + +# define the Emacs command to run +$cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; + +# run it and capture the output +$agenda = qx@{$cmd 2>/dev/null@}; + +# loop over all lines +foreach $line (split(/\n/,$agenda)) @{ + + # get the individual values + ($category,$head,$type,$todo,$tags,$date,$time,$extra, + $priority_l,$priority_n) = split(/,/,$line); + + # proccess and print + print "[ ] $head\n"; +@} +@end group +@end example + @node Embedded LaTeX, Exporting, Agenda views, Top @chapter Embedded LaTeX @cindex @TeX{} interpretation @@ -4566,7 +5018,9 @@ all fragments will be converted to images and inlined into the HTML document. For this to work you need to be on a system with a working La@TeX{} installation. You also need the @file{dvipng} program, -available at @url{http://sourceforge.net/projects/dvipng/}. +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}. La@TeX{} fragments don't need any special marking at all. The following snippets will be identified as LaTeX source code: @@ -4773,7 +5227,7 @@ language, but with additional support for tables. @menu -* Export commands:: How to invode HTML export +* Export commands:: How to invoke HTML export * Quoting HTML tags:: Using direct HTML in Org-mode * Links:: How hyperlinks get transferred to HTML * Images:: To inline or not to inline? @@ -4793,11 +5247,27 @@ @kindex C-c C-e b @item C-c C-e b Export as HTML file and 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 H +Export the active region to a temporary buffer. With prefix arg, do not +produce file header and foot, but just the plain HTML section for the +region. This is good for cut-and-paste operations. @kindex C-c C-e v h @kindex C-c C-e v b +@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 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 +syntax before. This is a global command that can be invoked in any +buffer. @end table @cindex headline levels, for exporting @@ -4975,19 +5445,20 @@ @menu * Comment lines:: Some lines will not be exported +* Initial text:: Text before the first headline +* Footnotes:: Numbers like [1] * Enhancing text:: Subscripts, symbols and more * Export options:: How to influence the export settings @end menu -@node Comment lines, Enhancing text, Text interpretation, Text interpretation +@node Comment lines, Initial text, Text interpretation, Text interpretation @subsection Comment lines @cindex comment lines @cindex exporting, not Lines starting with @samp{#} in column zero are treated as comments and will never be exported. Also entire subtrees starting with the -word @samp{COMMENT} will never be exported. Finally, any text before -the first headline will not be exported either. +word @samp{COMMENT} will never be exported. @table @kbd @kindex C-c ; @@ -4995,7 +5466,70 @@ Toggle the COMMENT keyword at the beginning of an entry. @end table -@node Enhancing text, Export options, Comment lines, Text interpretation +@node Initial text, Footnotes, Comment lines, Text interpretation +@subsection Text before the first headline + +Org-mode normally ignores any text before the first headline when +exporting, leaving this region for internal links to speed up navigation +etc. However, in publishing-oriented files, you might want to have some +text before the first headline, like a small introduction, special HTML +code with a navigation bar, etc. You can ask to have this part of the +file exported as well by setting the variable +@code{org-export-skip-text-before-1st-heading} to @code{nil}. On a +per-file basis, you can get the same effect with + +@example +#+OPTIONS: skip:nil +@end example + +The text before the first headline will be fully processed +(@pxref{Enhancing text}), and the first non-comment line becomes the +title of the exported document. If you need to include literal HTML, +use the special constructs described in @ref{Quoting HTML tags}. The +table of contents is normally inserted directly before the first +headline of the file. If you would like to get it to a different +location, insert the string @code{[TABLE-OF-CONTENTS]} on a line by +itself at the desired location. + +Finally, if you want to use the space before the first headline for +internal purposes, but @emph{still} want to place something before the +first headline when exporting the file, you can use the @code{#+TEXT} +construct: + +@example +#+OPTIONS: skip:t +#+TEXT: This text will go before the *first* headline. +#+TEXT: We place the table of contents here: +#+TEXT: [TABLE-OF-CONTENTS] +#+TEXT: This goes between the table of contents and the first headline +@end example + +@node Footnotes, Enhancing text, Initial text, Text interpretation +@subsection Footnotes +@cindex footnotes +@cindex @file{footnote.el} + +Numbers in square brackets are treated as footnotes, so that you can use +the Emacs package @file{footnote.el} to create footnotes. For example: + +@example +The org-mode homepage[1] clearly needs help from +a good web designer. + +[1] The link is: http://www.astro.uva.nl/~dominik/Tools/org +@end example + +@noindent +@kindex C-c ! +Note that the @file{footnote} package uses @kbd{C-c !} to invoke its +commands. This binding conflicts with the org-mode command for +inserting inactive time stamps. You could use the variable +@code{footnote-prefix} to switch footnotes commands to another key. Or, +if you are too used to this binding, you could use +@code{org-replace-disputed-keys} and @code{org-disputed-keys} to change +the settings in Org-mode. + +@node Enhancing text, Export options, Footnotes, Text interpretation @subsection Enhancing text for export @cindex enhancing text @cindex richer text @@ -5019,7 +5553,9 @@ @cindex italic text @item You can make words @b{*bold*}, @i{/italic/}, _underlined_, -@code{=code=}, and @samp{+strikethrough+}. +@code{=code=}, and even @samp{+strikethrough+}@footnote{but remember +that strikethrough is typographically evil and should @i{never} be +used.}. @cindex horizontal rules, in exported files @item @@ -5057,7 +5593,7 @@ @end itemize If these conversions conflict with your habits of typing ASCII text, -they can all be turned off with corresponding variables (see the +they can all be turned off with corresponding variables. See the customization group @code{org-export-general}, and the following section which explains how to set export options with special lines in a buffer. @@ -5088,7 +5624,7 @@ #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language}) #+TEXT: Some descriptive text to be inserted at the beginning. #+TEXT: Several lines may be given. -#+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t *:nil TeX:t LaTeX:t +#+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t *:nil TeX:t LaTeX:t skip:t @end example @noindent @@ -5113,10 +5649,13 @@ @@: @r{turn on/off quoted HTML tags} :: @r{turn on/off fixed-width sections} |: @r{turn on/off tables} -^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts.} +^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If} + @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but} + @r{the simple @code{a_b} will be left as it is.} *: @r{turn on/off emphasized text (bold, italic, underlined)} TeX: @r{turn on/off simple @TeX{} macros in plain text} LaTeX: @r{turn on/off La@TeX{} fragments} +skip: @r{turn on/off skipping the text before the first heading} @end example @node Publishing, Miscellaneous, Exporting, Top @@ -5444,13 +5983,13 @@ following functions: @table @kbd -@item C-c C-e c +@item C-c C-e C Prompt for a specific project and publish all files that belong to it. -@item C-c C-e p +@item C-c C-e P Publish the project containing the current file. -@item C-c C-e f +@item C-c C-e F Publish only the current file. -@item C-c C-e a +@item C-c C-e A Publish all projects. @end table @@ -5584,11 +6123,15 @@ @cindex @code{lognotedone}, STARTUP keyword @cindex @code{lognoteclock-out}, STARTUP keyword @cindex @code{lognotestate}, STARTUP keyword +@cindex @code{logrepeat}, STARTUP keyword +@cindex @code{nologrepeat}, STARTUP keyword @example logging @r{record a timestamp when an item is marked DONE} nologging @r{don't record when items are marked DONE} lognotedone @r{record timestamp and a note when DONE} lognotestate @r{record timestamp, note when TODO state changes} +logrepeat @r{record a not when re-instating a repeating item} +nologrepeat @r{do not record when re-instating repeating item} lognoteclock-out @r{record timestamp and a note when clocking out} @end example Here are the options for hiding leading stars in outline headings. The @@ -5612,6 +6155,14 @@ @example customtime @r{overlay custom time format} @end example +The following options influence the table spreadsheet (variable +@code{constants-unit-system}). +@cindex @code{constcgs}, STARTUP keyword +@cindex @code{constSI}, STARTUP keyword +@example +constcgs @r{@file{constants.el} should use the c-g-s unit system} +constSI @r{@file{constants.el} should use the SI unit system} +@end example @item #+SEQ_TODO: #+TYP_TODO: These lines set the TODO keywords and their interpretation in the current file. The corresponding variables are @code{org-todo-keywords} @@ -5633,6 +6184,10 @@ all subsequent lines until the next @samp{#+CATEGORY} line, or the end of the file. The first such line also applies to any entries before it. The corresponding variable is @code{org-archive-location}. +@item #+PRIORITIES: highest lowest default +This line sets the limits and the default for the priorities. All three +must be either letters A-Z or numbers 0-9. The highest priority must +have a lower ASCII number that the lowest priority. @item #+TBLFM: This line contains the formulas for the table directly above the line. @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS: @@ -5816,10 +6371,12 @@ @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}} @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab -@item @kbd{S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab -@item @kbd{S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab -@item @kbd{S-@key{up}} @tab @kbd{C-c C-x @key{up}} @tab -@item @kbd{S-@key{down}} @tab @kbd{C-c C-x @key{down}} @tab +@item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab +@item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab +@item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab +@item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab +@item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab +@item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @end multitable @node Interaction, Bugs, TTY keys, Miscellaneous @@ -5887,7 +6444,7 @@ @item C-c C-c Recognize @file{table.el} table. Works when the cursor is in a table.el table. - +@c @kindex C-c ~ @item C-c ~ Insert a table.el table. If there is already a table at point, this @@ -5897,6 +6454,10 @@ possible. @end table @file{table.el} is part of Emacs 22. +@cindex @file{footnote.el} +@item @file{footnote.el} by Steven L. Baur +Org-mode recognizes numerical footnotes as provided by this package +(@pxref{Footnotes}). @end table @node Conflicts, , Cooperation, Interaction @@ -5927,7 +6488,6 @@ @example S-UP -> M-p S-DOWN -> M-n S-LEFT -> M-- S-RIGHT -> M-+ -S-RET -> C-S-RET @end example Yes, these are unfortunately more difficult to remember. If you want @@ -5937,6 +6497,16 @@ @cindex @file{windmove.el} Also this package uses the @kbd{S-<cursor>} keys, so everything written in the paragraph above about CUA mode also applies here. + +@cindex @file{footnote.el} +@item @file{footnote.el} by Steven L. Baur +Org-mode supports the syntax of the footnote package, but only the +numerical footnote markers. Also, the default key for footnote +commands, @kbd{C-c !} is already used by org-mode. You could use the +variable @code{footnote-prefix} to switch footnotes commands to another +key. Or, you could use @code{org-replace-disputed-keys} and +@code{org-disputed-keys} to change the settings in Org-mode. + @end table @@ -6417,7 +6987,7 @@ @end lisp -@node History and Acknowledgments, GNU Free Documentation License, Extensions and Hacking, Top +@node History and Acknowledgments, Index, Extensions and Hacking, Top @appendix History and Acknowledgments @cindex acknowledgments @cindex history @@ -6478,6 +7048,9 @@ @i{Christian Egli} converted the documentation into TeXInfo format, patched CSS formatting into the HTML exporter, and inspired the agenda. @item +@i{David Emery} provided a patch for custom CSS support in exported +HTML agendas. +@item @i{Nic Ferrier} contributed mailcap and XOXO support. @item @i{John Foerch} figured out how to make incremental search show context @@ -6490,13 +7063,19 @@ @item @i{Kai Grossjohann} pointed out key-binding conflicts with other packages. @item -@i{Shidai Liu} (``Leo'') provided extensive feedback and some patches. +@i{Shidai Liu} ("Leo") asked for embedded LaTeX and tested it. He also +provided frequent feedback and some patches. @item -@i{Leon Liu} asked for embedded LaTeX and tested it. +@i{Jason F. McBrayer} suggested agenda export to CSV format. +@item +@i{Dmitri Minaev} sent a patch to set priority limits on a per-file +basis. @item @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler happy. @item +@i{Rick Moynihan} proposed to allow multiple TODO sequences in a file. +@item @i{Todd Neal} provided patches for links to Info files and elisp forms. @item @i{Tim O'Callaghan} suggested in-file links, search options for general @@ -6568,12 +7147,8 @@ and contributed various ideas and code snippets. @end itemize -@node GNU Free Documentation License, Index, History and Acknowledgments, Top -@appendix GNU Free Documentation License -@include doclicense.texi - - -@node Index, Key Index, GNU Free Documentation License, Top + +@node Index, Key Index, History and Acknowledgments, Top @unnumbered Index @printindex cp