Allow time stampes without day name
[org-mode.git] / doc / org.texi
1
2 \input texinfo
3 @c %**start of header
4 @setfilename ../../info/org
5 @settitle The Org Manual
6
7 @set VERSION 7.7
8 @set DATE July 2011
9
10 @c Use proper quote and backtick for code sections in PDF output
11 @c Cf. Texinfo manual 14.2
12 @set txicodequoteundirected
13 @set txicodequotebacktick
14
15 @c Version and Contact Info
16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
17 @set AUTHOR Carsten Dominik
18 @set MAINTAINER Carsten Dominik
19 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
21 @c %**end of header
22 @finalout
23
24
25 @c -----------------------------------------------------------------------------
26
27 @c Macro definitions for commands and keys
28 @c =======================================
29
30 @c The behavior of the key/command macros will depend on the flag cmdnames
31 @c When set, commands names are shown.  When clear, they are not shown.
32
33 @set cmdnames
34
35 @c Below we define the following macros for Org key tables:
36
37 @c orgkey{key}                        A key item
38 @c orgcmd{key,cmd}                    Key with command name
39 @c xorgcmd{key,cmmand}                Key with command name as @itemx
40 @c orgcmdnki{key,cmd}                 Like orgcmd, but do not index the key
41 @c orgcmdtkc{text,key,cmd}            Like orgcmd,special text instead of key
42 @c orgcmdkkc{key1,key2,cmd}           Two keys with one command name, use "or"
43 @c orgcmdkxkc{key1,key2,cmd}          Two keys with one command name, but
44 @c                                    different functions, so format as @itemx
45 @c orgcmdkskc{key1,key2,cmd}          Same as orgcmdkkc, but use "or short"
46 @c xorgcmdkskc{key1,key2,cmd}         Same as previous, but use @itemx
47 @c orgcmdkkcc{key1,key2,cmd1,cmd2}    Two keys and two commands
48
49 @c a key but no command
50 @c    Inserts:    @item key
51 @macro orgkey{key}
52 @kindex \key\
53 @item @kbd{\key\}
54 @end macro
55
56 @macro xorgkey{key}
57 @kindex \key\
58 @itemx @kbd{\key\}
59 @end macro
60
61 @c one key with a command
62 @c   Inserts:    @item KEY               COMMAND
63 @macro orgcmd{key,command}
64 @ifset cmdnames
65 @kindex \key\
66 @findex \command\
67 @iftex
68 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
69 @end iftex
70 @ifnottex
71 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
72 @end ifnottex
73 @end ifset
74 @ifclear cmdnames
75 @kindex \key\
76 @item @kbd{\key\}
77 @end ifclear
78 @end macro
79
80 @c One key with one command, formatted using @itemx
81 @c   Inserts:    @itemx KEY               COMMAND
82 @macro xorgcmd{key,command}
83 @ifset cmdnames
84 @kindex \key\
85 @findex \command\
86 @iftex
87 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
88 @end iftex
89 @ifnottex
90 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
91 @end ifnottex
92 @end ifset
93 @ifclear cmdnames
94 @kindex \key\
95 @itemx @kbd{\key\}
96 @end ifclear
97 @end macro
98
99 @c one key with a command, bit do not index the key
100 @c   Inserts:    @item KEY               COMMAND
101 @macro orgcmdnki{key,command}
102 @ifset cmdnames
103 @findex \command\
104 @iftex
105 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
106 @end iftex
107 @ifnottex
108 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
109 @end ifnottex
110 @end ifset
111 @ifclear cmdnames
112 @item @kbd{\key\}
113 @end ifclear
114 @end macro
115
116 @c one key with a command, and special text to replace key in item
117 @c   Inserts:    @item TEXT                    COMMAND
118 @macro orgcmdtkc{text,key,command}
119 @ifset cmdnames
120 @kindex \key\
121 @findex \command\
122 @iftex
123 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
124 @end iftex
125 @ifnottex
126 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
127 @end ifnottex
128 @end ifset
129 @ifclear cmdnames
130 @kindex \key\
131 @item @kbd{\text\}
132 @end ifclear
133 @end macro
134
135 @c two keys with one command
136 @c   Inserts:    @item KEY1 or KEY2            COMMAND
137 @macro orgcmdkkc{key1,key2,command}
138 @ifset cmdnames
139 @kindex \key1\
140 @kindex \key2\
141 @findex \command\
142 @iftex
143 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
144 @end iftex
145 @ifnottex
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
147 @end ifnottex
148 @end ifset
149 @ifclear cmdnames
150 @kindex \key1\
151 @kindex \key2\
152 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
153 @end ifclear
154 @end macro
155
156 @c Two keys with one command name, but different functions, so format as
157 @c @itemx
158 @c   Inserts:    @item KEY1
159 @c               @itemx KEY2                COMMAND
160 @macro orgcmdkxkc{key1,key2,command}
161 @ifset cmdnames
162 @kindex \key1\
163 @kindex \key2\
164 @findex \command\
165 @iftex
166 @item @kbd{\key1\}
167 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
168 @end iftex
169 @ifnottex
170 @item @kbd{\key1\}
171 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
172 @end ifnottex
173 @end ifset
174 @ifclear cmdnames
175 @kindex \key1\
176 @kindex \key2\
177 @item @kbd{\key1\}
178 @itemx @kbd{\key2\}
179 @end ifclear
180 @end macro
181
182 @c Same as previous, but use "or short"
183 @c   Inserts:    @item KEY1 or short KEY2            COMMAND
184 @macro orgcmdkskc{key1,key2,command}
185 @ifset cmdnames
186 @kindex \key1\
187 @kindex \key2\
188 @findex \command\
189 @iftex
190 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
191 @end iftex
192 @ifnottex
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
194 @end ifnottex
195 @end ifset
196 @ifclear cmdnames
197 @kindex \key1\
198 @kindex \key2\
199 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
200 @end ifclear
201 @end macro
202
203 @c Same as previous, but use @itemx
204 @c   Inserts:    @itemx KEY1 or short KEY2            COMMAND
205 @macro xorgcmdkskc{key1,key2,command}
206 @ifset cmdnames
207 @kindex \key1\
208 @kindex \key2\
209 @findex \command\
210 @iftex
211 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
212 @end iftex
213 @ifnottex
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
215 @end ifnottex
216 @end ifset
217 @ifclear cmdnames
218 @kindex \key1\
219 @kindex \key2\
220 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
221 @end ifclear
222 @end macro
223
224 @c two keys with two commands
225 @c   Inserts:    @item KEY1                        COMMAND1
226 @c               @itemx KEY2                       COMMAND2
227 @macro orgcmdkkcc{key1,key2,command1,command2}
228 @ifset cmdnames
229 @kindex \key1\
230 @kindex \key2\
231 @findex \command1\
232 @findex \command2\
233 @iftex
234 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
235 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
236 @end iftex
237 @ifnottex
238 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
239 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
240 @end ifnottex
241 @end ifset
242 @ifclear cmdnames
243 @kindex \key1\
244 @kindex \key2\
245 @item @kbd{\key1\}
246 @itemx @kbd{\key2\}
247 @end ifclear
248 @end macro
249 @c -----------------------------------------------------------------------------
250
251 @iftex
252 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
253 @end iftex
254
255 @c Subheadings inside a table.
256 @macro tsubheading{text}
257 @ifinfo
258 @subsubheading \text\
259 @end ifinfo
260 @ifnotinfo
261 @item @b{\text\}
262 @end ifnotinfo
263 @end macro
264
265 @copying
266 This manual is for Org version @value{VERSION}.
267
268 Copyright @copyright{} 2004-2011  Free Software Foundation, Inc.
269
270 @quotation
271 Permission is granted to copy, distribute and/or modify this document
272 under the terms of the GNU Free Documentation License, Version 1.3 or
273 any later version published by the Free Software Foundation; with no
274 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
275 and with the Back-Cover Texts as in (a) below.  A copy of the license
276 is included in the section entitled ``GNU Free Documentation License.''
277
278 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
279 modify this GNU manual.  Buying copies from the FSF supports it in
280 developing GNU and promoting software freedom.''
281
282 This document is part of a collection distributed under the GNU Free
283 Documentation License.  If you want to distribute this document
284 separately from the collection, you can do so by adding a copy of the
285 license to the document, as described in section 6 of the license.
286 @end quotation
287 @end copying
288
289 @dircategory Emacs
290 @direntry
291 * Org Mode: (org).      Outline-based notes management and organizer
292 @end direntry
293
294 @titlepage
295 @title The Org Manual
296
297 @subtitle Release @value{VERSION}
298 @author by Carsten Dominik
299 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, and Thomas Dye
300
301 @c The following two commands start the copyright page.
302 @page
303 @vskip 0pt plus 1filll
304 @insertcopying
305 @end titlepage
306
307 @c Output the table of contents at the beginning.
308 @contents
309
310 @ifnottex
311 @node Top, Introduction, (dir), (dir)
312 @top Org Mode Manual
313
314 @insertcopying
315 @end ifnottex
316
317 @menu
318 * Introduction::                Getting started
319 * Document Structure::          A tree works like your brain
320 * Tables::                      Pure magic for quick formatting
321 * Hyperlinks::                  Notes in context
322 * TODO Items::                  Every tree branch can be a TODO item
323 * Tags::                        Tagging headlines and matching sets of tags
324 * Properties and Columns::      Storing information about an entry
325 * Dates and Times::             Making items useful for planning
326 * Capture - Refile - Archive::  The ins and outs for projects
327 * Agenda Views::                Collecting information into views
328 * Markup::                      Prepare text for rich export
329 * Exporting::                   Sharing and publishing of notes
330 * Publishing::                  Create a web site of linked Org files
331 * Working With Source Code::    Export, evaluate, and tangle code blocks
332 * Miscellaneous::               All the rest which did not fit elsewhere
333 * Hacking::                     How to hack your way around
334 * MobileOrg::                   Viewing and capture on a mobile device
335 * History and Acknowledgments::  How Org came into being
336 * Main Index::                  An index of Org's concepts and features
337 * Key Index::                   Key bindings and where they are described
338 * Command and Function Index::  Command names and some internal functions
339 * Variable Index::              Variables mentioned in the manual
340
341 @detailmenu
342  --- The Detailed Node Listing ---
343
344 Introduction
345
346 * Summary::                     Brief summary of what Org does
347 * Installation::                How to install a downloaded version of Org
348 * Activation::                  How to activate Org for certain buffers
349 * Feedback::                    Bug reports, ideas, patches etc.
350 * Conventions::                 Type-setting conventions in the manual
351
352 Document structure
353
354 * Outlines::                    Org is based on Outline mode
355 * Headlines::                   How to typeset Org tree headlines
356 * Visibility cycling::          Show and hide, much simplified
357 * Motion::                      Jumping to other headlines
358 * Structure editing::           Changing sequence and level of headlines
359 * Sparse trees::                Matches embedded in context
360 * Plain lists::                 Additional structure within an entry
361 * Drawers::                     Tucking stuff away
362 * Blocks::                      Folding blocks
363 * Footnotes::                   How footnotes are defined in Org's syntax
364 * Orgstruct mode::              Structure editing outside Org
365
366 Tables
367
368 * Built-in table editor::       Simple tables
369 * Column width and alignment::  Overrule the automatic settings
370 * Column groups::               Grouping to trigger vertical lines
371 * Orgtbl mode::                 The table editor as minor mode
372 * The spreadsheet::             The table editor has spreadsheet capabilities
373 * Org-Plot::                    Plotting from org tables
374
375 The spreadsheet
376
377 * References::                  How to refer to another field or range
378 * Formula syntax for Calc::     Using Calc to compute stuff
379 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
380 * Durations and time values::   How to compute durations and time values
381 * Field and range formulas::    Formula for specific (ranges of) fields
382 * Column formulas::             Formulas valid for an entire column
383 * Editing and debugging formulas::  Fixing formulas
384 * Updating the table::          Recomputing all dependent fields
385 * Advanced features::           Field and column names, parameters and automatic recalc
386
387 Hyperlinks
388
389 * Link format::                 How links in Org are formatted
390 * Internal links::              Links to other places in the current file
391 * External links::              URL-like links to the world
392 * Handling links::              Creating, inserting and following
393 * Using links outside Org::     Linking from my C source code?
394 * Link abbreviations::          Shortcuts for writing complex links
395 * Search options::              Linking to a specific location
396 * Custom searches::             When the default search is not enough
397
398 Internal links
399
400 * Radio targets::               Make targets trigger links in plain text
401
402 TODO items
403
404 * TODO basics::                 Marking and displaying TODO entries
405 * TODO extensions::             Workflow and assignments
406 * Progress logging::            Dates and notes for progress
407 * Priorities::                  Some things are more important than others
408 * Breaking down tasks::         Splitting a task into manageable pieces
409 * Checkboxes::                  Tick-off lists
410
411 Extended use of TODO keywords
412
413 * Workflow states::             From TODO to DONE in steps
414 * TODO types::                  I do this, Fred does the rest
415 * Multiple sets in one file::   Mixing it all, and still finding your way
416 * Fast access to TODO states::  Single letter selection of a state
417 * Per-file keywords::           Different files, different requirements
418 * Faces for TODO keywords::     Highlighting states
419 * TODO dependencies::           When one task needs to wait for others
420
421 Progress logging
422
423 * Closing items::               When was this entry marked DONE?
424 * Tracking TODO state changes::  When did the status change?
425 * Tracking your habits::        How consistent have you been?
426
427 Tags
428
429 * Tag inheritance::             Tags use the tree structure of the outline
430 * Setting tags::                How to assign tags to a headline
431 * Tag searches::                Searching for combinations of tags
432
433 Properties and columns
434
435 * Property syntax::             How properties are spelled out
436 * Special properties::          Access to other Org-mode features
437 * Property searches::           Matching property values
438 * Property inheritance::        Passing values down the tree
439 * Column view::                 Tabular viewing and editing
440 * Property API::                Properties for Lisp programmers
441
442 Column view
443
444 * Defining columns::            The COLUMNS format property
445 * Using column view::           How to create and use column view
446 * Capturing column view::       A dynamic block for column view
447
448 Defining columns
449
450 * Scope of column definitions::  Where defined, where valid?
451 * Column attributes::           Appearance and content of a column
452
453 Dates and times
454
455 * Timestamps::                  Assigning a time to a tree entry
456 * Creating timestamps::         Commands which insert timestamps
457 * Deadlines and scheduling::    Planning your work
458 * Clocking work time::          Tracking how long you spend on a task
459 * Effort estimates::            Planning work effort in advance
460 * Relative timer::              Notes with a running timer
461 * Countdown timer::             Starting a countdown timer for a task
462
463 Creating timestamps
464
465 * The date/time prompt::        How Org-mode helps you entering date and time
466 * Custom time format::          Making dates look different
467
468 Deadlines and scheduling
469
470 * Inserting deadline/schedule::  Planning items
471 * Repeated tasks::              Items that show up again and again
472
473 Clocking work time
474
475 * Clocking commands::           Starting and stopping a clock
476 * The clock table::             Detailed reports
477 * Resolving idle time::         Resolving time when you've been idle
478
479 Capture - Refile - Archive
480
481 * Capture::                     Capturing new stuff
482 * Attachments::                 Add files to tasks
483 * RSS Feeds::                   Getting input from RSS feeds
484 * Protocols::                   External (e.g.@: Browser) access to Emacs and Org
485 * Refiling notes::              Moving a tree from one place to another
486 * Archiving::                   What to do with finished projects
487
488 Capture
489
490 * Setting up capture::          Where notes will be stored
491 * Using capture::               Commands to invoke and terminate capture
492 * Capture templates::           Define the outline of different note types
493
494 Capture templates
495
496 * Template elements::           What is needed for a complete template entry
497 * Template expansion::          Filling in information about time and context
498
499 Archiving
500
501 * Moving subtrees::             Moving a tree to an archive file
502 * Internal archiving::          Switch off a tree but keep it in the file
503
504 Agenda views
505
506 * Agenda files::                Files being searched for agenda information
507 * Agenda dispatcher::           Keyboard access to agenda views
508 * Built-in agenda views::       What is available out of the box?
509 * Presentation and sorting::    How agenda items are prepared for display
510 * Agenda commands::             Remote editing of Org trees
511 * Custom agenda views::         Defining special searches and views
512 * Exporting Agenda Views::      Writing a view to a file
513 * Agenda column view::          Using column view for collected entries
514
515 The built-in agenda views
516
517 * Weekly/daily agenda::         The calendar page with current tasks
518 * Global TODO list::            All unfinished action items
519 * Matching tags and properties::  Structured information with fine-tuned search
520 * Timeline::                    Time-sorted view for single file
521 * Search view::                 Find entries by searching for text
522 * Stuck projects::              Find projects you need to review
523
524 Presentation and sorting
525
526 * Categories::                  Not all tasks are equal
527 * Time-of-day specifications::  How the agenda knows the time
528 * Sorting of agenda items::     The order of things
529
530 Custom agenda views
531
532 * Storing searches::            Type once, use often
533 * Block agenda::                All the stuff you need in a single buffer
534 * Setting Options::             Changing the rules
535
536 Markup for rich export
537
538 * Structural markup elements::  The basic structure as seen by the exporter
539 * Images and tables::           Tables and Images will be included
540 * Literal examples::            Source code examples with special formatting
541 * Include files::               Include additional files into a document
542 * Index entries::               Making an index
543 * Macro replacement::           Use macros to create complex output
544 * Embedded LaTeX::              LaTeX can be freely used inside Org documents
545
546 Structural markup elements
547
548 * Document title::              Where the title is taken from
549 * Headings and sections::       The document structure as seen by the exporter
550 * Table of contents::           The if and where of the table of contents
551 * Initial text::                Text before the first heading?
552 * Lists::                       Lists
553 * Paragraphs::                  Paragraphs
554 * Footnote markup::             Footnotes
555 * Emphasis and monospace::      Bold, italic, etc.
556 * Horizontal rules::            Make a line
557 * Comment lines::               What will *not* be exported
558
559 Embedded @LaTeX{}
560
561 * Special symbols::             Greek letters and other symbols
562 * Subscripts and superscripts::  Simple syntax for raising/lowering text
563 * LaTeX fragments::             Complex formulas made easy
564 * Previewing LaTeX fragments::  What will this snippet look like?
565 * CDLaTeX mode::                Speed up entering of formulas
566
567 Exporting
568
569 * Selective export::            Using tags to select and exclude trees
570 * Export options::              Per-file export settings
571 * The export dispatcher::       How to access exporter commands
572 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
573 * HTML export::                 Exporting to HTML
574 * LaTeX and PDF export::        Exporting to @LaTeX{}, and processing to PDF
575 * DocBook export::              Exporting to DocBook
576 * OpenDocumentText export::     Exporting to OpenDocumentText
577 * TaskJuggler export::          Exporting to TaskJuggler
578 * Freemind export::             Exporting to Freemind mind maps
579 * XOXO export::                 Exporting to XOXO
580 * iCalendar export::            Exporting in iCalendar format
581
582 HTML export
583
584 * HTML Export commands::        How to invoke HTML export
585 * HTML preamble and postamble::  How to insert a preamble and a postamble
586 * Quoting HTML tags::           Using direct HTML in Org-mode
587 * Links in HTML export::        How links will be interpreted and formatted
588 * Tables in HTML export::       How to modify the formatting of tables
589 * Images in HTML export::       How to insert figures into HTML output
590 * Math formatting in HTML export::  Beautiful math also on the web
591 * Text areas in HTML export::   An alternative way to show an example
592 * CSS support::                 Changing the appearance of the output
593 * JavaScript support::          Info and Folding in a web browser
594
595 @LaTeX{} and PDF export
596
597 * LaTeX/PDF export commands::   Which key invokes which commands
598 * Header and sectioning::       Setting up the export file structure
599 * Quoting LaTeX code::          Incorporating literal @LaTeX{} code
600 * Tables in LaTeX export::      Options for exporting tables to @LaTeX{}
601 * Images in LaTeX export::      How to insert figures into @LaTeX{} output
602 * Beamer class export::         Turning the file into a presentation
603
604 DocBook export
605
606 * DocBook export commands::     How to invoke DocBook export
607 * Quoting DocBook code::        Incorporating DocBook code in Org files
608 * Recursive sections::          Recursive sections in DocBook
609 * Tables in DocBook export::    Tables are exported as HTML tables
610 * Images in DocBook export::    How to insert figures into DocBook output
611 * Special characters::          How to handle special characters
612
613 OpenDocument export
614
615 * OpenDocumentText export commands::    How to invoke OpenDocumentText export
616 * Applying Custom Styles::      How to apply custom styles to the output
617 * Converting to Other formats:: How to convert to formats like doc, docx etc
618 * Links in OpenDocumentText export::  How links will be interpreted and formatted
619 * Tables in OpenDocumentText export::    How Tables are handled
620 * Images in OpenDocumentText export::    How to insert figures
621 * Additional Documentation::          How to handle special characters
622
623 Publishing
624
625 * Configuration::               Defining projects
626 * Uploading files::             How to get files up on the server
627 * Sample configuration::        Example projects
628 * Triggering publication::      Publication commands
629
630 Configuration
631
632 * Project alist::               The central configuration variable
633 * Sources and destinations::    From here to there
634 * Selecting files::             What files are part of the project?
635 * Publishing action::           Setting the function doing the publishing
636 * Publishing options::          Tweaking HTML/@LaTeX{} export
637 * Publishing links::            Which links keep working after publishing?
638 * Sitemap::                     Generating a list of all pages
639 * Generating an index::         An index that reaches across pages
640
641 Sample configuration
642
643 * Simple example::              One-component publishing
644 * Complex example::             A multi-component publishing example
645
646 Working with source code
647
648 * Structure of code blocks::    Code block syntax described
649 * Editing source code::         Language major-mode editing
650 * Exporting code blocks::       Export contents and/or results
651 * Extracting source code::      Create pure source code files
652 * Evaluating code blocks::      Place results of evaluation in the Org-mode buffer
653 * Library of Babel::            Use and contribute to a library of useful code blocks
654 * Languages::                   List of supported code block languages
655 * Header arguments::            Configure code block functionality
656 * Results of evaluation::       How evaluation results are handled
657 * Noweb reference syntax::      Literate programming in Org-mode
658 * Key bindings and useful functions::  Work quickly with code blocks
659 * Batch execution::             Call functions from the command line
660
661 Header arguments
662
663 * Using header arguments::      Different ways to set header arguments
664 * Specific header arguments::   List of header arguments
665
666 Using header arguments
667
668 * System-wide header arguments::  Set global default values
669 * Language-specific header arguments::  Set default values by language
670 * Buffer-wide header arguments::  Set default values for a specific buffer
671 * Header arguments in Org-mode properties::  Set default values for a buffer or heading
672 * Code block specific header arguments::  The most common way to set values
673 * Header arguments in function calls::  The most specific level
674
675 Specific header arguments
676
677 * var::                         Pass arguments to code blocks
678 * results::                     Specify the type of results and how they will
679                                 be collected and handled
680 * file::                        Specify a path for file output
681 * dir::                         Specify the default (possibly remote)
682                                 directory for code block execution
683 * exports::                     Export code and/or results
684 * tangle::                      Toggle tangling and specify file name
685 * mkdirp::                      Toggle creation of parent directories of target
686                                 files during tangling
687 * comments::                    Toggle insertion of comments in tangled
688                                 code files
689 * padline::                     Control insertion of padding lines in tangled
690                                 code files
691 * no-expand::                   Turn off variable assignment and noweb
692                                 expansion during tangling
693 * session::                     Preserve the state of code evaluation
694 * noweb::                       Toggle expansion of noweb references
695 * noweb-ref::                   Specify block's noweb reference resolution target
696 * cache::                       Avoid re-evaluating unchanged code blocks
697 * sep::                         Delimiter for writing tabular results outside Org
698 * hlines::                      Handle horizontal lines in tables
699 * colnames::                    Handle column names in tables
700 * rownames::                    Handle row names in tables
701 * shebang::                     Make tangled files executable
702 * eval::                        Limit evaluation of specific code blocks
703
704 Miscellaneous
705
706 * Completion::                  M-TAB knows what you need
707 * Easy Templates::              Quick insertion of structural elements
708 * Speed keys::                  Electric commands at the beginning of a headline
709 * Code evaluation security::    Org mode files evaluate inline code
710 * Customization::               Adapting Org to your taste
711 * In-buffer settings::          Overview of the #+KEYWORDS
712 * The very busy C-c C-c key::   When in doubt, press C-c C-c
713 * Clean view::                  Getting rid of leading stars in the outline
714 * TTY keys::                    Using Org on a tty
715 * Interaction::                 Other Emacs packages
716 * org-crypt.el::                Encrypting Org files
717
718 Interaction with other packages
719
720 * Cooperation::                 Packages Org cooperates with
721 * Conflicts::                   Packages that lead to conflicts
722
723 Hacking
724
725 * Hooks::                       Who to reach into Org's internals
726 * Add-on packages::             Available extensions
727 * Adding hyperlink types::      New custom link types
728 * Context-sensitive commands::  How to add functionality to such commands
729 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
730 * Dynamic blocks::              Automatically filled blocks
731 * Special agenda views::        Customized views
732 * Extracting agenda information::  Postprocessing of agenda information
733 * Using the property API::      Writing programs that use entry properties
734 * Using the mapping API::       Mapping over all or selected entries
735
736 Tables and lists in arbitrary syntax
737
738 * Radio tables::                Sending and receiving radio tables
739 * A LaTeX example::             Step by step, almost a tutorial
740 * Translator functions::        Copy and modify
741 * Radio lists::                 Doing the same for lists
742
743 MobileOrg
744
745 * Setting up the staging area::  Where to interact with the mobile device
746 * Pushing to MobileOrg::        Uploading Org files and agendas
747 * Pulling from MobileOrg::      Integrating captured and flagged items
748
749 @end detailmenu
750 @end menu
751
752 @node Introduction, Document Structure, Top, Top
753 @chapter Introduction
754 @cindex introduction
755
756 @menu
757 * Summary::                     Brief summary of what Org does
758 * Installation::                How to install a downloaded version of Org
759 * Activation::                  How to activate Org for certain buffers
760 * Feedback::                    Bug reports, ideas, patches etc.
761 * Conventions::                 Type-setting conventions in the manual
762 @end menu
763
764 @node Summary, Installation, Introduction, Introduction
765 @section Summary
766 @cindex summary
767
768 Org is a mode for keeping notes, maintaining TODO lists, and doing
769 project planning with a fast and effective plain-text system.
770
771 Org develops organizational tasks around NOTES files that contain
772 lists or information about projects as plain text.  Org is
773 implemented on top of Outline mode, which makes it possible to keep the
774 content of large files well structured.  Visibility cycling and
775 structure editing help to work with the tree.  Tables are easily created
776 with a built-in table editor.  Org supports TODO items, deadlines,
777 timestamps, and scheduling.  It dynamically compiles entries into an
778 agenda that utilizes and smoothly integrates much of the Emacs calendar
779 and diary.  Plain text URL-like links connect to websites, emails,
780 Usenet messages, BBDB entries, and any files related to the projects.
781 For printing and sharing of notes, an Org file can be exported as a
782 structured ASCII file, as HTML, or (TODO and agenda items only) as an
783 iCalendar file.  It can also serve as a publishing tool for a set of
784 linked web pages.
785
786 As a project planning environment, Org works by adding metadata to outline
787 nodes.  Based on this data, specific entries can be extracted in queries and
788 create dynamic @i{agenda views}.
789
790 Org mode contains the Org Babel environment which allows you to work with
791 embedded source code blocks in a file, to facilitate code evaluation,
792 documentation, and literate programming techniques.
793
794 Org's automatic, context-sensitive table editor with spreadsheet
795 capabilities can be integrated into any major mode by activating the
796 minor Orgtbl mode.  Using a translation step, it can be used to maintain
797 tables in arbitrary file types, for example in @LaTeX{}.  The structure
798 editing and list creation capabilities can be used outside Org with
799 the minor Orgstruct mode.
800
801 Org keeps simple things simple.  When first fired up, it should
802 feel like a straightforward, easy to use outliner.  Complexity is not
803 imposed, but a large amount of functionality is available when you need
804 it.  Org is a toolbox and can be used in different ways and for different
805 ends, for example:
806
807 @example
808 @r{@bullet{} an outline extension with visibility cycling and structure editing}
809 @r{@bullet{} an ASCII system and table editor for taking structured notes}
810 @r{@bullet{} a TODO list editor}
811 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
812 @pindex GTD, Getting Things Done
813 @r{@bullet{} an environment in which to implement David Allen's GTD system}
814 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
815 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
816 @r{@bullet{} an environment for literate programming}
817 @end example
818
819
820 @cindex FAQ
821 There is a website for Org which provides links to the newest
822 version of Org, as well as additional information, frequently asked
823 questions (FAQ), links to tutorials, etc@.  This page is located at
824 @uref{http://orgmode.org}.
825
826 @cindex print edition
827 The version 7.3 of this manual is available as a
828 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
829 Theory Ltd.}
830
831 @page
832
833
834 @node Installation, Activation, Summary, Introduction
835 @section Installation
836 @cindex installation
837 @cindex XEmacs
838
839 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
840 distribution or an XEmacs package, please skip this section and go directly
841 to @ref{Activation}.  To see what version of Org (if any) is part of your
842 Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x
843 org-version}.}
844
845 If you have downloaded Org from the Web, either as a distribution @file{.zip}
846 or @file{.tar} file, or as a Git archive, you must take the following steps
847 to install it: go into the unpacked Org distribution directory and edit the
848 top section of the file @file{Makefile}.  You must set the name of the Emacs
849 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
850 directories where local Lisp and Info files are kept.  If you don't have
851 access to the system-wide directories, you can simply run Org directly from
852 the distribution directory by adding the @file{lisp} subdirectory to the
853 Emacs load path.  To do this, add the following line to @file{.emacs}:
854
855 @example
856 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
857 @end example
858
859 @noindent
860 If you plan to use code from the @file{contrib} subdirectory, do a similar
861 step for this directory:
862
863 @example
864 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
865 @end example
866
867 @noindent Now byte-compile the Lisp files with the shell command:
868
869 @example
870 make
871 @end example
872
873 @noindent If you are running Org from the distribution directory, this is
874 all.  If you want to install Org into the system directories, use (as
875 administrator)
876
877 @example
878 make install
879 @end example
880
881 Installing Info files is system dependent, because of differences in the
882 @file{install-info} program.  The following should correctly install the Info
883 files on most systems, please send a bug report if not@footnote{The output
884 from install-info (if any) is also system dependent.  In particular Debian
885 and its derivatives use two different versions of install-info and you may
886 see the message:
887
888 @example
889 This is not dpkg install-info anymore, but GNU install-info
890 See the man page for ginstall-info for command line arguments
891 @end example
892
893 @noindent which can be safely ignored.}.
894
895 @example
896 make install-info
897 @end example
898
899 Then add the following line to @file{.emacs}.  It is needed so that
900 Emacs can autoload functions that are located in files not immediately loaded
901 when Org-mode starts.
902 @lisp
903 (require 'org-install)
904 @end lisp
905
906 Do not forget to activate Org as described in the following section.
907 @page
908
909 @node Activation, Feedback, Installation, Introduction
910 @section Activation
911 @cindex activation
912 @cindex autoload
913 @cindex global key bindings
914 @cindex key bindings, global
915
916 To make sure files with extension @file{.org} use Org mode, add the following
917 line to your @file{.emacs} file.
918 @lisp
919 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
920 @end lisp
921 @noindent Org mode buffers need font-lock to be turned on - this is the
922 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
923 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
924
925 The four Org commands @command{org-store-link}, @command{org-capture},
926 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
927 global keys (i.e.@: anywhere in Emacs, not just in Org buffers).  Here are
928 suggested bindings for these keys, please modify the keys to your own
929 liking.
930 @lisp
931 (global-set-key "\C-cl" 'org-store-link)
932 (global-set-key "\C-cc" 'org-capture)
933 (global-set-key "\C-ca" 'org-agenda)
934 (global-set-key "\C-cb" 'org-iswitchb)
935 @end lisp
936
937 @cindex Org-mode, turning on
938 With this setup, all files with extension @samp{.org} will be put
939 into Org-mode.  As an alternative, make the first line of a file look
940 like this:
941
942 @example
943 MY PROJECTS    -*- mode: org; -*-
944 @end example
945
946 @vindex org-insert-mode-line-in-empty-file
947 @noindent which will select Org-mode for this buffer no matter what
948 the file's name is.  See also the variable
949 @code{org-insert-mode-line-in-empty-file}.
950
951 Many commands in Org work on the region if the region is @i{active}.  To make
952 use of this, you need to have @code{transient-mark-mode}
953 (@code{zmacs-regions} in XEmacs) turned on.  In Emacs 23 this is the default,
954 in Emacs 22 you need to do this yourself with
955 @lisp
956 (transient-mark-mode 1)
957 @end lisp
958 @noindent If you do not like @code{transient-mark-mode}, you can create an
959 active region by using the mouse to select a region, or pressing
960 @kbd{C-@key{SPC}} twice before moving the cursor.
961
962 @node Feedback, Conventions, Activation, Introduction
963 @section Feedback
964 @cindex feedback
965 @cindex bug reports
966 @cindex maintainer
967 @cindex author
968
969 If you find problems with Org, or if you have questions, remarks, or ideas
970 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
971 If you are not a member of the mailing list, your mail will be passed to the
972 list after a moderator has approved it@footnote{Please consider subscribing
973 to the mailing list, in order to minimize the work the mailing list
974 moderators have to do.}.
975
976 For bug reports, please first try to reproduce the bug with the latest
977 version of Org available---if you are running an outdated version, it is
978 quite possible that the bug has been fixed already.  If the bug persists,
979 prepare a report and provide as much information as possible, including the
980 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
981 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
982 @file{.emacs}.  The easiest way to do this is to use the command
983 @example
984 @kbd{M-x org-submit-bug-report}
985 @end example
986 @noindent which will put all this information into an Emacs mail buffer so
987 that you only need to add your description.  If you re not sending the Email
988 from within Emacs, please copy and paste the content into your Email program.
989
990 If an error occurs, a backtrace can be very useful (see below on how to
991 create one).  Often a small example file helps, along with clear information
992 about:
993
994 @enumerate
995 @item What exactly did you do?
996 @item What did you expect to happen?
997 @item What happened instead?
998 @end enumerate
999 @noindent Thank you for helping to improve this program.
1000
1001 @subsubheading How to create a useful backtrace
1002
1003 @cindex backtrace of an error
1004 If working with Org produces an error with a message you don't
1005 understand, you may have hit a bug.  The best way to report this is by
1006 providing, in addition to what was mentioned above, a @emph{backtrace}.
1007 This is information from the built-in debugger about where and how the
1008 error occurred.  Here is how to produce a useful backtrace:
1009
1010 @enumerate
1011 @item
1012 Reload uncompiled versions of all Org-mode Lisp files.  The backtrace
1013 contains much more information if it is produced with uncompiled code.
1014 To do this, use
1015 @example
1016 C-u M-x org-reload RET
1017 @end example
1018 @noindent
1019 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1020 menu.
1021 @item
1022 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1023 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1024 @item
1025 Do whatever you have to do to hit the error.  Don't forget to
1026 document the steps you take.
1027 @item
1028 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1029 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
1030 attach it to your bug report.
1031 @end enumerate
1032
1033 @node Conventions,  , Feedback, Introduction
1034 @section Typesetting conventions used in this manual
1035
1036 Org uses three types of keywords: TODO keywords, tags, and property
1037 names.  In this manual we use the following conventions:
1038
1039 @table @code
1040 @item TODO
1041 @itemx WAITING
1042 TODO keywords are written with all capitals, even if they are
1043 user-defined.
1044 @item boss
1045 @itemx ARCHIVE
1046 User-defined tags are written in lowercase; built-in tags with special
1047 meaning are written with all capitals.
1048 @item Release
1049 @itemx PRIORITY
1050 User-defined properties are capitalized; built-in properties with
1051 special meaning are written with all capitals.
1052 @end table
1053
1054 The manual lists both the keys and the corresponding commands for accessing
1055 functionality.  Org mode often uses the same key for different functions,
1056 depending on context.  The command that is bound to such keys has a generic
1057 name, like @code{org-metaright}.  In the manual we will, wherever possible,
1058 give the function that is internally called by the generic command.  For
1059 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1060 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1061 be listed to call org-table-move-column-right.
1062
1063 If you prefer, you can compile the manual without the command names by
1064 unsetting the flag @code{cmdnames} in @file{org.texi}.
1065
1066 @node Document Structure, Tables, Introduction, Top
1067 @chapter Document structure
1068 @cindex document structure
1069 @cindex structure of document
1070
1071 Org is based on Outline mode and provides flexible commands to
1072 edit the structure of the document.
1073
1074 @menu
1075 * Outlines::                    Org is based on Outline mode
1076 * Headlines::                   How to typeset Org tree headlines
1077 * Visibility cycling::          Show and hide, much simplified
1078 * Motion::                      Jumping to other headlines
1079 * Structure editing::           Changing sequence and level of headlines
1080 * Sparse trees::                Matches embedded in context
1081 * Plain lists::                 Additional structure within an entry
1082 * Drawers::                     Tucking stuff away
1083 * Blocks::                      Folding blocks
1084 * Footnotes::                   How footnotes are defined in Org's syntax
1085 * Orgstruct mode::              Structure editing outside Org
1086 @end menu
1087
1088 @node Outlines, Headlines, Document Structure, Document Structure
1089 @section Outlines
1090 @cindex outlines
1091 @cindex Outline mode
1092
1093 Org is implemented on top of Outline mode.  Outlines allow a
1094 document to be organized in a hierarchical structure, which (at least
1095 for me) is the best representation of notes and thoughts.  An overview
1096 of this structure is achieved by folding (hiding) large parts of the
1097 document to show only the general document structure and the parts
1098 currently being worked on.  Org greatly simplifies the use of
1099 outlines by compressing the entire show/hide functionality into a single
1100 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1101
1102 @node Headlines, Visibility cycling, Outlines, Document Structure
1103 @section Headlines
1104 @cindex headlines
1105 @cindex outline tree
1106 @vindex org-special-ctrl-a/e
1107 @vindex org-special-ctrl-k
1108 @vindex org-ctrl-k-protect-subtree
1109
1110 Headlines define the structure of an outline tree.  The headlines in Org
1111 start with one or more stars, on the left margin@footnote{See the variables
1112 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1113 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1114 @kbd{C-e}, and @kbd{C-k} in headlines.}.  For example:
1115
1116 @example
1117 * Top level headline
1118 ** Second level
1119 *** 3rd level
1120     some text
1121 *** 3rd level
1122     more text
1123
1124 * Another top level headline
1125 @end example
1126
1127 @noindent Some people find the many stars too noisy and would prefer an
1128 outline that has whitespace followed by a single star as headline
1129 starters.  @ref{Clean view}, describes a setup to realize this.
1130
1131 @vindex org-cycle-separator-lines
1132 An empty line after the end of a subtree is considered part of it and
1133 will be hidden when the subtree is folded.  However, if you leave at
1134 least two empty lines, one empty line will remain visible after folding
1135 the subtree, in order to structure the collapsed view.  See the
1136 variable @code{org-cycle-separator-lines} to modify this behavior.
1137
1138 @node Visibility cycling, Motion, Headlines, Document Structure
1139 @section Visibility cycling
1140 @cindex cycling, visibility
1141 @cindex visibility cycling
1142 @cindex trees, visibility
1143 @cindex show hidden text
1144 @cindex hide text
1145
1146 Outlines make it possible to hide parts of the text in the buffer.
1147 Org uses just two commands, bound to @key{TAB} and
1148 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1149
1150 @cindex subtree visibility states
1151 @cindex subtree cycling
1152 @cindex folded, subtree visibility state
1153 @cindex children, subtree visibility state
1154 @cindex subtree, subtree visibility state
1155 @table @asis
1156 @orgcmd{@key{TAB},org-cycle}
1157 @emph{Subtree cycling}: Rotate current subtree among the states
1158
1159 @example
1160 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1161 '-----------------------------------'
1162 @end example
1163
1164 @vindex org-cycle-emulate-tab
1165 @vindex org-cycle-global-at-bob
1166 The cursor must be on a headline for this to work@footnote{see, however,
1167 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
1168 beginning of the buffer and the first line is not a headline, then
1169 @key{TAB} actually runs global cycling (see below)@footnote{see the
1170 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
1171 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1172
1173 @cindex global visibility states
1174 @cindex global cycling
1175 @cindex overview, global visibility state
1176 @cindex contents, global visibility state
1177 @cindex show all, global visibility state
1178 @orgcmd{S-@key{TAB},org-global-cycle}
1179 @itemx C-u @key{TAB}
1180 @emph{Global cycling}: Rotate the entire buffer among the states
1181
1182 @example
1183 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1184 '--------------------------------------'
1185 @end example
1186
1187 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1188 CONTENTS view up to headlines of level N will be shown.  Note that inside
1189 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1190
1191 @cindex show all, command
1192 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1193 Show all, including drawers.
1194 @orgcmd{C-c C-r,org-reveal}
1195 Reveal context around point, showing the current entry, the following heading
1196 and the hierarchy above.  Useful for working near a location that has been
1197 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1198 (@pxref{Agenda commands}).  With a prefix argument show, on each
1199 level, all sibling headings.  With double prefix arg, also show the entire
1200 subtree of the parent.
1201 @orgcmd{C-c C-k,show-branches}
1202 Expose all the headings of the subtree, CONTENT view for just one subtree.
1203 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1204 Show the current subtree in an indirect buffer@footnote{The indirect
1205 buffer
1206 @ifinfo
1207 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1208 @end ifinfo
1209 @ifnotinfo
1210 (see the Emacs manual for more information about indirect buffers)
1211 @end ifnotinfo
1212 will contain the entire buffer, but will be narrowed to the current
1213 tree.  Editing the indirect buffer will also change the original buffer,
1214 but without affecting visibility in that buffer.}.  With a numeric
1215 prefix argument N, go up to level N and then take that tree.  If N is
1216 negative then go up that many levels.  With a @kbd{C-u} prefix, do not remove
1217 the previously used indirect buffer.
1218 @orgcmd{C-c C-x v,org-copy-visible}
1219 Copy the @i{visible} text in the region into the kill ring.
1220 @end table
1221
1222 @vindex org-startup-folded
1223 @cindex @code{overview}, STARTUP keyword
1224 @cindex @code{content}, STARTUP keyword
1225 @cindex @code{showall}, STARTUP keyword
1226 @cindex @code{showeverything}, STARTUP keyword
1227
1228 When Emacs first visits an Org file, the global state is set to
1229 OVERVIEW, i.e.@: only the top level headlines are visible.  This can be
1230 configured through the variable @code{org-startup-folded}, or on a
1231 per-file basis by adding one of the following lines anywhere in the
1232 buffer:
1233
1234 @example
1235 #+STARTUP: overview
1236 #+STARTUP: content
1237 #+STARTUP: showall
1238 #+STARTUP: showeverything
1239 @end example
1240
1241 @cindex property, VISIBILITY
1242 @noindent
1243 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1244 and Columns}) will get their visibility adapted accordingly.  Allowed values
1245 for this property are @code{folded}, @code{children}, @code{content}, and
1246 @code{all}.
1247 @table @asis
1248 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1249 Switch back to the startup visibility of the buffer, i.e.@: whatever is
1250 requested by startup options and @samp{VISIBILITY} properties in individual
1251 entries.
1252 @end table
1253
1254 @node Motion, Structure editing, Visibility cycling, Document Structure
1255 @section Motion
1256 @cindex motion, between headlines
1257 @cindex jumping, to headlines
1258 @cindex headline navigation
1259 The following commands jump to other headlines in the buffer.
1260
1261 @table @asis
1262 @orgcmd{C-c C-n,outline-next-visible-heading}
1263 Next heading.
1264 @orgcmd{C-c C-p,outline-previous-visible-heading}
1265 Previous heading.
1266 @orgcmd{C-c C-f,org-forward-same-level}
1267 Next heading same level.
1268 @orgcmd{C-c C-b,org-backward-same-level}
1269 Previous heading same level.
1270 @orgcmd{C-c C-u,outline-up-heading}
1271 Backward to higher level heading.
1272 @orgcmd{C-c C-j,org-goto}
1273 Jump to a different place without changing the current outline
1274 visibility.  Shows the document structure in a temporary buffer, where
1275 you can use the following keys to find your destination:
1276 @vindex org-goto-auto-isearch
1277 @example
1278 @key{TAB}         @r{Cycle visibility.}
1279 @key{down} / @key{up}   @r{Next/previous visible headline.}
1280 @key{RET}         @r{Select this location.}
1281 @kbd{/}           @r{Do a Sparse-tree search}
1282 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1283 n / p        @r{Next/previous visible headline.}
1284 f / b        @r{Next/previous headline same level.}
1285 u            @r{One level up.}
1286 0-9          @r{Digit argument.}
1287 q            @r{Quit}
1288 @end example
1289 @vindex org-goto-interface
1290 @noindent
1291 See also the variable @code{org-goto-interface}.
1292 @end table
1293
1294 @node Structure editing, Sparse trees, Motion, Document Structure
1295 @section Structure editing
1296 @cindex structure editing
1297 @cindex headline, promotion and demotion
1298 @cindex promotion, of subtrees
1299 @cindex demotion, of subtrees
1300 @cindex subtree, cut and paste
1301 @cindex pasting, of subtrees
1302 @cindex cutting, of subtrees
1303 @cindex copying, of subtrees
1304 @cindex sorting, of subtrees
1305 @cindex subtrees, cut and paste
1306
1307 @table @asis
1308 @orgcmd{M-@key{RET},org-insert-heading}
1309 @vindex org-M-RET-may-split-line
1310 Insert new heading with same level as current.  If the cursor is in a plain
1311 list item, a new item is created (@pxref{Plain lists}).  To force creation of
1312 a new headline, use a prefix argument.  When this command is used in the
1313 middle of a line, the line is split and the rest of the line becomes the new
1314 headline@footnote{If you do not want the line to be split, customize the
1315 variable @code{org-M-RET-may-split-line}.}.  If the command is used at the
1316 beginning of a headline, the new headline is created before the current line.
1317 If at the beginning of any other line, the content of that line is made the
1318 new heading.  If the command is used at the end of a folded subtree (i.e.@:
1319 behind the ellipses at the end of a headline), then a headline like the
1320 current one will be inserted after the end of the subtree.
1321 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1322 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1323 current heading, the new heading is placed after the body instead of before
1324 it.  This command works from anywhere in the entry.
1325 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1326 @vindex org-treat-insert-todo-heading-as-state-change
1327 Insert new TODO entry with same level as current heading.  See also the
1328 variable @code{org-treat-insert-todo-heading-as-state-change}.
1329 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1330 Insert new TODO entry with same level as current heading.  Like
1331 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1332 subtree.
1333 @orgcmd{@key{TAB},org-cycle}
1334 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1335 become a child of the previous one.  The next @key{TAB} makes it a parent,
1336 and so on, all the way to top level.  Yet another @key{TAB}, and you are back
1337 to the initial level.
1338 @orgcmd{M-@key{left},org-do-promote}
1339 Promote current heading by one level.
1340 @orgcmd{M-@key{right},org-do-demote}
1341 Demote current heading by one level.
1342 @orgcmd{M-S-@key{left},org-promote-subtree}
1343 Promote the current subtree by one level.
1344 @orgcmd{M-S-@key{right},org-demote-subtree}
1345 Demote the current subtree by one level.
1346 @orgcmd{M-S-@key{up},org-move-subtree-up}
1347 Move subtree up (swap with previous subtree of same
1348 level).
1349 @orgcmd{M-S-@key{down},org-move-subtree-down}
1350 Move subtree down (swap with next subtree of same level).
1351 @orgcmd{C-c C-x C-w,org-cut-subtree}
1352 Kill subtree, i.e.@: remove it from buffer but save in kill ring.
1353 With a numeric prefix argument N, kill N sequential subtrees.
1354 @orgcmd{C-c C-x M-w,org-copy-subtree}
1355 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
1356 sequential subtrees.
1357 @orgcmd{C-c C-x C-y,org-paste-subtree}
1358 Yank subtree from kill ring.  This does modify the level of the subtree to
1359 make sure the tree fits in nicely at the yank position.  The yank level can
1360 also be specified with a numeric prefix argument, or by yanking after a
1361 headline marker like @samp{****}.
1362 @orgcmd{C-y,org-yank}
1363 @vindex org-yank-adjusted-subtrees
1364 @vindex org-yank-folded-subtrees
1365 Depending on the variables @code{org-yank-adjusted-subtrees} and
1366 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1367 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1368 C-x C-y}.  With the default settings, no level adjustment will take place,
1369 but the yanked tree will be folded unless doing so would swallow text
1370 previously visible.  Any prefix argument to this command will force a normal
1371 @code{yank} to be executed, with the prefix passed along.  A good way to
1372 force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
1373 yank, it will yank previous kill items plainly, without adjustment and
1374 folding.
1375 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1376 Clone a subtree by making a number of sibling copies of it.  You will be
1377 prompted for the number of copies to make, and you can also specify if any
1378 timestamps in the entry should be shifted.  This can be useful, for example,
1379 to create a number of tasks related to a series of lectures to prepare.  For
1380 more details, see the docstring of the command
1381 @code{org-clone-subtree-with-time-shift}.
1382 @orgcmd{C-c C-w,org-refile}
1383 Refile entry or region to a different location.  @xref{Refiling notes}.
1384 @orgcmd{C-c ^,org-sort-entries-or-items}
1385 Sort same-level entries.  When there is an active region, all entries in the
1386 region will be sorted.  Otherwise the children of the current headline are
1387 sorted.  The command prompts for the sorting method, which can be
1388 alphabetically, numerically, by time (first timestamp with active preferred,
1389 creation time, scheduled time, deadline time), by priority, by TODO keyword
1390 (in the sequence the keywords have been defined in the setup) or by the value
1391 of a property.  Reverse sorting is possible as well.  You can also supply
1392 your own function to extract the sorting key.  With a @kbd{C-u} prefix,
1393 sorting will be case-sensitive.  With two @kbd{C-u C-u} prefixes, duplicate
1394 entries will also be removed.
1395 @orgcmd{C-x n s,org-narrow-to-subtree}
1396 Narrow buffer to current subtree.
1397 @orgcmd{C-x n b,org-narrow-to-block}
1398 Narrow buffer to current block.
1399 @orgcmd{C-x n w,widen}
1400 Widen buffer to remove narrowing.
1401 @orgcmd{C-c *,org-toggle-heading}
1402 Turn a normal line or plain list item into a headline (so that it becomes a
1403 subheading at its location).  Also turn a headline into a normal line by
1404 removing the stars.  If there is an active region, turn all lines in the
1405 region into headlines.  If the first line in the region was an item, turn
1406 only the item lines into headlines.  Finally, if the first line is a
1407 headline, remove the stars from all headlines in the region.
1408 @end table
1409
1410 @cindex region, active
1411 @cindex active region
1412 @cindex transient mark mode
1413 When there is an active region (Transient Mark mode), promotion and
1414 demotion work on all headlines in the region.  To select a region of
1415 headlines, it is best to place both point and mark at the beginning of a
1416 line, mark at the beginning of the first headline, and point at the line
1417 just after the last headline to change.  Note that when the cursor is
1418 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1419 functionality.
1420
1421
1422 @node Sparse trees, Plain lists, Structure editing, Document Structure
1423 @section Sparse trees
1424 @cindex sparse trees
1425 @cindex trees, sparse
1426 @cindex folding, sparse trees
1427 @cindex occur, command
1428
1429 @vindex org-show-hierarchy-above
1430 @vindex org-show-following-heading
1431 @vindex org-show-siblings
1432 @vindex org-show-entry-below
1433 An important feature of Org-mode is the ability to construct @emph{sparse
1434 trees} for selected information in an outline tree, so that the entire
1435 document is folded as much as possible, but the selected information is made
1436 visible along with the headline structure above it@footnote{See also the
1437 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1438 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1439 control on how much context is shown around each match.}.  Just try it out
1440 and you will see immediately how it works.
1441
1442 Org-mode contains several commands creating such trees, all these
1443 commands can be accessed through a dispatcher:
1444
1445 @table @asis
1446 @orgcmd{C-c /,org-sparse-tree}
1447 This prompts for an extra key to select a sparse-tree creating command.
1448 @orgcmd{C-c / r,org-occur}
1449 @vindex org-remove-highlights-with-change
1450 Prompts for a regexp and shows a sparse tree with all matches.  If
1451 the match is in a headline, the headline is made visible.  If the match is in
1452 the body of an entry, headline and body are made visible.  In order to
1453 provide minimal context, also the full hierarchy of headlines above the match
1454 is shown, as well as the headline following the match.  Each match is also
1455 highlighted; the highlights disappear when the buffer is changed by an
1456 editing command@footnote{This depends on the option
1457 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1458 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1459 so several calls to this command can be stacked.
1460 @orgcmdkkc{M-g n,M-g M-n,next-error}
1461 Jump to the next sparse tree match in this buffer.
1462 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1463 Jump to the previous sparse tree match in this buffer.
1464 @end table
1465
1466
1467 @noindent
1468 @vindex org-agenda-custom-commands
1469 For frequently used sparse trees of specific search strings, you can
1470 use the variable @code{org-agenda-custom-commands} to define fast
1471 keyboard access to specific sparse trees.  These commands will then be
1472 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1473 For example:
1474
1475 @lisp
1476 (setq org-agenda-custom-commands
1477       '(("f" occur-tree "FIXME")))
1478 @end lisp
1479
1480 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1481 a sparse tree matching the string @samp{FIXME}.
1482
1483 The other sparse tree commands select headings based on TODO keywords,
1484 tags, or properties and will be discussed later in this manual.
1485
1486 @kindex C-c C-e v
1487 @cindex printing sparse trees
1488 @cindex visible text, printing
1489 To print a sparse tree, you can use the Emacs command
1490 @code{ps-print-buffer-with-faces} which does not print invisible parts
1491 of the document @footnote{This does not work under XEmacs, because
1492 XEmacs uses selective display for outlining, not text properties.}.
1493 Or you can use the command @kbd{C-c C-e v} to export only the visible
1494 part of the document and print the resulting file.
1495
1496 @node Plain lists, Drawers, Sparse trees, Document Structure
1497 @section Plain lists
1498 @cindex plain lists
1499 @cindex lists, plain
1500 @cindex lists, ordered
1501 @cindex ordered lists
1502
1503 Within an entry of the outline tree, hand-formatted lists can provide
1504 additional structure.  They also provide a way to create lists of checkboxes
1505 (@pxref{Checkboxes}).  Org supports editing such lists, and every exporter
1506 (@pxref{Exporting}) can parse and format them.
1507
1508 Org knows ordered lists, unordered lists, and description lists.
1509 @itemize @bullet
1510 @item
1511 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1512 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1513 they will be seen as top-level headlines.  Also, when you are hiding leading
1514 stars to get a clean outline view, plain list items starting with a star may
1515 be hard to distinguish from true headlines.  In short: even though @samp{*}
1516 is supported, it may be better to not use it for plain list items.}  as
1517 bullets.
1518 @item
1519 @vindex org-plain-list-ordered-item-terminator
1520 @vindex org-alphabetical-lists
1521 @emph{Ordered} list items start with a numeral followed by either a period or
1522 a right parenthesis@footnote{You can filter out any of them by configuring
1523 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1524 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1525 @samp{A)} by configuring @code{org-alphabetical-lists}.  To minimize
1526 confusion with normal text, those are limited to one character only.  Beyond
1527 that limit, bullets will automatically fallback to numbers.}.  If you want a
1528 list to start with a different value (e.g.@: 20), start the text of the item
1529 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1530 must be put @emph{before} the checkbox.  If you have activated alphabetical
1531 lists, you can also use counters like @code{[@@b]}.}.  Those constructs can
1532 be used in any item of the list in order to enforce a particular numbering.
1533 @item
1534 @emph{Description} list items are unordered list items, and contain the
1535 separator @samp{ :: } to distinguish the description @emph{term} from the
1536 description.
1537 @end itemize
1538
1539 Items belonging to the same list must have the same indentation on the first
1540 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1541 2--digit numbers must be written left-aligned with the other numbers in the
1542 list.  An item ends before the next line that is less or equally indented
1543 than its bullet/number.
1544
1545 @vindex org-list-ending-method
1546 @vindex org-list-end-regexp
1547 @vindex org-empty-line-terminates-plain-lists
1548 Two methods@footnote{To disable either of them, configure
1549 @code{org-list-ending-method}.} are provided to terminate lists.  A list ends
1550 whenever every item has ended, which means before any line less or equally
1551 indented than items at top level.  It also ends before two blank
1552 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}.  In
1553 that case, all items are closed.  For finer control, you can end lists with
1554 any pattern set in @code{org-list-end-regexp}.  Here is an example:
1555
1556 @example
1557 @group
1558 ** Lord of the Rings
1559    My favorite scenes are (in this order)
1560    1. The attack of the Rohirrim
1561    2. Eowyn's fight with the witch king
1562       + this was already my favorite scene in the book
1563       + I really like Miranda Otto.
1564    3. Peter Jackson being shot by Legolas
1565       - on DVD only
1566       He makes a really funny face when it happens.
1567    But in the end, no individual scenes matter but the film as a whole.
1568    Important actors in this film are:
1569    - @b{Elijah Wood} :: He plays Frodo
1570    - @b{Sean Austin} :: He plays Sam, Frodo's friend.  I still remember
1571      him very well from his role as Mikey Walsh in @i{The Goonies}.
1572 @end group
1573 @end example
1574
1575 Org supports these lists by tuning filling and wrapping commands to deal with
1576 them correctly@footnote{Org only changes the filling settings for Emacs.  For
1577 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}.  To turn this on,
1578 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1579 properly (@pxref{Exporting}).  Since indentation is what governs the
1580 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1581 blocks can be indented to signal that they belong to a particular item.
1582
1583 @vindex org-list-demote-modify-bullet
1584 @vindex org-list-indent-offset
1585 If you find that using a different bullet for a sub-list (than that used for
1586 the current list-level) improves readability, customize the variable
1587 @code{org-list-demote-modify-bullet}.  To get a greater difference of
1588 indentation between items and theirs sub-items, customize
1589 @code{org-list-indent-offset}.
1590
1591 @vindex org-list-automatic-rules
1592 The following commands act on items when the cursor is in the first line of
1593 an item (the line with the bullet or number).  Some of them imply the
1594 application of automatic rules to keep list structure intact.  If some of
1595 these actions get in your way, configure @code{org-list-automatic-rules}
1596 to disable them individually.
1597
1598 @table @asis
1599 @orgcmd{@key{TAB},org-cycle}
1600 @vindex org-cycle-include-plain-lists
1601 Items can be folded just like headline levels.  Normally this works only if
1602 the cursor is on a plain list item.  For more details, see the variable
1603 @code{org-cycle-include-plain-lists}.  If this variable is set to
1604 @code{integrate}, plain list items will be treated like low-level
1605 headlines.  The level of an item is then given by the
1606 indentation of the bullet/number.  Items are always subordinate to real
1607 headlines, however; the hierarchies remain completely separated.
1608 @orgcmd{M-@key{RET},org-insert-heading}
1609 @vindex org-M-RET-may-split-line
1610 @vindex org-list-automatic-rules
1611 Insert new item at current level.  With a prefix argument, force a new
1612 heading (@pxref{Structure editing}).  If this command is used in the middle
1613 of an item, that item is @emph{split} in two, and the second part becomes the
1614 new item@footnote{If you do not want the item to be split, customize the
1615 variable @code{org-M-RET-may-split-line}.}.  If this command is executed
1616 @emph{before item's body}, the new item is created @emph{before} the current
1617 one.
1618 @kindex M-S-@key{RET}
1619 @item M-S-@key{RET}
1620 Insert a new item with a checkbox (@pxref{Checkboxes}).
1621 @orgcmd{@key{TAB},org-cycle}
1622 In a new item with no text yet, the first @key{TAB} demotes the item to
1623 become a child of the previous one.  Subsequent @key{TAB}s move the item to
1624 meaningful levels in the list and eventually get it back to its initial
1625 position.
1626 @kindex S-@key{down}
1627 @item S-@key{up}
1628 @itemx S-@key{down}
1629 @cindex shift-selection-mode
1630 @vindex org-support-shift-select
1631 @vindex org-list-use-circular-motion
1632 Jump to the previous/next item in the current list@footnote{If you want to
1633 cycle around items that way, you may customize
1634 @code{org-list-use-circular-motion}.}, but only if
1635 @code{org-support-shift-select} is off.  If not, you can still use paragraph
1636 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1637 similar effect.
1638 @kindex M-@key{up}
1639 @kindex M-@key{down}
1640 @item M-@key{up}
1641 @itemx M-@key{down}
1642 Move the item including subitems up/down@footnote{See
1643 @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
1644 previous/next item of same indentation).  If the list is ordered, renumbering
1645 is automatic.
1646 @kindex M-@key{left}
1647 @kindex M-@key{right}
1648 @item M-@key{left}
1649 @itemx M-@key{right}
1650 Decrease/increase the indentation of an item, leaving children alone.
1651 @kindex M-S-@key{left}
1652 @kindex M-S-@key{right}
1653 @item M-S-@key{left}
1654 @itemx M-S-@key{right}
1655 Decrease/increase the indentation of the item, including subitems.
1656 Initially, the item tree is selected based on current indentation.  When
1657 these commands are executed several times in direct succession, the initially
1658 selected region is used, even if the new indentation would imply a different
1659 hierarchy.  To use the new hierarchy, break the command chain with a cursor
1660 motion or so.
1661
1662 As a special case, using this command on the very first item of a list will
1663 move the whole list.  This behavior can be disabled by configuring
1664 @code{org-list-automatic-rules}.  The global indentation of a list has no
1665 influence on the text @emph{after} the list.
1666 @kindex C-c C-c
1667 @item C-c C-c
1668 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1669 state of the checkbox.  In any case, verify bullets and indentation
1670 consistency in the whole list.
1671 @kindex C-c -
1672 @vindex org-plain-list-ordered-item-terminator
1673 @vindex org-list-automatic-rules
1674 @item C-c -
1675 Cycle the entire list level through the different itemize/enumerate bullets
1676 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1677 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1678 and its position@footnote{See @code{bullet} rule in
1679 @code{org-list-automatic-rules} for more information.}.  With a numeric
1680 prefix argument N, select the Nth bullet from this list.  If there is an
1681 active region when calling this, selected text will be changed into an item.
1682 With a prefix argument, all lines will be converted to list items.  If the
1683 first line already was a list item, any item marker will be removed from the
1684 list.  Finally, even without an active region, a normal line will be
1685 converted into a list item.
1686 @kindex C-c *
1687 @item C-c *
1688 Turn a plain list item into a headline (so that it becomes a subheading at
1689 its location).  @xref{Structure editing}, for a detailed explanation.
1690 @kindex C-c C-*
1691 @item C-c C-*
1692 Turn the whole plain list into a subtree of the current heading.  Checkboxes
1693 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1694 (resp. checked).
1695 @kindex S-@key{left}
1696 @kindex S-@key{right}
1697 @item S-@key{left}/@key{right}
1698 @vindex org-support-shift-select
1699 This command also cycles bullet styles when the cursor in on the bullet or
1700 anywhere in an item line, details depending on
1701 @code{org-support-shift-select}.
1702 @kindex C-c ^
1703 @item C-c ^
1704 Sort the plain list.  You will be prompted for the sorting method:
1705 numerically, alphabetically, by time, or by custom function.
1706 @end table
1707
1708 @node Drawers, Blocks, Plain lists, Document Structure
1709 @section Drawers
1710 @cindex drawers
1711 @cindex #+DRAWERS
1712 @cindex visibility cycling, drawers
1713
1714 @vindex org-drawers
1715 Sometimes you want to keep information associated with an entry, but you
1716 normally don't want to see it.  For this, Org-mode has @emph{drawers}.
1717 Drawers need to be configured with the variable
1718 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1719 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}.  Drawers
1720 look like this:
1721
1722 @example
1723 ** This is a headline
1724    Still outside the drawer
1725    :DRAWERNAME:
1726    This is inside the drawer.
1727    :END:
1728    After the drawer.
1729 @end example
1730
1731 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1732 show the entry, but keep the drawer collapsed to a single line.  In order to
1733 look inside the drawer, you need to move the cursor to the drawer line and
1734 press @key{TAB} there.  Org-mode uses the @code{PROPERTIES} drawer for
1735 storing properties (@pxref{Properties and Columns}), and you can also arrange
1736 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1737 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.  If you
1738 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1739
1740 @table @kbd
1741 @kindex C-c C-z
1742 @item C-c C-z
1743 Add a time-stamped note to the LOGBOOK drawer.
1744 @end table
1745
1746 @node Blocks, Footnotes, Drawers, Document Structure
1747 @section Blocks
1748
1749 @vindex org-hide-block-startup
1750 @cindex blocks, folding
1751 Org-mode uses begin...end blocks for various purposes from including source
1752 code examples (@pxref{Literal examples}) to capturing time logging
1753 information (@pxref{Clocking work time}).  These blocks can be folded and
1754 unfolded by pressing TAB in the begin line.  You can also get all blocks
1755 folded at startup by configuring the variable @code{org-hide-block-startup}
1756 or on a per-file basis by using
1757
1758 @cindex @code{hideblocks}, STARTUP keyword
1759 @cindex @code{nohideblocks}, STARTUP keyword
1760 @example
1761 #+STARTUP: hideblocks
1762 #+STARTUP: nohideblocks
1763 @end example
1764
1765 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1766 @section Footnotes
1767 @cindex footnotes
1768
1769 Org-mode supports the creation of footnotes.  In contrast to the
1770 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
1771 larger document, not only for one-off documents like emails.  The basic
1772 syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
1773 defined in a paragraph that is started by a footnote marker in square
1774 brackets in column 0, no indentation allowed.  If you need a paragraph break
1775 inside a footnote, use the @LaTeX{} idiom @samp{\par}.  The footnote reference
1776 is simply the marker in square brackets, inside text.  For example:
1777
1778 @example
1779 The Org homepage[fn:1] now looks a lot better than it used to.
1780 ...
1781 [fn:1] The link is: http://orgmode.org
1782 @end example
1783
1784 Org-mode extends the number-based syntax to @emph{named} footnotes and
1785 optional inline definition.  Using plain numbers as markers (as
1786 @file{footnote.el} does) is supported for backward compatibility, but not
1787 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1788 LaTeX}).  Here are the valid references:
1789
1790 @table @code
1791 @item [1]
1792 A plain numeric footnote marker.  Compatible with @file{footnote.el}, but not
1793 recommended because something like @samp{[1]} could easily be part of a code
1794 snippet.
1795 @item [fn:name]
1796 A named footnote reference, where @code{name} is a unique label word, or, for
1797 simplicity of automatic creation, a number.
1798 @item [fn:: This is the inline definition of this footnote]
1799 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1800 reference point.
1801 @item [fn:name: a definition]
1802 An inline definition of a footnote, which also specifies a name for the note.
1803 Since Org allows multiple references to the same note, you can then use
1804 @code{[fn:name]} to create additional references.
1805 @end table
1806
1807 @vindex org-footnote-auto-label
1808 Footnote labels can be created automatically, or you can create names yourself.
1809 This is handled by the variable @code{org-footnote-auto-label} and its
1810 corresponding @code{#+STARTUP} keywords.  See the docstring of that variable
1811 for details.
1812
1813 @noindent The following command handles footnotes:
1814
1815 @table @kbd
1816 @kindex C-c C-x f
1817 @item C-c C-x f
1818 The footnote action command.
1819
1820 When the cursor is on a footnote reference, jump to the definition.  When it
1821 is at a definition, jump to the (first) reference.
1822
1823 @vindex org-footnote-define-inline
1824 @vindex org-footnote-section
1825 @vindex org-footnote-auto-adjust
1826 Otherwise, create a new footnote.  Depending on the variable
1827 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1828 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1829 definition will be placed right into the text as part of the reference, or
1830 separately into the location determined by the variable
1831 @code{org-footnote-section}.
1832
1833 When this command is called with a prefix argument, a menu of additional
1834 options is offered:
1835 @example
1836 s   @r{Sort the footnote definitions by reference sequence.  During editing,}
1837     @r{Org makes no effort to sort footnote definitions into a particular}
1838     @r{sequence.  If you want them sorted, use this command, which will}
1839     @r{also move entries according to @code{org-footnote-section}.  Automatic}
1840     @r{sorting after each insertion/deletion can be configured using the}
1841     @r{variable @code{org-footnote-auto-adjust}.}
1842 r   @r{Renumber the simple @code{fn:N} footnotes.  Automatic renumbering}
1843     @r{after each insertion/deletion can be configured using the variable}
1844     @r{@code{org-footnote-auto-adjust}.}
1845 S   @r{Short for first @code{r}, then @code{s} action.}
1846 n   @r{Normalize the footnotes by collecting all definitions (including}
1847     @r{inline definitions) into a special section, and then numbering them}
1848     @r{in sequence.  The references will then also be numbers.  This is}
1849     @r{meant to be the final step before finishing a document (e.g.@: sending}
1850     @r{off an email).  The exporters do this automatically, and so could}
1851     @r{something like @code{message-send-hook}.}
1852 d   @r{Delete the footnote at point, and all definitions of and references}
1853     @r{to it.}
1854 @end example
1855 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1856 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1857 renumbering and sorting footnotes can be automatic after each insertion or
1858 deletion.
1859
1860 @kindex C-c C-c
1861 @item C-c C-c
1862 If the cursor is on a footnote reference, jump to the definition.  If it is a
1863 the definition, jump back to the reference.  When called at a footnote
1864 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1865 @kindex C-c C-o
1866 @kindex mouse-1
1867 @kindex mouse-2
1868 @item C-c C-o  @r{or} mouse-1/2
1869 Footnote labels are also links to the corresponding definition/reference, and
1870 you can use the usual commands to follow these links.
1871 @end table
1872
1873 @node Orgstruct mode,  , Footnotes, Document Structure
1874 @section The Orgstruct minor mode
1875 @cindex Orgstruct mode
1876 @cindex minor mode for structure editing
1877
1878 If you like the intuitive way the Org-mode structure editing and list
1879 formatting works, you might want to use these commands in other modes like
1880 Text mode or Mail mode as well.  The minor mode @code{orgstruct-mode} makes
1881 this possible.   Toggle the mode with @kbd{M-x orgstruct-mode}, or
1882 turn it on by default, for example in Message mode, with one of:
1883
1884 @lisp
1885 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1886 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1887 @end lisp
1888
1889 When this mode is active and the cursor is on a line that looks to Org like a
1890 headline or the first line of a list item, most structure editing commands
1891 will work, even if the same keys normally have different functionality in the
1892 major mode you are using.  If the cursor is not in one of those special
1893 lines, Orgstruct mode lurks silently in the shadows.  When you use
1894 @code{orgstruct++-mode}, Org will also export indentation and autofill
1895 settings into that mode, and detect item context after the first line of an
1896 item.
1897
1898 @node Tables, Hyperlinks, Document Structure, Top
1899 @chapter Tables
1900 @cindex tables
1901 @cindex editing tables
1902
1903 Org comes with a fast and intuitive table editor.  Spreadsheet-like
1904 calculations are supported using the Emacs @file{calc} package
1905 @ifinfo
1906 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1907 @end ifinfo
1908 @ifnotinfo
1909 (see the Emacs Calculator manual for more information about the Emacs
1910 calculator).
1911 @end ifnotinfo
1912
1913 @menu
1914 * Built-in table editor::       Simple tables
1915 * Column width and alignment::  Overrule the automatic settings
1916 * Column groups::               Grouping to trigger vertical lines
1917 * Orgtbl mode::                 The table editor as minor mode
1918 * The spreadsheet::             The table editor has spreadsheet capabilities
1919 * Org-Plot::                    Plotting from org tables
1920 @end menu
1921
1922 @node Built-in table editor, Column width and alignment, Tables, Tables
1923 @section The built-in table editor
1924 @cindex table editor, built-in
1925
1926 Org makes it easy to format tables in plain ASCII.  Any line with @samp{|} as
1927 the first non-whitespace character is considered part of a table.  @samp{|}
1928 is also the column separator@footnote{To insert a vertical bar into a table
1929 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}.  A table
1930 might look like this:
1931
1932 @example
1933 | Name  | Phone | Age |
1934 |-------+-------+-----|
1935 | Peter |  1234 |  17 |
1936 | Anna  |  4321 |  25 |
1937 @end example
1938
1939 A table is re-aligned automatically each time you press @key{TAB} or
1940 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
1941 the next field (@key{RET} to the next row) and creates new table rows
1942 at the end of the table or before horizontal lines.  The indentation
1943 of the table is set by the first line.  Any line starting with
1944 @samp{|-} is considered as a horizontal separator line and will be
1945 expanded on the next re-align to span the whole table width.  So, to
1946 create the above table, you would only type
1947
1948 @example
1949 |Name|Phone|Age|
1950 |-
1951 @end example
1952
1953 @noindent and then press @key{TAB} to align the table and start filling in
1954 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
1955 @kbd{C-c @key{RET}}.
1956
1957 @vindex org-enable-table-editor
1958 @vindex org-table-auto-blank-field
1959 When typing text into a field, Org treats @key{DEL},
1960 @key{Backspace}, and all character keys in a special way, so that
1961 inserting and deleting avoids shifting other fields.  Also, when
1962 typing @emph{immediately after the cursor was moved into a new field
1963 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1964 field is automatically made blank.  If this behavior is too
1965 unpredictable for you, configure the variables
1966 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1967
1968 @table @kbd
1969 @tsubheading{Creation and conversion}
1970 @orgcmd{C-c |,org-table-create-or-convert-from-region}
1971 Convert the active region to table.  If every line contains at least one
1972 TAB character, the function assumes that the material is tab separated.
1973 If every line contains a comma, comma-separated values (CSV) are assumed.
1974 If not, lines are split at whitespace into fields.  You can use a prefix
1975 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1976 C-u} forces TAB, and a numeric argument N indicates that at least N
1977 consecutive spaces, or alternatively a TAB will be the separator.
1978 @*
1979 If there is no active region, this command creates an empty Org
1980 table.  But it is easier just to start typing, like
1981 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1982
1983 @tsubheading{Re-aligning and field motion}
1984 @orgcmd{C-c C-c,org-table-align}
1985 Re-align the table without moving the cursor.
1986 @c
1987 @orgcmd{<TAB>,org-table-next-field}
1988 Re-align the table, move to the next field.  Creates a new row if
1989 necessary.
1990 @c
1991 @orgcmd{S-@key{TAB},org-table-previous-field}
1992 Re-align, move to previous field.
1993 @c
1994 @orgcmd{@key{RET},org-table-next-row}
1995 Re-align the table and move down to next row.  Creates a new row if
1996 necessary.  At the beginning or end of a line, @key{RET} still does
1997 NEWLINE, so it can be used to split a table.
1998 @c
1999 @orgcmd{M-a,org-table-beginning-of-field}
2000 Move to beginning of the current table field, or on to the previous field.
2001 @orgcmd{M-e,org-table-end-of-field}
2002 Move to end of the current table field, or on to the next field.
2003
2004 @tsubheading{Column and row editing}
2005 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2006 Move the current column left/right.
2007 @c
2008 @orgcmd{M-S-@key{left},org-table-delete-column}
2009 Kill the current column.
2010 @c
2011 @orgcmd{M-S-@key{right},org-table-insert-column}
2012 Insert a new column to the left of the cursor position.
2013 @c
2014 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2015 Move the current row up/down.
2016 @c
2017 @orgcmd{M-S-@key{up},org-table-kill-row}
2018 Kill the current row or horizontal line.
2019 @c
2020 @orgcmd{M-S-@key{down},org-table-insert-row}
2021 Insert a new row above the current row.  With a prefix argument, the line is
2022 created below the current one.
2023 @c
2024 @orgcmd{C-c -,org-table-insert-hline}
2025 Insert a horizontal line below current row.  With a prefix argument, the line
2026 is created above the current line.
2027 @c
2028 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2029 Insert a horizontal line below current row, and move the cursor into the row
2030 below that line.
2031 @c
2032 @orgcmd{C-c ^,org-table-sort-lines}
2033 Sort the table lines in the region.  The position of point indicates the
2034 column to be used for sorting, and the range of lines is the range
2035 between the nearest horizontal separator lines, or the entire table.  If
2036 point is before the first column, you will be prompted for the sorting
2037 column.  If there is an active region, the mark specifies the first line
2038 and the sorting column, while point should be in the last line to be
2039 included into the sorting.  The command prompts for the sorting type
2040 (alphabetically, numerically, or by time).  When called with a prefix
2041 argument, alphabetic sorting will be case-sensitive.
2042
2043 @tsubheading{Regions}
2044 @orgcmd{C-c C-x M-w,org-table-copy-region}
2045 Copy a rectangular region from a table to a special clipboard.  Point and
2046 mark determine edge fields of the rectangle.  If there is no active region,
2047 copy just the current field.  The process ignores horizontal separator lines.
2048 @c
2049 @orgcmd{C-c C-x C-w,org-table-cut-region}
2050 Copy a rectangular region from a table to a special clipboard, and
2051 blank all fields in the rectangle.  So this is the ``cut'' operation.
2052 @c
2053 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2054 Paste a rectangular region into a table.
2055 The upper left corner ends up in the current field.  All involved fields
2056 will be overwritten.  If the rectangle does not fit into the present table,
2057 the table is enlarged as needed.  The process ignores horizontal separator
2058 lines.
2059 @c
2060 @orgcmd{M-@key{RET},org-table-wrap-region}
2061 Split the current field at the cursor position and move the rest to the line
2062 below.  If there is an active region, and both point and mark are in the same
2063 column, the text in the column is wrapped to minimum width for the given
2064 number of lines.  A numeric prefix argument may be used to change the number
2065 of desired lines.  If there is no region, but you specify a prefix argument,
2066 the current field is made blank, and the content is appended to the field
2067 above.
2068
2069 @tsubheading{Calculations}
2070 @cindex formula, in tables
2071 @cindex calculations, in tables
2072 @cindex region, active
2073 @cindex active region
2074 @cindex transient mark mode
2075 @orgcmd{C-c +,org-table-sum}
2076 Sum the numbers in the current column, or in the rectangle defined by
2077 the active region.  The result is shown in the echo area and can
2078 be inserted with @kbd{C-y}.
2079 @c
2080 @orgcmd{S-@key{RET},org-table-copy-down}
2081 @vindex org-table-copy-increment
2082 When current field is empty, copy from first non-empty field above.  When not
2083 empty, copy current field down to next row and move cursor along with it.
2084 Depending on the variable @code{org-table-copy-increment}, integer field
2085 values will be incremented during copy.  Integers that are too large will not
2086 be incremented.  Also, a @code{0} prefix argument temporarily disables the
2087 increment.  This key is also used by shift-selection and related modes
2088 (@pxref{Conflicts}).
2089
2090 @tsubheading{Miscellaneous}
2091 @orgcmd{C-c `,org-table-edit-field}
2092 Edit the current field in a separate window.  This is useful for fields that
2093 are not fully visible (@pxref{Column width and alignment}).  When called with
2094 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2095 edited in place.  When called with two @kbd{C-u} prefixes, make the editor
2096 window follow the cursor through the table and always show the current
2097 field.  The follow mode exits automatically when the cursor leaves the table,
2098 or when you repeat this command with @kbd{C-u C-u C-c `}.
2099 @c
2100 @item M-x org-table-import
2101 Import a file as a table.  The table should be TAB or whitespace
2102 separated.  Use, for example, to import a spreadsheet table or data
2103 from a database, because these programs generally can write
2104 TAB-separated text files.  This command works by inserting the file into
2105 the buffer and then converting the region to a table.  Any prefix
2106 argument is passed on to the converter, which uses it to determine the
2107 separator.
2108 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2109 Tables can also be imported by pasting tabular text into the Org
2110 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2111 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2112 @c
2113 @item M-x org-table-export
2114 @findex org-table-export
2115 @vindex org-table-export-default-format
2116 Export the table, by default as a TAB-separated file.  Use for data
2117 exchange with, for example, spreadsheet or database programs.  The format
2118 used to export the file can be configured in the variable
2119 @code{org-table-export-default-format}.  You may also use properties
2120 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2121 name and the format for table export in a subtree.  Org supports quite
2122 general formats for exported tables.  The exporter format is the same as the
2123 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2124 detailed description.
2125 @end table
2126
2127 If you don't like the automatic table editor because it gets in your
2128 way on lines which you would like to start with @samp{|}, you can turn
2129 it off with
2130
2131 @lisp
2132 (setq org-enable-table-editor nil)
2133 @end lisp
2134
2135 @noindent Then the only table command that still works is
2136 @kbd{C-c C-c} to do a manual re-align.
2137
2138 @node Column width and alignment, Column groups, Built-in table editor, Tables
2139 @section Column width and alignment
2140 @cindex narrow columns in tables
2141 @cindex alignment in tables
2142
2143 The width of columns is automatically determined by the table editor.  And
2144 also the alignment of a column is determined automatically from the fraction
2145 of number-like versus non-number fields in the column.
2146
2147 Sometimes a single field or a few fields need to carry more text, leading to
2148 inconveniently wide columns.  Or maybe you want to make a table with several
2149 columns having a fixed width, regardless of content.  To set@footnote{This
2150 feature does not work on XEmacs.} the width of a column, one field anywhere
2151 in the column may contain just the string @samp{<N>} where @samp{N} is an
2152 integer specifying the width of the column in characters.  The next re-align
2153 will then set the width of this column to this value.
2154
2155 @example
2156 @group
2157 |---+------------------------------|               |---+--------|
2158 |   |                              |               |   | <6>    |
2159 | 1 | one                          |               | 1 | one    |
2160 | 2 | two                          |     ----\     | 2 | two    |
2161 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
2162 | 4 | four                         |               | 4 | four   |
2163 |---+------------------------------|               |---+--------|
2164 @end group
2165 @end example
2166
2167 @noindent
2168 Fields that are wider become clipped and end in the string @samp{=>}.
2169 Note that the full text is still in the buffer but is hidden.
2170 To see the full text, hold the mouse over the field---a tool-tip window
2171 will show the full content.  To edit such a field, use the command
2172 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
2173 open a new window with the full field.  Edit it and finish with @kbd{C-c
2174 C-c}.
2175
2176 @vindex org-startup-align-all-tables
2177 When visiting a file containing a table with narrowed columns, the
2178 necessary character hiding has not yet happened, and the table needs to
2179 be aligned before it looks nice.  Setting the option
2180 @code{org-startup-align-all-tables} will realign all tables in a file
2181 upon visiting, but also slow down startup.  You can also set this option
2182 on a per-file basis with:
2183
2184 @example
2185 #+STARTUP: align
2186 #+STARTUP: noalign
2187 @end example
2188
2189 If you would like to overrule the automatic alignment of number-rich columns
2190 to the right and of string-rich column to the left, you can use @samp{<r>},
2191 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2192 effect when exporting to HTML.} or @samp{<l>} in a similar fashion.  You may
2193 also combine alignment and field width like this: @samp{<l10>}.
2194
2195 Lines which only contain these formatting cookies will be removed
2196 automatically when exporting the document.
2197
2198 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2199 @section Column groups
2200 @cindex grouping columns in tables
2201
2202 When Org exports tables, it does so by default without vertical
2203 lines because that is visually more satisfying in general.  Occasionally
2204 however, vertical lines can be useful to structure a table into groups
2205 of columns, much like horizontal lines can do for groups of rows.  In
2206 order to specify column groups, you can use a special row where the
2207 first field contains only @samp{/}.  The further fields can either
2208 contain @samp{<} to indicate that this column should start a group,
2209 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2210 a group of its own.  Boundaries between column groups will upon export be
2211 marked with vertical lines.  Here is an example:
2212
2213 @example
2214 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2215 |---+-----+-----+-----+---------+------------|
2216 | / |   < |     |   > |       < |          > |
2217 | 1 |   1 |   1 |   1 |       1 |          1 |
2218 | 2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
2219 | 3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
2220 |---+-----+-----+-----+---------+------------|
2221 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2222 @end example
2223
2224 It is also sufficient to just insert the column group starters after
2225 every vertical line you would like to have:
2226
2227 @example
2228 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2229 |----+-----+-----+-----+---------+------------|
2230 | /  | <   |     |     | <       |            |
2231 @end example
2232
2233 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2234 @section The Orgtbl minor mode
2235 @cindex Orgtbl mode
2236 @cindex minor mode for tables
2237
2238 If you like the intuitive way the Org table editor works, you
2239 might also want to use it in other modes like Text mode or Mail mode.
2240 The minor mode Orgtbl mode makes this possible.  You can always toggle
2241 the mode with @kbd{M-x orgtbl-mode}.  To turn it on by default, for
2242 example in Message mode, use
2243
2244 @lisp
2245 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2246 @end lisp
2247
2248 Furthermore, with some special setup, it is possible to maintain tables
2249 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
2250 construct @LaTeX{} tables with the underlying ease and power of
2251 Orgtbl mode, including spreadsheet capabilities.  For details, see
2252 @ref{Tables in arbitrary syntax}.
2253
2254 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2255 @section The spreadsheet
2256 @cindex calculations, in tables
2257 @cindex spreadsheet capabilities
2258 @cindex @file{calc} package
2259
2260 The table editor makes use of the Emacs @file{calc} package to implement
2261 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
2262 derive fields from other fields.  While fully featured, Org's implementation
2263 is not identical to other spreadsheets.  For example, Org knows the concept
2264 of a @emph{column formula} that will be applied to all non-header fields in a
2265 column without having to copy the formula to each relevant field.  There is
2266 also a formula debugger, and a formula editor with features for highlighting
2267 fields in the table corresponding to the references at the point in the
2268 formula, moving these references by arrow keys
2269
2270 @menu
2271 * References::                  How to refer to another field or range
2272 * Formula syntax for Calc::     Using Calc to compute stuff
2273 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
2274 * Durations and time values::   How to compute durations and time values
2275 * Field and range formulas::    Formula for specific (ranges of) fields
2276 * Column formulas::             Formulas valid for an entire column
2277 * Editing and debugging formulas::  Fixing formulas
2278 * Updating the table::          Recomputing all dependent fields
2279 * Advanced features::           Field and column names, parameters and automatic recalc
2280 @end menu
2281
2282 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2283 @subsection References
2284 @cindex references
2285
2286 To compute fields in the table from other fields, formulas must
2287 reference other fields or ranges.  In Org, fields can be referenced
2288 by name, by absolute coordinates, and by relative coordinates.  To find
2289 out what the coordinates of a field are, press @kbd{C-c ?} in that
2290 field, or press @kbd{C-c @}} to toggle the display of a grid.
2291
2292 @subsubheading Field references
2293 @cindex field references
2294 @cindex references, to fields
2295
2296 Formulas can reference the value of another field in two ways.  Like in
2297 any other spreadsheet, you may reference fields with a letter/number
2298 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2299 @vindex org-table-use-standard-references
2300 However, Org prefers@footnote{Org will understand references typed by the
2301 user as @samp{B4}, but it will not use this syntax when offering a formula
2302 for editing.  You can customize this behavior using the variable
2303 @code{org-table-use-standard-references}.}  to use another, more general
2304 representation that looks like this:
2305 @example
2306 @@@var{row}$@var{column}
2307 @end example
2308
2309 Column specifications can be absolute like @code{$1},
2310 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
2311 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2312 @code{$<} and @code{$>} are immutable references to the first and last
2313 column, respectively, and you can use @code{$>>>} to indicate the third
2314 column from the right.
2315
2316 The row specification only counts data lines and ignores horizontal separator
2317 lines (hlines).  Like with columns, you can use absolute row numbers
2318 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2319 current row like @code{@@+3} or @code{@@-1}.  @code{@@<} and @code{@@>} are
2320 immutable references the first and last@footnote{For backward compatibility
2321 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2322 a stable way to the 5th and 12th field in the last row of the table.
2323 However, this syntax is deprecated, it should not be used for new documents.
2324 Use @code{@@>$} instead.} row in the table, respectively.  You may also
2325 specify the row relative to one of the hlines: @code{@@I} refers to the first
2326 hline, @code{@@II} to the second, etc@.  @code{@@-I} refers to the first such
2327 line above the current line, @code{@@+I} to the first such line below the
2328 current line.  You can also write @code{@@III+2} which is the second data line
2329 after the third hline in the table.
2330
2331 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2332 i.e. to the row/column for the field being computed.  Also, if you omit
2333 either the column or the row part of the reference, the current row/column is
2334 implied.
2335
2336 Org's references with @emph{unsigned} numbers are fixed references
2337 in the sense that if you use the same reference in the formula for two
2338 different fields, the same field will be referenced each time.
2339 Org's references with @emph{signed} numbers are floating
2340 references because the same reference operator can reference different
2341 fields depending on the field being calculated by the formula.
2342
2343 Here are a few examples:
2344
2345 @example
2346 @@2$3      @r{2nd row, 3rd column (same as @code{C2})}
2347 $5        @r{column 5 in the current row (same as @code{E&})}
2348 @@2        @r{current column, row 2}
2349 @@-1$-3    @r{the field one row up, three columns to the left}
2350 @@-I$2     @r{field just under hline above current row, column 2}
2351 @@>$5      @r{field in the last row, in column 5}
2352 @end example
2353
2354 @subsubheading Range references
2355 @cindex range references
2356 @cindex references, to ranges
2357
2358 You may reference a rectangular range of fields by specifying two field
2359 references connected by two dots @samp{..}.  If both fields are in the
2360 current row, you may simply use @samp{$2..$7}, but if at least one field
2361 is in a different row, you need to use the general @code{@@row$column}
2362 format at least for the first field (i.e the reference must start with
2363 @samp{@@} in order to be interpreted correctly).  Examples:
2364
2365 @example
2366 $1..$3        @r{first three fields in the current row}
2367 $P..$Q        @r{range, using column names (see under Advanced)}
2368 $<<<..$>>     @r{start in third column, continue to the one but last}
2369 @@2$1..@@4$3    @r{6 fields between these two fields (same as @code{A2..C4})}
2370 @@-1$-2..@@-1   @r{3 numbers from the column to the left, 2 up to current row}
2371 @@I..II        @r{between first and second hline, short for @code{@@I..@@II}}
2372 @end example
2373
2374 @noindent Range references return a vector of values that can be fed
2375 into Calc vector functions.  Empty fields in ranges are normally
2376 suppressed, so that the vector contains only the non-empty fields (but
2377 see the @samp{E} mode switch below).  If there are no non-empty fields,
2378 @samp{[0]} is returned to avoid syntax errors in formulas.
2379
2380 @subsubheading Field coordinates in formulas
2381 @cindex field coordinates
2382 @cindex coordinates, of field
2383 @cindex row, of field coordinates
2384 @cindex column, of field coordinates
2385
2386 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2387 get the row or column number of the field where the formula result goes.
2388 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2389 and @code{org-table-current-column}.  Examples:
2390
2391 @example
2392 if(@@# % 2, $#, string(""))   @r{column number on odd lines only}
2393 $3 = remote(FOO, @@@@#$2)      @r{copy column 2 from table FOO into}
2394                              @r{column 3 of the current table}
2395 @end example
2396
2397 @noindent For the second example, table FOO must have at least as many rows
2398 as the current table.  Note that this is inefficient@footnote{The computation time scales as
2399 O(N^2) because table FOO is parsed for each field to be copied.} for large
2400 number of rows.
2401
2402 @subsubheading Named references
2403 @cindex named references
2404 @cindex references, named
2405 @cindex name, of column or field
2406 @cindex constants, in calculations
2407 @cindex #+CONSTANTS
2408
2409 @vindex org-table-formula-constants
2410 @samp{$name} is interpreted as the name of a column, parameter or
2411 constant.  Constants are defined globally through the variable
2412 @code{org-table-formula-constants}, and locally (for the file) through a
2413 line like
2414
2415 @example
2416 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2417 @end example
2418
2419 @noindent
2420 @vindex constants-unit-system
2421 @pindex constants.el
2422 Also properties (@pxref{Properties and Columns}) can be used as
2423 constants in table formulas: for a property @samp{:Xyz:} use the name
2424 @samp{$PROP_Xyz}, and the property will be searched in the current
2425 outline entry and in the hierarchy above it.  If you have the
2426 @file{constants.el} package, it will also be used to resolve constants,
2427 including natural constants like @samp{$h} for Planck's constant, and
2428 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2429 supply the values of constants in two different unit systems, @code{SI}
2430 and @code{cgs}.  Which one is used depends on the value of the variable
2431 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
2432 @code{constSI} and @code{constcgs} to set this value for the current
2433 buffer.}.  Column names and parameters can be specified in special table
2434 lines.  These are described below, see @ref{Advanced features}.  All
2435 names must start with a letter, and further consist of letters and
2436 numbers.
2437
2438 @subsubheading Remote references
2439 @cindex remote references
2440 @cindex references, remote
2441 @cindex references, to a different table
2442 @cindex name, of column or field
2443 @cindex constants, in calculations
2444 @cindex #+TBLNAME
2445
2446 You may also reference constants, fields and ranges from a different table,
2447 either in the current file or even in a different file.  The syntax is
2448
2449 @example
2450 remote(NAME-OR-ID,REF)
2451 @end example
2452
2453 @noindent
2454 where NAME can be the name of a table in the current file as set by a
2455 @code{#+TBLNAME: NAME} line before the table.  It can also be the ID of an
2456 entry, even in a different file, and the reference then refers to the first
2457 table in that entry.  REF is an absolute field or range reference as
2458 described above for example @code{@@3$3} or @code{$somename}, valid in the
2459 referenced table.
2460
2461 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2462 @subsection Formula syntax for Calc
2463 @cindex formula syntax, Calc
2464 @cindex syntax, of formulas
2465
2466 A formula can be any algebraic expression understood by the Emacs
2467 @file{Calc} package.  @b{Note that @file{calc} has the
2468 non-standard convention that @samp{/} has lower precedence than
2469 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.}  Before
2470 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2471 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2472 Emacs Calc Manual}),
2473 @c FIXME:  The link to the Calc manual in HTML does not work.
2474 variable substitution takes place according to the rules described above.
2475 @cindex vectors, in table calculations
2476 The range vectors can be directly fed into the Calc vector functions
2477 like @samp{vmean} and @samp{vsum}.
2478
2479 @cindex format specifier
2480 @cindex mode, for @file{calc}
2481 @vindex org-calc-default-modes
2482 A formula can contain an optional mode string after a semicolon.  This
2483 string consists of flags to influence Calc and other modes during
2484 execution.  By default, Org uses the standard Calc modes (precision
2485 12, angular units degrees, fraction and symbolic modes off).  The display
2486 format, however, has been changed to @code{(float 8)} to keep tables
2487 compact.  The default settings can be configured using the variable
2488 @code{org-calc-default-modes}.
2489
2490 @example
2491 p20           @r{set the internal Calc calculation precision to 20 digits}
2492 n3 s3 e2 f4   @r{Normal, scientific, engineering, or fixed}
2493               @r{format of the result of Calc passed back to Org.}
2494               @r{Calc formatting is unlimited in precision as}
2495               @r{long as the Calc calculation precision is greater.}
2496 D R           @r{angle modes: degrees, radians}
2497 F S           @r{fraction and symbolic modes}
2498 N             @r{interpret all fields as numbers, use 0 for non-numbers}
2499 E             @r{keep empty fields in ranges}
2500 L             @r{literal}
2501 @end example
2502
2503 @noindent
2504 Unless you use large integer numbers or high-precision-calculation
2505 and -display for floating point numbers you may alternatively provide a
2506 @code{printf} format specifier to reformat the Calc result after it has been
2507 passed back to Org instead of letting Calc already do the
2508 formatting@footnote{The @code{printf} reformatting is limited in precision
2509 because the value passed to it is converted into an @code{integer} or
2510 @code{double}.  The @code{integer} is limited in size by truncating the
2511 signed value to 32 bits.  The @code{double} is limited in precision to 64
2512 bits overall which leaves approximately 16 significant decimal digits.}.
2513 A few examples:
2514
2515 @example
2516 $1+$2                @r{Sum of first and second field}
2517 $1+$2;%.2f           @r{Same, format result to two decimals}
2518 exp($2)+exp($1)      @r{Math functions can be used}
2519 $0;%.1f              @r{Reformat current cell to 1 decimal}
2520 ($3-32)*5/9          @r{Degrees F -> C conversion}
2521 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
2522 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
2523 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
2524 vmean($2..$7)        @r{Compute column range mean, using vector function}
2525 vmean($2..$7);EN     @r{Same, but treat empty fields as 0}
2526 taylor($3,x=7,2)     @r{Taylor series of $3, at x=7, second degree}
2527 @end example
2528
2529 Calc also contains a complete set of logical operations.  For example
2530
2531 @example
2532 if($1<20,teen,string(""))  @r{"teen" if age $1 less than 20, else empty}
2533 @end example
2534
2535 Note that you can also use two org-specific flags @code{T} and @code{t} for
2536 durations computations @ref{Durations and time values}.
2537
2538 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2539 @subsection Emacs Lisp forms as formulas
2540 @cindex Lisp forms, as table formulas
2541
2542 It is also possible to write a formula in Emacs Lisp; this can be useful for
2543 string manipulation and control structures, if Calc's functionality is not
2544 enough.  If a formula starts with a single-quote followed by an opening
2545 parenthesis, then it is evaluated as a Lisp form.  The evaluation should
2546 return either a string or a number.  Just as with @file{calc} formulas, you
2547 can specify modes and a printf format after a semicolon.  With Emacs Lisp
2548 forms, you need to be conscious about the way field references are
2549 interpolated into the form.  By default, a reference will be interpolated as
2550 a Lisp string (in double-quotes) containing the field.  If you provide the
2551 @samp{N} mode switch, all referenced elements will be numbers (non-number
2552 fields will be zero) and interpolated as Lisp numbers, without quotes.  If
2553 you provide the @samp{L} flag, all fields will be interpolated literally,
2554 without quotes.  I.e., if you want a reference to be interpreted as a string
2555 by the Lisp form, enclose the reference operator itself in double-quotes,
2556 like @code{"$3"}.  Ranges are inserted as space-separated fields, so you can
2557 embed them in list or vector syntax.  Here are a few examples---note how the
2558 @samp{N} mode is used when we do computations in Lisp:
2559
2560 @example
2561 @r{Swap the first two characters of the content of column 1}
2562   '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2563 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2564   '(+ $1 $2);N
2565 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2566   '(apply '+ '($1..$4));N
2567 @end example
2568
2569 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2570 @subsection Durations and time values
2571 @cindex Duration, computing
2572 @cindex Time, computing
2573 @vindex org-table-duration-custom-format
2574
2575 If you want to compute time values use the @code{T} flag, either in Calc
2576 formulas or Elisp formulas:
2577
2578 @example
2579 @group
2580   |  Task 1 |   Task 2 |    Total |
2581   |---------+----------+----------|
2582   |    2:12 |     1:47 | 03:59:00 |
2583   | 3:02:20 | -2:07:00 |     0.92 |
2584   #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2585 @end group
2586 @end example
2587
2588 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2589 are optional.  With the @code{T} flag, computed durations will be displayed
2590 as @code{[HH:MM:SS} (see the first formula above).  With the @code{t} flag,
2591 computed durations will be displayed according to the value of the variable
2592 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2593 will display the result as a fraction of hours (see the second formula in the
2594 example above).
2595
2596 Negative duration values can be manipulated as well, and integers will be
2597 considered as seconds in addition and subtraction.
2598
2599 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2600 @subsection Field and range formulas
2601 @cindex field formula
2602 @cindex range formula
2603 @cindex formula, for individual table field
2604 @cindex formula, for range of fields
2605
2606 To assign a formula to a particular field, type it directly into the field,
2607 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}.  When you press
2608 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2609 the formula will be stored as the formula for this field, evaluated, and the
2610 current field will be replaced with the result.
2611
2612 @cindex #+TBLFM
2613 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2614 below the table.  If you type the equation in the 4th field of the 3rd data
2615 line in the table, the formula will look like @samp{@@3$4=$1+$2}.  When
2616 inserting/deleting/swapping column and rows with the appropriate commands,
2617 @i{absolute references} (but not relative ones) in stored formulas are
2618 modified in order to still reference the same field.  To avoid this from
2619 happening, in particular in range references, anchor ranges at the table
2620 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2621 using the @code{@@I} notation.  Automatic adaptation of field references does
2622 of cause not happen if you edit the table structure with normal editing
2623 commands---then you must fix the equations yourself.
2624
2625 Instead of typing an equation into the field, you may also use the following
2626 command
2627
2628 @table @kbd
2629 @orgcmd{C-u C-c =,org-table-eval-formula}
2630 Install a new formula for the current field.  The command prompts for a
2631 formula with default taken from the @samp{#+TBLFM:} line, applies
2632 it to the current field, and stores it.
2633 @end table
2634
2635 The left-hand side of a formula can also be a special expression in order to
2636 assign the formula to a number of different fields.  There is no keyboard
2637 shortcut to enter such range formulas.  To add them, use the formula editor
2638 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2639 directly.
2640
2641 @table @code
2642 @item $2=
2643 Column formula, valid for the entire column.  This is so common that Org
2644 treats these formulas in a special way, see @ref{Column formulas}.
2645 @item @@3=
2646 Row formula, applies to all fields in the specified row.  @code{@@>=} means
2647 the last row.
2648 @item @@1$2..@@4$3=
2649 Range formula, applies to all fields in the given rectangular range.  This
2650 can also be used to assign a formula to some but not all fields in a row.
2651 @item $name=
2652 Named field, see @ref{Advanced features}.
2653 @end table
2654
2655 @node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
2656 @subsection Column formulas
2657 @cindex column formula
2658 @cindex formula, for table column
2659
2660 When you assign a formula to a simple column reference like @code{$3=}, the
2661 same formula will be used in all fields of that column, with the following
2662 very convenient exceptions: (i) If the table contains horizontal separator
2663 hlines, everything before the first such line is considered part of the table
2664 @emph{header} and will not be modified by column formulas.  (ii) Fields that
2665 already get a value from a field/range formula will be left alone by column
2666 formulas.  These conditions make column formulas very easy to use.
2667
2668 To assign a formula to a column, type it directly into any field in the
2669 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2670 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2671 the formula will be stored as the formula for the current column, evaluated
2672 and the current field replaced with the result.  If the field contains only
2673 @samp{=}, the previously stored formula for this column is used.  For each
2674 column, Org will only remember the most recently used formula.  In the
2675 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}.  The
2676 left-hand side of a column formula can not be the name of column, it must be
2677 the numeric column reference or @code{$>}.
2678
2679 Instead of typing an equation into the field, you may also use the
2680 following command:
2681
2682 @table @kbd
2683 @orgcmd{C-c =,org-table-eval-formula}
2684 Install a new formula for the current column and replace current field with
2685 the result of the formula.  The command prompts for a formula, with default
2686 taken from the @samp{#+TBLFM} line, applies it to the current field and
2687 stores it.  With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
2688 will apply it to that many consecutive fields in the current column.
2689 @end table
2690
2691 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2692 @subsection Editing and debugging formulas
2693 @cindex formula editing
2694 @cindex editing, of table formulas
2695
2696 @vindex org-table-use-standard-references
2697 You can edit individual formulas in the minibuffer or directly in the
2698 field.  Org can also prepare a special buffer with all active
2699 formulas of a table.  When offering a formula for editing, Org
2700 converts references to the standard format (like @code{B3} or @code{D&})
2701 if possible.  If you prefer to only work with the internal format (like
2702 @code{@@3$2} or @code{$4}), configure the variable
2703 @code{org-table-use-standard-references}.
2704
2705 @table @kbd
2706 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2707 Edit the formula associated with the current column/field in the
2708 minibuffer.  See @ref{Column formulas}, and @ref{Field and range formulas}.
2709 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2710 Re-insert the active formula (either a
2711 field formula, or a column formula) into the current field, so that you
2712 can edit it directly in the field.  The advantage over editing in the
2713 minibuffer is that you can use the command @kbd{C-c ?}.
2714 @orgcmd{C-c ?,org-table-field-info}
2715 While editing a formula in a table field, highlight the field(s)
2716 referenced by the reference at the cursor position in the formula.
2717 @kindex C-c @}
2718 @findex org-table-toggle-coordinate-overlays
2719 @item C-c @}
2720 Toggle the display of row and column numbers for a table, using overlays
2721 (@command{org-table-toggle-coordinate-overlays}).  These are updated each
2722 time the table is aligned; you can force it with @kbd{C-c C-c}.
2723 @kindex C-c @{
2724 @findex org-table-toggle-formula-debugger
2725 @item C-c @{
2726 Toggle the formula debugger on and off
2727 (@command{org-table-toggle-formula-debugger}).  See below.
2728 @orgcmd{C-c ',org-table-edit-formulas}
2729 Edit all formulas for the current table in a special buffer, where the
2730 formulas will be displayed one per line.  If the current field has an
2731 active formula, the cursor in the formula editor will mark it.
2732 While inside the special buffer, Org will automatically highlight
2733 any field or range reference at the cursor position.  You may edit,
2734 remove and add formulas, and use the following commands:
2735 @table @kbd
2736 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2737 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
2738 prefix, also apply the new formulas to the entire table.
2739 @orgcmd{C-c C-q,org-table-fedit-abort}
2740 Exit the formula editor without installing changes.
2741 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2742 Toggle all references in the formula editor between standard (like
2743 @code{B3}) and internal (like @code{@@3$2}).
2744 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2745 Pretty-print or indent Lisp formula at point.  When in a line containing
2746 a Lisp formula, format the formula according to Emacs Lisp rules.
2747 Another @key{TAB} collapses the formula back again.  In the open
2748 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2749 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2750 Complete Lisp symbols, just like in Emacs Lisp mode.
2751 @kindex S-@key{up}
2752 @kindex S-@key{down}
2753 @kindex S-@key{left}
2754 @kindex S-@key{right}
2755 @findex org-table-fedit-ref-up
2756 @findex org-table-fedit-ref-down
2757 @findex org-table-fedit-ref-left
2758 @findex org-table-fedit-ref-right
2759 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2760 Shift the reference at point.  For example, if the reference is
2761 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2762 This also works for relative references and for hline references.
2763 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2764 Move the test line for column formulas in the Org buffer up and
2765 down.
2766 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2767 Scroll the window displaying the table.
2768 @kindex C-c @}
2769 @findex org-table-toggle-coordinate-overlays
2770 @item C-c @}
2771 Turn the coordinate grid in the table on and off.
2772 @end table
2773 @end table
2774
2775 Making a table field blank does not remove the formula associated with
2776 the field, because that is stored in a different line (the @samp{#+TBLFM}
2777 line)---during the next recalculation the field will be filled again.
2778 To remove a formula from a field, you have to give an empty reply when
2779 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2780
2781 @kindex C-c C-c
2782 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2783 equations with @kbd{C-c C-c} in that line or with the normal
2784 recalculation commands in the table.
2785
2786 @subsubheading Debugging formulas
2787 @cindex formula debugging
2788 @cindex debugging, of table formulas
2789 When the evaluation of a formula leads to an error, the field content
2790 becomes the string @samp{#ERROR}.  If you would like see what is going
2791 on during variable substitution and calculation in order to find a bug,
2792 turn on formula debugging in the @code{Tbl} menu and repeat the
2793 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2794 field.  Detailed information will be displayed.
2795
2796 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2797 @subsection Updating the table
2798 @cindex recomputing table fields
2799 @cindex updating, table
2800
2801 Recalculation of a table is normally not automatic, but needs to be
2802 triggered by a command.  See @ref{Advanced features}, for a way to make
2803 recalculation at least semi-automatic.
2804
2805 In order to recalculate a line of a table or the entire table, use the
2806 following commands:
2807
2808 @table @kbd
2809 @orgcmd{C-c *,org-table-recalculate}
2810 Recalculate the current row by first applying the stored column formulas
2811 from left to right, and all field/range formulas in the current row.
2812 @c
2813 @kindex C-u C-c *
2814 @item C-u C-c *
2815 @kindex C-u C-c C-c
2816 @itemx C-u C-c C-c
2817 Recompute the entire table, line by line.  Any lines before the first
2818 hline are left alone, assuming that these are part of the table header.
2819 @c
2820 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2821 Iterate the table by recomputing it until no further changes occur.
2822 This may be necessary if some computed fields use the value of other
2823 fields that are computed @i{later} in the calculation sequence.
2824 @item M-x org-table-recalculate-buffer-tables
2825 @findex org-table-recalculate-buffer-tables
2826 Recompute all tables in the current buffer.
2827 @item M-x org-table-iterate-buffer-tables
2828 @findex org-table-iterate-buffer-tables
2829 Iterate all tables in the current buffer, in order to converge table-to-table
2830 dependencies.
2831 @end table
2832
2833 @node Advanced features,  , Updating the table, The spreadsheet
2834 @subsection Advanced features
2835
2836 If you want the recalculation of fields to happen automatically, or if you
2837 want to be able to assign @i{names}@footnote{Such names must start by an
2838 alphabetic character and use only alphanumeric/underscore characters.} to
2839 fields and columns, you need to reserve the first column of the table for
2840 special marking characters.
2841
2842 @table @kbd
2843 @orgcmd{C-#,org-table-rotate-recalc-marks}
2844 Rotate the calculation mark in first column through the states @samp{ },
2845 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
2846 change all marks in the region.
2847 @end table
2848
2849 Here is an example of a table that collects exam results of students and
2850 makes use of these features:
2851
2852 @example
2853 @group
2854 |---+---------+--------+--------+--------+-------+------|
2855 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2856 |---+---------+--------+--------+--------+-------+------|
2857 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
2858 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
2859 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
2860 |---+---------+--------+--------+--------+-------+------|
2861 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
2862 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
2863 |---+---------+--------+--------+--------+-------+------|
2864 |   | Average |        |        |        |  29.7 |      |
2865 | ^ |         |        |        |        |    at |      |
2866 | $ | max=50  |        |        |        |       |      |
2867 |---+---------+--------+--------+--------+-------+------|
2868 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2869 @end group
2870 @end example
2871
2872 @noindent @b{Important}: please note that for these special tables,
2873 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2874 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2875 to the field itself.  The column formulas are not applied in rows with
2876 empty first field.
2877
2878 @cindex marking characters, tables
2879 The marking characters have the following meaning:
2880 @table @samp
2881 @item !
2882 The fields in this line define names for the columns, so that you may
2883 refer to a column as @samp{$Tot} instead of @samp{$6}.
2884 @item ^
2885 This row defines names for the fields @emph{above} the row.  With such
2886 a definition, any formula in the table may use @samp{$m1} to refer to
2887 the value @samp{10}.  Also, if you assign a formula to a names field, it
2888 will be stored as @samp{$name=...}.
2889 @item _
2890 Similar to @samp{^}, but defines names for the fields in the row
2891 @emph{below}.
2892 @item $
2893 Fields in this row can define @emph{parameters} for formulas.  For
2894 example, if a field in a @samp{$} row contains @samp{max=50}, then
2895 formulas in this table can refer to the value 50 using @samp{$max}.
2896 Parameters work exactly like constants, only that they can be defined on
2897 a per-table basis.
2898 @item #
2899 Fields in this row are automatically recalculated when pressing
2900 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
2901 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
2902 lines will be left alone by this command.
2903 @item *
2904 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2905 not for automatic recalculation.  Use this when automatic
2906 recalculation slows down editing too much.
2907 @item
2908 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2909 All lines that should be recalculated should be marked with @samp{#}
2910 or @samp{*}.
2911 @item /
2912 Do not export this line.  Useful for lines that contain the narrowing
2913 @samp{<N>} markers or column group markers.
2914 @end table
2915
2916 Finally, just to whet your appetite for what can be done with the
2917 fantastic @file{calc.el} package, here is a table that computes the Taylor
2918 series of degree @code{n} at location @code{x} for a couple of
2919 functions.
2920
2921 @example
2922 @group
2923 |---+-------------+---+-----+--------------------------------------|
2924 |   | Func        | n | x   | Result                               |
2925 |---+-------------+---+-----+--------------------------------------|
2926 | # | exp(x)      | 1 | x   | 1 + x                                |
2927 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
2928 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
2929 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2930 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
2931 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
2932 |---+-------------+---+-----+--------------------------------------|
2933 #+TBLFM: $5=taylor($2,$4,$3);n3
2934 @end group
2935 @end example
2936
2937 @node Org-Plot,  , The spreadsheet, Tables
2938 @section Org-Plot
2939 @cindex graph, in tables
2940 @cindex plot tables using Gnuplot
2941 @cindex #+PLOT
2942
2943 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2944 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2945 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}.  To see
2946 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2947 on your system, then call @code{org-plot/gnuplot} on the following table.
2948
2949 @example
2950 @group
2951 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2952 | Sede      | Max cites | H-index |
2953 |-----------+-----------+---------|
2954 | Chile     |    257.72 |   21.39 |
2955 | Leeds     |    165.77 |   19.68 |
2956 | Sao Paolo |     71.00 |   11.50 |
2957 | Stockholm |    134.19 |   14.33 |
2958 | Morelia   |    257.56 |   17.67 |
2959 @end group
2960 @end example
2961
2962 Notice that Org Plot is smart enough to apply the table's headers as labels.
2963 Further control over the labels, type, content, and appearance of plots can
2964 be exercised through the @code{#+PLOT:} lines preceding a table.  See below
2965 for a complete list of Org-plot options.  For more information and examples
2966 see the Org-plot tutorial at
2967 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
2968
2969 @subsubheading Plot Options
2970
2971 @table @code
2972 @item set
2973 Specify any @command{gnuplot} option to be set when graphing.
2974
2975 @item title
2976 Specify the title of the plot.
2977
2978 @item ind
2979 Specify which column of the table to use as the @code{x} axis.
2980
2981 @item deps
2982 Specify the columns to graph as a Lisp style list, surrounded by parentheses
2983 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2984 fourth columns (defaults to graphing all other columns aside from the @code{ind}
2985 column).
2986
2987 @item type
2988 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2989
2990 @item with
2991 Specify a @code{with} option to be inserted for every col being plotted
2992 (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2993 Defaults to @code{lines}.
2994
2995 @item file
2996 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
2997
2998 @item labels
2999 List of labels to be used for the @code{deps} (defaults to the column headers
3000 if they exist).
3001
3002 @item line
3003 Specify an entire line to be inserted in the Gnuplot script.
3004
3005 @item map
3006 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3007 flat mapping rather than a @code{3d} slope.
3008
3009 @item timefmt
3010 Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
3011 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3012
3013 @item script
3014 If you want total control, you can specify a script file (place the file name
3015 between double-quotes) which will be used to plot.  Before plotting, every
3016 instance of @code{$datafile} in the specified script will be replaced with
3017 the path to the generated data file.  Note: even if you set this option, you
3018 may still want to specify the plot type, as that can impact the content of
3019 the data file.
3020 @end table
3021
3022 @node Hyperlinks, TODO Items, Tables, Top
3023 @chapter Hyperlinks
3024 @cindex hyperlinks
3025
3026 Like HTML, Org provides links inside a file, external links to
3027 other files, Usenet articles, emails, and much more.
3028
3029 @menu
3030 * Link format::                 How links in Org are formatted
3031 * Internal links::              Links to other places in the current file
3032 * External links::              URL-like links to the world
3033 * Handling links::              Creating, inserting and following
3034 * Using links outside Org::     Linking from my C source code?
3035 * Link abbreviations::          Shortcuts for writing complex links
3036 * Search options::              Linking to a specific location
3037 * Custom searches::             When the default search is not enough
3038 @end menu
3039
3040 @node Link format, Internal links, Hyperlinks, Hyperlinks
3041 @section Link format
3042 @cindex link format
3043 @cindex format, of links
3044
3045 Org will recognize plain URL-like links and activate them as
3046 clickable links.  The general link format, however, looks like this:
3047
3048 @example
3049 [[link][description]]       @r{or alternatively}           [[link]]
3050 @end example
3051
3052 @noindent
3053 Once a link in the buffer is complete (all brackets present), Org
3054 will change the display so that @samp{description} is displayed instead
3055 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3056 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
3057 which by default is an underlined face.  You can directly edit the
3058 visible part of a link.  Note that this can be either the @samp{link}
3059 part (if there is no description) or the @samp{description} part.  To
3060 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3061 cursor on the link.
3062
3063 If you place the cursor at the beginning or just behind the end of the
3064 displayed text and press @key{BACKSPACE}, you will remove the
3065 (invisible) bracket at that location.  This makes the link incomplete
3066 and the internals are again displayed as plain text.  Inserting the
3067 missing bracket hides the link internals again.  To show the
3068 internal structure of all links, use the menu entry
3069 @code{Org->Hyperlinks->Literal links}.
3070
3071 @node Internal links, External links, Link format, Hyperlinks
3072 @section Internal links
3073 @cindex internal links
3074 @cindex links, internal
3075 @cindex targets, for links
3076
3077 @cindex property, CUSTOM_ID
3078 If the link does not look like a URL, it is considered to be internal in the
3079 current file.  The most important case is a link like
3080 @samp{[[#my-custom-id]]} which will link to the entry with the
3081 @code{CUSTOM_ID} property @samp{my-custom-id}.  Such custom IDs are very good
3082 for HTML export (@pxref{HTML export}) where they produce pretty section
3083 links.  You are responsible yourself to make sure these custom IDs are unique
3084 in a file.
3085
3086 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3087 lead to a text search in the current file.
3088
3089 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3090 or with a mouse click (@pxref{Handling links}).  Links to custom IDs will
3091 point to the corresponding headline.  The preferred match for a text link is
3092 a @i{dedicated target}: the same string in double angular brackets.  Targets
3093 may be located anywhere; sometimes it is convenient to put them into a
3094 comment line.  For example
3095
3096 @example
3097 # <<My Target>>
3098 @end example
3099
3100 @noindent In HTML export (@pxref{HTML export}), such targets will become
3101 named anchors for direct access through @samp{http} links@footnote{Note that
3102 text before the first headline is usually not exported, so the first such
3103 target should be after the first headline, or in the line directly before the
3104 first headline.}.
3105
3106 If no dedicated target exists, Org will search for a headline that is exactly
3107 the link text but may also include a TODO keyword and tags@footnote{To insert
3108 a link targeting a headline, in-buffer completion can be used.  Just type a
3109 star followed by a few optional letters into the buffer and press
3110 @kbd{M-@key{TAB}}.  All headlines in the current buffer will be offered as
3111 completions.}.  In non-Org files, the search will look for the words in the
3112 link text.  In the above example the search would be for @samp{my target}.
3113
3114 Following a link pushes a mark onto Org's own mark ring.  You can
3115 return to the previous position with @kbd{C-c &}.  Using this command
3116 several times in direct succession goes back to positions recorded
3117 earlier.
3118
3119 @menu
3120 * Radio targets::               Make targets trigger links in plain text
3121 @end menu
3122
3123 @node Radio targets,  , Internal links, Internal links
3124 @subsection Radio targets
3125 @cindex radio targets
3126 @cindex targets, radio
3127 @cindex links, radio targets
3128
3129 Org can automatically turn any occurrences of certain target names
3130 in normal text into a link.  So without explicitly creating a link, the
3131 text connects to the target radioing its position.  Radio targets are
3132 enclosed by triple angular brackets.  For example, a target @samp{<<<My
3133 Target>>>} causes each occurrence of @samp{my target} in normal text to
3134 become activated as a link.  The Org file is scanned automatically
3135 for radio targets only when the file is first loaded into Emacs.  To
3136 update the target list during editing, press @kbd{C-c C-c} with the
3137 cursor on or at a target.
3138
3139 @node External links, Handling links, Internal links, Hyperlinks
3140 @section External links
3141 @cindex links, external
3142 @cindex external links
3143 @cindex links, external
3144 @cindex Gnus links
3145 @cindex BBDB links
3146 @cindex IRC links
3147 @cindex URL links
3148 @cindex file links
3149 @cindex VM links
3150 @cindex RMAIL links
3151 @cindex WANDERLUST links
3152 @cindex MH-E links
3153 @cindex USENET links
3154 @cindex SHELL links
3155 @cindex Info links
3156 @cindex Elisp links
3157
3158 Org supports links to files, websites, Usenet and email messages,
3159 BBDB database entries and links to both IRC conversations and their
3160 logs.  External links are URL-like locators.  They start with a short
3161 identifying string followed by a colon.  There can be no space after
3162 the colon.  The following list shows examples for each link type.
3163
3164 @example
3165 http://www.astro.uva.nl/~dominik          @r{on the web}
3166 doi:10.1000/182                           @r{DOI for an electronic resource}
3167 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
3168 /home/dominik/images/jupiter.jpg          @r{same as above}
3169 file:papers/last.pdf                      @r{file, relative path}
3170 ./papers/last.pdf                         @r{same as above}
3171 file:/myself@@some.where:papers/last.pdf   @r{file, path on remote machine}
3172 /myself@@some.where:papers/last.pdf        @r{same as above}
3173 file:sometextfile::NNN                    @r{file with line number to jump to}
3174 file:projects.org                         @r{another Org file}
3175 file:projects.org::some words             @r{text search in Org file}@footnote{
3176 The actual behavior of the search will depend on the value of
3177 the variable @code{org-link-search-must-match-exact-headline}.  If its value
3178 is nil, then a fuzzy text search will be done.  If it is t, then only the
3179 exact headline will be matched.  If the value is @code{'query-to-create},
3180 then an exact headline will be searched; if it is not found, then the user
3181 will be queried to create it.}
3182 file:projects.org::*task title            @r{heading search in Org file}
3183 docview:papers/last.pdf::NNN              @r{open file in doc-view mode at page NNN}
3184 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
3185 news:comp.emacs                           @r{Usenet link}
3186 mailto:adent@@galaxy.net                   @r{Mail link}
3187 vm:folder                                 @r{VM folder link}
3188 vm:folder#id                              @r{VM message link}
3189 vm://myself@@some.where.org/folder#id      @r{VM on remote machine}
3190 wl:folder                                 @r{WANDERLUST folder link}
3191 wl:folder#id                              @r{WANDERLUST message link}
3192 mhe:folder                                @r{MH-E folder link}
3193 mhe:folder#id                             @r{MH-E message link}
3194 rmail:folder                              @r{RMAIL folder link}
3195 rmail:folder#id                           @r{RMAIL message link}
3196 gnus:group                                @r{Gnus group link}
3197 gnus:group#id                             @r{Gnus article link}
3198 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
3199 irc:/irc.com/#emacs/bob                   @r{IRC link}
3200 info:org#External links                   @r{Info node link}
3201 shell:ls *.org                            @r{A shell command}
3202 elisp:org-agenda                          @r{Interactive Elisp command}
3203 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3204 @end example
3205
3206 For customizing Org to add new link types @ref{Adding hyperlink types}.
3207
3208 A link should be enclosed in double brackets and may contain a
3209 descriptive text to be displayed instead of the URL (@pxref{Link
3210 format}), for example:
3211
3212 @example
3213 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3214 @end example
3215
3216 @noindent
3217 If the description is a file name or URL that points to an image, HTML
3218 export (@pxref{HTML export}) will inline the image as a clickable
3219 button.  If there is no description at all and the link points to an
3220 image,
3221 that image will be inlined into the exported HTML file.
3222
3223 @cindex square brackets, around links
3224 @cindex plain text external links
3225 Org also finds external links in the normal text and activates them
3226 as links.  If spaces must be part of the link (for example in
3227 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3228 about the end of the link, enclose them in square brackets.
3229
3230 @node Handling links, Using links outside Org, External links, Hyperlinks
3231 @section Handling links
3232 @cindex links, handling
3233
3234 Org provides methods to create a link in the correct syntax, to
3235 insert it into an Org file, and to follow the link.
3236
3237 @table @kbd
3238 @orgcmd{C-c l,org-store-link}
3239 @cindex storing links
3240 Store a link to the current location.  This is a @emph{global} command (you
3241 must create the key binding yourself) which can be used in any buffer to
3242 create a link.  The link will be stored for later insertion into an Org
3243 buffer (see below).  What kind of link will be created depends on the current
3244 buffer:
3245
3246 @b{Org-mode buffers}@*
3247 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3248 to the target.  Otherwise it points to the current headline, which will also
3249 be the description@footnote{If the headline contains a timestamp, it will be
3250 removed from the link and result in a wrong link -- you should avoid putting
3251 timestamp in the headline.}.
3252
3253 @vindex org-link-to-org-use-id
3254 @cindex property, CUSTOM_ID
3255 @cindex property, ID
3256 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3257 will be stored.  In addition or alternatively (depending on the value of
3258 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3259 created and/or used to construct a link.  So using this command in Org
3260 buffers will potentially create two links: a human-readable from the custom
3261 ID, and one that is globally unique and works even if the entry is moved from
3262 file to file.  Later, when inserting the link, you need to decide which one
3263 to use.
3264
3265 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3266 Pretty much all Emacs mail clients are supported.  The link will point to the
3267 current article, or, in some GNUS buffers, to the group.  The description is
3268 constructed from the author and the subject.
3269
3270 @b{Web browsers: W3 and W3M}@*
3271 Here the link will be the current URL, with the page title as description.
3272
3273 @b{Contacts: BBDB}@*
3274 Links created in a BBDB buffer will point to the current entry.
3275
3276 @b{Chat: IRC}@*
3277 @vindex org-irc-link-to-logs
3278 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3279 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3280 the current conversation is created.  Otherwise an @samp{irc:/} style link to
3281 the user/channel/server under the point will be stored.
3282
3283 @b{Other files}@*
3284 For any other files, the link will point to the file, with a search string
3285 (@pxref{Search options}) pointing to the contents of the current line.  If
3286 there is an active region, the selected words will form the basis of the
3287 search string.  If the automatically created link is not working correctly or
3288 accurately enough, you can write custom functions to select the search string
3289 and to do the search for particular file types---see @ref{Custom searches}.
3290 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3291
3292 @b{Agenda view}@*
3293 When the cursor is in an agenda view, the created link points to the
3294 entry referenced by the current line.
3295
3296 @c
3297 @orgcmd{C-c C-l,org-insert-link}
3298 @cindex link completion
3299 @cindex completion, of links
3300 @cindex inserting links
3301 @vindex org-keep-stored-link-after-insertion
3302 Insert a link@footnote{ Note that you don't have to use this command to
3303 insert a link.  Links in Org are plain text, and you can type or paste them
3304 straight into the buffer.  By using this command, the links are automatically
3305 enclosed in double brackets, and you will be asked for the optional
3306 descriptive text.}.  This prompts for a link to be inserted into the buffer.
3307 You can just type a link, using text for an internal link, or one of the link
3308 type prefixes mentioned in the examples above.  The link will be inserted
3309 into the buffer@footnote{After insertion of a stored link, the link will be
3310 removed from the list of stored links.  To keep it in the list later use, use
3311 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3312 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3313 If some text was selected when this command is called, the selected text
3314 becomes the default description.
3315
3316 @b{Inserting stored links}@*
3317 All links stored during the
3318 current session are part of the history for this prompt, so you can access
3319 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3320
3321 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3322 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3323 defined through link abbreviations (@pxref{Link abbreviations}).  If you
3324 press @key{RET} after inserting only the @var{prefix}, Org will offer
3325 specific completion support for some link types@footnote{This works by
3326 calling a special function @code{org-PREFIX-complete-link}.}  For
3327 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3328 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3329 @key{RET}} you can complete contact names.
3330 @orgkey C-u C-c C-l
3331 @cindex file name completion
3332 @cindex completion, of file names
3333 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3334 a file will be inserted and you may use file name completion to select
3335 the name of the file.  The path to the file is inserted relative to the
3336 directory of the current Org file, if the linked file is in the current
3337 directory or in a sub-directory of it, or if the path is written relative
3338 to the current directory using @samp{../}.  Otherwise an absolute path
3339 is used, if possible with @samp{~/} for your home directory.  You can
3340 force an absolute path with two @kbd{C-u} prefixes.
3341 @c
3342 @item C-c C-l @ @r{(with cursor on existing link)}
3343 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3344 link and description parts of the link.
3345 @c
3346 @cindex following links
3347 @orgcmd{C-c C-o,org-open-at-point}
3348 @vindex org-file-apps
3349 @vindex org-link-frame-setup
3350 Open link at point.  This will launch a web browser for URLs (using
3351 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3352 the corresponding links, and execute the command in a shell link.  When the
3353 cursor is on an internal link, this command runs the corresponding search.
3354 When the cursor is on a TAG list in a headline, it creates the corresponding
3355 TAGS view.  If the cursor is on a timestamp, it compiles the agenda for that
3356 date.  Furthermore, it will visit text and remote files in @samp{file:} links
3357 with Emacs and select a suitable application for local non-text files.
3358 Classification of files is based on file extension only.  See option
3359 @code{org-file-apps}.  If you want to override the default application and
3360 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
3361 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3362 If the cursor is on a headline, but not on a link, offer all links in the
3363 headline and entry text.  If you want to setup the frame configuration for
3364 following links, customize @code{org-link-frame-setup}.
3365
3366 @orgkey @key{RET}
3367 @vindex org-return-follows-link
3368 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3369 the link at point.
3370 @c
3371 @kindex mouse-2
3372 @kindex mouse-1
3373 @item mouse-2
3374 @itemx mouse-1
3375 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3376 would.  Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3377 @c
3378 @kindex mouse-3
3379 @item mouse-3
3380 @vindex org-display-internal-link-with-indirect-buffer
3381 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3382 internal links to be displayed in another window@footnote{See the
3383 variable @code{org-display-internal-link-with-indirect-buffer}}.
3384 @c
3385 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3386 @cindex inlining images
3387 @cindex images, inlining
3388 @vindex org-startup-with-inline-images
3389 @cindex @code{inlineimages}, STARTUP keyword
3390 @cindex @code{noinlineimages}, STARTUP keyword
3391 Toggle the inline display of linked images.  Normally this will only inline
3392 images that have no description part in the link, i.e.@: images that will also
3393 be inlined during export.  When called with a prefix argument, also display
3394 images that do have a link description.  You can ask for inline images to be
3395 displayed at startup by configuring the variable
3396 @code{org-startup-with-inline-images}@footnote{with corresponding
3397 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3398 @orgcmd{C-c %,org-mark-ring-push}
3399 @cindex mark ring
3400 Push the current position onto the mark ring, to be able to return
3401 easily.  Commands following an internal link do this automatically.
3402 @c
3403 @orgcmd{C-c &,org-mark-ring-goto}
3404 @cindex links, returning to
3405 Jump back to a recorded position.  A position is recorded by the
3406 commands following internal links, and by @kbd{C-c %}.  Using this
3407 command several times in direct succession moves through a ring of
3408 previously recorded positions.
3409 @c
3410 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3411 @cindex links, finding next/previous
3412 Move forward/backward to the next link in the buffer.  At the limit of
3413 the buffer, the search fails once, and then wraps around.  The key
3414 bindings for this are really too long; you might want to bind this also
3415 to @kbd{C-n} and @kbd{C-p}
3416 @lisp
3417 (add-hook 'org-load-hook
3418   (lambda ()
3419     (define-key org-mode-map "\C-n" 'org-next-link)
3420     (define-key org-mode-map "\C-p" 'org-previous-link)))
3421 @end lisp
3422 @end table
3423
3424 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3425 @section Using links outside Org
3426
3427 You can insert and follow links that have Org syntax not only in
3428 Org, but in any Emacs buffer.  For this, you should create two
3429 global commands, like this (please select suitable global keys
3430 yourself):
3431
3432 @lisp
3433 (global-set-key "\C-c L" 'org-insert-link-global)
3434 (global-set-key "\C-c o" 'org-open-at-point-global)
3435 @end lisp
3436
3437 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3438 @section Link abbreviations
3439 @cindex link abbreviations
3440 @cindex abbreviation, links
3441
3442 Long URLs can be cumbersome to type, and often many similar links are
3443 needed in a document.  For this you can use link abbreviations.  An
3444 abbreviated link looks like this
3445
3446 @example
3447 [[linkword:tag][description]]
3448 @end example
3449
3450 @noindent
3451 @vindex org-link-abbrev-alist
3452 where the tag is optional.
3453 The @i{linkword} must be a word, starting with a letter, followed by
3454 letters, numbers, @samp{-}, and @samp{_}.  Abbreviations are resolved
3455 according to the information in the variable @code{org-link-abbrev-alist}
3456 that relates the linkwords to replacement text.  Here is an example:
3457
3458 @smalllisp
3459 @group
3460 (setq org-link-abbrev-alist
3461   '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3462     ("google"   . "http://www.google.com/search?q=")
3463     ("gmap"     . "http://maps.google.com/maps?q=%s")
3464     ("omap"     . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3465     ("ads"      . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3466 @end group
3467 @end smalllisp
3468
3469 If the replacement text contains the string @samp{%s}, it will be
3470 replaced with the tag.  Otherwise the tag will be appended to the string
3471 in order to create the link.  You may also specify a function that will
3472 be called with the tag as the only argument to create the link.
3473
3474 With the above setting, you could link to a specific bug with
3475 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3476 @code{[[google:OrgMode]]}, show the map location of the Free Software
3477 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3478 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3479 what the Org author is doing besides Emacs hacking with
3480 @code{[[ads:Dominik,C]]}.
3481
3482 If you need special abbreviations just for a single Org buffer, you
3483 can define them in the file with
3484
3485 @cindex #+LINK
3486 @example
3487 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
3488 #+LINK: google    http://www.google.com/search?q=%s
3489 @end example
3490
3491 @noindent
3492 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3493 complete link abbreviations.  You may also define a function
3494 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
3495 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
3496 not accept any arguments, and return the full link with prefix.
3497
3498 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3499 @section Search options in file links
3500 @cindex search option in file links
3501 @cindex file links, searching
3502
3503 File links can contain additional information to make Emacs jump to a
3504 particular location in the file when following a link.  This can be a
3505 line number or a search option after a double@footnote{For backward
3506 compatibility, line numbers can also follow a single colon.} colon.  For
3507 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3508 links}) to a file, it encodes the words in the current line as a search
3509 string that can be used to find this line back later when following the
3510 link with @kbd{C-c C-o}.
3511
3512 Here is the syntax of the different ways to attach a search to a file
3513 link, together with an explanation:
3514
3515 @example
3516 [[file:~/code/main.c::255]]
3517 [[file:~/xx.org::My Target]]
3518 [[file:~/xx.org::*My Target]]
3519 [[file:~/xx.org::#my-custom-id]]
3520 [[file:~/xx.org::/regexp/]]
3521 @end example
3522
3523 @table @code
3524 @item 255
3525 Jump to line 255.
3526 @item My Target
3527 Search for a link target @samp{<<My Target>>}, or do a text search for
3528 @samp{my target}, similar to the search in internal links, see
3529 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
3530 link will become an HTML reference to the corresponding named anchor in
3531 the linked file.
3532 @item *My Target
3533 In an Org file, restrict search to headlines.
3534 @item #my-custom-id
3535 Link to a heading with a @code{CUSTOM_ID} property
3536 @item /regexp/
3537 Do a regular expression search for @code{regexp}.  This uses the Emacs
3538 command @code{occur} to list all matches in a separate window.  If the
3539 target file is in Org-mode, @code{org-occur} is used to create a
3540 sparse tree with the matches.
3541 @c If the target file is a directory,
3542 @c @code{grep} will be used to search all files in the directory.
3543 @end table
3544
3545 As a degenerate case, a file link with an empty file name can be used
3546 to search the current file.  For example, @code{[[file:::find me]]} does
3547 a search for @samp{find me} in the current file, just as
3548 @samp{[[find me]]} would.
3549
3550 @node Custom searches,  , Search options, Hyperlinks
3551 @section Custom Searches
3552 @cindex custom search strings
3553 @cindex search strings, custom
3554
3555 The default mechanism for creating search strings and for doing the
3556 actual search related to a file link may not work correctly in all
3557 cases.  For example, Bib@TeX{} database files have many entries like
3558 @samp{year="1993"} which would not result in good search strings,
3559 because the only unique identification for a Bib@TeX{} entry is the
3560 citation key.
3561
3562 @vindex org-create-file-search-functions
3563 @vindex org-execute-file-search-functions
3564 If you come across such a problem, you can write custom functions to set
3565 the right search string for a particular file type, and to do the search
3566 for the string in the file.  Using @code{add-hook}, these functions need
3567 to be added to the hook variables
3568 @code{org-create-file-search-functions} and
3569 @code{org-execute-file-search-functions}.  See the docstring for these
3570 variables for more information.  Org actually uses this mechanism
3571 for Bib@TeX{} database files, and you can use the corresponding code as
3572 an implementation example.  See the file @file{org-bibtex.el}.
3573
3574 @node TODO Items, Tags, Hyperlinks, Top
3575 @chapter TODO items
3576 @cindex TODO items
3577
3578 Org-mode does not maintain TODO lists as separate documents@footnote{Of
3579 course, you can make a document that contains only long lists of TODO items,
3580 but this is not required.}.  Instead, TODO items are an integral part of the
3581 notes file, because TODO items usually come up while taking notes!  With Org
3582 mode, simply mark any entry in a tree as being a TODO item.  In this way,
3583 information is not duplicated, and the entire context from which the TODO
3584 item emerged is always present.
3585
3586 Of course, this technique for managing TODO items scatters them
3587 throughout your notes file.  Org-mode compensates for this by providing
3588 methods to give you an overview of all the things that you have to do.
3589
3590 @menu
3591 * TODO basics::                 Marking and displaying TODO entries
3592 * TODO extensions::             Workflow and assignments
3593 * Progress logging::            Dates and notes for progress
3594 * Priorities::                  Some things are more important than others
3595 * Breaking down tasks::         Splitting a task into manageable pieces
3596 * Checkboxes::                  Tick-off lists
3597 @end menu
3598
3599 @node TODO basics, TODO extensions, TODO Items, TODO Items
3600 @section Basic TODO functionality
3601
3602 Any headline becomes a TODO item when it starts with the word
3603 @samp{TODO}, for example:
3604
3605 @example
3606 *** TODO Write letter to Sam Fortune
3607 @end example
3608
3609 @noindent
3610 The most important commands to work with TODO entries are:
3611
3612 @table @kbd
3613 @orgcmd{C-c C-t,org-todo}
3614 @cindex cycling, of TODO states
3615 Rotate the TODO state of the current item among
3616
3617 @example
3618 ,-> (unmarked) -> TODO -> DONE --.
3619 '--------------------------------'
3620 @end example
3621
3622 The same rotation can also be done ``remotely'' from the timeline and
3623 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3624
3625 @orgkey{C-u C-c C-t}
3626 Select a specific keyword using completion or (if it has been set up)
3627 the fast selection interface.  For the latter, you need to assign keys
3628 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3629 more information.
3630
3631 @kindex S-@key{right}
3632 @kindex S-@key{left}
3633 @item S-@key{right} @ @r{/} @ S-@key{left}
3634 @vindex org-treat-S-cursor-todo-selection-as-state-change
3635 Select the following/preceding TODO state, similar to cycling.  Useful
3636 mostly if more than two TODO states are possible (@pxref{TODO
3637 extensions}).  See also @ref{Conflicts}, for a discussion of the interaction
3638 with @code{shift-selection-mode}.  See also the variable
3639 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3640 @orgcmd{C-c / t,org-show-todo-key}
3641 @cindex sparse tree, for TODO
3642 @vindex org-todo-keywords
3643 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
3644 entire buffer, but shows all TODO items (with not-DONE state) and the
3645 headings hierarchy above them.  With a prefix argument (or by using @kbd{C-c
3646 / T}), search for a specific TODO.  You will be prompted for the keyword, and
3647 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3648 entries that match any one of these keywords.  With a numeric prefix argument
3649 N, show the tree for the Nth keyword in the variable
3650 @code{org-todo-keywords}.  With two prefix arguments, find all TODO states,
3651 both un-done and done.
3652 @orgcmd{C-c a t,org-todo-list}
3653 Show the global TODO list.  Collects the TODO items (with not-DONE states)
3654 from all agenda files (@pxref{Agenda Views}) into a single buffer.  The new
3655 buffer will be in @code{agenda-mode}, which provides commands to examine and
3656 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3657 @xref{Global TODO list}, for more information.
3658 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3659 Insert a new TODO entry below the current one.
3660 @end table
3661
3662 @noindent
3663 @vindex org-todo-state-tags-triggers
3664 Changing a TODO state can also trigger tag changes.  See the docstring of the
3665 option @code{org-todo-state-tags-triggers} for details.
3666
3667 @node TODO extensions, Progress logging, TODO basics, TODO Items
3668 @section Extended use of TODO keywords
3669 @cindex extended TODO keywords
3670
3671 @vindex org-todo-keywords
3672 By default, marked TODO entries have one of only two states: TODO and
3673 DONE.  Org-mode allows you to classify TODO items in more complex ways
3674 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
3675 special setup, the TODO keyword system can work differently in different
3676 files.
3677
3678 Note that @i{tags} are another way to classify headlines in general and
3679 TODO items in particular (@pxref{Tags}).
3680
3681 @menu
3682 * Workflow states::             From TODO to DONE in steps
3683 * TODO types::                  I do this, Fred does the rest
3684 * Multiple sets in one file::   Mixing it all, and still finding your way
3685 * Fast access to TODO states::  Single letter selection of a state
3686 * Per-file keywords::           Different files, different requirements
3687 * Faces for TODO keywords::     Highlighting states
3688 * TODO dependencies::           When one task needs to wait for others
3689 @end menu
3690
3691 @node Workflow states, TODO types, TODO extensions, TODO extensions
3692 @subsection TODO keywords as workflow states
3693 @cindex TODO workflow
3694 @cindex workflow states as TODO keywords
3695
3696 You can use TODO keywords to indicate different @emph{sequential} states
3697 in the process of working on an item, for example@footnote{Changing
3698 this variable only becomes effective after restarting Org-mode in a
3699 buffer.}:
3700
3701 @lisp
3702 (setq org-todo-keywords
3703   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3704 @end lisp
3705
3706 The vertical bar separates the TODO keywords (states that @emph{need
3707 action}) from the DONE states (which need @emph{no further action}).  If
3708 you don't provide the separator bar, the last state is used as the DONE
3709 state.
3710 @cindex completion, of TODO keywords
3711 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3712 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.  You may
3713 also use a numeric prefix argument to quickly select a specific state.  For
3714 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3715 Or you can use @kbd{S-@key{left}} to go backward through the sequence.  If you
3716 define many keywords, you can use in-buffer completion
3717 (@pxref{Completion}) or even a special one-key selection scheme
3718 (@pxref{Fast access to TODO states}) to insert these words into the
3719 buffer.  Changing a TODO state can be logged with a timestamp, see
3720 @ref{Tracking TODO state changes}, for more information.
3721
3722 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3723 @subsection TODO keywords as types
3724 @cindex TODO types
3725 @cindex names as TODO keywords
3726 @cindex types as TODO keywords
3727
3728 The second possibility is to use TODO keywords to indicate different
3729 @emph{types} of action items.  For example, you might want to indicate
3730 that items are for ``work'' or ``home''.  Or, when you work with several
3731 people on a single project, you might want to assign action items
3732 directly to persons, by using their names as TODO keywords.  This would
3733 be set up like this:
3734
3735 @lisp
3736 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3737 @end lisp
3738
3739 In this case, different keywords do not indicate a sequence, but rather
3740 different types.  So the normal work flow would be to assign a task to a
3741 person, and later to mark it DONE.  Org-mode supports this style by adapting
3742 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3743 @kbd{t} command in the timeline and agenda buffers.}.  When used several
3744 times in succession, it will still cycle through all names, in order to first
3745 select the right type for a task.  But when you return to the item after some
3746 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3747 to DONE.  Use prefix arguments or completion to quickly select a specific
3748 name.  You can also review the items of a specific TODO type in a sparse tree
3749 by using a numeric prefix to @kbd{C-c / t}.  For example, to see all things
3750 Lucy has to do, you would use @kbd{C-3 C-c / t}.  To collect Lucy's items
3751 from all agenda files into a single buffer, you would use the numeric prefix
3752 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3753
3754 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3755 @subsection Multiple keyword sets in one file
3756 @cindex TODO keyword sets
3757
3758 Sometimes you may want to use different sets of TODO keywords in
3759 parallel.  For example, you may want to have the basic
3760 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3761 separate state indicating that an item has been canceled (so it is not
3762 DONE, but also does not require action).  Your setup would then look
3763 like this:
3764
3765 @lisp
3766 (setq org-todo-keywords
3767       '((sequence "TODO" "|" "DONE")
3768         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3769         (sequence "|" "CANCELED")))
3770 @end lisp
3771
3772 The keywords should all be different, this helps Org-mode to keep track
3773 of which subsequence should be used for a given entry.  In this setup,
3774 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3775 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3776 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
3777 select the correct sequence.  Besides the obvious ways like typing a
3778 keyword or using completion, you may also apply the following commands:
3779
3780 @table @kbd
3781 @kindex C-S-@key{right}
3782 @kindex C-S-@key{left}
3783 @kindex C-u C-u C-c C-t
3784 @item C-u C-u C-c C-t
3785 @itemx C-S-@key{right}
3786 @itemx C-S-@key{left}
3787 These keys jump from one TODO subset to the next.  In the above example,
3788 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3789 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3790 @code{CANCELED}.  Note that the @kbd{C-S-} key binding conflict with
3791 @code{shift-selection-mode} (@pxref{Conflicts}).
3792 @kindex S-@key{right}
3793 @kindex S-@key{left}
3794 @item S-@key{right}
3795 @itemx S-@key{left}
3796 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3797 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3798 from @code{DONE} to @code{REPORT} in the example above.  See also
3799 @ref{Conflicts}, for a discussion of the interaction with
3800 @code{shift-selection-mode}.
3801 @end table
3802
3803 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3804 @subsection Fast access to TODO states
3805
3806 If you would like to quickly change an entry to an arbitrary TODO state
3807 instead of cycling through the states, you can set up keys for
3808 single-letter access to the states.  This is done by adding the section
3809 key after each keyword, in parentheses.  For example:
3810
3811 @lisp
3812 (setq org-todo-keywords
3813       '((sequence "TODO(t)" "|" "DONE(d)")
3814         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3815         (sequence "|" "CANCELED(c)")))
3816 @end lisp
3817
3818 @vindex org-fast-tag-selection-include-todo
3819 If you then press @kbd{C-c C-t} followed by the selection key, the entry
3820 will be switched to this state.  @kbd{SPC} can be used to remove any TODO
3821 keyword from an entry.@footnote{Check also the variable
3822 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3823 state through the tags interface (@pxref{Setting tags}), in case you like to
3824 mingle the two concepts.  Note that this means you need to come up with
3825 unique keys across both sets of keywords.}
3826
3827 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3828 @subsection Setting up keywords for individual files
3829 @cindex keyword options
3830 @cindex per-file keywords
3831 @cindex #+TODO
3832 @cindex #+TYP_TODO
3833 @cindex #+SEQ_TODO
3834
3835 It can be very useful to use different aspects of the TODO mechanism in
3836 different files.  For file-local settings, you need to add special lines
3837 to the file which set the keywords and interpretation for that file
3838 only.  For example, to set one of the two examples discussed above, you
3839 need one of the following lines, starting in column zero anywhere in the
3840 file:
3841
3842 @example
3843 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3844 @end example
3845 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3846 interpretation, but it means the same as @code{#+TODO}), or
3847 @example
3848 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3849 @end example
3850
3851 A setup for using several sets in parallel would be:
3852
3853 @example
3854 #+TODO: TODO | DONE
3855 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3856 #+TODO: | CANCELED
3857 @end example
3858
3859 @cindex completion, of option keywords
3860 @kindex M-@key{TAB}
3861 @noindent To make sure you are using the correct keyword, type
3862 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3863
3864 @cindex DONE, final TODO keyword
3865 Remember that the keywords after the vertical bar (or the last keyword
3866 if no bar is there) must always mean that the item is DONE (although you
3867 may use a different word).  After changing one of these lines, use
3868 @kbd{C-c C-c} with the cursor still in the line to make the changes
3869 known to Org-mode@footnote{Org-mode parses these lines only when
3870 Org-mode is activated after visiting a file.  @kbd{C-c C-c} with the
3871 cursor in a line starting with @samp{#+} is simply restarting Org-mode
3872 for the current buffer.}.
3873
3874 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3875 @subsection Faces for TODO keywords
3876 @cindex faces, for TODO keywords
3877
3878 @vindex org-todo @r{(face)}
3879 @vindex org-done @r{(face)}
3880 @vindex org-todo-keyword-faces
3881 Org-mode highlights TODO keywords with special faces: @code{org-todo}
3882 for keywords indicating that an item still has to be acted upon, and
3883 @code{org-done} for keywords indicating that an item is finished.  If
3884 you are using more than 2 different states, you might want to use
3885 special faces for some of them.  This can be done using the variable
3886 @code{org-todo-keyword-faces}.  For example:
3887
3888 @lisp
3889 @group
3890 (setq org-todo-keyword-faces
3891       '(("TODO" . org-warning) ("STARTED" . "yellow")
3892         ("CANCELED" . (:foreground "blue" :weight bold))))
3893 @end group
3894 @end lisp
3895
3896 While using a list with face properties as shown for CANCELED @emph{should}
3897 work, this does not aways seem to be the case.  If necessary, define a
3898 special face and use that.  A string is interpreted as a color.  The variable
3899 @code{org-faces-easy-properties} determines if that color is interpreted as a
3900 foreground or a background color.
3901
3902 @node TODO dependencies,  , Faces for TODO keywords, TODO extensions
3903 @subsection TODO dependencies
3904 @cindex TODO dependencies
3905 @cindex dependencies, of TODO states
3906
3907 @vindex org-enforce-todo-dependencies
3908 @cindex property, ORDERED
3909 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3910 dependencies.  Usually, a parent TODO task should not be marked DONE until
3911 all subtasks (defined as children tasks) are marked as DONE.  And sometimes
3912 there is a logical sequence to a number of (sub)tasks, so that one task
3913 cannot be acted upon before all siblings above it are done.  If you customize
3914 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3915 from changing state to DONE while they have children that are not DONE.
3916 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3917 will be blocked until all earlier siblings are marked DONE.  Here is an
3918 example:
3919
3920 @example
3921 * TODO Blocked until (two) is done
3922 ** DONE one
3923 ** TODO two
3924
3925 * Parent
3926   :PROPERTIES:
3927   :ORDERED: t
3928   :END:
3929 ** TODO a
3930 ** TODO b, needs to wait for (a)
3931 ** TODO c, needs to wait for (a) and (b)
3932 @end example
3933
3934 @table @kbd
3935 @orgcmd{C-c C-x o,org-toggle-ordered-property}
3936 @vindex org-track-ordered-property-with-tag
3937 @cindex property, ORDERED
3938 Toggle the @code{ORDERED} property of the current entry.  A property is used
3939 for this behavior because this should be local to the current entry, not
3940 inherited like a tag.  However, if you would like to @i{track} the value of
3941 this property with a tag for better visibility, customize the variable
3942 @code{org-track-ordered-property-with-tag}.
3943 @orgkey{C-u C-u C-u C-c C-t}
3944 Change TODO state, circumventing any state blocking.
3945 @end table
3946
3947 @vindex org-agenda-dim-blocked-tasks
3948 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3949 that cannot be closed because of such dependencies will be shown in a dimmed
3950 font or even made invisible in agenda views (@pxref{Agenda Views}).
3951
3952 @cindex checkboxes and TODO dependencies
3953 @vindex org-enforce-todo-dependencies
3954 You can also block changes of TODO states by looking at checkboxes
3955 (@pxref{Checkboxes}).  If you set the variable
3956 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3957 checkboxes will be blocked from switching to DONE.
3958
3959 If you need more complex dependency structures, for example dependencies
3960 between entries in different trees or files, check out the contributed
3961 module @file{org-depend.el}.
3962
3963 @page
3964 @node Progress logging, Priorities, TODO extensions, TODO Items
3965 @section Progress logging
3966 @cindex progress logging
3967 @cindex logging, of progress
3968
3969 Org-mode can automatically record a timestamp and possibly a note when
3970 you mark a TODO item as DONE, or even each time you change the state of
3971 a TODO item.  This system is highly configurable, settings can be on a
3972 per-keyword basis and can be localized to a file or even a subtree.  For
3973 information on how to clock working time for a task, see @ref{Clocking
3974 work time}.
3975
3976 @menu
3977 * Closing items::               When was this entry marked DONE?
3978 * Tracking TODO state changes::  When did the status change?
3979 * Tracking your habits::        How consistent have you been?
3980 @end menu
3981
3982 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3983 @subsection Closing items
3984
3985 The most basic logging is to keep track of @emph{when} a certain TODO
3986 item was finished.  This is achieved with@footnote{The corresponding
3987 in-buffer setting is: @code{#+STARTUP: logdone}}
3988
3989 @lisp
3990 (setq org-log-done 'time)
3991 @end lisp
3992
3993 @noindent
3994 Then each time you turn an entry from a TODO (not-done) state into any
3995 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3996 just after the headline.  If you turn the entry back into a TODO item
3997 through further state cycling, that line will be removed again.  If you
3998 want to record a note along with the timestamp, use@footnote{The
3999 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4000
4001 @lisp
4002 (setq org-log-done 'note)
4003 @end lisp
4004
4005 @noindent
4006 You will then be prompted for a note, and that note will be stored below
4007 the entry with a @samp{Closing Note} heading.
4008
4009 In the timeline (@pxref{Timeline}) and in the agenda
4010 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4011 display the TODO items with a @samp{CLOSED} timestamp on each day,
4012 giving you an overview of what has been done.
4013
4014 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4015 @subsection Tracking TODO state changes
4016 @cindex drawer, for state change recording
4017
4018 @vindex org-log-states-order-reversed
4019 @vindex org-log-into-drawer
4020 @cindex property, LOG_INTO_DRAWER
4021 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4022 might want to keep track of when a state change occurred and maybe take a
4023 note about this change.  You can either record just a timestamp, or a
4024 time-stamped note for a change.  These records will be inserted after the
4025 headline as an itemized list, newest first@footnote{See the variable
4026 @code{org-log-states-order-reversed}}.  When taking a lot of notes, you might
4027 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4028 Customize the variable @code{org-log-into-drawer} to get this
4029 behavior---the recommended drawer for this is called @code{LOGBOOK}.  You can
4030 also overrule the setting of this variable for a subtree by setting a
4031 @code{LOG_INTO_DRAWER} property.
4032
4033 Since it is normally too much to record a note for every state, Org-mode
4034 expects configuration on a per-keyword basis for this.  This is achieved by
4035 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
4036 in parentheses after each keyword.  For example, with the setting
4037
4038 @lisp
4039 (setq org-todo-keywords
4040   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4041 @end lisp
4042
4043 @noindent
4044 @vindex org-log-done
4045 you not only define global TODO keywords and fast access keys, but also
4046 request that a time is recorded when the entry is set to
4047 DONE@footnote{It is possible that Org-mode will record two timestamps
4048 when you are using both @code{org-log-done} and state change logging.
4049 However, it will never prompt for two notes---if you have configured
4050 both, the state change recording note will take precedence and cancel
4051 the @samp{Closing Note}.}, and that a note is recorded when switching to
4052 WAIT or CANCELED.  The setting for WAIT is even more special: the
4053 @samp{!} after the slash means that in addition to the note taken when
4054 entering the state, a timestamp should be recorded when @i{leaving} the
4055 WAIT state, if and only if the @i{target} state does not configure
4056 logging for entering it.  So it has no effect when switching from WAIT
4057 to DONE, because DONE is configured to record a timestamp only.  But
4058 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4059 setting now triggers a timestamp even though TODO has no logging
4060 configured.
4061
4062 You can use the exact same syntax for setting logging preferences local
4063 to a buffer:
4064 @example
4065 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4066 @end example
4067
4068 @cindex property, LOGGING
4069 In order to define logging settings that are local to a subtree or a
4070 single item, define a LOGGING property in this entry.  Any non-empty
4071 LOGGING property resets all logging settings to nil.  You may then turn
4072 on logging for this specific tree using STARTUP keywords like
4073 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4074 settings like @code{TODO(!)}.  For example
4075
4076 @example
4077 * TODO Log each state with only a time
4078   :PROPERTIES:
4079   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4080   :END:
4081 * TODO Only log when switching to WAIT, and when repeating
4082   :PROPERTIES:
4083   :LOGGING: WAIT(@@) logrepeat
4084   :END:
4085 * TODO No logging at all
4086   :PROPERTIES:
4087   :LOGGING: nil
4088   :END:
4089 @end example
4090
4091 @node Tracking your habits,  , Tracking TODO state changes, Progress logging
4092 @subsection Tracking your habits
4093 @cindex habits
4094
4095 Org has the ability to track the consistency of a special category of TODOs,
4096 called ``habits''.  A habit has the following properties:
4097
4098 @enumerate
4099 @item
4100 You have enabled the @code{habits} module by customizing the variable
4101 @code{org-modules}.
4102 @item
4103 The habit is a TODO item, with a TODO keyword representing an open state.
4104 @item
4105 The property @code{STYLE} is set to the value @code{habit}.
4106 @item
4107 The TODO has a scheduled date, usually with a @code{.+} style repeat
4108 interval.  A @code{++} style may be appropriate for habits with time
4109 constraints, e.g., must be done on weekends, or a @code{+} style for an
4110 unusual habit that can have a backlog, e.g., weekly reports.
4111 @item
4112 The TODO may also have minimum and maximum ranges specified by using the
4113 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4114 three days, but at most every two days.
4115 @item
4116 You must also have state logging for the @code{DONE} state enabled, in order
4117 for historical data to be represented in the consistency graph.  If it is not
4118 enabled it is not an error, but the consistency graphs will be largely
4119 meaningless.
4120 @end enumerate
4121
4122 To give you an idea of what the above rules look like in action, here's an
4123 actual habit with some history:
4124
4125 @example
4126 ** TODO Shave
4127    SCHEDULED: <2009-10-17 Sat .+2d/4d>
4128    - State "DONE"       from "TODO"       [2009-10-15 Thu]
4129    - State "DONE"       from "TODO"       [2009-10-12 Mon]
4130    - State "DONE"       from "TODO"       [2009-10-10 Sat]
4131    - State "DONE"       from "TODO"       [2009-10-04 Sun]
4132    - State "DONE"       from "TODO"       [2009-10-02 Fri]
4133    - State "DONE"       from "TODO"       [2009-09-29 Tue]
4134    - State "DONE"       from "TODO"       [2009-09-25 Fri]
4135    - State "DONE"       from "TODO"       [2009-09-19 Sat]
4136    - State "DONE"       from "TODO"       [2009-09-16 Wed]
4137    - State "DONE"       from "TODO"       [2009-09-12 Sat]
4138    :PROPERTIES:
4139    :STYLE:    habit
4140    :LAST_REPEAT: [2009-10-19 Mon 00:36]
4141    :END:
4142 @end example
4143
4144 What this habit says is: I want to shave at most every 2 days (given by the
4145 @code{SCHEDULED} date and repeat interval) and at least every 4 days.  If
4146 today is the 15th, then the habit first appears in the agenda on Oct 17,
4147 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4148 after four days have elapsed.
4149
4150 What's really useful about habits is that they are displayed along with a
4151 consistency graph, to show how consistent you've been at getting that task
4152 done in the past.  This graph shows every day that the task was done over the
4153 past three weeks, with colors for each day.  The colors used are:
4154
4155 @table @code
4156 @item Blue
4157 If the task wasn't to be done yet on that day.
4158 @item Green
4159 If the task could have been done on that day.
4160 @item Yellow
4161 If the task was going to be overdue the next day.
4162 @item Red
4163 If the task was overdue on that day.
4164 @end table
4165
4166 In addition to coloring each day, the day is also marked with an asterisk if
4167 the task was actually done that day, and an exclamation mark to show where
4168 the current day falls in the graph.
4169
4170 There are several configuration variables that can be used to change the way
4171 habits are displayed in the agenda.
4172
4173 @table @code
4174 @item org-habit-graph-column
4175 The buffer column at which the consistency graph should be drawn.  This will
4176 overwrite any text in that column, so it is a good idea to keep your habits'
4177 titles brief and to the point.
4178 @item org-habit-preceding-days
4179 The amount of history, in days before today, to appear in consistency graphs.
4180 @item org-habit-following-days
4181 The number of days after today that will appear in consistency graphs.
4182 @item org-habit-show-habits-only-for-today
4183 If non-nil, only show habits in today's agenda view.  This is set to true by
4184 default.
4185 @end table
4186
4187 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4188 temporarily be disabled and they won't appear at all.  Press @kbd{K} again to
4189 bring them back.  They are also subject to tag filtering, if you have habits
4190 which should only be done in certain contexts, for example.
4191
4192 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4193 @section Priorities
4194 @cindex priorities
4195
4196 If you use Org-mode extensively, you may end up with enough TODO items that
4197 it starts to make sense to prioritize them.  Prioritizing can be done by
4198 placing a @emph{priority cookie} into the headline of a TODO item, like this
4199
4200 @example
4201 *** TODO [#A] Write letter to Sam Fortune
4202 @end example
4203
4204 @noindent
4205 @vindex org-priority-faces
4206 By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
4207 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie is
4208 treated just like priority @samp{B}.  Priorities make a difference only for
4209 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4210 have no inherent meaning to Org-mode.  The cookies can be highlighted with
4211 special faces by customizing the variable @code{org-priority-faces}.
4212
4213 Priorities can be attached to any outline node; they do not need to be TODO
4214 items.
4215
4216 @table @kbd
4217 @item @kbd{C-c ,}
4218 @kindex @kbd{C-c ,}
4219 @findex org-priority
4220 Set the priority of the current headline (@command{org-priority}).  The
4221 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4222 When you press @key{SPC} instead, the priority cookie is removed from the
4223 headline.  The priorities can also be changed ``remotely'' from the timeline
4224 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).