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