[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to org.texi
|
From: |
Glenn Morris |
|
Subject: |
[Emacs-diffs] Changes to org.texi |
|
Date: |
Thu, 06 Sep 2007 05:01:29 +0000 |
CVSROOT: /sources/emacs
Module name: emacs
Changes by: Glenn Morris <gm> 07/09/06 05:01:28
Index: org.texi
===================================================================
RCS file: org.texi
diff -N org.texi
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ org.texi 6 Sep 2007 05:01:28 -0000 1.1
@@ -0,0 +1,7931 @@
+\input texinfo
address@hidden %**start of header
address@hidden ../info/org
address@hidden Org Mode Manual
+
address@hidden VERSION 5.07
address@hidden DATE August 2007
+
address@hidden Emacs
address@hidden
+* Org Mode: (org). Outline-based notes management and organizer
address@hidden direntry
+
address@hidden Version and Contact Info
address@hidden MAINTAINERSITE
@uref{http://www.astro.uva.nl/~dominik/Tools/org/,maintainers webpage}
address@hidden AUTHOR Carsten Dominik
address@hidden MAINTAINER Carsten Dominik
address@hidden MAINTAINEREMAIL @email{dominik at science dot uva dot nl}
address@hidden MAINTAINERCONTACT @uref{mailto:dominik at science dot uva dot
nl,contact the maintainer}
address@hidden %**end of header
address@hidden
+
address@hidden Macro definitions
+
address@hidden Subheadings inside a table.
address@hidden tsubheading{text}
address@hidden
address@hidden \text\
address@hidden ifinfo
address@hidden
address@hidden @b{\text\}
address@hidden ifnotinfo
address@hidden macro
+
address@hidden
+This manual is for Org-mode (version @value{VERSION}).
+
+Copyright @copyright{} 2004, 2005, 2006, 2007 Free Software Foundation
+
address@hidden
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.1 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
+and with the Back-Cover Texts as in (a) below. A copy of the
+license is included in the section entitled ``GNU Free Documentation
+License.''
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software. Copies published by the Free
+Software Foundation raise funds for GNU development.''
address@hidden quotation
address@hidden copying
+
address@hidden
address@hidden Org Mode Manual
+
address@hidden Release @value{VERSION}
address@hidden by Carsten Dominik
+
address@hidden The following two commands start the copyright page.
address@hidden
address@hidden 0pt plus 1filll
address@hidden
address@hidden titlepage
+
address@hidden Output the table of contents at the beginning.
address@hidden
+
address@hidden
address@hidden Top, Introduction, (dir), (dir)
address@hidden Org Mode Manual
+
address@hidden
address@hidden ifnottex
+
address@hidden
+* Introduction:: Getting started
+* 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
+* Tags:: Tagging headlines and matching sets of tags
+* Properties and columns::
+* Timestamps:: Assign date and time to items
+* 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
+* 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
+* Index:: The fast road to specific information
+* Key Index:: Key bindings and where they are described
+
address@hidden
+ --- The Detailed Node Listing ---
+
+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.
+* Feedback:: Bug reports, ideas, patches etc.
+
+Document Structure
+
+* Outlines:: Org-mode 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
+* Archiving:: Move done task trees to a different place
+* Sparse trees:: Matches embedded in context
+* Plain lists:: Additional structure within an entry
+* Drawers:: Tucking stuff away
+* orgstruct-mode:: Structure editing outside Org-mode
+
+Archiving
+
+* ARCHIVE tag:: Marking a tree as inactive
+* Moving subtrees:: Moving a tree to an archive file
+
+Tables
+
+* 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.
+
+The spreadsheet
+
+* References:: How to refer to another field or range
+* Formula syntax for Calc:: Using Calc to compute stuff
+* Formula syntax for Lisp:: Writing formulas in Emacs Lisp
+* Field formulas:: Formulas valid for a single field
+* Column formulas:: Formulas valid for an entire column
+* Editing and debugging formulas:: Fixing formulas
+* Updating the table:: Recomputing all dependent fields
+* Advanced features:: Field names, parameters and automatic recalc
+
+Hyperlinks
+
+* Link format:: How links in Org-mode 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?
+* Link abbreviations:: Shortcuts for writing complex links
+* Search options:: Linking to a specific location
+* Custom searches:: When the default search is not enough
+* Remember:: Org-trees store quick notes
+
+Internal links
+
+* Radio targets:: Make targets trigger links in plain text.
+
+Remember
+
+* 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
+
+TODO items
+
+* TODO basics:: Marking and displaying TODO entries
+* TODO extensions:: Workflow and assignments
+* Priorities:: Some things are more important than others
+* Breaking down tasks:: Splitting a task into manageable pieces
+* Checkboxes:: Tick-off lists
+
+Extended use of TODO keywords
+
+* Workflow states:: From TODO to DONE in steps
+* TODO types:: I do this, Fred the rest
+* Multiple sets in one file:: Mixing it all, and still finding your way
+* Per file keywords:: Different files, different requirements
+
+Tags
+
+* Tag inheritance:: Tags use the tree structure of the outline
+* Setting tags:: How to assign tags to a headline
+* Tag searches:: Searching for combinations of tags
+
+Properties and Columns
+
+* Property syntax:: How properties are spelled out
+* Special properties:: Access to other Org-mode features
+* Property searches:: Matching property values
+* Column view:: Tabular viewing and editing
+* Property API:: Properties for Lisp programmers
+
+Column View
+
+* Defining columns:: The COLUMNS format property
+* Using column view:: How to create and use column view
+
+Defining Columns
+
+* Scope of column definitions:: Where defined, where valid?
+* Column attributes:: Appearance and content of a column
+
+Timestamps
+
+* Time stamps:: Assigning a time to a tree entry
+* Creating timestamps:: Commands which insert timestamps
+* Deadlines and scheduling:: Planning your work
+* Progress logging:: Documenting when what work was done.
+
+Creating timestamps
+
+* The date/time prompt:: How org-mode helps you entering date and time
+* Custom time format:: Making dates look differently
+
+Deadlines and Scheduling
+
+* Inserting deadline/schedule:: Planning items
+* Repeated tasks:: Items that show up again and again
+
+Progress Logging
+
+* Closing items:: When was this entry marked DONE?
+* Tracking TODO state changes:: When did the status change?
+* Clocking work time:: When exactly did you work on this item?
+
+Agenda Views
+
+* Agenda files:: Files being searched for agenda information
+* 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
+* Custom agenda views:: Defining special searches and views
+
+The built-in agenda views
+
+* 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
+* Stuck projects:: Find projects you need to review
+
+Presentation and sorting
+
+* Categories:: Not all tasks are equal
+* Time-of-day specifications:: How the agenda knows the time
+* Sorting of agenda items:: The order of things
+
+Custom agenda views
+
+* 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::
+
+Embedded LaTeX
+
+* Math symbols:: TeX macros for symbols and Greek letters
+* 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
+
+Exporting
+
+* ASCII export:: Exporting to plain ASCII
+* HTML export:: Exporting to HTML
+* LaTeX export:: Exporting to LaTeX
+* XOXO export:: Exporting to XOXO
+* iCalendar export:: Exporting in iCalendar format
+* Text interpretation:: How the exporter looks at the file
+
+HTML export
+
+* HTML Export commands:: How to invoke LaTeX export
+* 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
+
+LaTeX export
+
+* LaTeX export commands:: How to invoke LaTeX export
+* Quoting LaTeX code:: Incorporating literal LaTeX code
+
+Text interpretation by the exporter
+
+* Comment lines:: Some lines will not be exported
+* Initial text:: Text before the first headline
+* Footnotes:: Numbers like [1]
+* Enhancing text:: Subscripts, symbols and more
+* Export options:: How to influence the export settings
+
+Publishing
+
+* Configuration:: Defining projects
+* Sample configuration:: Example projects
+* Triggering publication:: Publication commands
+
+Configuration
+
+* Project alist:: The central configuration variable
+* Sources and destinations:: From here to there
+* Selecting files:: What files are part of the project?
+* Publishing action:: Setting the function doing the publishing
+* Publishing options:: Tweaking HTML export
+* Publishing links:: Which links keep working after publishing?
+* Project page index:: Publishing a list of project files
+
+Sample configuration
+
+* Simple example:: One-component publishing
+* Complex example:: A multi-component publishing example
+
+Miscellaneous
+
+* Completion:: M-TAB knows what you need
+* Customization:: Adapting Org-mode 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
+* Interaction:: Other Emacs packages
+* Bugs:: Things which do not work perfectly
+
+Interaction with other packages
+
+* Cooperation:: Packages Org-mode cooperates with
+* Conflicts:: Packages that lead to conflicts
+
+Extensions, Hooks and Hacking
+
+* Extensions:: Existing 3rd-part 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 in arbitrary syntax
+
+* Radio tables:: Sending and receiving
+* A LaTeX example:: Step by step, almost a tutorial
+* Translator functions:: Copy and modify
+
address@hidden detailmenu
address@hidden menu
+
address@hidden Introduction, Document structure, Top, Top
address@hidden Introduction
address@hidden introduction
+
address@hidden
+* 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.
+* Feedback:: Bug reports, ideas, patches etc.
address@hidden menu
+
address@hidden Summary, Installation, Introduction, Introduction
address@hidden Summary
address@hidden summary
+
+Org-mode 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
+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,
+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
+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
+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,
+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
+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
+example as:
+
address@hidden
address@hidden@bullet{} outline extension with visibility cycling and structure
editing}
address@hidden@bullet{} ASCII system and table editor for taking structured
notes}
address@hidden@bullet{} ASCII table editor with spreadsheet-like capabilities}
address@hidden@bullet{} TODO list editor}
address@hidden@bullet{} full agenda and planner with deadlines and work
scheduling}
address@hidden@bullet{} environment to implement David Allen's GTD system}
address@hidden@bullet{} a basic database application}
address@hidden@bullet{} simple hypertext system, with HTML export}
address@hidden@bullet{} publishing tool to create a set of interlinked webpages}
address@hidden example
+
+Org-mode's automatic, context sensitive table editor with spreadsheet
+capabilities can be integrated into any major mode by activating the
+minor Orgtbl-mode. Using a translation step, it can be used to maintain
+tables in arbitrary file types, for example in address@hidden The structure
+editing and list creation capabilities can be used outside Org-mode with
+the minor Orgstruct-mode.
+
address@hidden 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
+questions (FAQ), links to tutorials etc. This page is located at
address@hidden://www.astro.uva.nl/~dominik/Tools/org/}.
+
address@hidden
+
+
address@hidden Installation, Activation, Summary, Introduction
address@hidden Installation
address@hidden installation
address@hidden XEmacs
+
address@hidden:} @i{If Org-mode is part of the Emacs distribution or an
+XEmacs package, please skip this section and go directly to
address@hidden
+
+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
address@hidden), 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}:
+
address@hidden
+(setq load-path (cons "~/path/to/lispdir" load-path))
address@hidden example
+
address@hidden users now need to install the file @file{noutline.el} from
+the @file{xemacs} subdirectory of the Org-mode distribution. Use the
+command:}
+
address@hidden
address@hidden install-noutline}
address@hidden example
+
address@hidden Now byte-compile and install the Lisp files with the shell
+commands:
+
address@hidden
+make
+make install
address@hidden example
+
address@hidden If you want to install the info documentation, use this command:
+
address@hidden
+make install-info
address@hidden example
+
address@hidden Then add to @file{.emacs}:
+
address@hidden
+;; This line only if org-mode is not part of the X/Emacs distribution.
+(require 'org-install)
address@hidden lisp
+
address@hidden Activation, Feedback, Installation, Introduction
address@hidden Activation
address@hidden activation
address@hidden autoload
address@hidden global keybindings
address@hidden keybindings, global
+
address@hidden
address@hidden:} @i{If you use copy-and-paste to copy lisp code from the
+PDF documentation as viewed by Acrobat reader to your .emacs file, the
+single quote character comes out incorrectly and the code will not work.
+You need to fix the single quotes by hand, or copy from Info
+documentation.}
address@hidden 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
address@hidden - please choose suitable keys yourself.
+
address@hidden
+;; 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)
address@hidden lisp
+
+Furthermore, you must activate @code{font-lock-mode} in org-mode
+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):
address@hidden
+(global-font-lock-mode 1) ; for all buffers
+(add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
address@hidden lisp
+
address@hidden 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
+like this:
+
address@hidden
+MY PROJECTS -*- mode: org; -*-
address@hidden example
+
address@hidden which will select Org-mode for this buffer no matter what
+the file's name is. See also the variable
address@hidden
+
address@hidden Feedback, , Activation, Introduction
address@hidden Feedback
address@hidden feedback
address@hidden bug reports
address@hidden maintainer
address@hidden author
+
+If you find problems with Org-mode, or if you have questions, remarks,
+or ideas about it, please contact the maintainer @value{MAINTAINER} at
address@hidden
+
+For bug reports, please provide as much information as possible,
+including the version information of Emacs (@kbd{C-h v emacs-version
address@hidden) 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
+backtrace can be very useful (see below on how to create one). Often a
+small example file helps, along with clear information about:
+
address@hidden
address@hidden What exactly did you do?
address@hidden What did you expect to happen?
address@hidden What happened instead?
address@hidden enumerate
address@hidden Thank you for helping to improve this mode.
+
address@hidden How to create a useful backtrace
+
address@hidden backtrace of an error
+If working with Org-mode 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
+error occurred. Here is how to produce a useful backtrace:
+
address@hidden
address@hidden
+Start a fresh Emacs or XEmacs, and make sure that it will load the
+original Lisp code in @file{org.el} instead of the compiled version in
address@hidden The backtrace contains much more information if it is
+produced with uncompiled code. To do this, either rename @file{org.elc}
+to something else before starting Emacs, or ask Emacs explicitly to load
address@hidden by using the command line
address@hidden
+emacs -l /path/to/org.el
address@hidden example
address@hidden
+Go to the @code{Options} menu and select @code{Enter Debugger on Error}
+(XEmacs has this option in the @code{Troubleshooting} sub-menu).
address@hidden
+Do whatever you have to do to hit the error. Don't forget to
+document the steps you take.
address@hidden
+When you hit the error, a @file{*Backtrace*} buffer will appear on the
+screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
+attach it to your bug report.
address@hidden enumerate
+
address@hidden Document structure, Tables, Introduction, Top
address@hidden Document Structure
address@hidden document structure
address@hidden structure of document
+
+Org-mode is based on outline mode and provides flexible commands to
+edit the structure of the document.
+
address@hidden
+* Outlines:: Org-mode 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
+* Archiving:: Move done task trees to a different place
+* Sparse trees:: Matches embedded in context
+* Plain lists:: Additional structure within an entry
+* Drawers:: Tucking stuff away
+* orgstruct-mode:: Structure editing outside Org-mode
address@hidden menu
+
address@hidden Outlines, Headlines, Document structure, Document structure
address@hidden Outlines
address@hidden outlines
address@hidden outline-mode
+
+Org-mode 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
+outlines by compressing the entire show/hide functionality into a single
+command @command{org-cycle}, which is bound to the @key{TAB} key.
+
address@hidden Headlines, Visibility cycling, Outlines, Document structure
address@hidden Headlines
address@hidden headlines
address@hidden outline tree
+
+Headlines define the structure of an outline tree. The headlines in
+Org-mode start with one or more stars, on the left address@hidden
+the variable @code{org-special-ctrl-a/e} to configure special behavior
+of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
+
address@hidden
+* Top level headline
+** Second level
+*** 3rd level
+ some text
+*** 3rd level
+ more text
+
+* Another top level headline
address@hidden example
+
address@hidden Some people find the many stars too noisy and would prefer an
+outline that has whitespace followed by a single star as headline
+starters. @ref{Clean view} describes a setup to realize this.
+
+An empty line after the end of a subtree is considered part of it and
+will be hidden when the subtree is folded. However, if you leave at
+least two empty lines, one empty line will remain visible after folding
+the subtree, in order to structure the collapsed view. See the
+variable @code{org-cycle-separator-lines} to modify this behavior.
+
address@hidden Visibility cycling, Motion, Headlines, Document structure
address@hidden Visibility cycling
address@hidden cycling, visibility
address@hidden visibility cycling
address@hidden trees, visibility
address@hidden show hidden text
address@hidden 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
address@hidden@key{TAB}} to change the visibility in the buffer.
+
address@hidden subtree visibility states
address@hidden subtree cycling
address@hidden folded, subtree visibility state
address@hidden children, subtree visibility state
address@hidden subtree, subtree visibility state
address@hidden @kbd
address@hidden @key{TAB}
address@hidden @key{TAB}
address@hidden cycling}: Rotate current subtree among the states
+
address@hidden
+,-> FOLDED -> CHILDREN -> SUBTREE --.
+'-----------------------------------'
address@hidden example
+
+The cursor must be on a headline for this to address@hidden, however,
+the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
+beginning of the buffer and the first line is not a headline, then
address@hidden actually runs global cycling (see below)@footnote{see the
+option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
+argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
+
address@hidden global visibility states
address@hidden global cycling
address@hidden overview, global visibility state
address@hidden contents, global visibility state
address@hidden show all, global visibility state
address@hidden address@hidden
address@hidden address@hidden
address@hidden C-u @key{TAB}
address@hidden cycling}: Rotate the entire buffer among the states
+
address@hidden
+,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
+'--------------------------------------'
address@hidden example
+
+When @address@hidden is called with a numerical prefix N, the CONTENTS
+view up to headlines of level N will be shown.
+Note that inside tables, @address@hidden jumps to the previous field.
+
address@hidden show all, command
address@hidden C-c C-a
address@hidden C-c C-a
+Show all.
address@hidden C-c C-r
address@hidden 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
+exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda
+command (@pxref{Agenda commands}). With prefix arg show, on each
+level, all sibling headings.
address@hidden C-c C-x b
address@hidden C-c C-x b
+Show the current subtree in an indirect address@hidden indirect
+buffer
address@hidden
+(@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
address@hidden ifinfo
address@hidden
+(see the Emacs manual for more information about indirect buffers)
address@hidden ifnotinfo
+will contain the entire buffer, but will be narrowed to the current
+tree. Editing the indirect buffer will also change the original buffer,
+but without affecting visibility in that buffer.}. With numerical
+prefix ARG, go up to this level and then take that tree. If ARG is
+negative, go up that many levels. With @kbd{C-u} prefix, do not remove
+the previously used indirect buffer.
address@hidden table
+
+When Emacs first visits an Org-mode 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
+buffer:
+
address@hidden
+#+STARTUP: overview
+#+STARTUP: content
+#+STARTUP: showall
address@hidden example
+
address@hidden Motion, Structure editing, Visibility cycling, Document structure
address@hidden Motion
address@hidden motion, between headlines
address@hidden jumping, to headlines
address@hidden headline navigation
+The following commands jump to other headlines in the buffer.
+
address@hidden @kbd
address@hidden C-c C-n
address@hidden C-c C-n
+Next heading.
address@hidden C-c C-p
address@hidden C-c C-p
+Previous heading.
address@hidden C-c C-f
address@hidden C-c C-f
+Next heading same level.
address@hidden C-c C-b
address@hidden C-c C-b
+Previous heading same level.
address@hidden C-c C-u
address@hidden C-c C-u
+Backward to higher level heading.
address@hidden C-c C-j
address@hidden C-c C-j
+Jump to a different place without changing the current outline
+visibility. Shows the document structure in a temporary buffer, where
+you can use the following keys to find your destination:
address@hidden
address@hidden @r{Cycle visibility.}
address@hidden / @key{up} @r{Next/previous visible headline.}
+n / p @r{Next/previous visible headline.}
+f / b @r{Next/previous headline same level.}
+u @r{One level up.}
+0-9 @r{Digit argument.}
address@hidden @r{Select this location.}
address@hidden example
address@hidden table
+
address@hidden Structure editing, Archiving, Motion, Document structure
address@hidden Structure editing
address@hidden structure editing
address@hidden headline, promotion and demotion
address@hidden promotion, of subtrees
address@hidden demotion, of subtrees
address@hidden subtree, cut and paste
address@hidden pasting, of subtrees
address@hidden cutting, of subtrees
address@hidden copying, of subtrees
address@hidden subtrees, cut and paste
+
address@hidden @kbd
address@hidden address@hidden
address@hidden address@hidden
+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}
+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. If the command is used at the beginning of a
+headline, the new headline is created before the current line. If at
+the beginning of any other line, the content of that line is made the
+new heading. If the command is used at the end of a folded subtree
+(i.e. behind the ellipses at the end of a headline), then a headline
+like the current one will be inserted after the end of the subtree.
address@hidden address@hidden
address@hidden address@hidden
+Insert new TODO entry with same level as current heading.
address@hidden address@hidden
address@hidden address@hidden
+Promote current heading by one level.
address@hidden address@hidden
address@hidden address@hidden
+Demote current heading by one level.
address@hidden address@hidden
address@hidden address@hidden
+Promote the current subtree by one level.
address@hidden address@hidden
address@hidden address@hidden
+Demote the current subtree by one level.
address@hidden address@hidden
address@hidden address@hidden
+Move subtree up (swap with previous subtree of same
+level).
address@hidden address@hidden
address@hidden address@hidden
+Move subtree down (swap with next subtree of same level).
address@hidden C-c C-x C-w
address@hidden C-c C-x C-k
address@hidden C-c C-x C-w
address@hidden C-c C-x C-k
+Kill subtree, i.e. remove it from buffer but save in kill ring.
address@hidden C-c C-x M-w
address@hidden C-c C-x M-w
+Copy subtree to kill ring.
address@hidden C-c C-x C-y
address@hidden 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
+headline marker like @samp{****}.
address@hidden C-c ^
address@hidden 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. With a
address@hidden prefix, sorting will be case-sensitive. With two @kbd{C-u
+C-u} prefixes, duplicate entries will also be removed.
address@hidden table
+
address@hidden region, active
address@hidden active region
address@hidden 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
+just after the last headline to change. Note that when the cursor is
+inside a table (@pxref{Tables}), the Meta-Cursor keys have different
+functionality.
+
address@hidden Archiving, Sparse trees, Structure editing, Document structure
address@hidden Archiving
address@hidden 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
+the ARCHIVE tag, or you can move an entire (sub)tree to a different
+location.
+
address@hidden
+* ARCHIVE tag:: Marking a tree as inactive
+* Moving subtrees:: Moving a tree to an archive file
address@hidden menu
+
address@hidden ARCHIVE tag, Moving subtrees, Archiving, Archiving
address@hidden The ARCHIVE tag
address@hidden internal archiving
+
+A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
+its location in the outline tree, but behaves in the following way:
address@hidden @minus
address@hidden
+It does not open when you attempt to do so with a visibility cycling
+command (@pxref{Visibility cycling}). You can force cycling archived
+subtrees with @address@hidden, or by setting the option
address@hidden Also normal outline commands like
address@hidden will open archived subtrees.
address@hidden
+During sparse tree construction (@pxref{Sparse trees}), matches in
+archived subtrees are not exposed, unless you configure the option
address@hidden
address@hidden
+During agenda view construction (@pxref{Agenda views}), the content of
+archived trees is ignored unless you configure the option
address@hidden
address@hidden
+Archived trees are not exported (@pxref{Exporting}), only the headline
+is. Configure the details using the variable
address@hidden
address@hidden itemize
+
+The following commands help managing the ARCHIVE tag:
+
address@hidden @kbd
address@hidden C-c C-x C-a
address@hidden C-c C-x C-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
+hidden.
address@hidden C-u C-c C-x C-a
address@hidden C-u C-c C-x C-a
+Check if any direct children of the current headline should be archived.
+To do this, each subtree is checked for open TODO entries. If none are
+found, the command offers to set the ARCHIVE tag for the child. If the
+cursor is @emph{not} on a headline when this command is invoked, the
+level 1 trees will be checked.
address@hidden address@hidden
address@hidden address@hidden
+Cycle a tree even if it is tagged with ARCHIVE.
address@hidden table
+
address@hidden Moving subtrees, , ARCHIVE tag, Archiving
address@hidden Moving subtrees
address@hidden 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.
+
address@hidden @kbd
address@hidden C-c C-x C-s
address@hidden 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
+state will be store as properties in the entry.
address@hidden C-u C-c C-x C-s
address@hidden C-u C-c C-x C-s
+Check if any direct children of the current headline could be moved to
+the archive. To do this, each subtree is checked for open TODO entries.
+If none are found, the command offers to move it to the archive
+location. If the cursor is @emph{not} on a headline when this command
+is invoked, the level 1 trees will be checked.
address@hidden table
+
address@hidden archive locations
+The default archive location is a file in the same directory as the
+current file, with the name derived by appending @file{_archive} to the
+current file name. For information and examples on how to change this,
+see the documentation string of the variable
address@hidden There is also an in-buffer option for
+setting this variable, for example
+
address@hidden
+#+ARCHIVE: %s_done::
address@hidden example
+
address@hidden
+You may have several such lines in the buffer, they will then be valid
+for the entries following the line (the first will also apply to any
+text before it).
+
address@hidden Sparse trees, Plain lists, Archiving, Document structure
address@hidden Sparse trees
address@hidden sparse trees
address@hidden trees, sparse
address@hidden folding, sparse trees
address@hidden occur, command
+
+An important feature of Org-mode is the ability to construct
address@hidden trees} for selected information in an outline tree. A
+sparse tree means that the entire document is folded as much as
+possible, but the selected information is made visible along with the
+headline structure above address@hidden also the variables
address@hidden, @code{org-show-following-heading}, and
address@hidden for 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. The most
+basic one is @command{org-occur}:
+
address@hidden @kbd
address@hidden C-c /
address@hidden C-c /
+Occur. Prompts for a regexp and shows a sparse tree with all matches.
+If the match is in a headline, the headline is made visible. If the
+match is in the body of an entry, headline and body are made visible.
+In order to provide minimal context, also the full hierarchy of
+headlines above the match is shown, as well as the headline following
+the match. Each match is also highlighted; the highlights disappear
+when the buffer is changed by an editing command, or by pressing
address@hidden C-c}. When called with a @kbd{C-u} prefix argument, previous
+highlights are kept, so several calls to this command can be stacked.
address@hidden table
address@hidden
+For frequently used sparse trees of specific search strings, you can
+use the variable @code{org-agenda-custom-commands} to define fast
+keyboard access to specific sparse trees. These commands will then be
+accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
+For example:
+
address@hidden
+(setq org-agenda-custom-commands
+ '(("f" occur-tree "FIXME")))
address@hidden lisp
+
address@hidden will define the key @kbd{C-c a f} as a shortcut for creating
+a sparse tree matching the string @samp{FIXME}.
+
+Other commands use sparse trees as well. For example @kbd{C-c
+C-v} creates a sparse TODO tree (@pxref{TODO basics}).
+
address@hidden C-c C-e v
address@hidden printing sparse trees
address@hidden visible text, printing
+To print a sparse tree, you can use the Emacs command
address@hidden which does not print invisible parts
+of the document @footnote{This does not work under XEmacs, because
+XEmacs uses selective display for outlining, not text properties.}.
+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.
+
address@hidden Plain lists, Drawers, Sparse trees, Document structure
address@hidden Plain lists
address@hidden plain lists
address@hidden lists, plain
address@hidden lists, ordered
address@hidden ordered lists
+
+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,
+and the HTML exporter (@pxref{Exporting}) does parse and format them.
+
+Org-mode knows ordered and unordered lists. Unordered list items start
+with @samp{-}, @samp{+}, or @address@hidden using @samp{*} as a
+bullet, lines must be indented or they will be seen as top-level
+headlines. Also, when you are hiding leading stars to get a clean
+outline view, plain list items starting with a star are visually
+indistinguishable from true headlines. In short: even though @samp{*}
+is supported, it may be better not to use it for plain list items.} as
+bullets. Ordered list items start with @samp{1.} or @samp{1)}. Items
+belonging to the same list must have the same indentation on the first
+line. In particular, if an ordered list reaches number @samp{10.}, then
+the 2--digit numbers must be written left-aligned with the other numbers
+in the list. Indentation also determines the end of a list item. It
+ends before the next line that is indented like the bullet/number, or
+less. Empty lines are part of the previous item, so you can have
+several paragraphs in one item. If you would like an empty line to
+terminate all currently open plain lists, configure the variable
address@hidden Here is an example:
+
address@hidden
address@hidden
+** Lord of the Rings
+ My favorite scenes are (in this order)
+ 1. The attack of the Rohirrim
+ 2. Eowyns fight with the witch king
+ + this was already my favorite scene in the book
+ + I really like Miranda Otto.
+ 3. Peter Jackson being shot by Legolas
+ - on DVD only
+ He makes a really funny face when it happens.
+ But in the end, not individual scenes matter but the film as a whole.
address@hidden group
address@hidden example
+
+Org-mode supports these lists by tuning filling and wrapping commands to
+deal with them address@hidden only changes the filling
+settings for Emacs. For XEmacs, you should use Kyle E. Jones'
address@hidden To turn this on, put into @file{.emacs}:
address@hidden(require 'filladapt)}}.
+
+The following commands act on items when the cursor is in the first line
+of an item (the line with the bullet or number).
+
address@hidden @kbd
address@hidden @key{TAB}
address@hidden @key{TAB}
+Items can be folded just like headline levels if you set the variable
address@hidden The level of an item is then
+given by the indentation of the bullet/number. Items are always
+subordinate to real headlines, however; the hierarchies remain
+completely separated.
+
+If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
+fixes the indentation of the curent line in a heuristic way.
address@hidden address@hidden
address@hidden address@hidden
+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. 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.
address@hidden address@hidden
address@hidden address@hidden
+Insert a new item with a checkbox (@pxref{Checkboxes}).
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Jump to the previous/next item in the current list.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Move the item including subitems up/down (swap with previous/next item
+of same indentation). If the list is ordered, renumbering is
+automatic.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Decrease/increase the indentation of the item, including subitems.
+Initially, the item tree is selected based on current indentation.
+When these commands are executed several times in direct succession,
+the initially selected region is used, even if the new indentation
+would imply a different hierarchy. To use the new hierarchy, break
+the command chain with a cursor motion or so.
address@hidden C-c C-c
address@hidden C-c C-c
+If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
+state of the checkbox. If not, make 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.
address@hidden C-c -
address@hidden 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.
address@hidden table
+
address@hidden Drawers, orgstruct-mode, Plain lists, Document structure
address@hidden Drawers
address@hidden drawers
address@hidden 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}.
+Drawers need to be configured with the variable @code{org-drawers}, and
+look like this:
+
address@hidden
+** This is a headline
+ Still outside the drawer
+ :DRAWERNAME:
+ This is inside the drawer.
+ :END:
+ After the drawer.
address@hidden example
+
+Visibility cycling (@pxref{Visibility cycling}) on the headline will
+hide and show the entry, but keep the drawer collapsed to a single line.
+In order to look inside the drawer, you need to move the cursor to the
+drawer line and press @key{TAB} there. Org-mode uses a drawer for
+storing properties (@pxref{Properties and columns}).
+
address@hidden orgstruct-mode, , Drawers, Document structure
address@hidden The Orgstruct minor mode
address@hidden orgstruct-mode
address@hidden minor mode for structure editing
+
+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
+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,
+use
+
address@hidden
+(add-hook 'mail-mode-hook 'turn-on-orgstruct)
address@hidden 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
+structure editing commands will work, even if the same keys normally
+have different functionality in the major mode you are using. If the
+cursor is not in one of those special lines, Orgstruct-mode lurks
+silently in the shadow.
+
address@hidden Tables, Hyperlinks, Document structure, Top
address@hidden Tables
address@hidden tables
address@hidden editing tables
+
+Org-mode has a very fast and intuitive table editor built-in.
+Spreadsheet-like calculations are supported in connection with the
+Emacs @file{calc} package.
+
address@hidden
+* 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.
address@hidden menu
+
address@hidden Built-in table editor, Narrow columns, Tables, Tables
address@hidden The built-in table editor
address@hidden table editor, built-in
+
+Org-mode makes it easy to format tables in plain ASCII. Any line with
address@hidden|} as the first non-whitespace character is considered part of a
+table. @samp{|} is also the column separator. A table might look like
+this:
+
address@hidden
+| Name | Phone | Age |
+|-------+-------+-----|
+| Peter | 1234 | 17 |
+| Anna | 4321 | 25 |
address@hidden example
+
+A table is re-aligned automatically each time you press @key{TAB} or
address@hidden or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
+the next field (@key{RET} to the next row) and creates new table rows
+at the end of the table or before horizontal lines. The indentation
+of the table is set by the first line. Any line starting with
address@hidden|-} is considered as a horizontal separator line and will be
+expanded on the next re-align to span the whole table width. So, to
+create the above table, you would only type
+
address@hidden
+|Name|Phone|Age|
+|-
address@hidden example
+
address@hidden 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},
address@hidden, 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
+with @address@hidden, @address@hidden or @address@hidden, the
+field is automatically made blank. If this behavior is too
+unpredictable for you, configure the variables
address@hidden and @code{org-table-auto-blank-field}.
+
address@hidden @kbd
address@hidden and conversion}
address@hidden C-c |
address@hidden C-c |
+Convert the active region to table. If every line contains at least one
+TAB character, the function assumes that the material is tab separated.
+If not, lines are split at whitespace into fields. You can use a prefix
+argument to indicate the minimum number of consecutive spaces required
+to identify a field separator (default: just one)address@hidden
+If there is no active region, this command creates an empty Org-mode
+table. But it's easier just to start typing, like
address@hidden|Name|Phone|Age @key{RET} |- @key{TAB}}.
+
address@hidden and field motion}
address@hidden C-c C-c
address@hidden C-c C-c
+Re-align the table without moving the cursor.
address@hidden
address@hidden @key{TAB}
address@hidden @key{TAB}
+Re-align the table, move to the next field. Creates a new row if
+necessary.
address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Re-align, move to previous field.
address@hidden
address@hidden @key{RET}
address@hidden @key{RET}
+Re-align the table and move down to next row. Creates a new row if
+necessary. At the beginning or end of a line, @key{RET} still does
+NEWLINE, so it can be used to split a table.
+
address@hidden and row editing}
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Move the current column left/right.
address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Kill the current column.
address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Insert a new column to the left of the cursor position.
address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Move the current row up/down.
address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Kill the current row or horizontal line.
address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Insert a new row above (with arg: below) the current row.
address@hidden
address@hidden C-c -
address@hidden C-c -
+Insert a horizontal line below current row. With prefix arg, the line
+is created above the current line.
address@hidden
address@hidden C-c ^
address@hidden C-c ^
+Sort the table lines in the region. The position of point indicates the
+column to be used for sorting, and the range of lines is the range
+between the nearest horizontal separator lines, or the entire table. If
+point is before the first column, you will be prompted for the sorting
+column. If there is an active region, the mark specifies the first line
+and the sorting column, while point should be in the last line to be
+included into the sorting. The command prompts for the sorting type
+(alphabetically, numerically, or by time). When called with a prefix
+argument, alphabetic sorting will be case-sensitive.
+
address@hidden
address@hidden C-c C-x M-w
address@hidden C-c C-x M-w
+Copy a rectangular region from a table to a special clipboard. Point
+and mark determine edge fields of the rectangle. The process ignores
+horizontal separator lines.
address@hidden
address@hidden C-c C-x C-w
address@hidden C-c C-x C-w
+Copy a rectangular region from a table to a special clipboard, and
+blank all fields in the rectangle. So this is the ``cut'' operation.
address@hidden
address@hidden C-c C-x C-y
address@hidden C-c C-x C-y
+Paste a rectangular region into a table.
+The upper right corner ends up in the current field. All involved fields
+will be overwritten. If the rectangle does not fit into the present table,
+the table is enlarged as needed. The process ignores horizontal separator
+lines.
address@hidden
address@hidden C-c C-q
address@hidden C-c C-q
+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.
+
address@hidden
address@hidden formula, in tables
address@hidden calculations, in tables
address@hidden region, active
address@hidden active region
address@hidden transient-mark-mode
address@hidden C-c +
address@hidden C-c +
+Sum the numbers in the current column, or in the rectangle defined by
+the active region. The result is shown in the echo area and can
+be inserted with @kbd{C-y}.
address@hidden
address@hidden address@hidden
address@hidden address@hidden
+When current field is empty, copy from first non-empty field above.
+When not empty, copy current field down to next row and move cursor
+along with it. Depending on the variable
address@hidden, integer field values will be
+incremented during copy. This key is also used by CUA-mode
+(@pxref{Cooperation}).
+
address@hidden
address@hidden C-c `
address@hidden C-c `
+Edit the current field in a separate window. This is useful for fields
+that are not fully visible (@pxref{Narrow columns}). When called with a
address@hidden prefix, just make the full field visible, so that it can be
+edited in place.
address@hidden
address@hidden C-c @key{TAB}
address@hidden C-c @key{TAB}
+This is an alias for @kbd{C-u C-c `} to make the current field fully
+visible.
address@hidden
address@hidden M-x org-table-import
+Import a file as a table. The table should be TAB- or whitespace
+separated. Useful, for example, to import an Excel table or data from a
+database, because these programs generally can write TAB-separated text
+files. This command works by inserting the file into the buffer and
+then converting the region to a table. Any prefix argument is passed on
+to the converter, which uses it to determine the separator.
address@hidden C-c |
+Tables can also be imported by pasting tabular text into the org-mode
+buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
address@hidden |} command (see above under @i{Creation and conversion}.
address@hidden
address@hidden M-x org-table-export
+Export the table as a TAB-separated file. Useful for data exchange with,
+for example, Excel or database programs.
address@hidden table
+
+If you don't like the automatic table editor because it gets in your
+way on lines which you would like to start with @samp{|}, you can turn
+it off with
+
address@hidden
+(setq org-enable-table-editor nil)
address@hidden lisp
+
address@hidden Then the only table command that still works is
address@hidden C-c} to do a manual re-align.
+
address@hidden Narrow columns, Column groups, Built-in table editor, Tables
address@hidden Narrow columns
address@hidden narrow columns in tables
+
+The width of columns is automatically determined by the table editor.
+Sometimes a single field or a few fields need to carry more text,
+leading to inconveniently wide columns. To address@hidden feature
+does not work on XEmacs.} the width of a column, one field anywhere in
+the column may contain just the string @samp{<N>} where @samp{N} is an
+integer specifying the width of the column in characters. The next
+re-align will then set the width of this column to no more than this
+value.
+
address@hidden
address@hidden
+|---+------------------------------| |---+--------|
+| | | | | <6> |
+| 1 | one | | 1 | one |
+| 2 | two | ----\ | 2 | two |
+| 3 | This is a long chunk of text | ----/ | 3 | This=> |
+| 4 | four | | 4 | four |
+|---+------------------------------| |---+--------|
address@hidden group
address@hidden example
+
address@hidden
+Fields that are wider become clipped and end in the string @samp{=>}.
+Note that the full text is still in the buffer, it is only invisible.
+To see the full text, hold the mouse over the field - a tool-tip window
+will show the full content. To edit such a field, use the command
address@hidden `} (that is @kbd{C-c} followed by the backquote). This will
+open a new window with the full field. Edit it and finish with @kbd{C-c
+C-c}.
+
+When visiting a file containing a table with narrowed columns, the
+necessary character hiding has not yet happened, and the table needs to
+be aligned before it looks nice. Setting the option
address@hidden will realign all tables in a file
+upon visiting, but also slow down startup. You can also set this option
+on a per-file basis with:
+
address@hidden
+#+STARTUP: align
+#+STARTUP: noalign
address@hidden example
+
address@hidden Column groups, orgtbl-mode, Narrow columns, Tables
address@hidden Column groups
address@hidden grouping columns in tables
+
+When Org-mode exports tables, it does so by default without vertical
+lines because that is visually more satisfying in general. Occasionally
+however, vertical lines can be useful to structure a table into groups
+of columns, much like horizontal lines can do for groups of rows. In
+order to specify column groups, you can use a special row where the
+first field contains only @samp{/}. The further fields can either
+contain @samp{<} to indicate that this column should start a group,
address@hidden>} to indicate the end of a column, or @samp{<>} to make a column
+a group of its own. Boundaries between colum groups will upon export be
+marked with vertical lines. Here is an example:
+
address@hidden
+| | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
+|---+----+-----+-----+-----+---------+------------|
+| / | <> | < | | > | < | > |
+| # | 1 | 1 | 1 | 1 | 1 | 1 |
+| # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
+| # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
+|---+----+-----+-----+-----+---------+------------|
+#+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))
address@hidden example
+
+It is also sufficient to just insert the colum group starters after
+every vertical line you'd like to have:
+
address@hidden
+| N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
+|----+-----+-----+-----+---------+------------|
+| / | < | | | < | |
address@hidden example
+
address@hidden orgtbl-mode, The spreadsheet, Column groups, Tables
address@hidden The Orgtbl minor mode
address@hidden orgtbl-mode
address@hidden 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
+the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
+example in mail mode, use
+
address@hidden
+(add-hook 'mail-mode-hook 'turn-on-orgtbl)
address@hidden lisp
+
+Furthermore, with some special setup, it is possible to maintain tables
+in arbitrary syntax with Orgtbl-mode. For example, it is possible to
+construct address@hidden tables with the underlying ease and power of
+Orgtbl-mode, including spreadsheet capabilities. For details, see
address@hidden in arbitrary syntax}.
+
address@hidden The spreadsheet, , orgtbl-mode, Tables
address@hidden The spreadsheet
address@hidden calculations, in tables
address@hidden spreadsheet capabilities
address@hidden @file{calc} package
+
+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
+implementation is not identical to other spreadsheets. For example,
+Org-mode knows the concept of a @emph{column formula} that will be
+applied to all non-header fields in a column without having to copy the
+formula to each relevant field.
+
address@hidden
+* References:: How to refer to another field or range
+* Formula syntax for Calc:: Using Calc to compute stuff
+* Formula syntax for Lisp:: Writing formulas in Emacs Lisp
+* Field formulas:: Formulas valid for a single field
+* Column formulas:: Formulas valid for an entire column
+* Editing and debugging formulas:: Fixing formulas
+* Updating the table:: Recomputing all dependent fields
+* Advanced features:: Field names, parameters and automatic recalc
address@hidden menu
+
address@hidden References, Formula syntax for Calc, The spreadsheet, The
spreadsheet
address@hidden References
address@hidden references
+
+To compute fields in the table from other fields, formulas must
+reference other fields or ranges. In Org-mode, fields can be referenced
+by name, by absolute coordinates, and by relative coordinates. To find
+out what the coordinates of a field are, press @kbd{C-c ?} in that
+field, or press @kbd{C-c @}} to toggle the display of a grid.
+
address@hidden Field references
address@hidden field references
address@hidden references, to fields
+
+Formulas can reference the value of another field in two ways. Like in
+any other spreadsheet, you may reference fields with a letter/number
+combination like @code{B3}, meaning the 2nd field in the 3rd row.
address@hidden Such references are always fixed to that field, they don't change
address@hidden when you copy and paste a formula to a different field. So
address@hidden Org-mode's @code{B3} behaves like @code{$B$3} in other
spreadsheets.
+
address@hidden
+Org-mode also uses another, more general operator that looks like this:
address@hidden
+@@row$column
address@hidden example
+
address@hidden
+Column references can be absolute like @samp{1}, @samp{2},address@hidden,
+or relative to the current column like @samp{+1} or @samp{-2}.
+
+The row specification only counts data lines and ignores horizontal
+separator lines (hlines). You can use absolute row numbers
address@hidden@samp{N}, and row numbers relative to the current row like
address@hidden or @samp{-1}. Or specify the row relative to one of the
+hlines: @samp{I} refers to the first hline, @samp{II} to the second etc.
address@hidden refers to the first such line above the current line,
address@hidden to the first such line below the current line. You can also
+write @samp{III+2} which is the second data line after the third hline
+in the table. Relative row numbers like @samp{-3} will not cross hlines
+if the current line is too close to the hline. Instead, the value
+directly at the hline is used.
+
address@hidden refers to the current row and column. Also, if you omit
+either the column or the row part of the reference, the current
+row/column is implied.
+
+Org-mode's references with @emph{unsigned} numbers are fixed references
+in the sense that if you use the same reference in the formula for two
+different fields, the same field will be referenced each time.
+Org-mode's references with @emph{signed} numbers are floating
+references because the same reference operator can reference different
+fields depending on the field being calculated by the formula.
+
+Here are a few examples:
+
address@hidden
+@@2$3 @r{2nd row, 3rd column}
+C2 @r{same as previous}
+$5 @r{column 5 in the current row}
+E& @r{same as previous}
+@@2 @r{current column, row 2}
+@@-1$-3 @r{the field one row up, three columns to the left}
+@@-I$2 @r{field just under hline above current row, column 2}
address@hidden example
+
address@hidden Range references
address@hidden range references
address@hidden references, to ranges
+
+You may reference a rectangular range of fields by specifying two field
+references connected by two dots @samp{..}. If both fields are in the
+current row, you may simply use @samp{$2..$7}, but if at least one field
+is in a different row, you need to use the general @code{@@row$column}
+format at least for the first field (i.e the reference must start with
address@hidden@@} in order to be interpreted correctly). Examples:
+
address@hidden
+$1..$3 @r{First three fields in the current row.}
+$P..$Q @r{Range, using column names (see under Advanced)}
+@@2$1..@@4$3 @r{6 fields between these two fields.}
+A2..C4 @r{Same as above.}
+@@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
address@hidden example
+
address@hidden Range references return a vector of values that can be fed
+into Calc vector functions. Empty fields in ranges are normally
+suppressed, so that the vector contains only the non-empty fields (but
+see the @samp{E} mode switch below). If there are no non-empty fields,
address@hidden is returned to avoid syntax errors in formulas.
+
address@hidden Named references
address@hidden named references
address@hidden references, named
address@hidden name, of column or field
address@hidden constants, in calculations
+
address@hidden is interpreted as the name of a column, parameter or
+constant. Constants are defined globally through the variable
address@hidden, and locally (for the file) through a
+line like
+
address@hidden
+#+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
address@hidden example
+
address@hidden
+Also properties (@pxref{Properties and columns}) can be used as
+constants in table formulas: For a property @samp{:XYZ:} use the name
address@hidden, and the property will be searched in the current
+outline entry and in the hierarchy above it. If you have the
address@hidden package, it will also be used to resolve constants,
+including natural constants like @samp{$h} for Planck's constant, and
+units like @samp{$km} for address@hidden@file{Constant.el} can
+supply the values of constants in two different unit systems, @code{SI}
+and @code{cgs}. Which one is used depends on the value of the variable
address@hidden You can use the @code{#+STARTUP} options
address@hidden and @code{constcgs} to set this value for the current
+buffer.}. Column names and parameters can be specified in special table
+lines. These are described below, see @ref{Advanced features}. All
+names must start with a letter, and further consist of letters and
+numbers.
+
address@hidden Formula syntax for Calc, Formula syntax for Lisp, References,
The spreadsheet
address@hidden Formula syntax for Calc
address@hidden formula syntax, Calc
address@hidden syntax, of formulas
+
+A formula can be any algebraic expression understood by the Emacs
address@hidden package. @b{Note that @file{calc} has the
+non-standard convention that @samp{/} has lower precedence than
address@hidden, 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
+Emacs Calc Manual}),
address@hidden FIXME: The link to the calc manual in HTML does not work.
+variable substitution takes place according to the rules described above.
address@hidden vectors, in table calculations
+The range vectors can be directly fed into the calc vector functions
+like @samp{vmean} and @samp{vsum}.
+
address@hidden format specifier
address@hidden 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
+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
address@hidden
+
address@hidden
+p20 @r{switch the internal precision to 20 digits}
+n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
+D R @r{angle modes: degrees, radians}
+F S @r{fraction and symbolic modes}
+N @r{interpret all fields as numbers, use 0 for non-numbers}
+T @r{force text interpretation}
+E @r{keep empty fields in ranges}
address@hidden example
+
address@hidden
+In addition, you may provide a @code{printf} format specifier to
+reformat the final result. A few examples:
+
address@hidden
+$1+$2 @r{Sum of first and second field}
+$1+$2;%.2f @r{Same, format result to two decimals}
+exp($2)+exp($1) @r{Math functions can be used}
+$0;%.1f @r{Reformat current cell to 1 decimal}
+($3-32)*5/9 @r{Degrees F -> C conversion}
+$c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
+tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
+sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
+vmean($2..$7) @r{Compute column range mean, using vector function}
+vmean($2..$7);EN @r{Same, but treat empty fields as 0}
+taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
address@hidden example
+
+Calc also contains a complete set of logical operations. For example
+
address@hidden
+if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
address@hidden example
+
address@hidden Formula syntax for Lisp, Field formulas, Formula syntax for
Calc, The spreadsheet
address@hidden Emacs Lisp forms as formulas
address@hidden Lisp forms, as table formulas
+
+It is also possible to write a formula in Emacs Lisp; this can be useful
+for string manipulation and control structures, if the Calc's
+functionality is not enough. If a formula starts with a single quote
+followed by an opening parenthesis, then it is evaluated as a lisp form.
+The evaluation should return either a string or a number. Just as with
address@hidden formulas, you can specify modes and a printf format after a
+semicolon. With Emacs Lisp forms, you need to be concious about the way
+field references are interpolated into the form. By default, a
+reference will be interpolated as a Lisp string (in double quotes)
+containing the field. If you provide the @samp{N} mode switch, all
+referenced elements will be numbers (non-number fields will be zero) and
+interpolated as Lisp numbers, without quotes. If you provide the
address@hidden 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
address@hidden"$3"}. Ranges are inserted as space-separated fields, so you can
+embed them in list or vector syntax. A few examples, note how the
address@hidden mode is used when we do computations in lisp.
+
address@hidden
address@hidden the first two characters of the content of column 1}
+ '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
address@hidden columns 1 and 2, equivalent to the Calc's @code{$1+$2}}
+ '(+ $1 $2);N
address@hidden the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
+ '(apply '+ '($1..$4));N
address@hidden example
+
address@hidden Field formulas, Column formulas, Formula syntax for Lisp, The
spreadsheet
address@hidden Field formulas
address@hidden field formula
address@hidden formula, for individual table field
+
+To assign a formula to a particular field, type it directly into the
+field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
+press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
+the field, the formula will be stored as the formula for this field,
+evaluated, and the current field replaced with the result.
+
+Formulas are stored in a special line starting with @samp{#+TBLFM:}
+directly below the table. If you typed the equation in the 4th field of
+the 3rd data line in the table, the formula will look like
address@hidden@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
+with the appropriate commands, @i{absolute references} (but not relative
+ones) in stored formulas are modified in order to still reference the
+same field. Of cause this is not true if you edit the table structure
+with normal editing commands - then you must fix the equations yourself.
+
+Instead of typing an equation into the field, you may also use the
+following command
+
address@hidden @kbd
address@hidden C-u C-c =
address@hidden C-u C-c =
+Install a new formula for the current field. The command prompts for a
+formula, with default taken from the @samp{#+TBLFM:} line, applies
+it to the current field and stores it.
address@hidden table
+
address@hidden Column formulas, Editing and debugging formulas, Field formulas,
The spreadsheet
address@hidden Column formulas
address@hidden column formula
address@hidden formula, for table column
+
+Often in a table, the same formula should be used for all fields in a
+particular column. Instead of having to copy the formula to all fields
+in that column, org-mode 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.
+
+To assign a formula to a column, type it directly into any field in the
+column, preceded by an equal sign, like @samp{=$1+$2}. When you press
address@hidden or @key{RET} or @kbd{C-c C-c} with the cursor still in the
+field, the formula will be stored as the formula for 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 formula. In the @samp{TBLFM:} line, column formulas will look like
address@hidden
+
+Instead of typing an equation into the field, you may also use the
+following command:
+
address@hidden @kbd
address@hidden C-c =
address@hidden 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 =})
+will apply it to that many consecutive fields in the current column.
address@hidden table
+
+
address@hidden Editing and debugging formulas, Updating the table, Column
formulas, The spreadsheet
address@hidden Editing and Debugging formulas
address@hidden formula editing
address@hidden 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
+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
address@hidden@@3$2} or @code{$4}), configure the variable
address@hidden
+
address@hidden @kbd
address@hidden C-c =
address@hidden C-u C-c =
address@hidden C-c =
address@hidden C-u C-c =
+Edit the formula associated with the current column/field in the
+minibuffer. See @ref{Column formulas} and @ref{Field formulas}.
address@hidden C-u C-u C-c =
address@hidden C-u C-u C-c =
+Re-insert the active formula (either a
+field formula, or a column formula) into the current field, so that you
+can edit it directly in the field. The advantage over editing in the
+minibuffer is that you can use the command @kbd{C-c ?}.
address@hidden C-c ?
address@hidden C-c ?
+While editing a formula in a table field, highlight the field(s)
+referenced by the reference at the cursor position in the formula.
address@hidden C-c @}
address@hidden C-c @}
+Toggle the display of row and column numbers for a table, using
+overlays. These are updated each time the table is aligned, you can
+force it with @kbd{C-c C-c}.
address@hidden C-c @{
address@hidden C-c @{
+Toggle the formula debugger on and off. See below.
address@hidden C-c '
address@hidden C-c '
+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
+any field or range reference at the cursor position. You may edit,
+remove and add formulas, and use the following commands:
address@hidden @kbd
address@hidden C-c C-c
address@hidden C-x C-s
address@hidden C-c C-c
address@hidden C-x C-s
+Exit the formula editor and store the modified formulas. With @kbd{C-u}
+prefix, also apply the new formulas to the entire table.
address@hidden C-c C-q
address@hidden C-c C-q
+Exit the formula editor without installing changes.
address@hidden C-c C-r
address@hidden C-c C-r
+Toggle all references in the formula editor between standard (like
address@hidden) and internal (like @code{@@3$2}).
address@hidden @key{TAB}
address@hidden @key{TAB}
+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.
address@hidden address@hidden
address@hidden address@hidden
+Complete Lisp symbols, just like in Emacs-lisp-mode.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden/@key{down}/@key{left}/@key{right}
+Shift the reference at point. For example, if the reference is
address@hidden and you press @address@hidden, it will become @code{C3}.
+This also works for relative references, and for hline references.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden/@key{down}
+Move the test line for column formulas in the Org-mode buffer up and
+down.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden/@key{down}
+Scroll the window displaying the table.
address@hidden C-c @}
address@hidden C-c @}
+Turn the coordinate grid in the table on and off.
address@hidden table
address@hidden table
+
+Making a table field blank does not remove the formula associated with
+the field, because that is stored in a different line (the @samp{TBLFM}
+line) - during the next recalculation the field will be filled again.
+To remove a formula from a field, you have to give an empty reply when
+prompted for the formula, or to edit the @samp{#+TBLFM} line.
+
address@hidden C-c C-c
+You may edit the @samp{#+TBLFM} directly and re-apply the changed
+equations with @kbd{C-c C-c} in that line, or with the normal
+recalculation commands in the table.
+
address@hidden Debugging formulas
address@hidden formula debugging
address@hidden debugging, of table formulas
+When the evaluation of a formula leads to an error, the field content
+becomes the string @samp{#ERROR}. If you would like see what is going
+on during variable substitution and calculation in order to find a bug,
+turn on formula debugging in the @code{Tbl} menu and repeat the
+calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
+field. Detailed information will be displayed.
+
address@hidden Updating the table, Advanced features, Editing and debugging
formulas, The spreadsheet
address@hidden Updating the Table
address@hidden recomputing table fields
address@hidden updating, table
+
+Recalculation of a table is normally not automatic, but needs to be
+triggered by a command. See @ref{Advanced features} for a way to make
+recalculation at least semi-automatically.
+
+In order to recalculate a line of a table or the entire table, use the
+following commands:
+
address@hidden @kbd
address@hidden C-c *
address@hidden C-c *
+Recalculate the current row by first applying the stored column formulas
+from left to right, and all field formulas in the current row.
address@hidden
address@hidden C-u C-c *
address@hidden C-u C-c *
address@hidden C-u C-c C-c
address@hidden C-u C-c C-c
+Recompute the entire table, line by line. Any lines before the first
+hline are left alone, assuming that these are part of the table header.
address@hidden
address@hidden C-u C-u C-c *
address@hidden C-u C-u C-c C-c
address@hidden C-u C-u C-c *
address@hidden C-u C-u C-c C-c
+Iterate the table by recomputing it until no further changes occur.
+This may be necessary if some computed fields use the value of other
+fields that are computed @i{later} in the calculation sequence.
address@hidden table
+
address@hidden Advanced features, , Updating the table, The spreadsheet
address@hidden Advanced features
+
+If you want the recalculation of fields to happen automatically, or if
+you want to be able to assign @i{names} to fields and columns, you need
+to reserve the first column of the table for special marking characters.
address@hidden @kbd
address@hidden C-#
address@hidden C-#
+Rotate the calculation mark in first column through the states @samp{},
address@hidden, @samp{*}, @samp{!}, @samp{$}. The meaning of these characters
+is discussed below. When there is an active region, change all marks in
+the region.
address@hidden table
+
+Here is an example of a table that collects exam results of students and
+makes use of these features:
+
address@hidden
address@hidden
+|---+---------+--------+--------+--------+-------+------|
+| | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
+|---+---------+--------+--------+--------+-------+------|
+| ! | | P1 | P2 | P3 | Tot | |
+| # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
+| ^ | | m1 | m2 | m3 | mt | |
+|---+---------+--------+--------+--------+-------+------|
+| # | Peter | 10 | 8 | 23 | 41 | 8.2 |
+| # | Sara | 6 | 14 | 19 | 39 | 7.8 |
+| # | Sam | 2 | 4 | 3 | 9 | 1.8 |
+|---+---------+--------+--------+--------+-------+------|
+| | Average | | | | 29.7 | |
+| ^ | | | | | at | |
+| $ | max=50 | | | | | |
+|---+---------+--------+--------+--------+-------+------|
+#+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
address@hidden group
address@hidden example
+
address@hidden @b{Important}: Please note that for these special tables,
+recalculating the table with @kbd{C-u C-c *} will only affect rows that
+are marked @samp{#} or @samp{*}, and fields that have a formula assigned
+to the field itself. The column formulas are not applied in rows with
+empty first field.
+
address@hidden marking characters, tables
+The marking characters have the following meaning:
address@hidden @samp
address@hidden !
+The fields in this line define names for the columns, so that you may
+refer to a column as @samp{$Tot} instead of @samp{$6}.
address@hidden ^
+This row defines names for the fields @emph{above} the row. With such
+a definition, any formula in the table may use @samp{$m1} to refer to
+the value @samp{10}. Also, if you assign a formula to a names field, it
+will be stored as @samp{$name=...}.
address@hidden _
+Similar to @samp{^}, but defines names for the fields in the row
address@hidden
address@hidden $
+Fields in this row can define @emph{parameters} for formulas. For
+example, if a field in a @samp{$} row contains @samp{max=50}, then
+formulas in this table can refer to the value 50 using @samp{$max}.
+Parameters work exactly like constants, only that they can be defined on
+a per-table basis.
address@hidden #
+Fields in this row are automatically recalculated when pressing
address@hidden or @key{RET} or @address@hidden in this row. Also, this row
+is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
+lines will be left alone by this command.
address@hidden *
+Selects this line for global recalculation with @kbd{C-u C-c *}, but
+not for automatic recalculation. Use this when automatic
+recalculation slows down editing too much.
address@hidden
+Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
+All lines that should be recalculated should be marked with @samp{#}
+or @samp{*}.
address@hidden /
+Do not export this line. Useful for lines that contain the narrowing
address@hidden<N>} markers.
address@hidden table
+
+Finally, just to whet your appetite on what can be done with the
+fantastic @file{calc} package, here is a table that computes the Taylor
+series of degree @code{n} at location @code{x} for a couple of functions
+(homework: try that with Excel :-)
+
address@hidden
address@hidden
+|---+-------------+---+-----+--------------------------------------|
+| | Func | n | x | Result |
+|---+-------------+---+-----+--------------------------------------|
+| # | exp(x) | 1 | x | 1 + x |
+| # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
+| # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
+| # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
+| # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
+| * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
+|---+-------------+---+-----+--------------------------------------|
+#+TBLFM: $5=taylor($2,$4,$3);n3
address@hidden group
address@hidden example
+
address@hidden Hyperlinks, TODO items, Tables, Top
address@hidden Hyperlinks
address@hidden hyperlinks
+
+Just like HTML, Org-mode provides links inside a file, and external
+links to other files, Usenet articles, emails, and much more.
+
address@hidden
+* Link format:: How links in Org-mode 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?
+* Link abbreviations:: Shortcuts for writing complex links
+* Search options:: Linking to a specific location
+* Custom searches:: When the default search is not enough
+* Remember:: Org-trees store quick notes
address@hidden menu
+
address@hidden Link format, Internal links, Hyperlinks, Hyperlinks
address@hidden Link format
address@hidden link format
address@hidden format, of links
+
+Org-mode will recognize plain URL-like links and activate them as
+clickable links. The general link format, however, looks like this:
+
address@hidden
+[[link][description]] @r{or alternatively} [[link]]
address@hidden example
+
+Once a link in the buffer is complete (all brackets present), Org-mode
+will change the display so that @samp{description} is displayed instead
+of @samp{[[link][description]]} and @samp{link} is displayed instead of
address@hidden Links will be highlighted in the face @code{org-link},
+which by default is an underlined face. You can directly edit the
+visible part of a link. Note that this can be either the @samp{link}
+part (if there is no description) or the @samp{description} part. To
+edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
+cursor on the link.
+
+If you place the cursor at the beginning or just behind the end of the
+displayed text and press @key{BACKSPACE}, you will remove the
+(invisible) bracket at that location. This makes the link incomplete
+and the internals are again displayed as plain text. Inserting the
+missing bracket hides the link internals again. To show the
+internal structure of all links, use the menu entry
address@hidden>Hyperlinks->Literal links}.
+
address@hidden Internal links, External links, Link format, Hyperlinks
address@hidden Internal links
address@hidden internal links
address@hidden links, internal
address@hidden targets, for links
+
+If the link does not look like a URL, it is considered to be internal in
+the current file. Links such as @samp{[[My Target]]} or @samp{[[My
+Target][Find my target]]} lead to a text search in the current file.
+The link can be followed with @kbd{C-c C-o} when the cursor is on the
+link, or with a mouse click (@pxref{Handling links}). The preferred
+match for such a link is a dedicated target: the same string in double
+angular brackets. Targets may be located anywhere; sometimes it is
+convenient to put them into a comment line. For example
+
address@hidden
+# <<My Target>>
address@hidden example
+
address@hidden In HTML export (@pxref{HTML export}), such targets will become
+named anchors for direct access through @samp{http} address@hidden
+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
+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
+then move on to more and more lenient searches. For example, the link
address@hidden Targets]]} will find any of the following:
+
address@hidden
+** My targets
+** TODO my targets are bright
+** my 20 targets are
address@hidden example
+
+To insert a link targeting a headline, in-buffer completion can be used.
+Just type a star followed by a few optional letters into the buffer and
+press @address@hidden All headlines in the current buffer will be
+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
+return to the previous position with @kbd{C-c &}. Using this command
+several times in direct succession goes back to positions recorded
+earlier.
+
address@hidden
+* Radio targets:: Make targets trigger links in plain text.
address@hidden menu
+
address@hidden Radio targets, , Internal links, Internal links
address@hidden Radio targets
address@hidden radio targets
address@hidden targets, radio
address@hidden links, radio targets
+
+Org-mode 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
+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.
+
address@hidden External links, Handling links, Internal links, Hyperlinks
address@hidden External links
address@hidden links, external
address@hidden external links
address@hidden links, external
address@hidden GNUS links
address@hidden BBDB links
address@hidden URL links
address@hidden file links
address@hidden VM links
address@hidden RMAIL links
address@hidden WANDERLUST links
address@hidden MH-E links
address@hidden USENET links
address@hidden SHELL links
address@hidden Info links
address@hidden elisp links
+
+Org-mode supports links to files, websites, Usenet and email messages,
+and BBDB database entries. 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.
+
address@hidden
+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}
+mailto:adent@@galaxy.net @r{Mail link}
+vm:folder @r{VM folder link}
+vm:folder#id @r{VM message link}
+vm://myself@@some.where.org/folder#id @r{VM on remote machine}
+wl:folder @r{WANDERLUST folder link}
+wl:folder#id @r{WANDERLUST message link}
+mhe:folder @r{MH-E folder link}
+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}
+bbdb:Richard Stallman @r{BBDB link}
+shell:ls *.org @r{A shell command}
+elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate}
address@hidden example
+
+A link should be enclosed in double brackets and may contain a
+descriptive text to be displayed instead of the url (@pxref{Link
+format}), for example:
+
address@hidden
+[[http://www.gnu.org/software/emacs/][GNU Emacs]]
address@hidden example
+
address@hidden
+If the description is a file name or URL that points to an image, HTML
+export (@pxref{HTML export}) will inline the image as a clickable
+button. If there is no description at all and the link points to an
+image,
+that image will be inlined into the exported HTML file.
+
address@hidden angular brackets, around links
address@hidden plain text external links
+Org-mode also finds external links in the normal text and activates them
+as links. If spaces must be part of the link (for example in
address@hidden:Richard Stallman}), or if you need to remove ambiguities
+about the end of the link, enclose them in angular brackets.
+
address@hidden Handling links, Using links outside Org-mode, External links,
Hyperlinks
address@hidden Handling links
address@hidden 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.
+
address@hidden @kbd
address@hidden C-c l
address@hidden storing links
address@hidden 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 link
+points to the target. Otherwise it points to the current 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 any other files, the link will point to
+the file, with a search string (@pxref{Search options}) pointing to the
+contents of the current line. If there is an active region, the
+selected words will form the basis of the search string. If the
+automatically created link is not working correctly or accurately
+enough, you can write custom functions to select the search string and
+to do the search for particular file types - see @ref{Custom searches}.
+The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}.
address@hidden
address@hidden C-c C-l
address@hidden link completion
address@hidden completion, of links
address@hidden inserting links
address@hidden 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}. Completion, on the
+other hand, will help you to insert valid link prefixes like
address@hidden:} or @samp{ftp:}, including the prefixes defined through link
+abbreviations (@pxref{Link abbreviations}). The link will be inserted
+into the address@hidden 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 address@hidden 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.
address@hidden
address@hidden If the link is a @samp{file:} link and
address@hidden the linked file is located in the same directory as the current
file or
address@hidden a subdirectory of it, the path of the file will be inserted
relative to
address@hidden the current directory.
address@hidden
address@hidden C-u C-c C-l
address@hidden file name completion
address@hidden completion, of file names
address@hidden C-u C-c C-l
+When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
+a file will be inserted and you may use file name completion to select
+the name of the file. The path to the file is inserted relative to the
+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
+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.
address@hidden
address@hidden C-c C-l @r{(with cursor on existing link)}
+When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
+link and description parts of the link.
address@hidden
address@hidden following links
address@hidden C-c C-o
address@hidden C-c C-o
+Open link at point. This will launch a web browser for URLs (using
address@hidden), 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,
+it creates the corresponding TAGS view. If the cursor is on a time
+stamp, it compiles the agenda for that date. Furthermore, it will visit
+text and remote files in @samp{file:} links with Emacs and select a
+suitable application for local non-text files. Classification of files
+is based on file extension only. See option @code{org-file-apps}. If
+you want to override the default application and visit the file with
+Emacs, use a @kbd{C-u} prefix.
address@hidden
address@hidden mouse-2
address@hidden mouse-1
address@hidden mouse-2
address@hidden mouse-1
+On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
+would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
address@hidden
address@hidden mouse-3
address@hidden mouse-3
+Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
+internal links to be displayed in another address@hidden the
+variable @code{org-display-internal-link-with-indirect-buffer}}.
address@hidden
address@hidden mark ring
address@hidden C-c %
address@hidden C-c %
+Push the current position onto the mark ring, to be able to return
+easily. Commands following an internal link do this automatically.
address@hidden
address@hidden links, returning to
address@hidden C-c &
address@hidden C-c &
+Jump back to a recorded position. A position is recorded by the
+commands following internal links, and by @kbd{C-c %}. Using this
+command several times in direct succession moves through a ring of
+previously recorded positions.
address@hidden
address@hidden C-c C-x C-n
address@hidden C-c C-x C-p
address@hidden links, finding next/previous
address@hidden C-c C-x C-n
address@hidden C-c C-x C-p
+Move forward/backward to the next link in the buffer. At the limit of
+the buffer, the search fails once, and then wraps around. The key
+bindings for this are really too long, you might want to bind this also
+to @kbd{C-n} and @kbd{C-p}
address@hidden
+(add-hook 'org-load-hook
+ (lambda ()
+ (define-key 'org-mode-map "\C-n" 'org-next-link)
+ (define-key 'org-mode-map "\C-p" 'org-previous-link)))
address@hidden lisp
address@hidden table
+
address@hidden Using links outside Org-mode, Link abbreviations, Handling
links, Hyperlinks
address@hidden 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
+global commands, like this (please select suitable global keys
+yourself):
+
address@hidden
+(global-set-key "\C-c L" 'org-insert-link-global)
+(global-set-key "\C-c o" 'org-open-at-point-global)
address@hidden lisp
+
address@hidden Link abbreviations, Search options, Using links outside
Org-mode, Hyperlinks
address@hidden Link abbreviations
address@hidden link abbreviations
address@hidden abbreviation, links
+
+Long URLs can be cumbersome to type, and often many similar links are
+needed in a document. For this you can use link abbreviations. An
+abbreviated link looks like this
+
address@hidden
+[[linkword:tag][description]]
address@hidden example
+
address@hidden
+where the tag is optional. Such abbreviations are resolved according to
+the information in the variable @code{org-link-abbrev-alist} that
+relates the linkwords to replacement text. Here is an example:
+
address@hidden
address@hidden
+(setq org-link-abbrev-alist
+ '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=";)
+ ("google" . "http://www.google.com/search?q=";)
+ ("ads" . "http://adsabs.harvard.edu/cgi-bin/
+ nph-abs_connect?author=%s&db_key=AST")))
address@hidden group
address@hidden lisp
+
+If the replacement text contains the string @samp{%s}, it will be
+replaced with the tag. Otherwise the tag will be appended to the string
+in order to create the link. You may also specify a function that will
+be called with the tag as the only argument to create the link.
+
+With the above setting, you could link to a specific bug with
address@hidden:129]]}, search the web for @samp{OrgMode} with
address@hidden:OrgMode]]} and find out what the Org-mode author is
+doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
+
+If you need special abbreviations just for a single Org-mode buffer, you
+can define them in the file with
+
address@hidden
+#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
+#+LINK: google http://www.google.com/search?q=%s
address@hidden example
+
address@hidden
+In-buffer completion @pxref{Completion} can be used after @samp{[} to
+complete link abbreviations.
+
address@hidden Search options, Custom searches, Link abbreviations, Hyperlinks
address@hidden Search options in file links
address@hidden search option in file links
address@hidden file links, searching
+
+File links can contain additional information to make Emacs jump to a
+particular location in the file when following a link. This can be a
+line number or a search option after a address@hidden backward
+compatibility, line numbers can also follow a single colon.} colon. For
+example, when the command @kbd{C-c l} creates a link (@pxref{Handling
+links}) to a file, it encodes the words in the current line as a search
+string that can be used to find this line back later when following the
+link with @kbd{C-c C-o}.
+
+Here is the syntax of the different ways to attach a search to a file
+link, together with an explanation:
+
address@hidden
+[[file:~/code/main.c::255]]
+[[file:~/xx.org::My Target]]
+[[file:~/xx.org::*My Target]]
+[[file:~/xx.org::/regexp/]]
address@hidden example
+
address@hidden @code
address@hidden 255
+Jump to line 255.
address@hidden My Target
+Search for a link target @samp{<<My Target>>}, or do a text search for
address@hidden target}, similar to the search in internal links, see
address@hidden links}. In HTML export (@pxref{HTML export}), such a file
+link will become an HTML reference to the corresponding named anchor in
+the linked file.
address@hidden *My Target
+In an Org-mode file, restrict search to headlines.
address@hidden /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
+sparse tree with the matches.
address@hidden If the target file is a directory,
address@hidden @code{grep} will be used to search all files in the directory.
address@hidden table
+
+As a degenerate case, a file link with an empty file name can be used
+to search the current file. For example, @code{[[file:::find me]]} does
+a search for @samp{find me} in the current file, just as
address@hidden me]]} would.
+
address@hidden Custom searches, Remember, Search options, Hyperlinks
address@hidden Custom Searches
address@hidden custom search strings
address@hidden search strings, custom
+
+The default mechanism for creating search strings and for doing the
+actual search related to a file link may not work correctly in all
+cases. For example, BibTeX database files have many entries like
address@hidden"1993"} which would not result in good search strings,
+because the only unique identification for a BibTeX entry is the
+citation key.
+
+If you come across such a problem, you can write custom functions to set
+the right search string for a particular file type, and to do the search
+for the string in the file. Using @code{add-hook}, these functions need
+to be added to the hook variables
address@hidden and
address@hidden See the docstring for these
+variables for more information. Org-mode actually uses this mechanism
+for address@hidden database files, and you can use the corresponding code as
+an implementation example. Search for @samp{BibTeX links} in the source
+file.
+
+
address@hidden Remember, , Custom searches, Hyperlinks
address@hidden Remember
address@hidden @file{remember.el}
+
+Another way to create org entries with links to other files is through
+the @i{remember} package by John Wiegley. @i{Remember} lets you store
+quick notes with little interruption of your work flow. See
address@hidden://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
+information. The notes produced by @i{Remember} can be stored in
+different ways, and Org-mode files are a good target. Org-mode
+significantly expands the possibilities of @i{remember}: You may define
+templates for different note types, and to 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.
+
address@hidden
+* 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
address@hidden menu
+
address@hidden Setting up remember, Remember templates, Remember, Remember
address@hidden 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.
+
address@hidden
+(setq org-directory "~/path/to/my/orgfiles/")
+(setq org-default-notes-file "~/.notes")
+(setq remember-annotation-functions '(org-remember-annotation))
+(setq remember-handler-functions '(org-remember-handler))
+(add-hook 'remember-mode-hook 'org-remember-apply-template)
address@hidden example
+
address@hidden Remember templates, Storing notes, Setting up remember, Remember
address@hidden Remember templates
address@hidden templates, for remember
+
+In combination with Org-mode, 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
+use:
+
address@hidden
+(setq org-remember-templates
+ '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
+ (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
+ (?i "* address@hidden@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
address@hidden example
+
address@hidden In these entries, the character specifies how to select the
+template. The first string specifies the template. Two more (optional)
+strings give the file in which, and the headline under which the new
+note should be stored. The file defaults (if not present or @code{nil})
+to @code{org-default-notes-file}, the heading to
address@hidden Both defaults help to get to the
+storing location quickly, but you can change the location interactively
+while storing the note.
+
+When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remember
+something, org will prompt for a key to select the template (if you have
+more than one template) and then prepare the buffer like
address@hidden
+* TODO
+ [[file:link to where you called remember]]
address@hidden example
+
address@hidden or
+
address@hidden
+* [2006-03-21 Tue 15:37]
+
+ [[file:link to where you called remember]]
address@hidden example
+
address@hidden
+During expansion of the template, special @kbd{%}-escapes allow dynamic
+insertion of content:
address@hidden
address@hidden@} @r{prompt the user for a string and replace this sequence
with it.}
+%t @r{time stamp, date only}
+%T @r{time stamp with date and time}
+%u, %U @r{like the above, but inactive time stamps}
+%^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T},
@code{%^u}, @code{%^U}}
+ @r{You may define a prompt like @address@hidden@}t}}
+%n @r{user name (taken from @code{user-full-name})}
+%a @r{annotation, normally the link created with
@code{org-store-link}}
+%i @r{initial content, the region when remember is called with C-u.}
+ @r{The entire text will be indented like @code{%i} itself.}
+%^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}
address@hidden example
+
address@hidden
+For specific link types, the following keywords will be defined:
+
address@hidden
+Link type | Available keywords
+-------------------+----------------------------------------------
+bbdb | %:name %:company
+vm, wl, mh, rmail | %:type %:subject %:message-id
+ | %:from %:fromname %:fromaddress
+ | %:to %:toname %:toaddress
+ | %:fromto @r{(either "to NAME" or "from
NAME")@footnote{This will always be the other, not the user. See the variable
@code{org-from-is-user-regexp}.}}
+gnus | %:group, @r{for messages also all email fields}
+w3, w3m | %:url
+info | %:file %:node
+calendar | %:date"
address@hidden example
+
address@hidden
+To place the cursor after template expansion use:
+
address@hidden
+%? @r{After completing the template, position cursor here.}
address@hidden example
+
address@hidden
+If you change you mind about which template to use, call
address@hidden in the remember buffer. You may then select a new
+template that will be filled with the previous context information.
+
address@hidden Storing notes, , Remember templates, Remember
address@hidden Storing notes
+
+When you are finished preparing a note with @i{remember}, you have to press
address@hidden C-c} to file the note away. The handler first prompts for a
+target file - if you press @key{RET}, the value specified for the
+template is used. Then the command offers the headings tree of the
+selected file, with the cursor position at the default headline (if you
+had specified one in the template). You can either immediately press
address@hidden to get the note placed there. Or you can use the following
+keys to find a better location:
address@hidden
address@hidden @r{Cycle visibility.}
address@hidden / @key{up} @r{Next/previous visible headline.}
+n / p @r{Next/previous visible headline.}
+f / b @r{Next/previous headline same level.}
+u @r{One level up.}
address@hidden 0-9 @r{Digit argument.}
address@hidden example
address@hidden
+Pressing @key{RET} or @key{left} or @key{right}
+then leads to the following result.
+
address@hidden @columnfractions 0.2 0.15 0.65
address@hidden @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
address@hidden buffer-start @tab @key{RET} @tab as level 2 heading at end of
file
address@hidden on headline @tab @key{RET} @tab as sublevel of the heading at
cursor
address@hidden @tab @key{left}/@key{right} @tab as same level,
before/after current heading
address@hidden not on headline @tab @key{RET}
+ @tab at cursor position, level taken from context.
address@hidden multitable
+
+So a fast way to store the note to its default location is to press
address@hidden C-c @key{RET} @key{RET}}. Even shorter would be @kbd{C-u C-c
+C-c}, which does the same without even asking for a file or showing the
+tree.
+
+Before inserting the text into a tree, the function ensures that the
+text has a headline, i.e. a first line that starts with a @samp{*}.
+If not, a headline is constructed from the current date and some
+additional data. If the variable @code{org-adapt-indentation} is
+non-nil, the entire text is also indented so that it starts in the
+same column as the headline (after the asterisks).
+
+
address@hidden TODO items, Tags, Hyperlinks, Top
address@hidden TODO items
address@hidden TODO items
+
+Org-mode does not maintain TODO lists as a separate document. TODO
+items are an integral part of the notes file, because TODO items
+usually come up while taking notes! With Org-mode, you simply mark
+any entry in a tree as being a TODO item. In this way, the
+information is not duplicated, and the entire context from which the
+item emerged is always present when you check.
+
+Of course, this technique causes TODO items to be scattered throughout
+your file. Org-mode provides methods to give you an overview over all
+things you have to do.
+
address@hidden
+* TODO basics:: Marking and displaying TODO entries
+* TODO extensions:: Workflow and assignments
+* Priorities:: Some things are more important than others
+* Breaking down tasks:: Splitting a task into manageable pieces
+* Checkboxes:: Tick-off lists
address@hidden menu
+
address@hidden TODO basics, TODO extensions, TODO items, TODO items
address@hidden Basic TODO functionality
+
+Any headline can become a TODO item by starting it with the word TODO,
+for example:
+
address@hidden
+*** TODO Write letter to Sam Fortune
address@hidden example
+
address@hidden
+The most important commands to work with TODO entries are:
+
address@hidden @kbd
address@hidden C-c C-t
address@hidden cycling, of TODO states
address@hidden C-c C-t
+Rotate the TODO state of the current item among
+
address@hidden
+,-> (unmarked) -> TODO -> DONE --.
+'--------------------------------'
address@hidden example
+
+The same rotation can also be done ``remotely'' from the timeline and
+agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Select the following/preceding TODO state, similar to cycling. Mostly
+useful if more than two TODO states are possible (@pxref{TODO
+extensions}).
address@hidden C-c C-c
address@hidden C-c C-c
+Use the fast tag interface to quickly and directly select a specific
+TODO state. For this you need to assign keys to TODO state, like this:
address@hidden
+#+SEQ_TODO: TODO(t) STARTED(s) WAITING(w) | DONE(d)
address@hidden example
address@hidden See @ref{Per file keywords} and @ref{Setting tags} for more
+information.
address@hidden C-c C-v
address@hidden sparse tree, for TODO
address@hidden C-c C-v
+View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
+the entire buffer, but shows all TODO items and the headings hierarchy
+above them. With prefix arg, search for a specific TODO. You will be
+prompted for the keyword, and you can also give a list of keywords like
address@hidden|kwd2|...}. With numerical prefix N, show the tree for the
+Nth keyword in the variable @code{org-todo-keywords}. With two prefix
+args, find all TODO and DONE entries.
address@hidden C-c a t
address@hidden 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
address@hidden, so there are commands to examine and manipulate
+the TODO entries directly from that buffer (@pxref{Agenda commands}).
address@hidden TODO list}, for more information.
address@hidden address@hidden
address@hidden address@hidden
+Insert a new TODO entry below the current one.
address@hidden table
+
address@hidden TODO extensions, Priorities, TODO basics, TODO items
address@hidden Extended use of TODO keywords
address@hidden extended TODO keywords
+
+The default implementation of TODO entries is just two states: TODO and
+DONE. You can use the TODO feature for more complicated things by
+configuring the variable @code{org-todo-keywords}. With special setup,
+the TODO keyword system can work differently in different files.
+
+Note that @i{tags} are another way to classify headlines in general and
+TODO items in particular (@pxref{Tags}).
+
address@hidden
+* Workflow states:: From TODO to DONE in steps
+* TODO types:: I do this, Fred the rest
+* Multiple sets in one file:: Mixing it all, and still finding your way
+* Per file keywords:: Different files, different requirements
address@hidden menu
+
address@hidden Workflow states, TODO types, TODO extensions, TODO extensions
address@hidden TODO keywords as workflow states
address@hidden TODO workflow
address@hidden workflow states as TODO keywords
+
+You can use TODO keywords to indicate different @emph{sequential} states
+in the process of working on an item, for address@hidden
+this variable only becomes effective after restarting Org-mode in a
+buffer.}:
+
address@hidden
+(setq org-todo-keywords
+ '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
address@hidden lisp
+
+The vertical bar separates the TODO keywords (states that @emph{need
+action}) from the DONE states (which need @emph{no further action}. If
+you don't provide the separator bar, the last state is used as the DONE
+state.
address@hidden 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
+example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
+If you define many keywords, you can use in-buffer completion (see
address@hidden) to insert these words into the buffer. Changing a
+todo state can be logged with a timestamp, see @ref{Tracking TODO state
+changes} for more information.
+
address@hidden TODO types, Multiple sets in one file, Workflow states, TODO
extensions
address@hidden TODO keywords as types
address@hidden TODO types
address@hidden names as TODO keywords
address@hidden types as TODO keywords
+
+The second possibility is to use TODO keywords to indicate different
address@hidden of action items. For example, you might want to indicate
+that items are for ``work'' or ``home''. Or, when you work with several
+people on a single project, you might want to assign action items
+directly to persons, by using their names as TODO keywords. This would
+be set up like this:
+
address@hidden
+(setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
address@hidden lisp
+
+In this case, different keywords do not indicate a sequence, but rather
+different types. So the normal work flow would be to assign a task to a
+person, and later to mark it DONE. Org-mode supports this style by
+adapting the workings of the command @kbd{C-c address@hidden 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}.
+
address@hidden Multiple sets in one file, Per file keywords, TODO types, TODO
extensions
address@hidden Multiple keyword sets in one file
address@hidden 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
address@hidden/@code{DONE}, but also a workflow for bug fixing, and a
+separate state indicating that an item has been canceled (so it is not
+DONE, but also does not require action). Your setup would then look
+like this:
+
address@hidden
+(setq org-todo-keywords
+ '((sequence "TODO" "|" "DONE")
+ (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
+ (sequence "|" "CANCELED")))
address@hidden lisp
+
+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,
address@hidden C-t} only operates within a subsequence, so it switches from
address@hidden to (nothing) to @code{TODO}, and from @code{FIXED} to
+(nothing) to @code{REPORT}. Therefore you need a mechanism to initially
+select the correct sequence. Besides the obvious ways like typing a
+keyword or using completion, you may also apply the following commands:
+
address@hidden @kbd
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+These keys jump from one TODO subset to the next. In the above example,
address@hidden@key{right}} would jump from @code{TODO} or @code{DONE} to
address@hidden, and any of the words in the second row to @code{CANCELED}.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden@key{<left>}} and @address@hidden<right>}} and walk through
address@hidden keywords from all sets, so for example @address@hidden<right>}}
+would switch from @code{DONE} to @code{REPORT} in the example above.
address@hidden table
+
address@hidden Per file keywords, , Multiple sets in one file, TODO extensions
address@hidden Setting up keywords for individual files
address@hidden keyword options
address@hidden per file keywords
+
+It can be very useful to use different aspects of the TODO mechanism in
+different files. For file-local settings, you need to add special lines
+to the file which set the keywords and interpretation for that file
+only. For example, to set one of the two examples discussed above, you
+need one of the following lines, starting in column zero anywhere in the
+file:
+
address@hidden
+#+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
address@hidden example
+or
address@hidden
+#+TYP_TODO: Fred Sara Lucy Mike | DONE
address@hidden example
+
+A setup for using several sets in parallel would be:
+
address@hidden
+#+SEQ_TODO: TODO | DONE
+#+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
+#+SEQ_TODO: | CANCELED
address@hidden example
+
address@hidden completion, of option keywords
address@hidden address@hidden
address@hidden To make sure you are using the correct keyword, type
address@hidden into the buffer and then use @address@hidden completion.
+
address@hidden DONE, final TODO keyword
+Remember that the keywords after the vertical bar (or the last keyword
+if no bar is there) must always mean that the item is DONE (although you
+may use a different word). After changing one of these lines, use
address@hidden C-c} with the cursor still in the line to make the changes
+known to address@hidden 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.}.
+
address@hidden Priorities, Breaking down tasks, TODO extensions, TODO items
address@hidden Priorities
address@hidden priorities
+
+If you use Org-mode extensively to organize your work, you may end up
+with a number of TODO entries so large that you'd like to prioritize
+them. This can be done by placing a @emph{priority cookie} into the
+headline, like this
+
address@hidden
+*** TODO [#A] Write letter to Sam Fortune
address@hidden example
+
address@hidden
+With its standard setup, Org-mode supports priorities @samp{A},
address@hidden, 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}).
+
address@hidden @kbd
address@hidden @kbd{C-c ,}
address@hidden @kbd{C-c ,}
+Set the priority of the current headline. The command prompts for a
+priority character @samp{A}, @samp{B} or @samp{C}. When you press
address@hidden instead, the priority cookie is removed from the headline.
+The priorities can also be changed ``remotely'' from the timeline and
+agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Increase/decrease priority of current headline. 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}).
address@hidden table
+
+You can change the range of allowed priorities by setting the variables
address@hidden, @code{org-lowest-priority}, and
address@hidden For an individual buffer, you may set
+these values (highest, lowest, default) like this (please make sure that
+the highest priority is earlier in the alphabet than the lowest
+priority):
+
address@hidden
+#+PRIORITIES: A C B
address@hidden example
+
address@hidden Breaking down tasks, Checkboxes, Priorities, TODO items
address@hidden Breaking tasks down into subtasks
address@hidden tasks, breaking down
+
+It is often advisable to break down large tasks into smaller, manageable
+subtasks. You can do this by creating an outline tree below a TODO
+item, with detailed subtasks on the address@hidden keep subtasks out
+of the global TODO list, see the
address@hidden Another possibility is the use
+of checkboxes to identify (a hierarchy of) a large number of subtasks
+(@pxref{Checkboxes}).
+
+
address@hidden Checkboxes, , Breaking down tasks, TODO items
address@hidden Checkboxes
address@hidden checkboxes
+
+Every item in a plain list (@pxref{Plain lists}) can be made a checkbox
+by starting it with the string @samp{[ ]}. This feature is similar to
+TODO items (@pxref{TODO items}), but 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 try Piotr Zielinski's
address@hidden Here is an example of a checkbox list.
+
address@hidden
+* TODO Organize party [3/6]
+ - call people [1/3]
+ - [ ] Peter
+ - [X] Sarah
+ - [ ] Sam
+ - [X] order food
+ - [ ] think about what music to play
+ - [X] talk to the neighbors
address@hidden example
+
address@hidden statistics, for checkboxes
address@hidden checkbox statistics
+The @samp{[3/6]} and @samp{[1/3]} in the first and second line are
+cookies indicating how many checkboxes are present in this entry, and
+how many of them have been checked off. This can give you an idea on
+how many checkboxes remain, even without opening a folded entry. The
+cookies can be placed into a headline or into (the first line of) a
+plain list item. Each cookie covers all checkboxes structurally below
+that headline/item. You have to insert the cookie yourself by typing
+either @samp{[/]} or @samp{[%]}. In the first case you get an @samp{n
+out of m} result, in the second case you get information about the
+percentage of checkboxes checked (in the above example, this would be
address@hidden and @samp{[33%], respectively}).
+
address@hidden The following commands work with checkboxes:
+
address@hidden @kbd
address@hidden C-c C-c
address@hidden C-c C-c
+Toggle checkbox at point. With prefix argument, set it to @samp{[-]},
+which is considered to be an intermediate state.
address@hidden C-c C-x C-b
address@hidden C-c C-x C-b
+Toggle checkbox at point.
address@hidden @minus
address@hidden
+If there is an active region, toggle the first checkbox in the region
+and set all remaining boxes to the same status as the first. If you
+want to toggle all boxes in the region independently, use a prefix
+argument.
address@hidden
+If the cursor is in a headline, toggle checkboxes in the region between
+this headline and the next (so @emph{not} the entire subtree).
address@hidden
+If there is no active region, just toggle the checkbox at point.
address@hidden itemize
address@hidden address@hidden
address@hidden address@hidden
+Insert a new item with a checkbox.
+This works only if the cursor is already in a plain list item
+(@pxref{Plain lists}).
address@hidden C-c #
address@hidden C-c #
+Update the checkbox statistics in the current outline entry. When
+called with a @kbd{C-u} prefix, update the entire file. Checkbox
+statistic cookies are updated automatically if you toggle checkboxes
+with @kbd{C-c C-c} and make new ones with @address@hidden If you
+delete boxes or add/change them by hand, use this command to get things
+back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
address@hidden table
+
+
address@hidden Tags, Properties and columns, TODO items, Top
address@hidden Tags
address@hidden tags
address@hidden headline tagging
address@hidden matching, tags
address@hidden sparse tree, tag based
+
+If you wish to implement a system of labels and contexts for
+cross-correlating information, an excellent way is to assign @i{tags} to
+headlines. Org-mode has extensive support for using tags.
+
+Every headline can contain a list of tags, at the end of the headline.
+Tags are normal words containing letters, numbers, @samp{_}, and
address@hidden@@}. Tags must be preceded and followed by a single colon; like
address@hidden:WORK:}. Several tags can be specified like @samp{:WORK:URGENT:}.
+
address@hidden
+* Tag inheritance:: Tags use the tree structure of the outline
+* Setting tags:: How to assign tags to a headline
+* Tag searches:: Searching for combinations of tags
address@hidden menu
+
address@hidden Tag inheritance, Setting tags, Tags, Tags
address@hidden Tag inheritance
address@hidden inheritance, of tags
address@hidden sublevels, inclusion into tags match
+
address@hidden make use of the hierarchical structure of outline trees. If a
+heading has a certain tag, all subheadings will inherit the tag as
+well. For example, in the list
+
address@hidden
+* Meeting with the French group :WORK:
+** Summary by Frank :BOSS:NOTES:
+*** TODO Prepare slides for him :ACTION:
address@hidden example
+
address@hidden
+the final heading will have the tags @samp{:WORK:}, @samp{:BOSS:},
address@hidden:NOTES:}, and @samp{:ACTION:}. When executing tag searches and
+Org-mode finds that a certain headline matches the search criterion, it
+will not check any sublevel headline, assuming that these likely also
+match, and that the list of matches can become very long. This may
+not be what you want, however, and you can influence inheritance and
+searching using the variables @code{org-use-tag-inheritance} and
address@hidden
+
address@hidden Setting tags, Tag searches, Tag inheritance, Tags
address@hidden Setting tags
address@hidden setting tags
address@hidden tags, setting
+
address@hidden address@hidden
+Tags can simply be typed into the buffer at the end of a headline.
+After a colon, @address@hidden offers completion on tags. There is
+also a special command for inserting tags:
+
address@hidden @kbd
address@hidden C-c C-c
address@hidden C-c C-c
address@hidden completion, of tags
+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
+tags in the current buffer will be aligned to that column, just to make
+things look nice. TAGS are automatically realigned after promotion,
+demotion, and TODO state changes (@pxref{TODO basics}).
address@hidden table
+
+Org will support tag insertion based on a @emph{list of tags}. By
+default this list is constructed dynamically, containing all tags
+currently used in the buffer. You may also globally specify a hard list
+of tags with the variable @code{org-tag-alist}. Finally you can set
+the default tags for a given file with lines like
+
address@hidden
+#+TAGS: @@WORK @@HOME @@TENNISCLUB
+#+TAGS: Laptop Car PC Sailboat
address@hidden example
+
+If you have globally defined your preferred set of tags using the
+variable @code{org-tag-alist}, but would like to use a dynamic tag list
+in a specific file: Just add an empty TAGS option line to that file:
+
address@hidden
+#+TAGS:
address@hidden 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
+
address@hidden
+(setq org-tag-alist '(("@@WORK" . ?w) ("@@HOME" . ?h) ("Laptop" . ?l)))
address@hidden lisp
+
address@hidden or on a per-file basis with
+
address@hidden
+#+TAGS: @@WORK(w) @@HOME(h) @@TENNISCLUB(t) Laptop(l) PC(p)
address@hidden example
+
address@hidden
+You can also group together tags that are mutually exclusive. With
+curly address@hidden @code{org-mode-alist} use
address@hidden'(:startgroup)} and @code{'(:endgroup)}, respectively. Several
+groups are allowed.}
+
address@hidden
+#+TAGS: @{ @@WORK(w) @@HOME(h) @@TENNISCLUB(t) @} Laptop(l) PC(p)
address@hidden example
+
address@hidden you indicate that at most one of @samp{@@WORK}, @samp{@@HOME},
+and @samp{@@TENNISCLUB} should be selected.
+
address@hidden 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 legal tags
+with corresponding address@hidden will automatically be assigned to
+tags which have no configured keys.}. In this interface, you can use
+the following keys:
+
address@hidden @kbd
address@hidden a-z...
+Pressing keys assigned to tags will add or remove them from the list of
+tags in the current line. Selecting a tag in a group of mutually
+exclusive tags will turn off any other tags from that group.
address@hidden @key{TAB}
address@hidden @key{TAB}
+Enter a tag in the minibuffer, even if the tag is not in the predefined
+list. You will be able to complete on all tags present in the buffer.
address@hidden @key{SPC}
address@hidden @key{SPC}
+Clear all tags for this line.
address@hidden @key{RET}
address@hidden @key{RET}
+Accept the modified set.
address@hidden C-g
+Abort without installing changes.
address@hidden q
+If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
address@hidden !
+Turn off groups of mutually exclusive tags. Use this to (as an
+exception) assign several tags from such a group.
address@hidden C-c
+Toggle auto-exit after the next change (see below).
+If you are using expert mode, the first @kbd{C-c} will display the
+selection window.
address@hidden table
+
address@hidden
+This method lets you assign tags to a headline with very few keys. With
+the above setup, you could clear the current tags and set @samp{@@HOME},
address@hidden and @samp{PC} tags with just the following keys: @kbd{C-c
+C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@HOME} to
address@hidden@@WORK} would be done with @kbd{C-c C-c w @key{RET}} or
+alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
address@hidden could be done with @kbd{C-c C-c @key{TAB} S a r a h
address@hidden @key{RET}}.
+
+If you find that most of the time, you need only a single keypress to
+modify your list of tags, set the variable
address@hidden Then you no longer have to
+press @key{RET} to exit fast tag selection - it will immediately exit
+after the first change. If you then occasionally need more keys, press
address@hidden to turn off auto-exit for the current tag selection process
+(in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
+C-c}). If you set the variable to the value @code{expert}, the special
+window is not even shown for single-key tag selection, it comes up only
+when you press an extra @kbd{C-c}.
+
address@hidden Tag searches, , Setting tags, Tags
address@hidden Tag searches
address@hidden tag searches
address@hidden searching for tags
+
+Once a tags system has been set up, it can be used to collect related
+information into special lists.
+
address@hidden @kbd
address@hidden C-c \
address@hidden C-c \
+Create a sparse tree with all headlines matching a tags search. With a
address@hidden prefix argument, ignore headlines that are not a TODO line.
address@hidden C-c a m
address@hidden C-c a m
+Create a global list of tag matches from all agenda files.
address@hidden tags and properties}.
address@hidden C-c a M
address@hidden C-c a M
+Create a global list of tag matches from all agenda files, but check
+only TODO items and force checking subitems (see variable
address@hidden).
address@hidden table
+
address@hidden Boolean logic, for tag searches
+A @i{tags} search string can use Boolean operators @samp{&} for AND and
address@hidden|} for OR. @samp{&} binds more strongly than @samp{|}.
+Parenthesis are currently not implemented. A tag may also be preceded
+by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
+positive selection. The AND operator @samp{&} is optional when @samp{+}
+or @samp{-} is present. Examples:
+
address@hidden @samp
address@hidden +WORK-BOSS
+Select headlines tagged @samp{:WORK:}, but discard those also tagged
address@hidden:BOSS:}.
address@hidden WORK|LAPTOP
+Selects lines tagged @samp{:WORK:} or @samp{:LAPTOP:}.
address@hidden WORK|LAPTOP&NIGHT
+Like before, but require the @samp{:LAPTOP:} lines to be tagged also
address@hidden
address@hidden table
+
address@hidden TODO keyword matching, with tags search
+If you are using multi-state TODO keywords (@pxref{TODO extensions}), it
+can be useful to also match on the TODO keyword. This can be done by
+adding a condition after a slash to a tags match. The syntax is similar
+to the tag matches, but should be applied with consideration: For
+example, a positive selection on several TODO keywords can not
+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{!}.
+Examples:
+
address@hidden @samp
address@hidden WORK/WAITING
+Select @samp{:WORK:}-tagged TODO lines with the specific TODO
+keyword @samp{WAITING}.
address@hidden WORK/!-WAITING-NEXT
+Select @samp{:WORK:}-tagged TODO lines that are neither @samp{WAITING}
+nor @samp{NEXT}
address@hidden WORK/+WAITING|+NEXT
+Select @samp{:WORK:}-tagged TODO lines that are either @samp{WAITING} or
address@hidden
address@hidden table
+
address@hidden regular expressions, with tags search
+Any element of the tag/todo match can be a regular expression - in this
+case it must be enclosed in curly braces. For example,
address@hidden@address@hidden matches headlines that contain the tag
address@hidden and any tag @i{starting} with @samp{BOSS}.
+
address@hidden level, require for tags match
+You can also require a headline to be of a certain level, by writing
+instead of any TAG an expression like @samp{LEVEL=3}. For example, a
+search @samp{+LEVEL=3+BOSS/-DONE} lists all level three headlines that
+have the tag BOSS and are @emph{not} marked with the todo keyword DONE.
+
address@hidden Properties and columns, Timestamps, Tags, Top
address@hidden Properties and Columns
address@hidden properties
+
+Properties are a set of key-value pairs associated with an entry. There
+are two main applications for properties in Org-mode. First, properties
+are like tags, but with a value. For example, in 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:}, it can be more
+efficient to use a property @code{RELEASE} with a value @code{1.0} or
address@hidden Second, you can use properties to implement (very basic)
+database capabilities in an Org-mode 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}).
+
address@hidden
+* Property syntax:: How properties are spelled out
+* Special properties:: Access to other Org-mode features
+* Property searches:: Matching property values
+* Column view:: Tabular viewing and editing
+* Property API:: Properties for Lisp programmers
address@hidden menu
+
address@hidden Property syntax, Special properties, Properties and columns,
Properties and columns
address@hidden Property Syntax
address@hidden property syntax
address@hidden drawer, for properties
+
+Properties are key-value pairs. They need to be inserted into a special
+drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
+is specified on a single line, with the key (surrounded by colons)
+first, and the value after it. Here is an example:
+
address@hidden
+* CD collection
+** Classic
+*** Goldberg Variations
+ :PROPERTIES:
+ :Title: Goldberg Variations
+ :Composer: J.S. Bach
+ :Artist: Glen Gould
+ :Publisher: Deutsche Grammphon
+ :NDisks: 1
+ :END:
address@hidden example
+
+You may define the allowed values for a particular property @samp{XYZ}
+by setting a property @samp{XYZ_ALL}. This special property is
address@hidden, so if you set it in a level 1 entry, it will apply to
+the entire tree. When allowed values are defined, setting the
+corresponding property becomes easier and is less prone to typing
+errors. For the example with the CD collection, we can predefine
+publishers and the number of disks in a box like this:
+
address@hidden
+* CD collection
+ :PROPERTIES:
+ :NDisks_ALL: 1 2 3 4
+ :Publisher_ALL: "Deutsche Grammophon" Phillips EMI
+ :END:
address@hidden example
+
+If you want to set properties that can be inherited by any entry in a
+file, use a line like
+
address@hidden
+#+PROPERTY: NDisks_ALL 1 2 3 4
address@hidden example
+
+Property values set with the global variable
address@hidden can be inherited by all entries in all
+Org-mode files.
+
address@hidden
+The following commands help to work with properties:
+
address@hidden @kbd
address@hidden address@hidden
address@hidden address@hidden
+After an initial colon in a line, complete property keys. All keys used
+in the current file will be offered as possible completions.
address@hidden M-x org-insert-property-drawer
+Insert a property drawer into the current entry. The drawer will be
+inserted early in the entry, but after the lines with planning
+information like deadlines.
address@hidden C-c C-c
address@hidden C-c C-c
+With the cursor in a property drawer, this executes property commands.
address@hidden C-c C-c s
+Set a property in the current entry. Both the property and the value
+can be inserted using completion.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden/@key{right}
+Switch property at point to the next/previous allowed value.
address@hidden C-c C-c d
+Remove a property from the current entry.
address@hidden C-c C-c D
+Globally remove a property, from all entries in the current file.
address@hidden table
+
address@hidden Special properties, Property searches, Property syntax,
Properties and columns
address@hidden Special Properties
address@hidden properties, special
+
+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}). The following
+property names are special and should not be used as keys in the
+properties drawer:
+
address@hidden
+TODO @r{The TODO keyword of the entry.}
+TAGS @r{The tags defined directly in the headline.}
+ALLTAGS @r{All tags, including inherited ones.}
+PRIORITY @r{The priority of the entry, a string with a single letter.}
+DEADLINE @r{The deadline time string, without the angular brackets.}
+SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
address@hidden example
+
address@hidden Property searches, Column view, Special properties, Properties
and columns
address@hidden Property searches
address@hidden properties, searching
+
+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
+
address@hidden
++WORK-BOSS+PRIORITY="A"+coffee="unlimited"address@hidden|address@hidden
address@hidden example
+
address@hidden
+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}, and a @samp{:with:} property that is matched by
+the regular expression @samp{Sarah\|Denny}.
+
address@hidden Column view, Property API, Property searches, Properties and
columns
address@hidden Column View
+
+A great way to view and edit properties in an outline tree is
address@hidden 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
+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
+view (@address@hidden address@hidden, or simply @kbd{c} while column view
+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
+queries have collected selected items, possibly from a number of files.
+
address@hidden
+* Defining columns:: The COLUMNS format property
+* Using column view:: How to create and use column view
address@hidden menu
+
address@hidden Defining columns, Using column view, Column view, Column view
address@hidden Defining Columns
address@hidden column view, for properties
address@hidden properties, column view
+
+Setting up a column view first requires defining the columns. This is
+done by defining a column format line.
+
address@hidden
+* Scope of column definitions:: Where defined, where valid?
+* Column attributes:: Appearance and content of a column
address@hidden menu
+
address@hidden Scope of column definitions, Column attributes, Defining
columns, Defining columns
address@hidden Scope of column definitions
+
+To define a column format for an entire file, use a line like
+
address@hidden
+#+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
address@hidden example
+
+To specify a format that only applies to a specific tree, add a COLUMNS
+property to the top node of that tree, for example
address@hidden
+** Top node for columns view
+ :PROPERTIES:
+ :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
+ :END:
address@hidden example
+
+If a @code{COLUMNS} property is present in an entry, it defines columns
+for the entry itself, and for the entire subtree below it. Since the
+column definition is part of the hierarchical structure of the document,
+you can define columns on level 1 that are general enough for all
+sublevels, and more specific columns further down, when you edit a
+deeper part of the tree.
+
address@hidden Column attributes, , Scope of column definitions, Defining
columns
address@hidden Column attributes
+A column definition sets the attributes of a column. The general
+definition looks like this:
+
address@hidden
+ %[width]property[(title)address@hidden@}]
address@hidden example
+
address@hidden
+Except for the percent sign and the property name, all items are
+optional. The individual parts have the following meaning:
+
address@hidden
+width @r{An integer specifying the width of the column in
characters.}
+ @r{If omitted, the width will be determined automatically.}
+property @r{The property that should be edited in this column.}
+(title) @r{The header text for the column. If omitted, the}
+ @r{property name is used.}
address@hidden@} @r{The summary type. If specified, the column values for}
+ @r{parent nodes are computed from the children.}
+ @r{Supported summary types are:}
+ @address@hidden @r{Sum numbers in this column.}
+ @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
+ @address@hidden @r{Checkbox status, [X] if all children are
[X].}
address@hidden example
+
address@hidden
+Here is an example for a complete columns definition, along with allowed
+values.
+
address@hidden
+:COLUMNS: %20ITEM %9Approved(Approved?)@address@hidden %Owner %11Status
address@hidden:@}
+:Owner_ALL: Tammy Mark Karl Lisa Don
+:Status_ALL: "In progress" "Not started yet" "Finished" ""
+:Approved_ALL: "[ ]" "[X]"
address@hidden example
+
+The first column, @samp{%25ITEM}, means the first 25 characters of the
+item itself, i.e. of the headline. You probably always should start the
+column definition with the ITEM specifier. The other specifiers create
+columns @samp{Owner} with a list of names as allowed values, for
address@hidden with four different possible values, and for a checkbox
+field @samp{Approved}. When no width is given after the @samp{%}
+character, the column will be exactly as wide as it needs to be in order
+to fully display all values. The @samp{Approved} column does have a
+modified title (@samp{Approved?}, with a question mark). Summaries will
+be created for the @samp{Time_Spent} column by adding time duration
+expressions like HH:MM, and for the @samp{Approved} column, by providing
+an @samp{[X]} status if all children have been checked.
+
address@hidden Using column view, , Defining columns, Column view
address@hidden Using Column View
+
address@hidden @kbd
address@hidden column view on and off}
address@hidden C-c C-x C-c
address@hidden C-c C-x C-c
+Create the column view for the local environment. This command searches
+the hierarchy, up from point, for a @code{COLUMNS} property that defines
+a format. When one is found, the column view table is established for
+the entire tree, starting from the entry that contains the @code{COLUMNS}
+property. If none is found, the format is taken from the @code{#+COLUMNS}
+line or from the variable @code{org-columns-default-format}, and column
+view is established for the current entry and its subtree.
address@hidden q
address@hidden q
+Exit column view.
address@hidden values}
address@hidden @key{left} @key{right} @key{up} @key{down}
+Move through the column view from field to field.
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden/@key{right}
+Switch to the next/previous allowed value of the field. For this, you
+have to have specified allowed values for a property.
address@hidden n
address@hidden p
address@hidden n / p
+Same as @address@hidden/@key{right}}
address@hidden e
address@hidden e
+Edit the property at point. For the special properties, this will
+invoke the same interface that you normally use to change that
+property. For example, when editing a TAGS property, the tag completion
+or fast selection interface will pop up.
address@hidden v
address@hidden v
+View the full value of this property. This is useful if the width of
+the column is smaller than that of the value.
address@hidden a
address@hidden a
+Edit the list of allowed values for this property. If the list is found
+in the hierarchy, the modified values is stored there. If no list is
+found, the new value is stored in the first entry that is part of the
+current column view.
address@hidden the table structure}
address@hidden <
address@hidden >
address@hidden < / >
+Make the column narrower/wider by one character.
address@hidden address@hidden
address@hidden address@hidden
+Insert a new column, to the right of the current column.
address@hidden address@hidden
address@hidden address@hidden
+Delete the current column.
address@hidden table
+
address@hidden Property API, , Column view, Properties and columns
address@hidden The Property API
address@hidden properties, API
address@hidden API, for properties
+
+There is a full API for accessing and changing properties. This API can
+be used by Emacs Lisp programs to work with properties and to implement
+features based on them. For more information see @ref{Using the
+property API}.
+
address@hidden Timestamps, Agenda views, Properties and columns, Top
address@hidden Timestamps
address@hidden time stamps
address@hidden date stamps
+
+Items can be labeled with timestamps to make them useful for project
+planning.
+
address@hidden
+* Time stamps:: Assigning a time to a tree entry
+* Creating timestamps:: Commands which insert timestamps
+* Deadlines and scheduling:: Planning your work
+* Progress logging:: Documenting when what work was done.
address@hidden menu
+
+
address@hidden Time stamps, Creating timestamps, Timestamps, Timestamps
address@hidden Time stamps, deadlines and scheduling
address@hidden time stamps
address@hidden ranges, time
address@hidden date stamps
address@hidden deadlines
address@hidden scheduling
+
+A time stamp is a specification of a date (possibly with time or a range
+of times) in a special format, either @samp{<2003-09-16 Tue>} or
address@hidden<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
+12:00-12:30>address@hidden is the standard ISO date/time format. If
+you cannot get used to these, see @ref{Custom time format}}. A time
+stamp can appear anywhere in the headline or body of an org-tree entry.
+Its presence causes entries to be shown on specific dates in the agenda
+(@pxref{Weekly/Daily agenda}). We distinguish:
+
address@hidden @var
address@hidden Plain time stamp
address@hidden timestamp
+A simple time stamp just assigns a date/time to an item. This is just
+like writing down an appointment in a paper agenda, or like writing down
+an event in a diary, when you want to take note of when something
+happened. In the timeline and agenda displays, the headline of an entry
+associated with a plain time stamp will be shown exactly on that date.
+
address@hidden
+* Meet Peter at the movies <2006-11-01 Wed 19:15>
+* Discussion on climate change <2006-11-02 Thu 20:00-22:00>
address@hidden example
+
address@hidden Time stamp with repeater interval
address@hidden timestamp, with repeater interval
+A time stamp may contain a @emph{repeater interval}, indicating that it
+applies not only on the given date, but again and again after a certain
+interval of N days (d), weeks (w), months(m), or years(y). The
+following will show up in the agenda every Wednesday:
+
address@hidden
+* Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
address@hidden example
+
address@hidden Diary-style sexp entries
+For more complex date specifications, Org-mode supports using the
+special sexp diary entries implemented in the Emacs calendar/diary
+package. For example
+
address@hidden
+* The nerd meeting on every 2nd Thursday of the month
+ <%%(diary-float t 4 2)>
address@hidden example
+
address@hidden Time/Date range
address@hidden timerange
address@hidden date range
+Two time stamps connected by @samp{--} denote a range. The headline
+will be shown on the first and last day of the range, and on any dates
+that are displayed and fall in the range. Here is an example:
+
address@hidden
+** Meeting in Amsterdam
+ <2004-08-23 Mon>--<2004-08-26 Thu>
address@hidden example
+
address@hidden Inactive time stamp
address@hidden timestamp, inactive
address@hidden inactive timestamp
+Just like a plain time stamp, but with square brackets instead of
+angular ones. These time stamps are inactive in the sense that they do
address@hidden trigger an entry to show up in the agenda.
+
address@hidden
+* Gillian comes late for the fifth time [2006-11-01 Wed]
address@hidden example
+
address@hidden table
+
address@hidden Creating timestamps, Deadlines and scheduling, Time stamps,
Timestamps
address@hidden Creating timestamps
address@hidden creating timestamps
address@hidden timestamps, creating
+
+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.
+
address@hidden @kbd
address@hidden C-c .
address@hidden C-c .
+Prompt for a date and insert a corresponding time stamp. When the
+cursor is at a previously used time stamp, it is updated to NOW. When
+this command is used twice in succession, a time range is inserted.
address@hidden
address@hidden C-u C-c .
address@hidden C-u C-c .
+Like @kbd{C-c .}, but use the alternative format which contains date
+and time. The default time can be rounded to multiples of 5 minutes,
+see the option @code{org-time-stamp-rounding-minutes}.
address@hidden
address@hidden C-c !
address@hidden C-c !
+Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
+an agenda entry.
address@hidden
address@hidden C-c <
address@hidden C-c <
+Insert a time stamp corresponding to the cursor date in the Calendar.
address@hidden
address@hidden C-c >
address@hidden C-c >
+Access the Emacs calendar for the current date. If there is a
+timestamp in the current line, goto the corresponding date
+instead.
address@hidden
address@hidden C-c C-o
address@hidden C-c C-o
+Access the agenda for the date given by the time stamp or -range at
+point (@pxref{Weekly/Daily agenda}).
address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Change date at cursor by one day. These key bindings conflict with
+CUA-mode (@pxref{Conflicts}).
address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Change the item under the cursor in a timestamp. The cursor can be on a
+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}).
address@hidden
address@hidden C-c C-y
address@hidden evaluate time range
address@hidden 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).
address@hidden table
+
+
address@hidden
+* The date/time prompt:: How org-mode helps you entering date and time
+* Custom time format:: Making dates look differently
address@hidden menu
+
address@hidden The date/time prompt, Custom time format, Creating timestamps,
Creating timestamps
address@hidden The date/time prompt
address@hidden date, reading in minibuffer
address@hidden time, reading in minibuffer
+
+When Org-mode prompts for a date/time, the prompt suggests to enter an
+ISO date. But it will in fact accept any string containing some date
+and/or time information. You can, for example, use @kbd{C-y} to paste a
+(possibly multi-line) string copied from an email message. Org-mode
+will find whatever information is in there and will replace anything not
+specified with the current date and time. For example:
+
address@hidden
+ 3-2-5 --> 2003-02-05
+ feb 15 --> currentyear-02-15
+ sep 12 9 --> 2009-09-12
+ 12:45 --> today 12:45
+ 22 sept 0:34 --> currentyear-09-22 0:34
+ 12 --> currentyear-currentmonth-12
+ Fri --> nearest Friday (today or later)
+ +4 --> 4 days from now (if +N is the only thing given)
address@hidden example
+
+The function understands English month and weekday abbreviations. If
+you want to use unabbreviated names and/or other languages, configure
+the variables @code{parse-time-months} and @code{parse-time-weekdays}.
+
address@hidden calendar, for selecting date
+Parallel to the minibuffer prompt, a calendar is popped address@hidden
+you don't need/want the calendar, configure the variable
address@hidden When you exit the date
+prompt, either by clicking on a date in the calendar, or by pressing
address@hidden, the date selected in the calendar will be combined with the
+information entered at the prompt. You can control the calendar fully
+from the minibuffer:
+
address@hidden @kbd
address@hidden <
address@hidden <
+Scroll calendar backwards by one month.
address@hidden >
address@hidden >
+Scroll calendar forwards by one month.
address@hidden mouse-1
address@hidden mouse-1
+Select date by clicking on it.
address@hidden address@hidden
address@hidden address@hidden
+One day forward.
address@hidden address@hidden
address@hidden address@hidden
+One day back.
address@hidden address@hidden
address@hidden address@hidden
+One week forward.
address@hidden address@hidden
address@hidden address@hidden
+One week back.
address@hidden address@hidden
address@hidden address@hidden
+One month forward.
address@hidden address@hidden
address@hidden address@hidden
+One month back.
address@hidden @key{RET}
address@hidden @key{RET}
+Choose date in calendar (only if nothing was typed into minibuffer).
address@hidden table
+
address@hidden Custom time format, , The date/time prompt, Creating timestamps
address@hidden Custom time format
address@hidden custom date/time format
address@hidden time format, custom
address@hidden date format, custom
+
+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
address@hidden
+
address@hidden @kbd
address@hidden C-c C-x C-t
address@hidden C-c C-x C-t
+Toggle the display of custom formats for dates and times.
address@hidden table
+
address@hidden
+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
address@hidden the default format using text properties. This has the
+following consequences:
address@hidden @bullet
address@hidden
+You cannot place the cursor onto a time stamp anymore, only before or
+after.
address@hidden
+The @address@hidden/@key{down}} keys can no longer be used to adjust
+each component of a time stamp. If the cursor is at the beginning of
+the stamp, @address@hidden/@key{down}} will change the stamp by one day,
+just like @address@hidden/@key{right}}. At the end of the stamp, the
+time will be changed by one minute.
address@hidden
+If the time stamp contains a range of clock times or a repeater, these
+will not be overlayed, but remain in the buffer as they were.
address@hidden
+When you delete a time stamp character-by-character, it will only
+disappear from the buffer after @emph{all} (invisible) characters
+belonging to the ISO timestamp have been removed.
address@hidden
+If the custom time stamp format is longer than the default and you are
+using dates in tables, table alignment will be messed up. If the custom
+format is shorter, things do work as expected.
address@hidden itemize
+
+
address@hidden Deadlines and scheduling, Progress logging, Creating timestamps,
Timestamps
address@hidden Deadlines and Scheduling
+
+A time stamp may be preceded by special keywords to facilitate planning
+of work:
+
address@hidden @var
address@hidden DEADLINE
address@hidden DEADLINE keyword
+The task (most likely a TODO item) is supposed to be finished on that
+date, and it will be listed then. In addition, the compilation for
address@hidden will carry a warning about the approaching or missed
+deadline, starting @code{org-deadline-warning-days} before the due date,
+and continuing until the entry is marked DONE. An example:
+
address@hidden
+*** TODO write article about the Earth for the Guide
+ The editor in charge is [[bbdb:Ford Prefect]]
+ DEADLINE: <2004-02-29 Sun>
address@hidden example
+
+You can specify a different lead time for warnings for a specific
+deadlines using the following syntax. Here is an example with a warning
+period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
+
address@hidden SCHEDULED
address@hidden SCHEDULED keyword
+You are planning to start working on that task on the given date. The
+headline will be listed under the given address@hidden will still be
+listed on that date after it has been marked DONE. If you don't like
+this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
+addition, a reminder that the scheduled date has passed will be present
+in the compilation for @emph{today}, until the entry is marked DONE.
+I.e., the task will automatically be forwarded until completed.
+
address@hidden
+*** TODO Call Trillian for a date on New Years Eve.
+ SCHEDULED: <2004-12-25 Sat>
address@hidden example
address@hidden table
+
address@hidden
+* Inserting deadline/schedule:: Planning items
+* Repeated tasks:: Items that show up again and again
address@hidden menu
+
address@hidden Inserting deadline/schedule, Repeated tasks, Deadlines and
scheduling, Deadlines and scheduling
address@hidden Inserting deadline/schedule
+
+The following commands allow to quickly insert a deadline or to schedule
+an item:
+
address@hidden @kbd
address@hidden
address@hidden C-c C-d
address@hidden C-c C-d
+Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
+happen in the line directly following the headline.
address@hidden FIXME Any CLOSED timestamp will be removed.????????
address@hidden
address@hidden C-c C-w
address@hidden sparse tree, for deadlines
address@hidden C-c C-w
+Create a sparse tree with all deadlines that are either past-due, or
+which will become due within @code{org-deadline-warning-days}.
+With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
+prefix, check that many days. For example, @kbd{C-1 C-c C-w} shows
+all deadlines due tomorrow.
address@hidden
address@hidden C-c C-s
address@hidden C-c C-s
+Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
+happen in the line directly following the headline. Any CLOSED
+timestamp will be removed.
address@hidden table
+
address@hidden Repeated tasks, , Inserting deadline/schedule, Deadlines and
scheduling
address@hidden Repeated Tasks
+
+Some tasks need to be repeated again and again, and Org-mode therefore
+allows to use a repeater in a DEADLINE or SCHEDULED time stamp, for
+example:
address@hidden
+** TODO Pay the rent
+ DEADLINE: <2005-10-01 Sat +1m>
address@hidden example
+
+Deadlines and scheduled items produce entries in the agenda when they
+are over-due, so it is important to be able to mark such an entry as
+completed once you have done so. When you mark a DEADLINE or a SCHEDULE
+with the todo keyword DONE, it will no longer produce entries in the
+agenda. The problem with this is, however, that then also the
address@hidden instance of the repeated entry will not be active. Org-mode
+deals with this in the following way: When you try to mark such an entry
+DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
+time stamp by the repeater interval, and immediately set the entry state
+back to TODO. In the example above, setting the state to DONE would
+actually switch the date like this:
+
address@hidden
+** TODO Pay the rent
+ DEADLINE: <2005-11-01 Tue +1m>
address@hidden example
+
+You will also be prompted for a note that will be put under the DEADLINE
+line to keep a record that you actually acted on the previous instance
+of this deadline.
+
+As a consequence of shifting the base date, this entry will no longer be
+visible in the agenda when checking past dates, but all future instances
+will be visible.
+
+You may have both scheduling and deadline information for a specific
+task - just make sure that the repeater intervals on both are the same.
+
address@hidden Progress logging, , Deadlines and scheduling, Timestamps
address@hidden Progress Logging
address@hidden progress logging
address@hidden logging, of progress
+
+Org-mode can automatically record a time stamp when you mark a TODO item
+as DONE, or even each time when you change the state of a TODO item.
+You can also measure precisely the time you spent on specific items in a
+project by starting and stopping a clock when you start and stop working
+on an aspect of a project.
+
address@hidden
+* Closing items:: When was this entry marked DONE?
+* Tracking TODO state changes:: When did the status change?
+* Clocking work time:: When exactly did you work on this item?
address@hidden menu
+
address@hidden Closing items, Tracking TODO state changes, Progress logging,
Progress logging
address@hidden Closing items
+
+If you want to keep track of @emph{when} a certain TODO item was
+finished, turn on logging address@hidden corresponding in-buffer
+setting is: @code{#+STARTUP: logdone}}
+
address@hidden
+(setq org-log-done t)
address@hidden lisp
+
address@hidden
+Then each time you turn a TODO entry into DONE using either @kbd{C-c
+C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line
address@hidden: [timestamp]} will be inserted just after the headline. If
+you turn the entry back into a TODO item through further state cycling,
+that line will be removed again. In the timeline (@pxref{Timeline}) and
+in the agenda (@pxref{Weekly/Daily agenda}), you can then use the
address@hidden key to display the TODO items closed on each day, giving you an
+overview of what has been done on a day. If you want to record a note
+along with the timestamp, address@hidden corresponding in-buffer
+setting is: @code{#+STARTUP: lognotedone}}
+
address@hidden
+(setq org-log-done '(done))
address@hidden lisp
+
address@hidden Tracking TODO state changes, Clocking work time, Closing items,
Progress logging
address@hidden Tracking TODO state changes
+
+When TODO keywords are used as workflow states (@pxref{Workflow
+states}), you might want to keep track of when a state change occurred,
+and you may even want to attach notes to that state change. With the
+setting
+
address@hidden
+(setq org-log-done '(state))
address@hidden lisp
+
address@hidden
+each state change will prompt you for a note that will be attached to
+the current headline. Very likely you do not want this verbose tracking
+all the time, so it is probably better to configure this behavior with
+in-buffer options. For example, if you are tracking purchases, put
+these into a separate file that starts with:
+
address@hidden
+#+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
+#+STARTUP: lognotestate
address@hidden example
+
+
address@hidden Clocking work time, , Tracking TODO state changes, Progress
logging
address@hidden Clocking work time
+
+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
+also computes the total time spent on each subtree of a project.
+
address@hidden @kbd
address@hidden C-c C-x C-i
address@hidden C-c C-x C-i
+Start the clock on the current item (clock-in). This inserts the CLOCK
+keyword together with a timestamp.
address@hidden C-c C-x C-o
address@hidden C-c C-x C-o
+Stop the clock (clock-out). The inserts another timestamp at the same
+location where the clock was last started. It also directly computes
+the resulting time in inserts it after the time range as @samp{=>
+HH:MM}. See the variable @code{org-log-done} for the possibility to
+record an additional note together with the clock-out time
address@hidden corresponding in-buffer setting is: @code{#+STARTUP:
+lognoteclock-out}}.
address@hidden C-c C-y
address@hidden C-c C-y
+Recompute the time interval after changing one of the time stamps. This
+is only necessary if you edit the time stamps directly. If you change
+them with @address@hidden keys, the update is automatic.
address@hidden C-c C-t
address@hidden C-c C-t
+Changing the TODO state of an item to DONE automatically stops the clock
+if it is running in this same item.
address@hidden C-c C-x C-x
address@hidden C-c C-x C-x
+Cancel the current clock. This is useful if a clock was started by
+mistake, or if you ended up working on something else.
address@hidden C-c C-x C-d
address@hidden C-c C-x C-d
+Display time summaries for each subtree in the current buffer. This
+puts overlays at the end of each headline, showing the total time
+recorded under that heading, including the time of any subheadings. You
+can use visibility cycling to study the tree, but the overlays disappear
+when you change the buffer (see variable
address@hidden) or press @kbd{C-c C-c}.
address@hidden C-c C-x C-r
address@hidden 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.
address@hidden
+#+BEGIN: clocktable :maxlevel 2 :emphasize nil
+
+#+END: clocktable
address@hidden example
address@hidden
+If such a block already exists, its content is replaced by the new
+table. The @samp{BEGIN} line can specify options:
address@hidden
+:maxlevels @r{Maximum level depth to which times are listed in the table.}
+:emphasize @r{When @code{t}, emphasize level one and level two items}
+:block @r{The time block to consider. This block is specified relative}
+ @r{to the current time and may be any of these keywords:}
+ @address@hidden, @code{yesterday}, @code{thisweek},
@code{lastweek},}
+ @address@hidden, @code{lastmonth}, @code{thisyear}, or
@code{lastyear}}.
+:tstart @r{A time string specifying when to start considering times}
+:tend @r{A time string specifying when to stop considering times}
address@hidden example
+So to get a clock summary for the current day, you could write
address@hidden
+#+BEGIN: clocktable :maxlevel 2 :block today
+
+#+END: clocktable
address@hidden example
+and to use a specific time range you could address@hidden that all
+parameters must be specified in a single line - the line is broken here
+only to fit it onto the manual.}
address@hidden
+#+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
+ :tend "<2006-08-10 Thu 12:00>"
+
+#+END: clocktable
address@hidden example
address@hidden C-u C-c C-x C-u
address@hidden 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.
address@hidden table
+
+The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
+the agenda (@pxref{Weekly/Daily agenda}) to show which tasks have been
+worked on or closed during a day.
+
address@hidden Agenda views, Embedded LaTeX, Timestamps, Top
address@hidden Agenda Views
address@hidden agenda views
+
+Due to the way Org-mode 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 over open action items, or over 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
+in a separate buffer. Six different view types are provided:
+
address@hidden @bullet
address@hidden
+an @emph{agenda} that is like a calendar and shows information
+for specific dates,
address@hidden
+a @emph{TODO list} that covers all unfinished
+action items,
address@hidden
+a @emph{tags view}, showings headlines based on
+the tags associated with them,
address@hidden
+a @emph{timeline view} that shows all events in a single Org-mode file,
+in time-sorted view,
address@hidden
+a @emph{stuck projects view} showing projects that currently don't move
+along, and
address@hidden
address@hidden views} that are special tag/keyword searches and
+combinations of different views.
address@hidden itemize
+
address@hidden
+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
+edit these files remotely.
+
+Two variables control how the agenda buffer is displayed and whether the
+window configuration is restored when the agenda exits:
address@hidden and
address@hidden
+
address@hidden
+* Agenda files:: Files being searched for agenda information
+* 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
+* Custom agenda views:: Defining special searches and views
address@hidden menu
+
address@hidden Agenda files, Agenda dispatcher, Agenda views, Agenda views
address@hidden Agenda files
address@hidden agenda files
address@hidden files for agenda
+
+The information to be shown is collected from all @emph{agenda files},
+the files listed in the variable @address@hidden the
+value of that variable is not a list, but a single file name, then the
+list of agenda files will be maintained in that external file.}. Thus even
+if you only work with a single Org-mode file, this file should be put
+into that address@hidden using the dispatcher, pressing @kbd{1}
+before selecting a command will actually limit the command to the
+current file, and ignore @code{org-agenda-files} until the next
+dispatcher command.}. You can customize @code{org-agenda-files}, but
+the easiest way to maintain it is through the following commands
+
address@hidden files, adding to agenda list
address@hidden @kbd
address@hidden C-c [
address@hidden 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.
address@hidden C-c ]
address@hidden C-c ]
+Remove current file from the list of agenda files.
address@hidden C-,
address@hidden C-'
address@hidden C-,
address@hidden C-'
+Cycle through agenda file list, visiting one file after the other.
address@hidden table
+
address@hidden
+The Org menu contains the current list of files and can be used
+to visit any of them.
+
address@hidden Agenda dispatcher, Built-in agenda views, Agenda files, Agenda
views
address@hidden The agenda dispatcher
address@hidden agenda dispatcher
address@hidden dispatching agenda commands
+The views are created through a dispatcher that should be bound to a
+global key, for example @kbd{C-c a} (@pxref{Installation}). In the
+following we will assume that @kbd{C-c a} is indeed how the dispatcher
+is accessed and list keyboard access to commands accordingly. After
+pressing @kbd{C-c a}, an additional letter is required to execute a
+command. The dispatcher offers the following default commands:
address@hidden @kbd
address@hidden a
+Create the calendar-like agenda (@pxref{Weekly/Daily agenda}).
address@hidden t @r{/} T
+Create a list of all TODO items (@pxref{Global TODO list}).
address@hidden m @r{/} M
+Create a list of headlines matching a TAGS expression (@pxref{Matching
+tags and properties}).
address@hidden L
+Create the timeline view for the current buffer (@pxref{Timeline}).
address@hidden # @r{/} !
+Create a list of stuck projects (@pxref{Stuck projects}).
address@hidden 1
+Restrict an agenda command to the current buffer. After pressing
address@hidden, you still need to press the character selecting the command.
address@hidden 0
+If there is an active region, restrict the following agenda command to
+the region. Otherwise, restrict it to the current subtree. After
+pressing @kbd{0}, you still need to press the character selecting the
+command.
address@hidden table
+
+You can also define custom commands that will be accessible through the
+dispatcher, just like the default commands. This includes the
+possibility to create extended agenda buffers that contain several
+blocks together, for example the weekly agenda, the global TODO list and
+a number of special tags matches. @xref{Custom agenda views}.
+
address@hidden Built-in agenda views, Presentation and sorting, Agenda
dispatcher, Agenda views
address@hidden The built-in agenda views
+
+In this section we describe the built-in views.
+
address@hidden
+* 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
+* Stuck projects:: Find projects you need to review
address@hidden menu
+
address@hidden Weekly/Daily agenda, Global TODO list, Built-in agenda views,
Built-in agenda views
address@hidden The weekly/daily agenda
address@hidden agenda
address@hidden weekly agenda
address@hidden daily agenda
+
+The purpose of the weekly/daily @emph{agenda} is to act like a page of a
+paper agenda, showing all the tasks for the current week or day.
+
address@hidden @kbd
address@hidden org-agenda, command
address@hidden C-c a a
address@hidden C-c a a
+Compile an agenda for the current week from a list of org files. The
+agenda shows the entries for each day. With a @kbd{C-u} prefix (or
+when the variable @code{org-agenda-include-all-todo} is @code{t}), all
+unfinished TODO items (including those without a date) are also listed at
+the beginning of the buffer, before the first address@hidden
address@hidden table
+
+Remote editing from the agenda buffer means, for example, that you can
+change the dates of deadlines and appointments from the agenda buffer.
+The commands available in the Agenda buffer are listed in @ref{Agenda
+commands}.
+
address@hidden Calendar/Diary integration
address@hidden calendar integration
address@hidden diary integration
+
+Emacs contains the calendar and diary by Edward M. Reingold. The
+calendar displays a three-month calendar with holidays from different
+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
+the diary.
+
+In order to include entries from the Emacs diary into Org-mode's
+agenda, you only need to customize the variable
+
address@hidden
+(setq org-agenda-include-diary t)
address@hidden lisp
+
address@hidden 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
address@hidden 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
+well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
+Sunrise/Sunset times, show lunar phases and to convert to other
+calendars, respectively. @kbd{c} can be used to switch back and forth
+between calendar and agenda.
+
+If you are using the diary only for sexp entries and holidays, it is
+faster to not use the above setting, but instead to copy or even move
+the entries into an Org-mode file. Org-mode evaluates diary-style sexp
+entries, and does it faster because there is no overhead for first
+creating the diary display. Note that the sexp entries must start at
+the left margin, no white space is allowed before them. For example,
+the following segment of an Org-mode file will be processed and entries
+will be made in the agenda:
+
address@hidden
+* Birthdays and similar stuff
+#+CATEGORY: Holiday
+%%(org-calendar-holiday) ; special function for holiday names
+#+CATEGORY: Ann
+%%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
+%%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
address@hidden example
+
address@hidden Global TODO list, Matching tags and properties, Weekly/Daily
agenda, Built-in agenda views
address@hidden The global TODO list
address@hidden global TODO list
address@hidden TODO list, global
+
+The global TODO list contains all unfinished TODO items, formatted and
+collected into a single place.
+
address@hidden @kbd
address@hidden C-c a t
address@hidden 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
address@hidden, so there are commands to examine and manipulate
+the TODO entries directly from that buffer (@pxref{Agenda commands}).
address@hidden C-c a T
address@hidden C-c a T
address@hidden TODO keyword matching
+Like the above, but allows selection of a specific TODO keyword. You
+can also do this by specifying a prefix argument to @kbd{C-c a t}. With
+a @kbd{C-u} prefix you are prompted for a keyword, and you may also
+specify several keywords by separating them with @samp{|} as boolean OR
+operator. With a numeric prefix, the Nth keyword in
address@hidden is selected.
address@hidden r
+The @kbd{r} key in the agenda buffer regenerates it, and you can give
+a prefix argument to this command to change the selected TODO keyword,
+for example @kbd{3 r}. If you often need a search for a specific
+keyword, define a custom command for it (@pxref{Agenda
dispatcher})address@hidden
+Matching specific TODO keywords can also be done as part of a tags
+search (@pxref{Tag searches}).
address@hidden table
+
+Remote editing of TODO items means that you can change the state of a
+TODO entry with a single key press. The commands available in the
+TODO list are described in @ref{Agenda commands}.
+
address@hidden 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:
address@hidden @minus
address@hidden
+Some people view a TODO item that has been @emph{scheduled} for
+execution (@pxref{Time stamps}) as no longer @emph{open}. Configure the
+variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled
+items from the global TODO list.
address@hidden
+TODO items may have sublevels to break up the task into subtasks. In
+such cases it may be enough to list only the highest level TODO headline
+and omit the sublevels from the global list. Configure the variable
address@hidden to get this behavior.
address@hidden itemize
+
address@hidden Matching tags and properties, Timeline, Global TODO list,
Built-in agenda views
address@hidden Matching Tags and Properties
address@hidden matching, of tags
address@hidden matching, of properties
address@hidden tags view
+
+If headlines in the agenda files are marked with @emph{tags}
+(@pxref{Tags}), you can select headlines based on the tags that apply
+to them and collect them into an agenda buffer.
+
address@hidden @kbd
address@hidden C-c a m
address@hidden C-c a m
+Produce a list of all headlines that match a given set of tags. The
+command prompts for a selection criterion, which is a boolean logic
+expression with tags, like @samp{+WORK+URGENT-WITHBOSS} or
address@hidden|HOME} (@pxref{Tags}). If you often need a specific search,
+define a custom command for it (@pxref{Agenda dispatcher}).
address@hidden C-c a M
address@hidden 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
address@hidden). Matching specific todo keywords
+together with a tags match is also possible, see @ref{Tag searches}.
address@hidden table
+
+The commands available in the tags list are described in @ref{Agenda
+commands}.
+
address@hidden Timeline, Stuck projects, Matching tags and properties, Built-in
agenda views
address@hidden Timeline for a single file
address@hidden timeline, single file
address@hidden time-sorted view
+
+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.
+
address@hidden @kbd
address@hidden C-c a L
address@hidden C-c a L
+Show a time-sorted view of the org file, with all time-stamped items.
+When called with a @kbd{C-u} prefix, all unfinished TODO entries
+(scheduled or not) are also listed under the current date.
address@hidden table
+
address@hidden
+The commands available in the timeline buffer are listed in
address@hidden commands}.
+
+
address@hidden Stuck projects, , Timeline, Built-in agenda views
address@hidden Stuck projects
+
+If you are following a system like David Allen's GTD to organize your
+work, one of the ``duties'' you have is a regular review to make sure
+that all projects move along. A @emph{stuck} project is a project that
+has no defined next actions, so it will never show up in the TODO lists
+Org-mode produces. During the review, you need to identify such
+projects and define next actions for them.
+
address@hidden @kbd
address@hidden C-c a #
address@hidden C-c a #
+List projects that are stuck.
address@hidden C-c a !
address@hidden C-c a !
+Customize the variable @code{org-stuck-projects} to define what a stuck
+project is and how to find it.
address@hidden table
+
+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
+indicate a project that should not be considered yet. Lets further
+assume that the todo keyword DONE marks finished projects, and that NEXT
+and TODO indicate next actions. The tag @@SHOP indicates shopping and
+is a next action even without the NEXT tag. Finally, if the project
+contains the special word IGNORE anywhere, it should not be listed
+either. In this case you would start by identifying eligible projects
+with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
+TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
+are not stuck. The correct customization for this is
+
address@hidden
+(setq org-stuck-projects
+ '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
+ "\\<IGNORE\\>"))
address@hidden lisp
+
+
address@hidden Presentation and sorting, Agenda commands, Built-in agenda
views, Agenda views
address@hidden Presentation and sorting
address@hidden presentation, of agenda items
+
+Before displaying items in an agenda view, Org-mode visually prepares
+the items and sorts them. Each item occupies a single line. The line
+starts with a @emph{prefix} that contains the @emph{category}
+(@pxref{Categories}) of the item and other important information. You can
+customize the prefix using the option @code{org-agenda-prefix-format}.
+The prefix is followed by a cleaned-up version of the outline headline
+associated with the item.
+
address@hidden
+* Categories:: Not all tasks are equal
+* Time-of-day specifications:: How the agenda knows the time
+* Sorting of agenda items:: The order of things
address@hidden menu
+
address@hidden Categories, Time-of-day specifications, Presentation and
sorting, Presentation and sorting
address@hidden Categories
+
address@hidden category
+The category is a broad label assigned to each agenda item. By default,
+the category is simply derived from the file name, but you can also
+specify it with a special line in the buffer, like this:
+
address@hidden
+#+CATEGORY: Thesis
address@hidden example
+
+If there are several such lines in a file, each specifies the category
+for the text below it (but the first category also applies to any text
+before the first CATEGORY line). The display in the agenda buffer looks
+best if the category is not longer than 10 characters.
+
address@hidden Time-of-day specifications, Sorting of agenda items, Categories,
Presentation and sorting
address@hidden Time-of-Day Specifications
address@hidden time-of-day specification
+
+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 @address@hidden<2005-05-10 Tue 19:00>}}. Time
+ranges can be specified with two time stamps, like
address@hidden
address@hidden@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
+
+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
+specifications in diary entries are recognized as well.
+
+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:
+
address@hidden
+ 8:30-13:00 Arthur Dent lies in front of the bulldozer
+ 12:45...... Ford Prefect arrives and takes Arthur to the pub
+ 19:00...... The Vogon reads his poem
+ 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
address@hidden example
+
address@hidden time grid
+If the agenda is in single-day mode, or for the display of today, the
+timed entries are embedded in a time grid, like
+
address@hidden
+ 8:00...... ------------------
+ 8:30-13:00 Arthur Dent lies in front of the bulldozer
+ 10:00...... ------------------
+ 12:00...... ------------------
+ 12:45...... Ford Prefect arrives and takes Arthur to the pub
+ 14:00...... ------------------
+ 16:00...... ------------------
+ 18:00...... ------------------
+ 19:00...... The Vogon reads his poem
+ 20:00...... ------------------
+ 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
address@hidden example
+
+The time grid can be turned on and off with the variable
address@hidden, and can be configured with
address@hidden
+
address@hidden Sorting of agenda items, , Time-of-day specifications,
Presentation and sorting
address@hidden Sorting of agenda items
address@hidden sorting, of agenda items
address@hidden priorities, of agenda items
+Before being inserted into a view, the items are sorted. How this is
+done depends on the type of view.
address@hidden @bullet
address@hidden
+For the daily/weekly agenda, the items for each day are sorted. The
+default order is to first collect all items containing an explicit
+time-of-day specification. These entries will be shown at the beginning
+of the list, as a @emph{schedule} for the day. After that, items remain
+grouped in categories, in the sequence given by @code{org-agenda-files}.
+Within each category, items are sorted by priority (@pxref{Priorities}),
+which is composed of the base priority (2000 for priority @samp{A}, 1000
+for @samp{B}, and 0 for @samp{C}), plus additional increments for
+overdue scheduled or deadline items.
address@hidden
+For the TODO list, items remain in the order of categories, but within
+each category, sorting takes place according to priority
+(@pxref{Priorities}).
address@hidden
+For tags matches, items are not sorted at all, but just appear in the
+sequence in which they are found in the agenda files.
address@hidden itemize
+
+Sorting can be customized using the variable
address@hidden
+
+
address@hidden Agenda commands, Custom agenda views, Presentation and sorting,
Agenda views
address@hidden Commands in the agenda buffer
address@hidden commands, in agenda buffer
+
+Entries in the agenda buffer are linked back to the org file or diary
+file where they originate. You are not allowed to edit the agenda
+buffer itself, but commands are provided to show and jump to the
+original entry location, and to edit the org-files ``remotely'' from
+the agenda buffer. In this way, all information is stored only once,
+removing the risk that your agenda and note files may diverge.
+
+Some commands can be executed with mouse clicks on agenda lines. For
+the other commands, the cursor needs to be in the desired line.
+
address@hidden @kbd
address@hidden
address@hidden motion commands in agenda
address@hidden n
address@hidden n
+Next line (same as @key{up}).
address@hidden p
address@hidden p
+Previous line (same as @key{down}).
address@hidden/GoTo org file}
address@hidden mouse-3
address@hidden @key{SPC}
address@hidden mouse-3
address@hidden @key{SPC}
+Display the original location of the item in another window.
address@hidden
address@hidden L
address@hidden L
+Display original location and recenter that window.
address@hidden
address@hidden mouse-2
address@hidden mouse-1
address@hidden @key{TAB}
address@hidden mouse-2
address@hidden mouse-1
address@hidden @key{TAB}
+Go to the original location of the item in another window. Under Emacs
+22, @kbd{mouse-1} will also works for this.
address@hidden
address@hidden @key{RET}
address@hidden @key{RET}
+Go to the original location of the item and delete other windows.
address@hidden
address@hidden f
address@hidden f
+Toggle Follow mode. In Follow mode, as you move the cursor through
+the agenda buffer, the other window always shows the corresponding
+location in the org file. The initial setting for this mode in new
+agenda buffers can be set with the variable
address@hidden
address@hidden
address@hidden b
address@hidden 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.
address@hidden
address@hidden l
address@hidden 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.
+
address@hidden display}
address@hidden display changing, in agenda
address@hidden o
address@hidden o
+Delete other windows.
address@hidden
address@hidden d
address@hidden w
address@hidden m
address@hidden y
address@hidden 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.
address@hidden
address@hidden D
address@hidden D
+Toggle the inclusion of diary entries. See @ref{Weekly/Daily agenda}.
address@hidden
address@hidden g
address@hidden g
+Toggle the time grid on and off. See also the variables
address@hidden and @code{org-agenda-time-grid}.
address@hidden
address@hidden r
address@hidden r
+Recreate the agenda buffer, for example to reflect the changes
+after modification of the time stamps of items with address@hidden and
address@hidden When the buffer is the global todo list, a prefix
+argument is interpreted to create a selective list for a specific TODO
+keyword.
address@hidden
address@hidden s
address@hidden s
+Save all Org-mode buffers in the current Emacs session.
address@hidden
address@hidden @key{right}
address@hidden @key{right}
+Display the following @code{org-agenda-ndays} days. For example, if
+the display covers a week, switch to the following week. With prefix
+arg, go forward that many times @code{org-agenda-ndays} days.
address@hidden
address@hidden @key{left}
address@hidden @key{left}
+Display the previous dates.
address@hidden
address@hidden .
address@hidden .
+Goto today.
+
address@hidden editing}
address@hidden remote editing, from agenda
+
address@hidden 0-9
+Digit argument.
address@hidden
address@hidden undoing remote-editing events
address@hidden remote editing, undo
address@hidden C-_
address@hidden C-_
+Undo a change due to a remote editing command. The change is undone
+both in the agenda buffer and in the remote buffer.
address@hidden
address@hidden t
address@hidden t
+Change the TODO state of the item, both in the agenda and in the
+original org file.
address@hidden
address@hidden C-k
address@hidden C-k
+Delete the current agenda item along with the entire subtree belonging
+to it in the original Org-mode file. If the text to be deleted remotely
+is longer than one line, the kill needs to be confirmed by the user. See
+variable @code{org-agenda-confirm-kill}.
address@hidden
address@hidden $
address@hidden $
+Archive the subtree corresponding to the current headline.
address@hidden
address@hidden T
address@hidden T
+Show all tags associated with the current item. Because of
+inheritance, this may be more than the tags listed in the line itself.
address@hidden
address@hidden :
address@hidden :
+Set tags for the current headline.
address@hidden
address@hidden a
address@hidden a
+Toggle the ARCHIVE tag for the current headline.
address@hidden
address@hidden ,
address@hidden ,
+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.
address@hidden
address@hidden P
address@hidden P
+Display weighted priority of current item.
address@hidden
address@hidden +
address@hidden address@hidden
address@hidden +
address@hidden address@hidden
+Increase the priority of the current item. The priority is changed in
+the original buffer, but the agenda is not resorted. Use the @kbd{r}
+key for this.
address@hidden
address@hidden -
address@hidden address@hidden
address@hidden -
address@hidden address@hidden
+Decrease the priority of the current item.
address@hidden
address@hidden C-c C-s
address@hidden C-c C-s
+Schedule this item
address@hidden
address@hidden C-c C-d
address@hidden C-c C-d
+Set a deadline for this item.
address@hidden
address@hidden address@hidden
address@hidden address@hidden
+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 address@hidden 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
address@hidden key to update the buffer.
address@hidden
address@hidden address@hidden
address@hidden address@hidden
+Change the time stamp associated with the current line by one day
+into the past.
address@hidden
address@hidden >
address@hidden >
+Change the time stamp associated with the current line to today.
+The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
+on my keyboard.
address@hidden
address@hidden I
address@hidden I
+Start the clock on the current item. If a clock is running already, it
+is stopped first.
address@hidden
address@hidden O
address@hidden O
+Stop the previously started clock.
address@hidden
address@hidden X
address@hidden X
+Cancel the currently running clock.
+
address@hidden commands}
address@hidden calendar commands, from agenda
address@hidden c
address@hidden c
+Open the Emacs calendar and move to the date at the agenda cursor.
address@hidden
address@hidden c
+When in the calendar, compute and show the Org-mode agenda for the
+date at the cursor.
address@hidden
address@hidden diary entries, creating from agenda
address@hidden i
address@hidden i
+Insert a new entry into the diary. Prompts for the type of entry
+(day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
+entry in the diary, just as @kbd{i d} etc. would do in the calendar.
+The date is taken from the cursor position.
address@hidden
address@hidden M
address@hidden M
+Show the phases of the moon for the three months around current date.
address@hidden
address@hidden S
address@hidden S
+Show sunrise and sunset times. The geographical location must be set
+with calendar variables, see documentation of the Emacs calendar.
address@hidden
address@hidden C
address@hidden C
+Convert the date at cursor into many other cultural and historic
+calendars.
address@hidden
address@hidden H
address@hidden H
+Show holidays for three month around the cursor date.
address@hidden
address@hidden FIXME: This should be a different key.
address@hidden C-c C-x C-c
address@hidden C-c C-x C-c
+Export a single iCalendar file containing entries from all agenda files.
+
address@hidden to a file}
address@hidden C-x C-w
address@hidden C-x C-w
address@hidden exporting agenda views
address@hidden agenda views, exporting
+Write the agenda view to a file. Depending on the extension of the
+selected file name, the view will be exported as HTML (extension
address@hidden or @file{.htm}), Postscript (extension @file{.ps}), or
+plain text (any other extension). Use the variable
address@hidden to set options for @file{ps-print}
+and for @file{htmlize} to be used during export.
+
address@hidden and Exit}
address@hidden q
address@hidden q
+Quit agenda, remove the agenda buffer.
address@hidden
address@hidden x
address@hidden agenda files, removing buffers
address@hidden x
+Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
+for the compilation of the agenda. Buffers created by the user to
+visit org files will not be removed.
address@hidden table
+
+
address@hidden Custom agenda views, , Agenda commands, Agenda views
address@hidden Custom agenda views
address@hidden custom agenda views
address@hidden agenda views, custom
+
+Custom agenda commands serve two purposes: to store and quickly access
+frequently used TODO and tags searches, and to create special composite
+agenda buffers. Custom agenda commands will be accessible through the
+dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
+
address@hidden
+* 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::
address@hidden menu
+
address@hidden Storing searches, Block agenda, Custom agenda views, Custom
agenda views
address@hidden Storing searches
+
+The first application of custom searches is the definition of keyboard
+shortcuts for frequently used searches, either creating an agenda
+buffer, or a sparse tree (the latter covering of course only the current
+buffer).
address@hidden C-c a C
+Custom commands are configured in the variable
address@hidden You can customize this variable, for
+example by pressing @kbd{C-c a C}. You can also directly set it with
+Emacs Lisp in @file{.emacs}. The following example contains all valid
+search types:
+
address@hidden
address@hidden
+(setq org-agenda-custom-commands
+ '(("w" todo "WAITING")
+ ("W" todo-tree "WAITING")
+ ("u" tags "+BOSS-URGENT")
+ ("v" tags-todo "+BOSS-URGENT")
+ ("U" tags-tree "+BOSS-URGENT")
+ ("f" occur-tree "\\<FIXME\\>")))
address@hidden group
address@hidden lisp
+
address@hidden
+The initial single-character string in each entry defines the character
+you have to press after the dispatcher command @kbd{C-c a} in order to
+access the command. The second parameter is the search type, followed
+by the string or regular expression to be used for the matching. The
+example above will therefore define:
+
address@hidden @kbd
address@hidden C-c a w
+as a global search for TODO entries with @samp{WAITING} as the TODO
+keyword
address@hidden C-c a W
+as the same search, but only in the current buffer and displaying the
+results as a sparse tree
address@hidden C-c a u
+as a global tags search for headlines marked @samp{:BOSS:} but not
address@hidden:URGENT:}
address@hidden C-c a v
+as the same search as @kbd{C-c a u}, but limiting the search to
+headlines that are also TODO items
address@hidden C-c a U
+as the same search as @kbd{C-c a u}, but only in the current buffer and
+displaying the result as a sparse tree
address@hidden C-c a f
+to create a sparse tree (again: current buffer only) with all entries
+containing the word @samp{FIXME}.
address@hidden table
+
address@hidden Block agenda, Setting Options, Storing searches, Custom agenda
views
address@hidden Block agenda
address@hidden block agenda
address@hidden agenda, with block views
+
+Another possibility is the construction of agenda views that comprise
+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
+matching commands discussed above: @code{todo}, @code{tags}, and
address@hidden Here are two examples:
+
address@hidden
address@hidden
+(setq org-agenda-custom-commands
+ '(("h" "Agenda and Home-related tasks"
+ ((agenda)
+ (tags-todo "HOME")
+ (tags "GARDEN")))
+ ("o" "Agenda and Office-related tasks"
+ ((agenda)
+ (tags-todo "WORK")
+ (tags "OFFICE")))))
address@hidden group
address@hidden lisp
+
address@hidden
+This will define @kbd{C-c a h} to create a multi-block view for stuff
+you need to attend to at home. The resulting agenda buffer will contain
+your agenda for the current week, all TODO items that carry the tag
address@hidden, and also all lines tagged with @samp{GARDEN}. Finally the
+command @kbd{C-c a o} provides a similar view for office tasks.
+
+
address@hidden Setting Options, Exporting Agenda Views, Block agenda, Custom
agenda views
address@hidden Setting Options for custom commands
address@hidden options, for custom agenda views
+
+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
+options requires inserting a list of variable names and values at the
+right spot in @code{org-agenda-custom-commands}. For example:
+
address@hidden
address@hidden
+(setq org-agenda-custom-commands
+ '(("w" todo "WAITING"
+ ((org-agenda-sorting-strategy '(priority-down))
+ (org-agenda-prefix-format " Mixed: ")))
+ ("U" tags-tree "+BOSS-URGENT"
+ ((org-show-following-heading nil)
+ (org-show-hierarchy-above nil)))))
address@hidden group
address@hidden lisp
+
address@hidden
+Now the @kbd{C-c a w} command will sort the collected entries only by
+priority, and the prefix format is modified to just say @samp{ Mixed:}
+instead of giving the category of the entry. The sparse tags tree of
address@hidden a U} will now turn out ultra-compact, because neither the
+headline hierarchy above the match, nor the headline following the match
+will be shown.
+
+For command sets creating a block agenda,
address@hidden has two separate spots for setting
+options. You can add options that should be valid for just a single
+command in the set, and options that should be valid for all commands in
+the set. The former are just added to the command entry, the latter
+must come after the list of command entries. Going back to the block
+agenda example (@pxref{Block agenda}), let's change the sorting strategy
+for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
+the results for GARDEN tags query in the opposite order,
address@hidden This would look like this:
+
address@hidden
address@hidden
+(setq org-agenda-custom-commands
+ '(("h" "Agenda and Home-related tasks"
+ ((agenda)
+ (tags-todo "HOME")
+ (tags "GARDEN"
+ ((org-agenda-sorting-strategy '(priority-up)))))
+ ((org-agenda-sorting-strategy '(priority-down))))
+ ("o" "Agenda and Office-related tasks"
+ ((agenda)
+ (tags-todo "WORK")
+ (tags "OFFICE")))))
address@hidden group
address@hidden lisp
+
+As you see, the values and parenthesis setting is a little complex.
+When in doubt, use the customize interface to set this variable - it
+fully supports its structure. Just one caveat: When setting options in
+this interface, the @emph{values} are just lisp expressions. So if the
+value is a string, you need to add the double quotes around the value
+yourself.
+
+
address@hidden Exporting Agenda Views, Extracting Agenda Information for other
programs, Setting Options, Custom agenda views
address@hidden Exporting Agenda Views
address@hidden agenda views, exporting
+
+If you are away from your computer, it can be very useful to have a
+printed version of some agenda views to carry around. Org-mode can
+export custom agenda views as plain text, address@hidden need to
+install Hrvoje Niksic' @file{htmlize.el}.} and postscript. If you want
+to do this only occasionally, use the command
+
address@hidden @kbd
address@hidden C-x C-w
address@hidden C-x C-w
address@hidden exporting agenda views
address@hidden agenda views, exporting
+Write the agenda view to a file. Depending on the extension of the
+selected file name, the view will be exported as HTML (extension
address@hidden or @file{.htm}), Postscript (extension @file{.ps}), or
+plain text (any other extension). Use the variable
address@hidden to set options for @file{ps-print}
+and for @file{htmlize} to be used during export, for example
address@hidden
+(setq org-agenda-exporter-settings
+ '((ps-number-of-columns 2)
+ (ps-landscape-mode t)
+ (htmlize-output-type 'css)))
address@hidden lisp
address@hidden table
+
+If you need to export certain agenda views frequently, you can associate
+any custom agenda command with a list of output file names
address@hidden you want to store standard views like the weekly agenda
+or the global TODO list as well, you need to define custom commands for
+them in order to be able to specify filenames.}. Here is an example
+that first does define custom commands for the agenda and the global
+todo list, together with a number of files to which to export them.
+Then we define two block agenda commands and specify filenames for them
+as well. File names can be relative to the current working directory,
+or absolute.
+
address@hidden
address@hidden
+(setq org-agenda-custom-commands
+ '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
+ ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
+ ("h" "Agenda and Home-related tasks"
+ ((agenda)
+ (tags-todo "HOME")
+ (tags "GARDEN"))
+ nil
+ ("~/views/home.html"))
+ ("o" "Agenda and Office-related tasks"
+ ((agenda)
+ (tags-todo "WORK")
+ (tags "OFFICE"))
+ nil
+ ("~/views/office.ps"))))
address@hidden group
address@hidden lisp
+
+The extension of the file name determines the type of export. If it is
address@hidden, 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
address@hidden, @code{ps-print-buffer-with-faces} is used to produce
+postscript output. Any other extension produces a plain ASCII file.
+
+The export files are @emph{not} created when you use one of those
+commands interactively. Instead, there is a special command to produce
address@hidden specified files in one step:
+
address@hidden @kbd
address@hidden C-c a e
address@hidden C-c a e
+Export all agenda views that have export filenames associated with
+them.
address@hidden table
+
+You can use the options section of the custom agenda commands to also
+set options for the export commands. For example:
+
address@hidden
+(setq org-agenda-custom-commands
+ '(("X" agenda ""
+ ((ps-number-of-columns 2)
+ (ps-landscape-mode t)
+ (org-agenda-prefix-format " [ ] ")
+ (org-agenda-with-colors nil)
+ (org-agenda-remove-tags t))
+ ("theagenda.ps"))))
address@hidden lisp
+
address@hidden
+This command sets two options for the postscript exporter, to make it
+print in two columns in landscape format - the resulting page can be cut
+in two and then used in a paper agenda. The remaining settings modify
+the agenda prefix to omit category and scheduling information, and
+instead include a checkbox to check off items. We also remove the tags
+to make the lines compact, and we don't want to use colors for the
+black-and-white printer. Settings specified in
address@hidden will also apply, but the settings
+in @code{org-agenda-custom-commands} take precedence.
+
address@hidden
+From the command line you may also use
address@hidden
+emacs -f org-batch-store-agenda-views -kill
address@hidden example
address@hidden
+or, if you need to modify some parameters
address@hidden
+emacs -eval '(org-batch-store-agenda-views \
+ org-agenda-ndays 30 \
+ org-agenda-include-diary nil \
+ org-agenda-files (quote ("~/org/project.org")))' \
+ -kill
address@hidden example
address@hidden
+which will create the agenda views restricted to the file
address@hidden/org/project.org}, without diary entries and with 30 days
+extent.
+
address@hidden Extracting Agenda Information for other programs, , Exporting
Agenda Views, Custom agenda views
address@hidden Extracting Agenda Information for other programs
address@hidden agenda, pipe
address@hidden Scripts, for agenda processing
+
+Org-mode provides commands to access agenda information for the command
+line in emacs batch mode. This extracted information can be sent
+directly to a printer, or it can be read by a program that does further
+processing of the data. The first of these commands is the function
address@hidden, that produces an agenda view and sends it as
+ASCII text to STDOUT. The command takes a single string as parameter.
+If the string has length 1, it is used as a key to one of the commands
+you have configured in @code{org-agenda-custom-commands}, basically any
+key you can use after @kbd{C-c a}. For example, to directly print the
+current TODO list, you could use
+
address@hidden
+emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
address@hidden example
+
+If the parameter is a string with 2 or more characters, it is used as a
+tags/todo match string. For example, to print your local shopping list
+(all items with the tag @samp{shop}, but excluding the tag
address@hidden), you could use
+
address@hidden
+emacs -batch -l ~/.emacs \
+ -eval '(org-batch-agenda "+shop-NewYork")' | lpr
address@hidden example
+
address@hidden
+You may also modify parameters on the fly like this:
+
address@hidden
+emacs -batch -l ~/.emacs \
+ -eval '(org-batch-agenda "a" \
+ org-agenda-ndays 30 \
+ org-agenda-include-diary nil \
+ org-agenda-files (quote ("~/org/project.org")))' \
+ | lpr
address@hidden example
+
address@hidden
+which will produce a 30 day agenda, fully restricted to the Org file
address@hidden/org/projects.org}, not even including the diary.
+
+If you want to process the agenda data in more sophisticated ways, you
+can use the command @code{org-batch-agenda-csv} to get a comma-separated
+list of values for each agenda item. Each line in the output will
+contain a number of fields separated by commas. The fields in a line
+are:
+
address@hidden
+category @r{The category of the item}
+head @r{The headline, without TODO kwd, TAGS and PRIORITY}
+type @r{The type of the agenda entry, can be}
+ todo @r{selected in TODO match}
+ tagsmatch @r{selected in tags match}
+ diary @r{imported from diary}
+ deadline @r{a deadline}
+ scheduled @r{scheduled}
+ timestamp @r{appointment, selected by timestamp}
+ closed @r{entry was closed on date}
+ upcoming-deadline @r{warning about nearing deadline}
+ past-scheduled @r{forwarded scheduled item}
+ block @r{entry has date block including date}
+todo @r{The todo keyword, if any}
+tags @r{All tags including inherited ones, separated by colons}
+date @r{The relevant date, like 2007-2-14}
+time @r{The time, like 15:00-16:50}
+extra @r{String with extra planning info}
+priority-l @r{The priority letter if any was given}
+priority-n @r{The computed numerical priority}
address@hidden example
+
address@hidden
+Time and date will only be given if a timestamp (or deadline/scheduled)
+lead to the selection of the item.
+
+A CSV list like this is very easy to use in a post processing script.
+For example, here is a Perl program that gets the TODO list from
+Emacs/org-mode and prints all the items, preceded by a checkbox:
+
address@hidden
address@hidden
+#!/usr/bin/perl
+
+# define the Emacs command to run
+$cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
+
+# run it and capture the output
+$agenda = address@hidden 2>/dev/address@hidden;
+
+# loop over all lines
+foreach $line (split(/\n/,$agenda)) @{
+
+ # get the individual values
+ ($category,$head,$type,$todo,$tags,$date,$time,$extra,
+ $priority_l,$priority_n) = split(/,/,$line);
+
+ # proccess and print
+ print "[ ] $head\n";
address@hidden
address@hidden group
address@hidden example
+
address@hidden Embedded LaTeX, Exporting, Agenda views, Top
address@hidden Embedded LaTeX
address@hidden @TeX{} interpretation
address@hidden address@hidden 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.
address@hidden@address@hidden is a macro system based on Donald E. Knuth's
address@hidden system. Many of the features described here as address@hidden''
are
+really from @TeX{}, but for simplicity I am blurring this distinction.}
+is widely used to typeset scientific documents. Org-mode supports
+embedding address@hidden code into its files, because many academics are used
+to read address@hidden source code, and because it can be readily processed
+into images for HTML production.
+
+It is not necessary to mark address@hidden macros and code in any special way.
+If you observe a few conventions, Org-mode knows how to find it and what
+to do with it.
+
address@hidden
+* Math symbols:: TeX macros for symbols and Greek letters
+* 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
address@hidden menu
+
address@hidden Math symbols, Subscripts and Superscripts, Embedded LaTeX,
Embedded LaTeX
address@hidden Math symbols
address@hidden math symbols
address@hidden TeX macros
+
+You can use address@hidden macros to insert special symbols like @samp{\alpha}
+to indicate the Greek letter, or @samp{\to} to indicate an arrow.
+Completion for these macros is available, just type @samp{\} and maybe a
+few letters, and press @address@hidden to see possible completions.
+Unlike address@hidden code, Org-mode allows these macros to be present
+without surrounding math delimiters, for example:
+
address@hidden
+Angles are written as Greek letters \alpha, \beta and \gamma.
address@hidden example
+
+During HTML export (@pxref{HTML export}), these symbols are translated
+into the proper syntax for HTML, for the above examples this is
address@hiddenα} and @samp{→}, respectively.
+
address@hidden Subscripts and Superscripts, LaTeX fragments, Math symbols,
Embedded LaTeX
address@hidden Subscripts and Superscripts
address@hidden subscript
address@hidden superscript
+
+Just like in address@hidden, @samp{^} and @samp{_} are used to indicate super-
+and subscripts. Again, these can be used without embedding them in
+math-mode delimiters. To increase the readability of ASCII text, it is
+not necessary (but OK) to surround multi-character sub- and superscripts
+with curly braces. For example
+
address@hidden
+The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
+the sun is address@hidden@} = 6.96 x 10^8 m.
address@hidden example
+
+To avoid interpretation as raised or lowered text, you can quote
address@hidden and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
+
+During HTML export (@pxref{HTML export}), subscript and superscripts
+are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
+
address@hidden LaTeX fragments, Processing LaTeX fragments, Subscripts and
Superscripts, Embedded LaTeX
address@hidden LaTeX fragments
address@hidden LaTeX fragments
+
+With symbols, sub- and superscripts, HTML is pretty much at its end when
+it comes to representing mathematical address@hidden, there is
+MathML, but that is not yet fully supported by many browsers, and there
+is no decent converter for turning address@hidden 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 address@hidden
+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 address@hidden address@hidden export
+will not use images for displaying address@hidden fragments but include these
+fragments directly into the address@hidden code.}. For this to work you
+need to be on a system with a working address@hidden installation. You also
+need the @file{dvipng} program, available at
address@hidden://sourceforge.net/projects/dvipng/}. The address@hidden header
that
+will be used when processing a fragment can be configured with the
+variable @code{org-format-latex-header}.
+
address@hidden fragments don't need any special marking at all. The following
+snippets will be identified as address@hidden source code:
address@hidden @bullet
address@hidden
+Environments of any kind. The only requirement is that the
address@hidden statement appears on a new line, preceded by only
+whitespace.
address@hidden
+Text within the usual address@hidden math delimiters. To avoid conflicts with
+currency specifications, single @samp{$} characters are only recognized
+as math delimiters if the enclosed text contains at most two line breaks,
+is directly attached to the @samp{$} characters with no whitespace in
+between, and if the closing @samp{$} is followed by whitespace or
+punctuation. For the other delimiters, there is no such restriction, so
+when in doubt, use @samp{\(...\)} as inline math delimiters.
address@hidden itemize
+
address@hidden For example:
+
address@hidden
address@hidden@} % arbitrary environments,
address@hidden@} % even tables, figures
address@hidden@} % etc
+
+If $a^2=b$ and \( b=2 \), then the solution must be
+either $$ address@hidden@} $$ or \[ address@hidden@} \].
address@hidden example
+
address@hidden
+If you need any of the delimiter ASCII sequences for other purposes, you
+can configure the option @code{org-format-latex-options} to deselect the
+ones you do not wish to have interpreted by the address@hidden converter.
+
address@hidden Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments,
Embedded LaTeX
address@hidden Processing LaTeX fragments
address@hidden LaTeX fragments, preview
+
address@hidden fragments can be processed to produce a preview images of the
+typeset expressions:
+
address@hidden @kbd
address@hidden C-c C-x C-l
address@hidden C-c C-x C-l
+Produce a preview image of the address@hidden fragment at point and overlay it
+over the source code. If there is no fragment at point, process all
+fragments in the current entry (between two headlines). When called
+with a prefix argument, process the entire subtree. When called with
+two prefix arguments, or when the cursor is before the first headline,
+process the entire buffer.
address@hidden C-c C-c
address@hidden C-c C-c
+Remove the overlay preview images.
address@hidden table
+
+During HTML export (@pxref{HTML export}), all address@hidden fragments are
+converted into images and inlined into the document if the following
+setting is active:
+
address@hidden
+(setq org-export-with-LaTeX-fragments t)
address@hidden lisp
+
address@hidden CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
address@hidden Using CDLaTeX to enter math
address@hidden CDLaTeX
+
+CDLaTeX-mode is a minor mode that is normally used in combination with a
+major address@hidden 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
address@hidden 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
+on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
+Org-mode files with
+
address@hidden
+(add-hook 'org-mode-hook 'turn-on-org-cdlatex)
address@hidden lisp
+
+When this mode is enabled, the following features are present (for more
+details see the documentation of cdlatex-mode):
address@hidden @bullet
address@hidden C-c @{
address@hidden
+Environment templates can be inserted with @kbd{C-c @{}.
address@hidden
address@hidden @key{TAB}
+The @key{TAB} key will do template expansion if the cursor is inside a
address@hidden address@hidden has a method to test if the cursor is
+inside such a fragment, see the documentation of the function
address@hidden For example, @key{TAB} will
+expand @code{fr} to @address@hidden@address@hidden@}} and position the cursor
+correctly inside the first brace. Another @key{TAB} will get you into
+the second brace. Even outside fragments, @key{TAB} will expand
+environment abbreviations at the beginning of a line. For example, if
+you write @samp{equ} at the beginning of a line and press @key{TAB},
+this abbreviation will be expanded to an @code{equation} environment.
+To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
address@hidden
address@hidden _
address@hidden ^
+Pressing @kbd{_} and @kbd{^} inside a address@hidden fragment will insert these
+characters together with a pair of braces. If you use @key{TAB} to move
+out of the braces, and if the braces surround only a single character or
+macro, they are removed again (depending on the variable
address@hidden).
address@hidden
address@hidden `
+Pressing the backquote @kbd{`} followed by a character inserts math
+macros, also outside address@hidden fragments. If you wait more than 1.5
seconds
+after the backquote, a help window will pop up.
address@hidden
address@hidden '
+Pressing the normal quote @kbd{'} followed by another character modifies
+the symbol before point with an accent or a font. If you wait more than
+1.5 seconds after the backquote, a help window will pop up. Character
+modification will work only inside address@hidden fragments, outside the quote
+is normal.
address@hidden itemize
+
address@hidden Exporting, Publishing, Embedded LaTeX, Top
address@hidden Exporting
address@hidden exporting
+
+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
+notes file on the web, while the XOXO format provides a solid base for
+exchange with a broad range of other applications. address@hidden export lets
+you use Org-mode and its structured editing functions to easily create
address@hidden 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
+produced. @xref{Text interpretation}, for more details.
+
address@hidden @kbd
address@hidden C-c C-e
address@hidden 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.
address@hidden table
+
address@hidden
+* ASCII export:: Exporting to plain ASCII
+* HTML export:: Exporting to HTML
+* LaTeX export:: Exporting to LaTeX
+* XOXO export:: Exporting to XOXO
+* iCalendar export:: Exporting in iCalendar format
+* Text interpretation:: How the exporter looks at the file
address@hidden menu
+
address@hidden ASCII export, HTML export, Exporting, Exporting
address@hidden ASCII export
address@hidden ASCII export
+
+ASCII export produces a simple and very readable version of an Org-mode
+file.
+
address@hidden region, active
address@hidden active region
address@hidden transient-mark-mode
address@hidden @kbd
address@hidden C-c C-e a
address@hidden C-c C-e a
+Export as ASCII file. For an org file @file{myfile.org}, the ASCII file
+will be @file{myfile.txt}. The file will be overwritten without
+warning. If there is an active region, only the region will be
+exported. If the selected region is a single tree, the tree head will
+become the document title. If the tree head entry has or inherits an
+EXPORT_FILE_NAME property, that name will be used for the export.
address@hidden C-c C-e v a
address@hidden C-c C-e v a
+Export only the visible part of the document.
address@hidden table
+
address@hidden 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,
+
address@hidden
address@hidden C-c C-e a}
address@hidden example
+
address@hidden
+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 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.
+
address@hidden HTML export, LaTeX export, ASCII export, Exporting
address@hidden HTML export
address@hidden HTML export
+
+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.
+
address@hidden
+* HTML Export commands:: How to invoke LaTeX export
+* 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
address@hidden menu
+
address@hidden HTML Export commands, Quoting HTML tags, HTML export, HTML export
address@hidden HTML export commands
+
address@hidden region, active
address@hidden active region
address@hidden transient-mark-mode
address@hidden @kbd
address@hidden C-c C-e h
address@hidden C-c C-e h
+Export as HTML file @file{myfile.html}. For an org file
address@hidden, the ASCII file will be @file{myfile.html}. The file
+will be overwritten without warning. If there is an active region, only
+the region will be exported. If the selected region is a single tree,
+the tree head will become the document title. If the tree head entry
+has or inherits an EXPORT_FILE_NAME property, that name will be used for
+the export.
address@hidden C-c C-e b
address@hidden C-c C-e b
+Export as HTML file and immediately open it with a browser.
address@hidden C-c C-e H
address@hidden C-c C-e H
+Export to a temporary buffer, do not create a file.
address@hidden C-c C-e R
address@hidden C-c C-e H
+Export the active region to a temporary buffer. With prefix arg, do not
+produce file header and foot, but just the plain HTML section for the
+region. This is good for cut-and-paste operations.
address@hidden C-c C-e v h
address@hidden C-c C-e v b
address@hidden C-c C-e v H
address@hidden C-c C-e v R
address@hidden C-c C-e v h
address@hidden C-c C-e v b
address@hidden C-c C-e v H
address@hidden C-c C-e v R
+Export only the visible part of the document.
address@hidden M-x org-export-region-as-html
+Convert the region to HTML under the assumption that it was org-mode
+syntax before. This is a global command that can be invoked in any
+buffer.
address@hidden M-x org-replace-region-by-HTML
+Replace the active region (assumed to be in Org-mode syntax) by HTML
+code.
address@hidden table
+
address@hidden 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,
+
address@hidden
address@hidden C-c C-e b}
address@hidden example
+
address@hidden
+creates two levels of headings and does the rest as items.
+
address@hidden Quoting HTML tags, Links, HTML Export commands, HTML export
address@hidden Quoting HTML tags
+
+Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
address@hidden>} in HTML export. If you want to include simple HTML tags
+which should be interpreted as such, mark them with @samp{@@} as in
address@hidden@@<b>bold text@@</b>}. Note that this really works only for
+simple tags. For more extensive HTML that should be copied verbatim to
+the exported file use either
+
address@hidden
+#+HTML: Literal HTML code for export
address@hidden example
+
address@hidden or
+
address@hidden
+#+BEGIN_HTML
+All lines between these markers are exported literally
+#+END_HTML
address@hidden example
+
+
address@hidden Links, Images, Quoting HTML tags, HTML export
address@hidden Links
+
address@hidden links, in HTML export
address@hidden internal links, in HTML export
address@hidden external links, in HTML export
+Internal links (@pxref{Internal links}) will continue to work in HTML
+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}
+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
address@hidden links}.
+
address@hidden Images, CSS support, Links, HTML export
address@hidden Images
+
address@hidden images, inline in HTML
address@hidden inlining images in HTML
+HTML export can inline images given as links in the Org-mode file, and
+it can make an image the clickable part of a link. By
address@hidden see the variable
address@hidden, images are inlined if a link does
+not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
+while @samp{[[file:myimg.jpg][the image]]} will just produce a link
address@hidden image} that points to the image. If the description part
+itself is a @code{file:} link or a @code{http:} URL pointing to an
+image, this image will be inlined and activated so that clicking on the
+image will activate the link. For example, to include a thumbnail that
+will link to a high resolution version of the image, you could use:
+
address@hidden
+[[file:highres.jpg][file:thumb.jpg]]
address@hidden example
+
address@hidden
+and you could use @code{http} addresses just as well.
+
address@hidden CSS support, , Images, HTML export
address@hidden CSS support
+
+You can also give style information for the exported file. The HTML
+exporter assigns the following CSS classes to appropriate parts of the
+document - your style specifications may change these:
address@hidden
+.todo @r{TODO keywords}
+.done @r{the DONE keyword}
+.timestamp @r{time stamp}
+.timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
+.tag @r{tag in a headline}
+.target @r{target for links}
address@hidden example
+
+The default style specification can be configured through the option
address@hidden If you want to use a file-local style,
+you may use file variables, best wrapped into a COMMENT section at the
+end of the outline tree. For address@hidden Emacs 21, the
+continuation lines for a variable value should have no @samp{#} at the
+start of the line.}:
+
address@hidden
+* COMMENT html style specifications
+
+# Local Variables:
+# org-export-html-style: " <style type=\"text/css\">
+# p @{font-weight: normal; color: gray; @}
+# h1 @{color: black; @}
+# </style>"
+# End:
address@hidden 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
+current buffer and forces Emacs to re-evaluate the local variables
+section in the buffer.
+
address@hidden FIXME: More about header and footer styles
address@hidden FIXME: Talk about links and targets.
+
address@hidden LaTeX export, XOXO export, HTML export, Exporting
address@hidden LaTeX export
address@hidden LaTeX export
+
+Org-mode contains a address@hidden exporter written by Bastien Guerry.
+
address@hidden
+* LaTeX export commands:: How to invoke LaTeX export
+* Quoting LaTeX code:: Incorporating literal LaTeX code
address@hidden menu
+
address@hidden LaTeX export commands, Quoting LaTeX code, LaTeX export, LaTeX
export
address@hidden LaTeX export commands
+
address@hidden @kbd
address@hidden C-c C-e l
address@hidden C-c C-e l
+Export as address@hidden file @file{myfile.tex}.
address@hidden C-c C-e L
address@hidden C-c C-e L
+Export to a temporary buffer, do not create a file.
address@hidden C-c C-e v l
address@hidden C-c C-e v L
address@hidden C-c C-e v l
address@hidden C-c C-e v L
+Export only the visible part of the document.
address@hidden M-x org-export-region-as-latex
+Convert the region to address@hidden under the assumption that it was org-mode
+syntax before. This is a global command that can be invoked in any
+buffer.
address@hidden M-x org-replace-region-by-latex
+Replace the active region (assumed to be in Org-mode syntax) by address@hidden
+code.
address@hidden table
+
address@hidden 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 description lists. The exporter can ignore them or
+convert them to a custom string depending on
address@hidden
+
+If you want that transition to occur at a different level, specify it
+with a prefix argument. For example,
+
address@hidden
address@hidden C-c C-e l}
address@hidden example
+
address@hidden
+creates two levels of headings and does the rest as items.
+
address@hidden Quoting LaTeX code, , LaTeX export commands, LaTeX export
address@hidden Quoting LaTeX code
+
+Embedded address@hidden as described in @ref{Embedded LaTeX} will be correctly
+inserted into the address@hidden file. Forthermore, you can add special code
+that should only be present in address@hidden export with the following
+constructs:
+
address@hidden
+#+LaTeX: Literal LaTeX code for export
address@hidden example
+
address@hidden or
+
address@hidden
+#+BEGIN_LaTeX
+All lines between these markers are exported literally
+#+END_LaTeX
address@hidden example
address@hidden XOXO export, iCalendar export, LaTeX export, Exporting
address@hidden XOXO export
address@hidden XOXO export
+
+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.
+
address@hidden @kbd
address@hidden C-c C-e x
address@hidden C-c C-e x
+Export as XOXO file @file{myfile.html}.
address@hidden C-c C-e v
address@hidden C-c C-e v x
+Export only the visible part of the document.
address@hidden table
+
address@hidden iCalendar export, Text interpretation, XOXO export, Exporting
address@hidden iCalendar export
address@hidden iCalendar export
+
+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
+iCalendar format. If you also want to have TODO entries included in the
+export, configure the variable @code{org-icalendar-include-todo}.
+
address@hidden @kbd
address@hidden C-c C-e i
address@hidden C-c C-e i
+Create iCalendar entries for the current file and store them in the same
+directory, using a file extension @file{.ics}.
address@hidden C-c C-e I
address@hidden C-c C-e I
+Like @kbd{C-c C-e i}, but do this for all files in
address@hidden For each of these files, a separate iCalendar
+file will be written.
address@hidden C-c C-e c
address@hidden C-c C-e c
+Create a single large iCalendar file from all files in
address@hidden and write it to the file given by
address@hidden
address@hidden table
+
+How this calendar is best read and updated, depends on the application
+you are using. The FAQ covers this issue.
+
+
address@hidden Text interpretation, , iCalendar export, Exporting
address@hidden Text interpretation by the exporter
+
+The exporter backends interpret additional structure in the Org-mode file
+in order to produce better output.
+
address@hidden
+* Comment lines:: Some lines will not be exported
+* Initial text:: Text before the first headline
+* Footnotes:: Numbers like [1]
+* Enhancing text:: Subscripts, symbols and more
+* Export options:: How to influence the export settings
address@hidden menu
+
address@hidden Comment lines, Initial text, Text interpretation, Text
interpretation
address@hidden Comment lines
address@hidden comment lines
address@hidden exporting, not
+
+Lines starting with @samp{#} in column zero are treated as comments
+and will never be exported. Also entire subtrees starting with the
+word @samp{COMMENT} will never be exported.
+
address@hidden @kbd
address@hidden C-c ;
address@hidden C-c ;
+Toggle the COMMENT keyword at the beginning of an entry.
address@hidden table
+
address@hidden Initial text, Footnotes, Comment lines, Text interpretation
address@hidden Text before the first headline
+
+Org-mode normally ignores any text before the first headline when
+exporting, leaving this region for internal links to speed up navigation
+etc. However, in publishing-oriented files, you might want to have some
+text before the first headline, like a small introduction, special HTML
+code with a navigation bar, etc. You can ask to have this part of the
+file exported as well by setting the variable
address@hidden to @code{nil}. On a
+per-file basis, you can get the same effect with
+
address@hidden
+#+OPTIONS: skip:nil
address@hidden example
+
+The text before the first headline will be fully processed
+(@pxref{Enhancing text}), and the first non-comment line becomes the
+title of the exported document. If you need to include literal HTML,
+use the special constructs described in @ref{Quoting HTML tags}. The
+table of contents is normally inserted directly before the first
+headline of the file. If you would like to get it to a different
+location, insert the string @code{[TABLE-OF-CONTENTS]} on a line by
+itself at the desired location.
+
+Finally, if you want to use the space before the first headline for
+internal purposes, but @emph{still} want to place something before the
+first headline when exporting the file, you can use the @code{#+TEXT}
+construct:
+
address@hidden
+#+OPTIONS: skip:t
+#+TEXT: This text will go before the *first* headline.
+#+TEXT: We place the table of contents here:
+#+TEXT: [TABLE-OF-CONTENTS]
+#+TEXT: This goes between the table of contents and the first headline
address@hidden example
+
address@hidden Footnotes, Enhancing text, Initial text, Text interpretation
address@hidden Footnotes
address@hidden footnotes
address@hidden @file{footnote.el}
+
+Numbers in square brackets are treated as footnotes, so that you can use
+the Emacs package @file{footnote.el} to create footnotes. For example:
+
address@hidden
+The org-mode homepage[1] clearly needs help from
+a good web designer.
+
+[1] The link is: http://www.astro.uva.nl/~dominik/Tools/org
address@hidden example
+
address@hidden
address@hidden C-c !
+Note that the @file{footnote} package uses @kbd{C-c !} to invoke its
+commands. This binding conflicts with the org-mode command for
+inserting inactive time stamps. You could use the variable
address@hidden to switch footnotes commands to another key. Or,
+if you are too used to this binding, you could use
address@hidden and @code{org-disputed-keys} to change
+the settings in Org-mode.
+
address@hidden Enhancing text, Export options, Footnotes, Text interpretation
address@hidden Enhancing text for export
address@hidden enhancing text
address@hidden richer text
+
+Some of the export backends of Org-mode allow for sophisticated text
+formatting, this is true in particular for the HTML and address@hidden
+backends. Org-mode has a number of typing conventions that allow to
+produce a richly formatted output.
+
address@hidden @bullet
+
address@hidden hand-formatted lists
address@hidden lists, hand-formatted
address@hidden
+Plain lists @samp{-}, @samp{*} or @samp{+} as bullet, or with @samp{1.}
+or @samp{2)} as enumerator will be recognized and transformed if the
+backend supports lists. See @xref{Plain lists}.
+
address@hidden underlined text
address@hidden bold text
address@hidden italic text
address@hidden
+You can make words @b{*bold*}, @i{/italic/}, _underlined_,
address@hidden, and even @address@hidden remember
+that strikethrough is typographically evil and should @i{never} be
+used.}.
+
address@hidden horizontal rules, in exported files
address@hidden
+A line consisting of only dashes, and at least 5 of them, will be
+exported as a horizontal line (@samp{<hr/>} in HTML).
+
address@hidden LaTeX fragments, export
address@hidden TeX macros, export
address@hidden
+Many @TeX{} macros and entire address@hidden fragments are converted into HTML
+entities or images (@pxref{Embedded LaTeX}).
+
address@hidden tables, export
address@hidden
+Tables are transformed into native tables under the exporter, if the
+export backend supports this. Data fields before the first horizontal
+separator line will be formatted as table header fields.
+
address@hidden fixed width
address@hidden
+If a headline starts with the word @samp{QUOTE}, the text below the
+headline will be typeset as fixed-width, to allow quoting of computer
+codes etc. Lines starting with @samp{:} are also typeset in fixed-width
+font.
address@hidden @kbd
address@hidden C-c :
address@hidden C-c :
+Toggle fixed-width for entry (QUOTE) or region, see below.
address@hidden table
+
address@hidden linebreak, forced
address@hidden
+A double backslash @emph{at the end of a line} enforces a line break at
+this position.
address@hidden itemize
+
+If these conversions conflict with your habits of typing ASCII text,
+they can all be turned off with corresponding variables. See the
+customization group @code{org-export-general}, and the following section
+which explains how to set export options with special lines in a
+buffer.
+
+
address@hidden Export options, , Enhancing text, Text interpretation
address@hidden Export options
address@hidden options, for export
+
address@hidden completion, of option keywords
+The exporter recognizes special lines in the buffer which provide
+additional information. These lines may be put anywhere in the file.
+The whole set of lines can be inserted into the buffer with @kbd{C-c
+C-e t}. For individual lines, a good way to make sure the keyword is
+correct is to type @samp{#+} and then use @address@hidden completion
+(@pxref{Completion}).
+
address@hidden @kbd
address@hidden C-c C-e t
address@hidden C-c C-e t
+Insert template with export options, see example below.
address@hidden table
+
address@hidden
+#+TITLE: the title to be shown (default is the buffer name)
+#+AUTHOR: the author (default taken from @code{user-full-name})
+#+EMAIL: his/her email address (default from @code{user-mail-address})
+#+LANGUAGE: language for HTML, e.g. @samp{en}
(@code{org-export-default-language})
+#+TEXT: Some descriptive text to be inserted at the beginning.
+#+TEXT: Several lines may be given.
+#+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
address@hidden example
+
address@hidden
+The OPTIONS line is a compact form to specify export settings. Here
+you can:
address@hidden headline levels
address@hidden section-numbers
address@hidden table of contents
address@hidden linebreak preservation
address@hidden quoted HTML tags
address@hidden fixed-width sections
address@hidden tables
address@hidden @TeX{}-like syntax for sub- and superscripts
address@hidden footnotes
address@hidden emphasized text
address@hidden @TeX{} macros
address@hidden address@hidden fragments
address@hidden author info, in export
address@hidden time info, in export
address@hidden
+H: @r{set the number of headline levels for export}
+num: @r{turn on/off section-numbers}
+toc: @r{turn on/off table of contents, or set level limit (integer)}
+\n: @r{turn on/off linebreak-preservation}
+@@: @r{turn on/off quoted HTML tags}
+:: @r{turn on/off fixed-width sections}
+|: @r{turn on/off tables}
+^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
+ @r{you write "^:@address@hidden", @address@hidden@}} will be
interpreted, but}
+ @r{the simple @code{a_b} will be left as it is.}
+f: @r{turn on/off foototes like this[1].}
+*: @r{turn on/off emphasized text (bold, italic, underlined)}
+TeX: @r{turn on/off simple @TeX{} macros in plain text}
+LaTeX: @r{turn on/off address@hidden fragments}
+skip: @r{turn on/off skipping the text before the first heading}
+author: @r{turn on/off inclusion of author name/email into exported file}
+timestamp: @r{turn on/off inclusion creation time into exported file}
address@hidden example
+
+These options take effect in both the HTML and address@hidden export, except
+for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
address@hidden for the address@hidden export.
+
address@hidden Publishing, Miscellaneous, Exporting, Top
address@hidden Publishing
address@hidden publishing
+
+Org-mode address@hidden@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.
+
+You can also use Org-publish to convert files into address@hidden, or even
+combine HTML and address@hidden conversion so that files are available in both
+formats on the address@hidden address@hidden files on a server are not
+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.
+
address@hidden
+* Configuration:: Defining projects
+* Sample configuration:: Example projects
+* Triggering publication:: Publication commands
address@hidden menu
+
address@hidden Configuration, Sample configuration, Publishing, Publishing
address@hidden Configuration
+
+Publishing needs significant configuration to specify files, destination
+and many other properties of a project.
+
address@hidden
+* Project alist:: The central configuration variable
+* Sources and destinations:: From here to there
+* Selecting files:: What files are part of the project?
+* Publishing action:: Setting the function doing the publishing
+* Publishing options:: Tweaking HTML export
+* Publishing links:: Which links keep working after publishing?
+* Project page index:: Publishing a list of project files
address@hidden menu
+
address@hidden Project alist, Sources and destinations, Configuration,
Configuration
address@hidden The variable @code{org-publish-project-alist}
address@hidden org-publish-project-alist
address@hidden projects, for publishing
+
+Org-publish is configured almost entirely through setting the value of
+one variable, called @code{org-publish-project-alist}.
+Each element of the list configures one project, and may be in one of
+the two following forms:
+
address@hidden
+("project-name" :property value :property value ...)
+
address@hidden
+
+("project-name" :components ("project-name" "project-name" ...))
+
address@hidden lisp
+
+In both cases, projects are configured by specifying property values.
+A project defines the set of files that will be published, as well as
+the publishing configuration to use when publishing those files. When
+a project takes the second form listed above, the individual members
+of the ``components'' property are taken to be components of the
+project, which group together files requiring different publishing
+options. When you publish such a ``meta-project'' all the components
+will also publish.
+
address@hidden Sources and destinations, Selecting files, Project alist,
Configuration
address@hidden Sources and destinations for files
address@hidden directories, for publishing
+
+Most properties are optional, but some should always be set. In
+particular, org-publish needs to know where to look for source files,
+and where to put published files.
+
address@hidden @columnfractions 0.3 0.7
address@hidden @code{:base-directory}
address@hidden Directory containing publishing source files
address@hidden @code{:publishing-directory}
address@hidden Directory (possibly remote) where output files will be published.
address@hidden @code{:preparation-function}
address@hidden Function called before starting publishing process, for example
to
+run @code{make} for updating files to be published.
address@hidden multitable
address@hidden
+
address@hidden Selecting files, Publishing action, Sources and destinations,
Configuration
address@hidden Selecting files
address@hidden files, selecting for publishing
+
+By default, all files with extension @file{.org} in the base directory
+are considered part of the project. This can be modified by setting the
+properties
address@hidden @columnfractions 0.25 0.75
address@hidden @code{:base-extension}
address@hidden Extension (without the dot!) of source files. This actually is a
+regular expression.
+
address@hidden @code{:exclude}
address@hidden Regular expression to match file names that should not be
+published, even though they have been selected on the basis of their
+extension.
+
address@hidden @code{:include}
address@hidden List of files to be included regardless of @code{:base-extension}
+and @code{:exclude}.
address@hidden multitable
+
address@hidden Publishing action, Publishing options, Selecting files,
Configuration
address@hidden Publishing Action
address@hidden 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
address@hidden which calls the HTML exporter
+(@pxref{HTML export}). But you also can publish your files in address@hidden 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.
+
+
address@hidden @columnfractions 0.3 0.7
address@hidden @code{:publishing-function}
address@hidden Function executing the publication of a file. This may also be a
+list of functions, which will all be called in turn.
address@hidden multitable
+
+The function must accept two arguments: a property list containing at
+least a @code{:publishing-directory} property, and the name of the file
+to be published. It should take the specified file, make the necessary
+transformation (if any) and place the result into the destination folder.
+You can write your own publishing function, but @code{org-publish}
+provides one for attachments (files that only need to be copied):
address@hidden
+
address@hidden Publishing options, Publishing links, Publishing action,
Configuration
address@hidden Options for the HTML/LaTeX exporters
address@hidden options, for publishing
+
+The property list can be used to set many export options for the HTML
+and address@hidden exporters. In most cases, these properties correspond to
user
+variables in Org-mode. The table below lists these properties along
+with the variable they belong to. See the documentation string for the
+respective variable for details.
+
address@hidden @columnfractions 0.3 0.7
address@hidden @code{:language} @tab
@code{org-export-default-language}
address@hidden @code{:headline-levels} @tab
@code{org-export-headline-levels}
address@hidden @code{:section-numbers} @tab
@code{org-export-with-section-numbers}
address@hidden @code{:table-of-contents} @tab @code{org-export-with-toc}
address@hidden @code{:archived-trees} @tab
@code{org-export-with-archived-trees}
address@hidden @code{:emphasize} @tab
@code{org-export-with-emphasize}
address@hidden @code{:sub-superscript} @tab
@code{org-export-with-sub-superscripts}
address@hidden @code{:TeX-macros} @tab
@code{org-export-with-TeX-macros}
address@hidden @code{:LaTeX-fragments} @tab
@code{org-export-with-LaTeX-fragments}
address@hidden @code{:fixed-width} @tab
@code{org-export-with-fixed-width}
address@hidden @code{:timestamps} address@hidden
@code{org-export-with-timestamps}
address@hidden @code{:tags} address@hidden
@code{org-export-with-tags}
address@hidden @code{:tables} @tab @code{org-export-with-tables}
address@hidden @code{:table-auto-headline} @tab
@code{org-export-highlight-first-table-line}
address@hidden @code{:style} @tab @code{org-export-html-style}
address@hidden @code{:convert-org-links} @tab
@code{org-export-html-link-org-files-as-html}
address@hidden @code{:inline-images} @tab
@code{org-export-html-inline-images}
address@hidden @code{:expand-quoted-html} @tab @code{org-export-html-expand}
address@hidden @code{:timestamp} @tab
@code{org-export-html-with-timestamp}
address@hidden @code{:publishing-directory} @tab
@code{org-export-publishing-directory}
address@hidden @code{:preamble} @tab
@code{org-export-html-preamble}
address@hidden @code{:postamble} @tab
@code{org-export-html-postamble}
address@hidden @code{:auto-preamble} @tab
@code{org-export-html-auto-preamble}
address@hidden @code{:auto-postamble} @tab
@code{org-export-html-auto-postamble}
address@hidden @code{:author} @tab @code{user-full-name}
address@hidden @code{:email} @tab @code{user-mail-address}
address@hidden multitable
+
+Most of the @code{org-export-with-*} variables have the same effect in
+both HTML and address@hidden exporters, except for @code{:TeX-macros} and
address@hidden:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
address@hidden export.
+
+When a property is given a value in org-publish-project-alist, its
+setting overrides the value of the corresponding user variable (if any)
+during publishing. Options set within a file (@pxref{Export
+options}), however, override everything.
+
address@hidden Publishing links, Project page index, Publishing options,
Configuration
address@hidden Links between published files
address@hidden links, publishing
+
+To create a link from one Org-mode file to another, you would use
+something like @samp{[[file:foo.org][The foo]]} or simply
address@hidden:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link
+becomes a link to @file{foo.html}. In this way, you can interlink the
+pages of your "org web" project and the links will work as expected when
+you publish them to HTML.
+
+You may also link to related files, such as images. Provided you are
+careful with relative pathnames, and provided you have also configured
+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
+only valid in your production environment, but not in the publishing
+location. In this case, use the property
+
address@hidden @columnfractions 0.4 0.6
address@hidden @code{:link-validation-function}
address@hidden Function to validate links
address@hidden multitable
+
address@hidden
+to define a function for checking link validity. This function must
+accept two arguments, the file name and a directory relative to which
+the file name is interpreted in the production environment. If this
+function returns @code{nil}, then the HTML generator will only insert a
+description into the HTML file, but no link. One option for this
+function is @code{org-publish-validate-link} which checks if the given
+file is part of any project in @code{org-publish-project-alist}.
+
address@hidden Project page index, , Publishing links, Configuration
address@hidden Project page index
address@hidden index, of published pages
+
+The following properties may be used to control publishing of an
+index of files or summary page for a given project.
+
address@hidden @columnfractions 0.25 0.75
address@hidden @code{:auto-index}
address@hidden When non-nil, publish an index during
org-publish-current-project or
+org-publish-all.
+
address@hidden @code{:index-filename}
address@hidden Filename for output of index. Defaults to @file{index.org} (which
+becomes @file{index.html}).
+
address@hidden @code{:index-title}
address@hidden Title of index page. Defaults to name of file.
+
address@hidden @code{:index-function}
address@hidden Plugin 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.
address@hidden multitable
+
address@hidden Sample configuration, Triggering publication, Configuration,
Publishing
address@hidden 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
+more complex, with a multi-component project.
+
address@hidden
+* Simple example:: One-component publishing
+* Complex example:: A multi-component publishing example
address@hidden menu
+
address@hidden Simple example, Complex example, Sample configuration, Sample
configuration
address@hidden Example: simple publishing configuration
+
+This example publishes a set of Org-mode files to the @file{public_html}
+directory on the local machine.
+
address@hidden
+(setq org-publish-project-alist
+ '(("org"
+ :base-directory "~/org/"
+ :publishing-directory "~/public_html"
+ :section-numbers nil
+ :table-of-contents nil
+ :style "<link rel=stylesheet
+ href=\"../other/mystyle.css\"
+ type=\"text/css\">")))
address@hidden lisp
+
address@hidden Complex example, , Simple example, Sample configuration
address@hidden Example: complex publishing configuration
+
+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
+excluded.
+
+To ensure that links are preserved, care should be taken to replicate
+your directory structure on the web server, and to use relative file
+paths. For example, if your org files are kept in @file{~/org} and your
+publishable images in @file{~/images}, you'd link to an image with
address@hidden
address@hidden
+file:../images/myimage.png
address@hidden example
address@hidden
+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.
+
address@hidden
+(setq org-publish-project-alist
+ '(("orgfiles"
+ :base-directory "~/org/"
+ :base-extension "org"
+ :publishing-directory "/ssh:user@@host:~/html/notebook/"
+ :publishing-function org-publish-org-to-html
+ :exclude "PrivatePage.org" ;; regexp
+ :headline-levels 3
+ :section-numbers nil
+ :table-of-contents nil
+ :style "<link rel=stylesheet
+ href=\"../other/mystyle.css\" type=\"text/css\">"
+ :auto-preamble t
+ :auto-postamble nil)
+
+ ("images"
+ :base-directory "~/images/"
+ :base-extension "jpg\\|gif\\|png"
+ :publishing-directory "/ssh:user@@host:~/html/images/"
+ :publishing-function org-publish-attachment)
+
+ ("other"
+ :base-directory "~/other/"
+ :base-extension "css\\|el"
+ :publishing-directory "/ssh:user@@host:~/html/other/"
+ :publishing-function org-publish-attachment)
+ ("website" :components ("orgfiles" "images" "other"))))
address@hidden lisp
+
address@hidden Triggering publication, , Sample configuration, Publishing
address@hidden Triggering publication
+
+Once org-publish is properly configured, you can publish with the
+following functions:
+
address@hidden @kbd
address@hidden C-c C-e C
+Prompt for a specific project and publish all files that belong to it.
address@hidden C-c C-e P
+Publish the project containing the current file.
address@hidden C-c C-e F
+Publish only the current file.
address@hidden C-c C-e A
+Publish all projects.
address@hidden table
+
+Org uses timestamps to track when a file has changed. The above
+functions normally only publish changed files. You can override this and
+force publishing of all files by giving a prefix argument.
+
address@hidden Miscellaneous, Extensions and Hacking, Publishing, Top
address@hidden Miscellaneous
+
address@hidden
+* Completion:: M-TAB knows what you need
+* Customization:: Adapting Org-mode 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
+* Interaction:: Other Emacs packages
+* Bugs:: Things which do not work perfectly
address@hidden menu
+
address@hidden Completion, Customization, Miscellaneous, Miscellaneous
address@hidden Completion
address@hidden completion, of @TeX{} symbols
address@hidden completion, of TODO keywords
address@hidden completion, of dictionary words
address@hidden completion, of option keywords
address@hidden completion, of tags
address@hidden completion, of property keys
address@hidden completion, of link abbreviations
address@hidden @TeX{} symbol completion
address@hidden TODO keywords completion
address@hidden dictionary word completion
address@hidden option keyword completion
address@hidden tag completion
address@hidden link abbreviations, completion of
+
+Org-mode 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.
+
address@hidden @kbd
address@hidden address@hidden
address@hidden address@hidden
+Complete word at point
address@hidden @bullet
address@hidden
+At the beginning of a headline, complete TODO keywords.
address@hidden
+After @samp{\}, complete @TeX{} symbols supported by the exporter.
address@hidden
+After @samp{*}, complete headlines in the current buffer so that they
+can be used in search links like @samp{[[*find this headline]]}.
address@hidden
+After @samp{:} in a headline, complete tags. The list of tags is taken
+from the variable @code{org-tag-alist} (possibly set through the
address@hidden in-buffer option, @pxref{Setting tags}), or it is created
+dynamically from all tags used in the current buffer.
address@hidden
+After @samp{:} and not in a headline, complete property keys. The list
+of keys is constructed dynamically from all keys used in the current
+buffer.
address@hidden
+After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
address@hidden
+After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
address@hidden which set file-specific options for Org-mode. When the
+option keyword is already complete, pressing @address@hidden again
+will insert example settings for this keyword.
address@hidden
+In the line after @samp{#+STARTUP: }, complete startup keywords,
+i.e. valid keys for this line.
address@hidden
+Elsewhere, complete dictionary words using ispell.
address@hidden itemize
address@hidden table
+
address@hidden Customization, In-buffer settings, Completion, Miscellaneous
address@hidden Customization
address@hidden customization
address@hidden options, for customization
address@hidden 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
+describing the variables here. A structured overview of customization
+variables is available with @kbd{M-x org-customize}. Or select
address@hidden Org Group} from the @code{Org->Customization} menu. Many
+settings can also be activated on a per-file basis, by putting special
+lines into the buffer (@pxref{In-buffer settings}).
+
address@hidden In-buffer settings, The very busy C-c C-c key, Customization,
Miscellaneous
address@hidden Summary of in-buffer settings
address@hidden in-buffer settings
address@hidden special keywords
+
+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
+lines for the keyword. While these settings are described throughout
+the manual, here is a summary. After changing any of those lines in the
+buffer, press @kbd{C-c C-c} with the cursor still in the line to
+activate the changes immediately. Otherwise they become effective only
+when the file is visited again in a new Emacs session.
+
address@hidden @kbd
address@hidden #+ARCHIVE: %s_done::
+This line sets the archive location for the agenda file. It applies for
+all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
+of the file. The first such line also applies to any entries before it.
+The corresponding variable is @code{org-archive-location}.
address@hidden #+CATEGORY:
+This line sets the category for the agenda file. The category applies
+for all subsequent lines until the next @samp{#+CATEGORY} line, or the
+end of the file. The first such line also applies to any entries before it.
address@hidden #+COLUMNS: %25ITEM .....
+Set the default format for columns view. This format applies when
+columns view is invoked in location where no COLUMNS property applies.
address@hidden #+CONSTANTS: name1=value1 ...
+Set file-local values for constants to be used in table formulas. This
+line set the local variable @code{org-table-formula-constants-local}.
+The global version of theis variable is
address@hidden
+corresponding
address@hidden #+LINK: linkword replace
+These lines (several are allowed) specify link abbreviations.
address@hidden abbreviations}. The corresponding variable is
address@hidden
address@hidden #+PRIORITIES: highest lowest default
+This line sets the limits and the default for the priorities. All three
+must be either letters A-Z or numbers 0-9. The highest priority must
+have a lower ASCII number that the lowest priority.
address@hidden #+PROPERTY: Property_Name Value
+This line sets a default inheritance value for entries in the current
+buffer, most useful for specifying the allowed values of a property.
address@hidden #+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
+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}.
address@hidden @code{overview}, STARTUP keyword
address@hidden @code{content}, STARTUP keyword
address@hidden @code{showall}, STARTUP keyword
address@hidden
+overview @r{top-level headlines only}
+content @r{all headlines}
+showall @r{no folding at all, show everything}
address@hidden example
+Then there are options for aligning tables upon visiting a file. This
+is useful in files containing narrowed table columns. The corresponding
+variable is @code{org-startup-align-all-tables}, with a default value
address@hidden
address@hidden @code{align}, STARTUP keyword
address@hidden @code{noalign}, STARTUP keyword
address@hidden
+align @r{align all tables}
+noalign @r{don't align tables on startup}
address@hidden example
+Logging TODO state changes and clock intervals (variable
address@hidden) can be configured using these options.
address@hidden @code{logdone}, STARTUP keyword
address@hidden @code{nologging}, STARTUP keyword
address@hidden @code{lognotedone}, STARTUP keyword
address@hidden @code{lognoteclock-out}, STARTUP keyword
address@hidden @code{lognotestate}, STARTUP keyword
address@hidden @code{logrepeat}, STARTUP keyword
address@hidden @code{nologrepeat}, STARTUP keyword
address@hidden
+logging @r{record a timestamp when an item is marked DONE}
+nologging @r{don't record when items are marked DONE}
+lognotedone @r{record timestamp and a note when DONE}
+lognotestate @r{record timestamp and a note when TODO state changes}
+logrepeat @r{record a note when re-instating a repeating item}
+nologrepeat @r{do not record when re-instating repeating item}
+lognoteclock-out @r{record timestamp and a note when clocking out}
address@hidden example
+Here are the options for hiding leading stars in outline headings. The
+corresponding variables are @code{org-hide-leading-stars} and
address@hidden, both with a default setting @code{nil}
+(meaning @code{showstars} and @code{oddeven}).
address@hidden @code{hidestars}, STARTUP keyword
address@hidden @code{showstars}, STARTUP keyword
address@hidden @code{odd}, STARTUP keyword
address@hidden @code{even}, STARTUP keyword
address@hidden
+hidestars @r{make all but one of the stars starting a headline invisible.}
+showstars @r{show all stars starting a headline}
+odd @r{allow only odd outline levels (1,3,...)}
+oddeven @r{allow all outline levels}
address@hidden example
+To turn on custom format overlays over time stamps (variables
address@hidden and
address@hidden), use
address@hidden @code{customtime}, STARTUP keyword
address@hidden
+customtime @r{overlay custom time format}
address@hidden example
+The following options influence the table spreadsheet (variable
address@hidden).
address@hidden @code{constcgs}, STARTUP keyword
address@hidden @code{constSI}, STARTUP keyword
address@hidden
+constcgs @address@hidden should use the c-g-s unit system}
+constSI @address@hidden should use the SI unit system}
address@hidden example
address@hidden #+TAGS: TAG1(c1) TAG2(c2)
+These lines (several such lines are allowed) specify the legal tags in
+this file, and (potentially) the corresponding @emph{fast tag selection}
+keys. The corresponding variable is @code{org-tag-alist}.
address@hidden #+TBLFM:
+This line contains the formulas for the table directly above the line.
address@hidden #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:
+These lines provide settings for exporting files. For more details see
address@hidden options}.
address@hidden #+SEQ_TODO: #+TYP_TODO:
+These lines set the TODO keywords and their interpretation in the
+current file. The corresponding variables are @code{org-todo-keywords}
+and @code{org-todo-interpretation}.
address@hidden table
+
address@hidden The very busy C-c C-c key, Clean view, In-buffer settings,
Miscellaneous
address@hidden The very busy C-c C-c key
address@hidden C-c C-c
address@hidden C-c C-c, overview
+
+The key @kbd{C-c C-c} has many purposes in org-mode, 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
+here and update according to what you see here}. Here is a summary of
+what this means in different contexts.
+
address@hidden @minus
address@hidden
+If there are highlights in the buffer from the creation of a sparse
+tree, or from clock display, remove these highlights.
address@hidden
+If the cursor is in one of the special @code{#+KEYWORD} lines, this
+triggers scanning the buffer for these lines and updating the
+information.
address@hidden
+If the cursor is inside a table, realign the table. This command
+works even if the automatic table editor has been turned off.
address@hidden
+If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
+the entire table.
address@hidden
+If the cursor is inside a table created by the @file{table.el} package,
+activate that table.
address@hidden
+If the current buffer is a remember buffer, close the note and file it.
+With a prefix argument, file it, without further interaction, to the
+default location.
address@hidden
+If the cursor is on a @code{<<<target>>>}, update radio targets and
+corresponding links in this buffer.
address@hidden
+If the cursor is in a property line or at the start or end of a property
+drawer, offer property commands.
address@hidden
+If the cursor is in a plain list item with a checkbox, toggle the status
+of the checkbox.
address@hidden
+If the cursor is on a numbered item in a plain list, renumber the
+ordered list.
address@hidden itemize
+
address@hidden Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
address@hidden A cleaner outline view
address@hidden hiding leading stars
address@hidden clean outline view
+
+Some people find it noisy and distracting that the Org-mode headlines
+are starting with a potentially large number of stars. For example
+the tree from @ref{Headlines}:
+
address@hidden
+* Top level headline
+** Second level
+*** 3rd level
+ some text
+*** 3rd level
+ more text
+* Another top level headline
address@hidden example
+
address@hidden
+Unfortunately this is deeply ingrained into the code of Org-mode 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
address@hidden like this:
+
address@hidden
+(setq org-hide-leading-stars t)
address@hidden lisp
+
address@hidden
+or change this on a per-file basis with one of the lines (anywhere in
+the buffer)
+
address@hidden
+#+STARTUP: showstars
+#+STARTUP: hidestars
address@hidden example
+
address@hidden
+Press @kbd{C-c C-c} with the cursor in a @samp{STARTUP} line to activate
+the modifications.
+
+With stars hidden, the tree becomes:
+
address@hidden
+* Top level headline
+ * Second level
+ * 3rd level
+ some text
+ * 3rd level
+ more text
+* Another top level headline
address@hidden example
+
address@hidden
+Note that the leading stars are not truly replaced by whitespace, they
+are only fontified with the face @code{org-hide} that uses the
+background color as font color. If you are not using either white or
+black background, you may have to customize this face to get the wanted
+effect. Another possibility is to set this font such that the extra
+stars are @i{almost} invisible, for example using the color
address@hidden on a white background.
+
+Things become cleaner still if you skip all the even levels and use only
+odd levels 1, 3, 5..., effectively adding two stars to go from one
+outline level to the next:
+
address@hidden
+* Top level headline
+ * Second level
+ * 3rd level
+ some text
+ * 3rd level
+ more text
+* Another top level headline
address@hidden example
+
address@hidden
+In order to make the structure editing and export commands handle this
+convention correctly, use
+
address@hidden
+(setq org-odd-levels-only t)
address@hidden lisp
+
address@hidden
+or set this on a per-file basis with one of the following lines (don't
+forget to press @kbd{C-c C-c} with the cursor in the startup line to
+activate changes immediately).
+
address@hidden
+#+STARTUP: odd
+#+STARTUP: oddeven
address@hidden example
+
+You can convert an Org-mode 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}.
+
address@hidden TTY keys, Interaction, Clean view, Miscellaneous
address@hidden Using org-mode on a tty
address@hidden tty keybindings
+
+Org-mode uses a number of keys that are not accessible on a tty. This
+applies to most special keys like cursor keys, @key{TAB} and
address@hidden, when these are combined with modifier keys like @key{Meta}
+and/or @key{Shift}. Org-mode uses these bindings because it needs to
+provide keys for a large number of commands, and because these keys
+appeared particularly easy to remember. In order to still be able to
+access the core functionality of Org-mode on a tty, alternative
+bindings are provided. Here is a complete list of these bindings,
+which are obviously more cumbersome to use. Note that sometimes a
+work-around can be better. For example changing a time stamp is
+really only fun with @address@hidden keys. On a tty you would
+rather use @kbd{C-c .} to re-insert the timestamp.
+
address@hidden @columnfractions 0.15 0.2 0.2
address@hidden @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
address@hidden @address@hidden @tab @kbd{C-u @key{TAB}} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x l} @tab
@address@hidden @key{left}}
address@hidden @address@hidden @tab @kbd{C-c C-x L} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x r} @tab
@address@hidden @key{right}}
address@hidden @address@hidden @tab @kbd{C-c C-x R} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x u} @tab
@address@hidden @key{up}}
address@hidden @address@hidden @tab @kbd{C-c C-x U} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x d} @tab
@address@hidden @key{down}}
address@hidden @address@hidden @tab @kbd{C-c C-x D} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x c} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x m} @tab
@address@hidden @key{RET}}
address@hidden @address@hidden @tab @kbd{C-c C-x M} @tab
address@hidden @address@hidden @tab @kbd{C-c @key{left}} @tab
address@hidden @address@hidden @tab @kbd{C-c @key{right}} @tab
address@hidden @address@hidden @tab @kbd{C-c @key{up}} @tab
address@hidden @address@hidden @tab @kbd{C-c @key{down}} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x @key{left}} @tab
address@hidden @address@hidden @tab @kbd{C-c C-x @key{right}} @tab
address@hidden multitable
+
address@hidden Interaction, Bugs, TTY keys, Miscellaneous
address@hidden Interaction with other packages
address@hidden packages, interaction with other
+Org-mode lives in the world of GNU Emacs and interacts in various ways
+with other code out there.
+
address@hidden
+* Cooperation:: Packages Org-mode cooperates with
+* Conflicts:: Packages that lead to conflicts
address@hidden menu
+
address@hidden Cooperation, Conflicts, Interaction, Interaction
address@hidden Packages that Org-mode cooperates with
+
address@hidden @asis
address@hidden @file{calc.el}
address@hidden @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
address@hidden 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}.
address@hidden @file{constants.el}
address@hidden @file{constants.el} by Carsten Dominik
+In a table formula (@pxref{The spreadsheet}), it is possible to use
+names for natural constants or units. Instead of defining your own
+constants in the variable @code{org-table-formula-constants}, install
+the @file{constants} package which defines a large number of constants
+and units, and lets you use unit prefixes like @samp{M} for
address@hidden etc. You will need version 2.0 of this package, available
+at @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks for
+the function @code{constants-get}, which has to be autoloaded in your
+setup. See the installation instructions in the file
address@hidden
address@hidden @file{cdlatex.el} by Carsten Dominik
address@hidden @file{cdlatex.el}
+Org-mode can make use of the cdlatex package to efficiently enter
address@hidden fragments into Org-mode files. See @ref{CDLaTeX mode}.
address@hidden @file{remember.el} by John Wiegley
address@hidden @file{remember.el}
+Org mode cooperates with remember, see @ref{Remember}.
address@hidden is not part of Emacs, find it on the web.
address@hidden @file{table.el}
address@hidden @file{table.el} by Takaaki Ota
address@hidden C-c C-c
address@hidden table editor, @file{table.el}
address@hidden @file{table.el}
+
+Complex ASCII tables with automatic line wrapping, column- and
+row-spanning, and alignment can be created using the Emacs table
+package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
+and also part of Emacs 22).
+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.
+
address@hidden @kbd
address@hidden C-c C-c
address@hidden C-c C-c
+Recognize @file{table.el} table. Works when the cursor is in a
+table.el table.
address@hidden
address@hidden C-c ~
address@hidden 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
+format. See the documentation string of the command
address@hidden for the restrictions under which this is
+possible.
address@hidden table
address@hidden is part of Emacs 22.
address@hidden @file{footnote.el}
address@hidden @file{footnote.el} by Steven L. Baur
+Org-mode recognizes numerical footnotes as provided by this package
+(@pxref{Footnotes}).
address@hidden table
+
address@hidden Conflicts, , Cooperation, Interaction
address@hidden Packages that lead to conflicts with Org-mode
+
address@hidden @asis
+
address@hidden @file{allout.el}
address@hidden @file{allout.el} by Ken Manheimer
+Startup of Org-mode may fail with the error message
address@hidden(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
+disappear. If for some reason you cannot do this, make sure that org.el
+is loaded @emph{before} @file{allout.el}, for example by putting
address@hidden(require 'org)} early enough into your @file{.emacs} file.
+
address@hidden @file{CUA.el}
address@hidden @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 extend the region. If you want to use one of these
+packages along with Org-mode, configure the variable
address@hidden When set, Org-mode will move the following
+keybindings in Org-mode files, and in the agenda buffer (but not
+during date selection).
+
address@hidden
+S-UP -> M-p S-DOWN -> M-n
+S-LEFT -> M-- S-RIGHT -> M-+
address@hidden example
+
+Yes, these are unfortunately more difficult to remember. If you want
+to have other replacement keys, look at the variable
address@hidden
address@hidden @file{windmove.el} by Hovav Shacham
address@hidden @file{windmove.el}
+Also this package uses the @kbd{S-<cursor>} keys, so everything written
+in the paragraph above about CUA mode also applies here.
+
address@hidden @file{footnote.el}
address@hidden @file{footnote.el} by Steven L. Baur
+Org-mode supports the syntax of the footnote package, but only the
+numerical footnote markers. Also, the default key for footnote
+commands, @kbd{C-c !} is already used by Org-mode. You could use the
+variable @code{footnote-prefix} to switch footnotes commands to another
+key. Or, you could use @code{org-replace-disputed-keys} and
address@hidden to change the settings in Org-mode.
+
address@hidden table
+
+
address@hidden Bugs, , Interaction, Miscellaneous
address@hidden Bugs
address@hidden bugs
+
+Here is a list of things that should work differently, but which I
+have found too hard to fix.
+
address@hidden @bullet
address@hidden
+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
+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.
address@hidden
+Narrowing table columns does not work on XEmacs, because the
address@hidden function does not transport text properties.
address@hidden
+Text in an entry protected with the @samp{QUOTE} keyword should not
+autowrap.
address@hidden
+When the application called by @kbd{C-c C-o} to open a file link fails
+(for example because the application does not exist or refuses to open
+the file), it does so silently. No error message is displayed.
address@hidden
+Recalculating a table line applies the formulas from left to right.
+If a formula uses @emph{calculated} fields further down the row,
+multiple recalculation may be needed to get all fields consistent. You
+may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to
+recalculate until convergence.
address@hidden
+A single letter cannot be made bold, for example @samp{*a*}.
address@hidden
+The exporters work well, but could be made more efficient.
address@hidden itemize
+
+
address@hidden Extensions and Hacking, History and Acknowledgments,
Miscellaneous, Top
address@hidden Extensions, Hooks and Hacking
+
+This appendix lists extensions for Org-mode written by other authors.
+It also covers some aspects where users can extend the functionality of
+Org-mode.
+
address@hidden
+* Extensions:: Existing 3rd-part 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
address@hidden menu
+
address@hidden Extensions, Adding hyperlink types, Extensions and Hacking,
Extensions and Hacking
address@hidden Third-party extensions for Org-mode
address@hidden extension, third-party
+
+The following extensions for Org-mode have been written by other people:
+
address@hidden @asis
address@hidden @file{org-publish.el}
address@hidden @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,
address@hidden can be downloaded from David's site:
address@hidden://dto.freeshell.org/e/org-publish.el}.
address@hidden @file{org-mouse.el}
address@hidden @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
address@hidden 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,
address@hidden can be downloaded from Piotr's site:
address@hidden://www.cl.cam.ac.uk/~pz215/files/org-mouse.el}.
address@hidden @file{org-blog.el}
address@hidden @file{org-blog.el} by David O'Toole
+A blogging plug-in for @address@hidden
address@hidden://dto.freeshell.org/notebook/OrgMode.html}.
address@hidden @file{blorg.el}
address@hidden @file{blorg.el} by Bastien Guerry
+Publish Org-mode files as
+blogs. @url{http://www.cognition.ens.fr/~guerry/blorg.html}.
address@hidden @file{org2rem.el}
address@hidden @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}.
address@hidden table
+
address@hidden
+
address@hidden Adding hyperlink types, Tables in arbitrary syntax, Extensions,
Extensions and Hacking
address@hidden Adding hyperlink types
address@hidden hyperlinks, adding new types
+
+Org-mode 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
address@hidden that will add support for creating links like
address@hidden:printf][The printf manpage]]} to show unix manual pages inside
+emacs:
+
address@hidden
+;;; org-man.el - Support for links to manpages in Org-mode
+
+(require 'org)
+
+(org-add-link-type "man" 'org-man-open)
+(add-hook 'org-store-link-functions 'org-man-store-link)
+
+(defcustom org-man-command 'man
+ "The Emacs command to be used to display a man page."
+ :group 'org-link
+ :type '(choice (const man) (const woman)))
+
+(defun org-man-open (path)
+ "Visit the manpage on PATH.
+PATH should be a topic that can be thrown at the man command."
+ (funcall org-man-command path))
+
+(defun org-man-store-link ()
+ "Store a link to a manpage."
+ (when (memq major-mode '(Man-mode woman-mode))
+ ;; This is a man page, we do make this link
+ (let* ((page (org-man-get-page-name))
+ (link (concat "man:" page))
+ (description (format "Manpage for %s" page)))
+ (org-store-link-props
+ :type "man"
+ :link link
+ :description description))))
+
+(defun org-man-get-page-name ()
+ "Extract the page name from the buffer name."
+ ;; This works for both `Man-mode' and `woman-mode'.
+ (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
+ (match-string 1 (buffer-name))
+ (error "Cannot create link to this man page")))
+
+(provide 'org-man)
+
+;;; org-man.el ends here
address@hidden lisp
+
address@hidden
+You would activate this new link type in @file{.emacs} with
+
address@hidden
+(require 'org-man)
address@hidden lisp
+
address@hidden
+Lets go through the file and see what it does.
address@hidden
address@hidden
+It does @code{(require 'org)} to make sure that @file{org.el} has been
+loaded.
address@hidden
+The next line calls @code{org-add-link-type} to define a new link type
+with prefix @samp{man}. The call also contains the name of a function
+that will be called to follow such a link.
address@hidden
+The next line adds a function to @code{org-store-link-functions}, in
+order to allow the command @kbd{C-c l} to record a useful link in a
+buffer displaying a man page.
address@hidden enumerate
+
+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,
address@hidden 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
+value of @code{org-man-command} to display the man page.
+
+Finally the function @code{org-man-store-link} is defined. When you try
+to store a link with @kbd{C-c l}, also this function will be called to
+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
address@hidden:}. 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
+buffer with @kbd{C-c C-l}.
+
address@hidden Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink
types, Extensions and Hacking
address@hidden Tables in arbitrary syntax
address@hidden tables, in other modes
address@hidden 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 address@hidden However, this is extremely hard
+to do in a general way, would lead to a customization nightmare, and
+would take away much of the simplicity of the Orgtbl-mode table editor.
+
+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
address@hidden it in the right location (the @i{target table}). This puts
+the burden of writing conversion functions on the user, but it allows
+for a very flexible system.
+
address@hidden
+* Radio tables:: Sending and receiving
+* A LaTeX example:: Step by step, almost a tutorial
+* Translator functions:: Copy and modify
address@hidden menu
+
address@hidden Radio tables, A LaTeX example, Tables in arbitrary syntax,
Tables in arbitrary syntax
address@hidden Radio tables
address@hidden radio tables
+
+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
+between these lines, replacing whatever was there before. For example:
+
address@hidden
+/* BEGIN RECEIVE ORGTBL table_name */
+/* END RECEIVE ORGTBL table_name */
address@hidden example
+
address@hidden
+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
+example:
address@hidden
+#+ORGTBL: SEND table_name translation_function arguments....
address@hidden example
+
address@hidden
address@hidden is the reference name for the table that is also used
+in the receiver lines. @code{translation_function} is the Lisp function
+that does the translation. Furthermore, the line can contain a list of
+arguments (alternating key and value) at the end. The arguments will be
+passed as a property list to the translation function for
+interpretation. A few standard parameters are already recognized and
+acted upon before the translation function is called:
+
address@hidden @code
address@hidden :skip N
+Skip the first N lines of the table. Hlines do count!
address@hidden :skipcols (n1 n2 ...)
+List of columns that should be skipped. If the table has a column with
+calculation marks, that column is automatically discarded as well.
+Please note that the translator function sees the table @emph{after} the
+removal of these columns, the function never knows that there have been
+additional columns.
address@hidden table
+
address@hidden
+The one problem remaining is how to keep the source table in the buffer
+without disturbing the normal workings of the file, for example during
+compilation of a C file or processing of a address@hidden file. There are a
+number of different solutions:
+
address@hidden @bullet
address@hidden
+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
address@hidden/*} and @samp{*/} lines.
address@hidden
+Sometimes it is possible to put the table after some kind of @i{END}
+statement, for example @samp{\bye} in TeX and @address@hidden@}}
+in address@hidden
address@hidden
+You can just comment the table line by line whenever you want to process
+the file, and uncomment it whenever you need to edit the table. This
+only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
+make this comment-toggling very easy, in particular if you bind it to a
+key.
address@hidden itemize
+
address@hidden A LaTeX example, Translator functions, Radio tables, Tables in
arbitrary syntax
address@hidden A LaTeX example
address@hidden LaTeX, and orgtbl-mode
+
+The best way to wrap the source table in address@hidden is to use the
address@hidden environment provided by @file{comment.sty}. It has to be
+activated by placing @address@hidden@}} into the document
+header. Orgtbl-mode can insert a radio table address@hidden
+default this works only for address@hidden, 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
+will then get the following template:
+
address@hidden
+% BEGIN RECEIVE ORGTBL salesfigures
+% END RECEIVE ORGTBL salesfigures
address@hidden@}
+#+ORGTBL: SEND salesfigures orgtbl-to-latex
+| | |
address@hidden@}
address@hidden example
+
address@hidden
+The @code{#+ORGTBL: SEND} line tells orgtbl-mode to use the function
address@hidden to convert the table into address@hidden 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 address@hidden
+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
+example you can fix this by adding an extra line inside the
address@hidden environment that is used to balance the dollar
+expressions. If you are using AUCTeX with the font-latex library, a
+much better solution is to add the @code{comment} environment to the
+variable @code{LaTeX-verbatim-environments}.}:
+
address@hidden
+% BEGIN RECEIVE ORGTBL salesfigures
+% END RECEIVE ORGTBL salesfigures
address@hidden@}
+#+ORGTBL: SEND salesfigures orgtbl-to-latex
+| Month | Days | Nr sold | per day |
+|-------+------+---------+---------|
+| Jan | 23 | 55 | 2.4 |
+| Feb | 21 | 16 | 0.8 |
+| March | 22 | 278 | 12.6 |
+#+TBLFM: $4=$3/$2;%.1f
+% $ (optional extra dollar to keep font-lock happy, see footnote)
address@hidden@}
address@hidden example
+
address@hidden
+When you are done, press @kbd{C-c C-c} in the table to get the converted
+table inserted between the two marker lines.
+
+Now lets assume you want to make the table header by hand, because you
+want to control how columns are aligned etc. In this case we make sure
+that the table translator does skip the first 2 lines of the source
+table, and tell the command to work as a @i{splice}, i.e. to not produce
+header and footer commands of the target table:
+
address@hidden
address@hidden@address@hidden@}
+Month & address@hidden@address@hidden@address@hidden@} & Nr.\ sold & per day\\
+% BEGIN RECEIVE ORGTBL salesfigures
+% END RECEIVE ORGTBL salesfigures
address@hidden@}
+%
address@hidden@}
+#+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
+| Month | Days | Nr sold | per day |
+|-------+------+---------+---------|
+| Jan | 23 | 55 | 2.4 |
+| Feb | 21 | 16 | 0.8 |
+| March | 22 | 278 | 12.6 |
+#+TBLFM: $4=$3/$2;%.1f
address@hidden@}
address@hidden example
+
+The address@hidden translator function @code{orgtbl-to-latex} is already part
of
+Orgtbl-mode. It uses a @code{tabular} environment to typeset the table
+and marks horizontal lines with @code{\hline}. Furthermore, it
+interprets the following parameters:
+
address@hidden @code
address@hidden :splice nil/t
+When set to t, return only table body lines, don't wrap them into a
+tabular environment. Default is nil.
+
address@hidden :fmt fmt
+A format to be used to wrap each field, should contain @code{%s} for the
+original field value. For example, to wrap each field value in dollars,
+you could use @code{:fmt "$%s$"}. This may also be a property list with
+column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
+
address@hidden :efmt efmt
+Use this format to print numbers with exponentials. The format should
+have @code{%s} twice for inserting mantissa and exponent, for example
address@hidden"address@hidden@}"}. The default is @code{"%s\\,(%s)"}. This
+may also be a property list with column numbers and formats, for example
address@hidden:efmt (2 "address@hidden@}$" 4 "address@hidden@}$")}. After
address@hidden has been applied to a value, @code{fmt} will also be
+applied.
address@hidden table
+
address@hidden Translator functions, , A LaTeX example, Tables in arbitrary
syntax
address@hidden Translator functions
address@hidden HTML, and orgtbl-mode
address@hidden translator function
+
+Orgtbl-mode has several translator functions built-in:
address@hidden, @code{orgtbl-to-html}, and
address@hidden Except for @address@hidden
+HTML translator uses the same code that produces tables during HTML
+export.}, these all use a generic translator, @code{orgtbl-to-generic}.
+For example, @code{orgtbl-to-latex} itself is a very short function that
+computes the column definitions for the @code{tabular} environment,
+defines a few field and line separators and then hands over to the
+generic translator. Here is the entire code:
+
address@hidden
address@hidden
+(defun orgtbl-to-latex (table params)
+ "Convert the orgtbl-mode TABLE to LaTeX."
+ (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
+ org-table-last-alignment ""))
+ (params2
+ (list
+ :tstart (concat "address@hidden@address@hidden" alignment "@}")
+ :tend "address@hidden@}"
+ :lstart "" :lend " \\\\" :sep " & "
+ :efmt "%s\\,(%s)" :hline "\\hline")))
+ (orgtbl-to-generic table (org-combine-plists params2 params))))
address@hidden group
address@hidden lisp
+
+As you can see, the properties passed into the function (variable
address@hidden) are combined with the ones newly defined in the function
+(variable @var{PARAMS2}). The ones passed into the function (i.e. the
+ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
+would like to use the address@hidden translator, but wanted the line endings to
+be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
+overrule the default with
+
address@hidden
+#+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
address@hidden example
+
+For a new language, you can either write your own converter function in
+analogy with the address@hidden translator, or you can use the generic function
+directly. For example, if you have a language where a table is started
+with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
+started with @samp{!BL!}, ended with @samp{!EL!} and where the field
+separator is a TAB, you could call the generic translator like this (on
+a single line!):
+
address@hidden
+#+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
+ :lstart "!BL! " :lend " !EL!" :sep "\t"
address@hidden example
+
address@hidden
+Please check the documentation string of the function
address@hidden for a full list of parameters understood by
+that function and remember that you can pass each of them into
address@hidden, @code{orgtbl-to-texinfo}, and any other function
+using the generic function.
+
+Of course you can also write a completely new function doing complicated
+things the generic translator cannot do. A translator function takes
+two arguments. The first argument is the table, a list of lines, each
+line either the symbol @code{hline} or a list of fields. The second
+argument is the property list containing all parameters specified in the
address@hidden: SEND} line. The function must return a single string
+containing the formatted table. If you write a generally useful
+translator, please post it on @code{emacs-orgmode@@gnu.org} so that
+others can benefit from your work.
+
address@hidden Dynamic blocks, Special agenda views, Tables in arbitrary
syntax, Extensions and Hacking
address@hidden Dynamic blocks
address@hidden dynamic blocks
+
+Org-mode 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}).
+
+Dynamic block are enclosed by a BEGIN-END structure that assigns a name
+to the block and can also specify parameters for the function producing
+the content of the block.
+
address@hidden
+#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
+
+#+END:
address@hidden example
+
+Dynamic blocks are updated with the following commands
+
address@hidden @kbd
address@hidden C-c C-x C-u
address@hidden C-c C-x C-u
+Update dynamic block at point.
address@hidden C-u C-c C-x C-u
address@hidden C-u C-c C-x C-u
+Update all dynamic blocks in the current file.
address@hidden table
+
+Updating a dynamic block means to remove all the text between BEGIN and
+END, parse the BEGIN line for parameters and then call the specific
+writer function for this block to insert the new content. For a block
+with name @code{myblock}, the writer function is
address@hidden:myblock} with as only parameter a property list
+with the parameters given in the begin line. Here is a trivial example
+of a block that keeps track of when the block update function was last
+run:
+
address@hidden
+#+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
+
+#+END:
address@hidden example
+
address@hidden
+The corresponding block writer function could look like this:
+
address@hidden
+(defun org-dblock-write:block-update-time (params)
+ (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
+ (insert "Last block update at: "
+ (format-time-string fmt (current-time)))))
address@hidden lisp
+
+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.
+
address@hidden Special agenda views, Using the property API, Dynamic blocks,
Extensions and Hacking
address@hidden Special Agenda Views
address@hidden agenda views, user-defined
+
+Org-mode 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
+PROJECT, but skip the match unless there is a WAITING tag anywhere in
+the subtree belonging to the project line.
+
+To achieve this, you must write a function that searches the subtree for
+the tag. If the tag is found, the function must return @code{nil} to
+indicate that this match should not be skipped. If there is no such
+tag, return the location of the end of the subtree, to indicate that
+search should continue from there.
+
address@hidden
+(defun my-skip-unless-waiting ()
+ "Skip trees that are not waiting"
+ (let ((subtree-end (save-excursion (org-end-of-subtree t))))
+ (if (re-search-forward ":WAITING:" subtree-end t)
+ nil ; tag found, do not skip
+ subtree-end))) ; tag not found, continue after end of subtree
address@hidden lisp
+
+Now you may use this function in an agenda custom command, for example
+like this:
+
address@hidden
+(org-add-agenda-custom-command
+ '("b" todo "PROJECT"
+ ((org-agenda-skip-function 'my-org-waiting-projects)
+ (org-agenda-overriding-header "Projects waiting for something: "))))
address@hidden lisp
+
+Note that this also binds @code{org-agenda-overriding-header} to get a
+meaningful header in the agenda view.
+
+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:
+
address@hidden @code
address@hidden '(org-agenda-skip-entry-if 'scheduled)
+Skip current entry if it has been scheduled.
address@hidden '(org-agenda-skip-entry-if 'notscheduled)
+Skip current entry if it has not been scheduled.
address@hidden '(org-agenda-skip-entry-if 'deadline)
+Skip current entry if it has a deadline.
address@hidden '(org-agenda-skip-entry-if 'scheduled 'deadline)
+Skip current entry if it has a deadline, or if it is scheduled.
address@hidden '(org-agenda-skip-entry 'regexp "regular expression")
+Skip current entry if the regular expression contained in the variable
address@hidden matches in the entry.
address@hidden '(org-agenda-skip-subtree-if 'regexp "regular expression")
+Same as above, but check and skip the entire subtree.
address@hidden table
+
+Therefore we could also have written the search for WAITING projects
+like this, even without defining a special function:
+
address@hidden
+(org-add-agenda-custom-command
+ '("b" todo "PROJECT"
+ ((org-agenda-skip-function '(org-agenda-skip-subtree-if
+ 'regexp ":WAITING:"))
+ (org-agenda-overriding-header "Projects waiting for something: "))))
address@hidden lisp
+
+
address@hidden Using the property API, , Special agenda views, Extensions and
Hacking
address@hidden Using the property API
address@hidden API, for properties
address@hidden properties, API
+
+Here is a description of the functions that can be used to work with
+properties.
+
address@hidden org-entry-properties &optional pom which
+Get all properties of the entry at point-or-marker POM.
+This includes the TODO keyword, the tags, time strings for deadline,
+scheduled, and clocking, and any additional properties defined in the
+entry. The return value is an alist, keys may occur multiple times
+if the property key was used several times.
+POM may also be nil, in which case the current entry is used.
+If WHICH is nil or `all', get all properties. If WHICH is
+`special' or `standard', only get that subclass.
address@hidden defun
address@hidden 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.
address@hidden defun
+
address@hidden org-entry-delete pom property
+Delete the property PROPERTY from entry at point-or-marker POM.
address@hidden defun
+
address@hidden org-entry-put pom property value
+Set PROPERTY to VALUE for entry at point-or-marker POM.
address@hidden defun
+
address@hidden org-buffer-property-keys &optional include-specials
+Get all property keys in the current buffer.
address@hidden defun
+
address@hidden org-insert-property-drawer
+Insert a property drawer at point.
address@hidden defun
+
address@hidden History and Acknowledgments, Index, Extensions and Hacking, Top
address@hidden History and Acknowledgments
address@hidden acknowledgments
address@hidden history
address@hidden 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
+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
+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
+editing} were originally implemented in the package
address@hidden, but quickly moved to the more general
address@hidden 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,
+plain text mode with innovative and intuitive editing features, and to
+incorporate project planning functionality directly into a notes file.
+
+Since the first release, literally thousands of emails to me or on
address@hidden@@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
+complete, if I have forgotten someone, please accept my apologies and
+let me know.
+
address@hidden @bullet
+
address@hidden
address@hidden Adams} came up with the idea for drawers.
address@hidden
address@hidden Baumann} contributed the code for links to the MH-E email
+system.
address@hidden
address@hidden Bochannek} provided a patch for rounding time stamps.
address@hidden
address@hidden Cave}'s suggestion sparked the implementation of templates
+for Remember.
address@hidden
address@hidden Chalmoviansky} influenced the agenda treatment of items with
+specified time.
address@hidden
address@hidden Chernov} patched support for lisp forms into table
+calculations and improved XEmacs compatibility, in particular by porting
address@hidden to XEmacs.
address@hidden
address@hidden Chua} suggested to copy some linking code from Planner.
address@hidden
address@hidden DeVilla} proposed and tested checkbox statistics. He also
+came up with the idea of properties, and that there should be an API for
+them.
address@hidden
address@hidden Dullemond} used to edit projects lists directly in HTML and so
+inspired some of the early development, including HTML export. He also
+asked for a way to narrow wide table columns.
address@hidden
address@hidden Egli} converted the documentation into TeXInfo format,
+patched CSS formatting into the HTML exporter, and inspired the agenda.
address@hidden
address@hidden Emery} provided a patch for custom CSS support in exported
+HTML agendas.
address@hidden
address@hidden Ferrier} contributed mailcap and XOXO support.
address@hidden
address@hidden Foerch} figured out how to make incremental search show context
+around a match in a hidden outline tree.
address@hidden
address@hidden Giessen} had the idea to automatically archive DONE trees.
address@hidden
address@hidden Guerry} wrote the address@hidden exporter and has been prolific
+with patches, ideas, and bug reports.
+to Org-mode.
address@hidden
address@hidden Grossjohann} pointed out key-binding conflicts with other
packages.
address@hidden
address@hidden Jaderholm} proposed footnotes, control over whitespace between
+folded entries, and column view for properties.
address@hidden
address@hidden Liu} ("Leo") asked for embedded address@hidden and tested it.
He also
+provided frequent feedback and some patches.
address@hidden
address@hidden F. McBrayer} suggested agenda export to CSV format.
address@hidden
address@hidden Minaev} sent a patch to set priority limits on a per-file
+basis.
address@hidden
address@hidden Monnier} provided a patch to keep the Emacs-Lisp compiler
+happy.
address@hidden
address@hidden Moynihan} proposed to allow multiple TODO sequences in a file.
address@hidden
address@hidden Neal} provided patches for links to Info files and elisp forms.
address@hidden
address@hidden O'Callaghan} suggested in-file links, search options for general
+file links, and TAGS.
address@hidden
address@hidden Okano} translated the manual and David O'Toole's tutorial
+into Japanese.
address@hidden
address@hidden Oppitz} suggested multi-state TODO items.
address@hidden
address@hidden Otterson} sparked the introduction of descriptive text for
+links, among other things.
address@hidden
address@hidden Phillips} helped during the development of the TAGS feature, and
+provided frequent feedback.
address@hidden
address@hidden Raman} reported bugs and suggested improvements.
address@hidden
address@hidden Rempe} (Oelde) provided ideas, Windows support, and quality
+control.
address@hidden
address@hidden Rogers} contributed code to access VM files on remote hosts.
address@hidden
address@hidden Ruell} solved the mystery of the @code{keymapp nil} bug, a
+conflict with @file{allout.el}.
address@hidden
address@hidden Riedy} sent a patch to fix a bug with export of TODO keywords.
address@hidden
address@hidden Rooke} created the Org-mode reference card and provided lots
+of feedback.
address@hidden
address@hidden Schlauer} proposed angular brackets around links, among
+other things.
address@hidden
+Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s
address@hidden
address@hidden
address@hidden Sinder} came up with the idea of internal archiving by locking
+subtrees.
address@hidden
address@hidden Smith} proposed link abbreviations.
address@hidden
address@hidden Spiers} asked for global linking commands and inspired the link
+extension system. support mairix.
address@hidden
address@hidden O'Toole} wrote @file{org-publish.el} and drafted the manual
+chapter about publishing.
address@hidden
address@hidden@"urgen Vollmer} contributed code generating the table of contents
+in HTML output.
address@hidden
address@hidden Wallace} provided a patch implementing the @samp{QUOTE}
+keyword.
address@hidden
address@hidden Wainberg} suggested archiving, and improvements to the linking
+system.
address@hidden
address@hidden 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.
address@hidden
address@hidden Wimmer} suggested some changes and helped fix a bug in
+linking to GNUS.
address@hidden
address@hidden Winkler} requested additional keybindings to make Org-mode
+work on a tty.
address@hidden
address@hidden Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
+and contributed various ideas and code snippets.
address@hidden itemize
+
+
address@hidden Index, Key Index, History and Acknowledgments, Top
address@hidden Index
+
address@hidden cp
+
address@hidden Key Index, , Index, Top
address@hidden Key Index
+
address@hidden ky
+
address@hidden
+
address@hidden
+ arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac
address@hidden ignore