org.texi (Tag groups): Make it explicit that whitespaces are mandatory
[org-mode.git] / doc / org.texi
bloba68f54b268d494c99acb3d44c2131baf5577d2b0
1 \input texinfo
2 @c %**start of header
3 @setfilename ../../info/org
4 @settitle The Org Manual
6 @include org-version.inc
8 @c Use proper quote and backtick for code sections in PDF output
9 @c Cf. Texinfo manual 14.2
10 @set txicodequoteundirected
11 @set txicodequotebacktick
13 @c Version and Contact Info
14 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page}
15 @set AUTHOR Carsten Dominik
16 @set MAINTAINER Bastien Guerry
17 @set MAINTAINEREMAIL @email{bzg at gnu dot org}
18 @set MAINTAINERCONTACT @uref{mailto:bzg at gnu dot org,contact the maintainer}
19 @c %**end of header
20 @finalout
23 @c -----------------------------------------------------------------------------
25 @c Macro definitions for commands and keys
26 @c =======================================
28 @c The behavior of the key/command macros will depend on the flag cmdnames
29 @c When set, commands names are shown.  When clear, they are not shown.
31 @set cmdnames
33 @c Below we define the following macros for Org key tables:
35 @c orgkey{key}                        A key item
36 @c orgcmd{key,cmd}                    Key with command name
37 @c xorgcmd{key,cmd}                   Key with command name as @itemx
38 @c orgcmdnki{key,cmd}                 Like orgcmd, but do not index the key
39 @c orgcmdtkc{text,key,cmd}            Like orgcmd,special text instead of key
40 @c orgcmdkkc{key1,key2,cmd}           Two keys with one command name, use "or"
41 @c orgcmdkxkc{key1,key2,cmd}          Two keys with one command name, but
42 @c                                    different functions, so format as @itemx
43 @c orgcmdkskc{key1,key2,cmd}          Same as orgcmdkkc, but use "or short"
44 @c xorgcmdkskc{key1,key2,cmd}         Same as previous, but use @itemx
45 @c orgcmdkkcc{key1,key2,cmd1,cmd2}    Two keys and two commands
47 @c a key but no command
48 @c    Inserts:    @item key
49 @macro orgkey{key}
50 @kindex \key\
51 @item @kbd{\key\}
52 @end macro
54 @macro xorgkey{key}
55 @kindex \key\
56 @itemx @kbd{\key\}
57 @end macro
59 @c one key with a command
60 @c   Inserts:    @item KEY               COMMAND
61 @macro orgcmd{key,command}
62 @ifset cmdnames
63 @kindex \key\
64 @findex \command\
65 @iftex
66 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
67 @end iftex
68 @ifnottex
69 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
70 @end ifnottex
71 @end ifset
72 @ifclear cmdnames
73 @kindex \key\
74 @item @kbd{\key\}
75 @end ifclear
76 @end macro
78 @c One key with one command, formatted using @itemx
79 @c   Inserts:    @itemx KEY               COMMAND
80 @macro xorgcmd{key,command}
81 @ifset cmdnames
82 @kindex \key\
83 @findex \command\
84 @iftex
85 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
86 @end iftex
87 @ifnottex
88 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
89 @end ifnottex
90 @end ifset
91 @ifclear cmdnames
92 @kindex \key\
93 @itemx @kbd{\key\}
94 @end ifclear
95 @end macro
97 @c one key with a command, bit do not index the key
98 @c   Inserts:    @item KEY               COMMAND
99 @macro orgcmdnki{key,command}
100 @ifset cmdnames
101 @findex \command\
102 @iftex
103 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
104 @end iftex
105 @ifnottex
106 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
107 @end ifnottex
108 @end ifset
109 @ifclear cmdnames
110 @item @kbd{\key\}
111 @end ifclear
112 @end macro
114 @c one key with a command, and special text to replace key in item
115 @c   Inserts:    @item TEXT                    COMMAND
116 @macro orgcmdtkc{text,key,command}
117 @ifset cmdnames
118 @kindex \key\
119 @findex \command\
120 @iftex
121 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
122 @end iftex
123 @ifnottex
124 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
125 @end ifnottex
126 @end ifset
127 @ifclear cmdnames
128 @kindex \key\
129 @item @kbd{\text\}
130 @end ifclear
131 @end macro
133 @c two keys with one command
134 @c   Inserts:    @item KEY1 or KEY2            COMMAND
135 @macro orgcmdkkc{key1,key2,command}
136 @ifset cmdnames
137 @kindex \key1\
138 @kindex \key2\
139 @findex \command\
140 @iftex
141 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
142 @end iftex
143 @ifnottex
144 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
145 @end ifnottex
146 @end ifset
147 @ifclear cmdnames
148 @kindex \key1\
149 @kindex \key2\
150 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
151 @end ifclear
152 @end macro
154 @c Two keys with one command name, but different functions, so format as
155 @c @itemx
156 @c   Inserts:    @item KEY1
157 @c               @itemx KEY2                COMMAND
158 @macro orgcmdkxkc{key1,key2,command}
159 @ifset cmdnames
160 @kindex \key1\
161 @kindex \key2\
162 @findex \command\
163 @iftex
164 @item @kbd{\key1\}
165 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
166 @end iftex
167 @ifnottex
168 @item @kbd{\key1\}
169 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
170 @end ifnottex
171 @end ifset
172 @ifclear cmdnames
173 @kindex \key1\
174 @kindex \key2\
175 @item @kbd{\key1\}
176 @itemx @kbd{\key2\}
177 @end ifclear
178 @end macro
180 @c Same as previous, but use "or short"
181 @c   Inserts:    @item KEY1 or short KEY2            COMMAND
182 @macro orgcmdkskc{key1,key2,command}
183 @ifset cmdnames
184 @kindex \key1\
185 @kindex \key2\
186 @findex \command\
187 @iftex
188 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
189 @end iftex
190 @ifnottex
191 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
192 @end ifnottex
193 @end ifset
194 @ifclear cmdnames
195 @kindex \key1\
196 @kindex \key2\
197 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
198 @end ifclear
199 @end macro
201 @c Same as previous, but use @itemx
202 @c   Inserts:    @itemx KEY1 or short KEY2            COMMAND
203 @macro xorgcmdkskc{key1,key2,command}
204 @ifset cmdnames
205 @kindex \key1\
206 @kindex \key2\
207 @findex \command\
208 @iftex
209 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
210 @end iftex
211 @ifnottex
212 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
213 @end ifnottex
214 @end ifset
215 @ifclear cmdnames
216 @kindex \key1\
217 @kindex \key2\
218 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
219 @end ifclear
220 @end macro
222 @c two keys with two commands
223 @c   Inserts:    @item KEY1                        COMMAND1
224 @c               @itemx KEY2                       COMMAND2
225 @macro orgcmdkkcc{key1,key2,command1,command2}
226 @ifset cmdnames
227 @kindex \key1\
228 @kindex \key2\
229 @findex \command1\
230 @findex \command2\
231 @iftex
232 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
233 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
234 @end iftex
235 @ifnottex
236 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
237 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
238 @end ifnottex
239 @end ifset
240 @ifclear cmdnames
241 @kindex \key1\
242 @kindex \key2\
243 @item @kbd{\key1\}
244 @itemx @kbd{\key2\}
245 @end ifclear
246 @end macro
247 @c -----------------------------------------------------------------------------
249 @iftex
250 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
251 @end iftex
253 @c Subheadings inside a table.
254 @macro tsubheading{text}
255 @ifinfo
256 @subsubheading \text\
257 @end ifinfo
258 @ifnotinfo
259 @item @b{\text\}
260 @end ifnotinfo
261 @end macro
263 @copying
264 This manual is for Org version @value{VERSION}.
266 Copyright @copyright{} 2004--2013 Free Software Foundation, Inc.
268 @quotation
269 Permission is granted to copy, distribute and/or modify this document
270 under the terms of the GNU Free Documentation License, Version 1.3 or
271 any later version published by the Free Software Foundation; with no
272 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
273 and with the Back-Cover Texts as in (a) below.  A copy of the license
274 is included in the section entitled ``GNU Free Documentation License.''
276 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
277 modify this GNU manual.''
278 @end quotation
279 @end copying
281 @dircategory Emacs editing modes
282 @direntry
283 * Org Mode: (org).      Outline-based notes management and organizer
284 @end direntry
286 @titlepage
287 @title The Org Manual
289 @subtitle Release @value{VERSION}
290 @author by Carsten Dominik
291 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan
292 Davison, Eric Schulte, Thomas Dye, Jambunathan K and Nicolas Goaziou.
294 @c The following two commands start the copyright page.
295 @page
296 @vskip 0pt plus 1filll
297 @insertcopying
298 @end titlepage
300 @c Output the table of contents at the beginning.
301 @contents
303 @ifnottex
304 @c FIXME These hand-written next,prev,up node pointers make editing a lot
305 @c harder.  There should be no need for them, makeinfo can do it
306 @c automatically for any document with a normal structure.
307 @node Top, Introduction, (dir), (dir)
308 @top Org Mode Manual
310 @insertcopying
311 @end ifnottex
313 @menu
314 * Introduction::                Getting started
315 * Document Structure::          A tree works like your brain
316 * Tables::                      Pure magic for quick formatting
317 * Hyperlinks::                  Notes in context
318 * TODO Items::                  Every tree branch can be a TODO item
319 * Tags::                        Tagging headlines and matching sets of tags
320 * Properties and Columns::      Storing information about an entry
321 * Dates and Times::             Making items useful for planning
322 * Capture - Refile - Archive::  The ins and outs for projects
323 * Agenda Views::                Collecting information into views
324 * Markup::                      Prepare text for rich export
325 * Exporting::                   Sharing and publishing notes
326 * Publishing::                  Create a web site of linked Org files
327 * Working With Source Code::    Export, evaluate, and tangle code blocks
328 * Miscellaneous::               All the rest which did not fit elsewhere
329 * Hacking::                     How to hack your way around
330 * MobileOrg::                   Viewing and capture on a mobile device
331 * History and Acknowledgments::  How Org came into being
332 * GNU Free Documentation License::  The license for this documentation.
333 * Main Index::                  An index of Org's concepts and features
334 * Key Index::                   Key bindings and where they are described
335 * Command and Function Index::  Command names and some internal functions
336 * Variable Index::              Variables mentioned in the manual
338 @detailmenu
339  --- The Detailed Node Listing ---
341 Introduction
343 * Summary::                     Brief summary of what Org does
344 * Installation::                Installing Org
345 * Activation::                  How to activate Org for certain buffers
346 * Feedback::                    Bug reports, ideas, patches etc.
347 * Conventions::                 Typesetting conventions in the manual
349 Document structure
351 * Outlines::                    Org is based on Outline mode
352 * Headlines::                   How to typeset Org tree headlines
353 * Visibility cycling::          Show and hide, much simplified
354 * Motion::                      Jumping to other headlines
355 * Structure editing::           Changing sequence and level of headlines
356 * Sparse trees::                Matches embedded in context
357 * Plain lists::                 Additional structure within an entry
358 * Drawers::                     Tucking stuff away
359 * Blocks::                      Folding blocks
360 * Footnotes::                   How footnotes are defined in Org's syntax
361 * Orgstruct mode::              Structure editing outside Org
362 * Org syntax::                  Formal description of Org's syntax
364 Visibility cycling
366 * Global and local cycling::    Cycling through various visibility states
367 * Initial visibility::          Setting the initial visibility state
368 * Catching invisible edits::    Preventing mistakes when editing invisible parts
370 Global and local cycling
372 * Initial visibility::          Setting the initial visibility state
373 * Catching invisible edits::    Preventing mistakes when editing invisible parts
375 Tables
377 * Built-in table editor::       Simple tables
378 * Column width and alignment::  Overrule the automatic settings
379 * Column groups::               Grouping to trigger vertical lines
380 * Orgtbl mode::                 The table editor as minor mode
381 * The spreadsheet::             The table editor has spreadsheet capabilities
382 * Org-Plot::                    Plotting from org tables
384 The spreadsheet
386 * References::                  How to refer to another field or range
387 * Formula syntax for Calc::     Using Calc to compute stuff
388 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
389 * Durations and time values::   How to compute durations and time values
390 * Field and range formulas::    Formula for specific (ranges of) fields
391 * Column formulas::             Formulas valid for an entire column
392 * Lookup functions::            Lookup functions for searching tables
393 * Editing and debugging formulas::  Fixing formulas
394 * Updating the table::          Recomputing all dependent fields
395 * Advanced features::           Field and column names, parameters and automatic recalc
397 Hyperlinks
399 * Link format::                 How links in Org are formatted
400 * Internal links::              Links to other places in the current file
401 * External links::              URL-like links to the world
402 * Handling links::              Creating, inserting and following
403 * Using links outside Org::     Linking from my C source code?
404 * Link abbreviations::          Shortcuts for writing complex links
405 * Search options::              Linking to a specific location
406 * Custom searches::             When the default search is not enough
408 Internal links
410 * Radio targets::               Make targets trigger links in plain text
412 TODO items
414 * TODO basics::                 Marking and displaying TODO entries
415 * TODO extensions::             Workflow and assignments
416 * Progress logging::            Dates and notes for progress
417 * Priorities::                  Some things are more important than others
418 * Breaking down tasks::         Splitting a task into manageable pieces
419 * Checkboxes::                  Tick-off lists
421 Extended use of TODO keywords
423 * Workflow states::             From TODO to DONE in steps
424 * TODO types::                  I do this, Fred does the rest
425 * Multiple sets in one file::   Mixing it all, and still finding your way
426 * Fast access to TODO states::  Single letter selection of a state
427 * Per-file keywords::           Different files, different requirements
428 * Faces for TODO keywords::     Highlighting states
429 * TODO dependencies::           When one task needs to wait for others
431 Progress logging
433 * Closing items::               When was this entry marked DONE?
434 * Tracking TODO state changes::  When did the status change?
435 * Tracking your habits::        How consistent have you been?
437 Tags
439 * Tag inheritance::             Tags use the tree structure of the outline
440 * Setting tags::                How to assign tags to a headline
441 * Tag groups::                  Use one tag to search for several tags
442 * Tag searches::                Searching for combinations of tags
444 Properties and columns
446 * Property syntax::             How properties are spelled out
447 * Special properties::          Access to other Org mode features
448 * Property searches::           Matching property values
449 * Property inheritance::        Passing values down the tree
450 * Column view::                 Tabular viewing and editing
451 * Property API::                Properties for Lisp programmers
453 Column view
455 * Defining columns::            The COLUMNS format property
456 * Using column view::           How to create and use column view
457 * Capturing column view::       A dynamic block for column view
459 Defining columns
461 * Scope of column definitions::  Where defined, where valid?
462 * Column attributes::           Appearance and content of a column
464 Dates and times
466 * Timestamps::                  Assigning a time to a tree entry
467 * Creating timestamps::         Commands which insert timestamps
468 * Deadlines and scheduling::    Planning your work
469 * Clocking work time::          Tracking how long you spend on a task
470 * Effort estimates::            Planning work effort in advance
471 * Relative timer::              Notes with a running timer
472 * Countdown timer::             Starting a countdown timer for a task
474 Creating timestamps
476 * The date/time prompt::        How Org mode helps you entering date and time
477 * Custom time format::          Making dates look different
479 Deadlines and scheduling
481 * Inserting deadline/schedule::  Planning items
482 * Repeated tasks::              Items that show up again and again
484 Clocking work time
486 * Clocking commands::           Starting and stopping a clock
487 * The clock table::             Detailed reports
488 * Resolving idle time::         Resolving time when you've been idle
490 Capture - Refile - Archive
492 * Capture::                     Capturing new stuff
493 * Attachments::                 Add files to tasks
494 * RSS Feeds::                   Getting input from RSS feeds
495 * Protocols::                   External (e.g., Browser) access to Emacs and Org
496 * Refile and copy::             Moving/copying a tree from one place to another
497 * Archiving::                   What to do with finished projects
499 Capture
501 * Setting up capture::          Where notes will be stored
502 * Using capture::               Commands to invoke and terminate capture
503 * Capture templates::           Define the outline of different note types
505 Capture templates
507 * Template elements::           What is needed for a complete template entry
508 * Template expansion::          Filling in information about time and context
509 * Templates in contexts::       Only show a template in a specific context
511 Archiving
513 * Moving subtrees::             Moving a tree to an archive file
514 * Internal archiving::          Switch off a tree but keep it in the file
516 Agenda views
518 * Agenda files::                Files being searched for agenda information
519 * Agenda dispatcher::           Keyboard access to agenda views
520 * Built-in agenda views::       What is available out of the box?
521 * Presentation and sorting::    How agenda items are prepared for display
522 * Agenda commands::             Remote editing of Org trees
523 * Custom agenda views::         Defining special searches and views
524 * Exporting Agenda Views::      Writing a view to a file
525 * Agenda column view::          Using column view for collected entries
527 The built-in agenda views
529 * Weekly/daily agenda::         The calendar page with current tasks
530 * Global TODO list::            All unfinished action items
531 * Matching tags and properties::  Structured information with fine-tuned search
532 * Timeline::                    Time-sorted view for single file
533 * Search view::                 Find entries by searching for text
534 * Stuck projects::              Find projects you need to review
536 Presentation and sorting
538 * Categories::                  Not all tasks are equal
539 * Time-of-day specifications::  How the agenda knows the time
540 * Sorting agenda items::        The order of things
541 * Filtering/limiting agenda items:: Dynamically narrow the agenda
543 Custom agenda views
545 * Storing searches::            Type once, use often
546 * Block agenda::                All the stuff you need in a single buffer
547 * Setting Options::             Changing the rules
549 Markup for rich export
551 * Structural markup elements::  The basic structure as seen by the exporter
552 * Images and tables::           Images, tables and caption mechanism
553 * Literal examples::            Source code examples with special formatting
554 * Include files::               Include additional files into a document
555 * Index entries::               Making an index
556 * Macro replacement::           Use macros to create complex output
557 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
559 Structural markup elements
561 * Document title::              Where the title is taken from
562 * Headings and sections::       The document structure as seen by the exporter
563 * Table of contents::           The if and where of the table of contents
564 * Lists::                       Lists
565 * Paragraphs::                  Paragraphs
566 * Footnote markup::             Footnotes
567 * Emphasis and monospace::      Bold, italic, etc.
568 * Horizontal rules::            Make a line
569 * Comment lines::               What will *not* be exported
571 Embedded @LaTeX{}
573 * Special symbols::             Greek letters and other symbols
574 * Subscripts and superscripts::  Simple syntax for raising/lowering text
575 * @LaTeX{} fragments::          Complex formulas made easy
576 * Previewing @LaTeX{} fragments::  What will this snippet look like?
577 * CDLaTeX mode::                Speed up entering of formulas
579 Exporting
581 * The Export Dispatcher::       The main exporter interface
582 * Export formats::              Available export formats
583 * Export settings::             Generic export settings
584 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
585 * HTML export::                 Exporting to HTML
586 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
587 * OpenDocument Text export::    Exporting to OpenDocument Text
588 * iCalendar export::            Exporting in iCalendar format
590 HTML export
592 * HTML Export commands::        How to invoke HTML export
593 * HTML preamble and postamble::  How to insert a preamble and a postamble
594 * Quoting HTML tags::           Using direct HTML in Org mode
595 * Links in HTML export::        How links will be interpreted and formatted
596 * Tables in HTML export::       How to modify the formatting of tables
597 * Images in HTML export::       How to insert figures into HTML output
598 * Math formatting in HTML export::  Beautiful math also on the web
599 * Text areas in HTML export::   An alternative way to show an example
600 * CSS support::                 Changing the appearance of the output
601 * JavaScript support::          Info and Folding in a web browser
603 @LaTeX{} and PDF export
605 * @LaTeX{}/PDF export commands::
606 * Header and sectioning::       Setting up the export file structure
607 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
608 * @LaTeX{} specific attributes::  Controlling @LaTeX{} output
609 * Beamer class export::         Turning the file into a presentation
611 OpenDocument Text export
613 * Pre-requisites for ODT export::  What packages ODT exporter relies on
614 * ODT export commands::         How to invoke ODT export
615 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
616 * Applying custom styles::      How to apply custom styles to the output
617 * Links in ODT export::         How links will be interpreted and formatted
618 * Tables in ODT export::        How Tables are exported
619 * Images in ODT export::        How to insert images
620 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
621 * Labels and captions in ODT export::  How captions are rendered
622 * Literal examples in ODT export::  How source and example blocks are formatted
623 * Advanced topics in ODT export::  Read this if you are a power user
625 Math formatting in ODT export
627 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
628 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
630 Advanced topics in ODT export
632 * Configuring a document converter::  How to register a document converter
633 * Working with OpenDocument style files::  Explore the internals
634 * Creating one-off styles::     How to produce custom highlighting etc
635 * Customizing tables in ODT export::  How to define and use Table templates
636 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
638 Publishing
640 * Configuration::               Defining projects
641 * Uploading files::             How to get files up on the server
642 * Sample configuration::        Example projects
643 * Triggering publication::      Publication commands
645 Configuration
647 * Project alist::               The central configuration variable
648 * Sources and destinations::    From here to there
649 * Selecting files::             What files are part of the project?
650 * Publishing action::           Setting the function doing the publishing
651 * Publishing options::          Tweaking HTML/@LaTeX{} export
652 * Publishing links::            Which links keep working after publishing?
653 * Sitemap::                     Generating a list of all pages
654 * Generating an index::         An index that reaches across pages
656 Sample configuration
658 * Simple example::              One-component publishing
659 * Complex example::             A multi-component publishing example
661 Working with source code
663 * Structure of code blocks::    Code block syntax described
664 * Editing source code::         Language major-mode editing
665 * Exporting code blocks::       Export contents and/or results
666 * Extracting source code::      Create pure source code files
667 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
668 * Library of Babel::            Use and contribute to a library of useful code blocks
669 * Languages::                   List of supported code block languages
670 * Header arguments::            Configure code block functionality
671 * Results of evaluation::       How evaluation results are handled
672 * Noweb reference syntax::      Literate programming in Org mode
673 * Key bindings and useful functions::  Work quickly with code blocks
674 * Batch execution::             Call functions from the command line
676 Header arguments
678 * Using header arguments::      Different ways to set header arguments
679 * Specific header arguments::   List of header arguments
681 Using header arguments
683 * System-wide header arguments::  Set global default values
684 * Language-specific header arguments::  Set default values by language
685 * Buffer-wide header arguments::  Set default values for a specific buffer
686 * Header arguments in Org mode properties::  Set default values for a buffer or heading
687 * Code block specific header arguments::  The most common way to set values
688 * Header arguments in function calls::  The most specific level
690 Specific header arguments
692 * var::                         Pass arguments to code blocks
693 * results::                     Specify the type of results and how they will
694                                 be collected and handled
695 * file::                        Specify a path for file output
696 * file-desc::                   Specify a description for file results
697 * dir::                         Specify the default (possibly remote)
698                                 directory for code block execution
699 * exports::                     Export code and/or results
700 * tangle::                      Toggle tangling and specify file name
701 * mkdirp::                      Toggle creation of parent directories of target
702                                 files during tangling
703 * comments::                    Toggle insertion of comments in tangled
704                                 code files
705 * padline::                     Control insertion of padding lines in tangled
706                                 code files
707 * no-expand::                   Turn off variable assignment and noweb
708                                 expansion during tangling
709 * session::                     Preserve the state of code evaluation
710 * noweb::                       Toggle expansion of noweb references
711 * noweb-ref::                   Specify block's noweb reference resolution target
712 * noweb-sep::                   String used to separate noweb references
713 * cache::                       Avoid re-evaluating unchanged code blocks
714 * sep::                         Delimiter for writing tabular results outside Org
715 * hlines::                      Handle horizontal lines in tables
716 * colnames::                    Handle column names in tables
717 * rownames::                    Handle row names in tables
718 * shebang::                     Make tangled files executable
719 * eval::                        Limit evaluation of specific code blocks
720 * wrap::                        Mark source block evaluation results
721 * post::                        Post processing of code block results
723 Miscellaneous
725 * Completion::                  M-TAB knows what you need
726 * Easy Templates::              Quick insertion of structural elements
727 * Speed keys::                  Electric commands at the beginning of a headline
728 * Code evaluation security::    Org mode files evaluate inline code
729 * Customization::               Adapting Org to your taste
730 * In-buffer settings::          Overview of the #+KEYWORDS
731 * The very busy C-c C-c key::   When in doubt, press C-c C-c
732 * Clean view::                  Getting rid of leading stars in the outline
733 * TTY keys::                    Using Org on a tty
734 * Interaction::                 Other Emacs packages
735 * org-crypt.el::                Encrypting Org files
737 Interaction with other packages
739 * Cooperation::                 Packages Org cooperates with
740 * Conflicts::                   Packages that lead to conflicts
742 Hacking
744 * Hooks::                       How to reach into Org's internals
745 * Add-on packages::             Available extensions
746 * Adding hyperlink types::      New custom link types
747 * Adding export back-ends::     How to write new export back-ends
748 * Context-sensitive commands::  How to add functionality to such commands
749 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
750 * Dynamic blocks::              Automatically filled blocks
751 * Special agenda views::        Customized views
752 * Speeding up your agendas::    Tips on how to speed up your agendas
753 * Extracting agenda information::  Post-processing of agenda information
754 * Using the property API::      Writing programs that use entry properties
755 * Using the mapping API::       Mapping over all or selected entries
757 Tables and lists in arbitrary syntax
759 * Radio tables::                Sending and receiving radio tables
760 * A @LaTeX{} example::          Step by step, almost a tutorial
761 * Translator functions::        Copy and modify
762 * Radio lists::                 Doing the same for lists
764 MobileOrg
766 * Setting up the staging area::  Where to interact with the mobile device
767 * Pushing to MobileOrg::        Uploading Org files and agendas
768 * Pulling from MobileOrg::      Integrating captured and flagged items
770 @end detailmenu
771 @end menu
773 @node Introduction, Document Structure, Top, Top
774 @chapter Introduction
775 @cindex introduction
777 @menu
778 * Summary::                     Brief summary of what Org does
779 * Installation::                Installing Org
780 * Activation::                  How to activate Org for certain buffers
781 * Feedback::                    Bug reports, ideas, patches etc.
782 * Conventions::                 Typesetting conventions in the manual
783 @end menu
785 @node Summary, Installation, Introduction, Introduction
786 @section Summary
787 @cindex summary
789 Org is a mode for keeping notes, maintaining TODO lists, and doing
790 project planning with a fast and effective plain-text system.
792 Org develops organizational tasks around NOTES files that contain
793 lists or information about projects as plain text.  Org is
794 implemented on top of Outline mode, which makes it possible to keep the
795 content of large files well structured.  Visibility cycling and
796 structure editing help to work with the tree.  Tables are easily created
797 with a built-in table editor.  Org supports TODO items, deadlines,
798 timestamps, and scheduling.  It dynamically compiles entries into an
799 agenda that utilizes and smoothly integrates much of the Emacs calendar
800 and diary.  Plain text URL-like links connect to websites, emails,
801 Usenet messages, BBDB entries, and any files related to the projects.
802 For printing and sharing notes, an Org file can be exported as a
803 structured ASCII file, as HTML, or (TODO and agenda items only) as an
804 iCalendar file.  It can also serve as a publishing tool for a set of
805 linked web pages.
807 As a project planning environment, Org works by adding metadata to outline
808 nodes.  Based on this data, specific entries can be extracted in queries and
809 create dynamic @i{agenda views}.
811 Org mode contains the Org Babel environment which allows you to work with
812 embedded source code blocks in a file, to facilitate code evaluation,
813 documentation, and literate programming techniques.
815 Org's automatic, context-sensitive table editor with spreadsheet
816 capabilities can be integrated into any major mode by activating the
817 minor Orgtbl mode.  Using a translation step, it can be used to maintain
818 tables in arbitrary file types, for example in @LaTeX{}.  The structure
819 editing and list creation capabilities can be used outside Org with
820 the minor Orgstruct mode.
822 Org keeps simple things simple.  When first fired up, it should
823 feel like a straightforward, easy to use outliner.  Complexity is not
824 imposed, but a large amount of functionality is available when you need
825 it.  Org is a toolbox and can be used in different ways and for different
826 ends, for example:
828 @example
829 @r{@bullet{} an outline extension with visibility cycling and structure editing}
830 @r{@bullet{} an ASCII system and table editor for taking structured notes}
831 @r{@bullet{} a TODO list editor}
832 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
833 @pindex GTD, Getting Things Done
834 @r{@bullet{} an environment in which to implement David Allen's GTD system}
835 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
836 @r{@bullet{} a publishing tool to create a set of interlinked web pages}
837 @r{@bullet{} an environment for literate programming}
838 @end example
840 @cindex FAQ
841 There is a website for Org which provides links to the newest
842 version of Org, as well as additional information, frequently asked
843 questions (FAQ), links to tutorials, etc.  This page is located at
844 @uref{http://orgmode.org}.
846 @cindex print edition
847 The version 7.3 of this manual is available as a
848 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
849 Theory Ltd.}
851 @page
854 @node Installation, Activation, Summary, Introduction
855 @section Installation
856 @cindex installation
857 @cindex XEmacs
859 Org is part of recent distributions of GNU Emacs, so you normally don't need
860 to install it.  If, for one reason or another, you want to install Org on top
861 of this pre-packaged version, there are three ways to do it:
863 @itemize @bullet
864 @item By using Emacs package system.
865 @item By downloading Org as an archive.
866 @item By using Org's git repository.
867 @end itemize
869 We @b{strongly recommend} to stick to a single installation method.
871 @subsubheading Using Emacs packaging system
873 Recent Emacs distributions include a packaging system which lets you install
874 Elisp libraries.  You can install Org with @kbd{M-x package-install RET org}.
875 You need to do this in a session where no @code{.org} file has been visited.
876 Then, to make sure your Org configuration is taken into account, initialize
877 the package system with @code{(package-initialize)} in your @file{.emacs}
878 before setting any Org option.  If you want to use Org's package repository,
879 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
881 @subsubheading Downloading Org as an archive
883 You can download Org latest release from @uref{http://orgmode.org/, Org's
884 website}.  In this case, make sure you set the load-path correctly in your
885 @file{.emacs}:
887 @lisp
888 (add-to-list 'load-path "~/path/to/orgdir/lisp")
889 @end lisp
891 The downloaded archive contains contributed libraries that are not included
892 in Emacs.  If you want to use them, add the @file{contrib} directory to your
893 load-path:
895 @lisp
896 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
897 @end lisp
899 Optionally, you can compile the files and/or install them in your system.
900 Run @code{make help} to list compilation and installation options.
902 @subsubheading Using Org's git repository
904 You can clone Org's repository and install Org like this:
906 @example
907 $ cd ~/src/
908 $ git clone git://orgmode.org/org-mode.git
909 $ make autoloads
910 @end example
912 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
913 version in @file{org-version.el} and Org's autoloads in
914 @file{org-loaddefs.el}.
916 Remember to add the correct load-path as described in the method above.
918 You can also compile with @code{make}, generate the documentation with
919 @code{make doc}, create a local configuration with @code{make config} and
920 install Org with @code{make install}.  Please run @code{make help} to get
921 the list of compilation/installation options.
923 For more detailed explanations on Org's build system, please check the Org
924 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
925 Worg}.
927 @node Activation, Feedback, Installation, Introduction
928 @section Activation
929 @cindex activation
930 @cindex autoload
931 @cindex ELPA
932 @cindex global key bindings
933 @cindex key bindings, global
934 @findex org-agenda
935 @findex org-capture
936 @findex org-store-link
937 @findex org-iswitchb
939 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
940 default.  If you are using an earlier version of Emacs, add this line to your
941 @file{.emacs} file:
943 @lisp
944 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
945 @end lisp
947 Org mode buffers need font-lock to be turned on: this is the default in
948 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
949 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
951 There are compatibility issues between Org mode and some other Elisp
952 packages, please take the time to check the list (@pxref{Conflicts}).
954 The four Org commands @command{org-store-link}, @command{org-capture},
955 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
956 global keys (i.e., anywhere in Emacs, not just in Org buffers).  Here are
957 suggested bindings for these keys, please modify the keys to your own
958 liking.
959 @lisp
960 (global-set-key "\C-cl" 'org-store-link)
961 (global-set-key "\C-cc" 'org-capture)
962 (global-set-key "\C-ca" 'org-agenda)
963 (global-set-key "\C-cb" 'org-iswitchb)
964 @end lisp
966 @cindex Org mode, turning on
967 With this setup, all files with extension @samp{.org} will be put
968 into Org mode.  As an alternative, make the first line of a file look
969 like this:
971 @example
972 MY PROJECTS    -*- mode: org; -*-
973 @end example
975 @vindex org-insert-mode-line-in-empty-file
976 @noindent which will select Org mode for this buffer no matter what
977 the file's name is.  See also the variable
978 @code{org-insert-mode-line-in-empty-file}.
980 Many commands in Org work on the region if the region is @i{active}.  To make
981 use of this, you need to have @code{transient-mark-mode}
982 (@code{zmacs-regions} in XEmacs) turned on.  In Emacs 23 this is the default,
983 in Emacs 22 you need to do this yourself with
984 @lisp
985 (transient-mark-mode 1)
986 @end lisp
987 @noindent If you do not like @code{transient-mark-mode}, you can create an
988 active region by using the mouse to select a region, or pressing
989 @kbd{C-@key{SPC}} twice before moving the cursor.
991 @node Feedback, Conventions, Activation, Introduction
992 @section Feedback
993 @cindex feedback
994 @cindex bug reports
995 @cindex maintainer
996 @cindex author
998 If you find problems with Org, or if you have questions, remarks, or ideas
999 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1000 If you are not a member of the mailing list, your mail will be passed to the
1001 list after a moderator has approved it@footnote{Please consider subscribing
1002 to the mailing list, in order to minimize the work the mailing list
1003 moderators have to do.}.
1005 For bug reports, please first try to reproduce the bug with the latest
1006 version of Org available---if you are running an outdated version, it is
1007 quite possible that the bug has been fixed already.  If the bug persists,
1008 prepare a report and provide as much information as possible, including the
1009 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1010 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
1011 @file{.emacs}.  The easiest way to do this is to use the command
1012 @example
1013 @kbd{M-x org-submit-bug-report}
1014 @end example
1015 @noindent which will put all this information into an Emacs mail buffer so
1016 that you only need to add your description.  If you re not sending the Email
1017 from within Emacs, please copy and paste the content into your Email program.
1019 Sometimes you might face a problem due to an error in your Emacs or Org mode
1020 setup.  Before reporting a bug, it is very helpful to start Emacs with minimal
1021 customizations and reproduce the problem.  Doing so often helps you determine
1022 if the problem is with your customization or with Org mode itself.  You can
1023 start a typical minimal session with a command like the example below.
1025 @example
1026 $ emacs -Q -l /path/to/minimal-org.el
1027 @end example
1029 However if you are using Org mode as distributed with Emacs, a minimal setup
1030 is not necessary.  In that case it is sufficient to start Emacs as
1031 @code{emacs -Q}.  The @code{minimal-org.el} setup file can have contents as
1032 shown below.
1034 @lisp
1035 ;;; Minimal setup to load latest `org-mode'
1037 ;; activate debugging
1038 (setq debug-on-error t
1039       debug-on-signal nil
1040       debug-on-quit nil)
1042 ;; add latest org-mode to load path
1043 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1044 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1045 @end lisp
1047 If an error occurs, a backtrace can be very useful (see below on how to
1048 create one).  Often a small example file helps, along with clear information
1049 about:
1051 @enumerate
1052 @item What exactly did you do?
1053 @item What did you expect to happen?
1054 @item What happened instead?
1055 @end enumerate
1056 @noindent Thank you for helping to improve this program.
1058 @subsubheading How to create a useful backtrace
1060 @cindex backtrace of an error
1061 If working with Org produces an error with a message you don't
1062 understand, you may have hit a bug.  The best way to report this is by
1063 providing, in addition to what was mentioned above, a @emph{backtrace}.
1064 This is information from the built-in debugger about where and how the
1065 error occurred.  Here is how to produce a useful backtrace:
1067 @enumerate
1068 @item
1069 Reload uncompiled versions of all Org mode Lisp files.  The backtrace
1070 contains much more information if it is produced with uncompiled code.
1071 To do this, use
1072 @example
1073 C-u M-x org-reload RET
1074 @end example
1075 @noindent
1076 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1077 menu.
1078 @item
1079 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1080 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1081 @item
1082 Do whatever you have to do to hit the error.  Don't forget to
1083 document the steps you take.
1084 @item
1085 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1086 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
1087 attach it to your bug report.
1088 @end enumerate
1090 @node Conventions,  , Feedback, Introduction
1091 @section Typesetting conventions used in this manual
1093 @subsubheading TODO keywords, tags, properties, etc.
1095 Org mainly uses three types of keywords: TODO keywords, tags and property
1096 names.  In this manual we use the following conventions:
1098 @table @code
1099 @item TODO
1100 @itemx WAITING
1101 TODO keywords are written with all capitals, even if they are
1102 user-defined.
1103 @item boss
1104 @itemx ARCHIVE
1105 User-defined tags are written in lowercase; built-in tags with special
1106 meaning are written with all capitals.
1107 @item Release
1108 @itemx PRIORITY
1109 User-defined properties are capitalized; built-in properties with
1110 special meaning are written with all capitals.
1111 @end table
1113 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1114 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1115 environment).  They are written in uppercase in the manual to enhance its
1116 readability, but you can use lowercase in your Org files@footnote{Easy
1117 templates insert lowercase keywords and Babel dynamically inserts
1118 @code{#+results}.}
1120 @subsubheading Keybindings and commands
1121 @kindex C-c a
1122 @findex org-agenda
1123 @kindex C-c c
1124 @findex org-capture
1126 The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda}
1127 and @kbd{C-c c} for @code{org-capture}.  These are only suggestions, but the
1128 rest of the manual assumes that you are using these keybindings.
1130 Also, the manual lists both the keys and the corresponding commands for
1131 accessing a functionality.  Org mode often uses the same key for different
1132 functions, depending on context.  The command that is bound to such keys has
1133 a generic name, like @code{org-metaright}.  In the manual we will, wherever
1134 possible, give the function that is internally called by the generic command.
1135 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1136 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1137 will be listed to call @code{org-table-move-column-right}.  If you prefer,
1138 you can compile the manual without the command names by unsetting the flag
1139 @code{cmdnames} in @file{org.texi}.
1141 @node Document Structure, Tables, Introduction, Top
1142 @chapter Document structure
1143 @cindex document structure
1144 @cindex structure of document
1146 Org is based on Outline mode and provides flexible commands to
1147 edit the structure of the document.
1149 @menu
1150 * Outlines::                    Org is based on Outline mode
1151 * Headlines::                   How to typeset Org tree headlines
1152 * Visibility cycling::          Show and hide, much simplified
1153 * Motion::                      Jumping to other headlines
1154 * Structure editing::           Changing sequence and level of headlines
1155 * Sparse trees::                Matches embedded in context
1156 * Plain lists::                 Additional structure within an entry
1157 * Drawers::                     Tucking stuff away
1158 * Blocks::                      Folding blocks
1159 * Footnotes::                   How footnotes are defined in Org's syntax
1160 * Orgstruct mode::              Structure editing outside Org
1161 * Org syntax::                  Formal description of Org's syntax
1162 @end menu
1164 @node Outlines, Headlines, Document Structure, Document Structure
1165 @section Outlines
1166 @cindex outlines
1167 @cindex Outline mode
1169 Org is implemented on top of Outline mode.  Outlines allow a
1170 document to be organized in a hierarchical structure, which (at least
1171 for me) is the best representation of notes and thoughts.  An overview
1172 of this structure is achieved by folding (hiding) large parts of the
1173 document to show only the general document structure and the parts
1174 currently being worked on.  Org greatly simplifies the use of
1175 outlines by compressing the entire show/hide functionality into a single
1176 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1178 @node Headlines, Visibility cycling, Outlines, Document Structure
1179 @section Headlines
1180 @cindex headlines
1181 @cindex outline tree
1182 @vindex org-special-ctrl-a/e
1183 @vindex org-special-ctrl-k
1184 @vindex org-ctrl-k-protect-subtree
1186 Headlines define the structure of an outline tree.  The headlines in Org
1187 start with one or more stars, on the left margin@footnote{See the variables
1188 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1189 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1190 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1191 headings indented less then 30 stars.}.  For example:
1193 @example
1194 * Top level headline
1195 ** Second level
1196 *** 3rd level
1197     some text
1198 *** 3rd level
1199     more text
1201 * Another top level headline
1202 @end example
1204 @noindent Some people find the many stars too noisy and would prefer an
1205 outline that has whitespace followed by a single star as headline
1206 starters.  @ref{Clean view}, describes a setup to realize this.
1208 @vindex org-cycle-separator-lines
1209 An empty line after the end of a subtree is considered part of it and
1210 will be hidden when the subtree is folded.  However, if you leave at
1211 least two empty lines, one empty line will remain visible after folding
1212 the subtree, in order to structure the collapsed view.  See the
1213 variable @code{org-cycle-separator-lines} to modify this behavior.
1215 @node Visibility cycling, Motion, Headlines, Document Structure
1216 @section Visibility cycling
1217 @cindex cycling, visibility
1218 @cindex visibility cycling
1219 @cindex trees, visibility
1220 @cindex show hidden text
1221 @cindex hide text
1223 @menu
1224 * Global and local cycling::    Cycling through various visibility states
1225 * Initial visibility::          Setting the initial visibility state
1226 * Catching invisible edits::    Preventing mistakes when editing invisible parts
1227 @end menu
1229 @node Global and local cycling, Initial visibility, Visibility cycling, Visibility cycling
1230 @subsection Global and local cycling
1232 Outlines make it possible to hide parts of the text in the buffer.
1233 Org uses just two commands, bound to @key{TAB} and
1234 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1236 @cindex subtree visibility states
1237 @cindex subtree cycling
1238 @cindex folded, subtree visibility state
1239 @cindex children, subtree visibility state
1240 @cindex subtree, subtree visibility state
1241 @table @asis
1242 @orgcmd{@key{TAB},org-cycle}
1243 @emph{Subtree cycling}: Rotate current subtree among the states
1245 @example
1246 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1247 '-----------------------------------'
1248 @end example
1250 @vindex org-cycle-emulate-tab
1251 @vindex org-cycle-global-at-bob
1252 The cursor must be on a headline for this to work@footnote{see, however,
1253 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
1254 beginning of the buffer and the first line is not a headline, then
1255 @key{TAB} actually runs global cycling (see below)@footnote{see the
1256 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
1257 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1259 @cindex global visibility states
1260 @cindex global cycling
1261 @cindex overview, global visibility state
1262 @cindex contents, global visibility state
1263 @cindex show all, global visibility state
1264 @orgcmd{S-@key{TAB},org-global-cycle}
1265 @itemx C-u @key{TAB}
1266 @emph{Global cycling}: Rotate the entire buffer among the states
1268 @example
1269 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1270 '--------------------------------------'
1271 @end example
1273 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1274 CONTENTS view up to headlines of level N will be shown.  Note that inside
1275 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1277 @cindex show all, command
1278 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1279 Show all, including drawers.
1280 @cindex revealing context
1281 @orgcmd{C-c C-r,org-reveal}
1282 Reveal context around point, showing the current entry, the following heading
1283 and the hierarchy above.  Useful for working near a location that has been
1284 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1285 (@pxref{Agenda commands}).  With a prefix argument show, on each
1286 level, all sibling headings.  With a double prefix argument, also show the
1287 entire subtree of the parent.
1288 @cindex show branches, command
1289 @orgcmd{C-c C-k,show-branches}
1290 Expose all the headings of the subtree, CONTENT view for just one subtree.
1291 @cindex show children, command
1292 @orgcmd{C-c @key{TAB},show-children}
1293 Expose all direct children of the subtree.  With a numeric prefix argument N,
1294 expose all children down to level N@.
1295 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1296 Show the current subtree in an indirect buffer@footnote{The indirect
1297 buffer
1298 @ifinfo
1299 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1300 @end ifinfo
1301 @ifnotinfo
1302 (see the Emacs manual for more information about indirect buffers)
1303 @end ifnotinfo
1304 will contain the entire buffer, but will be narrowed to the current
1305 tree.  Editing the indirect buffer will also change the original buffer,
1306 but without affecting visibility in that buffer.}.  With a numeric
1307 prefix argument N, go up to level N and then take that tree.  If N is
1308 negative then go up that many levels.  With a @kbd{C-u} prefix, do not remove
1309 the previously used indirect buffer.
1310 @orgcmd{C-c C-x v,org-copy-visible}
1311 Copy the @i{visible} text in the region into the kill ring.
1312 @end table
1314 @menu
1315 * Initial visibility::          Setting the initial visibility state
1316 * Catching invisible edits::    Preventing mistakes when editing invisible parts
1317 @end menu
1319 @node Initial visibility, Catching invisible edits, Global and local cycling, Visibility cycling
1320 @subsection Initial visibility
1322 @cindex visibility, initialize
1323 @vindex org-startup-folded
1324 @vindex org-agenda-inhibit-startup
1325 @cindex @code{overview}, STARTUP keyword
1326 @cindex @code{content}, STARTUP keyword
1327 @cindex @code{showall}, STARTUP keyword
1328 @cindex @code{showeverything}, STARTUP keyword
1330 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1331 i.e., only the top level headlines are visible@footnote{When
1332 @code{org-agenda-inhibit-startup} is non-nil, Org will not honor the default
1333 visibility state when first opening a file for the agenda (@pxref{Speeding up
1334 your agendas}).}  This can be configured through the variable
1335 @code{org-startup-folded}, or on a per-file basis by adding one of the
1336 following lines anywhere in the buffer:
1338 @example
1339 #+STARTUP: overview
1340 #+STARTUP: content
1341 #+STARTUP: showall
1342 #+STARTUP: showeverything
1343 @end example
1345 The startup visibility options are ignored when the file is open for the
1346 first time during the agenda generation: if you want the agenda to honor
1347 the startup visibility, set @code{org-agenda-inhibit-startup} to nil.
1349 @cindex property, VISIBILITY
1350 @noindent
1351 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1352 and Columns}) will get their visibility adapted accordingly.  Allowed values
1353 for this property are @code{folded}, @code{children}, @code{content}, and
1354 @code{all}.
1356 @table @asis
1357 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1358 Switch back to the startup visibility of the buffer, i.e., whatever is
1359 requested by startup options and @samp{VISIBILITY} properties in individual
1360 entries.
1361 @end table
1363 @node Catching invisible edits,  , Initial visibility, Visibility cycling
1364 @subsection Catching invisible edits
1366 @vindex org-catch-invisible-edits
1367 @cindex edits, catching invisible
1368 Sometimes you may inadvertently edit an invisible part of the buffer and be
1369 confused on what as been edited and how to undo the mistake.  Setting
1370 @code{org-catch-invisible-edits} to non-nil will help prevent this.  See the
1371 docstring of this option on how Org should catch invisible edits and process
1372 them.
1374 @node Motion, Structure editing, Visibility cycling, Document Structure
1375 @section Motion
1376 @cindex motion, between headlines
1377 @cindex jumping, to headlines
1378 @cindex headline navigation
1379 The following commands jump to other headlines in the buffer.
1381 @table @asis
1382 @orgcmd{C-c C-n,outline-next-visible-heading}
1383 Next heading.
1384 @orgcmd{C-c C-p,outline-previous-visible-heading}
1385 Previous heading.
1386 @orgcmd{C-c C-f,org-forward-same-level}
1387 Next heading same level.
1388 @orgcmd{C-c C-b,org-backward-same-level}
1389 Previous heading same level.
1390 @orgcmd{C-c C-u,outline-up-heading}
1391 Backward to higher level heading.
1392 @orgcmd{C-c C-j,org-goto}
1393 Jump to a different place without changing the current outline
1394 visibility.  Shows the document structure in a temporary buffer, where
1395 you can use the following keys to find your destination:
1396 @vindex org-goto-auto-isearch
1397 @example
1398 @key{TAB}         @r{Cycle visibility.}
1399 @key{down} / @key{up}   @r{Next/previous visible headline.}
1400 @key{RET}         @r{Select this location.}
1401 @kbd{/}           @r{Do a Sparse-tree search}
1402 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1403 n / p        @r{Next/previous visible headline.}
1404 f / b        @r{Next/previous headline same level.}
1405 u            @r{One level up.}
1406 0-9          @r{Digit argument.}
1407 q            @r{Quit}
1408 @end example
1409 @vindex org-goto-interface
1410 @noindent
1411 See also the variable @code{org-goto-interface}.
1412 @end table
1414 @node Structure editing, Sparse trees, Motion, Document Structure
1415 @section Structure editing
1416 @cindex structure editing
1417 @cindex headline, promotion and demotion
1418 @cindex promotion, of subtrees
1419 @cindex demotion, of subtrees
1420 @cindex subtree, cut and paste
1421 @cindex pasting, of subtrees
1422 @cindex cutting, of subtrees
1423 @cindex copying, of subtrees
1424 @cindex sorting, of subtrees
1425 @cindex subtrees, cut and paste
1427 @table @asis
1428 @orgcmd{M-@key{RET},org-insert-heading}
1429 @vindex org-M-RET-may-split-line
1430 Insert a new heading/item with the same level than the one at point.
1431 If the cursor is in a plain list item, a new item is created
1432 (@pxref{Plain lists}).  To prevent this behavior in lists, call the
1433 command with a prefix argument.  When this command is used in the
1434 middle of a line, the line is split and the rest of the line becomes
1435 the new item or headline@footnote{If you do not want the line to be
1436 split, customize the variable @code{org-M-RET-may-split-line}.}.  If
1437 the command is used at the @emph{beginning} of a headline, the new
1438 headline is created before the current line.  If the command is used
1439 at the @emph{end} of a folded subtree (i.e., behind the ellipses at
1440 the end of a headline), then a headline like the current one will be
1441 inserted after the end of the subtree.  Calling this command with
1442 @kbd{C-u C-u} will unconditionally respect the headline's content and
1443 create a new item at the end of the parent subtree.
1444 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1445 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1446 current heading, the new heading is placed after the body instead of before
1447 it.  This command works from anywhere in the entry.
1448 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1449 @vindex org-treat-insert-todo-heading-as-state-change
1450 Insert new TODO entry with same level as current heading.  See also the
1451 variable @code{org-treat-insert-todo-heading-as-state-change}.
1452 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1453 Insert new TODO entry with same level as current heading.  Like
1454 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1455 subtree.
1456 @orgcmd{@key{TAB},org-cycle}
1457 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1458 become a child of the previous one.  The next @key{TAB} makes it a parent,
1459 and so on, all the way to top level.  Yet another @key{TAB}, and you are back
1460 to the initial level.
1461 @orgcmd{M-@key{left},org-do-promote}
1462 Promote current heading by one level.
1463 @orgcmd{M-@key{right},org-do-demote}
1464 Demote current heading by one level.
1465 @orgcmd{M-S-@key{left},org-promote-subtree}
1466 Promote the current subtree by one level.
1467 @orgcmd{M-S-@key{right},org-demote-subtree}
1468 Demote the current subtree by one level.
1469 @orgcmd{M-S-@key{up},org-move-subtree-up}
1470 Move subtree up (swap with previous subtree of same
1471 level).
1472 @orgcmd{M-S-@key{down},org-move-subtree-down}
1473 Move subtree down (swap with next subtree of same level).
1474 @orgcmd{M-h,org-mark-element}
1475 Mark the element at point.  Hitting repeatedly will mark subsequent elements
1476 of the one just marked.  E.g., hitting @key{M-h} on a paragraph will mark it,
1477 hitting @key{M-h} immediately again will mark the next one.
1478 @orgcmd{C-c @@,org-mark-subtree}
1479 Mark the subtree at point.  Hitting repeatedly will mark subsequent subtrees
1480 of the same level than the marked subtree.
1481 @orgcmd{C-c C-x C-w,org-cut-subtree}
1482 Kill subtree, i.e., remove it from buffer but save in kill ring.
1483 With a numeric prefix argument N, kill N sequential subtrees.
1484 @orgcmd{C-c C-x M-w,org-copy-subtree}
1485 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
1486 sequential subtrees.
1487 @orgcmd{C-c C-x C-y,org-paste-subtree}
1488 Yank subtree from kill ring.  This does modify the level of the subtree to
1489 make sure the tree fits in nicely at the yank position.  The yank level can
1490 also be specified with a numeric prefix argument, or by yanking after a
1491 headline marker like @samp{****}.
1492 @orgcmd{C-y,org-yank}
1493 @vindex org-yank-adjusted-subtrees
1494 @vindex org-yank-folded-subtrees
1495 Depending on the variables @code{org-yank-adjusted-subtrees} and
1496 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1497 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1498 C-x C-y}.  With the default settings, no level adjustment will take place,
1499 but the yanked tree will be folded unless doing so would swallow text
1500 previously visible.  Any prefix argument to this command will force a normal
1501 @code{yank} to be executed, with the prefix passed along.  A good way to
1502 force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
1503 yank, it will yank previous kill items plainly, without adjustment and
1504 folding.
1505 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1506 Clone a subtree by making a number of sibling copies of it.  You will be
1507 prompted for the number of copies to make, and you can also specify if any
1508 timestamps in the entry should be shifted.  This can be useful, for example,
1509 to create a number of tasks related to a series of lectures to prepare.  For
1510 more details, see the docstring of the command
1511 @code{org-clone-subtree-with-time-shift}.
1512 @orgcmd{C-c C-w,org-refile}
1513 Refile entry or region to a different location.  @xref{Refile and copy}.
1514 @orgcmd{C-c ^,org-sort}
1515 Sort same-level entries.  When there is an active region, all entries in the
1516 region will be sorted.  Otherwise the children of the current headline are
1517 sorted.  The command prompts for the sorting method, which can be
1518 alphabetically, numerically, by time (first timestamp with active preferred,
1519 creation time, scheduled time, deadline time), by priority, by TODO keyword
1520 (in the sequence the keywords have been defined in the setup) or by the value
1521 of a property.  Reverse sorting is possible as well.  You can also supply
1522 your own function to extract the sorting key.  With a @kbd{C-u} prefix,
1523 sorting will be case-sensitive.
1524 @orgcmd{C-x n s,org-narrow-to-subtree}
1525 Narrow buffer to current subtree.
1526 @orgcmd{C-x n b,org-narrow-to-block}
1527 Narrow buffer to current block.
1528 @orgcmd{C-x n w,widen}
1529 Widen buffer to remove narrowing.
1530 @orgcmd{C-c *,org-toggle-heading}
1531 Turn a normal line or plain list item into a headline (so that it becomes a
1532 subheading at its location).  Also turn a headline into a normal line by
1533 removing the stars.  If there is an active region, turn all lines in the
1534 region into headlines.  If the first line in the region was an item, turn
1535 only the item lines into headlines.  Finally, if the first line is a
1536 headline, remove the stars from all headlines in the region.
1537 @end table
1539 @cindex region, active
1540 @cindex active region
1541 @cindex transient mark mode
1542 When there is an active region (Transient Mark mode), promotion and
1543 demotion work on all headlines in the region.  To select a region of
1544 headlines, it is best to place both point and mark at the beginning of a
1545 line, mark at the beginning of the first headline, and point at the line
1546 just after the last headline to change.  Note that when the cursor is
1547 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1548 functionality.
1551 @node Sparse trees, Plain lists, Structure editing, Document Structure
1552 @section Sparse trees
1553 @cindex sparse trees
1554 @cindex trees, sparse
1555 @cindex folding, sparse trees
1556 @cindex occur, command
1558 @vindex org-show-hierarchy-above
1559 @vindex org-show-following-heading
1560 @vindex org-show-siblings
1561 @vindex org-show-entry-below
1562 An important feature of Org mode is the ability to construct @emph{sparse
1563 trees} for selected information in an outline tree, so that the entire
1564 document is folded as much as possible, but the selected information is made
1565 visible along with the headline structure above it@footnote{See also the
1566 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1567 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1568 control on how much context is shown around each match.}.  Just try it out
1569 and you will see immediately how it works.
1571 Org mode contains several commands creating such trees, all these
1572 commands can be accessed through a dispatcher:
1574 @table @asis
1575 @orgcmd{C-c /,org-sparse-tree}
1576 This prompts for an extra key to select a sparse-tree creating command.
1577 @orgcmd{C-c / r,org-occur}
1578 @vindex org-remove-highlights-with-change
1579 Prompts for a regexp and shows a sparse tree with all matches.  If
1580 the match is in a headline, the headline is made visible.  If the match is in
1581 the body of an entry, headline and body are made visible.  In order to
1582 provide minimal context, also the full hierarchy of headlines above the match
1583 is shown, as well as the headline following the match.  Each match is also
1584 highlighted; the highlights disappear when the buffer is changed by an
1585 editing command@footnote{This depends on the option
1586 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1587 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1588 so several calls to this command can be stacked.
1589 @orgcmdkkc{M-g n,M-g M-n,next-error}
1590 Jump to the next sparse tree match in this buffer.
1591 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1592 Jump to the previous sparse tree match in this buffer.
1593 @end table
1596 @noindent
1597 @vindex org-agenda-custom-commands
1598 For frequently used sparse trees of specific search strings, you can
1599 use the variable @code{org-agenda-custom-commands} to define fast
1600 keyboard access to specific sparse trees.  These commands will then be
1601 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1602 For example:
1604 @lisp
1605 (setq org-agenda-custom-commands
1606       '(("f" occur-tree "FIXME")))
1607 @end lisp
1609 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1610 a sparse tree matching the string @samp{FIXME}.
1612 The other sparse tree commands select headings based on TODO keywords,
1613 tags, or properties and will be discussed later in this manual.
1615 @kindex C-c C-e C-v
1616 @cindex printing sparse trees
1617 @cindex visible text, printing
1618 To print a sparse tree, you can use the Emacs command
1619 @code{ps-print-buffer-with-faces} which does not print invisible parts
1620 of the document @footnote{This does not work under XEmacs, because
1621 XEmacs uses selective display for outlining, not text properties.}.
1622 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1623 the document and print the resulting file.
1625 @node Plain lists, Drawers, Sparse trees, Document Structure
1626 @section Plain lists
1627 @cindex plain lists
1628 @cindex lists, plain
1629 @cindex lists, ordered
1630 @cindex ordered lists
1632 Within an entry of the outline tree, hand-formatted lists can provide
1633 additional structure.  They also provide a way to create lists of checkboxes
1634 (@pxref{Checkboxes}).  Org supports editing such lists, and every exporter
1635 (@pxref{Exporting}) can parse and format them.
1637 Org knows ordered lists, unordered lists, and description lists.
1638 @itemize @bullet
1639 @item
1640 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1641 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1642 they will be seen as top-level headlines.  Also, when you are hiding leading
1643 stars to get a clean outline view, plain list items starting with a star may
1644 be hard to distinguish from true headlines.  In short: even though @samp{*}
1645 is supported, it may be better to not use it for plain list items.}  as
1646 bullets.
1647 @item
1648 @vindex org-plain-list-ordered-item-terminator
1649 @vindex org-list-allow-alphabetical
1650 @emph{Ordered} list items start with a numeral followed by either a period or
1651 a right parenthesis@footnote{You can filter out any of them by configuring
1652 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1653 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1654 @samp{A)} by configuring @code{org-list-allow-alphabetical}.  To minimize
1655 confusion with normal text, those are limited to one character only.  Beyond
1656 that limit, bullets will automatically fallback to numbers.}.  If you want a
1657 list to start with a different value (e.g., 20), start the text of the item
1658 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1659 must be put @emph{before} the checkbox.  If you have activated alphabetical
1660 lists, you can also use counters like @code{[@@b]}.}.  Those constructs can
1661 be used in any item of the list in order to enforce a particular numbering.
1662 @item
1663 @emph{Description} list items are unordered list items, and contain the
1664 separator @samp{ :: } to distinguish the description @emph{term} from the
1665 description.
1666 @end itemize
1668 Items belonging to the same list must have the same indentation on the first
1669 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1670 2--digit numbers must be written left-aligned with the other numbers in the
1671 list.  An item ends before the next line that is less or equally indented
1672 than its bullet/number.
1674 @vindex org-list-empty-line-terminates-plain-lists
1675 A list ends whenever every item has ended, which means before any line less
1676 or equally indented than items at top level.  It also ends before two blank
1677 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1678 In that case, all items are closed.  Here is an example:
1680 @example
1681 @group
1682 ** Lord of the Rings
1683    My favorite scenes are (in this order)
1684    1. The attack of the Rohirrim
1685    2. Eowyn's fight with the witch king
1686       + this was already my favorite scene in the book
1687       + I really like Miranda Otto.
1688    3. Peter Jackson being shot by Legolas
1689       - on DVD only
1690       He makes a really funny face when it happens.
1691    But in the end, no individual scenes matter but the film as a whole.
1692    Important actors in this film are:
1693    - @b{Elijah Wood} :: He plays Frodo
1694    - @b{Sean Austin} :: He plays Sam, Frodo's friend.  I still remember
1695      him very well from his role as Mikey Walsh in @i{The Goonies}.
1696 @end group
1697 @end example
1699 Org supports these lists by tuning filling and wrapping commands to deal with
1700 them correctly@footnote{Org only changes the filling settings for Emacs.  For
1701 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}.  To turn this on,
1702 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1703 properly (@pxref{Exporting}).  Since indentation is what governs the
1704 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1705 blocks can be indented to signal that they belong to a particular item.
1707 @vindex org-list-demote-modify-bullet
1708 @vindex org-list-indent-offset
1709 If you find that using a different bullet for a sub-list (than that used for
1710 the current list-level) improves readability, customize the variable
1711 @code{org-list-demote-modify-bullet}.  To get a greater difference of
1712 indentation between items and theirs sub-items, customize
1713 @code{org-list-indent-offset}.
1715 @vindex org-list-automatic-rules
1716 The following commands act on items when the cursor is in the first line of
1717 an item (the line with the bullet or number).  Some of them imply the
1718 application of automatic rules to keep list structure intact.  If some of
1719 these actions get in your way, configure @code{org-list-automatic-rules}
1720 to disable them individually.
1722 @table @asis
1723 @orgcmd{@key{TAB},org-cycle}
1724 @cindex cycling, in plain lists
1725 @vindex org-cycle-include-plain-lists
1726 Items can be folded just like headline levels.  Normally this works only if
1727 the cursor is on a plain list item.  For more details, see the variable
1728 @code{org-cycle-include-plain-lists}.  If this variable is set to
1729 @code{integrate}, plain list items will be treated like low-level
1730 headlines.  The level of an item is then given by the indentation of the
1731 bullet/number.  Items are always subordinate to real headlines, however; the
1732 hierarchies remain completely separated.  In a new item with no text yet, the
1733 first @key{TAB} demotes the item to become a child of the previous
1734 one.  Subsequent @key{TAB}s move the item to meaningful levels in the list
1735 and eventually get it back to its initial position.
1736 @orgcmd{M-@key{RET},org-insert-heading}
1737 @vindex org-M-RET-may-split-line
1738 @vindex org-list-automatic-rules
1739 Insert new item at current level.  With a prefix argument, force a new
1740 heading (@pxref{Structure editing}).  If this command is used in the middle
1741 of an item, that item is @emph{split} in two, and the second part becomes the
1742 new item@footnote{If you do not want the item to be split, customize the
1743 variable @code{org-M-RET-may-split-line}.}.  If this command is executed
1744 @emph{before item's body}, the new item is created @emph{before} the current
1745 one.
1746 @end table
1748 @table @kbd
1749 @kindex M-S-@key{RET}
1750 @item M-S-RET
1751 Insert a new item with a checkbox (@pxref{Checkboxes}).
1752 @kindex S-@key{down}
1753 @item S-up
1754 @itemx S-down
1755 @cindex shift-selection-mode
1756 @vindex org-support-shift-select
1757 @vindex org-list-use-circular-motion
1758 Jump to the previous/next item in the current list@footnote{If you want to
1759 cycle around items that way, you may customize
1760 @code{org-list-use-circular-motion}.}, but only if
1761 @code{org-support-shift-select} is off.  If not, you can still use paragraph
1762 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1763 similar effect.
1764 @kindex M-@key{up}
1765 @kindex M-@key{down}
1766 @item M-up
1767 @itemx M-down
1768 Move the item including subitems up/down@footnote{See
1769 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1770 previous/next item of same indentation).  If the list is ordered, renumbering
1771 is automatic.
1772 @kindex M-@key{left}
1773 @kindex M-@key{right}
1774 @item M-left
1775 @itemx M-right
1776 Decrease/increase the indentation of an item, leaving children alone.
1777 @kindex M-S-@key{left}
1778 @kindex M-S-@key{right}
1779 @item M-S-left
1780 @itemx M-S-right
1781 Decrease/increase the indentation of the item, including subitems.
1782 Initially, the item tree is selected based on current indentation.  When
1783 these commands are executed several times in direct succession, the initially
1784 selected region is used, even if the new indentation would imply a different
1785 hierarchy.  To use the new hierarchy, break the command chain with a cursor
1786 motion or so.
1788 As a special case, using this command on the very first item of a list will
1789 move the whole list.  This behavior can be disabled by configuring
1790 @code{org-list-automatic-rules}.  The global indentation of a list has no
1791 influence on the text @emph{after} the list.
1792 @kindex C-c C-c
1793 @item C-c C-c
1794 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1795 state of the checkbox.  In any case, verify bullets and indentation
1796 consistency in the whole list.
1797 @kindex C-c -
1798 @vindex org-plain-list-ordered-item-terminator
1799 @item C-c -
1800 Cycle the entire list level through the different itemize/enumerate bullets
1801 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1802 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1803 and its indentation.  With a numeric prefix argument N, select the Nth bullet
1804 from this list.  If there is an active region when calling this, selected
1805 text will be changed into an item.  With a prefix argument, all lines will be
1806 converted to list items.  If the first line already was a list item, any item
1807 marker will be removed from the list.  Finally, even without an active
1808 region, a normal line will be converted into a list item.
1809 @kindex C-c *
1810 @item C-c *
1811 Turn a plain list item into a headline (so that it becomes a subheading at
1812 its location).  @xref{Structure editing}, for a detailed explanation.
1813 @kindex C-c C-*
1814 @item C-c C-*
1815 Turn the whole plain list into a subtree of the current heading.  Checkboxes
1816 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1817 (resp. checked).
1818 @kindex S-@key{left}
1819 @kindex S-@key{right}
1820 @item S-left/right
1821 @vindex org-support-shift-select
1822 This command also cycles bullet styles when the cursor in on the bullet or
1823 anywhere in an item line, details depending on
1824 @code{org-support-shift-select}.
1825 @kindex C-c ^
1826 @item C-c ^
1827 Sort the plain list.  You will be prompted for the sorting method:
1828 numerically, alphabetically, by time, or by custom function.
1829 @end table
1831 @node Drawers, Blocks, Plain lists, Document Structure
1832 @section Drawers
1833 @cindex drawers
1834 @cindex #+DRAWERS
1835 @cindex visibility cycling, drawers
1837 @vindex org-drawers
1838 @cindex org-insert-drawer
1839 @kindex C-c C-x d
1840 Sometimes you want to keep information associated with an entry, but you
1841 normally don't want to see it.  For this, Org mode has @emph{drawers}.
1842 Drawers need to be configured with the variable
1843 @code{org-drawers}@footnote{You can define additional drawers on a
1844 per-file basis with a line like @code{#+DRAWERS: HIDDEN STATE}}.  Drawers
1845 look like this:
1847 @example
1848 ** This is a headline
1849    Still outside the drawer
1850    :DRAWERNAME:
1851    This is inside the drawer.
1852    :END:
1853    After the drawer.
1854 @end example
1856 You can interactively insert drawers at point by calling
1857 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}.  With an active
1858 region, this command will put the region inside the drawer.  With a prefix
1859 argument, this command calls @code{org-insert-property-drawer} and add a
1860 property drawer right below the current headline.  Completion over drawer
1861 keywords is also possible using @key{M-TAB}.
1863 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1864 show the entry, but keep the drawer collapsed to a single line.  In order to
1865 look inside the drawer, you need to move the cursor to the drawer line and
1866 press @key{TAB} there.  Org mode uses the @code{PROPERTIES} drawer for
1867 storing properties (@pxref{Properties and Columns}), and you can also arrange
1868 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1869 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.  If you
1870 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1872 @table @kbd
1873 @kindex C-c C-z
1874 @item C-c C-z
1875 Add a time-stamped note to the LOGBOOK drawer.
1876 @end table
1878 @node Blocks, Footnotes, Drawers, Document Structure
1879 @section Blocks
1881 @vindex org-hide-block-startup
1882 @cindex blocks, folding
1883 Org mode uses begin...end blocks for various purposes from including source
1884 code examples (@pxref{Literal examples}) to capturing time logging
1885 information (@pxref{Clocking work time}).  These blocks can be folded and
1886 unfolded by pressing TAB in the begin line.  You can also get all blocks
1887 folded at startup by configuring the variable @code{org-hide-block-startup}
1888 or on a per-file basis by using
1890 @cindex @code{hideblocks}, STARTUP keyword
1891 @cindex @code{nohideblocks}, STARTUP keyword
1892 @example
1893 #+STARTUP: hideblocks
1894 #+STARTUP: nohideblocks
1895 @end example
1897 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1898 @section Footnotes
1899 @cindex footnotes
1901 Org mode supports the creation of footnotes.  In contrast to the
1902 @file{footnote.el} package, Org mode's footnotes are designed for work on
1903 a larger document, not only for one-off documents like emails.
1905 A footnote is started by a footnote marker in square brackets in column 0, no
1906 indentation allowed.  It ends at the next footnote definition, headline, or
1907 after two consecutive empty lines.  The footnote reference is simply the
1908 marker in square brackets, inside text.  For example:
1910 @example
1911 The Org homepage[fn:1] now looks a lot better than it used to.
1913 [fn:1] The link is: http://orgmode.org
1914 @end example
1916 Org mode extends the number-based syntax to @emph{named} footnotes and
1917 optional inline definition.  Using plain numbers as markers (as
1918 @file{footnote.el} does) is supported for backward compatibility, but not
1919 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1920 @LaTeX{}}).  Here are the valid references:
1922 @table @code
1923 @item [1]
1924 A plain numeric footnote marker.  Compatible with @file{footnote.el}, but not
1925 recommended because something like @samp{[1]} could easily be part of a code
1926 snippet.
1927 @item [fn:name]
1928 A named footnote reference, where @code{name} is a unique label word, or, for
1929 simplicity of automatic creation, a number.
1930 @item [fn:: This is the inline definition of this footnote]
1931 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1932 reference point.
1933 @item [fn:name: a definition]
1934 An inline definition of a footnote, which also specifies a name for the note.
1935 Since Org allows multiple references to the same note, you can then use
1936 @code{[fn:name]} to create additional references.
1937 @end table
1939 @vindex org-footnote-auto-label
1940 Footnote labels can be created automatically, or you can create names yourself.
1941 This is handled by the variable @code{org-footnote-auto-label} and its
1942 corresponding @code{#+STARTUP} keywords.  See the docstring of that variable
1943 for details.
1945 @noindent The following command handles footnotes:
1947 @table @kbd
1948 @kindex C-c C-x f
1949 @item C-c C-x f
1950 The footnote action command.
1952 When the cursor is on a footnote reference, jump to the definition.  When it
1953 is at a definition, jump to the (first) reference.
1955 @vindex org-footnote-define-inline
1956 @vindex org-footnote-section
1957 @vindex org-footnote-auto-adjust
1958 Otherwise, create a new footnote.  Depending on the variable
1959 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1960 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1961 definition will be placed right into the text as part of the reference, or
1962 separately into the location determined by the variable
1963 @code{org-footnote-section}.
1965 When this command is called with a prefix argument, a menu of additional
1966 options is offered:
1967 @example
1968 s   @r{Sort the footnote definitions by reference sequence.  During editing,}
1969     @r{Org makes no effort to sort footnote definitions into a particular}
1970     @r{sequence.  If you want them sorted, use this command, which will}
1971     @r{also move entries according to @code{org-footnote-section}.  Automatic}
1972     @r{sorting after each insertion/deletion can be configured using the}
1973     @r{variable @code{org-footnote-auto-adjust}.}
1974 r   @r{Renumber the simple @code{fn:N} footnotes.  Automatic renumbering}
1975     @r{after each insertion/deletion can be configured using the variable}
1976     @r{@code{org-footnote-auto-adjust}.}
1977 S   @r{Short for first @code{r}, then @code{s} action.}
1978 n   @r{Normalize the footnotes by collecting all definitions (including}
1979     @r{inline definitions) into a special section, and then numbering them}
1980     @r{in sequence.  The references will then also be numbers.  This is}
1981     @r{meant to be the final step before finishing a document (e.g., sending}
1982     @r{off an email).}
1983 d   @r{Delete the footnote at point, and all definitions of and references}
1984     @r{to it.}
1985 @end example
1986 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1987 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1988 renumbering and sorting footnotes can be automatic after each insertion or
1989 deletion.
1991 @kindex C-c C-c
1992 @item C-c C-c
1993 If the cursor is on a footnote reference, jump to the definition.  If it is a
1994 the definition, jump back to the reference.  When called at a footnote
1995 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1996 @kindex C-c C-o
1997 @kindex mouse-1
1998 @kindex mouse-2
1999 @item C-c C-o  @r{or} mouse-1/2
2000 Footnote labels are also links to the corresponding definition/reference, and
2001 you can use the usual commands to follow these links.
2002 @end table
2004 @node Orgstruct mode, Org syntax, Footnotes, Document Structure
2005 @section The Orgstruct minor mode
2006 @cindex Orgstruct mode
2007 @cindex minor mode for structure editing
2009 If you like the intuitive way the Org mode structure editing and list
2010 formatting works, you might want to use these commands in other modes like
2011 Text mode or Mail mode as well.  The minor mode @code{orgstruct-mode} makes
2012 this possible.   Toggle the mode with @kbd{M-x orgstruct-mode}, or
2013 turn it on by default, for example in Message mode, with one of:
2015 @lisp
2016 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2017 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2018 @end lisp
2020 When this mode is active and the cursor is on a line that looks to Org like a
2021 headline or the first line of a list item, most structure editing commands
2022 will work, even if the same keys normally have different functionality in the
2023 major mode you are using.  If the cursor is not in one of those special
2024 lines, Orgstruct mode lurks silently in the shadows.
2026 When you use @code{orgstruct++-mode}, Org will also export indentation and
2027 autofill settings into that mode, and detect item context after the first
2028 line of an item.
2030 @vindex orgstruct-heading-prefix-regexp
2031 You can also use Org structure editing to fold and unfold headlines in
2032 @emph{any} file, provided you defined @var{orgstruct-heading-prefix-regexp}:
2033 the regular expression must match the local prefix to use before Org's
2034 headlines.  For example, if you set this variable to @code{"^;; "} in Emacs
2035 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2036 commented lines.  Some commands like @code{org-demote} are disabled when the
2037 prefix is set, but folding/unfolding will work correctly.
2039 @node Org syntax,  , Orgstruct mode, Document Structure
2040 @section Org syntax
2041 @cindex Org syntax
2043 A reference document providing a formal description of Org's syntax is
2044 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2045 Worg}, written and maintained by Nicolas Goaziou.  It defines Org's core
2046 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2047 keywords}, @code{(greater) elements} and @code{objects}.  Each part of an Org
2048 file falls into one of the categories above.
2050 To explore the abstract structure of an Org buffer, run this in a buffer:
2052 @lisp
2053 M-: (org-element-parse-buffer) RET
2054 @end lisp
2056 It will output a list containing the buffer's content represented as an
2057 abstract structure.  The export engine relies on the information stored in
2058 this list.  Most interactive commands (e.g., for structure editing) also
2059 rely on the syntactic meaning of the surrounding context.
2061 @node Tables, Hyperlinks, Document Structure, Top
2062 @chapter Tables
2063 @cindex tables
2064 @cindex editing tables
2066 Org comes with a fast and intuitive table editor.  Spreadsheet-like
2067 calculations are supported using the Emacs @file{calc} package
2068 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2070 @menu
2071 * Built-in table editor::       Simple tables
2072 * Column width and alignment::  Overrule the automatic settings
2073 * Column groups::               Grouping to trigger vertical lines
2074 * Orgtbl mode::                 The table editor as minor mode
2075 * The spreadsheet::             The table editor has spreadsheet capabilities
2076 * Org-Plot::                    Plotting from org tables
2077 @end menu
2079 @node Built-in table editor, Column width and alignment, Tables, Tables
2080 @section The built-in table editor
2081 @cindex table editor, built-in
2083 Org makes it easy to format tables in plain ASCII@.  Any line with @samp{|} as
2084 the first non-whitespace character is considered part of a table.  @samp{|}
2085 is also the column separator@footnote{To insert a vertical bar into a table
2086 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}.  A table
2087 might look like this:
2089 @example
2090 | Name  | Phone | Age |
2091 |-------+-------+-----|
2092 | Peter |  1234 |  17 |
2093 | Anna  |  4321 |  25 |
2094 @end example
2096 A table is re-aligned automatically each time you press @key{TAB} or
2097 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
2098 the next field (@key{RET} to the next row) and creates new table rows
2099 at the end of the table or before horizontal lines.  The indentation
2100 of the table is set by the first line.  Any line starting with
2101 @samp{|-} is considered as a horizontal separator line and will be
2102 expanded on the next re-align to span the whole table width.  So, to
2103 create the above table, you would only type
2105 @example
2106 |Name|Phone|Age|
2108 @end example
2110 @noindent and then press @key{TAB} to align the table and start filling in
2111 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
2112 @kbd{C-c @key{RET}}.
2114 @vindex org-enable-table-editor
2115 @vindex org-table-auto-blank-field
2116 When typing text into a field, Org treats @key{DEL},
2117 @key{Backspace}, and all character keys in a special way, so that
2118 inserting and deleting avoids shifting other fields.  Also, when
2119 typing @emph{immediately after the cursor was moved into a new field
2120 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2121 field is automatically made blank.  If this behavior is too
2122 unpredictable for you, configure the variables
2123 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2125 @table @kbd
2126 @tsubheading{Creation and conversion}
2127 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2128 Convert the active region to table.  If every line contains at least one
2129 TAB character, the function assumes that the material is tab separated.
2130 If every line contains a comma, comma-separated values (CSV) are assumed.
2131 If not, lines are split at whitespace into fields.  You can use a prefix
2132 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2133 C-u} forces TAB, and a numeric argument N indicates that at least N
2134 consecutive spaces, or alternatively a TAB will be the separator.
2136 If there is no active region, this command creates an empty Org
2137 table.  But it is easier just to start typing, like
2138 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2140 @tsubheading{Re-aligning and field motion}
2141 @orgcmd{C-c C-c,org-table-align}
2142 Re-align the table and don't move to another field.
2144 @orgcmd{<TAB>,org-table-next-field}
2145 Re-align the table, move to the next field.  Creates a new row if
2146 necessary.
2148 @orgcmd{S-@key{TAB},org-table-previous-field}
2149 Re-align, move to previous field.
2151 @orgcmd{@key{RET},org-table-next-row}
2152 Re-align the table and move down to next row.  Creates a new row if
2153 necessary.  At the beginning or end of a line, @key{RET} still does
2154 NEWLINE, so it can be used to split a table.
2156 @orgcmd{M-a,org-table-beginning-of-field}
2157 Move to beginning of the current table field, or on to the previous field.
2158 @orgcmd{M-e,org-table-end-of-field}
2159 Move to end of the current table field, or on to the next field.
2161 @tsubheading{Column and row editing}
2162 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2163 Move the current column left/right.
2165 @orgcmd{M-S-@key{left},org-table-delete-column}
2166 Kill the current column.
2168 @orgcmd{M-S-@key{right},org-table-insert-column}
2169 Insert a new column to the left of the cursor position.
2171 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2172 Move the current row up/down.
2174 @orgcmd{M-S-@key{up},org-table-kill-row}
2175 Kill the current row or horizontal line.
2177 @orgcmd{M-S-@key{down},org-table-insert-row}
2178 Insert a new row above the current row.  With a prefix argument, the line is
2179 created below the current one.
2181 @orgcmd{C-c -,org-table-insert-hline}
2182 Insert a horizontal line below current row.  With a prefix argument, the line
2183 is created above the current line.
2185 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2186 Insert a horizontal line below current row, and move the cursor into the row
2187 below that line.
2189 @orgcmd{C-c ^,org-table-sort-lines}
2190 Sort the table lines in the region.  The position of point indicates the
2191 column to be used for sorting, and the range of lines is the range
2192 between the nearest horizontal separator lines, or the entire table.  If
2193 point is before the first column, you will be prompted for the sorting
2194 column.  If there is an active region, the mark specifies the first line
2195 and the sorting column, while point should be in the last line to be
2196 included into the sorting.  The command prompts for the sorting type
2197 (alphabetically, numerically, or by time).  When called with a prefix
2198 argument, alphabetic sorting will be case-sensitive.
2200 @tsubheading{Regions}
2201 @orgcmd{C-c C-x M-w,org-table-copy-region}
2202 Copy a rectangular region from a table to a special clipboard.  Point and
2203 mark determine edge fields of the rectangle.  If there is no active region,
2204 copy just the current field.  The process ignores horizontal separator lines.
2206 @orgcmd{C-c C-x C-w,org-table-cut-region}
2207 Copy a rectangular region from a table to a special clipboard, and
2208 blank all fields in the rectangle.  So this is the ``cut'' operation.
2210 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2211 Paste a rectangular region into a table.
2212 The upper left corner ends up in the current field.  All involved fields
2213 will be overwritten.  If the rectangle does not fit into the present table,
2214 the table is enlarged as needed.  The process ignores horizontal separator
2215 lines.
2217 @orgcmd{M-@key{RET},org-table-wrap-region}
2218 Split the current field at the cursor position and move the rest to the line
2219 below.  If there is an active region, and both point and mark are in the same
2220 column, the text in the column is wrapped to minimum width for the given
2221 number of lines.  A numeric prefix argument may be used to change the number
2222 of desired lines.  If there is no region, but you specify a prefix argument,
2223 the current field is made blank, and the content is appended to the field
2224 above.
2226 @tsubheading{Calculations}
2227 @cindex formula, in tables
2228 @cindex calculations, in tables
2229 @cindex region, active
2230 @cindex active region
2231 @cindex transient mark mode
2232 @orgcmd{C-c +,org-table-sum}
2233 Sum the numbers in the current column, or in the rectangle defined by
2234 the active region.  The result is shown in the echo area and can
2235 be inserted with @kbd{C-y}.
2237 @orgcmd{S-@key{RET},org-table-copy-down}
2238 @vindex org-table-copy-increment
2239 When current field is empty, copy from first non-empty field above.  When not
2240 empty, copy current field down to next row and move cursor along with it.
2241 Depending on the variable @code{org-table-copy-increment}, integer field
2242 values will be incremented during copy.  Integers that are too large will not
2243 be incremented.  Also, a @code{0} prefix argument temporarily disables the
2244 increment.  This key is also used by shift-selection and related modes
2245 (@pxref{Conflicts}).
2247 @tsubheading{Miscellaneous}
2248 @orgcmd{C-c `,org-table-edit-field}
2249 Edit the current field in a separate window.  This is useful for fields that
2250 are not fully visible (@pxref{Column width and alignment}).  When called with
2251 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2252 edited in place.  When called with two @kbd{C-u} prefixes, make the editor
2253 window follow the cursor through the table and always show the current
2254 field.  The follow mode exits automatically when the cursor leaves the table,
2255 or when you repeat this command with @kbd{C-u C-u C-c `}.
2257 @item M-x org-table-import
2258 Import a file as a table.  The table should be TAB or whitespace
2259 separated.  Use, for example, to import a spreadsheet table or data
2260 from a database, because these programs generally can write
2261 TAB-separated text files.  This command works by inserting the file into
2262 the buffer and then converting the region to a table.  Any prefix
2263 argument is passed on to the converter, which uses it to determine the
2264 separator.
2265 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2266 Tables can also be imported by pasting tabular text into the Org
2267 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2268 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2270 @item M-x org-table-export
2271 @findex org-table-export
2272 @vindex org-table-export-default-format
2273 Export the table, by default as a TAB-separated file.  Use for data
2274 exchange with, for example, spreadsheet or database programs.  The format
2275 used to export the file can be configured in the variable
2276 @code{org-table-export-default-format}.  You may also use properties
2277 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2278 name and the format for table export in a subtree.  Org supports quite
2279 general formats for exported tables.  The exporter format is the same as the
2280 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2281 detailed description.
2282 @end table
2284 If you don't like the automatic table editor because it gets in your
2285 way on lines which you would like to start with @samp{|}, you can turn
2286 it off with
2288 @lisp
2289 (setq org-enable-table-editor nil)
2290 @end lisp
2292 @noindent Then the only table command that still works is
2293 @kbd{C-c C-c} to do a manual re-align.
2295 @node Column width and alignment, Column groups, Built-in table editor, Tables
2296 @section Column width and alignment
2297 @cindex narrow columns in tables
2298 @cindex alignment in tables
2300 The width of columns is automatically determined by the table editor.  And
2301 also the alignment of a column is determined automatically from the fraction
2302 of number-like versus non-number fields in the column.
2304 Sometimes a single field or a few fields need to carry more text, leading to
2305 inconveniently wide columns.  Or maybe you want to make a table with several
2306 columns having a fixed width, regardless of content.  To set@footnote{This
2307 feature does not work on XEmacs.} the width of a column, one field anywhere
2308 in the column may contain just the string @samp{<N>} where @samp{N} is an
2309 integer specifying the width of the column in characters.  The next re-align
2310 will then set the width of this column to this value.
2312 @example
2313 @group
2314 |---+------------------------------|               |---+--------|
2315 |   |                              |               |   | <6>    |
2316 | 1 | one                          |               | 1 | one    |
2317 | 2 | two                          |     ----\     | 2 | two    |
2318 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
2319 | 4 | four                         |               | 4 | four   |
2320 |---+------------------------------|               |---+--------|
2321 @end group
2322 @end example
2324 @noindent
2325 Fields that are wider become clipped and end in the string @samp{=>}.
2326 Note that the full text is still in the buffer but is hidden.
2327 To see the full text, hold the mouse over the field---a tool-tip window
2328 will show the full content.  To edit such a field, use the command
2329 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
2330 open a new window with the full field.  Edit it and finish with @kbd{C-c
2331 C-c}.
2333 @vindex org-startup-align-all-tables
2334 When visiting a file containing a table with narrowed columns, the
2335 necessary character hiding has not yet happened, and the table needs to
2336 be aligned before it looks nice.  Setting the option
2337 @code{org-startup-align-all-tables} will realign all tables in a file
2338 upon visiting, but also slow down startup.  You can also set this option
2339 on a per-file basis with:
2341 @example
2342 #+STARTUP: align
2343 #+STARTUP: noalign
2344 @end example
2346 If you would like to overrule the automatic alignment of number-rich columns
2347 to the right and of string-rich column to the left, you can use @samp{<r>},
2348 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2349 effect when exporting to HTML.} or @samp{<l>} in a similar fashion.  You may
2350 also combine alignment and field width like this: @samp{<r10>}.
2352 Lines which only contain these formatting cookies will be removed
2353 automatically when exporting the document.
2355 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2356 @section Column groups
2357 @cindex grouping columns in tables
2359 When Org exports tables, it does so by default without vertical
2360 lines because that is visually more satisfying in general.  Occasionally
2361 however, vertical lines can be useful to structure a table into groups
2362 of columns, much like horizontal lines can do for groups of rows.  In
2363 order to specify column groups, you can use a special row where the
2364 first field contains only @samp{/}.  The further fields can either
2365 contain @samp{<} to indicate that this column should start a group,
2366 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2367 and @samp{>}) to make a column
2368 a group of its own.  Boundaries between column groups will upon export be
2369 marked with vertical lines.  Here is an example:
2371 @example
2372 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2373 |---+-----+-----+-----+---------+------------|
2374 | / |   < |     |   > |       < |          > |
2375 | 1 |   1 |   1 |   1 |       1 |          1 |
2376 | 2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
2377 | 3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
2378 |---+-----+-----+-----+---------+------------|
2379 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2380 @end example
2382 It is also sufficient to just insert the column group starters after
2383 every vertical line you would like to have:
2385 @example
2386 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2387 |----+-----+-----+-----+---------+------------|
2388 | /  | <   |     |     | <       |            |
2389 @end example
2391 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2392 @section The Orgtbl minor mode
2393 @cindex Orgtbl mode
2394 @cindex minor mode for tables
2396 If you like the intuitive way the Org table editor works, you
2397 might also want to use it in other modes like Text mode or Mail mode.
2398 The minor mode Orgtbl mode makes this possible.  You can always toggle
2399 the mode with @kbd{M-x orgtbl-mode}.  To turn it on by default, for
2400 example in Message mode, use
2402 @lisp
2403 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2404 @end lisp
2406 Furthermore, with some special setup, it is possible to maintain tables
2407 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
2408 construct @LaTeX{} tables with the underlying ease and power of
2409 Orgtbl mode, including spreadsheet capabilities.  For details, see
2410 @ref{Tables in arbitrary syntax}.
2412 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2413 @section The spreadsheet
2414 @cindex calculations, in tables
2415 @cindex spreadsheet capabilities
2416 @cindex @file{calc} package
2418 The table editor makes use of the Emacs @file{calc} package to implement
2419 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
2420 derive fields from other fields.  While fully featured, Org's implementation
2421 is not identical to other spreadsheets.  For example, Org knows the concept
2422 of a @emph{column formula} that will be applied to all non-header fields in a
2423 column without having to copy the formula to each relevant field.  There is
2424 also a formula debugger, and a formula editor with features for highlighting
2425 fields in the table corresponding to the references at the point in the
2426 formula, moving these references by arrow keys
2428 @menu
2429 * References::                  How to refer to another field or range
2430 * Formula syntax for Calc::     Using Calc to compute stuff
2431 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
2432 * Durations and time values::   How to compute durations and time values
2433 * Field and range formulas::    Formula for specific (ranges of) fields
2434 * Column formulas::             Formulas valid for an entire column
2435 * Lookup functions::            Lookup functions for searching tables
2436 * Editing and debugging formulas::  Fixing formulas
2437 * Updating the table::          Recomputing all dependent fields
2438 * Advanced features::           Field and column names, parameters and automatic recalc
2439 @end menu
2441 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2442 @subsection References
2443 @cindex references
2445 To compute fields in the table from other fields, formulas must
2446 reference other fields or ranges.  In Org, fields can be referenced
2447 by name, by absolute coordinates, and by relative coordinates.  To find
2448 out what the coordinates of a field are, press @kbd{C-c ?} in that
2449 field, or press @kbd{C-c @}} to toggle the display of a grid.
2451 @subsubheading Field references
2452 @cindex field references
2453 @cindex references, to fields
2455 Formulas can reference the value of another field in two ways.  Like in
2456 any other spreadsheet, you may reference fields with a letter/number
2457 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2458 @vindex org-table-use-standard-references
2459 However, Org prefers@footnote{Org will understand references typed by the
2460 user as @samp{B4}, but it will not use this syntax when offering a formula
2461 for editing.  You can customize this behavior using the variable
2462 @code{org-table-use-standard-references}.}  to use another, more general
2463 representation that looks like this:
2464 @example
2465 @@@var{row}$@var{column}
2466 @end example
2468 Column specifications can be absolute like @code{$1},
2469 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2470 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2471 @code{$<} and @code{$>} are immutable references to the first and last
2472 column, respectively, and you can use @code{$>>>} to indicate the third
2473 column from the right.
2475 The row specification only counts data lines and ignores horizontal separator
2476 lines (hlines).  Like with columns, you can use absolute row numbers
2477 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2478 current row like @code{@@+3} or @code{@@-1}.  @code{@@<} and @code{@@>} are
2479 immutable references the first and last@footnote{For backward compatibility
2480 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2481 a stable way to the 5th and 12th field in the last row of the table.
2482 However, this syntax is deprecated, it should not be used for new documents.
2483 Use @code{@@>$} instead.} row in the table, respectively.  You may also
2484 specify the row relative to one of the hlines: @code{@@I} refers to the first
2485 hline, @code{@@II} to the second, etc.  @code{@@-I} refers to the first such
2486 line above the current line, @code{@@+I} to the first such line below the
2487 current line.  You can also write @code{@@III+2} which is the second data line
2488 after the third hline in the table.
2490 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2491 i.e., to the row/column for the field being computed.  Also, if you omit
2492 either the column or the row part of the reference, the current row/column is
2493 implied.
2495 Org's references with @emph{unsigned} numbers are fixed references
2496 in the sense that if you use the same reference in the formula for two
2497 different fields, the same field will be referenced each time.
2498 Org's references with @emph{signed} numbers are floating
2499 references because the same reference operator can reference different
2500 fields depending on the field being calculated by the formula.
2502 Here are a few examples:
2504 @example
2505 @@2$3      @r{2nd row, 3rd column (same as @code{C2})}
2506 $5        @r{column 5 in the current row (same as @code{E&})}
2507 @@2        @r{current column, row 2}
2508 @@-1$-3    @r{the field one row up, three columns to the left}
2509 @@-I$2     @r{field just under hline above current row, column 2}
2510 @@>$5      @r{field in the last row, in column 5}
2511 @end example
2513 @subsubheading Range references
2514 @cindex range references
2515 @cindex references, to ranges
2517 You may reference a rectangular range of fields by specifying two field
2518 references connected by two dots @samp{..}.  If both fields are in the
2519 current row, you may simply use @samp{$2..$7}, but if at least one field
2520 is in a different row, you need to use the general @code{@@row$column}
2521 format at least for the first field (i.e the reference must start with
2522 @samp{@@} in order to be interpreted correctly).  Examples:
2524 @example
2525 $1..$3        @r{first three fields in the current row}
2526 $P..$Q        @r{range, using column names (see under Advanced)}
2527 $<<<..$>>     @r{start in third column, continue to the one but last}
2528 @@2$1..@@4$3    @r{6 fields between these two fields (same as @code{A2..C4})}
2529 @@-1$-2..@@-1   @r{3 fields in the row above, starting from 2 columns on the left}
2530 @@I..II        @r{between first and second hline, short for @code{@@I..@@II}}
2531 @end example
2533 @noindent Range references return a vector of values that can be fed
2534 into Calc vector functions.  Empty fields in ranges are normally
2535 suppressed, so that the vector contains only the non-empty fields (but
2536 see the @samp{E} mode switch below).  If there are no non-empty fields,
2537 @samp{[0]} is returned to avoid syntax errors in formulas.
2539 @subsubheading Field coordinates in formulas
2540 @cindex field coordinates
2541 @cindex coordinates, of field
2542 @cindex row, of field coordinates
2543 @cindex column, of field coordinates
2545 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2546 get the row or column number of the field where the formula result goes.
2547 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2548 and @code{org-table-current-column}.  Examples:
2550 @example
2551 if(@@# % 2, $#, string(""))   @r{column number on odd lines only}
2552 $3 = remote(FOO, @@@@#$2)      @r{copy column 2 from table FOO into}
2553                              @r{column 3 of the current table}
2554 @end example
2556 @noindent For the second example, table FOO must have at least as many rows
2557 as the current table.  Note that this is inefficient@footnote{The computation time scales as
2558 O(N^2) because table FOO is parsed for each field to be copied.} for large
2559 number of rows.
2561 @subsubheading Named references
2562 @cindex named references
2563 @cindex references, named
2564 @cindex name, of column or field
2565 @cindex constants, in calculations
2566 @cindex #+CONSTANTS
2568 @vindex org-table-formula-constants
2569 @samp{$name} is interpreted as the name of a column, parameter or
2570 constant.  Constants are defined globally through the variable
2571 @code{org-table-formula-constants}, and locally (for the file) through a
2572 line like
2574 @example
2575 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2576 @end example
2578 @noindent
2579 @vindex constants-unit-system
2580 @pindex constants.el
2581 Also properties (@pxref{Properties and Columns}) can be used as
2582 constants in table formulas: for a property @samp{:Xyz:} use the name
2583 @samp{$PROP_Xyz}, and the property will be searched in the current
2584 outline entry and in the hierarchy above it.  If you have the
2585 @file{constants.el} package, it will also be used to resolve constants,
2586 including natural constants like @samp{$h} for Planck's constant, and
2587 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2588 supply the values of constants in two different unit systems, @code{SI}
2589 and @code{cgs}.  Which one is used depends on the value of the variable
2590 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
2591 @code{constSI} and @code{constcgs} to set this value for the current
2592 buffer.}.  Column names and parameters can be specified in special table
2593 lines.  These are described below, see @ref{Advanced features}.  All
2594 names must start with a letter, and further consist of letters and
2595 numbers.
2597 @subsubheading Remote references
2598 @cindex remote references
2599 @cindex references, remote
2600 @cindex references, to a different table
2601 @cindex name, of column or field
2602 @cindex constants, in calculations
2603 @cindex #+NAME, for table
2605 You may also reference constants, fields and ranges from a different table,
2606 either in the current file or even in a different file.  The syntax is
2608 @example
2609 remote(NAME-OR-ID,REF)
2610 @end example
2612 @noindent
2613 where NAME can be the name of a table in the current file as set by a
2614 @code{#+NAME: Name} line before the table.  It can also be the ID of an
2615 entry, even in a different file, and the reference then refers to the first
2616 table in that entry.  REF is an absolute field or range reference as
2617 described above for example @code{@@3$3} or @code{$somename}, valid in the
2618 referenced table.
2620 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2621 @subsection Formula syntax for Calc
2622 @cindex formula syntax, Calc
2623 @cindex syntax, of formulas
2625 A formula can be any algebraic expression understood by the Emacs
2626 @file{Calc} package.  @b{Note that @file{calc} has the
2627 non-standard convention that @samp{/} has lower precedence than
2628 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.}  Before
2629 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2630 Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc, GNU
2631 Emacs Calc Manual}),
2632 variable substitution takes place according to the rules described above.
2633 @cindex vectors, in table calculations
2634 The range vectors can be directly fed into the Calc vector functions
2635 like @samp{vmean} and @samp{vsum}.
2637 @cindex format specifier
2638 @cindex mode, for @file{calc}
2639 @vindex org-calc-default-modes
2640 A formula can contain an optional mode string after a semicolon.  This
2641 string consists of flags to influence Calc and other modes during
2642 execution.  By default, Org uses the standard Calc modes (precision
2643 12, angular units degrees, fraction and symbolic modes off).  The display
2644 format, however, has been changed to @code{(float 8)} to keep tables
2645 compact.  The default settings can be configured using the variable
2646 @code{org-calc-default-modes}.
2648 @example
2649 p20           @r{set the internal Calc calculation precision to 20 digits}
2650 n3 s3 e2 f4   @r{Normal, scientific, engineering, or fixed}
2651               @r{format of the result of Calc passed back to Org.}
2652               @r{Calc formatting is unlimited in precision as}
2653               @r{long as the Calc calculation precision is greater.}
2654 D R           @r{angle modes: degrees, radians}
2655 F S           @r{fraction and symbolic modes}
2656 E             @r{keep empty fields in ranges and use nan (not a number)}
2657               @r{in Calc formulas for empty fields in range references and}
2658               @r{for empty field references; else suppress empty fields in}
2659               @r{range references and use 0 for empty field references, see}
2660               @r{also the notes for `Range references' in @pxref{References}}
2661 N             @r{interpret all fields as numbers, use 0 for non-numbers;}
2662               @r{N has higher precedence than E (for the value of the field)}
2663 L             @r{literal, for Lisp formulas only}
2664 @end example
2666 @noindent
2667 Unless you use large integer numbers or high-precision-calculation
2668 and -display for floating point numbers you may alternatively provide a
2669 @code{printf} format specifier to reformat the Calc result after it has been
2670 passed back to Org instead of letting Calc already do the
2671 formatting@footnote{The @code{printf} reformatting is limited in precision
2672 because the value passed to it is converted into an @code{integer} or
2673 @code{double}.  The @code{integer} is limited in size by truncating the
2674 signed value to 32 bits.  The @code{double} is limited in precision to 64
2675 bits overall which leaves approximately 16 significant decimal digits.}.
2676 A few examples:
2678 @example
2679 $1+$2                @r{Sum of first and second field}
2680 $1+$2;%.2f           @r{Same, format result to two decimals}
2681 exp($2)+exp($1)      @r{Math functions can be used}
2682 $0;%.1f              @r{Reformat current cell to 1 decimal}
2683 ($3-32)*5/9          @r{Degrees F -> C conversion}
2684 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
2685 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
2686 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
2687 vmean($2..$7)        @r{Compute column range mean, suppress empty fields}
2688 vmean($2..$7);EN     @r{Same, but treat empty fields as 0}
2689 taylor($3,x=7,2)     @r{Taylor series of $3, at x=7, second degree}
2690 @end example
2692 Calc also contains a complete set of logical operations.  For example
2694 @example
2695 if($1 < 20, teen, string(""))
2696                      @r{"teen" if age $1 is less than 20, else empty}
2697 if("$1" = "nan" || "$2" = "nan", string(""), $1 + $2); E
2698                      @r{sum of first two columns unless one or both empty}
2699 @end example
2701 Note that you can also use two org-specific flags @code{T} and @code{t} for
2702 durations computations @ref{Durations and time values}.
2704 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2705 and use them in formula syntax for Calc.
2707 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2708 @subsection Emacs Lisp forms as formulas
2709 @cindex Lisp forms, as table formulas
2711 It is also possible to write a formula in Emacs Lisp.  This can be useful
2712 for string manipulation and control structures, if Calc's functionality is
2713 not enough.
2715 If a formula starts with a single-quote followed by an opening parenthesis,
2716 then it is evaluated as a Lisp form.  The evaluation should return either a
2717 string or a number.  Just as with @file{calc} formulas, you can specify modes
2718 and a printf format after a semicolon.
2720 With Emacs Lisp forms, you need to be conscious about the way field
2721 references are interpolated into the form.  By default, a reference will be
2722 interpolated as a Lisp string (in double-quotes) containing the field.  If
2723 you provide the @samp{N} mode switch, all referenced elements will be numbers
2724 (non-number fields will be zero) and interpolated as Lisp numbers, without
2725 quotes.  If you provide the @samp{L} flag, all fields will be interpolated
2726 literally, without quotes.  I.e., if you want a reference to be interpreted
2727 as a string by the Lisp form, enclose the reference operator itself in
2728 double-quotes, like @code{"$3"}.  Ranges are inserted as space-separated
2729 fields, so you can embed them in list or vector syntax.
2731 Here are a few examples---note how the @samp{N} mode is used when we do
2732 computations in Lisp:
2734 @example
2735 @r{Swap the first two characters of the content of column 1}
2736   '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2737 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2738   '(+ $1 $2);N
2739 @r{Compute the sum of columns 1--4, like Calc's @code{vsum($1..$4)}}
2740   '(apply '+ '($1..$4));N
2741 @end example
2743 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2744 @subsection Durations and time values
2745 @cindex Duration, computing
2746 @cindex Time, computing
2747 @vindex org-table-duration-custom-format
2749 If you want to compute time values use the @code{T} flag, either in Calc
2750 formulas or Elisp formulas:
2752 @example
2753 @group
2754   |  Task 1 |   Task 2 |    Total |
2755   |---------+----------+----------|
2756   |    2:12 |     1:47 | 03:59:00 |
2757   | 3:02:20 | -2:07:00 |     0.92 |
2758   #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2759 @end group
2760 @end example
2762 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2763 are optional.  With the @code{T} flag, computed durations will be displayed
2764 as @code{HH:MM:SS} (see the first formula above).  With the @code{t} flag,
2765 computed durations will be displayed according to the value of the variable
2766 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2767 will display the result as a fraction of hours (see the second formula in the
2768 example above).
2770 Negative duration values can be manipulated as well, and integers will be
2771 considered as seconds in addition and subtraction.
2773 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2774 @subsection Field and range formulas
2775 @cindex field formula
2776 @cindex range formula
2777 @cindex formula, for individual table field
2778 @cindex formula, for range of fields
2780 To assign a formula to a particular field, type it directly into the field,
2781 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}.  When you press
2782 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2783 the formula will be stored as the formula for this field, evaluated, and the
2784 current field will be replaced with the result.
2786 @cindex #+TBLFM
2787 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2788 below the table.  If you type the equation in the 4th field of the 3rd data
2789 line in the table, the formula will look like @samp{@@3$4=$1+$2}.  When
2790 inserting/deleting/swapping column and rows with the appropriate commands,
2791 @i{absolute references} (but not relative ones) in stored formulas are
2792 modified in order to still reference the same field.  To avoid this from
2793 happening, in particular in range references, anchor ranges at the table
2794 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2795 using the @code{@@I} notation.  Automatic adaptation of field references does
2796 of course not happen if you edit the table structure with normal editing
2797 commands---then you must fix the equations yourself.
2799 Instead of typing an equation into the field, you may also use the following
2800 command
2802 @table @kbd
2803 @orgcmd{C-u C-c =,org-table-eval-formula}
2804 Install a new formula for the current field.  The command prompts for a
2805 formula with default taken from the @samp{#+TBLFM:} line, applies
2806 it to the current field, and stores it.
2807 @end table
2809 The left-hand side of a formula can also be a special expression in order to
2810 assign the formula to a number of different fields.  There is no keyboard
2811 shortcut to enter such range formulas.  To add them, use the formula editor
2812 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2813 directly.
2815 @table @code
2816 @item $2=
2817 Column formula, valid for the entire column.  This is so common that Org
2818 treats these formulas in a special way, see @ref{Column formulas}.
2819 @item @@3=
2820 Row formula, applies to all fields in the specified row.  @code{@@>=} means
2821 the last row.
2822 @item @@1$2..@@4$3=
2823 Range formula, applies to all fields in the given rectangular range.  This
2824 can also be used to assign a formula to some but not all fields in a row.
2825 @item $name=
2826 Named field, see @ref{Advanced features}.
2827 @end table
2829 @node Column formulas, Lookup functions, Field and range formulas, The spreadsheet
2830 @subsection Column formulas
2831 @cindex column formula
2832 @cindex formula, for table column
2834 When you assign a formula to a simple column reference like @code{$3=}, the
2835 same formula will be used in all fields of that column, with the following
2836 very convenient exceptions: (i) If the table contains horizontal separator
2837 hlines with rows above and below, everything before the first such hline is
2838 considered part of the table @emph{header} and will not be modified by column
2839 formulas.  Therefore a header is mandatory when you use column formulas and
2840 want to add hlines to group rows, like for example to separate a total row at
2841 the bottom from the summand rows above.  (ii) Fields that already get a value
2842 from a field/range formula will be left alone by column formulas.  These
2843 conditions make column formulas very easy to use.
2845 To assign a formula to a column, type it directly into any field in the
2846 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2847 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2848 the formula will be stored as the formula for the current column, evaluated
2849 and the current field replaced with the result.  If the field contains only
2850 @samp{=}, the previously stored formula for this column is used.  For each
2851 column, Org will only remember the most recently used formula.  In the
2852 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}.  The
2853 left-hand side of a column formula can not be the name of column, it must be
2854 the numeric column reference or @code{$>}.
2856 Instead of typing an equation into the field, you may also use the
2857 following command:
2859 @table @kbd
2860 @orgcmd{C-c =,org-table-eval-formula}
2861 Install a new formula for the current column and replace current field with
2862 the result of the formula.  The command prompts for a formula, with default
2863 taken from the @samp{#+TBLFM} line, applies it to the current field and
2864 stores it.  With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2865 will apply it to that many consecutive fields in the current column.
2866 @end table
2868 @node Lookup functions, Editing and debugging formulas, Column formulas, The spreadsheet
2869 @subsection Lookup functions
2870 @cindex lookup functions in tables
2871 @cindex table lookup functions
2873 Org has three predefined Emacs Lisp functions for lookups in tables.
2874 @table @code
2875 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2876 @findex org-lookup-first
2877 Searches for the first element @code{S} in list @code{S-LIST} for which
2878 @lisp
2879 (PREDICATE VAL S)
2880 @end lisp
2881 is @code{t}; returns the value from the corresponding position in list
2882 @code{R-LIST}.  The default @code{PREDICATE} is @code{equal}.  Note that the
2883 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2884 order as the corresponding parameters are in the call to
2885 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}.  If
2886 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2887 is returned.
2888 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2889 @findex org-lookup-last
2890 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2891 element for which @code{PREDICATE} is @code{t}.
2892 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2893 @findex org-lookup-all
2894 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2895 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2896 values.  This function can not be used by itself in a formula, because it
2897 returns a list of values.  However, powerful lookups can be built when this
2898 function is combined with other Emacs Lisp functions.
2899 @end table
2901 If the ranges used in these functions contain empty fields, the @code{E} mode
2902 for the formula should usually be specified: otherwise empty fields will not be
2903 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2904 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2905 element of @code{R-LIST}.
2907 These three functions can be used to implement associative arrays, count
2908 matching cells, rank results, group data etc.  For practical examples
2909 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2910 tutorial on Worg}.
2912 @node Editing and debugging formulas, Updating the table, Lookup functions, The spreadsheet
2913 @subsection Editing and debugging formulas
2914 @cindex formula editing
2915 @cindex editing, of table formulas
2917 @vindex org-table-use-standard-references
2918 You can edit individual formulas in the minibuffer or directly in the
2919 field.  Org can also prepare a special buffer with all active
2920 formulas of a table.  When offering a formula for editing, Org
2921 converts references to the standard format (like @code{B3} or @code{D&})
2922 if possible.  If you prefer to only work with the internal format (like
2923 @code{@@3$2} or @code{$4}), configure the variable
2924 @code{org-table-use-standard-references}.
2926 @table @kbd
2927 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2928 Edit the formula associated with the current column/field in the
2929 minibuffer.  See @ref{Column formulas}, and @ref{Field and range formulas}.
2930 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2931 Re-insert the active formula (either a
2932 field formula, or a column formula) into the current field, so that you
2933 can edit it directly in the field.  The advantage over editing in the
2934 minibuffer is that you can use the command @kbd{C-c ?}.
2935 @orgcmd{C-c ?,org-table-field-info}
2936 While editing a formula in a table field, highlight the field(s)
2937 referenced by the reference at the cursor position in the formula.
2938 @kindex C-c @}
2939 @findex org-table-toggle-coordinate-overlays
2940 @item C-c @}
2941 Toggle the display of row and column numbers for a table, using overlays
2942 (@command{org-table-toggle-coordinate-overlays}).  These are updated each
2943 time the table is aligned; you can force it with @kbd{C-c C-c}.
2944 @kindex C-c @{
2945 @findex org-table-toggle-formula-debugger
2946 @item C-c @{
2947 Toggle the formula debugger on and off
2948 (@command{org-table-toggle-formula-debugger}).  See below.
2949 @orgcmd{C-c ',org-table-edit-formulas}
2950 Edit all formulas for the current table in a special buffer, where the
2951 formulas will be displayed one per line.  If the current field has an
2952 active formula, the cursor in the formula editor will mark it.
2953 While inside the special buffer, Org will automatically highlight
2954 any field or range reference at the cursor position.  You may edit,
2955 remove and add formulas, and use the following commands:
2957 @table @kbd
2958 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2959 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
2960 prefix, also apply the new formulas to the entire table.
2961 @orgcmd{C-c C-q,org-table-fedit-abort}
2962 Exit the formula editor without installing changes.
2963 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2964 Toggle all references in the formula editor between standard (like
2965 @code{B3}) and internal (like @code{@@3$2}).
2966 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2967 Pretty-print or indent Lisp formula at point.  When in a line containing
2968 a Lisp formula, format the formula according to Emacs Lisp rules.
2969 Another @key{TAB} collapses the formula back again.  In the open
2970 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2971 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2972 Complete Lisp symbols, just like in Emacs Lisp mode.
2973 @kindex S-@key{up}
2974 @kindex S-@key{down}
2975 @kindex S-@key{left}
2976 @kindex S-@key{right}
2977 @findex org-table-fedit-ref-up
2978 @findex org-table-fedit-ref-down
2979 @findex org-table-fedit-ref-left
2980 @findex org-table-fedit-ref-right
2981 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2982 Shift the reference at point.  For example, if the reference is
2983 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2984 This also works for relative references and for hline references.
2985 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2986 Move the test line for column formulas in the Org buffer up and
2987 down.
2988 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2989 Scroll the window displaying the table.
2990 @kindex C-c @}
2991 @findex org-table-toggle-coordinate-overlays
2992 @item C-c @}
2993 Turn the coordinate grid in the table on and off.
2994 @end table
2995 @end table
2997 Making a table field blank does not remove the formula associated with
2998 the field, because that is stored in a different line (the @samp{#+TBLFM}
2999 line)---during the next recalculation the field will be filled again.
3000 To remove a formula from a field, you have to give an empty reply when
3001 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3003 @kindex C-c C-c
3004 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3005 equations with @kbd{C-c C-c} in that line or with the normal
3006 recalculation commands in the table.
3008 @anchor{Using multiple #+TBLFM lines}
3009 @subsubheading Using multiple #+TBLFM lines
3010 @cindex #+TBLFM line, multiple
3011 @cindex #+TBLFM
3012 @cindex #+TBLFM, switching
3013 @kindex C-c C-c
3015 You may apply the formula temporarily.  This is useful when you
3016 switch the formula.  Place multiple @samp{#+TBLFM} lines right
3017 after the table, and then press @kbd{C-c C-c} on the formula to
3018 apply.  Here is an example:
3020 @example
3021 | x | y |
3022 |---+---|
3023 | 1 |   |
3024 | 2 |   |
3025 #+TBLFM: $2=$1*1
3026 #+TBLFM: $2=$1*2
3027 @end example
3029 @noindent
3030 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3032 @example
3033 | x | y |
3034 |---+---|
3035 | 1 | 2 |
3036 | 2 | 4 |
3037 #+TBLFM: $2=$1*1
3038 #+TBLFM: $2=$1*2
3039 @end example
3041 @noindent
3042 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3043 will get the following result of applying only the first @samp{#+TBLFM} line.
3045 @example
3046 | x | y |
3047 |---+---|
3048 | 1 | 1 |
3049 | 2 | 2 |
3050 #+TBLFM: $2=$1*1
3051 #+TBLFM: $2=$1*2
3052 @end example
3054 @subsubheading Debugging formulas
3055 @cindex formula debugging
3056 @cindex debugging, of table formulas
3057 When the evaluation of a formula leads to an error, the field content
3058 becomes the string @samp{#ERROR}.  If you would like see what is going
3059 on during variable substitution and calculation in order to find a bug,
3060 turn on formula debugging in the @code{Tbl} menu and repeat the
3061 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3062 field.  Detailed information will be displayed.
3064 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
3065 @subsection Updating the table
3066 @cindex recomputing table fields
3067 @cindex updating, table
3069 Recalculation of a table is normally not automatic, but needs to be
3070 triggered by a command.  See @ref{Advanced features}, for a way to make
3071 recalculation at least semi-automatic.
3073 In order to recalculate a line of a table or the entire table, use the
3074 following commands:
3076 @table @kbd
3077 @orgcmd{C-c *,org-table-recalculate}
3078 Recalculate the current row by first applying the stored column formulas
3079 from left to right, and all field/range formulas in the current row.
3081 @kindex C-u C-c *
3082 @item C-u C-c *
3083 @kindex C-u C-c C-c
3084 @itemx C-u C-c C-c
3085 Recompute the entire table, line by line.  Any lines before the first
3086 hline are left alone, assuming that these are part of the table header.
3088 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3089 Iterate the table by recomputing it until no further changes occur.
3090 This may be necessary if some computed fields use the value of other
3091 fields that are computed @i{later} in the calculation sequence.
3092 @item M-x org-table-recalculate-buffer-tables
3093 @findex org-table-recalculate-buffer-tables
3094 Recompute all tables in the current buffer.
3095 @item M-x org-table-iterate-buffer-tables
3096 @findex org-table-iterate-buffer-tables
3097 Iterate all tables in the current buffer, in order to converge table-to-table
3098 dependencies.
3099 @end table
3101 @node Advanced features,  , Updating the table, The spreadsheet
3102 @subsection Advanced features
3104 If you want the recalculation of fields to happen automatically, or if you
3105 want to be able to assign @i{names}@footnote{Such names must start by an
3106 alphabetic character and use only alphanumeric/underscore characters.} to
3107 fields and columns, you need to reserve the first column of the table for
3108 special marking characters.
3110 @table @kbd
3111 @orgcmd{C-#,org-table-rotate-recalc-marks}
3112 Rotate the calculation mark in first column through the states @samp{ },
3113 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
3114 change all marks in the region.
3115 @end table
3117 Here is an example of a table that collects exam results of students and
3118 makes use of these features:
3120 @example
3121 @group
3122 |---+---------+--------+--------+--------+-------+------|
3123 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3124 |---+---------+--------+--------+--------+-------+------|
3125 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
3126 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
3127 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
3128 |---+---------+--------+--------+--------+-------+------|
3129 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
3130 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
3131 |---+---------+--------+--------+--------+-------+------|
3132 |   | Average |        |        |        |  25.0 |      |
3133 | ^ |         |        |        |        |    at |      |
3134 | $ | max=50  |        |        |        |       |      |
3135 |---+---------+--------+--------+--------+-------+------|
3136 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3137 @end group
3138 @end example
3140 @noindent @b{Important}: please note that for these special tables,
3141 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3142 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3143 to the field itself.  The column formulas are not applied in rows with
3144 empty first field.
3146 @cindex marking characters, tables
3147 The marking characters have the following meaning:
3149 @table @samp
3150 @item !
3151 The fields in this line define names for the columns, so that you may
3152 refer to a column as @samp{$Tot} instead of @samp{$6}.
3153 @item ^
3154 This row defines names for the fields @emph{above} the row.  With such
3155 a definition, any formula in the table may use @samp{$m1} to refer to
3156 the value @samp{10}.  Also, if you assign a formula to a names field, it
3157 will be stored as @samp{$name=...}.
3158 @item _
3159 Similar to @samp{^}, but defines names for the fields in the row
3160 @emph{below}.
3161 @item $
3162 Fields in this row can define @emph{parameters} for formulas.  For
3163 example, if a field in a @samp{$} row contains @samp{max=50}, then
3164 formulas in this table can refer to the value 50 using @samp{$max}.
3165 Parameters work exactly like constants, only that they can be defined on
3166 a per-table basis.
3167 @item #
3168 Fields in this row are automatically recalculated when pressing
3169 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
3170 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
3171 lines will be left alone by this command.
3172 @item *
3173 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3174 not for automatic recalculation.  Use this when automatic
3175 recalculation slows down editing too much.
3176 @item @w{ }
3177 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3178 All lines that should be recalculated should be marked with @samp{#}
3179 or @samp{*}.
3180 @item /
3181 Do not export this line.  Useful for lines that contain the narrowing
3182 @samp{<N>} markers or column group markers.
3183 @end table
3185 Finally, just to whet your appetite for what can be done with the
3186 fantastic @file{calc.el} package, here is a table that computes the Taylor
3187 series of degree @code{n} at location @code{x} for a couple of
3188 functions.
3190 @example
3191 @group
3192 |---+-------------+---+-----+--------------------------------------|
3193 |   | Func        | n | x   | Result                               |
3194 |---+-------------+---+-----+--------------------------------------|
3195 | # | exp(x)      | 1 | x   | 1 + x                                |
3196 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
3197 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
3198 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3199 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
3200 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
3201 |---+-------------+---+-----+--------------------------------------|
3202 #+TBLFM: $5=taylor($2,$4,$3);n3
3203 @end group
3204 @end example
3206 @node Org-Plot,  , The spreadsheet, Tables
3207 @section Org-Plot
3208 @cindex graph, in tables
3209 @cindex plot tables using Gnuplot
3210 @cindex #+PLOT
3212 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3213 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3214 @uref{http://xafs.org/BruceRavel/GnuplotMode}.  To see this in action, ensure
3215 that you have both Gnuplot and Gnuplot mode installed on your system, then
3216 call @code{org-plot/gnuplot} on the following table.
3218 @example
3219 @group
3220 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3221 | Sede      | Max cites | H-index |
3222 |-----------+-----------+---------|
3223 | Chile     |    257.72 |   21.39 |
3224 | Leeds     |    165.77 |   19.68 |
3225 | Sao Paolo |     71.00 |   11.50 |
3226 | Stockholm |    134.19 |   14.33 |
3227 | Morelia   |    257.56 |   17.67 |
3228 @end group
3229 @end example
3231 Notice that Org Plot is smart enough to apply the table's headers as labels.
3232 Further control over the labels, type, content, and appearance of plots can
3233 be exercised through the @code{#+PLOT:} lines preceding a table.  See below
3234 for a complete list of Org-plot options.  For more information and examples
3235 see the Org-plot tutorial at
3236 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3238 @subsubheading Plot Options
3240 @table @code
3241 @item set
3242 Specify any @command{gnuplot} option to be set when graphing.
3244 @item title
3245 Specify the title of the plot.
3247 @item ind
3248 Specify which column of the table to use as the @code{x} axis.
3250 @item deps
3251 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3252 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3253 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3254 column).
3256 @item type
3257 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3259 @item with
3260 Specify a @code{with} option to be inserted for every col being plotted
3261 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3262 Defaults to @code{lines}.
3264 @item file
3265 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3267 @item labels
3268 List of labels to be used for the @code{deps} (defaults to the column headers
3269 if they exist).
3271 @item line
3272 Specify an entire line to be inserted in the Gnuplot script.
3274 @item map
3275 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3276 flat mapping rather than a @code{3d} slope.
3278 @item timefmt
3279 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3280 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3282 @item script
3283 If you want total control, you can specify a script file (place the file name
3284 between double-quotes) which will be used to plot.  Before plotting, every
3285 instance of @code{$datafile} in the specified script will be replaced with
3286 the path to the generated data file.  Note: even if you set this option, you
3287 may still want to specify the plot type, as that can impact the content of
3288 the data file.
3289 @end table
3291 @node Hyperlinks, TODO Items, Tables, Top
3292 @chapter Hyperlinks
3293 @cindex hyperlinks
3295 Like HTML, Org provides links inside a file, external links to
3296 other files, Usenet articles, emails, and much more.
3298 @menu
3299 * Link format::                 How links in Org are formatted
3300 * Internal links::              Links to other places in the current file
3301 * External links::              URL-like links to the world
3302 * Handling links::              Creating, inserting and following
3303 * Using links outside Org::     Linking from my C source code?
3304 * Link abbreviations::          Shortcuts for writing complex links
3305 * Search options::              Linking to a specific location
3306 * Custom searches::             When the default search is not enough
3307 @end menu
3309 @node Link format, Internal links, Hyperlinks, Hyperlinks
3310 @section Link format
3311 @cindex link format
3312 @cindex format, of links
3314 Org will recognize plain URL-like links and activate them as
3315 clickable links.  The general link format, however, looks like this:
3317 @example
3318 [[link][description]]       @r{or alternatively}           [[link]]
3319 @end example
3321 @noindent
3322 Once a link in the buffer is complete (all brackets present), Org
3323 will change the display so that @samp{description} is displayed instead
3324 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3325 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
3326 which by default is an underlined face.  You can directly edit the
3327 visible part of a link.  Note that this can be either the @samp{link}
3328 part (if there is no description) or the @samp{description} part.  To
3329 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3330 cursor on the link.
3332 If you place the cursor at the beginning or just behind the end of the
3333 displayed text and press @key{BACKSPACE}, you will remove the
3334 (invisible) bracket at that location.  This makes the link incomplete
3335 and the internals are again displayed as plain text.  Inserting the
3336 missing bracket hides the link internals again.  To show the
3337 internal structure of all links, use the menu entry
3338 @code{Org->Hyperlinks->Literal links}.
3340 @node Internal links, External links, Link format, Hyperlinks
3341 @section Internal links
3342 @cindex internal links
3343 @cindex links, internal
3344 @cindex targets, for links
3346 @cindex property, CUSTOM_ID
3347 If the link does not look like a URL, it is considered to be internal in the
3348 current file.  The most important case is a link like
3349 @samp{[[#my-custom-id]]} which will link to the entry with the
3350 @code{CUSTOM_ID} property @samp{my-custom-id}.  You are responsible yourself
3351 to make sure these custom IDs are unique in a file.
3353 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3354 lead to a text search in the current file.
3356 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3357 or with a mouse click (@pxref{Handling links}).  Links to custom IDs will
3358 point to the corresponding headline.  The preferred match for a text link is
3359 a @i{dedicated target}: the same string in double angular brackets, like
3360 @samp{<<My Target>>}.
3362 @cindex #+NAME
3363 If no dedicated target exists, the link will then try to match the exact name
3364 of an element within the buffer.  Naming is done with the @code{#+NAME}
3365 keyword, which has to be put the line before the element it refers to, as in
3366 the following example
3368 @example
3369 #+NAME: My Target
3370 | a  | table      |
3371 |----+------------|
3372 | of | four cells |
3373 @end example
3375 If none of the above succeeds, Org will search for a headline that is exactly
3376 the link text but may also include a TODO keyword and tags@footnote{To insert
3377 a link targeting a headline, in-buffer completion can be used.  Just type
3378 a star followed by a few optional letters into the buffer and press
3379 @kbd{M-@key{TAB}}.  All headlines in the current buffer will be offered as
3380 completions.}.
3382 During export, internal links will be used to mark objects and assign them
3383 a number.  Marked objects will then be referenced by links pointing to them.
3384 In particular, links without a description will appear as the number assigned
3385 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3386 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3387 (@pxref{Images and tables}).}.  In the following excerpt from an Org buffer
3389 @example
3390 - one item
3391 - <<target>>another item
3392 Here we refer to item [[target]].
3393 @end example
3395 @noindent
3396 The last sentence will appear as @samp{Here we refer to item 2} when
3397 exported.
3399 In non-Org files, the search will look for the words in the link text.  In
3400 the above example the search would be for @samp{my target}.
3402 Following a link pushes a mark onto Org's own mark ring.  You can
3403 return to the previous position with @kbd{C-c &}.  Using this command
3404 several times in direct succession goes back to positions recorded
3405 earlier.
3407 @menu
3408 * Radio targets::               Make targets trigger links in plain text
3409 @end menu
3411 @node Radio targets,  , Internal links, Internal links
3412 @subsection Radio targets
3413 @cindex radio targets
3414 @cindex targets, radio
3415 @cindex links, radio targets
3417 Org can automatically turn any occurrences of certain target names
3418 in normal text into a link.  So without explicitly creating a link, the
3419 text connects to the target radioing its position.  Radio targets are
3420 enclosed by triple angular brackets.  For example, a target @samp{<<<My
3421 Target>>>} causes each occurrence of @samp{my target} in normal text to
3422 become activated as a link.  The Org file is scanned automatically
3423 for radio targets only when the file is first loaded into Emacs.  To
3424 update the target list during editing, press @kbd{C-c C-c} with the
3425 cursor on or at a target.
3427 @node External links, Handling links, Internal links, Hyperlinks
3428 @section External links
3429 @cindex links, external
3430 @cindex external links
3431 @cindex links, external
3432 @cindex Gnus links
3433 @cindex BBDB links
3434 @cindex IRC links
3435 @cindex URL links
3436 @cindex file links
3437 @cindex VM links
3438 @cindex RMAIL links
3439 @cindex WANDERLUST links
3440 @cindex MH-E links
3441 @cindex USENET links
3442 @cindex SHELL links
3443 @cindex Info links
3444 @cindex Elisp links
3446 Org supports links to files, websites, Usenet and email messages,
3447 BBDB database entries and links to both IRC conversations and their
3448 logs.  External links are URL-like locators.  They start with a short
3449 identifying string followed by a colon.  There can be no space after
3450 the colon.  The following list shows examples for each link type.
3452 @example
3453 http://www.astro.uva.nl/~dominik          @r{on the web}
3454 doi:10.1000/182                           @r{DOI for an electronic resource}
3455 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
3456 /home/dominik/images/jupiter.jpg          @r{same as above}
3457 file:papers/last.pdf                      @r{file, relative path}
3458 ./papers/last.pdf                         @r{same as above}
3459 file:/myself@@some.where:papers/last.pdf   @r{file, path on remote machine}
3460 /myself@@some.where:papers/last.pdf        @r{same as above}
3461 file:sometextfile::NNN                    @r{file, jump to line number}
3462 file:projects.org                         @r{another Org file}
3463 file:projects.org::some words             @r{text search in Org file}@footnote{
3464 The actual behavior of the search will depend on the value of
3465 the variable @code{org-link-search-must-match-exact-headline}.  If its value
3466 is nil, then a fuzzy text search will be done.  If it is t, then only the
3467 exact headline will be matched.  If the value is @code{'query-to-create},
3468 then an exact headline will be searched; if it is not found, then the user
3469 will be queried to create it.}
3470 file:projects.org::*task title            @r{heading search in Org file}
3471 file+sys:/path/to/file                    @r{open via OS, like double-click}
3472 file+emacs:/path/to/file                  @r{force opening by Emacs}
3473 docview:papers/last.pdf::NNN              @r{open in doc-view mode at page}
3474 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
3475 news:comp.emacs                           @r{Usenet link}
3476 mailto:adent@@galaxy.net                   @r{Mail link}
3477 vm:folder                                 @r{VM folder link}
3478 vm:folder#id                              @r{VM message link}
3479 vm://myself@@some.where.org/folder#id      @r{VM on remote machine}
3480 vm-imap:account:folder                    @r{VM IMAP folder link}
3481 vm-imap:account:folder#id                 @r{VM IMAP message link}
3482 wl:folder                                 @r{WANDERLUST folder link}
3483 wl:folder#id                              @r{WANDERLUST message link}
3484 mhe:folder                                @r{MH-E folder link}
3485 mhe:folder#id                             @r{MH-E message link}
3486 rmail:folder                              @r{RMAIL folder link}
3487 rmail:folder#id                           @r{RMAIL message link}
3488 gnus:group                                @r{Gnus group link}
3489 gnus:group#id                             @r{Gnus article link}
3490 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
3491 irc:/irc.com/#emacs/bob                   @r{IRC link}
3492 info:org#External links                   @r{Info node link}
3493 shell:ls *.org                            @r{A shell command}
3494 elisp:org-agenda                          @r{Interactive Elisp command}
3495 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3496 @end example
3498 For customizing Org to add new link types @ref{Adding hyperlink types}.
3500 A link should be enclosed in double brackets and may contain a
3501 descriptive text to be displayed instead of the URL (@pxref{Link
3502 format}), for example:
3504 @example
3505 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3506 @end example
3508 @noindent
3509 If the description is a file name or URL that points to an image, HTML
3510 export (@pxref{HTML export}) will inline the image as a clickable
3511 button.  If there is no description at all and the link points to an
3512 image,
3513 that image will be inlined into the exported HTML file.
3515 @cindex square brackets, around links
3516 @cindex plain text external links
3517 Org also finds external links in the normal text and activates them
3518 as links.  If spaces must be part of the link (for example in
3519 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3520 about the end of the link, enclose them in square brackets.
3522 @node Handling links, Using links outside Org, External links, Hyperlinks
3523 @section Handling links
3524 @cindex links, handling
3526 Org provides methods to create a link in the correct syntax, to
3527 insert it into an Org file, and to follow the link.
3529 @table @kbd
3530 @orgcmd{C-c l,org-store-link}
3531 @cindex storing links
3532 Store a link to the current location.  This is a @emph{global} command (you
3533 must create the key binding yourself) which can be used in any buffer to
3534 create a link.  The link will be stored for later insertion into an Org
3535 buffer (see below).  What kind of link will be created depends on the current
3536 buffer:
3538 @b{Org mode buffers}@*
3539 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3540 to the target.  Otherwise it points to the current headline, which will also
3541 be the description@footnote{If the headline contains a timestamp, it will be
3542 removed from the link and result in a wrong link---you should avoid putting
3543 timestamp in the headline.}.
3545 @vindex org-id-link-to-org-use-id
3546 @cindex property, CUSTOM_ID
3547 @cindex property, ID
3548 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3549 will be stored.  In addition or alternatively (depending on the value of
3550 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3551 be created and/or used to construct a link@footnote{The library @code{org-id}
3552 must first be loaded, either through @code{org-customize} by enabling
3553 @code{id} in @code{org-modules} , or by adding @code{(require 'org-id)} in
3554 your @file{.emacs}.}. So using this command in Org
3555 buffers will potentially create two links: a human-readable from the custom
3556 ID, and one that is globally unique and works even if the entry is moved from
3557 file to file.  Later, when inserting the link, you need to decide which one
3558 to use.
3560 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3561 Pretty much all Emacs mail clients are supported.  The link will point to the
3562 current article, or, in some GNUS buffers, to the group.  The description is
3563 constructed from the author and the subject.
3565 @b{Web browsers: W3 and W3M}@*
3566 Here the link will be the current URL, with the page title as description.
3568 @b{Contacts: BBDB}@*
3569 Links created in a BBDB buffer will point to the current entry.
3571 @b{Chat: IRC}@*
3572 @vindex org-irc-link-to-logs
3573 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3574 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3575 the current conversation is created.  Otherwise an @samp{irc:/} style link to
3576 the user/channel/server under the point will be stored.
3578 @b{Other files}@*
3579 For any other files, the link will point to the file, with a search string
3580 (@pxref{Search options}) pointing to the contents of the current line.  If
3581 there is an active region, the selected words will form the basis of the
3582 search string.  If the automatically created link is not working correctly or
3583 accurately enough, you can write custom functions to select the search string
3584 and to do the search for particular file types---see @ref{Custom searches}.
3585 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3587 @b{Agenda view}@*
3588 When the cursor is in an agenda view, the created link points to the
3589 entry referenced by the current line.
3592 @orgcmd{C-c C-l,org-insert-link}
3593 @cindex link completion
3594 @cindex completion, of links
3595 @cindex inserting links
3596 @vindex org-keep-stored-link-after-insertion
3597 Insert a link@footnote{ Note that you don't have to use this command to
3598 insert a link.  Links in Org are plain text, and you can type or paste them
3599 straight into the buffer.  By using this command, the links are automatically
3600 enclosed in double brackets, and you will be asked for the optional
3601 descriptive text.}.  This prompts for a link to be inserted into the buffer.
3602 You can just type a link, using text for an internal link, or one of the link
3603 type prefixes mentioned in the examples above.  The link will be inserted
3604 into the buffer@footnote{After insertion of a stored link, the link will be
3605 removed from the list of stored links.  To keep it in the list later use, use
3606 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3607 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3608 If some text was selected when this command is called, the selected text
3609 becomes the default description.
3611 @b{Inserting stored links}@*
3612 All links stored during the
3613 current session are part of the history for this prompt, so you can access
3614 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3616 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3617 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3618 defined through link abbreviations (@pxref{Link abbreviations}).  If you
3619 press @key{RET} after inserting only the @var{prefix}, Org will offer
3620 specific completion support for some link types@footnote{This works by
3621 calling a special function @code{org-PREFIX-complete-link}.}  For
3622 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3623 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3624 @key{RET}} you can complete contact names.
3625 @orgkey C-u C-c C-l
3626 @cindex file name completion
3627 @cindex completion, of file names
3628 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3629 a file will be inserted and you may use file name completion to select
3630 the name of the file.  The path to the file is inserted relative to the
3631 directory of the current Org file, if the linked file is in the current
3632 directory or in a sub-directory of it, or if the path is written relative
3633 to the current directory using @samp{../}.  Otherwise an absolute path
3634 is used, if possible with @samp{~/} for your home directory.  You can
3635 force an absolute path with two @kbd{C-u} prefixes.
3637 @item C-c C-l @ @r{(with cursor on existing link)}
3638 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3639 link and description parts of the link.
3641 @cindex following links
3642 @orgcmd{C-c C-o,org-open-at-point}
3643 @vindex org-file-apps
3644 @vindex org-link-frame-setup
3645 Open link at point.  This will launch a web browser for URLs (using
3646 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3647 the corresponding links, and execute the command in a shell link.  When the
3648 cursor is on an internal link, this command runs the corresponding search.
3649 When the cursor is on a TAG list in a headline, it creates the corresponding
3650 TAGS view.  If the cursor is on a timestamp, it compiles the agenda for that
3651 date.  Furthermore, it will visit text and remote files in @samp{file:} links
3652 with Emacs and select a suitable application for local non-text files.
3653 Classification of files is based on file extension only.  See option
3654 @code{org-file-apps}.  If you want to override the default application and
3655 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
3656 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3657 If the cursor is on a headline, but not on a link, offer all links in the
3658 headline and entry text.  If you want to setup the frame configuration for
3659 following links, customize @code{org-link-frame-setup}.
3661 @orgkey @key{RET}
3662 @vindex org-return-follows-link
3663 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3664 the link at point.
3666 @kindex mouse-2
3667 @kindex mouse-1
3668 @item mouse-2
3669 @itemx mouse-1
3670 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3671 would.  Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3673 @kindex mouse-3
3674 @item mouse-3
3675 @vindex org-display-internal-link-with-indirect-buffer
3676 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3677 internal links to be displayed in another window@footnote{See the
3678 variable @code{org-display-internal-link-with-indirect-buffer}}.
3680 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3681 @cindex inlining images
3682 @cindex images, inlining
3683 @vindex org-startup-with-inline-images
3684 @cindex @code{inlineimages}, STARTUP keyword
3685 @cindex @code{noinlineimages}, STARTUP keyword
3686 Toggle the inline display of linked images.  Normally this will only inline
3687 images that have no description part in the link, i.e., images that will also
3688 be inlined during export.  When called with a prefix argument, also display
3689 images that do have a link description.  You can ask for inline images to be
3690 displayed at startup by configuring the variable
3691 @code{org-startup-with-inline-images}@footnote{with corresponding
3692 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3693 @orgcmd{C-c %,org-mark-ring-push}
3694 @cindex mark ring
3695 Push the current position onto the mark ring, to be able to return
3696 easily.  Commands following an internal link do this automatically.
3698 @orgcmd{C-c &,org-mark-ring-goto}
3699 @cindex links, returning to
3700 Jump back to a recorded position.  A position is recorded by the
3701 commands following internal links, and by @kbd{C-c %}.  Using this
3702 command several times in direct succession moves through a ring of
3703 previously recorded positions.
3705 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3706 @cindex links, finding next/previous
3707 Move forward/backward to the next link in the buffer.  At the limit of
3708 the buffer, the search fails once, and then wraps around.  The key
3709 bindings for this are really too long; you might want to bind this also
3710 to @kbd{C-n} and @kbd{C-p}
3711 @lisp
3712 (add-hook 'org-load-hook
3713   (lambda ()
3714     (define-key org-mode-map "\C-n" 'org-next-link)
3715     (define-key org-mode-map "\C-p" 'org-previous-link)))
3716 @end lisp
3717 @end table
3719 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3720 @section Using links outside Org
3722 You can insert and follow links that have Org syntax not only in
3723 Org, but in any Emacs buffer.  For this, you should create two
3724 global commands, like this (please select suitable global keys
3725 yourself):
3727 @lisp
3728 (global-set-key "\C-c L" 'org-insert-link-global)
3729 (global-set-key "\C-c o" 'org-open-at-point-global)
3730 @end lisp
3732 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3733 @section Link abbreviations
3734 @cindex link abbreviations
3735 @cindex abbreviation, links
3737 Long URLs can be cumbersome to type, and often many similar links are
3738 needed in a document.  For this you can use link abbreviations.  An
3739 abbreviated link looks like this
3741 @example
3742 [[linkword:tag][description]]
3743 @end example
3745 @noindent
3746 @vindex org-link-abbrev-alist
3747 where the tag is optional.
3748 The @i{linkword} must be a word, starting with a letter, followed by
3749 letters, numbers, @samp{-}, and @samp{_}.  Abbreviations are resolved
3750 according to the information in the variable @code{org-link-abbrev-alist}
3751 that relates the linkwords to replacement text.  Here is an example:
3753 @smalllisp
3754 @group
3755 (setq org-link-abbrev-alist
3756   '(("bugzilla"  . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3757     ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3758     ("google"    . "http://www.google.com/search?q=")
3759     ("gmap"      . "http://maps.google.com/maps?q=%s")
3760     ("omap"      . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3761     ("ads"       . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3762 @end group
3763 @end smalllisp
3765 If the replacement text contains the string @samp{%s}, it will be
3766 replaced with the tag.  Using @samp{%h} instead of @samp{%s} will
3767 url-encode the tag (see the example above, where we need to encode
3768 the URL parameter.)  Using @samp{%(my-function)} will pass the tag
3769 to a custom function, and replace it by the resulting string.
3771 If the replacement text don't contain any specifier, it will simply
3772 be appended to the string in order to create the link.
3774 Instead of a string, you may also specify a function that will be
3775 called with the tag as the only argument to create the link.
3777 With the above setting, you could link to a specific bug with
3778 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3779 @code{[[google:OrgMode]]}, show the map location of the Free Software
3780 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3781 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3782 what the Org author is doing besides Emacs hacking with
3783 @code{[[ads:Dominik,C]]}.
3785 If you need special abbreviations just for a single Org buffer, you
3786 can define them in the file with
3788 @cindex #+LINK
3789 @example
3790 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
3791 #+LINK: google    http://www.google.com/search?q=%s
3792 @end example
3794 @noindent
3795 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3796 complete link abbreviations.  You may also define a function
3797 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3798 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
3799 not accept any arguments, and return the full link with prefix.
3801 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3802 @section Search options in file links
3803 @cindex search option in file links
3804 @cindex file links, searching
3806 File links can contain additional information to make Emacs jump to a
3807 particular location in the file when following a link.  This can be a
3808 line number or a search option after a double@footnote{For backward
3809 compatibility, line numbers can also follow a single colon.} colon.  For
3810 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3811 links}) to a file, it encodes the words in the current line as a search
3812 string that can be used to find this line back later when following the
3813 link with @kbd{C-c C-o}.
3815 Here is the syntax of the different ways to attach a search to a file
3816 link, together with an explanation:
3818 @example
3819 [[file:~/code/main.c::255]]
3820 [[file:~/xx.org::My Target]]
3821 [[file:~/xx.org::*My Target]]
3822 [[file:~/xx.org::#my-custom-id]]
3823 [[file:~/xx.org::/regexp/]]
3824 @end example
3826 @table @code
3827 @item 255
3828 Jump to line 255.
3829 @item My Target
3830 Search for a link target @samp{<<My Target>>}, or do a text search for
3831 @samp{my target}, similar to the search in internal links, see
3832 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
3833 link will become a HTML reference to the corresponding named anchor in
3834 the linked file.
3835 @item *My Target
3836 In an Org file, restrict search to headlines.
3837 @item #my-custom-id
3838 Link to a heading with a @code{CUSTOM_ID} property
3839 @item /regexp/
3840 Do a regular expression search for @code{regexp}.  This uses the Emacs
3841 command @code{occur} to list all matches in a separate window.  If the
3842 target file is in Org mode, @code{org-occur} is used to create a
3843 sparse tree with the matches.
3844 @c If the target file is a directory,
3845 @c @code{grep} will be used to search all files in the directory.
3846 @end table
3848 As a degenerate case, a file link with an empty file name can be used
3849 to search the current file.  For example, @code{[[file:::find me]]} does
3850 a search for @samp{find me} in the current file, just as
3851 @samp{[[find me]]} would.
3853 @node Custom searches,  , Search options, Hyperlinks
3854 @section Custom Searches
3855 @cindex custom search strings
3856 @cindex search strings, custom
3858 The default mechanism for creating search strings and for doing the
3859 actual search related to a file link may not work correctly in all
3860 cases.  For example, Bib@TeX{} database files have many entries like
3861 @samp{year="1993"} which would not result in good search strings,
3862 because the only unique identification for a Bib@TeX{} entry is the
3863 citation key.
3865 @vindex org-create-file-search-functions
3866 @vindex org-execute-file-search-functions
3867 If you come across such a problem, you can write custom functions to set
3868 the right search string for a particular file type, and to do the search
3869 for the string in the file.  Using @code{add-hook}, these functions need
3870 to be added to the hook variables
3871 @code{org-create-file-search-functions} and
3872 @code{org-execute-file-search-functions}.  See the docstring for these
3873 variables for more information.  Org actually uses this mechanism
3874 for Bib@TeX{} database files, and you can use the corresponding code as
3875 an implementation example.  See the file @file{org-bibtex.el}.
3877 @node TODO Items, Tags, Hyperlinks, Top
3878 @chapter TODO items
3879 @cindex TODO items
3881 Org mode does not maintain TODO lists as separate documents@footnote{Of
3882 course, you can make a document that contains only long lists of TODO items,
3883 but this is not required.}.  Instead, TODO items are an integral part of the
3884 notes file, because TODO items usually come up while taking notes!  With Org
3885 mode, simply mark any entry in a tree as being a TODO item.  In this way,
3886 information is not duplicated, and the entire context from which the TODO
3887 item emerged is always present.
3889 Of course, this technique for managing TODO items scatters them
3890 throughout your notes file.  Org mode compensates for this by providing
3891 methods to give you an overview of all the things that you have to do.
3893 @menu
3894 * TODO basics::                 Marking and displaying TODO entries
3895 * TODO extensions::             Workflow and assignments
3896 * Progress logging::            Dates and notes for progress
3897 * Priorities::                  Some things are more important than others
3898 * Breaking down tasks::         Splitting a task into manageable pieces
3899 * Checkboxes::                  Tick-off lists
3900 @end menu
3902 @node TODO basics, TODO extensions, TODO Items, TODO Items
3903 @section Basic TODO functionality
3905 Any headline becomes a TODO item when it starts with the word
3906 @samp{TODO}, for example:
3908 @example
3909 *** TODO Write letter to Sam Fortune
3910 @end example
3912 @noindent
3913 The most important commands to work with TODO entries are:
3915 @table @kbd
3916 @orgcmd{C-c C-t,org-todo}
3917 @cindex cycling, of TODO states
3918 @vindex org-use-fast-todo-selection
3920 Rotate the TODO state of the current item among
3922 @example
3923 ,-> (unmarked) -> TODO -> DONE --.
3924 '--------------------------------'
3925 @end example
3927 If TODO keywords have fast access keys (see @ref{Fast access to TODO
3928 states}), you will be prompted for a TODO keyword through the fast selection
3929 interface; this is the default behavior when
3930 @var{org-use-fast-todo-selection} is non-nil.
3932 The same rotation can also be done ``remotely'' from the timeline and agenda
3933 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3935 @orgkey{C-u C-c C-t}
3936 When TODO keywords have no selection keys, select a specific keyword using
3937 completion; otherwise force cycling through TODO states with no prompt.  When
3938 @var{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
3939 selection interface.
3941 @kindex S-@key{right}
3942 @kindex S-@key{left}
3943 @item S-@key{right} @ @r{/} @ S-@key{left}
3944 @vindex org-treat-S-cursor-todo-selection-as-state-change
3945 Select the following/preceding TODO state, similar to cycling.  Useful
3946 mostly if more than two TODO states are possible (@pxref{TODO
3947 extensions}).  See also @ref{Conflicts}, for a discussion of the interaction
3948 with @code{shift-selection-mode}.  See also the variable
3949 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3950 @orgcmd{C-c / t,org-show-todo-tree}
3951 @cindex sparse tree, for TODO
3952 @vindex org-todo-keywords
3953 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
3954 entire buffer, but shows all TODO items (with not-DONE state) and the
3955 headings hierarchy above them.  With a prefix argument (or by using @kbd{C-c
3956 / T}), search for a specific TODO@.  You will be prompted for the keyword, and
3957 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3958 entries that match any one of these keywords.  With a numeric prefix argument
3959 N, show the tree for the Nth keyword in the variable
3960 @code{org-todo-keywords}.  With two prefix arguments, find all TODO states,
3961 both un-done and done.
3962 @orgcmd{C-c a t,org-todo-list}
3963 Show the global TODO list.  Collects the TODO items (with not-DONE states)
3964 from all agenda files (@pxref{Agenda Views}) into a single buffer.  The new
3965 buffer will be in @code{agenda-mode}, which provides commands to examine and
3966 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3967 @xref{Global TODO list}, for more information.
3968 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3969 Insert a new TODO entry below the current one.
3970 @end table
3972 @noindent
3973 @vindex org-todo-state-tags-triggers
3974 Changing a TODO state can also trigger tag changes.  See the docstring of the
3975 option @code{org-todo-state-tags-triggers} for details.
3977 @node TODO extensions, Progress logging, TODO basics, TODO Items
3978 @section Extended use of TODO keywords
3979 @cindex extended TODO keywords
3981 @vindex org-todo-keywords
3982 By default, marked TODO entries have one of only two states: TODO and
3983 DONE@.  Org mode allows you to classify TODO items in more complex ways
3984 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
3985 special setup, the TODO keyword system can work differently in different
3986 files.
3988 Note that @i{tags} are another way to classify headlines in general and
3989 TODO items in particular (@pxref{Tags}).
3991 @menu
3992 * Workflow states::             From TODO to DONE in steps
3993 * TODO types::                  I do this, Fred does the rest
3994 * Multiple sets in one file::   Mixing it all, and still finding your way
3995 * Fast access to TODO states::  Single letter selection of a state
3996 * Per-file keywords::           Different files, different requirements
3997 * Faces for TODO keywords::     Highlighting states
3998 * TODO dependencies::           When one task needs to wait for others
3999 @end menu
4001 @node Workflow states, TODO types, TODO extensions, TODO extensions
4002 @subsection TODO keywords as workflow states
4003 @cindex TODO workflow
4004 @cindex workflow states as TODO keywords
4006 You can use TODO keywords to indicate different @emph{sequential} states
4007 in the process of working on an item, for example@footnote{Changing
4008 this variable only becomes effective after restarting Org mode in a
4009 buffer.}:
4011 @lisp
4012 (setq org-todo-keywords
4013   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4014 @end lisp
4016 The vertical bar separates the TODO keywords (states that @emph{need
4017 action}) from the DONE states (which need @emph{no further action}).  If
4018 you don't provide the separator bar, the last state is used as the DONE
4019 state.
4020 @cindex completion, of TODO keywords
4021 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4022 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@.  You may
4023 also use a numeric prefix argument to quickly select a specific state.  For
4024 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4025 Or you can use @kbd{S-@key{left}} to go backward through the sequence.  If you
4026 define many keywords, you can use in-buffer completion
4027 (@pxref{Completion}) or even a special one-key selection scheme
4028 (@pxref{Fast access to TODO states}) to insert these words into the
4029 buffer.  Changing a TODO state can be logged with a timestamp, see
4030 @ref{Tracking TODO state changes}, for more information.
4032 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
4033 @subsection TODO keywords as types
4034 @cindex TODO types
4035 @cindex names as TODO keywords
4036 @cindex types as TODO keywords
4038 The second possibility is to use TODO keywords to indicate different
4039 @emph{types} of action items.  For example, you might want to indicate
4040 that items are for ``work'' or ``home''.  Or, when you work with several
4041 people on a single project, you might want to assign action items
4042 directly to persons, by using their names as TODO keywords.  This would
4043 be set up like this:
4045 @lisp
4046 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4047 @end lisp
4049 In this case, different keywords do not indicate a sequence, but rather
4050 different types.  So the normal work flow would be to assign a task to a
4051 person, and later to mark it DONE@.  Org mode supports this style by adapting
4052 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4053 @kbd{t} command in the timeline and agenda buffers.}.  When used several
4054 times in succession, it will still cycle through all names, in order to first
4055 select the right type for a task.  But when you return to the item after some
4056 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4057 to DONE@.  Use prefix arguments or completion to quickly select a specific
4058 name.  You can also review the items of a specific TODO type in a sparse tree
4059 by using a numeric prefix to @kbd{C-c / t}.  For example, to see all things
4060 Lucy has to do, you would use @kbd{C-3 C-c / t}.  To collect Lucy's items
4061 from all agenda files into a single buffer, you would use the numeric prefix
4062 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4064 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
4065 @subsection Multiple keyword sets in one file
4066 @cindex TODO keyword sets
4068 Sometimes you may want to use different sets of TODO keywords in
4069 parallel.  For example, you may want to have the basic
4070 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4071 separate state indicating that an item has been canceled (so it is not
4072 DONE, but also does not require action).  Your setup would then look
4073 like this:
4075 @lisp
4076 (setq org-todo-keywords
4077       '((sequence "TODO" "|" "DONE")
4078         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4079         (sequence "|" "CANCELED")))
4080 @end lisp
4082 The keywords should all be different, this helps Org mode to keep track
4083 of which subsequence should be used for a given entry.  In this setup,
4084 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4085 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4086 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
4087 select the correct sequence.  Besides the obvious ways like typing a
4088 keyword or using completion, you may also apply the following commands:
4090 @table @kbd
4091 @kindex C-S-@key{right}
4092 @kindex C-S-@key{left}
4093 @kindex C-u C-u C-c C-t
4094 @item C-u C-u C-c C-t
4095 @itemx C-S-@key{right}
4096 @itemx C-S-@key{left}
4097 These keys jump from one TODO subset to the next.  In the above example,
4098 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4099 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4100 @code{CANCELED}.  Note that the @kbd{C-S-} key binding conflict with
4101 @code{shift-selection-mode} (@pxref{Conflicts}).
4102 @kindex S-@key{right}
4103 @kindex S-@key{left}
4104 @item S-@key{right}
4105 @itemx S-@key{left}
4106 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
4107 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
4108 from @code{DONE} to @code{REPORT} in the example above.  See also
4109 @ref{Conflicts}, for a discussion of the interaction with
4110 @code{shift-selection-mode}.
4111 @end table
4113 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
4114 @subsection Fast access to TODO states
4116 If you would like to quickly change an entry to an arbitrary TODO state
4117 instead of cycling through the states, you can set up keys for single-letter
4118 access to the states.  This is done by adding the selection character after
4119 each keyword, in parentheses@footnote{All characters are allowed except
4120 @code{@@^!}, which have a special meaning here.}.  For example:
4122 @lisp
4123 (setq org-todo-keywords
4124       '((sequence "TODO(t)" "|" "DONE(d)")
4125         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4126         (sequence "|" "CANCELED(c)")))
4127 @end lisp
4129 @vindex org-fast-tag-selection-include-todo
4130 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4131 will be switched to this state.  @kbd{SPC} can be used to remove any TODO
4132 keyword from an entry.@footnote{Check also the variable
4133 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4134 state through the tags interface (@pxref{Setting tags}), in case you like to
4135 mingle the two concepts.  Note that this means you need to come up with
4136 unique keys across both sets of keywords.}
4138 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
4139 @subsection Setting up keywords for individual files
4140 @cindex keyword options
4141 @cindex per-file keywords
4142 @cindex #+TODO
4143 @cindex #+TYP_TODO
4144 @cindex #+SEQ_TODO
4146 It can be very useful to use different aspects of the TODO mechanism in
4147 different files.  For file-local settings, you need to add special lines
4148 to the file which set the keywords and interpretation for that file
4149 only.  For example, to set one of the two examples discussed above, you
4150 need one of the following lines, starting in column zero anywhere in the
4151 file:
4153 @example
4154 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4155 @end example
4156 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4157 interpretation, but it means the same as @code{#+TODO}), or
4158 @example
4159 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4160 @end example
4162 A setup for using several sets in parallel would be:
4164 @example
4165 #+TODO: TODO | DONE
4166 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4167 #+TODO: | CANCELED
4168 @end example
4170 @cindex completion, of option keywords
4171 @kindex M-@key{TAB}
4172 @noindent To make sure you are using the correct keyword, type
4173 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4175 @cindex DONE, final TODO keyword
4176 Remember that the keywords after the vertical bar (or the last keyword
4177 if no bar is there) must always mean that the item is DONE (although you
4178 may use a different word).  After changing one of these lines, use
4179 @kbd{C-c C-c} with the cursor still in the line to make the changes
4180 known to Org mode@footnote{Org mode parses these lines only when
4181 Org mode is activated after visiting a file.  @kbd{C-c C-c} with the
4182 cursor in a line starting with @samp{#+} is simply restarting Org mode
4183 for the current buffer.}.
4185 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
4186 @subsection Faces for TODO keywords
4187 @cindex faces, for TODO keywords
4189 @vindex org-todo @r{(face)}
4190 @vindex org-done @r{(face)}
4191 @vindex org-todo-keyword-faces
4192 Org mode highlights TODO keywords with special faces: @code{org-todo}
4193 for keywords indicating that an item still has to be acted upon, and
4194 @code{org-done} for keywords indicating that an item is finished.  If
4195 you are using more than 2 different states, you might want to use
4196 special faces for some of them.  This can be done using the variable
4197 @code{org-todo-keyword-faces}.  For example:
4199 @lisp
4200 @group
4201 (setq org-todo-keyword-faces
4202       '(("TODO" . org-warning) ("STARTED" . "yellow")
4203         ("CANCELED" . (:foreground "blue" :weight bold))))
4204 @end group
4205 @end lisp
4207 While using a list with face properties as shown for CANCELED @emph{should}
4208 work, this does not always seem to be the case.  If necessary, define a
4209 special face and use that.  A string is interpreted as a color.  The variable
4210 @code{org-faces-easy-properties} determines if that color is interpreted as a
4211 foreground or a background color.
4213 @node TODO dependencies,  , Faces for TODO keywords, TODO extensions
4214 @subsection TODO dependencies
4215 @cindex TODO dependencies
4216 @cindex dependencies, of TODO states
4218 @vindex org-enforce-todo-dependencies
4219 @cindex property, ORDERED
4220 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4221 dependencies.  Usually, a parent TODO task should not be marked DONE until
4222 all subtasks (defined as children tasks) are marked as DONE@.  And sometimes
4223 there is a logical sequence to a number of (sub)tasks, so that one task
4224 cannot be acted upon before all siblings above it are done.  If you customize
4225 the variable @code{org-enforce-todo-dependencies}, Org will block entries
4226 from changing state to DONE while they have children that are not DONE@.
4227 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4228 will be blocked until all earlier siblings are marked DONE@.  Here is an
4229 example:
4231 @example
4232 * TODO Blocked until (two) is done
4233 ** DONE one
4234 ** TODO two
4236 * Parent
4237   :PROPERTIES:
4238   :ORDERED: t
4239   :END:
4240 ** TODO a
4241 ** TODO b, needs to wait for (a)
4242 ** TODO c, needs to wait for (a) and (b)
4243 @end example
4245 @table @kbd
4246 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4247 @vindex org-track-ordered-property-with-tag
4248 @cindex property, ORDERED
4249 Toggle the @code{ORDERED} property of the current entry.  A property is used
4250 for this behavior because this should be local to the current entry, not
4251 inherited like a tag.  However, if you would like to @i{track} the value of
4252 this property with a tag for better visibility, customize the variable
4253 @code{org-track-ordered-property-with-tag}.
4254 @orgkey{C-u C-u C-u C-c C-t}
4255 Change TODO state, circumventing any state blocking.
4256 @end table
4258 @vindex org-agenda-dim-blocked-tasks
4259 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
4260 that cannot be closed because of such dependencies will be shown in a dimmed
4261 font or even made invisible in agenda views (@pxref{Agenda Views}).
4263 @cindex checkboxes and TODO dependencies
4264 @vindex org-enforce-todo-dependencies
4265 You can also block changes of TODO states by looking at checkboxes
4266 (@pxref{Checkboxes}).  If you set the variable
4267 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4268 checkboxes will be blocked from switching to DONE.
4270 If you need more complex dependency structures, for example dependencies
4271 between entries in different trees or files, check out the contributed
4272 module @file{org-depend.el}.
4274 @page
4275 @node Progress logging, Priorities, TODO extensions, TODO Items
4276 @section Progress logging
4277 @cindex progress logging
4278 @cindex logging, of progress
4280 Org mode can automatically record a timestamp and possibly a note when
4281 you mark a TODO item as DONE, or even each time you change the state of
4282 a TODO item.  This system is highly configurable; settings can be on a
4283 per-keyword basis and can be localized to a file or even a subtree.  For
4284 information on how to clock working time for a task, see @ref{Clocking
4285 work time}.
4287 @menu
4288 * Closing items::               When was this entry marked DONE?
4289 * Tracking TODO state changes::  When did the status change?
4290 * Tracking your habits::        How consistent have you been?
4291 @end menu
4293 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4294 @subsection Closing items
4296 The most basic logging is to keep track of @emph{when} a certain TODO
4297 item was finished.  This is achieved with@footnote{The corresponding
4298 in-buffer setting is: @code{#+STARTUP: logdone}}
4300 @lisp
4301 (setq org-log-done 'time)
4302 @end lisp
4304 @noindent
4305 Then each time you turn an entry from a TODO (not-done) state into any
4306 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
4307 just after the headline.  If you turn the entry back into a TODO item
4308 through further state cycling, that line will be removed again.  If you
4309 want to record a note along with the timestamp, use@footnote{The
4310 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4312 @lisp
4313 (setq org-log-done 'note)
4314 @end lisp
4316 @noindent
4317 You will then be prompted for a note, and that note will be stored below
4318 the entry with a @samp{Closing Note} heading.
4320 In the timeline (@pxref{Timeline}) and in the agenda
4321 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4322 display the TODO items with a @samp{CLOSED} timestamp on each day,
4323 giving you an overview of what has been done.
4325 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4326 @subsection Tracking TODO state changes
4327 @cindex drawer, for state change recording
4329 @vindex org-log-states-order-reversed
4330 @vindex org-log-into-drawer
4331 @cindex property, LOG_INTO_DRAWER
4332 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4333 might want to keep track of when a state change occurred and maybe take a
4334 note about this change.  You can either record just a timestamp, or a
4335 time-stamped note for a change.  These records will be inserted after the
4336 headline as an itemized list, newest first@footnote{See the variable
4337 @code{org-log-states-order-reversed}}.  When taking a lot of notes, you might
4338 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4339 Customize the variable @code{org-log-into-drawer} to get this behavior---the
4340 recommended drawer for this is called @code{LOGBOOK}@footnote{Note that the
4341 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4342 show an entry---use @key{C-u SPC} to keep it folded here}.  You can also
4343 overrule the setting of this variable for a subtree by setting a
4344 @code{LOG_INTO_DRAWER} property.
4346 Since it is normally too much to record a note for every state, Org mode
4347 expects configuration on a per-keyword basis for this.  This is achieved by
4348 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4349 with timestamp) in parentheses after each keyword.  For example, with the
4350 setting
4352 @lisp
4353 (setq org-todo-keywords
4354   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4355 @end lisp
4357 To record a timestamp without a note for TODO keywords configured with
4358 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4360 @noindent
4361 @vindex org-log-done
4362 you not only define global TODO keywords and fast access keys, but also
4363 request that a time is recorded when the entry is set to
4364 DONE@footnote{It is possible that Org mode will record two timestamps
4365 when you are using both @code{org-log-done} and state change logging.
4366 However, it will never prompt for two notes---if you have configured
4367 both, the state change recording note will take precedence and cancel
4368 the @samp{Closing Note}.}, and that a note is recorded when switching to
4369 WAIT or CANCELED@.  The setting for WAIT is even more special: the
4370 @samp{!} after the slash means that in addition to the note taken when
4371 entering the state, a timestamp should be recorded when @i{leaving} the
4372 WAIT state, if and only if the @i{target} state does not configure
4373 logging for entering it.  So it has no effect when switching from WAIT
4374 to DONE, because DONE is configured to record a timestamp only.  But
4375 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4376 setting now triggers a timestamp even though TODO has no logging
4377 configured.
4379 You can use the exact same syntax for setting logging preferences local
4380 to a buffer:
4381 @example
4382 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4383 @end example
4385 @cindex property, LOGGING
4386 In order to define logging settings that are local to a subtree or a
4387 single item, define a LOGGING property in this entry.  Any non-empty
4388 LOGGING property resets all logging settings to nil.  You may then turn
4389 on logging for this specific tree using STARTUP keywords like
4390 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4391 settings like @code{TODO(!)}.  For example
4393 @example
4394 * TODO Log each state with only a time
4395   :PROPERTIES:
4396   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4397   :END:
4398 * TODO Only log when switching to WAIT, and when repeating
4399   :PROPERTIES:
4400   :LOGGING: WAIT(@@) logrepeat
4401   :END:
4402 * TODO No logging at all
4403   :PROPERTIES:
4404   :LOGGING: nil
4405   :END:
4406 @end example
4408 @node Tracking your habits,  , Tracking TODO state changes, Progress logging
4409 @subsection Tracking your habits
4410 @cindex habits
4412 Org has the ability to track the consistency of a special category of TODOs,
4413 called ``habits''.  A habit has the following properties:
4415 @enumerate
4416 @item
4417 You have enabled the @code{habits} module by customizing the variable
4418 @code{org-modules}.
4419 @item
4420 The habit is a TODO item, with a TODO keyword representing an open state.
4421 @item
4422 The property @code{STYLE} is set to the value @code{habit}.
4423 @item
4424 The TODO has a scheduled date, usually with a @code{.+} style repeat
4425 interval.  A @code{++} style may be appropriate for habits with time
4426 constraints, e.g., must be done on weekends, or a @code{+} style for an
4427 unusual habit that can have a backlog, e.g., weekly reports.
4428 @item
4429 The TODO may also have minimum and maximum ranges specified by using the
4430 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4431 three days, but at most every two days.
4432 @item
4433 You must also have state logging for the @code{DONE} state enabled
4434 (@pxref{Tracking TODO state changes}), in order for historical data to be
4435 represented in the consistency graph.  If it is not enabled it is not an
4436 error, but the consistency graphs will be largely meaningless.
4437 @end enumerate
4439 To give you an idea of what the above rules look like in action, here's an
4440 actual habit with some history:
4442 @example
4443 ** TODO Shave
4444    SCHEDULED: <2009-10-17 Sat .+2d/4d>
4445    - State "DONE"       from "TODO"       [2009-10-15 Thu]
4446    - State "DONE"       from "TODO"       [2009-10-12 Mon]
4447    - State "DONE"       from "TODO"       [2009-10-10 Sat]
4448    - State "DONE"       from "TODO"       [2009-10-04 Sun]
4449    - State "DONE"       from "TODO"       [2009-10-02 Fri]
4450    - State "DONE"       from "TODO"       [2009-09-29 Tue]
4451    - State "DONE"       from "TODO"       [2009-09-25 Fri]
4452    - State "DONE"       from "TODO"       [2009-09-19 Sat]
4453    - State "DONE"       from "TODO"       [2009-09-16 Wed]
4454    - State "DONE"       from "TODO"       [2009-09-12 Sat]
4455    :PROPERTIES:
4456    :STYLE:    habit
4457    :LAST_REPEAT: [2009-10-19 Mon 00:36]
4458    :END:
4459 @end example
4461 What this habit says is: I want to shave at most every 2 days (given by the
4462 @code{SCHEDULED} date and repeat interval) and at least every 4 days.  If
4463 today is the 15th, then the habit first appears in the agenda on Oct 17,
4464 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4465 after four days have elapsed.
4467 What's really useful about habits is that they are displayed along with a
4468 consistency graph, to show how consistent you've been at getting that task
4469 done in the past.  This graph shows every day that the task was done over the
4470 past three weeks, with colors for each day.  The colors used are:
4472 @table @code
4473 @item Blue
4474 If the task wasn't to be done yet on that day.
4475 @item Green
4476 If the task could have been done on that day.
4477 @item Yellow
4478 If the task was going to be overdue the next day.
4479 @item Red
4480 If the task was overdue on that day.
4481 @end table
4483 In addition to coloring each day, the day is also marked with an asterisk if
4484 the task was actually done that day, and an exclamation mark to show where
4485 the current day falls in the graph.
4487 There are several configuration variables that can be used to change the way
4488 habits are displayed in the agenda.
4490 @table @code
4491 @item org-habit-graph-column
4492 The buffer column at which the consistency graph should be drawn.  This will
4493 overwrite any text in that column, so it is a good idea to keep your habits'
4494 titles brief and to the point.
4495 @item org-habit-preceding-days
4496 The amount of history, in days before today, to appear in consistency graphs.
4497 @item org-habit-following-days
4498 The number of days after today that will appear in consistency graphs.
4499 @item org-habit-show-habits-only-for-today
4500 If non-nil, only show habits in today's agenda view.  This is set to true by
4501 default.
4502 @end table
4504 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4505 temporarily be disabled and they won't appear at all.  Press @kbd{K} again to
4506 bring them back.  They are also subject to tag filtering, if you have habits
4507 which should only be done in certain contexts, for example.
4509 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4510 @section Priorities
4511 @cindex priorities
4513 If you use Org mode extensively, you may end up with enough TODO items that
4514 it starts to make sense to prioritize them.  Prioritizing can be done by
4515 placing a @emph{priority cookie} into the headline of a TODO item, like this
4517 @example
4518 *** TODO [#A] Write letter to Sam Fortune
4519 @end example
4521 @noindent
4522 @vindex org-priority-faces
4523 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4524 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie is
4525 treated just like priority @samp{B}.  Priorities make a difference only for
4526 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4527 have no inherent meaning to Org mode.  The cookies can be highlighted with
4528 special faces by customizing the variable @code{org-priority-faces}.
4530 Priorities can be attached to any outline node; they do not need to be TODO
4531 items.
4533 @table @kbd
4534 @item @kbd{C-c ,}
4535 @kindex @kbd{C-c ,}
4536 @findex org-priority
4537 Set the priority of the current headline (@command{org-priority}).  The
4538 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4539 When you press @key{SPC} instead, the priority cookie is removed from the
4540 headline.  The priorities can also be changed ``remotely'' from the timeline
4541 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4543 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4544 @vindex org-priority-start-cycle-with-default
4545 Increase/decrease priority of current headline@footnote{See also the option
4546 @code{org-priority-start-cycle-with-default}.}.  Note that these keys are
4547 also used to modify timestamps (@pxref{Creating timestamps}).  See also
4548 @ref{Conflicts}, for a discussion of the interaction with
4549 @code{shift-selection-mode}.
4550 @end table
4552 @vindex org-highest-priority
4553 @vindex org-lowest-priority
4554 @vindex org-default-priority
4555 You can change the range of allowed priorities by setting the variables
4556 @code{org-highest-priority}, @code{org-lowest-priority}, and
4557 @code{org-default-priority}.  For an individual buffer, you may set
4558 these values (highest, lowest, default) like this (please make sure that
4559 the highest priority is earlier in the alphabet than the lowest
4560 priority):
4562 @cindex #+PRIORITIES
4563 @example
4564 #+PRIORITIES: A C B
4565 @end example
4567 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4568 @section Breaking tasks down into subtasks
4569 @cindex tasks, breaking down
4570 @cindex statistics, for TODO items
4572 @vindex org-agenda-todo-list-sublevels
4573 It is often advisable to break down large tasks into smaller, manageable
4574 subtasks.  You can do this by creating an outline tree below a TODO item,
4575 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4576 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.  To keep
4577 the overview over the fraction of subtasks that are already completed, insert
4578 either @samp{[/]} or @samp{[%]} anywhere in the headline.  These cookies will
4579 be updated each time the TODO status of a child changes, or when pressing
4580 @kbd{C-c C-c} on the cookie.  For example:
4582 @example
4583 * Organize Party [33%]
4584 ** TODO Call people [1/2]
4585 *** TODO Peter
4586 *** DONE Sarah
4587 ** TODO Buy food
4588 ** DONE Talk to neighbor
4589 @end example
4591 @cindex property, COOKIE_DATA
4592 If a heading has both checkboxes and TODO children below it, the meaning of
4593 the statistics cookie become ambiguous.  Set the property
4594 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4595 this issue.
4597 @vindex org-hierarchical-todo-statistics
4598 If you would like to have the statistics cookie count any TODO entries in the
4599 subtree (not just direct children), configure the variable
4600 @code{org-hierarchical-todo-statistics}.  To do this for a single subtree,
4601 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4602 property.
4604 @example
4605 * Parent capturing statistics [2/20]
4606   :PROPERTIES:
4607   :COOKIE_DATA: todo recursive
4608   :END:
4609 @end example
4611 If you would like a TODO entry to automatically change to DONE
4612 when all children are done, you can use the following setup:
4614 @example
4615 (defun org-summary-todo (n-done n-not-done)
4616   "Switch entry to DONE when all subentries are done, to TODO otherwise."
4617   (let (org-log-done org-log-states)   ; turn off logging
4618     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4620 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4621 @end example
4624 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4625 large number of subtasks (@pxref{Checkboxes}).
4628 @node Checkboxes,  , Breaking down tasks, TODO Items
4629 @section Checkboxes
4630 @cindex checkboxes
4632 @vindex org-list-automatic-rules
4633 Every item in a plain list@footnote{With the exception of description
4634 lists.  But you can allow it by modifying @code{org-list-automatic-rules}
4635 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4636 it with the string @samp{[ ]}.  This feature is similar to TODO items
4637 (@pxref{TODO Items}), but is more lightweight.  Checkboxes are not included
4638 in the global TODO list, so they are often great to split a task into a
4639 number of simple steps.  Or you can use them in a shopping list.  To toggle a
4640 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4641 @file{org-mouse.el}).
4643 Here is an example of a checkbox list.
4645 @example
4646 * TODO Organize party [2/4]
4647   - [-] call people [1/3]
4648     - [ ] Peter
4649     - [X] Sarah
4650     - [ ] Sam
4651   - [X] order food
4652   - [ ] think about what music to play
4653   - [X] talk to the neighbors
4654 @end example
4656 Checkboxes work hierarchically, so if a checkbox item has children that
4657 are checkboxes, toggling one of the children checkboxes will make the
4658 parent checkbox reflect if none, some, or all of the children are
4659 checked.
4661 @cindex statistics, for checkboxes
4662 @cindex checkbox statistics
4663 @cindex property, COOKIE_DATA
4664 @vindex org-checkbox-hierarchical-statistics
4665 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4666 indicating how many checkboxes present in this entry have been checked off,
4667 and the total number of checkboxes present.  This can give you an idea on how
4668 many checkboxes remain, even without opening a folded entry.  The cookies can
4669 be placed into a headline or into (the first line of) a plain list item.
4670 Each cookie covers checkboxes of direct children structurally below the
4671 headline/item on which the cookie appears@footnote{Set the variable
4672 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4673 count all checkboxes below the cookie, not just those belonging to direct
4674 children.}.  You have to insert the cookie yourself by typing either
4675 @samp{[/]} or @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m}
4676 result, as in the examples above.  With @samp{[%]} you get information about
4677 the percentage of checkboxes checked (in the above example, this would be
4678 @samp{[50%]} and @samp{[33%]}, respectively).  In a headline, a cookie can
4679 count either checkboxes below the heading or TODO states of children, and it
4680 will display whatever was changed last.  Set the property @code{COOKIE_DATA}
4681 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4683 @cindex blocking, of checkboxes
4684 @cindex checkbox blocking
4685 @cindex property, ORDERED
4686 If the current outline node has an @code{ORDERED} property, checkboxes must
4687 be checked off in sequence, and an error will be thrown if you try to check
4688 off a box while there are unchecked boxes above it.
4690 @noindent The following commands work with checkboxes:
4692 @table @kbd
4693 @orgcmd{C-c C-c,org-toggle-checkbox}
4694 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4695 With a single prefix argument, add an empty checkbox or remove the current
4696 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4697 will add checkboxes to the rest of the list.}.  With a double prefix argument, set it to @samp{[-]}, which is
4698 considered to be an intermediate state.
4699 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4700 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
4701 double prefix argument, set it to @samp{[-]}, which is considered to be an
4702 intermediate state.
4703 @itemize @minus
4704 @item
4705 If there is an active region, toggle the first checkbox in the region
4706 and set all remaining boxes to the same status as the first.  With a prefix
4707 arg, add or remove the checkbox for all items in the region.
4708 @item
4709 If the cursor is in a headline, toggle checkboxes in the region between
4710 this headline and the next (so @emph{not} the entire subtree).
4711 @item
4712 If there is no active region, just toggle the checkbox at point.
4713 @end itemize
4714 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4715 Insert a new item with a checkbox.  This works only if the cursor is already
4716 in a plain list item (@pxref{Plain lists}).
4717 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4718 @vindex org-track-ordered-property-with-tag
4719 @cindex property, ORDERED
4720 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4721 be checked off in sequence.  A property is used for this behavior because
4722 this should be local to the current entry, not inherited like a tag.
4723 However, if you would like to @i{track} the value of this property with a tag
4724 for better visibility, customize the variable
4725 @code{org-track-ordered-property-with-tag}.
4726 @orgcmd{C-c #,org-update-statistics-cookies}
4727 Update the statistics cookie in the current outline entry.  When called with
4728 a @kbd{C-u} prefix, update the entire file.  Checkbox statistic cookies are
4729 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4730 new ones with @kbd{M-S-@key{RET}}.  TODO statistics cookies update when
4731 changing TODO states.  If you delete boxes/entries or add/change them by
4732 hand, use this command to get things back into sync.
4733 @end table
4735 @node Tags, Properties and Columns, TODO Items, Top
4736 @chapter Tags
4737 @cindex tags
4738 @cindex headline tagging
4739 @cindex matching, tags
4740 @cindex sparse tree, tag based
4742 An excellent way to implement labels and contexts for cross-correlating
4743 information is to assign @i{tags} to headlines.  Org mode has extensive
4744 support for tags.
4746 @vindex org-tag-faces
4747 Every headline can contain a list of tags; they occur at the end of the
4748 headline.  Tags are normal words containing letters, numbers, @samp{_}, and
4749 @samp{@@}.  Tags must be preceded and followed by a single colon, e.g.,
4750 @samp{:work:}.  Several tags can be specified, as in @samp{:work:urgent:}.
4751 Tags will by default be in bold face with the same color as the headline.
4752 You may specify special faces for specific tags using the variable
4753 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4754 (@pxref{Faces for TODO keywords}).
4756 @menu
4757 * Tag inheritance::             Tags use the tree structure of the outline
4758 * Setting tags::                How to assign tags to a headline
4759 * Tag groups::                  Use one tag to search for several tags
4760 * Tag searches::                Searching for combinations of tags
4761 @end menu
4763 @node Tag inheritance, Setting tags, Tags, Tags
4764 @section Tag inheritance
4765 @cindex tag inheritance
4766 @cindex inheritance, of tags
4767 @cindex sublevels, inclusion into tags match
4769 @i{Tags} make use of the hierarchical structure of outline trees.  If a
4770 heading has a certain tag, all subheadings will inherit the tag as
4771 well.  For example, in the list
4773 @example
4774 * Meeting with the French group      :work:
4775 ** Summary by Frank                  :boss:notes:
4776 *** TODO Prepare slides for him      :action:
4777 @end example
4779 @noindent
4780 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4781 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4782 explicitly marked with those tags.  You can also set tags that all entries in
4783 a file should inherit just as if these tags were defined in a hypothetical
4784 level zero that surrounds the entire file.  Use a line like this@footnote{As
4785 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4786 changes in the line.}:
4788 @cindex #+FILETAGS
4789 @example
4790 #+FILETAGS: :Peter:Boss:Secret:
4791 @end example
4793 @noindent
4794 @vindex org-use-tag-inheritance
4795 @vindex org-tags-exclude-from-inheritance
4796 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4797 To turn it off entirely, use @code{org-use-tag-inheritance}.
4799 @vindex org-tags-match-list-sublevels
4800 When a headline matches during a tags search while tag inheritance is turned
4801 on, all the sublevels in the same tree will (for a simple match form) match
4802 as well@footnote{This is only true if the search does not involve more
4803 complex tests including properties (@pxref{Property searches}).}.  The list
4804 of matches may then become very long.  If you only want to see the first tags
4805 match in a subtree, configure the variable
4806 @code{org-tags-match-list-sublevels} (not recommended).
4808 @vindex org-agenda-use-tag-inheritance
4809 Tag inheritance is relevant when the agenda search tries to match a tag,
4810 either in the @code{tags} or @code{tags-todo} agenda types.  In other agenda
4811 types, @code{org-use-tag-inheritance} has no effect.  Still, you may want to
4812 have your tags correctly set in the agenda, so that tag filtering works fine,
4813 with inherited tags.  Set @code{org-agenda-use-tag-inheritance} to control
4814 this: the default value includes all agenda types, but setting this to nil
4815 can really speed up agenda generation.
4817 @node Setting tags, Tag groups, Tag inheritance, Tags
4818 @section Setting tags
4819 @cindex setting tags
4820 @cindex tags, setting
4822 @kindex M-@key{TAB}
4823 Tags can simply be typed into the buffer at the end of a headline.
4824 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
4825 also a special command for inserting tags:
4827 @table @kbd
4828 @orgcmd{C-c C-q,org-set-tags-command}
4829 @cindex completion, of tags
4830 @vindex org-tags-column
4831 Enter new tags for the current headline.  Org mode will either offer
4832 completion or a special single-key interface for setting tags, see
4833 below.  After pressing @key{RET}, the tags will be inserted and aligned
4834 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
4835 tags in the current buffer will be aligned to that column, just to make
4836 things look nice.  TAGS are automatically realigned after promotion,
4837 demotion, and TODO state changes (@pxref{TODO basics}).
4839 @orgcmd{C-c C-c,org-set-tags-command}
4840 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4841 @end table
4843 @vindex org-tag-alist
4844 Org supports tag insertion based on a @emph{list of tags}.  By
4845 default this list is constructed dynamically, containing all tags
4846 currently used in the buffer.  You may also globally specify a hard list
4847 of tags with the variable @code{org-tag-alist}.  Finally you can set
4848 the default tags for a given file with lines like
4850 @cindex #+TAGS
4851 @example
4852 #+TAGS: @@work @@home @@tennisclub
4853 #+TAGS: laptop car pc sailboat
4854 @end example
4856 If you have globally defined your preferred set of tags using the
4857 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4858 in a specific file, add an empty TAGS option line to that file:
4860 @example
4861 #+TAGS:
4862 @end example
4864 @vindex org-tag-persistent-alist
4865 If you have a preferred set of tags that you would like to use in every file,
4866 in addition to those defined on a per-file basis by TAGS option lines, then
4867 you may specify a list of tags with the variable
4868 @code{org-tag-persistent-alist}.  You may turn this off on a per-file basis
4869 by adding a STARTUP option line to that file:
4871 @example
4872 #+STARTUP: noptag
4873 @end example
4875 By default Org mode uses the standard minibuffer completion facilities for
4876 entering tags.  However, it also implements another, quicker, tag selection
4877 method called @emph{fast tag selection}.  This allows you to select and
4878 deselect tags with just a single key press.  For this to work well you should
4879 assign unique letters to most of your commonly used tags.  You can do this
4880 globally by configuring the variable @code{org-tag-alist} in your
4881 @file{.emacs} file.  For example, you may find the need to tag many items in
4882 different files with @samp{:@@home:}.  In this case you can set something
4883 like:
4885 @lisp
4886 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4887 @end lisp
4889 @noindent If the tag is only relevant to the file you are working on, then you
4890 can instead set the TAGS option line as:
4892 @example
4893 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
4894 @end example
4896 @noindent The tags interface will show the available tags in a splash
4897 window.  If you want to start a new line after a specific tag, insert
4898 @samp{\n} into the tag list
4900 @example
4901 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t) \n laptop(l)  pc(p)
4902 @end example
4904 @noindent or write them in two lines:
4906 @example
4907 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)
4908 #+TAGS: laptop(l)  pc(p)
4909 @end example
4911 @noindent
4912 You can also group together tags that are mutually exclusive by using
4913 braces, as in:
4915 @example
4916 #+TAGS: @{ @@work(w)  @@home(h)  @@tennisclub(t) @}  laptop(l)  pc(p)
4917 @end example
4919 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4920 and @samp{@@tennisclub} should be selected.  Multiple such groups are allowed.
4922 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4923 these lines to activate any changes.
4925 @noindent
4926 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4927 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4928 of the braces.  Similarly, you can use @code{:newline} to indicate a line
4929 break.  The previous example would be set globally by the following
4930 configuration:
4932 @lisp
4933 (setq org-tag-alist '((:startgroup . nil)
4934                       ("@@work" . ?w) ("@@home" . ?h)
4935                       ("@@tennisclub" . ?t)
4936                       (:endgroup . nil)
4937                       ("laptop" . ?l) ("pc" . ?p)))
4938 @end lisp
4940 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4941 automatically present you with a special interface, listing inherited tags,
4942 the tags of the current headline, and a list of all valid tags with
4943 corresponding keys@footnote{Keys will automatically be assigned to tags which
4944 have no configured keys.}.  In this interface, you can use the following
4945 keys:
4947 @table @kbd
4948 @item a-z...
4949 Pressing keys assigned to tags will add or remove them from the list of
4950 tags in the current line.  Selecting a tag in a group of mutually
4951 exclusive tags will turn off any other tags from that group.
4952 @kindex @key{TAB}
4953 @item @key{TAB}
4954 Enter a tag in the minibuffer, even if the tag is not in the predefined
4955 list.  You will be able to complete on all tags present in the buffer.
4956 You can also add several tags: just separate them with a comma.
4958 @kindex @key{SPC}
4959 @item @key{SPC}
4960 Clear all tags for this line.
4961 @kindex @key{RET}
4962 @item @key{RET}
4963 Accept the modified set.
4964 @item C-g
4965 Abort without installing changes.
4966 @item q
4967 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4968 @item !
4969 Turn off groups of mutually exclusive tags.  Use this to (as an
4970 exception) assign several tags from such a group.
4971 @item C-c
4972 Toggle auto-exit after the next change (see below).
4973 If you are using expert mode, the first @kbd{C-c} will display the
4974 selection window.
4975 @end table
4977 @noindent
4978 This method lets you assign tags to a headline with very few keys.  With
4979 the above setup, you could clear the current tags and set @samp{@@home},
4980 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4981 C-c @key{SPC} h l p @key{RET}}.  Switching from @samp{@@home} to
4982 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4983 alternatively with @kbd{C-c C-c C-c w}.  Adding the non-predefined tag
4984 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4985 @key{RET} @key{RET}}.
4987 @vindex org-fast-tag-selection-single-key
4988 If you find that most of the time you need only a single key press to
4989 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
4990 Then you no longer have to press @key{RET} to exit fast tag selection---it
4991 will immediately exit after the first change.  If you then occasionally
4992 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
4993 selection process (in effect: start selection with @kbd{C-c C-c C-c}
4994 instead of @kbd{C-c C-c}).  If you set the variable to the value
4995 @code{expert}, the special window is not even shown for single-key tag
4996 selection, it comes up only when you press an extra @kbd{C-c}.
4998 @node Tag groups, Tag searches, Setting tags, Tags
4999 @section Tag groups
5001 @cindex group tags
5002 @cindex tags, groups
5003 In a set of mutually exclusive tags, the first tag can be defined as a
5004 @emph{group tag}.  When you search for a group tag, it will return matches
5005 for all members in the group.  In an agenda view, filtering by a group tag
5006 will display headlines tagged with at least one of the members of the
5007 group.  This makes tag searches and filters even more flexible.
5009 You can set group tags by inserting a colon between the group tag and other
5010 tags---beware that all whitespaces are mandatory so that Org can parse this
5011 line correctly:
5013 @example
5014 #+TAGS: @{ @@read : @@read_book  @@read_ebook @}
5015 @end example
5017 In this example, @samp{@@read} is a @emph{group tag} for a set of three
5018 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
5020 You can also use the @code{:grouptags} keyword directly when setting
5021 @var{org-tag-alist}:
5023 @lisp
5024 (setq org-tag-alist '((:startgroup . nil) 
5025                       ("@@read" . nil)
5026                       (:grouptags . nil)
5027                       ("@@read_book" . nil)
5028                       ("@@read_ebook" . nil)
5029                       (:endgroup . nil)))
5030 @end lisp
5032 @kindex C-c C-x q
5033 @vindex org-group-tags
5034 If you want to ignore group tags temporarily, toggle group tags support
5035 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}.  If you
5036 want to disable tag groups completely, set @var{org-group-tags} to nil.
5038 @node Tag searches,  , Tag groups, Tags
5039 @section Tag searches
5040 @cindex tag searches
5041 @cindex searching for tags
5043 Once a system of tags has been set up, it can be used to collect related
5044 information into special lists.
5046 @table @kbd
5047 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5048 Create a sparse tree with all headlines matching a tags search.  With a
5049 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5050 @orgcmd{C-c a m,org-tags-view}
5051 Create a global list of tag matches from all agenda files.
5052 @xref{Matching tags and properties}.
5053 @orgcmd{C-c a M,org-tags-view}
5054 @vindex org-tags-match-list-sublevels
5055 Create a global list of tag matches from all agenda files, but check
5056 only TODO items and force checking subitems (see variable
5057 @code{org-tags-match-list-sublevels}).
5058 @end table
5060 These commands all prompt for a match string which allows basic Boolean logic
5061 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5062 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5063 which are tagged, like @samp{Kathy} or @samp{Sally}.  The full syntax of the search
5064 string is rich and allows also matching against TODO keywords, entry levels
5065 and properties.  For a complete description with many examples, see
5066 @ref{Matching tags and properties}.
5069 @node Properties and Columns, Dates and Times, Tags, Top
5070 @chapter Properties and columns
5071 @cindex properties
5073 A property is a key-value pair associated with an entry.  Properties can be
5074 set so they are associated with a single entry, with every entry in a tree,
5075 or with every entry in an Org mode file.
5077 There are two main applications for properties in Org mode.  First,
5078 properties are like tags, but with a value.  Imagine maintaining a file where
5079 you document bugs and plan releases for a piece of software.  Instead of
5080 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5081 property, say @code{:Release:}, that in different subtrees has different
5082 values, such as @code{1.0} or @code{2.0}.  Second, you can use properties to
5083 implement (very basic) database capabilities in an Org buffer.  Imagine
5084 keeping track of your music CDs, where properties could be things such as the
5085 album, artist, date of release, number of tracks, and so on.
5087 Properties can be conveniently edited and viewed in column view
5088 (@pxref{Column view}).
5090 @menu
5091 * Property syntax::             How properties are spelled out
5092 * Special properties::          Access to other Org mode features
5093 * Property searches::           Matching property values
5094 * Property inheritance::        Passing values down the tree
5095 * Column view::                 Tabular viewing and editing
5096 * Property API::                Properties for Lisp programmers
5097 @end menu
5099 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
5100 @section Property syntax
5101 @cindex property syntax
5102 @cindex drawer, for properties
5104 Properties are key-value pairs.  When they are associated with a single entry
5105 or with a tree they need to be inserted into a special
5106 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}.  Each property
5107 is specified on a single line, with the key (surrounded by colons)
5108 first, and the value after it.  Here is an example:
5110 @example
5111 * CD collection
5112 ** Classic
5113 *** Goldberg Variations
5114     :PROPERTIES:
5115     :Title:     Goldberg Variations
5116     :Composer:  J.S. Bach
5117     :Artist:    Glen Gould
5118     :Publisher: Deutsche Grammophon
5119     :NDisks:    1
5120     :END:
5121 @end example
5123 Depending on the value of @code{org-use-property-inheritance}, a property set
5124 this way will either be associated with a single entry, or the sub-tree
5125 defined by the entry, see @ref{Property inheritance}.
5127 You may define the allowed values for a particular property @samp{:Xyz:}
5128 by setting a property @samp{:Xyz_ALL:}.  This special property is
5129 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5130 the entire tree.  When allowed values are defined, setting the
5131 corresponding property becomes easier and is less prone to typing
5132 errors.  For the example with the CD collection, we can predefine
5133 publishers and the number of disks in a box like this:
5135 @example
5136 * CD collection
5137   :PROPERTIES:
5138   :NDisks_ALL:  1 2 3 4
5139   :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5140   :END:
5141 @end example
5143 If you want to set properties that can be inherited by any entry in a
5144 file, use a line like
5145 @cindex property, _ALL
5146 @cindex #+PROPERTY
5147 @example
5148 #+PROPERTY: NDisks_ALL 1 2 3 4
5149 @end example
5151 Contrary to properties set from a special drawer, you have to refresh the
5152 buffer with @kbd{C-c C-c} to activate this changes.
5154 If you want to add to the value of an existing property, append a @code{+} to
5155 the property name.  The following results in the property @code{var} having
5156 the value ``foo=1 bar=2''.
5157 @cindex property, +
5158 @example
5159 #+PROPERTY: var  foo=1
5160 #+PROPERTY: var+ bar=2
5161 @end example
5163 It is also possible to add to the values of inherited properties.  The
5164 following results in the @code{genres} property having the value ``Classic
5165 Baroque'' under the @code{Goldberg Variations} subtree.
5166 @cindex property, +
5167 @example
5168 * CD collection
5169 ** Classic
5170     :PROPERTIES:
5171     :GENRES: Classic
5172     :END:
5173 *** Goldberg Variations
5174     :PROPERTIES:
5175     :Title:     Goldberg Variations
5176     :Composer:  J.S. Bach
5177     :Artist:    Glen Gould
5178     :Publisher: Deutsche Grammophon
5179     :NDisks:    1
5180     :GENRES+:   Baroque
5181     :END:
5182 @end example
5183 Note that a property can only have one entry per Drawer.
5185 @vindex org-global-properties
5186 Property values set with the global variable
5187 @code{org-global-properties} can be inherited by all entries in all
5188 Org files.
5190 @noindent
5191 The following commands help to work with properties:
5193 @table @kbd
5194 @orgcmd{M-@key{TAB},pcomplete}
5195 After an initial colon in a line, complete property keys.  All keys used
5196 in the current file will be offered as possible completions.
5197 @orgcmd{C-c C-x p,org-set-property}
5198 Set a property.  This prompts for a property name and a value.  If
5199 necessary, the property drawer is created as well.
5200 @item C-u M-x org-insert-drawer
5201 @cindex org-insert-drawer
5202 Insert a property drawer into the current entry.  The drawer will be
5203 inserted early in the entry, but after the lines with planning
5204 information like deadlines.
5205 @orgcmd{C-c C-c,org-property-action}
5206 With the cursor in a property drawer, this executes property commands.
5207 @orgcmd{C-c C-c s,org-set-property}
5208 Set a property in the current entry.  Both the property and the value
5209 can be inserted using completion.
5210 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5211 Switch property at point to the next/previous allowed value.
5212 @orgcmd{C-c C-c d,org-delete-property}
5213 Remove a property from the current entry.
5214 @orgcmd{C-c C-c D,org-delete-property-globally}
5215 Globally remove a property, from all entries in the current file.
5216 @orgcmd{C-c C-c c,org-compute-property-at-point}
5217 Compute the property at point, using the operator and scope from the
5218 nearest column format definition.
5219 @end table
5221 @node Special properties, Property searches, Property syntax, Properties and Columns
5222 @section Special properties
5223 @cindex properties, special
5225 Special properties provide an alternative access method to Org mode features,
5226 like the TODO state or the priority of an entry, discussed in the previous
5227 chapters.  This interface exists so that you can include these states in a
5228 column view (@pxref{Column view}), or to use them in queries.  The following
5229 property names are special and (except for @code{:CATEGORY:}) should not be
5230 used as keys in the properties drawer:
5232 @cindex property, special, ID
5233 @cindex property, special, TODO
5234 @cindex property, special, TAGS
5235 @cindex property, special, ALLTAGS
5236 @cindex property, special, CATEGORY
5237 @cindex property, special, PRIORITY
5238 @cindex property, special, DEADLINE
5239 @cindex property, special, SCHEDULED
5240 @cindex property, special, CLOSED
5241 @cindex property, special, TIMESTAMP
5242 @cindex property, special, TIMESTAMP_IA
5243 @cindex property, special, CLOCKSUM
5244 @cindex property, special, CLOCKSUM_T
5245 @cindex property, special, BLOCKED
5246 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5247 @cindex property, special, ITEM
5248 @cindex property, special, FILE
5249 @example
5250 ID           @r{A globally unique ID used for synchronization during}
5251              @r{iCalendar or MobileOrg export.}
5252 TODO         @r{The TODO keyword of the entry.}
5253 TAGS         @r{The tags defined directly in the headline.}
5254 ALLTAGS      @r{All tags, including inherited ones.}
5255 CATEGORY     @r{The category of an entry.}
5256 PRIORITY     @r{The priority of the entry, a string with a single letter.}
5257 DEADLINE     @r{The deadline time string, without the angular brackets.}
5258 SCHEDULED    @r{The scheduling timestamp, without the angular brackets.}
5259 CLOSED       @r{When was this entry closed?}
5260 TIMESTAMP    @r{The first keyword-less timestamp in the entry.}
5261 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5262 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
5263              @r{must be run first to compute the values in the current buffer.}
5264 CLOCKSUM_T   @r{The sum of CLOCK intervals in the subtree for today.}
5265              @r{@code{org-clock-sum-today} must be run first to compute the}
5266              @r{values in the current buffer.}
5267 BLOCKED      @r{"t" if task is currently blocked by children or siblings}
5268 ITEM         @r{The headline of the entry.}
5269 FILE         @r{The filename the entry is located in.}
5270 @end example
5272 @node Property searches, Property inheritance, Special properties, Properties and Columns
5273 @section Property searches
5274 @cindex properties, searching
5275 @cindex searching, of properties
5277 To create sparse trees and special lists with selection based on properties,
5278 the same commands are used as for tag searches (@pxref{Tag searches}).
5280 @table @kbd
5281 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5282 Create a sparse tree with all matching entries.  With a
5283 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5284 @orgcmd{C-c a m,org-tags-view}
5285 Create a global list of tag/property  matches from all agenda files.
5286 @xref{Matching tags and properties}.
5287 @orgcmd{C-c a M,org-tags-view}
5288 @vindex org-tags-match-list-sublevels
5289 Create a global list of tag matches from all agenda files, but check
5290 only TODO items and force checking of subitems (see variable
5291 @code{org-tags-match-list-sublevels}).
5292 @end table
5294 The syntax for the search string is described in @ref{Matching tags and
5295 properties}.
5297 There is also a special command for creating sparse trees based on a
5298 single property:
5300 @table @kbd
5301 @orgkey{C-c / p}
5302 Create a sparse tree based on the value of a property.  This first
5303 prompts for the name of a property, and then for a value.  A sparse tree
5304 is created with all entries that define this property with the given
5305 value.  If you enclose the value in curly braces, it is interpreted as
5306 a regular expression and matched against the property values.
5307 @end table
5309 @node Property inheritance, Column view, Property searches, Properties and Columns
5310 @section Property Inheritance
5311 @cindex properties, inheritance
5312 @cindex inheritance, of properties
5314 @vindex org-use-property-inheritance
5315 The outline structure of Org mode documents lends itself to an
5316 inheritance model of properties: if the parent in a tree has a certain
5317 property, the children can inherit this property.  Org mode does not
5318 turn this on by default, because it can slow down property searches
5319 significantly and is often not needed.  However, if you find inheritance
5320 useful, you can turn it on by setting the variable
5321 @code{org-use-property-inheritance}.  It may be set to @code{t} to make
5322 all properties inherited from the parent, to a list of properties
5323 that should be inherited, or to a regular expression that matches
5324 inherited properties.  If a property has the value @samp{nil}, this is
5325 interpreted as an explicit undefine of the property, so that inheritance
5326 search will stop at this value and return @code{nil}.
5328 Org mode has a few properties for which inheritance is hard-coded, at
5329 least for the special applications for which they are used:
5331 @cindex property, COLUMNS
5332 @table @code
5333 @item COLUMNS
5334 The @code{:COLUMNS:} property defines the format of column view
5335 (@pxref{Column view}).  It is inherited in the sense that the level
5336 where a @code{:COLUMNS:} property is defined is used as the starting
5337 point for a column view table, independently of the location in the
5338 subtree from where columns view is turned on.
5339 @item CATEGORY
5340 @cindex property, CATEGORY
5341 For agenda view, a category set through a @code{:CATEGORY:} property
5342 applies to the entire subtree.
5343 @item ARCHIVE
5344 @cindex property, ARCHIVE
5345 For archiving, the @code{:ARCHIVE:} property may define the archive
5346 location for the entire subtree (@pxref{Moving subtrees}).
5347 @item LOGGING
5348 @cindex property, LOGGING
5349 The LOGGING property may define logging settings for an entry or a
5350 subtree (@pxref{Tracking TODO state changes}).
5351 @end table
5353 @node Column view, Property API, Property inheritance, Properties and Columns
5354 @section Column view
5356 A great way to view and edit properties in an outline tree is
5357 @emph{column view}.  In column view, each outline node is turned into a
5358 table row.  Columns in this table provide access to properties of the
5359 entries.  Org mode implements columns by overlaying a tabular structure
5360 over the headline of each item.  While the headlines have been turned
5361 into a table row, you can still change the visibility of the outline
5362 tree.  For example, you get a compact table by switching to CONTENTS
5363 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5364 is active), but you can still open, read, and edit the entry below each
5365 headline.  Or, you can switch to column view after executing a sparse
5366 tree command and in this way get a table only for the selected items.
5367 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5368 queries have collected selected items, possibly from a number of files.
5370 @menu
5371 * Defining columns::            The COLUMNS format property
5372 * Using column view::           How to create and use column view
5373 * Capturing column view::       A dynamic block for column view
5374 @end menu
5376 @node Defining columns, Using column view, Column view, Column view
5377 @subsection Defining columns
5378 @cindex column view, for properties
5379 @cindex properties, column view
5381 Setting up a column view first requires defining the columns.  This is
5382 done by defining a column format line.
5384 @menu
5385 * Scope of column definitions::  Where defined, where valid?
5386 * Column attributes::           Appearance and content of a column
5387 @end menu
5389 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5390 @subsubsection Scope of column definitions
5392 To define a column format for an entire file, use a line like
5394 @cindex #+COLUMNS
5395 @example
5396 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5397 @end example
5399 To specify a format that only applies to a specific tree, add a
5400 @code{:COLUMNS:} property to the top node of that tree, for example:
5402 @example
5403 ** Top node for columns view
5404    :PROPERTIES:
5405    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5406    :END:
5407 @end example
5409 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5410 for the entry itself, and for the entire subtree below it.  Since the
5411 column definition is part of the hierarchical structure of the document,
5412 you can define columns on level 1 that are general enough for all
5413 sublevels, and more specific columns further down, when you edit a
5414 deeper part of the tree.
5416 @node Column attributes,  , Scope of column definitions, Defining columns
5417 @subsubsection Column attributes
5418 A column definition sets the attributes of a column.  The general
5419 definition looks like this:
5421 @example
5422  %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5423 @end example
5425 @noindent
5426 Except for the percent sign and the property name, all items are
5427 optional.  The individual parts have the following meaning:
5429 @example
5430 @var{width}           @r{An integer specifying the width of the column in characters.}
5431                 @r{If omitted, the width will be determined automatically.}
5432 @var{property}        @r{The property that should be edited in this column.}
5433                 @r{Special properties representing meta data are allowed here}
5434                 @r{as well (@pxref{Special properties})}
5435 @var{title}           @r{The header text for the column.  If omitted, the property}
5436                 @r{name is used.}
5437 @{@var{summary-type}@}  @r{The summary type.  If specified, the column values for}
5438                 @r{parent nodes are computed from the children.}
5439                 @r{Supported summary types are:}
5440                 @{+@}       @r{Sum numbers in this column.}
5441                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
5442                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
5443                 @{:@}       @r{Sum times, HH:MM, plain numbers are hours.}
5444                 @{X@}       @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5445                 @{X/@}      @r{Checkbox status, @samp{[n/m]}.}
5446                 @{X%@}      @r{Checkbox status, @samp{[n%]}.}
5447                 @{min@}     @r{Smallest number in column.}
5448                 @{max@}     @r{Largest number.}
5449                 @{mean@}    @r{Arithmetic mean of numbers.}
5450                 @{:min@}    @r{Smallest time value in column.}
5451                 @{:max@}    @r{Largest time value.}
5452                 @{:mean@}   @r{Arithmetic mean of time values.}
5453                 @{@@min@}    @r{Minimum age (in days/hours/mins/seconds).}
5454                 @{@@max@}    @r{Maximum age (in days/hours/mins/seconds).}
5455                 @{@@mean@}   @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5456                 @{est+@}    @r{Add low-high estimates.}
5457 @end example
5459 @noindent
5460 Be aware that you can only have one summary type for any property you
5461 include.  Subsequent columns referencing the same property will all display the
5462 same summary information.
5464 The @code{est+} summary type requires further explanation.  It is used for
5465 combining estimates, expressed as low-high ranges.  For example, instead
5466 of estimating a particular task will take 5 days, you might estimate it as
5467 5--6 days if you're fairly confident you know how much work is required, or
5468 1--10 days if you don't really know what needs to be done.  Both ranges
5469 average at 5.5 days, but the first represents a more predictable delivery.
5471 When combining a set of such estimates, simply adding the lows and highs
5472 produces an unrealistically wide result.  Instead, @code{est+} adds the
5473 statistical mean and variance of the sub-tasks, generating a final estimate
5474 from the sum.  For example, suppose you had ten tasks, each of which was
5475 estimated at 0.5 to 2 days of work.  Straight addition produces an estimate
5476 of 5 to 20 days, representing what to expect if everything goes either
5477 extremely well or extremely poorly.  In contrast, @code{est+} estimates the
5478 full job more realistically, at 10--15 days.
5480 Here is an example for a complete columns definition, along with allowed
5481 values.
5483 @example
5484 :COLUMNS:  %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.}
5485                    %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5486 :Owner_ALL:    Tammy Mark Karl Lisa Don
5487 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
5488 :Approved_ALL: "[ ]" "[X]"
5489 @end example
5491 @noindent
5492 The first column, @samp{%25ITEM}, means the first 25 characters of the
5493 item itself, i.e., of the headline.  You probably always should start the
5494 column definition with the @samp{ITEM} specifier.  The other specifiers
5495 create columns @samp{Owner} with a list of names as allowed values, for
5496 @samp{Status} with four different possible values, and for a checkbox
5497 field @samp{Approved}.  When no width is given after the @samp{%}
5498 character, the column will be exactly as wide as it needs to be in order
5499 to fully display all values.  The @samp{Approved} column does have a
5500 modified title (@samp{Approved?}, with a question mark).  Summaries will
5501 be created for the @samp{Time_Estimate} column by adding time duration
5502 expressions like HH:MM, and for the @samp{Approved} column, by providing
5503 an @samp{[X]} status if all children have been checked.  The
5504 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5505 sums of CLOCK intervals in the subtree, either for all clocks or just for
5506 today.
5508 @node Using column view, Capturing column view, Defining columns, Column view
5509 @subsection Using column view
5511 @table @kbd
5512 @tsubheading{Turning column view on and off}
5513 @orgcmd{C-c C-x C-c,org-columns}
5514 @vindex org-columns-default-format
5515 Turn on column view.  If the cursor is before the first headline in the file,
5516 column view is turned on for the entire file, using the @code{#+COLUMNS}
5517 definition.  If the cursor is somewhere inside the outline, this command
5518 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5519 defines a format.  When one is found, the column view table is established
5520 for the tree starting at the entry that contains the @code{:COLUMNS:}
5521 property.  If no such property is found, the format is taken from the
5522 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5523 and column view is established for the current entry and its subtree.
5524 @orgcmd{r,org-columns-redo}
5525 Recreate the column view, to include recent changes made in the buffer.
5526 @orgcmd{g,org-columns-redo}
5527 Same as @kbd{r}.
5528 @orgcmd{q,org-columns-quit}
5529 Exit column view.
5530 @tsubheading{Editing values}
5531 @item @key{left} @key{right} @key{up} @key{down}
5532 Move through the column view from field to field.
5533 @kindex S-@key{left}
5534 @kindex S-@key{right}
5535 @item  S-@key{left}/@key{right}
5536 Switch to the next/previous allowed value of the field.  For this, you
5537 have to have specified allowed values for a property.
5538 @item 1..9,0
5539 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5540 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5541 Same as @kbd{S-@key{left}/@key{right}}
5542 @orgcmd{e,org-columns-edit-value}
5543 Edit the property at point.  For the special properties, this will
5544 invoke the same interface that you normally use to change that
5545 property.  For example, when editing a TAGS property, the tag completion
5546 or fast selection interface will pop up.
5547 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5548 When there is a checkbox at point, toggle it.
5549 @orgcmd{v,org-columns-show-value}
5550 View the full value of this property.  This is useful if the width of
5551 the column is smaller than that of the value.
5552 @orgcmd{a,org-columns-edit-allowed}
5553 Edit the list of allowed values for this property.  If the list is found
5554 in the hierarchy, the modified values is stored there.  If no list is
5555 found, the new value is stored in the first entry that is part of the
5556 current column view.
5557 @tsubheading{Modifying the table structure}
5558 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5559 Make the column narrower/wider by one character.
5560 @orgcmd{S-M-@key{right},org-columns-new}
5561 Insert a new column, to the left of the current column.
5562 @orgcmd{S-M-@key{left},org-columns-delete}
5563 Delete the current column.
5564 @end table
5566 @node Capturing column view,  , Using column view, Column view
5567 @subsection Capturing column view
5569 Since column view is just an overlay over a buffer, it cannot be
5570 exported or printed directly.  If you want to capture a column view, use
5571 a @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
5572 of this block looks like this:
5574 @cindex #+BEGIN, columnview
5575 @example
5576 * The column view
5577 #+BEGIN: columnview :hlines 1 :id "label"
5579 #+END:
5580 @end example
5582 @noindent This dynamic block has the following parameters:
5584 @table @code
5585 @item :id
5586 This is the most important parameter.  Column view is a feature that is
5587 often localized to a certain (sub)tree, and the capture block might be
5588 at a different location in the file.  To identify the tree whose view to
5589 capture, you can use 4 values:
5590 @cindex property, ID
5591 @example
5592 local     @r{use the tree in which the capture block is located}
5593 global    @r{make a global view, including all headings in the file}
5594 "file:@var{path-to-file}"
5595           @r{run column view at the top of this file}
5596 "@var{ID}"      @r{call column view in the tree that has an @code{:ID:}}
5597           @r{property with the value @i{label}.  You can use}
5598           @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5599           @r{the current entry and copy it to the kill-ring.}
5600 @end example
5601 @item :hlines
5602 When @code{t}, insert an hline after every line.  When a number @var{N}, insert
5603 an hline before each headline with level @code{<= @var{N}}.
5604 @item :vlines
5605 When set to @code{t}, force column groups to get vertical lines.
5606 @item :maxlevel
5607 When set to a number, don't capture entries below this level.
5608 @item :skip-empty-rows
5609 When set to @code{t}, skip rows where the only non-empty specifier of the
5610 column view is @code{ITEM}.
5612 @end table
5614 @noindent
5615 The following commands insert or update the dynamic block:
5617 @table @kbd
5618 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5619 Insert a dynamic block capturing a column view.  You will be prompted
5620 for the scope or ID of the view.
5621 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5622 Update dynamic block at point.  The cursor needs to be in the
5623 @code{#+BEGIN} line of the dynamic block.
5624 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5625 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
5626 you have several clock table blocks, column-capturing blocks or other dynamic
5627 blocks in a buffer.
5628 @end table
5630 You can add formulas to the column view table and you may add plotting
5631 instructions in front of the table---these will survive an update of the
5632 block.  If there is a @code{#+TBLFM:} after the table, the table will
5633 actually be recalculated automatically after an update.
5635 An alternative way to capture and process property values into a table is
5636 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5637 package@footnote{Contributed packages are not part of Emacs, but are
5638 distributed with the main distribution of Org (visit
5639 @uref{http://orgmode.org}).}.  It provides a general API to collect
5640 properties from entries in a certain scope, and arbitrary Lisp expressions to
5641 process these values before inserting them into a table or a dynamic block.
5643 @node Property API,  , Column view, Properties and Columns
5644 @section The Property API
5645 @cindex properties, API
5646 @cindex API, for properties
5648 There is a full API for accessing and changing properties.  This API can
5649 be used by Emacs Lisp programs to work with properties and to implement
5650 features based on them.  For more information see @ref{Using the
5651 property API}.
5653 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5654 @chapter Dates and times
5655 @cindex dates
5656 @cindex times
5657 @cindex timestamp
5658 @cindex date stamp
5660 To assist project planning, TODO items can be labeled with a date and/or
5661 a time.  The specially formatted string carrying the date and time
5662 information is called a @emph{timestamp} in Org mode.  This may be a
5663 little confusing because timestamp is often used as indicating when
5664 something was created or last changed.  However, in Org mode this term
5665 is used in a much wider sense.
5667 @menu
5668 * Timestamps::                  Assigning a time to a tree entry
5669 * Creating timestamps::         Commands which insert timestamps
5670 * Deadlines and scheduling::    Planning your work
5671 * Clocking work time::          Tracking how long you spend on a task
5672 * Effort estimates::            Planning work effort in advance
5673 * Relative timer::              Notes with a running timer
5674 * Countdown timer::             Starting a countdown timer for a task
5675 @end menu
5678 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5679 @section Timestamps, deadlines, and scheduling
5680 @cindex timestamps
5681 @cindex ranges, time
5682 @cindex date stamps
5683 @cindex deadlines
5684 @cindex scheduling
5686 A timestamp is a specification of a date (possibly with a time or a range of
5687 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5688 simplest form, the day name is optional when you type the date yourself.
5689 However, any dates inserted or modified by Org will add that day name, for
5690 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5691 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5692 date/time format.  To use an alternative format, see @ref{Custom time
5693 format}.}.  A timestamp can appear anywhere in the headline or body of an Org
5694 tree entry.  Its presence causes entries to be shown on specific dates in the
5695 agenda (@pxref{Weekly/daily agenda}).  We distinguish:
5697 @table @var
5698 @item Plain timestamp; Event; Appointment
5699 @cindex timestamp
5700 @cindex appointment
5701 A simple timestamp just assigns a date/time to an item.  This is just
5702 like writing down an appointment or event in a paper agenda.  In the
5703 timeline and agenda displays, the headline of an entry associated with a
5704 plain timestamp will be shown exactly on that date.
5706 @example
5707 * Meet Peter at the movies
5708   <2006-11-01 Wed 19:15>
5709 * Discussion on climate change
5710   <2006-11-02 Thu 20:00-22:00>
5711 @end example
5713 @item Timestamp with repeater interval
5714 @cindex timestamp, with repeater interval
5715 A timestamp may contain a @emph{repeater interval}, indicating that it
5716 applies not only on the given date, but again and again after a certain
5717 interval of N days (d), weeks (w), months (m), or years (y).  The
5718 following will show up in the agenda every Wednesday:
5720 @example
5721 * Pick up Sam at school
5722   <2007-05-16 Wed 12:30 +1w>
5723 @end example
5725 @item Diary-style sexp entries
5726 For more complex date specifications, Org mode supports using the special
5727 sexp diary entries implemented in the Emacs calendar/diary
5728 package@footnote{When working with the standard diary sexp functions, you
5729 need to be very careful with the order of the arguments.  That order depend
5730 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5731 versions, @code{european-calendar-style}).  For example, to specify a date
5732 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5733 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5734 the settings.  This has been the source of much confusion.  Org mode users
5735 can resort to special versions of these functions like @code{org-date} or
5736 @code{org-anniversary}.  These work just like the corresponding @code{diary-}
5737 functions, but with stable ISO order of arguments (year, month, day) wherever
5738 applicable, independent of the value of @code{calendar-date-style}.}.  For
5739 example with optional time
5741 @example
5742 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5743   <%%(diary-float t 4 2)>
5744 @end example
5746 @item Time/Date range
5747 @cindex timerange
5748 @cindex date range
5749 Two timestamps connected by @samp{--} denote a range.  The headline
5750 will be shown on the first and last day of the range, and on any dates
5751 that are displayed and fall in the range.  Here is an example:
5753 @example
5754 ** Meeting in Amsterdam
5755    <2004-08-23 Mon>--<2004-08-26 Thu>
5756 @end example
5758 @item Inactive timestamp
5759 @cindex timestamp, inactive
5760 @cindex inactive timestamp
5761 Just like a plain timestamp, but with square brackets instead of
5762 angular ones.  These timestamps are inactive in the sense that they do
5763 @emph{not} trigger an entry to show up in the agenda.
5765 @example
5766 * Gillian comes late for the fifth time
5767   [2006-11-01 Wed]
5768 @end example
5770 @end table
5772 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5773 @section Creating timestamps
5774 @cindex creating timestamps
5775 @cindex timestamps, creating
5777 For Org mode to recognize timestamps, they need to be in the specific
5778 format.  All commands listed below produce timestamps in the correct
5779 format.
5781 @table @kbd
5782 @orgcmd{C-c .,org-time-stamp}
5783 Prompt for a date and insert a corresponding timestamp.  When the cursor is
5784 at an existing timestamp in the buffer, the command is used to modify this
5785 timestamp instead of inserting a new one.  When this command is used twice in
5786 succession, a time range is inserted.
5788 @orgcmd{C-c !,org-time-stamp-inactive}
5789 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5790 an agenda entry.
5792 @kindex C-u C-c .
5793 @kindex C-u C-c !
5794 @item C-u C-c .
5795 @itemx C-u C-c !
5796 @vindex org-time-stamp-rounding-minutes
5797 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5798 contains date and time.  The default time can be rounded to multiples of 5
5799 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5801 @orgkey{C-c C-c}
5802 Normalize timestamp, insert/fix day name if missing or wrong.
5804 @orgcmd{C-c <,org-date-from-calendar}
5805 Insert a timestamp corresponding to the cursor date in the Calendar.
5807 @orgcmd{C-c >,org-goto-calendar}
5808 Access the Emacs calendar for the current date.  If there is a
5809 timestamp in the current line, go to the corresponding date
5810 instead.
5812 @orgcmd{C-c C-o,org-open-at-point}
5813 Access the agenda for the date given by the timestamp or -range at
5814 point (@pxref{Weekly/daily agenda}).
5816 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5817 Change date at cursor by one day.  These key bindings conflict with
5818 shift-selection and related modes (@pxref{Conflicts}).
5820 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5821 Change the item under the cursor in a timestamp.  The cursor can be on a
5822 year, month, day, hour or minute.  When the timestamp contains a time range
5823 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5824 shifting the time block with constant length.  To change the length, modify
5825 the second time.  Note that if the cursor is in a headline and not at a
5826 timestamp, these same keys modify the priority of an item.
5827 (@pxref{Priorities}).  The key bindings also conflict with shift-selection and
5828 related modes (@pxref{Conflicts}).
5830 @orgcmd{C-c C-y,org-evaluate-time-range}
5831 @cindex evaluate time range
5832 Evaluate a time range by computing the difference between start and end.
5833 With a prefix argument, insert result after the time range (in a table: into
5834 the following column).
5835 @end table
5838 @menu
5839 * The date/time prompt::        How Org mode helps you entering date and time
5840 * Custom time format::          Making dates look different
5841 @end menu
5843 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5844 @subsection The date/time prompt
5845 @cindex date, reading in minibuffer
5846 @cindex time, reading in minibuffer
5848 @vindex org-read-date-prefer-future
5849 When Org mode prompts for a date/time, the default is shown in default
5850 date/time format, and the prompt therefore seems to ask for a specific
5851 format.  But it will in fact accept date/time information in a variety of
5852 formats.  Generally, the information should start at the beginning of the
5853 string.  Org mode will find whatever information is in
5854 there and derive anything you have not specified from the @emph{default date
5855 and time}.  The default is usually the current date and time, but when
5856 modifying an existing timestamp, or when entering the second stamp of a
5857 range, it is taken from the stamp in the buffer.  When filling in
5858 information, Org mode assumes that most of the time you will want to enter a
5859 date in the future: if you omit the month/year and the given day/month is
5860 @i{before} today, it will assume that you mean a future date@footnote{See the
5861 variable @code{org-read-date-prefer-future}.  You may set that variable to
5862 the symbol @code{time} to even make a time before now shift the date to
5863 tomorrow.}.  If the date has been automatically shifted into the future, the
5864 time prompt will show this with @samp{(=>F).}
5866 For example, let's assume that today is @b{June 13, 2006}.  Here is how
5867 various inputs will be interpreted, the items filled in by Org mode are
5868 in @b{bold}.
5870 @example
5871 3-2-5         @result{} 2003-02-05
5872 2/5/3         @result{} 2003-02-05
5873 14            @result{} @b{2006}-@b{06}-14
5874 12            @result{} @b{2006}-@b{07}-12
5875 2/5           @result{} @b{2007}-02-05
5876 Fri           @result{} nearest Friday (default date or later)
5877 sep 15        @result{} @b{2006}-09-15
5878 feb 15        @result{} @b{2007}-02-15
5879 sep 12 9      @result{} 2009-09-12
5880 12:45         @result{} @b{2006}-@b{06}-@b{13} 12:45
5881 22 sept 0:34  @result{} @b{2006}-09-22 0:34
5882 w4            @result{} ISO week for of the current year @b{2006}
5883 2012 w4 fri   @result{} Friday of ISO week 4 in 2012
5884 2012-w04-5    @result{} Same as above
5885 @end example
5887 Furthermore you can specify a relative date by giving, as the @emph{first}
5888 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
5889 indicate change in hours, days, weeks, months, or years.  With a single plus
5890 or minus, the date is always relative to today.  With a double plus or minus,
5891 it is relative to the default date.  If instead of a single letter, you use
5892 the abbreviation of day name, the date will be the Nth such day, e.g.:
5894 @example
5895 +0            @result{} today
5896 .             @result{} today
5897 +4d           @result{} four days from today
5898 +4            @result{} same as above
5899 +2w           @result{} two weeks from today
5900 ++5           @result{} five days from default date
5901 +2tue         @result{} second Tuesday from now.
5902 @end example
5904 @vindex parse-time-months
5905 @vindex parse-time-weekdays
5906 The function understands English month and weekday abbreviations.  If
5907 you want to use unabbreviated names and/or other languages, configure
5908 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5910 @vindex org-read-date-force-compatible-dates
5911 Not all dates can be represented in a given Emacs implementation.  By default
5912 Org mode forces dates into the compatibility range 1970--2037 which works on
5913 all Emacs implementations.  If you want to use dates outside of this range,
5914 read the docstring of the variable
5915 @code{org-read-date-force-compatible-dates}.
5917 You can specify a time range by giving start and end times or by giving a
5918 start time and a duration (in HH:MM format).  Use one or two dash(es) as the
5919 separator in the former case and use '+' as the separator in the latter
5920 case, e.g.:
5922 @example
5923 11am-1:15pm    @result{} 11:00-13:15
5924 11am--1:15pm   @result{} same as above
5925 11am+2:15      @result{} same as above
5926 @end example
5928 @cindex calendar, for selecting date
5929 @vindex org-popup-calendar-for-date-prompt
5930 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5931 you don't need/want the calendar, configure the variable
5932 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
5933 prompt, either by clicking on a date in the calendar, or by pressing
5934 @key{RET}, the date selected in the calendar will be combined with the
5935 information entered at the prompt.  You can control the calendar fully
5936 from the minibuffer:
5938 @kindex <
5939 @kindex >
5940 @kindex M-v
5941 @kindex C-v
5942 @kindex mouse-1
5943 @kindex S-@key{right}
5944 @kindex S-@key{left}
5945 @kindex S-@key{down}
5946 @kindex S-@key{up}
5947 @kindex M-S-@key{right}
5948 @kindex M-S-@key{left}
5949 @kindex @key{RET}
5950 @example
5951 @key{RET}           @r{Choose date at cursor in calendar.}
5952 mouse-1        @r{Select date by clicking on it.}
5953 S-@key{right}/@key{left}     @r{One day forward/backward.}
5954 S-@key{down}/@key{up}     @r{One week forward/backward.}
5955 M-S-@key{right}/@key{left}   @r{One month forward/backward.}
5956 > / <          @r{Scroll calendar forward/backward by one month.}
5957 M-v / C-v      @r{Scroll calendar forward/backward by 3 months.}
5958 @end example
5960 @vindex org-read-date-display-live
5961 The actions of the date/time prompt may seem complex, but I assure you they
5962 will grow on you, and you will start getting annoyed by pretty much any other
5963 way of entering a date/time out there.  To help you understand what is going
5964 on, the current interpretation of your input will be displayed live in the
5965 minibuffer@footnote{If you find this distracting, turn the display of with
5966 @code{org-read-date-display-live}.}.
5968 @node Custom time format,  , The date/time prompt, Creating timestamps
5969 @subsection Custom time format
5970 @cindex custom date/time format
5971 @cindex time format, custom
5972 @cindex date format, custom
5974 @vindex org-display-custom-times
5975 @vindex org-time-stamp-custom-formats
5976 Org mode uses the standard ISO notation for dates and times as it is
5977 defined in ISO 8601.  If you cannot get used to this and require another
5978 representation of date and time to keep you happy, you can get it by
5979 customizing the variables @code{org-display-custom-times} and
5980 @code{org-time-stamp-custom-formats}.
5982 @table @kbd
5983 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5984 Toggle the display of custom formats for dates and times.
5985 @end table
5987 @noindent
5988 Org mode needs the default format for scanning, so the custom date/time
5989 format does not @emph{replace} the default format---instead it is put
5990 @emph{over} the default format using text properties.  This has the
5991 following consequences:
5992 @itemize @bullet
5993 @item
5994 You cannot place the cursor onto a timestamp anymore, only before or
5995 after.
5996 @item
5997 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5998 each component of a timestamp.  If the cursor is at the beginning of
5999 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6000 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
6001 time will be changed by one minute.
6002 @item
6003 If the timestamp contains a range of clock times or a repeater, these
6004 will not be overlaid, but remain in the buffer as they were.
6005 @item
6006 When you delete a timestamp character-by-character, it will only
6007 disappear from the buffer after @emph{all} (invisible) characters
6008 belonging to the ISO timestamp have been removed.
6009 @item
6010 If the custom timestamp format is longer than the default and you are
6011 using dates in tables, table alignment will be messed up.  If the custom
6012 format is shorter, things do work as expected.
6013 @end itemize
6016 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
6017 @section Deadlines and scheduling
6019 A timestamp may be preceded by special keywords to facilitate planning:
6021 @table @var
6022 @item DEADLINE
6023 @cindex DEADLINE keyword
6025 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6026 to be finished on that date.
6028 @vindex org-deadline-warning-days
6029 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6030 On the deadline date, the task will be listed in the agenda.  In
6031 addition, the agenda for @emph{today} will carry a warning about the
6032 approaching or missed deadline, starting
6033 @code{org-deadline-warning-days} before the due date, and continuing
6034 until the entry is marked DONE@.  An example:
6036 @example
6037 *** TODO write article about the Earth for the Guide
6038     DEADLINE: <2004-02-29 Sun>
6039     The editor in charge is [[bbdb:Ford Prefect]]
6040 @end example
6042 You can specify a different lead time for warnings for a specific
6043 deadlines using the following syntax.  Here is an example with a warning
6044 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.  This warning is
6045 deactivated if the task get scheduled and you set
6046 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6048 @item SCHEDULED
6049 @cindex SCHEDULED keyword
6051 Meaning: you are planning to start working on that task on the given
6052 date.
6054 @vindex org-agenda-skip-scheduled-if-done
6055 The headline will be listed under the given date@footnote{It will still
6056 be listed on that date after it has been marked DONE@.  If you don't like
6057 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
6058 addition, a reminder that the scheduled date has passed will be present
6059 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6060 the task will automatically be forwarded until completed.
6062 @example
6063 *** TODO Call Trillian for a date on New Years Eve.
6064     SCHEDULED: <2004-12-25 Sat>
6065 @end example
6067 @vindex org-scheduled-delay-days
6068 @vindex org-agenda-skip-scheduled-delay-if-deadline
6069 If you want to @emph{delay} the display of this task in the agenda, use
6070 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6071 25th but will appear two days later.  In case the task contains a repeater,
6072 the delay is considered to affect all occurrences; if you want the delay to
6073 only affect the first scheduled occurrence of the task, use @code{--2d}
6074 instead.  See @code{org-scheduled-delay-days} and
6075 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6076 control this globally or per agenda.
6078 @noindent
6079 @b{Important:} Scheduling an item in Org mode should @i{not} be
6080 understood in the same way that we understand @i{scheduling a meeting}.
6081 Setting a date for a meeting is just a simple appointment, you should
6082 mark this entry with a simple plain timestamp, to get this item shown
6083 on the date where it applies.  This is a frequent misunderstanding by
6084 Org users.  In Org mode, @i{scheduling} means setting a date when you
6085 want to start working on an action item.
6086 @end table
6088 You may use timestamps with repeaters in scheduling and deadline
6089 entries.  Org mode will issue early and late warnings based on the
6090 assumption that the timestamp represents the @i{nearest instance} of
6091 the repeater.  However, the use of diary sexp entries like
6093 @code{<%%(diary-float t 42)>}
6095 in scheduling and deadline timestamps is limited.  Org mode does not
6096 know enough about the internals of each sexp function to issue early and
6097 late warnings.  However, it will show the item on each day where the
6098 sexp entry matches.
6100 @menu
6101 * Inserting deadline/schedule::  Planning items
6102 * Repeated tasks::              Items that show up again and again
6103 @end menu
6105 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
6106 @subsection Inserting deadlines or schedules
6108 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6109 @samp{DEADLINE} dates are inserted on the line right below the headline.  Don't put
6110 any text between this line and the headline.} a deadline or to schedule
6111 an item:
6113 @table @kbd
6115 @orgcmd{C-c C-d,org-deadline}
6116 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will happen
6117 in the line directly following the headline.  Any CLOSED timestamp will be
6118 removed.  When called with a prefix arg, an existing deadline will be removed
6119 from the entry.  Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6120 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6121 and @code{nologredeadline}}, a note will be taken when changing an existing
6122 deadline.
6124 @orgcmd{C-c C-s,org-schedule}
6125 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
6126 happen in the line directly following the headline.  Any CLOSED timestamp
6127 will be removed.  When called with a prefix argument, remove the scheduling
6128 date from the entry.  Depending on the variable
6129 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6130 keywords @code{logreschedule}, @code{lognotereschedule}, and
6131 @code{nologreschedule}}, a note will be taken when changing an existing
6132 scheduling time.
6134 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
6135 @kindex k a
6136 @kindex k s
6137 Mark the current entry for agenda action.  After you have marked the entry
6138 like this, you can open the agenda or the calendar to find an appropriate
6139 date.  With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
6140 schedule the marked item.
6142 @orgcmd{C-c / d,org-check-deadlines}
6143 @cindex sparse tree, for deadlines
6144 @vindex org-deadline-warning-days
6145 Create a sparse tree with all deadlines that are either past-due, or
6146 which will become due within @code{org-deadline-warning-days}.
6147 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
6148 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
6149 all deadlines due tomorrow.
6151 @orgcmd{C-c / b,org-check-before-date}
6152 Sparse tree for deadlines and scheduled items before a given date.
6154 @orgcmd{C-c / a,org-check-after-date}
6155 Sparse tree for deadlines and scheduled items after a given date.
6156 @end table
6158 Note that @code{org-schedule} and @code{org-deadline} supports
6159 setting the date by indicating a relative time: e.g., +1d will set
6160 the date to the next day after today, and --1w will set the date
6161 to the previous week before any current timestamp.
6163 @node Repeated tasks,  , Inserting deadline/schedule, Deadlines and scheduling
6164 @subsection Repeated tasks
6165 @cindex tasks, repeated
6166 @cindex repeated tasks
6168 Some tasks need to be repeated again and again.  Org mode helps to
6169 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6170 or plain timestamp.  In the following example
6171 @example
6172 ** TODO Pay the rent
6173    DEADLINE: <2005-10-01 Sat +1m>
6174 @end example
6175 @noindent
6176 the @code{+1m} is a repeater; the intended interpretation is that the task
6177 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6178 from that time.  You can use yearly, monthly, weekly, daily and hourly repeat
6179 cookies by using the @code{y/w/m/d/h} letters.  If you need both a repeater
6180 and a special warning period in a deadline entry, the repeater should come
6181 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6183 @vindex org-todo-repeat-to-state
6184 Deadlines and scheduled items produce entries in the agenda when they are
6185 over-due, so it is important to be able to mark such an entry as completed
6186 once you have done so.  When you mark a DEADLINE or a SCHEDULE with the TODO
6187 keyword DONE, it will no longer produce entries in the agenda.  The problem
6188 with this is, however, that then also the @emph{next} instance of the
6189 repeated entry will not be active.  Org mode deals with this in the following
6190 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6191 shift the base date of the repeating timestamp by the repeater interval, and
6192 immediately set the entry state back to TODO@footnote{In fact, the target
6193 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6194 the variable @code{org-todo-repeat-to-state}.  If neither of these is
6195 specified, the target state defaults to the first state of the TODO state
6196 sequence.}.  In the example above, setting the state to DONE would actually
6197 switch the date like this:
6199 @example
6200 ** TODO Pay the rent
6201    DEADLINE: <2005-11-01 Tue +1m>
6202 @end example
6204 @vindex org-log-repeat
6205 A timestamp@footnote{You can change this using the option
6206 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6207 @code{lognoterepeat}, and @code{nologrepeat}.  With @code{lognoterepeat}, you
6208 will also be prompted for a note.} will be added under the deadline, to keep
6209 a record that you actually acted on the previous instance of this deadline.
6211 As a consequence of shifting the base date, this entry will no longer be
6212 visible in the agenda when checking past dates, but all future instances
6213 will be visible.
6215 With the @samp{+1m} cookie, the date shift will always be exactly one
6216 month.  So if you have not paid the rent for three months, marking this
6217 entry DONE will still keep it as an overdue deadline.  Depending on the
6218 task, this may not be the best way to handle it.  For example, if you
6219 forgot to call your father for 3 weeks, it does not make sense to call
6220 him 3 times in a single day to make up for it.  Finally, there are tasks
6221 like changing batteries which should always repeat a certain time
6222 @i{after} the last time you did it.  For these tasks, Org mode has
6223 special repeaters  @samp{++} and @samp{.+}.  For example:
6225 @example
6226 ** TODO Call Father
6227    DEADLINE: <2008-02-10 Sun ++1w>
6228    Marking this DONE will shift the date by at least one week,
6229    but also by as many weeks as it takes to get this date into
6230    the future.  However, it stays on a Sunday, even if you called
6231    and marked it done on Saturday.
6232 ** TODO Check the batteries in the smoke detectors
6233    DEADLINE: <2005-11-01 Tue .+1m>
6234    Marking this DONE will shift the date to one month after
6235    today.
6236 @end example
6238 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6239 You may have both scheduling and deadline information for a specific task.
6240 If the repeater is set for the scheduling information only, you probably want
6241 the repeater to be ignored after the deadline.  If so, set the variable
6242 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6243 @code{repeated-after-deadline}.  If you want both scheduling and deadline
6244 information to repeat after the same interval, set the same repeater for both
6245 timestamps.
6247 An alternative to using a repeater is to create a number of copies of a task
6248 subtree, with dates shifted in each copy.  The command @kbd{C-c C-x c} was
6249 created for this purpose, it is described in @ref{Structure editing}.
6252 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
6253 @section Clocking work time
6254 @cindex clocking time
6255 @cindex time clocking
6257 Org mode allows you to clock the time you spend on specific tasks in a
6258 project.  When you start working on an item, you can start the clock.  When
6259 you stop working on that task, or when you mark the task done, the clock is
6260 stopped and the corresponding time interval is recorded.  It also computes
6261 the total time spent on each subtree@footnote{Clocking only works if all
6262 headings are indented with less than 30 stars.  This is a hardcoded
6263 limitation of `lmax' in `org-clock-sum'.} of a project.  And it remembers a
6264 history or tasks recently clocked, to that you can jump quickly between a
6265 number of tasks absorbing your time.
6267 To save the clock history across Emacs sessions, use
6268 @lisp
6269 (setq org-clock-persist 'history)
6270 (org-clock-persistence-insinuate)
6271 @end lisp
6272 When you clock into a new task after resuming Emacs, the incomplete
6273 clock@footnote{To resume the clock under the assumption that you have worked
6274 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6275 will be found (@pxref{Resolving idle time}) and you will be prompted about
6276 what to do with it.
6278 @menu
6279 * Clocking commands::           Starting and stopping a clock
6280 * The clock table::             Detailed reports
6281 * Resolving idle time::         Resolving time when you've been idle
6282 @end menu
6284 @node Clocking commands, The clock table, Clocking work time, Clocking work time
6285 @subsection Clocking commands
6287 @table @kbd
6288 @orgcmd{C-c C-x C-i,org-clock-in}
6289 @vindex org-clock-into-drawer
6290 @vindex org-clock-continuously
6291 @cindex property, LOG_INTO_DRAWER
6292 Start the clock on the current item (clock-in).  This inserts the CLOCK
6293 keyword together with a timestamp.  If this is not the first clocking of
6294 this item, the multiple CLOCK lines will be wrapped into a
6295 @code{:LOGBOOK:} drawer (see also the variable
6296 @code{org-clock-into-drawer}).  You can also overrule
6297 the setting of this variable for a subtree by setting a
6298 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6299 When called with a @kbd{C-u} prefix argument,
6300 select the task from a list of recently clocked tasks.  With two @kbd{C-u
6301 C-u} prefixes, clock into the task at point and mark it as the default task;
6302 the default task will then always be available with letter @kbd{d} when
6303 selecting a clocking task.  With three @kbd{C-u C-u C-u} prefixes, force
6304 continuous clocking by starting the clock when the last clock stopped.@*
6305 @cindex property: CLOCK_MODELINE_TOTAL
6306 @cindex property: LAST_REPEAT
6307 @vindex org-clock-modeline-total
6308 While the clock is running, the current clocking time is shown in the mode
6309 line, along with the title of the task.  The clock time shown will be all
6310 time ever clocked for this task and its children.  If the task has an effort
6311 estimate (@pxref{Effort estimates}), the mode line displays the current
6312 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6313 hook a function doing this to @code{org-clock-in-prepare-hook}.}  If the task
6314 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6315 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6316 will be shown.  More control over what time is shown can be exercised with
6317 the @code{CLOCK_MODELINE_TOTAL} property.  It may have the values
6318 @code{current} to show only the current clocking instance, @code{today} to
6319 show all time clocked on this tasks today (see also the variable
6320 @code{org-extend-today-until}), @code{all} to include all time, or
6321 @code{auto} which is the default@footnote{See also the variable
6322 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6323 mode line entry will pop up a menu with clocking options.
6325 @orgcmd{C-c C-x C-o,org-clock-out}
6326 @vindex org-log-note-clock-out
6327 Stop the clock (clock-out).  This inserts another timestamp at the same
6328 location where the clock was last started.  It also directly computes
6329 the resulting time in inserts it after the time range as @samp{=>
6330 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
6331 possibility to record an additional note together with the clock-out
6332 timestamp@footnote{The corresponding in-buffer setting is:
6333 @code{#+STARTUP: lognoteclock-out}}.
6334 @orgcmd{C-c C-x C-x,org-clock-in-last}
6335 @vindex org-clock-continuously
6336 Reclock the last clocked task.  With one @kbd{C-u} prefix argument,
6337 select the task from the clock history.  With two @kbd{C-u} prefixes,
6338 force continuous clocking by starting the clock when the last clock
6339 stopped.
6340 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6341 Update the effort estimate for the current clock task.
6342 @kindex C-c C-y
6343 @kindex C-c C-c
6344 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6345 Recompute the time interval after changing one of the timestamps.  This
6346 is only necessary if you edit the timestamps directly.  If you change
6347 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6348 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6349 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6350 clock duration keeps the same.
6351 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6352 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6353 the one of the previous (or the next clock) timestamp by the same duration.
6354 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6355 by five minutes, then the clocked-in timestamp of the next clock will be
6356 increased by five minutes.
6357 @orgcmd{C-c C-t,org-todo}
6358 Changing the TODO state of an item to DONE automatically stops the clock
6359 if it is running in this same item.
6360 @orgcmd{C-c C-x C-q,org-clock-cancel}
6361 Cancel the current clock.  This is useful if a clock was started by
6362 mistake, or if you ended up working on something else.
6363 @orgcmd{C-c C-x C-j,org-clock-goto}
6364 Jump to the headline of the currently clocked in task.  With a @kbd{C-u}
6365 prefix arg, select the target task from a list of recently clocked tasks.
6366 @orgcmd{C-c C-x C-d,org-clock-display}
6367 @vindex org-remove-highlights-with-change
6368 Display time summaries for each subtree in the current buffer.  This puts
6369 overlays at the end of each headline, showing the total time recorded under
6370 that heading, including the time of any subheadings.  You can use visibility
6371 cycling to study the tree, but the overlays disappear when you change the
6372 buffer (see variable @code{org-remove-highlights-with-change}) or press
6373 @kbd{C-c C-c}.
6374 @end table
6376 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6377 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6378 worked on or closed during a day.
6380 @strong{Important:} note that both @code{org-clock-out} and
6381 @code{org-clock-in-last} can have a global keybinding and will not
6382 modify the window disposition.
6384 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6385 @subsection The clock table
6386 @cindex clocktable, dynamic block
6387 @cindex report, of clocked time
6389 Org mode can produce quite complex reports based on the time clocking
6390 information.  Such a report is called a @emph{clock table}, because it is
6391 formatted as one or several Org tables.
6393 @table @kbd
6394 @orgcmd{C-c C-x C-r,org-clock-report}
6395 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6396 report as an Org mode table into the current file.  When the cursor is
6397 at an existing clock table, just update it.  When called with a prefix
6398 argument, jump to the first clock report in the current document and
6399 update it.  The clock table always includes also trees with
6400 @code{:ARCHIVE:} tag.
6401 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6402 Update dynamic block at point.  The cursor needs to be in the
6403 @code{#+BEGIN} line of the dynamic block.
6404 @orgkey{C-u C-c C-x C-u}
6405 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
6406 you have several clock table blocks in a buffer.
6407 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6408 Shift the current @code{:block} interval and update the table.  The cursor
6409 needs to be in the @code{#+BEGIN: clocktable} line for this command.  If
6410 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6411 @end table
6414 Here is an example of the frame for a clock table as it is inserted into the
6415 buffer with the @kbd{C-c C-x C-r} command:
6417 @cindex #+BEGIN, clocktable
6418 @example
6419 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6420 #+END: clocktable
6421 @end example
6422 @noindent
6423 @vindex org-clocktable-defaults
6424 The @samp{BEGIN} line and specify a number of options to define the scope,
6425 structure, and formatting of the report.  Defaults for all these options can
6426 be configured in the variable @code{org-clocktable-defaults}.
6428 @noindent First there are options that determine which clock entries are to
6429 be selected:
6430 @example
6431 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
6432              @r{Clocks at deeper levels will be summed into the upper level.}
6433 :scope       @r{The scope to consider.  This can be any of the following:}
6434              nil        @r{the current buffer or narrowed region}
6435              file       @r{the full current buffer}
6436              subtree    @r{the subtree where the clocktable is located}
6437              tree@var{N}      @r{the surrounding level @var{N} tree, for example @code{tree3}}
6438              tree       @r{the surrounding level 1 tree}
6439              agenda     @r{all agenda files}
6440              ("file"..) @r{scan these files}
6441              file-with-archives    @r{current file and its archives}
6442              agenda-with-archives  @r{all agenda files, including archives}
6443 :block       @r{The time block to consider.  This block is specified either}
6444              @r{absolute, or relative to the current time and may be any of}
6445              @r{these formats:}
6446              2007-12-31    @r{New year eve 2007}
6447              2007-12       @r{December 2007}
6448              2007-W50      @r{ISO-week 50 in 2007}
6449              2007-Q2       @r{2nd quarter in 2007}
6450              2007          @r{the year 2007}
6451              today, yesterday, today-@var{N}          @r{a relative day}
6452              thisweek, lastweek, thisweek-@var{N}     @r{a relative week}
6453              thismonth, lastmonth, thismonth-@var{N}  @r{a relative month}
6454              thisyear, lastyear, thisyear-@var{N}     @r{a relative year}
6455              @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6456 :tstart      @r{A time string specifying when to start considering times.}
6457              @r{Relative times like @code{"<-2w>"} can also be used.  See}
6458              @r{@ref{Matching tags and properties} for relative time syntax.}
6459 :tend        @r{A time string specifying when to stop considering times.}
6460              @r{Relative times like @code{"<now>"} can also be used.  See}
6461              @r{@ref{Matching tags and properties} for relative time syntax.}
6462 :wstart      @r{The starting day of the week.  The default is 1 for monday.}
6463 :mstart      @r{The starting day of the month.  The default 1 is for the first}
6464              @r{day of the month.}
6465 :step        @r{@code{week} or @code{day}, to split the table into chunks.}
6466              @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6467 :stepskip0   @r{Do not show steps that have zero time.}
6468 :fileskip0   @r{Do not show table sections from files which did not contribute.}
6469 :tags        @r{A tags match to select entries that should contribute.  See}
6470              @r{@ref{Matching tags and properties} for the match syntax.}
6471 @end example
6473 Then there are options which determine the formatting of the table.  There
6474 options are interpreted by the function @code{org-clocktable-write-default},
6475 but you can specify your own function using the @code{:formatter} parameter.
6476 @example
6477 :emphasize   @r{When @code{t}, emphasize level one and level two items.}
6478 :lang        @r{Language@footnote{Language terms can be set through the variable @code{org-clock-clocktable-language-setup}.} to use for descriptive cells like "Task".}
6479 :link        @r{Link the item headlines in the table to their origins.}
6480 :narrow      @r{An integer to limit the width of the headline column in}
6481              @r{the org table.  If you write it like @samp{50!}, then the}
6482              @r{headline will also be shortened in export.}
6483 :indent      @r{Indent each headline field according to its level.}
6484 :tcolumns    @r{Number of columns to be used for times.  If this is smaller}
6485              @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6486 :level       @r{Should a level number column be included?}
6487 :compact     @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6488              @r{All are overwritten except if there is an explicit @code{:narrow}}
6489 :timestamp   @r{A timestamp for the entry, when available.  Look for SCHEDULED,}
6490              @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6491 :properties  @r{List of properties that should be shown in the table.  Each}
6492              @r{property will get its own column.}
6493 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6494 :formula     @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6495              @r{As a special case, @samp{:formula %} adds a column with % time.}
6496              @r{If you do not specify a formula here, any existing formula}
6497              @r{below the clock table will survive updates and be evaluated.}
6498 :formatter   @r{A function to format clock data and insert it into the buffer.}
6499 @end example
6500 To get a clock summary of the current level 1 tree, for the current
6501 day, you could write
6502 @example
6503 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6504 #+END: clocktable
6505 @end example
6506 @noindent
6507 and to use a specific time range you could write@footnote{Note that all
6508 parameters must be specified in a single line---the line is broken here
6509 only to fit it into the manual.}
6510 @example
6511 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6512                     :tend "<2006-08-10 Thu 12:00>"
6513 #+END: clocktable
6514 @end example
6515 A range starting a week ago and ending right now could be written as
6516 @example
6517 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6518 #+END: clocktable
6519 @end example
6520 A summary of the current subtree with % times would be
6521 @example
6522 #+BEGIN: clocktable :scope subtree :link t :formula %
6523 #+END: clocktable
6524 @end example
6525 A horizontally compact representation of everything clocked during last week
6526 would be
6527 @example
6528 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6529 #+END: clocktable
6530 @end example
6532 @node Resolving idle time,  , The clock table, Clocking work time
6533 @subsection Resolving idle time and continuous clocking
6535 @subsubheading Resolving idle time
6536 @cindex resolve idle time
6537 @vindex org-clock-x11idle-program-name
6539 @cindex idle, resolve, dangling
6540 If you clock in on a work item, and then walk away from your
6541 computer---perhaps to take a phone call---you often need to ``resolve'' the
6542 time you were away by either subtracting it from the current clock, or
6543 applying it to another one.
6545 @vindex org-clock-idle-time
6546 By customizing the variable @code{org-clock-idle-time} to some integer, such
6547 as 10 or 15, Emacs can alert you when you get back to your computer after
6548 being idle for that many minutes@footnote{On computers using Mac OS X,
6549 idleness is based on actual user idleness, not just Emacs' idle time.  For
6550 X11, you can install a utility program @file{x11idle.c}, available in the
6551 @code{contrib/scripts} directory of the Org git distribution, or install the
6552 @file{xprintidle} package and set it to the variable
6553 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6554 same general treatment of idleness.  On other systems, idle time refers to
6555 Emacs idle time only.}, and ask what you want to do with the idle time.
6556 There will be a question waiting for you when you get back, indicating how
6557 much idle time has passed (constantly updated with the current amount), as
6558 well as a set of choices to correct the discrepancy:
6560 @table @kbd
6561 @item k
6562 To keep some or all of the minutes and stay clocked in, press @kbd{k}.  Org
6563 will ask how many of the minutes to keep.  Press @key{RET} to keep them all,
6564 effectively changing nothing, or enter a number to keep that many minutes.
6565 @item K
6566 If you use the shift key and press @kbd{K}, it will keep however many minutes
6567 you request and then immediately clock out of that task.  If you keep all of
6568 the minutes, this is the same as just clocking out of the current task.
6569 @item s
6570 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6571 the clock, and then check back in from the moment you returned.
6572 @item S
6573 To keep none of the minutes and just clock out at the start of the away time,
6574 use the shift key and press @kbd{S}.  Remember that using shift will always
6575 leave you clocked out, no matter which option you choose.
6576 @item C
6577 To cancel the clock altogether, use @kbd{C}.  Note that if instead of
6578 canceling you subtract the away time, and the resulting clock amount is less
6579 than a minute, the clock will still be canceled rather than clutter up the
6580 log with an empty entry.
6581 @end table
6583 What if you subtracted those away minutes from the current clock, and now
6584 want to apply them to a new clock?  Simply clock in to any task immediately
6585 after the subtraction.  Org will notice that you have subtracted time ``on
6586 the books'', so to speak, and will ask if you want to apply those minutes to
6587 the next task you clock in on.
6589 There is one other instance when this clock resolution magic occurs.  Say you
6590 were clocked in and hacking away, and suddenly your cat chased a mouse who
6591 scared a hamster that crashed into your UPS's power button!  You suddenly
6592 lose all your buffers, but thanks to auto-save you still have your recent Org
6593 mode changes, including your last clock in.
6595 If you restart Emacs and clock into any task, Org will notice that you have a
6596 dangling clock which was never clocked out from your last session.  Using
6597 that clock's starting time as the beginning of the unaccounted-for period,
6598 Org will ask how you want to resolve that time.  The logic and behavior is
6599 identical to dealing with away time due to idleness; it is just happening due
6600 to a recovery event rather than a set amount of idle time.
6602 You can also check all the files visited by your Org agenda for dangling
6603 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6605 @subsubheading Continuous clocking
6606 @cindex continuous clocking
6607 @vindex org-clock-continuously
6609 You may want to start clocking from the time when you clocked out the
6610 previous task.  To enable this systematically, set @code{org-clock-continuously}
6611 to @code{t}.  Each time you clock in, Org retrieves the clock-out time of the
6612 last clocked entry for this session, and start the new clock from there.
6614 If you only want this from time to time, use three universal prefix arguments
6615 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6617 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6618 @section Effort estimates
6619 @cindex effort estimates
6621 @cindex property, Effort
6622 @vindex org-effort-property
6623 If you want to plan your work in a very detailed way, or if you need to
6624 produce offers with quotations of the estimated work effort, you may want to
6625 assign effort estimates to entries.  If you are also clocking your work, you
6626 may later want to compare the planned effort with the actual working time, a
6627 great way to improve planning estimates.  Effort estimates are stored in a
6628 special property @samp{Effort}@footnote{You may change the property being
6629 used with the variable @code{org-effort-property}.}.  You can set the effort
6630 for an entry with the following commands:
6632 @table @kbd
6633 @orgcmd{C-c C-x e,org-set-effort}
6634 Set the effort estimate for the current entry.  With a numeric prefix
6635 argument, set it to the Nth allowed value (see below).  This command is also
6636 accessible from the agenda with the @kbd{e} key.
6637 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6638 Modify the effort estimate of the item currently being clocked.
6639 @end table
6641 Clearly the best way to work with effort estimates is through column view
6642 (@pxref{Column view}).  You should start by setting up discrete values for
6643 effort estimates, and a @code{COLUMNS} format that displays these values
6644 together with clock sums (if you want to clock your time).  For a specific
6645 buffer you can use
6647 @example
6648 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6649 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6650 @end example
6652 @noindent
6653 @vindex org-global-properties
6654 @vindex org-columns-default-format
6655 or, even better, you can set up these values globally by customizing the
6656 variables @code{org-global-properties} and @code{org-columns-default-format}.
6657 In particular if you want to use this setup also in the agenda, a global
6658 setup may be advised.
6660 The way to assign estimates to individual items is then to switch to column
6661 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6662 value.  The values you enter will immediately be summed up in the hierarchy.
6663 In the column next to it, any clocked time will be displayed.
6665 @vindex org-agenda-columns-add-appointments-to-effort-sum
6666 If you switch to column view in the daily/weekly agenda, the effort column
6667 will summarize the estimated work effort for each day@footnote{Please note
6668 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6669 column view}).}, and you can use this to find space in your schedule.  To get
6670 an overview of the entire part of the day that is committed, you can set the
6671 option @code{org-agenda-columns-add-appointments-to-effort-sum}.  The
6672 appointments on a day that take place over a specified time interval will
6673 then also be added to the load estimate of the day.
6675 Effort estimates can be used in secondary agenda filtering that is triggered
6676 with the @kbd{/} key in the agenda (@pxref{Agenda commands}).  If you have
6677 these estimates defined consistently, two or three key presses will narrow
6678 down the list to stuff that fits into an available time slot.
6680 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6681 @section Taking notes with a relative timer
6682 @cindex relative timer
6684 When taking notes during, for example, a meeting or a video viewing, it can
6685 be useful to have access to times relative to a starting time.  Org provides
6686 such a relative timer and make it easy to create timed notes.
6688 @table @kbd
6689 @orgcmd{C-c C-x .,org-timer}
6690 Insert a relative time into the buffer.  The first time you use this, the
6691 timer will be started.  When called with a prefix argument, the timer is
6692 restarted.
6693 @orgcmd{C-c C-x -,org-timer-item}
6694 Insert a description list item with the current relative time.  With a prefix
6695 argument, first reset the timer to 0.
6696 @orgcmd{M-@key{RET},org-insert-heading}
6697 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6698 new timer items.
6699 @c for key sequences with a comma, command name macros fail :(
6700 @kindex C-c C-x ,
6701 @item C-c C-x ,
6702 Pause the timer, or continue it if it is already paused
6703 (@command{org-timer-pause-or-continue}).
6704 @c removed the sentence because it is redundant to the following item
6705 @kindex C-u C-c C-x ,
6706 @item C-u C-c C-x ,
6707 Stop the timer.  After this, you can only start a new timer, not continue the
6708 old one.  This command also removes the timer from the mode line.
6709 @orgcmd{C-c C-x 0,org-timer-start}
6710 Reset the timer without inserting anything into the buffer.  By default, the
6711 timer is reset to 0.  When called with a @kbd{C-u} prefix, reset the timer to
6712 specific starting offset.  The user is prompted for the offset, with a
6713 default taken from a timer string at point, if any, So this can be used to
6714 restart taking notes after a break in the process.  When called with a double
6715 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6716 by a certain amount.  This can be used to fix timer strings if the timer was
6717 not started at exactly the right moment.
6718 @end table
6720 @node Countdown timer,  , Relative timer, Dates and Times
6721 @section Countdown timer
6722 @cindex Countdown timer
6723 @kindex C-c C-x ;
6724 @kindex ;
6726 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6727 timer.  Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6729 @code{org-timer-set-timer} prompts the user for a duration and displays a
6730 countdown timer in the modeline.  @code{org-timer-default-timer} sets the
6731 default countdown value.  Giving a prefix numeric argument overrides this
6732 default value.
6734 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6735 @chapter Capture - Refile - Archive
6736 @cindex capture
6738 An important part of any organization system is the ability to quickly
6739 capture new ideas and tasks, and to associate reference material with them.
6740 Org does this using a process called @i{capture}.  It also can store files
6741 related to a task (@i{attachments}) in a special directory.  Once in the
6742 system, tasks and projects need to be moved around.  Moving completed project
6743 trees to an archive file keeps the system compact and fast.
6745 @menu
6746 * Capture::                     Capturing new stuff
6747 * Attachments::                 Add files to tasks
6748 * RSS Feeds::                   Getting input from RSS feeds
6749 * Protocols::                   External (e.g., Browser) access to Emacs and Org
6750 * Refile and copy::             Moving/copying a tree from one place to another
6751 * Archiving::                   What to do with finished projects
6752 @end menu
6754 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6755 @section Capture
6756 @cindex capture
6758 Capture lets you quickly store notes with little interruption of your work
6759 flow.  Org's method for capturing new items is heavily inspired by John
6760 Wiegley excellent @code{remember.el} package.  Up to version 6.36, Org
6761 used a special setup for @file{remember.el}, then replaced it with
6762 @file{org-remember.el}.  As of version 8.0, @file{org-remember.el} has
6763 been completely replaced by @file{org-capture.el}.
6765 If your configuration depends on @file{org-remember.el}, you need to update
6766 it and use the setup described below.  To convert your
6767 @code{org-remember-templates}, run the command
6768 @example
6769 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6770 @end example
6771 @noindent and then customize the new variable with @kbd{M-x
6772 customize-variable org-capture-templates}, check the result, and save the
6773 customization.
6775 @menu
6776 * Setting up capture::          Where notes will be stored
6777 * Using capture::               Commands to invoke and terminate capture
6778 * Capture templates::           Define the outline of different note types
6779 @end menu
6781 @node Setting up capture, Using capture, Capture, Capture
6782 @subsection Setting up capture
6784 The following customization sets a default target file for notes, and defines
6785 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6786 suggestion.}  for capturing new material.
6788 @vindex org-default-notes-file
6789 @smalllisp
6790 @group
6791 (setq org-default-notes-file (concat org-directory "/notes.org"))
6792 (define-key global-map "\C-cc" 'org-capture)
6793 @end group
6794 @end smalllisp
6796 @node Using capture, Capture templates, Setting up capture, Capture
6797 @subsection Using capture
6799 @table @kbd
6800 @orgcmd{C-c c,org-capture}
6801 Call the command @code{org-capture}.  Note that this keybinding is global and
6802 not active by default: you need to install it.  If you have templates
6803 @cindex date tree
6804 defined @pxref{Capture templates}, it will offer these templates for
6805 selection or use a new Org outline node as the default template.  It will
6806 insert the template into the target file and switch to an indirect buffer
6807 narrowed to this new node.  You may then insert the information you want.
6809 @orgcmd{C-c C-c,org-capture-finalize}
6810 Once you have finished entering information into the capture buffer, @kbd{C-c
6811 C-c} will return you to the window configuration before the capture process,
6812 so that you can resume your work without further distraction.  When called
6813 with a prefix arg, finalize and then jump to the captured item.
6815 @orgcmd{C-c C-w,org-capture-refile}
6816 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6817 a different place.  Please realize that this is a normal refiling command
6818 that will be executed---so the cursor position at the moment you run this
6819 command is important.  If you have inserted a tree with a parent and
6820 children, first move the cursor back to the parent.  Any prefix argument
6821 given to this command will be passed on to the @code{org-refile} command.
6823 @orgcmd{C-c C-k,org-capture-kill}
6824 Abort the capture process and return to the previous state.
6826 @end table
6828 You can also call @code{org-capture} in a special way from the agenda, using
6829 the @kbd{k c} key combination.  With this access, any timestamps inserted by
6830 the selected capture template will default to the cursor date in the agenda,
6831 rather than to the current date.
6833 To find the locations of the last stored capture, use @code{org-capture} with
6834 prefix commands:
6836 @table @kbd
6837 @orgkey{C-u C-c c}
6838 Visit the target location of a capture template.  You get to select the
6839 template in the usual way.
6840 @orgkey{C-u C-u C-c c}
6841 Visit the last stored capture item in its buffer.
6842 @end table
6844 @vindex org-capture-bookmark
6845 @cindex org-capture-last-stored
6846 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6847 automatically be created unless you set @code{org-capture-bookmark} to
6848 @code{nil}.
6850 To insert the capture at point in an Org buffer, call @code{org-capture} with
6851 a @code{C-0} prefix argument.
6853 @node Capture templates,  , Using capture, Capture
6854 @subsection Capture templates
6855 @cindex templates, for Capture
6857 You can use templates for different types of capture items, and
6858 for different target locations.  The easiest way to create such templates is
6859 through the customize interface.
6861 @table @kbd
6862 @orgkey{C-c c C}
6863 Customize the variable @code{org-capture-templates}.
6864 @end table
6866 Before we give the formal description of template definitions, let's look at
6867 an example.  Say you would like to use one template to create general TODO
6868 entries, and you want to put these entries under the heading @samp{Tasks} in
6869 your file @file{~/org/gtd.org}.  Also, a date tree in the file
6870 @file{journal.org} should capture journal entries.  A possible configuration
6871 would look like:
6873 @smalllisp
6874 @group
6875 (setq org-capture-templates
6876  '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6877         "* TODO %?\n  %i\n  %a")
6878    ("j" "Journal" entry (file+datetree "~/org/journal.org")
6879         "* %?\nEntered on %U\n  %i\n  %a")))
6880 @end group
6881 @end smalllisp
6883 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6884 for you like this:
6885 @example
6886 * TODO
6887   [[file:@var{link to where you initiated capture}]]
6888 @end example
6890 @noindent
6891 During expansion of the template, @code{%a} has been replaced by a link to
6892 the location from where you called the capture command.  This can be
6893 extremely useful for deriving tasks from emails, for example.  You fill in
6894 the task definition, press @code{C-c C-c} and Org returns you to the same
6895 place where you started the capture process.
6897 To define special keys to capture to a particular template without going
6898 through the interactive template selection, you can create your key binding
6899 like this:
6901 @lisp
6902 (define-key global-map "\C-cx"
6903    (lambda () (interactive) (org-capture nil "x")))
6904 @end lisp
6906 @menu
6907 * Template elements::           What is needed for a complete template entry
6908 * Template expansion::          Filling in information about time and context
6909 * Templates in contexts::       Only show a template in a specific context
6910 @end menu
6912 @node Template elements, Template expansion, Capture templates, Capture templates
6913 @subsubsection Template elements
6915 Now lets look at the elements of a template definition.  Each entry in
6916 @code{org-capture-templates} is a list with the following items:
6918 @table @var
6919 @item keys
6920 The keys that will select the template, as a string, characters
6921 only, for example @code{"a"} for a template to be selected with a
6922 single key, or @code{"bt"} for selection with two keys.  When using
6923 several keys, keys using the same prefix key must be sequential
6924 in the list and preceded by a 2-element entry explaining the
6925 prefix key, for example
6926 @smalllisp
6927          ("b" "Templates for marking stuff to buy")
6928 @end smalllisp
6929 @noindent If you do not define a template for the @kbd{C} key, this key will
6930 be used to open the customize buffer for this complex variable.
6932 @item description
6933 A short string describing the template, which will be shown during
6934 selection.
6936 @item type
6937 The type of entry, a symbol.  Valid values are:
6939 @table @code
6940 @item entry
6941 An Org mode node, with a headline.  Will be filed as the child of the target
6942 entry or as a top-level entry.  The target file should be an Org mode file.
6943 @item item
6944 A plain list item, placed in the first plain  list at the target
6945 location.  Again the target file should be an Org file.
6946 @item checkitem
6947 A checkbox item.  This only differs from the plain list item by the
6948 default template.
6949 @item table-line
6950 a new line in the first table at the target location.  Where exactly the
6951 line will be inserted depends on the properties @code{:prepend} and
6952 @code{:table-line-pos} (see below).
6953 @item plain
6954 Text to be inserted as it is.
6955 @end table
6957 @item target
6958 @vindex org-default-notes-file
6959 Specification of where the captured item should be placed.  In Org mode
6960 files, targets usually define a node.  Entries will become children of this
6961 node.  Other types will be added to the table or list in the body of this
6962 node.  Most target specifications contain a file name.  If that file name is
6963 the empty string, it defaults to @code{org-default-notes-file}.  A file can
6964 also be given as a variable, function, or Emacs Lisp form.
6966 Valid values are:
6968 @table @code
6969 @item (file "path/to/file")
6970 Text will be placed at the beginning or end of that file.
6972 @item (id "id of existing org entry")
6973 Filing as child of this entry, or in the body of the entry.
6975 @item (file+headline "path/to/file" "node headline")
6976 Fast configuration if the target heading is unique in the file.
6978 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6979 For non-unique headings, the full path is safer.
6981 @item (file+regexp  "path/to/file" "regexp to find location")
6982 Use a regular expression to position the cursor.
6984 @item (file+datetree "path/to/file")
6985 Will create a heading in a date tree for today's date.
6987 @item (file+datetree+prompt "path/to/file")
6988 Will create a heading in a date tree, but will prompt for the date.
6990 @item (file+function "path/to/file" function-finding-location)
6991 A function to find the right location in the file.
6993 @item (clock)
6994 File to the entry that is currently being clocked.
6996 @item (function function-finding-location)
6997 Most general way, write your own function to find both
6998 file and location.
6999 @end table
7001 @item template
7002 The template for creating the capture item.  If you leave this empty, an
7003 appropriate default template will be used.  Otherwise this is a string with
7004 escape codes, which will be replaced depending on time and context of the
7005 capture call.  The string with escapes may be loaded from a template file,
7006 using the special syntax @code{(file "path/to/template")}.  See below for
7007 more details.
7009 @item properties
7010 The rest of the entry is a property list of additional options.
7011 Recognized properties are:
7013 @table @code
7014 @item :prepend
7015 Normally new captured information will be appended at
7016 the target location (last child, last table line, last list item...).
7017 Setting this property will change that.
7019 @item :immediate-finish
7020 When set, do not offer to edit the information, just
7021 file it away immediately.  This makes sense if the template only needs
7022 information that can be added automatically.
7024 @item :empty-lines
7025 Set this to the number of lines to insert
7026 before and after the new item.  Default 0, only common other value is 1.
7028 @item :clock-in
7029 Start the clock in this item.
7031 @item :clock-keep
7032 Keep the clock running when filing the captured entry.
7034 @item :clock-resume
7035 If starting the capture interrupted a clock, restart that clock when finished
7036 with the capture.  Note that @code{:clock-keep} has precedence over
7037 @code{:clock-resume}.  When setting both to @code{t}, the current clock will
7038 run and the previous one will not be resumed.
7040 @item :unnarrowed
7041 Do not narrow the target buffer, simply show the full buffer.  Default is to
7042 narrow it so that you only see the new material.
7044 @item :table-line-pos
7045 Specification of the location in the table where the new line should be
7046 inserted.  It should be a string like @code{"II-3"} meaning that the new
7047 line should become the third line before the second horizontal separator
7048 line.
7050 @item :kill-buffer
7051 If the target file was not yet visited when capture was invoked, kill the
7052 buffer again after capture is completed.
7053 @end table
7054 @end table
7056 @node Template expansion, Templates in contexts, Template elements, Capture templates
7057 @subsubsection Template expansion
7059 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7060 these sequences literally, escape the @kbd{%} with a backslash.} allow
7061 dynamic insertion of content.  The templates are expanded in the order given here:
7063 @smallexample
7064 %[@var{file}]     @r{Insert the contents of the file given by @var{file}.}
7065 %(@var{sexp})     @r{Evaluate Elisp @var{sexp} and replace with the result.}
7066                   @r{For convenience, %:keyword (see below) placeholders}
7067                   @r{within the expression will be expanded prior to this.}
7068                   @r{The sexp must return a string.}
7069 %<...>      @r{The result of format-time-string on the ... format specification.}
7070 %t          @r{Timestamp, date only.}
7071 %T          @r{Timestamp, with date and time.}
7072 %u, %U      @r{Like the above, but inactive timestamps.}
7073 %i          @r{Initial content, the region when capture is called while the}
7074             @r{region is active.}
7075             @r{The entire text will be indented like @code{%i} itself.}
7076 %a          @r{Annotation, normally the link created with @code{org-store-link}.}
7077 %A          @r{Like @code{%a}, but prompt for the description part.}
7078 %l          @r{Like %a, but only insert the literal link.}
7079 %c          @r{Current kill ring head.}
7080 %x          @r{Content of the X clipboard.}
7081 %k          @r{Title of the currently clocked task.}
7082 %K          @r{Link to the currently clocked task.}
7083 %n          @r{User name (taken from @code{user-full-name}).}
7084 %f          @r{File visited by current buffer when org-capture was called.}
7085 %F          @r{Full path of the file or directory visited by current buffer.}
7086 %:keyword   @r{Specific information for certain link types, see below.}
7087 %^g         @r{Prompt for tags, with completion on tags in target file.}
7088 %^G         @r{Prompt for tags, with completion all tags in all agenda files.}
7089 %^t         @r{Like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7090             @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7091 %^C         @r{Interactive selection of which kill or clip to use.}
7092 %^L         @r{Like @code{%^C}, but insert as link.}
7093 %^@{@var{prop}@}p   @r{Prompt the user for a value for property @var{prop}.}
7094 %^@{@var{prompt}@}  @r{prompt the user for a string and replace this sequence with it.}
7095             @r{You may specify a default value and a completion table with}
7096             @r{%^@{prompt|default|completion2|completion3...@}.}
7097             @r{The arrow keys access a prompt-specific history.}
7098 %\n         @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7099             @r{a number, starting from 1.}
7100 %?          @r{After completing the template, position cursor here.}
7101 @end smallexample
7103 @noindent
7104 For specific link types, the following keywords will be
7105 defined@footnote{If you define your own link types (@pxref{Adding
7106 hyperlink types}), any property you store with
7107 @code{org-store-link-props} can be accessed in capture templates in a
7108 similar way.}:
7110 @vindex org-from-is-user-regexp
7111 @smallexample
7112 Link type                        |  Available keywords
7113 ---------------------------------+----------------------------------------------
7114 bbdb                             |  %:name %:company
7115 irc                              |  %:server %:port %:nick
7116 vm, vm-imap, wl, mh, mew, rmail  |  %:type %:subject %:message-id
7117                                  |  %:from %:fromname %:fromaddress
7118                                  |  %:to   %:toname   %:toaddress
7119                                  |  %:date @r{(message date header field)}
7120                                  |  %:date-timestamp @r{(date as active timestamp)}
7121                                  |  %:date-timestamp-inactive @r{(date as inactive timestamp)}
7122                                  |  %: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}.}}
7123 gnus                             |  %:group, @r{for messages also all email fields}
7124 w3, w3m                          |  %:url
7125 info                             |  %:file %:node
7126 calendar                         |  %:date
7127 @end smallexample
7129 @noindent
7130 To place the cursor after template expansion use:
7132 @smallexample
7133 %?          @r{After completing the template, position cursor here.}
7134 @end smallexample
7136 @node Templates in contexts,  , Template expansion, Capture templates
7137 @subsubsection Templates in contexts
7139 @vindex org-capture-templates-contexts
7140 To control whether a capture template should be accessible from a specific
7141 context, you can customize @var{org-capture-templates-contexts}.  Let's say
7142 for example that you have a capture template @code{"p"} for storing Gnus
7143 emails containing patches.  Then you would configure this option like this:
7145 @smalllisp
7146 (setq org-capture-templates-contexts
7147       '(("p" (in-mode . "message-mode"))))
7148 @end smalllisp
7150 You can also tell that the command key @code{"p"} should refer to another
7151 template.  In that case, add this command key like this:
7153 @smalllisp
7154 (setq org-capture-templates-contexts
7155       '(("p" "q" (in-mode . "message-mode"))))
7156 @end smalllisp
7158 See the docstring of the variable for more information.
7160 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
7161 @section Attachments
7162 @cindex attachments
7164 @vindex org-attach-directory
7165 It is often useful to associate reference material with an outline node/task.
7166 Small chunks of plain text can simply be stored in the subtree of a project.
7167 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7168 files that live elsewhere on your computer or in the cloud, like emails or
7169 source code files belonging to a project.  Another method is @i{attachments},
7170 which are files located in a directory belonging to an outline node.  Org
7171 uses directories named by the unique ID of each entry.  These directories are
7172 located in the @file{data} directory which lives in the same directory where
7173 your Org file lives@footnote{If you move entries or Org files from one
7174 directory to another, you may want to configure @code{org-attach-directory}
7175 to contain an absolute path.}.  If you initialize this directory with
7176 @code{git init}, Org will automatically commit changes when it sees them.
7177 The attachment system has been contributed to Org by John Wiegley.
7179 In cases where it seems better to do so, you can also attach a directory of your
7180 choice to an entry.  You can also make children inherit the attachment
7181 directory from a parent, so that an entire subtree uses the same attached
7182 directory.
7184 @noindent The following commands deal with attachments:
7186 @table @kbd
7187 @orgcmd{C-c C-a,org-attach}
7188 The dispatcher for commands related to the attachment system.  After these
7189 keys, a list of commands is displayed and you must press an additional key
7190 to select a command:
7192 @table @kbd
7193 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7194 @vindex org-attach-method
7195 Select a file and move it into the task's attachment directory.  The file
7196 will be copied, moved, or linked, depending on @code{org-attach-method}.
7197 Note that hard links are not supported on all systems.
7199 @kindex C-c C-a c
7200 @kindex C-c C-a m
7201 @kindex C-c C-a l
7202 @item c/m/l
7203 Attach a file using the copy/move/link method.
7204 Note that hard links are not supported on all systems.
7206 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7207 Create a new attachment as an Emacs buffer.
7209 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7210 Synchronize the current task with its attachment directory, in case you added
7211 attachments yourself.
7213 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7214 @vindex org-file-apps
7215 Open current task's attachment.  If there is more than one, prompt for a
7216 file name first.  Opening will follow the rules set by @code{org-file-apps}.
7217 For more details, see the information on following hyperlinks
7218 (@pxref{Handling links}).
7220 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7221 Also open the attachment, but force opening the file in Emacs.
7223 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7224 Open the current task's attachment directory.
7226 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7227 Also open the directory, but force using @command{dired} in Emacs.
7229 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7230 Select and delete a single attachment.
7232 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7233 Delete all of a task's attachments.  A safer way is to open the directory in
7234 @command{dired} and delete from there.
7236 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7237 @cindex property, ATTACH_DIR
7238 Set a specific directory as the entry's attachment directory.  This works by
7239 putting the directory path into the @code{ATTACH_DIR} property.
7241 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7242 @cindex property, ATTACH_DIR_INHERIT
7243 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7244 same directory for attachments as the parent does.
7245 @end table
7246 @end table
7248 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
7249 @section RSS feeds
7250 @cindex RSS feeds
7251 @cindex Atom feeds
7253 Org can add and change entries based on information found in RSS feeds and
7254 Atom feeds.  You could use this to make a task out of each new podcast in a
7255 podcast feed.  Or you could use a phone-based note-creating service on the
7256 web to import tasks into Org.  To access feeds, configure the variable
7257 @code{org-feed-alist}.  The docstring of this variable has detailed
7258 information.  Here is just an example:
7260 @smalllisp
7261 @group
7262 (setq org-feed-alist
7263      '(("Slashdot"
7264          "http://rss.slashdot.org/Slashdot/slashdot"
7265          "~/txt/org/feeds.org" "Slashdot Entries")))
7266 @end group
7267 @end smalllisp
7269 @noindent
7270 will configure that new items from the feed provided by
7271 @code{rss.slashdot.org} will result in new entries in the file
7272 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7273 the following command is used:
7275 @table @kbd
7276 @orgcmd{C-c C-x g,org-feed-update-all}
7277 @item C-c C-x g
7278 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7279 them.
7280 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7281 Prompt for a feed name and go to the inbox configured for this feed.
7282 @end table
7284 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7285 it will store information about the status of items in the feed, to avoid
7286 adding the same item several times.  You should add @samp{FEEDSTATUS} to the
7287 list of drawers in that file:
7289 @example
7290 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
7291 @end example
7293 For more information, including how to read atom feeds, see
7294 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7296 @node Protocols, Refile and copy, RSS Feeds, Capture - Refile - Archive
7297 @section Protocols for external access
7298 @cindex protocols, for external access
7299 @cindex emacsserver
7301 You can set up Org for handling protocol calls from outside applications that
7302 are passed to Emacs through the @file{emacsserver}.  For example, you can
7303 configure bookmarks in your web browser to send a link to the current page to
7304 Org and create a note from it using capture (@pxref{Capture}).  Or you
7305 could create a bookmark that will tell Emacs to open the local source file of
7306 a remote website you are looking at with the browser.  See
7307 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7308 documentation and setup instructions.
7310 @node Refile and copy, Archiving, Protocols, Capture - Refile - Archive
7311 @section Refile and copy
7312 @cindex refiling notes
7313 @cindex copying notes
7315 When reviewing the captured data, you may want to refile or to copy some of
7316 the entries into a different list, for example into a project.  Cutting,
7317 finding the right location, and then pasting the note is cumbersome.  To
7318 simplify this process, you can use the following special command:
7320 @table @kbd
7321 @orgcmd{C-c M-w,org-copy}
7322 @findex org-copy
7323 Copying works like refiling, except that the original note is not deleted.
7324 @orgcmd{C-c C-w,org-refile}
7325 @findex org-refile
7326 @vindex org-reverse-note-order
7327 @vindex org-refile-targets
7328 @vindex org-refile-use-outline-path
7329 @vindex org-outline-path-complete-in-steps
7330 @vindex org-refile-allow-creating-parent-nodes
7331 @vindex org-log-refile
7332 @vindex org-refile-use-cache
7333 Refile the entry or region at point.  This command offers possible locations
7334 for refiling the entry and lets you select one with completion.  The item (or
7335 all items in the region) is filed below the target heading as a subitem.
7336 Depending on @code{org-reverse-note-order}, it will be either the first or
7337 last subitem.@*
7338 By default, all level 1 headlines in the current buffer are considered to be
7339 targets, but you can have more complex definitions across a number of files.
7340 See the variable @code{org-refile-targets} for details.  If you would like to
7341 select a location via a file-path-like completion along the outline path, see
7342 the variables @code{org-refile-use-outline-path} and
7343 @code{org-outline-path-complete-in-steps}.  If you would like to be able to
7344 create new nodes as new parents for refiling on the fly, check the
7345 variable @code{org-refile-allow-creating-parent-nodes}.
7346 When the variable @code{org-log-refile}@footnote{with corresponding
7347 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7348 and @code{nologrefile}} is set, a timestamp or a note will be
7349 recorded when an entry has been refiled.
7350 @orgkey{C-u C-c C-w}
7351 Use the refile interface to jump to a heading.
7352 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7353 Jump to the location where @code{org-refile} last moved a tree to.
7354 @item C-2 C-c C-w
7355 Refile as the child of the item currently being clocked.
7356 @orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C-w,org-refile-cache-clear}
7357 Clear the target cache.  Caching of refile targets can be turned on by
7358 setting @code{org-refile-use-cache}.  To make the command see new possible
7359 targets, you have to clear the cache with this command.
7360 @end table
7362 @node Archiving,  , Refile and copy, Capture - Refile - Archive
7363 @section Archiving
7364 @cindex archiving
7366 When a project represented by a (sub)tree is finished, you may want
7367 to move the tree out of the way and to stop it from contributing to the
7368 agenda.  Archiving is important to keep your working files compact and global
7369 searches like the construction of agenda views fast.
7371 @table @kbd
7372 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7373 @vindex org-archive-default-command
7374 Archive the current entry using the command specified in the variable
7375 @code{org-archive-default-command}.
7376 @end table
7378 @menu
7379 * Moving subtrees::             Moving a tree to an archive file
7380 * Internal archiving::          Switch off a tree but keep it in the file
7381 @end menu
7383 @node Moving subtrees, Internal archiving, Archiving, Archiving
7384 @subsection Moving a tree to the archive file
7385 @cindex external archiving
7387 The most common archiving action is to move a project tree to another file,
7388 the archive file.
7390 @table @kbd
7391 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7392 @vindex org-archive-location
7393 Archive the subtree starting at the cursor position to the location
7394 given by @code{org-archive-location}.
7395 @orgkey{C-u C-c C-x C-s}
7396 Check if any direct children of the current headline could be moved to
7397 the archive.  To do this, each subtree is checked for open TODO entries.
7398 If none are found, the command offers to move it to the archive
7399 location.  If the cursor is @emph{not} on a headline when this command
7400 is invoked, the level 1 trees will be checked.
7401 @end table
7403 @cindex archive locations
7404 The default archive location is a file in the same directory as the
7405 current file, with the name derived by appending @file{_archive} to the
7406 current file name.  You can also choose what heading to file archived
7407 items under, with the possibility to add them to a datetree in a file.
7408 For information and examples on how to specify the file and the heading,
7409 see the documentation string of the variable
7410 @code{org-archive-location}.
7412 There is also an in-buffer option for setting this variable, for
7413 example@footnote{For backward compatibility, the following also works:
7414 If there are several such lines in a file, each specifies the archive
7415 location for the text below it.  The first such line also applies to any
7416 text before its definition.  However, using this method is
7417 @emph{strongly} deprecated as it is incompatible with the outline
7418 structure of the document.  The correct method for setting multiple
7419 archive locations in a buffer is using properties.}:
7421 @cindex #+ARCHIVE
7422 @example
7423 #+ARCHIVE: %s_done::
7424 @end example
7426 @cindex property, ARCHIVE
7427 @noindent
7428 If you would like to have a special ARCHIVE location for a single entry
7429 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7430 location as the value (@pxref{Properties and Columns}).
7432 @vindex org-archive-save-context-info
7433 When a subtree is moved, it receives a number of special properties that
7434 record context information like the file from where the entry came, its
7435 outline path the archiving time etc.  Configure the variable
7436 @code{org-archive-save-context-info} to adjust the amount of information
7437 added.
7440 @node Internal archiving,  , Moving subtrees, Archiving
7441 @subsection Internal archiving
7443 If you want to just switch off (for agenda views) certain subtrees without
7444 moving them to a different file, you can use the @code{ARCHIVE tag}.
7446 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7447 its location in the outline tree, but behaves in the following way:
7448 @itemize @minus
7449 @item
7450 @vindex org-cycle-open-archived-trees
7451 It does not open when you attempt to do so with a visibility cycling
7452 command (@pxref{Visibility cycling}).  You can force cycling archived
7453 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7454 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
7455 @code{show-all} will open archived subtrees.
7456 @item
7457 @vindex org-sparse-tree-open-archived-trees
7458 During sparse tree construction (@pxref{Sparse trees}), matches in
7459 archived subtrees are not exposed, unless you configure the option
7460 @code{org-sparse-tree-open-archived-trees}.
7461 @item
7462 @vindex org-agenda-skip-archived-trees
7463 During agenda view construction (@pxref{Agenda Views}), the content of
7464 archived trees is ignored unless you configure the option
7465 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7466 be included.  In the agenda you can press @kbd{v a} to get archives
7467 temporarily included.
7468 @item
7469 @vindex org-export-with-archived-trees
7470 Archived trees are not exported (@pxref{Exporting}), only the headline
7471 is.  Configure the details using the variable
7472 @code{org-export-with-archived-trees}.
7473 @item
7474 @vindex org-columns-skip-archived-trees
7475 Archived trees are excluded from column view unless the variable
7476 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7477 @end itemize
7479 The following commands help manage the ARCHIVE tag:
7481 @table @kbd
7482 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7483 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
7484 the headline changes to a shadowed face, and the subtree below it is
7485 hidden.
7486 @orgkey{C-u C-c C-x a}
7487 Check if any direct children of the current headline should be archived.
7488 To do this, each subtree is checked for open TODO entries.  If none are
7489 found, the command offers to set the ARCHIVE tag for the child.  If the
7490 cursor is @emph{not} on a headline when this command is invoked, the
7491 level 1 trees will be checked.
7492 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7493 Cycle a tree even if it is tagged with ARCHIVE.
7494 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7495 Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
7496 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}.  The
7497 entry becomes a child of that sibling and in this way retains a lot of its
7498 original context, including inherited tags and approximate position in the
7499 outline.
7500 @end table
7503 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7504 @chapter Agenda views
7505 @cindex agenda views
7507 Due to the way Org works, TODO items, time-stamped items, and
7508 tagged headlines can be scattered throughout a file or even a number of
7509 files.  To get an overview of open action items, or of events that are
7510 important for a particular date, this information must be collected,
7511 sorted and displayed in an organized way.
7513 Org can select items based on various criteria and display them
7514 in a separate buffer.  Seven different view types are provided:
7516 @itemize @bullet
7517 @item
7518 an @emph{agenda} that is like a calendar and shows information
7519 for specific dates,
7520 @item
7521 a @emph{TODO list} that covers all unfinished
7522 action items,
7523 @item
7524 a @emph{match view}, showings headlines based on the tags, properties, and
7525 TODO state associated with them,
7526 @item
7527 a @emph{timeline view} that shows all events in a single Org file,
7528 in time-sorted view,
7529 @item
7530 a @emph{text search view} that shows all entries from multiple files
7531 that contain specified keywords,
7532 @item
7533 a @emph{stuck projects view} showing projects that currently don't move
7534 along, and
7535 @item
7536 @emph{custom views} that are special searches and combinations of different
7537 views.
7538 @end itemize
7540 @noindent
7541 The extracted information is displayed in a special @emph{agenda
7542 buffer}.  This buffer is read-only, but provides commands to visit the
7543 corresponding locations in the original Org files, and even to
7544 edit these files remotely.
7546 @vindex org-agenda-window-setup
7547 @vindex org-agenda-restore-windows-after-quit
7548 Two variables control how the agenda buffer is displayed and whether the
7549 window configuration is restored when the agenda exits:
7550 @code{org-agenda-window-setup} and
7551 @code{org-agenda-restore-windows-after-quit}.
7553 @menu
7554 * Agenda files::                Files being searched for agenda information
7555 * Agenda dispatcher::           Keyboard access to agenda views
7556 * Built-in agenda views::       What is available out of the box?
7557 * Presentation and sorting::    How agenda items are prepared for display
7558 * Agenda commands::             Remote editing of Org trees
7559 * Custom agenda views::         Defining special searches and views
7560 * Exporting Agenda Views::      Writing a view to a file
7561 * Agenda column view::          Using column view for collected entries
7562 @end menu
7564 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7565 @section Agenda files
7566 @cindex agenda files
7567 @cindex files for agenda
7569 @vindex org-agenda-files
7570 The information to be shown is normally collected from all @emph{agenda
7571 files}, the files listed in the variable
7572 @code{org-agenda-files}@footnote{If the value of that variable is not a
7573 list, but a single file name, then the list of agenda files will be
7574 maintained in that external file.}.  If a directory is part of this list,
7575 all files with the extension @file{.org} in this directory will be part
7576 of the list.
7578 Thus, even if you only work with a single Org file, that file should
7579 be put into the list@footnote{When using the dispatcher, pressing
7580 @kbd{<} before selecting a command will actually limit the command to
7581 the current file, and ignore @code{org-agenda-files} until the next
7582 dispatcher command.}.  You can customize @code{org-agenda-files}, but
7583 the easiest way to maintain it is through the following commands
7585 @cindex files, adding to agenda list
7586 @table @kbd
7587 @orgcmd{C-c [,org-agenda-file-to-front}
7588 Add current file to the list of agenda files.  The file is added to
7589 the front of the list.  If it was already in the list, it is moved to
7590 the front.  With a prefix argument, file is added/moved to the end.
7591 @orgcmd{C-c ],org-remove-file}
7592 Remove current file from the list of agenda files.
7593 @kindex C-,
7594 @cindex cycling, of agenda files
7595 @orgcmd{C-',org-cycle-agenda-files}
7596 @itemx C-,
7597 Cycle through agenda file list, visiting one file after the other.
7598 @kindex M-x org-iswitchb
7599 @item M-x org-iswitchb
7600 Command to use an @code{iswitchb}-like interface to switch to and between Org
7601 buffers.
7602 @end table
7604 @noindent
7605 The Org menu contains the current list of files and can be used
7606 to visit any of them.
7608 If you would like to focus the agenda temporarily on a file not in
7609 this list, or on just one file in the list, or even on only a subtree in a
7610 file, then this can be done in different ways.  For a single agenda command,
7611 you may press @kbd{<} once or several times in the dispatcher
7612 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
7613 extended period, use the following commands:
7615 @table @kbd
7616 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7617 Permanently restrict the agenda to the current subtree.  When with a
7618 prefix argument, or with the cursor before the first headline in a file,
7619 the agenda scope is set to the entire file.  This restriction remains in
7620 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7621 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
7622 agenda view, the new restriction takes effect immediately.
7623 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7624 Remove the permanent restriction created by @kbd{C-c C-x <}.
7625 @end table
7627 @noindent
7628 When working with @file{speedbar.el}, you can use the following commands in
7629 the Speedbar frame:
7631 @table @kbd
7632 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7633 Permanently restrict the agenda to the item---either an Org file or a subtree
7634 in such a file---at the cursor in the Speedbar frame.
7635 If there is a window displaying an agenda view, the new restriction takes
7636 effect immediately.
7637 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7638 Lift the restriction.
7639 @end table
7641 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7642 @section The agenda dispatcher
7643 @cindex agenda dispatcher
7644 @cindex dispatching agenda commands
7645 The views are created through a dispatcher, which should be bound to a
7646 global key---for example @kbd{C-c a} (@pxref{Activation}).  In the
7647 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7648 is accessed and list keyboard access to commands accordingly.  After
7649 pressing @kbd{C-c a}, an additional letter is required to execute a
7650 command.  The dispatcher offers the following default commands:
7652 @table @kbd
7653 @item a
7654 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7655 @item t @r{/} T
7656 Create a list of all TODO items (@pxref{Global TODO list}).
7657 @item m @r{/} M
7658 Create a list of headlines matching a TAGS expression (@pxref{Matching
7659 tags and properties}).
7660 @item L
7661 Create the timeline view for the current buffer (@pxref{Timeline}).
7662 @item s
7663 Create a list of entries selected by a boolean expression of keywords
7664 and/or regular expressions that must or must not occur in the entry.
7665 @item /
7666 @vindex org-agenda-text-search-extra-files
7667 Search for a regular expression in all agenda files and additionally in
7668 the files listed in @code{org-agenda-text-search-extra-files}.  This
7669 uses the Emacs command @code{multi-occur}.  A prefix argument can be
7670 used to specify the number of context lines for each match, default is
7672 @item # @r{/} !
7673 Create a list of stuck projects (@pxref{Stuck projects}).
7674 @item <
7675 Restrict an agenda command to the current buffer@footnote{For backward
7676 compatibility, you can also press @kbd{1} to restrict to the current
7677 buffer.}.  After pressing @kbd{<}, you still need to press the character
7678 selecting the command.
7679 @item < <
7680 If there is an active region, restrict the following agenda command to
7681 the region.  Otherwise, restrict it to the current subtree@footnote{For
7682 backward compatibility, you can also press @kbd{0} to restrict to the
7683 current region/subtree.}.  After pressing @kbd{< <}, you still need to press the
7684 character selecting the command.
7686 @item *
7687 @vindex org-agenda-sticky
7688 Toggle sticky agenda views.  By default, Org maintains only a single agenda
7689 buffer and rebuilds it each time you change the view, to make sure everything
7690 is always up to date.  If you switch between views often and the build time
7691 bothers you, you can turn on sticky agenda buffers (make this the default by
7692 customizing the variable @code{org-agenda-sticky}).  With sticky agendas, the
7693 dispatcher only switches to the selected view, you need to update it by hand
7694 with @kbd{r} or @kbd{g}.  You can toggle sticky agenda view any time with
7695 @code{org-toggle-sticky-agenda}.
7696 @end table
7698 You can also define custom commands that will be accessible through the
7699 dispatcher, just like the default commands.  This includes the
7700 possibility to create extended agenda buffers that contain several
7701 blocks together, for example the weekly agenda, the global TODO list and
7702 a number of special tags matches.  @xref{Custom agenda views}.
7704 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7705 @section The built-in agenda views
7707 In this section we describe the built-in views.
7709 @menu
7710 * Weekly/daily agenda::         The calendar page with current tasks
7711 * Global TODO list::            All unfinished action items
7712 * Matching tags and properties::  Structured information with fine-tuned search
7713 * Timeline::                    Time-sorted view for single file
7714 * Search view::                 Find entries by searching for text
7715 * Stuck projects::              Find projects you need to review
7716 @end menu
7718 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7719 @subsection The weekly/daily agenda
7720 @cindex agenda
7721 @cindex weekly agenda
7722 @cindex daily agenda
7724 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7725 paper agenda, showing all the tasks for the current week or day.
7727 @table @kbd
7728 @cindex org-agenda, command
7729 @orgcmd{C-c a a,org-agenda-list}
7730 Compile an agenda for the current week from a list of Org files.  The agenda
7731 shows the entries for each day.  With a numeric prefix@footnote{For backward
7732 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7733 listed before the agenda.  This feature is deprecated, use the dedicated TODO
7734 list, or a block agenda instead (@pxref{Block agenda}).}  (like @kbd{C-u 2 1
7735 C-c a a}) you may set the number of days to be displayed.
7736 @end table
7738 @vindex org-agenda-span
7739 @vindex org-agenda-ndays
7740 @vindex org-agenda-start-day
7741 @vindex org-agenda-start-on-weekday
7742 The default number of days displayed in the agenda is set by the variable
7743 @var{org-agenda-span} (or the obsolete @var{org-agenda-ndays}).  This
7744 variable can be set to any number of days you want to see by default in the
7745 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7746 @code{year}.  For weekly agendas, the default is to start on the previous
7747 monday (see @var{org-agenda-start-on-weekday}).  You can also set the start
7748 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7749 start the agenda ten days from today in the future.
7751 Remote editing from the agenda buffer means, for example, that you can
7752 change the dates of deadlines and appointments from the agenda buffer.
7753 The commands available in the Agenda buffer are listed in @ref{Agenda
7754 commands}.
7756 @subsubheading Calendar/Diary integration
7757 @cindex calendar integration
7758 @cindex diary integration
7760 Emacs contains the calendar and diary by Edward M. Reingold.  The
7761 calendar displays a three-month calendar with holidays from different
7762 countries and cultures.  The diary allows you to keep track of
7763 anniversaries, lunar phases, sunrise/set, recurrent appointments
7764 (weekly, monthly) and more.  In this way, it is quite complementary to
7765 Org.  It can be very useful to combine output from Org with
7766 the diary.
7768 In order to include entries from the Emacs diary into Org mode's
7769 agenda, you only need to customize the variable
7771 @lisp
7772 (setq org-agenda-include-diary t)
7773 @end lisp
7775 @noindent After that, everything will happen automatically.  All diary
7776 entries including holidays, anniversaries, etc., will be included in the
7777 agenda buffer created by Org mode.  @key{SPC}, @key{TAB}, and
7778 @key{RET} can be used from the agenda buffer to jump to the diary
7779 file in order to edit existing diary entries.  The @kbd{i} command to
7780 insert new entries for the current date works in the agenda buffer, as
7781 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7782 Sunrise/Sunset times, show lunar phases and to convert to other
7783 calendars, respectively.  @kbd{c} can be used to switch back and forth
7784 between calendar and agenda.
7786 If you are using the diary only for sexp entries and holidays, it is
7787 faster to not use the above setting, but instead to copy or even move
7788 the entries into an Org file.  Org mode evaluates diary-style sexp
7789 entries, and does it faster because there is no overhead for first
7790 creating the diary display.  Note that the sexp entries must start at
7791 the left margin, no whitespace is allowed before them.  For example,
7792 the following segment of an Org file will be processed and entries
7793 will be made in the agenda:
7795 @example
7796 * Birthdays and similar stuff
7797 #+CATEGORY: Holiday
7798 %%(org-calendar-holiday)   ; special function for holiday names
7799 #+CATEGORY: Ann
7800 %%(org-anniversary 1956  5 14)@footnote{@code{org-anniversary} is just like @code{diary-anniversary}, but the argument order is always according to ISO and therefore independent of the value of @code{calendar-date-style}.} Arthur Dent is %d years old
7801 %%(org-anniversary 1869 10  2) Mahatma Gandhi would be %d years old
7802 @end example
7804 @subsubheading Anniversaries from BBDB
7805 @cindex BBDB, anniversaries
7806 @cindex anniversaries, from BBDB
7808 If you are using the Big Brothers Database to store your contacts, you will
7809 very likely prefer to store anniversaries in BBDB rather than in a
7810 separate Org or diary file.  Org supports this and will show BBDB
7811 anniversaries as part of the agenda.  All you need to do is to add the
7812 following to one of your agenda files:
7814 @example
7815 * Anniversaries
7816   :PROPERTIES:
7817   :CATEGORY: Anniv
7818   :END:
7819 %%(org-bbdb-anniversaries)
7820 @end example
7822 You can then go ahead and define anniversaries for a BBDB record.  Basically,
7823 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7824 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7825 followed by a space and the class of the anniversary (@samp{birthday} or
7826 @samp{wedding}, or a format string).  If you omit the class, it will default to
7827 @samp{birthday}.  Here are a few examples, the header for the file
7828 @file{org-bbdb.el} contains more detailed information.
7830 @example
7831 1973-06-22
7832 06-22
7833 1955-08-02 wedding
7834 2008-04-14 %s released version 6.01 of org mode, %d years ago
7835 @end example
7837 After a change to BBDB, or for the first agenda display during an Emacs
7838 session, the agenda display will suffer a short delay as Org updates its
7839 hash with anniversaries.  However, from then on things will be very fast---much
7840 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7841 in an Org or Diary file.
7843 @subsubheading Appointment reminders
7844 @cindex @file{appt.el}
7845 @cindex appointment reminders
7846 @cindex appointment
7847 @cindex reminders
7849 Org can interact with Emacs appointments notification facility.  To add the
7850 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7851 This command lets you filter through the list of your appointments and add
7852 only those belonging to a specific category or matching a regular expression.
7853 It also reads a @code{APPT_WARNTIME} property which will then override the
7854 value of @code{appt-message-warning-time} for this appointment.  See the
7855 docstring for details.
7857 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7858 @subsection The global TODO list
7859 @cindex global TODO list
7860 @cindex TODO list, global
7862 The global TODO list contains all unfinished TODO items formatted and
7863 collected into a single place.
7865 @table @kbd
7866 @orgcmd{C-c a t,org-todo-list}
7867 Show the global TODO list.  This collects the TODO items from all agenda
7868 files (@pxref{Agenda Views}) into a single buffer.  By default, this lists
7869 items with a state the is not a DONE state.  The buffer is in
7870 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7871 entries directly from that buffer (@pxref{Agenda commands}).
7872 @orgcmd{C-c a T,org-todo-list}
7873 @cindex TODO keyword matching
7874 @vindex org-todo-keywords
7875 Like the above, but allows selection of a specific TODO keyword.  You can
7876 also do this by specifying a prefix argument to @kbd{C-c a t}.  You are
7877 prompted for a keyword, and you may also specify several keywords by
7878 separating them with @samp{|} as the boolean OR operator.  With a numeric
7879 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7880 @kindex r
7881 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7882 a prefix argument to this command to change the selected TODO keyword,
7883 for example @kbd{3 r}.  If you often need a search for a specific
7884 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7885 Matching specific TODO keywords can also be done as part of a tags
7886 search (@pxref{Tag searches}).
7887 @end table
7889 Remote editing of TODO items means that you can change the state of a
7890 TODO entry with a single key press.  The commands available in the
7891 TODO list are described in @ref{Agenda commands}.
7893 @cindex sublevels, inclusion into TODO list
7894 Normally the global TODO list simply shows all headlines with TODO
7895 keywords.  This list can become very long.  There are two ways to keep
7896 it more compact:
7897 @itemize @minus
7898 @item
7899 @vindex org-agenda-todo-ignore-scheduled
7900 @vindex org-agenda-todo-ignore-deadlines
7901 @vindex org-agenda-todo-ignore-timestamp
7902 @vindex org-agenda-todo-ignore-with-date
7903 Some people view a TODO item that has been @emph{scheduled} for execution or
7904 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7905 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7906 @code{org-agenda-todo-ignore-deadlines},
7907 @code{org-agenda-todo-ignore-timestamp} and/or
7908 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7909 TODO list.
7910 @item
7911 @vindex org-agenda-todo-list-sublevels
7912 TODO items may have sublevels to break up the task into subtasks.  In
7913 such cases it may be enough to list only the highest level TODO headline
7914 and omit the sublevels from the global list.  Configure the variable
7915 @code{org-agenda-todo-list-sublevels} to get this behavior.
7916 @end itemize
7918 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7919 @subsection Matching tags and properties
7920 @cindex matching, of tags
7921 @cindex matching, of properties
7922 @cindex tags view
7923 @cindex match view
7925 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7926 or have properties (@pxref{Properties and Columns}), you can select headlines
7927 based on this metadata and collect them into an agenda buffer.  The match
7928 syntax described here also applies when creating sparse trees with @kbd{C-c /
7931 @table @kbd
7932 @orgcmd{C-c a m,org-tags-view}
7933 Produce a list of all headlines that match a given set of tags.  The
7934 command prompts for a selection criterion, which is a boolean logic
7935 expression with tags, like @samp{+work+urgent-withboss} or
7936 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
7937 define a custom command for it (@pxref{Agenda dispatcher}).
7938 @orgcmd{C-c a M,org-tags-view}
7939 @vindex org-tags-match-list-sublevels
7940 @vindex org-agenda-tags-todo-honor-ignore-options
7941 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7942 not-DONE state and force checking subitems (see variable
7943 @code{org-tags-match-list-sublevels}).  To exclude scheduled/deadline items,
7944 see the variable @code{org-agenda-tags-todo-honor-ignore-options}.  Matching
7945 specific TODO keywords together with a tags match is also possible, see
7946 @ref{Tag searches}.
7947 @end table
7949 The commands available in the tags list are described in @ref{Agenda
7950 commands}.
7952 @subsubheading Match syntax
7954 @cindex Boolean logic, for tag/property searches
7955 A search string can use Boolean operators @samp{&} for @code{AND} and
7956 @samp{|} for @code{OR}@.  @samp{&} binds more strongly than @samp{|}.
7957 Parentheses are not implemented.  Each element in the search is either a
7958 tag, a regular expression matching tags, or an expression like
7959 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
7960 property value.  Each element may be preceded by @samp{-}, to select
7961 against it, and @samp{+} is syntactic sugar for positive selection.  The
7962 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
7963 present.  Here are some examples, using only tags.
7965 @table @samp
7966 @item work
7967 Select headlines tagged @samp{:work:}.
7968 @item work&boss
7969 Select headlines tagged @samp{:work:} and @samp{:boss:}.
7970 @item +work-boss
7971 Select headlines tagged @samp{:work:}, but discard those also tagged
7972 @samp{:boss:}.
7973 @item work|laptop
7974 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7975 @item work|laptop+night
7976 Like before, but require the @samp{:laptop:} lines to be tagged also
7977 @samp{:night:}.
7978 @end table
7980 @cindex regular expressions, with tags search
7981 Instead of a tag, you may also specify a regular expression enclosed in curly
7982 braces.  For example,
7983 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7984 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7986 @cindex group tags, as regular expressions
7987 Group tags (@pxref{Tag groups}) are expanded as regular expressions.  E.g.,
7988 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
7989 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
7990 and searching for @samp{-work} will search for all headlines but those with
7991 one of the tag in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
7993 @cindex TODO keyword matching, with tags search
7994 @cindex level, require for tags/property match
7995 @cindex category, require for tags/property match
7996 @vindex org-odd-levels-only
7997 You may also test for properties (@pxref{Properties and Columns}) at the same
7998 time as matching tags.  The properties may be real properties, or special
7999 properties that represent other metadata (@pxref{Special properties}).  For
8000 example, the ``property'' @code{TODO} represents the TODO keyword of the
8001 entry.  Or, the ``property'' @code{LEVEL} represents the level of an entry.
8002 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
8003 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
8004 DONE@.  In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
8005 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8006 The ITEM special property cannot currently be used in tags/property
8007 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
8008 ,skipping entries based on regexp}.}.
8010 Here are more examples:
8012 @table @samp
8013 @item work+TODO="WAITING"
8014 Select @samp{:work:}-tagged TODO lines with the specific TODO
8015 keyword @samp{WAITING}.
8016 @item work+TODO="WAITING"|home+TODO="WAITING"
8017 Waiting tasks both at work and at home.
8018 @end table
8020 When matching properties, a number of different operators can be used to test
8021 the value of a property.  Here is a complex example:
8023 @example
8024 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
8025          +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8026 @end example
8028 @noindent
8029 The type of comparison will depend on how the comparison value is written:
8030 @itemize @minus
8031 @item
8032 If the comparison value is a plain number, a numerical comparison is done,
8033 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8034 @samp{>=}, and @samp{<>}.
8035 @item
8036 If the comparison value is enclosed in double-quotes,
8037 a string comparison is done, and the same operators are allowed.
8038 @item
8039 If the comparison value is enclosed in double-quotes @emph{and} angular
8040 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8041 assumed to be date/time specifications in the standard Org way, and the
8042 comparison will be done accordingly.  Special values that will be recognized
8043 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8044 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8045 specification.  Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8046 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8047 respectively, can be used.
8048 @item
8049 If the comparison value is enclosed
8050 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8051 regexp matches the property value, and @samp{<>} meaning that it does not
8052 match.
8053 @end itemize
8055 So the search string in the example finds entries tagged @samp{:work:} but
8056 not @samp{:boss:}, which also have a priority value @samp{A}, a
8057 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8058 property that is numerically smaller than 2, a @samp{:With:} property that is
8059 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8060 on or after October 11, 2008.
8062 Accessing TODO, LEVEL, and CATEGORY during a search is fast.  Accessing any
8063 other properties will slow down the search.  However, once you have paid the
8064 price by accessing one property, testing additional properties is cheap
8065 again.
8067 You can configure Org mode to use property inheritance during a search, but
8068 beware that this can slow down searches considerably.  See @ref{Property
8069 inheritance}, for details.
8071 For backward compatibility, and also for typing speed, there is also a
8072 different way to test TODO states in a search.  For this, terminate the
8073 tags/property part of the search string (which may include several terms
8074 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8075 expression just for TODO keywords.  The syntax is then similar to that for
8076 tags, but should be applied with care: for example, a positive selection on
8077 several TODO keywords cannot meaningfully be combined with boolean AND@.
8078 However, @emph{negative selection} combined with AND can be meaningful.  To
8079 make sure that only lines are checked that actually have any TODO keyword
8080 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8081 part after the slash with @samp{!}.  Using @kbd{C-c a M} or @samp{/!} will
8082 not match TODO keywords in a DONE state.  Examples:
8084 @table @samp
8085 @item work/WAITING
8086 Same as @samp{work+TODO="WAITING"}
8087 @item work/!-WAITING-NEXT
8088 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8089 nor @samp{NEXT}
8090 @item work/!+WAITING|+NEXT
8091 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8092 @samp{NEXT}.
8093 @end table
8095 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
8096 @subsection Timeline for a single file
8097 @cindex timeline, single file
8098 @cindex time-sorted view
8100 The timeline summarizes all time-stamped items from a single Org mode
8101 file in a @emph{time-sorted view}.  The main purpose of this command is
8102 to give an overview over events in a project.
8104 @table @kbd
8105 @orgcmd{C-c a L,org-timeline}
8106 Show a time-sorted view of the Org file, with all time-stamped items.
8107 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8108 (scheduled or not) are also listed under the current date.
8109 @end table
8111 @noindent
8112 The commands available in the timeline buffer are listed in
8113 @ref{Agenda commands}.
8115 @node Search view, Stuck projects, Timeline, Built-in agenda views
8116 @subsection Search view
8117 @cindex search view
8118 @cindex text search
8119 @cindex searching, for text
8121 This agenda view is a general text search facility for Org mode entries.
8122 It is particularly useful to find notes.
8124 @table @kbd
8125 @orgcmd{C-c a s,org-search-view}
8126 This is a special search that lets you select entries by matching a substring
8127 or specific words using a boolean logic.
8128 @end table
8129 For example, the search string @samp{computer equipment} will find entries
8130 that contain @samp{computer equipment} as a substring.  If the two words are
8131 separated by more space or a line break, the search will still match.
8132 Search view can also search for specific keywords in the entry, using Boolean
8133 logic.  The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8134 will search for note entries that contain the keywords @code{computer}
8135 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8136 not matched by the regular expression @code{8\.11[bg]}, meaning to
8137 exclude both 8.11b and 8.11g.  The first @samp{+} is necessary to turn on
8138 word search, other @samp{+} characters are optional.  For more details, see
8139 the docstring of the command @code{org-search-view}.
8141 @vindex org-agenda-text-search-extra-files
8142 Note that in addition to the agenda files, this command will also search
8143 the files listed in @code{org-agenda-text-search-extra-files}.
8145 @node Stuck projects,  , Search view, Built-in agenda views
8146 @subsection Stuck projects
8147 @pindex GTD, Getting Things Done
8149 If you are following a system like David Allen's GTD to organize your
8150 work, one of the ``duties'' you have is a regular review to make sure
8151 that all projects move along.  A @emph{stuck} project is a project that
8152 has no defined next actions, so it will never show up in the TODO lists
8153 Org mode produces.  During the review, you need to identify such
8154 projects and define next actions for them.
8156 @table @kbd
8157 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8158 List projects that are stuck.
8159 @kindex C-c a !
8160 @item C-c a !
8161 @vindex org-stuck-projects
8162 Customize the variable @code{org-stuck-projects} to define what a stuck
8163 project is and how to find it.
8164 @end table
8166 You almost certainly will have to configure this view before it will
8167 work for you.  The built-in default assumes that all your projects are
8168 level-2 headlines, and that a project is not stuck if it has at least
8169 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8171 Let's assume that you, in your own way of using Org mode, identify
8172 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8173 indicate a project that should not be considered yet.  Let's further
8174 assume that the TODO keyword DONE marks finished projects, and that NEXT
8175 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
8176 is a next action even without the NEXT tag.  Finally, if the project
8177 contains the special word IGNORE anywhere, it should not be listed
8178 either.  In this case you would start by identifying eligible projects
8179 with a tags/todo match@footnote{@xref{Tag searches}.}
8180 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8181 IGNORE in the subtree to identify projects that are not stuck.  The
8182 correct customization for this is
8184 @lisp
8185 (setq org-stuck-projects
8186       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8187                                "\\<IGNORE\\>"))
8188 @end lisp
8190 Note that if a project is identified as non-stuck, the subtree of this entry
8191 will still be searched for stuck projects.
8193 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
8194 @section Presentation and sorting
8195 @cindex presentation, of agenda items
8197 @vindex org-agenda-prefix-format
8198 @vindex org-agenda-tags-column
8199 Before displaying items in an agenda view, Org mode visually prepares the
8200 items and sorts them.  Each item occupies a single line.  The line starts
8201 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8202 of the item and other important information.  You can customize in which
8203 column tags will be displayed through @code{org-agenda-tags-column}.  You can
8204 also customize the prefix using the option @code{org-agenda-prefix-format}.
8205 This prefix is followed by a cleaned-up version of the outline headline
8206 associated with the item.
8208 @menu
8209 * Categories::                  Not all tasks are equal
8210 * Time-of-day specifications::  How the agenda knows the time
8211 * Sorting agenda items::        The order of things
8212 * Filtering/limiting agenda items:: Dynamically narrow the agenda
8213 @end menu
8215 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
8216 @subsection Categories
8218 @cindex category
8219 @cindex #+CATEGORY
8220 The category is a broad label assigned to each agenda item.  By default,
8221 the category is simply derived from the file name, but you can also
8222 specify it with a special line in the buffer, like this@footnote{For
8223 backward compatibility, the following also works: if there are several
8224 such lines in a file, each specifies the category for the text below it.
8225 The first category also applies to any text before the first CATEGORY
8226 line.  However, using this method is @emph{strongly} deprecated as it is
8227 incompatible with the outline structure of the document.  The correct
8228 method for setting multiple categories in a buffer is using a
8229 property.}:
8231 @example
8232 #+CATEGORY: Thesis
8233 @end example
8235 @noindent
8236 @cindex property, CATEGORY
8237 If you would like to have a special CATEGORY for a single entry or a
8238 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8239 special category you want to apply as the value.
8241 @noindent
8242 The display in the agenda buffer looks best if the category is not
8243 longer than 10 characters.
8245 @noindent
8246 You can set up icons for category by customizing the
8247 @code{org-agenda-category-icon-alist} variable.
8249 @node Time-of-day specifications, Sorting agenda items, Categories, Presentation and sorting
8250 @subsection Time-of-day specifications
8251 @cindex time-of-day specification
8253 Org mode checks each agenda item for a time-of-day specification.  The
8254 time can be part of the timestamp that triggered inclusion into the
8255 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
8256 ranges can be specified with two timestamps, like
8258 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8260 In the headline of the entry itself, a time(range) may also appear as
8261 plain text (like @samp{12:45} or a @samp{8:30-1pm}).  If the agenda
8262 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8263 specifications in diary entries are recognized as well.
8265 For agenda display, Org mode extracts the time and displays it in a
8266 standard 24 hour format as part of the prefix.  The example times in
8267 the previous paragraphs would end up in the agenda like this:
8269 @example
8270     8:30-13:00 Arthur Dent lies in front of the bulldozer
8271    12:45...... Ford Prefect arrives and takes Arthur to the pub
8272    19:00...... The Vogon reads his poem
8273    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8274 @end example
8276 @cindex time grid
8277 If the agenda is in single-day mode, or for the display of today, the
8278 timed entries are embedded in a time grid, like
8280 @example
8281     8:00...... ------------------
8282     8:30-13:00 Arthur Dent lies in front of the bulldozer
8283    10:00...... ------------------
8284    12:00...... ------------------
8285    12:45...... Ford Prefect arrives and takes Arthur to the pub
8286    14:00...... ------------------
8287    16:00...... ------------------
8288    18:00...... ------------------
8289    19:00...... The Vogon reads his poem
8290    20:00...... ------------------
8291    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8292 @end example
8294 @vindex org-agenda-use-time-grid
8295 @vindex org-agenda-time-grid
8296 The time grid can be turned on and off with the variable
8297 @code{org-agenda-use-time-grid}, and can be configured with
8298 @code{org-agenda-time-grid}.
8300 @node Sorting agenda items, Filtering/limiting agenda items, Time-of-day specifications, Presentation and sorting
8301 @subsection Sorting agenda items
8302 @cindex sorting, of agenda items
8303 @cindex priorities, of agenda items
8304 Before being inserted into a view, the items are sorted.  How this is
8305 done depends on the type of view.
8306 @itemize @bullet
8307 @item
8308 @vindex org-agenda-files
8309 For the daily/weekly agenda, the items for each day are sorted.  The
8310 default order is to first collect all items containing an explicit
8311 time-of-day specification.  These entries will be shown at the beginning
8312 of the list, as a @emph{schedule} for the day.  After that, items remain
8313 grouped in categories, in the sequence given by @code{org-agenda-files}.
8314 Within each category, items are sorted by priority (@pxref{Priorities}),
8315 which is composed of the base priority (2000 for priority @samp{A}, 1000
8316 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8317 overdue scheduled or deadline items.
8318 @item
8319 For the TODO list, items remain in the order of categories, but within
8320 each category, sorting takes place according to priority
8321 (@pxref{Priorities}).  The priority used for sorting derives from the
8322 priority cookie, with additions depending on how close an item is to its due
8323 or scheduled date.
8324 @item
8325 For tags matches, items are not sorted at all, but just appear in the
8326 sequence in which they are found in the agenda files.
8327 @end itemize
8329 @vindex org-agenda-sorting-strategy
8330 Sorting can be customized using the variable
8331 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8332 the estimated effort of an entry (@pxref{Effort estimates}).
8334 @node Filtering/limiting agenda items,  , Sorting agenda items, Presentation and sorting
8335 @subsection Filtering/limiting agenda items
8337 Agenda built-in or customized commands are statically defined.  Agenda
8338 filters and limits provide two ways of dynamically narrowing down the list of
8339 agenda entries: @emph{fitlers} and @emph{limits}.  Filters only act on the
8340 display of the items, while limits take effect before the list of agenda
8341 entries is built.  Filter are more often used interactively, while limits are
8342 mostly useful when defined as local variables within custom agenda commands.
8344 @subsubheading Filtering in the agenda
8345 @cindex filtering, by tag, category, top headline and effort, in agenda
8346 @cindex tag filtering, in agenda
8347 @cindex category filtering, in agenda
8348 @cindex top headline filtering, in agenda
8349 @cindex effort filtering, in agenda
8350 @cindex query editing, in agenda
8352 @table @kbd
8353 @orgcmd{/,org-agenda-filter-by-tag}
8354 @vindex org-agenda-tag-filter-preset
8355 Filter the agenda view with respect to a tag and/or effort estimates.  The
8356 difference between this and a custom agenda command is that filtering is very
8357 fast, so that you can switch quickly between different filters without having
8358 to recreate the agenda.@footnote{Custom commands can preset a filter by
8359 binding the variable @code{org-agenda-tag-filter-preset} as an option.  This
8360 filter will then be applied to the view and persist as a basic filter through
8361 refreshes and more secondary filtering.  The filter is a global property of
8362 the entire agenda view---in a block agenda, you should only set this in the
8363 global options section, not in the section of an individual block.}
8365 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8366 all.  Pressing @key{TAB} at that prompt will offer use completion to select a
8367 tag (including any tags that do not have a selection character).  The command
8368 then hides all entries that do not contain or inherit this tag.  When called
8369 with prefix arg, remove the entries that @emph{do} have the tag.  A second
8370 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8371 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8372 will be narrowed by requiring or forbidding the selected additional tag.
8373 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8374 immediately use the @kbd{\} command.
8376 @vindex org-sort-agenda-noeffort-is-high
8377 In order to filter for effort estimates, you should set up allowed
8378 efforts globally, for example
8379 @lisp
8380 (setq org-global-properties
8381     '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8382 @end lisp
8383 You can then filter for an effort by first typing an operator, one of
8384 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8385 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8386 The filter will then restrict to entries with effort smaller-or-equal, equal,
8387 or larger-or-equal than the selected value.  If the digits 0--9 are not used
8388 as fast access keys to tags, you can also simply press the index digit
8389 directly without an operator.  In this case, @kbd{<} will be assumed.  For
8390 application of the operator, entries without a defined effort will be treated
8391 according to the value of @code{org-sort-agenda-noeffort-is-high}.  To filter
8392 for tasks without effort definition, press @kbd{?} as the operator.
8394 Org also supports automatic, context-aware tag filtering.  If the variable
8395 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8396 that function can decide which tags should be excluded from the agenda
8397 automatically.  Once this is set, the @kbd{/} command then accepts @kbd{RET}
8398 as a sub-option key and runs the auto exclusion logic.  For example, let's
8399 say you use a @code{Net} tag to identify tasks which need network access, an
8400 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8401 calls.  You could auto-exclude these tags based on the availability of the
8402 Internet, and outside of business hours, with something like this:
8404 @smalllisp
8405 @group
8406 (defun org-my-auto-exclude-function (tag)
8407   (and (cond
8408         ((string= tag "Net")
8409          (/= 0 (call-process "/sbin/ping" nil nil nil
8410                              "-c1" "-q" "-t1" "mail.gnu.org")))
8411         ((or (string= tag "Errand") (string= tag "Call"))
8412          (let ((hour (nth 2 (decode-time))))
8413            (or (< hour 8) (> hour 21)))))
8414        (concat "-" tag)))
8416 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8417 @end group
8418 @end smalllisp
8420 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8421 Narrow the current agenda filter by an additional condition.  When called with
8422 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8423 the effort criterion.  You can achieve the same effect by pressing @kbd{+} or
8424 @kbd{-} as the first key after the @kbd{/} command.
8427 @kindex [
8428 @kindex ]
8429 @kindex @{
8430 @kindex @}
8431 @item [ ] @{ @}
8432 @table @i
8433 @item @r{in} search view
8434 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8435 (@kbd{@{} and @kbd{@}}) to the query string.  The opening bracket/brace will
8436 add a positive search term prefixed by @samp{+}, indicating that this search
8437 term @i{must} occur/match in the entry.  The closing bracket/brace will add a
8438 negative search term which @i{must not} occur/match in the entry for it to be
8439 selected.
8440 @end table
8442 @orgcmd{<,org-agenda-filter-by-category}
8443 @vindex org-agenda-category-filter-preset
8445 Filter the current agenda view with respect to the category of the item at
8446 point.  Pressing @code{<} another time will remove this filter.  You can add
8447 a filter preset through the option @code{org-agenda-category-filter-preset}
8448 (see below.)
8450 @orgcmd{^,org-agenda-filter-by-top-headline}
8451 Filter the current agenda view and only display the siblings and the parent
8452 headline of the one at point.
8454 @orgcmd{=,org-agenda-filter-by-regexp}
8455 @vindex org-agenda-regexp-filter-preset
8457 Filter the agenda view by a regular expression: only show agenda entries
8458 matching the regular expression the user entered.  When called with a prefix
8459 argument, it will filter @emph{out} entries matching the regexp.  With two
8460 universal prefix arguments, it will remove all the regexp filters, which can
8461 be accumulated.  You can add a filter preset through the option
8462 @code{org-agenda-category-filter-preset} (see below.)
8464 @orgcmd{|,org-agenda-filter-remove-all}
8465 Remove all filters in the current agenda view.
8466 @end table
8468 @subsubheading Setting limits for the agenda
8469 @cindex limits, in agenda
8470 @vindex org-agenda-max-entries
8471 @vindex org-agenda-max-effort
8472 @vindex org-agenda-max-todos
8473 @vindex org-agenda-max-tags
8475 Here is a list of options that you can set, either globally, or locally in
8476 your custom agenda views@pxref{Custom agenda views}.
8478 @table @var
8479 @item org-agenda-max-entries
8480 Limit the number of entries.
8481 @item org-agenda-max-effort
8482 Limit the duration of accumulated efforts (as minutes).
8483 @item org-agenda-max-todos
8484 Limit the number of entries with TODO keywords.
8485 @item org-agenda-max-tags
8486 Limit the number of tagged entries.
8487 @end table
8489 When set to a positive integer, each option will exclude entries from other
8490 catogories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8491 the agenda to 100 minutes of effort and exclude any entry that as no effort
8492 property.  If you want to include entries with no effort property, use a
8493 negative value for @var{org-agenda-max-effort}.
8495 One useful setup is to use @var{org-agenda-max-entries} locally in a custom
8496 command.  For example, this custom command will display the next five entries
8497 with a @code{NEXT} TODO keyword.
8499 @smalllisp
8500 (setq org-agenda-custom-commands
8501       '(("n" todo "NEXT"
8502          ((org-agenda-max-entries 5)))))
8503 @end smalllisp
8505 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8506 will again the next five entries again, including the first entry that was
8507 excluded so far.
8509 You can also dynamically set temporary limits@footnote{Those temporary limits
8510 are lost when rebuilding the agenda.}:
8512 @table @kbd
8513 @orgcmd{~,org-agenda-limit-interactively}
8514 This prompts for the type of limit to apply and its value.
8515 @end table
8517 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
8518 @section Commands in the agenda buffer
8519 @cindex commands, in agenda buffer
8521 Entries in the agenda buffer are linked back to the Org file or diary
8522 file where they originate.  You are not allowed to edit the agenda
8523 buffer itself, but commands are provided to show and jump to the
8524 original entry location, and to edit the Org files ``remotely'' from
8525 the agenda buffer.  In this way, all information is stored only once,
8526 removing the risk that your agenda and note files may diverge.
8528 Some commands can be executed with mouse clicks on agenda lines.  For
8529 the other commands, the cursor needs to be in the desired line.
8531 @table @kbd
8532 @tsubheading{Motion}
8533 @cindex motion commands in agenda
8534 @orgcmd{n,org-agenda-next-line}
8535 Next line (same as @key{down} and @kbd{C-n}).
8536 @orgcmd{p,org-agenda-previous-line}
8537 Previous line (same as @key{up} and @kbd{C-p}).
8538 @tsubheading{View/Go to Org file}
8539 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8540 Display the original location of the item in another window.
8541 With prefix arg, make sure that the entire entry is made visible in the
8542 outline, not only the heading.
8544 @orgcmd{L,org-agenda-recenter}
8545 Display original location and recenter that window.
8547 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8548 Go to the original location of the item in another window.
8550 @orgcmd{@key{RET},org-agenda-switch-to}
8551 Go to the original location of the item and delete other windows.
8553 @orgcmd{F,org-agenda-follow-mode}
8554 @vindex org-agenda-start-with-follow-mode
8555 Toggle Follow mode.  In Follow mode, as you move the cursor through
8556 the agenda buffer, the other window always shows the corresponding
8557 location in the Org file.  The initial setting for this mode in new
8558 agenda buffers can be set with the variable
8559 @code{org-agenda-start-with-follow-mode}.
8561 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8562 Display the entire subtree of the current item in an indirect buffer.  With a
8563 numeric prefix argument N, go up to level N and then take that tree.  If N is
8564 negative, go up that many levels.  With a @kbd{C-u} prefix, do not remove the
8565 previously used indirect buffer.
8567 @orgcmd{C-c C-o,org-agenda-open-link}
8568 Follow a link in the entry.  This will offer a selection of any links in the
8569 text belonging to the referenced Org node.  If there is only one link, it
8570 will be followed without a selection prompt.
8572 @tsubheading{Change display}
8573 @cindex display changing, in agenda
8574 @kindex A
8575 @item A
8576 Interactively select another agenda view and append it to the current view.
8578 @kindex o
8579 @item o
8580 Delete other windows.
8582 @orgcmdkskc{v d,d,org-agenda-day-view}
8583 @xorgcmdkskc{v w,w,org-agenda-week-view}
8584 @xorgcmd{v m,org-agenda-month-view}
8585 @xorgcmd{v y,org-agenda-year-view}
8586 @xorgcmd{v SPC,org-agenda-reset-view}
8587 @vindex org-agenda-span
8588 Switch to day/week/month/year view.  When switching to day or week view, this
8589 setting becomes the default for subsequent agenda refreshes.  Since month and
8590 year views are slow to create, they do not become the default.  A numeric
8591 prefix argument may be used to jump directly to a specific day of the year,
8592 ISO week, month, or year, respectively.  For example, @kbd{32 d} jumps to
8593 February 1st, @kbd{9 w} to ISO week number 9.  When setting day, week, or
8594 month view, a year may be encoded in the prefix argument as well.  For
8595 example, @kbd{200712 w} will jump to week 12 in 2007.  If such a year
8596 specification has only one or two digits, it will be mapped to the interval
8597 1938--2037.  @kbd{v @key{SPC}} will reset to what is set in
8598 @code{org-agenda-span}.
8600 @orgcmd{f,org-agenda-later}
8601 Go forward in time to display the following @code{org-agenda-current-span} days.
8602 For example, if the display covers a week, switch to the following week.
8603 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8605 @orgcmd{b,org-agenda-earlier}
8606 Go backward in time to display earlier dates.
8608 @orgcmd{.,org-agenda-goto-today}
8609 Go to today.
8611 @orgcmd{j,org-agenda-goto-date}
8612 Prompt for a date and go there.
8614 @orgcmd{J,org-agenda-clock-goto}
8615 Go to the currently clocked-in task @i{in the agenda buffer}.
8617 @orgcmd{D,org-agenda-toggle-diary}
8618 Toggle the inclusion of diary entries.  See @ref{Weekly/daily agenda}.
8620 @orgcmdkskc{v l,l,org-agenda-log-mode}
8621 @kindex v L
8622 @vindex org-log-done
8623 @vindex org-agenda-log-mode-items
8624 Toggle Logbook mode.  In Logbook mode, entries that were marked DONE while
8625 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8626 entries that have been clocked on that day.  You can configure the entry
8627 types that should be included in log mode using the variable
8628 @code{org-agenda-log-mode-items}.  When called with a @kbd{C-u} prefix, show
8629 all possible logbook entries, including state changes.  When called with two
8630 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8631 @kbd{v L} is equivalent to @kbd{C-u v l}.
8633 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8634 Include inactive timestamps into the current view.  Only for weekly/daily
8635 agenda and timeline views.
8637 @orgcmd{v a,org-agenda-archives-mode}
8638 @xorgcmd{v A,org-agenda-archives-mode 'files}
8639 Toggle Archives mode.  In Archives mode, trees that are marked
8640 @code{ARCHIVED} are also scanned when producing the agenda.  When you use the
8641 capital @kbd{A}, even all archive files are included.  To exit archives mode,
8642 press @kbd{v a} again.
8644 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8645 @vindex org-agenda-start-with-clockreport-mode
8646 @vindex org-clock-report-include-clocking-task
8647 Toggle Clockreport mode.  In Clockreport mode, the daily/weekly agenda will
8648 always show a table with the clocked times for the time span and file scope
8649 covered by the current agenda view.  The initial setting for this mode in new
8650 agenda buffers can be set with the variable
8651 @code{org-agenda-start-with-clockreport-mode}.  By using a prefix argument
8652 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8653 contributions from entries that are hidden by agenda filtering@footnote{Only
8654 tags filtering will be respected here, effort filtering is ignored.}.  See
8655 also the variable @code{org-clock-report-include-clocking-task}.
8657 @orgkey{v c}
8658 @vindex org-agenda-clock-consistency-checks
8659 Show overlapping clock entries, clocking gaps, and other clocking problems in
8660 the current agenda range.  You can then visit clocking lines and fix them
8661 manually.  See the variable @code{org-agenda-clock-consistency-checks} for
8662 information on how to customize the definition of what constituted a clocking
8663 problem.  To return to normal agenda display, press @kbd{l} to exit Logbook
8664 mode.
8666 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8667 @vindex org-agenda-start-with-entry-text-mode
8668 @vindex org-agenda-entry-text-maxlines
8669 Toggle entry text mode.  In entry text mode, a number of lines from the Org
8670 outline node referenced by an agenda line will be displayed below the line.
8671 The maximum number of lines is given by the variable
8672 @code{org-agenda-entry-text-maxlines}.  Calling this command with a numeric
8673 prefix argument will temporarily modify that number to the prefix value.
8675 @orgcmd{G,org-agenda-toggle-time-grid}
8676 @vindex org-agenda-use-time-grid
8677 @vindex org-agenda-time-grid
8678 Toggle the time grid on and off.  See also the variables
8679 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8681 @orgcmd{r,org-agenda-redo}
8682 Recreate the agenda buffer, for example to reflect the changes after
8683 modification of the timestamps of items with @kbd{S-@key{left}} and
8684 @kbd{S-@key{right}}.  When the buffer is the global TODO list, a prefix
8685 argument is interpreted to create a selective list for a specific TODO
8686 keyword.
8687 @orgcmd{g,org-agenda-redo}
8688 Same as @kbd{r}.
8690 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8691 Save all Org buffers in the current Emacs session, and also the locations of
8692 IDs.
8694 @orgcmd{C-c C-x C-c,org-agenda-columns}
8695 @vindex org-columns-default-format
8696 Invoke column view (@pxref{Column view}) in the agenda buffer.  The column
8697 view format is taken from the entry at point, or (if there is no entry at
8698 point), from the first entry in the agenda view.  So whatever the format for
8699 that entry would be in the original buffer (taken from a property, from a
8700 @code{#+COLUMNS} line, or from the default variable
8701 @code{org-columns-default-format}), will be used in the agenda.
8703 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8704 Remove the restriction lock on the agenda, if it is currently restricted to a
8705 file or subtree (@pxref{Agenda files}).
8707 @tsubheading{Secondary filtering and query editing@footnote{See
8708 @pxref{Filtering/limiting agenda items} for a detailed description of these
8709 commands.}}
8711 @orgcmd{/,org-agenda-filter-by-tag}
8712 @vindex org-agenda-tag-filter-preset
8713 Filter the agenda view with respect to a tag and/or effort estimates.
8715 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8716 Narrow the current agenda filter by an additional condition.
8718 @orgcmd{<,org-agenda-filter-by-category}
8719 @vindex org-agenda-category-filter-preset
8721 Filter the current agenda view with respect to the category of the item at
8722 point.  Pressing @code{<} another time will remove this filter.
8724 @orgcmd{^,org-agenda-filter-by-top-headline}
8725 Filter the current agenda view and only display the siblings and the parent
8726 headline of the one at point.
8728 @orgcmd{=,org-agenda-filter-by-regexp}
8729 @vindex org-agenda-regexp-filter-preset
8731 Filter the agenda view by a regular expression: only show agenda entries
8732 matching the regular expression the user entered.  When called with a prefix
8733 argument, it will filter @emph{out} entries matching the regexp.  With two
8734 universal prefix arguments, it will remove all the regexp filters, which can
8735 be accumulated.  You can add a filter preset through the option
8736 @code{org-agenda-category-filter-preset} (see below.)
8738 @orgcmd{|,org-agenda-filter-remove-all}
8739 Remove all filters in the current agenda view.
8741 @tsubheading{Remote editing}
8742 @cindex remote editing, from agenda
8744 @item 0--9
8745 Digit argument.
8747 @cindex undoing remote-editing events
8748 @cindex remote editing, undo
8749 @orgcmd{C-_,org-agenda-undo}
8750 Undo a change due to a remote editing command.  The change is undone
8751 both in the agenda buffer and in the remote buffer.
8753 @orgcmd{t,org-agenda-todo}
8754 Change the TODO state of the item, both in the agenda and in the
8755 original org file.
8757 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8758 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8759 Switch to the next/previous set of TODO keywords.
8761 @orgcmd{C-k,org-agenda-kill}
8762 @vindex org-agenda-confirm-kill
8763 Delete the current agenda item along with the entire subtree belonging
8764 to it in the original Org file.  If the text to be deleted remotely
8765 is longer than one line, the kill needs to be confirmed by the user.  See
8766 variable @code{org-agenda-confirm-kill}.
8768 @orgcmd{C-c C-w,org-agenda-refile}
8769 Refile the entry at point.
8771 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8772 @vindex org-archive-default-command
8773 Archive the subtree corresponding to the entry at point using the default
8774 archiving command set in @code{org-archive-default-command}.  When using the
8775 @code{a} key, confirmation will be required.
8777 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8778 Toggle the ARCHIVE tag for the current headline.
8780 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8781 Move the subtree corresponding to the current entry to its @emph{archive
8782 sibling}.
8784 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8785 Archive the subtree corresponding to the current headline.  This means the
8786 entry will be moved to the configured archive location, most likely a
8787 different file.
8789 @orgcmd{T,org-agenda-show-tags}
8790 @vindex org-agenda-show-inherited-tags
8791 Show all tags associated with the current item.  This is useful if you have
8792 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8793 tags of a headline occasionally.
8795 @orgcmd{:,org-agenda-set-tags}
8796 Set tags for the current headline.  If there is an active region in the
8797 agenda, change a tag for all headings in the region.
8799 @kindex ,
8800 @item ,
8801 Set the priority for the current item (@command{org-agenda-priority}).
8802 Org mode prompts for the priority character.  If you reply with @key{SPC},
8803 the priority cookie is removed from the entry.
8805 @orgcmd{P,org-agenda-show-priority}
8806 Display weighted priority of current item.
8808 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8809 Increase the priority of the current item.  The priority is changed in
8810 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
8811 key for this.
8813 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8814 Decrease the priority of the current item.
8816 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8817 @vindex org-log-into-drawer
8818 Add a note to the entry.  This note will be recorded, and then filed to the
8819 same location where state change notes are put.  Depending on
8820 @code{org-log-into-drawer}, this may be inside a drawer.
8822 @orgcmd{C-c C-a,org-attach}
8823 Dispatcher for all command related to attachments.
8825 @orgcmd{C-c C-s,org-agenda-schedule}
8826 Schedule this item.  With prefix arg remove the scheduling timestamp
8828 @orgcmd{C-c C-d,org-agenda-deadline}
8829 Set a deadline for this item.  With prefix arg remove the deadline.
8831 @orgcmd{S-@key{right},org-agenda-do-date-later}
8832 Change the timestamp associated with the current line by one day into the
8833 future.  If the date is in the past, the first call to this command will move
8834 it to today.@*
8835 With a numeric prefix argument, change it by that many days.  For example,
8836 @kbd{3 6 5 S-@key{right}} will change it by a year.  With a @kbd{C-u} prefix,
8837 change the time by one hour.  If you immediately repeat the command, it will
8838 continue to change hours even without the prefix arg.  With a double @kbd{C-u
8839 C-u} prefix, do the same for changing minutes.@*
8840 The stamp is changed in the original Org file, but the change is not directly
8841 reflected in the agenda buffer.  Use @kbd{r} or @kbd{g} to update the buffer.
8843 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8844 Change the timestamp associated with the current line by one day
8845 into the past.
8847 @orgcmd{>,org-agenda-date-prompt}
8848 Change the timestamp associated with the current line.  The key @kbd{>} has
8849 been chosen, because it is the same as @kbd{S-.}  on my keyboard.
8851 @orgcmd{I,org-agenda-clock-in}
8852 Start the clock on the current item.  If a clock is running already, it
8853 is stopped first.
8855 @orgcmd{O,org-agenda-clock-out}
8856 Stop the previously started clock.
8858 @orgcmd{X,org-agenda-clock-cancel}
8859 Cancel the currently running clock.
8861 @orgcmd{J,org-agenda-clock-goto}
8862 Jump to the running clock in another window.
8864 @orgcmd{k,org-agenda-capture}
8865 Like @code{org-capture}, but use the date at point as the default date for
8866 the capture template.  See @var{org-capture-use-agenda-date} to make this
8867 the default behavior of @code{org-capture}.
8868 @cindex capturing, from agenda
8869 @vindex org-capture-use-agenda-date
8871 @tsubheading{Bulk remote editing selected entries}
8872 @cindex remote editing, bulk, from agenda
8873 @vindex org-agenda-bulk-persistent-marks
8874 @vindex org-agenda-bulk-custom-functions
8876 @orgcmd{m,org-agenda-bulk-mark}
8877 Mark the entry at point for bulk action.  With prefix arg, mark that many
8878 successive entries.
8880 @orgcmd{%,org-agenda-bulk-mark-regexp}
8881 Mark entries matching a regular expression for bulk action.
8883 @orgcmd{u,org-agenda-bulk-unmark}
8884 Unmark entry for bulk action.
8886 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8887 Unmark all marked entries for bulk action.
8889 @orgcmd{B,org-agenda-bulk-action}
8890 Bulk action: act on all marked entries in the agenda.  This will prompt for
8891 another key to select the action to be applied.  The prefix arg to @kbd{B}
8892 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8893 these special timestamps.  By default, marks are removed after the bulk.  If
8894 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
8895 @code{t} or hit @kbd{p} at the prompt.
8897 @table @kbd
8898 @item *
8899 Toggle persistent marks.
8900 @item $
8901 Archive all selected entries.
8902 @item A
8903 Archive entries by moving them to their respective archive siblings.
8904 @item t
8905 Change TODO state.  This prompts for a single TODO keyword and changes the
8906 state of all selected entries, bypassing blocking and suppressing logging
8907 notes (but not timestamps).
8908 @item +
8909 Add a tag to all selected entries.
8910 @item -
8911 Remove a tag from all selected entries.
8912 @item s
8913 Schedule all items to a new date.  To shift existing schedule dates by a
8914 fixed number of days, use something starting with double plus at the prompt,
8915 for example @samp{++8d} or @samp{++2w}.
8916 @item d
8917 Set deadline to a specific date.
8918 @item r
8919 Prompt for a single refile target and move all entries.  The entries will no
8920 longer be in the agenda; refresh (@kbd{g}) to bring them back.
8921 @item S
8922 Reschedule randomly into the coming N days.  N will be prompted for.  With
8923 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
8924 @item f
8925 Apply a function@footnote{You can also create persistent custom functions
8926 through@code{org-agenda-bulk-custom-functions}.} to marked entries.  For
8927 example, the function below sets the CATEGORY property of the entries to web.
8929 @lisp
8930 @group
8931 (defun set-category ()
8932   (interactive "P")
8933   (let* ((marker (or (org-get-at-bol 'org-hd-marker)
8934                      (org-agenda-error)))
8935          (buffer (marker-buffer marker)))
8936     (with-current-buffer buffer
8937       (save-excursion
8938         (save-restriction
8939           (widen)
8940           (goto-char marker)
8941           (org-back-to-heading t)
8942           (org-set-property "CATEGORY" "web"))))))
8943 @end group
8944 @end lisp
8945 @end table
8947 @tsubheading{Calendar commands}
8948 @cindex calendar commands, from agenda
8950 @orgcmd{c,org-agenda-goto-calendar}
8951 Open the Emacs calendar and move to the date at the agenda cursor.
8953 @orgcmd{c,org-calendar-goto-agenda}
8954 When in the calendar, compute and show the Org mode agenda for the
8955 date at the cursor.
8957 @cindex diary entries, creating from agenda
8958 @orgcmd{i,org-agenda-diary-entry}
8959 @vindex org-agenda-diary-file
8960 Insert a new entry into the diary, using the date at the cursor and (for
8961 block entries) the date at the mark.  This will add to the Emacs diary
8962 file@footnote{This file is parsed for the agenda when
8963 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8964 command in the calendar.  The diary file will pop up in another window, where
8965 you can add the entry.
8967 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
8968 Org will create entries (in Org mode syntax) in that file instead.  Most
8969 entries will be stored in a date-based outline tree that will later make it
8970 easy to archive appointments from previous months/years.  The tree will be
8971 built under an entry with a @code{DATE_TREE} property, or else with years as
8972 top-level entries.  Emacs will prompt you for the entry text---if you specify
8973 it, the entry will be created in @code{org-agenda-diary-file} without further
8974 interaction.  If you directly press @key{RET} at the prompt without typing
8975 text, the target file will be shown in another window for you to finish the
8976 entry there.  See also the @kbd{k r} command.
8978 @orgcmd{M,org-agenda-phases-of-moon}
8979 Show the phases of the moon for the three months around current date.
8981 @orgcmd{S,org-agenda-sunrise-sunset}
8982 Show sunrise and sunset times.  The geographical location must be set
8983 with calendar variables, see the documentation for the Emacs calendar.
8985 @orgcmd{C,org-agenda-convert-date}
8986 Convert the date at cursor into many other cultural and historic
8987 calendars.
8989 @orgcmd{H,org-agenda-holidays}
8990 Show holidays for three months around the cursor date.
8992 @item M-x org-icalendar-combine-agenda-files
8993 Export a single iCalendar file containing entries from all agenda files.
8994 This is a globally available command, and also available in the agenda menu.
8996 @tsubheading{Exporting to a file}
8997 @orgcmd{C-x C-w,org-agenda-write}
8998 @cindex exporting agenda views
8999 @cindex agenda views, exporting
9000 @vindex org-agenda-exporter-settings
9001 Write the agenda view to a file.  Depending on the extension of the selected
9002 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9003 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9004 (any other extension).  When exporting to Org, only the body of original
9005 headlines are exported, not subtrees or inherited tags.  When called with a
9006 @kbd{C-u} prefix argument, immediately open the newly created file.  Use the
9007 variable @code{org-agenda-exporter-settings} to set options for
9008 @file{ps-print} and for @file{htmlize} to be used during export.
9010 @tsubheading{Quit and Exit}
9011 @orgcmd{q,org-agenda-quit}
9012 Quit agenda, remove the agenda buffer.
9014 @cindex agenda files, removing buffers
9015 @orgcmd{x,org-agenda-exit}
9016 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9017 for the compilation of the agenda.  Buffers created by the user to
9018 visit Org files will not be removed.
9019 @end table
9022 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
9023 @section Custom agenda views
9024 @cindex custom agenda views
9025 @cindex agenda views, custom
9027 Custom agenda commands serve two purposes: to store and quickly access
9028 frequently used TODO and tags searches, and to create special composite
9029 agenda buffers.  Custom agenda commands will be accessible through the
9030 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9032 @menu
9033 * Storing searches::            Type once, use often
9034 * Block agenda::                All the stuff you need in a single buffer
9035 * Setting Options::             Changing the rules
9036 @end menu
9038 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
9039 @subsection Storing searches
9041 The first application of custom searches is the definition of keyboard
9042 shortcuts for frequently used searches, either creating an agenda
9043 buffer, or a sparse tree (the latter covering of course only the current
9044 buffer).
9045 @kindex C-c a C
9046 @vindex org-agenda-custom-commands
9047 @cindex agenda views, main example
9048 @cindex agenda, as an agenda views
9049 @cindex agenda*, as an agenda views
9050 @cindex tags, as an agenda view
9051 @cindex todo, as an agenda view
9052 @cindex tags-todo
9053 @cindex todo-tree
9054 @cindex occur-tree
9055 @cindex tags-tree
9057 Custom commands are configured in the variable
9058 @code{org-agenda-custom-commands}.  You can customize this variable, for
9059 example by pressing @kbd{C-c a C}.  You can also directly set it with Emacs
9060 Lisp in @file{.emacs}.  The following example contains all valid agenda
9061 views:
9063 @lisp
9064 @group
9065 (setq org-agenda-custom-commands
9066       '(("x" agenda)
9067         ("y" agenda*)
9068         ("w" todo "WAITING")
9069         ("W" todo-tree "WAITING")
9070         ("u" tags "+boss-urgent")
9071         ("v" tags-todo "+boss-urgent")
9072         ("U" tags-tree "+boss-urgent")
9073         ("f" occur-tree "\\<FIXME\\>")
9074         ("h" . "HOME+Name tags searches") ; description for "h" prefix
9075         ("hl" tags "+home+Lisa")
9076         ("hp" tags "+home+Peter")
9077         ("hk" tags "+home+Kim")))
9078 @end group
9079 @end lisp
9081 @noindent
9082 The initial string in each entry defines the keys you have to press
9083 after the dispatcher command @kbd{C-c a} in order to access the command.
9084 Usually this will be just a single character, but if you have many
9085 similar commands, you can also define two-letter combinations where the
9086 first character is the same in several combinations and serves as a
9087 prefix key@footnote{You can provide a description for a prefix key by
9088 inserting a cons cell with the prefix and the description.}.  The second
9089 parameter is the search type, followed by the string or regular
9090 expression to be used for the matching.  The example above will
9091 therefore define:
9093 @table @kbd
9094 @item C-c a x
9095 as a global search for agenda entries planned@footnote{@emph{Planned} means
9096 here that these entries have some planning information attached to them, like
9097 a time-stamp, a scheduled or a deadline string.  See
9098 @var{org-agenda-entry-types} on how to set what planning information will be
9099 taken into account.} this week/day.
9100 @item C-c a y
9101 as a global search for agenda entries planned this week/day, but only those
9102 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9103 @item C-c a w
9104 as a global search for TODO entries with @samp{WAITING} as the TODO
9105 keyword
9106 @item C-c a W
9107 as the same search, but only in the current buffer and displaying the
9108 results as a sparse tree
9109 @item C-c a u
9110 as a global tags search for headlines marked @samp{:boss:} but not
9111 @samp{:urgent:}
9112 @item C-c a v
9113 as the same search as @kbd{C-c a u}, but limiting the search to
9114 headlines that are also TODO items
9115 @item C-c a U
9116 as the same search as @kbd{C-c a u}, but only in the current buffer and
9117 displaying the result as a sparse tree
9118 @item C-c a f
9119 to create a sparse tree (again: current buffer only) with all entries
9120 containing the word @samp{FIXME}
9121 @item C-c a h
9122 as a prefix command for a HOME tags search where you have to press an
9123 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9124 Peter, or Kim) as additional tag to match.
9125 @end table
9127 Note that the @code{*-tree} agenda views need to be called from an
9128 Org buffer as they operate on the current buffer only.
9130 @node Block agenda, Setting Options, Storing searches, Custom agenda views
9131 @subsection Block agenda
9132 @cindex block agenda
9133 @cindex agenda, with block views
9135 Another possibility is the construction of agenda views that comprise
9136 the results of @emph{several} commands, each of which creates a block in
9137 the agenda buffer.  The available commands include @code{agenda} for the
9138 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9139 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9140 matching commands discussed above: @code{todo}, @code{tags}, and
9141 @code{tags-todo}.  Here are two examples:
9143 @lisp
9144 @group
9145 (setq org-agenda-custom-commands
9146       '(("h" "Agenda and Home-related tasks"
9147          ((agenda "")
9148           (tags-todo "home")
9149           (tags "garden")))
9150         ("o" "Agenda and Office-related tasks"
9151          ((agenda "")
9152           (tags-todo "work")
9153           (tags "office")))))
9154 @end group
9155 @end lisp
9157 @noindent
9158 This will define @kbd{C-c a h} to create a multi-block view for stuff
9159 you need to attend to at home.  The resulting agenda buffer will contain
9160 your agenda for the current week, all TODO items that carry the tag
9161 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
9162 command @kbd{C-c a o} provides a similar view for office tasks.
9164 @node Setting Options,  , Block agenda, Custom agenda views
9165 @subsection Setting options for custom commands
9166 @cindex options, for custom agenda views
9168 @vindex org-agenda-custom-commands
9169 Org mode contains a number of variables regulating agenda construction
9170 and display.  The global variables define the behavior for all agenda
9171 commands, including the custom commands.  However, if you want to change
9172 some settings just for a single custom view, you can do so.  Setting
9173 options requires inserting a list of variable names and values at the
9174 right spot in @code{org-agenda-custom-commands}.  For example:
9176 @lisp
9177 @group
9178 (setq org-agenda-custom-commands
9179       '(("w" todo "WAITING"
9180          ((org-agenda-sorting-strategy '(priority-down))
9181           (org-agenda-prefix-format "  Mixed: ")))
9182         ("U" tags-tree "+boss-urgent"
9183          ((org-show-following-heading nil)
9184           (org-show-hierarchy-above nil)))
9185         ("N" search ""
9186          ((org-agenda-files '("~org/notes.org"))
9187           (org-agenda-text-search-extra-files nil)))))
9188 @end group
9189 @end lisp
9191 @noindent
9192 Now the @kbd{C-c a w} command will sort the collected entries only by
9193 priority, and the prefix format is modified to just say @samp{  Mixed: }
9194 instead of giving the category of the entry.  The sparse tags tree of
9195 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9196 headline hierarchy above the match, nor the headline following the match
9197 will be shown.  The command @kbd{C-c a N} will do a text search limited
9198 to only a single file.
9200 @vindex org-agenda-custom-commands
9201 For command sets creating a block agenda,
9202 @code{org-agenda-custom-commands} has two separate spots for setting
9203 options.  You can add options that should be valid for just a single
9204 command in the set, and options that should be valid for all commands in
9205 the set.  The former are just added to the command entry; the latter
9206 must come after the list of command entries.  Going back to the block
9207 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9208 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9209 the results for GARDEN tags query in the opposite order,
9210 @code{priority-up}.  This would look like this:
9212 @lisp
9213 @group
9214 (setq org-agenda-custom-commands
9215       '(("h" "Agenda and Home-related tasks"
9216          ((agenda)
9217           (tags-todo "home")
9218           (tags "garden"
9219                 ((org-agenda-sorting-strategy '(priority-up)))))
9220          ((org-agenda-sorting-strategy '(priority-down))))
9221         ("o" "Agenda and Office-related tasks"
9222          ((agenda)
9223           (tags-todo "work")
9224           (tags "office")))))
9225 @end group
9226 @end lisp
9228 As you see, the values and parentheses setting is a little complex.
9229 When in doubt, use the customize interface to set this variable---it
9230 fully supports its structure.  Just one caveat: when setting options in
9231 this interface, the @emph{values} are just Lisp expressions.  So if the
9232 value is a string, you need to add the double-quotes around the value
9233 yourself.
9235 @vindex org-agenda-custom-commands-contexts
9236 To control whether an agenda command should be accessible from a specific
9237 context, you can customize @var{org-agenda-custom-commands-contexts}.  Let's
9238 say for example that you have an agenda commands @code{"o"} displaying a view
9239 that you only need when reading emails.  Then you would configure this option
9240 like this:
9242 @lisp
9243 (setq org-agenda-custom-commands-contexts
9244       '(("o" (in-mode . "message-mode"))))
9245 @end lisp
9247 You can also tell that the command key @code{"o"} should refer to another
9248 command key @code{"r"}.  In that case, add this command key like this:
9250 @lisp
9251 (setq org-agenda-custom-commands-contexts
9252       '(("o" "r" (in-mode . "message-mode"))))
9253 @end lisp
9255 See the docstring of the variable for more information.
9257 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
9258 @section Exporting Agenda Views
9259 @cindex agenda views, exporting
9261 If you are away from your computer, it can be very useful to have a printed
9262 version of some agenda views to carry around.  Org mode can export custom
9263 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9264 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9265 ghostscript @file{ps2pdf} utility must be installed on the system.  Selecting
9266 a PDF file will also create the postscript file.}, and iCalendar files.  If
9267 you want to do this only occasionally, use the command
9269 @table @kbd
9270 @orgcmd{C-x C-w,org-agenda-write}
9271 @cindex exporting agenda views
9272 @cindex agenda views, exporting
9273 @vindex org-agenda-exporter-settings
9274 Write the agenda view to a file.  Depending on the extension of the selected
9275 file name, the view will be exported as HTML (extension @file{.html} or
9276 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9277 @file{.ics}), or plain text (any other extension).  Use the variable
9278 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9279 for @file{htmlize} to be used during export, for example
9281 @vindex org-agenda-add-entry-text-maxlines
9282 @vindex htmlize-output-type
9283 @vindex ps-number-of-columns
9284 @vindex ps-landscape-mode
9285 @lisp
9286 (setq org-agenda-exporter-settings
9287       '((ps-number-of-columns 2)
9288         (ps-landscape-mode t)
9289         (org-agenda-add-entry-text-maxlines 5)
9290         (htmlize-output-type 'css)))
9291 @end lisp
9292 @end table
9294 If you need to export certain agenda views frequently, you can associate
9295 any custom agenda command with a list of output file names
9296 @footnote{If you want to store standard views like the weekly agenda
9297 or the global TODO list as well, you need to define custom commands for
9298 them in order to be able to specify file names.}.  Here is an example
9299 that first defines custom commands for the agenda and the global
9300 TODO list, together with a number of files to which to export them.
9301 Then we define two block agenda commands and specify file names for them
9302 as well.  File names can be relative to the current working directory,
9303 or absolute.
9305 @lisp
9306 @group
9307 (setq org-agenda-custom-commands
9308       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9309         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9310         ("h" "Agenda and Home-related tasks"
9311          ((agenda "")
9312           (tags-todo "home")
9313           (tags "garden"))
9314          nil
9315          ("~/views/home.html"))
9316         ("o" "Agenda and Office-related tasks"
9317          ((agenda)
9318           (tags-todo "work")
9319           (tags "office"))
9320          nil
9321          ("~/views/office.ps" "~/calendars/office.ics"))))
9322 @end group
9323 @end lisp
9325 The extension of the file name determines the type of export.  If it is
9326 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9327 the buffer to HTML and save it to this file name.  If the extension is
9328 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9329 Postscript output.  If the extension is @file{.ics}, iCalendar export is
9330 run export over all files that were used to construct the agenda, and
9331 limit the export to entries listed in the agenda.  Any other
9332 extension produces a plain ASCII file.
9334 The export files are @emph{not} created when you use one of those
9335 commands interactively because this might use too much overhead.
9336 Instead, there is a special command to produce @emph{all} specified
9337 files in one step:
9339 @table @kbd
9340 @orgcmd{C-c a e,org-store-agenda-views}
9341 Export all agenda views that have export file names associated with
9342 them.
9343 @end table
9345 You can use the options section of the custom agenda commands to also
9346 set options for the export commands.  For example:
9348 @lisp
9349 (setq org-agenda-custom-commands
9350       '(("X" agenda ""
9351          ((ps-number-of-columns 2)
9352           (ps-landscape-mode t)
9353           (org-agenda-prefix-format " [ ] ")
9354           (org-agenda-with-colors nil)
9355           (org-agenda-remove-tags t))
9356          ("theagenda.ps"))))
9357 @end lisp
9359 @noindent
9360 This command sets two options for the Postscript exporter, to make it
9361 print in two columns in landscape format---the resulting page can be cut
9362 in two and then used in a paper agenda.  The remaining settings modify
9363 the agenda prefix to omit category and scheduling information, and
9364 instead include a checkbox to check off items.  We also remove the tags
9365 to make the lines compact, and we don't want to use colors for the
9366 black-and-white printer.  Settings specified in
9367 @code{org-agenda-exporter-settings} will also apply, but the settings
9368 in @code{org-agenda-custom-commands} take precedence.
9370 @noindent
9371 From the command line you may also use
9372 @example
9373 emacs -eval (org-batch-store-agenda-views) -kill
9374 @end example
9375 @noindent
9376 or, if you need to modify some parameters@footnote{Quoting depends on the
9377 system you use, please check the FAQ for examples.}
9378 @example
9379 emacs -eval '(org-batch-store-agenda-views                      \
9380               org-agenda-span (quote month)                     \
9381               org-agenda-start-day "2007-11-01"                 \
9382               org-agenda-include-diary nil                      \
9383               org-agenda-files (quote ("~/org/project.org")))'  \
9384       -kill
9385 @end example
9386 @noindent
9387 which will create the agenda views restricted to the file
9388 @file{~/org/project.org}, without diary entries and with a 30-day
9389 extent.
9391 You can also extract agenda information in a way that allows further
9392 processing by other programs.  See @ref{Extracting agenda information}, for
9393 more information.
9396 @node Agenda column view,  , Exporting Agenda Views, Agenda Views
9397 @section Using column view in the agenda
9398 @cindex column view, in agenda
9399 @cindex agenda, column view
9401 Column view (@pxref{Column view}) is normally used to view and edit
9402 properties embedded in the hierarchical structure of an Org file.  It can be
9403 quite useful to use column view also from the agenda, where entries are
9404 collected by certain criteria.
9406 @table @kbd
9407 @orgcmd{C-c C-x C-c,org-agenda-columns}
9408 Turn on column view in the agenda.
9409 @end table
9411 To understand how to use this properly, it is important to realize that the
9412 entries in the agenda are no longer in their proper outline environment.
9413 This causes the following issues:
9415 @enumerate
9416 @item
9417 @vindex org-columns-default-format
9418 @vindex org-overriding-columns-format
9419 Org needs to make a decision which @code{COLUMNS} format to use.  Since the
9420 entries in the agenda are collected from different files, and different files
9421 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9422 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9423 currently set, and if so, takes the format from there.  Otherwise it takes
9424 the format associated with the first item in the agenda, or, if that item
9425 does not have a specific format (defined in a property, or in its file), it
9426 uses @code{org-columns-default-format}.
9427 @item
9428 @cindex property, special, CLOCKSUM
9429 If any of the columns has a summary type defined (@pxref{Column attributes}),
9430 turning on column view in the agenda will visit all relevant agenda files and
9431 make sure that the computations of this property are up to date.  This is
9432 also true for the special @code{CLOCKSUM} property.  Org will then sum the
9433 values displayed in the agenda.  In the daily/weekly agenda, the sums will
9434 cover a single day; in all other views they cover the entire block.  It is
9435 vital to realize that the agenda may show the same entry @emph{twice} (for
9436 example as scheduled and as a deadline), and it may show two entries from the
9437 same hierarchy (for example a @emph{parent} and its @emph{child}).  In these
9438 cases, the summation in the agenda will lead to incorrect results because
9439 some values will count double.
9440 @item
9441 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9442 the entire clocked time for this item.  So even in the daily/weekly agenda,
9443 the clocksum listed in column view may originate from times outside the
9444 current view.  This has the advantage that you can compare these values with
9445 a column listing the planned total effort for a task---one of the major
9446 applications for column view in the agenda.  If you want information about
9447 clocked time in the displayed period use clock table mode (press @kbd{R} in
9448 the agenda).
9450 @item
9451 @cindex property, special, CLOCKSUM_T
9452 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9453 always today's clocked time for this item.  So even in the weekly agenda,
9454 the clocksum listed in column view only originates from today.  This lets
9455 you compare the time you spent on a task for today, with the time already
9456 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9457 @end enumerate
9460 @node Markup, Exporting, Agenda Views, Top
9461 @chapter Markup for rich export
9463 When exporting Org mode documents, the exporter tries to reflect the
9464 structure of the document as accurately as possible in the back-end.  Since
9465 export targets like HTML, @LaTeX{} allow much richer formatting, Org mode has
9466 rules on how to prepare text for rich export.  This section summarizes the
9467 markup rules used in an Org mode buffer.
9469 @menu
9470 * Structural markup elements::  The basic structure as seen by the exporter
9471 * Images and tables::           Images, tables and caption mechanism
9472 * Literal examples::            Source code examples with special formatting
9473 * Include files::               Include additional files into a document
9474 * Index entries::               Making an index
9475 * Macro replacement::           Use macros to create complex output
9476 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
9477 @end menu
9479 @node Structural markup elements, Images and tables, Markup, Markup
9480 @section Structural markup elements
9482 @menu
9483 * Document title::              Where the title is taken from
9484 * Headings and sections::       The document structure as seen by the exporter
9485 * Table of contents::           The if and where of the table of contents
9486 * Lists::                       Lists
9487 * Paragraphs::                  Paragraphs
9488 * Footnote markup::             Footnotes
9489 * Emphasis and monospace::      Bold, italic, etc.
9490 * Horizontal rules::            Make a line
9491 * Comment lines::               What will *not* be exported
9492 @end menu
9494 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
9495 @subheading Document title
9496 @cindex document title, markup rules
9498 @noindent
9499 The title of the exported document is taken from the special line
9501 @cindex #+TITLE
9502 @example
9503 #+TITLE: This is the title of the document
9504 @end example
9506 @noindent
9507 If this line does not exist, the title will be the name of the file
9508 associated to buffer, without extension, or the buffer name.
9510 @cindex property, EXPORT_TITLE
9511 If you are exporting only a subtree by marking is as the region, the heading
9512 of the subtree will become the title of the document.  If the subtree has a
9513 property @code{EXPORT_TITLE}, that will take precedence.
9515 @node Headings and sections, Table of contents, Document title, Structural markup elements
9516 @subheading Headings and sections
9517 @cindex headings and sections, markup rules
9519 @vindex org-export-headline-levels
9520 The outline structure of the document as described in @ref{Document
9521 Structure}, forms the basis for defining sections of the exported document.
9522 However, since the outline structure is also used for (for example) lists of
9523 tasks, only the first three outline levels will be used as headings.  Deeper
9524 levels will become itemized lists.  You can change the location of this
9525 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9526 per-file basis with a line
9528 @cindex #+OPTIONS
9529 @example
9530 #+OPTIONS: H:4
9531 @end example
9533 @node Table of contents, Lists, Headings and sections, Structural markup elements
9534 @subheading Table of contents
9535 @cindex table of contents, markup rules
9537 @cindex #+TOC
9538 @vindex org-export-with-toc
9539 The table of contents is normally inserted directly before the first headline
9540 of the file.  If you would like to get it to a different location, insert
9541 @code{#+TOC: headlines} at the desired location.  The depth of the table of
9542 contents is by default the same as the number of headline levels, but you can
9543 choose a smaller number, or turn off the table of contents entirely, by
9544 configuring the variable @code{org-export-with-toc}, or on a per-file basis
9545 with a line like
9547 @example
9548 #+OPTIONS: toc:2          (only to two levels in TOC)
9549 #+TOC: headlines 2        (the same, at a specific location)
9550 #+OPTIONS: toc:nil        (no TOC at all)
9551 @end example
9553 The same @code{TOC} keyword can also generate a list of all tables (resp.@:
9554 all listings) with a caption in the buffer.
9556 @example
9557 #+TOC: listings           (build a list of listings)
9558 #+TOC: tables             (build a list of tables)
9559 @end example
9561 @cindex property, ALT_TITLE
9562 The headline's title usually determines its corresponding entry in a table of
9563 contents.  However, it is possible to specify an alternative title by
9564 setting @code{ALT_TITLE} property accordingly.  It will then be used when
9565 building the table.
9567 @node Lists, Paragraphs, Table of contents, Structural markup elements
9568 @subheading Lists
9569 @cindex lists, markup rules
9571 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9572 syntax for such lists.  Most back-ends support unordered, ordered, and
9573 description lists.
9575 @node Paragraphs, Footnote markup, Lists, Structural markup elements
9576 @subheading Paragraphs, line breaks, and quoting
9577 @cindex paragraphs, markup rules
9579 Paragraphs are separated by at least one empty line.  If you need to enforce
9580 a line break within a paragraph, use @samp{\\} at the end of a line.
9582 To keep the line breaks in a region, but otherwise use normal formatting, you
9583 can use this construct, which can also be used to format poetry.
9585 @cindex #+BEGIN_VERSE
9586 @example
9587 #+BEGIN_VERSE
9588  Great clouds overhead
9589  Tiny black birds rise and fall
9590  Snow covers Emacs
9592      -- AlexSchroeder
9593 #+END_VERSE
9594 @end example
9596 When quoting a passage from another document, it is customary to format this
9597 as a paragraph that is indented on both the left and the right margin.  You
9598 can include quotations in Org mode documents like this:
9600 @cindex #+BEGIN_QUOTE
9601 @example
9602 #+BEGIN_QUOTE
9603 Everything should be made as simple as possible,
9604 but not any simpler -- Albert Einstein
9605 #+END_QUOTE
9606 @end example
9608 If you would like to center some text, do it like this:
9609 @cindex #+BEGIN_CENTER
9610 @example
9611 #+BEGIN_CENTER
9612 Everything should be made as simple as possible, \\
9613 but not any simpler
9614 #+END_CENTER
9615 @end example
9618 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
9619 @subheading Footnote markup
9620 @cindex footnotes, markup rules
9621 @cindex @file{footnote.el}
9623 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9624 by all back-ends.  Org allows multiple references to the same note, and
9625 multiple footnotes side by side.
9627 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
9628 @subheading Emphasis and monospace
9630 @cindex underlined text, markup rules
9631 @cindex bold text, markup rules
9632 @cindex italic text, markup rules
9633 @cindex verbatim text, markup rules
9634 @cindex code text, markup rules
9635 @cindex strike-through text, markup rules
9636 @vindex org-fontify-emphasized-text
9637 @vindex org-emphasis-regexp-components
9638 @vindex org-emphasis-alist
9639 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
9640 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}.  Text
9641 in the code and verbatim string is not processed for Org mode specific
9642 syntax, it is exported verbatim.
9644 To turn off fontification for marked up text, you can set
9645 @code{org-fontify-emphasized-text} to @code{nil}.  To narrow down the list of
9646 available markup syntax, you can customize @var{org-emphasis-alist}.  To fine
9647 tune what characters are allowed before and after the markup characters, you
9648 can tweak @code{org-emphasis-regexp-components}.  Beware that changing one of
9649 the above variables will no take effect until you reload Org, for which you
9650 may need to restart Emacs.
9652 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
9653 @subheading  Horizontal rules
9654 @cindex horizontal rules, markup rules
9655 A line consisting of only dashes, and at least 5 of them, will be exported as
9656 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
9658 @node Comment lines,  , Horizontal rules, Structural markup elements
9659 @subheading Comment lines
9660 @cindex comment lines
9661 @cindex exporting, not
9662 @cindex #+BEGIN_COMMENT
9664 Lines starting with zero or more whitespace characters followed by one
9665 @samp{#} and a whitespace are treated as comments and will never be exported.
9666 Also entire subtrees starting with the word @samp{COMMENT} will never be
9667 exported.  Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
9668 ... @samp{#+END_COMMENT} will not be exported.
9670 @table @kbd
9671 @kindex C-c ;
9672 @item C-c ;
9673 Toggle the COMMENT keyword at the beginning of an entry.
9674 @end table
9677 @node Images and tables, Literal examples, Structural markup elements, Markup
9678 @section Images and Tables
9680 @cindex tables, markup rules
9681 @cindex #+CAPTION
9682 @cindex #+NAME
9683 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9684 the @file{table.el} package will be exported properly.  For Org mode tables,
9685 the lines before the first horizontal separator line will become table header
9686 lines.  You can use the following lines somewhere before the table to assign
9687 a caption and a label for cross references, and in the text you can refer to
9688 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9690 @example
9691 #+CAPTION: This is the caption for the next table (or link)
9692 #+NAME:   tab:basic-data
9693    | ... | ...|
9694    |-----|----|
9695 @end example
9697 Optionally, the caption can take the form:
9698 @example
9699 #+CAPTION[Caption for list of tables]: Caption for table.
9700 @end example
9702 @cindex inlined images, markup rules
9703 Some back-ends allow you to directly include images into the exported
9704 document.  Org does this, if a link to an image files does not have
9705 a description part, for example @code{[[./img/a.jpg]]}.  If you wish to
9706 define a caption for the image and maybe a label for internal cross
9707 references, make sure that the link is on a line by itself and precede it
9708 with @code{#+CAPTION} and @code{#+NAME} as follows:
9710 @example
9711 #+CAPTION: This is the caption for the next figure link (or table)
9712 #+NAME:   fig:SED-HR4049
9713 [[./img/a.jpg]]
9714 @end example
9716 @noindent
9717 Such images can be displayed within the buffer.  @xref{Handling links,the
9718 discussion of image links}.
9720 Even though images and tables are prominent examples of captioned structures,
9721 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9722 equations, source code blocks).  Depending on the export back-end, those may
9723 or may not be handled.
9725 @node Literal examples, Include files, Images and tables, Markup
9726 @section Literal examples
9727 @cindex literal examples, markup rules
9728 @cindex code line references, markup rules
9730 You can include literal examples that should not be subjected to
9731 markup.  Such examples will be typeset in monospace, so this is well suited
9732 for source code and similar examples.
9733 @cindex #+BEGIN_EXAMPLE
9735 @example
9736 #+BEGIN_EXAMPLE
9737 Some example from a text file.
9738 #+END_EXAMPLE
9739 @end example
9741 Note that such blocks may be @i{indented} in order to align nicely with
9742 indented text and in particular with plain list structure (@pxref{Plain
9743 lists}).  For simplicity when using small examples, you can also start the
9744 example lines with a colon followed by a space.  There may also be additional
9745 whitespace before the colon:
9747 @example
9748 Here is an example
9749    : Some example from a text file.
9750 @end example
9752 @cindex formatting source code, markup rules
9753 If the example is source code from a programming language, or any other text
9754 that can be marked up by font-lock in Emacs, you can ask for the example to
9755 look like the fontified Emacs buffer@footnote{This works automatically for
9756 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9757 which is distributed with Org).  Fontified code chunks in @LaTeX{} can be
9758 achieved using either the listings or the
9759 @url{http://code.google.com/p/minted, minted,} package.  Refer to
9760 @code{org-latex-listings} documentation for details.}.  This is done
9761 with the @samp{src} block, where you also need to specify the name of the
9762 major mode that should be used to fontify the example@footnote{Code in
9763 @samp{src} blocks may also be evaluated either interactively or on export.
9764 See @pxref{Working With Source Code} for more information on evaluating code
9765 blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code
9766 blocks.
9767 @cindex #+BEGIN_SRC
9769 @example
9770 #+BEGIN_SRC emacs-lisp
9771   (defun org-xor (a b)
9772      "Exclusive or."
9773      (if a (not b) b))
9774 #+END_SRC
9775 @end example
9777 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9778 switch to the end of the @code{BEGIN} line, to get the lines of the example
9779 numbered.  If you use a @code{+n} switch, the numbering from the previous
9780 numbered snippet will be continued in the current one.  In literal examples,
9781 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9782 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9783 enclosed in single parenthesis).  In HTML, hovering the mouse over such a
9784 link will remote-highlight the corresponding code line, which is kind of
9785 cool.
9787 You can also add a @code{-r} switch which @i{removes} the labels from the
9788 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9789 labels in the source code while using line numbers for the links, which might
9790 be useful to explain those in an Org mode example code.}.  With the @code{-n}
9791 switch, links to these references will be labeled by the line numbers from
9792 the code listing, otherwise links will use the labels with no parentheses.
9793 Here is an example:
9795 @example
9796 #+BEGIN_SRC emacs-lisp -n -r
9797 (save-excursion                  (ref:sc)
9798    (goto-char (point-min))       (ref:jump)
9799 #+END_SRC
9800 In line [[(sc)]] we remember the current position.  [[(jump)][Line (jump)]]
9801 jumps to point-min.
9802 @end example
9804 @vindex org-coderef-label-format
9805 If the syntax for the label format conflicts with the language syntax, use a
9806 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9807 -n -r -l "((%s))"}.  See also the variable @code{org-coderef-label-format}.
9809 HTML export also allows examples to be published as text areas (@pxref{Text
9810 areas in HTML export}).
9812 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9813 so often, shortcuts are provided using the Easy Templates facility
9814 (@pxref{Easy Templates}).
9816 @table @kbd
9817 @kindex C-c '
9818 @item C-c '
9819 Edit the source code example at point in its native mode.  This works by
9820 switching to a temporary buffer with the source code.  You need to exit by
9821 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9822 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9823 from being interpreted by Org as outline nodes or special syntax.  These
9824 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9825 The edited version will then replace the old version in the Org buffer.
9826 Fixed-width regions (where each line starts with a colon followed by a space)
9827 will be edited using @code{artist-mode}@footnote{You may select
9828 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9829 to allow creating ASCII drawings easily.  Using this command in an empty line
9830 will create a new fixed-width region.
9831 @kindex C-c l
9832 @item C-c l
9833 Calling @code{org-store-link} while editing a source code example in a
9834 temporary buffer created with @kbd{C-c '} will prompt for a label.  Make sure
9835 that it is unique in the current buffer, and insert it with the proper
9836 formatting like @samp{(ref:label)} at the end of the current line.  Then the
9837 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9838 @end table
9841 @node Include files, Index entries, Literal examples, Markup
9842 @section Include files
9843 @cindex include files, markup rules
9845 During export, you can include the content of another file.  For example, to
9846 include your @file{.emacs} file, you could use:
9847 @cindex #+INCLUDE
9849 @example
9850 #+INCLUDE: "~/.emacs" src emacs-lisp
9851 @end example
9853 @noindent
9854 The optional second and third parameter are the markup (e.g., @samp{quote},
9855 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9856 language for formatting the contents.  The markup is optional; if it is not
9857 given, the text will be assumed to be in Org mode format and will be
9858 processed normally.
9860 Contents of the included file will belong to the same structure (headline,
9861 item) containing the INCLUDE keyword.  In particular, headlines within the
9862 file will become children of the current section.  That behaviour can be
9863 changed by providing an additional keyword parameter, @code{:minlevel}.  In
9864 that case, all headlines in the included file will be shifted so the one with
9865 the lowest level reaches that specified level.  For example, to make a file
9866 become a sibling of the current top-level headline, use
9868 @example
9869 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
9870 @end example
9872 You can also include a portion of a file by specifying a lines range using
9873 the @code{:lines} parameter.  The line at the upper end of the range will not
9874 be included.  The start and/or the end of the range may be omitted to use the
9875 obvious defaults.
9877 @example
9878 #+INCLUDE: "~/.emacs" :lines "5-10"   @r{Include lines 5 to 10, 10 excluded}
9879 #+INCLUDE: "~/.emacs" :lines "-10"    @r{Include lines 1 to 10, 10 excluded}
9880 #+INCLUDE: "~/.emacs" :lines "10-"    @r{Include lines from 10 to EOF}
9881 @end example
9883 @table @kbd
9884 @kindex C-c '
9885 @item C-c '
9886 Visit the include file at point.
9887 @end table
9889 @node Index entries, Macro replacement, Include files, Markup
9890 @section Index entries
9891 @cindex index entries, for publishing
9893 You can specify entries that will be used for generating an index during
9894 publishing.  This is done by lines starting with @code{#+INDEX}.  An entry
9895 the contains an exclamation mark will create a sub item.  See @ref{Generating
9896 an index} for more information.
9898 @example
9899 * Curriculum Vitae
9900 #+INDEX: CV
9901 #+INDEX: Application!CV
9902 @end example
9907 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
9908 @section Macro replacement
9909 @cindex macro replacement, during export
9910 @cindex #+MACRO
9912 You can define text snippets with
9914 @example
9915 #+MACRO: name   replacement text $1, $2 are arguments
9916 @end example
9918 @noindent which can be referenced in
9919 paragraphs, verse blocks, table cells and some keywords with
9920 @code{@{@{@{name(arg1,arg2)@}@}@}}@footnote{Since commas separate arguments,
9921 commas within arguments have to be escaped with a backslash character.
9922 Conversely, backslash characters before a comma, and only them, need to be
9923 escaped with another backslash character.}.  In addition to defined macros,
9924 @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will reference
9925 information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and similar lines.
9926 Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9927 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9928 and to the modification time of the file being exported, respectively.
9929 @var{FORMAT} should be a format string understood by
9930 @code{format-time-string}.
9932 Macro expansion takes place during export.
9935 @node Embedded @LaTeX{},  , Macro replacement, Markup
9936 @section Embedded @LaTeX{}
9937 @cindex @TeX{} interpretation
9938 @cindex @LaTeX{} interpretation
9940 Plain ASCII is normally sufficient for almost all note taking.  Exceptions
9941 include scientific notes, which often require mathematical symbols and the
9942 occasional formula.  @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9943 Donald E. Knuth's @TeX{} system.  Many of the features described here as
9944 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9945 distinction.}  is widely used to typeset scientific documents.  Org mode
9946 supports embedding @LaTeX{} code into its files, because many academics are
9947 used to writing and reading @LaTeX{} source code, and because it can be
9948 readily processed to produce pretty output for a number of export back-ends.
9950 @menu
9951 * Special symbols::             Greek letters and other symbols
9952 * Subscripts and superscripts::  Simple syntax for raising/lowering text
9953 * @LaTeX{} fragments::          Complex formulas made easy
9954 * Previewing @LaTeX{} fragments::  What will this snippet look like?
9955 * CDLaTeX mode::                Speed up entering of formulas
9956 @end menu
9958 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
9959 @subsection Special symbols
9960 @cindex math symbols
9961 @cindex special symbols
9962 @cindex @TeX{} macros
9963 @cindex @LaTeX{} fragments, markup rules
9964 @cindex HTML entities
9965 @cindex @LaTeX{} entities
9967 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
9968 to indicate the Greek letter, or @samp{\to} to indicate an arrow.  Completion
9969 for these symbols is available, just type @samp{\} and maybe a few letters,
9970 and press @kbd{M-@key{TAB}} to see possible completions.  Unlike @LaTeX{}
9971 code, Org mode allows these symbols to be present without surrounding math
9972 delimiters, for example:
9974 @example
9975 Angles are written as Greek letters \alpha, \beta and \gamma.
9976 @end example
9978 @vindex org-entities
9979 During export, these symbols will be transformed into the native format of
9980 the exporter back-end.  Strings like @code{\alpha} will be exported as
9981 @code{&alpha;} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9982 output.  Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
9983 @code{~} in @LaTeX{}.  If you need such a symbol inside a word, terminate it
9984 like this: @samp{\Aacute@{@}stor}.
9986 A large number of entities is provided, with names taken from both HTML and
9987 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9988 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9989 @samp{...} are all converted into special commands creating hyphens of
9990 different lengths or a compact set of dots.
9992 If you would like to see entities displayed as UTF-8 characters, use the
9993 following command@footnote{You can turn this on by default by setting the
9994 variable @code{org-pretty-entities}, or on a per-file base with the
9995 @code{#+STARTUP} option @code{entitiespretty}.}:
9997 @table @kbd
9998 @cindex @code{entitiespretty}, STARTUP keyword
9999 @kindex C-c C-x \
10000 @item C-c C-x \
10001 Toggle display of entities as UTF-8 characters.  This does not change the
10002 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10003 for display purposes only.
10004 @end table
10006 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
10007 @subsection Subscripts and superscripts
10008 @cindex subscript
10009 @cindex superscript
10011 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10012 subscripts.  Again, these can be used without embedding them in math-mode
10013 delimiters.  To increase the readability of ASCII text, it is not necessary
10014 (but OK) to surround multi-character sub- and superscripts with curly braces.
10015 For example
10017 @example
10018 The mass of the sun is M_sun = 1.989 x 10^30 kg.  The radius of
10019 the sun is R_@{sun@} = 6.96 x 10^8 m.
10020 @end example
10022 @vindex org-use-sub-superscripts
10023 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
10024 @samp{_} with a backslash: @samp{\^} and @samp{\_}.  If you write a text
10025 where the underscore is often used in a different context, Org's convention
10026 to always interpret these as subscripts can get in your way.  Configure the
10027 variable @code{org-use-sub-superscripts} to change this convention.  For
10028 example, when setting this variable to @code{@{@}}, @samp{a_b} will not be
10029 interpreted as a subscript, but @samp{a_@{b@}} will.
10031 @table @kbd
10032 @kindex C-c C-x \
10033 @item C-c C-x \
10034 In addition to showing entities as UTF-8 characters, this command will also
10035 format sub- and superscripts in a WYSIWYM way.
10036 @end table
10038 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
10039 @subsection @LaTeX{} fragments
10040 @cindex @LaTeX{} fragments
10042 @vindex org-format-latex-header
10043 Going beyond symbols and sub- and superscripts, a full formula language is
10044 needed.  Org mode can contain @LaTeX{} math fragments, and it supports ways
10045 to process these for several export back-ends.  When exporting to @LaTeX{},
10046 the code is obviously left as it is.  When exporting to HTML, Org invokes the
10047 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
10048 HTML export}) to process and display the math@footnote{If you plan to use
10049 this regularly or on pages with significant page views, you should install
10050 @file{MathJax} on your own server in order to limit the load of our server.}.
10051 Finally, it can also process the mathematical expressions into
10052 images@footnote{For this to work you need to be on a system with a working
10053 @LaTeX{} installation.  You also need the @file{dvipng} program or the
10054 @file{convert}, respectively available at
10055 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10056 suite.  The @LaTeX{} header that will be used when processing a fragment can
10057 be configured with the variable @code{org-format-latex-header}.} that can be
10058 displayed in a browser.
10060 @LaTeX{} fragments don't need any special marking at all.  The following
10061 snippets will be identified as @LaTeX{} source code:
10062 @itemize @bullet
10063 @item
10064 Environments of any kind@footnote{When @file{MathJax} is used, only the
10065 environments recognized by @file{MathJax} will be processed.  When
10066 @file{dvipng} is used to create images, any @LaTeX{} environment will be
10067 handled.}.  The only requirement is that the @code{\begin} and @code{\end}
10068 statements appear on a new line, at the beginning of the line or after
10069 whitespaces only.
10070 @item
10071 Text within the usual @LaTeX{} math delimiters.  To avoid conflicts with
10072 currency specifications, single @samp{$} characters are only recognized as
10073 math delimiters if the enclosed text contains at most two line breaks, is
10074 directly attached to the @samp{$} characters with no whitespace in between,
10075 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
10076 For the other delimiters, there is no such restriction, so when in doubt, use
10077 @samp{\(...\)} as inline math delimiters.
10078 @end itemize
10080 @noindent For example:
10082 @example
10083 \begin@{equation@}
10084 x=\sqrt@{b@}
10085 \end@{equation@}
10087 If $a^2=b$ and \( b=2 \), then the solution must be
10088 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10089 @end example
10091 @c FIXME
10092 @c @noindent
10093 @c @vindex org-format-latex-options
10094 @c If you need any of the delimiter ASCII sequences for other purposes, you
10095 @c can configure the option @code{org-format-latex-options} to deselect the
10096 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10098 @vindex org-export-with-latex
10099 @LaTeX{} processing can be configured with the variable
10100 @code{org-export-with-latex}.  The default setting is @code{t} which means
10101 @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10102 You can also set this variable on a per-file basis using one of these
10103 lines:
10105 @example
10106 #+OPTIONS: tex:t          @r{Do the right thing automatically (MathJax)}
10107 #+OPTIONS: tex:dvipng     @r{Force using dvipng images}
10108 #+OPTIONS: tex:nil        @r{Do not process @LaTeX{} fragments at all}
10109 #+OPTIONS: tex:verbatim   @r{Verbatim export, for jsMath or so}
10110 @end example
10112 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
10113 @subsection Previewing @LaTeX{} fragments
10114 @cindex @LaTeX{} fragments, preview
10116 @vindex org-latex-create-formula-image-program
10117 If you have @file{dvipng} or @file{imagemagick} installed@footnote{Choose the
10118 converter by setting the variable
10119 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10120 fragments can be processed to produce preview images of the typeset
10121 expressions:
10123 @table @kbd
10124 @kindex C-c C-x C-l
10125 @item C-c C-x C-l
10126 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10127 over the source code.  If there is no fragment at point, process all
10128 fragments in the current entry (between two headlines).  When called
10129 with a prefix argument, process the entire subtree.  When called with
10130 two prefix arguments, or when the cursor is before the first headline,
10131 process the entire buffer.
10132 @kindex C-c C-c
10133 @item C-c C-c
10134 Remove the overlay preview images.
10135 @end table
10137 @vindex org-format-latex-options
10138 You can customize the variable @code{org-format-latex-options} to influence
10139 some aspects of the preview.  In particular, the @code{:scale} (and for HTML
10140 export, @code{:html-scale}) property can be used to adjust the size of the
10141 preview images.
10143 @vindex org-startup-with-latex-preview
10144 You can turn on the previewing of all @LaTeX{} fragments in a file with
10146 @example
10147 #+STARTUP: latexpreview
10148 @end example
10150 To disable it, simply use
10152 @example
10153 #+STARTUP: nolatexpreview
10154 @end example
10156 @node CDLaTeX mode,  , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
10157 @subsection Using CD@LaTeX{} to enter math
10158 @cindex CD@LaTeX{}
10160 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10161 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10162 environments and math templates.  Inside Org mode, you can make use of
10163 some of the features of CD@LaTeX{} mode.  You need to install
10164 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10165 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10166 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10167 version @code{org-cdlatex-mode} that comes as part of Org mode.  Turn it
10168 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
10169 Org files with
10171 @lisp
10172 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10173 @end lisp
10175 When this mode is enabled, the following features are present (for more
10176 details see the documentation of CD@LaTeX{} mode):
10177 @itemize @bullet
10178 @kindex C-c @{
10179 @item
10180 Environment templates can be inserted with @kbd{C-c @{}.
10181 @item
10182 @kindex @key{TAB}
10183 The @key{TAB} key will do template expansion if the cursor is inside a
10184 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10185 inside such a fragment, see the documentation of the function
10186 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
10187 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10188 correctly inside the first brace.  Another @key{TAB} will get you into
10189 the second brace.  Even outside fragments, @key{TAB} will expand
10190 environment abbreviations at the beginning of a line.  For example, if
10191 you write @samp{equ} at the beginning of a line and press @key{TAB},
10192 this abbreviation will be expanded to an @code{equation} environment.
10193 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
10194 @item
10195 @kindex _
10196 @kindex ^
10197 @vindex cdlatex-simplify-sub-super-scripts
10198 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10199 characters together with a pair of braces.  If you use @key{TAB} to move
10200 out of the braces, and if the braces surround only a single character or
10201 macro, they are removed again (depending on the variable
10202 @code{cdlatex-simplify-sub-super-scripts}).
10203 @item
10204 @kindex `
10205 Pressing the backquote @kbd{`} followed by a character inserts math
10206 macros, also outside @LaTeX{} fragments.  If you wait more than 1.5 seconds
10207 after the backquote, a help window will pop up.
10208 @item
10209 @kindex '
10210 Pressing the single-quote @kbd{'} followed by another character modifies
10211 the symbol before point with an accent or a font.  If you wait more than
10212 1.5 seconds after the single-quote, a help window will pop up.  Character
10213 modification will work only inside @LaTeX{} fragments; outside the quote
10214 is normal.
10215 @end itemize
10217 @node Exporting, Publishing, Markup, Top
10218 @chapter Exporting
10219 @cindex exporting
10221 Org mode documents can be exported into a variety of other formats.
10223 For printing and sharing notes, ASCII export produces a readable and simple
10224 version of an Org file.  HTML export allows you to publish a notes file on
10225 the web.  @LaTeX{} export lets you use Org mode and its structured editing
10226 functions to easily create @LaTeX{} files.  OpenDocument Text (ODT) export
10227 allows seamless collaboration across organizational boundaries.  To
10228 incorporate entries with associated times like deadlines or appointments into
10229 a desktop calendar program like iCal, Org mode can also produce extracts in
10230 the iCalendar format.
10232 @menu
10233 * The Export Dispatcher::       The main exporter interface
10234 * Export formats::              Available export formats
10235 * Export settings::             Generic export settings
10236 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
10237 * HTML export::                 Exporting to HTML
10238 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
10239 * OpenDocument Text export::    Exporting to OpenDocument Text
10240 * iCalendar export::            Exporting in iCalendar format
10241 @end menu
10243 @node The Export Dispatcher, Export formats, Exporting, Exporting
10244 @section The Export Dispatcher
10245 @vindex org-export-dispatch-use-expert-ui
10246 @cindex Export, dispatcher
10248 The main entry point for any export related task is the dispatcher, a
10249 hierarchical menu@footnote{It is also possible to use a less intrusive
10250 interface by setting @var{org-export-dispatch-use-expert-ui} to a non-nil
10251 value.  In that case, only a prompt is visible from the minibuffer.  From
10252 there one can still switch back to regular menu with @kbd{?} key.} from
10253 which it is possible to select an export format and to toggle export
10254 options.
10256 @c @quotation
10257 @table @asis
10258 @orgcmd{C-c C-e,org-export-dispatch}
10260 Dispatch for export and publishing commands.  When called with @kbd{C-u}
10261 prefix argument, repeat last command, preserving toggled options, on
10262 current buffer.  If the active buffer hasn't changed and subtree export was
10263 activated, the command will affect that same subtree.
10264 @end table
10265 @c @end quotation
10267 Normally the entire buffer is exported, but if there is an active region
10268 only that part of the buffer will be exported.
10270 Export options can also, among other things, affect the scope of export
10271 process.  They are toggled from the dispatcher with appropriate key
10272 combinations:
10274 @table @kbd
10275 @item C-a
10276 @vindex org-export-async-init-file
10277 @vindex org-export-run-in-background
10278 Toggles asynchronous export.  The export happens in an external Emacs
10279 process@footnote{Configure @var{org-export-async-init-file} to properly set
10280 it up.}.
10282 In this case, no output is displayed automatically.  It is stored in a list
10283 called the export stack, and can be viewed from there.  The stack can be
10284 reached by calling the dispatcher with a double @kbd{C-u} prefix argument,
10285 or with @kbd{&} key from the dispatcher.
10287 To make this behaviour the default, customize the variable successfully
10288 @var{org-export-run-in-background}.
10290 @item C-b
10291 Toggles body-only export.  Its effect, if any, depends on the back-end
10292 used.  Its purpose is to remove all meta-data from output and focus on the
10293 real contents.
10295 @item C-s
10296 @vindex org-export-initial-scope
10297 Toggles subtree export.  The top heading becomes the document title and is
10298 removed from the contents.
10300 You can change the default state of this option by setting
10301 @var{org-export-initial-scope}.
10303 @item C-v
10304 Toggles visible-only export.  Only export the text that is currently
10305 visible, i.e. not hidden by outline visibility in the buffer.
10307 @end table
10309 @vindex org-export-copy-to-kill-ring
10310 Unless it happened asynchronously, a successful export process usually
10311 stores its output into the kill-ring.  You can configure
10312 @var{org-export-copy-to-kill-ring} in order to change this behaviour.
10314 @node Export formats, Export settings, The Export Dispatcher, Exporting
10315 @section Export formats
10316 @cindex Export, formats
10318 Libraries translating an Org buffer into a foreign format are called export
10319 back-ends.  An export format is not available until the proper back-end has
10320 been loaded.
10322 @vindex org-export-backends
10323 By default, the following four back-ends are ready to use: @code{ascii},
10324 @code{html}, @code{icalendar} and @code{latex}.  It is possible to add more
10325 (or remove some) by customizing @var{org-export-backends}.
10327 Core back-ends include:
10329 @itemize
10330 @item ascii (ASCII format)
10331 @item beamer (@LaTeX{} Beamer format)
10332 @item html (HTML format)
10333 @item icalendar (iCalendar format)
10334 @item latex (@LaTeX{} format)
10335 @item man (Man page format)
10336 @item md (Markdown format)
10337 @item odt (OpenDocument Text format)
10338 @item texinfo (Texinfo format)
10339 @end itemize
10341 More are available from the @code{contrib/} directory available from the
10342 distribution archives or from GNU/Org ELPA.
10344 @node Export settings, ASCII/Latin-1/UTF-8 export, Export formats, Exporting
10345 @section Export settings
10346 @cindex Export, settings
10348 Export output can be controlled through a number of export options.  These
10349 can be set globally with variables, and overridden on a per-buffer basis
10350 with keywords.  Such keywords may be put anywhere in the file.  For
10351 individual lines, a good way to make sure the keyword is correct is to type
10352 @code{#+} and then use @kbd{M-<TAB>} completion.
10354 Here is an exhaustive list of such keywords along with the equivalent
10355 global variable.  Only options available for every back-end are discussed
10356 in this section.
10358 @table @samp
10359 @item AUTHOR
10360 @vindex user-full-name
10361 the author (@var{user-full-name}).
10363 @item CREATOR
10364 @vindex org-export-creator-string
10365 entity responsible for output generation (@var{org-export-creator-string}).
10367 @item DATE
10368 @vindex org-export-date-timestamp-format
10369 A date or a time-stamp@footnote{The variable
10370 @var{org-export-date-timestamp-format} defines how this time-stamp will be
10371 exported.}.
10373 @item DESCRIPTION
10374 the page description, e.g., for the XHTML meta tag.
10376 @item EMAIL
10377 @vindex user-mail-address
10378 email address (@var{user-mail-address}).
10380 @item EXCLUDE_TAGS
10381 Tags that exclude a tree from export
10383 @item KEYWORDS
10384 keywords defining the contents, e.g., for the XHTML meta tag.
10386 @item LANGUAGE
10387 @vindex org-export-default-language
10388 language used for translation of some strings
10389 (@var{org-export-default-language}).
10391 @item SELECT_TAGS
10392 @vindex org-export-select-tags
10393 Tags that select a tree for export (@var{org-export-select-tags}).
10395 @item TITLE
10396 the title to be shown (otherwise derived from buffer's name).
10397 @end table
10399 Additionally, the @code{OPTIONS} keyword is a compact@footnote{If you want
10400 to configure many options this way, you can use several @code{#+OPTIONS}
10401 lines.} form to specify export settings.  Here you can:
10403 @table @code
10404 @item ':
10405 @vindex org-export-with-smart-quotes
10406 toggle smart quotes (@var{org-export-with-smart-quotes}).
10408 @item *:
10409 toggle emphasized text (@var{org-export-with-emphasize}).
10411 @item -:
10412 @vindex org-export-with-special-strings
10413 toggle conversion of special strings
10414 (@var{org-export-with-special-strings}).
10416 @item ::
10417 @vindex org-export-with-fixed-width
10418 toggle fixed-width sections
10419 (@var{org-export-with-fixed-width}).
10421 @item <:
10422 @vindex org-export-with-timestamps
10423 toggle inclusion of any time/date stamps like DEADLINES
10424 (@var{org-export-with-timestamps}).
10426 @item :
10427 @vindex org-export-preserve-breaks
10428 toggle line-break-preservation (@var{org-export-preserve-breaks}).
10430 @item ^:
10431 @vindex org-export-with-sub-superscripts
10432 toggle @TeX{}-like syntax for sub- and superscripts.  If you write "^:@{@}",
10433 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10434 it is (@var{org-export-with-sub-superscripts}).
10436 @item arch:
10437 @vindex org-export-with-archived-trees
10438 configure export of archived trees.  Can be set to @code{headline} to only
10439 process the headline, skipping its contents
10440 (@var{org-export-with-archived-trees}).
10442 @item author:
10443 @vindex org-export-with-author
10444 toggle inclusion of author name into exported file
10445 (@var{org-export-with-author}).
10447 @item c:
10448 @vindex org-export-with-clocks
10449 toggle inclusion of CLOCK keywords (@var{org-export-with-clocks}).
10451 @item creator:
10452 @vindex org-export-with-creator
10453 configure inclusion of creator info into exported file.  It may be set to
10454 @code{comment} (@var{org-export-with-creator}).
10456 @item d:
10457 @vindex org-export-with-drawers
10458 toggle inclusion of drawers, or list drawers to include
10459 (@var{org-export-with-drawers}).
10461 @item e:
10462 @vindex org-export-with-entities
10463 toggle inclusion of entities (@var{org-export-with-entities}).
10465 @item email:
10466 @vindex org-export-with-email
10467 toggle inclusion of author email into exported file
10468 (@var{org-export-with-email}).
10470 @item f:
10471 @vindex org-export-with-footnotes
10472 toggle footnotes (@var{org-export-with-footnotes}).
10474 @item H:
10475 @vindex org-export-headline-levels
10476 set the number of headline levels for export
10477 (@var{org-export-headline-levels}).
10479 @item inline:
10480 @vindex org-export-with-inlinetasks
10481 toggle inclusion of inlinetasks (@var{org-export-with-inlinetasks}).
10483 @item num:
10484 @vindex org-export-with-section-numbers
10485 toggle section-numbers (@var{org-export-with-section-numbers}).
10487 @item p:
10488 @vindex org-export-with-planning
10489 toggle export of planning information (e.g. deadlines)
10490 (@var{org-export-with-planning}).
10492 @item pri:
10493 @vindex org-export-with-priority
10494 toggle priority cookies (@var{org-export-with-priority}).
10496 @item stat:
10497 @vindex org-export-with-statistics-cookies
10498 toggle inclusion of statistics cookies
10499 (@var{org-export-with-statistics-cookies}).
10501 @item tags:
10502 @vindex org-export-with-tags
10503 toggle inclusion of tags, may also be @code{not-in-toc}
10504 (@var{org-export-with-tags}).
10506 @item tasks:
10507 @vindex org-export-with-tasks
10508 toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10509 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10510 (@var{org-export-with-tasks}).
10512 @item tex:
10513 @vindex org-export-with-latex
10514 configure export of @LaTeX{} fragments and environments.  It may be set to
10515 @code{verbatim} (@var{org-export-with-latex}).
10517 @item timestamp:
10518 @vindex org-export-time-stamp-file
10519 toggle inclusion creation time into exported file
10520 (@var{org-export-time-stamp-file}).
10522 @item toc:
10523 @vindex org-export-with-toc
10524 toggle table of contents, or set level limit (@var{org-export-with-toc}).
10526 @item todo:
10527 @vindex org-export-with-todo-keywords
10528 toggle inclusion of TODO keywords into exported text
10529 (@var{org-export-with-todo-keywords}).
10531 @item |:
10532 @vindex org-export-with-tables
10533 toggle tables (@var{org-export-with-tables}).
10535 @end table
10537 A more general mechanism is also provided.  Indeed, Emacs variables can
10538 become buffer-local during export by using the BIND keyword.  Its syntax is
10539 @samp{#+BIND: variable value}.  This is particularly useful for in-buffer
10540 settings that cannot be changed using specific keywords.
10542 You can place commonly-used export settings in a separate file which can be
10543 included using @samp{#+SETUPFILE: filename} syntax.
10545 These settings affect all buffer's export processes.  Though, it is
10546 possible to override them locally when exporting only a subtree.  This is
10547 done by adding a headline property named after the keyword with the
10548 @samp{EXPORT_} prefix.  For example, @samp{DATE} and @samp{OPTIONS}
10549 keywords become, respectively @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10550 properties.  Subtree export also supports the self-explicit
10551 @samp{EXPORT_FILE_NAME} property@footnote{There is no buffer-wide
10552 equivalent for this property.  The file name in this case is derived from
10553 the file associated to the buffer, if possible, or asked to the user
10554 otherwise.}.
10556 @node ASCII/Latin-1/UTF-8 export, HTML export, Export settings, Exporting
10557 @section ASCII/Latin-1/UTF-8 export
10558 @cindex ASCII export
10559 @cindex Latin-1 export
10560 @cindex UTF-8 export
10562 ASCII export produces a simple and very readable version of an Org mode
10563 file, containing only plain ASCII@.  Latin-1 and UTF-8 export augment the file
10564 with special characters and symbols available in these encodings.
10566 @cindex region, active
10567 @cindex active region
10568 @cindex transient-mark-mode
10569 @table @kbd
10570 @orgcmd{C-c C-e t a,org-ascii-export-to-ascii}
10571 @cindex property, EXPORT_FILE_NAME
10572 Export as an ASCII file.  For an Org file, @file{myfile.org}, the ASCII file
10573 will be @file{myfile.txt}.  The file will be overwritten without
10574 warning.  If there is an active region@footnote{This requires
10575 @code{transient-mark-mode} be turned on.}, only the region will be
10576 exported.  If the selected region is a single tree@footnote{To select the
10577 current subtree, use @kbd{C-c @@}.}, the tree head will
10578 become the document title.  If the tree head entry has or inherits an
10579 @code{EXPORT_FILE_NAME} property, that name will be used for the
10580 export.
10581 @orgcmd{C-c C-e t A,org-ascii-export-as-ascii}
10582 Export to a temporary buffer.  Do not create a file.
10583 @item C-c C-e C-v t a/t A
10584 Export only the visible part of the document.
10585 @end table
10587 @c FIXME Exporting sublevels
10588 @c @cindex headline levels, for exporting
10589 @c In the exported version, the first 3 outline levels will become
10590 @c headlines, defining a general document structure.  Additional levels
10591 @c will be exported as itemized lists.  If you want that transition to occur
10592 @c at a different level, specify it with a prefix argument.  For example,
10594 @c @example
10595 @c @kbd{C-1 C-c C-e a}
10596 @c @end example
10598 @c @noindent
10599 @c creates only top level headlines and exports the rest as items.  When
10600 @c headlines are converted to items, the indentation of the text following
10601 @c the headline is changed to fit nicely under the item.  This is done with
10602 @c the assumption that the first body line indicates the base indentation of
10603 @c the body text.  Any indentation larger than this is adjusted to preserve
10604 @c the layout relative to the first line.  Should there be lines with less
10605 @c indentation than the first one, these are left alone.
10607 @vindex org-ascii-links-to-notes
10608 Links will be exported in a footnote-like style, with the descriptive part in
10609 the text and the link in a note before the next heading.  See the variable
10610 @code{org-ascii-links-to-notes} for details and other options.
10612 @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
10613 @section HTML export
10614 @cindex HTML export
10616 Org mode contains a HTML (XHTML 1.0 strict) exporter with extensive
10617 HTML formatting, in ways similar to John Gruber's @emph{markdown}
10618 language, but with additional support for tables.
10620 @menu
10621 * HTML Export commands::        How to invoke HTML export
10622 * HTML preamble and postamble::  How to insert a preamble and a postamble
10623 * Quoting HTML tags::           Using direct HTML in Org mode
10624 * Links in HTML export::        How links will be interpreted and formatted
10625 * Tables in HTML export::       How to modify the formatting of tables
10626 * Images in HTML export::       How to insert figures into HTML output
10627 * Math formatting in HTML export::  Beautiful math also on the web
10628 * Text areas in HTML export::   An alternative way to show an example
10629 * CSS support::                 Changing the appearance of the output
10630 * JavaScript support::          Info and Folding in a web browser
10631 @end menu
10633 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
10634 @subsection HTML export commands
10636 @cindex region, active
10637 @cindex active region
10638 @cindex transient-mark-mode
10639 @table @kbd
10640 @orgcmd{C-c C-e h h,org-html-export-to-html}
10641 @cindex property, EXPORT_FILE_NAME
10642 Export as a HTML file.  For an Org file @file{myfile.org},
10643 the HTML file will be @file{myfile.html}.  The file will be overwritten
10644 without warning.  If there is an active region@footnote{This requires
10645 @code{transient-mark-mode} be turned on.}, only the region will be
10646 exported.  If the selected region is a single tree@footnote{To select the
10647 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10648 title.  If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10649 property, that name will be used for the export.
10650 @kbd{C-c C-e h o}
10651 Export as a HTML file and immediately open it with a browser.
10652 @orgcmd{C-c C-e h H,org-html-export-as-html}
10653 Export to a temporary buffer.  Do not create a file.
10654 @item C-c C-e C-v h H/h h/h o
10655 Export only the visible part of the document.
10656 @end table
10658 @c FIXME Exporting sublevels
10659 @c @cindex headline levels, for exporting
10660 @c In the exported version, the first 3 outline levels will become headlines,
10661 @c defining a general document structure.  Additional levels will be exported as
10662 @c itemized lists.  If you want that transition to occur at a different level,
10663 @c specify it with a numeric prefix argument.  For example,
10665 @c @example
10666 @c @kbd{C-2 C-c C-e b}
10667 @c @end example
10669 @c @noindent
10670 @c creates two levels of headings and does the rest as items.
10672 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
10673 @subsection HTML preamble and postamble
10674 @vindex org-html-preamble
10675 @vindex org-html-postamble
10676 @vindex org-html-preamble-format
10677 @vindex org-html-postamble-format
10678 @vindex org-html-validation-link
10679 @vindex org-export-author-info
10680 @vindex org-export-email-info
10681 @vindex org-export-creator-info
10682 @vindex org-export-time-stamp-file
10684 The HTML exporter lets you define a preamble and a postamble.
10686 The default value for @code{org-html-preamble} is @code{t}, which means
10687 that the preamble is inserted depending on the relevant format string in
10688 @code{org-html-preamble-format}.
10690 Setting @code{org-html-preamble} to a string will override the default format
10691 string.  If you set it to a function, it will insert the output of the
10692 function, which must be a string.  Setting to @code{nil} will not insert any
10693 preamble.
10695 The default value for @code{org-html-postamble} is @code{'auto}, which means
10696 that the HTML exporter will look for information about the author, the email,
10697 the creator and the date, and build the postamble from these values.  Setting
10698 @code{org-html-postamble} to @code{t} will insert the postamble from the
10699 relevant format string found in @code{org-html-postamble-format}.  Setting it
10700 to @code{nil} will not insert any postamble.
10702 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
10703 @subsection Quoting HTML tags
10705 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
10706 @samp{&gt;} in HTML export.  If you want to include simple HTML tags
10707 which should be interpreted as such, mark them with @samp{@@} as in
10708 @samp{@@<b>bold text@@</b>}.  Note that this really works only for
10709 simple tags.  For more extensive HTML that should be copied verbatim to
10710 the exported file use either
10712 @cindex #+HTML
10713 @cindex #+BEGIN_HTML
10714 @example
10715 #+HTML: Literal HTML code for export
10716 @end example
10718 @noindent or
10719 @cindex #+BEGIN_HTML
10721 @example
10722 #+BEGIN_HTML
10723 All lines between these markers are exported literally
10724 #+END_HTML
10725 @end example
10728 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
10729 @subsection Links in HTML export
10731 @cindex links, in HTML export
10732 @cindex internal links, in HTML export
10733 @cindex external links, in HTML export
10734 Internal links (@pxref{Internal links}) will continue to work in HTML@.  This
10735 includes automatic links created by radio targets (@pxref{Radio
10736 targets}).  Links to external files will still work if the target file is on
10737 the same @i{relative} path as the published Org file.  Links to other
10738 @file{.org} files will be translated into HTML links under the assumption
10739 that a HTML version also exists of the linked file, at the same relative
10740 path.  @samp{id:} links can then be used to jump to specific entries across
10741 files.  For information related to linking files while publishing them to a
10742 publishing directory see @ref{Publishing links}.
10744 If you want to specify attributes for links, you can do so using a special
10745 @code{#+ATTR_HTML} line to define attributes that will be added to the
10746 @code{<a>} or @code{<img>} tags.  Here is an example that sets @code{title}
10747 and @code{style} attributes for a link:
10749 @cindex #+ATTR_HTML
10750 @example
10751 #+ATTR_HTML: :title The Org mode homepage :style color:red;
10752 [[http://orgmode.org]]
10753 @end example
10755 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
10756 @subsection Tables
10757 @cindex tables, in HTML
10758 @vindex org-html-table-default-attributes
10760 Org mode tables are exported to HTML using the table attributes defined in
10761 @code{org-html-table-default-attributes}.  The default setting makes tables
10762 without cell borders and frame.  If you would like to change this for
10763 individual tables, place something like the following before the table:
10765 @cindex #+CAPTION
10766 @cindex #+ATTR_HTML
10767 @example
10768 #+CAPTION: This is a table with lines around and between cells
10769 #+ATTR_HTML: :border 2 :rules all :frame border
10770 @end example
10772 @vindex org-html-table-row-tags
10773 You can also modify the default tags used for each row by setting
10774 @var{org-html-table-row-tags}.  See the docstring for an example on
10775 how to use this option.
10777 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
10778 @subsection Images in HTML export
10780 @cindex images, inline in HTML
10781 @cindex inlining images in HTML
10782 @vindex org-html-inline-images
10783 HTML export can inline images given as links in the Org file, and
10784 it can make an image the clickable part of a link.  By
10785 default@footnote{But see the variable
10786 @code{org-html-inline-images}.}, images are inlined if a link does
10787 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
10788 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
10789 @samp{the image} that points to the image.  If the description part
10790 itself is a @code{file:} link or a @code{http:} URL pointing to an
10791 image, this image will be inlined and activated so that clicking on the
10792 image will activate the link.  For example, to include a thumbnail that
10793 will link to a high resolution version of the image, you could use:
10795 @example
10796 [[file:highres.jpg][file:thumb.jpg]]
10797 @end example
10799 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
10800 In the example below we specify the @code{alt} and @code{title} attributes to
10801 support text viewers and accessibility, and align it to the right.
10803 @cindex #+CAPTION
10804 @cindex #+ATTR_HTML
10805 @example
10806 #+CAPTION: A black cat stalking a spider
10807 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
10808 [[./img/a.jpg]]
10809 @end example
10811 @noindent
10812 You could use @code{http} addresses just as well.
10814 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
10815 @subsection Math formatting in HTML export
10816 @cindex MathJax
10817 @cindex dvipng
10819 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
10820 different ways on HTML pages.  The default is to use the
10821 @uref{http://www.mathjax.org, MathJax system} which should work out of the
10822 box with Org mode installation because @code{http://orgmode.org} serves
10823 @file{MathJax} for Org mode users for small applications and for testing
10824 purposes.  @b{If you plan to use this regularly or on pages with significant
10825 page views, you should install@footnote{Installation instructions can be
10826 found on the MathJax website, see
10827 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
10828 your own server in order to limit the load of our server.}  To configure
10829 @file{MathJax}, use the variable @code{org-html-mathjax-options} or
10830 insert something like the following into the buffer:
10832 @example
10833 #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
10834 @end example
10836 @noindent See the docstring of the variable
10837 @code{org-html-mathjax-options} for the meaning of the parameters in
10838 this line.
10840 If you prefer, you can also request that @LaTeX{} fragments are processed
10841 into small images that will be inserted into the browser page.  Before the
10842 availability of MathJax, this was the default method for Org files.  This
10843 method requires that the @file{dvipng} program is available on your system.
10844 You can still get this processing with
10846 @example
10847 #+OPTIONS: LaTeX:dvipng
10848 @end example
10850 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
10851 @subsection Text areas in HTML export
10853 @cindex text areas, in HTML
10854 An alternative way to publish literal code examples in HTML is to use text
10855 areas, where the example can even be edited before pasting it into an
10856 application.  It is triggered by a @code{-t} switch at an @code{example} or
10857 @code{src} block.  Using this switch disables any options for syntax and
10858 label highlighting, and line numbering, which may be present.  You may also
10859 use @code{-h} and @code{-w} switches to specify the height and width of the
10860 text area, which default to the number of lines in the example, and 80,
10861 respectively.  For example
10863 @example
10864 #+BEGIN_EXAMPLE -t -w 40
10865   (defun org-xor (a b)
10866      "Exclusive or."
10867      (if a (not b) b))
10868 #+END_EXAMPLE
10869 @end example
10872 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
10873 @subsection CSS support
10874 @cindex CSS, for HTML export
10875 @cindex HTML export, CSS
10877 @vindex org-html-todo-kwd-class-prefix
10878 @vindex org-html-tag-class-prefix
10879 You can also give style information for the exported file.  The HTML exporter
10880 assigns the following special CSS classes@footnote{If the classes on TODO
10881 keywords and tags lead to conflicts, use the variables
10882 @code{org-html-todo-kwd-class-prefix} and
10883 @code{org-html-tag-class-prefix} to make them unique.} to appropriate
10884 parts of the document---your style specifications may change these, in
10885 addition to any of the standard classes like for headlines, tables, etc.
10886 @example
10887 p.author            @r{author information, including email}
10888 p.date              @r{publishing date}
10889 p.creator           @r{creator info, about org mode version}
10890 .title              @r{document title}
10891 .todo               @r{TODO keywords, all not-done states}
10892 .done               @r{the DONE keywords, all states that count as done}
10893 .WAITING            @r{each TODO keyword also uses a class named after itself}
10894 .timestamp          @r{timestamp}
10895 .timestamp-kwd      @r{keyword associated with a timestamp, like SCHEDULED}
10896 .timestamp-wrapper  @r{span around keyword plus timestamp}
10897 .tag                @r{tag in a headline}
10898 ._HOME              @r{each tag uses itself as a class, "@@" replaced by "_"}
10899 .target             @r{target for links}
10900 .linenr             @r{the line number in a code example}
10901 .code-highlighted   @r{for highlighting referenced code lines}
10902 div.outline-N       @r{div for outline level N (headline plus text))}
10903 div.outline-text-N  @r{extra div for text at outline level N}
10904 .section-number-N   @r{section number in headlines, different for each level}
10905 div.figure          @r{how to format an inlined image}
10906 pre.src             @r{formatted source code}
10907 pre.example         @r{normal example}
10908 p.verse             @r{verse paragraph}
10909 div.footnotes       @r{footnote section headline}
10910 p.footnote          @r{footnote definition paragraph, containing a footnote}
10911 .footref            @r{a footnote reference number (always a <sup>)}
10912 .footnum            @r{footnote number in footnote definition (always <sup>)}
10913 @end example
10915 @vindex org-html-style-default
10916 @vindex org-html-head-include-default-style
10917 @vindex org-html-head
10918 @vindex org-html-head-extra
10919 @cindex #+HTML_INCLUDE_STYLE
10920 Each exported file contains a compact default style that defines these
10921 classes in a basic way@footnote{This style is defined in the constant
10922 @code{org-html-style-default}, which you should not modify.  To turn
10923 inclusion of these defaults off, customize
10924 @code{org-html-head-include-default-style} or set @code{#+HTML_INCLUDE_STYLE}
10925 to nil on a per-file basis.}.  You may overwrite these settings, or add to
10926 them by using the variables @code{org-html-head} and
10927 @code{org-html-head-extra}.  You can override the global values of these
10928 variables for each file by using these keywords:
10930 @cindex #+HTML_HEAD
10931 @cindex #+HTML_HEAD_EXTRA
10932 @example
10933 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
10934 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
10935 @end example
10937 @noindent
10938 For longer style definitions, you can use several such lines.  You could also
10939 directly write a @code{<style>} @code{</style>} section in this way, without
10940 referring to an external file.
10942 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
10943 property to assign a class to the tree.  In order to specify CSS styles for a
10944 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
10945 property.
10947 @c FIXME: More about header and footer styles
10948 @c FIXME: Talk about links and targets.
10950 @node JavaScript support,  , CSS support, HTML export
10951 @subsection JavaScript supported display of web pages
10953 @cindex Rose, Sebastian
10954 Sebastian Rose has written a JavaScript program especially designed to
10955 enhance the web viewing experience of HTML files created with Org.  This
10956 program allows you to view large files in two different ways.  The first one
10957 is an @emph{Info}-like mode where each section is displayed separately and
10958 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
10959 as well, press @kbd{?} for an overview of the available keys).  The second
10960 view type is a @emph{folding} view much like Org provides inside Emacs.  The
10961 script is available at @url{http://orgmode.org/org-info.js} and you can find
10962 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
10963 We host the script at our site, but if you use it a lot, you might not want
10964 to be dependent on @url{http://orgmode.org} and prefer to install a local
10965 copy on your own web server.
10967 All it then takes to use this program is adding a single line to the Org
10968 file:
10970 @cindex #+INFOJS_OPT
10971 @example
10972 #+INFOJS_OPT: view:info toc:nil
10973 @end example
10975 @noindent
10976 If this line is found, the HTML header will automatically contain the code
10977 needed to invoke the script.  Using the line above, you can set the following
10978 viewing options:
10980 @example
10981 path:    @r{The path to the script.  The default is to grab the script from}
10982          @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
10983          @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
10984 view:    @r{Initial view when the website is first shown.  Possible values are:}
10985          info      @r{Info-like interface with one section per page.}
10986          overview  @r{Folding interface, initially showing only top-level.}
10987          content   @r{Folding interface, starting with all headlines visible.}
10988          showall   @r{Folding interface, all headlines and text visible.}
10989 sdepth:  @r{Maximum headline level that will still become an independent}
10990          @r{section for info and folding modes.  The default is taken from}
10991          @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
10992          @r{If this is smaller than in @code{org-export-headline-levels}, each}
10993          @r{info/folding section can still contain child headlines.}
10994 toc:     @r{Should the table of contents @emph{initially} be visible?}
10995          @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
10996 tdepth:  @r{The depth of the table of contents.  The defaults are taken from}
10997          @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
10998 ftoc:    @r{Does the CSS of the page specify a fixed position for the "toc"?}
10999          @r{If yes, the toc will never be displayed as a section.}
11000 ltoc:    @r{Should there be short contents (children) in each section?}
11001          @r{Make this @code{above} if the section should be above initial text.}
11002 mouse:   @r{Headings are highlighted when the mouse is over them.  Should be}
11003          @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11004 buttons: @r{Should view-toggle buttons be everywhere?  When @code{nil} (the}
11005          @r{default), only one such button will be present.}
11006 @end example
11007 @noindent
11008 @vindex org-html-infojs-options
11009 @vindex org-html-use-infojs
11010 You can choose default values for these options by customizing the variable
11011 @code{org-html-infojs-options}.  If you always want to apply the script to your
11012 pages, configure the variable @code{org-html-use-infojs}.
11014 @node @LaTeX{} and PDF export, OpenDocument Text export, HTML export, Exporting
11015 @section @LaTeX{} and PDF export
11016 @cindex @LaTeX{} export
11017 @cindex PDF export
11019 Org mode contains a @LaTeX{} exporter.  With further processing@footnote{The
11020 default @LaTeX{} output is designed for processing with @code{pdftex} or
11021 @LaTeX{}.  It includes packages that are not compatible with @code{xetex} and
11022 possibly @code{luatex}.  See the variables
11023 @code{org-latex-default-packages-alist} and
11024 @code{org-latex-packages-alist}.}, this back-end is also used to produce PDF
11025 output.  Since the @LaTeX{} output uses @file{hyperref} to implement links
11026 and cross references, the PDF output file will be fully linked.
11028 As is @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11029 will not be started if two contiguous syntactical elements are not separated
11030 by an empty line.
11032 This back-end also offers enhanced support for footnotes.  Thus, it handles
11033 nested footnotes, footnotes in tables and footnotes in items' description.
11035 @menu
11036 * @LaTeX{}/PDF export commands::
11037 * Header and sectioning::       Setting up the export file structure
11038 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
11039 * @LaTeX{} specific attributes::   Controlling @LaTeX{} output
11040 * Beamer class export::         Turning the file into a presentation
11041 @end menu
11043 @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
11044 @subsection @LaTeX{} export commands
11046 @cindex region, active
11047 @cindex active region
11048 @cindex transient-mark-mode
11049 @table @kbd
11050 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11051 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
11052 file will be @file{myfile.tex}.  The file will be overwritten without
11053 warning.
11054 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11055 Export to a temporary buffer.  Do not create a file.
11056 @item C-c C-e C-v l/L
11057 Export only the visible part of the document.
11058 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11059 Export as @LaTeX{} and then process to PDF.
11060 @item C-c C-e l o
11061 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11062 @end table
11064 In the exported version, the first three outline levels will become
11065 headlines, defining a general document structure.  Additional levels will be
11066 exported as description lists.  The transition can also occur at a different
11067 level (@pxref{Export settings}).
11069 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
11070 @subsection Header and sectioning structure
11071 @cindex @LaTeX{} class
11072 @cindex @LaTeX{} sectioning structure
11073 @cindex @LaTeX{} header
11074 @cindex header, for @LaTeX{} files
11075 @cindex sectioning structure, for @LaTeX{} export
11077 By default, the @LaTeX{} output uses the class @code{article}.
11079 @vindex org-latex-default-class
11080 @vindex org-latex-classes
11081 @vindex org-latex-default-packages-alist
11082 @vindex org-latex-packages-alist
11083 You can change this globally by setting a different value for
11084 @code{org-latex-default-class} or locally by adding an option like
11085 @code{#+LATEX_CLASS: myclass} in your file, or with
11086 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11087 containing only this (sub)tree.  The class must be listed in
11088 @code{org-latex-classes}.  This variable defines a header template for each
11089 class@footnote{Into which the values of
11090 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
11091 are spliced.}, and allows you to define the sectioning structure for each
11092 class.  You can also define your own classes there.
11094 @cindex #+LATEX_CLASS
11095 @cindex #+LATEX_CLASS_OPTIONS
11096 @cindex property, EXPORT_LATEX_CLASS
11097 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
11098 @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
11099 property can specify the options for the @code{\documentclass} macro.  These
11100 options have to be provided, as expected by @LaTeX{}, within square brackets.
11102 @cindex #+LATEX_HEADER
11103 @cindex #+LATEX_HEADER_EXTRA
11104 You can also use LATEX_HEADER and LATEX_HEADER_EXTRA keywords in order to add
11105 lines to the header.  See the docstring of @code{org-latex-classes} for more
11106 information.
11108 An example is shown below.
11110 @example
11111 #+LATEX_CLASS: article
11112 #+LATEX_CLASS_OPTIONS: [a4paper]
11113 #+LATEX_HEADER: \usepackage@{xyz@}
11115 * Headline 1
11116   some text
11117 @end example
11119 @node Quoting @LaTeX{} code, @LaTeX{} specific attributes, Header and sectioning, @LaTeX{} and PDF export
11120 @subsection Quoting @LaTeX{} code
11122 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11123 inserted into the @LaTeX{} file.  Furthermore, you can add special code that
11124 should only be present in @LaTeX{} export with the following constructs:
11126 @cindex #+LATEX
11127 @cindex #+BEGIN_LATEX
11128 @example
11129 Code within @@@@latex:some code@@@@ a paragraph.
11130 @end example
11132 @noindent or
11134 @example
11135 #+LATEX: Literal @LaTeX{} code for export
11136 @end example
11138 @noindent or, eventually,
11140 @example
11141 #+BEGIN_LATEX
11142 All lines between these markers are exported literally
11143 #+END_LATEX
11144 @end example
11147 @node @LaTeX{} specific attributes, Beamer class export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
11148 @subsection @LaTeX{} specific attributes
11149 @cindex #+ATTR_LATEX
11151 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line.  They
11152 affect tables, images, plain lists, special blocks and source blocks.
11154 @subsubheading Tables in @LaTeX{} export
11155 @cindex tables, in @LaTeX{} export
11157 For @LaTeX{} export of a table, you can specify a label and a caption
11158 (@pxref{Images and tables}).  You can also use attributes to control table
11159 layout and contents.  Valid properties are:
11161 @table @code
11162 @item :mode
11163 @vindex org-latex-default-table-mode
11164 Nature of table's contents.  It can be set to @code{table}, @code{math},
11165 @code{inline-math} or @code{verbatim}.  In particular, when in @code{math} or
11166 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11167 ignored and the table will be wrapped in a math environment.  Also,
11168 contiguous tables sharing the same math mode will be wrapped within the same
11169 environment.  Default mode is determined in
11170 @var{org-latex-default-table-mode}.
11171 @item :environment
11172 @vindex org-latex-default-table-environment
11173 Environment used for the table.  It can be to any @LaTeX{} table
11174 environment, like @code{tabularx}, @code{longtable}, @code{array},
11175 @code{tabu}, @code{bmatrix}@enddots{}  It defaults to
11176 @var{org-latex-default-table-environment} value.
11177 @item :float
11178 Float environment for the table.  Possible values are @code{sidewaystable},
11179 @code{multicolumn} and @code{table}.  If unspecified, a table with a caption
11180 will have a @code{table} environment.  Moreover, @code{:placement} attribute
11181 can specify the positioning of the float.
11182 @item :align
11183 @itemx :font
11184 @itemx :width
11185 set, respectively, the alignment string of the table, its font size and its
11186 width.  They only apply on regular tables.
11187 @item :spread
11188 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11189 only takes effect when used in conjunction with the @code{:width} attribute.
11190 When @code{:spread} is non-nil, the table will be spread or shrunk by the
11191 value of @code{:width}.
11192 @item :booktabs
11193 @itemx :center
11194 @itemx :rmlines
11195 @vindex org-latex-tables-booktabs
11196 @vindex org-latex-tables-centered
11197 They toggle, respectively, @code{booktabs} usage (assuming the package is
11198 properly loaded), table centering and removal of every horizontal rule but
11199 the first one (in a "table.el" table only).  In particular,
11200 @var{org-latex-tables-booktabs} (resp.@: @var{org-latex-tables-centered})
11201 activates the first (resp.@: second) attribute globally.
11202 @item :math-prefix
11203 @itemx :math-suffix
11204 @itemx :math-arguments
11205 string which will be inserted, respectively, before the table within the math
11206 environment, after the table within the math environment, and between the
11207 macro name and the contents of the table.  The latter attribute is necessary
11208 to matrix macros that require more than one argument (e.g.,
11209 @code{qbordermatrix}).
11210 @end table
11212 Thus, attributes can be used in a wide array of situations, like writing
11213 a table that will span over multiple pages, or a matrix product:
11215 @example
11216 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11217 | ..... | ..... |
11218 | ..... | ..... |
11220 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11221 | a | b |
11222 | c | d |
11223 #+ATTR_LATEX: :mode math :environment bmatrix
11224 | 1 | 2 |
11225 | 3 | 4 |
11226 @end example
11228 @subsubheading Images in @LaTeX{} export
11229 @cindex images, inline in @LaTeX{}
11230 @cindex inlining images in @LaTeX{}
11232 Images that are linked to without a description part in the link, like
11233 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11234 output file resulting from @LaTeX{} processing.  Org will use an
11235 @code{\includegraphics} macro to insert the image@footnote{In the case of
11236 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11237 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
11239 You can specify specify image width or height with, respectively,
11240 @code{:width} and @code{:height} attributes.  It is also possible to add any
11241 other option with the @code{:options} attribute, as shown in the following
11242 example:
11244 @example
11245 #+ATTR_LATEX: :width 5cm :options angle=90
11246 [[./img/sed-hr4049.pdf]]
11247 @end example
11249 If you have specified a caption as described in @ref{Images and tables}, the
11250 picture will be wrapped into a @code{figure} environment and thus become
11251 a floating element.  You can also ask Org to export an image as a float
11252 without specifying caption by setting the @code{:float} attribute.  You may
11253 also set it to:
11254 @itemize @minus
11255 @item
11256 @code{wrap}: if you would like to let text flow around the image.  It will
11257 make the figure occupy the left half of the page.
11258 @item
11259 @code{multicolumn}: if you wish to include an image which spans multiple
11260 columns in a page.  This will export the image wrapped in a @code{figure*}
11261 environment.
11262 @end itemize
11263 @noindent
11264 To modify the placement option of any floating environment, set the
11265 @code{placement} attribute.
11267 @example
11268 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
11269 [[./img/hst.png]]
11270 @end example
11272 Eventually, in the @code{:comment-include} attributes has a non-nil value,
11273 the code actually including the image will be commented out.
11275 @subsubheading Plain lists in @LaTeX{} export
11276 @cindex plain lists, in @LaTeX{} export
11278 Plain lists accept two optional attributes: @code{:environment} and
11279 @code{:options}.  The first one allows to use a non-standard environment
11280 (e.g., @samp{inparaenum}).  The second one allows to specify optional
11281 arguments for that environment (square brackets may be omitted).
11283 @example
11284 #+ATTR_LATEX: :environment compactitem :options $\circ$
11285 - you need ``paralist'' package to reproduce this example.
11286 @end example
11288 @subsubheading Source blocks in @LaTeX{} export
11289 @cindex source blocks, in @LaTeX{} export
11291 In addition to syntax defined in @ref{Literal examples}, names and captions
11292 (@pxref{Images and tables}), source blocks also accept @code{:long-listing}
11293 attribute, which prevents the block to become a float when non nil.
11295 @example
11296 #+ATTR_LATEX: :long-listing t
11297 #+BEGIN_SRC emacs-lisp
11298 Code that may not fit in a single page.
11299 #+END_SRC
11300 @end example
11302 @subsubheading Special blocks in @LaTeX{} export
11303 @cindex special blocks, in @LaTeX{} export
11305 In @LaTeX{} back-end, special blocks become environments of the same name.
11306 Value of @code{:options} attribute will be appended as-is to that
11307 environment's opening string.  For example:
11309 @example
11310 #+ATTR_LATEX: :options [Proof of important theorem]
11311 #+BEGIN_PROOF
11313 Therefore, any natural number above 4 is the sum of two primes.
11314 #+END_PROOF
11315 @end example
11317 @noindent
11318 becomes
11320 @example
11321 \begin@{proof@}[Proof of important theorem]
11323 Therefore, any natural number above 4 is the sum of two primes.
11324 \end@{proof@}
11325 @end example
11327 @node Beamer class export,  , @LaTeX{} specific attributes, @LaTeX{} and PDF export
11328 @subsection Beamer class export
11330 The @LaTeX{} class @file{beamer} allows production of high quality
11331 presentations using @LaTeX{} and pdf processing.  Org mode has special
11332 support for turning an Org mode file or tree into a @file{beamer}
11333 presentation.
11335 When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
11336 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
11337 @code{beamer}, a special export mode will turn the file or tree into a beamer
11338 presentation.  Any tree with not-too-deep level nesting should in principle be
11339 exportable as a beamer presentation.  By default, the top-level entries (or
11340 the first level below the selected subtree heading) will be turned into
11341 frames, and the outline structure below this level will become itemize lists.
11342 You can also configure the variable @code{org-beamer-frame-level} to a
11343 different level---then the hierarchy above frames will produce the sectioning
11344 structure of the presentation.
11346 A template for useful in-buffer settings or properties can be inserted into
11347 the buffer with @kbd{M-x org-beamer-insert-options-template}.  Among other
11348 things, this will install a column view format which is very handy for
11349 editing special properties used by beamer.
11351 You can influence the structure of the presentation using the following
11352 properties:
11354 @table @code
11355 @item BEAMER_env
11356 The environment that should be used to format this entry.  Valid environments
11357 are defined in the constant @code{org-beamer-environments-default}, and you
11358 can define more in @code{org-beamer-environments-extra}.  If this property is
11359 set, the entry will also get a @code{:B_environment:} tag to make this
11360 visible.  This tag has no semantic meaning, it is only a visual aid.
11361 @item BEAMER_envargs
11362 The beamer-special arguments that should be used for the environment, like
11363 @code{[t]} or @code{[<+->]} of @code{<2-3>}.  If the @code{BEAMER_col}
11364 property is also set, something like @code{C[t]} can be added here as well to
11365 set an options argument for the implied @code{columns} environment.
11366 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
11367 environment.
11368 @item BEAMER_col
11369 The width of a column that should start with this entry.  If this property is
11370 set, the entry will also get a @code{:BMCOL:} property to make this visible.
11371 Also this tag is only a visual aid.  When this is a plain number, it will be
11372 interpreted as a fraction of @code{\textwidth}.  Otherwise it will be assumed
11373 that you have specified the units, like @samp{3cm}.  The first such property
11374 in a frame will start a @code{columns} environment to surround the columns.
11375 This environment is closed when an entry has a @code{BEAMER_col} property
11376 with value 0 or 1, or automatically at the end of the frame.
11377 @item BEAMER_extra
11378 Additional commands that should be inserted after the environment has been
11379 opened.  For example, when creating a frame, this can be used to specify
11380 transitions.
11381 @end table
11383 Frames will automatically receive a @code{fragile} option if they contain
11384 source code that uses the verbatim environment.  Special @file{beamer}
11385 specific code can be inserted using @code{#+BEAMER:} and
11386 @code{#+BEGIN_BEAMER...#+END_BEAMER} constructs, similar to other export
11387 backends, but with the difference that @code{#+LaTeX:} stuff will be included
11388 in the presentation as well.
11390 Outline nodes with @code{BEAMER_env} property value @samp{note} or
11391 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
11392 into @code{\note@{...@}}.  The former will include the heading as part of the
11393 note text, the latter will ignore the heading of that node.  To simplify note
11394 generation, it is actually enough to mark the note with a @emph{tag} (either
11395 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
11396 @code{BEAMER_env} property.
11398 You can turn on a special minor mode @code{org-beamer-mode} for editing
11399 support with
11401 @example
11402 #+STARTUP: beamer
11403 @end example
11405 @table @kbd
11406 @orgcmd{C-c C-b,org-beamer-select-environment}
11407 In @code{org-beamer-mode}, this key offers fast selection of a beamer
11408 environment or the @code{BEAMER_col} property.
11409 @end table
11411 Column view provides a great way to set the environment of a node and other
11412 important parameters.  Make sure you are using a COLUMN format that is geared
11413 toward this special purpose.  The command @kbd{M-x
11414 org-insert-beamer-options-template} defines such a format.
11416 Here is a simple example Org document that is intended for beamer export.
11418 @smallexample
11419 #+LaTeX_CLASS: beamer
11420 #+TITLE: Example Presentation
11421 #+AUTHOR: Carsten Dominik
11422 #+LaTeX_CLASS_OPTIONS: [presentation]
11423 #+BEAMER_FRAME_LEVEL: 2
11424 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
11425 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
11427 * This is the first structural section
11429 ** Frame 1 \\ with a subtitle
11430 *** Thanks to Eric Fraga                                      :BMCOL:B_block:
11431     :PROPERTIES:
11432     :BEAMER_env: block
11433     :BEAMER_envargs: C[t]
11434     :BEAMER_col: 0.5
11435     :END:
11436     for the first viable beamer setup in Org
11437 *** Thanks to everyone else                                   :BMCOL:B_block:
11438     :PROPERTIES:
11439     :BEAMER_col: 0.5
11440     :BEAMER_env: block
11441     :BEAMER_envargs: <2->
11442     :END:
11443     for contributing to the discussion
11444 **** This will be formatted as a beamer note                  :B_note:
11445 ** Frame 2 \\ where we will not use columns
11446 *** Request                                                   :B_block:
11447     Please test this stuff!
11448     :PROPERTIES:
11449     :BEAMER_env: block
11450     :END:
11451 @end smallexample
11453 For more information, see the documentation on Worg.
11455 @c begin opendocument
11457 @node OpenDocument Text export, iCalendar export, @LaTeX{} and PDF export, Exporting
11458 @section OpenDocument Text export
11459 @cindex ODT
11460 @cindex OpenDocument
11461 @cindex export, OpenDocument
11462 @cindex LibreOffice
11463 @cindex org-odt.el
11464 @cindex org-modules
11466 Org Mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
11467 (ODT) format using the @file{org-odt.el} module.  Documents created
11468 by this exporter use the @cite{OpenDocument-v1.2
11469 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11470 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
11471 are compatible with LibreOffice 3.4.
11473 @menu
11474 * Pre-requisites for ODT export::  What packages ODT exporter relies on
11475 * ODT export commands::         How to invoke ODT export
11476 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
11477 * Applying custom styles::      How to apply custom styles to the output
11478 * Links in ODT export::         How links will be interpreted and formatted
11479 * Tables in ODT export::        How Tables are exported
11480 * Images in ODT export::        How to insert images
11481 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
11482 * Labels and captions in ODT export::  How captions are rendered
11483 * Literal examples in ODT export::  How source and example blocks are formatted
11484 * Advanced topics in ODT export::  Read this if you are a power user
11485 @end menu
11487 @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
11488 @subsection Pre-requisites for ODT export
11489 @cindex zip
11490 The ODT exporter relies on the @file{zip} program to create the final
11491 output.  Check the availability of this program before proceeding further.
11493 @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
11494 @subsection ODT export commands
11496 @subsubheading Exporting to ODT
11497 @anchor{x-export-to-odt}
11499 @cindex region, active
11500 @cindex active region
11501 @cindex transient-mark-mode
11502 @table @kbd
11503 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
11504 @cindex property EXPORT_FILE_NAME
11506 Export as OpenDocument Text file.
11508 @vindex org-odt-preferred-output-format
11509 If @code{org-preferred-output-format} is specified, automatically convert
11510 the exported file to that format.  @xref{x-export-to-other-formats, ,
11511 Automatically exporting to other formats}.
11513 For an Org file @file{myfile.org}, the ODT file will be
11514 @file{myfile.odt}.  The file will be overwritten without warning.  If there
11515 is an active region,@footnote{This requires @code{transient-mark-mode} to be
11516 turned on} only the region will be exported.  If the selected region is a
11517 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
11518 tree head will become the document title.  If the tree head entry has, or
11519 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
11520 export.
11522 @kbd{C-c C-e o O}
11523 Export as an OpenDocument Text file and open the resulting file.
11525 @vindex org-odt-preferred-output-format
11526 If @code{org-odt-preferred-output-format} is specified, open the converted
11527 file instead.  @xref{x-export-to-other-formats, , Automatically exporting to
11528 other formats}.
11529 @end table
11531 @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
11532 @subsection Extending ODT export
11534 The ODT exporter can interface with a variety of document
11535 converters and supports popular converters out of the box.  As a result, you
11536 can use it to export to formats like @samp{doc} or convert a document from
11537 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
11539 @cindex @file{unoconv}
11540 @cindex LibreOffice
11541 If you have a working installation of LibreOffice, a document converter is
11542 pre-configured for you and you can use it right away.  If you would like to
11543 use @file{unoconv} as your preferred converter, customize the variable
11544 @code{org-odt-convert-process} to point to @code{unoconv}.  You can
11545 also use your own favorite converter or tweak the default settings of the
11546 @file{LibreOffice} and @samp{unoconv} converters.  @xref{Configuring a
11547 document converter}.
11549 @subsubsection Automatically exporting to other formats
11550 @anchor{x-export-to-other-formats}
11552 @vindex org-odt-preferred-output-format
11553 Very often, you will find yourself exporting to ODT format, only to
11554 immediately save the exported document to other formats like @samp{doc},
11555 @samp{docx}, @samp{rtf}, @samp{pdf} etc.  In such cases, you can specify your
11556 preferred output format by customizing the variable
11557 @code{org-odt-preferred-output-format}.  This way, the export commands
11558 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
11559 format that is of immediate interest to you.
11561 @subsubsection Converting between document formats
11562 @anchor{x-convert-to-other-formats}
11564 There are many document converters in the wild which support conversion to
11565 and from various file formats, including, but not limited to the
11566 ODT format.  LibreOffice converter, mentioned above, is one such
11567 converter.  Once a converter is configured, you can interact with it using
11568 the following command.
11570 @vindex org-odt-convert
11571 @table @kbd
11573 @item M-x org-odt-convert
11574 Convert an existing document from one format to another.  With a prefix
11575 argument, also open the newly produced file.
11576 @end table
11578 @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
11579 @subsection Applying custom styles
11580 @cindex styles, custom
11581 @cindex template, custom
11583 The ODT exporter ships with a set of OpenDocument styles
11584 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
11585 output.  These factory styles, however, may not cater to your specific
11586 tastes.  To customize the output, you can either modify the above styles
11587 files directly, or generate the required styles using an application like
11588 LibreOffice.  The latter method is suitable for expert and non-expert
11589 users alike, and is described here.
11591 @subsubsection Applying custom styles: the easy way
11593 @enumerate
11594 @item
11595 Create a sample @file{example.org} file with the below settings and export it
11596 to ODT format.
11598 @example
11599 #+OPTIONS: H:10 num:t
11600 @end example
11602 @item
11603 Open the above @file{example.odt} using LibreOffice.  Use the @file{Stylist}
11604 to locate the target styles---these typically have the @samp{Org} prefix---and
11605 modify those to your taste.  Save the modified file either as an
11606 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
11608 @item
11609 @cindex #+ODT_STYLES_FILE
11610 @vindex org-odt-styles-file
11611 Customize the variable @code{org-odt-styles-file} and point it to the
11612 newly created file.  For additional configuration options
11613 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
11615 If you would like to choose a style on a per-file basis, you can use the
11616 @code{#+ODT_STYLES_FILE} option.  A typical setting will look like
11618 @example
11619 #+ODT_STYLES_FILE: "/path/to/example.ott"
11620 @end example
11624 @example
11625 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
11626 @end example
11628 @end enumerate
11630 @subsubsection Using third-party styles and templates
11632 You can use third-party styles and templates for customizing your output.
11633 This will produce the desired output only if the template provides all
11634 style names that the @samp{ODT} exporter relies on.  Unless this condition is
11635 met, the output is going to be less than satisfactory.  So it is highly
11636 recommended that you only work with templates that are directly derived from
11637 the factory settings.
11639 @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
11640 @subsection Links in ODT export
11641 @cindex links, in ODT export
11643 ODT exporter creates native cross-references for internal links.  It creates
11644 Internet-style links for all other links.
11646 A link with no description and destined to a regular (un-itemized) outline
11647 heading is replaced with a cross-reference and section number of the heading.
11649 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
11650 with a cross-reference and sequence number of the labeled entity.
11651 @xref{Labels and captions in ODT export}.
11653 @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
11654 @subsection Tables in ODT export
11655 @cindex tables, in ODT export
11657 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
11658 tables is supported.  However, export of complex @file{table.el} tables---tables
11659 that have column or row spans---is not supported.  Such tables are
11660 stripped from the exported document.
11662 By default, a table is exported with top and bottom frames and with rules
11663 separating row and column groups (@pxref{Column groups}).  Furthermore, all
11664 tables are typeset to occupy the same width.  If the table specifies
11665 alignment and relative width for its columns (@pxref{Column width and
11666 alignment}) then these are honored on export.@footnote{The column widths are
11667 interpreted as weighted ratios with the default weight being 1}
11669 @cindex #+ATTR_ODT
11670 You can control the width of the table by specifying @code{:rel-width}
11671 property using an @code{#+ATTR_ODT} line.
11673 For example, consider the following table which makes use of all the rules
11674 mentioned above.
11676 @example
11677 #+ATTR_ODT: :rel-width 50
11678 | Area/Month    |   Jan |   Feb |   Mar |   Sum |
11679 |---------------+-------+-------+-------+-------|
11680 | /             |     < |       |       |     < |
11681 | <l13>         |  <r5> |  <r5> |  <r5> |  <r6> |
11682 | North America |     1 |    21 |   926 |   948 |
11683 | Middle East   |     6 |    75 |   844 |   925 |
11684 | Asia Pacific  |     9 |    27 |   790 |   826 |
11685 |---------------+-------+-------+-------+-------|
11686 | Sum           |    16 |   123 |  2560 |  2699 |
11687 @end example
11689 On export, the table will occupy 50% of text area.  The columns will be sized
11690 (roughly) in the ratio of 13:5:5:5:6.  The first column will be left-aligned
11691 and rest of the columns will be right-aligned.  There will be vertical rules
11692 after separating the header and last columns from other columns.  There will
11693 be horizontal rules separating the header and last rows from other rows.
11695 If you are not satisfied with the above formatting options, you can create
11696 custom table styles and associate them with a table using the
11697 @code{#+ATTR_ODT} line.  @xref{Customizing tables in ODT export}.
11699 @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
11700 @subsection Images in ODT export
11701 @cindex images, embedding in ODT
11702 @cindex embedding images in ODT
11704 @subsubheading Embedding images
11705 You can embed images within the exported document by providing a link to the
11706 desired image file with no link description.  For example, to embed
11707 @samp{img.png} do either of the following:
11709 @example
11710 [[file:img.png]]
11711 @end example
11713 @example
11714 [[./img.png]]
11715 @end example
11717 @subsubheading Embedding clickable images
11718 You can create clickable images by providing a link whose description is a
11719 link to an image file.  For example, to embed a image
11720 @file{org-mode-unicorn.png} which when clicked jumps to
11721 @uref{http://Orgmode.org} website, do the following
11723 @example
11724 [[http://orgmode.org][./org-mode-unicorn.png]]
11725 @end example
11727 @subsubheading Sizing and scaling of embedded images
11729 @cindex #+ATTR_ODT
11730 You can control the size and scale of the embedded images using the
11731 @code{#+ATTR_ODT} attribute.
11733 @cindex identify, ImageMagick
11734 @vindex org-odt-pixels-per-inch
11735 The exporter specifies the desired size of the image in the final document in
11736 units of centimeters.  In order to scale the embedded images, the exporter
11737 queries for pixel dimensions of the images using one of a) ImageMagick's
11738 @file{identify} program or b) Emacs `create-image' and `image-size'
11739 APIs.@footnote{Use of @file{ImageMagick} is only desirable.  However, if you
11740 routinely produce documents that have large images or you export your Org
11741 files that has images using a Emacs batch script, then the use of
11742 @file{ImageMagick} is mandatory.} The pixel dimensions are subsequently
11743 converted in to units of centimeters using
11744 @code{org-odt-pixels-per-inch}.  The default value of this variable is
11745 set to @code{display-pixels-per-inch}.  You can tweak this variable to
11746 achieve the best results.
11748 The examples below illustrate the various possibilities.
11750 @table @asis
11751 @item Explicitly size the image
11752 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
11754 @example
11755 #+ATTR_ODT: :width 10 :height 10
11756 [[./img.png]]
11757 @end example
11759 @item Scale the image
11760 To embed @file{img.png} at half its size, do the following:
11762 @example
11763 #+ATTR_ODT: :scale 0.5
11764 [[./img.png]]
11765 @end example
11767 @item Scale the image to a specific width
11768 To embed @file{img.png} with a width of 10 cm while retaining the original
11769 height:width ratio, do the following:
11771 @example
11772 #+ATTR_ODT: :width 10
11773 [[./img.png]]
11774 @end example
11776 @item Scale the image to a specific height
11777 To embed @file{img.png} with a height of 10 cm while retaining the original
11778 height:width ratio, do the following
11780 @example
11781 #+ATTR_ODT: :height 10
11782 [[./img.png]]
11783 @end example
11784 @end table
11786 @subsubheading Anchoring of images
11788 @cindex #+ATTR_ODT
11789 You can control the manner in which an image is anchored by setting the
11790 @code{:anchor} property of it's @code{#+ATTR_ODT} line.  You can specify one
11791 of the the following three values for the @code{:anchor} property:
11792 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
11794 To create an image that is anchored to a page, do the following:
11795 @example
11796 #+ATTR_ODT: :anchor "page"
11797 [[./img.png]]
11798 @end example
11800 @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
11801 @subsection Math formatting in ODT export
11803 The ODT exporter has special support for handling math.
11805 @menu
11806 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
11807 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
11808 @end menu
11810 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
11811 @subsubsection Working with @LaTeX{} math snippets
11813 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
11814 document in one of the following ways:
11816 @cindex MathML
11817 @enumerate
11818 @item MathML
11820 This option is activated on a per-file basis with
11822 @example
11823 #+OPTIONS: LaTeX:t
11824 @end example
11826 With this option, @LaTeX{} fragments are first converted into MathML
11827 fragments using an external @LaTeX{}-to-MathML converter program.  The
11828 resulting MathML fragments are then embedded as an OpenDocument Formula in
11829 the exported document.
11831 @vindex org-latex-to-mathml-convert-command
11832 @vindex org-latex-to-mathml-jar-file
11834 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
11835 @code{org-latex-to-mathml-convert-command} and
11836 @code{org-latex-to-mathml-jar-file}.
11838 If you prefer to use @file{MathToWeb}@footnote{See
11839 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
11840 converter, you can configure the above variables as shown below.
11842 @lisp
11843 (setq org-latex-to-mathml-convert-command
11844       "java -jar %j -unicode -force -df %o %I"
11845       org-latex-to-mathml-jar-file
11846       "/path/to/mathtoweb.jar")
11847 @end lisp
11849 You can use the following commands to quickly verify the reliability of
11850 the @LaTeX{}-to-MathML converter.
11852 @table @kbd
11853 @item M-x org-odt-export-as-odf
11854 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
11856 @item M-x org-odt-export-as-odf-and-open
11857 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
11858 and open the formula file with the system-registered application.
11859 @end table
11861 @cindex dvipng
11862 @item PNG images
11864 This option is activated on a per-file basis with
11866 @example
11867 #+OPTIONS: LaTeX:dvipng
11868 @end example
11870 With this option, @LaTeX{} fragments are processed into PNG images and the
11871 resulting images are embedded in the exported document.  This method requires
11872 that the @file{dvipng} program be available on your system.
11873 @end enumerate
11875 @node Working with MathML or OpenDocument formula files,  , Working with @LaTeX{} math snippets, Math formatting in ODT export
11876 @subsubsection Working with MathML or OpenDocument formula files
11878 For various reasons, you may find embedding @LaTeX{} math snippets in an
11879 ODT document less than reliable.  In that case, you can embed a
11880 math equation by linking to its MathML (@file{.mml}) source or its
11881 OpenDocument formula (@file{.odf}) file as shown below:
11883 @example
11884 [[./equation.mml]]
11885 @end example
11889 @example
11890 [[./equation.odf]]
11891 @end example
11893 @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
11894 @subsection Labels and captions in ODT export
11896 You can label and caption various category of objects---an inline image, a
11897 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
11898 @code{#+CAPTION} lines.  @xref{Images and tables}.  ODT exporter enumerates
11899 each labeled or captioned object of a given category separately.  As a
11900 result, each such object is assigned a sequence number based on order of it's
11901 appearance in the Org file.
11903 In the exported document, a user-provided caption is augmented with the
11904 category and sequence number.  Consider the following inline image in an Org
11905 file.
11907 @example
11908 #+CAPTION: Bell curve
11909 #+LABEL:   fig:SED-HR4049
11910 [[./img/a.png]]
11911 @end example
11913 It could be rendered as shown below in the exported document.
11915 @example
11916 Figure 2: Bell curve
11917 @end example
11919 @vindex org-odt-category-map-alist
11920 You can modify the category component of the caption by customizing the
11921 option @code{org-odt-category-map-alist}.  For example, to tag all embedded
11922 images with the string @samp{Illustration} (instead of the default
11923 @samp{Figure}) use the following setting:
11925 @lisp
11926 (setq org-odt-category-map-alist
11927       (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
11928 @end lisp
11930 With this, previous image will be captioned as below in the exported
11931 document.
11933 @example
11934 Illustration 2: Bell curve
11935 @end example
11937 @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
11938 @subsection Literal examples in ODT export
11940 Export of literal examples (@pxref{Literal examples}) with full fontification
11941 is supported.  Internally, the exporter relies on @file{htmlfontify.el} to
11942 generate all style definitions needed for a fancy listing.@footnote{Your
11943 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
11944 fontification to be turned on.}  The auto-generated styles have @samp{OrgSrc}
11945 as prefix and inherit their color from the faces used by Emacs
11946 @code{font-lock} library for the source language.
11948 @vindex org-odt-fontify-srcblocks
11949 If you prefer to use your own custom styles for fontification, you can do
11950 so by customizing the variable
11951 @code{org-odt-create-custom-styles-for-srcblocks}.
11953 @vindex org-odt-create-custom-styles-for-srcblocks
11954 You can turn off fontification of literal examples by customizing the
11955 option @code{org-odt-fontify-srcblocks}.
11957 @node Advanced topics in ODT export,  , Literal examples in ODT export, OpenDocument Text export
11958 @subsection Advanced topics in ODT export
11960 If you rely heavily on ODT export, you may want to exploit the full
11961 set of features that the exporter offers.  This section describes features
11962 that would be of interest to power users.
11964 @menu
11965 * Configuring a document converter::  How to register a document converter
11966 * Working with OpenDocument style files::  Explore the internals
11967 * Creating one-off styles::     How to produce custom highlighting etc
11968 * Customizing tables in ODT export::  How to define and use Table templates
11969 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
11970 @end menu
11972 @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
11973 @subsubsection Configuring a document converter
11974 @cindex convert
11975 @cindex doc, docx, rtf
11976 @cindex converter
11978 The ODT exporter can work with popular converters with little or no
11979 extra configuration from your side. @xref{Extending ODT export}.
11980 If you are using a converter that is not supported by default or if you would
11981 like to tweak the default converter settings, proceed as below.
11983 @enumerate
11984 @item Register the converter
11986 @vindex org-odt-convert-processes
11987 Name your converter and add it to the list of known converters by
11988 customizing the option @code{org-odt-convert-processes}.  Also specify how
11989 the converter can be invoked via command-line to effect the conversion.
11991 @item Configure its capabilities
11993 @vindex org-odt-convert-capabilities
11994 @anchor{x-odt-converter-capabilities} Specify the set of formats the
11995 converter can handle by customizing the variable
11996 @code{org-odt-convert-capabilities}.  Use the default value for this
11997 variable as a guide for configuring your converter.  As suggested by the
11998 default setting, you can specify the full set of formats supported by the
11999 converter and not limit yourself to specifying formats that are related to
12000 just the OpenDocument Text format.
12002 @item Choose the converter
12004 @vindex org-odt-convert-process
12005 Select the newly added converter as the preferred one by customizing the
12006 option @code{org-odt-convert-process}.
12007 @end enumerate
12009 @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
12010 @subsubsection Working with OpenDocument style files
12011 @cindex styles, custom
12012 @cindex template, custom
12014 This section explores the internals of the ODT exporter and the
12015 means by which it produces styled documents.  Read this section if you are
12016 interested in exploring the automatic and custom OpenDocument styles used by
12017 the exporter.
12019 @anchor{x-factory-styles}
12020 @subsubheading Factory styles
12022 The ODT exporter relies on two files for generating its output.
12023 These files are bundled with the distribution under the directory pointed to
12024 by the variable @code{org-odt-styles-dir}.  The two files are:
12026 @itemize
12027 @anchor{x-orgodtstyles-xml}
12028 @item
12029 @file{OrgOdtStyles.xml}
12031 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12032 document.  This file gets modified for the following purposes:
12033 @enumerate
12035 @item
12036 To control outline numbering based on user settings.
12038 @item
12039 To add styles generated by @file{htmlfontify.el} for fontification of code
12040 blocks.
12041 @end enumerate
12043 @anchor{x-orgodtcontenttemplate-xml}
12044 @item
12045 @file{OrgOdtContentTemplate.xml}
12047 This file contributes to the @file{content.xml} file of the final @samp{ODT}
12048 document.  The contents of the Org outline are inserted between the
12049 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
12051 Apart from serving as a template file for the final @file{content.xml}, the
12052 file serves the following purposes:
12053 @enumerate
12055 @item
12056 It contains automatic styles for formatting of tables which are referenced by
12057 the exporter.
12059 @item
12060 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
12061 elements that control how various entities---tables, images, equations,
12062 etc.---are numbered.
12063 @end enumerate
12064 @end itemize
12066 @anchor{x-overriding-factory-styles}
12067 @subsubheading Overriding factory styles
12068 The following two variables control the location from which the ODT
12069 exporter picks up the custom styles and content template files.  You can
12070 customize these variables to override the factory styles used by the
12071 exporter.
12073 @itemize
12074 @anchor{x-org-odt-styles-file}
12075 @item
12076 @code{org-odt-styles-file}
12078 Use this variable to specify the @file{styles.xml} that will be used in the
12079 final output.  You can specify one of the following values:
12081 @enumerate
12082 @item A @file{styles.xml} file
12084 Use this file instead of the default @file{styles.xml}
12086 @item A @file{.odt} or @file{.ott} file
12088 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12089 Template file
12091 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
12093 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12094 Template file.  Additionally extract the specified member files and embed
12095 those within the final @samp{ODT} document.
12097 Use this option if the @file{styles.xml} file references additional files
12098 like header and footer images.
12100 @item @code{nil}
12102 Use the default @file{styles.xml}
12103 @end enumerate
12105 @anchor{x-org-odt-content-template-file}
12106 @item
12107 @code{org-odt-content-template-file}
12109 Use this variable to specify the blank @file{content.xml} that will be used
12110 in the final output.
12111 @end itemize
12113 @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
12114 @subsubsection Creating one-off styles
12116 There are times when you would want one-off formatting in the exported
12117 document.  You can achieve this by embedding raw OpenDocument XML in the Org
12118 file.  The use of this feature is better illustrated with couple of examples.
12120 @enumerate
12121 @item Embedding ODT tags as part of regular text
12123 You can include simple OpenDocument tags by prefixing them with
12124 @samp{@@}.  For example, to highlight a region of text do the following:
12126 @example
12127 @@<text:span text:style-name="Highlight">This is a
12128 highlighted text@@</text:span>.  But this is a
12129 regular text.
12130 @end example
12132 @strong{Hint:} To see the above example in action, edit your
12133 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12134 custom @samp{Highlight} style as shown below.
12136 @example
12137 <style:style style:name="Highlight" style:family="text">
12138   <style:text-properties fo:background-color="#ff0000"/>
12139 </style:style>
12140 @end example
12142 @item Embedding a one-line OpenDocument XML
12144 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
12145 directive.  For example, to force a page break do the following:
12147 @example
12148 #+ODT: <text:p text:style-name="PageBreak"/>
12149 @end example
12151 @strong{Hint:} To see the above example in action, edit your
12152 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12153 custom @samp{PageBreak} style as shown below.
12155 @example
12156 <style:style style:name="PageBreak" style:family="paragraph"
12157              style:parent-style-name="Text_20_body">
12158   <style:paragraph-properties fo:break-before="page"/>
12159 </style:style>
12160 @end example
12162 @item Embedding a block of OpenDocument XML
12164 You can add a large block of OpenDocument XML using the
12165 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
12167 For example, to create a one-off paragraph that uses bold text, do the
12168 following:
12170 @example
12171 #+BEGIN_ODT
12172 <text:p text:style-name="Text_20_body_20_bold">
12173 This paragraph is specially formatted and uses bold text.
12174 </text:p>
12175 #+END_ODT
12176 @end example
12178 @end enumerate
12180 @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
12181 @subsubsection Customizing tables in ODT export
12182 @cindex tables, in ODT export
12184 @cindex #+ATTR_ODT
12185 You can override the default formatting of the table by specifying a custom
12186 table style with the @code{#+ATTR_ODT} line.  For a discussion on default
12187 formatting of tables @pxref{Tables in ODT export}.
12189 This feature closely mimics the way table templates are defined in the
12190 OpenDocument-v1.2
12191 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12192 OpenDocument-v1.2 Specification}}
12194 @subsubheading Custom table styles: an illustration
12196 @vindex org-odt-table-styles
12197 To have a quick preview of this feature, install the below setting and
12198 export the table that follows:
12200 @lisp
12201 (setq org-odt-table-styles
12202       (append org-odt-table-styles
12203             '(("TableWithHeaderRowAndColumn" "Custom"
12204                 ((use-first-row-styles . t)
12205                  (use-first-column-styles . t)))
12206                 ("TableWithFirstRowandLastRow" "Custom"
12207                  ((use-first-row-styles . t)
12208                  (use-last-row-styles . t))))))
12209 @end lisp
12211 @example
12212 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12213 | Name  | Phone | Age |
12214 | Peter |  1234 |  17 |
12215 | Anna  |  4321 |  25 |
12216 @end example
12218 In the above example, you used a template named @samp{Custom} and installed
12219 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12220 @samp{TableWithFirstRowandLastRow}.  (@strong{Important:} The OpenDocument
12221 styles needed for producing the above template have been pre-defined for
12222 you.  These styles are available under the section marked @samp{Custom
12223 Table Template} in @file{OrgOdtContentTemplate.xml}
12224 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}).  If you need
12225 additional templates you have to define these styles yourselves.
12227 @subsubheading Custom table styles: the nitty-gritty
12228 To use this feature proceed as follows:
12230 @enumerate
12231 @item
12232 Create a table template@footnote{See the @code{<table:table-template>}
12233 element of the OpenDocument-v1.2 specification}
12235 A table template is nothing but a set of @samp{table-cell} and
12236 @samp{paragraph} styles for each of the following table cell categories:
12238 @itemize @minus
12239 @item Body
12240 @item First column
12241 @item Last column
12242 @item First row
12243 @item Last row
12244 @item Even row
12245 @item Odd row
12246 @item Even column
12247 @item Odd Column
12248 @end itemize
12250 The names for the above styles must be chosen based on the name of the table
12251 template using a well-defined convention.
12253 The naming convention is better illustrated with an example.  For a table
12254 template with the name @samp{Custom}, the needed style names are listed in
12255 the following table.
12257 @multitable  {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12258 @headitem Table cell type
12259 @tab @code{table-cell} style
12260 @tab @code{paragraph} style
12261 @item
12262 @tab
12263 @tab
12264 @item Body
12265 @tab @samp{CustomTableCell}
12266 @tab @samp{CustomTableParagraph}
12267 @item First column
12268 @tab @samp{CustomFirstColumnTableCell}
12269 @tab @samp{CustomFirstColumnTableParagraph}
12270 @item Last column
12271 @tab @samp{CustomLastColumnTableCell}
12272 @tab @samp{CustomLastColumnTableParagraph}
12273 @item First row
12274 @tab @samp{CustomFirstRowTableCell}
12275 @tab @samp{CustomFirstRowTableParagraph}
12276 @item Last row
12277 @tab @samp{CustomLastRowTableCell}
12278 @tab @samp{CustomLastRowTableParagraph}
12279 @item Even row
12280 @tab @samp{CustomEvenRowTableCell}
12281 @tab @samp{CustomEvenRowTableParagraph}
12282 @item Odd row
12283 @tab @samp{CustomOddRowTableCell}
12284 @tab @samp{CustomOddRowTableParagraph}
12285 @item Even column
12286 @tab @samp{CustomEvenColumnTableCell}
12287 @tab @samp{CustomEvenColumnTableParagraph}
12288 @item Odd column
12289 @tab @samp{CustomOddColumnTableCell}
12290 @tab @samp{CustomOddColumnTableParagraph}
12291 @end multitable
12293 To create a table template with the name @samp{Custom}, define the above
12294 styles in the
12295 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
12296 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
12297 styles}).
12299 @item
12300 Define a table style@footnote{See the attributes @code{table:template-name},
12301 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
12302 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
12303 @code{table:use-banding-rows-styles}, and
12304 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
12305 the OpenDocument-v1.2 specification}
12307 @vindex org-odt-table-styles
12308 To define a table style, create an entry for the style in the variable
12309 @code{org-odt-table-styles} and specify the following:
12311 @itemize @minus
12312 @item the name of the table template created in step (1)
12313 @item the set of cell styles in that template that are to be activated
12314 @end itemize
12316 For example, the entry below defines two different table styles
12317 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
12318 based on the same template @samp{Custom}.  The styles achieve their intended
12319 effect by selectively activating the individual cell styles in that template.
12321 @lisp
12322 (setq org-odt-table-styles
12323       (append org-odt-table-styles
12324               '(("TableWithHeaderRowAndColumn" "Custom"
12325                  ((use-first-row-styles . t)
12326                   (use-first-column-styles . t)))
12327                 ("TableWithFirstRowandLastRow" "Custom"
12328                  ((use-first-row-styles . t)
12329                   (use-last-row-styles . t))))))
12330 @end lisp
12332 @item
12333 Associate a table with the table style
12335 To do this, specify the table style created in step (2) as part of
12336 the @code{ATTR_ODT} line as shown below.
12338 @example
12339 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12340 | Name  | Phone | Age |
12341 | Peter |  1234 |  17 |
12342 | Anna  |  4321 |  25 |
12343 @end example
12344 @end enumerate
12346 @node Validating OpenDocument XML,  , Customizing tables in ODT export, Advanced topics in ODT export
12347 @subsubsection Validating OpenDocument XML
12349 Occasionally, you will discover that the document created by the
12350 ODT exporter cannot be opened by your favorite application.  One of
12351 the common reasons for this is that the @file{.odt} file is corrupt.  In such
12352 cases, you may want to validate the document against the OpenDocument RELAX
12353 NG Compact Syntax (RNC) schema.
12355 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
12356 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}.  For
12357 general help with validation (and schema-sensitive editing) of XML files:
12358 @inforef{Introduction,,nxml-mode}.
12360 @vindex org-odt-schema-dir
12361 If you have ready access to OpenDocument @file{.rnc} files and the needed
12362 schema-locating rules in a single folder, you can customize the variable
12363 @code{org-odt-schema-dir} to point to that directory.  The ODT exporter
12364 will take care of updating the @code{rng-schema-locating-files} for you.
12366 @c end opendocument
12368 @node iCalendar export,  , OpenDocument Text export, Exporting
12369 @section iCalendar export
12370 @cindex iCalendar export
12372 @vindex org-icalendar-include-todo
12373 @vindex org-icalendar-use-deadline
12374 @vindex org-icalendar-use-scheduled
12375 @vindex org-icalendar-categories
12376 @vindex org-icalendar-alarm-time
12377 Some people use Org mode for keeping track of projects, but still prefer a
12378 standard calendar application for anniversaries and appointments.  In this
12379 case it can be useful to show deadlines and other time-stamped items in Org
12380 files in the calendar application.  Org mode can export calendar information
12381 in the standard iCalendar format.  If you also want to have TODO entries
12382 included in the export, configure the variable
12383 @code{org-icalendar-include-todo}.  Plain timestamps are exported as VEVENT,
12384 and TODO items as VTODO@.  It will also create events from deadlines that are
12385 in non-TODO items.  Deadlines and scheduling dates in TODO items will be used
12386 to set the start and due dates for the TODO entry@footnote{See the variables
12387 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
12388 As categories, it will use the tags locally defined in the heading, and the
12389 file/tree category@footnote{To add inherited tags or the TODO state,
12390 configure the variable @code{org-icalendar-categories}.}.  See the variable
12391 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
12392 time.
12394 @vindex org-icalendar-store-UID
12395 @cindex property, ID
12396 The iCalendar standard requires each entry to have a globally unique
12397 identifier (UID).  Org creates these identifiers during export.  If you set
12398 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
12399 @code{:ID:} property of the entry and re-used next time you report this
12400 entry.  Since a single entry can give rise to multiple iCalendar entries (as
12401 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
12402 prefixes to the UID, depending on what triggered the inclusion of the entry.
12403 In this way the UID remains unique, but a synchronization program can still
12404 figure out from which entry all the different instances originate.
12406 @table @kbd
12407 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
12408 Create iCalendar entries for the current buffer and store them in the same
12409 directory, using a file extension @file{.ics}.
12410 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
12411 @vindex org-agenda-files
12412 Like @kbd{C-c C-e c f}, but do this for all files in
12413 @code{org-agenda-files}.  For each of these files, a separate iCalendar
12414 file will be written.
12415 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
12416 @vindex org-icalendar-combined-agenda-file
12417 Create a single large iCalendar file from all files in
12418 @code{org-agenda-files} and write it to the file given by
12419 @code{org-icalendar-combined-agenda-file}.
12420 @end table
12422 @vindex org-use-property-inheritance
12423 @vindex org-icalendar-include-body
12424 @cindex property, SUMMARY
12425 @cindex property, DESCRIPTION
12426 @cindex property, LOCATION
12427 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
12428 property can be inherited from higher in the hierarchy if you configure
12429 @code{org-use-property-inheritance} accordingly.} properties if the selected
12430 entries have them.  If not, the summary will be derived from the headline,
12431 and the description from the body (limited to
12432 @code{org-icalendar-include-body} characters).
12434 How this calendar is best read and updated, depends on the application
12435 you are using.  The FAQ covers this issue.
12437 @node Publishing, Working With Source Code, Exporting, Top
12438 @chapter Publishing
12439 @cindex publishing
12441 Org includes a publishing management system that allows you to configure
12442 automatic HTML conversion of @emph{projects} composed of interlinked org
12443 files.  You can also configure Org to automatically upload your exported HTML
12444 pages and related attachments, such as images and source code files, to a web
12445 server.
12447 You can also use Org to convert files into PDF, or even combine HTML and PDF
12448 conversion so that files are available in both formats on the server.
12450 Publishing has been contributed to Org by David O'Toole.
12452 @menu
12453 * Configuration::               Defining projects
12454 * Uploading files::             How to get files up on the server
12455 * Sample configuration::        Example projects
12456 * Triggering publication::      Publication commands
12457 @end menu
12459 @node Configuration, Uploading files, Publishing, Publishing
12460 @section Configuration
12462 Publishing needs significant configuration to specify files, destination
12463 and many other properties of a project.
12465 @menu
12466 * Project alist::               The central configuration variable
12467 * Sources and destinations::    From here to there
12468 * Selecting files::             What files are part of the project?
12469 * Publishing action::           Setting the function doing the publishing
12470 * Publishing options::          Tweaking HTML/@LaTeX{} export
12471 * Publishing links::            Which links keep working after publishing?
12472 * Sitemap::                     Generating a list of all pages
12473 * Generating an index::         An index that reaches across pages
12474 @end menu
12476 @node Project alist, Sources and destinations, Configuration, Configuration
12477 @subsection The variable @code{org-publish-project-alist}
12478 @cindex org-publish-project-alist
12479 @cindex projects, for publishing
12481 @vindex org-publish-project-alist
12482 Publishing is configured almost entirely through setting the value of one
12483 variable, called @code{org-publish-project-alist}.  Each element of the list
12484 configures one project, and may be in one of the two following forms:
12486 @lisp
12487    ("project-name" :property value :property value ...)
12488      @r{i.e., a well-formed property list with alternating keys and values}
12489 @r{or}
12490    ("project-name" :components ("project-name" "project-name" ...))
12492 @end lisp
12494 In both cases, projects are configured by specifying property values.  A
12495 project defines the set of files that will be published, as well as the
12496 publishing configuration to use when publishing those files.  When a project
12497 takes the second form listed above, the individual members of the
12498 @code{:components} property are taken to be sub-projects, which group
12499 together files requiring different publishing options.  When you publish such
12500 a ``meta-project'', all the components will also be published, in the
12501 sequence given.
12503 @node Sources and destinations, Selecting files, Project alist, Configuration
12504 @subsection Sources and destinations for files
12505 @cindex directories, for publishing
12507 Most properties are optional, but some should always be set.  In
12508 particular, Org needs to know where to look for source files,
12509 and where to put published files.
12511 @multitable @columnfractions 0.3 0.7
12512 @item @code{:base-directory}
12513 @tab Directory containing publishing source files
12514 @item @code{:publishing-directory}
12515 @tab Directory where output files will be published.  You can directly
12516 publish to a web server using a file name syntax appropriate for
12517 the Emacs @file{tramp} package.  Or you can publish to a local directory and
12518 use external tools to upload your website (@pxref{Uploading files}).
12519 @item @code{:preparation-function}
12520 @tab Function or list of functions to be called before starting the
12521 publishing process, for example, to run @code{make} for updating files to be
12522 published.  The project property list is scoped into this call as the
12523 variable @code{project-plist}.
12524 @item @code{:completion-function}
12525 @tab Function or list of functions called after finishing the publishing
12526 process, for example, to change permissions of the resulting files.  The
12527 project property list is scoped into this call as the variable
12528 @code{project-plist}.
12529 @end multitable
12530 @noindent
12532 @node Selecting files, Publishing action, Sources and destinations, Configuration
12533 @subsection Selecting files
12534 @cindex files, selecting for publishing
12536 By default, all files with extension @file{.org} in the base directory
12537 are considered part of the project.  This can be modified by setting the
12538 properties
12539 @multitable @columnfractions 0.25 0.75
12540 @item @code{:base-extension}
12541 @tab Extension (without the dot!) of source files.  This actually is a
12542 regular expression.  Set this to the symbol @code{any} if you want to get all
12543 files in @code{:base-directory}, even without extension.
12545 @item @code{:exclude}
12546 @tab Regular expression to match file names that should not be
12547 published, even though they have been selected on the basis of their
12548 extension.
12550 @item @code{:include}
12551 @tab List of files to be included regardless of @code{:base-extension}
12552 and @code{:exclude}.
12554 @item @code{:recursive}
12555 @tab Non-nil means, check base-directory recursively for files to publish.
12556 @end multitable
12558 @node Publishing action, Publishing options, Selecting files, Configuration
12559 @subsection Publishing action
12560 @cindex action, for publishing
12562 Publishing means that a file is copied to the destination directory and
12563 possibly transformed in the process.  The default transformation is to export
12564 Org files as HTML files, and this is done by the function
12565 @code{org-html-publish-to-html} which calls the HTML exporter (@pxref{HTML
12566 export}).  But you also can publish your content as PDF files using
12567 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
12568 using the corresponding functions.
12570 If you want to publish the Org file itself but with the @i{archived},
12571 @i{commented} and @i{tag-excluded} trees removed, use the function
12572 @code{org-org-publish-to-org}.  This will produce @file{file.org}.  If you
12573 want a htmlized version of this file, set the parameter
12574 @code{:htmlized-source} to @code{t}, it will produce @file{file.org.html} in
12575 the publishing directory.
12577 @c @footnote{@file{file-source.org} and @file{file-source.org.html} if source
12578 @c and publishing directories are equal.  Note that with this kind of setup, you
12579 @c need to add @code{:exclude "-source\\.org"} to the project definition in
12580 @c @code{org-publish-project-alist} to prevent the published source files from
12581 @c being considered as new org files the next time the project is published.}.
12583 Other files like images only need to be copied to the publishing destination;
12584 for this you may use @code{org-publish-attachment}.  For non-Org files, you
12585 always need to specify the publishing function:
12587 @multitable @columnfractions 0.3 0.7
12588 @item @code{:publishing-function}
12589 @tab Function executing the publication of a file.  This may also be a
12590 list of functions, which will all be called in turn.
12591 @c @item @code{:plain-source}
12592 @c @tab Non-nil means, publish plain source.
12593 @item @code{:htmlized-source}
12594 @tab Non-nil means, publish htmlized source.
12595 @end multitable
12597 The function must accept three arguments: a property list containing at least
12598 a @code{:publishing-directory} property, the name of the file to be
12599 published, and the path to the publishing directory of the output file.  It
12600 should take the specified file, make the necessary transformation (if any)
12601 and place the result into the destination folder.
12603 @node Publishing options, Publishing links, Publishing action, Configuration
12604 @subsection Options for the exporters
12605 @cindex options, for publishing
12607 The property list can be used to set many export options for the exporters.
12608 In most cases, these properties correspond to user variables in Org.  The
12609 first table below lists these properties along with the variable they belong
12610 to.  The second table list HTML specific properties.  See the documentation
12611 string for the respective variable for details.
12613 @vindex org-export-with-archived-trees
12614 @vindex org-export-with-author
12615 @vindex org-export-with-creator
12616 @vindex org-display-custom-times
12617 @vindex org-export-with-drawers
12618 @vindex org-export-with-email
12619 @vindex user-mail-address
12620 @vindex org-export-with-emphasize
12621 @vindex org-export-exclude-tags
12622 @vindex org-export-with-fixed-width
12623 @vindex org-export-with-footnotes
12624 @vindex org-export-headline-levels
12625 @vindex org-export-default-language
12626 @vindex org-export-with-latex
12627 @vindex org-export-preserve-breaks
12628 @vindex org-export-with-priority
12629 @vindex org-export-publishing-directory
12630 @vindex org-export-with-section-numbers
12631 @vindex org-export-select-tags
12632 @vindex org-export-with-special-strings
12633 @vindex org-export-with-sub-superscripts
12634 @vindex org-export-with-toc
12635 @vindex org-export-with-tables
12636 @vindex org-export-with-tags
12637 @vindex org-export-with-tasks
12638 @vindex org-export-with-timestamps
12639 @vindex org-export-with-todo-keywords
12641 @multitable @columnfractions 0.32 0.68
12642 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
12643 @item @code{:author}                @tab @code{org-export-with-author}
12644 @item @code{:creator}               @tab @code{org-export-with-creator}
12645 @item @code{:customtime}            @tab @code{org-display-custom-times}
12646 @item @code{:drawers}               @tab @code{org-export-with-drawers}
12647 @item @code{:email}                 @tab @code{org-export-with-email}
12648 @item @code{:email}                 @tab @code{user-mail-address} : @code{addr;addr;..}
12649 @item @code{:emphasize}             @tab @code{org-export-with-emphasize}
12650 @item @code{:exclude-tags}          @tab @code{org-export-exclude-tags}
12651 @item @code{:fixed-width}           @tab @code{org-export-with-fixed-width}
12652 @item @code{:footnotes}             @tab @code{org-export-with-footnotes}
12653 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
12654 @item @code{:language}              @tab @code{org-export-default-language}
12655 @item @code{:latex-fragments}       @tab @code{org-export-with-latex}
12656 @item @code{:preserve-breaks}       @tab @code{org-export-preserve-breaks}
12657 @item @code{:priority}              @tab @code{org-export-with-priority}
12658 @item @code{:publishing-directory}  @tab @code{org-export-publishing-directory}
12659 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
12660 @item @code{:select-tags}           @tab @code{org-export-select-tags}
12661 @item @code{:special-strings}       @tab @code{org-export-with-special-strings}
12662 @item @code{:sub-superscript}       @tab @code{org-export-with-sub-superscripts}
12663 @item @code{:table-of-contents}     @tab @code{org-export-with-toc}
12664 @item @code{:tables}                @tab @code{org-export-with-tables}
12665 @item @code{:tags}                  @tab @code{org-export-with-tags}
12666 @item @code{:tasks}                 @tab @code{org-export-with-tasks}
12667 @item @code{:timestamps}            @tab @code{org-export-with-timestamps}
12668 @item @code{:todo-keywords}         @tab @code{org-export-with-todo-keywords}
12669 @end multitable
12671 @vindex org-html-doctype
12672 @vindex org-html-xml-declaration
12673 @vindex org-html-link-up
12674 @vindex org-html-link-home
12675 @vindex org-html-link-org-files-as-html
12676 @vindex org-html-head
12677 @vindex org-html-head-extra
12678 @vindex org-html-inline-images
12679 @vindex org-html-extension
12680 @vindex org-html-preamble
12681 @vindex org-html-postamble
12682 @vindex org-html-table-default-attributes
12683 @vindex org-html-style-include-default
12684 @vindex org-html-style-include-scripts
12685 @multitable @columnfractions 0.32 0.68
12686 @item @code{:html-doctype}          @tab @code{org-html-doctype}
12687 @item @code{:html-xml-declaration}  @tab @code{org-html-xml-declaration}
12688 @item @code{:html-link-up}          @tab @code{org-html-link-up}
12689 @item @code{:html-link-home}        @tab @code{org-html-link-home}
12690 @item @code{:html-link-org-as-html} @tab @code{org-html-link-org-files-as-html}
12691 @item @code{:html-head}             @tab @code{org-html-head}
12692 @item @code{:html-head-extra}       @tab @code{org-html-head-extra}
12693 @item @code{:html-inline-images}    @tab @code{org-html-inline-images}
12694 @item @code{:html-extension}        @tab @code{org-html-extension}
12695 @item @code{:html-preamble}         @tab @code{org-html-preamble}
12696 @item @code{:html-postamble}        @tab @code{org-html-postamble}
12697 @item @code{:html-table-attributes}        @tab @code{org-html-table-default-attributes}
12698 @item @code{:html-head-include-default-style} @tab @code{org-html-style-include-default}
12699 @item @code{:html-head-include-scripts} @tab @code{org-html-style-include-scripts}
12700 @end multitable
12702 Most of the @code{org-export-with-*} variables have the same effect in each
12703 exporter.
12705 @vindex org-publish-project-alist
12706 When a property is given a value in @code{org-publish-project-alist}, its
12707 setting overrides the value of the corresponding user variable (if any)
12708 during publishing.  Options set within a file (@pxref{Export settings}),
12709 however, override everything.
12711 @node Publishing links, Sitemap, Publishing options, Configuration
12712 @subsection Links between published files
12713 @cindex links, publishing
12715 To create a link from one Org file to another, you would use something like
12716 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
12717 (@pxref{Hyperlinks}).  When published, this link becomes a link to
12718 @file{foo.html}.  You can thus interlink the pages of your "org web" project
12719 and the links will work as expected when you publish them to HTML@.  If you
12720 also publish the Org source file and want to link to it, use an @code{http:}
12721 link instead of a @code{file:} link, because @code{file:} links are converted
12722 to link to the corresponding @file{html} file.
12724 You may also link to related files, such as images.  Provided you are careful
12725 with relative file names, and provided you have also configured Org to upload
12726 the related files, these links will work too.  See @ref{Complex example}, for
12727 an example of this usage.
12729 @node Sitemap, Generating an index, Publishing links, Configuration
12730 @subsection Generating a sitemap
12731 @cindex sitemap, of published pages
12733 The following properties may be used to control publishing of
12734 a map of files for a given project.
12736 @multitable @columnfractions 0.35 0.65
12737 @item @code{:auto-sitemap}
12738 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
12739 or @code{org-publish-all}.
12741 @item @code{:sitemap-filename}
12742 @tab Filename for output of sitemap.  Defaults to @file{sitemap.org} (which
12743 becomes @file{sitemap.html}).
12745 @item @code{:sitemap-title}
12746 @tab Title of sitemap page.  Defaults to name of file.
12748 @item @code{:sitemap-function}
12749 @tab Plug-in function to use for generation of the sitemap.
12750 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
12751 of links to all files in the project.
12753 @item @code{:sitemap-sort-folders}
12754 @tab Where folders should appear in the sitemap.  Set this to @code{first}
12755 (default) or @code{last} to display folders first or last,
12756 respectively.  Any other value will mix files and folders.
12758 @item @code{:sitemap-sort-files}
12759 @tab How the files are sorted in the site map.  Set this to
12760 @code{alphabetically} (default), @code{chronologically} or
12761 @code{anti-chronologically}.  @code{chronologically} sorts the files with
12762 older date first while @code{anti-chronologically} sorts the files with newer
12763 date first.  @code{alphabetically} sorts the files alphabetically.  The date of
12764 a file is retrieved with @code{org-publish-find-date}.
12766 @item @code{:sitemap-ignore-case}
12767 @tab Should sorting be case-sensitive?  Default @code{nil}.
12769 @item @code{:sitemap-file-entry-format}
12770 @tab With this option one can tell how a sitemap's entry is formatted in the
12771 sitemap.  This is a format string with some escape sequences: @code{%t} stands
12772 for the title of the file, @code{%a} stands for the author of the file and
12773 @code{%d} stands for the date of the file.  The date is retrieved with the
12774 @code{org-publish-find-date} function and formatted with
12775 @code{org-publish-sitemap-date-format}.  Default @code{%t}.
12777 @item @code{:sitemap-date-format}
12778 @tab Format string for the @code{format-time-string} function that tells how
12779 a sitemap entry's date is to be formatted.  This property bypasses
12780 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
12782 @item @code{:sitemap-sans-extension}
12783 @tab When non-nil, remove filenames' extensions from the generated sitemap.
12784 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
12785 Defaults to @code{nil}.
12787 @end multitable
12789 @node Generating an index,  , Sitemap, Configuration
12790 @subsection Generating an index
12791 @cindex index, in a publishing project
12793 Org mode can generate an index across the files of a publishing project.
12795 @multitable @columnfractions 0.25 0.75
12796 @item @code{:makeindex}
12797 @tab When non-nil, generate in index in the file @file{theindex.org} and
12798 publish it as @file{theindex.html}.
12799 @end multitable
12801 The file will be created when first publishing a project with the
12802 @code{:makeindex} set.  The file only contains a statement @code{#+INCLUDE:
12803 "theindex.inc"}.  You can then build around this include statement by adding
12804 a title, style information, etc.
12806 @node Uploading files, Sample configuration, Configuration, Publishing
12807 @section Uploading files
12808 @cindex rsync
12809 @cindex unison
12811 For those people already utilizing third party sync tools such as
12812 @command{rsync} or @command{unison}, it might be preferable not to use the built in
12813 @i{remote} publishing facilities of Org mode which rely heavily on
12814 Tramp.  Tramp, while very useful and powerful, tends not to be
12815 so efficient for multiple file transfer and has been known to cause problems
12816 under heavy usage.
12818 Specialized synchronization utilities offer several advantages.  In addition
12819 to timestamp comparison, they also do content and permissions/attribute
12820 checks.  For this reason you might prefer to publish your web to a local
12821 directory (possibly even @i{in place} with your Org files) and then use
12822 @file{unison} or @file{rsync} to do the synchronization with the remote host.
12824 Since Unison (for example) can be configured as to which files to transfer to
12825 a certain remote destination, it can greatly simplify the project publishing
12826 definition.  Simply keep all files in the correct location, process your Org
12827 files with @code{org-publish} and let the synchronization tool do the rest.
12828 You do not need, in this scenario, to include attachments such as @file{jpg},
12829 @file{css} or @file{gif} files in the project definition since the 3rd party
12830 tool syncs them.
12832 Publishing to a local directory is also much faster than to a remote one, so
12833 that you can afford more easily to republish entire projects.  If you set
12834 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
12835 benefit of re-including any changed external files such as source example
12836 files you might include with @code{#+INCLUDE:}.  The timestamp mechanism in
12837 Org is not smart enough to detect if included files have been modified.
12839 @node Sample configuration, Triggering publication, Uploading files, Publishing
12840 @section Sample configuration
12842 Below we provide two example configurations.  The first one is a simple
12843 project publishing only a set of Org files.  The second example is
12844 more complex, with a multi-component project.
12846 @menu
12847 * Simple example::              One-component publishing
12848 * Complex example::             A multi-component publishing example
12849 @end menu
12851 @node Simple example, Complex example, Sample configuration, Sample configuration
12852 @subsection Example: simple publishing configuration
12854 This example publishes a set of Org files to the @file{public_html}
12855 directory on the local machine.
12857 @lisp
12858 (setq org-publish-project-alist
12859       '(("org"
12860          :base-directory "~/org/"
12861          :publishing-directory "~/public_html"
12862          :section-numbers nil
12863          :table-of-contents nil
12864          :style "<link rel=\"stylesheet\"
12865                 href=\"../other/mystyle.css\"
12866                 type=\"text/css\"/>")))
12867 @end lisp
12869 @node Complex example,  , Simple example, Sample configuration
12870 @subsection Example: complex publishing configuration
12872 This more complicated example publishes an entire website, including
12873 Org files converted to HTML, image files, Emacs Lisp source code, and
12874 style sheets.  The publishing directory is remote and private files are
12875 excluded.
12877 To ensure that links are preserved, care should be taken to replicate
12878 your directory structure on the web server, and to use relative file
12879 paths.  For example, if your Org files are kept in @file{~/org} and your
12880 publishable images in @file{~/images}, you would link to an image with
12882 @example
12883 file:../images/myimage.png
12884 @end example
12886 On the web server, the relative path to the image should be the
12887 same.  You can accomplish this by setting up an "images" folder in the
12888 right place on the web server, and publishing images to it.
12890 @lisp
12891 (setq org-publish-project-alist
12892       '(("orgfiles"
12893           :base-directory "~/org/"
12894           :base-extension "org"
12895           :publishing-directory "/ssh:user@@host:~/html/notebook/"
12896           :publishing-function org-html-publish-to-html
12897           :exclude "PrivatePage.org"   ;; regexp
12898           :headline-levels 3
12899           :section-numbers nil
12900           :table-of-contents nil
12901           :style "<link rel=\"stylesheet\"
12902                   href=\"../other/mystyle.css\" type=\"text/css\"/>"
12903           :html-preamble t)
12905          ("images"
12906           :base-directory "~/images/"
12907           :base-extension "jpg\\|gif\\|png"
12908           :publishing-directory "/ssh:user@@host:~/html/images/"
12909           :publishing-function org-publish-attachment)
12911          ("other"
12912           :base-directory "~/other/"
12913           :base-extension "css\\|el"
12914           :publishing-directory "/ssh:user@@host:~/html/other/"
12915           :publishing-function org-publish-attachment)
12916          ("website" :components ("orgfiles" "images" "other"))))
12917 @end lisp
12919 @node Triggering publication,  , Sample configuration, Publishing
12920 @section Triggering publication
12922 Once properly configured, Org can publish with the following commands:
12924 @table @kbd
12925 @orgcmd{C-c C-e P x,org-publish}
12926 Prompt for a specific project and publish all files that belong to it.
12927 @orgcmd{C-c C-e P p,org-publish-current-project}
12928 Publish the project containing the current file.
12929 @orgcmd{C-c C-e P f,org-publish-current-file}
12930 Publish only the current file.
12931 @orgcmd{C-c C-e P a,org-publish-all}
12932 Publish every project.
12933 @end table
12935 @vindex org-publish-use-timestamps-flag
12936 Org uses timestamps to track when a file has changed.  The above functions
12937 normally only publish changed files.  You can override this and force
12938 publishing of all files by giving a prefix argument to any of the commands
12939 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
12940 This may be necessary in particular if files include other files via
12941 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
12943 @comment  node-name,  next,  previous,  up
12944 @comment Working With Source Code, Miscellaneous, Publishing, Top
12946 @node Working With Source Code, Miscellaneous, Publishing, Top
12947 @chapter Working with source code
12948 @cindex Schulte, Eric
12949 @cindex Davison, Dan
12950 @cindex source code, working with
12952 Source code can be included in Org mode documents using a @samp{src} block,
12953 e.g.:
12955 @example
12956 #+BEGIN_SRC emacs-lisp
12957   (defun org-xor (a b)
12958      "Exclusive or."
12959      (if a (not b) b))
12960 #+END_SRC
12961 @end example
12963 Org mode provides a number of features for working with live source code,
12964 including editing of code blocks in their native major-mode, evaluation of
12965 code blocks, converting code blocks into source files (known as @dfn{tangling}
12966 in literate programming), and exporting code blocks and their
12967 results in several formats.  This functionality was contributed by Eric
12968 Schulte and Dan Davison, and was originally named Org-babel.
12970 The following sections describe Org mode's code block handling facilities.
12972 @menu
12973 * Structure of code blocks::    Code block syntax described
12974 * Editing source code::         Language major-mode editing
12975 * Exporting code blocks::       Export contents and/or results
12976 * Extracting source code::      Create pure source code files
12977 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
12978 * Library of Babel::            Use and contribute to a library of useful code blocks
12979 * Languages::                   List of supported code block languages
12980 * Header arguments::            Configure code block functionality
12981 * Results of evaluation::       How evaluation results are handled
12982 * Noweb reference syntax::      Literate programming in Org mode
12983 * Key bindings and useful functions::  Work quickly with code blocks
12984 * Batch execution::             Call functions from the command line
12985 @end menu
12987 @comment  node-name,  next,  previous,  up
12988 @comment  Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12990 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12991 @section Structure of code blocks
12992 @cindex code block, structure
12993 @cindex source code, block structure
12994 @cindex #+NAME
12995 @cindex #+BEGIN_SRC
12997 Live code blocks can be specified with a @samp{src} block or
12998 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
12999 @ref{Easy Templates} system}  The structure of a @samp{src} block is
13001 @example
13002 #+NAME: <name>
13003 #+BEGIN_SRC <language> <switches> <header arguments>
13004   <body>
13005 #+END_SRC
13006 @end example
13008 The @code{#+NAME:} line is optional, and can be used to name the code
13009 block.  Live code blocks require that a language be specified on the
13010 @code{#+BEGIN_SRC} line.  Switches and header arguments are optional.
13011 @cindex source code, inline
13013 Live code blocks can also be specified inline using
13015 @example
13016 src_<language>@{<body>@}
13017 @end example
13021 @example
13022 src_<language>[<header arguments>]@{<body>@}
13023 @end example
13025 @table @code
13026 @item <#+NAME: name>
13027 This line associates a name with the code block.  This is similar to the
13028 @code{#+NAME: Name} lines that can be used to name tables in Org mode
13029 files.  Referencing the name of a code block makes it possible to evaluate
13030 the block from other places in the file, from other files, or from Org mode
13031 table formulas (see @ref{The spreadsheet}).  Names are assumed to be unique
13032 and the behavior of Org mode when two or more blocks share the same name is
13033 undefined.
13034 @cindex #+NAME
13035 @item <language>
13036 The language of the code in the block (see @ref{Languages}).
13037 @cindex source code, language
13038 @item <switches>
13039 Optional switches control code block export (see the discussion of switches in
13040 @ref{Literal examples})
13041 @cindex source code, switches
13042 @item <header arguments>
13043 Optional header arguments control many aspects of evaluation, export and
13044 tangling of code blocks (see @ref{Header arguments}).
13045 Header arguments can also be set on a per-buffer or per-subtree
13046 basis using properties.
13047 @item source code, header arguments
13048 @item <body>
13049 Source code in the specified language.
13050 @end table
13052 @comment  node-name,  next,  previous,  up
13053 @comment  Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
13055 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
13056 @section Editing source code
13057 @cindex code block, editing
13058 @cindex source code, editing
13060 @kindex C-c '
13061 Use @kbd{C-c '} to edit the current code block.  This brings up
13062 a language major-mode edit buffer containing the body of the code
13063 block.  Saving this buffer will write the new contents back to the Org
13064 buffer.  Use @kbd{C-c '} again to exit.
13066 The @code{org-src-mode} minor mode will be active in the edit buffer.  The
13067 following variables can be used to configure the behavior of the edit
13068 buffer.  See also the customization group @code{org-edit-structure} for
13069 further configuration options.
13071 @table @code
13072 @item org-src-lang-modes
13073 If an Emacs major-mode named @code{<lang>-mode} exists, where
13074 @code{<lang>} is the language named in the header line of the code block,
13075 then the edit buffer will be placed in that major-mode.  This variable
13076 can be used to map arbitrary language names to existing major modes.
13077 @item org-src-window-setup
13078 Controls the way Emacs windows are rearranged when the edit buffer is created.
13079 @item org-src-preserve-indentation
13080 This variable is especially useful for tangling languages such as
13081 Python, in which whitespace indentation in the output is critical.
13082 @item org-src-ask-before-returning-to-edit-buffer
13083 By default, Org will ask before returning to an open edit buffer.  Set this
13084 variable to nil to switch without asking.
13085 @end table
13087 To turn on native code fontification in the @emph{Org} buffer, configure the
13088 variable @code{org-src-fontify-natively}.
13090 @comment  node-name,  next,  previous,  up
13091 @comment  Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
13093 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
13094 @section Exporting code blocks
13095 @cindex code block, exporting
13096 @cindex source code, exporting
13098 It is possible to export the @emph{code} of code blocks, the @emph{results}
13099 of code block evaluation, @emph{both} the code and the results of code block
13100 evaluation, or @emph{none}.  For most languages, the default exports code.
13101 However, for some languages (e.g., @code{ditaa}) the default exports the
13102 results of code block evaluation.  For information on exporting code block
13103 bodies, see @ref{Literal examples}.
13105 The @code{:exports} header argument can be used to specify export
13106 behavior:
13108 @subsubheading Header arguments:
13110 @table @code
13111 @item :exports code
13112 The default in most languages.  The body of the code block is exported, as
13113 described in @ref{Literal examples}.
13114 @item :exports results
13115 The code block will be evaluated and the results will be placed in the
13116 Org mode buffer for export, either updating previous results of the code
13117 block located anywhere in the buffer or, if no previous results exist,
13118 placing the results immediately after the code block.  The body of the code
13119 block will not be exported.
13120 @item :exports both
13121 Both the code block and its results will be exported.
13122 @item :exports none
13123 Neither the code block nor its results will be exported.
13124 @end table
13126 It is possible to inhibit the evaluation of code blocks during export.
13127 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
13128 ensure that no code blocks are evaluated as part of the export process.  This
13129 can be useful in situations where potentially untrusted Org mode files are
13130 exported in an automated fashion, for example when Org mode is used as the
13131 markup language for a wiki.
13133 @comment  node-name,  next,  previous,  up
13134 @comment  Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
13135 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
13136 @section Extracting source code
13137 @cindex tangling
13138 @cindex source code, extracting
13139 @cindex code block, extracting source code
13141 Creating pure source code files by extracting code from source blocks is
13142 referred to as ``tangling''---a term adopted from the literate programming
13143 community.  During ``tangling'' of code blocks their bodies are expanded
13144 using @code{org-babel-expand-src-block} which can expand both variable and
13145 ``noweb'' style references  (see @ref{Noweb reference syntax}).
13147 @subsubheading Header arguments
13149 @table @code
13150 @item :tangle no
13151 The default.  The code block is not included in the tangled output.
13152 @item :tangle yes
13153 Include the code block in the tangled output.  The output file name is the
13154 name of the org file with the extension @samp{.org} replaced by the extension
13155 for the block language.
13156 @item :tangle filename
13157 Include the code block in the tangled output to file @samp{filename}.
13158 @end table
13160 @kindex  C-c C-v t
13161 @subsubheading Functions
13163 @table @code
13164 @item org-babel-tangle
13165 Tangle the current file.  Bound to @kbd{C-c C-v t}.
13167 With prefix argument only tangle the current code block.
13168 @item org-babel-tangle-file
13169 Choose a file to tangle.  Bound to @kbd{C-c C-v f}.
13170 @end table
13172 @subsubheading Hooks
13174 @table @code
13175 @item org-babel-post-tangle-hook
13176 This hook is run from within code files tangled by @code{org-babel-tangle}.
13177 Example applications could include post-processing, compilation or evaluation
13178 of tangled code files.
13179 @end table
13181 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
13182 @section Evaluating code blocks
13183 @cindex code block, evaluating
13184 @cindex source code, evaluating
13185 @cindex #+RESULTS
13187 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
13188 potential for that code to do harm.  Org mode provides safeguards to ensure
13189 that code is only evaluated after explicit confirmation from the user.  For
13190 information on these safeguards (and on how to disable them) see @ref{Code
13191 evaluation security}.} and the results of evaluation optionally placed in the
13192 Org mode buffer.  The results of evaluation are placed following a line that
13193 begins by default with @code{#+RESULTS} and optionally a cache identifier
13194 and/or the name of the evaluated code block.  The default value of
13195 @code{#+RESULTS} can be changed with the customizable variable
13196 @code{org-babel-results-keyword}.
13198 By default, the evaluation facility is only enabled for Lisp code blocks
13199 specified as @code{emacs-lisp}.  However, source code blocks in many languages
13200 can be evaluated within Org mode (see @ref{Languages} for a list of supported
13201 languages and @ref{Structure of code blocks} for information on the syntax
13202 used to define a code block).
13204 @kindex C-c C-c
13205 There are a number of ways to evaluate code blocks.  The simplest is to press
13206 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
13207 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
13208 evaluation from the @kbd{C-c C-c} key binding.}.  This will call the
13209 @code{org-babel-execute-src-block} function to evaluate the block and insert
13210 its results into the Org mode buffer.
13211 @cindex #+CALL
13213 It is also possible to evaluate named code blocks from anywhere in an Org
13214 mode buffer or an Org mode table.  Live code blocks located in the current
13215 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
13216 can be executed.  Named code blocks can be executed with a separate
13217 @code{#+CALL:} line or inline within a block of text.
13219 The syntax of the @code{#+CALL:} line is
13221 @example
13222 #+CALL: <name>(<arguments>)
13223 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
13224 @end example
13226 The syntax for inline evaluation of named code blocks is
13228 @example
13229 ... call_<name>(<arguments>) ...
13230 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
13231 @end example
13233 @table @code
13234 @item <name>
13235 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
13236 @item <arguments>
13237 Arguments specified in this section will be passed to the code block.  These
13238 arguments use standard function call syntax, rather than
13239 header argument syntax.  For example, a @code{#+CALL:} line that passes the
13240 number four to a code block named @code{double}, which declares the header
13241 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
13242 @item <inside header arguments>
13243 Inside header arguments are passed through and applied to the named code
13244 block.  These arguments use header argument syntax rather than standard
13245 function call syntax.  Inside header arguments affect how the code block is
13246 evaluated.  For example, @code{[:results output]} will collect the results of
13247 everything printed to @code{STDOUT} during execution of the code block.
13248 @item <end header arguments>
13249 End header arguments are applied to the calling instance and do not affect
13250 evaluation of the named code block.  They affect how the results are
13251 incorporated into the Org mode buffer and how the call line is exported.  For
13252 example, @code{:results html} will insert the results of the call line
13253 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
13255 For more examples of passing header arguments to @code{#+CALL:} lines see
13256 @ref{Header arguments in function calls}.
13257 @end table
13259 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
13260 @section Library of Babel
13261 @cindex babel, library of
13262 @cindex source code, library
13263 @cindex code block, library
13265 The ``Library of Babel'' consists of code blocks that can be called from any
13266 Org mode file.  Code blocks defined in the ``Library of Babel'' can be called
13267 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
13268 code blocks} for information on the syntax of remote code block evaluation).
13271 The central repository of code blocks in the ``Library of Babel'' is housed
13272 in an Org mode file located in the @samp{contrib} directory of Org mode.
13274 Users can add code blocks they believe to be generally useful to their
13275 ``Library of Babel.''  The code blocks can be stored in any Org mode file and
13276 then loaded into the library with @code{org-babel-lob-ingest}.
13279 @kindex C-c C-v i
13280 Code blocks located in any Org mode file can be loaded into the ``Library of
13281 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
13284 @node Languages, Header arguments, Library of Babel, Working With Source Code
13285 @section Languages
13286 @cindex babel, languages
13287 @cindex source code, languages
13288 @cindex code block, languages
13290 Code blocks in the following languages are supported.
13292 @multitable @columnfractions 0.28 0.3 0.22 0.2
13293 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
13294 @item Asymptote @tab asymptote @tab Awk @tab awk
13295 @item Emacs Calc @tab calc @tab C @tab C
13296 @item C++ @tab C++ @tab Clojure @tab clojure
13297 @item CSS @tab css @tab ditaa @tab ditaa
13298 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
13299 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
13300 @item Java @tab java @tab @tab
13301 @item Javascript @tab js @tab LaTeX @tab latex
13302 @item Ledger @tab ledger @tab Lisp @tab lisp
13303 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
13304 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
13305 @item Octave @tab octave @tab Org mode @tab org
13306 @item Oz @tab oz @tab Perl @tab perl
13307 @item Plantuml @tab plantuml @tab Python @tab python
13308 @item R @tab R @tab Ruby @tab ruby
13309 @item Sass @tab sass @tab Scheme @tab scheme
13310 @item GNU Screen @tab screen @tab shell @tab sh
13311 @item SQL @tab sql @tab SQLite @tab sqlite
13312 @end multitable
13314 Language-specific documentation is available for some languages.  If
13315 available, it can be found at
13316 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
13318 The @code{org-babel-load-languages} controls which languages are enabled for
13319 evaluation (by default only @code{emacs-lisp} is enabled).  This variable can
13320 be set using the customization interface or by adding code like the following
13321 to your emacs configuration.
13323 @quotation
13324 The following disables @code{emacs-lisp} evaluation and enables evaluation of
13325 @code{R} code blocks.
13326 @end quotation
13328 @lisp
13329 (org-babel-do-load-languages
13330  'org-babel-load-languages
13331  '((emacs-lisp . nil)
13332    (R . t)))
13333 @end lisp
13335 It is also possible to enable support for a language by loading the related
13336 elisp file with @code{require}.
13338 @quotation
13339 The following adds support for evaluating @code{clojure} code blocks.
13340 @end quotation
13342 @lisp
13343 (require 'ob-clojure)
13344 @end lisp
13346 @node Header arguments, Results of evaluation, Languages, Working With Source Code
13347 @section Header arguments
13348 @cindex code block, header arguments
13349 @cindex source code, block header arguments
13351 Code block functionality can be configured with header arguments.  This
13352 section provides an overview of the use of header arguments, and then
13353 describes each header argument in detail.
13355 @menu
13356 * Using header arguments::      Different ways to set header arguments
13357 * Specific header arguments::   List of header arguments
13358 @end menu
13360 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
13361 @subsection Using header arguments
13363 The values of header arguments can be set in six different ways, each more
13364 specific (and having higher priority) than the last.
13365 @menu
13366 * System-wide header arguments::  Set global default values
13367 * Language-specific header arguments::  Set default values by language
13368 * Buffer-wide header arguments::  Set default values for a specific buffer
13369 * Header arguments in Org mode properties::  Set default values for a buffer or heading
13370 * Code block specific header arguments::  The most common way to set values
13371 * Header arguments in function calls::  The most specific level
13372 @end menu
13375 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
13376 @subsubheading System-wide header arguments
13377 @vindex org-babel-default-header-args
13378 System-wide values of header arguments can be specified by adapting the
13379 @code{org-babel-default-header-args} variable:
13381 @example
13382 :session    => "none"
13383 :results    => "replace"
13384 :exports    => "code"
13385 :cache      => "no"
13386 :noweb      => "no"
13387 @end example
13389 For example, the following example could be used to set the default value of
13390 @code{:noweb} header arguments to @code{yes}.  This would have the effect of
13391 expanding @code{:noweb} references by default when evaluating source code
13392 blocks.
13394 @lisp
13395 (setq org-babel-default-header-args
13396       (cons '(:noweb . "yes")
13397             (assq-delete-all :noweb org-babel-default-header-args)))
13398 @end lisp
13400 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
13401 @subsubheading Language-specific header arguments
13402 Each language can define its own set of default header arguments.  See the
13403 language-specific documentation available online at
13404 @uref{http://orgmode.org/worg/org-contrib/babel}.
13406 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
13407 @subsubheading Buffer-wide header arguments
13408 Buffer-wide header arguments may be specified as properties through the use
13409 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
13410 @ref{Property syntax}).
13412 For example the following would set @code{session} to @code{*R*}, and
13413 @code{results} to @code{silent} for every code block in the buffer, ensuring
13414 that all execution took place in the same session, and no results would be
13415 inserted into the buffer.
13417 @example
13418 #+PROPERTY: session *R*
13419 #+PROPERTY: results silent
13420 @end example
13422 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
13423 @subsubheading Header arguments in Org mode properties
13425 Header arguments are also read from Org mode properties (see @ref{Property
13426 syntax}), which can be set on a buffer-wide or per-heading basis.  An example
13427 of setting a header argument for all code blocks in a buffer is
13429 @example
13430 #+PROPERTY: tangle yes
13431 @end example
13433 @vindex org-use-property-inheritance
13434 When properties are used to set default header arguments, they are looked up
13435 with inheritance, regardless of the value of
13436 @code{org-use-property-inheritance}.  In the following example the value of
13437 the @code{:cache} header argument will default to @code{yes} in all code
13438 blocks in the subtree rooted at the following heading:
13440 @example
13441 * outline header
13442   :PROPERTIES:
13443   :cache:    yes
13444   :END:
13445 @end example
13447 @kindex C-c C-x p
13448 @vindex org-babel-default-header-args
13449 Properties defined in this way override the properties set in
13450 @code{org-babel-default-header-args}.  It is convenient to use the
13451 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
13452 in Org mode documents.
13454 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
13455 @subsubheading Code block specific header arguments
13457 The most common way to assign values to header arguments is at the
13458 code block level.  This can be done by listing a sequence of header
13459 arguments and their values as part of the @code{#+BEGIN_SRC} line.
13460 Properties set in this way override both the values of
13461 @code{org-babel-default-header-args} and header arguments specified as
13462 properties.  In the following example, the @code{:results} header argument
13463 is set to @code{silent}, meaning the results of execution will not be
13464 inserted in the buffer, and the @code{:exports} header argument is set to
13465 @code{code}, meaning only the body of the code block will be
13466 preserved on export to HTML or @LaTeX{}.
13468 @example
13469 #+NAME: factorial
13470 #+BEGIN_SRC haskell :results silent :exports code :var n=0
13471 fac 0 = 1
13472 fac n = n * fac (n-1)
13473 #+END_SRC
13474 @end example
13475 Similarly, it is possible to set header arguments for inline code blocks
13477 @example
13478 src_haskell[:exports both]@{fac 5@}
13479 @end example
13481 Code block header arguments can span multiple lines using @code{#+HEADER:} or
13482 @code{#+HEADERS:} lines preceding a code block or nested between the
13483 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
13484 @cindex #+HEADER:
13485 @cindex #+HEADERS:
13487 Multi-line header arguments on an un-named code block:
13489 @example
13490  #+HEADERS: :var data1=1
13491  #+BEGIN_SRC emacs-lisp :var data2=2
13492    (message "data1:%S, data2:%S" data1 data2)
13493  #+END_SRC
13495  #+RESULTS:
13496  : data1:1, data2:2
13497 @end example
13499 Multi-line header arguments on a named code block:
13501 @example
13502    #+NAME: named-block
13503    #+HEADER: :var data=2
13504    #+BEGIN_SRC emacs-lisp
13505      (message "data:%S" data)
13506    #+END_SRC
13508    #+RESULTS: named-block
13509    : data:2
13510 @end example
13512 @node Header arguments in function calls,  , Code block specific header arguments, Using header arguments
13513 @comment  node-name,  next,  previous,  up
13514 @subsubheading Header arguments in function calls
13516 At the most specific level, header arguments for ``Library of Babel'' or
13517 @code{#+CALL:} lines can be set as shown in the two examples below.  For more
13518 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
13519 blocks}.
13521 The following will apply the @code{:exports results} header argument to the
13522 evaluation of the @code{#+CALL:} line.
13524 @example
13525 #+CALL: factorial(n=5) :exports results
13526 @end example
13528 The following will apply the @code{:session special} header argument to the
13529 evaluation of the @code{factorial} code block.
13531 @example
13532 #+CALL: factorial[:session special](n=5)
13533 @end example
13535 @node Specific header arguments,  , Using header arguments, Header arguments
13536 @subsection Specific header arguments
13537 Header arguments consist of an initial colon followed by the name of the
13538 argument in lowercase letters.  The following header arguments are defined:
13540 @menu
13541 * var::                         Pass arguments to code blocks
13542 * results::                     Specify the type of results and how they will
13543                                 be collected and handled
13544 * file::                        Specify a path for file output
13545 * file-desc::                   Specify a description for file results
13546 * dir::                         Specify the default (possibly remote)
13547                                 directory for code block execution
13548 * exports::                     Export code and/or results
13549 * tangle::                      Toggle tangling and specify file name
13550 * mkdirp::                      Toggle creation of parent directories of target
13551                                 files during tangling
13552 * comments::                    Toggle insertion of comments in tangled
13553                                 code files
13554 * padline::                     Control insertion of padding lines in tangled
13555                                 code files
13556 * no-expand::                   Turn off variable assignment and noweb
13557                                 expansion during tangling
13558 * session::                     Preserve the state of code evaluation
13559 * noweb::                       Toggle expansion of noweb references
13560 * noweb-ref::                   Specify block's noweb reference resolution target
13561 * noweb-sep::                   String used to separate noweb references
13562 * cache::                       Avoid re-evaluating unchanged code blocks
13563 * sep::                         Delimiter for writing tabular results outside Org
13564 * hlines::                      Handle horizontal lines in tables
13565 * colnames::                    Handle column names in tables
13566 * rownames::                    Handle row names in tables
13567 * shebang::                     Make tangled files executable
13568 * eval::                        Limit evaluation of specific code blocks
13569 * wrap::                        Mark source block evaluation results
13570 * post::                        Post processing of code block results
13571 @end menu
13573 Additional header arguments are defined on a language-specific basis, see
13574 @ref{Languages}.
13576 @node var, results, Specific header arguments, Specific header arguments
13577 @subsubsection @code{:var}
13578 The @code{:var} header argument is used to pass arguments to code blocks.
13579 The specifics of how arguments are included in a code block vary by language;
13580 these are addressed in the language-specific documentation.  However, the
13581 syntax used to specify arguments is the same across all languages.  In every
13582 case, variables require a default value when they are declared.
13584 The values passed to arguments can either be literal values, references, or
13585 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
13586 References include anything in the Org mode file that takes a @code{#+NAME:}
13587 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
13588 other code blocks and the results of other code blocks.
13590 Note: When a reference is made to another code block, the referenced block
13591 will be evaluated unless it has current cached results (see @ref{cache}).
13593 Argument values can be indexed in a manner similar to arrays (see @ref{var,
13594 Indexable variable values}).
13596 The following syntax is used to pass arguments to code blocks using the
13597 @code{:var} header argument.
13599 @example
13600 :var name=assign
13601 @end example
13603 The argument, @code{assign}, can either be a literal value, such as a string
13604 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
13605 literal example, another code block (with or without arguments), or the
13606 results of evaluating another code block.
13608 Here are examples of passing values by reference:
13610 @table @dfn
13612 @item table
13613 an Org mode table named with either a @code{#+NAME:} line
13615 @example
13616 #+NAME: example-table
13617 | 1 |
13618 | 2 |
13619 | 3 |
13620 | 4 |
13622 #+NAME: table-length
13623 #+BEGIN_SRC emacs-lisp :var table=example-table
13624 (length table)
13625 #+END_SRC
13627 #+RESULTS: table-length
13628 : 4
13629 @end example
13631 @item list
13632 a simple list named with a @code{#+NAME:} line (note that nesting is not
13633 carried through to the source code block)
13635 @example
13636 #+NAME: example-list
13637   - simple
13638     - not
13639     - nested
13640   - list
13642 #+BEGIN_SRC emacs-lisp :var x=example-list
13643   (print x)
13644 #+END_SRC
13646 #+RESULTS:
13647 | simple | list |
13648 @end example
13650 @item code block without arguments
13651 a code block name (from the example above), as assigned by @code{#+NAME:},
13652 optionally followed by parentheses
13654 @example
13655 #+BEGIN_SRC emacs-lisp :var length=table-length()
13656 (* 2 length)
13657 #+END_SRC
13659 #+RESULTS:
13660 : 8
13661 @end example
13663 @item code block with arguments
13664 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
13665 optional arguments passed within the parentheses following the
13666 code block name using standard function call syntax
13668 @example
13669 #+NAME: double
13670 #+BEGIN_SRC emacs-lisp :var input=8
13671 (* 2 input)
13672 #+END_SRC
13674 #+RESULTS: double
13675 : 16
13677 #+NAME: squared
13678 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
13679 (* input input)
13680 #+END_SRC
13682 #+RESULTS: squared
13683 : 4
13684 @end example
13686 @item literal example
13687 a literal example block named with a @code{#+NAME:} line
13689 @example
13690 #+NAME: literal-example
13691 #+BEGIN_EXAMPLE
13692 A literal example
13693 on two lines
13694 #+END_EXAMPLE
13696 #+NAME: read-literal-example
13697 #+BEGIN_SRC emacs-lisp :var x=literal-example
13698   (concatenate 'string x " for you.")
13699 #+END_SRC
13701 #+RESULTS: read-literal-example
13702 : A literal example
13703 : on two lines for you.
13705 @end example
13707 @end table
13709 @subsubheading Indexable variable values
13710 It is possible to reference portions of variable values by ``indexing'' into
13711 the variables.  Indexes are 0 based with negative values counting back from
13712 the end.  If an index is separated by @code{,}s then each subsequent section
13713 will index into the next deepest nesting or dimension of the value.  Note
13714 that this indexing occurs @emph{before} other table related header arguments
13715 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied.  The
13716 following example assigns the last cell of the first row the table
13717 @code{example-table} to the variable @code{data}:
13719 @example
13720 #+NAME: example-table
13721 | 1 | a |
13722 | 2 | b |
13723 | 3 | c |
13724 | 4 | d |
13726 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
13727   data
13728 #+END_SRC
13730 #+RESULTS:
13731 : a
13732 @end example
13734 Ranges of variable values can be referenced using two integers separated by a
13735 @code{:}, in which case the entire inclusive range is referenced.  For
13736 example the following assigns the middle three rows of @code{example-table}
13737 to @code{data}.
13739 @example
13740 #+NAME: example-table
13741 | 1 | a |
13742 | 2 | b |
13743 | 3 | c |
13744 | 4 | d |
13745 | 5 | 3 |
13747 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
13748   data
13749 #+END_SRC
13751 #+RESULTS:
13752 | 2 | b |
13753 | 3 | c |
13754 | 4 | d |
13755 @end example
13757 Additionally, an empty index, or the single character @code{*}, are both
13758 interpreted to mean the entire range and as such are equivalent to
13759 @code{0:-1}, as shown in the following example in which the entire first
13760 column is referenced.
13762 @example
13763 #+NAME: example-table
13764 | 1 | a |
13765 | 2 | b |
13766 | 3 | c |
13767 | 4 | d |
13769 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
13770   data
13771 #+END_SRC
13773 #+RESULTS:
13774 | 1 | 2 | 3 | 4 |
13775 @end example
13777 It is possible to index into the results of code blocks as well as tables.
13778 Any number of dimensions can be indexed.  Dimensions are separated from one
13779 another by commas, as shown in the following example.
13781 @example
13782 #+NAME: 3D
13783 #+BEGIN_SRC emacs-lisp
13784   '(((1  2  3)  (4  5  6)  (7  8  9))
13785     ((10 11 12) (13 14 15) (16 17 18))
13786     ((19 20 21) (22 23 24) (25 26 27)))
13787 #+END_SRC
13789 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
13790   data
13791 #+END_SRC
13793 #+RESULTS:
13794 | 11 | 14 | 17 |
13795 @end example
13797 @subsubheading Emacs Lisp evaluation of variables
13799 Emacs lisp code can be used to initialize variable values.  When a variable
13800 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
13801 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
13802 the variable value.  The following example demonstrates use of this
13803 evaluation to reliably pass the file-name of the Org mode buffer to a code
13804 block---note that evaluation of header arguments is guaranteed to take place
13805 in the original Org mode file, while there is no such guarantee for
13806 evaluation of the code block body.
13808 @example
13809 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
13810   wc -w $filename
13811 #+END_SRC
13812 @end example
13814 Note that values read from tables and lists will not be evaluated as
13815 Emacs Lisp, as shown in the following example.
13817 @example
13818 #+NAME: table
13819 | (a b c) |
13821 #+HEADERS: :var data=table[0,0]
13822 #+BEGIN_SRC perl
13823   $data
13824 #+END_SRC
13826 #+RESULTS:
13827 : (a b c)
13828 @end example
13830 @node results, file, var, Specific header arguments
13831 @subsubsection @code{:results}
13833 There are four classes of @code{:results} header argument.  Only one option
13834 per class may be supplied per code block.
13836 @itemize @bullet
13837 @item
13838 @b{collection} header arguments specify how the results should be collected
13839 from the code block
13840 @item
13841 @b{type} header arguments specify what type of result the code block will
13842 return---which has implications for how they will be processed before
13843 insertion into the Org mode buffer
13844 @item
13845 @b{format} header arguments specify what type of result the code block will
13846 return---which has implications for how they will be inserted into the
13847 Org mode buffer
13848 @item
13849 @b{handling} header arguments specify how the results of evaluating the code
13850 block should be handled.
13851 @end itemize
13853 @subsubheading Collection
13854 The following options are mutually exclusive, and specify how the results
13855 should be collected from the code block.
13857 @itemize @bullet
13858 @item @code{value}
13859 This is the default.  The result is the value of the last statement in the
13860 code block.  This header argument places the evaluation in functional
13861 mode.  Note that in some languages, e.g., Python, use of this result type
13862 requires that a @code{return} statement be included in the body of the source
13863 code block.  E.g., @code{:results value}.
13864 @item @code{output}
13865 The result is the collection of everything printed to STDOUT during the
13866 execution of the code block.  This header argument places the
13867 evaluation in scripting mode.  E.g., @code{:results output}.
13868 @end itemize
13870 @subsubheading Type
13872 The following options are mutually exclusive and specify what type of results
13873 the code block will return.  By default, results are inserted as either a
13874 table or scalar depending on their value.
13876 @itemize @bullet
13877 @item @code{table}, @code{vector}
13878 The results should be interpreted as an Org mode table.  If a single value is
13879 returned, it will be converted into a table with one row and one column.
13880 E.g., @code{:results value table}.
13881 @item @code{list}
13882 The results should be interpreted as an Org mode list.  If a single scalar
13883 value is returned it will be converted into a list with only one element.
13884 @item @code{scalar}, @code{verbatim}
13885 The results should be interpreted literally---they will not be
13886 converted into a table.  The results will be inserted into the Org mode
13887 buffer as quoted text.  E.g., @code{:results value verbatim}.
13888 @item @code{file}
13889 The results will be interpreted as the path to a file, and will be inserted
13890 into the Org mode buffer as a file link.  E.g., @code{:results value file}.
13891 @end itemize
13893 @subsubheading Format
13895 The following options are mutually exclusive and specify what type of results
13896 the code block will return.  By default, results are inserted according to the
13897 type as specified above.
13899 @itemize @bullet
13900 @item @code{raw}
13901 The results are interpreted as raw Org mode code and are inserted directly
13902 into the buffer.  If the results look like a table they will be aligned as
13903 such by Org mode.  E.g., @code{:results value raw}.
13904 @item @code{org}
13905 The results are will be enclosed in a @code{BEGIN_SRC org} block.
13906 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
13907 in the block and/or if you export the file.  E.g., @code{:results value org}.
13908 @item @code{html}
13909 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
13910 block.  E.g., @code{:results value html}.
13911 @item @code{latex}
13912 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
13913 E.g., @code{:results value latex}.
13914 @item @code{code}
13915 Result are assumed to be parsable code and are enclosed in a code block.
13916 E.g., @code{:results value code}.
13917 @item @code{pp}
13918 The result is converted to pretty-printed code and is enclosed in a code
13919 block.  This option currently supports Emacs Lisp, Python, and Ruby.  E.g.,
13920 @code{:results value pp}.
13921 @item @code{drawer}
13922 The result is wrapped in a RESULTS drawer.  This can be useful for
13923 inserting @code{raw} or @code{org} syntax results in such a way that their
13924 extent is known and they can be automatically removed or replaced.
13925 @end itemize
13927 @subsubheading Handling
13928 The following results options indicate what happens with the
13929 results once they are collected.
13931 @itemize @bullet
13932 @item @code{silent}
13933 The results will be echoed in the minibuffer but will not be inserted into
13934 the Org mode buffer.  E.g., @code{:results output silent}.
13935 @item @code{replace}
13936 The default value.  Any existing results will be removed, and the new results
13937 will be inserted into the Org mode buffer in their place.  E.g.,
13938 @code{:results output replace}.
13939 @item @code{append}
13940 If there are pre-existing results of the code block then the new results will
13941 be appended to the existing results.  Otherwise the new results will be
13942 inserted as with @code{replace}.
13943 @item @code{prepend}
13944 If there are pre-existing results of the code block then the new results will
13945 be prepended to the existing results.  Otherwise the new results will be
13946 inserted as with @code{replace}.
13947 @end itemize
13949 @node file, file-desc, results, Specific header arguments
13950 @subsubsection @code{:file}
13952 The header argument @code{:file} is used to specify an external file in which
13953 to save code block results.  After code block evaluation an Org mode style
13954 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
13955 into the Org mode buffer.  Some languages including R, gnuplot, dot, and
13956 ditaa provide special handling of the @code{:file} header argument
13957 automatically wrapping the code block body in the boilerplate code required
13958 to save output to the specified file.  This is often useful for saving
13959 graphical output of a code block to the specified file.
13961 The argument to @code{:file} should be either a string specifying the path to
13962 a file, or a list of two strings in which case the first element of the list
13963 should be the path to a file and the second a description for the link.
13965 @node file-desc, dir, file, Specific header arguments
13966 @subsubsection @code{:file-desc}
13968 The value of the @code{:file-desc} header argument is used to provide a
13969 description for file code block results which are inserted as Org mode links
13970 (see @ref{Link format}).  If the @code{:file-desc} header argument is given
13971 with no value the link path will be placed in both the ``link'' and the
13972 ``description'' portion of the Org mode link.
13974 @node dir, exports, file-desc, Specific header arguments
13975 @subsubsection @code{:dir} and remote execution
13977 While the @code{:file} header argument can be used to specify the path to the
13978 output file, @code{:dir} specifies the default directory during code block
13979 execution.  If it is absent, then the directory associated with the current
13980 buffer is used.  In other words, supplying @code{:dir path} temporarily has
13981 the same effect as changing the current directory with @kbd{M-x cd path}, and
13982 then not supplying @code{:dir}.  Under the surface, @code{:dir} simply sets
13983 the value of the Emacs variable @code{default-directory}.
13985 When using @code{:dir}, you should supply a relative path for file output
13986 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
13987 case that path will be interpreted relative to the default directory.
13989 In other words, if you want your plot to go into a folder called @file{Work}
13990 in your home directory, you could use
13992 @example
13993 #+BEGIN_SRC R :file myplot.png :dir ~/Work
13994 matplot(matrix(rnorm(100), 10), type="l")
13995 #+END_SRC
13996 @end example
13998 @subsubheading Remote execution
13999 A directory on a remote machine can be specified using tramp file syntax, in
14000 which case the code will be evaluated on the remote machine.  An example is
14002 @example
14003 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
14004 plot(1:10, main=system("hostname", intern=TRUE))
14005 #+END_SRC
14006 @end example
14008 Text results will be returned to the local Org mode buffer as usual, and file
14009 output will be created on the remote machine with relative paths interpreted
14010 relative to the remote directory.  An Org mode link to the remote file will be
14011 created.
14013 So, in the above example a plot will be created on the remote machine,
14014 and a link of the following form will be inserted in the org buffer:
14016 @example
14017 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
14018 @end example
14020 Most of this functionality follows immediately from the fact that @code{:dir}
14021 sets the value of the Emacs variable @code{default-directory}, thanks to
14022 tramp.  Those using XEmacs, or GNU Emacs prior to version 23 may need to
14023 install tramp separately in order for these features to work correctly.
14025 @subsubheading Further points
14027 @itemize @bullet
14028 @item
14029 If @code{:dir} is used in conjunction with @code{:session}, although it will
14030 determine the starting directory for a new session as expected, no attempt is
14031 currently made to alter the directory associated with an existing session.
14032 @item
14033 @code{:dir} should typically not be used to create files during export with
14034 @code{:exports results} or @code{:exports both}.  The reason is that, in order
14035 to retain portability of exported material between machines, during export
14036 links inserted into the buffer will @emph{not} be expanded against @code{default
14037 directory}.  Therefore, if @code{default-directory} is altered using
14038 @code{:dir}, it is probable that the file will be created in a location to
14039 which the link does not point.
14040 @end itemize
14042 @node exports, tangle, dir, Specific header arguments
14043 @subsubsection @code{:exports}
14045 The @code{:exports} header argument specifies what should be included in HTML
14046 or @LaTeX{} exports of the Org mode file.
14048 @itemize @bullet
14049 @item @code{code}
14050 The default.  The body of code is included into the exported file.  E.g.,
14051 @code{:exports code}.
14052 @item @code{results}
14053 The result of evaluating the code is included in the exported file.  E.g.,
14054 @code{:exports results}.
14055 @item @code{both}
14056 Both the code and results are included in the exported file.  E.g.,
14057 @code{:exports both}.
14058 @item @code{none}
14059 Nothing is included in the exported file.  E.g., @code{:exports none}.
14060 @end itemize
14062 @node tangle, mkdirp, exports, Specific header arguments
14063 @subsubsection @code{:tangle}
14065 The @code{:tangle} header argument specifies whether or not the code
14066 block should be included in tangled extraction of source code files.
14068 @itemize @bullet
14069 @item @code{tangle}
14070 The code block is exported to a source code file named after the full path
14071 (including the directory) and file name (w/o extension) of the Org mode file.
14072 E.g., @code{:tangle yes}.
14073 @item @code{no}
14074 The default.  The code block is not exported to a source code file.
14075 E.g., @code{:tangle no}.
14076 @item other
14077 Any other string passed to the @code{:tangle} header argument is interpreted
14078 as a path (directory and file name relative to the directory of the Org mode
14079 file) to which the block will be exported.  E.g., @code{:tangle path}.
14080 @end itemize
14082 @node mkdirp, comments, tangle, Specific header arguments
14083 @subsubsection @code{:mkdirp}
14085 The @code{:mkdirp} header argument can be used to create parent directories
14086 of tangled files when missing.  This can be set to @code{yes} to enable
14087 directory creation or to @code{no} to inhibit directory creation.
14089 @node comments, padline, mkdirp, Specific header arguments
14090 @subsubsection @code{:comments}
14091 By default code blocks are tangled to source-code files without any insertion
14092 of comments beyond those which may already exist in the body of the code
14093 block.  The @code{:comments} header argument can be set as follows to control
14094 the insertion of extra comments into the tangled code file.
14096 @itemize @bullet
14097 @item @code{no}
14098 The default.  No extra comments are inserted during tangling.
14099 @item @code{link}
14100 The code block is wrapped in comments which contain pointers back to the
14101 original Org file from which the code was tangled.
14102 @item @code{yes}
14103 A synonym for ``link'' to maintain backwards compatibility.
14104 @item @code{org}
14105 Include text from the Org mode file as a comment.
14106 The text is picked from the leading context of the tangled code and is
14107 limited by the nearest headline or source block as the case may be.
14108 @item @code{both}
14109 Turns on both the ``link'' and ``org'' comment options.
14110 @item @code{noweb}
14111 Turns on the ``link'' comment option, and additionally wraps expanded noweb
14112 references in the code block body in link comments.
14113 @end itemize
14115 @node padline, no-expand, comments, Specific header arguments
14116 @subsubsection @code{:padline}
14117 Control in insertion of padding lines around code block bodies in tangled
14118 code files.  The default value is @code{yes} which results in insertion of
14119 newlines before and after each tangled code block.  The following arguments
14120 are accepted.
14122 @itemize @bullet
14123 @item @code{yes}
14124 Insert newlines before and after each code block body in tangled code files.
14125 @item @code{no}
14126 Do not insert any newline padding in tangled output.
14127 @end itemize
14129 @node no-expand, session, padline, Specific header arguments
14130 @subsubsection @code{:no-expand}
14132 By default, code blocks are expanded with @code{org-babel-expand-src-block}
14133 during tangling.  This has the effect of assigning values to variables
14134 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
14135 references (see @ref{Noweb reference syntax}) with their targets.  The
14136 @code{:no-expand} header argument can be used to turn off this behavior.
14138 @node session, noweb, no-expand, Specific header arguments
14139 @subsubsection @code{:session}
14141 The @code{:session} header argument starts a session for an interpreted
14142 language where state is preserved.
14144 By default, a session is not started.
14146 A string passed to the @code{:session} header argument will give the session
14147 a name.  This makes it possible to run concurrent sessions for each
14148 interpreted language.
14150 @node noweb, noweb-ref, session, Specific header arguments
14151 @subsubsection @code{:noweb}
14153 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
14154 references (see @ref{Noweb reference syntax}) when the code block is
14155 evaluated, tangled, or exported.  The @code{:noweb} header argument can have
14156 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
14157 @code{no-export} @code{strip-export}.
14159 @itemize @bullet
14160 @item @code{no}
14161 The default.  ``Noweb'' syntax references in the body of the code block will
14162 not be expanded before the code block is evaluated, tangled or exported.
14163 @item @code{yes}
14164 ``Noweb'' syntax references in the body of the code block will be
14165 expanded before the code block is evaluated, tangled or exported.
14166 @item @code{tangle}
14167 ``Noweb'' syntax references in the body of the code block will be expanded
14168 before the code block is tangled.  However, ``noweb'' syntax references will
14169 not be expanded when the code block is evaluated or exported.
14170 @item @code{no-export}
14171 ``Noweb'' syntax references in the body of the code block will be expanded
14172 before the block is evaluated or tangled.  However, ``noweb'' syntax
14173 references will not be expanded when the code block is exported.
14174 @item @code{strip-export}
14175 ``Noweb'' syntax references in the body of the code block will be expanded
14176 before the block is evaluated or tangled.  However, ``noweb'' syntax
14177 references will not be removed when the code block is exported.
14178 @item @code{eval}
14179 ``Noweb'' syntax references in the body of the code block will only be
14180 expanded before the block is evaluated.
14181 @end itemize
14183 @subsubheading Noweb prefix lines
14184 Noweb insertions are now placed behind the line prefix of the
14185 @code{<<reference>>}.
14186 This behavior is illustrated in the following example.  Because the
14187 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
14188 each line of the expanded noweb reference will be commented.
14190 This code block:
14192 @example
14193 -- <<example>>
14194 @end example
14196 expands to:
14198 @example
14199 -- this is the
14200 -- multi-line body of example
14201 @end example
14203 Note that noweb replacement text that does not contain any newlines will not
14204 be affected by this change, so it is still possible to use inline noweb
14205 references.
14207 @node noweb-ref, noweb-sep, noweb, Specific header arguments
14208 @subsubsection @code{:noweb-ref}
14209 When expanding ``noweb'' style references the bodies of all code block with
14210 @emph{either} a block name matching the reference name @emph{or} a
14211 @code{:noweb-ref} header argument matching the reference name will be
14212 concatenated together to form the replacement text.
14214 By setting this header argument at the sub-tree or file level, simple code
14215 block concatenation may be achieved.  For example, when tangling the
14216 following Org mode file, the bodies of code blocks will be concatenated into
14217 the resulting pure code file@footnote{(The example needs property inheritance
14218 to be turned on for the @code{noweb-ref} property, see @ref{Property
14219 inheritance}).}.
14221 @example
14222  #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
14223    <<fullest-disk>>
14224  #+END_SRC
14225  * the mount point of the fullest disk
14226    :PROPERTIES:
14227    :noweb-ref: fullest-disk
14228    :END:
14230  ** query all mounted disks
14231  #+BEGIN_SRC sh
14232    df \
14233  #+END_SRC
14235  ** strip the header row
14236  #+BEGIN_SRC sh
14237    |sed '1d' \
14238  #+END_SRC
14240  ** sort by the percent full
14241  #+BEGIN_SRC sh
14242    |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
14243  #+END_SRC
14245  ** extract the mount point
14246  #+BEGIN_SRC sh
14247    |awk '@{print $2@}'
14248  #+END_SRC
14249 @end example
14251 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
14252 used to separate accumulate noweb references like those above.  By default a
14253 newline is used.
14255 @node noweb-sep, cache, noweb-ref, Specific header arguments
14256 @subsubsection @code{:noweb-sep}
14258 The @code{:noweb-sep} header argument holds the string used to separate
14259 accumulate noweb references (see @ref{noweb-ref}).  By default a newline is
14260 used.
14262 @node cache, sep, noweb-sep, Specific header arguments
14263 @subsubsection @code{:cache}
14265 The @code{:cache} header argument controls the use of in-buffer caching of
14266 the results of evaluating code blocks.  It can be used to avoid re-evaluating
14267 unchanged code blocks.  Note that the @code{:cache} header argument will not
14268 attempt to cache results when the @code{:session} header argument is used,
14269 because the results of the code block execution may be stored in the session
14270 outside of the Org mode buffer.  The @code{:cache} header argument can have
14271 one of two values: @code{yes} or @code{no}.
14273 @itemize @bullet
14274 @item @code{no}
14275 The default.  No caching takes place, and the code block will be evaluated
14276 every time it is called.
14277 @item @code{yes}
14278 Every time the code block is run a SHA1 hash of the code and arguments
14279 passed to the block will be generated.  This hash is packed into the
14280 @code{#+RESULTS:} line and will be checked on subsequent
14281 executions of the code block.  If the code block has not
14282 changed since the last time it was evaluated, it will not be re-evaluated.
14283 @end itemize
14285 Code block caches notice if the value of a variable argument
14286 to the code block has changed.  If this is the case, the cache is
14287 invalidated and the code block is re-run.  In the following example,
14288 @code{caller} will not be re-run unless the results of @code{random} have
14289 changed since it was last run.
14291 @example
14292  #+NAME: random
14293  #+BEGIN_SRC R :cache yes
14294  runif(1)
14295  #+END_SRC
14297  #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
14298  0.4659510825295
14300  #+NAME: caller
14301  #+BEGIN_SRC emacs-lisp :var x=random :cache yes
14303  #+END_SRC
14305  #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
14306  0.254227238707244
14307 @end example
14309 @node sep, hlines, cache, Specific header arguments
14310 @subsubsection @code{:sep}
14312 The @code{:sep} header argument can be used to control the delimiter used
14313 when writing tabular results out to files external to Org mode.  This is used
14314 either when opening tabular results of a code block by calling the
14315 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
14316 or when writing code block results to an external file (see @ref{file})
14317 header argument.
14319 By default, when @code{:sep} is not specified output tables are tab
14320 delimited.
14322 @node hlines, colnames, sep, Specific header arguments
14323 @subsubsection @code{:hlines}
14325 Tables are frequently represented with one or more horizontal lines, or
14326 hlines.  The @code{:hlines} argument to a code block accepts the
14327 values @code{yes} or @code{no}, with a default value of @code{no}.
14329 @itemize @bullet
14330 @item @code{no}
14331 Strips horizontal lines from the input table.  In most languages this is the
14332 desired effect because an @code{hline} symbol is interpreted as an unbound
14333 variable and raises an error.  Setting @code{:hlines no} or relying on the
14334 default value yields the following results.
14336 @example
14337 #+NAME: many-cols
14338 | a | b | c |
14339 |---+---+---|
14340 | d | e | f |
14341 |---+---+---|
14342 | g | h | i |
14344 #+NAME: echo-table
14345 #+BEGIN_SRC python :var tab=many-cols
14346   return tab
14347 #+END_SRC
14349 #+RESULTS: echo-table
14350 | a | b | c |
14351 | d | e | f |
14352 | g | h | i |
14353 @end example
14355 @item @code{yes}
14356 Leaves hlines in the table.  Setting @code{:hlines yes} has this effect.
14358 @example
14359 #+NAME: many-cols
14360 | a | b | c |
14361 |---+---+---|
14362 | d | e | f |
14363 |---+---+---|
14364 | g | h | i |
14366 #+NAME: echo-table
14367 #+BEGIN_SRC python :var tab=many-cols :hlines yes
14368   return tab
14369 #+END_SRC
14371 #+RESULTS: echo-table
14372 | a | b | c |
14373 |---+---+---|
14374 | d | e | f |
14375 |---+---+---|
14376 | g | h | i |
14377 @end example
14378 @end itemize
14380 @node colnames, rownames, hlines, Specific header arguments
14381 @subsubsection @code{:colnames}
14383 The @code{:colnames} header argument accepts the values @code{yes},
14384 @code{no}, or @code{nil} for unassigned.  The default value is @code{nil}.
14385 Note that the behavior of the @code{:colnames} header argument may differ
14386 across languages.
14388 @itemize @bullet
14389 @item @code{nil}
14390 If an input table looks like it has column names
14391 (because its second row is an hline), then the column
14392 names will be removed from the table before
14393 processing, then reapplied to the results.
14395 @example
14396 #+NAME: less-cols
14397 | a |
14398 |---|
14399 | b |
14400 | c |
14402 #+NAME: echo-table-again
14403 #+BEGIN_SRC python :var tab=less-cols
14404   return [[val + '*' for val in row] for row in tab]
14405 #+END_SRC
14407 #+RESULTS: echo-table-again
14408 | a  |
14409 |----|
14410 | b* |
14411 | c* |
14412 @end example
14414 Please note that column names are not removed before the table is indexed
14415 using variable indexing @xref{var, Indexable variable values}.
14417 @item @code{no}
14418 No column name pre-processing takes place
14420 @item @code{yes}
14421 Column names are removed and reapplied as with @code{nil} even if the table
14422 does not ``look like'' it has column names (i.e., the second row is not an
14423 hline)
14424 @end itemize
14426 @node rownames, shebang, colnames, Specific header arguments
14427 @subsubsection @code{:rownames}
14429 The @code{:rownames} header argument can take on the values @code{yes} or
14430 @code{no}, with a default value of @code{no}.  Note that Emacs Lisp code
14431 blocks ignore the @code{:rownames} header argument entirely given the ease
14432 with which tables with row names may be handled directly in Emacs Lisp.
14434 @itemize @bullet
14435 @item @code{no}
14436 No row name pre-processing will take place.
14438 @item @code{yes}
14439 The first column of the table is removed from the table before processing,
14440 and is then reapplied to the results.
14442 @example
14443 #+NAME: with-rownames
14444 | one | 1 | 2 | 3 | 4 |  5 |
14445 | two | 6 | 7 | 8 | 9 | 10 |
14447 #+NAME: echo-table-once-again
14448 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
14449   return [[val + 10 for val in row] for row in tab]
14450 #+END_SRC
14452 #+RESULTS: echo-table-once-again
14453 | one | 11 | 12 | 13 | 14 | 15 |
14454 | two | 16 | 17 | 18 | 19 | 20 |
14455 @end example
14457 Please note that row names are not removed before the table is indexed using
14458 variable indexing @xref{var, Indexable variable values}.
14460 @end itemize
14462 @node shebang, eval, rownames, Specific header arguments
14463 @subsubsection @code{:shebang}
14465 Setting the @code{:shebang} header argument to a string value
14466 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
14467 first line of any tangled file holding the code block, and the file
14468 permissions of the tangled file are set to make it executable.
14470 @node eval, wrap, shebang, Specific header arguments
14471 @subsubsection @code{:eval}
14472 The @code{:eval} header argument can be used to limit the evaluation of
14473 specific code blocks.  The @code{:eval} header argument can be useful for
14474 protecting against the evaluation of dangerous code blocks or to ensure that
14475 evaluation will require a query regardless of the value of the
14476 @code{org-confirm-babel-evaluate} variable.  The possible values of
14477 @code{:eval} and their effects are shown below.
14479 @table @code
14480 @item never or no
14481 The code block will not be evaluated under any circumstances.
14482 @item query
14483 Evaluation of the code block will require a query.
14484 @item never-export or no-export
14485 The code block will not be evaluated during export but may still be called
14486 interactively.
14487 @item query-export
14488 Evaluation of the code block during export will require a query.
14489 @end table
14491 If this header argument is not set then evaluation is determined by the value
14492 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
14493 security}.
14495 @node wrap, post, eval, Specific header arguments
14496 @subsubsection @code{:wrap}
14497 The @code{:wrap} header argument is used to mark the results of source block
14498 evaluation.  The header argument can be passed a string that will be appended
14499 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
14500 results.  If not string is specified then the results will be wrapped in a
14501 @code{#+BEGIN/END_RESULTS} block.
14503 @node post,  , wrap, Specific header arguments
14504 @subsubsection @code{:post}
14505 The @code{:post} header argument is used to post-process the results of a
14506 code block execution.  When a post argument is given, the results of the code
14507 block will temporarily be bound to the @code{*this*} variable.  This variable
14508 may then be included in header argument forms such as those used in @ref{var}
14509 header argument specifications allowing passing of results to other code
14510 blocks, or direct execution via Emacs Lisp.
14512 The following example illustrates the usage of the @code{:post} header
14513 argument.
14515 @example
14516 #+name: attr_wrap
14517 #+begin_src sh :var data="" :var width="\\textwidth" :results output
14518   echo "#+ATTR_LATEX :width $width"
14519   echo "$data"
14520 #+end_src
14522 #+header: :file /tmp/it.png
14523 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
14524   digraph@{
14525           a -> b;
14526           b -> c;
14527           c -> a;
14528   @}
14529 #+end_src
14531 #+RESULTS:
14532 :RESULTS:
14533 #+ATTR_LATEX :width 5cm
14534 [[file:/tmp/it.png]]
14535 :END:
14536 @end example
14538 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
14539 @section Results of evaluation
14540 @cindex code block, results of evaluation
14541 @cindex source code, results of evaluation
14543 The way in which results are handled depends on whether a session is invoked,
14544 as well as on whether @code{:results value} or @code{:results output} is
14545 used.  The following table shows the table possibilities.  For a full listing
14546 of the possible results header arguments see @ref{results}.
14548 @multitable @columnfractions 0.26 0.33 0.41
14549 @item @tab @b{Non-session} @tab @b{Session}
14550 @item @code{:results value} @tab value of last expression @tab value of last expression
14551 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
14552 @end multitable
14554 Note: With @code{:results value}, the result in both @code{:session} and
14555 non-session is returned to Org mode as a table (a one- or two-dimensional
14556 vector of strings or numbers) when appropriate.
14558 @subsection Non-session
14559 @subsubsection @code{:results value}
14560 This is the default.  Internally, the value is obtained by wrapping the code
14561 in a function definition in the external language, and evaluating that
14562 function.  Therefore, code should be written as if it were the body of such a
14563 function.  In particular, note that Python does not automatically return a
14564 value from a function unless a @code{return} statement is present, and so a
14565 @samp{return} statement will usually be required in Python.
14567 This is the only one of the four evaluation contexts in which the code is
14568 automatically wrapped in a function definition.
14570 @subsubsection @code{:results output}
14571 The code is passed to the interpreter as an external process, and the
14572 contents of the standard output stream are returned as text.  (In certain
14573 languages this also contains the error output stream; this is an area for
14574 future work.)
14576 @subsection Session
14577 @subsubsection @code{:results value}
14578 The code is passed to an interpreter running as an interactive Emacs inferior
14579 process.  Only languages which provide tools for interactive evaluation of
14580 code have session support, so some language (e.g., C and ditaa) do not
14581 support the @code{:session} header argument, and in other languages (e.g.,
14582 Python and Haskell) which have limitations on the code which may be entered
14583 into interactive sessions, those limitations apply to the code in code blocks
14584 using the @code{:session} header argument as well.
14586 Unless the @code{:results output} option is supplied (see below) the result
14587 returned is the result of the last evaluation performed by the
14588 interpreter.  (This is obtained in a language-specific manner: the value of
14589 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
14590 in R).
14592 @subsubsection @code{:results output}
14593 The code is passed to the interpreter running as an interactive Emacs
14594 inferior process.  The result returned is the concatenation of the sequence of
14595 (text) output from the interactive interpreter.  Notice that this is not
14596 necessarily the same as what would be sent to @code{STDOUT} if the same code
14597 were passed to a non-interactive interpreter running as an external
14598 process.  For example, compare the following two blocks:
14600 @example
14601 #+BEGIN_SRC python :results output
14602  print "hello"
14604  print "bye"
14605 #+END_SRC
14607 #+RESULTS:
14608 : hello
14609 : bye
14610 @end example
14612 In non-session mode, the `2' is not printed and does not appear.
14614 @example
14615 #+BEGIN_SRC python :results output :session
14616  print "hello"
14618  print "bye"
14619 #+END_SRC
14621 #+RESULTS:
14622 : hello
14623 : 2
14624 : bye
14625 @end example
14627 But in @code{:session} mode, the interactive interpreter receives input `2'
14628 and prints out its value, `2'.  (Indeed, the other print statements are
14629 unnecessary here).
14631 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
14632 @section Noweb reference syntax
14633 @cindex code block, noweb reference
14634 @cindex syntax, noweb
14635 @cindex source code, noweb reference
14637 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
14638 Programming system allows named blocks of code to be referenced by using the
14639 familiar Noweb syntax:
14641 @example
14642 <<code-block-name>>
14643 @end example
14645 When a code block is tangled or evaluated, whether or not ``noweb''
14646 references are expanded depends upon the value of the @code{:noweb} header
14647 argument.  If @code{:noweb yes}, then a Noweb reference is expanded before
14648 evaluation.  If @code{:noweb no}, the default, then the reference is not
14649 expanded before evaluation.  See the @ref{noweb-ref} header argument for
14650 a more flexible way to resolve noweb references.
14652 It is possible to include the @emph{results} of a code block rather than the
14653 body.  This is done by appending parenthesis to the code block name which may
14654 optionally contain arguments to the code block as shown below.
14656 @example
14657 <<code-block-name(optional arguments)>>
14658 @end example
14660 Note: the default value, @code{:noweb no}, was chosen to ensure that
14661 correct code is not broken in a language, such as Ruby, where
14662 @code{<<arg>>} is a syntactically valid construct.  If @code{<<arg>>} is not
14663 syntactically valid in languages that you use, then please consider setting
14664 the default value.
14666 Note: if noweb tangling is slow in large Org mode files consider setting the
14667 @code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
14668 This will result in faster noweb reference resolution at the expense of not
14669 correctly resolving inherited values of the @code{:noweb-ref} header
14670 argument.
14672 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
14673 @section Key bindings and useful functions
14674 @cindex code block, key bindings
14676 Many common Org mode key sequences are re-bound depending on
14677 the context.
14679 Within a code block, the following key bindings
14680 are active:
14682 @multitable @columnfractions 0.25 0.75
14683 @kindex C-c C-c
14684 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
14685 @kindex C-c C-o
14686 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
14687 @kindex C-up
14688 @item @kbd{C-@key{up}}    @tab @code{org-babel-load-in-session}
14689 @kindex M-down
14690 @item @kbd{M-@key{down}}  @tab @code{org-babel-pop-to-session}
14691 @end multitable
14693 In an Org mode buffer, the following key bindings are active:
14695 @multitable @columnfractions 0.45 0.55
14696 @kindex C-c C-v p
14697 @kindex C-c C-v C-p
14698 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
14699 @kindex C-c C-v n
14700 @kindex C-c C-v C-n
14701 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
14702 @kindex C-c C-v e
14703 @kindex C-c C-v C-e
14704 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
14705 @kindex C-c C-v o
14706 @kindex C-c C-v C-o
14707 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
14708 @kindex C-c C-v v
14709 @kindex C-c C-v C-v
14710 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
14711 @kindex C-c C-v u
14712 @kindex C-c C-v C-u
14713 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
14714 @kindex C-c C-v g
14715 @kindex C-c C-v C-g
14716 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
14717 @kindex C-c C-v r
14718 @kindex C-c C-v C-r
14719 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
14720 @kindex C-c C-v b
14721 @kindex C-c C-v C-b
14722 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14723 @kindex C-c C-v s
14724 @kindex C-c C-v C-s
14725 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14726 @kindex C-c C-v d
14727 @kindex C-c C-v C-d
14728 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
14729 @kindex C-c C-v t
14730 @kindex C-c C-v C-t
14731 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14732 @kindex C-c C-v f
14733 @kindex C-c C-v C-f
14734 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14735 @kindex C-c C-v c
14736 @kindex C-c C-v C-c
14737 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
14738 @kindex C-c C-v j
14739 @kindex C-c C-v C-j
14740 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
14741 @kindex C-c C-v l
14742 @kindex C-c C-v C-l
14743 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
14744 @kindex C-c C-v i
14745 @kindex C-c C-v C-i
14746 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
14747 @kindex C-c C-v I
14748 @kindex C-c C-v C-I
14749 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
14750 @kindex C-c C-v z
14751 @kindex C-c C-v C-z
14752 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session-with-code}
14753 @kindex C-c C-v a
14754 @kindex C-c C-v C-a
14755 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14756 @kindex C-c C-v h
14757 @kindex C-c C-v C-h
14758 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
14759 @kindex C-c C-v x
14760 @kindex C-c C-v C-x
14761 @item @kbd{C-c C-v x} @ @ @r{or} @ @ @kbd{C-c C-v C-x} @tab @code{org-babel-do-key-sequence-in-edit-buffer}
14762 @end multitable
14764 @c When possible these keybindings were extended to work when the control key is
14765 @c kept pressed, resulting in the following additional keybindings.
14767 @c @multitable @columnfractions 0.25 0.75
14768 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14769 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14770 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14771 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14772 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14773 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14774 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14775 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14776 @c @end multitable
14778 @node Batch execution,  , Key bindings and useful functions, Working With Source Code
14779 @section Batch execution
14780 @cindex code block, batch execution
14781 @cindex source code, batch execution
14783 It is possible to call functions from the command line.  This shell
14784 script calls @code{org-babel-tangle} on every one of its arguments.
14786 Be sure to adjust the paths to fit your system.
14788 @example
14789 #!/bin/sh
14790 # -*- mode: shell-script -*-
14792 # tangle files with org-mode
14794 DIR=`pwd`
14795 FILES=""
14797 # wrap each argument in the code required to call tangle on it
14798 for i in $@@; do
14799     FILES="$FILES \"$i\""
14800 done
14802 emacs -Q --batch \
14803 --eval "(progn
14804 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
14805 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
14806 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
14807 (mapc (lambda (file)
14808        (find-file (expand-file-name file \"$DIR\"))
14809        (org-babel-tangle)
14810        (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
14811 @end example
14813 @node Miscellaneous, Hacking, Working With Source Code, Top
14814 @chapter Miscellaneous
14816 @menu
14817 * Completion::                  M-TAB knows what you need
14818 * Easy Templates::              Quick insertion of structural elements
14819 * Speed keys::                  Electric commands at the beginning of a headline
14820 * Code evaluation security::    Org mode files evaluate inline code
14821 * Customization::               Adapting Org to your taste
14822 * In-buffer settings::          Overview of the #+KEYWORDS
14823 * The very busy C-c C-c key::   When in doubt, press C-c C-c
14824 * Clean view::                  Getting rid of leading stars in the outline
14825 * TTY keys::                    Using Org on a tty
14826 * Interaction::                 Other Emacs packages
14827 * org-crypt.el::                Encrypting Org files
14828 @end menu
14831 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
14832 @section Completion
14833 @cindex completion, of @TeX{} symbols
14834 @cindex completion, of TODO keywords
14835 @cindex completion, of dictionary words
14836 @cindex completion, of option keywords
14837 @cindex completion, of tags
14838 @cindex completion, of property keys
14839 @cindex completion, of link abbreviations
14840 @cindex @TeX{} symbol completion
14841 @cindex TODO keywords completion
14842 @cindex dictionary word completion
14843 @cindex option keyword completion
14844 @cindex tag completion
14845 @cindex link abbreviations, completion of
14847 Emacs would not be Emacs without completion, and Org mode uses it whenever it
14848 makes sense.  If you prefer an @i{iswitchb}- or @i{ido}-like interface for
14849 some of the completion prompts, you can specify your preference by setting at
14850 most one of the variables @code{org-completion-use-iswitchb}
14851 @code{org-completion-use-ido}.
14853 Org supports in-buffer completion.  This type of completion does
14854 not make use of the minibuffer.  You simply type a few letters into
14855 the buffer and use the key to complete text right there.
14857 @table @kbd
14858 @kindex M-@key{TAB}
14859 @item M-@key{TAB}
14860 Complete word at point
14861 @itemize @bullet
14862 @item
14863 At the beginning of a headline, complete TODO keywords.
14864 @item
14865 After @samp{\}, complete @TeX{} symbols supported by the exporter.
14866 @item
14867 After @samp{*}, complete headlines in the current buffer so that they
14868 can be used in search links like @samp{[[*find this headline]]}.
14869 @item
14870 After @samp{:} in a headline, complete tags.  The list of tags is taken
14871 from the variable @code{org-tag-alist} (possibly set through the
14872 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
14873 dynamically from all tags used in the current buffer.
14874 @item
14875 After @samp{:} and not in a headline, complete property keys.  The list
14876 of keys is constructed dynamically from all keys used in the current
14877 buffer.
14878 @item
14879 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
14880 @item
14881 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
14882 @samp{OPTIONS} which set file-specific options for Org mode.  When the
14883 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
14884 will insert example settings for this keyword.
14885 @item
14886 In the line after @samp{#+STARTUP: }, complete startup keywords,
14887 i.e., valid keys for this line.
14888 @item
14889 Elsewhere, complete dictionary words using Ispell.
14890 @end itemize
14891 @end table
14893 @node Easy Templates, Speed keys, Completion, Miscellaneous
14894 @section Easy Templates
14895 @cindex template insertion
14896 @cindex insertion, of templates
14898 Org mode supports insertion of empty structural elements (like
14899 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
14900 strokes.  This is achieved through a native template expansion mechanism.
14901 Note that Emacs has several other template mechanisms which could be used in
14902 a similar way, for example @file{yasnippet}.
14904 To insert a structural element, type a @samp{<}, followed by a template
14905 selector and @kbd{@key{TAB}}.  Completion takes effect only when the above
14906 keystrokes are typed on a line by itself.
14908 The following template selectors are currently supported.
14910 @multitable @columnfractions 0.1 0.9
14911 @item @kbd{s} @tab @code{#+BEGIN_SRC     ... #+END_SRC}
14912 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
14913 @item @kbd{q} @tab @code{#+BEGIN_QUOTE   ... #+END_QUOTE}
14914 @item @kbd{v} @tab @code{#+BEGIN_VERSE   ... #+END_VERSE}
14915 @item @kbd{c} @tab @code{#+BEGIN_CENTER  ... #+END_CENTER}
14916 @item @kbd{l} @tab @code{#+BEGIN_LaTeX   ... #+END_LaTeX}
14917 @item @kbd{L} @tab @code{#+LaTeX:}
14918 @item @kbd{h} @tab @code{#+BEGIN_HTML    ... #+END_HTML}
14919 @item @kbd{H} @tab @code{#+HTML:}
14920 @item @kbd{a} @tab @code{#+BEGIN_ASCII   ... #+END_ASCII}
14921 @item @kbd{A} @tab @code{#+ASCII:}
14922 @item @kbd{i} @tab @code{#+INDEX:} line
14923 @item @kbd{I} @tab @code{#+INCLUDE:} line
14924 @end multitable
14926 For example, on an empty line, typing "<e" and then pressing TAB, will expand
14927 into a complete EXAMPLE template.
14929 You can install additional templates by customizing the variable
14930 @code{org-structure-template-alist}.  See the docstring of the variable for
14931 additional details.
14933 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
14934 @section Speed keys
14935 @cindex speed keys
14936 @vindex org-use-speed-commands
14937 @vindex org-speed-commands-user
14939 Single keys can be made to execute commands when the cursor is at the
14940 beginning of a headline, i.e., before the first star.  Configure the variable
14941 @code{org-use-speed-commands} to activate this feature.  There is a
14942 pre-defined list of commands, and you can add more such commands using the
14943 variable @code{org-speed-commands-user}.  Speed keys do not only speed up
14944 navigation and other commands, but they also provide an alternative way to
14945 execute commands bound to keys that are not or not easily available on a TTY,
14946 or on a small mobile device with a limited keyboard.
14948 To see which commands are available, activate the feature and press @kbd{?}
14949 with the cursor at the beginning of a headline.
14951 @node Code evaluation security, Customization, Speed keys, Miscellaneous
14952 @section Code evaluation and security issues
14954 Org provides tools to work with the code snippets, including evaluating them.
14956 Running code on your machine always comes with a security risk.  Badly
14957 written or malicious code can be executed on purpose or by accident.  Org has
14958 default settings which will only evaluate such code if you give explicit
14959 permission to do so, and as a casual user of these features you should leave
14960 these precautions intact.
14962 For people who regularly work with such code, the confirmation prompts can
14963 become annoying, and you might want to turn them off.  This can be done, but
14964 you must be aware of the risks that are involved.
14966 Code evaluation can happen under the following circumstances:
14968 @table @i
14969 @item Source code blocks
14970 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
14971 C-c} in the block.  The most important thing to realize here is that Org mode
14972 files which contain code snippets are, in a certain sense, like executable
14973 files.  So you should accept them and load them into Emacs only from trusted
14974 sources---just like you would do with a program you install on your computer.
14976 Make sure you know what you are doing before customizing the variables
14977 which take off the default security brakes.
14979 @defopt org-confirm-babel-evaluate
14980 When t (the default), the user is asked before every code block evaluation.
14981 When nil, the user is not asked.  When set to a function, it is called with
14982 two arguments (language and body of the code block) and should return t to
14983 ask and nil not to ask.
14984 @end defopt
14986 For example, here is how to execute "ditaa" code (which is considered safe)
14987 without asking:
14989 @lisp
14990 (defun my-org-confirm-babel-evaluate (lang body)
14991   (not (string= lang "ditaa")))  ; don't ask for ditaa
14992 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
14993 @end lisp
14995 @item Following @code{shell} and @code{elisp} links
14996 Org has two link types that can directly evaluate code (@pxref{External
14997 links}).  These links can be problematic because the code to be evaluated is
14998 not visible.
15000 @defopt org-confirm-shell-link-function
15001 Function to queries user about shell link execution.
15002 @end defopt
15003 @defopt org-confirm-elisp-link-function
15004 Functions to query user for Emacs Lisp link execution.
15005 @end defopt
15007 @item Formulas in tables
15008 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
15009 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
15010 @end table
15012 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
15013 @section Customization
15014 @cindex customization
15015 @cindex options, for customization
15016 @cindex variables, for customization
15018 There are more than 500 variables that can be used to customize
15019 Org.  For the sake of compactness of the manual, I am not
15020 describing the variables here.  A structured overview of customization
15021 variables is available with @kbd{M-x org-customize}.  Or select
15022 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
15023 settings can also be activated on a per-file basis, by putting special
15024 lines into the buffer (@pxref{In-buffer settings}).
15026 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
15027 @section Summary of in-buffer settings
15028 @cindex in-buffer settings
15029 @cindex special keywords
15031 Org mode uses special lines in the buffer to define settings on a
15032 per-file basis.  These lines start with a @samp{#+} followed by a
15033 keyword, a colon, and then individual words defining a setting.  Several
15034 setting words can be in the same line, but you can also have multiple
15035 lines for the keyword.  While these settings are described throughout
15036 the manual, here is a summary.  After changing any of those lines in the
15037 buffer, press @kbd{C-c C-c} with the cursor still in the line to
15038 activate the changes immediately.  Otherwise they become effective only
15039 when the file is visited again in a new Emacs session.
15041 @vindex org-archive-location
15042 @table @kbd
15043 @item #+ARCHIVE: %s_done::
15044 This line sets the archive location for the agenda file.  It applies for
15045 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
15046 of the file.  The first such line also applies to any entries before it.
15047 The corresponding variable is @code{org-archive-location}.
15048 @item #+CATEGORY:
15049 This line sets the category for the agenda file.  The category applies
15050 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
15051 end of the file.  The first such line also applies to any entries before it.
15052 @item #+COLUMNS: %25ITEM .....
15053 @cindex property, COLUMNS
15054 Set the default format for columns view.  This format applies when
15055 columns view is invoked in locations where no @code{COLUMNS} property
15056 applies.
15057 @item #+CONSTANTS: name1=value1 ...
15058 @vindex org-table-formula-constants
15059 @vindex org-table-formula
15060 Set file-local values for constants to be used in table formulas.  This
15061 line sets the local variable @code{org-table-formula-constants-local}.
15062 The global version of this variable is
15063 @code{org-table-formula-constants}.
15064 @item #+FILETAGS: :tag1:tag2:tag3:
15065 Set tags that can be inherited by any entry in the file, including the
15066 top-level entries.
15067 @item #+DRAWERS: NAME1 .....
15068 @vindex org-drawers
15069 Set the file-local set of additional drawers.  The corresponding global
15070 variable is @code{org-drawers}.
15071 @item #+LINK:  linkword replace
15072 @vindex org-link-abbrev-alist
15073 These lines (several are allowed) specify link abbreviations.
15074 @xref{Link abbreviations}.  The corresponding variable is
15075 @code{org-link-abbrev-alist}.
15076 @item #+PRIORITIES: highest lowest default
15077 @vindex org-highest-priority
15078 @vindex org-lowest-priority
15079 @vindex org-default-priority
15080 This line sets the limits and the default for the priorities.  All three
15081 must be either letters A--Z or numbers 0--9.  The highest priority must
15082 have a lower ASCII number than the lowest priority.
15083 @item #+PROPERTY: Property_Name Value
15084 This line sets a default inheritance value for entries in the current
15085 buffer, most useful for specifying the allowed values of a property.
15086 @cindex #+SETUPFILE
15087 @item #+SETUPFILE: file
15088 This line defines a file that holds more in-buffer setup.  Normally this is
15089 entirely ignored.  Only when the buffer is parsed for option-setting lines
15090 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
15091 settings line, or when exporting), then the contents of this file are parsed
15092 as if they had been included in the buffer.  In particular, the file can be
15093 any other Org mode file with internal setup.  You can visit the file the
15094 cursor is in the line with @kbd{C-c '}.
15095 @item #+STARTUP:
15096 @cindex #+STARTUP:
15097 This line sets options to be used at startup of Org mode, when an
15098 Org file is being visited.
15100 The first set of options deals with the initial visibility of the outline
15101 tree.  The corresponding variable for global default settings is
15102 @code{org-startup-folded}, with a default value @code{t}, which means
15103 @code{overview}.
15104 @vindex org-startup-folded
15105 @cindex @code{overview}, STARTUP keyword
15106 @cindex @code{content}, STARTUP keyword
15107 @cindex @code{showall}, STARTUP keyword
15108 @cindex @code{showeverything}, STARTUP keyword
15109 @example
15110 overview         @r{top-level headlines only}
15111 content          @r{all headlines}
15112 showall          @r{no folding of any entries}
15113 showeverything   @r{show even drawer contents}
15114 @end example
15116 @vindex org-startup-indented
15117 @cindex @code{indent}, STARTUP keyword
15118 @cindex @code{noindent}, STARTUP keyword
15119 Dynamic virtual indentation is controlled by the variable
15120 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
15121 @example
15122 indent     @r{start with @code{org-indent-mode} turned on}
15123 noindent   @r{start with @code{org-indent-mode} turned off}
15124 @end example
15126 @vindex org-startup-align-all-tables
15127 Then there are options for aligning tables upon visiting a file.  This
15128 is useful in files containing narrowed table columns.  The corresponding
15129 variable is @code{org-startup-align-all-tables}, with a default value
15130 @code{nil}.
15131 @cindex @code{align}, STARTUP keyword
15132 @cindex @code{noalign}, STARTUP keyword
15133 @example
15134 align      @r{align all tables}
15135 noalign    @r{don't align tables on startup}
15136 @end example
15138 @vindex org-startup-with-inline-images
15139 When visiting a file, inline images can be automatically displayed.  The
15140 corresponding variable is @code{org-startup-with-inline-images}, with a
15141 default value @code{nil} to avoid delays when visiting a file.
15142 @cindex @code{inlineimages}, STARTUP keyword
15143 @cindex @code{noinlineimages}, STARTUP keyword
15144 @example
15145 inlineimages   @r{show inline images}
15146 noinlineimages @r{don't show inline images on startup}
15147 @end example
15149 @vindex org-startup-with-latex-preview
15150 When visiting a file, @LaTeX{} fragments can be converted to images
15151 automatically.  The variable @code{org-startup-with-latex-preview} which
15152 controls this behavior, is set to @code{nil} by default to avoid delays on
15153 startup.
15154 @cindex @code{latexpreview}, STARTUP keyword
15155 @cindex @code{nolatexpreview}, STARTUP keyword
15156 @example
15157 latexpreview   @r{preview @LaTeX{} fragments}
15158 nolatexpreview @r{don't preview @LaTeX{} fragments}
15159 @end example
15161 @vindex org-log-done
15162 @vindex org-log-note-clock-out
15163 @vindex org-log-repeat
15164 Logging the closing and reopening of TODO items and clock intervals can be
15165 configured using these options (see variables @code{org-log-done},
15166 @code{org-log-note-clock-out} and @code{org-log-repeat})
15167 @cindex @code{logdone}, STARTUP keyword
15168 @cindex @code{lognotedone}, STARTUP keyword
15169 @cindex @code{nologdone}, STARTUP keyword
15170 @cindex @code{lognoteclock-out}, STARTUP keyword
15171 @cindex @code{nolognoteclock-out}, STARTUP keyword
15172 @cindex @code{logrepeat}, STARTUP keyword
15173 @cindex @code{lognoterepeat}, STARTUP keyword
15174 @cindex @code{nologrepeat}, STARTUP keyword
15175 @cindex @code{logreschedule}, STARTUP keyword
15176 @cindex @code{lognotereschedule}, STARTUP keyword
15177 @cindex @code{nologreschedule}, STARTUP keyword
15178 @cindex @code{logredeadline}, STARTUP keyword
15179 @cindex @code{lognoteredeadline}, STARTUP keyword
15180 @cindex @code{nologredeadline}, STARTUP keyword
15181 @cindex @code{logrefile}, STARTUP keyword
15182 @cindex @code{lognoterefile}, STARTUP keyword
15183 @cindex @code{nologrefile}, STARTUP keyword
15184 @cindex @code{logdrawer}, STARTUP keyword
15185 @cindex @code{nologdrawer}, STARTUP keyword
15186 @cindex @code{logstatesreversed}, STARTUP keyword
15187 @cindex @code{nologstatesreversed}, STARTUP keyword
15188 @example
15189 logdone             @r{record a timestamp when an item is marked DONE}
15190 lognotedone         @r{record timestamp and a note when DONE}
15191 nologdone           @r{don't record when items are marked DONE}
15192 logrepeat           @r{record a time when reinstating a repeating item}
15193 lognoterepeat       @r{record a note when reinstating a repeating item}
15194 nologrepeat         @r{do not record when reinstating repeating item}
15195 lognoteclock-out    @r{record a note when clocking out}
15196 nolognoteclock-out  @r{don't record a note when clocking out}
15197 logreschedule       @r{record a timestamp when scheduling time changes}
15198 lognotereschedule   @r{record a note when scheduling time changes}
15199 nologreschedule     @r{do not record when a scheduling date changes}
15200 logredeadline       @r{record a timestamp when deadline changes}
15201 lognoteredeadline   @r{record a note when deadline changes}
15202 nologredeadline     @r{do not record when a deadline date changes}
15203 logrefile           @r{record a timestamp when refiling}
15204 lognoterefile       @r{record a note when refiling}
15205 nologrefile         @r{do not record when refiling}
15206 logdrawer           @r{store log into drawer}
15207 nologdrawer         @r{store log outside of drawer}
15208 logstatesreversed   @r{reverse the order of states notes}
15209 nologstatesreversed @r{do not reverse the order of states notes}
15210 @end example
15212 @vindex org-hide-leading-stars
15213 @vindex org-odd-levels-only
15214 Here are the options for hiding leading stars in outline headings, and for
15215 indenting outlines.  The corresponding variables are
15216 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
15217 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
15218 @cindex @code{hidestars}, STARTUP keyword
15219 @cindex @code{showstars}, STARTUP keyword
15220 @cindex @code{odd}, STARTUP keyword
15221 @cindex @code{even}, STARTUP keyword
15222 @example
15223 hidestars  @r{make all but one of the stars starting a headline invisible.}
15224 showstars  @r{show all stars starting a headline}
15225 indent     @r{virtual indentation according to outline level}
15226 noindent   @r{no virtual indentation according to outline level}
15227 odd        @r{allow only odd outline levels (1,3,...)}
15228 oddeven    @r{allow all outline levels}
15229 @end example
15231 @vindex org-put-time-stamp-overlays
15232 @vindex org-time-stamp-overlay-formats
15233 To turn on custom format overlays over timestamps (variables
15234 @code{org-put-time-stamp-overlays} and
15235 @code{org-time-stamp-overlay-formats}), use
15236 @cindex @code{customtime}, STARTUP keyword
15237 @example
15238 customtime @r{overlay custom time format}
15239 @end example
15241 @vindex constants-unit-system
15242 The following options influence the table spreadsheet (variable
15243 @code{constants-unit-system}).
15244 @cindex @code{constcgs}, STARTUP keyword
15245 @cindex @code{constSI}, STARTUP keyword
15246 @example
15247 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
15248 constSI    @r{@file{constants.el} should use the SI unit system}
15249 @end example
15251 @vindex org-footnote-define-inline
15252 @vindex org-footnote-auto-label
15253 @vindex org-footnote-auto-adjust
15254 To influence footnote settings, use the following keywords.  The
15255 corresponding variables are @code{org-footnote-define-inline},
15256 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
15257 @cindex @code{fninline}, STARTUP keyword
15258 @cindex @code{nofninline}, STARTUP keyword
15259 @cindex @code{fnlocal}, STARTUP keyword
15260 @cindex @code{fnprompt}, STARTUP keyword
15261 @cindex @code{fnauto}, STARTUP keyword
15262 @cindex @code{fnconfirm}, STARTUP keyword
15263 @cindex @code{fnplain}, STARTUP keyword
15264 @cindex @code{fnadjust}, STARTUP keyword
15265 @cindex @code{nofnadjust}, STARTUP keyword
15266 @example
15267 fninline    @r{define footnotes inline}
15268 fnnoinline  @r{define footnotes in separate section}
15269 fnlocal     @r{define footnotes near first reference, but not inline}
15270 fnprompt    @r{prompt for footnote labels}
15271 fnauto      @r{create @code{[fn:1]}-like labels automatically (default)}
15272 fnconfirm   @r{offer automatic label for editing or confirmation}
15273 fnplain     @r{create @code{[1]}-like labels automatically}
15274 fnadjust    @r{automatically renumber and sort footnotes}
15275 nofnadjust  @r{do not renumber and sort automatically}
15276 @end example
15278 @cindex org-hide-block-startup
15279 To hide blocks on startup, use these keywords.  The corresponding variable is
15280 @code{org-hide-block-startup}.
15281 @cindex @code{hideblocks}, STARTUP keyword
15282 @cindex @code{nohideblocks}, STARTUP keyword
15283 @example
15284 hideblocks   @r{Hide all begin/end blocks on startup}
15285 nohideblocks @r{Do not hide blocks on startup}
15286 @end example
15288 @cindex org-pretty-entities
15289 The display of entities as UTF-8 characters is governed by the variable
15290 @code{org-pretty-entities} and the keywords
15291 @cindex @code{entitiespretty}, STARTUP keyword
15292 @cindex @code{entitiesplain}, STARTUP keyword
15293 @example
15294 entitiespretty  @r{Show entities as UTF-8 characters where possible}
15295 entitiesplain   @r{Leave entities plain}
15296 @end example
15298 @item #+TAGS:  TAG1(c1) TAG2(c2)
15299 @vindex org-tag-alist
15300 These lines (several such lines are allowed) specify the valid tags in
15301 this file, and (potentially) the corresponding @emph{fast tag selection}
15302 keys.  The corresponding variable is @code{org-tag-alist}.
15303 @cindex #+TBLFM
15304 @item #+TBLFM:
15305 This line contains the formulas for the table directly above the line.
15307 Table can have multiple lines containing @samp{#+TBLFM:}.  Note
15308 that only the first line of @samp{#+TBLFM:} will be applied when
15309 you recalculate the table.  For more details see @ref{Using
15310 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
15312 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
15313 @itemx #+OPTIONS:, #+BIND:,
15314 @itemx #+DESCRIPTION:, #+KEYWORDS:,
15315 @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
15316 @itemx #+HTML_HEAD:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
15317 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
15318 These lines provide settings for exporting files.  For more details see
15319 @ref{Export settings}.
15320 @item #+TODO:    #+SEQ_TODO:   #+TYP_TODO:
15321 @vindex org-todo-keywords
15322 These lines set the TODO keywords and their interpretation in the
15323 current file.  The corresponding variable is @code{org-todo-keywords}.
15324 @end table
15326 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
15327 @section The very busy C-c C-c key
15328 @kindex C-c C-c
15329 @cindex C-c C-c, overview
15331 The key @kbd{C-c C-c} has many purposes in Org, which are all
15332 mentioned scattered throughout this manual.  One specific function of
15333 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
15334 other circumstances it means something like @emph{``Hey Org, look
15335 here and update according to what you see here''}.  Here is a summary of
15336 what this means in different contexts.
15338 @itemize @minus
15339 @item
15340 If there are highlights in the buffer from the creation of a sparse
15341 tree, or from clock display, remove these highlights.
15342 @item
15343 If the cursor is in one of the special @code{#+KEYWORD} lines, this
15344 triggers scanning the buffer for these lines and updating the
15345 information.
15346 @item
15347 If the cursor is inside a table, realign the table.  This command
15348 works even if the automatic table editor has been turned off.
15349 @item
15350 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
15351 the entire table.
15352 @item
15353 If the current buffer is a capture buffer, close the note and file it.
15354 With a prefix argument, file it, without further interaction, to the
15355 default location.
15356 @item
15357 If the cursor is on a @code{<<<target>>>}, update radio targets and
15358 corresponding links in this buffer.
15359 @item
15360 If the cursor is in a property line or at the start or end of a property
15361 drawer, offer property commands.
15362 @item
15363 If the cursor is at a footnote reference, go to the corresponding
15364 definition, and @emph{vice versa}.
15365 @item
15366 If the cursor is on a statistics cookie, update it.
15367 @item
15368 If the cursor is in a plain list item with a checkbox, toggle the status
15369 of the checkbox.
15370 @item
15371 If the cursor is on a numbered item in a plain list, renumber the
15372 ordered list.
15373 @item
15374 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
15375 block is updated.
15376 @item
15377 If the cursor is at a timestamp, fix the day name in the timestamp.
15378 @end itemize
15380 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
15381 @section A cleaner outline view
15382 @cindex hiding leading stars
15383 @cindex dynamic indentation
15384 @cindex odd-levels-only outlines
15385 @cindex clean outline view
15387 Some people find it noisy and distracting that the Org headlines start with a
15388 potentially large number of stars, and that text below the headlines is not
15389 indented.  While this is no problem when writing a @emph{book-like} document
15390 where the outline headings are really section headings, in a more
15391 @emph{list-oriented} outline, indented structure is a lot cleaner:
15393 @example
15394 @group
15395 * Top level headline             |    * Top level headline
15396 ** Second level                  |      * Second level
15397 *** 3rd level                    |        * 3rd level
15398 some text                        |          some text
15399 *** 3rd level                    |        * 3rd level
15400 more text                        |          more text
15401 * Another top level headline     |    * Another top level headline
15402 @end group
15403 @end example
15405 @noindent
15407 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
15408 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
15409 be achieved dynamically at display time using @code{org-indent-mode}.  In
15410 this minor mode, all lines are prefixed for display with the necessary amount
15411 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
15412 property, such that @code{visual-line-mode} (or purely setting
15413 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
15414 }.  Also headlines are prefixed with additional stars, so that the amount of
15415 indentation shifts by two@footnote{See the variable
15416 @code{org-indent-indentation-per-level}.}  spaces per level.  All headline
15417 stars but the last one are made invisible using the @code{org-hide}
15418 face@footnote{Turning on @code{org-indent-mode} sets
15419 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
15420 @code{nil}.}; see below under @samp{2.} for more information on how this
15421 works.  You can turn on @code{org-indent-mode} for all files by customizing
15422 the variable @code{org-startup-indented}, or you can turn it on for
15423 individual files using
15425 @example
15426 #+STARTUP: indent
15427 @end example
15429 If you want a similar effect in an earlier version of Emacs and/or Org, or if
15430 you want the indentation to be hard space characters so that the plain text
15431 file looks as similar as possible to the Emacs display, Org supports you in
15432 the following way:
15434 @enumerate
15435 @item
15436 @emph{Indentation of text below headlines}@*
15437 You may indent text below each headline to make the left boundary line up
15438 with the headline, like
15440 @example
15441 *** 3rd level
15442     more text, now indented
15443 @end example
15445 @vindex org-adapt-indentation
15446 Org supports this with paragraph filling, line wrapping, and structure
15447 editing@footnote{See also the variable @code{org-adapt-indentation}.},
15448 preserving or adapting the indentation as appropriate.
15450 @item
15451 @vindex org-hide-leading-stars
15452 @emph{Hiding leading stars}@* You can modify the display in such a way that
15453 all leading stars become invisible.  To do this in a global way, configure
15454 the variable @code{org-hide-leading-stars} or change this on a per-file basis
15455 with
15457 @example
15458 #+STARTUP: hidestars
15459 #+STARTUP: showstars
15460 @end example
15462 With hidden stars, the tree becomes:
15464 @example
15465 @group
15466 * Top level headline
15467  * Second level
15468   * 3rd level
15469   ...
15470 @end group
15471 @end example
15473 @noindent
15474 @vindex org-hide @r{(face)}
15475 The leading stars are not truly replaced by whitespace, they are only
15476 fontified with the face @code{org-hide} that uses the background color as
15477 font color.  If you are not using either white or black background, you may
15478 have to customize this face to get the wanted effect.  Another possibility is
15479 to set this font such that the extra stars are @i{almost} invisible, for
15480 example using the color @code{grey90} on a white background.
15482 @item
15483 @vindex org-odd-levels-only
15484 Things become cleaner still if you skip all the even levels and use only odd
15485 levels 1, 3, 5..., effectively adding two stars to go from one outline level
15486 to the next@footnote{When you need to specify a level for a property search
15487 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}.  In this
15488 way we get the outline view shown at the beginning of this section.  In order
15489 to make the structure editing and export commands handle this convention
15490 correctly, configure the variable @code{org-odd-levels-only}, or set this on
15491 a per-file basis with one of the following lines:
15493 @example
15494 #+STARTUP: odd
15495 #+STARTUP: oddeven
15496 @end example
15498 You can convert an Org file from single-star-per-level to the
15499 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
15500 RET} in that file.  The reverse operation is @kbd{M-x
15501 org-convert-to-oddeven-levels}.
15502 @end enumerate
15504 @node TTY keys, Interaction, Clean view, Miscellaneous
15505 @section Using Org on a tty
15506 @cindex tty key bindings
15508 Because Org contains a large number of commands, by default many of
15509 Org's core commands are bound to keys that are generally not
15510 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
15511 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
15512 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
15513 these commands on a tty when special keys are unavailable, the following
15514 alternative bindings can be used.  The tty bindings below will likely be
15515 more cumbersome; you may find for some of the bindings below that a
15516 customized workaround suits you better.  For example, changing a timestamp
15517 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
15518 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
15520 @multitable @columnfractions 0.15 0.2 0.1 0.2
15521 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
15522 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab @kbd{C} @tab
15523 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
15524 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab @kbd{L} @tab
15525 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x r}           @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
15526 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab @kbd{R} @tab
15527 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
15528 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab @kbd{U} @tab
15529 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
15530 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab @kbd{D} @tab
15531 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab @kbd{ } @tab
15532 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
15533 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab @kbd{ } @tab
15534 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab @kbd{ } @tab
15535 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab @kbd{ } @tab
15536 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab @kbd{ } @tab
15537 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab @kbd{ } @tab
15538 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab @kbd{ } @tab
15539 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
15540 @end multitable
15543 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
15544 @section Interaction with other packages
15545 @cindex packages, interaction with other
15546 Org lives in the world of GNU Emacs and interacts in various ways
15547 with other code out there.
15549 @menu
15550 * Cooperation::                 Packages Org cooperates with
15551 * Conflicts::                   Packages that lead to conflicts
15552 @end menu
15554 @node Cooperation, Conflicts, Interaction, Interaction
15555 @subsection Packages that Org cooperates with
15557 @table @asis
15558 @cindex @file{calc.el}
15559 @cindex Gillespie, Dave
15560 @item @file{calc.el} by Dave Gillespie
15561 Org uses the Calc package for implementing spreadsheet
15562 functionality in its tables (@pxref{The spreadsheet}).  Org
15563 checks for the availability of Calc by looking for the function
15564 @code{calc-eval} which will have been autoloaded during setup if Calc has
15565 been installed properly.  As of Emacs 22, Calc is part of the Emacs
15566 distribution.  Another possibility for interaction between the two
15567 packages is using Calc for embedded calculations.  @xref{Embedded Mode,
15568 , Embedded Mode, calc, GNU Emacs Calc Manual}.
15569 @item @file{constants.el} by Carsten Dominik
15570 @cindex @file{constants.el}
15571 @cindex Dominik, Carsten
15572 @vindex org-table-formula-constants
15573 In a table formula (@pxref{The spreadsheet}), it is possible to use
15574 names for natural constants or units.  Instead of defining your own
15575 constants in the variable @code{org-table-formula-constants}, install
15576 the @file{constants} package which defines a large number of constants
15577 and units, and lets you use unit prefixes like @samp{M} for
15578 @samp{Mega}, etc.  You will need version 2.0 of this package, available
15579 at @url{http://www.astro.uva.nl/~dominik/Tools}.  Org checks for
15580 the function @code{constants-get}, which has to be autoloaded in your
15581 setup.  See the installation instructions in the file
15582 @file{constants.el}.
15583 @item @file{cdlatex.el} by Carsten Dominik
15584 @cindex @file{cdlatex.el}
15585 @cindex Dominik, Carsten
15586 Org mode can make use of the CD@LaTeX{} package to efficiently enter
15587 @LaTeX{} fragments into Org files.  See @ref{CDLaTeX mode}.
15588 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
15589 @cindex @file{imenu.el}
15590 Imenu allows menu access to an index of items in a file.  Org mode
15591 supports Imenu---all you need to do to get the index is the following:
15592 @lisp
15593 (add-hook 'org-mode-hook
15594           (lambda () (imenu-add-to-menubar "Imenu")))
15595 @end lisp
15596 @vindex org-imenu-depth
15597 By default the index is two levels deep---you can modify the depth using
15598 the option @code{org-imenu-depth}.
15599 @item @file{remember.el} by John Wiegley
15600 @cindex @file{remember.el}
15601 @cindex Wiegley, John
15602 Org used to use this package for capture, but no longer does.
15603 @item @file{speedbar.el} by Eric M. Ludlam
15604 @cindex @file{speedbar.el}
15605 @cindex Ludlam, Eric M.
15606 Speedbar is a package that creates a special frame displaying files and
15607 index items in files.  Org mode supports Speedbar and allows you to
15608 drill into Org files directly from the Speedbar.  It also allows you to
15609 restrict the scope of agenda commands to a file or a subtree by using
15610 the command @kbd{<} in the Speedbar frame.
15611 @cindex @file{table.el}
15612 @item @file{table.el} by Takaaki Ota
15613 @kindex C-c C-c
15614 @cindex table editor, @file{table.el}
15615 @cindex @file{table.el}
15616 @cindex Ota, Takaaki
15618 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
15619 and alignment can be created using the Emacs table package by Takaaki Ota
15620 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
15621 Org mode will recognize these tables and export them properly.  Because of
15622 interference with other Org mode functionality, you unfortunately cannot edit
15623 these tables directly in the buffer.  Instead, you need to use the command
15624 @kbd{C-c '} to edit them, similar to source code snippets.
15626 @table @kbd
15627 @orgcmd{C-c ',org-edit-special}
15628 Edit a @file{table.el} table.  Works when the cursor is in a table.el table.
15630 @orgcmd{C-c ~,org-table-create-with-table.el}
15631 Insert a @file{table.el} table.  If there is already a table at point, this
15632 command converts it between the @file{table.el} format and the Org mode
15633 format.  See the documentation string of the command
15634 @code{org-convert-table} for the restrictions under which this is
15635 possible.
15636 @end table
15637 @file{table.el} is part of Emacs since Emacs 22.
15638 @item @file{footnote.el} by Steven L. Baur
15639 @cindex @file{footnote.el}
15640 @cindex Baur, Steven L.
15641 Org mode recognizes numerical footnotes as provided by this package.
15642 However, Org mode also has its own footnote support (@pxref{Footnotes}),
15643 which makes using @file{footnote.el} unnecessary.
15644 @end table
15646 @node Conflicts,  , Cooperation, Interaction
15647 @subsection Packages that lead to conflicts with Org mode
15649 @table @asis
15651 @cindex @code{shift-selection-mode}
15652 @vindex org-support-shift-select
15653 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
15654 cursor motions combined with the shift key should start or enlarge regions.
15655 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
15656 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
15657 at such a location.  By default, @kbd{S-@key{cursor}} commands outside
15658 special contexts don't do anything, but you can customize the variable
15659 @code{org-support-shift-select}.  Org mode then tries to accommodate shift
15660 selection by (i) using it outside of the special contexts where special
15661 commands apply, and by (ii) extending an existing active region even if the
15662 cursor moves across a special context.
15664 @item @file{CUA.el} by Kim. F. Storm
15665 @cindex @file{CUA.el}
15666 @cindex Storm, Kim. F.
15667 @vindex org-replace-disputed-keys
15668 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
15669 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
15670 region.  In fact, Emacs 23 has this built-in in the form of
15671 @code{shift-selection-mode}, see previous paragraph.  If you are using Emacs
15672 23, you probably don't want to use another package for this purpose.  However,
15673 if you prefer to leave these keys to a different package while working in
15674 Org mode, configure the variable @code{org-replace-disputed-keys}.  When set,
15675 Org will move the following key bindings in Org files, and in the agenda
15676 buffer (but not during date selection).
15678 @example
15679 S-UP      @result{}  M-p             S-DOWN     @result{}  M-n
15680 S-LEFT    @result{}  M--             S-RIGHT    @result{}  M-+
15681 C-S-LEFT  @result{}  M-S--           C-S-RIGHT  @result{}  M-S-+
15682 @end example
15684 @vindex org-disputed-keys
15685 Yes, these are unfortunately more difficult to remember.  If you want
15686 to have other replacement keys, look at the variable
15687 @code{org-disputed-keys}.
15689 @item @file{filladapt.el} by Kyle Jones
15690 @cindex @file{filladapt.el}
15692 Org mode tries to do the right thing when filling paragraphs, list items and
15693 other elements.  Many users reported they had problems using both
15694 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
15695 this:
15697 @lisp
15698 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
15699 @end lisp
15701 @item @file{yasnippet.el}
15702 @cindex @file{yasnippet.el}
15703 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
15704 @code{"\t"}) overrules YASnippet's access to this key.  The following code
15705 fixed this problem:
15707 @lisp
15708 (add-hook 'org-mode-hook
15709           (lambda ()
15710             (org-set-local 'yas/trigger-key [tab])
15711             (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
15712 @end lisp
15714 The latest version of yasnippet doesn't play well with Org mode.  If the
15715 above code does not fix the conflict, start by defining the following
15716 function:
15718 @lisp
15719 (defun yas/org-very-safe-expand ()
15720   (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
15721 @end lisp
15723 Then, tell Org mode what to do with the new function:
15725 @lisp
15726 (add-hook 'org-mode-hook
15727           (lambda ()
15728             (make-variable-buffer-local 'yas/trigger-key)
15729             (setq yas/trigger-key [tab])
15730             (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
15731             (define-key yas/keymap [tab] 'yas/next-field)))
15732 @end lisp
15734 @item @file{windmove.el} by Hovav Shacham
15735 @cindex @file{windmove.el}
15736 This package also uses the @kbd{S-<cursor>} keys, so everything written
15737 in the paragraph above about CUA mode also applies here.  If you want make
15738 the windmove function active in locations where Org mode does not have
15739 special functionality on @kbd{S-@key{cursor}}, add this to your
15740 configuration:
15742 @lisp
15743 ;; Make windmove work in org-mode:
15744 (add-hook 'org-shiftup-final-hook 'windmove-up)
15745 (add-hook 'org-shiftleft-final-hook 'windmove-left)
15746 (add-hook 'org-shiftdown-final-hook 'windmove-down)
15747 (add-hook 'org-shiftright-final-hook 'windmove-right)
15748 @end lisp
15750 @item @file{viper.el} by Michael Kifer
15751 @cindex @file{viper.el}
15752 @kindex C-c /
15753 Viper uses @kbd{C-c /} and therefore makes this key not access the
15754 corresponding Org mode command @code{org-sparse-tree}.  You need to find
15755 another key for this command, or override the key in
15756 @code{viper-vi-global-user-map} with
15758 @lisp
15759 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
15760 @end lisp
15762 @end table
15764 @node org-crypt.el,  , Interaction, Miscellaneous
15765 @section org-crypt.el
15766 @cindex @file{org-crypt.el}
15767 @cindex @code{org-decrypt-entry}
15769 Org-crypt will encrypt the text of an entry, but not the headline, or
15770 properties.  Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
15771 files.
15773 Any text below a headline that has a @samp{:crypt:} tag will be automatically
15774 be encrypted when the file is saved.  If you want to use a different tag just
15775 customize the @code{org-crypt-tag-matcher} setting.
15777 To use org-crypt it is suggested that you have the following in your
15778 @file{.emacs}:
15780 @lisp
15781 (require 'org-crypt)
15782 (org-crypt-use-before-save-magic)
15783 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
15785 (setq org-crypt-key nil)
15786   ;; GPG key to use for encryption
15787   ;; Either the Key ID or set to nil to use symmetric encryption.
15789 (setq auto-save-default nil)
15790   ;; Auto-saving does not cooperate with org-crypt.el: so you need
15791   ;; to turn it off if you plan to use org-crypt.el quite often.
15792   ;; Otherwise, you'll get an (annoying) message each time you
15793   ;; start Org.
15795   ;; To turn it off only locally, you can insert this:
15796   ;;
15797   ;; # -*- buffer-auto-save-file-name: nil; -*-
15798 @end lisp
15800 Excluding the crypt tag from inheritance prevents already encrypted text
15801 being encrypted again.
15803 @node Hacking, MobileOrg, Miscellaneous, Top
15804 @appendix Hacking
15805 @cindex hacking
15807 This appendix covers some aspects where users can extend the functionality of
15808 Org.
15810 @menu
15811 * Hooks::                       How to reach into Org's internals
15812 * Add-on packages::             Available extensions
15813 * Adding hyperlink types::      New custom link types
15814 * Adding export back-ends::     How to write new export back-ends
15815 * Context-sensitive commands::  How to add functionality to such commands
15816 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
15817 * Dynamic blocks::              Automatically filled blocks
15818 * Special agenda views::        Customized views
15819 * Speeding up your agendas::    Tips on how to speed up your agendas
15820 * Extracting agenda information::  Post-processing of agenda information
15821 * Using the property API::      Writing programs that use entry properties
15822 * Using the mapping API::       Mapping over all or selected entries
15823 @end menu
15825 @node Hooks, Add-on packages, Hacking, Hacking
15826 @section Hooks
15827 @cindex hooks
15829 Org has a large number of hook variables that can be used to add
15830 functionality.  This appendix about hacking is going to illustrate the
15831 use of some of them.  A complete list of all hooks with documentation is
15832 maintained by the Worg project and can be found at
15833 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
15835 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
15836 @section Add-on packages
15837 @cindex add-on packages
15839 A large number of add-on packages have been written by various authors.
15840 These packages are not part of Emacs, but they are distributed as contributed
15841 packages with the separate release available at the Org mode home page at
15842 @uref{http://orgmode.org}.  The list of contributed packages, along with
15843 documentation about each package, is maintained by the Worg project at
15844 @uref{http://orgmode.org/worg/org-contrib/}.
15848 @node Adding hyperlink types, Adding export back-ends, Add-on packages, Hacking
15849 @section Adding hyperlink types
15850 @cindex hyperlinks, adding new types
15852 Org has a large number of hyperlink types built-in
15853 (@pxref{Hyperlinks}).  If you would like to add new link types, Org
15854 provides an interface for doing so.  Let's look at an example file,
15855 @file{org-man.el}, that will add support for creating links like
15856 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
15857 Emacs:
15859 @lisp
15860 ;;; org-man.el - Support for links to manpages in Org
15862 (require 'org)
15864 (org-add-link-type "man" 'org-man-open)
15865 (add-hook 'org-store-link-functions 'org-man-store-link)
15867 (defcustom org-man-command 'man
15868   "The Emacs command to be used to display a man page."
15869   :group 'org-link
15870   :type '(choice (const man) (const woman)))
15872 (defun org-man-open (path)
15873   "Visit the manpage on PATH.
15874 PATH should be a topic that can be thrown at the man command."
15875   (funcall org-man-command path))
15877 (defun org-man-store-link ()
15878   "Store a link to a manpage."
15879   (when (memq major-mode '(Man-mode woman-mode))
15880     ;; This is a man page, we do make this link
15881     (let* ((page (org-man-get-page-name))
15882            (link (concat "man:" page))
15883            (description (format "Manpage for %s" page)))
15884       (org-store-link-props
15885        :type "man"
15886        :link link
15887        :description description))))
15889 (defun org-man-get-page-name ()
15890   "Extract the page name from the buffer name."
15891   ;; This works for both `Man-mode' and `woman-mode'.
15892   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
15893       (match-string 1 (buffer-name))
15894     (error "Cannot create link to this man page")))
15896 (provide 'org-man)
15898 ;;; org-man.el ends here
15899 @end lisp
15901 @noindent
15902 You would activate this new link type in @file{.emacs} with
15904 @lisp
15905 (require 'org-man)
15906 @end lisp
15908 @noindent
15909 Let's go through the file and see what it does.
15910 @enumerate
15911 @item
15912 It does @code{(require 'org)} to make sure that @file{org.el} has been
15913 loaded.
15914 @item
15915 The next line calls @code{org-add-link-type} to define a new link type
15916 with prefix @samp{man}.  The call also contains the name of a function
15917 that will be called to follow such a link.
15918 @item
15919 @vindex org-store-link-functions
15920 The next line adds a function to @code{org-store-link-functions}, in
15921 order to allow the command @kbd{C-c l} to record a useful link in a
15922 buffer displaying a man page.
15923 @end enumerate
15925 The rest of the file defines the necessary variables and functions.
15926 First there is a customization variable that determines which Emacs
15927 command should be used to display man pages.  There are two options,
15928 @code{man} and @code{woman}.  Then the function to follow a link is
15929 defined.  It gets the link path as an argument---in this case the link
15930 path is just a topic for the manual command.  The function calls the
15931 value of @code{org-man-command} to display the man page.
15933 Finally the function @code{org-man-store-link} is defined.  When you try
15934 to store a link with @kbd{C-c l}, this function will be called to
15935 try to make a link.  The function must first decide if it is supposed to
15936 create the link for this buffer type; we do this by checking the value
15937 of the variable @code{major-mode}.  If not, the function must exit and
15938 return the value @code{nil}.  If yes, the link is created by getting the
15939 manual topic from the buffer name and prefixing it with the string
15940 @samp{man:}.  Then it must call the command @code{org-store-link-props}
15941 and set the @code{:type} and @code{:link} properties.  Optionally you
15942 can also set the @code{:description} property to provide a default for
15943 the link description when the link is later inserted into an Org
15944 buffer with @kbd{C-c C-l}.
15946 When it makes sense for your new link type, you may also define a function
15947 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
15948 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
15949 not accept any arguments, and return the full link with prefix.
15951 @node Adding export back-ends, Context-sensitive commands, Adding hyperlink types, Hacking
15952 @section Adding export back-ends
15953 @cindex Export, writing back-ends
15955 Org 8.0 comes with a completely rewritten export engine which makes it easy
15956 to write new export back-ends, either from scratch, or from deriving them
15957 from existing ones.
15959 Your two entry points are respectively @code{org-export-define-backend} and
15960 @code{org-export-define-derived-backend}.  To grok these functions, you
15961 should first have a look at @file{ox-latex.el} (for how to define a new
15962 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
15963 back-end from an existing one.
15965 When creating a new back-end from scratch, the basic idea is to set the name
15966 of the back-end (as a symbol) and an an alist of elements and export
15967 functions.  On top of this, you will need to set additional keywords like
15968 @code{:menu-entry} (to display the back-end in the export dispatcher),
15969 @code{:export-block} (to specify what blocks should not be exported by this
15970 back-end), and @code{:options-alist} (to let the user set export options that
15971 are specific to this back-end.)
15973 Deriving a new back-end is similar, except that you need to set
15974 @code{:translate-alist} to an alist of export functions that should be used
15975 instead of the parent back-end functions.
15977 For a complete reference documentation, see
15978 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
15979 Reference on Worg}.
15981 @node Context-sensitive commands, Tables in arbitrary syntax, Adding export back-ends, Hacking
15982 @section Context-sensitive commands
15983 @cindex context-sensitive commands, hooks
15984 @cindex add-ons, context-sensitive commands
15985 @vindex org-ctrl-c-ctrl-c-hook
15987 Org has several commands that act differently depending on context.  The most
15988 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
15989 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
15991 Add-ons can tap into this functionality by providing a function that detects
15992 special context for that add-on and executes functionality appropriate for
15993 the context.  Here is an example from Dan Davison's @file{org-R.el} which
15994 allows you to evaluate commands based on the @file{R} programming language
15995 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
15996 described in @ref{Working With Source Code} and is now obsolete.}.  For this
15997 package, special contexts are lines that start with @code{#+R:} or
15998 @code{#+RR:}.
16000 @lisp
16001 (defun org-R-apply-maybe ()
16002   "Detect if this is context for org-R and execute R commands."
16003   (if (save-excursion
16004         (beginning-of-line 1)
16005         (looking-at "#\\+RR?:"))
16006       (progn (call-interactively 'org-R-apply)
16007              t) ;; to signal that we took action
16008     nil)) ;; to signal that we did not
16010 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
16011 @end lisp
16013 The function first checks if the cursor is in such a line.  If that is the
16014 case, @code{org-R-apply} is called and the function returns @code{t} to
16015 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
16016 contexts.  If the function finds it should do nothing locally, it returns
16017 @code{nil} so that other, similar functions can have a try.
16020 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
16021 @section Tables and lists in arbitrary syntax
16022 @cindex tables, in other modes
16023 @cindex lists, in other modes
16024 @cindex Orgtbl mode
16026 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
16027 frequent feature request has been to make it work with native tables in
16028 specific languages, for example @LaTeX{}.  However, this is extremely
16029 hard to do in a general way, would lead to a customization nightmare,
16030 and would take away much of the simplicity of the Orgtbl mode table
16031 editor.
16033 This appendix describes a different approach.  We keep the Orgtbl mode
16034 table in its native format (the @i{source table}), and use a custom
16035 function to @i{translate} the table to the correct syntax, and to
16036 @i{install} it in the right location (the @i{target table}).  This puts
16037 the burden of writing conversion functions on the user, but it allows
16038 for a very flexible system.
16040 Bastien added the ability to do the same with lists, in Orgstruct mode.  You
16041 can use Org's facilities to edit and structure lists by turning
16042 @code{orgstruct-mode} on, then locally exporting such lists in another format
16043 (HTML, @LaTeX{} or Texinfo.)
16046 @menu
16047 * Radio tables::                Sending and receiving radio tables
16048 * A @LaTeX{} example::          Step by step, almost a tutorial
16049 * Translator functions::        Copy and modify
16050 * Radio lists::                 Doing the same for lists
16051 @end menu
16053 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
16054 @subsection Radio tables
16055 @cindex radio tables
16057 To define the location of the target table, you first need to create two
16058 lines that are comments in the current mode, but contain magic words for
16059 Orgtbl mode to find.  Orgtbl mode will insert the translated table
16060 between these lines, replacing whatever was there before.  For example:
16062 @example
16063 /* BEGIN RECEIVE ORGTBL table_name */
16064 /* END RECEIVE ORGTBL table_name */
16065 @end example
16067 @noindent
16068 Just above the source table, we put a special line that tells
16069 Orgtbl mode how to translate this table and where to install it.  For
16070 example:
16071 @cindex #+ORGTBL
16072 @example
16073 #+ORGTBL: SEND table_name translation_function arguments....
16074 @end example
16076 @noindent
16077 @code{table_name} is the reference name for the table that is also used
16078 in the receiver lines.  @code{translation_function} is the Lisp function
16079 that does the translation.  Furthermore, the line can contain a list of
16080 arguments (alternating key and value) at the end.  The arguments will be
16081 passed as a property list to the translation function for
16082 interpretation.  A few standard parameters are already recognized and
16083 acted upon before the translation function is called:
16085 @table @code
16086 @item :skip N
16087 Skip the first N lines of the table.  Hlines do count as separate lines for
16088 this parameter!
16090 @item :skipcols (n1 n2 ...)
16091 List of columns that should be skipped.  If the table has a column with
16092 calculation marks, that column is automatically discarded as well.
16093 Please note that the translator function sees the table @emph{after} the
16094 removal of these columns, the function never knows that there have been
16095 additional columns.
16097 @item :no-escape t
16098 When non-nil, do not escape special characters @code{&%#_^} when exporting
16099 the table.  The default value is nil.
16100 @end table
16102 @noindent
16103 The one problem remaining is how to keep the source table in the buffer
16104 without disturbing the normal workings of the file, for example during
16105 compilation of a C file or processing of a @LaTeX{} file.  There are a
16106 number of different solutions:
16108 @itemize @bullet
16109 @item
16110 The table could be placed in a block comment if that is supported by the
16111 language.  For example, in C mode you could wrap the table between
16112 @samp{/*} and @samp{*/} lines.
16113 @item
16114 Sometimes it is possible to put the table after some kind of @i{END}
16115 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
16116 in @LaTeX{}.
16117 @item
16118 You can just comment the table line-by-line whenever you want to process
16119 the file, and uncomment it whenever you need to edit the table.  This
16120 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
16121 makes this comment-toggling very easy, in particular if you bind it to a
16122 key.
16123 @end itemize
16125 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
16126 @subsection A @LaTeX{} example of radio tables
16127 @cindex @LaTeX{}, and Orgtbl mode
16129 The best way to wrap the source table in @LaTeX{} is to use the
16130 @code{comment} environment provided by @file{comment.sty}.  It has to be
16131 activated by placing @code{\usepackage@{comment@}} into the document
16132 header.  Orgtbl mode can insert a radio table skeleton@footnote{By
16133 default this works only for @LaTeX{}, HTML, and Texinfo.  Configure the
16134 variable @code{orgtbl-radio-tables} to install templates for other
16135 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table}.  You will
16136 be prompted for a table name, let's say we use @samp{salesfigures}.  You
16137 will then get the following template:
16139 @cindex #+ORGTBL, SEND
16140 @example
16141 % BEGIN RECEIVE ORGTBL salesfigures
16142 % END RECEIVE ORGTBL salesfigures
16143 \begin@{comment@}
16144 #+ORGTBL: SEND salesfigures orgtbl-to-latex
16145 | | |
16146 \end@{comment@}
16147 @end example
16149 @noindent
16150 @vindex @LaTeX{}-verbatim-environments
16151 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
16152 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
16153 into the receiver location with name @code{salesfigures}.  You may now
16154 fill in the table---feel free to use the spreadsheet features@footnote{If
16155 the @samp{#+TBLFM} line contains an odd number of dollar characters,
16156 this may cause problems with font-lock in @LaTeX{} mode.  As shown in the
16157 example you can fix this by adding an extra line inside the
16158 @code{comment} environment that is used to balance the dollar
16159 expressions.  If you are using AUC@TeX{} with the font-latex library, a
16160 much better solution is to add the @code{comment} environment to the
16161 variable @code{LaTeX-verbatim-environments}.}:
16163 @example
16164 % BEGIN RECEIVE ORGTBL salesfigures
16165 % END RECEIVE ORGTBL salesfigures
16166 \begin@{comment@}
16167 #+ORGTBL: SEND salesfigures orgtbl-to-latex
16168 | Month | Days | Nr sold | per day |
16169 |-------+------+---------+---------|
16170 | Jan   |   23 |      55 |     2.4 |
16171 | Feb   |   21 |      16 |     0.8 |
16172 | March |   22 |     278 |    12.6 |
16173 #+TBLFM: $4=$3/$2;%.1f
16174 % $ (optional extra dollar to keep font-lock happy, see footnote)
16175 \end@{comment@}
16176 @end example
16178 @noindent
16179 When you are done, press @kbd{C-c C-c} in the table to get the converted
16180 table inserted between the two marker lines.
16182 Now let's assume you want to make the table header by hand, because you
16183 want to control how columns are aligned, etc.  In this case we make sure
16184 that the table translator skips the first 2 lines of the source
16185 table, and tell the command to work as a @i{splice}, i.e., to not produce
16186 header and footer commands of the target table:
16188 @example
16189 \begin@{tabular@}@{lrrr@}
16190 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
16191 % BEGIN RECEIVE ORGTBL salesfigures
16192 % END RECEIVE ORGTBL salesfigures
16193 \end@{tabular@}
16195 \begin@{comment@}
16196 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
16197 | Month | Days | Nr sold | per day |
16198 |-------+------+---------+---------|
16199 | Jan   |   23 |      55 |     2.4 |
16200 | Feb   |   21 |      16 |     0.8 |
16201 | March |   22 |     278 |    12.6 |
16202 #+TBLFM: $4=$3/$2;%.1f
16203 \end@{comment@}
16204 @end example
16206 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
16207 Orgtbl mode.  It uses a @code{tabular} environment to typeset the table
16208 and marks horizontal lines with @code{\hline}.  Furthermore, it
16209 interprets the following parameters (see also @pxref{Translator functions}):
16211 @table @code
16212 @item :splice nil/t
16213 When set to t, return only table body lines, don't wrap them into a
16214 tabular environment.  Default is nil.
16216 @item :fmt fmt
16217 A format to be used to wrap each field, it should contain @code{%s} for the
16218 original field value.  For example, to wrap each field value in dollars,
16219 you could use @code{:fmt "$%s$"}.  This may also be a property list with
16220 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
16221 A function of one argument can be used in place of the strings; the
16222 function must return a formatted string.
16224 @item :efmt efmt
16225 Use this format to print numbers with exponentials.  The format should
16226 have @code{%s} twice for inserting mantissa and exponent, for example
16227 @code{"%s\\times10^@{%s@}"}.  The default is @code{"%s\\,(%s)"}.  This
16228 may also be a property list with column numbers and formats, for example
16229 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}.  After
16230 @code{efmt} has been applied to a value, @code{fmt} will also be
16231 applied.  Similar to @code{fmt}, functions of two arguments can be
16232 supplied instead of strings.
16233 @end table
16235 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
16236 @subsection Translator functions
16237 @cindex HTML, and Orgtbl mode
16238 @cindex translator function
16240 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
16241 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
16242 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
16243 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
16244 code that produces tables during HTML export.}, these all use a generic
16245 translator, @code{orgtbl-to-generic}.  For example, @code{orgtbl-to-latex}
16246 itself is a very short function that computes the column definitions for the
16247 @code{tabular} environment, defines a few field and line separators and then
16248 hands processing over to the generic translator.  Here is the entire code:
16250 @lisp
16251 @group
16252 (defun orgtbl-to-latex (table params)
16253   "Convert the Orgtbl mode TABLE to LaTeX."
16254   (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
16255                                org-table-last-alignment ""))
16256          (params2
16257           (list
16258            :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
16259            :tend "\\end@{tabular@}"
16260            :lstart "" :lend " \\\\" :sep " & "
16261            :efmt "%s\\,(%s)" :hline "\\hline")))
16262     (orgtbl-to-generic table (org-combine-plists params2 params))))
16263 @end group
16264 @end lisp
16266 As you can see, the properties passed into the function (variable
16267 @var{PARAMS}) are combined with the ones newly defined in the function
16268 (variable @var{PARAMS2}).  The ones passed into the function (i.e., the
16269 ones set by the @samp{ORGTBL SEND} line) take precedence.  So if you
16270 would like to use the @LaTeX{} translator, but wanted the line endings to
16271 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
16272 overrule the default with
16274 @example
16275 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
16276 @end example
16278 For a new language, you can either write your own converter function in
16279 analogy with the @LaTeX{} translator, or you can use the generic function
16280 directly.  For example, if you have a language where a table is started
16281 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
16282 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
16283 separator is a TAB, you could call the generic translator like this (on
16284 a single line!):
16286 @example
16287 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
16288                               :lstart "!BL! " :lend " !EL!" :sep "\t"
16289 @end example
16291 @noindent
16292 Please check the documentation string of the function
16293 @code{orgtbl-to-generic} for a full list of parameters understood by
16294 that function, and remember that you can pass each of them into
16295 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
16296 using the generic function.
16298 Of course you can also write a completely new function doing complicated
16299 things the generic translator cannot do.  A translator function takes
16300 two arguments.  The first argument is the table, a list of lines, each
16301 line either the symbol @code{hline} or a list of fields.  The second
16302 argument is the property list containing all parameters specified in the
16303 @samp{#+ORGTBL: SEND} line.  The function must return a single string
16304 containing the formatted table.  If you write a generally useful
16305 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
16306 others can benefit from your work.
16308 @node Radio lists,  , Translator functions, Tables in arbitrary syntax
16309 @subsection Radio lists
16310 @cindex radio lists
16311 @cindex org-list-insert-radio-list
16313 Sending and receiving radio lists works exactly the same way as sending and
16314 receiving radio tables (@pxref{Radio tables}).  As for radio tables, you can
16315 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
16316 @code{org-list-insert-radio-list}.
16318 Here are the differences with radio tables:
16320 @itemize @minus
16321 @item
16322 Orgstruct mode must be active.
16323 @item
16324 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
16325 @item
16326 The available translation functions for radio lists don't take
16327 parameters.
16328 @item
16329 @kbd{C-c C-c} will work when pressed on the first item of the list.
16330 @end itemize
16332 Here is a @LaTeX{} example.  Let's say that you have this in your
16333 @LaTeX{} file:
16335 @cindex #+ORGLST
16336 @example
16337 % BEGIN RECEIVE ORGLST to-buy
16338 % END RECEIVE ORGLST to-buy
16339 \begin@{comment@}
16340 #+ORGLST: SEND to-buy org-list-to-latex
16341 - a new house
16342 - a new computer
16343   + a new keyboard
16344   + a new mouse
16345 - a new life
16346 \end@{comment@}
16347 @end example
16349 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
16350 @LaTeX{} list between the two marker lines.
16352 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
16353 @section Dynamic blocks
16354 @cindex dynamic blocks
16356 Org documents can contain @emph{dynamic blocks}.  These are
16357 specially marked regions that are updated by some user-written function.
16358 A good example for such a block is the clock table inserted by the
16359 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
16361 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
16362 to the block and can also specify parameters for the function producing
16363 the content of the block.
16365 @cindex #+BEGIN:dynamic block
16366 @example
16367 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
16369 #+END:
16370 @end example
16372 Dynamic blocks are updated with the following commands
16374 @table @kbd
16375 @orgcmd{C-c C-x C-u,org-dblock-update}
16376 Update dynamic block at point.
16377 @orgkey{C-u C-c C-x C-u}
16378 Update all dynamic blocks in the current file.
16379 @end table
16381 Updating a dynamic block means to remove all the text between BEGIN and
16382 END, parse the BEGIN line for parameters and then call the specific
16383 writer function for this block to insert the new content.  If you want
16384 to use the original content in the writer function, you can use the
16385 extra parameter @code{:content}.
16387 For a block with name @code{myblock}, the writer function is
16388 @code{org-dblock-write:myblock} with as only parameter a property list
16389 with the parameters given in the begin line.  Here is a trivial example
16390 of a block that keeps track of when the block update function was last
16391 run:
16393 @example
16394 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
16396 #+END:
16397 @end example
16399 @noindent
16400 The corresponding block writer function could look like this:
16402 @lisp
16403 (defun org-dblock-write:block-update-time (params)
16404   (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
16405     (insert "Last block update at: "
16406             (format-time-string fmt (current-time)))))
16407 @end lisp
16409 If you want to make sure that all dynamic blocks are always up-to-date,
16410 you could add the function @code{org-update-all-dblocks} to a hook, for
16411 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
16412 written in a way such that it does nothing in buffers that are not in
16413 @code{org-mode}.
16415 You can narrow the current buffer to the current dynamic block (like any
16416 other block) with @code{org-narrow-to-block}.
16418 @node Special agenda views, Speeding up your agendas, Dynamic blocks, Hacking
16419 @section Special agenda views
16420 @cindex agenda views, user-defined
16422 @vindex org-agenda-skip-function
16423 @vindex org-agenda-skip-function-global
16424 Org provides a special hook that can be used to narrow down the selection
16425 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
16426 @code{agenda*} view is the same than @code{agenda} except that it only
16427 considers @emph{appointments}, i.e., scheduled and deadline items that have a
16428 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
16429 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}.  You may
16430 specify a function that is used at each match to verify if the match should
16431 indeed be part of the agenda view, and if not, how much should be skipped.
16432 You can specify a global condition that will be applied to all agenda views,
16433 this condition would be stored in the variable
16434 @code{org-agenda-skip-function-global}.  More commonly, such a definition is
16435 applied only to specific custom searches, using
16436 @code{org-agenda-skip-function}.
16438 Let's say you want to produce a list of projects that contain a WAITING
16439 tag anywhere in the project tree.  Let's further assume that you have
16440 marked all tree headings that define a project with the TODO keyword
16441 PROJECT@.  In this case you would run a TODO search for the keyword
16442 PROJECT, but skip the match unless there is a WAITING tag anywhere in
16443 the subtree belonging to the project line.
16445 To achieve this, you must write a function that searches the subtree for
16446 the tag.  If the tag is found, the function must return @code{nil} to
16447 indicate that this match should not be skipped.  If there is no such
16448 tag, return the location of the end of the subtree, to indicate that
16449 search should continue from there.
16451 @lisp
16452 (defun my-skip-unless-waiting ()
16453   "Skip trees that are not waiting"
16454   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
16455     (if (re-search-forward ":waiting:" subtree-end t)
16456         nil          ; tag found, do not skip
16457       subtree-end))) ; tag not found, continue after end of subtree
16458 @end lisp
16460 Now you may use this function in an agenda custom command, for example
16461 like this:
16463 @lisp
16464 (org-add-agenda-custom-command
16465  '("b" todo "PROJECT"
16466    ((org-agenda-skip-function 'my-skip-unless-waiting)
16467     (org-agenda-overriding-header "Projects waiting for something: "))))
16468 @end lisp
16470 @vindex org-agenda-overriding-header
16471 Note that this also binds @code{org-agenda-overriding-header} to get a
16472 meaningful header in the agenda view.
16474 @vindex org-odd-levels-only
16475 @vindex org-agenda-skip-function
16476 A general way to create custom searches is to base them on a search for
16477 entries with a certain level limit.  If you want to study all entries with
16478 your custom search function, simply do a search for
16479 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
16480 level number corresponds to order in the hierarchy, not to the number of
16481 stars.}, and then use @code{org-agenda-skip-function} to select the entries
16482 you really want to have.
16484 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
16485 particular, you may use the functions @code{org-agenda-skip-entry-if}
16486 and @code{org-agenda-skip-subtree-if} in this form, for example:
16488 @table @code
16489 @item (org-agenda-skip-entry-if 'scheduled)
16490 Skip current entry if it has been scheduled.
16491 @item (org-agenda-skip-entry-if 'notscheduled)
16492 Skip current entry if it has not been scheduled.
16493 @item (org-agenda-skip-entry-if 'deadline)
16494 Skip current entry if it has a deadline.
16495 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
16496 Skip current entry if it has a deadline, or if it is scheduled.
16497 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
16498 Skip current entry if the TODO keyword is TODO or WAITING.
16499 @item (org-agenda-skip-entry-if 'todo 'done)
16500 Skip current entry if the TODO keyword marks a DONE state.
16501 @item (org-agenda-skip-entry-if 'timestamp)
16502 Skip current entry if it has any timestamp, may also be deadline or scheduled.
16503 @anchor{x-agenda-skip-entry-regexp}
16504 @item (org-agenda-skip-entry-if 'regexp "regular expression")
16505 Skip current entry if the regular expression matches in the entry.
16506 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
16507 Skip current entry unless the regular expression matches.
16508 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
16509 Same as above, but check and skip the entire subtree.
16510 @end table
16512 Therefore we could also have written the search for WAITING projects
16513 like this, even without defining a special function:
16515 @lisp
16516 (org-add-agenda-custom-command
16517  '("b" todo "PROJECT"
16518    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
16519                                 'regexp ":waiting:"))
16520     (org-agenda-overriding-header "Projects waiting for something: "))))
16521 @end lisp
16523 @node Speeding up your agendas, Extracting agenda information, Special agenda views, Hacking
16524 @section Speeding up your agendas
16525 @cindex agenda views, optimization
16527 When your Org files grow in both number and size, agenda commands may start
16528 to become slow.  Below are some tips on how to speed up the agenda commands.
16530 @enumerate
16531 @item
16532 Reduce the number of Org agenda files: this will reduce the slowliness caused
16533 by accessing to a hard drive.
16534 @item
16535 Reduce the number of DONE and archived headlines: this way the agenda does
16536 not need to skip them.
16537 @item
16538 @vindex org-agenda-dim-blocked-tasks
16539 Inhibit the dimming of blocked tasks: 
16540 @lisp
16541 (setq org-agenda-dim-blocked-tasks nil)
16542 @end lisp
16543 @item
16544 @vindex org-startup-folded
16545 @vindex org-agenda-inhibit-startup
16546 Inhibit agenda files startup options:
16547 @lisp
16548 (setq org-agenda-inhibit-startup nil)
16549 @end lisp
16550 @item
16551 @vindex org-agenda-show-inherited-tags
16552 @vindex org-agenda-use-tag-inheritance
16553 Disable tag inheritance in agenda:
16554 @lisp
16555 (setq org-agenda-use-tag-inheritance nil)
16556 @end lisp
16557 @end enumerate
16559 You can set these options for specific agenda views only.  See the docstrings
16560 of these variables for details on why they affect the agenda generation, and
16561 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
16562 page} for further explanations.
16564 @node Extracting agenda information, Using the property API, Speeding up your agendas, Hacking
16565 @section Extracting agenda information
16566 @cindex agenda, pipe
16567 @cindex Scripts, for agenda processing
16569 @vindex org-agenda-custom-commands
16570 Org provides commands to access agenda information for the command
16571 line in Emacs batch mode.  This extracted information can be sent
16572 directly to a printer, or it can be read by a program that does further
16573 processing of the data.  The first of these commands is the function
16574 @code{org-batch-agenda}, that produces an agenda view and sends it as
16575 ASCII text to STDOUT@.  The command takes a single string as parameter.
16576 If the string has length 1, it is used as a key to one of the commands
16577 you have configured in @code{org-agenda-custom-commands}, basically any
16578 key you can use after @kbd{C-c a}.  For example, to directly print the
16579 current TODO list, you could use
16581 @example
16582 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
16583 @end example
16585 If the parameter is a string with 2 or more characters, it is used as a
16586 tags/TODO match string.  For example, to print your local shopping list
16587 (all items with the tag @samp{shop}, but excluding the tag
16588 @samp{NewYork}), you could use
16590 @example
16591 emacs -batch -l ~/.emacs                                      \
16592       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
16593 @end example
16595 @noindent
16596 You may also modify parameters on the fly like this:
16598 @example
16599 emacs -batch -l ~/.emacs                                      \
16600    -eval '(org-batch-agenda "a"                               \
16601             org-agenda-span (quote month)                     \
16602             org-agenda-include-diary nil                      \
16603             org-agenda-files (quote ("~/org/project.org")))'  \
16604    | lpr
16605 @end example
16607 @noindent
16608 which will produce a 30-day agenda, fully restricted to the Org file
16609 @file{~/org/projects.org}, not even including the diary.
16611 If you want to process the agenda data in more sophisticated ways, you
16612 can use the command @code{org-batch-agenda-csv} to get a comma-separated
16613 list of values for each agenda item.  Each line in the output will
16614 contain a number of fields separated by commas.  The fields in a line
16615 are:
16617 @example
16618 category     @r{The category of the item}
16619 head         @r{The headline, without TODO keyword, TAGS and PRIORITY}
16620 type         @r{The type of the agenda entry, can be}
16621                 todo               @r{selected in TODO match}
16622                 tagsmatch          @r{selected in tags match}
16623                 diary              @r{imported from diary}
16624                 deadline           @r{a deadline}
16625                 scheduled          @r{scheduled}
16626                 timestamp          @r{appointment, selected by timestamp}
16627                 closed             @r{entry was closed on date}
16628                 upcoming-deadline  @r{warning about nearing deadline}
16629                 past-scheduled     @r{forwarded scheduled item}
16630                 block              @r{entry has date block including date}
16631 todo         @r{The TODO keyword, if any}
16632 tags         @r{All tags including inherited ones, separated by colons}
16633 date         @r{The relevant date, like 2007-2-14}
16634 time         @r{The time, like 15:00-16:50}
16635 extra        @r{String with extra planning info}
16636 priority-l   @r{The priority letter if any was given}
16637 priority-n   @r{The computed numerical priority}
16638 @end example
16640 @noindent
16641 Time and date will only be given if a timestamp (or deadline/scheduled)
16642 led to the selection of the item.
16644 A CSV list like this is very easy to use in a post-processing script.
16645 For example, here is a Perl program that gets the TODO list from
16646 Emacs/Org and prints all the items, preceded by a checkbox:
16648 @example
16649 #!/usr/bin/perl
16651 # define the Emacs command to run
16652 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
16654 # run it and capture the output
16655 $agenda = qx@{$cmd 2>/dev/null@};
16657 # loop over all lines
16658 foreach $line (split(/\n/,$agenda)) @{
16659   # get the individual values
16660   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
16661    $priority_l,$priority_n) = split(/,/,$line);
16662   # process and print
16663   print "[ ] $head\n";
16665 @end example
16667 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
16668 @section Using the property API
16669 @cindex API, for properties
16670 @cindex properties, API
16672 Here is a description of the functions that can be used to work with
16673 properties.
16675 @defun org-entry-properties &optional pom which
16676 Get all properties of the entry at point-or-marker POM.@*
16677 This includes the TODO keyword, the tags, time strings for deadline,
16678 scheduled, and clocking, and any additional properties defined in the
16679 entry.  The return value is an alist.  Keys may occur multiple times
16680 if the property key was used several times.@*
16681 POM may also be nil, in which case the current entry is used.
16682 If WHICH is nil or `all', get all properties.  If WHICH is
16683 `special' or `standard', only get that subclass.
16684 @end defun
16685 @vindex org-use-property-inheritance
16686 @findex org-insert-property-drawer
16687 @defun org-entry-get pom property &optional inherit
16688 Get value of PROPERTY for entry at point-or-marker POM@.  By default,
16689 this only looks at properties defined locally in the entry.  If INHERIT
16690 is non-nil and the entry does not have the property, then also check
16691 higher levels of the hierarchy.  If INHERIT is the symbol
16692 @code{selective}, use inheritance if and only if the setting of
16693 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
16694 @end defun
16696 @defun org-entry-delete pom property
16697 Delete the property PROPERTY from entry at point-or-marker POM.
16698 @end defun
16700 @defun org-entry-put pom property value
16701 Set PROPERTY to VALUE for entry at point-or-marker POM.
16702 @end defun
16704 @defun org-buffer-property-keys &optional include-specials
16705 Get all property keys in the current buffer.
16706 @end defun
16708 @defun org-insert-property-drawer
16709 Insert a property drawer for the current entry.  Also
16710 @end defun
16712 @defun org-entry-put-multivalued-property pom property &rest values
16713 Set PROPERTY at point-or-marker POM to VALUES@.  VALUES should be a list of
16714 strings.  They will be concatenated, with spaces as separators.
16715 @end defun
16717 @defun org-entry-get-multivalued-property pom property
16718 Treat the value of the property PROPERTY as a whitespace-separated list of
16719 values and return the values as a list of strings.
16720 @end defun
16722 @defun org-entry-add-to-multivalued-property pom property value
16723 Treat the value of the property PROPERTY as a whitespace-separated list of
16724 values and make sure that VALUE is in this list.
16725 @end defun
16727 @defun org-entry-remove-from-multivalued-property pom property value
16728 Treat the value of the property PROPERTY as a whitespace-separated list of
16729 values and make sure that VALUE is @emph{not} in this list.
16730 @end defun
16732 @defun org-entry-member-in-multivalued-property pom property value
16733 Treat the value of the property PROPERTY as a whitespace-separated list of
16734 values and check if VALUE is in this list.
16735 @end defun
16737 @defopt org-property-allowed-value-functions
16738 Hook for functions supplying allowed values for a specific property.
16739 The functions must take a single argument, the name of the property, and
16740 return a flat list of allowed values.  If @samp{:ETC} is one of
16741 the values, use the values as completion help, but allow also other values
16742 to be entered.  The functions must return @code{nil} if they are not
16743 responsible for this property.
16744 @end defopt
16746 @node Using the mapping API,  , Using the property API, Hacking
16747 @section Using the mapping API
16748 @cindex API, for mapping
16749 @cindex mapping entries, API
16751 Org has sophisticated mapping capabilities to find all entries satisfying
16752 certain criteria.  Internally, this functionality is used to produce agenda
16753 views, but there is also an API that can be used to execute arbitrary
16754 functions for each or selected entries.  The main entry point for this API
16757 @defun org-map-entries func &optional match scope &rest skip
16758 Call FUNC at each headline selected by MATCH in SCOPE.
16760 FUNC is a function or a Lisp form.  The function will be called without
16761 arguments, with the cursor positioned at the beginning of the headline.
16762 The return values of all calls to the function will be collected and
16763 returned as a list.
16765 The call to FUNC will be wrapped into a save-excursion form, so FUNC
16766 does not need to preserve point.  After evaluation, the cursor will be
16767 moved to the end of the line (presumably of the headline of the
16768 processed entry) and search continues from there.  Under some
16769 circumstances, this may not produce the wanted results.  For example,
16770 if you have removed (e.g., archived) the current (sub)tree it could
16771 mean that the next entry will be skipped entirely.  In such cases, you
16772 can specify the position from where search should continue by making
16773 FUNC set the variable `org-map-continue-from' to the desired buffer
16774 position.
16776 MATCH is a tags/property/todo match as it is used in the agenda match view.
16777 Only headlines that are matched by this query will be considered during
16778 the iteration.  When MATCH is nil or t, all headlines will be
16779 visited by the iteration.
16781 SCOPE determines the scope of this command.  It can be any of:
16783 @example
16784 nil     @r{the current buffer, respecting the restriction if any}
16785 tree    @r{the subtree started with the entry at point}
16786 region  @r{The entries within the active region, if any}
16787 file    @r{the current buffer, without restriction}
16788 file-with-archives
16789         @r{the current buffer, and any archives associated with it}
16790 agenda  @r{all agenda files}
16791 agenda-with-archives
16792         @r{all agenda files with any archive files associated with them}
16793 (file1 file2 ...)
16794         @r{if this is a list, all files in the list will be scanned}
16795 @end example
16796 @noindent
16797 The remaining args are treated as settings for the skipping facilities of
16798 the scanner.  The following items can be given here:
16800 @vindex org-agenda-skip-function
16801 @example
16802 archive   @r{skip trees with the archive tag}
16803 comment   @r{skip trees with the COMMENT keyword}
16804 function or Lisp form
16805           @r{will be used as value for @code{org-agenda-skip-function},}
16806           @r{so whenever the function returns t, FUNC}
16807           @r{will not be called for that entry and search will}
16808           @r{continue from the point where the function leaves it}
16809 @end example
16810 @end defun
16812 The function given to that mapping routine can really do anything you like.
16813 It can use the property API (@pxref{Using the property API}) to gather more
16814 information about the entry, or in order to change metadata in the entry.
16815 Here are a couple of functions that might be handy:
16817 @defun org-todo &optional arg
16818 Change the TODO state of the entry.  See the docstring of the functions for
16819 the many possible values for the argument ARG.
16820 @end defun
16822 @defun org-priority &optional action
16823 Change the priority of the entry.  See the docstring of this function for the
16824 possible values for ACTION.
16825 @end defun
16827 @defun org-toggle-tag tag &optional onoff
16828 Toggle the tag TAG in the current entry.  Setting ONOFF to either @code{on}
16829 or @code{off} will not toggle tag, but ensure that it is either on or off.
16830 @end defun
16832 @defun org-promote
16833 Promote the current entry.
16834 @end defun
16836 @defun org-demote
16837 Demote the current entry.
16838 @end defun
16840 Here is a simple example that will turn all entries in the current file with
16841 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
16842 Entries in comment trees and in archive trees will be ignored.
16844 @lisp
16845 (org-map-entries
16846  '(org-todo "UPCOMING")
16847  "+TOMORROW" 'file 'archive 'comment)
16848 @end lisp
16850 The following example counts the number of entries with TODO keyword
16851 @code{WAITING}, in all agenda files.
16853 @lisp
16854 (length (org-map-entries t "/+WAITING" 'agenda))
16855 @end lisp
16857 @node MobileOrg, History and Acknowledgments, Hacking, Top
16858 @appendix MobileOrg
16859 @cindex iPhone
16860 @cindex MobileOrg
16862 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
16863 available for iOS and for Android.  @i{MobileOrg} offers offline viewing and
16864 capture support for an Org mode system rooted on a ``real'' computer.  It
16865 does also allow you to record changes to existing entries.
16866 The @uref{http://mobileorg.ncogni.to/, iOS implementation} for the
16867 @i{iPhone/iPod Touch/iPad} series of devices, was developed by Richard
16868 Moreland.  Android users should check out
16869 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
16870 by Matt Jones.  The two implementations are not identical but offer similar
16871 features.
16873 This appendix describes the support Org has for creating agenda views in a
16874 format that can be displayed by @i{MobileOrg}, and for integrating notes
16875 captured and changes made by @i{MobileOrg} into the main system.
16877 For changing tags and TODO states in MobileOrg, you should have set up the
16878 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
16879 cover all important tags and TODO keywords, even if individual files use only
16880 part of these.  MobileOrg will also offer you states and tags set up with
16881 in-buffer settings, but it will understand the logistics of TODO state
16882 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
16883 (@pxref{Setting tags}) only for those set in these variables.
16885 @menu
16886 * Setting up the staging area::  Where to interact with the mobile device
16887 * Pushing to MobileOrg::        Uploading Org files and agendas
16888 * Pulling from MobileOrg::      Integrating captured and flagged items
16889 @end menu
16891 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
16892 @section Setting up the staging area
16894 MobileOrg needs to interact with Emacs through a directory on a server.  If you
16895 are using a public server, you should consider to encrypt the files that are
16896 uploaded to the server.  This can be done with Org mode 7.02 and with
16897 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
16898 installation on your system.  To turn on encryption, set a password in
16899 @i{MobileOrg} and, on the Emacs side, configure the variable
16900 @code{org-mobile-use-encryption}@footnote{If you can safely store the
16901 password in your Emacs setup, you might also want to configure
16902 @code{org-mobile-encryption-password}.  Please read the docstring of that
16903 variable.  Note that encryption will apply only to the contents of the
16904 @file{.org} files.  The file names themselves will remain visible.}.
16906 The easiest way to create that directory is to use a free
16907 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
16908 Dropbox, or if your version of MobileOrg does not support it, you can use a
16909 webdav server.  For more information, check out the documentation of MobileOrg and also this
16910 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
16911 When MobileOrg first connects to your Dropbox, it will create a directory
16912 @i{MobileOrg} inside the Dropbox.  After the directory has been created, tell
16913 Emacs about it:
16915 @lisp
16916 (setq org-mobile-directory "~/Dropbox/MobileOrg")
16917 @end lisp
16919 Org mode has commands to put files for @i{MobileOrg} into that directory,
16920 and to read captured notes from there.
16922 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
16923 @section Pushing to MobileOrg
16925 This operation copies all files currently listed in @code{org-mobile-files}
16926 to the directory @code{org-mobile-directory}.  By default this list contains
16927 all agenda files (as listed in @code{org-agenda-files}), but additional files
16928 can be included by customizing @code{org-mobile-files}.  File names will be
16929 staged with paths relative to @code{org-directory}, so all files should be
16930 inside this directory@footnote{Symbolic links in @code{org-directory} need to
16931 have the same name than their targets.}.
16933 The push operation also creates a special Org file @file{agendas.org} with
16934 all custom agenda view defined by the user@footnote{While creating the
16935 agendas, Org mode will force ID properties on all referenced entries, so that
16936 these entries can be uniquely identified if @i{MobileOrg} flags them for
16937 further action.  If you do not want to get these properties in so many
16938 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
16939 to @code{nil}.  Org mode will then rely on outline paths, in the hope that
16940 these will be unique enough.}.
16942 Finally, Org writes the file @file{index.org}, containing links to all other
16943 files.  @i{MobileOrg} first reads this file from the server, and then
16944 downloads all agendas and Org files listed in it.  To speed up the download,
16945 MobileOrg will only read files whose checksums@footnote{Checksums are stored
16946 automatically in the file @file{checksums.dat}} have changed.
16948 @node Pulling from MobileOrg,  , Pushing to MobileOrg, MobileOrg
16949 @section Pulling from MobileOrg
16951 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
16952 files for viewing.  It also appends captured entries and pointers to flagged
16953 and changed entries to the file @file{mobileorg.org} on the server.  Org has
16954 a @emph{pull} operation that integrates this information into an inbox file
16955 and operates on the pointers to flagged entries.  Here is how it works:
16957 @enumerate
16958 @item
16959 Org moves all entries found in
16960 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
16961 operation.} and appends them to the file pointed to by the variable
16962 @code{org-mobile-inbox-for-pull}.  Each captured entry and each editing event
16963 will be a top-level entry in the inbox file.
16964 @item
16965 After moving the entries, Org will attempt to implement the changes made in
16966 @i{MobileOrg}.  Some changes are applied directly and without user
16967 interaction.  Examples are all changes to tags, TODO state, headline and body
16968 text that can be cleanly applied.  Entries that have been flagged for further
16969 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
16970 again.  When there is a problem finding an entry or applying the change, the
16971 pointer entry will remain in the inbox and will be marked with an error
16972 message.  You need to later resolve these issues by hand.
16973 @item
16974 Org will then generate an agenda view with all flagged entries.  The user
16975 should then go through these entries and do whatever actions are necessary.
16976 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
16977 will be displayed in the echo area when the cursor is on the corresponding
16978 agenda line.
16980 @table @kbd
16981 @kindex ?
16982 @item ?
16983 Pressing @kbd{?} in that special agenda will display the full flagging note in
16984 another window and also push it onto the kill ring.  So you could use @kbd{?
16985 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
16986 Pressing @kbd{?} twice in succession will offer to remove the
16987 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
16988 in a property).  In this way you indicate that the intended processing for
16989 this flagged entry is finished.
16990 @end table
16991 @end enumerate
16993 @kindex C-c a ?
16994 If you are not able to process all flagged entries directly, you can always
16995 return to this agenda view@footnote{Note, however, that there is a subtle
16996 difference.  The view created automatically by @kbd{M-x org-mobile-pull
16997 @key{RET}} is guaranteed to search all files that have been addressed by the
16998 last pull.  This might include a file that is not currently in your list of
16999 agenda files.  If you later use @kbd{C-c a ?} to regenerate the view, only
17000 the current agenda files will be searched.} using @kbd{C-c a ?}.
17002 @node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top
17003 @appendix History and acknowledgments
17004 @cindex acknowledgments
17005 @cindex history
17006 @cindex thanks
17008 @section From Carsten
17010 Org was born in 2003, out of frustration over the user interface of the Emacs
17011 Outline mode.  I was trying to organize my notes and projects, and using
17012 Emacs seemed to be the natural way to go.  However, having to remember eleven
17013 different commands with two or three keys per command, only to hide and show
17014 parts of the outline tree, that seemed entirely unacceptable to me.  Also,
17015 when using outlines to take notes, I constantly wanted to restructure the
17016 tree, organizing it parallel to my thoughts and plans.  @emph{Visibility
17017 cycling} and @emph{structure editing} were originally implemented in the
17018 package @file{outline-magic.el}, but quickly moved to the more general
17019 @file{org.el}.  As this environment became comfortable for project planning,
17020 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
17021 @emph{table support}.  These areas highlighted the two main goals that Org
17022 still has today: to be a new, outline-based, plain text mode with innovative
17023 and intuitive editing features, and to incorporate project planning
17024 functionality directly into a notes file.
17026 Since the first release, literally thousands of emails to me or to
17027 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
17028 reports, feedback, new ideas, and sometimes patches and add-on code.
17029 Many thanks to everyone who has helped to improve this package.  I am
17030 trying to keep here a list of the people who had significant influence
17031 in shaping one or more aspects of Org.  The list may not be
17032 complete, if I have forgotten someone, please accept my apologies and
17033 let me know.
17035 Before I get to this list, a few special mentions are in order:
17037 @table @i
17038 @item Bastien Guerry
17039 Bastien has written a large number of extensions to Org (most of them
17040 integrated into the core by now), including the @LaTeX{} exporter and the plain
17041 list parser.  His support during the early days, when he basically acted as
17042 co-maintainer, was central to the success of this project.  Bastien also
17043 invented Worg, helped establishing the Web presence of Org, and sponsored
17044 hosting costs for the orgmode.org website.
17045 @item Eric Schulte and Dan Davison
17046 Eric and Dan are jointly responsible for the Org-babel system, which turns
17047 Org into a multi-language environment for evaluating code and doing literate
17048 programming and reproducible research.
17049 @item John Wiegley
17050 John has contributed a number of great ideas and patches directly to Org,
17051 including the attachment system (@file{org-attach.el}), integration with
17052 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
17053 items, habit tracking (@file{org-habits.el}), and encryption
17054 (@file{org-crypt.el}).  Also, the capture system is really an extended copy
17055 of his great @file{remember.el}.
17056 @item Sebastian Rose
17057 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
17058 of an ignorant amateur.  Sebastian has pushed this part of Org onto a much
17059 higher level.  He also wrote @file{org-info.js}, a Java script for displaying
17060 web pages derived from Org using an Info-like or a folding interface with
17061 single-key navigation.
17062 @end table
17064 @noindent See below for the full list of contributions!  Again, please
17065 let me know what I am missing here!
17067 @section From Bastien
17069 I (Bastien) have been maintaining Org since January 2011.  This appendix
17070 would not be complete without adding a few more acknowledgements and thanks
17071 to Carsten's ones above.
17073 I am first grateful to Carsten for his trust while handing me over the
17074 maintainership of Org.  His support as been great since day one of this new
17075 adventure, and it helped a lot.
17077 When I took over maintainership, I knew I would have to make Org more
17078 collaborative than ever, as I would have to rely on people that are more
17079 knowledgeable than I am on many parts of the code.  Here is a list of the
17080 persons I could rely on, they should really be considered co-maintainers,
17081 either of the code or the community:
17083 @table @i
17084 @item Eric Schulte
17085 Eric is maintaining the Babel parts of Org.  His reactivity here kept me away
17086 from worrying about possible bugs here and let me focus on other parts.
17088 @item Nicolas Goaziou
17089 Nicolas is maintaining the consistency of the deepest parts of Org.  His
17090 work on @file{org-element.el} and @file{ox.el} has been outstanding, and
17091 opened the doors for many new ideas and features.  He rewrote many of the
17092 old exporters to use the new export engine, and helped with documenting
17093 this major change.  More importantly (if that's possible), he has been more
17094 than reliable during all the work done for Org 8.0, and always very
17095 reactive on the mailing list.
17097 @item Achim Gratz
17098 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
17099 into a flexible and conceptually clean process.  He patiently coped with the
17100 many hiccups that such a change can create for users.
17102 @item Nick Dokos
17103 The Org mode mailing list would not be such a nice place without Nick, who
17104 patiently helped users so many times.  It is impossible to overestimate such
17105 a great help, and the list would not be so active without him.
17106 @end table
17108 I received support from so many users that it is clearly impossible to be
17109 fair when shortlisting a few of them, but Org's history would not be
17110 complete if the ones above were not mentioned in this manual.
17112 @section List of contributions
17114 @itemize @bullet
17116 @item
17117 @i{Russel Adams} came up with the idea for drawers.
17118 @item
17119 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
17120 feedback on many features and several patches.
17121 @item
17122 @i{Luis Anaya} wrote @file{ox-man.el}.
17123 @item
17124 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
17125 @item
17126 @i{Michael Brand} helped by reporting many bugs and testing many features.
17127 He also implemented the distinction between empty fields and 0-value fields
17128 in Org's spreadsheets.
17129 @item
17130 @i{Christophe Bataillon} created the great unicorn logo that we use on the
17131 Org mode website.
17132 @item
17133 @i{Alex Bochannek} provided a patch for rounding timestamps.
17134 @item
17135 @i{Jan Böcker} wrote @file{org-docview.el}.
17136 @item
17137 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
17138 @item
17139 @i{Tom Breton} wrote @file{org-choose.el}.
17140 @item
17141 @i{Charles Cave}'s suggestion sparked the implementation of templates
17142 for Remember, which are now templates for capture.
17143 @item
17144 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
17145 specified time.
17146 @item
17147 @i{Gregory Chernov} patched support for Lisp forms into table
17148 calculations and improved XEmacs compatibility, in particular by porting
17149 @file{nouline.el} to XEmacs.
17150 @item
17151 @i{Sacha Chua} suggested copying some linking code from Planner.
17152 @item
17153 @i{Toby S. Cubitt} contributed to the code for clock formats.
17154 @item
17155 @i{Baoqiu Cui} contributed the DocBook exporter.  It has been deleted from
17156 Org 8.0: you can now export to Texinfo and export the @code{.texi} file to
17157 DocBook using @code{makeinfo}.
17158 @item
17159 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
17160 came up with the idea of properties, and that there should be an API for
17161 them.
17162 @item
17163 @i{Nick Dokos} tracked down several nasty bugs.
17164 @item
17165 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
17166 inspired some of the early development, including HTML export.  He also
17167 asked for a way to narrow wide table columns.
17168 @item
17169 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
17170 the Org-Babel documentation into the manual.
17171 @item
17172 @i{Christian Egli} converted the documentation into Texinfo format, inspired
17173 the agenda, patched CSS formatting into the HTML exporter, and wrote
17174 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
17175 @file{ox-taskjuggler.el} for Org 8.0.
17176 @item
17177 @i{David Emery} provided a patch for custom CSS support in exported
17178 HTML agendas.
17179 @item
17180 @i{Nic Ferrier} contributed mailcap and XOXO support.
17181 @item
17182 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
17183 @item
17184 @i{John Foerch} figured out how to make incremental search show context
17185 around a match in a hidden outline tree.
17186 @item
17187 @i{Raimar Finken} wrote @file{org-git-line.el}.
17188 @item
17189 @i{Mikael Fornius} works as a mailing list moderator.
17190 @item
17191 @i{Austin Frank} works as a mailing list moderator.
17192 @item
17193 @i{Eric Fraga} drove the development of BEAMER export with ideas and
17194 testing.
17195 @item
17196 @i{Barry Gidden} did proofreading the manual in preparation for the book
17197 publication through Network Theory Ltd.
17198 @item
17199 @i{Niels Giesen} had the idea to automatically archive DONE trees.
17200 @item
17201 @i{Nicolas Goaziou} rewrote much of the plain list code.  He also wrote
17202 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
17203 in implementing a clean framework for Org exporters.
17204 @item
17205 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
17206 @item
17207 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
17208 book.
17209 @item
17210 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
17211 task state change logging, and the clocktable.  His clear explanations have
17212 been critical when we started to adopt the Git version control system.
17213 @item
17214 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
17215 patches.
17216 @item
17217 @i{Phil Jackson} wrote @file{org-irc.el}.
17218 @item
17219 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
17220 folded entries, and column view for properties.
17221 @item
17222 @i{Matt Jones} wrote @i{MobileOrg Android}.
17223 @item
17224 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
17225 @item
17226 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
17227 @item
17228 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it.  He also
17229 provided frequent feedback and some patches.
17230 @item
17231 @i{Matt Lundin} has proposed last-row references for table formulas and named
17232 invisible anchors.  He has also worked a lot on the FAQ.
17233 @item
17234 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
17235 and is a prolific contributor on the mailing list with competent replies,
17236 small fixes and patches.
17237 @item
17238 @i{Jason F. McBrayer} suggested agenda export to CSV format.
17239 @item
17240 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
17241 @item
17242 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
17243 basis.
17244 @item
17245 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
17246 happy.
17247 @item
17248 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
17249 @item
17250 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
17251 and being able to quickly restrict the agenda to a subtree.
17252 @item
17253 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
17254 @item
17255 @i{Greg Newman} refreshed the unicorn logo into its current form.
17256 @item
17257 @i{Tim O'Callaghan} suggested in-file links, search options for general
17258 file links, and TAGS.
17259 @item
17260 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
17261 version of the reference card.
17262 @item
17263 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
17264 into Japanese.
17265 @item
17266 @i{Oliver Oppitz} suggested multi-state TODO items.
17267 @item
17268 @i{Scott Otterson} sparked the introduction of descriptive text for
17269 links, among other things.
17270 @item
17271 @i{Pete Phillips} helped during the development of the TAGS feature, and
17272 provided frequent feedback.
17273 @item
17274 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
17275 generation.
17276 @item
17277 @i{Martin Pohlack} provided the code snippet to bundle character insertion
17278 into bundles of 20 for undo.
17279 @item
17280 @i{T.V. Raman} reported bugs and suggested improvements.
17281 @item
17282 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
17283 control.
17284 @item
17285 @i{Paul Rivier} provided the basic implementation of named footnotes.  He
17286 also acted as mailing list moderator for some time.
17287 @item
17288 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
17289 @item
17290 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
17291 conflict with @file{allout.el}.
17292 @item
17293 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
17294 extensive patches.
17295 @item
17296 @i{Philip Rooke} created the Org reference card, provided lots
17297 of feedback, developed and applied standards to the Org documentation.
17298 @item
17299 @i{Christian Schlauer} proposed angular brackets around links, among
17300 other things.
17301 @item
17302 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
17303 enjoy folding in non-org buffers by using Org headlines in comments.
17304 @item
17305 @i{Paul Sexton} wrote @file{org-ctags.el}.
17306 @item
17307 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
17308 @file{organizer-mode.el}.
17309 @item
17310 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
17311 examples, and remote highlighting for referenced code lines.
17312 @item
17313 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
17314 now packaged into Org's @file{contrib} directory.
17315 @item
17316 @i{Daniel Sinder} came up with the idea of internal archiving by locking
17317 subtrees.
17318 @item
17319 @i{Dale Smith} proposed link abbreviations.
17320 @item
17321 @i{James TD Smith} has contributed a large number of patches for useful
17322 tweaks and features.
17323 @item
17324 @i{Adam Spiers} asked for global linking commands, inspired the link
17325 extension system, added support for mairix, and proposed the mapping API.
17326 @item
17327 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
17328 @LaTeX{}, UTF-8, Latin-1 and ASCII.
17329 @item
17330 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
17331 with links transformation to Org syntax.
17332 @item
17333 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
17334 chapter about publishing.
17335 @item
17336 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
17337 @item
17338 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
17339 enabled source code highlighting in Gnus.
17340 @item
17341 @i{Stefan Vollmar} organized a video-recorded talk at the
17342 Max-Planck-Institute for Neurology.  He also inspired the creation of a
17343 concept index for HTML export.
17344 @item
17345 @i{J@"urgen Vollmer} contributed code generating the table of contents
17346 in HTML output.
17347 @item
17348 @i{Samuel Wales} has provided important feedback and bug reports.
17349 @item
17350 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
17351 keyword.
17352 @item
17353 @i{David Wainberg} suggested archiving, and improvements to the linking
17354 system.
17355 @item
17356 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
17357 linking to Gnus.
17358 @item
17359 @i{Roland Winkler} requested additional key bindings to make Org
17360 work on a tty.
17361 @item
17362 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
17363 and contributed various ideas and code snippets.
17364 @end itemize
17367 @node GNU Free Documentation License, Main Index, History and Acknowledgments, Top
17368 @appendix GNU Free Documentation License
17369 @include doclicense.texi
17372 @node Main Index, Key Index, GNU Free Documentation License, Top
17373 @unnumbered Concept index
17375 @printindex cp
17377 @node Key Index, Command and Function Index, Main Index, Top
17378 @unnumbered Key index
17380 @printindex ky
17382 @node Command and Function Index, Variable Index, Key Index, Top
17383 @unnumbered Command and function index
17385 @printindex fn
17387 @node Variable Index,  , Command and Function Index, Top
17388 @unnumbered Variable index
17390 This is not a complete index of variables and faces, only the ones that are
17391 mentioned in the manual.  For a more complete list, use @kbd{M-x
17392 org-customize @key{RET}} and then click yourself through the tree.
17394 @printindex vr
17396 @bye
17398 @c Local variables:
17399 @c fill-column: 77
17400 @c indent-tabs-mode: nil
17401 @c paragraph-start:    "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[  ]*$"
17402 @c paragraph-separate: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[       \f]*$"
17403 @c End:
17406 @c  LocalWords:  webdavhost pre