\input texinfo@c %**start of header@setfilename ../info/org@settitle Org Mode Manual@set VERSION 4.67@set DATE February 2007@dircategory Emacs@direntry* Org Mode: (org). Outline-based notes management and organizer@end direntry@c Version and Contact Info@set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/org/,maintainers webpage}@set AUTHOR Carsten Dominik@set MAINTAINER Carsten Dominik@set MAINTAINEREMAIL @email{dominik at science dot uva dot nl}@set MAINTAINERCONTACT @uref{mailto:dominik at science dot uva dot nl,contact the maintainer}@c %**end of header@finalout@c Macro definitions@c Subheadings inside a table.@macro tsubheading{text}@ifinfo@subsubheading \text\@end ifinfo@ifnotinfo@item @b{\text\}@end ifnotinfo@end macro@copyingThis manual is for Org-mode (version @value{VERSION}).Copyright @copyright{} 2004, 2005, 2006, 2007 Free Software Foundation@quotationPermission is granted to copy, distribute and/or modify this documentunder the terms of the GNU Free Documentation License, Version 1.1 orany later version published by the Free Software Foundation; with noInvariant Sections, with the Front-Cover texts being ``A GNU Manual,''and with the Back-Cover Texts as in (a) below. A copy of thelicense is included in the section entitled ``GNU Free DocumentationLicense.''(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modifythis GNU Manual, like GNU software. Copies published by the FreeSoftware Foundation raise funds for GNU development.''@end quotation@end copying@titlepage@title Org Mode Manual@subtitle Release @value{VERSION}@author by Carsten Dominik@c The following two commands start the copyright page.@page@vskip 0pt plus 1filll@insertcopying@end titlepage@c Output the table of contents at the beginning.@contents@ifnottex@node Top, Introduction, (dir), (dir)@top Org Mode Manual@insertcopying@end ifnottex@menu* 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* Timestamps:: Assign date and time to items* Tags:: Tagging headlines and matching sets of tags* 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 * GNU Free Documentation License:: The license for this documentation.* Index:: The fast road to specific information* Key Index:: Key bindings and where they are described@detailmenu --- 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 entryArchiving* ARCHIVE tag:: Marking a tree as inactive* Moving subtrees:: Moving a tree to an archive fileTables* Built-in table editor:: Simple tables* Narrow columns:: Stop wasting space in tables * 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 recalcHyperlinks* 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* 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 notesInternal 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 belongsTODO 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 managable pieces* Checkboxes:: Tick-off listsExtended use of TODO keywords* Workflow states:: From TODO to DONE in steps* TODO types:: I do this, Fred the rest* Per file keywords:: Different files, different requirementsTimestamps* Time stamps:: Assigning a time to a tree entry* Creating timestamps:: Commands which insert timestamps* Custom time format:: If you cannot work with the ISO format* Repeating items:: Deadlines that come back again and again* Progress logging:: Documenting when what work was done.Creating timestamps* The date/time prompt:: How org-mode helps you entering date and timeProgress 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?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 tagsAgenda 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 viewsThe built-in agenda views* Weekly/Daily agenda:: The calendar page with current tasks* Global TODO list:: All unfinished action items* Matching headline tags:: Structured information with fine-tuned search* Timeline:: Time-sorted view for single file* Stuck projects:: Find projects you need to reviewPresentation 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 thingsCustom agenda views* Storing searches:: Type once, use often* Block agenda:: All the stuff you need in a single buffer* Setting Options:: Changing the rules* Batch processing:: Agenda views from the command lineEmbedded 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 formulasExporting* ASCII export:: Exporting to plain ASCII* HTML export:: Exporting to HTML* XOXO export:: Exporting to XOXO* iCalendar export:: Exporting in iCalendar format* Text interpretation:: How the exporter looks at the fileHTML export* Export commands:: How to invode HTML export* Quoting HTML tags:: Using direct HTML in Org-mode* Links:: How hyperlinks get transferred to HTML* Images:: To inline or not to inline?* CSS support:: Style specificationsText interpretation by the exporter* Comment lines:: Some lines will not be exported* Enhancing text:: Subscripts, symbols and more* Export options:: How to influence the export settingsPublishing* Configuration:: Defining projects* Sample configuration:: Example projects* Triggering publication:: Publication commandsConfiguration* 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 filesSample configuration* Simple example:: One-component publishing* Complex example:: A multi-component publishing exampleMiscellaneous* 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 perfectlyInteraction with other packages* Cooperation:: Packages Org-mode cooperates with* Conflicts:: Packages that lead to conflictsExtensions, Hooks and Hacking* Extensions:: Existing 3rd-part extensions* Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs* Dynamic blocks:: Automatically filled blocks* Special agenda views:: Customized viewsTables in arbitrary syntax* Radio tables:: Sending and receiving* A LaTeX example:: Step by step, almost a tutorial* Translator functions:: Copy and modify@end detailmenu@end menu@node Introduction, Document structure, Top, Top@chapter Introduction@cindex introduction@menu* Summary:: Brief summary of what Org-mode does* Installation:: How to install a downloaded version of Org-mode* Activation:: How to activate Org-mode for certain buffers.* Feedback:: Bug reports, ideas, patches etc.@end menu@node Summary, Installation, Introduction, Introduction@section Summary@cindex summaryOrg-mode is a mode for keeping notes, maintaining ToDo lists, and doingproject planning with a fast and effective plain-text system.Org-mode develops organizational tasks around NOTES files that containlists or information about projects as plain text. Org-mode isimplemented on top of outline-mode, which makes it possible to keep thecontent of large files well structured. Visibility cycling andstructure editing help to work with the tree. Tables are easily createdwith a built-in table editor. Org-mode supports ToDo items, deadlines,time stamps, and scheduling. It dynamically compiles entries into anagenda that utilizes and smoothly integrates much of the Emacs calendarand 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 astructured ASCII file, as HTML, or (todo and agenda items only) as aniCalendar file. It can also serve as a publishing tool for a set oflinked webpages.An important design aspect that distinguishes Org-mode from for examplePlanner/Muse is that it encourages to store every piece of informationonly once. In Planner, you have project pages, day pages and possiblyother 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 aschedule for the day, the agenda for a meeting, tasks lists selected bytags etc are created dynamically when you need them.Org-mode keeps simple things simple. When first fired up, it shouldfeel like a straightforward, easy to use outliner. Complexity is notimposed, but a large amount of functionality is available when you needit. Org-mode can be used on different levels and in different ways, forexample as:@example@r{@bullet{} outline extension with visibility cycling and structure editing}@r{@bullet{} ASCII system and table editor for taking structured notes}@r{@bullet{} ASCII table editor with spreadsheet-like capabilities}@r{@bullet{} TODO list editor}@r{@bullet{} full agenda and planner with deadlines and work scheduling}@r{@bullet{} environment to implement David Allen's GTD system}@r{@bullet{} simple hypertext system, with HTML export}@r{@bullet{} publishing tool to create a set of interlinked webpages}@end exampleOrg-mode's automatic, context sensitive table editor with spreadsheetcapabilities can be integrated into any major mode by activating theminor Orgtbl-mode. Using a translation step, it can be used to maintaintables in arbitray file types, for example in LaTeX.@cindex FAQThere is a website for Org-mode which provides links to the newestversion of Org-mode, as well as additional information, frequently askedquestions (FAQ), links to tutorials etc. This page is located at@uref{http://www.astro.uva.nl/~dominik/Tools/org/}.@page@node Installation, Activation, Summary, Introduction@section Installation@cindex installation@cindex XEmacs@b{Important:} @i{If Org-mode is part of the Emacs distribution or anXEmacs package, please skip this section and go directly to@ref{Activation}.}If you have downloaded Org-mode from the Web, you must take thefollowing steps to install it: Go into the Org-mode distributiondirectory and edit the top section of the file @file{Makefile}. Youmust set the name of the Emacs binary (likely either @file{emacs} or@file{xemacs}), and the paths to the directories where local Lisp andInfo files are kept. If you don't have access to the system-widedirectories, create your own two directories for these files, enter theminto the Makefile, and make sure Emacs finds the Lisp files by addingthe following line to @file{.emacs}:@example(setq load-path (cons "~/path/to/lispdir" load-path))@end example@b{XEmacs users now need to install the file @file{noutline.el} fromthe @file{xemacs} subdirectory of the Org-mode distribution. Use thecommand:}@example@b{make install-noutline}@end example@noindent Now byte-compile and install the Lisp files with the shellcommands:@examplemakemake install@end example@noindent If you want to install the info documentation, use this command:@examplemake install-info@end example@noindent Then add to @file{.emacs}:@lisp;; This line only if org-mode is not part of the X/Emacs distribution.(require 'org-install)@end lisp@node Activation, Feedback, Installation, Introduction@section Activation@cindex activation@cindex autoload@cindex global keybindings@cindex keybindings, global@iftex@b{Important:} @i{If you use copy-and-paste to copy lisp code from thePDF documentation to your .emacs file, the single quote character comesout incorrectly and the code will not work. You need to fix the singlequotes by hand, or copy from Info documentation.}@end iftexAdd the following lines to your @file{.emacs} file. The last two linesdefine @emph{global} keys for the commands @command{org-store-link} and@command{org-agenda} - please choose suitable keys yourself.@lisp;; The following lines are always needed. Choose your own keys.(add-to-list 'auto-mode-alist '("\\.org$" . org-mode))(define-key global-map "\C-cl" 'org-store-link)(define-key global-map "\C-ca" 'org-agenda)@end lispFurthermore, you must activate @code{font-lock-mode} in org-modebuffers, because significant functionality depends on font-locking beingactive. You can do this with either one of the following two lines(XEmacs user must use the second option):@lisp(global-font-lock-mode 1) ; for all buffers(add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only@end lisp@cindex org-mode, turning onWith this setup, all files with extension @samp{.org} will be putinto Org-mode. As an alternative, make the first line of a file looklike this:@exampleMY PROJECTS -*- mode: org; -*-@end example@noindent which will select Org-mode for this buffer no matter whatthe file's name is. See also the variable@code{org-insert-mode-line-in-empty-file}.@node Feedback, , Activation, Introduction@section Feedback@cindex feedback@cindex bug reports@cindex maintainer@cindex authorIf you find problems with Org-mode, or if you have questions, remarks,or ideas about it, please contact the maintainer @value{MAINTAINER} at@value{MAINTAINEREMAIL}.For bug reports, please provide as much information as possible,including the version information of Emacs (@kbd{C-h v emacs-version@key{RET}}) and Org-mode (@kbd{C-h v org-version @key{RET}}), as well asthe Org-mode related setup in @file{.emacs}. If an error occurs, abacktrace can be very useful (see below on how to create one). Often asmall example file helps, along with clear information about:@enumerate@item What exactly did you do?@item What did you expect to happen?@item What happened instead?@end enumerate@noindent Thank you for helping to improve this mode.@subsubheading How to create a useful backtrace@cindex backtrace of an errorIf working with Org-mode produces an error with a message you don'tunderstand, you may have hit a bug. The best way to report this is byproviding, in addition to what was mentioned above, a @emph{Backtrace}.This is information from the built-in debugger about where and how theerror occurred. Here is how to produce a useful backtrace:@enumerate@itemStart a fresh Emacs or XEmacs, and make sure that it will load theoriginal Lisp code in @file{org.el} instead of the compiled version in@file{org.elc}. The backtrace contains much more information if it isproduced with uncompiled code. To do this, either rename @file{org.elc}to something else before starting Emacs, or ask Emacs explicitly to load@file{org.el} by using the command line@exampleemacs -l /path/to/org.el@end example@itemGo to the @code{Options} menu and select @code{Enter Debugger on Error}(XEmacs has this option in the @code{Troubleshooting} sub-menu).@itemDo whatever you have to do to hit the error. Don't forget todocument the steps you take.@itemWhen you hit the error, a @file{*Backtrace*} buffer will appear on thescreen. Save this buffer to a file (for example using @kbd{C-x C-w}) andattach it to your bug report.@end enumerate@node Document structure, Tables, Introduction, Top@chapter Document Structure@cindex document structure@cindex structure of documentOrg-mode is based on outline mode and provides flexible commands toedit the structure of the document.@menu* 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@end menu@node Outlines, Headlines, Document structure, Document structure@section Outlines@cindex outlines@cindex outline-modeOrg-mode is implemented on top of outline-mode. Outlines allow toorganize a document in a hierarchical structure, which (at least forme) is the best representation of notes and thoughts. Overview overthis structure is achieved by folding (hiding) large parts of thedocument to show only the general document structure and the partscurrently being worked on. Org-mode greatly simplifies the use ofoutlines by compressing the entire show/hide functionality into asingle command @command{org-cycle}, which is bound to the @key{TAB}key.@node Headlines, Visibility cycling, Outlines, Document structure@section Headlines@cindex headlines@cindex outline treeHeadlines define the structure of an outline tree. The headlines inOrg-mode start with one or more stars, on the left margin. Forexample:@example* Top level headline** Second level*** 3rd level some text*** 3rd level more text* Another top level headline@end example@noindent Some people find the many stars too noisy and would prefer anoutline that has whitespace followed by a single star as headlinestarters. @ref{Clean view} describes a setup to realize this.@node Visibility cycling, Motion, Headlines, Document structure@section Visibility cycling@cindex cycling, visibility@cindex visibility cycling@cindex trees, visibility@cindex show hidden text@cindex hide textOutlines make it possible to hide parts of the text in the buffer.Org-mode uses just two commands, bound to @key{TAB} and@kbd{S-@key{TAB}} to change the visibility in the buffer.@cindex subtree visibility states@cindex subtree cycling@cindex folded, subtree visibility state@cindex children, subtree visibility state@cindex subtree, subtree visibility state@table @kbd@kindex @key{TAB}@item @key{TAB}@emph{Subtree cycling}: Rotate current subtree between the states@example,-> FOLDED -> CHILDREN -> SUBTREE --.'-----------------------------------'@end exampleThe cursor must be on a headline for this to work@footnote{see, however,the option @code{org-cycle-emulate-tab}.}. When the cursor is at thebeginning of the buffer and the first line is not a headline, then@key{TAB} actually runs global cycling (see below)@footnote{see theoption @code{org-cycle-global-at-bob}.}. Also when called with a prefixargument (@kbd{C-u @key{TAB}}), global cycling is invoked.@cindex global visibility states@cindex global cycling@cindex overview, global visibility state@cindex contents, global visibility state@cindex show all, global visibility state@kindex S-@key{TAB}@item S-@key{TAB}@itemx C-u @key{TAB}@emph{Global cycling}: Rotate the entire buffer between the states@example,-> OVERVIEW -> CONTENTS -> SHOW ALL --.'--------------------------------------'@end exampleWhen @kbd{S-@key{TAB}} is called with a numerical prefix N, the CONTENTSview up to headlines of level N will be shown.Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field.@cindex show all, command@kindex C-c C-a@item C-c C-aShow all.@kindex C-c C-r@item C-c C-rReveal context around point, showing the current entry, the followingheading and the hierarchy above. Useful for working near a locationexposed by a sparse tree command (@pxref{Sparse trees}) or an agendacommand (@pxref{Agenda commands}). With prefix arg show, on eachlevel, all sibling headings.@kindex C-c C-x b@item C-c C-x bShow the current subtree in an indirect buffer@footnote{The indirectbuffer (@pxref{Indirect Buffers,Indirect Buffers,IndirectBuffers,emacs,GNU Emacs Manual}) will contain the entire buffer, butwill be narrowed to the current tree. Editing the indirect buffer willalso change the original buffer, but without affecting visibility inthat buffer.}. With numerical prefix ARG, go up to this level and thentake that tree. If ARG is negative, go up that many levels. With@kbd{C-u} prefix, do not remove the previously used indirect buffer.@end tableWhen Emacs first visits an Org-mode file, the global state is set toOVERVIEW, i.e. only the top level headlines are visible. This can beconfigured through the variable @code{org-startup-folded}, or on aper-file basis by adding one of the following lines anywhere in thebuffer:@example#+STARTUP: overview#+STARTUP: content#+STARTUP: showall@end example@node Motion, Structure editing, Visibility cycling, Document structure@section Motion@cindex motion, between headlines@cindex jumping, to headlines@cindex headline navigationThe following commands jump to other headlines in the buffer.@table @kbd@kindex C-c C-n@item C-c C-nNext heading.@kindex C-c C-p@item C-c C-pPrevious heading.@kindex C-c C-f@item C-c C-fNext heading same level.@kindex C-c C-b@item C-c C-bPrevious heading same level.@kindex C-c C-u@item C-c C-uBackward to higher level heading.@kindex C-c C-j@item C-c C-jJump to a different place without changing the current outlinevisibility. Shows the document structure in a temporary buffer, whereyou can use visibility cycling (@key{TAB}) to find your destination.After pressing @key{RET}, the cursor moves to the selected location inthe original buffer, and the headings hierarchy above it is madevisible.@end table@node Structure editing, Archiving, Motion, Document structure@section Structure editing@cindex structure editing@cindex headline, promotion and demotion@cindex promotion, of subtrees@cindex demotion, of subtrees@cindex subtree, cut and paste@cindex pasting, of subtrees@cindex cutting, of subtrees@cindex copying, of subtrees@cindex subtrees, cut and paste@table @kbd@kindex M-@key{RET}@item M-@key{RET}Insert new heading with same level as current. If the cursor is in aplain list item, a new item is created (@pxref{Plain lists}). To forcecreation 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 inthe middle of a line, the line is split and the rest of the line becomesthe new headline. If the command is used at the beginning of aheadline, the new headline is created before the current line. If atthe beginning of any other line, the content of that line is made thenew 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 headlinelike the current one will be inserted after the end of the subtree.@kindex M-S-@key{RET}@item M-S-@key{RET}Insert new TODO entry with same level as current heading.@kindex M-@key{left}@item M-@key{left}Promote current heading by one level.@kindex M-@key{right}@item M-@key{right}Demote current heading by one level.@kindex M-S-@key{left}@item M-S-@key{left}Promote the current subtree by one level.@kindex M-S-@key{right}@item M-S-@key{right}Demote the current subtree by one level.@kindex M-S-@key{up}@item M-S-@key{up}Move subtree up (swap with previous subtree of samelevel).@kindex M-S-@key{down}@item M-S-@key{down}Move subtree down (swap with next subtree of same level).@kindex C-c C-x C-w@kindex C-c C-x C-k@item C-c C-x C-w@itemx C-c C-x C-kKill subtree, i.e. remove it from buffer but save in kill ring.@kindex C-c C-x M-w@item C-c C-x M-wCopy subtree to kill ring.@kindex C-c C-x C-y@item C-c C-x C-yYank subtree from kill ring. This does modify the level of the subtree tomake sure the tree fits in nicely at the yank position. The yanklevel can also be specified with a prefix arg, or by yanking after aheadline marker like @samp{****}.@kindex C-c ^@item C-c ^Sort same-level entries. When there is an active region, all entries inthe region will be sorted. Otherwise the children of the currentheadline are sorted. The command prompts for the sorting method, whichcan be alphabetically, numerically, by time (using the first time stampin each entry), and each of these in reverse order. With a @kbd{C-u}prefix, sorting will be case-sensitive. With two @kbd{C-u C-u}prefixes, duplicate entries will also be removed.@end table@cindex region, active@cindex active region@cindex transient-mark-modeWhen there is an active region (transient-mark-mode), promotion anddemotion work on all headlines in the region. To select a region ofheadlines, it is best to place both point and mark at the beginning of aline, mark at the beginning of the first headline, and point at the linejust after the last headline to change. Note that when the cursor isinside a table (@pxref{Tables}), the Meta-Cursor keys have differentfunctionality.@node Archiving, Sparse trees, Structure editing, Document structure@section Archiving@cindex archivingWhen a project represented by a (sub)tree is finished, you may wantto move the tree out of the way and to stop it from contributing to theagenda. Org-mode knows two ways of archiving. You can mark a tree withthe ARCHIVE tag, or you can move an entire (sub)tree to a differentlocation.@menu* ARCHIVE tag:: Marking a tree as inactive* Moving subtrees:: Moving a tree to an archive file@end menu@node ARCHIVE tag, Moving subtrees, Archiving, Archiving@subsection The ARCHIVE tag@cindex internal archivingA headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays atits location in the outline tree, but behaves in the following way:@itemize @minus@itemIt does not open when you attempt to do so with a visibility cyclingcommand (@pxref{Visibility cycling}). You can force cycling archivedsubtrees with @kbd{C-@key{TAB}}, or by setting the option@code{org-cycle-open-archived-trees}. Also normal outline commands like@code{show-all} will open archived subtrees.@itemDuring sparse tree construction (@pxref{Sparse trees}), matches inarchived subtrees are not exposed, unless you configure the option@code{org-sparse-tree-open-archived-trees}.@itemDuring agenda view construction (@pxref{Agenda views}), the content ofarchived trees is ignored unless you configure the option@code{org-agenda-skip-archived-trees}.@itemArchived trees are not exported (@pxref{Exporting}), only the headlineis. Configure the details using the variable@code{org-export-with-archived-trees}.@end itemizeThe following commands help managing the ARCHIVE tag:@table @kbd@kindex C-c C-x C-a@item C-c C-x C-aToggle the ARCHIVE tag for the current headline. When the tag is set,the headline changes to a shadowish face, and the subtree below it ishidden.@kindex C-u C-c C-x C-a@item C-u C-c C-x C-aCheck if any direct children of the current headline should be archived.To do this, each subtree is checked for open TODO entries. If none arefound, the command offers to set the ARCHIVE tag for the child. If thecursor is @emph{not} on a headline when this command is invoked, thelevel 1 trees will be checked.@kindex C-@kbd{TAB}@item C-@kbd{TAB}Cycle a tree even if it is tagged with ARCHIVE.@end table@node Moving subtrees, , ARCHIVE tag, Archiving@subsection Moving subtrees@cindex external archivingOnce an entire project is finished, you may want to move it to adifferent location, either in the current file, or even in a differentfile, the archive file.@table @kbd@kindex C-c C-x C-s@item C-c C-x C-sArchive the subtree starting at the cursor position to the locationgiven by @code{org-archive-location}.@kindex C-u C-c C-x C-s@item C-u C-c C-x C-sCheck if any direct children of the current headline could be moved tothe archive. To do this, each subtree is checked for open TODO entries.If none are found, the command offers to move it to the archivelocation. If the cursor is @emph{not} on a headline when this commandis invoked, the level 1 trees will be checked.@end table@cindex archive locationsThe default archive location is a file in the same directory as thecurrent file, with the name derived by appending @file{_archive} to thecurrent file name. For information and examples on how to change this,see the documentation string of the variable@code{org-archive-location}. There is also an in-buffer option forsetting this variable, for example@example#+ARCHIVE: %s_done::@end example@noindentYou may have several such lines in the buffer, they will then be validfor the entries following the line (the first will also apply to anytext before it).@node Sparse trees, Plain lists, Archiving, Document structure@section Sparse trees@cindex sparse trees@cindex trees, sparse@cindex folding, sparse trees@cindex occur, commandAn important feature of Org-mode is the ability to construct@emph{sparse trees} for selected information in an outline tree. Asparse tree means that the entire document is folded as much aspossible, but the selected information is made visible along with theheadline structure above it@footnote{See also the variables@code{org-show-hierarchy-above}, @code{org-show-following-heading}, and@code{org-show-siblings} for detailed control on how much context isshown around each match.}. Just try it out and you will see immediatelyhow it works.Org-mode contains several commands creating such trees. The mostbasic one is @command{org-occur}:@table @kbd@kindex C-c /@item 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 thematch is in the body of an entry, headline and body are made visible.In order to provide minimal context, also the full hierarchy ofheadlines above the match is shown, as well as the headline followingthe match. Each match is also highlighted; the highlights disappearwhen the buffer is changes an editing command, or by pressing @kbd{C-cC-c}. When called with a @kbd{C-u} prefix argument, previous highlightsare kept, so several calls to this command can be stacked.@end table@noindentFor frequently used sparse trees of specific search strings, you canuse the variable @code{org-agenda-custom-commands} to define fastkeyboard access to specific sparse trees. These commands will then beaccessible through the agenda dispatcher (@pxref{Agenda dispatcher}).For example:@lisp(setq org-agenda-custom-commands '(("f" occur-tree "FIXME")))@end lisp@noindent will define the key @kbd{C-c a f} as a shortcut for creatinga sparse tree matching the string @samp{FIXME}.Other commands use sparse trees as well. For example @kbd{C-cC-v} creates a sparse TODO tree (@pxref{TODO basics}).@kindex C-c C-e v@cindex printing sparse trees@cindex visible text, printingTo print a sparse tree, you can use the Emacs command@code{ps-print-buffer-with-faces} which does not print invisible partsof the document @footnote{This does not work under XEmacs, becauseXEmacs uses selective display for outlining, not text properties.}.Or you can use the command @kbd{C-c C-e v} to export only the visiblepart of the document and print the resulting file.@node Plain lists, , Sparse trees, Document structure@section Plain lists@cindex plain lists@cindex lists, plain@cindex lists, ordered@cindex ordered listsWithin an entry of the outline tree, hand-formatted lists can provideadditional structure. They also provide a way to create lists ofcheckboxes (@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 startwith @samp{-}, @samp{+}, or @samp{*}@footnote{When using @samp{*} as abullet, lines must be indented or they will be seen as top-levelheadlines. Also, when you are hiding leading stars to get a cleanoutline view, plain list items starting with a star are visuallyindistinguishable from true headlines. In short: even though @samp{*}is supported, it may be better not to use it for plain list items} asbullets. Ordered list items start with @samp{1.} or @samp{1)}. Itemsbelonging to the same list must have the same indentation on the firstline. In particular, if an ordered list reaches number @samp{10.}, thenthe 2--digit numbers must be written left-aligned with the other numbersin the list. Indentation also determines the end of a list item. Itends before the next line that is indented like the bullet/number, orless. For example:@example@group** 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.@end group@end exampleOrg-mode supports these lists by tuning filling and wrapping commands todeal with them correctly@footnote{Org-mode only changes the fillingsettings for Emacs. For XEmacs, you should use Kyle E. Jones'@file{filladapt.el}. To turn this on, put into @file{.emacs}:@example(require 'filladapt)@end example}.The following commands act on items when the cursor is in the first lineof an item (the line with the bullet or number).@table @kbd@kindex @key{TAB}@item @key{TAB}Items can be folded just like headline levels if you set the variable@code{org-cycle-include-plain-lists}. The level of an item is thengiven by the indentation of the bullet/number. Items are alwayssubordinate to real headlines, however; the hierarchies remaincompletely separated.@kindex M-@key{RET}@item M-@key{RET}Insert new item at current level. With prefix arg, force a new heading(@pxref{Structure editing}). If this command is used in the middle of aline, the line is @emph{split} and the rest of the line becomes the newitem. If this command is executed in the @emph{whitespace before a bullet ornumber}, the new item is created @emph{before} the current item. If thecommand is executed in the white space before the text that is part ofan item but does not contain the bullet, a bullet is added to thecurrent line.@kindex M-S-@key{RET}@item M-S-@key{RET}Insert a new item with a checkbox (@pxref{Checkboxes}).@kindex S-@key{up}@kindex S-@key{down}@item S-@key{up}@itemx S-@key{down}Jump to the previous/next item in the current list.@kindex M-S-@key{up}@kindex M-S-@key{down}@item M-S-@key{up}@itemx M-S-@key{down}Move the item including subitems up/down (swap with previous/next itemof same indentation). If the list is ordered, renumbering isautomatic.@kindex M-S-@key{left}@kindex M-S-@key{right}@item M-S-@key{left}@itemx M-S-@key{right}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 indentationwould imply a different hierarchy. To use the new hierarchy, breakthe command chain with a cursor motion or so.@kindex C-c C-c@item C-c C-cIf there is a checkbox (@pxref{Checkboxes}) in the item line, toggle thestate of the checkbox. Otherwise, if this is an ordered list, renumberthe ordered list at the cursor.@end table@node Tables, Hyperlinks, Document structure, Top@chapter Tables@cindex tables@cindex editing tablesOrg-mode has a very fast and intuitive table editor built-in.Spreadsheet-like calculations are supported in connection with theEmacs @file{calc} package.@menu* Built-in table editor:: Simple tables* Narrow columns:: Stop wasting space in tables * orgtbl-mode:: The table editor as minor mode* The spreadsheet:: The table editor has spreadsheet capabilities.@end menu@node Built-in table editor, Narrow columns, Tables, Tables@section The built-in table editor@cindex table editor, built-inOrg-mode makes it easy to format tables in plain ASCII. Any line with@samp{|} as the first non-white character is considered part of atable. @samp{|} is also the column separator. A table might looklike this:@example| Name | Phone | Age ||-------+-------+-----|| Peter | 1234 | 17 || Anna | 4321 | 25 |@end exampleA table is re-aligned automatically each time you press @key{TAB} or@key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves tothe next field (@key{RET} to the next row) and creates new table rowsat the end of the table or before horizontal lines. The indentationof the table is set by the first line. Any line starting with@samp{|-} is considered as a horizontal separator line and will beexpanded on the next re-align to span the whole table width. So, tocreate the above table, you would only type@example|Name|Phone|Age||-@end example@noindent and then press @key{TAB} to align the table and start filling infields.When typing text into a field, Org-mode treats @key{DEL},@key{Backspace}, and all character keys in a special way, so thatinserting and deleting avoids shifting other fields. Also, whentyping @emph{immediately after the cursor was moved into a new fieldwith @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, thefield is automatically made blank. If this behavior is toounpredictable for you, configure the variables@code{org-enable-table-editor} and @code{org-table-auto-blank-field}.@table @kbd@tsubheading{Creation and conversion}@kindex C-c |@item C-c |Convert the active region to table. If every line contains at least oneTAB character, the function assumes that the material is tab separated.If not, lines are split at whitespace into fields. You can use a prefixargument to indicate the minimum number of consecutive spaces requiredto identify a field separator (default: just one).@* If there is no active region, this command creates an empty Org-modetable. But it's easier just to start typing, like@kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.@tsubheading{Re-aligning and field motion}@kindex C-c C-c@item C-c C-cRe-align the table without moving the cursor.@kindex @key{TAB}@item @key{TAB}Re-align the table, move to the next field. Creates a new row ifnecessary.@kindex S-@key{TAB}@item S-@key{TAB}Re-align, move to previous field.@kindex @key{RET}@item @key{RET}Re-align the table and move down to next row. Creates a new row ifnecessary. At the beginning or end of a line, @key{RET} still doesNEWLINE, so it can be used to split a table.@tsubheading{Column and row editing}@kindex M-@key{left}@kindex M-@key{right}@item M-@key{left}@itemx M-@key{right}Move the current column left/right.@kindex M-S-@key{left}@item M-S-@key{left}Kill the current column.@kindex M-S-@key{right}@item M-S-@key{right}Insert a new column to the left of the cursor position.@kindex M-@key{up}@kindex M-@key{down}@item M-@key{up}@itemx M-@key{down}Move the current row up/down.@kindex M-S-@key{up}@item M-S-@key{up}Kill the current row or horizontal line.@kindex M-S-@key{down}@item M-S-@key{down}Insert a new row above (with arg: below) the current row.@kindex C-c -@item C-c -Insert a horizontal line below current row. With prefix arg, the lineis created above the current line.@kindex C-c ^@item C-c ^Sort the table lines in the region. The position of point indicates thecolumn to be used for sorting, and the range of lines is the rangebetween the nearest horizontal separator lines, or the entire table. Ifpoint is before the first column, you will be prompted for the sortingcolumn. If there is an active region, the mark specifies the first lineand the sorting column, while point should be in the last line to beincluded into the sorting. The command prompts for the sorting type(alphabetically, numerically, or by time). When called with a prefixargument, alphabetic sorting will be case-sensitive.@tsubheading{Regions}@kindex C-c C-x M-w@item C-c C-x M-wCopy a rectangular region from a table to a special clipboard. Pointand mark determine edge fields of the rectangle. The process ignoreshorizontal separator lines.@kindex C-c C-x C-w@item C-c C-x C-wCopy a rectangular region from a table to a special clipboard, andblank all fields in the rectangle. So this is the ``cut'' operation.@kindex C-c C-x C-y@item C-c C-x C-yPaste a rectangular region into a table.The upper right corner ends up in the current field. All involved fieldswill be overwritten. If the rectangle does not fit into the present table,the table is enlarged as needed. The process ignores horizontal separatorlines.@kindex C-c C-q@item C-c C-qWrap several fields in a column like a paragraph. If there is an activeregion, and both point and mark are in the same column, the text in thecolumn is wrapped to minimum width for the given number of lines. Aprefix ARG may be used to change the number of desired lines. If thereis no region, the current field is split at the cursor position and thetext fragment to the right of the cursor is prepended to the field oneline down. If there is no region, but you specify a prefix ARG, thecurrent field is made blank, and the content is appended to the fieldabove.@tsubheading{Calculations}@cindex formula, in tables@cindex calculations, in tables@cindex region, active@cindex active region@cindex transient-mark-mode@kindex C-c +@item C-c +Sum the numbers in the current column, or in the rectangle defined bythe active region. The result is shown in the echo area and canbe inserted with @kbd{C-y}.@kindex S-@key{RET}@item S-@key{RET}When current field is empty, copy from first non-empty field above.When not empty, copy current field down to next row and move cursoralong with it. Depending on the variable@code{org-table-copy-increment}, integer field values will beincremented during copy. This key is also used by CUA-mode(@pxref{Cooperation}).@tsubheading{Miscellaneous}@kindex C-c `@item C-c `Edit the current field in a separate window. This is useful for fieldsthat are not fully visible (@pxref{Narrow columns}). When called with a@kbd{C-u} prefix, just make the full field visible, so that it can beedited in place.@kindex C-c @key{TAB}@item C-c @key{TAB}This is an alias for @kbd{C-u C-c `} to make the current field fullyvisible.@item M-x org-table-importImport a file as a table. The table should be TAB- or whitespaceseparated. Useful, for example, to import an Excel table or data from adatabase, because these programs generally can write TAB-separated textfiles. This command works by inserting the file into the buffer andthen converting the region to a table. Any prefix argument is passed onto the converter, which uses it to determine the separator.@item M-x org-table-exportExport the table as a TAB-separated file. Useful for data exchange with,for example, Excel or database programs.@end tableIf you don't like the automatic table editor because it gets in yourway on lines which you would like to start with @samp{|}, you can turnit off with@lisp(setq org-enable-table-editor nil)@end lisp@noindent Then the only table command that still works is@kbd{C-c C-c} to do a manual re-align.@node Narrow columns, orgtbl-mode, Built-in table editor, Tables@section Narrow columns@cindex narrow columns in tablesThe 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 limit@footnote{This featuredoes not work on XEmacs.} the width of a column, one field anywhere inthe column may contain just the string @samp{<N>} where @samp{N} is aninteger specifying the width of the column in characters. The nextre-align will then set the width of this column to no more than thisvalue.@example@group|---+------------------------------| |---+--------|| | | | | <6> || 1 | one | | 1 | one || 2 | two | ----\ | 2 | two || 3 | This is a long chunk of text | ----/ | 3 | This=> || 4 | four | | 4 | four ||---+------------------------------| |---+--------|@end group@end example@noindentFields that are wider become clipped and end in the string @samp{=>}.Note that the full text is still in the buffer, it is only invisible.To see the full text, hold the mouse over the field - a tooltip windowwill show the full content. To edit such a field, use the command@kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This willopen a new window with the full field. Edit it and finish with @kbd{C-cC-c}.When visiting a file containing a table with narrowed columns, thenecessary character hiding has not yet happened, and the table needs tobe aligned before it looks nice. Setting the option@code{org-startup-align-all-tables} will realign all tables in a fileupon visiting, but also slow down startup. You can also set this optionon a per-file basis with:@example#+STARTUP: align#+STARTUP: noalign@end example@node orgtbl-mode, The spreadsheet, Narrow columns, Tables@section The Orgtbl minor mode@cindex orgtbl-mode@cindex minor mode for tablesIf you like the intuitive way the Org-mode table editor works, youmight 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 togglethe mode with @kbd{M-x orgtbl-mode}. To turn it on by default, forexample in mail mode, use@lisp(add-hook 'mail-mode-hook 'turn-on-orgtbl)@end lispFurthermore, with some special setup, it is possible to maintain tablesin arbitrary syntax with Orgtbl-mode. For example, it is possible toconstruct LaTeX tables with the underlying ease and power ofOrgtbl-mode, including spreadsheet capabulities. For details, see@ref{Tables in arbitrary syntax}.@node The spreadsheet, , orgtbl-mode, Tables@section The spreadsheet@cindex calculations, in tables@cindex spreadsheet capabilities@cindex @file{calc} packageThe table editor makes use of the Emacs @file{calc} package to implementspreadsheet-like capabilities. It can also evaluate Emacs Lisp forms toderive fields from other fields.@menu* 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@end menu@node References, Formula syntax for Calc, The spreadsheet, The spreadsheet@subsection References@cindex referencesTo compute fields in the table from other fields, formulas mustreference other fields or ranges. In Org-mode, fields can be referencedby name, by absolute coordinates, and by relative coordinates. To findout what the coordinates of a field are, press @kbd{C-c ?} in thatfield.@subsubheading Field references@cindex field references@cindex references, to fieldsFormulas can reference the value of another field with the operator@example@@row$column@end exampleColumn references can be absolute like @samp{1}, @samp{2},...@samp{N},or relative to the current column like @samp{+1} or @samp{-2}.The row specification only counts data lines and ignores horizontalseparator lines (hlines). You can use absolute row numbers@samp{1}...@samp{N}, and row numbers relative to the current row like@samp{+3} or @samp{-1}. Or specify the row relative to one of thehlines: @samp{I} refers to the first hline, @samp{II} to the second etc.@samp{-I} refers to the first such line above the current line,@samp{+I} to the first such line below the current line. You can alsowrite @samp{III+2} which is the second data line after the third hlinein the table. Relative row numbers like @samp{-3} will not cross hlinesif the current line is too close to the hline. Instead, the valuedirectly at the hline is used.@samp{0} refers to the current row and column. Also, if you omiteither the column or the row part of the reference, the currentrow/column is implied. Org-mode's references with @emph{positive} numbers correspond to fixedreferences in other spreadsheet programs. For example, @code{@@3$28}corresponds to @code{$AB$3}. Org-mode's references with @emph{negative}numbers behave similar to non-fixed references in other spreadsheetprograms, because when the same formula is used in several fields,different fields are referenced each time.Here are a few examples:@example@@2$3 @r{2nd row, 3rd column}$5 @r{column 5 in the current row}@@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}@end example@subsubheading Range references@cindex range references@cindex references, to rangesYou may reference a rectangular range of fields by specifying two fieldreferences connected by two dots @samp{..}. If both fields are in thecurrent row, you may simply use @samp{$2..$7}, but if at least one fieldis 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@samp{@@} in order to be interpreted correctly). Examples:@example$1..$3 @r{First three fields in the current row.}$P..$Q @r{Range, using column names (see under Advanced)}@@2$1..@@4$3 @r{6 fields between these two fields.}@@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}@end example@noindent Range references return a vector of values that can be fedinto Calc vector functions. Empty fields in ranges are normallysuppressed, so that the vector contains only the non-empty fields (butsee the @samp{E} mode switch below). If there are no non-empty fields,@samp{[0]} is returned to avoid syntax errors in formulas.@subsubheading Named references@cindex named references@cindex references, named@cindex name, of column or field@cindex constants, in calculations@samp{$name} is interpreted as the name of a column, parameter orconstant. Constants are defined globally through the variable@code{org-table-formula-constants}. If you have the@file{constants.el} package, it will also be used to resolveconstants, including natural constants like @samp{$h} for Planck'sconstant, and units like @samp{$km} for kilometers. Column names andparameters can be specified in special table lines. These aredescribed below, see @ref{Advanced features}.@node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet@subsection Formula syntax for Calc@cindex formula syntax, Calc@cindex syntax, of formulasA formula can be any algebraic expression understood by the Emacs@file{Calc} package. @b{Note that @file{calc} has thenon-standard convention that @samp{/} has lower precedence than@samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Beforeevaluation by @code{calc-eval} (@pxref{Calling Calc fromYour Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNUEmacs Calc Manual}),variable substitution takes place according to the rules described above.@cindex vectors, in table calculationsThe range vectors can be directly fed into the calc vector functionslike @samp{vmean} and @samp{vsum}.@cindex format specifier@cindex mode, for @file{calc}A formula can contain an optional mode string after a semicolon. Thisstring consists of flags to influence Calc and other modes duringexecution. By default, Org-mode uses the standard calc modes (precision12, angular units degrees, fraction and symbolic modes off. The displayformat, however, has been changed to @code{(float 5)} to keep tablescompact. The default settings can be configured using the variable@code{org-calc-default-modes}.@examplep20 @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}@end example@noindentIn addition, you may provide a @code{printf} format specifier toreformat the final result. A few examples:@example$1+$2 @r{Sum of first and second field}$1+$2;%.2f @r{Same, format result to two decimals}exp($2)+exp($1) @r{Math functions can be used}$;%.1f @r{Reformat current cell to 1 decimal}($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}@end example@node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet@subsection Emacs Lisp forms as formulas@cindex Lisp forms, as table formulasIt is also possible to write a formula in Emacs Lisp; this can be usefulfor string manipulation and control structures. If a formula startswith a single quote followed by an opening parenthesis, then it isevaluated as a lisp form. The evaluation should return either a stringor a number. Just as with @file{calc} formulas, you can specify modesand a printf format after a semicolon. A reference will be replacedwith a string (in double quotes) containing the field. If you providethe @samp{N} mode switch, all referenced elements will be numbers.Ranges are inserted as space-separated fields, so you can embed them inlist or vector syntax. A few examples, note how the @samp{N} mode isused when we do computations in lisp.@example@r{Swap the first two characters of the content of column 1} '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))@r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}} '(+ $1 $2);N@r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}} '(apply '+ '($1..$4));N@end example@node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet@subsection Field formulas@cindex field formula@cindex formula, for individual table fieldTo assign a formula to a particular field, type it directly into thefield, preceded by @samp{:=}, for example @samp{:=$1+$2}. When youpress @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still inthe 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 ofthe 3rd data line in the table, the formula will look like@samp{@@3$2=$1+$2}. When inserting/deleting/swapping column and rowswith the appropriate commands, @i{absolute references} (but not relativeones) in stored formulas are modified in order tostill reference the same field. Of cause this is not true if you editthe table structure with normal editing commands - then you must go andfix equations yourself.Instead of typing an equation into the field, you may also use thefollowing command@table @kbd@kindex C-u C-c =@item C-u C-c =Install a new formula for the current field. The command prompts for aformula, with default taken from the @samp{#+TBLFM:} line, appliesit to the current field and stores it.@end table@node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet@subsection Column formulas@cindex column formula@cindex formula, for table columnOften in a table, the same formula should be used for all fields in aparticular column. Instead of having to copy the formula to all fieldsin that column, org-mode allows to assign a single formula to an entirecolumn.To assign a formula to a column, type it directly into any field in thecolumn, preceded by an equal sign, like @samp{=$1+$2}. When you press@key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in thefield, the formula will be stored as the formula for the current column,evaluated and the current field replaced with the result. If the fieldcontains only @samp{=}, the previously stored formula for this column isused. For each column, Org-mode will only remember the most recentlyused formula. In the @samp{TBLFM:} line, column formulas will look like@samp{$4=$1+$2}.Instead of typing an equation into the field, you may also use thefollowing command:@table @kbd@kindex C-c =@item C-c =Install a new formula for the current column and replace current fieldwith the result of the formula. The command prompts for a formula, withdefault taken from the @samp{#+TBLFM} line, applies it to the currentfield 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.@end table@node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet@subsection Editing and Debugging formulas@cindex formula editing@cindex editing, of table formulasYou can edit individual formulas in the minibuffer or directly in thefield. Org-mode can also prepare a special buffer with all activeformulas of a table.@table @kbd@kindex C-c =@kindex C-u C-c =@item C-c =@itemx C-u C-c =Edit the formula associated with the current column/field in theminibuffer. See @ref{Column formulas} and @ref{Field formulas}.@kindex C-u C-u C-c =@item C-u C-u C-c =Re-insert the active formula (either afield formula, or a column formula) into the current field, so that youcan edit it directly in the field. The advantage over editing in theminibuffer is that you can use the command @kbd{C-c ?}.@kindex C-c ?@item C-c ?While editing a formula in a table field, highlight the field(s)referenced by the reference at the cursor position in the formula.@kindex C-c '@item C-c 'Edit all formulas for the current table in a special buffer, where theformulas will be displayed one per line. While inside the special buffer, Org-mode will automatically highlightany field or range reference at the cursor position. You may edit,remove and add formulas, and use the following commands:@table @kbd@kindex C-c C-c@item C-c C-cExit the buffer and store the modified formulas. With @kbd{C-u} prefix,also apply the new formulas to the entire table.@kindex C-c C-q@item C-c C-qExit the buffer without installing changes.@kindex @key{TAB}@item @key{TAB}Pretty-print or indent lisp formula at point. When in a line containinga lisp formula, format the formula according to Emacs Lisp rules.Another @key{TAB} collapses the formula back again. In the openformula, @key{TAB} re-indents just like in Emacs-lisp-mode.@kindex M-@key{TAB}@item M-@key{TAB}Complete Lisp symbols, just like in Emacs-lisp-mode.@kindex S-@key{up}@kindex S-@key{down}@item S-@key{up}/@key{down}Move the reference line in the Org-mode buffer up and down. This isimportant for highlighting the references of column formulas fordifferent rows.@kindex M-@key{up}@kindex M-@key{down}@item M-@key{up}/@key{down}Scroll the window displaying the table.@end table@kindex C-c @}@item C-c @}Toggle the display of row and column numbers for a table, usingoverlays. These are uptated each time the table is aligned, you canforce it with @kbd{C-c C-c}.@kindex C-c @{@item C-c @{Toggle the formula debugger on and off. See below.@end tableMaking a table field blank does not remove the formula associated withthe 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 whenprompted for the formula, or to edit the @samp{#+TBLFM} line.@kindex C-c C-cYou may edit the @samp{#+TBLFM} directly and re-apply the changedequations with @kbd{C-c C-c} in that line, or with the normalrecalculation commands in the table.@subsubheading Debugging formulas@cindex formula debugging@cindex debugging, of table formulasWhen the evaluation of a formula leads to an error, the field contentbecomes the string @samp{#ERROR}. If you would like see what is goingon during variable substitution and calculation in order to find a bug,turn on formula debugging in the @code{Tbl} menu and repeat thecalculation, for example by pressing @kbd{C-c = @key{RET}} in a field.Detailed information will be displayed.@node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet@subsection Updating the Table@cindex recomputing table fields@cindex updating, tableRecalculation of a table is normally not automatic, but needs to betriggered by a command. See @ref{Advanced features} for a way to makerecalculation at least semi-automatically.In order to recalculate a line of a table or the entire table, use thefollowing commands:@table @kbd@kindex C-c *@item C-c *Recalculate the current row by first applying the stored column formulasfrom left to right, and all field formulas in the current row.@kindex C-u C-c *@item C-u C-c *@kindex C-u C-c C-c@itemx C-u C-c C-cRecompute the entire table, line by line. Any lines before the firsthline are left alone, assuming that these are part of the table header.@kindex C-u C-u C-c *@item C-u C-u C-c *Iterate the table by recomputing it until no further changes occur.This may be necessary if some computed fields use the value of otherfields that are computed @i{later} in the calculation sequence.@end table@node Advanced features, , Updating the table, The spreadsheet@subsection Advanced featuresIf you want the recalculation of fields to happen automatically, or ifyou want to be able to assign @i{names} to fields and columns, you needto reserve the first column of the table for special marking characters.@table @kbd@kindex C-#@item C-#Rotate the calculation mark in first column through the states @samp{},@samp{#}, @samp{*}, @samp{!}, @samp{$}. The meaning of these charactersis discussed below. When there is an active region, change all marks inthe region.@end tableHere is an example of a table that collects exam results of students andmakes use of these features:@example@group|---+---------+--------+--------+--------+-------+------|| | 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@end group@end example@noindent @b{Important}: Please note that for these special tables,recalculating the table with @kbd{C-u C-c *} will only affect rows thatare marked @samp{#} or @samp{*}, and fields that have a formula assignedto the field itself. The column formulas are not applied in rows withempty first field.@cindex marking characters, tablesThe marking characters have the following meaning:@table @samp@item !The fields in this line define names for the columns, so that you mayrefer to a column as @samp{$Tot} instead of @samp{$6}.@item ^This row defines names for the fields @emph{above} the row. With sucha definition, any formula in the table may use @samp{$m1} to refer tothe value @samp{10}. Also, if you assign a formula to a names field, itwill be stored as @samp{$name=...}.@item _Similar to @samp{^}, but defines names for the fields in the row@emph{below}.@item $Fields in this row can define @emph{parameters} for formulas. Forexample, if a field in a @samp{$} row contains @samp{max=50}, thenformulas in this table can refer to the value 50 using @samp{$max}.Parameters work exactly like constants, only that they can be defined ona per-table basis.@item #Fields in this row are automatically recalculated when pressing@key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this rowis selected for a global recalculation with @kbd{C-u C-c *}. Unmarkedlines will be left alone by this command.@item *Selects this line for global recalculation with @kbd{C-u C-c *}, butnot for automatic recalculation. Use this when automaticrecalculation slows down editing too much.@itemUnmarked lines are exempt from recalculation with @kbd{C-u C-c *}.All lines that should be recalculated should be marked with @samp{#}or @samp{*}.@item /Do not export this line. Useful for lines that contain the narrowing@samp{<N>} markers.@end tableFinally, just to whet your appetite on what can be done with thefantastic @file{calc} package, here is a table that computes the Taylorseries of degree @code{n} at location @code{x} for a couple of functions(homework: try that with Excel :-)@example@group|---+-------------+---+-----+--------------------------------------|| | 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@end group@end example@node Hyperlinks, TODO items, Tables, Top@chapter Hyperlinks@cindex hyperlinksJust like HTML, Org-mode provides links inside a file, and externallinks to other files, Usenet articles, emails, and much more.@menu* 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* 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@end menu@node Link format, Internal links, Hyperlinks, Hyperlinks@section Link format@cindex link format@cindex format, of linksOrg-mode will recognize plain URL-like links and activate them asclickable links. The general link format, however, looks like this:@example[[link][description]] @r{or alternatively} [[link]] @end exampleOnce a link in the buffer is complete (all brackets present), Org-modewill change the display so that @samp{description} is displayed insteadof @samp{[[link][description]]} and @samp{link} is displayed instead of@samp{[[link]]}. Links will be highlighted in the face @code{org-link},which by default is an underlined face. You can directly edit thevisible part of a link. Note that this can be either the @samp{link}part (if there is no description) or the @samp{description} part. Toedit also the invisible @samp{link} part, use @kbd{C-c C-l} with thecursor on the link.If you place the cursor at the beginning or just behind the end of thedisplayed text and press @key{BACKSPACE}, you will remove the(invisible) bracket at that location. This makes the link incompleteand the internals are again displayed as plain text. Inserting themissing bracket hides the link internals again. To show theinternal structure of all links, use the menu entry@code{Org->Hyperlinks->Literal links}.@node Internal links, External links, Link format, Hyperlinks@section Internal links@cindex internal links@cindex links, internal@cindex targets, for linksIf the link does not look like a URL, it is considered to be internal inthe current file. Links such as @samp{[[My Target]]} or @samp{[[MyTarget][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 thelink, or with a mouse click (@pxref{Handling links}). The preferredmatch for such a link is a dedicated target: the same string in doubleangular brackets. Targets may be located anywhere; sometimes it isconvenient to put them into a comment line. For example@example# <<My Target>>@end example@noindent In HTML export (@pxref{HTML export}), such targets will becomenamed anchors for direct access through @samp{http} links@footnote{Notethat text before the first headline will never be exported, so the firstsuch target must be after the first headline.}.If no dedicated target exists, Org-mode will search for the words in thelink. In the above example the search would be for @samp{my target}.Links starting with a star like @samp{*My Target} restrict the search toheadlines. When searching, Org-mode will first try an exact match, butthen move on to more and more lenient searches. For example, the link@samp{[[*My Targets]]} will find any of the following:@example** My targets** TODO my targets are bright** my 20 targets are@end exampleTo 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 andpress @kbd{M-@key{TAB}}. All headlines in the current buffer will beoffered as completions. @xref{Handling links}, for more commandscreating links.Following a link pushes a mark onto Org-mode's own mark ring. You canreturn to the previous position with @kbd{C-c &}. Using this commandseveral times in direct succession goes back to positions recordedearlier.@menu* Radio targets:: Make targets trigger links in plain text.@end menu@node Radio targets, , Internal links, Internal links@subsection Radio targets@cindex radio targets@cindex targets, radio@cindex links, radio targetsYou can configure Org-mode to link any occurrences of certain targetnames in normal text. So without explicitly creating a link, the textconnects to the target radioing its position. Radio targets areenclosed by triple angular brackets. For example, a target@samp{<<<My Target>>>} causes each occurrence of @samp{my target} innormal text to become activated as a link. The Org-mode file isscanned automatically for radio targets only when the file is firstloaded into Emacs. To update the target list during editing, press@kbd{C-c C-c} with the cursor on or at a target.@node External links, Handling links, Internal links, Hyperlinks@section External links@cindex links, external@cindex external links@cindex links, external@cindex GNUS links@cindex BBDB links@cindex URL links@cindex file links@cindex VM links@cindex RMAIL links@cindex WANDERLUST links@cindex MH-E links@cindex USENET links@cindex SHELL links@cindex Info links@cindex elisp linksOrg-mode supports links to files, websites, Usenet and email messages,and BBDB database entries. External links are URL-like locators. Theystart with a short identifying string followed by a colon. There can beno space after the colon. The following list shows examples for eachlink type.@examplehttp://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}@end exampleA link should be enclosed in double brackets and may contain adescriptive text to be displayed instead of the url (@pxref{Linkformat}), for example:@example[[http://www.gnu.org/software/emacs/][GNU Emacs]]@end example@noindentIf the description is a file name or URL that points to an image, HTMLexport (@pxref{HTML export}) will inline the image as a clickablebutton. If there is no description at all and the link points to animage,that image will be inlined into the exported HTML file.@cindex angular brackets, around links@cindex plain text external linksOrg-mode also finds external links in the normal text and activates themas links. If spaces must be part of the link (for example in@samp{bbdb:Richard Stallman}), or if you need to remove ambiguitiesabout the end of the link, enclose them in angular brackets.@node Handling links, Link abbreviations, External links, Hyperlinks@section Handling links@cindex links, handlingOrg-mode provides methods to create a link in the correct syntax, toinsert it into an org-mode file, and to follow the link.@table @kbd@kindex C-c l@cindex storing links@item C-c lStore a link to the current location. This is a @emph{global} commandwhich can be used in any buffer to create a link. The link will bestored for later insertion into an Org-mode buffer (see below). ForOrg-mode files, if there is a @samp{<<target>>} at the cursor, the linkpoints to the target. Otherwise it points to the current headline. ForVM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the link willindicate the current article/entry. For W3 and W3M buffers, the linkgoes to the current URL. For any other files, the link will point tothe file, with a search string (@pxref{Search options}) pointing to thecontents of the current line. If there is an active region, theselected words will form the basis of the search string. If theautomatically created link is not working correctly or accuratelyenough, you can write custom functions to select the search string andto 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}.@kindex C-c C-l@cindex link completion@cindex completion, of links@cindex inserting links@item C-c C-lInsert 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 thelink type prefixes mentioned in the examples above. All links storedduring the current session are part of the history for this prompt, soyou can access them with @key{up} and @key{down}, or withcompletion@footnote{After insertion of a stored link, the link will beremoved from the list of stored links. To keep it in the list lateruse, use a triple @kbd{C-u} prefix to @kbd{C-c C-l}, or configure theoption @code{org-keep-stored-link-after-insertion}.}. The link will beinserted into the buffer, along with a descriptive text. If some textwas selected when this command is called, the selected text becomes thedefault description.@* Note that you don't have to use this command toinsert a link. Links in Org-mode are plain text, and you can type orpaste them straight into the buffer. By using this command, the linksare automatically enclosed in double brackets, and you will be asked forthe optional descriptive text.@c If the link is a @samp{file:} link and@c the linked file is located in the same directory as the current file or@c a subdirectory of it, the path of the file will be inserted relative to@c the current directory.@kindex C-u C-c C-l@cindex file name completion@cindex completion, of file names@item C-u C-c C-lWhen @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link toa file will be inserted and you may use file name completion to selectthe name of the file. The path to the file is inserted relative to thedirectory of the current org file, if the linked file is in the currentdirectory or in a subdirectory of it, or if the path is written relativeto the current directory using @samp{../}. Otherwise an absolute pathis used, if possible with @samp{~/} for your home directory. You canforce an absolute path with two @kbd{C-u} prefixes.@item C-c C-l @r{with cursor on existing link}When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit thelink and description parts of the link.@cindex following links@kindex C-c C-o@item C-c C-oOpen link at point. This will launch a web browser for URLs (using@command{browse-url-at-point}), run vm/mh-e/wanderlust/rmail/gnus/bbdbfor the corresponding links, and execute the command in a shell link.When the cursor is on an internal link, this commands runs thecorresponding search. When the cursor is on a TAG list in a headline,it creates the corresponding TAGS view. If the cursor is on a timestamp, it compiles the agenda for that date. Furthermore, it will visittext and remote files in @samp{file:} links with Emacs and select asuitable application for local non-text files. Classification of filesis based on file extension only. See option @code{org-file-apps}. Ifyou want to override the default application and visit the file withEmacs, use a @kbd{C-u} prefix.@kindex mouse-2@kindex mouse-1@item mouse-2@itemx mouse-1On 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.@kindex mouse-3@item mouse-3Like @kbd{mouse-2}, but force file links to be opened with Emacs, andinternal links to be displayed in another window@footnote{See thevariable @code{org-display-internal-link-with-indirect-buffer}}.@cindex mark ring@kindex C-c %@item C-c %Push the current position onto the mark ring, to be able to returneasily. Commands following an internal link do this automatically.@cindex links, returning to@kindex C-c &@item C-c &Jump back to a recorded position. A position is recorded by thecommands following internal links, and by @kbd{C-c %}. Using thiscommand several times in direct succession moves through a ring ofpreviously recorded positions.@kindex C-c C-x C-n@kindex C-c C-x C-p@cindex links, finding next/previous@item C-c C-x C-n@itemx C-c C-x C-pMove forward/backward to the next link in the buffer. At the limit ofthe buffer, the search fails once, and then wraps around. The keybindings for this are really too long, you might want to bind this alsoto @kbd{C-n} and @kbd{C-p}@lisp(add-hook 'org-load-hook (lambda () (define-key 'org-mode-map "\C-n" 'org-next-link) (define-key 'org-mode-map "\C-p" 'org-previous-link)))@end lisp@end table@node Link abbreviations, Search options, Handling links, Hyperlinks@section Link abbreviations@cindex link abbreviations@cindex abbreviation, linksLong URLs can be cumbersome to type, and often many similar links areneeded in a document. For this you can use link abbreviations. Anabbreviated link looks like this@example[[linkword:tag][description]]@end example@noindentwhere the tag is optional. Such abbreviations are resolved according tothe information in the variable @code{org-link-abbrev-alist} thatrelates the linkwords to replacement text. Here is an example:@lisp@group(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")))@end group@end lispIf the replacement text contains the string @samp{%s}, it will bereplaced with the tag. Otherwise the tag will be appended to the stringin order to create the link. You may also specify a function that willbe called with the tag as the only argument to create the link.With the above setting, you could link to a specific bug with@code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with@code{[[google:OrgMode]]} and find out what the Org-mode author isdoing besides Emacs hacking with @code{[[ads:Dominik,C]]}.If you need special abbreviations just for a single Org-mode buffer, youcan define them in the file with@example#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=#+LINK: google http://www.google.com/search?q=%s@end example@noindentIn-buffer completion @pxref{Completion} can be used after @samp{[} tocomplete link abbreviations.@node Search options, Custom searches, Link abbreviations, Hyperlinks@section Search options in file links@cindex search option in file links@cindex file links, searchingFile links can contain additional information to make Emacs jump to aparticular location in the file when following a link. This can be aline number or a search option after a double@footnote{For backwardcompatibility, line numbers can also follow a single colon.} colon. Forexample, when the command @kbd{C-c l} creates a link (@pxref{Handlinglinks}) to a file, it encodes the words in the current line as a searchstring that can be used to find this line back later when following thelink with @kbd{C-c C-o}. Here is the syntax of the different ways to attach a search to a filelink, together with an explanation:@example[[file:~/code/main.c::255]][[file:~/xx.org::My Target]][[file:~/xx.org::*My Target]][[file:~/xx.org::/regexp/]]@end example@table @code@item 255Jump to line 255.@item My TargetSearch for a link target @samp{<<My Target>>}, or do a text search for@samp{my target}, similar to the search in internal links, see@ref{Internal links}. In HTML export (@pxref{HTML export}), such a filelink will become an HTML reference to the corresponding named anchor inthe linked file.@item *My TargetIn an Org-mode file, restrict search to headlines.@item /regexp/Do a regular expression search for @code{regexp}. This uses the Emacscommand @code{occur} to list all matches in a separate window. If thetarget file is in Org-mode, @code{org-occur} is used to create asparse tree with the matches.@c If the target file is a directory,@c @code{grep} will be used to search all files in the directory.@end tableAs a degenerate case, a file link with an empty file name can be usedto search the current file. For example, @code{[[file:::find me]]} doesa search for @samp{find me} in the current file, just as@samp{[[find me]]} would.@node Custom searches, Remember, Search options, Hyperlinks@section Custom Searches@cindex custom search strings@cindex search strings, customThe default mechanism for creating search strings and for doing theactual search related to a file link may not work correctly in allcases. For example, BibTeX database files have many entries like@samp{year="1993"} which would not result in good search strings,because the only unique identification for a BibTeX entry is thecitation key.If you come across such a problem, you can write custom functions to setthe right search string for a particular file type, and to do the searchfor the string in the file. Using @code{add-hook}, these functions needto be added to the hook variables@code{org-create-file-search-functions} and@code{org-execute-file-search-functions}. See the docstring for thesevariables for more information. Org-mode actually uses this mechanismfor Bib@TeX{} database files, and you can use the corresponding code asan implementation example. Search for @samp{BibTeX links} in the sourcefile.@node Remember, , Custom searches, Hyperlinks@section Remember@cindex @file{remember.el}Another way to create org entries with links to other files is throughthe @i{remember} package by John Wiegley. @i{Remember} lets you storequick notes with little interruption of your work flow. See@uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for moreinformation. The notes produced by @i{Remember} can be stored indifferent ways, and Org-mode files are a good target. Org-modesignificantly expands the possibilities of @i{remember}: You may definetemplates for different note types, and to associate target files andheadlines with specific templates. It also allows you to select thelocation where a note should be stored interactively, on the fly.@menu* 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@end menu@node Setting up remember, Remember templates, Remember, Remember@subsection Setting up rememberThe following customization will tell @i{remember} to use org files astarget, and to create annotations compatible with Org-mode links.@example(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)@end example@node Remember templates, Storing notes, Setting up remember, Remember@subsection Remember templates@cindex templates, for rememberIn combination with Org-mode, you can use templates to generatedifferent types of @i{remember} notes. For example, if you would liketo use one template to create general TODO entries, another one forjournal entries, and a third one for collecting random ideas, you coulduse:@example(setq org-remember-templates '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org") (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org") (?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))@end example@noindent In these entries, the character specifies how to select thetemplate. The first string specifies the template. Two more (optional)strings give the file in which, and the headline under which the newnote should be stored. The file defaults to@code{org-default-notes-file}, the heading to@code{org-remember-default-headline}. Both defaults help to get to thestoring location quickly, but you can change the location interactivelywhile storing the note.When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remembersomething, org will prompt for a key to select the template (if you havemore than one template) and then prepare the buffer like@example* TODO [[file:link to where you called remember]]@end example@noindent or@example* [2006-03-21 Tue 15:37] [[file:link to where you called remember]]@end example@noindentDuring expansion of the template, special @kbd{%}-escapes allow dynamicinsertion of content:@example%^@{prompt@} @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 @code{%^@{Birthday@}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.}%:keyword @r{specific information for certain link types, see below}@end example@noindentFor specific link types, the following keywords will be defined:@exampleLink type | Available keywords-------------------+----------------------------------------------bbdb | %:name %:companyvm, 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 | %:urlinfo | %:file %:nodecalendar | %:date"@end example@noindentIf you would like to have the cursor in a specific position after thetemplate has been expanded:@example%? @r{After completing the template, position cursor here.}@end example@noindentIf you change you mind about which template to use, call@code{org-remember} in the remember buffer. You may then select a newtemplate that will be filled with the previoous context information.@node Storing notes, , Remember templates, Remember@subsection Storing notesWhen you are finished preparing a note with @i{remember}, you have to press@kbd{C-c C-c} to file the note away. The handler first prompts for atarget file - if you press @key{RET}, the value specified for thetemplate is used. Then the command offers the headings tree of theselected file, with the cursor position at the default headline (if youhad specified one in the template). You can either immediately press@key{RET} to get the note placed there. Or you can use vertical cursormotion (@key{up} and @key{down}) and visibility cycling (@key{TAB}) tofind a better place. Pressing @key{RET} or @key{left} or @key{right}then leads to the following result.@multitable @columnfractions 0.2 0.1 0.7@item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}@item buffer-start @tab @key{RET} @tab as level 2 heading at end of file@item on headline @tab @key{RET} @tab as sublevel of the heading at cursor@item @tab @key{left} @tab as same level, before current heading@item @tab @key{right} @tab as same level, after current heading@item not on headline @tab @key{RET} @tab at cursor position, level taken from context. Or use prefix arg to specify level manually.@end multitableSo a fast way to store the note to its default location is to press@kbd{C-c C-c @key{RET} @key{RET}}. Even shorter would be @kbd{C-u C-cC-c}, which does the same without even asking for a file or showing thetree.Before inserting the text into a tree, the function ensures that thetext has a headline, i.e. a first line that starts with a @samp{*}.If not, a headline is constructed from the current date and someadditional data. If the variable @code{org-adapt-indentation} isnon-nil, the entire text is also indented so that it starts in thesame column as the headline (after the asterisks).@node TODO items, Timestamps, Hyperlinks, Top@chapter TODO items@cindex TODO itemsOrg-mode does not maintain TODO lists as a separate document. TODOitems are an integral part of the notes file, because TODO itemsusually come up while taking notes! With Org-mode, you simply markany entry in a tree as being a TODO item. In this way, theinformation is not duplicated, and the entire context from which theitem emerged is always present when you check.Of course, this technique causes TODO items to be scattered throughoutyour file. Org-mode provides methods to give you an overview over allthings you have to do.@menu* TODO basics:: Marking and displaying TODO entries* TODO extensions:: Workflow and assignments* Priorities:: Some things are more important than others* Breaking down tasks:: Splitting a task into managable pieces* Checkboxes:: Tick-off lists@end menu@node TODO basics, TODO extensions, TODO items, TODO items@section Basic TODO functionalityAny headline can become a TODO item by starting it with the word TODO,for example:@example*** TODO Write letter to Sam Fortune@end example@noindentThe most important commands to work with TODO entries are:@table @kbd@kindex C-c C-t@cindex cycling, of TODO states@item C-c C-tRotate the TODO state of the current item between@example,-> (unmarked) -> TODO -> DONE --.'--------------------------------'@end exampleThe same rotation can also be done ``remotely'' from the timeline andagenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).@kindex S-@key{right}@kindex S-@key{left}@item S-@key{right}@itemx S-@key{left}Select the following/preceding TODO state, similar to cycling. Mostlyuseful if more than two TODO states are possible (@pxref{TODO extensions}).@kindex C-c C-v@cindex sparse tree, for TODO@item C-c C-vView TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Foldsthe entire buffer, but shows all TODO items and the headings hierarchyabove them. With prefix arg, show also the DONE entries. Withnumerical prefix N, show the tree for the Nth keyword in the variable@code{org-todo-keywords}.@kindex C-c a t@item C-c a tShow the global TODO list. This collects the TODO items from allagenda files (@pxref{Agenda views}) into a single buffer. The buffer is in@code{agenda-mode}, so there are commands to examine and manipulatethe TODO entries directly from that buffer (@pxref{Agenda commands}).@xref{Global TODO list}, for more information.@c @item @code{org-agenda-include-all-todo}@c If you would like to have all your TODO items listed as part of your@c agenda, customize the variable @code{org-agenda-include-all-todo}.@end table@node TODO extensions, Priorities, TODO basics, TODO items@section Extended use of TODO keywords@cindex extended TODO keywordsThe default implementation of TODO entries is just two states: TODO andDONE. You can, however, use the TODO feature for more complicatedthings by configuring the variables @code{org-todo-keywords} and@code{org-todo-interpretation}. Using special setup, you can even useTODO keywords in different ways in different org files.Note that @i{tags} are another way to classify headlines in general andTODO items in particular (@pxref{Tags}).@menu* Workflow states:: From TODO to DONE in steps* TODO types:: I do this, Fred the rest* Per file keywords:: Different files, different requirements@end menu@node Workflow states, TODO types, TODO extensions, TODO extensions@subsection TODO keywords as workflow states@cindex TODO workflow@cindex workflow states as TODO keywordsYou can use TODO keywords to indicate different states in the processof working on an item, for example:@lisp(setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE") org-todo-interpretation 'sequence)@end lisp@cindex completion, of TODO keywordsChanging these variables only becomes effective in a new Emacs session.With this setup, the command @kbd{C-c C-t} will cycle an entry fromTODO to FEEDBACK, then to VERIFY, and finally to DONE. You may alsouse a prefix argument to quickly select a specific state. For example@kbd{C-3 C-c C-t} will change the state immediately to VERIFY.If you define many keywords, you can use in-buffer completion (see@ref{Completion}) to insert these words into the buffer. Changing a todostate can be logged with a timestamp, see @ref{Tracking TODO statechanges} for more information.@node TODO types, Per file keywords, Workflow states, TODO extensions@subsection TODO keywords as types@cindex TODO types@cindex names as TODO keywords@cindex types as TODO keywordsThe second possibility is to use TODO keywords to indicate differenttypes of action items. For example, you might want to indicate thatitems are for ``work'' or ``home''. If you are into David Allen's@emph{Getting Things DONE}, you might want to use todo types@samp{NEXTACTION}, @samp{WAITING}, @samp{MAYBE}. Or, when you workwith several people on a single project, you might want to assignaction items directly to persons, by using their names as TODOkeywords. This would be set up like this:@lisp(setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") org-todo-interpretation 'type)@end lispIn this case, different keywords do not indicate a sequence, butrather different types. So it is normally not useful to change fromone type to another. Therefore, in this case the behavior of thecommand @kbd{C-c C-t} is changed slightly@footnote{This is also truefor the @kbd{t} command in the timeline and agenda buffers.}. Whenused several times in succession, it will still cycle through allnames. But when you return to the item after some time and execute@kbd{C-c C-t} again, it will switch from each name directly to DONE.Use prefix arguments or completion to quickly select a specific name.You can also review the items of a specific TODO type in a sparse treeby using a numeric prefix to @kbd{C-c C-v}. For example, to see allthings Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collectLucy's items from all agenda files into a single buffer, youwould use the prefix arg as well when creating the global todo list:@kbd{C-3 C-c t}.@node Per file keywords, , TODO types, TODO extensions@subsection Setting up TODO keywords for individual files@cindex keyword options@cindex per file keywordsIt can be very useful to use different aspects of the TODO mechanismin different files, which is not possible with the global settingsdescribed above. For file-local settings, you need to add speciallines to the file which set the keywords and interpretation for thatfile only. For example, to set one of the two examples discussedabove, you need one of the following lines, starting in column zeroanywhere in the file:@example#+SEQ_TODO: TODO FEEDBACK VERIFY DONE#+TYP_TODO: Fred Sara Lucy Mike DONE@end example@cindex completion, of option keywords@kindex M-@key{TAB}@noindent To make sure you are using the correct keyword, type@samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.@cindex DONE, final TODO keywordRemember that the last keyword must always mean that the item is DONE(although you may use a different word). Also note that in each file,only one of the two aspects of TODO keywords can be used. Afterchanging one of these lines, use @kbd{C-c C-c} with the cursor stillin the line to make the changes known to Org-mode@footnote{Org-modeparses these lines only when Org-mode is activated after visiting afile. @kbd{C-c C-c} with the cursor in a line starting with @samp{#+}is simply restarting Org-mode for the current buffer.}.If you want to use very many keywords, for example when working with alarge group of people, you may split the names over several lines:@example#+TYP_TODO: Fred Sara Lucy Mike#+TYP_TODO: Luis George Jules Jessica#+TYP_TODO: Kim Arnold Peter#+TYP_TODO: DONE@end example@node Priorities, Breaking down tasks, TODO extensions, TODO items@section Priorities@cindex prioritiesIf you use Org-mode extensively to organize your work, you may end upwith a number of TODO entries so large that you'd like to prioritizethem. This can be done by placing a @emph{priority cookie} into theheadline, like this@example*** TODO [#A] Write letter to Sam Fortune@end example@noindentWith its standard setup, Org-mode supports priorities @samp{A},@samp{B}, and @samp{C}. @samp{A} is the highest priority. An entrywithout a cookie is treated as priority @samp{B}. Priorities make adifference only in the agenda (@pxref{Weekly/Daily agenda}).@table @kbd@kindex @kbd{C-c ,}@item @kbd{C-c ,}Set the priority of the current headline. The command prompts for apriority character @samp{A}, @samp{B} or @samp{C}. When you press@key{SPC} instead, the priority cookie is removed from the headline.The priorities can also be changed ``remotely'' from the timeline andagenda buffer with the @kbd{,} command (@pxref{Agenda commands}).@kindex S-@key{up}@kindex S-@key{down}@item S-@key{up}@itemx S-@key{down}Increase/decrease priority of current headline. Note that these keysare also used to modify time stamps (@pxref{Creating timestamps}).Furthermore, these keys are also used by CUA-mode (@pxref{Conflicts}).@end table@node Breaking down tasks, Checkboxes, Priorities, TODO items@section Breaking tasks down into subtasks@cindex tasks, breaking downIt is often advisable to break down large tasks into smaller, managablesubtasks. You can do this by creating an outline tree below a TODOitem, with detailed subtasks on the tree@footnote{To keep subtasks outof the global TODO list, see the@code{org-agenda-todo-list-sublevels}.}. Another possibility is the useof checkboxes to identify (a hierarchy of) a large number of subtasks(@pxref{Checkboxes}).@node Checkboxes, , Breaking down tasks, TODO items@section Checkboxes@cindex checkboxesEvery item in a plain list (@pxref{Plain lists}) can be made a checkboxby starting it with the string @samp{[ ]}. This feature is similar toTODO items (@pxref{TODO items}), but more lightweight. Checkboxes arenot included into the global TODO list, so they are often great to splita task into a number of simple steps. Or you can use them in a shoppinglist. To toggle a checkbox, use @kbd{C-c C-c}, or try Piotr Zielinski's@file{org-mouse.el}. Here is an example of a checkbox list.@example* 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@end example@cindex statistics, for checkboxes@cindex checkbox statisticsThe @samp{[3/6]} and @samp{[1/3]} in the first and second line arecookies indicating how many checkboxes are present in this entry, andhow many of them have been checked off. This can give you an idea onhow many checkboxes remain, even without opening a folded entry. Thecookies can be placed into a headline or into (the first line of) aplain list item. Each cookie covers all checkboxes structurally belowthat headline/item. You have to insert the cookie yourself by typingeither @samp{[/]} or @samp{[%]}. In the first case you get an @samp{nout of m} result, in the second case you get information about thepercentage of checkboxes checked (in the above example, this would be@samp{[50%]} and @samp{[33%], respectively}).@noindent The following commands work with checkboxes:@table @kbd@kindex C-c C-c@item C-c C-cToggle checkbox at point.@kindex C-c C-x C-b@item C-c C-x C-bToggle checkbox at point.@itemize @minus@itemIf there is an active region, toggle the first checkbox in the regionand set all remaining boxes to the same status as the first. If youwant to toggle all boxes in the region independently, use a prefixargument.@itemIf the cursor is in a headline, toggle checkboxes in the region betweenthis headline and the next (so @emph{not} the entire subtree).@itemIf there is no active region, just toggle the checkbox at point.@end itemize@kindex M-S-@key{RET}@item M-S-@key{RET}Insert a new item with a checkbox.This works only if the cursor is already in a plain list item(@pxref{Plain lists}).@kindex C-c #@item C-c #Update the checkbox statistics in the current outline entry. Whencalled with a @kbd{C-u} prefix, update the entire file. Checkboxstatistic cookies are updated automatically if you toggle checkboxeswith @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If youdelete boxes or add/change them by hand, use this command to get thingsback into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}.@end table@node Timestamps, Tags, TODO items, Top@chapter Timestamps@cindex time stamps@cindex date stampsItems can be labeled with timestamps to make them useful for projectplanning.@menu* Time stamps:: Assigning a time to a tree entry* Creating timestamps:: Commands which insert timestamps* Custom time format:: If you cannot work with the ISO format* Repeating items:: Deadlines that come back again and again* Progress logging:: Documenting when what work was done.@end menu@node Time stamps, Creating timestamps, Timestamps, Timestamps@section Time stamps, deadlines and scheduling@cindex time stamps@cindex ranges, time@cindex date stamps@cindex deadlines@cindex schedulingA time stamp is a specification of a date (possibly with time) in aspecial format, either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16 Tue09:39>}@footnote{This is the standard ISO date/time format. If youcannot get used to these, see @ref{Custom time format}}. A time stampcan appear anywhere in the headline or body of an org-tree entry. Itspresence allows entries to be shown on specific dates in the agenda(@pxref{Weekly/Daily agenda}). We distinguish:@table @var@item Plain time stamp@cindex timestampA simple time stamp just assigns a date/time to an item. This is justlike writing down an appointment in a paper agenda, or like writing downan event in a diary, when you want to take note of when somethinghappened. In the timeline and agenda displays, the headline of an entryassociated with a plain time stamp will be shown exactly on that date.@example* Meet Peter at the movies <2006-11-01 Wed 19:15>@end example@item Inactive time stamp@cindex timestamp, inactive@cindex inactive timestampJust like a plain time stamp, but with square brackets instead ofangular ones. These time stamps are inactive in the sense that they do@emph{not} trigger an entry to show up in the agenda.@example* Gillian comes late for the fifth time [2006-11-01 Wed]@end example@item Time stamp range@cindex timerangeTwo time stamps connected by @samp{--} denote a time range. Theheadline will be shown on the first and last day of the range, and onany dates that are displayed and fall in the range. Here is anexample:@example** Meeting in Amsterdam <2004-08-23 Mon>--<2004-08-26 Thu>@end example@item Time stamp with SCHEDULED keyword@cindex SCHEDULED keywordIf a time stamp is preceded by the word @samp{SCHEDULED:}, it means youare planning to start working on that task on the given date. So this isnot about recording an event, but about planning your work. Theheadline will be listed under the given date@footnote{It will still belisted on that date after it has been marked DONE. If you don't likethis, set the variable @code{org-agenda-skip-scheduled-if-done}.}. Inaddition, a reminder that the scheduled date has passed will be presentin the compilation for @emph{today}, until the entry is marked DONE.I.e., the task will automatically be forwarded until completed.@example*** TODO Call Trillian for a date on New Years Eve. SCHEDULED: <2004-12-25 Sat>@end example@item Time stamp with DEADLINE keyword@cindex DEADLINE keywordIf a time stamp is preceded by the word @samp{DEADLINE:}, the task(most likely a TODO item) is supposed to be finished on that date, andit will be listed then. In addition, the compilation for @emph{today}will carry a warning about the approaching or missed deadline,starting @code{org-deadline-warning-days} before the due date, andcontinuing until the entry is marked DONE. An example:@example*** TODO write article about the Earth for the Guide The editor in charge is [[bbdb:Ford Prefect]] DEADLINE: <2004-02-29 Sun>@end example@item Time stamp with CLOSED keyword@cindex CLOSED keywordWhen @code{org-log-done} is non-nil, Org-mode will automatically inserta special time stamp each time a TODO entry is marked done(@pxref{Progress logging}). This time stamp is enclosed in squarebrackets instead of angular brackets.@item Time range with CLOCK keyword@cindex CLOCK keywordWhen using the clock to time the work that is being done on specificitems, time ranges preceded by the CLOCK keyword are insertedautomatically into the file. The time stamps are enclosed in squarebrackets instead of angular brackets. @xref{Clocking work time}.@end table@node Creating timestamps, Custom time format, Time stamps, Timestamps@section Creating timestamps@cindex creating timestamps@cindex timestamps, creatingFor Org-mode to recognize time stamps, they need to be in the specificformat. All commands listed below produce time stamps in the correctformat.@table @kbd@kindex C-c .@item C-c .Prompt for a date and insert a corresponding time stamp. When thecursor is at a previously used time stamp, it is updated to NOW. Whenthis command is used twice in succession, a time range is inserted.@kindex C-u C-c .@item C-u C-c .Like @kbd{C-c .}, but use the alternative format which contains dateand time. The default time can be rounded to multiples of 5 minutes,see the option @code{org-time-stamp-rounding-minutes}.@kindex C-c !@item C-c !Like @kbd{C-c .}, but insert an inactive time stamp not triggering theagenda.@kindex C-c <@item C-c <Insert a time stamp corresponding to the cursor date in the Calendar.@kindex C-c >@item C-c >Access the Emacs calendar for the current date. If there is atimestamp in the current line, goto the corresponding dateinstead.@kindex C-c C-o@item C-c C-oAccess the agenda for the date given by the time stamp or -range atpoint (@pxref{Weekly/Daily agenda}).@kindex C-c C-d@item C-c C-dInsert @samp{DEADLINE} keyword along with a stamp. The insertion willhappen in the line directly following the headline. @c FIXME Any CLOSED timestamp will be removed.????????@kindex C-c C-w@cindex sparse tree, for deadlines@item C-c C-wCreate a sparse tree with all deadlines that are either past-due, orwhich will become due within @code{org-deadline-warning-days}.With @kbd{C-u} prefix, show all deadlines in the file. With a numericprefix, check that many days. For example, @kbd{C-1 C-c C-w} showsall deadlines due tomorrow.@kindex C-c C-s@item C-c C-sInsert @samp{SCHEDULED} keyword along with a stamp. The insertion willhappen in the line directly following the headline. Any CLOSEDtimestamp will be removed.@kindex S-@key{left}@kindex S-@key{right}@item S-@key{left}@itemx S-@key{right}Change date at cursor by one day. These key bindings conflict withCUA-mode (@pxref{Conflicts}).@kindex S-@key{up}@kindex S-@key{down}@item S-@key{up}@itemx S-@key{down}Change the item under the cursor in a timestamp. The cursor can be on ayear, month, day, hour or minute. Note that if the cursor is in aheadline and not at a time stamp, these same keys modify the priority ofan item. (@pxref{Priorities}). The key bindings also conflict withCUA-mode (@pxref{Conflicts}).@kindex C-c C-y@cindex evaluate time range@item C-c C-yEvaluate a time range by computing the difference between start andend. With prefix arg, insert result after the time range (in a table:into the following column).@end table@menu* The date/time prompt:: How org-mode helps you entering date and time@end menu@node The date/time prompt, , Creating timestamps, Creating timestamps@subsection The date/time prompt@cindex date, reading in minibuffer@cindex time, reading in minibufferWhen Org-mode prompts for a date/time, the prompt suggests to enter anISO date. But it will in fact accept any string containing some dateand/or time information. You can, for example, use @kbd{C-y} to paste a(possibly multi-line) string copied from an email message. Org-modewill find whatever information is in there and will replace anything notspecified with the current date and time. For example:@example 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)@end exampleThe function understands English month and weekday abbreviations. Ifyou want to use unabbreviated names and/or other languages, configurethe variables @code{parse-time-months} and @code{parse-time-weekdays}.@cindex calendar, for selecting dateParallel to the minibuffer prompt, a calendar is popped up@footnote{Ifyou don't need/want the calendar, configure the variable@code{org-popup-calendar-for-date-prompt}.}. When you exit the dateprompt, either by clicking on a date in the calendar, or by pressing@key{RET}, the date selected in the calendar will be combined with theinformation entered at the prompt. You can control the calendar fullyfrom the minibuffer:@table @kbd@kindex <@item <Scroll calendar backwards by one month.@kindex >@item >Scroll calendar forwards by one month.@kindex mouse-1@item mouse-1Select date by clicking on it.@kindex S-@key{right}@item S-@key{right}One day forward.@kindex S-@key{left}@item S-@key{left}One day back.@kindex S-@key{down}@item S-@key{down}One week forward.@kindex S-@key{up}@item S-@key{up}One week back.@kindex M-S-@key{right}@item M-S-@key{right}One month forward.@kindex M-S-@key{left}@item M-S-@key{left}One month back.@kindex @key{RET}@item @key{RET}Choose date in calendar (only if nothing was typed into minibuffer).@end table@node Custom time format, Repeating items, Creating timestamps, Timestamps@section Custom time format@cindex custom date/time format@cindex time format, custom@cindex date format, customOrg-mode uses the standard ISO notation for dates and times as it isdefined in ISO 8601. If you cannot get used to this and require anotherrepresentation of date and time to keep you happy, you can get it bycustomizing the variables @code{org-display-custom-times} and@code{org-time-stamp-custom-formats}.@table @kbd@kindex C-c C-x C-t@item C-c C-x C-tToggle the display of custom formats for dates and times.@end table@noindentOrg-mode needs the default format for scanning, so the custom date/timeformat does not @emph{replace} the default format - instead it is put@emph{over} the default format using text properties. This has thefollowing consequences:@itemize @bullet@item You cannot place the cursor onto a time stamp anymore, only before orafter.@itemThe @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjusteach component of a time stamp. If the cursor is at the beginning ofthe stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, thetime will be changed by one minute.@itemWhen you delete a time stamp character-by-character, it will onlydisappear from the buffer after @emph{all} (invisible) charactersbelonging to the ISO timestamp have been removed.@itemIf the custom time stamp format is longer than the default and you areusing dates in tables, table alignment will be messed up. If the customformat is shorter, things do work as expected.@end itemize@node Repeating items, Progress logging, Custom time format, Timestamps@section Repeating items@cindex TODO items, repeating@cindex deadlines, repeating@cindex scheduling, repeatingOrg-mode integrates with the Emacs calendar and diary to display cyclicappointments, anniversaries and other special entries in the agenda(@pxref{Weekly/Daily agenda}). However, it can be useful to havecertain deadlines and scheduling items to auto-repeat. The advantage ofa deadline or scheduled item is that the they produce warnings ahead oftime and automatically forward themselves in the agenda until they aredone. The abstract difference is therefore between cyclic@i{appointments} and cyclic @i{action items}. For appointments youshould use the diary, for actions you can uses an org-mode deadline orscheduling time stamp together with a REPEAT cookie. For example:@example* TODO Replace batteries in smoke detector REPEAT(+18m) SCHEDULED: <2007-01-01 Mon>* TODO Get dentist appointment REPEAT(+6m) SCHEDULED: <2006-12-19 Tue>* TODO Tax report to IRS REPEAT(+1y) DEADLINE: <2007-04-01 Sun>@end exampleEach time you try to mark one of these entries DONE using @kbd{C-c C-t},they will automatically switch back to the state TODO, and thedeadline/scheduling will be shifted accordingly. The time unitsrecognized by org-mode are year (y), month (m), week (w), and day (d).Org-mode will also prompt you for a note and record the fact that youhave closed this item in a note under the headline.One unusual property of these repeating items is that only one instanceof each exist at any given time. So if you look back or ahead in theagenda, you will not find past and future instances, only the currentone will show up. Use a cyclic diary entry if you need all past andfuture instances to be visible in the agenda.@node Progress logging, , Repeating items, Timestamps@section Progress Logging@cindex progress logging@cindex logging, of progressOrg-mode can automatically record a time stamp when you mark a TODO itemas 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 aproject by starting and stopping a clock when you start and stop workingon an aspect of a project.@menu* 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?@end menu@node Closing items, Tracking TODO state changes, Progress logging, Progress logging@subsection Closing itemsIf you want to keep track of @emph{when} a certain TODO item wasfinished, turn on logging with@footnote{The corresponding in-buffersetting is: @code{#+STARTUP: logdone}}@lisp(setq org-log-done t)@end lisp@noindentThen each time you turn a TODO entry into DONE using either @kbd{C-cC-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line@samp{CLOSED: [timestamp]} will be inserted just after the headline. Ifyou turn the entry back into a TODO item through further state cycling,that line will be removed again. In the timeline (@pxref{Timeline}) andin the agenda (@pxref{Weekly/Daily agenda}), you can then use the@kbd{l} key to display the TODO items closed on each day, giving you anoverview of what has been done on a day. If you want to record a notealong with the timestamp, use@footnote{The corresponding in-buffersetting is: @code{#+STARTUP: lognotedone}}@lisp(setq org-log-done '(done))@end lisp@node Tracking TODO state changes, Clocking work time, Closing items, Progress logging@subsection Tracking TODO state changesWhen TODO keywords are used as workflow states (@pxref{Workflowstates}), 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 thesetting@lisp(setq org-log-done '(state))@end lisp@noindenteach state change will prompt you for a note that will be attached tothe current headline. Very likely you do not want this verbose trackingall the time, so it is probably better to configure this behavior within-buffer options. For example, if you are tracking purchases, putthese into a separate file that starts with:@example#+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT#+STARTUP: lognotestate@end example@node Clocking work time, , Tracking TODO state changes, Progress logging@subsection Clocking work timeOrg-mode allows you to clock the time you spent on specific tasks in aproject. 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, theclock is stopped and the corresponding time interval is recorded. Italso computes the total time spent on each subtree of a project.@table @kbd@kindex C-c C-x C-i@item C-c C-x C-iStart the clock on the current item (clock-in). This inserts the CLOCKkeyword together with a timestamp.@kindex C-c C-x C-o@item C-c C-x C-oStop the clock (clock-out). The inserts another timestamp at the samelocation where the clock was last started. It also directly computesthe resulting time in inserts it after the time range as @samp{=>HH:MM}. See the variable @code{org-log-done} for the possibility torecord an additional note together with the clock-out timestamp@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:lognoteclock-out}}.@kindex C-c C-y@item C-c C-yRecompute the time interval after changing one of the time stamps. Thisis only necessary if you edit the time stamps directly. If you changethem with @kbd{S-@key{cursor}} keys, the update is automatic.@kindex C-c C-t@item C-c C-tChanging the TODO state of an item to DONE automatically stops the clockif it is running in this same item.@kindex C-c C-x C-x@item C-c C-x C-xCancel the current clock. This is useful if a clock was started bymistake, or if you ended up working on something else.@kindex C-c C-x C-d@item C-c C-x C-dDisplay time summaries for each subtree in the current buffer. Thisputs overlays at the end of each headline, showing the total timerecorded under that heading, including the time of any subheadings. Youcan use visibility cycling to study the tree, but the overlays disappearwhen you change the buffer (see variable@code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.@kindex C-c C-x C-r@item C-c C-x C-rInsert a dynamic block (@pxref{Dynamic blocks}) containing a clockreport as an org-mode table into the current file.@example#+BEGIN: clocktable :maxlevel 2 :emphasize nil#+END: clocktable@end example@noindentIf such a block already exists, its content is replaced by the newtable. The @samp{BEGIN} line can specify options:@example: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:} @r{@code{today}, @code{yesterday}, @code{thisweek}, @code{lastweek},} @r{@code{thismonth}, @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}@end exampleSo to get a clock summary for the current day, you could write@example#+BEGIN: clocktable :maxlevel 2 :block today#+END: clocktable@end exampleand to use a specific time range you could write@footnote{Note that allparameters must be specified in a single line - the line is broken hereonly to fit it onto the manual.}@example#+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" :tend "<2006-08-10 Thu 12:00>"#+END: clocktable@end example@kindex C-u C-c C-x C-u@item C-u C-c C-x C-uUpdate all dynamic blocks (@pxref{Dynamic blocks}). This is useful ifyou have several clocktable blocks in a buffer.@end tableThe @kbd{l} key may be used in the timeline (@pxref{Timeline}) and inthe agenda (@pxref{Weekly/Daily agenda}) to show which tasks have beenworked on or closed during a day.@node Tags, Agenda views, Timestamps, Top@chapter Tags@cindex tags@cindex headline tagging@cindex matching, tags@cindex sparse tree, tag basedIf you wish to implement a system of labels and contexts forcross-correlating information, an excellent way is to assign @i{tags} toheadlines. 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@samp{@@}. Tags must be preceded and followed by a single colon; like@samp{:WORK:}. Several tags can be specified like @samp{:WORK:URGENT:}.@menu* 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@end menu@node Tag inheritance, Setting tags, Tags, Tags@section Tag inheritance@cindex inheritance, of tags@cindex sublevels, inclusion into tags match@i{Tags} make use of the hierarchical structure of outline trees. If aheading has a certain tag, all subheadings will inherit the tag aswell. For example, in the list@example* Meeting with the French group :WORK:** Summary by Frank :BOSS:NOTES:*** TODO Prepare slides for him :ACTION:@end example@noindentthe final heading will have the tags @samp{:WORK:}, @samp{:BOSS:},@samp{:NOTES:}, and @samp{:ACTION:}. When executing tag searches andOrg-mode finds that a certain headline matches the search criterion, itwill not check any sublevel headline, assuming that these likely alsomatch, and that the list of matches can become very long. This maynot be what you want, however, and you can influence inheritance andsearching using the variables @code{org-use-tag-inheritance} and@code{org-tags-match-list-sublevels}.@node Setting tags, Tag searches, Tag inheritance, Tags@section Setting tags@cindex setting tags@cindex tags, setting@kindex M-@key{TAB}Tags can simply be typed into the buffer at the end of a headline.After a colon, @kbd{M-@key{TAB}} offers completion on tags. There isalso a special command for inserting tags:@table @kbd@kindex C-c C-c@item C-c C-c@cindex completion, of tagsEnter new tags for the current headline. Org-mode will either offercompletion or a special single-key interface for setting tags, seebelow. After pressing @key{RET}, the tags will be inserted and alignedto @code{org-tags-column}. When called with a @kbd{C-u} prefix, alltags in the current buffer will be aligned to that column, just to makethings look nice. TAGS are automatically realigned after promotion,demotion, and TODO state changes (@pxref{TODO basics}).@end tableOrg will support tag insertion based on a @emph{list of tags}. Bydefault this list is constructed dynamically, containing all tagscurrently used in the buffer. You may also globally specify a hard listof tags with the variable @code{org-tag-alist}. Finally you can setthe default tags for a given file with lines like@example#+TAGS: @@WORK @@HOME @@TENNISCLUB#+TAGS: Laptop Car PC Sailboat@end exampleIf you have globally defined your preferred set of tags using thevariable @code{org-tag-alist}, but would like to use a dynamic tag listin a specific file: Just add an empty TAGS option line to that file:@example#+TAGS:@end exampleThe default support method for entering tags is minibuffer completion.However, Org-mode also implements a much better method: @emph{fast tagselection}. This method allows to select and deselect tags with asingle key per tag. To function efficiently, you should assign uniquekeys to most tags. This can be done globally with@lisp(setq org-tag-alist '(("@@WORK" . ?w) ("@@HOME" . ?h) ("Laptop" . ?l)))@end lisp@noindent or on a per-file basis with@example#+TAGS: @@WORK(w) @@HOME(h) @@TENNISCLUB(t) Laptop(l) PC(p)@end example@noindentYou can also group together tags that are mutually exclusive. Withcurly braces@footnote{In @code{org-mode-alist} use@code{'(:startgroup)} and @code{'(:endgroup)}, respectively. Severalgroups are allowed.}@example#+TAGS: @{ @@WORK(w) @@HOME(h) @@TENNISCLUB(t) @} Laptop(l) PC(p)@end example@noindent you indicate that at most one of @samp{@@WORK}, @samp{@@HOME},and @samp{@@TENNISCLUB} should be selected.@noindent Don't forget to press @kbd{C-c C-c} with the cursor in one ofthese lines to activate any changes.If at least one tag has a selection key, pressing @kbd{C-c C-c} willautomatically present you with a special interface, listing inheritedtags, the tags of the current headline, and a list of all legal tagswith corresponding keys@footnote{Keys will automatically be assigned totags which have no configured keys.}. In this interface, you can usethe following keys:@table @kbd@item a-z...Pressing keys assigned to tags will add or remove them from the list oftags in the current line. Selecting a tag in a group of mutuallyexclusive tags will turn off any other tags from that group.@kindex @key{TAB}@item @key{TAB}Enter a tag in the minibuffer, even if the tag is not in the predefinedlist. You will be able to complete on all tags present in the buffer.@kindex @key{SPC}@item @key{SPC}Clear all tags for this line.@kindex @key{RET}@item @key{RET}Accept the modified set.@item C-gAbort without installing changes.@item qIf @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.@item !Turn off groups of mutually exclusive tags. Use this to (as anexception) assign several tags from such a group.@item C-cToggle auto-exit after the next change (see below).If you are using expert mode, the first @kbd{C-c} will display theselection window.@end table@noindentThis method lets you assign tags to a headline with very few keys. Withthe above setup, you could clear the current tags and set @samp{@@HOME},@samp{Laptop} and @samp{PC} tags with just the following keys: @kbd{C-cC-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@HOME} to@samp{@@WORK} would be done with @kbd{C-c C-c w @key{RET}} oralternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag@samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h@key{RET} @key{RET}}.If you find that most of the time, you need only a single keypress tomodify your list of tags, set the variable@code{org-fast-tag-selection-single-key}. Then you no longer have topress @key{RET} to exit fast tag selection - it will immediately exitafter the first change. If you then occasionally need more keys, press@kbd{C-c} 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-cC-c}). If you set the variable to the value @code{expert}, the specialwindow is not even shown for single-key tag selection, it comes up onlywhen you press an extra @kbd{C-c}.@node Tag searches, , Setting tags, Tags@section Tag searches@cindex tag searches@cindex searching for tagsOnce a tags system has been set up, it can be used to collect relatedinformation into special lists.@table @kbd@kindex C-c \@item C-c \Create a sparse tree with all headlines matching a tags search. With a@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.@kindex C-c a m@item C-c a mCreate a global list of tag matches from all agenda files.@xref{Matching headline tags}.@kindex C-c a M@item C-c a MCreate a global list of tag matches from all agenda files, but checkonly TODO items and force checking subitems (see variable@code{org-tags-match-list-sublevels}).@end table@cindex Boolean logic, for tag searchesA @i{tags} search string can use Boolean operators @samp{&} for AND and@samp{|} for OR. @samp{&} binds more strongly than @samp{|}.Parenthesis are currently not implemented. A tag may also be precededby @samp{-}, to select against it, and @samp{+} is syntactic sugar forpositive selection. The AND operator @samp{&} is optional when @samp{+}or @samp{-} is present. Examples:@table @samp@item +WORK-BOSSSelect headlines tagged @samp{:WORK:}, but discard those also tagged@samp{:BOSS:}.@item WORK|LAPTOPSelects lines tagged @samp{:WORK:} or @samp{:LAPTOP:}.@item WORK|LAPTOP&NIGHTLike before, but require the @samp{:LAPTOP:} lines to be tagged also@samp{NIGHT}.@end table@cindex TODO keyword matching, with tags searchIf you are using multi-state TODO keywords (@pxref{TODO extensions}), itcan be useful to also match on the TODO keyword. This can be done byadding a condition after a slash to a tags match. The syntax is similarto the tag matches, but should be applied with consideration: Forexample, a positive selection on several TODO keywords can notmeaningfully be combined with boolean AND. However, @emph{negativeselection} combined with AND can be meaningful. To make sure that onlylines are checked that actually have any TODO keyword, use @kbd{C-c aM}, or equivalently start the todo part after the slash with @samp{!}.Examples:@table @samp@item WORK/WAITINGSelect @samp{:WORK:}-tagged TODO lines with the specific TODOkeyword @samp{WAITING}.@item WORK/!-WAITING-NEXTSelect @samp{:WORK:}-tagged TODO lines that are neither @samp{WAITING}nor @samp{NEXT}@item WORK/+WAITING|+NEXTSelect @samp{:WORK:}-tagged TODO lines that are either @samp{WAITING} or@samp{NEXT}.@end table@cindex regular expressions, with tags searchAny element of the tag/todo match can be a regular expression - in thiscase it must be enclosed in curly braces. For example,@samp{WORK+@{^BOSS.*@}} matches headlines that contain the tag@samp{WORK} and any tag @i{starting} with @samp{BOSS}.@cindex level, require for tags matchYou can also require a headline to be of a certain level, by writinginstead of any TAG an expression like @samp{LEVEL=3}. For example, asearch @samp{+LEVEL=3+BOSS/-DONE} lists all level three headlines thathave the tag BOSS and are @emph{not} marked with the todo keyword DONE.@node Agenda views, Embedded LaTeX, Tags, Top@chapter Agenda Views@cindex agenda viewsDue to the way Org-mode works, TODO items, time-stamped items, andtagged headlines can be scattered throughout a file or even a number offiles. To get an overview over open action items, or over events thatare 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 themin a separate buffer. Six different view types are provided:@itemize @bullet@iteman @emph{agenda} that is like a calendar and shows informationfor specific dates,@itema @emph{TODO list} that covers all unfinishedaction items,@itema @emph{tags view}, showings headlines based onthe tags associated with them,@itema @emph{timeline view} that shows all events in a single Org-mode file,in time-sorted view,@itema @emph{stuck projects view} showing projects that currently don't movealong, and@item@emph{custom views} that are special tag/keyword searches andcombinations of different views.@end itemize@noindentThe extracted information is displayed in a special @emph{agendabuffer}. This buffer is read-only, but provides commands to visit thecorresponding locations in the original Org-mode files, and even toedit these files remotely. Two variables control how the agenda buffer is displayed and whether thewindow configuration is restored when the agenda exits:@code{org-agenda-window-setup} and@code{org-agenda-restore-windows-after-quit}.@menu* 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@end menu@node Agenda files, Agenda dispatcher, Agenda views, Agenda views@section Agenda files@cindex agenda files@cindex files for agendaThe information to be shown is collected from all @emph{agenda files},the files listed in the variable @code{org-agenda-files}@footnote{If thevalue of that variable is not a list, but a single file name, then thelist of agenda files will be maintained in that external file.}. Thus evenif you only work with a single Org-mode file, this file should be putinto that list@footnote{When using the dispatcher, pressing @kbd{1}before selecting a command will actually limit the command to thecurrent file, and ignore @code{org-agenda-files} until the nextdispatcher command.}. You can customize @code{org-agenda-files}, butthe easiest way to maintain it is through the following commands@cindex files, adding to agenda list@table @kbd@kindex C-c [@item C-c [Add current file to the list of agenda files. The file is added tothe front of the list. If it was already in the list, it is moved tothe front. With prefix arg, file is added/moved to the end.@kindex C-c ]@item C-c ]Remove current file from the list of agenda files.@kindex C-,@kindex C-'@item C-,@itemx C-'Cycle through agenda file list, visiting one file after the other.@end table@noindentThe Org menu contains the current list of files and can be usedto visit any of them.@node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda views@section The agenda dispatcher@cindex agenda dispatcher@cindex dispatching agenda commandsThe views are created through a dispatcher that should be bound to aglobal key, for example @kbd{C-c a} (@pxref{Installation}). In thefollowing we will assume that @kbd{C-c a} is indeed how the dispatcheris accessed and list keyboard access to commands accordingly. Afterpressing @kbd{C-c a}, an additional letter is required to execute acommand. The dispatcher offers the following default commands:@table @kbd@item aCreate the calendar-like agenda (@pxref{Weekly/Daily agenda}).@item t @r{/} TCreate a list of all TODO items (@pxref{Global TODO list}).@item m @r{/} MCreate a list of headlines matching a TAGS expression (@pxref{Matchingheadline tags}).@item LCreate the timeline view for the current buffer (@pxref{Timeline}).@item # @r{/} !Create a list of stuck projects (@pxref{Stuck projects}).@item 1Restrict an agenda command to the current buffer. After pressing@kbd{1}, you still need to press the character selecting the command.@item 0If there is an active region, restrict the following agenda command tothe region. Otherwise, restrict it to the current subtree. Afterpressing @kbd{0}, you still need to press the character selecting thecommand.@end tableYou can also define custom commands that will be accessible through thedispatcher, just like the default commands. This includes thepossibility to create extended agenda buffers that contain severalblocks together, for example the weekly agenda, the global TODO list anda number of special tags matches. @xref{Custom agenda views}.@node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda views@section The built-in agenda viewsIn this section we describe the built-in views.@menu* Weekly/Daily agenda:: The calendar page with current tasks* Global TODO list:: All unfinished action items* Matching headline tags:: Structured information with fine-tuned search* Timeline:: Time-sorted view for single file* Stuck projects:: Find projects you need to review@end menu@node Weekly/Daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views@subsection The weekly/daily agenda@cindex agenda@cindex weekly agenda@cindex daily agendaThe purpose of the weekly/daily @emph{agenda} is to act like a page of apaper agenda, showing all the tasks for the current week or day.@table @kbd@cindex org-agenda, command@kindex C-c a a@item C-c a aCompile an agenda for the current week from a list of org files. Theagenda shows the entries for each day. With a @kbd{C-u} prefix (orwhen the variable @code{org-agenda-include-all-todo} is @code{t}), allunfinished TODO items (including those without a date) are also listed atthe beginning of the buffer, before the first date.@*@end tableRemote editing from the agenda buffer means, for example, that you canchange the dates of deadlines and appointments from the agenda buffer.The commands available in the Agenda buffer are listed in @ref{Agendacommands}.@subsubheading Calendar/Diary integration@cindex calendar integration@cindex diary integrationEmacs contains the calendar and diary by Edward M. Reingold. Thecalendar displays a three-month calendar with holidays from differentcountries and cultures. The diary allows you to keep track ofanniversaries, lunar phases, sunrise/set, recurrent appointments(weekly, monthly) and more. In this way, it is quite complementary toOrg-mode. It can be very useful to combine output from Org-mode withthe diary.In order to include entries from the Emacs diary into Org-mode'sagenda, you only need to customize the variable@lisp(setq org-agenda-include-diary t)@end lisp@noindent After that, everything will happen automatically. All diaryentries including holidays, anniversaries etc will be included in theagenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and@key{RET} can be used from the agenda buffer to jump to the diaryfile in order to edit existing diary entries. The @kbd{i} command toinsert new entries for the current date works in the agenda buffer, aswell as the commands @kbd{S}, @kbd{M}, and @kbd{C} to displaySunrise/Sunset times, show lunar phases and to convert to othercalendars, respectively. @kbd{c} can be used to switch back and forthbetween calendar and agenda.@node Global TODO list, Matching headline tags, Weekly/Daily agenda, Built-in agenda views@subsection The global TODO list@cindex global TODO list@cindex TODO list, globalThe global TODO list contains all unfinished TODO items, formatted andcollected into a single place.@table @kbd@kindex C-c a t@item C-c a tShow the global TODO list. This collects the TODO items from allagenda files (@pxref{Agenda views}) into a single buffer. The buffer is in@code{agenda-mode}, so there are commands to examine and manipulatethe TODO entries directly from that buffer (@pxref{Agenda commands}).@kindex C-c a T@item C-c a T@cindex TODO keyword matchingLike the above, but allows selection of a specific TODO keyword. You canalso do this by specifying a prefix argument to @kbd{C-c a t}. With a@kbd{C-u} prefix you are prompted for a keyword. With a numericprefix, the Nth keyword in @code{org-todo-keywords} is selected.@kindex rThe @kbd{r} key in the agenda buffer regenerates it, and you can givea prefix argument to this command to change the selected TODO keyword,for example @kbd{3 r}. If you often need a search for a specifickeyword, define a custom command for it (@pxref{Agenda dispatcher}).@*Matching specific TODO keywords can also be done as part of a tagssearch (@pxref{Tag searches}).@end tableRemote editing of TODO items means that you can change the state of aTODO entry with a single key press. The commands available in theTODO list are described in @ref{Agenda commands}.@cindex sublevels, inclusion into todo listNormally the global todo list simply shows all headlines with TODOkeywords. This list can become very long. There are two ways to keepit more compact:@itemize @minus@itemSome people view a TODO item that has been @emph{scheduled} forexecution (@pxref{Time stamps}) as no longer @emph{open}. Configure thevariable @code{org-agenda-todo-ignore-scheduled} to exclude scheduleditems from the global TODO list.@itemTODO items may have sublevels to break up the task into subtasks. Insuch cases it may be enough to list only the highest level TODO headlineand omit the sublevels from the global list. Configure the variable@code{org-agenda-todo-list-sublevels} to get this behavior.@end itemize@node Matching headline tags, Timeline, Global TODO list, Built-in agenda views@subsection Matching headline tags@cindex matching, of tags@cindex tags viewIf headlines in the agenda files are marked with @emph{tags}(@pxref{Tags}), you can select headlines based on the tags that applyto them and collect them into an agenda buffer.@table @kbd@kindex C-c a m@item C-c a mProduce a list of all headlines that match a given set of tags. Thecommand prompts for a selection criterion, which is a boolean logicexpression with tags, like @samp{+WORK+URGENT-WITHBOSS} or@samp{WORK|HOME} (@pxref{Tags}). If you often need a specific search,define a custom command for it (@pxref{Agenda dispatcher}).@kindex C-c a M@item C-c a MLike @kbd{C-c a m}, but only select headlines that are also TODO itemsand force checking subitems (see variable@code{org-tags-match-list-sublevels}). Matching specific todo keywordstogether with a tags match is also possible, see @ref{Tag searches}.@end tableThe commands available in the tags list are described in @ref{Agendacommands}.@node Timeline, Stuck projects, Matching headline tags, Built-in agenda views@subsection Timeline for a single file@cindex timeline, single file@cindex time-sorted viewThe timeline summarizes all time-stamped items from a single Org-modefile in a @emph{time-sorted view}. The main purpose of this command isto give an overview over events in a project.@table @kbd@kindex C-a a L@item C-c a LShow 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.@end table@noindentThe commands available in the timeline buffer are listed in@ref{Agenda commands}.@node Stuck projects, , Timeline, Built-in agenda views@subsection Stuck projectsIf you are following a system like David Allen's GTD to organize yourwork, one of the ``duties'' you have is a regular review to make surethat all projects move along. A @emph{stuck} project is a project thathas no defined next actions, so it will never show up in the TODO listsOrg-mode produces. During the review, you need to identify suchprojects and define next actions for them.@table @kbd@kindex C-c a #@item C-c a #List projects that are stuck.@kindex C-c a !@item C-c a !Customize the variable @code{org-stuck-projects} to define what a stuckproject is and how to find it.@end tableYou almost certainly will have to configure this view before it willwork for you. The built-in default assumes that all your projects arelevel-2 headlines, and that a project is not stuck if it has at leastone entry marked with a todo keyword TODO or NEXT or NEXTACTION.Lets assume that you, in your own way of using Org-mode, identifyprojects with a tag PROJECT, and that you use a todo keyword MAYBE toindicate a project that should not be considered yet. Lets furtherassume that the todo keyword DONE marks finished projects, and that NEXTand TODO indicate next actions. Finally, the tag @@SHOP indicatesshopping and is a next action even without the NEXT tag. In this caseyou would start by identifying eligible projects with a tags/todo match@samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT and @@SHOP inthe subtree to identify projects that are not stuck. The correctcustomization for this is@lisp(setq org-stuck-projects ("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")))@end lisp@node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda views@section Presentation and sorting@cindex presentation, of agenda itemsBefore displaying items in an agenda view, Org-mode visually preparesthe items and sorts them. Each item occupies a single line. The linestarts with a @emph{prefix} that contains the @emph{category}(@pxref{Categories}) of the item and other important information. You cancustomize the prefix using the option @code{org-agenda-prefix-format}.The prefix is followed by a cleaned-up version of the outline headlineassociated with the item.@menu* Categories:: Not all tasks are equal* Time-of-day specifications:: How the agenda knows the time* Sorting of agenda items:: The order of things@end menu@node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting@subsection Categories@cindex categoryThe category is a broad label assigned to each agenda item. By default,the category is simply derived from the file name, but you can alsospecify it with a special line in the buffer, like this:@example#+CATEGORY: Thesis@end exampleIf there are several such lines in a file, each specifies the categoryfor the text below it (but the first category also applies to any textbefore the first CATEGORY line). The display in the agenda buffer looksbest if the category is not longer than 10 characters.@node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting@subsection Time-of-Day Specifications@cindex time-of-day specificationOrg-mode checks each agenda item for a time-of-day specification. Thetime can be part of the time stamp that triggered inclusion into theagenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Timeranges can be specified with two time stamps, like@c@w{@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 asplain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agendaintegrates the Emacs diary (@pxref{Weekly/Daily agenda}), timespecifications in diary entries are recognized as well.For agenda display, Org-mode extracts the time and displays it in astandard 24 hour format as part of the prefix. The example times inthe previous paragraphs would end up in the agenda like this:@example 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@end example@cindex time gridIf the agenda is in single-day mode, or for the display of today, thetimed entries are embedded in a time grid, like@example 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@end exampleThe time grid can be turned on and off with the variable@code{org-agenda-use-time-grid}, and can be configured with@code{org-agenda-time-grid}.@node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting@subsection Sorting of agenda items@cindex sorting, of agenda items@cindex priorities, of agenda itemsBefore being inserted into a view, the items are sorted. How this isdone depends on the type of view.@itemize @bullet@itemFor the daily/weekly agenda, the items for each day are sorted. Thedefault order is to first collect all items containing an explicittime-of-day specification. These entries will be shown at the beginningof the list, as a @emph{schedule} for the day. After that, items remaingrouped 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}, 1000for @samp{B}, and 0 for @samp{C}), plus additional increments foroverdue scheduled or deadline items.@item For the TODO list, items remain in the order of categories, but withineach category, sorting takes place according to priority(@pxref{Priorities}).@itemFor tags matches, items are not sorted at all, but just appear in thesequence in which they are found in the agenda files.@end itemizeSorting can be customized using the variable@code{org-agenda-sorting-strategy}.@node Agenda commands, Custom agenda views, Presentation and sorting, Agenda views@section Commands in the agenda buffer@cindex commands, in agenda bufferEntries in the agenda buffer are linked back to the org file or diaryfile where they originate. You are not allowed to edit the agendabuffer itself, but commands are provided to show and jump to theoriginal entry location, and to edit the org-files ``remotely'' fromthe 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. Forthe other commands, the cursor needs to be in the desired line.@table @kbd@tsubheading{Motion}@cindex motion commands in agenda@kindex n@item nNext line (same as @key{up}).@kindex p@item pPrevious line (same as @key{down}).@tsubheading{View/GoTo org file}@kindex mouse-3@kindex @key{SPC}@item mouse-3@itemx @key{SPC}Display the original location of the item in another window.@kindex L@item LDisplay original location and recenter that window.@kindex mouse-2@kindex mouse-1@kindex @key{TAB}@item mouse-2@itemx mouse-1@itemx @key{TAB}Go to the original location of the item in another window. Under Emacs22, @kbd{mouse-1} will also works for this.@kindex @key{RET}@itemx @key{RET}Go to the original location of the item and delete other windows.@kindex f@item fToggle Follow mode. In Follow mode, as you move the cursor throughthe agenda buffer, the other window always shows the correspondinglocation in the org file. The initial setting for this mode in newagenda buffers can be set with the variable@code{org-agenda-start-with-follow-mode}.@kindex b@item bDisplay 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, donot remove the previously used indirect buffer.@kindex l@item lToggle Logbook mode. In Logbook mode, entries that where marked DONE whilelogging was on (variable @code{org-log-done}) are shown in the agenda,as are entries that have been clocked on that day.@tsubheading{Change display}@cindex display changing, in agenda@kindex o@item oDelete other windows.@kindex w@item wSwitch to weekly view (7 days displayed together).@kindex d@item dSwitch to daily view (just one day displayed).@kindex D@item DToggle the inclusion of diary entries. See @ref{Weekly/Daily agenda}.@kindex g@item gToggle the time grid on and off. See also the variables@code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.@kindex r@item rRecreate the agenda buffer, for example to reflect the changesafter modification of the time stamps of items with S-@key{left} andS-@key{right}. When the buffer is the global todo list, a prefixargument is interpreted to create a selective list for a specific TODOkeyword.@kindex s@item sSave all Org-mode buffers in the current Emacs session.@kindex @key{right}@item @key{right}Display the following @code{org-agenda-ndays} days. For example, ifthe display covers a week, switch to the following week. With prefixarg, go forward that many times @code{org-agenda-ndays} days.@kindex @key{left}@item @key{left}Display the previous dates.@kindex .@item .Goto today.@tsubheading{Remote editing}@cindex remote editing, from agenda@item 0-9Digit argument.@cindex undoing remote-editing events@cindex remote editing, undo@kindex C-_@item C-_Undo a change due to a remote editing command. The change is undoneboth in the agenda buffer and in the remote buffer.@kindex t@item tChange the TODO state of the item, both in the agenda and in theoriginal org file.@kindex C-k@item C-kDelete the current agenda item along with the entire subtree belongingto it in the original Org-mode file. If the text to be deleted remotelyis longer than one line, the kill needs to be confirmed by the user. Seevariable @code{org-agenda-confirm-kill}.@kindex $@item $Archive the subtree corresponding to the current headline.@kindex T@item TShow all tags associated with the current item. Because ofinheritance, this may be more than the tags listed in the line itself.@kindex :@item :Set tags for the current headline.@kindex a@item aToggle the ARCHIVE tag for the current headline.@kindex ,@item ,Set the priority for the current item. Org-mode prompts for thepriority character. If you reply with @key{SPC}, the priority cookieis removed from the entry.@kindex P@item PDisplay weighted priority of current item.@kindex +@kindex S-@key{up}@item +@itemx S-@key{up}Increase the priority of the current item. The priority is changed inthe original buffer, but the agenda is not resorted. Use the @kbd{r}key for this.@kindex -@kindex S-@key{down}@item -@itemx S-@key{down}Decrease the priority of the current item.@kindex C-c C-s@item C-c C-sSchedule this item@kindex C-c C-d@item C-c C-dSet a deadline for this item.@kindex S-@key{right}@item S-@key{right}Change the time stamp associated with the current line by one day intothe future. With prefix argument, change it by that many days. Forexample, @kbd{3 6 5 S-@key{right}} will change it by a year. Thestamp is changed in the original org file, but the change is notdirectly reflected in the agenda buffer. Use the@kbd{r} key to update the buffer.@kindex S-@key{left}@item S-@key{left}Change the time stamp associated with the current line by one dayinto the past.@kindex >@item >Change the time stamp associated with the current line to today.The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}on my keyboard.@kindex I@item IStart the clock on the current item. If a clock is running already, itis stopped first.@kindex O@item OStop the previously started clock.@kindex X@item XCancel the currently running clock.@tsubheading{Calendar commands}@cindex calendar commands, from agenda@kindex c@item cOpen the Emacs calendar and move to the date at the agenda cursor.@item cWhen in the calendar, compute and show the Org-mode agenda for thedate at the cursor.@cindex diary entries, creating from agenda@kindex i@item iInsert a new entry into the diary. Prompts for the type of entry(day, weekly, monthly, yearly, anniversary, cyclic) and creates a newentry in the diary, just as @kbd{i d} etc. would do in the calendar.The date is taken from the cursor position.@kindex M@item MShow the phases of the moon for the three months around current date.@kindex S@item SShow sunrise and sunset times. The geographical location must be setwith calendar variables, see documentation of the Emacs calendar.@kindex C@item CConvert the date at cursor into many other cultural and historiccalendars.@kindex H@item HShow holidays for three month around the cursor date.@c FIXME: This should be a different key.@kindex C-c C-x C-c@item C-c C-x C-cExport a single iCalendar file containing entries from all agenda files.@tsubheading{Quit and Exit}@kindex q@item qQuit agenda, remove the agenda buffer.@kindex x@cindex agenda files, removing buffers@item xExit agenda, remove the agenda buffer and all buffers loaded by Emacsfor the compilation of the agenda. Buffers created by the user tovisit org files will not be removed.@end table@node Custom agenda views, , Agenda commands, Agenda views@section Custom agenda views@cindex custom agenda views@cindex agenda views, customCustom agenda commands serve two purposes: to store and quickly accessfrequently used TODO and tags searches, and to create special compositeagenda buffers. Custom agenda commands will be accessible through thedispatcher (@pxref{Agenda dispatcher}), just like the default commands.@menu* Storing searches:: Type once, use often* Block agenda:: All the stuff you need in a single buffer* Setting Options:: Changing the rules* Batch processing:: Agenda views from the command line@end menu@node Storing searches, Block agenda, Custom agenda views, Custom agenda views@subsection Storing searchesThe first application of custom searches is the definition of keyboardshortcuts for frequently used searches, either creating an agendabuffer, or a sparse tree (the latter covering of course only the currentbuffer).@kindex C-c a CCustom commands are configured in the variable@code{org-agenda-custom-commands}. You can customize this variable, forexample by pressing @kbd{C-c a C}. You can also directly set it withEmacs Lisp in @file{.emacs}. The following example contains all validsearch types:@lisp@group(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\\>")))@end group@end lisp@noindentThe initial single-character string in each entry defines the characteryou have to press after the dispatcher command @kbd{C-c a} in order toaccess the command. The second parameter is the search type, followedby the string or regular expression to be used for the matching. Theexample above will therefore define:@table @kbd@item C-c a was a global search for TODO entries with @samp{WAITING} as the TODOkeyword@item C-c a Was the same search, but only in the current buffer and displaying theresults as a sparse tree@item C-c a uas a global tags search for headlines marked @samp{:BOSS:} but not@samp{:URGENT:}@item C-c a vas the same search as @kbd{C-c a u}, but limiting the search toheadlines that are also TODO items@item C-c a Uas the same search as @kbd{C-c a u}, but only in the current buffer anddisplaying the result as a sparse tree@item C-c a fto create a sparse tree (again: current buffer only) with all entriescontaining the word @samp{FIXME}.@end table@node Block agenda, Setting Options, Storing searches, Custom agenda views@subsection Block agenda@cindex block agenda@cindex agenda, with block viewsAnother possibility is the construction of agenda views that comprisethe results of @emph{several} commands, each of which creates a block inthe agenda buffer. The available commands include @code{agenda} for thedaily 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 thematching commands discussed above: @code{todo}, @code{tags}, and@code{tags-todo}. Here are two examples:@lisp@group(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")))))@end group@end lisp@noindentThis will define @kbd{C-c a h} to create a multi-block view for stuffyou need to attend to at home. The resulting agenda buffer will containyour agenda for the current week, all TODO items that carry the tag@samp{HOME}, and also all lines tagged with @samp{GARDEN}. Finally thecommand @kbd{C-c a o} provides a similar view for office tasks.@node Setting Options, Batch processing, Block agenda, Custom agenda views@subsection Setting Options for custom commands@cindex options, for custom agenda viewsOrg-mode contains a number of variables regulating agenda constructionand display. The global variables define the behavior for all agendacommands, including the custom commands. However, if you want to changesome settings just for a single custom view, you can do so. Settingoptions requires inserting a list of variable names and values at theright spot in @code{org-agenda-custom-commands}. For example:@lisp@group(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)))))@end group@end lisp@noindentNow the @kbd{C-c a w} command will sort the collected entries only bypriority, and the prefix format is modified to just say @samp{ Mixed:}instead of giving the category of the entry. The sparse tags tree of@kbd{C-c a U} will now turn out ultra-compact, because neither theheadline hierarchy above the match, nor the headline following the matchwill be shown.For command sets creating a block agenda,@code{org-agenda-custom-commands} has two separate spots for settingoptions. You can add options that should be valid for just a singlecommand in the set, and options that should be valid for all commands inthe set. The former are just added to the command entry, the lattermust come after the list of command entries. Going back to the blockagenda example (@pxref{Block agenda}), let's change the sorting strategyfor the @kbd{C-c a h} commands to @code{priority-down}, but let's sortthe results for GARDEN tags query in the opposite order,@code{priority-up}. This would look like this:@lisp@group(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")))))@end group@end lispAs you see, the values and parenthesis setting is a little complex.When in doubt, use the customize interface to set this variable - itfully supports its structure. Just one caveat: When setting options inthis interface, the @emph{values} are just lisp expressions. So if thevalue is a string, you need to add the double quotes around the valueyourself.@node Batch processing, , Setting Options, Custom agenda views@subsection Creating agenda views in batch processing@cindex agenda, batch productionIf you want to print or otherwise reprocess agenda views, it can beuseful to create an agenda from the command line. This is the purposeof the function @code{org-batch-agenda}. It takes as a parameter one ofthe strings that are the keys in @code{org-agenda-custom-commands}. Forexample, to directly print the current TODO list, you could use@exampleemacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr@end example@noindentYou may also modify parameters on the fly like this:@exampleemacs -batch -l ~/.emacs \ -eval '(org-batch-agenda "a" \ org-agenda-ndays 300 \ org-agenda-include-diary nil \ org-agenda-files (quote ("~/org/project.org")))' \ | lpr@end example@noindentwhich will produce a 300 day agenda, fully restricted to the Org file@file{~/org/projects.org}, not even including the diary.@node Embedded LaTeX, Exporting, Agenda views, Top@chapter Embedded LaTeX@cindex @TeX{} interpretation@cindex La@TeX{} interpretationPlain ASCII is normally sufficient for almost all note taking. Oneexception, however, are scientific notes which need to be able tocontain mathematical symbols and the occasional formula.La@TeX{}@footnote{La@TeX{} is a macro system based on Donald E. Knuth's@TeX{} system. Many of the features described here as ``La@TeX{}'' arereally from @TeX{}, but for simplicity I am blurring this distinction.}is widely used to typeset scientific documents. Org-mode supportsembedding La@TeX{} code into its files, because many academics are usedto read La@TeX{} source code, and because it can be readily processedinto images for HTML production.It is not necessary to mark La@TeX{} macros and code in any special way.If you observe a few conventions, Org-mode knows how to find it and whatto do with it.@menu* 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@end menu@node Math symbols, Subscripts and Superscripts, Embedded LaTeX, Embedded LaTeX@section Math symbols@cindex math symbols@cindex TeX macrosYou can use La@TeX{} 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 afew letters, and press @kbd{M-@key{TAB}} to see possible completions.Unlike La@TeX{} code, Org-mode allows these macros to be presentwithout surrounding math delimiters, for example:@exampleAngles are written as Greek letters \alpha, \beta and \gamma.@end exampleDuring HTML export (@pxref{HTML export}), these symbols are translatedinto the proper syntax for HTML, for the above examples this is@samp{α} and @samp{→}, respectively.@node Subscripts and Superscripts, LaTeX fragments, Math symbols, Embedded LaTeX@section Subscripts and Superscripts@cindex subscript@cindex superscriptJust like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-and subscripts. Again, these can be used without embedding them inmath-mode delimiters. To increase the readability of ASCII text, it isnot necessary (but OK) to surround multi-character sub- and superscriptswith curly braces. For example@exampleThe mass if the sun is M_sun = 1.989 x 10^30 kg. The radius ofthe sun is R_@{sun@} = 6.96 x 10^8 m.@end exampleTo avoid interpretation as raised or lowered text, you can quote@samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.During HTML export (@pxref{HTML export}), subscript and superscriptsare surrounded with @code{<sub>} and @code{<sup>} tags, respectively.@node LaTeX fragments, Processing LaTeX fragments, Subscripts and Superscripts, Embedded LaTeX@section LaTeX fragments@cindex LaTeX fragmentsWith symbols, sub- and superscripts, HTML is pretty much at its end whenit comes to representing mathematical formulas@footnote{Yes, there isMathML, but that is not yet fully supported by many browsers, and thereis no decent converter for turning LaTeX of ASCII representations offormulas into MathML. So for the time being, converting formulas intoimages seems the way to go.}. More complexexpressions need a dedicated formula processor. To this end, Org-modecan contain arbitrary La@TeX{} fragments. It provides commands topreview the typeset result of these fragments, and upon export to HTML,all fragments will be converted to images and inlined into the HTMLdocument. For this to work you need to be on a system with a workingLa@TeX{} installation. You also need the @file{dvipng} program,available at @url{http://sourceforge.net/projects/dvipng/}.La@TeX{} fragments don't need any special marking at all. The followingsnippets will be identified as LaTeX source code:@itemize @bullet@itemEnvironments of any kind. The only requirement is that the@code{\begin} statement appears on a new line, preceded by onlywhitespace.@itemText within the usual La@TeX{} math delimiters. To avoid conflicts withcurrency specifications, single @samp{$} characters are only recognizedas math delimiters if the enclosed text contains at most two line breaks,is directly attached to the @samp{$} characters with no whitespace inbetween, and if the closing @samp{$} is followed by whitespace orpunctuation. For the other delimiters, there is no such restriction, sowhen in doubt, use @samp{\(...\)} as inline math delimiters.@end itemize@noindent For example:@example\begin@{equation@} % arbitrary environments,x=\sqrt@{b@} % even tables, figures\end@{equation@} % etcIf $a^2=b$ and \( b=2 \), then the solution must beeither $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].@end example@noindentIf you need any of the delimiter ASCII sequences for other purposes, youcan configure the option @code{org-format-latex-options} to deselect theones you do not wish to have interpreted by the La@TeX{} converter.@node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX@section Processing LaTeX fragments@cindex LaTeX fragments, previewLa@TeX{} fragments can be processed to produce a preview images of thetypeset expressions:@table @kbd@kindex C-c C-x C-l@item C-c C-x C-lProduce a preview image of the La@TeX{} fragment at point and overlay itover the source code. If there is no fragment at point, process allfragments in the current entry (between two headlines). When calledwith a prefix argument, process the entire subtree. When called withtwo prefix arguments, or when the cursor is before the first headline,process the entire buffer.@kindex C-c C-c@item C-c C-cRemove the overlay preview images.@end tableDuring HTML export (@pxref{HTML export}), all La@TeX{} fragments areconverted into images and inlined into the document if the followingsetting is active:@lisp(setq org-export-with-LaTeX-fragments t)@end lisp@node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX@section Using CDLaTeX to enter math@cindex CDLaTeXCDLaTeX-mode is a minor mode that is normally used in combination with amajor LaTeX mode like AUCTeX in order to speed-up insertion ofenvironments and math templates. Inside Org-mode, you can make use ofsome of the features of cdlatex-mode. You need to install@file{cdlatex.el} and @file{texmathp.el} (the latter comes also withAUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.Don't turn cdlatex-mode itself under Org-mode, but use the lightversion @code{org-cdlatex-mode} that comes as part of Org-mode. Turn iton for the current buffer with @code{M-x org-cdlatex-mode}, or for allOrg-mode files with@lisp(add-hook 'org-mode-hook 'turn-on-org-cdlatex)@end lispWhen this mode is enabled, the following features are present (for moredetails see the documentation of cdlatex-mode):@itemize @bullet@kindex C-c @{@itemEnvironment templates can be inserted with @kbd{C-c @{}.@item@kindex @key{TAB}The @key{TAB} key will do template expansion if the cursor is inside aLaTeX fragment@footnote{Org-mode has a method to test if the cursor isinside such a fragment, see the documentation of the function@code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} willexpand @code{fr} to @code{\frac@{@}@{@}} and position the cursorcorrectly inside the first brace. Another @key{TAB} will get you intothe second brace. Even outside fragments, @key{TAB} will expandenvironment abbreviations at the beginning of a line. For example, ifyou 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}.@item@kindex _@kindex ^Pressing @kbd{_} and @kbd{^} inside a LaTeX fragment will insert thesecharacters together with a pair of braces. If you use @key{TAB} to moveout of the braces, and if the braces surround only a single character ormacro, they are removed again (depending on the variable@code{cdlatex-simplify-sub-super-scripts}).@item@kindex `Pressing the backquote @kbd{`} followed by a character inserts mathmacros, also outside LaTeX fragments. If you wait more than 1.5 secondsafter the backquote, a help window will pop up.@item@kindex 'Pressing the normal quote @kbd{'} followed by another character modifiesthe symbol before point with an accent or a font. If you wait more than1.5 seconds after the backquote, a help window will pop up. Charactermodification will work only inside La@TeX{} fragments, outside the quoteis normal.@end itemize@node Exporting, Publishing, Embedded LaTeX, Top@chapter Exporting@cindex exportingOrg-mode documents can be exported into a variety of other formats. Forprinting and sharing of notes, ASCII export produces a readable andsimple version of an Org-mode file. HTML export allows you to publish anotes file on the web, while the XOXO format provides a solid base forexchange with a broad range of other applications. To incorporateentries with associated times like deadlines or appointments into adesktop calendar program like iCal, Org-mode can also produce extractsin the iCalendar format. Currently Org-mode only supports export, notimport of these different formats.When exporting, Org-mode uses special conventions to enrich the outputproduced. @xref{Text interpretation}, for more details.@table @kbd@kindex C-c C-e@item C-c C-eDispatcher for export and publishing commands. Displays a help-windowlisting the additional key(s) needed to launch an export or publishingcommand.@end table@menu* ASCII export:: Exporting to plain ASCII* HTML export:: Exporting to HTML* XOXO export:: Exporting to XOXO* iCalendar export:: Exporting in iCalendar format* Text interpretation:: How the exporter looks at the file@end menu@node ASCII export, HTML export, Exporting, Exporting@section ASCII export@cindex ASCII exportASCII export produces a simple and very readable version of an Org-modefile.@cindex region, active@cindex active region@cindex transient-mark-mode@table @kbd@kindex C-c C-e a@item C-c C-e aExport as ASCII file. If there is an active region, only the regionwill be exported. For an org file @file{myfile.org}, the ASCII filewill be @file{myfile.txt}. The file will be overwritten withoutwarning.@kindex C-c C-e v a@item C-c C-e v aExport only the visible part of the document.@end table@cindex headline levels, for exportingIn the exported version, the first 3 outline levels will becomeheadlines, defining a general document structure. Additional levelswill be exported as itemized lists. If you want that transition to occurat a different level, specify it with a prefix argument. For example,@example@kbd{C-1 C-c C-e a}@end example@noindentcreates only top level headlines and does the rest as items. Whenheadlines are converted to items, the indentation of the text followingthe headline is changed to fit nicely under the item. This is done withthe assumption that the first bodyline indicates the base indentation ofthe body text. Any indentation larger than this is adjusted to preservethe layout relative to the first line. Should there be lines with lessindentation than the first, these are left alone.@node HTML export, XOXO export, ASCII export, Exporting@section HTML export@cindex HTML exportOrg-mode contains an HTML (XHTML 1.0 strict) exporter with extensiveHTML formatting, in ways similar to John Grubers @emph{markdown}language, but with additional support for tables.@menu* Export commands:: How to invode HTML export* Quoting HTML tags:: Using direct HTML in Org-mode* Links:: How hyperlinks get transferred to HTML* Images:: To inline or not to inline?* CSS support:: Style specifications@end menu@node Export commands, Quoting HTML tags, HTML export, HTML export@subsection HTML export commands@cindex region, active@cindex active region@cindex transient-mark-mode@table @kbd@kindex C-c C-e h@item C-c C-e hExport as HTML file @file{myfile.html}.@kindex C-c C-e b@item C-c C-e bExport as HTML file and open it with a browser.@kindex C-c C-e v h@kindex C-c C-e v b@item C-c C-e v h@item C-c C-e v bExport only the visible part of the document.@end table@cindex headline levels, for exportingIn the exported version, the first 3 outline levels will becomeheadlines, defining a general document structure. Additional levelswill be exported as itemized lists. If you want that transition to occurat a different level, specify it with a prefix argument. For example,@example@kbd{C-2 C-c C-e b}@end example@noindentcreates two levels of headings and does the rest as items.@node Quoting HTML tags, Links, Export commands, HTML export@subsection Quoting HTML tagsPlain @samp{<} and @samp{>} are always transformed to @samp{<} and@samp{>} in HTML export. If you want to include simple HTML tagswhich should be interpreted as such, mark them with @samp{@@} as in@samp{@@<b>bold text@@</b>}. Note that this really works only forsimple tags. For more extensive HTML that should be copied verbatim tothe exported file use either@example#+HTML: Literal HTML code for export@end example@noindent or@example#+BEGIN_HTMLAll lines between these markers are exported literally#+END_HTML@end example@node Links, Images, Quoting HTML tags, HTML export@subsection Links@cindex links, in HTML export@cindex internal links, in HTML export@cindex external links, in HTML exportInternal links (@pxref{Internal links}) will continue to work in HTMLfiles only if they match a dedicated @samp{<<target>>}. Automatic linkscreated by radio targets (@pxref{Radio targets}) will also work in theHTML file. Links to external files will still work if the HTML file isin the same directory as the Org-mode file. Links to other @file{.org}files will be translated into HTML links under the assumption that anHTML version also exists of the linked file. For information related tolinking files while publishing them to a publishing directory see@ref{Publishing links}.@node Images, CSS support, Links, HTML export@subsection Images@cindex images, inline in HTML@cindex inlining images in HTMLHTML export can inline images given as links in the Org-mode file, andit can make an image the clickable part of a link. Bydefault@footnote{but see the variable@code{org-export-html-inline-images}}, images are inlined if a link doesnot have a description. So @samp{[[file:myimg.jpg]]} will be inlined,while @samp{[[file:myimg.jpg][the image]]} will just produce a link@samp{the image} that points to the image. If the description partitself is a @code{file:} link or a @code{http:} URL pointing to animage, this image will be inlined and activated so that clicking on theimage will activate the link. For example, to include a thumbnail thatwill link to a high resolution version of the image, you could use:@example[[file:highres.jpg][file:thumb.jpg]]@end example@noindentand you could use @code{http} addresses just as well.@node CSS support, , Images, HTML export@subsection CSS supportYou can also give style information for the exported file. The HTMLexporter assigns the following CSS classes to appropriate parts of thedocument - your style specifications may change these:@example.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}@end exampleThe default style specification can be configured through the option@code{org-export-html-style}. If you want to use a file-local style,you may use file variables, best wrapped into a COMMENT section at theend of the outline tree. For example@footnote{Under Emacs 21, thecontinuation lines for a variable value should have no @samp{#} at thestart of the line.}:@example* 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:@end exampleRemember to execute @kbd{M-x normal-mode} after changing this to makethe new style visible to Emacs. This command restarts org-mode for thecurrent buffer and forces Emacs to re-evaluate the local variablessection in the buffer.@c FIXME: More about header and footer styles@c FIXME: Talk about links and targets.@node XOXO export, iCalendar export, HTML export, Exporting@section XOXO export@cindex XOXO exportOrg-mode contains an exporter that produces XOXO-style output.Currently, this exporter only handles the general outline structure anddoes not interpret any additional Org-mode features.@table @kbd@kindex C-c C-e x@item C-c C-e xExport as XOXO file @file{myfile.html}.@kindex C-c C-e v@item C-c C-e v xExport only the visible part of the document.@end table@node iCalendar export, Text interpretation, XOXO export, Exporting@section iCalendar export@cindex iCalendar exportSome people like to use Org-mode for keeping track of projects, butstill prefer a standard calendar application for anniversaries andappointments. In this case it can be useful to have deadlines andother time-stamped items in Org-mode files show up in the calendarapplication. Org-mode can export calendar information in the standardiCalendar format. If you also want to have TODO entries included in theexport, configure the variable @code{org-icalendar-include-todo}.@table @kbd@kindex C-c C-e i@item C-c C-e iCreate iCalendar entries for the current file and store them in the samedirectory, using a file extension @file{.ics}.@kindex C-c C-e I@item C-c C-e ILike @kbd{C-c C-e i}, but do this for all files in@code{org-agenda-files}. For each of these files, a separate iCalendarfile will be written.@kindex C-c C-e c@item C-c C-e cCreate a single large iCalendar file from all files in@code{org-agenda-files} and write it to the file given by@code{org-combined-agenda-icalendar-file}.@end tableHow this calendar is best read and updated, depends on the applicationyou are using. The FAQ covers this issue.@node Text interpretation, , iCalendar export, Exporting@section Text interpretation by the exporterThe exporter backends interpret additional structure in the Org-mode filein order to produce better output.@menu* Comment lines:: Some lines will not be exported* Enhancing text:: Subscripts, symbols and more* Export options:: How to influence the export settings@end menu@node Comment lines, Enhancing text, Text interpretation, Text interpretation@subsection Comment lines@cindex comment lines@cindex exporting, notLines starting with @samp{#} in column zero are treated as commentsand will never be exported. Also entire subtrees starting with theword @samp{COMMENT} will never be exported. Finally, any text beforethe first headline will not be exported either.@table @kbd@kindex C-c ;@item C-c ;Toggle the COMMENT keyword at the beginning of an entry.@end table@node Enhancing text, Export options, Comment lines, Text interpretation@subsection Enhancing text for export@cindex enhancing text@cindex richer textSome of the export backends of Org-mode allow for sophisticated textformatting, this is true in particular for the HTML backend. Org-modehas a number of typing conventions that allow to produce a richlyformatted output.@itemize @bullet@cindex hand-formatted lists@cindex lists, hand-formatted@itemPlain lists @samp{-}, @samp{*} or @samp{+} as bullet, or with @samp{1.}or @samp{2)} as enumerator will be recognized and transformed if thebackend supports lists. See @xref{Plain lists}.@cindex underlined text@cindex bold text@cindex italic text@itemYou can make words @b{*bold*}, @i{/italic/}, _underlined_,@code{=code=}, and @samp{+strikethrough+}.@cindex horizontal rules, in exported files@itemA line consisting of only dashes, and at least 5 of them, will beexported as a horizontal line (@samp{<hr/>} in HTML).@cindex LaTeX fragments, export@cindex TeX macros, export@itemMany @TeX{} macros and entire La@TeX{} fragments are converted into HTMLentities or images (@pxref{Embedded LaTeX}).@cindex tables, export@itemTables are transformed into native tables under the exporter, if theexport backend supports this. Data fields before the first horizontalseparator line will be formatted as table header fields.@cindex fixed width@itemIf a headline starts with the word @samp{QUOTE}, the text below theheadline will be typeset as fixed-width, to allow quoting of computercodes etc. Lines starting with @samp{:} are also typeset infixed-width font.@table @kbd@kindex C-c :@item C-c :Toggle fixed-width for entry (QUOTE) or region, see below.@end table@cindex linebreak, forced@item A double backslash @emph{at the end of a line} enforces a line break atthis position.@end itemizeIf these conversions conflict with your habits of typing ASCII text,they can all be turned off with corresponding variables (see thecustomization group @code{org-export-general}, and the following sectionwhich explains how to set export options with special lines in abuffer.@node Export options, , Enhancing text, Text interpretation@subsection Export options@cindex options, for export@cindex completion, of option keywordsThe exporter recognizes special lines in the buffer which provideadditional information. These lines may be put anywhere in the file.The whole set of lines can be inserted into the buffer with @kbd{C-cC-e t}. For individual lines, a good way to make sure the keyword iscorrect is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion(@pxref{Completion}).@table @kbd@kindex C-c C-e t@item C-c C-e tInsert template with export options, see example below.@end table@example#+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 *:nil TeX:t LaTeX:t@end example@noindentThe OPTIONS line is a compact form to specify export settings. Hereyou can:@cindex headline levels@cindex section-numbers@cindex table of contents@cindex linebreak preservation@cindex quoted HTML tags@cindex fixed-width sections@cindex tables@cindex @TeX{}-like syntax for sub- and superscripts@cindex emphasized text@cindex @TeX{} macros@cindex La@TeX{} fragments@exampleH: @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.}*: @r{turn on/off emphasized text (bold, italic, underlined)}TeX: @r{turn on/off simple @TeX{} macros in plain text}LaTeX: @r{turn on/off La@TeX{} fragments}@end example@node Publishing, Miscellaneous, Exporting, Top@chapter Publishing@cindex publishingOrg-mode includes@footnote{@file{org-publish.el} is not yet part ofEmacs, so if you are using @file{org.el} as it comes with Emacs, youneed to download this file separately. Also make sure org.el is atleast version 4.27.} a publishing management systemthat allows you to configure automatic HTML conversion of@emph{projects} composed of interlinked org files. This system iscalled @emph{org-publish}. You can also configure org-publish toautomatically upload your exported HTML pages and related attachments,such as images and source code files, to a web server. Org-publish turnsorg-mode into a web-site authoring tool.Org-publish has been contributed to Org-mode by David O'Toole.@menu* Configuration:: Defining projects* Sample configuration:: Example projects* Triggering publication:: Publication commands@end menu@node Configuration, Sample configuration, Publishing, Publishing@section ConfigurationPublishing needs significant configuration to specify files, destinationand many other properties of a project.@menu* 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@end menu@node Project alist, Sources and destinations, Configuration, Configuration@subsection The variable @code{org-publish-project-alist}@cindex org-publish-project-alist@cindex projects, for publishingOrg-publish is configured almost entirely through setting the value ofone variable, called @code{org-publish-project-alist}.Each element of the list configures one project, and may be in one ofthe two following forms:@lisp("project-name" :property value :property value ...)@r{or} ("project-name" :components ("project-name" "project-name" ...))@end lispIn both cases, projects are configured by specifying property values.A project defines the set of files that will be published, as well asthe publishing configuration to use when publishing those files. Whena project takes the second form listed above, the individual membersof the ``components'' property are taken to be components of theproject, which group together files requiring different publishingoptions. When you publish such a ``meta-project'' all the componentswill also publish.@node Sources and destinations, Selecting files, Project alist, Configuration@subsection Sources and destinations for files@cindex directories, for publishingMost properties are optional, but some should always be set. Inparticular, org-publish needs to know where to look for source files,and where to put published files.@multitable @columnfractions 0.3 0.7@item @code{:base-directory}@tab Directory containing publishing source files@item @code{:publishing-directory}@tab Directory (possibly remote) where output files will be published.@item @code{:preparation-function}@tab Function called before starting publishing process, for example torun @code{make} for updating files to be published.@end multitable@noindent@node Selecting files, Publishing action, Sources and destinations, Configuration@subsection Selecting files@cindex files, selecting for publishingBy default, all files with extension @file{.org} in the base directoryare considered part of the project. This can be modified by setting theproperties @multitable @columnfractions 0.25 0.75@item @code{:base-extension}@tab Extension (without the dot!) of source files. This actually is aregular expression.@item @code{:exclude} @tab Regular expression to match file names that should not bepublished, even though they have been selected on the basis of theirextension.@item @code{:include}@tab List of files to be included regardless of @code{:base-extension}and @code{:exclude}.@end multitable@node Publishing action, Publishing options, Selecting files, Configuration@subsection Publishing Action@cindex action, for publishingPublishing means that a file is copied to the destination directory andpossibly transformed in the process. The default transformation is toexport Org-mode files as HTML files, and this is done by the function@code{org-publish-org-to-html} which calls the HTML exporter(@pxref{HTML export}). Other files like images only need to be copiedto the publishing destination. For non-Org-mode files, you need tospecify the publishing function.@multitable @columnfractions 0.3 0.7@item @code{:publishing-function}@tab Function executing the publication of a file. This may also be alist of functions, which will all be called in turn.@end multitableThe function must accept two arguments: a property list containing atleast a @code{:publishing-directory} property, and the name of the fileto be published. It should take the specified file, make the necessarytransformation (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):@code{org-publish-attachment}.@node Publishing options, Publishing links, Publishing action, Configuration@subsection Options for the HTML exporter@cindex options, for publishingThe property list can be used to set many export options for the HTMLexporter. In most cases, these properties correspond to user variablesin Org-mode. The table below lists these properties along with thevariable they belong to. See the documentation string for therespective variable for details.@multitable @columnfractions 0.3 0.7@item @code{:language} @tab @code{org-export-default-language}@item @code{:headline-levels} @tab @code{org-export-headline-levels}@item @code{:section-numbers} @tab @code{org-export-with-section-numbers}@item @code{:table-of-contents} @tab @code{org-export-with-toc}@item @code{:archived-trees} @tab @code{org-export-with-archived-trees}@item @code{:emphasize} @tab @code{org-export-with-emphasize}@item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}@item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}@item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}@item @code{:fixed-width} @tab @code{org-export-with-fixed-width}@item @code{:timestamps} .@tab @code{org-export-with-timestamps}@item @code{:tags} .@tab @code{org-export-with-tags}@item @code{:tables} @tab @code{org-export-with-tables}@item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}@item @code{:style} @tab @code{org-export-html-style}@item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}@item @code{:inline-images} @tab @code{org-export-html-inline-images}@item @code{:expand-quoted-html} @tab @code{org-export-html-expand}@item @code{:timestamp} @tab @code{org-export-html-with-timestamp}@item @code{:publishing-directory} @tab @code{org-export-publishing-directory}@item @code{:preamble} @tab @code{org-export-html-preamble}@item @code{:postamble} @tab @code{org-export-html-postamble}@item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}@item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}@item @code{:author} @tab @code{user-full-name}@item @code{:email} @tab @code{user-mail-address}@end multitableWhen a property is given a value in org-publish-project-alist, itssetting overrides the value of the corresponding user variable (if any)during publishing. options set within a file (@pxref{Exportoptions}), however, override everything.@node Publishing links, Project page index, Publishing options, Configuration@subsection Links between published files@cindex links, publishingTo create a link from one Org-mode file to another, you would usesomething like @samp{[[file:foo.org][The foo]]} or simply@samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this linkbecomes a link to @file{foo.html}. In this way, you can interlink thepages of your "org web" project and the links will work as expected whenyou publish them to HTML.You may also link to related files, such as images. Provided you arecareful with relative pathnames, and provided you have also configuredorg-publish to upload the related files, these links will worktoo. @ref{Complex example} for an example of this usage.Sometime an Org-mode file to be published may contain links that areonly valid in your production environment, but not in the publishinglocation. In this case, use the property @multitable @columnfractions 0.4 0.6@item @code{:link-validation-function}@tab Function to validate links@end multitable@noindentto define a function for checking link validity. This function mustaccept two arguments, the file name and a directory relative to whichthe file name is interpreted in the production environment. If thisfunction returns @code{nil}, then the HTML generator will only insert adescription into the HTML file, but no link. One option for thisfunction is @code{org-publish-validate-link} which checks if the givenfile is part of any project in @code{org-publish-project-alist}.@node Project page index, , Publishing links, Configuration@subsection Project page index@cindex index, of published pagesThe following properties may be used to control publishing of anindex of files or summary page for a given project.@multitable @columnfractions 0.25 0.75@item @code{:auto-index}@tab When non-nil, publish an index during org-publish-current-project ororg-publish-all.@item @code{:index-filename}@tab Filename for output of index. Defaults to @file{index.org} (whichbecomes @file{index.html}).@item @code{:index-title}@tab Title of index page. Defaults to name of file.@item @code{:index-function}@tab Plugin function to use for generation of index.Defaults to @code{org-publish-org-index}, which generates a plain listof links to all files in the project.@end multitable@node Sample configuration, Triggering publication, Configuration, Publishing@section Sample configurationBelow we provide two example configurations. The first one is a simpleproject publishing only a set of Org-mode files. The second example ismore complex, with a multi-component project.@menu* Simple example:: One-component publishing* Complex example:: A multi-component publishing example@end menu@node Simple example, Complex example, Sample configuration, Sample configuration@subsection Example: simple publishing configurationThis example publishes a set of Org-mode files to the @file{public_html}directory on the local machine.@lisp(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\">")))@end lisp@node Complex example, , Simple example, Sample configuration@subsection Example: complex publishing configurationThis more complicated example publishes an entire website, includingorg files converted to HTML, image files, emacs lisp source code, andstylesheets. The publishing-directory is remote and private files areexcluded.To ensure that links are preserved, care should be taken to replicateyour directory structure on the web server, and to use relative filepaths. For example, if your org files are kept in @file{~/org} and yourpublishable images in @file{~/images}, you'd link to an image with@c@examplefile:../images/myimage.png@end example@cOn the web server, the relative path to the image should be thesame. You can accomplish this by setting up an "images" folder in theright place on the webserver, and publishing images to it.@lisp(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"))))@end lisp@node Triggering publication, , Sample configuration, Publishing@section Triggering publicationOnce org-publish is properly configured, you can publish with thefollowing functions: @table @kbd@item C-c C-e cPrompt for a specific project and publish all files that belong to it.@item C-c C-e pPublish the project containing the current file.@item C-c C-e fPublish only the current file.@item C-c C-e aPublish all projects.@end tableOrg uses timestamps to track when a file has changed. The abovefunctions normally only publish changed files. You can override this andforce publishing of all files by giving a prefix argument.@node Miscellaneous, Extensions and Hacking, Publishing, Top@chapter Miscellaneous@menu* 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@end menu@node Completion, Customization, Miscellaneous, Miscellaneous@section Completion@cindex completion, of @TeX{} symbols@cindex completion, of TODO keywords@cindex completion, of dictionary words@cindex completion, of option keywords@cindex completion, of tags@cindex completion, of link abbreviations@cindex @TeX{} symbol completion@cindex TODO keywords completion@cindex dictionary word completion@cindex option keyword completion@cindex tag completion@cindex link abbreviations, completion ofOrg-mode supports in-buffer completion. This type of completion doesnot make use of the minibuffer. You simply type a few letters intothe buffer and use the key to complete text right there.@table @kbd@kindex M-@key{TAB}@item M-@key{TAB}Complete word at point@itemize @bullet@itemAt the beginning of a headline, complete TODO keywords.@itemAfter @samp{\}, complete @TeX{} symbols supported by the exporter.@itemAfter @samp{*}, complete headlines in the current buffer so that theycan be used in search links like @samp{[[*find this headline]]}.@itemAfter @samp{:}, complete tags. The list of tags is taken from thevariable @code{org-tag-alist} (possibly set through the @samp{#+TAGS}in-buffer option, @pxref{Setting tags}), or it is created dynamicallyfrom all tags used in the current buffer.@itemAfter @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).@itemAfter @samp{#+}, complete the special keywords like @samp{TYP_TODO} or@samp{OPTIONS} which set file-specific options for Org-mode. When theoption keyword is already complete, pressing @kbd{M-@key{TAB}} againwill insert example settings for this keyword.@itemIn the line after @samp{#+STARTUP: }, complete startup keywords,i.e. valid keys for this line.@itemElsewhere, complete dictionary words using ispell.@end itemize@end table@node Customization, In-buffer settings, Completion, Miscellaneous@section Customization@cindex customization@cindex options, for customization@cindex variables, for customizationThere are more than 180 variables that can be used to customizeOrg-mode. For the sake of compactness of the manual, I am notdescribing the variables here. A structured overview of customizationvariables is available with @kbd{M-x org-customize}. Or select@code{Browse Org Group} from the @code{Org->Customization} menu. Manysettings can also be activated on a per-file basis, by putting speciallines into the buffer (@pxref{In-buffer settings}).@node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous@section Summary of in-buffer settings@cindex in-buffer settings@cindex special keywordsOrg-mode uses special lines in the buffer to define settings on aper-file basis. These lines start with a @samp{#+} followed by akeyword, a colon, and then individual words defining a setting. Severalsetting words can be in the same line, but you can also have multiplelines for the keyword. While these settings are described throughoutthe manual, here is a summary. After changing any of those lines in thebuffer, press @kbd{C-c C-c} with the cursor still in the line toactivate the changes immediately. Otherwise they become effective onlywhen the file is visited again in a new Emacs session.@table @kbd@item #+STARTUP:This line sets options to be used at startup of org-mode, when anOrg-mode file is being visited. The first set of options deals with theinitial visibility of the outline tree. The corresponding variable forglobal default settings is @code{org-startup-folded}, with a defaultvalue @code{t}, which means @code{overview}.@cindex @code{overview}, STARTUP keyword@cindex @code{content}, STARTUP keyword@cindex @code{showall}, STARTUP keyword@exampleoverview @r{top-level headlines only}content @r{all headlines}showall @r{no folding at all, show everything}@end exampleThen there are options for aligning tables upon visiting a file. Thisis useful in files containing narrowed table columns. The correspondingvariable is @code{org-startup-align-all-tables}, with a default value@code{nil}. @cindex @code{align}, STARTUP keyword@cindex @code{noalign}, STARTUP keyword@examplealign @r{align all tables}noalign @r{don't align tables on startup}@end exampleLogging TODO state changes and clock intervals (variable@code{org-log-done}) can be configured using these options.@cindex @code{logdone}, STARTUP keyword@cindex @code{nologging}, STARTUP keyword@cindex @code{lognotedone}, STARTUP keyword@cindex @code{lognoteclock-out}, STARTUP keyword@cindex @code{lognotestate}, STARTUP keyword@examplelogging @r{record a timestamp when an item is marked DONE}nologging @r{don't record when items are marked DONE}lognotedone @r{record timestamp and a note when DONE}lognotestate @r{record timestamp, note when TODO state changes}lognoteclock-out @r{record timestamp and a note when clocking out}@end exampleHere are the options for hiding leading stars in outline headings. Thecorresponding variables are @code{org-hide-leading-stars} and@code{org-odd-levels-only}, both with a default setting @code{nil}(meaning @code{showstars} and @code{oddeven}).@cindex @code{hidestars}, STARTUP keyword@cindex @code{showstars}, STARTUP keyword@cindex @code{odd}, STARTUP keyword@cindex @code{even}, STARTUP keyword@examplehidestars @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}@end exampleTo turn on custom format overlays over time stamps (variables@code{org-put-time-stamp-overlays} and@code{org-time-stamp-overlay-formats}), use@cindex @code{customtime}, STARTUP keyword@examplecustomtime @r{overlay custom time format}@end example@item #+SEQ_TODO: #+TYP_TODO:These lines set the TODO keywords and their interpretation in thecurrent file. The corresponding variables are @code{org-todo-keywords}and @code{org-todo-interpretation}.@item #+TAGS: TAG1(c1) TAG2(c2)These lines (several such lines are allowed) specify the legal tags inthis file, and (potentially) the corresponding @emph{fast tag selection}keys. The corresponding variable is @code{org-tag-alist}.@item #+LINK: linkword replaceThese lines (several are allowed) specify link abbreviations.@xref{Link abbreviations}. The corresponding variable is@code{org-link-abbrev-alist}.@item #+CATEGORY:This line sets the category for the agenda file. The category appliesfor all subsequent lines until the next @samp{#+CATEGORY} line, or theend of the file. The first such line also applies to any entries before it.@item #+ARCHIVE: %s_done::This line sets the archive location for the agenda file. It applies forall subsequent lines until the next @samp{#+CATEGORY} line, or the endof the file. The first such line also applies to any entries before it.The corresponding variable is @code{org-archive-location}.@item #+TBLFM:This line contains the formulas for the table directly above the line.@item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:These lines provide settings for exporting files. For more details see@ref{Export options}.@end table@node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous@section The very busy C-c C-c key@kindex C-c C-c@cindex C-c C-c, overviewThe key @kbd{C-c C-c} has many purposes in org-mode, which are allmentioned scattered throughout this manual. One specific function ofthis key is to add @emph{tags} to a headline (@pxref{Tags}). In manyother circumstances it means something like @emph{Hey Org-mode, lookhere and update according to what you see here}. Here is a summary ofwhat this means in different contexts.@itemize @minus@itemIf there are highlights in the buffer from the creation of a sparsetree, or from clock display, remove these highlights.@itemIf the cursor is in one of the special @code{#+KEYWORD} lines, thistriggers scanning the buffer for these lines and updating theinformation. @itemIf the cursor is inside a table, realign the table. This commandworks even if the automatic table editor has been turned off.@itemIf the cursor is on a @code{#+TBLFM} line, re-apply the formulas tothe entire table.@itemIf the cursor is inside a table created by the @file{table.el} package,activate that table.@itemIf the current buffer is a remember buffer, close the note and file it.With a prefix argument, file it, without further interaction, to thedefault location.@itemIf the cursor is on a @code{<<<target>>>}, update radio targets andcorresponding links in this buffer.@itemIf the cursor is in a plain list item with a checkbox, toggle the statusof the checkbox.@itemIf the cursor is on a numbered item in a plain list, renumber theordered list.@end itemize@node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous@section A cleaner outline view@cindex hiding leading stars@cindex clean outline viewSome people find it noisy and distracting that the Org-mode headlinesare starting with a potentially large number of stars. For examplethe tree from @ref{Headlines}:@example* Top level headline** Second level*** 3rd level some text*** 3rd level more text* Another top level headline@end example@noindentUnfortunately this is deeply ingrained into the code of Org-mode andcannot be easily changed. You can, however, modify the display in sucha way that all leading stars become invisible and the outline more easyto read. To do this, customize the variable@code{org-hide-leading-stars} like this:@lisp(setq org-hide-leading-stars t)@end lisp@noindentor change this on a per-file basis with one of the lines (anywhere inthe buffer)@example#+STARTUP: showstars#+STARTUP: hidestars@end example@noindentPress @kbd{C-c C-c} with the cursor in a @samp{STARTUP} line to activatethe modifications.With stars hidden, the tree becomes:@example* Top level headline * Second level * 3rd level some text * 3rd level more text* Another top level headline@end example@noindentNote that the leading stars are not truly replaced by whitespace, theyare only fontified with the face @code{org-hide} that uses thebackground color as font color. If you are not using either white orblack background, you may have to customize this face to get the wantedeffect. Another possibility is to set this font such that the extrastars are @i{almost} invisible, for example using the color@code{grey90} on a white background.Things become cleaner still if you skip all the even levels and use onlyodd levels 1, 3, 5..., effectively adding two stars to go from oneoutline level to the next:@example* Top level headline * Second level * 3rd level some text * 3rd level more text* Another top level headline@end example@noindentIn order to make the structure editing and export commands handle thisconvention correctly, use@lisp(setq org-odd-levels-only t)@end lisp@noindentor set this on a per-file basis with one of the following lines (don'tforget to press @kbd{C-c C-c} with the cursor in the startup line toactivate changes immediately).@example#+STARTUP: odd#+STARTUP: oddeven@end exampleYou can convert an Org-mode file from single-star-per-level to thedouble-star-per-level convention with @kbd{M-x org-convert-to-odd-levelsRET} in that file. The reverse operation is @kbd{M-xorg-convert-to-oddeven-levels}.@node TTY keys, Interaction, Clean view, Miscellaneous@section Using org-mode on a tty@cindex tty keybindingsOrg-mode uses a number of keys that are not accessible on a tty. Thisapplies to most special keys like cursor keys, @key{TAB} and@key{RET}, when these are combined with modifier keys like @key{Meta}and/or @key{Shift}. Org-mode uses these bindings because it needs toprovide keys for a large number of commands, and because these keysappeared particularly easy to remember. In order to still be able toaccess the core functionality of Org-mode on a tty, alternativebindings are provided. Here is a complete list of these bindings,which are obviously more cumbersome to use. Note that sometimes awork-around can be better. For example changing a time stamp isreally only fun with @kbd{S-@key{cursor}} keys. On a tty you wouldrather use @kbd{C-c .} to re-insert the timestamp.@multitable @columnfractions 0.15 0.2 0.2@item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}@item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab@item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}@item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab@item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}@item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab@item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}@item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab@item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}@item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab@item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab@item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}@item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab@item @kbd{S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab@item @kbd{S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab@item @kbd{S-@key{up}} @tab @kbd{C-c C-x @key{up}} @tab@item @kbd{S-@key{down}} @tab @kbd{C-c C-x @key{down}} @tab@end multitable@node Interaction, Bugs, TTY keys, Miscellaneous@section Interaction with other packages@cindex packages, interaction with otherOrg-mode lives in the world of GNU Emacs and interacts in various wayswith other code out there.@menu* Cooperation:: Packages Org-mode cooperates with* Conflicts:: Packages that lead to conflicts@end menu@node Cooperation, Conflicts, Interaction, Interaction@subsection Packages that Org-mode cooperates with@table @asis@cindex @file{calc.el}@item @file{calc.el} by Dave GillespieOrg-mode uses the calc package for implementing spreadsheetfunctionality in its tables (@pxref{The spreadsheet}). Org-modechecks for the availability of calc by looking for the function@code{calc-eval} which should be autoloaded in your setup if calc hasbeen installed properly. As of Emacs 22, calc is part of the Emacsdistribution. Another possibility for interaction between the twopackages is using calc for embedded calculations. @xref{Embedded Mode,, Embedded Mode, calc, GNU Emacs Calc Manual}.@cindex @file{constants.el}@item @file{constants.el} by Carsten DominikIn a table formula (@pxref{The spreadsheet}), it is possible to usenames for natural constants or units. Instead of defining your ownconstants in the variable @code{org-table-formula-constants}, installthe @file{constants} package which defines a large number of constantsand units, and lets you use unit prefixes like @samp{M} for@samp{Mega} etc. You will need version 2.0 of this package, availableat @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks forthe function @code{constants-get}, which has to be autoloaded in yoursetup. See the installation instructions in the file@file{constants.el}.@item @file{cdlatex.el} by Carsten Dominik@cindex @file{cdlatex.el}Org-mode can make use of the cdlatex package to efficiently enterLa@TeX{} fragments into Org-mode files. See @ref{CDLaTeX mode}.@item @file{remember.el} by John Wiegley@cindex @file{remember.el}Org mode cooperates with remember, see @ref{Remember}.@file{Remember.el} is not part of Emacs, find it on the web.@cindex @file{table.el}@item @file{table.el} by Takaaki Ota@kindex C-c C-c@cindex table editor, @file{table.el}@cindex @file{table.el}Complex ASCII tables with automatic line wrapping, column- androw-spanning, and alignment can be created using the Emacs tablepackage 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-modewill call @command{table-recognize-table} and move the cursor into thetable. Inside a table, the keymap of Org-mode is inactive. In orderto execute Org-mode-related commands, leave the table.@table @kbd@kindex C-c C-c@item C-c C-cRecognize @file{table.el} table. Works when the cursor is in atable.el table.@kindex C-c ~@item C-c ~Insert a table.el table. If there is already a table at point, thiscommand converts it between the table.el format and the Org-modeformat. See the documentation string of the command@code{org-convert-table} for the restrictions under which this ispossible.@end table@file{table.el} is part of Emacs 22.@end table@node Conflicts, , Cooperation, Interaction@subsection Packages that lead to conflicts with Org-mode@table @asis@cindex @file{allout.el}@item @file{allout.el} by Ken ManheimerStartup of Org-mode may fail with the error message@code{(wrong-type-argument keymapp nil)} when there is an outdatedversion @file{allout.el} on the load path, for example the versiondistributed with Emacs 21.x. Upgrade to Emacs 22 and this problem willdisappear. If for some reason you cannot do this, make sure that org.elis loaded @emph{before} @file{allout.el}, for example by putting@code{(require 'org)} early enough into your @file{.emacs} file.@cindex @file{CUA.el}@item @file{CUA.el} by Kim. F. StormKeybindings in Org-mode conflict with the @kbd{S-<cursor>} keysused by CUA-mode (as well as pc-select-mode and s-region-mode) toselect and extend the region. If you want to use one of thesepackages along with Org-mode, configure the variable@code{org-CUA-compatible}. When set, Org-mode will move the followingkeybindings in org-mode files, and in the agenda buffer (but notduring date selection).@exampleS-UP -> M-p S-DOWN -> M-nS-LEFT -> M-- S-RIGHT -> M-+S-RET -> C-S-RET@end exampleYes, these are unfortunately more difficult to remember. If you wantto have other replacement keys, look at the variable@code{org-disputed-keys}.@item @file{windmove.el} by Hovav Shacham@cindex @file{windmove.el}Also this package uses the @kbd{S-<cursor>} keys, so everything writtenin the paragraph above about CUA mode also applies here.@end table@node Bugs, , Interaction, Miscellaneous@section Bugs@cindex bugsHere is a list of things that should work differently, but which Ihave found too hard to fix.@itemize @bullet@itemIf a table field starts with a link, and if the corresponding tablecolumn is narrowed (@pxref{Narrow columns}) to a width too small todisplay the link, the field would look entirely empty even though it isnot. To prevent this, Org-mode throws an error. The work-around is tomake the column wide enough to fit the link, or to add some text (atleast 2 characters) before the link in the same field.@itemNarrowing table columns does not work on XEmacs, because the@code{format} function does not transport text properties.@itemText in an entry protected with the @samp{QUOTE} keyword should notautowrap.@itemWhen 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 openthe file), it does so silently. No error message is displayed.@itemRecalculating 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. Youmay use the command @code{org-table-iterate} (@kbd{C-u C-c *}) torecalculate until convergence.@itemA single letter cannot be made bold, for example @samp{*a*}.@itemThe exporters work well, but could be made more efficient.@end itemize@node Extensions and Hacking, History and Acknowledgments, Miscellaneous, Top@appendix Extensions, Hooks and HackingThis appendix lists extensions for Org-mode written by other authors.It also covers some aspects where users can extend the functionality ofOrg-mode.@menu* Extensions:: Existing 3rd-part extensions* Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs* Dynamic blocks:: Automatically filled blocks* Special agenda views:: Customized views@end menu@node Extensions, Tables in arbitrary syntax, Extensions and Hacking, Extensions and Hacking@section Third-party extensions for Org-mode@cindex extension, third-partyThe following extensions for Org-mode have been written by other people:@table @asis@cindex @file{org-publish.el}@item @file{org-publish.el} by David O'TooleThis package provides facilities for publishing related sets of Org-modefiles together with linked files like images as webpages. It ishighly configurable and can be used for other publishing purposes aswell. As of Org-mode version 4.30, @file{org-publish.el} is part of theOrg-mode distribution. It is not yet part of Emacs, however, a delaycaused by the preparations for the 22.1 release. In the mean time,@file{org-publish.el} can be downloaded from David's site:@url{http://dto.freeshell.org/e/org-publish.el}.@cindex @file{org-mouse.el}@item @file{org-mouse.el} by Piotr ZielinskiThis package implements extended mouse functionality for Org-mode. Itallows you to cycle visibility and to edit the document structure withthe mouse. Best of all, it provides a context-sensitive menu on@key{mouse-3} that changes depending on the context of a mouse-click.As of Org-mode version 4.53, @file{org-mouse.el} is part of theOrg-mode distribution. It is not yet part of Emacs, however, a delaycaused by the preparations for the 22.1 release. In the mean time,@file{org-mouse.el} can be downloaded from Piotr's site:@url{http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el}.@cindex @file{org-blog.el}@item @file{org-blog.el} by David O'TooleA blogging plug-in for @file{org-publish.el}.@*@url{http://dto.freeshell.org/notebook/OrgMode.html}.@cindex @file{blorg.el}@item @file{blorg.el} by Bastien GuerryPublish Org-mode files asblogs. @url{http://www.cognition.ens.fr/~guerry/blorg.html}.@cindex @file{org2rem.el}@item @file{org2rem.el} by Bastien GuerryTranslates Org-mode files into something readable byRemind. @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}.@end table@page@node Tables in arbitrary syntax, Dynamic blocks, Extensions, Extensions and Hacking@section Tables in arbitrary syntax@cindex tables, in other modes@cindex orgtbl-modeSince Orgtbl-mode can be used as a minor mode in arbitrary buffers, afrequent feature request has been to make it work with native tables inspecific languages, for example LaTeX. However, this is extremely hardto do in a general way, would lead to a customization nightmare, andwould take away much of the simplicity of the Orgtbl-mode table editor.This appendix describes a different approach. We keep the Orgtbl-modetable in its native format (the @i{source table}), and use a customfunction to @i{translate} the table to the correct syntax, and to@i{install} it in the right location (the @i{target table}). This putsthe burden of writing conversion functions on the user, but it allowsfor a very flexible system.@menu* Radio tables:: Sending and receiving* A LaTeX example:: Step by step, almost a tutorial* Translator functions:: Copy and modify@end menu@node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax@subsection Radio tables@cindex radio tablesTo define the location of the target table, you first need to create twolines that are comments in the current mode, but contain magic words forOrgtbl-mode to find. Orgtbl-mode will insert the translated tablebetween these lines, replacing whatever was there before. For example:@example/* BEGIN RECEIVE ORGTBL table_name *//* END RECEIVE ORGTBL table_name */@end example@noindentJust above the source table, we put a special line that tellsOrgtbl-mode how to translate this table and where to install it. Forexample:@example#+ORGTBL: SEND table_name translation_function arguments....@end example@noindent@code{table_name} is the reference name for the table that is also usedin the receiver lines. @code{translation_function} is the Lisp functionthat does the translation. Furthermore, the line can contain a list ofarguments (alternating key and value) at the end. The arguments will bepassed as a property list to the translation function forinterpretation. A few standard parameters are already recognized andacted upon before the translation function is called:@table @code@item :skip NSkip the first N lines of the table. Hlines do count!@item :skipcols (n1 n2 ...)List of columns that should be skipped. If the table has a column withcalculation marks, that column is automatically discarded as well.Please note that the translator function sees the table @emph{after} theremoval of these columns, the function never knows that there have beenadditional columns.@end table@noindentThe one problem remaining is how to keep the source table in the bufferwithout disturbing the normal workings of the file, for example duringcompilation of a C file or processing of a LaTeX file. There are anumber of different solutions:@itemize @bullet@itemThe table could be placed in a block comment if that is supported by thelanguage. For example, in C-mode you could wrap the table between@samp{/*} and @samp{*/} lines.@item Sometimes it is possible to put the table after some kind of @i{END}statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}in LaTeX.@itemYou can just comment the table line by line whenever you want to processthe file, and uncomment it whenever you need to edit the table. Thisonly sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} doesmake this comment-toggling very easy, in particular if you bind it to akey.@end itemize@node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax@subsection A LaTeX example@cindex LaTeX, and orgtbl-modeThe best way to wrap the source table in LaTeX is to use the@code{comment} environment provided by @file{comment.sty}. It has to beactivated by placing @code{\usepackage@{comment@}} into the documentheader. Orgtbl-mode can insert a radio table skeleton@footnote{Bydefault this works only for LaTeX, HTML, and TeXInfo. Configure thevariable @code{orgtbl-radio-tables} to install templates for othermodes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You willbe prompted for a table name, lets say we use @samp{salesfigures}. Youwill then get the following template:@example% BEGIN RECEIVE ORGTBL salesfigures% END RECEIVE ORGTBL salesfigures\begin@{comment@}#+ORGTBL: SEND salesfigures orgtbl-to-latex| | |\end@{comment@}@end example@noindentThe @code{#+ORGTBL: SEND} line tells orgtbl-mode to use the function@code{orgtbl-to-latex} to convert the table into LaTeX and to put itinto the receiver location with name @code{salesfigures}. You may nowfill in the table, feel free to use the spreadsheet features@footnote{Ifthe @samp{#+TBLFM} line contains an odd number of dollar characters,this may cause problems with font-lock in latex-mode. As shown in theexample you can fix this by adding an extra line inside the@code{comment} environment that is used to balance the dollarexpressions. If you are using AUCTeX with the font-latex library, amuch better solution is to add the @code{comment} environment to thevariable @code{LaTeX-verbatim-environments}.}:@example% BEGIN RECEIVE ORGTBL salesfigures% END RECEIVE ORGTBL salesfigures\begin@{comment@}#+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)\end@{comment@}@end example@noindentWhen you are done, press @kbd{C-c C-c} in the table to get the convertedtable inserted between the two marker lines.Now lets assume you want to make the table header by hand, because youwant to control how columns are aligned etc. In this case we make surethat the table translator does skip the first 2 lines of the sourcetable, and tell the command to work as a @i{splice}, i.e. to not produceheader and footer commands of the target table:@example\begin@{tabular@}@{lrrr@}Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\% BEGIN RECEIVE ORGTBL salesfigures% END RECEIVE ORGTBL salesfigures\end@{tabular@}%\begin@{comment@}#+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\end@{comment@}@end exampleThe LaTeX translator function @code{orgtbl-to-latex} is already part ofOrgtbl-mode. It uses a @code{tabular} environment to typeset the tableand marks horizontal lines with @code{\hline}. Furthermore, itinterprets the following parameters:@table @code@item :splice nil/tWhen set to t, return only table body lines, don't wrap them into atabular environment. Default is nil.@item :fmt fmtA format to be used to wrap each field, should contain @code{%s} for theoriginal field value. For example, to wrap each field value in dollars,you could use @code{:fmt "$%s$"}. This may also be a property list withcolumn numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.@item :efmt efmtUse this format to print numbers with exponentials. The format shouldhave @code{%s} twice for inserting mantissa and exponent, for example@code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. Thismay also be a property list with column numbers and formats, for example@code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After@code{efmt} has been applied to a value, @code{fmt} will also beapplied.@end table@node Translator functions, , A LaTeX example, Tables in arbitrary syntax@subsection Translator functions@cindex HTML, and orgtbl-mode@cindex translator functionOrgtbl-mode has several translator functions built-in:@code{orgtbl-to-latex}, @code{orgtbl-to-html}, and@code{orgtbl-to-texinfo}. Except for @code{orgtbl-to-html}@footnote{TheHTML translator uses the same code that produces tables during HTMLexport.}, these all use a generic translator, @code{orgtbl-to-generic}.For example, @code{orgtbl-to-latex} itself is a very short function thatcomputes the column definitions for the @code{tabular} environment,defines a few field and line separators and then hands over to thegeneric translator. Here is the entire code:@lisp@group(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 "\\begin@{tabular@}@{" alignment "@}") :tend "\\end@{tabular@}" :lstart "" :lend " \\\\" :sep " & " :efmt "%s\\,(%s)" :hline "\\hline"))) (orgtbl-to-generic table (org-combine-plists params2 params))))@end group@end lispAs you can see, the properties passed into the function (variable@var{PARAMS}) are combined with the ones newly defined in the function(variable @var{PARAMS2}). The ones passed into the function (i.e. theones set by the @samp{ORGTBL SEND} line) take precedence. So if youwould like to use the LaTeX translator, but wanted the line endings tobe @samp{\\[2mm]} instead of the default @samp{\\}, you could justoverrule the default with@example#+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"@end exampleFor a new language, you can either write your own converter function inanalogy with the LaTeX translator, or you can use the generic functiondirectly. For example, if you have a language where a table is startedwith @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines arestarted with @samp{!BL!}, ended with @samp{!EL!} and where the fieldseparator is a TAB, you could call the generic translator like this (ona single line!):@example#+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL! " :lend " !EL!" :sep "\t"@end example@noindentPlease check the documentation string of the function@code{orgtbl-to-generic} for a full list of parameters understood bythat function and remember that you can pass each of them into@code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other functionusing the generic function.Of course you can also write a completely new function doing complicatedthings the generic translator cannot do. A translator function takestwo arguments. The first argument is the table, a list of lines, eachline either the symbol @code{hline} or a list of fields. The secondargument is the property list containing all parameters specified in the@samp{#+ORGTBL: SEND} line. The function must return a single stringcontaining the formatted table. If you write a generally usefultranslator, please post it on @code{emacs-orgmode@@gnu.org} so thatothers can benefit from your work.@node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Extensions and Hacking@section Dynamic blocks@cindex dynamic blocksOrg-mode documents can contain @emph{dynamic blocks}. These arespecially marked regions that are updated by some user-written function.A good example for such a block is the clock table inserted by thecommand @kbd{C-c C-x C-r} (@pxref{Clocking work time}).Dynamic block are enclosed by a BEGIN-END structure that assigns a nameto the block and can also specify parameters for the function producingthe content of the block.@example#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...#+END:@end exampleDynamic blocks are updated with the following commands@table @kbd@kindex C-c C-x C-u@item C-c C-x C-uUpdate dynamic block at point.@kindex C-u C-c C-x C-u@item C-u C-c C-x C-uUpdate all dynamic blocks in the current file.@end tableUpdating a dynamic block means to remove all the text between BEGIN andEND, parse the BEGIN line for parameters and then call the specificwriter function for this block to insert the new content. For a blockwith name @code{myblock}, the writer function is@code{org-dblock-write:myblock} with as only parameter a property listwith the parameters given in the begin line. Here is a trivial exampleof a block that keeps track of when the block update function was lastrun:@example#+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"#+END:@end example@noindentThe corresponding block writer function could look like this:@lisp(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)))))@end lispIf 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, forexample @code{before-save-hook}. @code{org-update-all-dblocks} iswritten in a way that is does nothing in buffers that are not in Org-mode.@node Special agenda views, , Dynamic blocks, Extensions and Hacking@section Special Agenda Views@cindex agenda views, user-definedOrg-mode provides a special hook that can be used to narrow down theselection made by any of the agenda views. You may specify a functionthat is used at each match to verify if the match should indeed be partof 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 WAITINGtag anywhere in the project tree. Let's further assume that you havemarked all tree headings that define a project with the todo keywordPROJECT. In this case you would run a todo search for the keywordPROJECT, but skip the match unless there is a WAITING tag anywhere inthe subtree belonging to the project line.To achieve this, you must write a function that searches the subtree forthe tag. If the tag is found, the function must return @code{nil} toindicate that this match should not be skipped. If there is no suchtag, return the location of the end of the subtree, to indicate thatsearch should continue from there.@lisp(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@end lispFurthermore you must write a command that uses @code{let} to temporarilyput this function into the variable @code{org-agenda-skip-function},sets the header string for the agenda buffer, and calls the todo-listgenerator while asking for the specific TODO keyword PROJECT. Thefunction must also accept one argument MATCH, but it can choose toignore it@footnote{MATCH must be present in case you want to define acustom command for producing this special list. Custom commands alwayssupply the MATCH argument, but it can be empty if you do not specify itwhile defining the command(@pxref{Custom agendaviews}).} (as we do in the example below). Here is the example:@lisp(defun my-org-waiting-projects (&optional match) "Produce a list of projects that contain a WAITING tag.MATCH is being ignored." (interactive) (let ((org-agenda-skip-function 'my-skip-unless-waiting) (org-agenda-overriding-header "Projects waiting for something: ")) ;; make the list (org-todo-list "PROJECT")))@end lisp@node History and Acknowledgments, GNU Free Documentation License, Extensions and Hacking, Top@appendix History and Acknowledgments@cindex acknowledgments@cindex history@cindex thanksOrg-mode was borne in 2003, out of frustration over the user interfaceof the Emacs outline-mode. I was trying to organize my notes andprojects, and using Emacs seemed to be the natural way to go. However,having to remember eleven different commands with two or three keys percommand, only to hide and unhide parts of the outline tree, that seemedentirely unacceptable to me. Also, when using outlines to take notes, Iconstantly want to restructure the tree, organizing it parallel to mythoughts and plans. @emph{Visibility cycling} and @emph{structureediting} were originally implemented in the package@file{outline-magic.el}, but quickly moved to the more general@file{org.el}. As this environment became comfortable for projectplanning, the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and @emph{table support}. These areas highlight the two maingoals that Org-mode still has today: To create a new, outline-based,plain text mode with innovative and intuitive editing features, and toincorporate project planning functionality directly into a notes file.Since the first release, hundreds of emails to me or on@code{emacs-orgmode@@gnu.org} have provided a constant stream of bugreports, feedback, new ideas, and sometimes patches and add-on code.Many thanks to everyone who has helped to improve this package. I amtrying to keep here a list of the people who had significant influencein shaping one or more aspects of Org-mode. The list may not becomplete, if I have forgotten someone, please accept my apologies andlet me know.@itemize @bullet@item@i{Thomas Baumann} contributed the code for links to the MH-E emailsystem.@item@i{Alex Bochannek} provided a patch for rounding time stamps.@item@i{Charles Cave}'s suggestion sparked the implementation of templatesfor Remember.@item@i{Pavel Chalmoviansky} influenced the agenda treatment of items withspecified time.@item@i{Gregory Chernov} patched support for lisp forms into tablecalculations and improved XEmacs compatibility, in particular by porting@file{nouline.el} to XEmacs.@item@i{Sacha Chua} suggested to copy some linking code from Planner.@item@i{Eddward DeVilla} proposed and tested checkbox statistics.@item@i{Kees Dullemond} used to edit projects lists directly in HTML and soinspired some of the early development, including HTML export. He alsoasked for a way to narrow wide table columns.@item@i{Christian Egli} converted the documentation into TeXInfo format,patched CSS formatting into the HTML exporter, and inspired the agenda.@item@i{Nic Ferrier} contributed mailcap and XOXO support.@item@i{John Foerch} figured out how to make incremental search show contextaround a match in a hidden outline tree.@item@i{Niels Giessen} had the idea to automatically archive DONE trees.@item@i{Bastien Guerry} provided extensive feedback and some patches, andtranslated David O'Toole's tutorial into French.@item@i{Kai Grossjohann} pointed out key-binding conflicts with other packages.@item@i{Shidai Liu} (``Leo'') provided extensive feedback and some patches.@item@i{Leon Liu} asked for embedded LaTeX and tested it.@item@i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compilerhappy.@item@i{Todd Neal} provided patches for links to Info files and elisp forms.@item@i{Tim O'Callaghan} suggested in-file links, search options for generalfile links, and TAGS.@item@i{Takeshi Okano} translated the manual and David O'Toole's tutorialinto Japanese.@item@i{Oliver Oppitz} suggested multi-state TODO items.@item@i{Scott Otterson} sparked the introduction of descriptive text forlinks, among other things.@item@i{Pete Phillips} helped during the development of the TAGS feature, andprovided frequent feedback.@item@i{T.V. Raman} reported bugs and suggested improvements.@item@i{Matthias Rempe} (Oelde) provided ideas, Windows support, and qualitycontrol.@item@i{Kevin Rogers} contributed code to access VM files on remote hosts.@item@i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, aconflict with @file{allout.el}.@item@i{Jason Riedy} sent a patch to fix a bug with export of TODO keywords.@item@i{Philip Rooke} created the Org-mode reference card and provided lotsof feedback.@item@i{Christian Schlauer} proposed angular brackets around links, amongother things.@itemLinking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s@file{organizer-mode.el}.@item@i{Daniel Sinder} came up with the idea of internal archiving by lockingsubtrees.@item@i{Dale Smith} proposed link abbreviations.@item@i{David O'Toole} wrote @file{org-publish.el} and drafted the manualchapter about publishing.@item@i{J@"urgen Vollmer} contributed code generating the table of contentsin HTML output.@item@i{Chris Wallace} provided a patch implementing the @samp{QUOTE}keyword.@item@i{David Wainberg} suggested archiving, and improvements to the linkingsystem.@item@i{John Wiegley} wrote @file{emacs-wiki.el} and @file{planner.el}. Thedevelopment of Org-mode was fully independent, and both systems arereally different beasts in their basic ideas and implementation details.I later looked at John's code, however, and learned from hisimplementation of (i) links where the link itself is hidden and only adescription is shown, and (ii) popping up a calendar to select a date.@item@i{Carsten Wimmer} suggested some changes and helped fix a bug inlinking to GNUS.@item@i{Roland Winkler} requested additional keybindings to make Org-modework on a tty.@item@i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocksand contributed various ideas and code snippets.@end itemize@node GNU Free Documentation License, Index, History and Acknowledgments, Top@appendix GNU Free Documentation License@include doclicense.texi@node Index, Key Index, GNU Free Documentation License, Top@unnumbered Index@printindex cp@node Key Index, , Index, Top@unnumbered Key Index@printindex ky@bye@ignore arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac@end ignore