Mercurial > emacs
changeset 94409:e0901c47caf2
Massive changes in all parts of the documentation.
| author | Carsten Dominik <dominik@science.uva.nl> |
|---|---|
| date | Sun, 27 Apr 2008 18:18:27 +0000 |
| parents | e7b16891fcb0 |
| children | 850fe8049c1a |
| files | doc/misc/org.texi |
| diffstat | 1 files changed, 1175 insertions(+), 887 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/misc/org.texi Sun Apr 27 18:17:59 2008 +0000 +++ b/doc/misc/org.texi Sun Apr 27 18:18:27 2008 +0000 @@ -1,10 +1,10 @@ \input texinfo @c %**start of header @setfilename ../../info/org -@settitle Org Mode Manual - -@set VERSION 5.23 -@set DATE March 2008 +@settitle The Org Manual + +@set VERSION 6.02b +@set DATE April 2008 @dircategory Emacs @direntry @@ -33,7 +33,7 @@ @end macro @copying -This manual is for Org-mode (version @value{VERSION}). +This manual is for Org (version @value{VERSION}). Copyright @copyright{} 2004, 2005, 2006, 2007, 2008 Free Software Foundation @@ -53,7 +53,7 @@ @end copying @titlepage -@title Org Mode Manual +@title The Org Manual @subtitle Release @value{VERSION} @author by Carsten Dominik @@ -76,22 +76,22 @@ @menu * Introduction:: Getting started -* Document structure:: A tree works like your brain +* Document Structure:: A tree works like your brain * Tables:: Pure magic for quick formatting * Hyperlinks:: Notes in context -* TODO items:: Every tree branch can be a TODO item +* TODO Items:: Every tree branch can be a TODO item * Tags:: Tagging headlines and matching sets of tags -* Properties and columns:: Storing information about an entry -* Dates and times:: Making items useful for planning +* Properties and Columns:: Storing information about an entry +* Dates and Times:: Making items useful for planning * Remember:: Quickly adding nodes to the outline tree -* Agenda views:: Collecting information into views +* Agenda Views:: Collecting information into views * Embedded LaTeX:: LaTeX fragments and formulas * Exporting:: Sharing and publishing of notes -* Publishing:: Create a web site of linked Org-mode files +* Publishing:: Create a web site of linked Org files * 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 -* Main Index:: +* History and Acknowledgments:: How Org came into being +* Main Index:: An index of Org's concepts and features * Key Index:: Key bindings and where they are described @detailmenu @@ -99,16 +99,16 @@ Introduction -* Summary:: Brief summary of what Org-mode does -* Installation:: How to install a downloaded version of Org-mode -* Activation:: How to activate Org-mode for certain buffers. +* Summary:: Brief summary of what Org does +* Installation:: How to install a downloaded version of Org +* Activation:: How to activate Org for certain buffers * Feedback:: Bug reports, ideas, patches etc. * Conventions:: Type-setting conventions in the manual Document Structure -* Outlines:: Org-mode is based on outline-mode -* Headlines:: How to typeset org-tree headlines +* Outlines:: Org is based on Outline mode +* Headlines:: How to typeset Org tree headlines * Visibility cycling:: Show and hide, much simplified * Motion:: Jumping to other headlines * Structure editing:: Changing sequence and level of headlines @@ -116,7 +116,7 @@ * Sparse trees:: Matches embedded in context * Plain lists:: Additional structure within an entry * Drawers:: Tucking stuff away -* orgstruct-mode:: Structure editing outside Org-mode +* Orgstruct mode:: Structure editing outside Org Archiving @@ -128,8 +128,8 @@ * 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. +* Orgtbl mode:: The table editor as minor mode +* The spreadsheet:: The table editor has spreadsheet capabilities The spreadsheet @@ -144,20 +144,20 @@ Hyperlinks -* Link format:: How links in Org-mode are formatted +* Link format:: How links in Org are formatted * Internal links:: Links to other places in the current file * External links:: URL-like links to the world * Handling links:: Creating, inserting and following -* Using links outside Org-mode:: Linking from my C source code? +* Using links outside Org:: Linking from my C source code? * Link abbreviations:: Shortcuts for writing complex links * Search options:: Linking to a specific location * Custom searches:: When the default search is not enough Internal links -* Radio targets:: Make targets trigger links in plain text. - -TODO items +* Radio targets:: Make targets trigger links in plain text + +TODO Items * TODO basics:: Marking and displaying TODO entries * TODO extensions:: Workflow and assignments @@ -175,7 +175,7 @@ * Per-file keywords:: Different files, different requirements * Faces for TODO keywords:: Highlighting states -Progress Logging +Progress logging * Closing items:: When was this entry marked DONE? * Tracking TODO state changes:: When did the status change? @@ -189,43 +189,44 @@ Properties and Columns * Property syntax:: How properties are spelled out -* Special properties:: Access to other Org-mode features +* Special properties:: Access to other Org mode features * Property searches:: Matching property values * Property inheritance:: Passing values down the tree * Column view:: Tabular viewing and editing * Property API:: Properties for Lisp programmers -Column View +Column view * Defining columns:: The COLUMNS format property * Using column view:: How to create and use column view -* Capturing Column View:: A dynamic block for column view - -Defining Columns +* Capturing column view:: A dynamic block for column view + +Defining columns * Scope of column definitions:: Where defined, where valid? * Column attributes:: Appearance and content of a column Dates and Times -* Time stamps:: Assigning a time to a tree entry +* Timestamps:: Assigning a time to a tree entry * Creating timestamps:: Commands which insert timestamps * Deadlines and scheduling:: Planning your work -* Clocking work time:: +* Clocking work time:: Tracking how long you spend on a task +* Effort estimates:: Planning work effort in advance 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 +* The date/time prompt:: How Org mode helps you entering date and time +* Custom time format:: Making dates look different + +Deadlines and scheduling * Inserting deadline/schedule:: Planning items * Repeated tasks:: Items that show up again and again Remember -* Setting up remember:: Some code for .emacs to get things going +* Setting up Remember:: Some code for .emacs to get things going * Remember templates:: Define the outline of different note types * Storing notes:: Directly get the note to where it belongs * Refiling notes:: Moving a note or task to a project @@ -236,12 +237,13 @@ * Agenda dispatcher:: Keyboard access to agenda views * Built-in agenda views:: What is available out of the box? * Presentation and sorting:: How agenda items are prepared for display -* Agenda commands:: Remote editing of org trees +* Agenda commands:: Remote editing of Org trees * Custom agenda views:: Defining special searches and views +* Agenda column view:: Using column view for collected entries The built-in agenda views -* Weekly/Daily agenda:: The calendar page with current tasks +* Weekly/daily agenda:: The calendar page with current tasks * Global TODO list:: All unfinished action items * Matching tags and properties:: Structured information with fine-tuned search * Timeline:: Time-sorted view for single file @@ -259,13 +261,13 @@ * Storing searches:: Type once, use often * Block agenda:: All the stuff you need in a single buffer * Setting Options:: Changing the rules -* Exporting Agenda Views:: Writing agendas to files. -* Extracting Agenda Information for other programs:: +* Exporting Agenda Views:: Writing agendas to files +* Using the agenda elsewhere:: Using agenda information in other programs Embedded LaTeX * Math symbols:: TeX macros for symbols and Greek letters -* Subscripts and Superscripts:: Simple syntax for raising/lowering text +* Subscripts and superscripts:: Simple syntax for raising/lowering text * LaTeX fragments:: Complex formulas made easy * Processing LaTeX fragments:: Previewing LaTeX processing * CDLaTeX mode:: Speed up entering of formulas @@ -282,23 +284,24 @@ HTML export * HTML Export commands:: How to invoke LaTeX export -* Quoting HTML tags:: Using direct HTML in Org-mode +* Quoting HTML tags:: Using direct HTML in Org mode * Links:: Transformation of links for HTML * Images:: How to include images -* CSS support:: Changing the appearence of the output +* CSS support:: Changing the appearance of the output +* Javascript support:: Info and Folding in a web browser LaTeX export * LaTeX export commands:: How to invoke LaTeX export * Quoting LaTeX code:: Incorporating literal LaTeX code -* Sectioning structure:: +* Sectioning structure:: Changing sectioning in LaTeX output Text interpretation by the exporter * Comment lines:: Some lines will not be exported * Initial text:: Text before the first headline * Footnotes:: Numbers like [1] -* Quoted examples:: Inserting quoted chnuks of text +* Quoted examples:: Inserting quoted chunks of text * Enhancing text:: Subscripts, symbols and more * Export options:: How to influence the export settings @@ -326,46 +329,46 @@ Miscellaneous * Completion:: M-TAB knows what you need -* Customization:: Adapting Org-mode to your taste +* Customization:: Adapting Org to your taste * In-buffer settings:: Overview of the #+KEYWORDS * The very busy C-c C-c key:: When in doubt, press C-c C-c * Clean view:: Getting rid of leading stars in the outline -* TTY keys:: Using Org-mode on a tty +* TTY keys:: Using Org on a tty * Interaction:: Other Emacs packages * Bugs:: Things which do not work perfectly Interaction with other packages -* Cooperation:: Packages Org-mode cooperates with +* Cooperation:: Packages Org cooperates with * Conflicts:: Packages that lead to conflicts Extensions, Hooks and Hacking -* Extensions:: Existing 3rd-part extensions +* Extensions:: Existing 3rd-party extensions * Adding hyperlink types:: New custom link types * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs * Dynamic blocks:: Automatically filled blocks * Special agenda views:: Customized views * Using the property API:: Writing programs that use entry properties -Tables and Lists in arbitrary syntax +Tables and lists in arbitrary syntax * Radio tables:: Sending and receiving * A LaTeX example:: Step by step, almost a tutorial * Translator functions:: Copy and modify -* Radio lists:: Doing the same for lists. +* Radio lists:: Doing the same for lists @end detailmenu @end menu -@node Introduction, Document structure, Top, Top +@node Introduction, Document Structure, Top, Top @chapter Introduction @cindex introduction @menu -* Summary:: Brief summary of what Org-mode does -* Installation:: How to install a downloaded version of Org-mode -* Activation:: How to activate Org-mode for certain buffers. +* Summary:: Brief summary of what Org does +* Installation:: How to install a downloaded version of Org +* Activation:: How to activate Org for certain buffers * Feedback:: Bug reports, ideas, patches etc. * Conventions:: Type-setting conventions in the manual @end menu @@ -374,37 +377,37 @@ @section Summary @cindex summary -Org-mode is a mode for keeping notes, maintaining TODO lists, and doing +Org is a mode for keeping notes, maintaining TODO lists, and doing project planning with a fast and effective plain-text system. -Org-mode develops organizational tasks around NOTES files that contain -lists or information about projects as plain text. Org-mode is -implemented on top of outline-mode, which makes it possible to keep the +Org develops organizational tasks around NOTES files that contain +lists or information about projects as plain text. Org is +implemented on top of Outline mode, which makes it possible to keep the content of large files well structured. Visibility cycling and structure editing help to work with the tree. Tables are easily created -with a built-in table editor. Org-mode supports TODO items, deadlines, +with a built-in table editor. Org supports TODO items, deadlines, time stamps, and scheduling. It dynamically compiles entries into an agenda that utilizes and smoothly integrates much of the Emacs calendar and diary. Plain text URL-like links connect to websites, emails, Usenet messages, BBDB entries, and any files related to the projects. -For printing and sharing of notes, an Org-mode file can be exported as a +For printing and sharing of notes, an Org file can be exported as a structured ASCII file, as HTML, or (TODO and agenda items only) as an iCalendar file. It can also serve as a publishing tool for a set of -linked webpages. - -An important design aspect that distinguishes Org-mode from for example +linked web pages. + +An important design aspect that distinguishes Org from for example Planner/Muse is that it encourages to store every piece of information only once. In Planner, you have project pages, day pages and possibly -other files, duplicating some information such as tasks. In Org-mode, +other files, duplicating some information such as tasks. In Org, you only have notes files. In your notes you mark entries as tasks, label them with tags and timestamps. All necessary lists like a schedule for the day, the agenda for a meeting, tasks lists selected by tags etc are created dynamically when you need them. -Org-mode keeps simple things simple. When first fired up, it should +Org keeps simple things simple. When first fired up, it should feel like a straightforward, easy to use outliner. Complexity is not imposed, but a large amount of functionality is available when you need -it. Org-mode is a toolbox and can be used in different ways, for +it. Org is a toolbox and can be used in different ways, for example as: @example @@ -419,16 +422,16 @@ @r{@bullet{} publishing tool to create a set of interlinked webpages} @end example -Org-mode's automatic, context sensitive table editor with spreadsheet +Org's automatic, context sensitive table editor with spreadsheet capabilities can be integrated into any major mode by activating the -minor Orgtbl-mode. Using a translation step, it can be used to maintain +minor Orgtbl mode. Using a translation step, it can be used to maintain tables in arbitrary file types, for example in La@TeX{}. The structure -editing and list creation capabilities can be used outside Org-mode with -the minor Orgstruct-mode. +editing and list creation capabilities can be used outside Org with +the minor Orgstruct mode. @cindex FAQ -There is a website for Org-mode which provides links to the newest -version of Org-mode, as well as additional information, frequently asked +There is a website for Org which provides links to the newest +version of Org, as well as additional information, frequently asked questions (FAQ), links to tutorials etc. This page is located at @uref{http://orgmode.org}. @@ -440,59 +443,68 @@ @cindex installation @cindex XEmacs -@b{Important:} @i{If Org-mode is part of the Emacs distribution or an +@b{Important:} @i{If Org is part of the Emacs distribution or an XEmacs package, please skip this section and go directly to @ref{Activation}.} -If you have downloaded Org-mode from the Web, you must take the -following steps to install it: Go into the Org-mode distribution -directory and edit the top section of the file @file{Makefile}. You -must set the name of the Emacs binary (likely either @file{emacs} or -@file{xemacs}), and the paths to the directories where local Lisp and -Info files are kept. If you don't have access to the system-wide -directories, create your own two directories for these files, enter them -into the Makefile, and make sure Emacs finds the Lisp files by adding -the following line to @file{.emacs}: - -@example -(setq load-path (cons "~/path/to/lispdir" load-path)) +If you have downloaded Org from the Web, either as a distribution @file{.zip} +or @file{.tar} file, or as a GIT archive, you must take the following steps +to install it: Go into the unpacked Org distribution directory and edit the +top section of the file @file{Makefile}. You must set the name of the Emacs +binary (likely either @file{emacs} or @file{xemacs}), and the paths to the +directories where local Lisp and Info files are kept. If you don't have +access to the system-wide directories, you can simply run Org directly from +the distribution directory by adding the @file{lisp} subdirectory to the +Emacs load path. To do this, add the following line to @file{.emacs}: + +@example +(setq load-path (cons "~/path/to/orgdir/lisp" load-path)) +@end example + +@noindent +If you plan to use code from the @file{contrib} subdirectory, do a similar +step for this directory: + +@example +(setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path)) @end example @b{XEmacs users now need to install the file @file{noutline.el} from -the @file{xemacs} subdirectory of the Org-mode distribution. Use the +the @file{xemacs} sub-directory of the Org distribution. Use the command:} @example @b{make install-noutline} @end example -@noindent Now byte-compile and install the Lisp files with the shell -commands: +@noindent Now byte-compile the Lisp files with the shell command: @example make +@end example + +@noindent If you are running Org from the distribution directory, this is +all. If you want to install into the system directories, use + +@example make install -@end example - -@noindent If you want to install the info documentation, use this command: - -@example make install-info @end example @noindent Then add to @file{.emacs}: @lisp -;; This line only if org-mode is not part of the X/Emacs distribution. +;; This line only if Org is not part of the X/Emacs distribution. (require 'org-install) @end lisp + @node Activation, Feedback, Installation, Introduction @section Activation @cindex activation @cindex autoload -@cindex global keybindings -@cindex keybindings, global +@cindex global key bindings +@cindex key bindings, global @iftex @b{Important:} @i{If you use copy-and-paste to copy lisp code from the @@ -503,35 +515,37 @@ @end iftex Add the following lines to your @file{.emacs} file. The last two lines -define @emph{global} keys for the commands @command{org-store-link} and -@command{org-agenda} - please choose suitable keys yourself. +define @emph{global} keys for the commands @command{org-store-link}, +@command{org-agenda}, and @command{org-iswitchb} - please choose suitable +keys yourself. @lisp ;; The following lines are always needed. Choose your own keys. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) (global-set-key "\C-cl" 'org-store-link) (global-set-key "\C-ca" 'org-agenda) +(global-set-key "\C-cb" 'org-iswitchb) @end lisp -Furthermore, you must activate @code{font-lock-mode} in org-mode +Furthermore, you must activate @code{font-lock-mode} in Org buffers, because significant functionality depends on font-locking being active. You can do this with either one of the following two lines (XEmacs user must use the second option): @lisp (global-font-lock-mode 1) ; for all buffers -(add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only +(add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only @end lisp -@cindex org-mode, turning on +@cindex Org mode, turning on With this setup, all files with extension @samp{.org} will be put -into Org-mode. As an alternative, make the first line of a file look +into Org mode. As an alternative, make the first line of a file look like this: @example MY PROJECTS -*- mode: org; -*- @end example -@noindent which will select Org-mode for this buffer no matter what +@noindent which will select Org mode for this buffer no matter what the file's name is. See also the variable @code{org-insert-mode-line-in-empty-file}. @@ -542,14 +556,14 @@ @cindex maintainer @cindex author -If you find problems with Org-mode, or if you have questions, remarks, +If you find problems with Org, or if you have questions, remarks, or ideas about it, please contact the maintainer @value{MAINTAINER} at @value{MAINTAINEREMAIL}. For bug reports, please provide as much information as possible, including the version information of Emacs (@kbd{C-h v emacs-version -@key{RET}}) and Org-mode (@kbd{C-h v org-version @key{RET}}), as well as -the Org-mode related setup in @file{.emacs}. If an error occurs, a +@key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as +the Org related setup in @file{.emacs}. If an error occurs, a backtrace can be very useful (see below on how to create one). Often a small example file helps, along with clear information about: @@ -563,7 +577,7 @@ @subsubheading How to create a useful backtrace @cindex backtrace of an error -If working with Org-mode produces an error with a message you don't +If working with Org produces an error with a message you don't understand, you may have hit a bug. The best way to report this is by providing, in addition to what was mentioned above, a @emph{Backtrace}. This is information from the built-in debugger about where and how the @@ -595,7 +609,7 @@ @node Conventions, , Feedback, Introduction @section Typesetting conventions used in this manual -Org-mode uses three types of keywords: TODO keywords, tags, and property +Org uses three types of keywords: TODO keywords, tags, and property names. In this manual we use the following conventions: @table @code @@ -613,17 +627,17 @@ special meaning are written with all capitals. @end table -@node Document structure, Tables, Introduction, Top +@node Document Structure, Tables, Introduction, Top @chapter Document Structure @cindex document structure @cindex structure of document -Org-mode is based on outline mode and provides flexible commands to +Org is based on outline mode and provides flexible commands to edit the structure of the document. @menu -* Outlines:: Org-mode is based on outline-mode -* Headlines:: How to typeset org-tree headlines +* Outlines:: Org is based on Outline mode +* Headlines:: How to typeset Org tree headlines * Visibility cycling:: Show and hide, much simplified * Motion:: Jumping to other headlines * Structure editing:: Changing sequence and level of headlines @@ -631,30 +645,30 @@ * Sparse trees:: Matches embedded in context * Plain lists:: Additional structure within an entry * Drawers:: Tucking stuff away -* orgstruct-mode:: Structure editing outside Org-mode +* Orgstruct mode:: Structure editing outside Org @end menu -@node Outlines, Headlines, Document structure, Document structure +@node Outlines, Headlines, Document Structure, Document Structure @section Outlines @cindex outlines -@cindex outline-mode - -Org-mode is implemented on top of outline-mode. Outlines allow a +@cindex Outline mode + +Org is implemented on top of Outline mode. Outlines allow a document to be organized in a hierarchical structure, which (at least for me) is the best representation of notes and thoughts. An overview of this structure is achieved by folding (hiding) large parts of the document to show only the general document structure and the parts -currently being worked on. Org-mode greatly simplifies the use of +currently being worked on. Org greatly simplifies the use of outlines by compressing the entire show/hide functionality into a single command @command{org-cycle}, which is bound to the @key{TAB} key. -@node Headlines, Visibility cycling, Outlines, Document structure +@node Headlines, Visibility cycling, Outlines, Document Structure @section Headlines @cindex headlines @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@footnote{See +Org start with one or more stars, on the left margin@footnote{See the variable @code{org-special-ctrl-a/e} to configure special behavior of @kbd{C-a} and @kbd{C-e} in headlines.}. For example: @@ -679,7 +693,7 @@ the subtree, in order to structure the collapsed view. See the variable @code{org-cycle-separator-lines} to modify this behavior. -@node Visibility cycling, Motion, Headlines, Document structure +@node Visibility cycling, Motion, Headlines, Document Structure @section Visibility cycling @cindex cycling, visibility @cindex visibility cycling @@ -688,7 +702,7 @@ @cindex hide text Outlines make it possible to hide parts of the text in the buffer. -Org-mode uses just two commands, bound to @key{TAB} and +Org uses just two commands, bound to @key{TAB} and @kbd{S-@key{TAB}} to change the visibility in the buffer. @cindex subtree visibility states @@ -728,9 +742,9 @@ '--------------------------------------' @end example -When @kbd{S-@key{TAB}} is called with a numerical prefix N, the CONTENTS -view up to headlines of level N will be shown. -Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field. +When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the +CONTENTS view up to headlines of level N will be shown. Note that inside +tables, @kbd{S-@key{TAB}} jumps to the previous field. @cindex show all, command @kindex C-c C-a @@ -738,12 +752,10 @@ Show all. @kindex C-c C-r @item C-c C-r -Reveal context around point, showing the current entry, the following -heading and the hierarchy above. Useful for working near a location -that has been exposed by a sparse tree command (@pxref{Sparse trees}) or -an agenda command (@pxref{Agenda commands}). With prefix arg show, on -each - +Reveal context around point, showing the current entry, the following heading +and the hierarchy above. Useful for working near a location that has been +exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command +(@pxref{Agenda commands}). With a prefix argument show, on each level, all sibling headings. @kindex C-c C-x b @item C-c C-x b @@ -757,13 +769,13 @@ @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 +but without affecting visibility in that buffer.}. With a numeric +prefix argument N, go up to level N and then take that tree. If N is +negative then go up that many levels. With a @kbd{C-u} prefix, do not remove the previously used indirect buffer. @end table -When Emacs first visits an Org-mode file, the global state is set to +When Emacs first visits an Org file, the global state is set to OVERVIEW, i.e. only the top level headlines are visible. This can be configured through the variable @code{org-startup-folded}, or on a per-file basis by adding one of the following lines anywhere in the @@ -775,7 +787,7 @@ #+STARTUP: showall @end example -@node Motion, Structure editing, Visibility cycling, Document structure +@node Motion, Structure editing, Visibility cycling, Document Structure @section Motion @cindex motion, between headlines @cindex jumping, to headlines @@ -814,7 +826,7 @@ @end example @end table -@node Structure editing, Archiving, Motion, Document structure +@node Structure editing, Archiving, Motion, Document Structure @section Structure editing @cindex structure editing @cindex headline, promotion and demotion @@ -831,7 +843,7 @@ @item M-@key{RET} Insert new heading with same level as current. If the cursor is in a plain list item, a new item is created (@pxref{Plain lists}). To force -creation of a new headline, use a prefix arg, or first press @key{RET} +creation of a new headline, use a prefix argument, or first press @key{RET} to get to the beginning of the next line. When this command is used in the middle of a line, the line is split and the rest of the line becomes the new headline@footnote{If you do not want the line to be split, @@ -873,29 +885,31 @@ @item C-c C-x C-w @itemx C-c C-x C-k Kill subtree, i.e. remove it from buffer but save in kill ring. -With prefix arg, kill N sequential subtrees. +With a numeric prefix argument N, kill N sequential subtrees. @kindex C-c C-x M-w @item C-c C-x M-w -Copy subtree to kill ring. With prefix arg, copy N sequential subtrees. +Copy subtree to kill ring. With a numeric prefix argument N, copy the N +sequential subtrees. @kindex C-c C-x C-y @item C-c C-x C-y Yank subtree from kill ring. This does modify the level of the subtree to -make sure the tree fits in nicely at the yank position. The yank -level can also be specified with a prefix arg, or by yanking after a +make sure the tree fits in nicely at the yank position. The yank level can +also be specified with a numeric prefix argument, or by yanking after a headline marker like @samp{****}. @kindex C-c C-w @item C-c C-w Refile entry to a different location. @xref{Refiling notes}. @kindex C-c ^ @item C-c ^ -Sort same-level entries. When there is an active region, all entries in -the region will be sorted. Otherwise the children of the current -headline are sorted. The command prompts for the sorting method, which -can be alphabetically, numerically, by time (using the first time stamp -in each entry), by priority, and each of these in reverse order. You -can also supply your own function to extract the sorting key. With a -@kbd{C-u} prefix, sorting will be case-sensitive. With two @kbd{C-u -C-u} prefixes, duplicate entries will also be removed. +Sort same-level entries. When there is an active region, all entries in the +region will be sorted. Otherwise the children of the current headline are +sorted. The command prompts for the sorting method, which can be +alphabetically, numerically, by time (using the first time stamp in each +entry), by priority, or by TODO keyword (in the sequence the keywords have +been defined in the setup). Reverse sorting is possible as well. You can +also supply your own function to extract the sorting key. With a @kbd{C-u} +prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, +duplicate entries will also be removed. @kindex C-c * @item C-c * Turn a normal line or plain list item into a headline (so that it @@ -907,8 +921,8 @@ @cindex region, active @cindex active region -@cindex transient-mark-mode -When there is an active region (transient-mark-mode), promotion and +@cindex Transient mark mode +When there is an active region (Transient mark mode), promotion and demotion work on all headlines in the region. To select a region of headlines, it is best to place both point and mark at the beginning of a line, mark at the beginning of the first headline, and point at the line @@ -916,13 +930,13 @@ inside a table (@pxref{Tables}), the Meta-Cursor keys have different functionality. -@node Archiving, Sparse trees, Structure editing, Document structure +@node Archiving, Sparse trees, Structure editing, Document Structure @section Archiving @cindex archiving When a project represented by a (sub)tree is finished, you may want to move the tree out of the way and to stop it from contributing to the -agenda. Org-mode knows two ways of archiving. You can mark a tree with +agenda. Org mode knows two ways of archiving. You can mark a tree with the ARCHIVE tag, or you can move an entire (sub)tree to a different location. @@ -949,7 +963,7 @@ archived subtrees are not exposed, unless you configure the option @code{org-sparse-tree-open-archived-trees}. @item -During agenda view construction (@pxref{Agenda views}), the content of +During agenda view construction (@pxref{Agenda Views}), the content of archived trees is ignored unless you configure the option @code{org-agenda-skip-archived-trees}. @item @@ -961,13 +975,13 @@ The following commands help managing the ARCHIVE tag: @table @kbd -@kindex C-c C-x C-a -@item C-c C-x C-a +@kindex C-c C-x a +@item C-c C-x a Toggle the ARCHIVE tag for the current headline. When the tag is set, -the headline changes to a shadowish face, and the subtree below it is +the headline changes to a shadowed face, and the subtree below it is hidden. -@kindex C-u C-c C-x C-a -@item C-u C-c C-x C-a +@kindex C-u C-c C-x a +@item C-u C-c C-x a Check if any direct children of the current headline should be archived. To do this, each subtree is checked for open TODO entries. If none are found, the command offers to set the ARCHIVE tag for the child. If the @@ -982,16 +996,23 @@ @subsection Moving subtrees @cindex external archiving -Once an entire project is finished, you may want to move it to a -different location, either in the current file, or even in a different -file, the archive file. +Once an entire project is finished, you may want to move it to a different +location. Org can move it to an @emph{Attic Sibling} in the same tree, to a +different tree in the current file, or to a different file, the archive file. @table @kbd +@kindex C-c C-x A +@item C-c C-x A +Move the curent entry to the @emph{Attic Sibling}. This is a sibling of the +entry with the heading @samp{Attic} and the tag @samp{ARCHIVE} +(@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this +way retains a lot of its original context, including inherited tags and +approximate position in the outline. @kindex C-c C-x C-s @item C-c C-x C-s Archive the subtree starting at the cursor position to the location given by @code{org-archive-location}. Context information that could be -lost like the file name, the category, inherited tags, and the todo +lost like the file name, the category, inherited tags, and the TODO state will be store as properties in the entry. @kindex C-u C-c C-x C-s @item C-u C-c C-x C-s @@ -1023,7 +1044,7 @@ @noindent If you would like to have a special ARCHIVE location for a single entry or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the -location as the value (@pxref{Properties and columns}). +location as the value (@pxref{Properties and Columns}). When a subtree is moved, it receives a number of special properties that record context information like the file from where the entry came, it's @@ -1031,14 +1052,14 @@ @code{org-archive-save-context-info} to adjust the amount of information added. -@node Sparse trees, Plain lists, Archiving, Document structure +@node Sparse trees, Plain lists, Archiving, Document Structure @section Sparse trees @cindex sparse trees @cindex trees, sparse @cindex folding, sparse trees @cindex occur, command -An important feature of Org-mode is the ability to construct +An important feature of Org mode is the ability to construct @emph{sparse trees} for selected information in an outline tree, so that the entire document is folded as much as possible, but the selected information is made visible along with the headline structure above @@ -1047,7 +1068,7 @@ detailed control on how much context is shown around each match.}. Just try it out and you will see immediately how it works. -Org-mode contains several commands creating such trees, all these +Org mode contains several commands creating such trees, all these commands can be accessed through a dispatcher: @table @kbd @@ -1095,7 +1116,7 @@ Or you can use the command @kbd{C-c C-e v} to export only the visible part of the document and print the resulting file. -@node Plain lists, Drawers, Sparse trees, Document structure +@node Plain lists, Drawers, Sparse trees, Document Structure @section Plain lists @cindex plain lists @cindex lists, plain @@ -1104,10 +1125,10 @@ Within an entry of the outline tree, hand-formatted lists can provide additional structure. They also provide a way to create lists of -checkboxes (@pxref{Checkboxes}). Org-mode supports editing such lists, +checkboxes (@pxref{Checkboxes}). Org supports editing such lists, and the HTML exporter (@pxref{Exporting}) parses and formats them. -Org-mode knows ordered and unordered lists. Unordered list items start +Org knows ordered and unordered lists. Unordered list items start with @samp{-}, @samp{+}, or @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or they will be seen as top-level headlines. Also, when you are hiding leading stars to get a clean @@ -1141,8 +1162,8 @@ @end group @end example -Org-mode supports these lists by tuning filling and wrapping commands to -deal with them correctly@footnote{Org-mode only changes the filling +Org supports these lists by tuning filling and wrapping commands to +deal with them correctly@footnote{Org only changes the filling settings for Emacs. For XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on, put into @file{.emacs}: @code{(require 'filladapt)}}. @@ -1160,18 +1181,18 @@ completely separated. If @code{org-cycle-include-plain-lists} has not been set, @key{TAB} -fixes the indentation of the curent line in a heuristic way. +fixes the indentation of the current line in a heuristic way. @kindex M-@key{RET} @item M-@key{RET} -Insert new item at current level. With prefix arg, force a new heading -(@pxref{Structure editing}). If this command is used in the middle of a -line, the line is @emph{split} and the rest of the line becomes the new -item@footnote{If you do not want the line to be split, customize the -variable @code{org-M-RET-may-split-line}.}. If this command is executed -in the @emph{whitespace before a bullet or number}, the new item is -created @emph{before} the current item. If the command is executed in -the white space before the text that is part of an item but does not -contain the bullet, a bullet is added to the current line. +Insert new item at current level. With a prefix argument, force a new +heading (@pxref{Structure editing}). If this command is used in the middle +of a line, the line is @emph{split} and the rest of the line becomes the new +item@footnote{If you do not want the line to be split, customize the variable +@code{org-M-RET-may-split-line}.}. If this command is executed in the +@emph{whitespace before a bullet or number}, the new item is created +@emph{before} the current item. If the command is executed in the white +space before the text that is part of an item but does not contain the +bullet, a bullet is added to the current line. @kindex M-S-@key{RET} @item M-S-@key{RET} Insert a new item with a checkbox (@pxref{Checkboxes}). @@ -1202,25 +1223,25 @@ If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the state of the checkbox. If not, this command makes sure that all the items on this list level use the same bullet. Furthermore, if this is -an ordered list, make sure the numbering is ok. +an ordered list, make sure the numbering is OK. @kindex C-c - @item C-c - -Cycle the entire list level through the different itemize/enumerate -bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). -With prefix arg, select the nth bullet from this list. -If there is an active region when calling this, all lines will be -converted to list items. If the first line already was a list item, any -item markers will be removed from the list. Finally, even without an -active region, a normal line will be converted into a list item. +Cycle the entire list level through the different itemize/enumerate bullets +(@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix +argument N, select the Nth bullet from this list. If there is an active +region when calling this, all lines will be converted to list items. If the +first line already was a list item, any item markers will be removed from the +list. Finally, even without an active region, a normal line will be +converted into a list item. @end table -@node Drawers, orgstruct-mode, Plain lists, Document structure +@node Drawers, Orgstruct mode, Plain lists, Document Structure @section Drawers @cindex drawers @cindex visibility cycling, drawers Sometimes you want to keep information associated with an entry, but you -normally don't want to see it. For this, Org-mode has @emph{drawers}. +normally don't want to see it. For this, Org mode has @emph{drawers}. Drawers need to be configured with the variable @code{org-drawers}@footnote{You can define drawers on a per-file basis with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers @@ -1238,19 +1259,19 @@ Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and show the entry, but keep the drawer collapsed to a single line. In order to look inside the drawer, you need to move the cursor to the -drawer line and press @key{TAB} there. Org-mode uses a drawer for -storing properties (@pxref{Properties and columns}). - -@node orgstruct-mode, , Drawers, Document structure +drawer line and press @key{TAB} there. Org mode uses a drawer for +storing properties (@pxref{Properties and Columns}). + +@node Orgstruct mode, , Drawers, Document Structure @section The Orgstruct minor mode -@cindex orgstruct-mode +@cindex Orgstruct mode @cindex minor mode for structure editing -If you like the intuitive way the Org-mode structure editing and list +If you like the intuitive way the Org mode structure editing and list formatting works, you might want to use these commands in other modes -like text-mode or mail-mode as well. The minor mode Orgstruct-mode +like Text mode or Mail mode as well. The minor mode Orgstruct mode makes this possible. You can always toggle the mode with @kbd{M-x -orgstruct-mode}. To turn it on by default, for example in mail mode, +orgstruct-mode}. To turn it on by default, for example in Mail mode, use @lisp @@ -1258,22 +1279,22 @@ @end lisp When this mode is active and the cursor is on a line that looks to -Org-mode like a headline of the first line of a list item, most +Org like a headline of the first line of a list item, most structure editing commands will work, even if the same keys normally have different functionality in the major mode you are using. If the -cursor is not in one of those special lines, Orgstruct-mode lurks +cursor is not in one of those special lines, Orgstruct mode lurks silently in the shadow. -@node Tables, Hyperlinks, Document structure, Top +@node Tables, Hyperlinks, Document Structure, Top @chapter Tables @cindex tables @cindex editing tables -Org-mode comes with a fast and intuitive table editor. Spreadsheet-like +Org comes with a fast and intuitive table editor. Spreadsheet-like calculations are supported in connection with the Emacs @file{calc} package @ifinfo -(@pxref{Top,Calc,,calc,Gnu Emacs Calculator Manual}). +(@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}). @end ifinfo @ifnotinfo (see the Emacs Calculator manual for more information about the Emacs @@ -1284,15 +1305,15 @@ * 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. +* Orgtbl mode:: The table editor as minor mode +* The spreadsheet:: The table editor has spreadsheet capabilities @end menu @node Built-in table editor, Narrow columns, Tables, Tables @section The built-in table editor @cindex table editor, built-in -Org-mode makes it easy to format tables in plain ASCII. Any line with +Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as the first non-whitespace character is considered part of a table. @samp{|} is also the column separator. A table might look like this: @@ -1321,7 +1342,7 @@ @noindent and then press @key{TAB} to align the table and start filling in fields. -When typing text into a field, Org-mode treats @key{DEL}, +When typing text into a field, Org treats @key{DEL}, @key{Backspace}, and all character keys in a special way, so that inserting and deleting avoids shifting other fields. Also, when typing @emph{immediately after the cursor was moved into a new field @@ -1340,9 +1361,9 @@ If not, lines are split at whitespace into fields. You can use a prefix argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u C-u} forces TAB, and a numeric argument N indicates that at least N -consequtive spaces, or alternatively a TAB will be the separator. +consecutive spaces, or alternatively a TAB will be the separator. @* -If there is no active region, this command creates an empty Org-mode +If there is no active region, this command creates an empty Org table. But it's easier just to start typing, like @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. @@ -1393,11 +1414,12 @@ @c @kindex M-S-@key{down} @item M-S-@key{down} -Insert a new row above (with arg: below) the current row. +Insert a new row above the current row. With a prefix argument, the line is +created below the current one. @c @kindex C-c - @item C-c - -Insert a horizontal line below current row. With prefix arg, the line +Insert a horizontal line below current row. With a prefix argument, the line is created above the current line. @c @kindex C-c ^ @@ -1438,20 +1460,19 @@ @itemx M-@kbd{RET} Wrap several fields in a column like a paragraph. If there is an active region, and both point and mark are in the same column, the text in the -column is wrapped to minimum width for the given number of lines. A -prefix ARG may be used to change the number of desired lines. If there -is no region, the current field is split at the cursor position and the -text fragment to the right of the cursor is prepended to the field one -line down. If there is no region, but you specify a prefix ARG, the -current field is made blank, and the content is appended to the field -above. +column is wrapped to minimum width for the given number of lines. A numeric +prefix argument may be used to change the number of desired lines. If there +is no region, the current field is split at the cursor position and the text +fragment to the right of the cursor is prepended to the field one line +down. If there is no region, but you specify a prefix argument, the current +field is made blank, and the content is appended to the field above. @tsubheading{Calculations} @cindex formula, in tables @cindex calculations, in tables @cindex region, active @cindex active region -@cindex transient-mark-mode +@cindex Transient mark mode @kindex C-c + @item C-c + Sum the numbers in the current column, or in the rectangle defined by @@ -1464,7 +1485,7 @@ When not empty, copy current field down to next row and move cursor along with it. Depending on the variable @code{org-table-copy-increment}, integer field values will be -incremented during copy. This key is also used by CUA-mode +incremented during copy. This key is also used by CUA mode (@pxref{Cooperation}). @tsubheading{Miscellaneous} @@ -1484,13 +1505,17 @@ 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 +Tables can also be imported by pasting tabular text into the Org buffer, selecting the pasted text with @kbd{C-x C-x} and then using the @kbd{C-c |} command (see above under @i{Creation and conversion}. @c @item M-x org-table-export -Export the table as a TAB-separated file. Useful for data exchange with, -for example, spreadsheet or database programs. +Export the table, by default as a TAB-separated file. Useful for data +exchange with, for example, spreadsheet or database programs. The format +used to export the file can be configured in the variable +@code{org-table-export-default-format}. You may also use properties +@code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file +name and the format for table export in a subtree. @end table If you don't like the automatic table editor because it gets in your @@ -1550,11 +1575,11 @@ #+STARTUP: noalign @end example -@node Column groups, orgtbl-mode, 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 +When Org 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 @@ -1562,7 +1587,7 @@ 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 +a group of its own. Boundaries between column groups will upon export be marked with vertical lines. Here is an example: @example @@ -1576,7 +1601,7 @@ #+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 +It is also sufficient to just insert the column group starters after every vertical line you'd like to have: @example @@ -1585,14 +1610,14 @@ | / | < | | | < | | @end example -@node orgtbl-mode, The spreadsheet, Column groups, Tables +@node Orgtbl mode, The spreadsheet, Column groups, Tables @section The Orgtbl minor mode -@cindex orgtbl-mode +@cindex Orgtbl mode @cindex minor mode for tables -If you like the intuitive way the Org-mode table editor works, you -might also want to use it in other modes like text-mode or mail-mode. -The minor mode Orgtbl-mode makes this possible. You can always toggle +If you like the intuitive way the Org table editor works, you +might also want to use it in other modes like Text mode or Mail mode. +The minor mode Orgtbl mode makes this possible. You can always toggle the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for example in mail mode, use @@ -1601,12 +1626,12 @@ @end lisp Furthermore, with some special setup, it is possible to maintain tables -in arbitrary syntax with Orgtbl-mode. For example, it is possible to +in arbitrary syntax with Orgtbl mode. For example, it is possible to construct La@TeX{} tables with the underlying ease and power of -Orgtbl-mode, including spreadsheet capabilities. For details, see +Orgtbl mode, including spreadsheet capabilities. For details, see @ref{Tables in arbitrary syntax}. -@node The spreadsheet, , orgtbl-mode, Tables +@node The spreadsheet, , Orgtbl mode, Tables @section The spreadsheet @cindex calculations, in tables @cindex spreadsheet capabilities @@ -1614,9 +1639,9 @@ The table editor makes use of the Emacs @file{calc} package to implement spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to -derive fields from other fields. While fully featured, Org-mode's +derive fields from other fields. While fully featured, Org's implementation is not identical to other spreadsheets. For example, -Org-mode knows the concept of a @emph{column formula} that will be +Org knows the concept of a @emph{column formula} that will be applied to all non-header fields in a column without having to copy the formula to each relevant field. @@ -1636,7 +1661,7 @@ @cindex references To compute fields in the table from other fields, formulas must -reference other fields or ranges. In Org-mode, fields can be referenced +reference other fields or ranges. In Org, 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, or press @kbd{C-c @}} to toggle the display of a grid. @@ -1650,10 +1675,10 @@ 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. +@c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets. @noindent -Org-mode also uses another, more general operator that looks like this: +Org also uses another, more general operator that looks like this: @example @@row$column @end example @@ -1680,10 +1705,10 @@ either the column or the row part of the reference, the current row/column is implied. -Org-mode's references with @emph{unsigned} numbers are fixed references +Org's references with @emph{unsigned} numbers are fixed references in the sense that if you use the same reference in the formula for two different fields, the same field will be referenced each time. -Org-mode's references with @emph{signed} numbers are floating +Org'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. @@ -1740,7 +1765,7 @@ @end example @noindent -Also properties (@pxref{Properties and columns}) can be used as +Also properties (@pxref{Properties and Columns}) can be used as constants in table formulas: For a property @samp{:Xyz:} use the name @samp{$PROP_Xyz}, and the property will be searched in the current outline entry and in the hierarchy above it. If you have the @@ -1766,19 +1791,19 @@ non-standard convention that @samp{/} has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before evaluation by @code{calc-eval} (@pxref{Calling Calc from -Your Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU +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. +@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 +The range vectors can be directly fed into the Calc vector functions like @samp{vmean} and @samp{vsum}. @cindex format specifier @cindex mode, for @file{calc} A formula can contain an optional mode string after a semicolon. This string consists of flags to influence Calc and other modes during -execution. By default, Org-mode uses the standard calc modes (precision +execution. By default, Org uses the standard Calc modes (precision 12, angular units degrees, fraction and symbolic modes off. The display format, however, has been changed to @code{(float 5)} to keep tables compact. The default settings can be configured using the variable @@ -1828,7 +1853,7 @@ followed by an opening parenthesis, then it is evaluated as a lisp form. The evaluation should return either a string or a number. Just as with @file{calc} formulas, you can specify modes and a printf format after a -semicolon. With Emacs Lisp forms, you need to be concious about the way +semicolon. With Emacs Lisp forms, you need to be conscious about the way field references are interpolated into the form. By default, a reference will be interpolated as a Lisp string (in double quotes) containing the field. If you provide the @samp{N} mode switch, all @@ -1836,7 +1861,7 @@ interpolated as Lisp numbers, without quotes. If you provide the @samp{L} flag, all fields will be interpolated literally, without quotes. I.e., if you want a reference to be interpreted as a string by the Lisp -form, enclode the reference operator itself in double quotes, like +form, enclose the reference operator itself in double quotes, like @code{"$3"}. Ranges are inserted as space-separated fields, so you can embed them in list or vector syntax. A few examples, note how the @samp{N} mode is used when we do computations in lisp. @@ -1888,7 +1913,7 @@ 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 +in that column, Org allows to assign a single formula to an entire column. If the table contains horizontal separator hlines, everything before the first such line is considered part of the table @emph{header} and will not be modified by column formulas. @@ -1899,7 +1924,7 @@ field, the formula will be stored as the formula for the current column, evaluated and the current field replaced with the result. If the field contains only @samp{=}, the previously stored formula for this column is -used. For each column, Org-mode will only remember the most recently +used. For each column, Org will only remember the most recently used formula. In the @samp{TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. @@ -1909,22 +1934,21 @@ @table @kbd @kindex C-c = @item C-c = -Install a new formula for the current column and replace current field -with the result of the formula. The command prompts for a formula, with -default taken from the @samp{#+TBLFM} line, applies it to the current -field and stores it. With a numerical prefix (e.g. @kbd{C-5 C-c =}) +Install a new formula for the current column and replace current field with +the result of the formula. The command prompts for a formula, with default +taken from the @samp{#+TBLFM} line, applies it to the current field and +stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command will apply it to that many consecutive fields in the current column. @end table - @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet -@subsection Editing and Debugging formulas +@subsection Editing and debugging formulas @cindex formula editing @cindex editing, of table formulas 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. When offering a formula for editing, Org-mode +field. Org can also prepare a special buffer with all active +formulas of a table. When offering a formula for editing, Org 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 @@ -1960,7 +1984,7 @@ Edit all formulas for the current table in a special buffer, where the formulas will be displayed one per line. If the current field has an active formula, the cursor in the formula editor will mark it. -While inside the special buffer, Org-mode will automatically highlight +While inside the special buffer, Org will automatically highlight any field or range reference at the cursor position. You may edit, remove and add formulas, and use the following commands: @table @kbd @@ -1982,10 +2006,10 @@ Pretty-print or indent lisp formula at point. When in a line containing a lisp formula, format the formula according to Emacs Lisp rules. Another @key{TAB} collapses the formula back again. In the open -formula, @key{TAB} re-indents just like in Emacs-lisp-mode. +formula, @key{TAB} re-indents just like in Emacs lisp mode. @kindex M-@key{TAB} @item M-@key{TAB} -Complete Lisp symbols, just like in Emacs-lisp-mode. +Complete Lisp symbols, just like in Emacs lisp mode. @kindex S-@key{up} @kindex S-@key{down} @kindex S-@key{left} @@ -1997,7 +2021,7 @@ @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 +Move the test line for column formulas in the Org buffer up and down. @kindex M-@key{up} @kindex M-@key{down} @@ -2031,7 +2055,7 @@ field. Detailed information will be displayed. @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet -@subsection Updating the Table +@subsection Updating the table @cindex recomputing table fields @cindex updating, table @@ -2168,19 +2192,19 @@ @end group @end example -@node Hyperlinks, TODO items, Tables, Top +@node Hyperlinks, TODO Items, Tables, Top @chapter Hyperlinks @cindex hyperlinks -Like HTML, Org-mode provides links inside a file, external links to +Like HTML, Org provides links inside a file, external links to other files, Usenet articles, emails, and much more. @menu -* Link format:: How links in Org-mode are formatted +* Link format:: How links in Org are formatted * Internal links:: Links to other places in the current file * External links:: URL-like links to the world * Handling links:: Creating, inserting and following -* Using links outside Org-mode:: Linking from my C source code? +* Using links outside Org:: Linking from my C source code? * Link abbreviations:: Shortcuts for writing complex links * Search options:: Linking to a specific location * Custom searches:: When the default search is not enough @@ -2191,14 +2215,14 @@ @cindex link format @cindex format, of links -Org-mode will recognize plain URL-like links and activate them as +Org will recognize plain URL-like links and activate them as clickable links. The general link format, however, looks like this: @example [[link][description]] @r{or alternatively} [[link]] @end example -Once a link in the buffer is complete (all brackets present), Org-mode +Once a link in the buffer is complete (all brackets present), Org will change the display so that @samp{description} is displayed instead of @samp{[[link][description]]} and @samp{link} is displayed instead of @samp{[[link]]}. Links will be highlighted in the face @code{org-link}, @@ -2240,10 +2264,10 @@ that text before the first headline is usually not exported, so the first such target should be after the first headline.}. -If no dedicated target exists, Org-mode will search for the words in the +If no dedicated target exists, Org will search for the words in the link. In the above example the search would be for @samp{my target}. Links starting with a star like @samp{*My Target} restrict the search to -headlines. When searching, Org-mode will first try an exact match, but +headlines. When searching, Org mode will first try an exact match, but then move on to more and more lenient searches. For example, the link @samp{[[*My Targets]]} will find any of the following: @@ -2259,13 +2283,13 @@ offered as completions. @xref{Handling links}, for more commands creating links. -Following a link pushes a mark onto Org-mode's own mark ring. You can +Following a link pushes a mark onto Org's own mark ring. You can return to the previous position with @kbd{C-c &}. Using this command several times in direct succession goes back to positions recorded earlier. @menu -* Radio targets:: Make targets trigger links in plain text. +* Radio targets:: Make targets trigger links in plain text @end menu @node Radio targets, , Internal links, Internal links @@ -2274,12 +2298,12 @@ @cindex targets, radio @cindex links, radio targets -Org-mode can automatically turn any occurrences of certain target names +Org can automatically turn any occurrences of certain target names in normal text into a link. So without explicitly creating a link, the text connects to the target radioing its position. Radio targets are enclosed by triple angular brackets. For example, a target @samp{<<<My Target>>>} causes each occurrence of @samp{my target} in normal text to -become activated as a link. The Org-mode file is scanned automatically +become activated as a link. The Org file is scanned automatically for radio targets only when the file is first loaded into Emacs. To update the target list during editing, press @kbd{C-c C-c} with the cursor on or at a target. @@ -2289,7 +2313,7 @@ @cindex links, external @cindex external links @cindex links, external -@cindex GNUS links +@cindex Gnus links @cindex BBDB links @cindex IRC links @cindex URL links @@ -2303,14 +2327,14 @@ @cindex Info links @cindex elisp links -Org-mode supports links to files, websites, Usenet and email messages, +Org supports links to files, websites, Usenet and email messages, BBDB database entries and links to both IRC conversations and their logs. External links are URL-like locators. They start with a short identifying string followed by a colon. There can be no space after the colon. The following list shows examples for each link type. @example -http://orgmode.org/ @r{on the web} +http://www.astro.uva.nl/~dominik @r{on the web} file:/home/dominik/images/jupiter.jpg @r{file, absolute path} file:papers/last.pdf @r{file, relative path} news:comp.emacs @r{Usenet link} @@ -2324,8 +2348,8 @@ mhe:folder#id @r{MH-E message link} rmail:folder @r{RMAIL folder link} rmail:folder#id @r{RMAIL message link} -gnus:group @r{GNUS group link} -gnus:group#id @r{GNUS article link} +gnus:group @r{Gnus group link} +gnus:group#id @r{Gnus article link} bbdb:Richard Stallman @r{BBDB link} irc:/irc.com/#emacs/bob @r{IRC link} shell:ls *.org @r{A shell command} @@ -2333,7 +2357,7 @@ @end example A link should be enclosed in double brackets and may contain a -descriptive text to be displayed instead of the url (@pxref{Link +descriptive text to be displayed instead of the URL (@pxref{Link format}), for example: @example @@ -2349,17 +2373,17 @@ @cindex angular brackets, around links @cindex plain text external links -Org-mode also finds external links in the normal text and activates them +Org also finds external links in the normal text and activates them as links. If spaces must be part of the link (for example in @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities about the end of the link, enclose them in angular brackets. -@node Handling links, Using links outside Org-mode, External links, Hyperlinks +@node Handling links, Using links outside Org, External links, Hyperlinks @section Handling links @cindex links, handling -Org-mode provides methods to create a link in the correct syntax, to -insert it into an org-mode file, and to follow the link. +Org provides methods to create a link in the correct syntax, to +insert it into an Org file, and to follow the link. @table @kbd @kindex C-c l @@ -2367,10 +2391,10 @@ @item C-c l Store a link to the current location. This is a @emph{global} command which can be used in any buffer to create a link. The link will be -stored for later insertion into an Org-mode buffer (see below). For -Org-mode files, if there is a @samp{<<target>>} at the cursor, the +stored for later insertion into an Org buffer (see below). For +Org files, if there is a @samp{<<target>>} at the cursor, the link points to the target. Otherwise it points to the current -headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the +headline. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the link will indicate the current article/entry. For W3 and W3M buffers, the link goes to the current URL. For IRC links, if you set the variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will @@ -2391,25 +2415,24 @@ @cindex completion, of links @cindex inserting links @item C-c C-l -Insert a link. This prompts for a link to be inserted into the buffer. -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 @kbd{M-p/n}). -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}.}, 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. +Insert a link. This prompts for a link to be inserted into the buffer. 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 @kbd{M-p/n}). 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 argument to @kbd{C-c C-l}, or configure the 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 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 @@ -2424,7 +2447,7 @@ a file will be inserted and you may use file name completion to select the name of the file. The path to the file is inserted relative to the directory of the current org file, if the linked file is in the current -directory or in a subdirectory of it, or if the path is written relative +directory or in a sub-directory of it, or if the path is written relative 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. @@ -2437,7 +2460,7 @@ @kindex C-c C-o @item C-c C-o Open link at point. This will launch a web browser for URLs (using -@command{browse-url-at-point}), run vm/mh-e/wanderlust/rmail/gnus/bbdb +@command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for the corresponding links, and execute the command in a shell link. When the cursor is on an internal link, this commands runs the corresponding search. When the cursor is on a TAG list in a headline, @@ -2493,11 +2516,11 @@ @end lisp @end table -@node Using links outside Org-mode, Link abbreviations, Handling links, Hyperlinks -@section Using links outside Org-mode - -You can insert and follow links that have Org-mode syntax not only in -Org-mode, but in any Emacs buffer. For this, you should create two +@node Using links outside Org, Link abbreviations, Handling links, Hyperlinks +@section Using links outside Org + +You can insert and follow links that have Org syntax not only in +Org, but in any Emacs buffer. For this, you should create two global commands, like this (please select suitable global keys yourself): @@ -2506,7 +2529,7 @@ (global-set-key "\C-c o" 'org-open-at-point-global) @end lisp -@node Link abbreviations, Search options, Using links outside Org-mode, Hyperlinks +@node Link abbreviations, Search options, Using links outside Org, Hyperlinks @section Link abbreviations @cindex link abbreviations @cindex abbreviation, links @@ -2541,10 +2564,10 @@ With the above setting, you could link to a specific bug with @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with -@code{[[google:OrgMode]]} and find out what the Org-mode author is +@code{[[google:OrgMode]]} and find out what the Org author is doing besides Emacs hacking with @code{[[ads:Dominik,C]]}. -If you need special abbreviations just for a single Org-mode buffer, you +If you need special abbreviations just for a single Org buffer, you can define them in the file with @example @@ -2590,11 +2613,11 @@ link will become an HTML reference to the corresponding named anchor in the linked file. @item *My Target -In an Org-mode file, restrict search to headlines. +In an Org file, restrict search to headlines. @item /regexp/ Do a regular expression search for @code{regexp}. This uses the Emacs command @code{occur} to list all matches in a separate window. If the -target file is in Org-mode, @code{org-occur} is used to create a +target file is in Org mode, @code{org-occur} is used to create a sparse tree with the matches. @c If the target file is a directory, @c @code{grep} will be used to search all files in the directory. @@ -2623,26 +2646,26 @@ to be added to the hook variables @code{org-create-file-search-functions} and @code{org-execute-file-search-functions}. See the docstring for these -variables for more information. Org-mode actually uses this mechanism +variables for more information. Org actually uses this mechanism for Bib@TeX{} database files, and you can use the corresponding code as an implementation example. Search for @samp{BibTeX links} in the source file. -@node TODO items, Tags, Hyperlinks, Top -@chapter TODO items +@node TODO Items, Tags, Hyperlinks, Top +@chapter TODO Items @cindex TODO items -Org-mode does not maintain TODO lists as separate documents. Instead, +Org mode does not maintain TODO lists as separate documents. Instead, TODO items are an integral part of the notes file, because TODO items -usually come up while taking notes! With Org-mode, simply mark any +usually come up while taking notes! With Org mode, simply mark any entry in a tree as being a TODO item. In this way, information is not duplicated, and the entire context from which the TODO item emerged is always present. Of course, this technique for managing TODO items scatters them -throughout your notes file. Org-mode compensates for this by providing +throughout your notes file. Org mode compensates for this by providing methods to give you an overview of all the things that you have to do. @menu @@ -2654,7 +2677,7 @@ * Checkboxes:: Tick-off lists @end menu -@node TODO basics, TODO extensions, TODO items, TODO items +@node TODO basics, TODO extensions, TODO Items, TODO Items @section Basic TODO functionality Any headline becomes a TODO item when it starts with the word @@ -2702,15 +2725,15 @@ @itemx C-c / t 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, search for a specific TODO. You will be +above them. With a prefix argument, search for a specific TODO. You will be prompted for the keyword, and you can also give a list of keywords like -@code{KWD1|KWD2|...}. With numerical prefix N, show the tree for the +@code{KWD1|KWD2|...}. With numeric prefix argument 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. +arguments, find all TODO and DONE entries. @kindex C-c a t @item C-c a t Show the global TODO list. Collects the TODO items from all agenda -files (@pxref{Agenda views}) into a single buffer. The new buffer will +files (@pxref{Agenda Views}) into a single buffer. The new buffer will be in @code{agenda-mode}, which provides commands to examine and manipulate the TODO entries from the new buffer (@pxref{Agenda commands}). @xref{Global TODO list}, for more information. @@ -2719,12 +2742,12 @@ Insert a new TODO entry below the current one. @end table -@node TODO extensions, Progress logging, TODO basics, TODO items +@node TODO extensions, Progress logging, TODO basics, TODO Items @section Extended use of TODO keywords @cindex extended TODO keywords By default, marked TODO entries have one of only two states: TODO and -DONE. Org-mode allows you to classify TODO items in more complex ways +DONE. Org mode allows you to classify TODO items in more complex ways with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With special setup, the TODO keyword system can work differently in different files. @@ -2748,7 +2771,7 @@ You can use TODO keywords to indicate different @emph{sequential} states in the process of working on an item, for example@footnote{Changing -this variable only becomes effective after restarting Org-mode in a +this variable only becomes effective after restarting Org mode in a buffer.}: @lisp @@ -2763,13 +2786,13 @@ @cindex completion, of TODO keywords 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 +also use a numeric prefix argument to quickly select a specific state. For example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. Or you can use @kbd{S-left} to go backward through the sequence. If you define many keywords, you can use in-buffer completion (@pxref{Completion}) or even a special one-key selection scheme (@pxref{Fast access to TODO states}) to insert these words into the -buffer. Changing a todo state can be logged with a timestamp, see +buffer. Changing a TODO state can be logged with a timestamp, see @ref{Tracking TODO state changes} for more information. @node TODO types, Multiple sets in one file, Workflow states, TODO extensions @@ -2791,23 +2814,22 @@ 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}. +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 numeric prefix +argument as well when creating the global TODO list: @kbd{C-3 C-c t}. @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions @subsection Multiple keyword sets in one file -@cindex todo keyword sets +@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 @@ -2823,7 +2845,7 @@ (sequence "|" "CANCELED"))) @end lisp -The keywords should all be different, this helps Org-mode to keep track +The keywords should all be different, this helps Org mode to keep track of which subsequence should be used for a given entry. In this setup, @kbd{C-c C-t} only operates within a subsequence, so it switches from @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to @@ -2911,16 +2933,16 @@ if no bar is there) must always mean that the item is DONE (although you may use a different word). After changing one of these lines, use @kbd{C-c C-c} with the cursor still in the line to make the changes -known to Org-mode@footnote{Org-mode parses these lines only when -Org-mode is activated after visiting a file. @kbd{C-c C-c} with the -cursor in a line starting with @samp{#+} is simply restarting Org-mode +known to Org mode@footnote{Org mode parses these lines only when +Org mode is activated after visiting a file. @kbd{C-c C-c} with the +cursor in a line starting with @samp{#+} is simply restarting Org mode for the current buffer.}. @node Faces for TODO keywords, , Per-file keywords, TODO extensions @subsection Faces for TODO keywords @cindex faces, for TODO keywords -Org-mode highlights TODO keywords with special faces: @code{org-todo} +Org mode highlights TODO keywords with special faces: @code{org-todo} for keywords indicating that an item still has to be acted upon, and @code{org-done} for keywords indicating that an item is finished. If you are using more than 2 different states, you might want to use @@ -2939,12 +2961,12 @@ necessary, define a special face and use that. @page -@node Progress logging, Priorities, TODO extensions, TODO items -@section Progress Logging +@node Progress logging, Priorities, TODO extensions, TODO Items +@section Progress logging @cindex progress logging @cindex logging, of progress -Org-mode can automatically record a time stamp and possibly a note when +Org mode can automatically record a time stamp and possibly a note when you mark a TODO item as DONE, or even each time you change the state of a TODO item. This system is highly configurable, settings can be on a per-keyword basis and can be localized to a file or even a subtree. For @@ -2984,7 +3006,7 @@ the entry with a @samp{Closing Note} heading. In the timeline (@pxref{Timeline}) and in the agenda -(@pxref{Weekly/Daily agenda}), you can then use the @kbd{l} key to +(@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to display the TODO items with a @samp{CLOSED} timestamp on each day, giving you an overview of what has been done. @@ -2994,7 +3016,7 @@ When TODO keywords are used as workflow states (@pxref{Workflow states}), you might want to keep track of when a state change occurred and maybe take a note about this change. Since it is normally too much -to record a note for every state, Org-mode expects configuration on a +to record a note for every state, Org mode expects configuration on a per-keyword basis for this. This is achieved by adding special markers @samp{!} (for a time stamp) and @samp{@@} (for a note) in parenthesis after each keyword. For example, with the setting @@ -3007,7 +3029,7 @@ @noindent you not only define global TODO keywords and fast access keys, but also request that a time is recorded when the entry is turned into -DONE@footnote{It is possible that Org-mode will record two time stamps +DONE@footnote{It is possible that Org mode will record two time stamps when you are using both @code{org-log-done} and state change logging. However, it will never prompt for two notes - if you have configured both, the state change recording note will take precedence and cancel @@ -3051,11 +3073,11 @@ @end example -@node Priorities, Breaking down tasks, Progress logging, TODO items +@node Priorities, Breaking down tasks, Progress logging, TODO Items @section Priorities @cindex priorities -If you use Org-mode extensively, you may end up enough TODO items that +If you use Org mode extensively, you may end up enough TODO items that it starts to make sense to prioritize them. Prioritizing can be done by placing a @emph{priority cookie} into the headline of a TODO item, like this @@ -3065,11 +3087,11 @@ @end example @noindent -By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and +By default, Org mode supports three priorities: @samp{A}, @samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry without a cookie is treated as priority @samp{B}. Priorities make a difference only in -the agenda (@pxref{Weekly/Daily agenda}); outside the agenda, they have -no inherent meaning to Org-mode. +the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have +no inherent meaning to Org mode. Priorities can be attached to any outline tree entries; they do not need to be TODO items. @@ -3090,7 +3112,7 @@ Increase/decrease priority of current headline@footnote{See also the option @code{org-priority-start-cycle-with-default'}.}. Note that these keys are also used to modify time stamps (@pxref{Creating timestamps}). -Furthermore, these keys are also used by CUA-mode (@pxref{Conflicts}). +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 @@ -3104,7 +3126,7 @@ #+PRIORITIES: A C B @end example -@node Breaking down tasks, Checkboxes, Priorities, TODO items +@node Breaking down tasks, Checkboxes, Priorities, TODO Items @section Breaking tasks down into subtasks @cindex tasks, breaking down @@ -3117,13 +3139,13 @@ (@pxref{Checkboxes}). -@node Checkboxes, , Breaking down tasks, TODO items +@node Checkboxes, , Breaking down tasks, TODO Items @section Checkboxes @cindex checkboxes Every item in a plain list (@pxref{Plain lists}) can be made into a checkbox by starting it with the string @samp{[ ]}. This feature is -similar to TODO items (@pxref{TODO items}), but is more lightweight. +similar to TODO items (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included into the global TODO list, so they are often great to split a task into a number of simple steps. Or you can use them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or @@ -3167,7 +3189,7 @@ @table @kbd @kindex C-c C-c @item C-c C-c -Toggle checkbox at point. With prefix argument, set it to @samp{[-]}, +Toggle checkbox at point. With a prefix argument, set it to @samp{[-]}, which is considered to be an intermediate state. @kindex C-c C-x C-b @item C-c C-x C-b @@ -3199,7 +3221,7 @@ back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}. @end table -@node Tags, Properties and columns, TODO items, Top +@node Tags, Properties and Columns, TODO Items, Top @chapter Tags @cindex tags @cindex headline tagging @@ -3207,7 +3229,7 @@ @cindex sparse tree, tag based An excellent way to implement labels and contexts for cross-correlating -information is to assign @i{tags} to headlines. Org-mode has extensive +information is to assign @i{tags} to headlines. Org mode has extensive support for tags. Every headline can contain a list of tags; they occur at the end of the @@ -3242,12 +3264,13 @@ the final heading will have the tags @samp{:work:}, @samp{:boss:}, @samp{:notes:}, and @samp{:action:} even though the final heading is not explicitly marked with those tags. When executing tag searches and -Org-mode finds that a certain headline matches the search criterion, it +Org mode finds that a certain headline matches the search criterion, it will not check any sublevel headline, assuming that these also match and that the list of matches could become very long because of that. If you -do want the subevels be tested and listed as well, you may set the -variable @code{org-tags-match-list-sublevels}. To turn off tag -inheritance entirely, use the variable @code{org-use-tag-inheritance}. +do want the sublevels be tested and listed as well, you may set the +variable @code{org-tags-match-list-sublevels}. To limit tag inheritance +to specific tags, or to turn it off entirely, use the variable +@code{org-use-tag-inheritance}. @node Setting tags, Tag searches, Tag inheritance, Tags @section Setting tags @@ -3263,7 +3286,7 @@ @kindex C-c C-c @item C-c C-c @cindex completion, of tags -Enter new tags for the current headline. Org-mode will either offer +Enter new tags for the current headline. Org mode will either offer completion or a special single-key interface for setting tags, see below. After pressing @key{RET}, the tags will be inserted and aligned to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all @@ -3291,44 +3314,61 @@ #+TAGS: @end example -The default support method for entering tags is minibuffer completion. -However, Org-mode also implements a much better method: @emph{fast tag -selection}. This method allows to select and deselect tags with a -single key per tag. To function efficiently, you should assign unique -keys to most tags. This can be done globally with +By default Org mode uses the standard minibuffer completion facilities for +entering tags. However, it also implements another, quicker, tag selection +method called @emph{fast tag selection}. This allows you to select and +deselect tags with just a single key press. For this to work well you should +assign unique letters to most of your commonly used tags. You can do this +globally by configuring the variable @code{org-tag-alist} in your +@file{.emacs} file. For example, you may find the need to tag many items in +different files with @samp{:@@home:}. In this case you can set something +like: @lisp (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l))) @end lisp -@noindent or on a per-file basis with +@noindent If the tag is only relevant to the file you are working on then you +can, instead, set the TAGS option line as: @example #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p) @end example @noindent -You can also group together tags that are mutually exclusive. With -curly braces@footnote{In @code{org-mode-alist} use -@code{'(:startgroup)} and @code{'(:endgroup)}, respectively. Several -groups are allowed.} +You can also group together tags that are mutually exclusive. By using +braces, as in: @example #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p) @end example @noindent you indicate that at most one of @samp{@@work}, @samp{@@home}, -and @samp{@@tennisclub} should be selected. +and @samp{@@tennisclub} should be selected. Multiple such groups are allowed. @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of these lines to activate any changes. -If at least one tag has a selection key, pressing @kbd{C-c C-c} will -automatically present you with a special interface, listing inherited -tags, the tags of the current headline, and a list of all valid tags -with corresponding keys@footnote{Keys will automatically be assigned to -tags which have no configured keys.}. In this interface, you can use -the following keys: +@noindent +To set these mutually exclusive groups in the variable @code{org-mode-alist} +you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead +of the braces. The previous example would be set globally by the following +configuration: + +@lisp +(setq org-tag-alist '((:startgroup . nil) + ("@@work" . ?w) ("@@home" . ?h) + ("@@tennisclub" . ?t) + (:endgroup . nil) + ("laptop" . ?l) ("pc" . ?p))) +@end lisp + +If at least one tag has a selection key then pressing @kbd{C-c C-c} will +automatically present you with a special interface, listing inherited tags, +the tags of the current headline, and a list of all valid tags with +corresponding keys@footnote{Keys will automatically be assigned to tags which +have no configured keys.}. In this interface, you can use the following +keys: @table @kbd @item a-z... @@ -3368,7 +3408,7 @@ @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h @key{RET} @key{RET}}. -If you find that most of the time, you need only a single keypress to +If you find that most of the time, you need only a single key press to modify your list of tags, set the variable @code{org-fast-tag-selection-single-key}. Then you no longer have to press @key{RET} to exit fast tag selection - it will immediately exit @@ -3433,7 +3473,7 @@ meaningfully be combined with boolean AND. However, @emph{negative selection} combined with AND can be meaningful. To make sure that only lines are checked that actually have any TODO keyword, use @kbd{C-c a -M}, or equivalently start the todo part after the slash with @samp{!}. +M}, or equivalently start the TODO part after the slash with @samp{!}. Examples: @table @samp @@ -3460,22 +3500,22 @@ writing instead of any TAG an expression like @samp{LEVEL=3} or @samp{CATEGORY="work"}, respectively. For example, a search @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the -tag @samp{boss} and are @emph{not} marked with the todo keyword DONE. - -@node Properties and columns, Dates and times, Tags, Top +tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE. + +@node Properties and Columns, Dates and Times, Tags, Top @chapter Properties and Columns @cindex properties Properties are a set of key-value pairs associated with an entry. There -are two main applications for properties in Org-mode. First, properties +are two main applications for properties in Org mode. First, properties are like tags, but with a value. Second, you can use properties to -implement (very basic) database capabilities in an Org-mode buffer. For +implement (very basic) database capabilities in an Org buffer. For an example of the first application, imagine maintaining a file where you document bugs and plan releases of a piece of software. Instead of using tags like @code{:release_1:}, @code{:release_2:}, one can use a property, say @code{:Release:}, that in different subtrees has different values, such as @code{1.0} or @code{2.0}. For an example of the second -application of properties, imagine keeping track of one's music CD's, +application of properties, imagine keeping track of your music CD's, where properties could be things such as the album artist, date of release, number of tracks, and so on. @@ -3487,21 +3527,21 @@ instead of using tags like @code{:release_1:}, @code{:release_2:}, it can be more efficient to use a property @code{:Release:} with a value @code{1.0} or @code{2.0}. Second, you can use properties to implement -(very basic) database capabilities in an Org-mode buffer, for example to +(very basic) database capabilities in an Org buffer, for example to create a list of Music CD's you own. You can edit and view properties conveniently in column view (@pxref{Column view}). @menu * Property syntax:: How properties are spelled out -* Special properties:: Access to other Org-mode features +* Special properties:: Access to other Org mode features * Property searches:: Matching property values * Property inheritance:: Passing values down the tree * Column view:: Tabular viewing and editing * Property API:: Properties for Lisp programmers @end menu -@node Property syntax, Special properties, Properties and columns, Properties and columns -@section Property Syntax +@node Property syntax, Special properties, Properties and Columns, Properties and Columns +@section Property syntax @cindex property syntax @cindex drawer, for properties @@ -3548,7 +3588,7 @@ Property values set with the global variable @code{org-global-properties} can be inherited by all entries in all -Org-mode files. +Org files. @noindent The following commands help to work with properties: @@ -3585,11 +3625,11 @@ nearest column format definition. @end table -@node Special properties, Property searches, Property syntax, Properties and columns -@section Special Properties +@node Special properties, Property searches, Property syntax, Properties and Columns +@section Special properties @cindex properties, special -Special properties provide alternative access method to Org-mode +Special properties provide alternative access method to Org mode features discussed in the previous chapters, like the TODO state or the priority of an entry. This interface exists so that you can include these states into columns view (@pxref{Column view}), or to use them in @@ -3609,30 +3649,36 @@ @r{must be run first to compute the values.} @end example -@node Property searches, Property inheritance, Special properties, Properties and columns +@node Property searches, Property inheritance, Special properties, Properties and Columns @section Property searches @cindex properties, searching -@cindex properties, inheritance @cindex searching, of properties -@cindex inheritance, of properties - -To create sparse trees and special lists with selection based on -properties, the same commands are used as for tag searches (@pxref{Tag -searches}), and the same logic applies. For example, a search string - -@example -+work-boss+PRIORITY="A"+Coffee="unlimited"+Effort=""+With=@{Sarah\|Denny@} + +To create sparse trees and special lists with selection based on properties, +the same commands are used as for tag searches (@pxref{Tag searches}), and +the same logic applies. For example, here is a search string: + +@example ++work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2+With=@{Sarah\|Denny@} @end example @noindent -finds entries tagged @samp{:work:} but not @samp{:boss:}, which -also have a priority value @samp{A}, a @samp{:Coffee:} property with the -value @samp{unlimited}, an @samp{Effort} property that is undefined or -empty, and a @samp{:With:} property that is matched by -the regular expression @samp{Sarah\|Denny}. - -You can configure Org-mode to use property inheritance during a search, -see @ref{Property inheritance} for details. +If the comparison value is a plain number, a numerical comparison is done, +and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=}, +@samp{>=}, and @samp{<>}. If the comparison value is enclosed in double +quotes, a string comparison is done, and the same operators are allowed. If +the comparison value is enclosed in curly braces, a regexp match is +performed, with @samp{=} meaning that the regexp matches the property value, +and @samp{<>} meaning that it does not match. So the search string in the +example finds entries tagged @samp{:work:} but not @samp{:boss:}, which also +have a priority value @samp{A}, a @samp{:Coffee:} property with the value +@samp{unlimited}, an @samp{Effort} property that is numerically smaller than +2, and a @samp{:With:} property that is matched by the regular expression +@samp{Sarah\|Denny}. + +You can configure Org mode to use property inheritance during a search, but +beware that this can slow down searches considerably. See @ref{Property +inheritance} for details. There is also a special command for creating sparse trees based on a single property: @@ -3647,20 +3693,23 @@ a regular expression and matched against the property values. @end table -@node Property inheritance, Column view, Property searches, Properties and columns +@node Property inheritance, Column view, Property searches, Properties and Columns @section Property Inheritance - -The outline structure of Org-mode documents lends itself for an +@cindex properties, inheritance +@cindex inheritance, of properties + +The outline structure of Org mode documents lends itself for an inheritance model of properties: If the parent in a tree has a certain -property, the children can inherit this property. Org-mode does not +property, the children can inherit this property. Org mode does not turn this on by default, because it can slow down property searches significantly and is often not needed. However, if you find inheritance useful, you can turn it on by setting the variable @code{org-use-property-inheritance}. It may be set to @code{t}, to make -all properties inherited from the parent, or to a list of properties -that should be inherited. - -Org-mode has a few properties for which inheritance is hard-coded, at +all properties inherited from the parent, to a list of properties +that should be inherited, or to a regular expression that matches +inherited properties. + +Org mode has a few properties for which inheritance is hard-coded, at least for the special applications for which they are used: @table @code @@ -3681,13 +3730,13 @@ subtree (@pxref{Tracking TODO state changes}). @end table -@node Column view, Property API, Property inheritance, Properties and columns -@section Column View +@node Column view, Property API, Property inheritance, Properties and Columns +@section Column view A great way to view and edit properties in an outline tree is @emph{column view}. In column view, each outline item is turned into a table row. Columns in this table provide access to properties of the -entries. Org-mode implements columns by overlaying a tabular structure +entries. Org mode implements columns by overlaying a tabular structure over the headline of each item. While the headlines have been turned into a table row, you can still change the visibility of the outline tree. For example, you get a compact table by switching to CONTENTS @@ -3695,17 +3744,17 @@ is active), but you can still open, read, and edit the entry below each headline. Or, you can switch to column view after executing a sparse tree command and in this way get a table only for the selected items. -Column view also works in agenda buffers (@pxref{Agenda views}) where +Column view also works in agenda buffers (@pxref{Agenda Views}) where queries have collected selected items, possibly from a number of files. @menu * Defining columns:: The COLUMNS format property * Using column view:: How to create and use column view -* Capturing Column View:: A dynamic block for column view +* Capturing column view:: A dynamic block for column view @end menu @node Defining columns, Using column view, Column view, Column view -@subsection Defining Columns +@subsection Defining columns @cindex column view, for properties @cindex properties, column view @@ -3801,8 +3850,8 @@ @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals in the subtree. -@node Using column view, Capturing Column View, Defining columns, Column view -@subsection Using Column View +@node Using column view, Capturing column view, Defining columns, Column view +@subsection Using column view @table @kbd @tsubheading{Turning column view on and off} @@ -3817,7 +3866,7 @@ view is established for the current entry and its subtree. @kindex r @item r -Recreate the column view, to included hanges happening in the buffer. +Recreate the column view, to include recent changes made in the buffer. @kindex g @item g Same as @kbd{r}. @@ -3868,12 +3917,12 @@ Delete the current column. @end table -@node Capturing Column View, , Using column view, Column view -@subsection Capturing Column View +@node Capturing column view, , Using column view, Column view +@subsection Capturing column view Since column view is just an overlay over a buffer, it cannot be exported or printed directly. If you want to capture a column view, use -ths @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame +this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame of this block looks like this: @example @@ -3927,10 +3976,10 @@ @kindex C-u C-c C-x C-u @item C-u C-c C-x C-u Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if -you have several clocktable blocks in a buffer. +you have several clock table blocks in a buffer. @end table -@node Property API, , Column view, Properties and columns +@node Property API, , Column view, Properties and Columns @section The Property API @cindex properties, API @cindex API, for properties @@ -3940,7 +3989,7 @@ features based on them. For more information see @ref{Using the property API}. -@node Dates and times, Remember, Properties and columns, Top +@node Dates and Times, Remember, Properties and Columns, Top @chapter Dates and Times @cindex dates @cindex times @@ -3949,21 +3998,22 @@ To assist project planning, TODO items can be labeled with a date and/or a time. The specially formatted string carrying the date and time -information is called a @emph{timestamp} in Org-mode. This may be a +information is called a @emph{timestamp} in Org mode. This may be a little confusing because timestamp is often used as indicating when -something was created or last changed. However, in Org-mode this term +something was created or last changed. However, in Org mode this term is used in a much wider sense. @menu -* Time stamps:: Assigning a time to a tree entry +* Timestamps:: Assigning a time to a tree entry * Creating timestamps:: Commands which insert timestamps * Deadlines and scheduling:: Planning your work -* Clocking work time:: +* Clocking work time:: Tracking how long you spend on a task +* Effort estimates:: Planning work effort in advance @end menu -@node Time stamps, Creating timestamps, Dates and times, Dates and times -@section Time stamps, deadlines and scheduling +@node Timestamps, Creating timestamps, Dates and Times, Dates and Times +@section Timestamps, deadlines and scheduling @cindex time stamps @cindex ranges, time @cindex date stamps @@ -3975,9 +4025,9 @@ @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue 12:00-12:30>}@footnote{This is the standard ISO date/time format. To use an alternative format, see @ref{Custom time format}.}. A time stamp -can appear anywhere in the headline or body of an org-tree entry. Its +can appear anywhere in the headline or body of an Org tree entry. Its presence causes entries to be shown on specific dates in the agenda -(@pxref{Weekly/Daily agenda}). We distinguish: +(@pxref{Weekly/daily agenda}). We distinguish: @table @var @item Plain time stamp; Event; Appointment @@ -4004,7 +4054,7 @@ @end example @item Diary-style sexp entries -For more complex date specifications, Org-mode supports using the +For more complex date specifications, Org mode supports using the special sexp diary entries implemented in the Emacs calendar/diary package. For example @@ -4038,12 +4088,12 @@ @end table -@node Creating timestamps, Deadlines and scheduling, Time stamps, Dates and times +@node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times @section Creating timestamps @cindex creating timestamps @cindex timestamps, creating -For Org-mode to recognize time stamps, they need to be in the specific +For Org mode to recognize time stamps, they need to be in the specific format. All commands listed below produce time stamps in the correct format. @@ -4072,20 +4122,20 @@ @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 +timestamp in the current line, go to 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}). +point (@pxref{Weekly/daily agenda}). @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}). +CUA mode (@pxref{Conflicts}). @c @kindex S-@key{up} @kindex S-@key{down} @@ -4095,20 +4145,20 @@ year, month, day, hour or minute. Note that if the cursor is in a 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}). +CUA mode (@pxref{Conflicts}). @c @kindex C-c C-y @cindex evaluate time range @item C-c C-y -Evaluate a time range by computing the difference between start and -end. With prefix arg, insert result after the time range (in a table: -into the following column). +Evaluate a time range by computing the difference between start and end. +With a prefix argument, insert result after the time range (in a table: into +the following column). @end table @menu -* The date/time prompt:: How org-mode helps you entering date and time -* Custom time format:: Making dates look differently +* The date/time prompt:: How Org mode helps you entering date and time +* Custom time format:: Making dates look different @end menu @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps @@ -4116,24 +4166,24 @@ @cindex date, reading in minibuffer @cindex time, reading in minibuffer -When Org-mode prompts for a date/time, the default is shown as an ISO +When Org mode prompts for a date/time, the default is shown as an ISO date, and the prompt therefore seems to ask for an ISO date. But it will in fact accept any string containing some date and/or time information, and it is really smart about interpreting your input. You can, for example, use @kbd{C-y} to paste a (possibly multi-line) string -copied from an email message. Org-mode will find whatever information +copied from an email message. Org mode will find whatever information is in there and derive anything you have not specified from the @emph{default date and time}. The default is usually the current date and time, but when modifying an existing time stamp, or when entering the second stamp of a range, it is taken from the stamp in the buffer. -When filling in information, Org-mode assumes that most of the time you +When filling in information, Org mode assumes that most of the time you will want to enter a date in the future: If you omit the month/year and the given day/month is @i{before} today, it will assume that you mean a future date@footnote{See the variable @code{org-read-date-prefer-future}.}. For example, lets assume that today is @b{June 13, 2006}. Here is how -various inputs will be interpreted, the items filled in by Org-mode are +various inputs will be interpreted, the items filled in by Org mode are in @b{bold}. @example @@ -4146,6 +4196,9 @@ sep 12 9 --> 2009-09-12 12:45 --> @b{2006}-@b{06}-@b{13} 12:45 22 sept 0:34 --> @b{2006}-09-22 0:34 +w4 --> ISO week for of the current year @b{2006} +2012 w4 fri --> Friday of ISO week 4 in 2012 +2012-w04-5 --> Same as above @end example Furthermore you can specify a relative date by giving, as the @@ -4196,11 +4249,12 @@ @key{RET} @r{Choose date in calendar.} @end example -The actions of the date/time prompt may seem complex, but I asure you -they will grow on you. To help you understand what is going on, the -current interpretation of your input will be displayed live in the -minibuffer@footnote{If you find this distracting, turn the display of -with @code{org-read-date-display-live}.}. +The actions of the date/time prompt may seem complex, but I assure you they +will grow on you, and you will start getting annoyed by pretty much any other +way of entering a date/time out there. To help you understand what is going +on, the current interpretation of your input will be displayed live in the +minibuffer@footnote{If you find this distracting, turn the display of with +@code{org-read-date-display-live}.}. @node Custom time format, , The date/time prompt, Creating timestamps @subsection Custom time format @@ -4208,7 +4262,7 @@ @cindex time format, custom @cindex date format, custom -Org-mode uses the standard ISO notation for dates and times as it is +Org mode uses the standard ISO notation for dates and times as it is defined in ISO 8601. If you cannot get used to this and require another representation of date and time to keep you happy, you can get it by customizing the variables @code{org-display-custom-times} and @@ -4221,7 +4275,7 @@ @end table @noindent -Org-mode needs the default format for scanning, so the custom date/time +Org mode needs the default format for scanning, so the custom date/time format does not @emph{replace} the default format - instead it is put @emph{over} the default format using text properties. This has the following consequences: @@ -4249,8 +4303,8 @@ @end itemize -@node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and times -@section Deadlines and Scheduling +@node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times +@section Deadlines and scheduling A time stamp may be preceded by special keywords to facilitate planning: @@ -4296,23 +4350,23 @@ @end example @noindent -@b{Important:} Scheduling an item in Org-mode should @i{not} be +@b{Important:} Scheduling an item in Org mode should @i{not} be understood in the same way that we understand @i{scheduling a meeting}. Setting a date for a meeting is just a simple appointment, you should mark this entry with a simple plain time stamp, to get this item shown on the date where it applies. This is a frequent mis-understanding from -Org-users. In Org-mode, @i{scheduling} means setting a date when you +Org-users. In Org mode, @i{scheduling} means setting a date when you want to start working on an action item. @end table You may use time stamps with repeaters in scheduling and deadline -entries. Org-mode will issue early and late warnings based on the +entries. Org mode will issue early and late warnings based on the assumption that the time stamp represents the @i{nearest instance} of the repeater. However, the use of diary sexp entries like @c @code{<%%(diary-float t 42)>} @c -in scheduling and deadline timestamps is limited. Org-mode does not +in scheduling and deadline timestamps is limited. Org mode does not know enough about the internals of each sexp function to issue early and late warnings. However, it will show the item on each day where the sexp entry matches. @@ -4323,7 +4377,7 @@ @end menu @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling -@subsection Inserting deadline/schedule +@subsection Inserting deadlines or schedules The following commands allow to quickly insert a deadline or to schedule an item: @@ -4355,9 +4409,9 @@ @end table @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling -@subsection Repeated Tasks - -Some tasks need to be repeated again and again. Org-mode helps to +@subsection Repeated tasks + +Some tasks need to be repeated again and again. Org mode helps to organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED, or plain time stamp. In the following example @example @@ -4373,9 +4427,9 @@ 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 +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 +@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 @@ -4387,11 +4441,11 @@ DEADLINE: <2005-11-01 Tue +1m> @end example -You will also be prompted for a note@footnote{You can change this using -the option @code{org-log-repeat}, or the @code{#+STARTUP} options -@code{logrepeat}, @code{lognoterepeat}, and @code{nologrepeat}.} that -will be put under the DEADLINE line to keep a record that you actually -acted on the previous instance of this deadline. +A timestamp@footnote{You can change this using the option +@code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat}, +@code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you +will aslo be prompted for a note.} will be added under the deadline, 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 @@ -4402,10 +4456,10 @@ entry DONE will still keep it as an overdue deadline. Depending on the task, this may not be the best way to handle it. For example, if you forgot to call you father for 3 weeks, it does not make sense to call -her 3 times in a single day to make up for it. Finally, there are tasks +him 3 times in a single day to make up for it. Finally, there are tasks like changing batteries which should always repeat a certain time -@i{after} the last time you did it. For these tasks, Org-mode has -special repeaters markes with @samp{++} and @samp{.+}. For example: +@i{after} the last time you did it. For these tasks, Org mode has +special repeaters markers with @samp{++} and @samp{.+}. For example: @example ** TODO Call Father @@ -4423,10 +4477,10 @@ 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 Clocking work time, , Deadlines and scheduling, Dates and times +@node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times @section Clocking work time -Org-mode allows you to clock the time you spent on specific tasks in a +Org mode allows you to clock the time you spent on specific tasks in a project. When you start working on an item, you can start the clock. When you stop working on that task, or when you mark the task done, the clock is stopped and the corresponding time interval is recorded. It @@ -4439,7 +4493,11 @@ keyword together with a timestamp. If this is not the first clocking of this item, the multiple CLOCK lines will be wrapped into a @code{:CLOCK:} drawer (see also the variable -@code{org-clock-into-drawer}). +@code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument, +select the task from a list of recently clocked tasks. With two @kbd{C-u +C-u} prefixes, clock into the task at point and mark it as the default task. +The default task will always be available when selecting a clocking task, +with letter @kbd{d}. @kindex C-c C-x C-o @item C-c C-x C-o Stop the clock (clock-out). The inserts another timestamp at the same @@ -4464,8 +4522,9 @@ mistake, or if you ended up working on something else. @kindex C-c C-x C-j @item C-c C-x C-j -Jump to the entry that contains the currently running clock, an another -window. +Jump to the entry that contains the currently running clock. With a +@kbd{C-u} prefix arg, select the target task from a list of recently clocked +tasks. @kindex C-c C-x C-d @item C-c C-x C-d Display time summaries for each subtree in the current buffer. This @@ -4477,13 +4536,12 @@ @kindex C-c C-x C-r @item C-c C-x C-r Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock -report as an org-mode table into the current file. When the cursor is +report as an Org mode table into the current file. When the cursor is at an existing clock table, just update it. When called with a prefix argument, jump to the first clock report in the current document and update it. @example #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file - #+END: clocktable @end example @noindent @@ -4500,20 +4558,30 @@ tree @r{the surrounding level 1 tree} agenda @r{all agenda files} ("file"..) @r{scan these files} -:block @r{The time block to consider. This block is specified relative} - @r{to the current time and may be any of these keywords:} - @r{@code{today}, @code{yesterday}, @code{thisweek}, @code{lastweek},} - @r{@code{thismonth}, @code{lastmonth}, @code{thisyear}, or @code{lastyear}}. + file-with-archives @r{current file and its archives} + agenda-with-archives @r{all agenda files, including archives} +:block @r{The time block to consider. This block is specified either} + @r{absolute, or relative to the current time and may be any of} + @r{these formats:} + 2007-12-31 @r{New year eve 2007} + 2007-12 @r{December 2007} + 2007-W50 @r{ISO-week 50 in 2007} + 2007 @r{the year 2007} + today, yesterday, today-N @r{a relative day} + thisweek, lastweek, thisweek-N @r{a relative week} + thismonth, lastmonth, thismonth-N @r{a relative month} + thisyear, lastyear, thisyear-N @r{a relative year} + @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.} :tstart @r{A time string specifying when to start considering times} :tend @r{A time string specifying when to stop considering times} -:step @r{@code{week} or @code{day}, to split the table into chunks} +:step @r{@code{week} or @code{day}, to split the table into chunks.} + @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.} :link @r{Link the item headlines in the table to their origins} @end example So to get a clock summary of the current level 1 tree, for the current day, you could write @example -#+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 - +#+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t #+END: clocktable @end example and to use a specific time range you could write@footnote{Note that all @@ -4522,7 +4590,6 @@ @example #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" :tend "<2006-08-10 Thu 12:00>" - #+END: clocktable @end example @kindex C-c C-c @@ -4534,14 +4601,62 @@ @kindex C-u C-c C-x C-u @item C-u C-c C-x C-u Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if -you have several clocktable blocks in a buffer. +you have several clock table blocks in a buffer. +@kindex S-@key{left} +@kindex S-@key{right} +@item S-@key{left} +@itemx S-@key{right} +Shift the current @code{:block} interval and update the table. The cursor +needs to be in the @code{#+BEGIN: clocktable} line for this command. If +@code{:block} is @code{today}, it will be shifted to @code{today-1} etc. @end table The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in -the agenda (@pxref{Weekly/Daily agenda}) to show which tasks have been +the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been worked on or closed during a day. -@node Remember, Agenda views, Dates and times, Top +@node Effort estimates +@section Effort estimates +@cindex Effort estimates + +If you want to plan your work in a very detailed way, or if you need to +produce offers with quotations of the estimated work effort, you may want to +assign effort estimates to entries. If you are also clocking your work, you +may later want to compare the planned effort with the actual working time, a +great way to improve planning estimates. Effort estimates are stored in a +special property @samp{Effort}@footnote{You may change the property being +used with the variable @code{org-effort-property}.}. Clearly the best way to +work with effort estimates is through column view (@pxref{Column view}). You +should start by setting up discrete values for effort estimates, and a +@code{COLUMNS} format that displays these values together with clock sums (if +you want to clock your time). For a specific buffer you can use + +@example +#+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00 +#+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM +@end example + +@noindent +or you can set up these values globally by customizing the variables +@code{org-global-properties} and @code{org-columns-default-format}. In +particular if you want to use this setup also in the agenda, a global setup +may be advised. + +The way to assign estimates to individual items is then to switch to column +mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the +value. The values you enter will immediately be summed up in the hierarchy. +In the column next to it, any clocked time will be displayed. + +If you switch to column view in the daily/weekly agenda, the effort column +will summarize the estimated work effort for each day@footnote{Please note +the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda +column view}.}, and you can use this to find space in your schedule. To get +an overview of the entire part of the day that is committed, you can set the +option @code{org-agenda-columns-add-appointments-to-effort-sum}. The +appointments on a day that take place over a specified time interval will +then also be added to the load estimate of the day. + +@node Remember, Agenda Views, Dates and Times, Top @chapter Remember @cindex @file{remember.el} @@ -4549,24 +4664,24 @@ little interruption of your work flow. See @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more information. It is an excellent way to add new notes and tasks to -Org-mode files. Org-mode significantly expands the possibilities of +Org files. Org significantly expands the possibilities of @i{remember}: You may define templates for different note types, and associate target files and headlines with specific templates. It also allows you to select the location where a note should be stored interactively, on the fly. @menu -* Setting up remember:: Some code for .emacs to get things going +* Setting up Remember:: Some code for .emacs to get things going * Remember templates:: Define the outline of different note types * Storing notes:: Directly get the note to where it belongs * Refiling notes:: Moving a note or task to a project @end menu -@node Setting up remember, Remember templates, Remember, Remember -@section Setting up remember +@node Setting up Remember, Remember templates, Remember, Remember +@section Setting up Remember The following customization will tell @i{remember} to use org files as -target, and to create annotations compatible with Org-mode links. +target, and to create annotations compatible with Org links. @example (org-remember-insinuate) @@ -4582,14 +4697,14 @@ automatically copy the region into the remember buffer. It also allows to jump to the buffer and location where remember notes are being stored: Just call @code{org-remember} with a prefix argument. If you -use two prefix arguments, Org-mode jumps to the location where the last +use two prefix arguments, Org jumps to the location where the last remember note was stored. -@node Remember templates, Storing notes, Setting up remember, Remember +@node Remember templates, Storing notes, Setting up Remember, Remember @section Remember templates @cindex templates, for remember -In combination with Org-mode, you can use templates to generate +In combination with Org, you can use templates to generate different types of @i{remember} notes. For example, if you would like to use one template to create general TODO entries, another one for journal entries, and a third one for collecting random ideas, you could @@ -4609,12 +4724,13 @@ which, and the headline under which the new note should be stored. The file (if not present or @code{nil}) defaults to @code{org-default-notes-file}, the heading to -@code{org-remember-default-headline}. +@code{org-remember-default-headline}. If the file name is not an +absolute path, it will be interpreted relative to @code{org-directory}. An optional sixth element specifies the contexts in which the user can select the template. This element can be either a list of major modes or a function. @code{org-remember} will first check whether the function -returns @code{t} or if we are in any of the listed major mode, and select +returns @code{t} or if we are in any of the listed major mode, and select the template accordingly. So for example: @@ -4657,7 +4773,10 @@ %A @r{like @code{%a}, but prompt for the description part} %i @r{initial content, the region when remember is called with C-u.} @r{The entire text will be indented like @code{%i} itself.} -%c @r{Content of the clipboard, or current kill ring head.} +%c @r{Current kill ring head.} +%x @r{Content of the X clipboard.} +%^C @r{Interactive selection of which kill or clip to use.} +%^L @r{Like @code{%^C}, but insert as link.} %^g @r{prompt for tags, with completion on tags in target file.} %^G @r{prompt for tags, with completion all tags in all agenda files.} %:keyword @r{specific information for certain link types, see below} @@ -4779,21 +4898,21 @@ @item C-u C-c C-w Use the refile interface to jump to a heading. @kindex C-u C-u C-c C-w -@item C- C-u C-c C-w +@item C-u C-u C-c C-w Jump to the location where @code{org-refile} last moved a tree to. @end table -@node Agenda views, Embedded LaTeX, Remember, Top +@node Agenda Views, Embedded LaTeX, Remember, Top @chapter Agenda Views @cindex agenda views -Due to the way Org-mode works, TODO items, time-stamped items, and +Due to the way Org works, TODO items, time-stamped items, and tagged headlines can be scattered throughout a file or even a number of files. To get an overview of open action items, or of events that are important for a particular date, this information must be collected, sorted and displayed in an organized way. -Org-mode can select items based on various criteria, and display them +Org can select items based on various criteria, and display them in a separate buffer. Seven different view types are provided: @itemize @bullet @@ -4807,7 +4926,7 @@ a @emph{tags view}, showings headlines based on the tags associated with them, @item -a @emph{timeline view} that shows all events in a single Org-mode file, +a @emph{timeline view} that shows all events in a single Org file, in time-sorted view, @item a @emph{keyword search view} that shows all entries from multiple files @@ -4823,7 +4942,7 @@ @noindent The extracted information is displayed in a special @emph{agenda buffer}. This buffer is read-only, but provides commands to visit the -corresponding locations in the original Org-mode files, and even to +corresponding locations in the original Org files, and even to edit these files remotely. Two variables control how the agenda buffer is displayed and whether the @@ -4836,11 +4955,12 @@ * Agenda dispatcher:: Keyboard access to agenda views * Built-in agenda views:: What is available out of the box? * Presentation and sorting:: How agenda items are prepared for display -* Agenda commands:: Remote editing of org trees +* Agenda commands:: Remote editing of Org trees * Custom agenda views:: Defining special searches and views +* Agenda column view:: Using column view for collected entries @end menu -@node Agenda files, Agenda dispatcher, Agenda views, Agenda views +@node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views @section Agenda files @cindex agenda files @cindex files for agenda @@ -4853,7 +4973,7 @@ all files with the extension @file{.org} in this directory will be part of the list. -Thus even if you only work with a single Org-mode file, this file should +Thus even if you only work with a single Org file, this file should be put into that list@footnote{When using the dispatcher, pressing @kbd{<} before selecting a command will actually limit the command to the current file, and ignore @code{org-agenda-files} until the next @@ -4866,7 +4986,7 @@ @item C-c [ Add current file to the list of agenda files. The file is added to the front of the list. If it was already in the list, it is moved to -the front. With prefix arg, file is added/moved to the end. +the front. With a prefix argument, file is added/moved to the end. @kindex C-c ] @item C-c ] Remove current file from the list of agenda files. @@ -4875,6 +4995,10 @@ @item C-, @itemx C-' Cycle through agenda file list, visiting one file after the other. +@kindex M-x org-iswitchb +@item M-x org-iswitchb +Command to use an @code{iswitchb}-like interface to switch to and between Org +buffers. @end table @noindent @@ -4904,12 +5028,12 @@ @noindent When working with @file{Speedbar}, you can use the following commands in -the speedbar frame: +the Speedbar frame: @table @kbd @kindex < @item < @r{in the speedbar frame} Permanently restrict the agenda to the item at the cursor in the -speedbar frame, either an Org-mode file or a subtree in such a file. +Speedbar frame, either an Org file or a subtree in such a file. If there is a window displaying an agenda view, the new restriction takes effect immediately. @kindex < @@ -4917,7 +5041,7 @@ Lift the restriction again. @end table -@node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda views +@node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views @section The agenda dispatcher @cindex agenda dispatcher @cindex dispatching agenda commands @@ -4929,7 +5053,7 @@ command. The dispatcher offers the following default commands: @table @kbd @item a -Create the calendar-like agenda (@pxref{Weekly/Daily agenda}). +Create the calendar-like agenda (@pxref{Weekly/daily agenda}). @item t @r{/} T Create a list of all TODO items (@pxref{Global TODO list}). @item m @r{/} M @@ -4967,13 +5091,13 @@ blocks together, for example the weekly agenda, the global TODO list and a number of special tags matches. @xref{Custom agenda views}. -@node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda views +@node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views @section The built-in agenda views In this section we describe the built-in views. @menu -* Weekly/Daily agenda:: The calendar page with current tasks +* Weekly/daily agenda:: The calendar page with current tasks * Global TODO list:: All unfinished action items * Matching tags and properties:: Structured information with fine-tuned search * Timeline:: Time-sorted view for single file @@ -4981,7 +5105,7 @@ * Stuck projects:: Find projects you need to review @end menu -@node Weekly/Daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views +@node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views @subsection The weekly/daily agenda @cindex agenda @cindex weekly agenda @@ -5017,10 +5141,10 @@ countries and cultures. The diary allows you to keep track of anniversaries, lunar phases, sunrise/set, recurrent appointments (weekly, monthly) and more. In this way, it is quite complementary to -Org-mode. It can be very useful to combine output from Org-mode with +Org. It can be very useful to combine output from Org with the diary. -In order to include entries from the Emacs diary into Org-mode's +In order to include entries from the Emacs diary into Org mode's agenda, you only need to customize the variable @lisp @@ -5029,7 +5153,7 @@ @noindent After that, everything will happen automatically. All diary entries including holidays, anniversaries etc will be included in the -agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and +agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and @key{RET} can be used from the agenda buffer to jump to the diary file in order to edit existing diary entries. The @kbd{i} command to insert new entries for the current date works in the agenda buffer, as @@ -5040,11 +5164,11 @@ 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 +the entries into an Org file. Org mode evaluates diary-style sexp entries, and does it faster because there is no overhead for first creating the diary display. Note that the sexp entries must start at the left margin, no white space is allowed before them. For example, -the following segment of an Org-mode file will be processed and entries +the following segment of an Org file will be processed and entries will be made in the agenda: @example @@ -5068,7 +5192,7 @@ category or matching a regular expression. See the docstring for details. -@node Global TODO list, Matching tags and properties, Weekly/Daily agenda, Built-in agenda views +@node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views @subsection The global TODO list @cindex global TODO list @cindex TODO list, global @@ -5080,7 +5204,7 @@ @kindex C-c a t @item C-c a t Show the global TODO list. This collects the TODO items from all -agenda files (@pxref{Agenda views}) into a single buffer. The buffer is in +agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in @code{agenda-mode}, so there are commands to examine and manipulate the TODO entries directly from that buffer (@pxref{Agenda commands}). @kindex C-c a T @@ -5105,14 +5229,14 @@ TODO entry with a single key press. The commands available in the TODO list are described in @ref{Agenda commands}. -@cindex sublevels, inclusion into todo list -Normally the global todo list simply shows all headlines with TODO +@cindex sublevels, inclusion into TODO list +Normally the global TODO list simply shows all headlines with TODO keywords. This list can become very long. There are two ways to keep it more compact: @itemize @minus @item Some people view a TODO item that has been @emph{scheduled} for -execution (@pxref{Time stamps}) as no longer @emph{open}. Configure the +execution (@pxref{Timestamps}) as no longer @emph{open}. Configure the variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled items from the global TODO list. @item @@ -5123,7 +5247,7 @@ @end itemize @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views -@subsection Matching Tags and Properties +@subsection Matching tags and properties @cindex matching, of tags @cindex matching, of properties @cindex tags view @@ -5144,7 +5268,7 @@ @item C-c a M Like @kbd{C-c a m}, but only select headlines that are also TODO items and force checking subitems (see variable -@code{org-tags-match-list-sublevels}). Matching specific todo keywords +@code{org-tags-match-list-sublevels}). Matching specific TODO keywords together with a tags match is also possible, see @ref{Tag searches}. @end table @@ -5156,7 +5280,7 @@ @cindex timeline, single file @cindex time-sorted view -The timeline summarizes all time-stamped items from a single Org-mode +The timeline summarizes all time-stamped items from a single Org mode file in a @emph{time-sorted view}. The main purpose of this command is to give an overview over events in a project. @@ -5177,7 +5301,7 @@ @cindex keyword search @cindex searching, for keywords -This agenda view is a general text search facility for Org-mode entries. +This agenda view is a general text search facility for Org mode entries. It is particularly useful to find notes. @table @kbd @@ -5208,7 +5332,7 @@ work, one of the ``duties'' you have is a regular review to make sure that all projects move along. A @emph{stuck} project is a project that has no defined next actions, so it will never show up in the TODO lists -Org-mode produces. During the review, you need to identify such +Org mode produces. During the review, you need to identify such projects and define next actions for them. @table @kbd @@ -5224,12 +5348,12 @@ You almost certainly will have to configure this view before it will work for you. The built-in default assumes that all your projects are level-2 headlines, and that a project is not stuck if it has at least -one entry marked with a todo keyword TODO or NEXT or NEXTACTION. - -Lets assume that you, in your own way of using Org-mode, identify -projects with a tag PROJECT, and that you use a todo keyword MAYBE to +one entry marked with a TODO keyword TODO or NEXT or NEXTACTION. + +Lets assume that you, in your own way of using Org mode, identify +projects with a tag PROJECT, and that you use a TODO keyword MAYBE to indicate a project that should not be considered yet. Lets further -assume that the todo keyword DONE marks finished projects, and that NEXT +assume that the TODO keyword DONE marks finished projects, and that NEXT 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 @@ -5245,11 +5369,11 @@ @end lisp -@node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda views +@node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views @section Presentation and sorting @cindex presentation, of agenda items -Before displaying items in an agenda view, Org-mode visually prepares +Before displaying items in an agenda view, Org mode visually prepares the items and sorts them. Each item occupies a single line. The line starts with a @emph{prefix} that contains the @emph{category} (@pxref{Categories}) of the item and other important information. You can @@ -5285,17 +5409,17 @@ @noindent If you would like to have a special CATEGORY for a single entry or a (sub)tree, give the entry a @code{:CATEGORY:} property with the location -as the value (@pxref{Properties and columns}). +as the value (@pxref{Properties and Columns}). @noindent The display in the agenda buffer looks best if the category is not longer than 10 characters. @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting -@subsection Time-of-Day Specifications +@subsection Time-of-day specifications @cindex time-of-day specification -Org-mode checks each agenda item for a time-of-day specification. The +Org mode checks each agenda item for a time-of-day specification. The time can be part of the time stamp that triggered inclusion into the agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time ranges can be specified with two time stamps, like @@ -5304,10 +5428,10 @@ In the headline of the entry itself, a time(range) may also appear as plain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agenda -integrates the Emacs diary (@pxref{Weekly/Daily agenda}), time +integrates the Emacs diary (@pxref{Weekly/daily agenda}), time specifications in diary entries are recognized as well. -For agenda display, Org-mode extracts the time and displays it in a +For agenda display, Org mode extracts the time and displays it in a standard 24 hour format as part of the prefix. The example times in the previous paragraphs would end up in the agenda like this: @@ -5367,10 +5491,12 @@ @end itemize Sorting can be customized using the variable -@code{org-agenda-sorting-strategy}. - - -@node Agenda commands, Custom agenda views, Presentation and sorting, Agenda views +@code{org-agenda-sorting-strategy}, and may also include criteria based on +the estimated effort of an entry. +@c FIXME: link!!!!!!!! + + +@node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views @section Commands in the agenda buffer @cindex commands, in agenda buffer @@ -5393,7 +5519,7 @@ @kindex p @item p Previous line (same as @key{down} and @kbd{C-n}). -@tsubheading{View/GoTo org file} +@tsubheading{View/Go to org file} @kindex mouse-3 @kindex @key{SPC} @item mouse-3 @@ -5427,16 +5553,24 @@ @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. +Display the entire subtree of the current item in an indirect buffer. With a +numeric prefix argument N, go up to level N and then take that tree. If N is +negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the +previously used indirect buffer. @c @kindex l @item l Toggle Logbook mode. In Logbook mode, entries that where marked DONE while logging was on (variable @code{org-log-done}) are shown in the agenda, as are entries that have been clocked on that day. +@c +@kindex R +@item R +Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will +always show a table with the clocked times for the timespan and file scope +covered by the current agenda view. The initial setting for this mode in new +agenda buffers can be set with the variable +@code{org-agenda-start-with-clockreport-mode}. @tsubheading{Change display} @cindex display changing, in agenda @@ -5450,12 +5584,19 @@ @kindex y @item d w m y Switch to day/week/month/year view. When switching to day or week view, -this setting becomes the default for subseqent agenda commands. Since -month and year views are slow to create, the do not become the default. +this setting becomes the default for subsequent agenda commands. Since +month and year views are slow to create, they do not become the default. +A numeric prefix argument may be used to jump directly to a specific day +of the year, ISO week, month, or year, respectively. For example, +@kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When +setting day, week, or month view, a year may be encoded in the prefix +argument as well. For example, @kbd{200712 w} will jump to week 12 in +2007. If such a year specification has only one or two digits, it will +be mapped to the interval 1938-2037. @c @kindex D @item D -Toggle the inclusion of diary entries. See @ref{Weekly/Daily agenda}. +Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. @c @kindex G @item G @@ -5466,7 +5607,7 @@ @item r Recreate the agenda buffer, for example to reflect the changes after modification of the time stamps of items with S-@key{left} and -S-@key{right}. When the buffer is the global todo list, a prefix +S-@key{right}. When the buffer is the global TODO list, a prefix argument is interpreted to create a selective list for a specific TODO keyword. @kindex g @@ -5477,7 +5618,7 @@ @kindex C-x C-s @item s @itemx C-x C-s -Save all Org-mode buffers in the current Emacs session. +Save all Org buffers in the current Emacs session. @c @kindex @key{right} @item @key{right} @@ -5491,7 +5632,16 @@ @c @kindex . @item . -Goto today. +Go to today. +@c +@kindex C-c C-x C-c +@item C-c C-x C-c +Invoke column view (@pxref{Column view}) in the agenda buffer. The column +view format is taken from the entry at point, or (if there is no entry at +point), from the first entry in the agenda view. So whatever the format for +that entry would be in the original buffer (taken from a property, from a +@code{#+COLUMNS} line, or from the default variable +@code{org-columns-default-format}), will be used in the agenda. @tsubheading{Query editing} @cindex query editing, in agenda @@ -5531,13 +5681,24 @@ @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 +to it in the original Org file. If the text to be deleted remotely is longer than one line, the kill needs to be confirmed by the user. See variable @code{org-agenda-confirm-kill}. @c +@kindex a +@item a +Toggle the ARCHIVE tag for the current headline. +@c +@kindex A +@item A +Move the subtree correspoding to the current entry to its @emph{Archive +Sibling}. +@c @kindex $ @item $ -Archive the subtree corresponding to the current headline. +Archive the subtree corresponding to the current headline. This means the +entry will be moved to the configured archive locatin, most likely a +different file. @c @kindex T @item T @@ -5549,13 +5710,9 @@ Set tags for the current headline. If there is an active region in the agenda, change a tag for all headings in the region. @c -@kindex 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 +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 @@ -5587,12 +5744,11 @@ @c @kindex S-@key{right} @item S-@key{right} -Change the time stamp associated with the current line by one day into -the future. With prefix argument, change it by that many days. For -example, @kbd{3 6 5 S-@key{right}} will change it by a year. The -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. +Change the time stamp associated with the current line by one day into the +future. With a numeric prefix argument, change it by that many days. For +example, @kbd{3 6 5 S-@key{right}} will change it by a year. The 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} @@ -5629,7 +5785,7 @@ 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 +When in the calendar, compute and show the Org mode agenda for the date at the cursor. @c @cindex diary entries, creating from agenda @@ -5657,11 +5813,10 @@ @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 + +@item M-x org-export-icalendar-combine-agenda-files Export a single iCalendar file containing entries from all agenda files. +This is a globally available command, and also available in the agenda menu. @tsubheading{Exporting to a file} @kindex C-x C-w @@ -5689,7 +5844,7 @@ @end table -@node Custom agenda views, , Agenda commands, Agenda views +@node Custom agenda views, Agenda column view, Agenda commands, Agenda Views @section Custom agenda views @cindex custom agenda views @cindex agenda views, custom @@ -5703,8 +5858,8 @@ * Storing searches:: Type once, use often * Block agenda:: All the stuff you need in a single buffer * Setting Options:: Changing the rules -* Exporting Agenda Views:: Writing agendas to files. -* Extracting Agenda Information for other programs:: +* Exporting Agenda Views:: Writing agendas to files +* Using the agenda elsewhere:: Using agenda information in other programs @end menu @node Storing searches, Block agenda, Custom agenda views, Custom agenda views @@ -5783,7 +5938,7 @@ the results of @emph{several} commands, each of which creates a block in the agenda buffer. The available commands include @code{agenda} for the daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo} -for the global todo list (as constructed with @kbd{C-c a t}), and the +for the global TODO list (as constructed with @kbd{C-c a t}), and the matching commands discussed above: @code{todo}, @code{tags}, and @code{tags-todo}. Here are two examples: @@ -5809,10 +5964,10 @@ command @kbd{C-c a o} provides a similar view for office tasks. @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views -@subsection Setting Options for custom commands +@subsection Setting options for custom commands @cindex options, for custom agenda views -Org-mode contains a number of variables regulating agenda construction +Org mode contains a number of variables regulating agenda construction and display. The global variables define the behavior for all agenda commands, including the custom commands. However, if you want to change some settings just for a single custom view, you can do so. Setting @@ -5878,12 +6033,12 @@ yourself. -@node Exporting Agenda Views, Extracting Agenda Information for other programs, Setting Options, Custom agenda views +@node Exporting Agenda Views, Using the agenda elsewhere, 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 +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}.} postscript, and iCalendar files. If you want to do this only occasionally, use the command @@ -5941,7 +6096,7 @@ @end lisp The extension of the file name determines the type of export. If it is -@file{.html}, Org-mode will use the @file{htmlize.el} package to convert +@file{.html}, Org mode will use the @file{htmlize.el} package to convert the buffer to HTML and save it to this file name. If the extension is @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce postscript output. If the extension is @file{.ics}, iCalendar export is @@ -6006,12 +6161,12 @@ @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 +@node Using the agenda elsewhere, , Exporting Agenda Views, Custom agenda views +@subsection Using agenda information outside of Org @cindex agenda, pipe @cindex Scripts, for agenda processing -Org-mode provides commands to access agenda information for the command +Org 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 @@ -6072,7 +6227,7 @@ 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} +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} @@ -6087,7 +6242,7 @@ 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: +Emacs/Org and prints all the items, preceded by a checkbox: @example @group @@ -6112,35 +6267,88 @@ @end group @end example -@node Embedded LaTeX, Exporting, Agenda views, Top +@node Agenda column view, , Custom agenda views, Agenda Views +@section Using column view in the agenda +@cindex column view, in agenda +@cindex agenda, column view + +Column view (@pxref{Column view}) is normally used to view and edit +properties embedded in the hierarchical structure of an Org file. It can be +quite useful to use column view also from the agenda, where entries are +collected by certain criteria. + +@table @kbd +@kindex C-c C-x C-c +@item C-c C-x C-c +Turn on column view in the agenda. +@end table + +To understand how to use this properly, it is important to realize that the +entries in the agenda are no longer in their proper outline environment. +This causes the following issues: + +@enumerate +@item +Org needs to make a decision which @code{COLUMNS} format to use. Since the +entries in the agenda are collected from different files, and different files +may have different @code{COLUMNS} formats, this is a non-trivial problem. +Org first checks if the variable @code{org-overriding-columns-format} is +currently set, and if yes takes the format from there. Otherwise it takes +the format associated with the first item in the agenda, or, if that item +does not have a specific format (defined in a property, or in it's file), it +uses @code{org-columns-default-format}. +@item +If any of the columns has a summary type defined (@pxref{Column attributes}), +turning on column view in the agenda will visit all relevant agenda files and +make sure that the computations of this property are up to date. This is +also true for the special @code{CLOCKSUM} property. Org will then sum the +values displayed in the agenda. In the daily/weekly agenda, the sums will +cover a single day, in all other views they cover the entire block. It is +vital to realize that the agenda may show the same entry @emph{twice} (for +example as scheduled and as a deadline), and it may show two entries from the +same hierarchy (for example a @emph{parent} and it's @emph{child}). In these +cases, the summation in the agenda will lead to incorrect results because +some values will count double. +@item +When the column view in the agenda shows the @code{CLOCKSUM}, that is always +the entire clocked time for this item. So even in the daily/weekly agenda, +the clocksum listed in column view may originate from times outside the +current view. This has the advantage that you can compare these values with +a column listing the planned total effort for a task - one of the major +applications for column view in the agenda. If you want information about +clocked time in the displayed period use clock table mode (press @kbd{R} in +the agenda). +@end enumerate + + +@node Embedded LaTeX, Exporting, Agenda Views, Top @chapter Embedded LaTeX @cindex @TeX{} interpretation @cindex La@TeX{} interpretation Plain ASCII is normally sufficient for almost all note taking. One -exception, however, are scientific notes which need to be able to -contain mathematical symbols and the occasional formula. -La@TeX{}@footnote{La@TeX{} is a macro system based on Donald E. Knuth's -@TeX{} system. Many of the features described here as ``La@TeX{}'' are -really from @TeX{}, but for simplicity I am blurring this distinction.} -is widely used to typeset scientific documents. Org-mode supports -embedding La@TeX{} code into its files, because many academics are used -to read La@TeX{} source code, and because it can be readily processed -into images for HTML production. +exception, however, are scientific notes which need to be able to contain +mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{} +is a macro system based on Donald E. Knuth's @TeX{} system. Many of the +features described here as ``La@TeX{}'' are really from @TeX{}, but for +simplicity I am blurring this distinction.} is widely used to typeset +scientific documents. Org mode supports embedding La@TeX{} code into its +files, because many academics are used to reading La@TeX{} source code, and +because it can be readily processed into images for HTML production. It is not necessary to mark La@TeX{} macros and code in any special way. -If you observe a few conventions, Org-mode knows how to find it and what +If you observe a few conventions, Org mode knows how to find it and what to do with it. @menu * Math symbols:: TeX macros for symbols and Greek letters -* Subscripts and Superscripts:: Simple syntax for raising/lowering text +* Subscripts and superscripts:: Simple syntax for raising/lowering text * LaTeX fragments:: Complex formulas made easy * Processing LaTeX fragments:: Previewing LaTeX processing * CDLaTeX mode:: Speed up entering of formulas @end menu -@node Math symbols, Subscripts and Superscripts, Embedded LaTeX, Embedded LaTeX +@node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX @section Math symbols @cindex math symbols @cindex TeX macros @@ -6149,7 +6357,7 @@ to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion for these macros is available, just type @samp{\} and maybe a few letters, and press @kbd{M-@key{TAB}} to see possible completions. -Unlike La@TeX{} code, Org-mode allows these macros to be present +Unlike La@TeX{} code, Org mode allows these macros to be present without surrounding math delimiters, for example: @example @@ -6160,8 +6368,8 @@ into the proper syntax for HTML, for the above examples this is @samp{α} and @samp{→}, respectively. -@node Subscripts and Superscripts, LaTeX fragments, Math symbols, Embedded LaTeX -@section Subscripts and Superscripts +@node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX +@section Subscripts and superscripts @cindex subscript @cindex superscript @@ -6182,7 +6390,7 @@ During HTML export (@pxref{HTML export}), subscript and superscripts are surrounded with @code{<sub>} and @code{<sup>} tags, respectively. -@node LaTeX fragments, Processing LaTeX fragments, Subscripts and Superscripts, Embedded LaTeX +@node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX @section LaTeX fragments @cindex LaTeX fragments @@ -6192,7 +6400,7 @@ is no decent converter for turning La@TeX{} or ASCII representations of formulas into MathML. So for the time being, converting formulas into images seems the way to go.}. More complex expressions need a dedicated -formula processor. To this end, Org-mode can contain arbitrary La@TeX{} +formula processor. To this end, Org mode can contain arbitrary La@TeX{} fragments. It provides commands to preview the typeset result of these fragments, and upon export to HTML, all fragments will be converted to images and inlined into the HTML document@footnote{The La@TeX{} export @@ -6270,23 +6478,23 @@ @section Using CDLaTeX to enter math @cindex CDLaTeX -CDLaTeX-mode is a minor mode that is normally used in combination with a +CDLaTeX mode is a minor mode that is normally used in combination with a major La@TeX{} mode like AUCTeX in order to speed-up insertion of -environments and math templates. Inside Org-mode, you can make use of -some of the features of cdlatex-mode. You need to install +environments and math templates. Inside Org mode, you can make use of +some of the features of CDLaTeX mode. You need to install @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}. -Don't turn cdlatex-mode itself under Org-mode, but use the light -version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it +Don't use CDLaTeX mode itself under Org mode, but use the light +version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it on for the current buffer with @code{M-x org-cdlatex-mode}, or for all -Org-mode files with +Org files with @lisp (add-hook 'org-mode-hook 'turn-on-org-cdlatex) @end lisp When this mode is enabled, the following features are present (for more -details see the documentation of cdlatex-mode): +details see the documentation of CDLaTeX mode): @itemize @bullet @kindex C-c @{ @item @@ -6294,7 +6502,7 @@ @item @kindex @key{TAB} The @key{TAB} key will do template expansion if the cursor is inside a -La@TeX{} fragment@footnote{Org-mode has a method to test if the cursor is +La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is inside such a fragment, see the documentation of the function @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor @@ -6330,18 +6538,18 @@ @chapter Exporting @cindex exporting -Org-mode documents can be exported into a variety of other formats. For +Org mode documents can be exported into a variety of other formats. For printing and sharing of notes, ASCII export produces a readable and -simple version of an Org-mode file. HTML export allows you to publish a +simple version of an Org file. HTML export allows you to publish a notes file on the web, while the XOXO format provides a solid base for exchange with a broad range of other applications. La@TeX{} export lets -you use Org-mode and its structured editing functions to easily create +you use Org mode and its structured editing functions to easily create La@TeX{} files. To incorporate entries with associated times like deadlines or appointments into a desktop calendar program like iCal, -Org-mode can also produce extracts in the iCalendar format. Currently -Org-mode only supports export, not import of these different formats. - -When exporting, Org-mode uses special conventions to enrich the output +Org mode can also produce extracts in the iCalendar format. Currently +Org mode only supports export, not import of these different formats. + +When exporting, Org mode uses special conventions to enrich the output produced. @xref{Text interpretation}, for more details. @table @kbd @@ -6349,7 +6557,15 @@ @item C-c C-e Dispatcher for export and publishing commands. Displays a help-window listing the additional key(s) needed to launch an export or publishing -command. +command. The prefix arg is passed through to the exporter. If the option +@code{org-export-run-in-background} is set, Org will run the command in the +background if that seems useful for the specific command (i.e. commands that +write to a file). +@kindex C-u C-u C-c C-e +@item C-u C-u C-c C-e +Call an the exporter, but reverse the setting of +@code{org-export-run-in-background}, i.e. request background processing if +not set, or force processing in the current Emacs process if st. @end table @menu @@ -6365,12 +6581,12 @@ @section ASCII export @cindex ASCII export -ASCII export produces a simple and very readable version of an Org-mode +ASCII export produces a simple and very readable version of an Org mode file. @cindex region, active @cindex active region -@cindex transient-mark-mode +@cindex Transient mark mode @table @kbd @kindex C-c C-e a @item C-c C-e a @@ -6400,7 +6616,7 @@ creates only top level headlines and does the rest as items. When headlines are converted to items, the indentation of the text following the headline is changed to fit nicely under the item. This is done with -the assumption that the first bodyline indicates the base indentation of +the assumption that the first body line indicates the base indentation of the body text. Any indentation larger than this is adjusted to preserve the layout relative to the first line. Should there be lines with less indentation than the first, these are left alone. @@ -6409,16 +6625,17 @@ @section HTML export @cindex HTML export -Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive +Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive HTML formatting, in ways similar to John Grubers @emph{markdown} language, but with additional support for tables. @menu * HTML Export commands:: How to invoke LaTeX export -* Quoting HTML tags:: Using direct HTML in Org-mode +* Quoting HTML tags:: Using direct HTML in Org mode * Links:: Transformation of links for HTML * Images:: How to include images -* CSS support:: Changing the appearence of the output +* CSS support:: Changing the appearance of the output +* Javascript support:: Info and Folding in a web browser @end menu @node HTML Export commands, Quoting HTML tags, HTML export, HTML export @@ -6426,7 +6643,7 @@ @cindex region, active @cindex active region -@cindex transient-mark-mode +@cindex Transient mark mode @table @kbd @kindex C-c C-e h @item C-c C-e h @@ -6445,9 +6662,9 @@ Export to a temporary buffer, do not create a file. @kindex C-c C-e R @item C-c C-e R -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. +Export the active region to a temporary buffer. With a prefix argument, do +not produce the file header and footer, but just the plain HTML section for +the region. This is good for cut-and-paste operations. @kindex C-c C-e v h @kindex C-c C-e v b @kindex C-c C-e v H @@ -6458,19 +6675,19 @@ @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 +Convert the region to HTML under the assumption that it was Org mode syntax before. This is a global command that can be invoked in any buffer. @item M-x org-replace-region-by-HTML -Replace the active region (assumed to be in Org-mode syntax) by HTML +Replace the active region (assumed to be in Org mode syntax) by HTML code. @end table @cindex headline levels, for exporting -In the exported version, the first 3 outline levels will become -headlines, defining a general document structure. Additional levels -will be exported as itemized lists. If you want that transition to occur -at a different level, specify it with a prefix argument. For example, +In the exported version, the first 3 outline levels will become headlines, +defining a general document structure. Additional levels will be exported as +itemized lists. If you want that transition to occur at a different level, +specify it with a numeric prefix argument. For example, @example @kbd{C-2 C-c C-e b} @@ -6512,7 +6729,7 @@ files only if they match a dedicated @samp{<<target>>}. Automatic links created by radio targets (@pxref{Radio targets}) will also work in the HTML file. Links to external files will still work if the HTML file is -in the same directory as the Org-mode file. Links to other @file{.org} +in the same directory as the Org file. Links to other @file{.org} files will be translated into HTML links under the assumption that an HTML version also exists of the linked file. For information related to linking files while publishing them to a publishing directory see @@ -6523,7 +6740,7 @@ @cindex images, inline in HTML @cindex inlining images in HTML -HTML export can inline images given as links in the Org-mode file, and +HTML export can inline images given as links in the Org file, and it can make an image the clickable part of a link. By default@footnote{but see the variable @code{org-export-html-inline-images}}, images are inlined if a link does @@ -6542,8 +6759,10 @@ @noindent and you could use @code{http} addresses just as well. -@node CSS support, , Images, HTML export +@node CSS support, Javascript support, Images, HTML export @subsection CSS support +@cindex CSS, for HTML export +@cindex HTML export, CSS You can also give style information for the exported file. The HTML exporter assigns the following CSS classes to appropriate parts of the @@ -6576,23 +6795,83 @@ @end example Remember to execute @kbd{M-x normal-mode} after changing this to make -the new style visible to Emacs. This command restarts org-mode for the +the new style visible to Emacs. This command restarts Org mode for the current buffer and forces Emacs to re-evaluate the local variables section in the buffer. @c FIXME: More about header and footer styles @c FIXME: Talk about links and targets. +@node Javascript support, , CSS support, HTML export +@subsection Javascript supported display of web pages + +@emph{Sebastian Rose} has written a JavaScript program especially designed to +enhance the web viewing experience of HTML files created with Org. This +program allows to view large files in two different ways. The first one is +an @emph{Info}-like mode where each section is displayed separately and +navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys +as well, press @kbd{?} for an overview of the available keys). The second +view type is a @emph{folding} view much like Org provides it inside Emacs. +The script is available at @url{http://orgmode.org/org-info.js} and you can +find the documentation for it at @url{http://orgmode.org/org-infojs.html}. +We are serving the script from our site, but if you use it a lot, you might +not want to be dependent on @url{orgmode.org} and prefer to install a local +copy on your own web server. + +To use the script, you need to make sure that the @file{org-infojs.el} module +gets loaded. It should be loaded by default, try @kbd{M-x customize-variable +@key{RET} org-modules @key{RET}} to convince yourself that this is indeed the +case. All it then takes to make use of the program is adding a single line +to the Org file: + +@example +#+INFOSJ_OPT: view:info toc:nil +@end example + +@noindent +If this line is found, the HTML header will automatically contain the code +needed to invoke the script. Using the line above, you can set the following +viewing options: + +@example +path: @r{The path to the script. The default is to grab the script from} + @r{@url{http://orgmode.org/org-info.js}, but you might want to have} + @r{a local copy and use a path like @samp{../scripts/org-info.js}.} +view: @r{Initial view when website is first shown. Possible values are} + info @r{Info-like interface with one section per page.} + overview @r{Folding interface, initially showing only top-level.} + content @r{Folding interface, starting with all headlines visible.} + showall @r{Folding interface, all headlines and text visible.} +sdepth: @r{Maximum headline level that will still become an independent} + @r{section for info and folding modes. The default is taken from} + @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).} + @r{If this is smaller than in @code{org-headline-levels}, each} + @r{info/folding section can still contain children headlines.} +toc: @r{Should the table of content @emph{initially} be visible?} + @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.} +tdepth: @r{The depth of the table of contents. The defaults are taken from} + @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.} +ltoc: @r{Should there be short contents (children) in each section?} +mouse: @r{Headings are highlighted when the mouse is over them. Should be} + @r{@samp{underline} (default) or a background color like @samp{#cccccc}.} +buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the} + @r{default), only one such button will be present.} +@end example + +You can choose default values for these options by customizing the variable +@code{org-infojs-options}. If you always want to apply the script to your +pages, configure the variable @code{org-export-html-use-infojs}. + @node LaTeX export, XOXO export, HTML export, Exporting @section LaTeX export @cindex LaTeX export -Org-mode contains a La@TeX{} exporter written by Bastien Guerry. +Org mode contains a La@TeX{} exporter written by Bastien Guerry. @menu * LaTeX export commands:: How to invoke LaTeX export * Quoting LaTeX code:: Incorporating literal LaTeX code -* Sectioning structure:: +* Sectioning structure:: Changing sectioning in LaTeX output @end menu @node LaTeX export commands, Quoting LaTeX code, LaTeX export, LaTeX export @@ -6611,11 +6890,11 @@ @item C-c C-e v L Export only the visible part of the document. @item M-x org-export-region-as-latex -Convert the region to La@TeX{} under the assumption that it was org-mode +Convert the region to La@TeX{} under the assumption that it was Org mode syntax before. This is a global command that can be invoked in any buffer. @item M-x org-replace-region-by-latex -Replace the active region (assumed to be in Org-mode syntax) by La@TeX{} +Replace the active region (assumed to be in Org mode syntax) by La@TeX{} code. @end table @@ -6627,7 +6906,7 @@ @code{org-latex-low-levels}. If you want that transition to occur at a different level, specify it -with a prefix argument. For example, +with a numeric prefix argument. For example, @example @kbd{C-2 C-c C-e l} @@ -6640,7 +6919,7 @@ @subsection Quoting LaTeX code Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly -inserted into the La@TeX{} file. Forthermore, you can add special code +inserted into the La@TeX{} file. Furthermore, you can add special code that should only be present in La@TeX{} export with the following constructs: @@ -6676,9 +6955,9 @@ @section XOXO export @cindex XOXO export -Org-mode contains an exporter that produces XOXO-style output. +Org mode contains an exporter that produces XOXO-style output. Currently, this exporter only handles the general outline structure and -does not interpret any additional Org-mode features. +does not interpret any additional Org mode features. @table @kbd @kindex C-c C-e x @@ -6693,11 +6972,11 @@ @section iCalendar export @cindex iCalendar export -Some people like to use Org-mode for keeping track of projects, but +Some people like to use Org mode for keeping track of projects, but still prefer a standard calendar application for anniversaries and appointments. In this case it can be useful to have deadlines and -other time-stamped items in Org-mode files show up in the calendar -application. Org-mode can export calendar information in the standard +other time-stamped items in Org files show up in the calendar +application. Org mode can export calendar information in the standard iCalendar format. If you also want to have TODO entries included in the export, configure the variable @code{org-icalendar-include-todo}. @@ -6730,14 +7009,14 @@ @node Text interpretation, , iCalendar export, Exporting @section Text interpretation by the exporter -The exporter backends interpret additional structure in the Org-mode file +The exporter backends interpret additional structure in the Org file in order to produce better output. @menu * Comment lines:: Some lines will not be exported * Initial text:: Text before the first headline * Footnotes:: Numbers like [1] -* Quoted examples:: Inserting quoted chnuks of text +* Quoted examples:: Inserting quoted chunks of text * Enhancing text:: Subscripts, symbols and more * Export options:: How to influence the export settings @end menu @@ -6760,7 +7039,7 @@ @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 +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 @@ -6804,7 +7083,7 @@ the Emacs package @file{footnote.el} to create footnotes. For example: @example -The org-mode homepage[1] clearly needs help from +The Org homepage[1] clearly needs help from a good web designer. [1] The link is: http://orgmode.org @@ -6813,12 +7092,12 @@ @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 +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. +the settings in Org. @node Quoted examples, Enhancing text, Footnotes, Text interpretation @subsection Quoted examples @@ -6828,7 +7107,7 @@ @cindex fixed width text When writing technical documents, you often need to insert examples that -are not further interpreted by Org-mode. For historical reasons, there +are not further interpreted by Org mode. For historical reasons, there are several ways to do this: @itemize @bullet @@ -6859,9 +7138,9 @@ @cindex enhancing text @cindex richer text -Some of the export backends of Org-mode allow for sophisticated text +Some of the export backends of Org mode allow for sophisticated text formatting, this is true in particular for the HTML and La@TeX{} -backends. Org-mode has a number of typing conventions that allow to +backends. Org mode has a number of typing conventions that allow to produce a richly formatted output. @itemize @bullet @@ -6880,7 +7159,7 @@ @item You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=} and @code{~verbatim~}, and, if you must, @samp{+strikethrough+}. Text -in the code and verbatim string is not processed for org-mode specific +in the code and verbatim string is not processed for Org mode specific syntax, it is exported verbatim. @cindex horizontal rules, in exported files @@ -7018,14 +7297,14 @@ @chapter Publishing @cindex publishing -Org-mode includes@footnote{@file{org-publish.el} is not distributed with +Org includes@footnote{@file{org-publish.el} is not distributed with Emacs 21, if you are still using Emacs 21, you need you need to download this file separately.} a publishing management system that allows you to configure automatic HTML conversion of @emph{projects} composed of interlinked org files. This system is called @emph{org-publish}. You can also configure org-publish to automatically upload your exported HTML pages and related attachments, such as images and source code files, to -a web server. Org-publish turns org-mode into a web-site authoring tool. +a web server. Org-publish turns Org into a web-site authoring tool. You can also use Org-publish to convert files into La@TeX{}, or even combine HTML and La@TeX{} conversion so that files are available in both @@ -7033,7 +7312,7 @@ that helpful, you surely want to perform further conversion on them -- e.g. convert them to @code{PDF} format.}. -Org-publish has been contributed to Org-mode by David O'Toole. +Org-publish has been contributed to Org by David O'Toole. @menu * Configuration:: Defining projects @@ -7127,17 +7406,17 @@ @end multitable @node Publishing action, Publishing options, Selecting files, Configuration -@subsection Publishing Action +@subsection Publishing action @cindex action, for publishing Publishing means that a file is copied to the destination directory and possibly transformed in the process. The default transformation is to -export Org-mode files as HTML files, and this is done by the function +export Org files as HTML files, and this is done by the function @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML export}). But you also can publish your files in La@TeX{} by using the function @code{org-publish-org-to-latex} instead. Other files like images only need to be copied to the publishing destination. For -non-Org-mode files, you need to specify the publishing function. +non-Org files, you need to specify the publishing function. @multitable @columnfractions 0.3 0.7 @@ -7160,7 +7439,7 @@ The property list can be used to set many export options for the HTML and La@TeX{} exporters. In most cases, these properties correspond to user -variables in Org-mode. The table below lists these properties along +variables in Org. The table below lists these properties along with the variable they belong to. See the documentation string for the respective variable for details. @@ -7210,7 +7489,7 @@ @subsection Links between published files @cindex links, publishing -To create a link from one Org-mode file to another, you would use +To create a link from one Org file to another, you would use something like @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link becomes a link to @file{foo.html}. In this way, you can interlink the @@ -7222,7 +7501,7 @@ @code{org-publish} to upload the related files, these links will work too. @ref{Complex example} for an example of this usage. -Sometime an Org-mode file to be published may contain links that are +Sometime an Org file to be published may contain links that are only valid in your production environment, but not in the publishing location. In this case, use the property @@ -7260,7 +7539,7 @@ @tab Title of index page. Defaults to name of file. @item @code{:index-function} -@tab Plugin function to use for generation of index. +@tab Plug-in function to use for generation of index. Defaults to @code{org-publish-org-index}, which generates a plain list of links to all files in the project. @end multitable @@ -7269,7 +7548,7 @@ @section Sample configuration Below we provide two example configurations. The first one is a simple -project publishing only a set of Org-mode files. The second example is +project publishing only a set of Org files. The second example is more complex, with a multi-component project. @menu @@ -7280,7 +7559,7 @@ @node Simple example, Complex example, Sample configuration, Sample configuration @subsection Example: simple publishing configuration -This example publishes a set of Org-mode files to the @file{public_html} +This example publishes a set of Org files to the @file{public_html} directory on the local machine. @lisp @@ -7300,7 +7579,7 @@ This more complicated example publishes an entire website, including org files converted to HTML, image files, emacs lisp source code, and -stylesheets. The publishing-directory is remote and private files are +style sheets. The publishing-directory is remote and private files are excluded. To ensure that links are preserved, care should be taken to replicate @@ -7314,7 +7593,7 @@ @c On the web server, the relative path to the image should be the same. You can accomplish this by setting up an "images" folder in the -right place on the webserver, and publishing images to it. +right place on the web server, and publishing images to it. @lisp (setq org-publish-project-alist @@ -7372,11 +7651,11 @@ @menu * Completion:: M-TAB knows what you need -* Customization:: Adapting Org-mode to your taste +* Customization:: Adapting Org to your taste * In-buffer settings:: Overview of the #+KEYWORDS * The very busy C-c C-c key:: When in doubt, press C-c C-c * Clean view:: Getting rid of leading stars in the outline -* TTY keys:: Using Org-mode on a tty +* TTY keys:: Using Org on a tty * Interaction:: Other Emacs packages * Bugs:: Things which do not work perfectly @end menu @@ -7397,7 +7676,7 @@ @cindex tag completion @cindex link abbreviations, completion of -Org-mode supports in-buffer completion. This type of completion does +Org supports in-buffer completion. This type of completion does not make use of the minibuffer. You simply type a few letters into the buffer and use the key to complete text right there. @@ -7426,14 +7705,14 @@ After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}). @item After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or -@samp{OPTIONS} which set file-specific options for Org-mode. When the +@samp{OPTIONS} which set file-specific options for Org mode. When the option keyword is already complete, pressing @kbd{M-@key{TAB}} again will insert example settings for this keyword. @item In the line after @samp{#+STARTUP: }, complete startup keywords, i.e. valid keys for this line. @item -Elsewhere, complete dictionary words using ispell. +Elsewhere, complete dictionary words using Ispell. @end itemize @end table @@ -7444,7 +7723,7 @@ @cindex variables, for customization There are more than 180 variables that can be used to customize -Org-mode. For the sake of compactness of the manual, I am not +Org. For the sake of compactness of the manual, I am not describing the variables here. A structured overview of customization variables is available with @kbd{M-x org-customize}. Or select @code{Browse Org Group} from the @code{Org->Customization} menu. Many @@ -7456,7 +7735,7 @@ @cindex in-buffer settings @cindex special keywords -Org-mode uses special lines in the buffer to define settings on a +Org mode uses special lines in the buffer to define settings on a per-file basis. These lines start with a @samp{#+} followed by a keyword, a colon, and then individual words defining a setting. Several setting words can be in the same line, but you can also have multiple @@ -7500,8 +7779,8 @@ This line sets a default inheritance value for entries in the current buffer, most useful for specifying the allowed values of a property. @item #+STARTUP: -This line sets options to be used at startup of Org-mode, when an -Org-mode file is being visited. The first set of options deals with the +This line sets options to be used at startup of Org mode, when an +Org file is being visited. The first set of options deals with the initial visibility of the outline tree. The corresponding variable for global default settings is @code{org-startup-folded}, with a default value @code{t}, which means @code{overview}. @@ -7593,10 +7872,10 @@ @kindex C-c C-c @cindex C-c C-c, overview -The key @kbd{C-c C-c} has many purposes in org-mode, which are all +The key @kbd{C-c C-c} has many purposes in Org, which are all mentioned scattered throughout this manual. One specific function of this key is to add @emph{tags} to a headline (@pxref{Tags}). In many -other circumstances it means something like @emph{Hey Org-mode, look +other circumstances it means something like @emph{Hey Org, look here and update according to what you see here}. Here is a summary of what this means in different contexts. @@ -7643,7 +7922,7 @@ @cindex hiding leading stars @cindex clean outline view -Some people find it noisy and distracting that the Org-mode headlines +Some people find it noisy and distracting that the Org headlines are starting with a potentially large number of stars. For example the tree from @ref{Headlines}: @@ -7658,7 +7937,7 @@ @end example @noindent -Unfortunately this is deeply ingrained into the code of Org-mode and +Unfortunately this is deeply ingrained into the code of Org and cannot be easily changed. You can, however, modify the display in such a way that all leading stars become invisible and the outline more easy to read. To do this, customize the variable @@ -7734,17 +8013,17 @@ #+STARTUP: oddeven @end example -You can convert an Org-mode file from single-star-per-level to the +You can convert an Org file from single-star-per-level to the double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels RET} in that file. The reverse operation is @kbd{M-x org-convert-to-oddeven-levels}. @node TTY keys, Interaction, Clean view, Miscellaneous -@section Using org-mode on a tty -@cindex tty keybindings - -Because Org-mode contains a large number of commands, by default much of -Org-mode's core commands are bound to keys that are generally not +@section Using Org on a tty +@cindex tty key bindings + +Because Org contains a large number of commands, by default much of +Org's core commands are bound to keys that are generally not accessible on a tty, such as the cursor keys (@key{left}, @key{right}, @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used together with modifiers like @key{Meta} and/or @key{Shift}. To access @@ -7780,28 +8059,28 @@ @node Interaction, Bugs, TTY keys, Miscellaneous @section Interaction with other packages @cindex packages, interaction with other -Org-mode lives in the world of GNU Emacs and interacts in various ways +Org lives in the world of GNU Emacs and interacts in various ways with other code out there. @menu -* Cooperation:: Packages Org-mode cooperates with +* Cooperation:: Packages Org cooperates with * Conflicts:: Packages that lead to conflicts @end menu @node Cooperation, Conflicts, Interaction, Interaction -@subsection Packages that Org-mode cooperates with +@subsection Packages that Org cooperates with @table @asis @cindex @file{calc.el} @item @file{calc.el} by Dave Gillespie -Org-mode uses the calc package for implementing spreadsheet -functionality in its tables (@pxref{The spreadsheet}). Org-mode -checks for the availability of calc by looking for the function -@code{calc-eval} which should be autoloaded in your setup if calc has -been installed properly. As of Emacs 22, calc is part of the Emacs +Org uses the Calc package for implementing spreadsheet +functionality in its tables (@pxref{The spreadsheet}). Org +checks for the availability of Calc by looking for the function +@code{calc-eval} which should be autoloaded in your setup if Calc has +been installed properly. As of Emacs 22, Calc is part of the Emacs distribution. Another possibility for interaction between the two -packages is using calc for embedded calculations. @xref{Embedded Mode, -, Embedded Mode, calc, GNU Emacs Calc Manual}. +packages is using Calc for embedded calculations. @xref{Embedded Mode, +, Embedded Mode, Calc, GNU Emacs Calc Manual}. @cindex @file{constants.el} @item @file{constants.el} by Carsten Dominik In a table formula (@pxref{The spreadsheet}), it is possible to use @@ -7810,35 +8089,35 @@ the @file{constants} package which defines a large number of constants and units, and lets you use unit prefixes like @samp{M} for @samp{Mega} etc. You will need version 2.0 of this package, available -at @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks for +at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for the function @code{constants-get}, which has to be autoloaded in your setup. See the installation instructions in the file @file{constants.el}. @item @file{cdlatex.el} by Carsten Dominik @cindex @file{cdlatex.el} -Org-mode can make use of the cdlatex package to efficiently enter -La@TeX{} fragments into Org-mode files. See @ref{CDLaTeX mode}. +Org mode can make use of the CDLaTeX package to efficiently enter +La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg @cindex @file{imenu.el} -Imenu allows menu access to an index of items in a file. Org-mode -supports imenu - all you need to do to get the index is the following: +Imenu allows menu access to an index of items in a file. Org mode +supports Imenu - all you need to do to get the index is the following: @lisp (add-hook 'org-mode-hook - (lambda () 'imenu-add-to-menubar "Imenu")) + (lambda () (imenu-add-to-menubar "Imenu"))) @end lisp By default the index is two levels deep - you can modify the depth using the option @code{org-imenu-depth}. @item @file{remember.el} by John Wiegley @cindex @file{remember.el} -Org mode cooperates with remember, see @ref{Remember}. +Org cooperates with remember, see @ref{Remember}. @file{Remember.el} is not part of Emacs, find it on the web. @item @file{speedbar.el} by Eric M. Ludlam @cindex @file{speedbar.el} Speedbar is a package that creates a special frame displaying files and -index items in files. Org-mode supports speedbar and allows you to -drill into Org-mode files directly from the speedbar. It also allows to +index items in files. Org mode supports Speedbar and allows you to +drill into Org files directly from the Speedbar. It also allows to restrict the scope of agenda commands to a file or a subtree by using -the command @kbd{<} in the speedbar frame. +the command @kbd{<} in the Speedbar frame. @cindex @file{table.el} @item @file{table.el} by Takaaki Ota @kindex C-c C-c @@ -7849,10 +8128,10 @@ row-spanning, and alignment can be created using the Emacs table package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22). -When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode +When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode will call @command{table-recognize-table} and move the cursor into the -table. Inside a table, the keymap of Org-mode is inactive. In order -to execute Org-mode-related commands, leave the table. +table. Inside a table, the keymap of Org mode is inactive. In order +to execute Org mode-related commands, leave the table. @table @kbd @kindex C-c C-c @@ -7863,7 +8142,7 @@ @kindex C-c ~ @item C-c ~ Insert a table.el table. If there is already a table at point, this -command converts it between the table.el format and the Org-mode +command converts it between the table.el format and the Org mode format. See the documentation string of the command @code{org-convert-table} for the restrictions under which this is possible. @@ -7871,18 +8150,18 @@ @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 +Org mode recognizes numerical footnotes as provided by this package (@pxref{Footnotes}). @end table @node Conflicts, , Cooperation, Interaction -@subsection Packages that lead to conflicts with Org-mode +@subsection Packages that lead to conflicts with Org mode @table @asis @cindex @file{allout.el} @item @file{allout.el} by Ken Manheimer -Startup of Org-mode may fail with the error message +Startup of Org may fail with the error message @code{(wrong-type-argument keymapp nil)} when there is an outdated version @file{allout.el} on the load path, for example the version distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will @@ -7892,11 +8171,11 @@ @cindex @file{CUA.el} @item @file{CUA.el} by Kim. F. Storm -Keybindings in Org-mode conflict with the @kbd{S-<cursor>} keys used by -CUA-mode (as well as pc-select-mode and s-region-mode) to select and +Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by +CUA mode (as well as pc-select-mode and s-region-mode) to select and extend the region. If you want to use one of these packages along with -Org-mode, configure the variable @code{org-replace-disputed-keys}. When -set, Org-mode will move the following keybindings in Org-mode files, and +Org, configure the variable @code{org-replace-disputed-keys}. When +set, Org will move the following key bindings in Org files, and in the agenda buffer (but not during date selection). @example @@ -7914,12 +8193,12 @@ @cindex @file{footnote.el} @item @file{footnote.el} by Steven L. Baur -Org-mode supports the syntax of the footnote package, but only the +Org 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 +commands, @kbd{C-c !} is already used by Org. 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. +@code{org-disputed-keys} to change the settings in Org. @end table @@ -7936,7 +8215,7 @@ If a table field starts with a link, and if the corresponding table column is narrowed (@pxref{Narrow columns}) to a width too small to display the link, the field would look entirely empty even though it is -not. To prevent this, Org-mode throws an error. The work-around is to +not. To prevent this, Org throws an error. The work-around is to make the column wide enough to fit the link, or to add some text (at least 2 characters) before the link in the same field. @item @@ -7965,12 +8244,12 @@ @node Extensions and Hacking, History and Acknowledgments, Miscellaneous, Top @appendix Extensions, Hooks and Hacking -This appendix lists extensions for Org-mode written by other authors. +This appendix lists extensions for Org written by other authors. It also covers some aspects where users can extend the functionality of -Org-mode. +Org. @menu -* Extensions:: Existing 3rd-part extensions +* Extensions:: Existing 3rd-party extensions * Adding hyperlink types:: New custom link types * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs * Dynamic blocks:: Automatically filled blocks @@ -7979,68 +8258,28 @@ @end menu @node Extensions, Adding hyperlink types, Extensions and Hacking, Extensions and Hacking -@section Third-party extensions for Org-mode +@section Third-party extensions for Org @cindex extension, third-party -The following extensions for Org-mode have been written by other people: - -@table @asis -@cindex @file{org-publish.el} -@item @file{org-publish.el} by David O'Toole -This package provides facilities for publishing related sets of Org-mode -files together with linked files like images as webpages. It is -highly configurable and can be used for other publishing purposes as -well. As of Org-mode version 4.30, @file{org-publish.el} is part of the -Org-mode distribution. It is not yet part of Emacs, however, a delay -caused by the preparations for the 22.1 release. In the mean time, -@file{org-publish.el} can be downloaded from David's site: -@url{http://dto.freeshell.org/e/org-publish.el}. -@cindex @file{org-mouse.el} -@item @file{org-mouse.el} by Piotr Zielinski -This package implements extended mouse functionality for Org-mode. It -allows you to cycle visibility and to edit the document structure with -the mouse. Best of all, it provides a context-sensitive menu on -@key{mouse-3} that changes depending on the context of a mouse-click. -As of Org-mode version 4.53, @file{org-mouse.el} is part of the -Org-mode distribution. It is not yet part of Emacs, however, a delay -caused by the preparations for the 22.1 release. In the mean time, -@file{org-mouse.el} can be downloaded from Piotr's site: -@url{http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el}. -@cindex @file{org-blog.el} -@item @file{org-blog.el} by David O'Toole -A blogging plug-in for @file{org-publish.el}.@* -@url{http://dto.freeshell.org/notebook/OrgMode.html}. -@cindex @file{blorg.el} -@item @file{blorg.el} by Bastien Guerry -Publish Org-mode files as -blogs. @url{http://www.cognition.ens.fr/~guerry/blorg.html}. -@cindex @file{org2rem.el} -@item @file{org2rem.el} by Bastien Guerry -Translates Org-mode files into something readable by -Remind. @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}. -@item @file{org-toc.el} by Bastien Guerry -Produces a simple table of contents of an Org-mode file, for easy -navigation. @url{http://www.cognition.ens.fr/~guerry/u/org-registry.el}. -@item @file{org-registry.el} by Bastien Guerry -Find which Org-file link to a certain document. -@url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}. -@end table - -@page +There are lots of extensions that have been written by other people. Most of +them have either been integrated into Org by now, or they can be found in the +Org distribution, in the @file{contrib} directory. The list has gotten too +long to cover in any detail here, but there is a seaparate manual for these +extensions. @node Adding hyperlink types, Tables in arbitrary syntax, Extensions, Extensions and Hacking @section Adding hyperlink types @cindex hyperlinks, adding new types -Org-mode has a large number of hyperlink types built-in +Org has a large number of hyperlink types built-in (@pxref{Hyperlinks}). If you would like to add new link types, it provides an interface for doing so. Lets look at an example file @file{org-man.el} that will add support for creating links like -@samp{[[man:printf][The printf manpage]]} to show unix manual pages inside +@samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside emacs: @lisp -;;; org-man.el - Support for links to manpages in Org-mode +;;; org-man.el - Support for links to manpages in Org (require 'org) @@ -8106,7 +8345,7 @@ The rest of the file defines the necessary variables and functions. First there is a customization variable that determines which emacs -command should be used to display manpages. There are two options, +command should be used to display man pages. There are two options, @code{man} and @code{woman}. Then the function to follow a link is defined. It gets the link path as an argument - in this case the link path is just a topic for the manual command. The function calls the @@ -8117,29 +8356,29 @@ try to make a link. The function must first decide if it is supposed to create the link for this buffer type, we do this by checking the value of the variable @code{major-mode}. If not, the function must exit and -retunr the value @code{nil}. If yes, the link is created by getting the -manual tpoic from the buffer name and prefixing it with the string +return the value @code{nil}. If yes, the link is created by getting the +manual topic from the buffer name and prefixing it with the string @samp{man:}. Then it must call the command @code{org-store-link-props} and set the @code{:type} and @code{:link} properties. Optionally you can also set the @code{:description} property to provide a default for -the link description when the link is later inserted into tan Org-mode +the link description when the link is later inserted into an Org buffer with @kbd{C-c C-l}. @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Extensions and Hacking -@section Tables and Lists in arbitrary syntax +@section Tables and lists in arbitrary syntax @cindex tables, in other modes @cindex lists, in other modes -@cindex orgtbl-mode - -Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a +@cindex Orgtbl mode + +Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a frequent feature request has been to make it work with native tables in specific languages, for example La@TeX{}. However, this is extremely hard to do in a general way, would lead to a customization nightmare, -and would take away much of the simplicity of the Orgtbl-mode table +and would take away much of the simplicity of the Orgtbl mode table editor. -This appendix describes a different approach. We keep the Orgtbl-mode +This appendix describes a different approach. We keep the Orgtbl mode table in its native format (the @i{source table}), and use a custom function to @i{translate} the table to the correct syntax, and to @i{install} it in the right location (the @i{target table}). This puts @@ -8149,14 +8388,14 @@ Bastien added the ability to do the same with lists. You can use Org's facilities to edit and structure lists by turning @code{orgstruct-mode} on, then locally exporting such lists in another format (HTML, La@TeX{} -or TeXInfo.) +or Texinfo.) @menu * Radio tables:: Sending and receiving * A LaTeX example:: Step by step, almost a tutorial * Translator functions:: Copy and modify -* Radio lists:: Doing the same for lists. +* Radio lists:: Doing the same for lists @end menu @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax @@ -8165,7 +8404,7 @@ To define the location of the target table, you first need to create two lines that are comments in the current mode, but contain magic words for -Orgtbl-mode to find. Orgtbl-mode will insert the translated table +Orgtbl mode to find. Orgtbl mode will insert the translated table between these lines, replacing whatever was there before. For example: @example @@ -8175,7 +8414,7 @@ @noindent Just above the source table, we put a special line that tells -Orgtbl-mode how to translate this table and where to install it. For +Orgtbl mode how to translate this table and where to install it. For example: @example #+ORGTBL: SEND table_name translation_function arguments.... @@ -8210,7 +8449,7 @@ @itemize @bullet @item The table could be placed in a block comment if that is supported by the -language. For example, in C-mode you could wrap the table between +language. For example, in C mode you could wrap the table between @samp{/*} and @samp{*/} lines. @item Sometimes it is possible to put the table after some kind of @i{END} @@ -8226,13 +8465,13 @@ @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax @subsection A LaTeX example of radio tables -@cindex LaTeX, and orgtbl-mode +@cindex LaTeX, and Orgtbl mode The best way to wrap the source table in La@TeX{} is to use the @code{comment} environment provided by @file{comment.sty}. It has to be activated by placing @code{\usepackage@{comment@}} into the document -header. Orgtbl-mode can insert a radio table skeleton@footnote{By -default this works only for La@TeX{}, HTML, and TeXInfo. Configure the +header. Orgtbl mode can insert a radio table skeleton@footnote{By +default this works only for La@TeX{}, HTML, and Texinfo. Configure the variable @code{orgtbl-radio-tables} to install templates for other modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will be prompted for a table name, lets say we use @samp{salesfigures}. You @@ -8248,12 +8487,12 @@ @end example @noindent -The @code{#+ORGTBL: SEND} line tells orgtbl-mode to use the function +The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it into the receiver location with name @code{salesfigures}. You may now fill in the table, feel free to use the spreadsheet features@footnote{If the @samp{#+TBLFM} line contains an odd number of dollar characters, -this may cause problems with font-lock in latex-mode. As shown in the +this may cause problems with font-lock in LaTeX mode. As shown in the example you can fix this by adding an extra line inside the @code{comment} environment that is used to balance the dollar expressions. If you are using AUCTeX with the font-latex library, a @@ -8304,7 +8543,7 @@ @end example The La@TeX{} translator function @code{orgtbl-to-latex} is already part of -Orgtbl-mode. It uses a @code{tabular} environment to typeset the table +Orgtbl mode. It uses a @code{tabular} environment to typeset the table and marks horizontal lines with @code{\hline}. Furthermore, it interprets the following parameters: @@ -8318,6 +8557,8 @@ original field value. For example, to wrap each field value in dollars, you could use @code{:fmt "$%s$"}. This may also be a property list with column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}. +A function of one argument can be used in place of the strings; the +function must return a formatted string. @item :efmt efmt Use this format to print numbers with exponentials. The format should @@ -8326,15 +8567,16 @@ may also be a property list with column numbers and formats, for example @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After @code{efmt} has been applied to a value, @code{fmt} will also be -applied. +applied. Similar to @code{fmt}, functions of two arguments can be +supplied instead of strings. @end table @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax @subsection Translator functions -@cindex HTML, and orgtbl-mode +@cindex HTML, and Orgtbl mode @cindex translator function -Orgtbl-mode has several translator functions built-in: +Orgtbl mode has several translator functions built-in: @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}. Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same code that produces tables during HTML @@ -8347,7 +8589,7 @@ @lisp @group (defun orgtbl-to-latex (table params) - "Convert the orgtbl-mode TABLE to LaTeX." + "Convert the Orgtbl mode TABLE to LaTeX." (let* ((alignment (mapconcat (lambda (x) (if x "r" "l")) org-table-last-alignment "")) (params2 @@ -8411,7 +8653,7 @@ sending and receiving radio tables (@pxref{Radio tables}) @footnote{You need to load the @code{org-export-latex.el} package to use radio lists since the relevant code is there for now.}. As for radio tables, you -can insert radio lists templates in HTML, La@TeX{} and TeXInfo modes by +can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by calling @code{org-list-insert-radio-list}. Here are the differences with radio tables: @@ -8449,7 +8691,7 @@ @section Dynamic blocks @cindex dynamic blocks -Org-mode documents can contain @emph{dynamic blocks}. These are +Org documents can contain @emph{dynamic blocks}. These are specially marked regions that are updated by some user-written function. A good example for such a block is the clock table inserted by the command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). @@ -8506,21 +8748,22 @@ If you want to make sure that all dynamic blocks are always up-to-date, you could add the function @code{org-update-all-dblocks} to a hook, for example @code{before-save-hook}. @code{org-update-all-dblocks} is -written in a way that is does nothing in buffers that are not in Org-mode. +written in a way that is does nothing in buffers that are not in +@code{org-mode}. @node Special agenda views, Using the property API, Dynamic blocks, Extensions and Hacking -@section Special Agenda Views +@section Special agenda views @cindex agenda views, user-defined -Org-mode provides a special hook that can be used to narrow down the +Org provides a special hook that can be used to narrow down the selection made by any of the agenda views. You may specify a function that is used at each match to verify if the match should indeed be part of the agenda view, and if not, how much should be skipped. Let's say you want to produce a list of projects that contain a WAITING tag anywhere in the project tree. Let's further assume that you have -marked all tree headings that define a project with the todo keyword -PROJECT. In this case you would run a todo search for the keyword +marked all tree headings that define a project with the TODO keyword +PROJECT. In this case you would run a TODO search for the keyword PROJECT, but skip the match unless there is a WAITING tag anywhere in the subtree belonging to the project line. @@ -8552,6 +8795,12 @@ Note that this also binds @code{org-agenda-overriding-header} to get a meaningful header in the agenda view. +A general way to create custom searches is to base them on a search for +entries with a certain level limit. If you want to study all entries with +your custom search function, simply do a search for @samp{LEVEL>0}, and then +use @code{org-agenda-skip-function} to select the entries you really want to +have. + You may also put a Lisp form into @code{org-agenda-skip-function}. In particular, you may use the functions @code{org-agenda-skip-entry-if} and @code{org-agenda-skip-subtree-if} in this form, for example: @@ -8584,7 +8833,6 @@ (org-agenda-overriding-header "Projects waiting for something: ")))) @end lisp - @node Using the property API, , Special agenda views, Extensions and Hacking @section Using the property API @cindex API, for properties @@ -8604,11 +8852,12 @@ `special' or `standard', only get that subclass. @end defun @defun org-entry-get pom property &optional inherit -Get value of PROPERTY for entry at point-or-marker POM. -If INHERIT is non-nil and the entry does not have the property, -then also check higher levels of the hierarchy. This function ignores -the value of @code{org-use-property-inheritance} and requires the -explicit INHERIT flag. +Get value of PROPERTY for entry at point-or-marker POM. By default, +this only looks at properties defined locally in the entry. If INHERIT +is non-nil and the entry does not have the property, then also check +higher levels of the hierarchy. If INHERIT is the symbol +@code{selective}, use inheritance if and only if the setting of +@code{org-use-property-inheritance} selects PROPERTY for inheritance. @end defun @defun org-entry-delete pom property @@ -8627,17 +8876,32 @@ Insert a property drawer at point. @end defun +@defun org-entry-add-to-multivalued-property pom property value +Treat the value of the property PROPERTY as a whitespace-separated list of +values and make sure that VALUE is in this list. +@end defun + +@defun org-entry-remove-from-multivalued-property pom property value +Treat the value of the property PROPERTY as a whitespace-separated list of +values and make sure that VALUE is @emph{not} in this list. +@end defun + +@defun org-entry-member-in-multivalued-property pom property value +Treat the value of the property PROPERTY as a whitespace-separated list of +values and check if VALUE is in this list. +@end defun + @node History and Acknowledgments, Main Index, Extensions and Hacking, Top @appendix History and Acknowledgments @cindex acknowledgments @cindex history @cindex thanks -Org-mode was borne in 2003, out of frustration over the user interface -of the Emacs outline-mode. I was trying to organize my notes and +Org was borne in 2003, out of frustration over the user interface +of the Emacs Outline mode. I was trying to organize my notes and projects, and using Emacs seemed to be the natural way to go. However, having to remember eleven different commands with two or three keys per -command, only to hide and unhide parts of the outline tree, that seemed +command, only to hide and show parts of the outline tree, that seemed entirely unacceptable to me. Also, when using outlines to take notes, I constantly want to restructure the tree, organizing it parallel to my thoughts and plans. @emph{Visibility cycling} and @emph{structure @@ -8646,16 +8910,21 @@ @file{org.el}. As this environment became comfortable for project planning, the next step was adding @emph{TODO entries}, basic @emph{time stamps}, and @emph{table support}. These areas highlight the two main -goals that Org-mode still has today: To create a new, outline-based, +goals that Org still has today: To create a new, outline-based, plain text mode with innovative and intuitive editing features, and to incorporate project planning functionality directly into a notes file. +A special thanks goes to @i{Bastien Guerry} who has not only writen a large +number of extensions to Org (most of them integrated into the core by now), +but has also helped the development and maintenance of Org so much that he +should be considered co-author of this package. + Since the first release, literally thousands of emails to me or on @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug reports, feedback, new ideas, and sometimes patches and add-on code. Many thanks to everyone who has helped to improve this package. I am trying to keep here a list of the people who had significant influence -in shaping one or more aspects of Org-mode. The list may not be +in shaping one or more aspects of Org. The list may not be complete, if I have forgotten someone, please accept my apologies and let me know. @@ -8664,8 +8933,7 @@ @item @i{Russel Adams} came up with the idea for drawers. @item -@i{Thomas Baumann} contributed the code for links to the MH-E email -system. +@i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}. @item @i{Alex Bochannek} provided a patch for rounding time stamps. @item @@ -8689,7 +8957,7 @@ inspired some of the early development, including HTML export. He also asked for a way to narrow wide table columns. @item -@i{Christian Egli} converted the documentation into TeXInfo format, +@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 @@ -8704,14 +8972,22 @@ @item @i{Niels Giesen} had the idea to automatically archive DONE trees. @item -@i{Bastien Guerry} wrote the La@TeX{} exporter and has been prolific -with patches, ideas, and bug reports. +@i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and +has been prolific with patches, ideas, and bug reports. @item @i{Kai Grossjohann} pointed out key-binding conflicts with other packages. @item +@i{Bernt Hansen} has driven much of the support for auto-repeating tasks, +task state change logging, and the clocktable. His clear explanations have +been critical when we started to adopt the GIT version control system. +@item +@i{Phil Jackson} wrote @file{org-irc.el}. +@item @i{Scott Jaderholm} proposed footnotes, control over whitespace between folded entries, and column view for properties. @item +@i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}. +@item @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also provided frequent feedback and some patches. @item @@ -8751,20 +9027,26 @@ @item @i{Kevin Rogers} contributed code to access VM files on remote hosts. @item +@i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying +webpages derived from Org using an Info-like, or a folding interface with +single key navigation. +@item @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a conflict with @file{allout.el}. @item @i{Jason Riedy} sent a patch to fix a bug with export of TODO keywords. @item -@i{Philip Rooke} created the Org-mode reference card and provided lots +@i{Philip Rooke} created the Org reference card and provided lots of feedback. @item @i{Christian Schlauer} proposed angular brackets around links, among other things. @item -Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s +Linking to VM/BBDB/Gnus was inspired by @i{Tom Shannon}'s @file{organizer-mode.el}. @item +@i{Ilya Shlyakhter} proposed the Archive Sibling. +@item @i{Daniel Sinder} came up with the idea of internal archiving by locking subtrees. @item @@ -8786,17 +9068,18 @@ system. @item @i{John Wiegley} wrote @file{emacs-wiki.el} and @file{planner.el}. The -development of Org-mode was fully independent, and both systems are -really different beasts in their basic ideas and implementation details. -I later looked at John's code, however, and learned from his -implementation of (i) links where the link itself is hidden and only a -description is shown, and (ii) popping up a calendar to select a date. -John has also contributed a number of great ideas directly to Org-mode. +development of Org was fully independent, and both systems are really +different beasts in their basic ideas and implementation details. I later +looked at John's code, however, and learned from his implementation of (i) +links where the link itself is hidden and only a description is shown, and +(ii) popping up a calendar to select a date. John has also contributed a +number of great ideas and patches directly to Org, including the file +@code{org-mac-message.el}' @item @i{Carsten Wimmer} suggested some changes and helped fix a bug in -linking to GNUS. -@item -@i{Roland Winkler} requested additional keybindings to make Org-mode +linking to Gnus. +@item +@i{Roland Winkler} requested additional key bindings to make Org work on a tty. @item @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks @@ -8817,6 +9100,11 @@ @bye @ignore - arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac + arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac @end ignore -) + +@c Local variables: +@c ispell-local-dictionary: "en_US-w_accents" +@c ispell-local-pdict: "./.aspell.org.pws" +@c fill-column: 77 +@c End: