5f92e258db3630977ac0592a96ed3192c2a2baa7
[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.5
8 @set DATE March 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.  In Debian it copies the info files into the
884 correct directory and modifies the info directory file.  In many other
885 systems, the files need to be copied to the correct directory separately, and
886 @file{install-info} then only modifies the directory file.  Check your system
887 documentation to find out which of the following commands you need:
888
889 @example
890 make install-info
891 make install-info-debian
892 @end example
893
894 Then add the following line to @file{.emacs}.  It is needed so that
895 Emacs can autoload functions that are located in files not immediately loaded
896 when Org-mode starts.
897 @lisp
898 (require 'org-install)
899 @end lisp
900
901 Do not forget to activate Org as described in the following section.
902 @page
903
904 @node Activation, Feedback, Installation, Introduction
905 @section Activation
906 @cindex activation
907 @cindex autoload
908 @cindex global key bindings
909 @cindex key bindings, global
910
911 To make sure files with extension @file{.org} use Org mode, add the following
912 line to your @file{.emacs} file.
913 @lisp
914 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
915 @end lisp
916 @noindent Org mode buffers need font-lock to be turned on - this is the
917 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
918 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
919
920 The four Org commands @command{org-store-link}, @command{org-capture},
921 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
922 global keys (i.e.@: anywhere in Emacs, not just in Org buffers).  Here are
923 suggested bindings for these keys, please modify the keys to your own
924 liking.
925 @lisp
926 (global-set-key "\C-cl" 'org-store-link)
927 (global-set-key "\C-cc" 'org-capture)
928 (global-set-key "\C-ca" 'org-agenda)
929 (global-set-key "\C-cb" 'org-iswitchb)
930 @end lisp
931
932 @cindex Org-mode, turning on
933 With this setup, all files with extension @samp{.org} will be put
934 into Org-mode.  As an alternative, make the first line of a file look
935 like this:
936
937 @example
938 MY PROJECTS    -*- mode: org; -*-
939 @end example
940
941 @vindex org-insert-mode-line-in-empty-file
942 @noindent which will select Org-mode for this buffer no matter what
943 the file's name is.  See also the variable
944 @code{org-insert-mode-line-in-empty-file}.
945
946 Many commands in Org work on the region if the region is @i{active}.  To make
947 use of this, you need to have @code{transient-mark-mode}
948 (@code{zmacs-regions} in XEmacs) turned on.  In Emacs 23 this is the default,
949 in Emacs 22 you need to do this yourself with
950 @lisp
951 (transient-mark-mode 1)
952 @end lisp
953 @noindent If you do not like @code{transient-mark-mode}, you can create an
954 active region by using the mouse to select a region, or pressing
955 @kbd{C-@key{SPC}} twice before moving the cursor.
956
957 @node Feedback, Conventions, Activation, Introduction
958 @section Feedback
959 @cindex feedback
960 @cindex bug reports
961 @cindex maintainer
962 @cindex author
963
964 If you find problems with Org, or if you have questions, remarks, or ideas
965 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
966 If you are not a member of the mailing list, your mail will be passed to the
967 list after a moderator has approved it@footnote{Please consider subscribing
968 to the mailing list, in order to minimize the work the mailing list
969 moderators have to do.}.
970
971 For bug reports, please first try to reproduce the bug with the latest
972 version of Org available---if you are running an outdated version, it is
973 quite possible that the bug has been fixed already.  If the bug persists,
974 prepare a report and provide as much information as possible, including the
975 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
976 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
977 @file{.emacs}.  The easiest way to do this is to use the command
978 @example
979 @kbd{M-x org-submit-bug-report}
980 @end example
981 @noindent which will put all this information into an Emacs mail buffer so
982 that you only need to add your description.  If you re not sending the Email
983 from within Emacs, please copy and paste the content into your Email program.
984
985 If an error occurs, a backtrace can be very useful (see below on how to
986 create one).  Often a small example file helps, along with clear information
987 about:
988
989 @enumerate
990 @item What exactly did you do?
991 @item What did you expect to happen?
992 @item What happened instead?
993 @end enumerate
994 @noindent Thank you for helping to improve this program.
995
996 @subsubheading How to create a useful backtrace
997
998 @cindex backtrace of an error
999 If working with Org produces an error with a message you don't
1000 understand, you may have hit a bug.  The best way to report this is by
1001 providing, in addition to what was mentioned above, a @emph{backtrace}.
1002 This is information from the built-in debugger about where and how the
1003 error occurred.  Here is how to produce a useful backtrace:
1004
1005 @enumerate
1006 @item
1007 Reload uncompiled versions of all Org-mode Lisp files.  The backtrace
1008 contains much more information if it is produced with uncompiled code.
1009 To do this, use
1010 @example
1011 C-u M-x org-reload RET
1012 @end example
1013 @noindent
1014 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1015 menu.
1016 @item
1017 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1018 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1019 @item
1020 Do whatever you have to do to hit the error.  Don't forget to
1021 document the steps you take.
1022 @item
1023 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1024 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
1025 attach it to your bug report.
1026 @end enumerate
1027
1028 @node Conventions,  , Feedback, Introduction
1029 @section Typesetting conventions used in this manual
1030
1031 Org uses three types of keywords: TODO keywords, tags, and property
1032 names.  In this manual we use the following conventions:
1033
1034 @table @code
1035 @item TODO
1036 @itemx WAITING
1037 TODO keywords are written with all capitals, even if they are
1038 user-defined.
1039 @item boss
1040 @itemx ARCHIVE
1041 User-defined tags are written in lowercase; built-in tags with special
1042 meaning are written with all capitals.
1043 @item Release
1044 @itemx PRIORITY
1045 User-defined properties are capitalized; built-in properties with
1046 special meaning are written with all capitals.
1047 @end table
1048
1049 The manual lists both the keys and the corresponding commands for accessing
1050 functionality.  Org mode often uses the same key for different functions,
1051 depending on context.  The command that is bound to such keys has a generic
1052 name, like @code{org-metaright}.  In the manual we will, wherever possible,
1053 give the function that is internally called by the generic command.  For
1054 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1055 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1056 be listed to call org-table-move-column-right.
1057
1058 If you prefer, you can compile the manual without the command names by
1059 unsetting the flag @code{cmdnames} in @file{org.texi}.
1060
1061 @node Document Structure, Tables, Introduction, Top
1062 @chapter Document structure
1063 @cindex document structure
1064 @cindex structure of document
1065
1066 Org is based on Outline mode and provides flexible commands to
1067 edit the structure of the document.
1068
1069 @menu
1070 * Outlines::                    Org is based on Outline mode
1071 * Headlines::                   How to typeset Org tree headlines
1072 * Visibility cycling::          Show and hide, much simplified
1073 * Motion::                      Jumping to other headlines
1074 * Structure editing::           Changing sequence and level of headlines
1075 * Sparse trees::                Matches embedded in context
1076 * Plain lists::                 Additional structure within an entry
1077 * Drawers::                     Tucking stuff away
1078 * Blocks::                      Folding blocks
1079 * Footnotes::                   How footnotes are defined in Org's syntax
1080 * Orgstruct mode::              Structure editing outside Org
1081 @end menu
1082
1083 @node Outlines, Headlines, Document Structure, Document Structure
1084 @section Outlines
1085 @cindex outlines
1086 @cindex Outline mode
1087
1088 Org is implemented on top of Outline mode.  Outlines allow a
1089 document to be organized in a hierarchical structure, which (at least
1090 for me) is the best representation of notes and thoughts.  An overview
1091 of this structure is achieved by folding (hiding) large parts of the
1092 document to show only the general document structure and the parts
1093 currently being worked on.  Org greatly simplifies the use of
1094 outlines by compressing the entire show/hide functionality into a single
1095 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1096
1097 @node Headlines, Visibility cycling, Outlines, Document Structure
1098 @section Headlines
1099 @cindex headlines
1100 @cindex outline tree
1101 @vindex org-special-ctrl-a/e
1102 @vindex org-special-ctrl-k
1103 @vindex org-ctrl-k-protect-subtree
1104
1105 Headlines define the structure of an outline tree.  The headlines in Org
1106 start with one or more stars, on the left margin@footnote{See the variables
1107 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1108 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1109 @kbd{C-e}, and @kbd{C-k} in headlines.}.  For example:
1110
1111 @example
1112 * Top level headline
1113 ** Second level
1114 *** 3rd level
1115     some text
1116 *** 3rd level
1117     more text
1118
1119 * Another top level headline
1120 @end example
1121
1122 @noindent Some people find the many stars too noisy and would prefer an
1123 outline that has whitespace followed by a single star as headline
1124 starters.  @ref{Clean view}, describes a setup to realize this.
1125
1126 @vindex org-cycle-separator-lines
1127 An empty line after the end of a subtree is considered part of it and
1128 will be hidden when the subtree is folded.  However, if you leave at
1129 least two empty lines, one empty line will remain visible after folding
1130 the subtree, in order to structure the collapsed view.  See the
1131 variable @code{org-cycle-separator-lines} to modify this behavior.
1132
1133 @node Visibility cycling, Motion, Headlines, Document Structure
1134 @section Visibility cycling
1135 @cindex cycling, visibility
1136 @cindex visibility cycling
1137 @cindex trees, visibility
1138 @cindex show hidden text
1139 @cindex hide text
1140
1141 Outlines make it possible to hide parts of the text in the buffer.
1142 Org uses just two commands, bound to @key{TAB} and
1143 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1144
1145 @cindex subtree visibility states
1146 @cindex subtree cycling
1147 @cindex folded, subtree visibility state
1148 @cindex children, subtree visibility state
1149 @cindex subtree, subtree visibility state
1150 @table @asis
1151 @orgcmd{@key{TAB},org-cycle}
1152 @emph{Subtree cycling}: Rotate current subtree among the states
1153
1154 @example
1155 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1156 '-----------------------------------'
1157 @end example
1158
1159 @vindex org-cycle-emulate-tab
1160 @vindex org-cycle-global-at-bob
1161 The cursor must be on a headline for this to work@footnote{see, however,
1162 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
1163 beginning of the buffer and the first line is not a headline, then
1164 @key{TAB} actually runs global cycling (see below)@footnote{see the
1165 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
1166 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1167
1168 @cindex global visibility states
1169 @cindex global cycling
1170 @cindex overview, global visibility state
1171 @cindex contents, global visibility state
1172 @cindex show all, global visibility state
1173 @orgcmd{S-@key{TAB},org-global-cycle}
1174 @itemx C-u @key{TAB}
1175 @emph{Global cycling}: Rotate the entire buffer among the states
1176
1177 @example
1178 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1179 '--------------------------------------'
1180 @end example
1181
1182 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1183 CONTENTS view up to headlines of level N will be shown.  Note that inside
1184 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1185
1186 @cindex show all, command
1187 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1188 Show all, including drawers.
1189 @orgcmd{C-c C-r,org-reveal}
1190 Reveal context around point, showing the current entry, the following heading
1191 and the hierarchy above.  Useful for working near a location that has been
1192 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1193 (@pxref{Agenda commands}).  With a prefix argument show, on each
1194 level, all sibling headings.  With double prefix arg, also show the entire
1195 subtree of the parent.
1196 @orgcmd{C-c C-k,show-branches}
1197 Expose all the headings of the subtree, CONTENT view for just one subtree.
1198 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1199 Show the current subtree in an indirect buffer@footnote{The indirect
1200 buffer
1201 @ifinfo
1202 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1203 @end ifinfo
1204 @ifnotinfo
1205 (see the Emacs manual for more information about indirect buffers)
1206 @end ifnotinfo
1207 will contain the entire buffer, but will be narrowed to the current
1208 tree.  Editing the indirect buffer will also change the original buffer,
1209 but without affecting visibility in that buffer.}.  With a numeric
1210 prefix argument N, go up to level N and then take that tree.  If N is
1211 negative then go up that many levels.  With a @kbd{C-u} prefix, do not remove
1212 the previously used indirect buffer.
1213 @end table
1214
1215 @vindex org-startup-folded
1216 @cindex @code{overview}, STARTUP keyword
1217 @cindex @code{content}, STARTUP keyword
1218 @cindex @code{showall}, STARTUP keyword
1219 @cindex @code{showeverything}, STARTUP keyword
1220
1221 When Emacs first visits an Org file, the global state is set to
1222 OVERVIEW, i.e.@: only the top level headlines are visible.  This can be
1223 configured through the variable @code{org-startup-folded}, or on a
1224 per-file basis by adding one of the following lines anywhere in the
1225 buffer:
1226
1227 @example
1228 #+STARTUP: overview
1229 #+STARTUP: content
1230 #+STARTUP: showall
1231 #+STARTUP: showeverything
1232 @end example
1233
1234 @cindex property, VISIBILITY
1235 @noindent
1236 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1237 and Columns}) will get their visibility adapted accordingly.  Allowed values
1238 for this property are @code{folded}, @code{children}, @code{content}, and
1239 @code{all}.
1240 @table @asis
1241 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1242 Switch back to the startup visibility of the buffer, i.e.@: whatever is
1243 requested by startup options and @samp{VISIBILITY} properties in individual
1244 entries.
1245 @end table
1246
1247 @node Motion, Structure editing, Visibility cycling, Document Structure
1248 @section Motion
1249 @cindex motion, between headlines
1250 @cindex jumping, to headlines
1251 @cindex headline navigation
1252 The following commands jump to other headlines in the buffer.
1253
1254 @table @asis
1255 @orgcmd{C-c C-n,outline-next-visible-heading}
1256 Next heading.
1257 @orgcmd{C-c C-p,outline-previous-visible-heading}
1258 Previous heading.
1259 @orgcmd{C-c C-f,org-forward-same-level}
1260 Next heading same level.
1261 @orgcmd{C-c C-b,org-backward-same-level}
1262 Previous heading same level.
1263 @orgcmd{C-c C-u,outline-up-heading}
1264 Backward to higher level heading.
1265 @orgcmd{C-c C-j,org-goto}
1266 Jump to a different place without changing the current outline
1267 visibility.  Shows the document structure in a temporary buffer, where
1268 you can use the following keys to find your destination:
1269 @vindex org-goto-auto-isearch
1270 @example
1271 @key{TAB}         @r{Cycle visibility.}
1272 @key{down} / @key{up}   @r{Next/previous visible headline.}
1273 @key{RET}         @r{Select this location.}
1274 @kbd{/}           @r{Do a Sparse-tree search}
1275 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1276 n / p        @r{Next/previous visible headline.}
1277 f / b        @r{Next/previous headline same level.}
1278 u            @r{One level up.}
1279 0-9          @r{Digit argument.}
1280 q            @r{Quit}
1281 @end example
1282 @vindex org-goto-interface
1283 @noindent
1284 See also the variable @code{org-goto-interface}.
1285 @end table
1286
1287 @node Structure editing, Sparse trees, Motion, Document Structure
1288 @section Structure editing
1289 @cindex structure editing
1290 @cindex headline, promotion and demotion
1291 @cindex promotion, of subtrees
1292 @cindex demotion, of subtrees
1293 @cindex subtree, cut and paste
1294 @cindex pasting, of subtrees
1295 @cindex cutting, of subtrees
1296 @cindex copying, of subtrees
1297 @cindex sorting, of subtrees
1298 @cindex subtrees, cut and paste
1299
1300 @table @asis
1301 @orgcmd{M-@key{RET},org-insert-heading}
1302 @vindex org-M-RET-may-split-line
1303 Insert new heading with same level as current.  If the cursor is in a plain
1304 list item, a new item is created (@pxref{Plain lists}).  To force creation of
1305 a new headline, use a prefix argument.  When this command is used in the
1306 middle of a line, the line is split and the rest of the line becomes the new
1307 headline@footnote{If you do not want the line to be split, customize the
1308 variable @code{org-M-RET-may-split-line}.}.  If the command is used at the
1309 beginning of a headline, the new headline is created before the current line.
1310 If at the beginning of any other line, the content of that line is made the
1311 new heading.  If the command is used at the end of a folded subtree (i.e.@:
1312 behind the ellipses at the end of a headline), then a headline like the
1313 current one will be inserted after the end of the subtree.
1314 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1315 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1316 current heading, the new heading is placed after the body instead of before
1317 it.  This command works from anywhere in the entry.
1318 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1319 @vindex org-treat-insert-todo-heading-as-state-change
1320 Insert new TODO entry with same level as current heading.  See also the
1321 variable @code{org-treat-insert-todo-heading-as-state-change}.
1322 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1323 Insert new TODO entry with same level as current heading.  Like
1324 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1325 subtree.
1326 @orgcmd{@key{TAB},org-cycle}
1327 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1328 become a child of the previous one.  The next @key{TAB} makes it a parent,
1329 and so on, all the way to top level.  Yet another @key{TAB}, and you are back
1330 to the initial level.
1331 @orgcmd{M-@key{left},org-do-promote}
1332 Promote current heading by one level.
1333 @orgcmd{M-@key{right},org-do-demote}
1334 Demote current heading by one level.
1335 @orgcmd{M-S-@key{left},org-promote-subtree}
1336 Promote the current subtree by one level.
1337 @orgcmd{M-S-@key{right},org-demote-subtree}
1338 Demote the current subtree by one level.
1339 @orgcmd{M-S-@key{up},org-move-subtree-up}
1340 Move subtree up (swap with previous subtree of same
1341 level).
1342 @orgcmd{M-S-@key{down},org-move-subtree-down}
1343 Move subtree down (swap with next subtree of same level).
1344 @orgcmd{C-c C-x C-w,org-cut-subtree}
1345 Kill subtree, i.e.@: remove it from buffer but save in kill ring.
1346 With a numeric prefix argument N, kill N sequential subtrees.
1347 @orgcmd{C-c C-x M-w,org-copy-subtree}
1348 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
1349 sequential subtrees.
1350 @orgcmd{C-c C-x C-y,org-paste-subtree}
1351 Yank subtree from kill ring.  This does modify the level of the subtree to
1352 make sure the tree fits in nicely at the yank position.  The yank level can
1353 also be specified with a numeric prefix argument, or by yanking after a
1354 headline marker like @samp{****}.
1355 @orgcmd{C-y,org-yank}
1356 @vindex org-yank-adjusted-subtrees
1357 @vindex org-yank-folded-subtrees
1358 Depending on the variables @code{org-yank-adjusted-subtrees} and
1359 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1360 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1361 C-x C-y}.  With the default settings, no level adjustment will take place,
1362 but the yanked tree will be folded unless doing so would swallow text
1363 previously visible.  Any prefix argument to this command will force a normal
1364 @code{yank} to be executed, with the prefix passed along.  A good way to
1365 force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
1366 yank, it will yank previous kill items plainly, without adjustment and
1367 folding.
1368 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1369 Clone a subtree by making a number of sibling copies of it.  You will be
1370 prompted for the number of copies to make, and you can also specify if any
1371 timestamps in the entry should be shifted.  This can be useful, for example,
1372 to create a number of tasks related to a series of lectures to prepare.  For
1373 more details, see the docstring of the command
1374 @code{org-clone-subtree-with-time-shift}.
1375 @orgcmd{C-c C-w,org-refile}
1376 Refile entry or region to a different location.  @xref{Refiling notes}.
1377 @orgcmd{C-c ^,org-sort-entries-or-items}
1378 Sort same-level entries.  When there is an active region, all entries in the
1379 region will be sorted.  Otherwise the children of the current headline are
1380 sorted.  The command prompts for the sorting method, which can be
1381 alphabetically, numerically, by time (first timestamp with active preferred,
1382 creation time, scheduled time, deadline time), by priority, by TODO keyword
1383 (in the sequence the keywords have been defined in the setup) or by the value
1384 of a property.  Reverse sorting is possible as well.  You can also supply
1385 your own function to extract the sorting key.  With a @kbd{C-u} prefix,
1386 sorting will be case-sensitive.  With two @kbd{C-u C-u} prefixes, duplicate
1387 entries will also be removed.
1388 @orgcmd{C-x n s,org-narrow-to-subtree}
1389 Narrow buffer to current subtree.
1390 @orgcmd{C-x n b,org-narrow-to-block}
1391 Narrow buffer to current block.
1392 @orgcmd{C-x n w,widen}
1393 Widen buffer to remove narrowing.
1394 @orgcmd{C-c *,org-toggle-heading}
1395 Turn a normal line or plain list item into a headline (so that it becomes a
1396 subheading at its location).  Also turn a headline into a normal line by
1397 removing the stars.  If there is an active region, turn all lines in the
1398 region into headlines.  If the first line in the region was an item, turn
1399 only the item lines into headlines.  Finally, if the first line is a
1400 headline, remove the stars from all headlines in the region.
1401 @end table
1402
1403 @cindex region, active
1404 @cindex active region
1405 @cindex transient mark mode
1406 When there is an active region (Transient Mark mode), promotion and
1407 demotion work on all headlines in the region.  To select a region of
1408 headlines, it is best to place both point and mark at the beginning of a
1409 line, mark at the beginning of the first headline, and point at the line
1410 just after the last headline to change.  Note that when the cursor is
1411 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1412 functionality.
1413
1414
1415 @node Sparse trees, Plain lists, Structure editing, Document Structure
1416 @section Sparse trees
1417 @cindex sparse trees
1418 @cindex trees, sparse
1419 @cindex folding, sparse trees
1420 @cindex occur, command
1421
1422 @vindex org-show-hierarchy-above
1423 @vindex org-show-following-heading
1424 @vindex org-show-siblings
1425 @vindex org-show-entry-below
1426 An important feature of Org-mode is the ability to construct @emph{sparse
1427 trees} for selected information in an outline tree, so that the entire
1428 document is folded as much as possible, but the selected information is made
1429 visible along with the headline structure above it@footnote{See also the
1430 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1431 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1432 control on how much context is shown around each match.}.  Just try it out
1433 and you will see immediately how it works.
1434
1435 Org-mode contains several commands creating such trees, all these
1436 commands can be accessed through a dispatcher:
1437
1438 @table @asis
1439 @orgcmd{C-c /,org-sparse-tree}
1440 This prompts for an extra key to select a sparse-tree creating command.
1441 @orgcmd{C-c / r,org-occur}
1442 @vindex org-remove-highlights-with-change
1443 Prompts for a regexp and shows a sparse tree with all matches.  If
1444 the match is in a headline, the headline is made visible.  If the match is in
1445 the body of an entry, headline and body are made visible.  In order to
1446 provide minimal context, also the full hierarchy of headlines above the match
1447 is shown, as well as the headline following the match.  Each match is also
1448 highlighted; the highlights disappear when the buffer is changed by an
1449 editing command@footnote{This depends on the option
1450 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1451 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1452 so several calls to this command can be stacked.
1453 @orgcmdkkc{M-g n,M-g M-n,next-error}
1454 Jump to the next sparse tree match in this buffer.
1455 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1456 Jump to the previous sparse tree match in this buffer.
1457 @end table
1458
1459
1460 @noindent
1461 @vindex org-agenda-custom-commands
1462 For frequently used sparse trees of specific search strings, you can
1463 use the variable @code{org-agenda-custom-commands} to define fast
1464 keyboard access to specific sparse trees.  These commands will then be
1465 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1466 For example:
1467
1468 @lisp
1469 (setq org-agenda-custom-commands
1470       '(("f" occur-tree "FIXME")))
1471 @end lisp
1472
1473 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1474 a sparse tree matching the string @samp{FIXME}.
1475
1476 The other sparse tree commands select headings based on TODO keywords,
1477 tags, or properties and will be discussed later in this manual.
1478
1479 @kindex C-c C-e v
1480 @cindex printing sparse trees
1481 @cindex visible text, printing
1482 To print a sparse tree, you can use the Emacs command
1483 @code{ps-print-buffer-with-faces} which does not print invisible parts
1484 of the document @footnote{This does not work under XEmacs, because
1485 XEmacs uses selective display for outlining, not text properties.}.
1486 Or you can use the command @kbd{C-c C-e v} to export only the visible
1487 part of the document and print the resulting file.
1488
1489 @node Plain lists, Drawers, Sparse trees, Document Structure
1490 @section Plain lists
1491 @cindex plain lists
1492 @cindex lists, plain
1493 @cindex lists, ordered
1494 @cindex ordered lists
1495
1496 Within an entry of the outline tree, hand-formatted lists can provide
1497 additional structure.  They also provide a way to create lists of checkboxes
1498 (@pxref{Checkboxes}).  Org supports editing such lists, and every exporter
1499 (@pxref{Exporting}) can parse and format them.
1500
1501 Org knows ordered lists, unordered lists, and description lists.
1502 @itemize @bullet
1503 @item
1504 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1505 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1506 they will be seen as top-level headlines.  Also, when you are hiding leading
1507 stars to get a clean outline view, plain list items starting with a star may
1508 be hard to distinguish from true headlines.  In short: even though @samp{*}
1509 is supported, it may be better to not use it for plain list items.}  as
1510 bullets.
1511 @item
1512 @vindex org-plain-list-ordered-item-terminator
1513 @vindex org-alphabetical-lists
1514 @emph{Ordered} list items start with a numeral followed by either a period or
1515 a right parenthesis@footnote{You can filter out any of them by configuring
1516 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1517 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1518 @samp{A)} by configuring @code{org-alphabetical-lists}.  To minimize
1519 confusion with normal text, those are limited to one character only.  Beyond
1520 that limit, bullets will automatically fallback to numbers.}.  If you want a
1521 list to start with a different value (e.g.@: 20), start the text of the item
1522 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1523 must be put @emph{before} the checkbox.  If you have activated alphabetical
1524 lists, you can also use counters like @code{[@@b]}.}.  Those constructs can
1525 be used in any item of the list in order to enforce a particular numbering.
1526 @item
1527 @emph{Description} list items are unordered list items, and contain the
1528 separator @samp{ :: } to distinguish the description @emph{term} from the
1529 description.
1530 @end itemize
1531
1532 Items belonging to the same list must have the same indentation on the first
1533 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1534 2--digit numbers must be written left-aligned with the other numbers in the
1535 list.  An item ends before the next line that is less or equally indented
1536 than its bullet/number.
1537
1538 @vindex org-list-ending-method
1539 @vindex org-list-end-regexp
1540 @vindex org-empty-line-terminates-plain-lists
1541 Two methods@footnote{To disable either of them, configure
1542 @code{org-list-ending-method}.} are provided to terminate lists.  A list ends
1543 whenever every item has ended, which means before any line less or equally
1544 indented than items at top level.  It also ends before two blank
1545 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}.  In
1546 that case, all items are closed.  For finer control, you can end lists with
1547 any pattern set in @code{org-list-end-regexp}.  Here is an example:
1548
1549 @example
1550 @group
1551 ** Lord of the Rings
1552    My favorite scenes are (in this order)
1553    1. The attack of the Rohirrim
1554    2. Eowyn's fight with the witch king
1555       + this was already my favorite scene in the book
1556       + I really like Miranda Otto.
1557    3. Peter Jackson being shot by Legolas
1558       - on DVD only
1559       He makes a really funny face when it happens.
1560    But in the end, no individual scenes matter but the film as a whole.
1561    Important actors in this film are:
1562    - @b{Elijah Wood} :: He plays Frodo
1563    - @b{Sean Austin} :: He plays Sam, Frodo's friend.  I still remember
1564      him very well from his role as Mikey Walsh in @i{The Goonies}.
1565 @end group
1566 @end example
1567
1568 Org supports these lists by tuning filling and wrapping commands to deal with
1569 them correctly@footnote{Org only changes the filling settings for Emacs.  For
1570 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}.  To turn this on,
1571 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1572 properly (@pxref{Exporting}).  Since indentation is what governs the
1573 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1574 blocks can be indented to signal that they belong to a particular item.
1575
1576 @vindex org-list-demote-modify-bullet
1577 If you find that using a different bullet for a sub-list (than that used for
1578 the current list-level) improves readability, customize the variable
1579 @code{org-list-demote-modify-bullet}.
1580
1581 @vindex org-list-automatic-rules
1582 The following commands act on items when the cursor is in the first line of
1583 an item (the line with the bullet or number).  Some of them imply the
1584 application of automatic rules to keep list structure intact.  If some of
1585 these actions get in your way, configure @code{org-list-automatic-rules}
1586 to disable them individually.
1587
1588 @table @asis
1589 @orgcmd{@key{TAB},org-cycle}
1590 @vindex org-cycle-include-plain-lists
1591 Items can be folded just like headline levels.  Normally this works only if
1592 the cursor is on a plain list item.  For more details, see the variable
1593 @code{org-cycle-include-plain-lists}.  If this variable is set to
1594 @code{integrate}, plain list items will be treated like low-level
1595 headlines.  The level of an item is then given by the
1596 indentation of the bullet/number.  Items are always subordinate to real
1597 headlines, however; the hierarchies remain completely separated.
1598 @orgcmd{M-@key{RET},org-insert-heading}
1599 @vindex org-M-RET-may-split-line
1600 @vindex org-list-automatic-rules
1601 Insert new item at current level.  With a prefix argument, force a new
1602 heading (@pxref{Structure editing}).  If this command is used in the middle
1603 of an item, that item is @emph{split} in two, and the second part becomes the
1604 new item@footnote{If you do not want the item to be split, customize the
1605 variable @code{org-M-RET-may-split-line}.}.  If this command is executed
1606 @emph{before item's body}, the new item is created @emph{before} the current
1607 one.
1608 @kindex M-S-@key{RET}
1609 @item M-S-@key{RET}
1610 Insert a new item with a checkbox (@pxref{Checkboxes}).
1611 @orgcmd{@key{TAB},org-cycle}
1612 In a new item with no text yet, the first @key{TAB} demotes the item to
1613 become a child of the previous one.  Subsequent @key{TAB}s move the item to
1614 meaningful levels in the list and eventually get it back to its initial
1615 position.
1616 @kindex S-@key{down}
1617 @item S-@key{up}
1618 @itemx S-@key{down}
1619 @cindex shift-selection-mode
1620 @vindex org-support-shift-select
1621 Jump to the previous/next item in the current list, but only if
1622 @code{org-support-shift-select} is off.  If not, you can still use paragraph
1623 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1624 similar effect.
1625 @kindex M-S-@key{up}
1626 @kindex M-S-@key{down}
1627 @item M-S-@key{up}
1628 @itemx M-S-@key{down}
1629 Move the item including subitems up/down (swap with previous/next item
1630 of same indentation).  If the list is ordered, renumbering is
1631 automatic.
1632 @kindex M-@key{left}
1633 @kindex M-@key{right}
1634 @item M-@key{left}
1635 @itemx M-@key{right}
1636 Decrease/increase the indentation of an item, leaving children alone.
1637 @kindex M-S-@key{left}
1638 @kindex M-S-@key{right}
1639 @item M-S-@key{left}
1640 @itemx M-S-@key{right}
1641 Decrease/increase the indentation of the item, including subitems.
1642 Initially, the item tree is selected based on current indentation.  When
1643 these commands are executed several times in direct succession, the initially
1644 selected region is used, even if the new indentation would imply a different
1645 hierarchy.  To use the new hierarchy, break the command chain with a cursor
1646 motion or so.
1647
1648 As a special case, using this command on the very first item of a list will
1649 move the whole list.  This behavior can be disabled by configuring
1650 @code{org-list-automatic-rules}.  The global indentation of a list has no
1651 influence on the text @emph{after} the list.
1652 @kindex C-c C-c
1653 @item C-c C-c
1654 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1655 state of the checkbox.  In any case, verify bullets and indentation
1656 consistency in the whole list.
1657 @kindex C-c -
1658 @vindex org-plain-list-ordered-item-terminator
1659 @vindex org-list-automatic-rules
1660 @item C-c -
1661 Cycle the entire list level through the different itemize/enumerate bullets
1662 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1663 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1664 and its position@footnote{See @code{bullet} rule in
1665 @code{org-list-automatic-rules} for more information.}.  With a numeric
1666 prefix argument N, select the Nth bullet from this list.  If there is an
1667 active region when calling this, selected text will be changed into an item.
1668 With a prefix argument, all lines will be converted to list items.  If the
1669 first line already was a list item, any item marker will be removed from the
1670 list.  Finally, even without an active region, a normal line will be
1671 converted into a list item.
1672 @kindex C-c *
1673 @item C-c *
1674 Turn a plain list item into a headline (so that it becomes a subheading at
1675 its location).  @xref{Structure editing}, for a detailed explanation.
1676 @kindex C-c C-*
1677 @item C-c C-*
1678 Turn the whole plain list into a subtree of the current heading.  Checkboxes
1679 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1680 (resp. checked).
1681 @kindex S-@key{left}
1682 @kindex S-@key{right}
1683 @item S-@key{left}/@key{right}
1684 @vindex org-support-shift-select
1685 This command also cycles bullet styles when the cursor in on the bullet or
1686 anywhere in an item line, details depending on
1687 @code{org-support-shift-select}.
1688 @kindex C-c ^
1689 @item C-c ^
1690 Sort the plain list.  You will be prompted for the sorting method:
1691 numerically, alphabetically, by time, or by custom function.
1692 @end table
1693
1694 @node Drawers, Blocks, Plain lists, Document Structure
1695 @section Drawers
1696 @cindex drawers
1697 @cindex #+DRAWERS
1698 @cindex visibility cycling, drawers
1699
1700 @vindex org-drawers
1701 Sometimes you want to keep information associated with an entry, but you
1702 normally don't want to see it.  For this, Org-mode has @emph{drawers}.
1703 Drawers need to be configured with the variable
1704 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1705 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}.  Drawers
1706 look like this:
1707
1708 @example
1709 ** This is a headline
1710    Still outside the drawer
1711    :DRAWERNAME:
1712    This is inside the drawer.
1713    :END:
1714    After the drawer.
1715 @end example
1716
1717 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1718 show the entry, but keep the drawer collapsed to a single line.  In order to
1719 look inside the drawer, you need to move the cursor to the drawer line and
1720 press @key{TAB} there.  Org-mode uses the @code{PROPERTIES} drawer for
1721 storing properties (@pxref{Properties and Columns}), and you can also arrange
1722 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1723 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.  If you
1724 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1725
1726 @table @kbd
1727 @kindex C-c C-z
1728 @item C-c C-z
1729 Add a time-stamped note to the LOGBOOK drawer.
1730 @end table
1731
1732 @node Blocks, Footnotes, Drawers, Document Structure
1733 @section Blocks
1734
1735 @vindex org-hide-block-startup
1736 @cindex blocks, folding
1737 Org-mode uses begin...end blocks for various purposes from including source
1738 code examples (@pxref{Literal examples}) to capturing time logging
1739 information (@pxref{Clocking work time}).  These blocks can be folded and
1740 unfolded by pressing TAB in the begin line.  You can also get all blocks
1741 folded at startup by configuring the variable @code{org-hide-block-startup}
1742 or on a per-file basis by using
1743
1744 @cindex @code{hideblocks}, STARTUP keyword
1745 @cindex @code{nohideblocks}, STARTUP keyword
1746 @example
1747 #+STARTUP: hideblocks
1748 #+STARTUP: nohideblocks
1749 @end example
1750
1751 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1752 @section Footnotes
1753 @cindex footnotes
1754
1755 Org-mode supports the creation of footnotes.  In contrast to the
1756 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
1757 larger document, not only for one-off documents like emails.  The basic
1758 syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
1759 defined in a paragraph that is started by a footnote marker in square
1760 brackets in column 0, no indentation allowed.  If you need a paragraph break
1761 inside a footnote, use the @LaTeX{} idiom @samp{\par}.  The footnote reference
1762 is simply the marker in square brackets, inside text.  For example:
1763
1764 @example
1765 The Org homepage[fn:1] now looks a lot better than it used to.
1766 ...
1767 [fn:1] The link is: http://orgmode.org
1768 @end example
1769
1770 Org-mode extends the number-based syntax to @emph{named} footnotes and
1771 optional inline definition.  Using plain numbers as markers (as
1772 @file{footnote.el} does) is supported for backward compatibility, but not
1773 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1774 LaTeX}).  Here are the valid references:
1775
1776 @table @code
1777 @item [1]
1778 A plain numeric footnote marker.  Compatible with @file{footnote.el}, but not
1779 recommended because something like @samp{[1]} could easily be part of a code
1780 snippet.
1781 @item [fn:name]
1782 A named footnote reference, where @code{name} is a unique label word, or, for
1783 simplicity of automatic creation, a number.
1784 @item [fn:: This is the inline definition of this footnote]
1785 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1786 reference point.
1787 @item [fn:name: a definition]
1788 An inline definition of a footnote, which also specifies a name for the note.
1789 Since Org allows multiple references to the same note, you can then use
1790 @code{[fn:name]} to create additional references.
1791 @end table
1792
1793 @vindex org-footnote-auto-label
1794 Footnote labels can be created automatically, or you can create names yourself.
1795 This is handled by the variable @code{org-footnote-auto-label} and its
1796 corresponding @code{#+STARTUP} keywords.  See the docstring of that variable
1797 for details.
1798
1799 @noindent The following command handles footnotes:
1800
1801 @table @kbd
1802 @kindex C-c C-x f
1803 @item C-c C-x f
1804 The footnote action command.
1805
1806 When the cursor is on a footnote reference, jump to the definition.  When it
1807 is at a definition, jump to the (first) reference.
1808
1809 @vindex org-footnote-define-inline
1810 @vindex org-footnote-section
1811 @vindex org-footnote-auto-adjust
1812 Otherwise, create a new footnote.  Depending on the variable
1813 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1814 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1815 definition will be placed right into the text as part of the reference, or
1816 separately into the location determined by the variable
1817 @code{org-footnote-section}.
1818
1819 When this command is called with a prefix argument, a menu of additional
1820 options is offered:
1821 @example
1822 s   @r{Sort the footnote definitions by reference sequence.  During editing,}
1823     @r{Org makes no effort to sort footnote definitions into a particular}
1824     @r{sequence.  If you want them sorted, use this command, which will}
1825     @r{also move entries according to @code{org-footnote-section}.  Automatic}
1826     @r{sorting after each insertion/deletion can be configured using the}
1827     @r{variable @code{org-footnote-auto-adjust}.}
1828 r   @r{Renumber the simple @code{fn:N} footnotes.  Automatic renumbering}
1829     @r{after each insertion/deletion can be configured using the variable}
1830     @r{@code{org-footnote-auto-adjust}.}
1831 S   @r{Short for first @code{r}, then @code{s} action.}
1832 n   @r{Normalize the footnotes by collecting all definitions (including}
1833     @r{inline definitions) into a special section, and then numbering them}
1834     @r{in sequence.  The references will then also be numbers.  This is}
1835     @r{meant to be the final step before finishing a document (e.g.@: sending}
1836     @r{off an email).  The exporters do this automatically, and so could}
1837     @r{something like @code{message-send-hook}.}
1838 d   @r{Delete the footnote at point, and all definitions of and references}
1839     @r{to it.}
1840 @end example
1841 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1842 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1843 renumbering and sorting footnotes can be automatic after each insertion or
1844 deletion.
1845
1846 @kindex C-c C-c
1847 @item C-c C-c
1848 If the cursor is on a footnote reference, jump to the definition.  If it is a
1849 the definition, jump back to the reference.  When called at a footnote
1850 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1851 @kindex C-c C-o
1852 @kindex mouse-1
1853 @kindex mouse-2
1854 @item C-c C-o  @r{or} mouse-1/2
1855 Footnote labels are also links to the corresponding definition/reference, and
1856 you can use the usual commands to follow these links.
1857 @end table
1858
1859 @node Orgstruct mode,  , Footnotes, Document Structure
1860 @section The Orgstruct minor mode
1861 @cindex Orgstruct mode
1862 @cindex minor mode for structure editing
1863
1864 If you like the intuitive way the Org-mode structure editing and list
1865 formatting works, you might want to use these commands in other modes like
1866 Text mode or Mail mode as well.  The minor mode @code{orgstruct-mode} makes
1867 this possible.   Toggle the mode with @kbd{M-x orgstruct-mode}, or
1868 turn it on by default, for example in Message mode, with one of:
1869
1870 @lisp
1871 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1872 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1873 @end lisp
1874
1875 When this mode is active and the cursor is on a line that looks to Org like a
1876 headline or the first line of a list item, most structure editing commands
1877 will work, even if the same keys normally have different functionality in the
1878 major mode you are using.  If the cursor is not in one of those special
1879 lines, Orgstruct mode lurks silently in the shadows.  When you use
1880 @code{orgstruct++-mode}, Org will also export indentation and autofill
1881 settings into that mode, and detect item context after the first line of an
1882 item.
1883
1884 @node Tables, Hyperlinks, Document Structure, Top
1885 @chapter Tables
1886 @cindex tables
1887 @cindex editing tables
1888
1889 Org comes with a fast and intuitive table editor.  Spreadsheet-like
1890 calculations are supported using the Emacs @file{calc} package
1891 @ifinfo
1892 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1893 @end ifinfo
1894 @ifnotinfo
1895 (see the Emacs Calculator manual for more information about the Emacs
1896 calculator).
1897 @end ifnotinfo
1898
1899 @menu
1900 * Built-in table editor::       Simple tables
1901 * Column width and alignment::  Overrule the automatic settings
1902 * Column groups::               Grouping to trigger vertical lines
1903 * Orgtbl mode::                 The table editor as minor mode
1904 * The spreadsheet::             The table editor has spreadsheet capabilities
1905 * Org-Plot::                    Plotting from org tables
1906 @end menu
1907
1908 @node Built-in table editor, Column width and alignment, Tables, Tables
1909 @section The built-in table editor
1910 @cindex table editor, built-in
1911
1912 Org makes it easy to format tables in plain ASCII.  Any line with @samp{|} as
1913 the first non-whitespace character is considered part of a table.  @samp{|}
1914 is also the column separator@footnote{To insert a vertical bar into a table
1915 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}.  A table
1916 might look like this:
1917
1918 @example
1919 | Name  | Phone | Age |
1920 |-------+-------+-----|
1921 | Peter |  1234 |  17 |
1922 | Anna  |  4321 |  25 |
1923 @end example
1924
1925 A table is re-aligned automatically each time you press @key{TAB} or
1926 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
1927 the next field (@key{RET} to the next row) and creates new table rows
1928 at the end of the table or before horizontal lines.  The indentation
1929 of the table is set by the first line.  Any line starting with
1930 @samp{|-} is considered as a horizontal separator line and will be
1931 expanded on the next re-align to span the whole table width.  So, to
1932 create the above table, you would only type
1933
1934 @example
1935 |Name|Phone|Age|
1936 |-
1937 @end example
1938
1939 @noindent and then press @key{TAB} to align the table and start filling in
1940 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
1941 @kbd{C-c @key{RET}}.
1942
1943 @vindex org-enable-table-editor
1944 @vindex org-table-auto-blank-field
1945 When typing text into a field, Org treats @key{DEL},
1946 @key{Backspace}, and all character keys in a special way, so that
1947 inserting and deleting avoids shifting other fields.  Also, when
1948 typing @emph{immediately after the cursor was moved into a new field
1949 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1950 field is automatically made blank.  If this behavior is too
1951 unpredictable for you, configure the variables
1952 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1953
1954 @table @kbd
1955 @tsubheading{Creation and conversion}
1956 @orgcmd{C-c |,org-table-create-or-convert-from-region}
1957 Convert the active region to table.  If every line contains at least one
1958 TAB character, the function assumes that the material is tab separated.
1959 If every line contains a comma, comma-separated values (CSV) are assumed.
1960 If not, lines are split at whitespace into fields.  You can use a prefix
1961 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1962 C-u} forces TAB, and a numeric argument N indicates that at least N
1963 consecutive spaces, or alternatively a TAB will be the separator.
1964 @*
1965 If there is no active region, this command creates an empty Org
1966 table.  But it is easier just to start typing, like
1967 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1968
1969 @tsubheading{Re-aligning and field motion}
1970 @orgcmd{C-c C-c,org-table-align}
1971 Re-align the table without moving the cursor.
1972 @c
1973 @orgcmd{<TAB>,org-table-next-field}
1974 Re-align the table, move to the next field.  Creates a new row if
1975 necessary.
1976 @c
1977 @orgcmd{S-@key{TAB},org-table-previous-field}
1978 Re-align, move to previous field.
1979 @c
1980 @orgcmd{@key{RET},org-table-next-row}
1981 Re-align the table and move down to next row.  Creates a new row if
1982 necessary.  At the beginning or end of a line, @key{RET} still does
1983 NEWLINE, so it can be used to split a table.
1984 @c
1985 @orgcmd{M-a,org-table-beginning-of-field}
1986 Move to beginning of the current table field, or on to the previous field.
1987 @orgcmd{M-e,org-table-end-of-field}
1988 Move to end of the current table field, or on to the next field.
1989
1990 @tsubheading{Column and row editing}
1991 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
1992 Move the current column left/right.
1993 @c
1994 @orgcmd{M-S-@key{left},org-table-delete-column}
1995 Kill the current column.
1996 @c
1997 @orgcmd{M-S-@key{right},org-table-insert-column}
1998 Insert a new column to the left of the cursor position.
1999 @c
2000 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2001 Move the current row up/down.
2002 @c
2003 @orgcmd{M-S-@key{up},org-table-kill-row}
2004 Kill the current row or horizontal line.
2005 @c
2006 @orgcmd{M-S-@key{down},org-table-insert-row}
2007 Insert a new row above the current row.  With a prefix argument, the line is
2008 created below the current one.
2009 @c
2010 @orgcmd{C-c -,org-table-insert-hline}
2011 Insert a horizontal line below current row.  With a prefix argument, the line
2012 is created above the current line.
2013 @c
2014 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2015 Insert a horizontal line below current row, and move the cursor into the row
2016 below that line.
2017 @c
2018 @orgcmd{C-c ^,org-table-sort-lines}
2019 Sort the table lines in the region.  The position of point indicates the
2020 column to be used for sorting, and the range of lines is the range
2021 between the nearest horizontal separator lines, or the entire table.  If
2022 point is before the first column, you will be prompted for the sorting
2023 column.  If there is an active region, the mark specifies the first line
2024 and the sorting column, while point should be in the last line to be
2025 included into the sorting.  The command prompts for the sorting type
2026 (alphabetically, numerically, or by time).  When called with a prefix
2027 argument, alphabetic sorting will be case-sensitive.
2028
2029 @tsubheading{Regions}
2030 @orgcmd{C-c C-x M-w,org-table-copy-region}
2031 Copy a rectangular region from a table to a special clipboard.  Point and
2032 mark determine edge fields of the rectangle.  If there is no active region,
2033 copy just the current field.  The process ignores horizontal separator lines.
2034 @c
2035 @orgcmd{C-c C-x C-w,org-table-cut-region}
2036 Copy a rectangular region from a table to a special clipboard, and
2037 blank all fields in the rectangle.  So this is the ``cut'' operation.
2038 @c
2039 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2040 Paste a rectangular region into a table.
2041 The upper left corner ends up in the current field.  All involved fields
2042 will be overwritten.  If the rectangle does not fit into the present table,
2043 the table is enlarged as needed.  The process ignores horizontal separator
2044 lines.
2045 @c
2046 @orgcmd{M-@key{RET},org-table-wrap-region}
2047 Split the current field at the cursor position and move the rest to the line
2048 below.  If there is an active region, and both point and mark are in the same
2049 column, the text in the column is wrapped to minimum width for the given
2050 number of lines.  A numeric prefix argument may be used to change the number
2051 of desired lines.  If there is no region, but you specify a prefix argument,
2052 the current field is made blank, and the content is appended to the field
2053 above.
2054
2055 @tsubheading{Calculations}
2056 @cindex formula, in tables
2057 @cindex calculations, in tables
2058 @cindex region, active
2059 @cindex active region
2060 @cindex transient mark mode
2061 @orgcmd{C-c +,org-table-sum}
2062 Sum the numbers in the current column, or in the rectangle defined by
2063 the active region.  The result is shown in the echo area and can
2064 be inserted with @kbd{C-y}.
2065 @c
2066 @orgcmd{S-@key{RET},org-table-copy-down}
2067 @vindex org-table-copy-increment
2068 When current field is empty, copy from first non-empty field above.  When not
2069 empty, copy current field down to next row and move cursor along with it.
2070 Depending on the variable @code{org-table-copy-increment}, integer field
2071 values will be incremented during copy.  Integers that are too large will not
2072 be incremented.  Also, a @code{0} prefix argument temporarily disables the
2073 increment.  This key is also used by shift-selection and related modes
2074 (@pxref{Conflicts}).
2075
2076 @tsubheading{Miscellaneous}
2077 @orgcmd{C-c `,org-table-edit-field}
2078 Edit the current field in a separate window.  This is useful for fields that
2079 are not fully visible (@pxref{Column width and alignment}).  When called with
2080 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2081 edited in place.  When called with two @kbd{C-u} prefixes, make the editor
2082 window follow the cursor through the table and always show the current
2083 field.  The follow mode exits automatically when the cursor leaves the table,
2084 or when you repeat this command with @kbd{C-u C-u C-c `}.
2085 @c
2086 @item M-x org-table-import
2087 Import a file as a table.  The table should be TAB or whitespace
2088 separated.  Use, for example, to import a spreadsheet table or data
2089 from a database, because these programs generally can write
2090 TAB-separated text files.  This command works by inserting the file into
2091 the buffer and then converting the region to a table.  Any prefix
2092 argument is passed on to the converter, which uses it to determine the
2093 separator.
2094 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2095 Tables can also be imported by pasting tabular text into the Org
2096 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2097 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2098 @c
2099 @item M-x org-table-export
2100 @findex org-table-export
2101 @vindex org-table-export-default-format
2102 Export the table, by default as a TAB-separated file.  Use for data
2103 exchange with, for example, spreadsheet or database programs.  The format
2104 used to export the file can be configured in the variable
2105 @code{org-table-export-default-format}.  You may also use properties
2106 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2107 name and the format for table export in a subtree.  Org supports quite
2108 general formats for exported tables.  The exporter format is the same as the
2109 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2110 detailed description.
2111 @end table
2112
2113 If you don't like the automatic table editor because it gets in your
2114 way on lines which you would like to start with @samp{|}, you can turn
2115 it off with
2116
2117 @lisp
2118 (setq org-enable-table-editor nil)
2119 @end lisp
2120
2121 @noindent Then the only table command that still works is
2122 @kbd{C-c C-c} to do a manual re-align.
2123
2124 @node Column width and alignment, Column groups, Built-in table editor, Tables
2125 @section Column width and alignment
2126 @cindex narrow columns in tables
2127 @cindex alignment in tables
2128
2129 The width of columns is automatically determined by the table editor.  And
2130 also the alignment of a column is determined automatically from the fraction
2131 of number-like versus non-number fields in the column.
2132
2133 Sometimes a single field or a few fields need to carry more text, leading to
2134 inconveniently wide columns.  Or maybe you want to make a table with several
2135 columns having a fixed width, regardless of content.  To set@footnote{This
2136 feature does not work on XEmacs.} the width of a column, one field anywhere
2137 in the column may contain just the string @samp{<N>} where @samp{N} is an
2138 integer specifying the width of the column in characters.  The next re-align
2139 will then set the width of this column to this value.
2140
2141 @example
2142 @group
2143 |---+------------------------------|               |---+--------|
2144 |   |                              |               |   | <6>    |
2145 | 1 | one                          |               | 1 | one    |
2146 | 2 | two                          |     ----\     | 2 | two    |
2147 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
2148 | 4 | four                         |               | 4 | four   |
2149 |---+------------------------------|               |---+--------|
2150 @end group
2151 @end example
2152
2153 @noindent
2154 Fields that are wider become clipped and end in the string @samp{=>}.
2155 Note that the full text is still in the buffer but is hidden.
2156 To see the full text, hold the mouse over the field---a tool-tip window
2157 will show the full content.  To edit such a field, use the command
2158 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
2159 open a new window with the full field.  Edit it and finish with @kbd{C-c
2160 C-c}.
2161
2162 @vindex org-startup-align-all-tables
2163 When visiting a file containing a table with narrowed columns, the
2164 necessary character hiding has not yet happened, and the table needs to
2165 be aligned before it looks nice.  Setting the option
2166 @code{org-startup-align-all-tables} will realign all tables in a file
2167 upon visiting, but also slow down startup.  You can also set this option
2168 on a per-file basis with:
2169
2170 @example
2171 #+STARTUP: align
2172 #+STARTUP: noalign
2173 @end example
2174
2175 If you would like to overrule the automatic alignment of number-rich columns
2176 to the right and of string-rich column to the left, you can use @samp{<r>},
2177 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2178 effect when exporting to HTML.} or @samp{<l>} in a similar fashion.  You may
2179 also combine alignment and field width like this: @samp{<l10>}.
2180
2181 Lines which only contain these formatting cookies will be removed
2182 automatically when exporting the document.
2183
2184 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2185 @section Column groups
2186 @cindex grouping columns in tables
2187
2188 When Org exports tables, it does so by default without vertical
2189 lines because that is visually more satisfying in general.  Occasionally
2190 however, vertical lines can be useful to structure a table into groups
2191 of columns, much like horizontal lines can do for groups of rows.  In
2192 order to specify column groups, you can use a special row where the
2193 first field contains only @samp{/}.  The further fields can either
2194 contain @samp{<} to indicate that this column should start a group,
2195 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2196 a group of its own.  Boundaries between column groups will upon export be
2197 marked with vertical lines.  Here is an example:
2198
2199 @example
2200 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2201 |---+-----+-----+-----+---------+------------|
2202 | / |   < |     |   > |       < |          > |
2203 | 1 |   1 |   1 |   1 |       1 |          1 |
2204 | 2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
2205 | 3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
2206 |---+-----+-----+-----+---------+------------|
2207 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2208 @end example
2209
2210 It is also sufficient to just insert the column group starters after
2211 every vertical line you would like to have:
2212
2213 @example
2214 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2215 |----+-----+-----+-----+---------+------------|
2216 | /  | <   |     |     | <       |            |
2217 @end example
2218
2219 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2220 @section The Orgtbl minor mode
2221 @cindex Orgtbl mode
2222 @cindex minor mode for tables
2223
2224 If you like the intuitive way the Org table editor works, you
2225 might also want to use it in other modes like Text mode or Mail mode.
2226 The minor mode Orgtbl mode makes this possible.  You can always toggle
2227 the mode with @kbd{M-x orgtbl-mode}.  To turn it on by default, for
2228 example in Message mode, use
2229
2230 @lisp
2231 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2232 @end lisp
2233
2234 Furthermore, with some special setup, it is possible to maintain tables
2235 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
2236 construct @LaTeX{} tables with the underlying ease and power of
2237 Orgtbl mode, including spreadsheet capabilities.  For details, see
2238 @ref{Tables in arbitrary syntax}.
2239
2240 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2241 @section The spreadsheet
2242 @cindex calculations, in tables
2243 @cindex spreadsheet capabilities
2244 @cindex @file{calc} package
2245
2246 The table editor makes use of the Emacs @file{calc} package to implement
2247 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
2248 derive fields from other fields.  While fully featured, Org's implementation
2249 is not identical to other spreadsheets.  For example, Org knows the concept
2250 of a @emph{column formula} that will be applied to all non-header fields in a
2251 column without having to copy the formula to each relevant field.  There is
2252 also a formula debugger, and a formula editor with features for highlighting
2253 fields in the table corresponding to the references at the point in the
2254 formula, moving these references by arrow keys
2255
2256 @menu
2257 * References::                  How to refer to another field or range
2258 * Formula syntax for Calc::     Using Calc to compute stuff
2259 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
2260 * Durations and time values::   How to compute durations and time values
2261 * Field and range formulas::    Formula for specific (ranges of) fields
2262 * Column formulas::             Formulas valid for an entire column
2263 * Editing and debugging formulas::  Fixing formulas
2264 * Updating the table::          Recomputing all dependent fields
2265 * Advanced features::           Field names, parameters and automatic recalc
2266 @end menu
2267
2268 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2269 @subsection References
2270 @cindex references
2271
2272 To compute fields in the table from other fields, formulas must
2273 reference other fields or ranges.  In Org, fields can be referenced
2274 by name, by absolute coordinates, and by relative coordinates.  To find
2275 out what the coordinates of a field are, press @kbd{C-c ?} in that
2276 field, or press @kbd{C-c @}} to toggle the display of a grid.
2277
2278 @subsubheading Field references
2279 @cindex field references
2280 @cindex references, to fields
2281
2282 Formulas can reference the value of another field in two ways.  Like in
2283 any other spreadsheet, you may reference fields with a letter/number
2284 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2285 @vindex org-table-use-standard-references
2286 However, Org prefers@footnote{Org will understand references typed by the
2287 user as @samp{B4}, but it will not use this syntax when offering a formula
2288 for editing.  You can customize this behavior using the variable
2289 @code{org-table-use-standard-references}.}  to use another, more general
2290 representation that looks like this:
2291 @example
2292 @@@var{row}$@var{column}
2293 @end example
2294
2295 Column specifications can be absolute like @code{$1},
2296 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
2297 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2298 @code{$<} and @code{$>} are immutable references to the first and last
2299 column, respectively, and you can use @code{$>>>} to indicate the third
2300 column from the right.
2301
2302 The row specification only counts data lines and ignores horizontal separator
2303 lines (hlines).  Like with columns, you can use absolute row numbers
2304 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2305 current row like @code{@@+3} or @code{@@-1}.  @code{@@<} and @code{@@>} are
2306 immutable references the first and last@footnote{For backward compatibility
2307 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2308 a stable way to the 5th and 12th field in the last row of the table.
2309 However, this syntax is deprecated, it should not be used for new documents.
2310 Use @code{@@>$} instead.} row in the table, respectively.  You may also
2311 specify the row relative to one of the hlines: @code{@@I} refers to the first
2312 hline, @code{@@II} to the second, etc@.  @code{@@-I} refers to the first such
2313 line above the current line, @code{@@+I} to the first such line below the
2314 current line.  You can also write @code{@@III+2} which is the second data line
2315 after the third hline in the table.
2316
2317 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2318 i.e. to the row/column for the field being computed.  Also, if you omit
2319 either the column or the row part of the reference, the current row/column is
2320 implied.
2321
2322 Org's references with @emph{unsigned} numbers are fixed references
2323 in the sense that if you use the same reference in the formula for two
2324 different fields, the same field will be referenced each time.
2325 Org's references with @emph{signed} numbers are floating
2326 references because the same reference operator can reference different
2327 fields depending on the field being calculated by the formula.
2328
2329 Here are a few examples:
2330
2331 @example
2332 @@2$3      @r{2nd row, 3rd column (same as @code{C2})}
2333 $5        @r{column 5 in the current row (same as @code{E&})}
2334 @@2        @r{current column, row 2}
2335 @@-1$-3    @r{the field one row up, three columns to the left}
2336 @@-I$2     @r{field just under hline above current row, column 2}
2337 @@>$5      @r{field in the last row, in column 5}
2338 @end example
2339
2340 @subsubheading Range references
2341 @cindex range references
2342 @cindex references, to ranges
2343
2344 You may reference a rectangular range of fields by specifying two field
2345 references connected by two dots @samp{..}.  If both fields are in the
2346 current row, you may simply use @samp{$2..$7}, but if at least one field
2347 is in a different row, you need to use the general @code{@@row$column}
2348 format at least for the first field (i.e the reference must start with
2349 @samp{@@} in order to be interpreted correctly).  Examples:
2350
2351 @example
2352 $1..$3        @r{first three fields in the current row}
2353 $P..$Q        @r{range, using column names (see under Advanced)}
2354 $<<<..$>>     @r{start in third column, continue to the one but last}
2355 @@2$1..@@4$3    @r{6 fields between these two fields (same as @code{A2..C4})}
2356 @@-1$-2..@@-1   @r{3 numbers from the column to the left, 2 up to current row}
2357 @@I..II        @r{between first and second hline, short for @code{@@I..@@II}}
2358 @end example
2359
2360 @noindent Range references return a vector of values that can be fed
2361 into Calc vector functions.  Empty fields in ranges are normally
2362 suppressed, so that the vector contains only the non-empty fields (but
2363 see the @samp{E} mode switch below).  If there are no non-empty fields,
2364 @samp{[0]} is returned to avoid syntax errors in formulas.
2365
2366 @subsubheading Field coordinates in formulas
2367 @cindex field coordinates
2368 @cindex coordinates, of field
2369 @cindex row, of field coordinates
2370 @cindex column, of field coordinates
2371
2372 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2373 get the row or column number of the field where the formula result goes.
2374 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2375 and @code{org-table-current-column}.  Examples:
2376
2377 @example
2378 if(@@# % 2, $#, string(""))   @r{column number on odd lines only}
2379 $3 = remote(FOO, @@@@#$2)      @r{copy column 2 from table FOO into}
2380                              @r{column 3 of the current table}
2381 @end example
2382
2383 @noindent For the second example, table FOO must have at least as many rows
2384 as the current table.  Note that this is inefficient@footnote{The computation time scales as
2385 O(N^2) because table FOO is parsed for each field to be copied.} for large
2386 number of rows.
2387
2388 @subsubheading Named references
2389 @cindex named references
2390 @cindex references, named
2391 @cindex name, of column or field
2392 @cindex constants, in calculations
2393 @cindex #+CONSTANTS
2394
2395 @vindex org-table-formula-constants
2396 @samp{$name} is interpreted as the name of a column, parameter or
2397 constant.  Constants are defined globally through the variable
2398 @code{org-table-formula-constants}, and locally (for the file) through a
2399 line like
2400
2401 @example
2402 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2403 @end example
2404
2405 @noindent
2406 @vindex constants-unit-system
2407 @pindex constants.el
2408 Also properties (@pxref{Properties and Columns}) can be used as
2409 constants in table formulas: for a property @samp{:Xyz:} use the name
2410 @samp{$PROP_Xyz}, and the property will be searched in the current
2411 outline entry and in the hierarchy above it.  If you have the
2412 @file{constants.el} package, it will also be used to resolve constants,
2413 including natural constants like @samp{$h} for Planck's constant, and
2414 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2415 supply the values of constants in two different unit systems, @code{SI}
2416 and @code{cgs}.  Which one is used depends on the value of the variable
2417 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
2418 @code{constSI} and @code{constcgs} to set this value for the current
2419 buffer.}.  Column names and parameters can be specified in special table
2420 lines.  These are described below, see @ref{Advanced features}.  All
2421 names must start with a letter, and further consist of letters and
2422 numbers.
2423
2424 @subsubheading Remote references
2425 @cindex remote references
2426 @cindex references, remote
2427 @cindex references, to a different table
2428 @cindex name, of column or field
2429 @cindex constants, in calculations
2430 @cindex #+TBLNAME
2431
2432 You may also reference constants, fields and ranges from a different table,
2433 either in the current file or even in a different file.  The syntax is
2434
2435 @example
2436 remote(NAME-OR-ID,REF)
2437 @end example
2438
2439 @noindent
2440 where NAME can be the name of a table in the current file as set by a
2441 @code{#+TBLNAME: NAME} line before the table.  It can also be the ID of an
2442 entry, even in a different file, and the reference then refers to the first
2443 table in that entry.  REF is an absolute field or range reference as
2444 described above for example @code{@@3$3} or @code{$somename}, valid in the
2445 referenced table.
2446
2447 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2448 @subsection Formula syntax for Calc
2449 @cindex formula syntax, Calc
2450 @cindex syntax, of formulas
2451
2452 A formula can be any algebraic expression understood by the Emacs
2453 @file{Calc} package.  @b{Note that @file{calc} has the
2454 non-standard convention that @samp{/} has lower precedence than
2455 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.}  Before
2456 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2457 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2458 Emacs Calc Manual}),
2459 @c FIXME:  The link to the Calc manual in HTML does not work.
2460 variable substitution takes place according to the rules described above.
2461 @cindex vectors, in table calculations
2462 The range vectors can be directly fed into the Calc vector functions
2463 like @samp{vmean} and @samp{vsum}.
2464
2465 @cindex format specifier
2466 @cindex mode, for @file{calc}
2467 @vindex org-calc-default-modes
2468 A formula can contain an optional mode string after a semicolon.  This
2469 string consists of flags to influence Calc and other modes during
2470 execution.  By default, Org uses the standard Calc modes (precision
2471 12, angular units degrees, fraction and symbolic modes off).  The display
2472 format, however, has been changed to @code{(float 8)} to keep tables
2473 compact.  The default settings can be configured using the variable
2474 @code{org-calc-default-modes}.
2475
2476 @example
2477 p20           @r{set the internal Calc calculation precision to 20 digits}
2478 n3 s3 e2 f4   @r{Normal, scientific, engineering, or fixed}
2479               @r{format of the result of Calc passed back to Org.}
2480               @r{Calc formatting is unlimited in precision as}
2481               @r{long as the Calc calculation precision is greater.}
2482 D R           @r{angle modes: degrees, radians}
2483 F S           @r{fraction and symbolic modes}
2484 N             @r{interpret all fields as numbers, use 0 for non-numbers}
2485 T             @r{force text interpretation}
2486 E             @r{keep empty fields in ranges}
2487 L             @r{literal}
2488 @end example
2489
2490 @noindent
2491 Unless you use large integer numbers or high-precision-calculation
2492 and -display for floating point numbers you may alternatively provide a
2493 @code{printf} format specifier to reformat the Calc result after it has been
2494 passed back to Org instead of letting Calc already do the
2495 formatting@footnote{The @code{printf} reformatting is limited in precision
2496 because the value passed to it is converted into an @code{integer} or
2497 @code{double}.  The @code{integer} is limited in size by truncating the
2498 signed value to 32 bits.  The @code{double} is limited in precision to 64
2499 bits overall which leaves approximately 16 significant decimal digits.}.
2500 A few examples:
2501
2502 @example
2503 $1+$2                @r{Sum of first and second field}
2504 $1+$2;%.2f           @r{Same, format result to two decimals}
2505 exp($2)+exp($1)      @r{Math functions can be used}
2506 $0;%.1f              @r{Reformat current cell to 1 decimal}
2507 ($3-32)*5/9          @r{Degrees F -> C conversion}
2508 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
2509 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
2510 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
2511 vmean($2..$7)        @r{Compute column range mean, using vector function}
2512 vmean($2..$7);EN     @r{Same, but treat empty fields as 0}
2513 taylor($3,x=7,2)     @r{Taylor series of $3, at x=7, second degree}
2514 @end example
2515
2516 Calc also contains a complete set of logical operations.  For example
2517
2518 @example
2519 if($1<20,teen,string(""))  @r{"teen" if age $1 less than 20, else empty}
2520 @end example
2521
2522 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2523 @subsection Emacs Lisp forms as formulas
2524 @cindex Lisp forms, as table formulas
2525
2526 It is also possible to write a formula in Emacs Lisp; this can be useful for
2527 string manipulation and control structures, if Calc's functionality is not
2528 enough.  If a formula starts with a single-quote followed by an opening
2529 parenthesis, then it is evaluated as a Lisp form.  The evaluation should
2530 return either a string or a number.  Just as with @file{calc} formulas, you
2531 can specify modes and a printf format after a semicolon.  With Emacs Lisp
2532 forms, you need to be conscious about the way field references are
2533 interpolated into the form.  By default, a reference will be interpolated as
2534 a Lisp string (in double-quotes) containing the field.  If you provide the
2535 @samp{N} mode switch, all referenced elements will be numbers (non-number
2536 fields will be zero) and interpolated as Lisp numbers, without quotes.  If
2537 you provide the @samp{L} flag, all fields will be interpolated literally,
2538 without quotes.  I.e., if you want a reference to be interpreted as a string
2539 by the Lisp form, enclose the reference operator itself in double-quotes,
2540 like @code{"$3"}.  Ranges are inserted as space-separated fields, so you can
2541 embed them in list or vector syntax.  Here are a few examples---note how the
2542 @samp{N} mode is used when we do computations in Lisp:
2543
2544 @example
2545 @r{Swap the first two characters of the content of column 1}
2546   '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2547 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2548   '(+ $1 $2);N
2549 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2550   '(apply '+ '($1..$4));N
2551 @end example
2552
2553 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2554 @subsection Durations and time values
2555 @cindex Duration, computing
2556 @cindex Time, computing
2557
2558 If you want to compute time values use the @code{T} flag, either in Calc
2559 formulas or Elisp formulas:
2560
2561 @example
2562 @group
2563 | Task 1 | Task 2 |   Total |
2564 |--------+--------+---------|
2565 |  35:00 |  35:00 | 1:10:00 |
2566 #+TBLFM: @@2$3=$1+$2;T
2567 @end group
2568 @end example
2569
2570 Values must be of the form @code{[HH:]MM:SS}, where hours are optional.
2571
2572 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2573 @subsection Field and range formulas
2574 @cindex field formula
2575 @cindex range formula
2576 @cindex formula, for individual table field
2577 @cindex formula, for range of fields
2578
2579 To assign a formula to a particular field, type it directly into the field,
2580 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}.  When you press
2581 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2582 the formula will be stored as the formula for this field, evaluated, and the
2583 current field will be replaced with the result.
2584
2585 @cindex #+TBLFM
2586 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2587 below the table.  If you type the equation in the 4th field of the 3rd data
2588 line in the table, the formula will look like @samp{@@3$4=$1+$2}.  When
2589 inserting/deleting/swapping column and rows with the appropriate commands,
2590 @i{absolute references} (but not relative ones) in stored formulas are
2591 modified in order to still reference the same field.  To avoid this from
2592 happening, in particular in range references, anchor ranges at the table
2593 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2594 using the @code{@@I} notation.  Automatic adaptation of field references does
2595 of cause not happen if you edit the table structure with normal editing
2596 commands---then you must fix the equations yourself.
2597
2598 Instead of typing an equation into the field, you may also use the following
2599 command
2600
2601 @table @kbd
2602 @orgcmd{C-u C-c =,org-table-eval-formula}
2603 Install a new formula for the current field.  The command prompts for a
2604 formula with default taken from the @samp{#+TBLFM:} line, applies
2605 it to the current field, and stores it.
2606 @end table
2607
2608 The left-hand side of a formula can also be a special expression in order to
2609 assign the formula to a number of different fields.  There is no keyboard
2610 shortcut to enter such range formulas.  To add them, use the formula editor
2611 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2612 directly.
2613
2614 @table @code
2615 @item $2=
2616 Column formula, valid for the entire column.  This is so common that Org
2617 treats these formulas in a special way, see @ref{Column formulas}.
2618 @item @@3=
2619 Row formula, applies to all fields in the specified row.  @code{@@>=} means
2620 the last row.
2621 @item @@1$2..@@4$3=
2622 Range formula, applies to all fields in the given rectangular range.  This
2623 can also be used to assign a formula to some but not all fields in a row.
2624 @item $name=
2625 Named field, see @ref{Advanced features}.
2626 @end table
2627
2628 @node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
2629 @subsection Column formulas
2630 @cindex column formula
2631 @cindex formula, for table column
2632
2633 When you assign a formula to a simple column reference like @code{$3=}, the
2634 same formula will be used in all fields of that column, with the following
2635 very convenient exceptions: (i) If the table contains horizontal separator
2636 hlines, everything before the first such line is considered part of the table
2637 @emph{header} and will not be modified by column formulas.  (ii) Fields that
2638 already get a value from a field/range formula will be left alone by column
2639 formulas.  These conditions make column formulas very easy to use.
2640
2641 To assign a formula to a column, type it directly into any field in the
2642 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2643 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2644 the formula will be stored as the formula for the current column, evaluated
2645 and the current field replaced with the result.  If the field contains only
2646 @samp{=}, the previously stored formula for this column is used.  For each
2647 column, Org will only remember the most recently used formula.  In the
2648 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}.  The
2649 left-hand side of a column formula can not be the name of column, it must be
2650 the numeric column reference or @code{$>}.
2651
2652 Instead of typing an equation into the field, you may also use the
2653 following command:
2654
2655 @table @kbd
2656 @orgcmd{C-c =,org-table-eval-formula}
2657 Install a new formula for the current column and replace current field with
2658 the result of the formula.  The command prompts for a formula, with default
2659 taken from the @samp{#+TBLFM} line, applies it to the current field and
2660 stores it.  With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
2661 will apply it to that many consecutive fields in the current column.
2662 @end table
2663
2664 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2665 @subsection Editing and debugging formulas
2666 @cindex formula editing
2667 @cindex editing, of table formulas
2668
2669 @vindex org-table-use-standard-references
2670 You can edit individual formulas in the minibuffer or directly in the
2671 field.  Org can also prepare a special buffer with all active
2672 formulas of a table.  When offering a formula for editing, Org
2673 converts references to the standard format (like @code{B3} or @code{D&})
2674 if possible.  If you prefer to only work with the internal format (like
2675 @code{@@3$2} or @code{$4}), configure the variable
2676 @code{org-table-use-standard-references}.
2677
2678 @table @kbd
2679 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2680 Edit the formula associated with the current column/field in the
2681 minibuffer.  See @ref{Column formulas}, and @ref{Field and range formulas}.
2682 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2683 Re-insert the active formula (either a
2684 field formula, or a column formula) into the current field, so that you
2685 can edit it directly in the field.  The advantage over editing in the
2686 minibuffer is that you can use the command @kbd{C-c ?}.
2687 @orgcmd{C-c ?,org-table-field-info}
2688 While editing a formula in a table field, highlight the field(s)
2689 referenced by the reference at the cursor position in the formula.
2690 @kindex C-c @}
2691 @findex org-table-toggle-coordinate-overlays
2692 @item C-c @}
2693 Toggle the display of row and column numbers for a table, using overlays
2694 (@command{org-table-toggle-coordinate-overlays}).  These are updated each
2695 time the table is aligned; you can force it with @kbd{C-c C-c}.
2696 @kindex C-c @{
2697 @findex org-table-toggle-formula-debugger
2698 @item C-c @{
2699 Toggle the formula debugger on and off
2700 (@command{org-table-toggle-formula-debugger}).  See below.
2701 @orgcmd{C-c ',org-table-edit-formulas}
2702 Edit all formulas for the current table in a special buffer, where the
2703 formulas will be displayed one per line.  If the current field has an
2704 active formula, the cursor in the formula editor will mark it.
2705 While inside the special buffer, Org will automatically highlight
2706 any field or range reference at the cursor position.  You may edit,
2707 remove and add formulas, and use the following commands:
2708 @table @kbd
2709 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2710 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
2711 prefix, also apply the new formulas to the entire table.
2712 @orgcmd{C-c C-q,org-table-fedit-abort}
2713 Exit the formula editor without installing changes.
2714 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2715 Toggle all references in the formula editor between standard (like
2716 @code{B3}) and internal (like @code{@@3$2}).
2717 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2718 Pretty-print or indent Lisp formula at point.  When in a line containing
2719 a Lisp formula, format the formula according to Emacs Lisp rules.
2720 Another @key{TAB} collapses the formula back again.  In the open
2721 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2722 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2723 Complete Lisp symbols, just like in Emacs Lisp mode.
2724 @kindex S-@key{up}
2725 @kindex S-@key{down}
2726 @kindex S-@key{left}
2727 @kindex S-@key{right}
2728 @findex org-table-fedit-ref-up
2729 @findex org-table-fedit-ref-down
2730 @findex org-table-fedit-ref-left
2731 @findex org-table-fedit-ref-right
2732 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2733 Shift the reference at point.  For example, if the reference is
2734 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2735 This also works for relative references and for hline references.
2736 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2737 Move the test line for column formulas in the Org buffer up and
2738 down.
2739 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2740 Scroll the window displaying the table.
2741 @kindex C-c @}
2742 @findex org-table-toggle-coordinate-overlays
2743 @item C-c @}
2744 Turn the coordinate grid in the table on and off.
2745 @end table
2746 @end table
2747
2748 Making a table field blank does not remove the formula associated with
2749 the field, because that is stored in a different line (the @samp{#+TBLFM}
2750 line)---during the next recalculation the field will be filled again.
2751 To remove a formula from a field, you have to give an empty reply when
2752 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2753
2754 @kindex C-c C-c
2755 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2756 equations with @kbd{C-c C-c} in that line or with the normal
2757 recalculation commands in the table.
2758
2759 @subsubheading Debugging formulas
2760 @cindex formula debugging
2761 @cindex debugging, of table formulas
2762 When the evaluation of a formula leads to an error, the field content
2763 becomes the string @samp{#ERROR}.  If you would like see what is going
2764 on during variable substitution and calculation in order to find a bug,
2765 turn on formula debugging in the @code{Tbl} menu and repeat the
2766 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2767 field.  Detailed information will be displayed.
2768
2769 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2770 @subsection Updating the table
2771 @cindex recomputing table fields
2772 @cindex updating, table
2773
2774 Recalculation of a table is normally not automatic, but needs to be
2775 triggered by a command.  See @ref{Advanced features}, for a way to make
2776 recalculation at least semi-automatic.
2777
2778 In order to recalculate a line of a table or the entire table, use the
2779 following commands:
2780
2781 @table @kbd
2782 @orgcmd{C-c *,org-table-recalculate}
2783 Recalculate the current row by first applying the stored column formulas
2784 from left to right, and all field/range formulas in the current row.
2785 @c
2786 @kindex C-u C-c *
2787 @item C-u C-c *
2788 @kindex C-u C-c C-c
2789 @itemx C-u C-c C-c
2790 Recompute the entire table, line by line.  Any lines before the first
2791 hline are left alone, assuming that these are part of the table header.
2792 @c
2793 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2794 Iterate the table by recomputing it until no further changes occur.
2795 This may be necessary if some computed fields use the value of other
2796 fields that are computed @i{later} in the calculation sequence.
2797 @item M-x org-table-recalculate-buffer-tables
2798 @findex org-table-recalculate-buffer-tables
2799 Recompute all tables in the current buffer.
2800 @item M-x org-table-iterate-buffer-tables
2801 @findex org-table-iterate-buffer-tables
2802 Iterate all tables in the current buffer, in order to converge table-to-table
2803 dependencies.
2804 @end table
2805
2806 @node Advanced features,  , Updating the table, The spreadsheet
2807 @subsection Advanced features
2808
2809 If you want the recalculation of fields to happen automatically, or if
2810 you want to be able to assign @i{names} to fields and columns, you need
2811 to reserve the first column of the table for special marking characters.
2812
2813 @table @kbd
2814 @orgcmd{C-#,org-table-rotate-recalc-marks}
2815 Rotate the calculation mark in first column through the states @samp{ },
2816 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
2817 change all marks in the region.
2818 @end table
2819
2820 Here is an example of a table that collects exam results of students and
2821 makes use of these features:
2822
2823 @example
2824 @group
2825 |---+---------+--------+--------+--------+-------+------|
2826 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2827 |---+---------+--------+--------+--------+-------+------|
2828 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
2829 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
2830 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
2831 |---+---------+--------+--------+--------+-------+------|
2832 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
2833 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
2834 |---+---------+--------+--------+--------+-------+------|
2835 |   | Average |        |        |        |  29.7 |      |
2836 | ^ |         |        |        |        |    at |      |
2837 | $ | max=50  |        |        |        |       |      |
2838 |---+---------+--------+--------+--------+-------+------|
2839 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2840 @end group
2841 @end example
2842
2843 @noindent @b{Important}: please note that for these special tables,
2844 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2845 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2846 to the field itself.  The column formulas are not applied in rows with
2847 empty first field.
2848
2849 @cindex marking characters, tables
2850 The marking characters have the following meaning:
2851 @table @samp
2852 @item !
2853 The fields in this line define names for the columns, so that you may
2854 refer to a column as @samp{$Tot} instead of @samp{$6}.
2855 @item ^
2856 This row defines names for the fields @emph{above} the row.  With such
2857 a definition, any formula in the table may use @samp{$m1} to refer to
2858 the value @samp{10}.  Also, if you assign a formula to a names field, it
2859 will be stored as @samp{$name=...}.
2860 @item _
2861 Similar to @samp{^}, but defines names for the fields in the row
2862 @emph{below}.
2863 @item $
2864 Fields in this row can define @emph{parameters} for formulas.  For
2865 example, if a field in a @samp{$} row contains @samp{max=50}, then
2866 formulas in this table can refer to the value 50 using @samp{$max}.
2867 Parameters work exactly like constants, only that they can be defined on
2868 a per-table basis.
2869 @item #
2870 Fields in this row are automatically recalculated when pressing
2871 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
2872 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
2873 lines will be left alone by this command.
2874 @item *
2875 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2876 not for automatic recalculation.  Use this when automatic
2877 recalculation slows down editing too much.
2878 @item
2879 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2880 All lines that should be recalculated should be marked with @samp{#}
2881 or @samp{*}.
2882 @item /
2883 Do not export this line.  Useful for lines that contain the narrowing
2884 @samp{<N>} markers or column group markers.
2885 @end table
2886
2887 Finally, just to whet your appetite for what can be done with the
2888 fantastic @file{calc.el} package, here is a table that computes the Taylor
2889 series of degree @code{n} at location @code{x} for a couple of
2890 functions.
2891
2892 @example
2893 @group
2894 |---+-------------+---+-----+--------------------------------------|
2895 |   | Func        | n | x   | Result                               |
2896 |---+-------------+---+-----+--------------------------------------|
2897 | # | exp(x)      | 1 | x   | 1 + x                                |
2898 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
2899 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
2900 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2901 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
2902 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
2903 |---+-------------+---+-----+--------------------------------------|
2904 #+TBLFM: $5=taylor($2,$4,$3);n3
2905 @end group
2906 @end example
2907
2908 @node Org-Plot,  , The spreadsheet, Tables
2909 @section Org-Plot
2910 @cindex graph, in tables
2911 @cindex plot tables using Gnuplot
2912 @cindex #+PLOT
2913
2914 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2915 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2916 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}.  To see
2917 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2918 on your system, then call @code{org-plot/gnuplot} on the following table.
2919
2920 @example
2921 @group
2922 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2923 | Sede      | Max cites | H-index |
2924 |-----------+-----------+---------|
2925 | Chile     |    257.72 |   21.39 |
2926 | Leeds     |    165.77 |   19.68 |
2927 | Sao Paolo |     71.00 |   11.50 |
2928 | Stockholm |    134.19 |   14.33 |
2929 | Morelia   |    257.56 |   17.67 |
2930 @end group
2931 @end example
2932
2933 Notice that Org Plot is smart enough to apply the table's headers as labels.
2934 Further control over the labels, type, content, and appearance of plots can
2935 be exercised through the @code{#+PLOT:} lines preceding a table.  See below
2936 for a complete list of Org-plot options.  For more information and examples
2937 see the Org-plot tutorial at
2938 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
2939
2940 @subsubheading Plot Options
2941
2942 @table @code
2943 @item set
2944 Specify any @command{gnuplot} option to be set when graphing.
2945
2946 @item title
2947 Specify the title of the plot.
2948
2949 @item ind
2950 Specify which column of the table to use as the @code{x} axis.
2951
2952 @item deps
2953 Specify the columns to graph as a Lisp style list, surrounded by parentheses
2954 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2955 fourth columns (defaults to graphing all other columns aside from the @code{ind}
2956 column).
2957
2958 @item type
2959 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2960
2961 @item with
2962 Specify a @code{with} option to be inserted for every col being plotted
2963 (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2964 Defaults to @code{lines}.
2965
2966 @item file
2967 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
2968
2969 @item labels
2970 List of labels to be used for the @code{deps} (defaults to the column headers
2971 if they exist).
2972
2973 @item line
2974 Specify an entire line to be inserted in the Gnuplot script.
2975
2976 @item map
2977 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2978 flat mapping rather than a @code{3d} slope.
2979
2980 @item timefmt
2981 Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
2982 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
2983
2984 @item script
2985 If you want total control, you can specify a script file (place the file name
2986 between double-quotes) which will be used to plot.  Before plotting, every
2987 instance of @code{$datafile} in the specified script will be replaced with
2988 the path to the generated data file.  Note: even if you set this option, you
2989 may still want to specify the plot type, as that can impact the content of
2990 the data file.
2991 @end table
2992
2993 @node Hyperlinks, TODO Items, Tables, Top
2994 @chapter Hyperlinks
2995 @cindex hyperlinks
2996
2997 Like HTML, Org provides links inside a file, external links to
2998 other files, Usenet articles, emails, and much more.
2999
3000 @menu
3001 * Link format::                 How links in Org are formatted
3002 * Internal links::              Links to other places in the current file
3003 * External links::              URL-like links to the world
3004 * Handling links::              Creating, inserting and following
3005 * Using links outside Org::     Linking from my C source code?
3006 * Link abbreviations::          Shortcuts for writing complex links
3007 * Search options::              Linking to a specific location
3008 * Custom searches::             When the default search is not enough
3009 @end menu
3010
3011 @node Link format, Internal links, Hyperlinks, Hyperlinks
3012 @section Link format
3013 @cindex link format
3014 @cindex format, of links
3015
3016 Org will recognize plain URL-like links and activate them as
3017 clickable links.  The general link format, however, looks like this:
3018
3019 @example
3020 [[link][description]]       @r{or alternatively}           [[link]]
3021 @end example
3022
3023 @noindent
3024 Once a link in the buffer is complete (all brackets present), Org
3025 will change the display so that @samp{description} is displayed instead
3026 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3027 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
3028 which by default is an underlined face.  You can directly edit the
3029 visible part of a link.  Note that this can be either the @samp{link}
3030 part (if there is no description) or the @samp{description} part.  To
3031 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3032 cursor on the link.
3033
3034 If you place the cursor at the beginning or just behind the end of the
3035 displayed text and press @key{BACKSPACE}, you will remove the
3036 (invisible) bracket at that location.  This makes the link incomplete
3037 and the internals are again displayed as plain text.  Inserting the
3038 missing bracket hides the link internals again.  To show the
3039 internal structure of all links, use the menu entry
3040 @code{Org->Hyperlinks->Literal links}.
3041
3042 @node Internal links, External links, Link format, Hyperlinks
3043 @section Internal links
3044 @cindex internal links
3045 @cindex links, internal
3046 @cindex targets, for links
3047
3048 @cindex property, CUSTOM_ID
3049 If the link does not look like a URL, it is considered to be internal in the
3050 current file.  The most important case is a link like
3051 @samp{[[#my-custom-id]]} which will link to the entry with the
3052 @code{CUSTOM_ID} property @samp{my-custom-id}.  Such custom IDs are very good
3053 for HTML export (@pxref{HTML export}) where they produce pretty section
3054 links.  You are responsible yourself to make sure these custom IDs are unique
3055 in a file.
3056
3057 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3058 lead to a text search in the current file.
3059
3060 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3061 or with a mouse click (@pxref{Handling links}).  Links to custom IDs will
3062 point to the corresponding headline.  The preferred match for a text link is
3063 a @i{dedicated target}: the same string in double angular brackets.  Targets
3064 may be located anywhere; sometimes it is convenient to put them into a
3065 comment line.  For example
3066
3067 @example
3068 # <<My Target>>
3069 @end example
3070
3071 @noindent In HTML export (@pxref{HTML export}), such targets will become
3072 named anchors for direct access through @samp{http} links@footnote{Note that
3073 text before the first headline is usually not exported, so the first such
3074 target should be after the first headline, or in the line directly before the
3075 first headline.}.
3076
3077 If no dedicated target exists, Org will search for a headline that is exactly
3078 the link text but may also include a TODO keyword and tags@footnote{To insert
3079 a link targeting a headline, in-buffer completion can be used.  Just type a
3080 star followed by a few optional letters into the buffer and press
3081 @kbd{M-@key{TAB}}.  All headlines in the current buffer will be offered as
3082 completions.}.  In non-Org files, the search will look for the words in the
3083 link text.  In the above example the search would be for @samp{my target}.
3084
3085 Following a link pushes a mark onto Org's own mark ring.  You can
3086 return to the previous position with @kbd{C-c &}.  Using this command
3087 several times in direct succession goes back to positions recorded
3088 earlier.
3089
3090 @menu
3091 * Radio targets::               Make targets trigger links in plain text
3092 @end menu
3093
3094 @node Radio targets,  , Internal links, Internal links
3095 @subsection Radio targets
3096 @cindex radio targets
3097 @cindex targets, radio
3098 @cindex links, radio targets
3099
3100 Org can automatically turn any occurrences of certain target names
3101 in normal text into a link.  So without explicitly creating a link, the
3102 text connects to the target radioing its position.  Radio targets are
3103 enclosed by triple angular brackets.  For example, a target @samp{<<<My
3104 Target>>>} causes each occurrence of @samp{my target} in normal text to
3105 become activated as a link.  The Org file is scanned automatically
3106 for radio targets only when the file is first loaded into Emacs.  To
3107 update the target list during editing, press @kbd{C-c C-c} with the
3108 cursor on or at a target.
3109
3110 @node External links, Handling links, Internal links, Hyperlinks
3111 @section External links
3112 @cindex links, external
3113 @cindex external links
3114 @cindex links, external
3115 @cindex Gnus links
3116 @cindex BBDB links
3117 @cindex IRC links
3118 @cindex URL links
3119 @cindex file links
3120 @cindex VM links
3121 @cindex RMAIL links
3122 @cindex WANDERLUST links
3123 @cindex MH-E links
3124 @cindex USENET links
3125 @cindex SHELL links
3126 @cindex Info links
3127 @cindex Elisp links
3128
3129 Org supports links to files, websites, Usenet and email messages,
3130 BBDB database entries and links to both IRC conversations and their
3131 logs.  External links are URL-like locators.  They start with a short
3132 identifying string followed by a colon.  There can be no space after
3133 the colon.  The following list shows examples for each link type.
3134
3135 @example
3136 http://www.astro.uva.nl/~dominik          @r{on the web}
3137 doi:10.1000/182                           @r{DOI for an electronic resource}
3138 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
3139 /home/dominik/images/jupiter.jpg          @r{same as above}
3140 file:papers/last.pdf                      @r{file, relative path}
3141 ./papers/last.pdf                         @r{same as above}
3142 file:/myself@@some.where:papers/last.pdf   @r{file, path on remote machine}
3143 /myself@@some.where:papers/last.pdf        @r{same as above}
3144 file:sometextfile::NNN                    @r{file with line number to jump to}
3145 file:projects.org                         @r{another Org file}
3146 file:projects.org::some words             @r{text search in Org file}
3147 file:projects.org::*task title            @r{heading search in Org file}
3148 docview:papers/last.pdf::NNN              @r{open file in doc-view mode at page NNN}
3149 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
3150 news:comp.emacs                           @r{Usenet link}
3151 mailto:adent@@galaxy.net                   @r{Mail link}
3152 vm:folder                                 @r{VM folder link}
3153 vm:folder#id                              @r{VM message link}
3154 vm://myself@@some.where.org/folder#id      @r{VM on remote machine}
3155 wl:folder                                 @r{WANDERLUST folder link}
3156 wl:folder#id                              @r{WANDERLUST message link}
3157 mhe:folder                                @r{MH-E folder link}
3158 mhe:folder#id                             @r{MH-E message link}
3159 rmail:folder                              @r{RMAIL folder link}
3160 rmail:folder#id                           @r{RMAIL message link}
3161 gnus:group                                @r{Gnus group link}
3162 gnus:group#id                             @r{Gnus article link}
3163 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
3164 irc:/irc.com/#emacs/bob                   @r{IRC link}
3165 info:org#External%20links                 @r{Info node link (with encoded space)}
3166 shell:ls *.org                            @r{A shell command}
3167 elisp:org-agenda                          @r{Interactive Elisp command}
3168 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3169 @end example
3170
3171 For customizing Org to add new link types @ref{Adding hyperlink types}.
3172
3173 A link should be enclosed in double brackets and may contain a
3174 descriptive text to be displayed instead of the URL (@pxref{Link
3175 format}), for example:
3176
3177 @example
3178 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3179 @end example
3180
3181 @noindent
3182 If the description is a file name or URL that points to an image, HTML
3183 export (@pxref{HTML export}) will inline the image as a clickable
3184 button.  If there is no description at all and the link points to an
3185 image,
3186 that image will be inlined into the exported HTML file.
3187
3188 @cindex square brackets, around links
3189 @cindex plain text external links
3190 Org also finds external links in the normal text and activates them
3191 as links.  If spaces must be part of the link (for example in
3192 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3193 about the end of the link, enclose them in square brackets.
3194
3195 @node Handling links, Using links outside Org, External links, Hyperlinks
3196 @section Handling links
3197 @cindex links, handling
3198
3199 Org provides methods to create a link in the correct syntax, to
3200 insert it into an Org file, and to follow the link.
3201
3202 @table @kbd
3203 @orgcmd{C-c l,org-store-link}
3204 @cindex storing links
3205 Store a link to the current location.  This is a @emph{global} command (you
3206 must create the key binding yourself) which can be used in any buffer to
3207 create a link.  The link will be stored for later insertion into an Org
3208 buffer (see below).  What kind of link will be created depends on the current
3209 buffer:
3210
3211 @b{Org-mode buffers}@*
3212 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3213 to the target.  Otherwise it points to the current headline, which will also
3214 be the description@footnote{If the headline contains a timestamp, it will be
3215 removed from the link and result in a wrong link -- you should avoid putting
3216 timestamp in the headline.}.
3217
3218 @vindex org-link-to-org-use-id
3219 @cindex property, CUSTOM_ID
3220 @cindex property, ID
3221 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3222 will be stored.  In addition or alternatively (depending on the value of
3223 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3224 created and/or used to construct a link.  So using this command in Org
3225 buffers will potentially create two links: a human-readable from the custom
3226 ID, and one that is globally unique and works even if the entry is moved from
3227 file to file.  Later, when inserting the link, you need to decide which one
3228 to use.
3229
3230 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3231 Pretty much all Emacs mail clients are supported.  The link will point to the
3232 current article, or, in some GNUS buffers, to the group.  The description is
3233 constructed from the author and the subject.
3234
3235 @b{Web browsers: W3 and W3M}@*
3236 Here the link will be the current URL, with the page title as description.
3237
3238 @b{Contacts: BBDB}@*
3239 Links created in a BBDB buffer will point to the current entry.
3240
3241 @b{Chat: IRC}@*
3242 @vindex org-irc-link-to-logs
3243 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3244 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3245 the current conversation is created.  Otherwise an @samp{irc:/} style link to
3246 the user/channel/server under the point will be stored.
3247
3248 @b{Other files}@*
3249 For any other files, the link will point to the file, with a search string
3250 (@pxref{Search options}) pointing to the contents of the current line.  If
3251 there is an active region, the selected words will form the basis of the
3252 search string.  If the automatically created link is not working correctly or
3253 accurately enough, you can write custom functions to select the search string
3254 and to do the search for particular file types---see @ref{Custom searches}.
3255 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3256
3257 @b{Agenda view}@*
3258 When the cursor is in an agenda view, the created link points to the
3259 entry referenced by the current line.
3260
3261 @c
3262 @orgcmd{C-c C-l,org-insert-link}
3263 @cindex link completion
3264 @cindex completion, of links
3265 @cindex inserting links
3266 @vindex org-keep-stored-link-after-insertion
3267 Insert a link@footnote{ Note that you don't have to use this command to
3268 insert a link.  Links in Org are plain text, and you can type or paste them
3269 straight into the buffer.  By using this command, the links are automatically
3270 enclosed in double brackets, and you will be asked for the optional
3271 descriptive text.}.  This prompts for a link to be inserted into the buffer.
3272 You can just type a link, using text for an internal link, or one of the link
3273 type prefixes mentioned in the examples above.  The link will be inserted
3274 into the buffer@footnote{After insertion of a stored link, the link will be
3275 removed from the list of stored links.  To keep it in the list later use, use
3276 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3277 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3278 If some text was selected when this command is called, the selected text
3279 becomes the default description.
3280
3281 @b{Inserting stored links}@*
3282 All links stored during the
3283 current session are part of the history for this prompt, so you can access
3284 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3285
3286 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3287 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3288 defined through link abbreviations (@pxref{Link abbreviations}).  If you
3289 press @key{RET} after inserting only the @var{prefix}, Org will offer
3290 specific completion support for some link types@footnote{This works by
3291 calling a special function @code{org-PREFIX-complete-link}.}  For
3292 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3293 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3294 @key{RET}} you can complete contact names.
3295 @orgkey C-u C-c C-l
3296 @cindex file name completion
3297 @cindex completion, of file names
3298 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3299 a file will be inserted and you may use file name completion to select
3300 the name of the file.  The path to the file is inserted relative to the
3301 directory of the current Org file, if the linked file is in the current
3302 directory or in a sub-directory of it, or if the path is written relative
3303 to the current directory using @samp{../}.  Otherwise an absolute path
3304 is used, if possible with @samp{~/} for your home directory.  You can
3305 force an absolute path with two @kbd{C-u} prefixes.
3306 @c
3307 @item C-c C-l @ @r{(with cursor on existing link)}
3308 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3309 link and description parts of the link.
3310 @c
3311 @cindex following links
3312 @orgcmd{C-c C-o,org-open-at-point}
3313 @vindex org-file-apps
3314 Open link at point.  This will launch a web browser for URLs (using
3315 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3316 the corresponding links, and execute the command in a shell link.  When the
3317 cursor is on an internal link, this command runs the corresponding search.
3318 When the cursor is on a TAG list in a headline, it creates the corresponding
3319 TAGS view.  If the cursor is on a timestamp, it compiles the agenda for that
3320 date.  Furthermore, it will visit text and remote files in @samp{file:} links
3321 with Emacs and select a suitable application for local non-text files.
3322 Classification of files is based on file extension only.  See option
3323 @code{org-file-apps}.  If you want to override the default application and
3324 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
3325 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3326 If the cursor is on a headline, but not on a link, offer all links in the
3327 headline and entry text.
3328 @orgkey @key{RET}
3329 @vindex org-return-follows-link
3330 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3331 the link at point.
3332 @c
3333 @kindex mouse-2
3334 @kindex mouse-1
3335 @item mouse-2
3336 @itemx mouse-1
3337 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3338 would.  Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3339 @c
3340 @kindex mouse-3
3341 @item mouse-3
3342 @vindex org-display-internal-link-with-indirect-buffer
3343 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3344 internal links to be displayed in another window@footnote{See the
3345 variable @code{org-display-internal-link-with-indirect-buffer}}.
3346 @c
3347 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3348 @cindex inlining images
3349 @cindex images, inlining
3350 @vindex org-startup-with-inline-images
3351 @cindex @code{inlineimages}, STARTUP keyword
3352 @cindex @code{noinlineimages}, STARTUP keyword
3353 Toggle the inline display of linked images.  Normally this will only inline
3354 images that have no description part in the link, i.e.@: images that will also
3355 be inlined during export.  When called with a prefix argument, also display
3356 images that do have a link description.  You can ask for inline images to be
3357 displayed at startup by configuring the variable
3358 @code{org-startup-with-inline-images}@footnote{with corresponding
3359 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3360 @orgcmd{C-c %,org-mark-ring-push}
3361 @cindex mark ring
3362 Push the current position onto the mark ring, to be able to return
3363 easily.  Commands following an internal link do this automatically.
3364 @c
3365 @orgcmd{C-c &,org-mark-ring-goto}
3366 @cindex links, returning to
3367 Jump back to a recorded position.  A position is recorded by the
3368 commands following internal links, and by @kbd{C-c %}.  Using this
3369 command several times in direct succession moves through a ring of
3370 previously recorded positions.
3371 @c
3372 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3373 @cindex links, finding next/previous
3374 Move forward/backward to the next link in the buffer.  At the limit of
3375 the buffer, the search fails once, and then wraps around.  The key
3376 bindings for this are really too long; you might want to bind this also
3377 to @kbd{C-n} and @kbd{C-p}
3378 @lisp
3379 (add-hook 'org-load-hook
3380   (lambda ()
3381     (define-key org-mode-map "\C-n" 'org-next-link)
3382     (define-key org-mode-map "\C-p" 'org-previous-link)))
3383 @end lisp
3384 @end table
3385
3386 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3387 @section Using links outside Org
3388
3389 You can insert and follow links that have Org syntax not only in
3390 Org, but in any Emacs buffer.  For this, you should create two
3391 global commands, like this (please select suitable global keys
3392 yourself):
3393
3394 @lisp
3395 (global-set-key "\C-c L" 'org-insert-link-global)
3396 (global-set-key "\C-c o" 'org-open-at-point-global)
3397 @end lisp
3398
3399 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3400 @section Link abbreviations
3401 @cindex link abbreviations
3402 @cindex abbreviation, links
3403
3404 Long URLs can be cumbersome to type, and often many similar links are
3405 needed in a document.  For this you can use link abbreviations.  An
3406 abbreviated link looks like this
3407
3408 @example
3409 [[linkword:tag][description]]
3410 @end example
3411
3412 @noindent
3413 @vindex org-link-abbrev-alist
3414 where the tag is optional.
3415 The @i{linkword} must be a word, starting with a letter, followed by
3416 letters, numbers, @samp{-}, and @samp{_}.  Abbreviations are resolved
3417 according to the information in the variable @code{org-link-abbrev-alist}
3418 that relates the linkwords to replacement text.  Here is an example:
3419
3420 @smalllisp
3421 @group
3422 (setq org-link-abbrev-alist
3423   '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3424     ("google"   . "http://www.google.com/search?q=")
3425     ("gmap"     . "http://maps.google.com/maps?q=%s")
3426     ("omap"     . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3427     ("ads"      . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3428 @end group
3429 @end smalllisp
3430
3431 If the replacement text contains the string @samp{%s}, it will be
3432 replaced with the tag.  Otherwise the tag will be appended to the string
3433 in order to create the link.  You may also specify a function that will
3434 be called with the tag as the only argument to create the link.
3435
3436 With the above setting, you could link to a specific bug with
3437 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3438 @code{[[google:OrgMode]]}, show the map location of the Free Software
3439 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3440 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3441 what the Org author is doing besides Emacs hacking with
3442 @code{[[ads:Dominik,C]]}.
3443
3444 If you need special abbreviations just for a single Org buffer, you
3445 can define them in the file with
3446
3447 @cindex #+LINK
3448 @example
3449 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
3450 #+LINK: google    http://www.google.com/search?q=%s
3451 @end example
3452
3453 @noindent
3454 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3455 complete link abbreviations.  You may also define a function
3456 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
3457 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
3458 not accept any arguments, and return the full link with prefix.
3459
3460 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3461 @section Search options in file links
3462 @cindex search option in file links
3463 @cindex file links, searching
3464
3465 File links can contain additional information to make Emacs jump to a
3466 particular location in the file when following a link.  This can be a
3467 line number or a search option after a double@footnote{For backward
3468 compatibility, line numbers can also follow a single colon.} colon.  For
3469 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3470 links}) to a file, it encodes the words in the current line as a search
3471 string that can be used to find this line back later when following the
3472 link with @kbd{C-c C-o}.
3473
3474 Here is the syntax of the different ways to attach a search to a file
3475 link, together with an explanation:
3476
3477 @example
3478 [[file:~/code/main.c::255]]
3479 [[file:~/xx.org::My Target]]
3480 [[file:~/xx.org::*My Target]]
3481 [[file:~/xx.org::#my-custom-id]]
3482 [[file:~/xx.org::/regexp/]]
3483 @end example
3484
3485 @table @code
3486 @item 255
3487 Jump to line 255.
3488 @item My Target
3489 Search for a link target @samp{<<My Target>>}, or do a text search for
3490 @samp{my target}, similar to the search in internal links, see
3491 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
3492 link will become an HTML reference to the corresponding named anchor in
3493 the linked file.
3494 @item *My Target
3495 In an Org file, restrict search to headlines.
3496 @item #my-custom-id
3497 Link to a heading with a @code{CUSTOM_ID} property
3498 @item /regexp/
3499 Do a regular expression search for @code{regexp}.  This uses the Emacs
3500 command @code{occur} to list all matches in a separate window.  If the
3501 target file is in Org-mode, @code{org-occur} is used to create a
3502 sparse tree with the matches.
3503 @c If the target file is a directory,
3504 @c @code{grep} will be used to search all files in the directory.
3505 @end table
3506
3507 As a degenerate case, a file link with an empty file name can be used
3508 to search the current file.  For example, @code{[[file:::find me]]} does
3509 a search for @samp{find me} in the current file, just as
3510 @samp{[[find me]]} would.
3511
3512 @node Custom searches,  , Search options, Hyperlinks
3513 @section Custom Searches
3514 @cindex custom search strings
3515 @cindex search strings, custom
3516
3517 The default mechanism for creating search strings and for doing the
3518 actual search related to a file link may not work correctly in all
3519 cases.  For example, Bib@TeX{} database files have many entries like
3520 @samp{year="1993"} which would not result in good search strings,
3521 because the only unique identification for a Bib@TeX{} entry is the
3522 citation key.
3523
3524 @vindex org-create-file-search-functions
3525 @vindex org-execute-file-search-functions
3526 If you come across such a problem, you can write custom functions to set
3527 the right search string for a particular file type, and to do the search
3528 for the string in the file.  Using @code{add-hook}, these functions need
3529 to be added to the hook variables
3530 @code{org-create-file-search-functions} and
3531 @code{org-execute-file-search-functions}.  See the docstring for these
3532 variables for more information.  Org actually uses this mechanism
3533 for Bib@TeX{} database files, and you can use the corresponding code as
3534 an implementation example.  See the file @file{org-bibtex.el}.
3535
3536 @node TODO Items, Tags, Hyperlinks, Top
3537 @chapter TODO items
3538 @cindex TODO items
3539
3540 Org-mode does not maintain TODO lists as separate documents@footnote{Of
3541 course, you can make a document that contains only long lists of TODO items,
3542 but this is not required.}.  Instead, TODO items are an integral part of the
3543 notes file, because TODO items usually come up while taking notes!  With Org
3544 mode, simply mark any entry in a tree as being a TODO item.  In this way,
3545 information is not duplicated, and the entire context from which the TODO
3546 item emerged is always present.
3547
3548 Of course, this technique for managing TODO items scatters them
3549 throughout your notes file.  Org-mode compensates for this by providing
3550 methods to give you an overview of all the things that you have to do.
3551
3552 @menu
3553 * TODO basics::                 Marking and displaying TODO entries
3554 * TODO extensions::             Workflow and assignments
3555 * Progress logging::            Dates and notes for progress
3556 * Priorities::                  Some things are more important than others
3557 * Breaking down tasks::         Splitting a task into manageable pieces
3558 * Checkboxes::                  Tick-off lists
3559 @end menu
3560
3561 @node TODO basics, TODO extensions, TODO Items, TODO Items
3562 @section Basic TODO functionality
3563
3564 Any headline becomes a TODO item when it starts with the word
3565 @samp{TODO}, for example:
3566
3567 @example
3568 *** TODO Write letter to Sam Fortune
3569 @end example
3570
3571 @noindent
3572 The most important commands to work with TODO entries are:
3573
3574 @table @kbd
3575 @orgcmd{C-c C-t,org-todo}
3576 @cindex cycling, of TODO states
3577 Rotate the TODO state of the current item among
3578
3579 @example
3580 ,-> (unmarked) -> TODO -> DONE --.
3581 '--------------------------------'
3582 @end example
3583
3584 The same rotation can also be done ``remotely'' from the timeline and
3585 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3586
3587 @orgkey{C-u C-c C-t}
3588 Select a specific keyword using completion or (if it has been set up)
3589 the fast selection interface.  For the latter, you need to assign keys
3590 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3591 more information.
3592
3593 @kindex S-@key{right}
3594 @kindex S-@key{left}
3595 @item S-@key{right} @ @r{/} @ S-@key{left}
3596 @vindex org-treat-S-cursor-todo-selection-as-state-change
3597 Select the following/preceding TODO state, similar to cycling.  Useful
3598 mostly if more than two TODO states are possible (@pxref{TODO
3599 extensions}).  See also @ref{Conflicts}, for a discussion of the interaction
3600 with @code{shift-selection-mode}.  See also the variable
3601 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3602 @orgcmd{C-c / t,org-show-todo-key}
3603 @cindex sparse tree, for TODO
3604 @vindex org-todo-keywords
3605 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
3606 entire buffer, but shows all TODO items (with not-DONE state) and the
3607 headings hierarchy above them.  With a prefix argument (or by using @kbd{C-c
3608 / T}), search for a specific TODO.  You will be prompted for the keyword, and
3609 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3610 entries that match any one of these keywords.  With a numeric prefix argument
3611 N, show the tree for the Nth keyword in the variable
3612 @code{org-todo-keywords}.  With two prefix arguments, find all TODO states,
3613 both un-done and done.
3614 @orgcmd{C-c a t,org-todo-list}
3615 Show the global TODO list.  Collects the TODO items (with not-DONE states)
3616 from all agenda files (@pxref{Agenda Views}) into a single buffer.  The new
3617 buffer will be in @code{agenda-mode}, which provides commands to examine and
3618 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3619 @xref{Global TODO list}, for more information.
3620 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3621 Insert a new TODO entry below the current one.
3622 @end table
3623
3624 @noindent
3625 @vindex org-todo-state-tags-triggers
3626 Changing a TODO state can also trigger tag changes.  See the docstring of the
3627 option @code{org-todo-state-tags-triggers} for details.
3628
3629 @node TODO extensions, Progress logging, TODO basics, TODO Items
3630 @section Extended use of TODO keywords
3631 @cindex extended TODO keywords
3632
3633 @vindex org-todo-keywords
3634 By default, marked TODO entries have one of only two states: TODO and
3635 DONE.  Org-mode allows you to classify TODO items in more complex ways
3636 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
3637 special setup, the TODO keyword system can work differently in different
3638 files.
3639
3640 Note that @i{tags} are another way to classify headlines in general and
3641 TODO items in particular (@pxref{Tags}).
3642
3643 @menu
3644 * Workflow states::             From TODO to DONE in steps
3645 * TODO types::                  I do this, Fred does the rest
3646 * Multiple sets in one file::   Mixing it all, and still finding your way
3647 * Fast access to TODO states::  Single letter selection of a state
3648 * Per-file keywords::           Different files, different requirements
3649 * Faces for TODO keywords::     Highlighting states
3650 * TODO dependencies::           When one task needs to wait for others
3651 @end menu
3652
3653 @node Workflow states, TODO types, TODO extensions, TODO extensions
3654 @subsection TODO keywords as workflow states
3655 @cindex TODO workflow
3656 @cindex workflow states as TODO keywords
3657
3658 You can use TODO keywords to indicate different @emph{sequential} states
3659 in the process of working on an item, for example@footnote{Changing
3660 this variable only becomes effective after restarting Org-mode in a
3661 buffer.}:
3662
3663 @lisp
3664 (setq org-todo-keywords
3665   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3666 @end lisp
3667
3668 The vertical bar separates the TODO keywords (states that @emph{need
3669 action}) from the DONE states (which need @emph{no further action}).  If
3670 you don't provide the separator bar, the last state is used as the DONE
3671 state.
3672 @cindex completion, of TODO keywords
3673 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3674 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.  You may
3675 also use a numeric prefix argument to quickly select a specific state.  For
3676 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3677 Or you can use @kbd{S-@key{left}} to go backward through the sequence.  If you
3678 define many keywords, you can use in-buffer completion
3679 (@pxref{Completion}) or even a special one-key selection scheme
3680 (@pxref{Fast access to TODO states}) to insert these words into the
3681 buffer.  Changing a TODO state can be logged with a timestamp, see
3682 @ref{Tracking TODO state changes}, for more information.
3683
3684 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3685 @subsection TODO keywords as types
3686 @cindex TODO types
3687 @cindex names as TODO keywords
3688 @cindex types as TODO keywords
3689
3690 The second possibility is to use TODO keywords to indicate different
3691 @emph{types} of action items.  For example, you might want to indicate
3692 that items are for ``work'' or ``home''.  Or, when you work with several
3693 people on a single project, you might want to assign action items
3694 directly to persons, by using their names as TODO keywords.  This would
3695 be set up like this:
3696
3697 @lisp
3698 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3699 @end lisp
3700
3701 In this case, different keywords do not indicate a sequence, but rather
3702 different types.  So the normal work flow would be to assign a task to a
3703 person, and later to mark it DONE.  Org-mode supports this style by adapting
3704 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3705 @kbd{t} command in the timeline and agenda buffers.}.  When used several
3706 times in succession, it will still cycle through all names, in order to first
3707 select the right type for a task.  But when you return to the item after some
3708 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3709 to DONE.  Use prefix arguments or completion to quickly select a specific
3710 name.  You can also review the items of a specific TODO type in a sparse tree
3711 by using a numeric prefix to @kbd{C-c / t}.  For example, to see all things
3712 Lucy has to do, you would use @kbd{C-3 C-c / t}.  To collect Lucy's items
3713 from all agenda files into a single buffer, you would use the numeric prefix
3714 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3715
3716 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3717 @subsection Multiple keyword sets in one file
3718 @cindex TODO keyword sets
3719
3720 Sometimes you may want to use different sets of TODO keywords in
3721 parallel.  For example, you may want to have the basic
3722 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3723 separate state indicating that an item has been canceled (so it is not
3724 DONE, but also does not require action).  Your setup would then look
3725 like this:
3726
3727 @lisp
3728 (setq org-todo-keywords
3729       '((sequence "TODO" "|" "DONE")
3730         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3731         (sequence "|" "CANCELED")))
3732 @end lisp
3733
3734 The keywords should all be different, this helps Org-mode to keep track
3735 of which subsequence should be used for a given entry.  In this setup,
3736 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3737 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3738 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
3739 select the correct sequence.  Besides the obvious ways like typing a
3740 keyword or using completion, you may also apply the following commands:
3741
3742 @table @kbd
3743 @kindex C-S-@key{right}
3744 @kindex C-S-@key{left}
3745 @kindex C-u C-u C-c C-t
3746 @item C-u C-u C-c C-t
3747 @itemx C-S-@key{right}
3748 @itemx C-S-@key{left}
3749 These keys jump from one TODO subset to the next.  In the above example,
3750 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3751 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3752 @code{CANCELED}.  Note that the @kbd{C-S-} key binding conflict with
3753 @code{shift-selection-mode} (@pxref{Conflicts}).
3754 @kindex S-@key{right}
3755 @kindex S-@key{left}
3756 @item S-@key{right}
3757 @itemx S-@key{left}
3758 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3759 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3760 from @code{DONE} to @code{REPORT} in the example above.  See also
3761 @ref{Conflicts}, for a discussion of the interaction with
3762 @code{shift-selection-mode}.
3763 @end table
3764
3765 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3766 @subsection Fast access to TODO states
3767
3768 If you would like to quickly change an entry to an arbitrary TODO state
3769 instead of cycling through the states, you can set up keys for
3770 single-letter access to the states.  This is done by adding the section
3771 key after each keyword, in parentheses.  For example:
3772
3773 @lisp
3774 (setq org-todo-keywords
3775       '((sequence "TODO(t)" "|" "DONE(d)")
3776         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3777         (sequence "|" "CANCELED(c)")))
3778 @end lisp
3779
3780 @vindex org-fast-tag-selection-include-todo
3781 If you then press @kbd{C-c C-t} followed by the selection key, the entry
3782 will be switched to this state.  @kbd{SPC} can be used to remove any TODO
3783 keyword from an entry.@footnote{Check also the variable
3784 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3785 state through the tags interface (@pxref{Setting tags}), in case you like to
3786 mingle the two concepts.  Note that this means you need to come up with
3787 unique keys across both sets of keywords.}
3788
3789 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3790 @subsection Setting up keywords for individual files
3791 @cindex keyword options
3792 @cindex per-file keywords
3793 @cindex #+TODO
3794 @cindex #+TYP_TODO
3795 @cindex #+SEQ_TODO
3796
3797 It can be very useful to use different aspects of the TODO mechanism in
3798 different files.  For file-local settings, you need to add special lines
3799 to the file which set the keywords and interpretation for that file
3800 only.  For example, to set one of the two examples discussed above, you
3801 need one of the following lines, starting in column zero anywhere in the
3802 file:
3803
3804 @example
3805 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3806 @end example
3807 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3808 interpretation, but it means the same as @code{#+TODO}), or
3809 @example
3810 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3811 @end example
3812
3813 A setup for using several sets in parallel would be:
3814
3815 @example
3816 #+TODO: TODO | DONE
3817 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3818 #+TODO: | CANCELED
3819 @end example
3820
3821 @cindex completion, of option keywords
3822 @kindex M-@key{TAB}
3823 @noindent To make sure you are using the correct keyword, type
3824 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3825
3826 @cindex DONE, final TODO keyword
3827 Remember that the keywords after the vertical bar (or the last keyword
3828 if no bar is there) must always mean that the item is DONE (although you
3829 may use a different word).  After changing one of these lines, use
3830 @kbd{C-c C-c} with the cursor still in the line to make the changes
3831 known to Org-mode@footnote{Org-mode parses these lines only when
3832 Org-mode is activated after visiting a file.  @kbd{C-c C-c} with the
3833 cursor in a line starting with @samp{#+} is simply restarting Org-mode
3834 for the current buffer.}.
3835
3836 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3837 @subsection Faces for TODO keywords
3838 @cindex faces, for TODO keywords
3839
3840 @vindex org-todo @r{(face)}
3841 @vindex org-done @r{(face)}
3842 @vindex org-todo-keyword-faces
3843 Org-mode highlights TODO keywords with special faces: @code{org-todo}
3844 for keywords indicating that an item still has to be acted upon, and
3845 @code{org-done} for keywords indicating that an item is finished.  If
3846 you are using more than 2 different states, you might want to use
3847 special faces for some of them.  This can be done using the variable
3848 @code{org-todo-keyword-faces}.  For example:
3849
3850 @lisp
3851 @group
3852 (setq org-todo-keyword-faces
3853       '(("TODO" . org-warning) ("STARTED" . "yellow")
3854         ("CANCELED" . (:foreground "blue" :weight bold))))
3855 @end group
3856 @end lisp
3857
3858 While using a list with face properties as shown for CANCELED @emph{should}
3859 work, this does not aways seem to be the case.  If necessary, define a
3860 special face and use that.  A string is interpreted as a color.  The variable
3861 @code{org-faces-easy-properties} determines if that color is interpreted as a
3862 foreground or a background color.
3863
3864 @node TODO dependencies,  , Faces for TODO keywords, TODO extensions
3865 @subsection TODO dependencies
3866 @cindex TODO dependencies
3867 @cindex dependencies, of TODO states
3868
3869 @vindex org-enforce-todo-dependencies
3870 @cindex property, ORDERED
3871 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3872 dependencies.  Usually, a parent TODO task should not be marked DONE until
3873 all subtasks (defined as children tasks) are marked as DONE.  And sometimes
3874 there is a logical sequence to a number of (sub)tasks, so that one task
3875 cannot be acted upon before all siblings above it are done.  If you customize
3876 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3877 from changing state to DONE while they have children that are not DONE.
3878 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3879 will be blocked until all earlier siblings are marked DONE.  Here is an
3880 example:
3881
3882 @example
3883 * TODO Blocked until (two) is done
3884 ** DONE one
3885 ** TODO two
3886
3887 * Parent
3888   :PROPERTIES:
3889     :ORDERED: t
3890   :END:
3891 ** TODO a
3892 ** TODO b, needs to wait for (a)
3893 ** TODO c, needs to wait for (a) and (b)
3894 @end example
3895
3896 @table @kbd
3897 @orgcmd{C-c C-x o,org-toggle-ordered-property}
3898 @vindex org-track-ordered-property-with-tag
3899 @cindex property, ORDERED
3900 Toggle the @code{ORDERED} property of the current entry.  A property is used
3901 for this behavior because this should be local to the current entry, not
3902 inherited like a tag.  However, if you would like to @i{track} the value of
3903 this property with a tag for better visibility, customize the variable
3904 @code{org-track-ordered-property-with-tag}.
3905 @orgkey{C-u C-u C-u C-c C-t}
3906 Change TODO state, circumventing any state blocking.
3907 @end table
3908
3909 @vindex org-agenda-dim-blocked-tasks
3910 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3911 that cannot be closed because of such dependencies will be shown in a dimmed
3912 font or even made invisible in agenda views (@pxref{Agenda Views}).
3913
3914 @cindex checkboxes and TODO dependencies
3915 @vindex org-enforce-todo-dependencies
3916 You can also block changes of TODO states by looking at checkboxes
3917 (@pxref{Checkboxes}).  If you set the variable
3918 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3919 checkboxes will be blocked from switching to DONE.
3920
3921 If you need more complex dependency structures, for example dependencies
3922 between entries in different trees or files, check out the contributed
3923 module @file{org-depend.el}.
3924
3925 @page
3926 @node Progress logging, Priorities, TODO extensions, TODO Items
3927 @section Progress logging
3928 @cindex progress logging
3929 @cindex logging, of progress
3930
3931 Org-mode can automatically record a timestamp and possibly a note when
3932 you mark a TODO item as DONE, or even each time you change the state of
3933 a TODO item.  This system is highly configurable, settings can be on a
3934 per-keyword basis and can be localized to a file or even a subtree.  For
3935 information on how to clock working time for a task, see @ref{Clocking
3936 work time}.
3937
3938 @menu
3939 * Closing items::               When was this entry marked DONE?
3940 * Tracking TODO state changes::  When did the status change?
3941 * Tracking your habits::        How consistent have you been?
3942 @end menu
3943
3944 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3945 @subsection Closing items
3946
3947 The most basic logging is to keep track of @emph{when} a certain TODO
3948 item was finished.  This is achieved with@footnote{The corresponding
3949 in-buffer setting is: @code{#+STARTUP: logdone}}
3950
3951 @lisp
3952 (setq org-log-done 'time)
3953 @end lisp
3954
3955 @noindent
3956 Then each time you turn an entry from a TODO (not-done) state into any
3957 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3958 just after the headline.  If you turn the entry back into a TODO item
3959 through further state cycling, that line will be removed again.  If you
3960 want to record a note along with the timestamp, use@footnote{The
3961 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3962
3963 @lisp
3964 (setq org-log-done 'note)
3965 @end lisp
3966
3967 @noindent
3968 You will then be prompted for a note, and that note will be stored below
3969 the entry with a @samp{Closing Note} heading.
3970
3971 In the timeline (@pxref{Timeline}) and in the agenda
3972 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3973 display the TODO items with a @samp{CLOSED} timestamp on each day,
3974 giving you an overview of what has been done.
3975
3976 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
3977 @subsection Tracking TODO state changes
3978 @cindex drawer, for state change recording
3979
3980 @vindex org-log-states-order-reversed
3981 @vindex org-log-into-drawer
3982 @cindex property, LOG_INTO_DRAWER
3983 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3984 might want to keep track of when a state change occurred and maybe take a
3985 note about this change.  You can either record just a timestamp, or a
3986 time-stamped note for a change.  These records will be inserted after the
3987 headline as an itemized list, newest first@footnote{See the variable
3988 @code{org-log-states-order-reversed}}.  When taking a lot of notes, you might
3989 want to get the notes out of the way into a drawer (@pxref{Drawers}).
3990 Customize the variable @code{org-log-into-drawer} to get this
3991 behavior---the recommended drawer for this is called @code{LOGBOOK}.  You can
3992 also overrule the setting of this variable for a subtree by setting a
3993 @code{LOG_INTO_DRAWER} property.
3994
3995 Since it is normally too much to record a note for every state, Org-mode
3996 expects configuration on a per-keyword basis for this.  This is achieved by
3997 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
3998 in parentheses after each keyword.  For example, with the setting
3999
4000 @lisp
4001 (setq org-todo-keywords
4002   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4003 @end lisp
4004
4005 @noindent
4006 @vindex org-log-done
4007 you not only define global TODO keywords and fast access keys, but also
4008 request that a time is recorded when the entry is set to
4009 DONE@footnote{It is possible that Org-mode will record two timestamps
4010 when you are using both @code{org-log-done} and state change logging.
4011 However, it will never prompt for two notes---if you have configured
4012 both, the state change recording note will take precedence and cancel
4013 the @samp{Closing Note}.}, and that a note is recorded when switching to
4014 WAIT or CANCELED.  The setting for WAIT is even more special: the
4015 @samp{!} after the slash means that in addition to the note taken when
4016 entering the state, a timestamp should be recorded when @i{leaving} the
4017 WAIT state, if and only if the @i{target} state does not configure
4018 logging for entering it.  So it has no effect when switching from WAIT
4019 to DONE, because DONE is configured to record a timestamp only.  But
4020 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4021 setting now triggers a timestamp even though TODO has no logging
4022 configured.
4023
4024 You can use the exact same syntax for setting logging preferences local
4025 to a buffer:
4026 @example
4027 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4028 @end example
4029
4030 @cindex property, LOGGING
4031 In order to define logging settings that are local to a subtree or a
4032 single item, define a LOGGING property in this entry.  Any non-empty
4033 LOGGING property resets all logging settings to nil.  You may then turn
4034 on logging for this specific tree using STARTUP keywords like
4035 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4036 settings like @code{TODO(!)}.  For example
4037
4038 @example
4039 * TODO Log each state with only a time
4040   :PROPERTIES:
4041   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4042   :END:
4043 * TODO Only log when switching to WAIT, and when repeating
4044   :PROPERTIES:
4045   :LOGGING: WAIT(@@) logrepeat
4046   :END:
4047 * TODO No logging at all
4048   :PROPERTIES:
4049   :LOGGING: nil
4050   :END:
4051 @end example
4052
4053 @node Tracking your habits,  , Tracking TODO state changes, Progress logging
4054 @subsection Tracking your habits
4055 @cindex habits
4056
4057 Org has the ability to track the consistency of a special category of TODOs,
4058 called ``habits''.  A habit has the following properties:
4059
4060 @enumerate
4061 @item
4062 You have enabled the @code{habits} module by customizing the variable
4063 @code{org-modules}.
4064 @item
4065 The habit is a TODO item, with a TODO keyword representing an open state.
4066 @item
4067 The property @code{STYLE} is set to the value @code{habit}.
4068 @item
4069 The TODO has a scheduled date, usually with a @code{.+} style repeat
4070 interval.  A @code{++} style may be appropriate for habits with time
4071 constraints, e.g., must be done on weekends, or a @code{+} style for an
4072 unusual habit that can have a backlog, e.g., weekly reports.
4073 @item
4074 The TODO may also have minimum and maximum ranges specified by using the
4075 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4076 three days, but at most every two days.
4077 @item
4078 You must also have state logging for the @code{DONE} state enabled, in order
4079 for historical data to be represented in the consistency graph.  If it is not
4080 enabled it is not an error, but the consistency graphs will be largely
4081 meaningless.
4082 @end enumerate
4083
4084 To give you an idea of what the above rules look like in action, here's an
4085 actual habit with some history:
4086
4087 @example
4088 ** TODO Shave
4089    SCHEDULED: <2009-10-17 Sat .+2d/4d>
4090    - State "DONE"       from "TODO"       [2009-10-15 Thu]
4091    - State "DONE"       from "TODO"       [2009-10-12 Mon]
4092    - State "DONE"       from "TODO"       [2009-10-10 Sat]
4093    - State "DONE"       from "TODO"       [2009-10-04 Sun]
4094    - State "DONE"       from "TODO"       [2009-10-02 Fri]
4095    - State "DONE"       from "TODO"       [2009-09-29 Tue]
4096    - State "DONE"       from "TODO"       [2009-09-25 Fri]
4097    - State "DONE"       from "TODO"       [2009-09-19 Sat]
4098    - State "DONE"       from "TODO"       [2009-09-16 Wed]
4099    - State "DONE"       from "TODO"       [2009-09-12 Sat]
4100    :PROPERTIES:
4101    :STYLE:    habit
4102    :LAST_REPEAT: [2009-10-19 Mon 00:36]
4103    :END:
4104 @end example
4105
4106 What this habit says is: I want to shave at most every 2 days (given by the
4107 @code{SCHEDULED} date and repeat interval) and at least every 4 days.  If
4108 today is the 15th, then the habit first appears in the agenda on Oct 17,
4109 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4110 after four days have elapsed.
4111
4112 What's really useful about habits is that they are displayed along with a
4113 consistency graph, to show how consistent you've been at getting that task
4114 done in the past.  This graph shows every day that the task was done over the
4115 past three weeks, with colors for each day.  The colors used are:
4116
4117 @table @code
4118 @item Blue
4119 If the task wasn't to be done yet on that day.
4120 @item Green
4121 If the task could have been done on that day.
4122 @item Yellow
4123 If the task was going to be overdue the next day.
4124 @item Red
4125 If the task was overdue on that day.
4126 @end table
4127
4128 In addition to coloring each day, the day is also marked with an asterisk if
4129 the task was actually done that day, and an exclamation mark to show where
4130 the current day falls in the graph.
4131
4132 There are several configuration variables that can be used to change the way
4133 habits are displayed in the agenda.
4134
4135 @table @code
4136 @item org-habit-graph-column
4137 The buffer column at which the consistency graph should be drawn.  This will
4138 overwrite any text in that column, so it is a good idea to keep your habits'
4139 titles brief and to the point.
4140 @item org-habit-preceding-days
4141 The amount of history, in days before today, to appear in consistency graphs.
4142 @item org-habit-following-days
4143 The number of days after today that will appear in consistency graphs.
4144 @item org-habit-show-habits-only-for-today
4145 If non-nil, only show habits in today's agenda view.  This is set to true by
4146 default.
4147 @end table
4148
4149 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4150 temporarily be disabled and they won't appear at all.  Press @kbd{K} again to
4151 bring them back.  They are also subject to tag filtering, if you have habits
4152 which should only be done in certain contexts, for example.
4153
4154 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4155 @section Priorities
4156 @cindex priorities
4157
4158 If you use Org-mode extensively, you may end up with enough TODO items that
4159 it starts to make sense to prioritize them.  Prioritizing can be done by
4160 placing a @emph{priority cookie} into the headline of a TODO item, like this
4161
4162 @example
4163 *** TODO [#A] Write letter to Sam Fortune
4164 @end example
4165
4166 @noindent
4167 @vindex org-priority-faces
4168 By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
4169 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie is
4170 treated just like priority @samp{B}.  Priorities make a difference only for
4171 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4172 have no inherent meaning to Org-mode.  The cookies can be highlighted with
4173 special faces by customizing the variable @code{org-priority-faces}.
4174
4175 Priorities can be attached to any outline node; they do not need to be TODO
4176 items.
4177
4178 @table @kbd
4179 @item @kbd{C-c ,}
4180 @kindex @kbd{C-c ,}
4181 @findex org-priority
4182 Set the priority of the current headline (@command{org-priority}).  The
4183 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4184 When you press @key{SPC} instead, the priority cookie is removed from the
4185 headline.  The priorities can also be changed ``remotely'' from the timeline
4186 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4187 @c
4188 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4189 @vindex org-priority-start-cycle-with-default
4190 Increase/decrease priority of current headline@footnote{See also the option
4191 @code{org-priority-start-cycle-with-default}.}.  Note that these keys are
4192 also used to modify timestamps (@pxref{Creating timestamps}).  See also
4193 @ref{Conflicts}, for a discussion of the interaction with
4194 @code{shift-selection-mode}.
4195 @end table
4196
4197 @vindex org-highest-priority
4198 @vindex org-lowest-priority
4199 @vindex org-default-priority
4200 You can change the range of allowed priorities by setting the variables
4201 @code{org-highest-priority}, @code{org-lowest-priority}, and
4202 @code{org-default-priority}.  For an individual buffer, you may set
4203 these values (highest, lowest, default) like this (please make sure that
4204 the highest priority is earlier in the alphabet than the lowest
4205 priority):
4206
4207 @cindex #+PRIORITIES
4208 @example
4209 #+PRIORITIES: A C B
4210 @end example
4211
4212 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4213 @section Breaking tasks down into subtasks
4214 @cindex tasks, breaking down
4215 @cindex statistics, for TODO items
4216
4217 @vindex org-agenda-todo-list-sublevels
4218 It is often advisable to break down large tasks into smaller, manageable
4219 subtasks.  You can do this by creating an outline tree below a TODO item,
4220 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4221 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.  To keep
4222 the overview over the fraction of subtasks that are already completed, insert
4223 either @samp{[/]} or @samp{[%]} anywhere in the headline.  These cookies will
4224 be updated each time the TODO status of a child changes, or when pressing
4225 @kbd{C-c C-c} on the cookie.  For example:
4226
4227 @example
4228 * Organize Party [33%]
4229 ** TODO Call people [1/2]
4230 *** TODO Peter
4231 *** DONE Sarah
4232 ** TODO Buy food
4233 ** DONE Talk to neighbor
4234 @end example
4235
4236 @cindex property, COOKIE_DATA
4237 If a heading has both checkboxes and TODO children below it, the meaning of
4238 the statistics cookie become ambiguous.  Set the property
4239 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4240 this issue.
4241
4242 @vindex org-hierarchical-todo-statistics
4243 If you would like to have the statistics cookie count any TODO entries in the
4244 subtree (not just direct children), configure the variable
4245 @code{org-hierarchical-todo-statistics}.  To do this for a single subtree,
4246 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4247 property.
4248
4249 @example
4250 * Parent capturing statistics [2/20]
4251   :PROPERTIES:
4252   :COOKIE_DATA: todo recursive
4253   :END:
4254 @end example
4255
4256 If you would like a TODO entry to automatically change to DONE
4257 when all children are done, you can use the following setup:
4258
4259 @example
4260 (defun org-summary-todo (n-done n-not-done)
4261   "Switch entry to DONE when all subentries are done, to TODO otherwise."
4262   (let (org-log-done org-log-states)   ; turn off logging
4263     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4264
4265 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4266 @end example
4267
4268
4269 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4270 large number of subtasks (@pxref{Checkboxes}).
4271
4272
4273 @node Checkboxes,  , Breaking down tasks, TODO Items
4274 @section Checkboxes
4275 @cindex checkboxes
4276
4277 @vindex org-list-automatic-rules
4278 Every item in a plain list@footnote{With the exception of description
4279 lists.  But you can allow it by modifying @code{org-list-automatic-rules}
4280 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4281 it with the string @samp{[ ]}.  This feature is similar to TODO items
4282 (@pxref{TODO Items}), but is more lightweight.  Checkboxes are not included
4283 into the global TODO list, so they are often great to split a task into a
4284 number of simple steps.  Or you can use them in a shopping list.  To toggle a
4285 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4286 @file{org-mouse.el}).
4287
4288 Here is an example of a checkbox list.
4289
4290 @example
4291 * TODO Organize party [2/4]
4292   - [-] call people [1/3]
4293     - [ ] Peter
4294     - [X] Sarah
4295     - [ ] Sam
4296   - [X] order food
4297   - [ ] think about what music to play
4298   - [X] talk to the neighbors
4299 @end example
4300
4301 Checkboxes work hierarchically, so if a checkbox item has children that
4302 are checkboxes, toggling one of the children checkboxes will make the
4303 parent checkbox reflect if none, some, or all of the children are
4304 checked.
4305
4306 @cindex statistics, for checkboxes
4307 @cindex checkbox statistics
4308 @cindex property, COOKIE_DATA
4309 @vindex org-hierarchical-checkbox-statistics
4310 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4311 indicating how many checkboxes present in this entry have been checked off,
4312 and the total number of checkboxes present.  This can give you an idea on how
4313 many checkboxes remain, even without opening a folded entry.  The cookies can
4314 be placed into a headline or into (the first line of) a plain list item.
4315 Each cookie covers checkboxes of direct children structurally below the
4316 headline/item on which the cookie appears@footnote{Set the variable
4317 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4318 count all checkboxes below the cookie, not just those belonging to direct
4319 children.}.  You have to insert the cookie yourself by typing either
4320 @samp{[/]} or @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m}
4321 result, as in the examples above.  With @samp{[%]} you get information about
4322 the percentage of checkboxes checked (in the above example, this would be
4323 @samp{[50%]} and @samp{[33%]}, respectively).  In a headline, a cookie can
4324 count either checkboxes below the heading or TODO states of children, and it
4325 will display whatever was changed last.  Set the property @code{COOKIE_DATA}
4326 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4327
4328 @cindex blocking, of checkboxes
4329 @cindex checkbox blocking
4330 @cindex property, ORDERED
4331 If the current outline node has an @code{ORDERED} property, checkboxes must
4332 be checked off in sequence, and an error will be thrown if you try to check
4333 off a box while there are unchecked boxes above it.
4334
4335 @noindent The following commands work with checkboxes:
4336
4337 @table @kbd
4338 @orgcmd{C-c C-c,org-toggle-checkbox}
4339 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
4340 double prefix argument, set it to @samp{[-]}, which is considered to be an
4341 intermediate state.
4342 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4343 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
4344 double prefix argument, set it to @samp{[-]}, which is considered to be an
4345 intermediate state.
4346 @itemize @minus
4347 @item
4348 If there is an active region, toggle the first checkbox in the region
4349 and set all remaining boxes to the same status as the first.  With a prefix
4350 arg, add or remove the checkbox for all items in the region.
4351 @item
4352 If the cursor is in a headline, toggle checkboxes in the region between
4353 this headline and the next (so @emph{not} the entire subtree).
4354 @item
4355 If there is no active region, just toggle the checkbox at point.
4356 @end itemize
4357 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4358 Insert a new item with a checkbox.  This works only if the cursor is already
4359 in a plain list item (@pxref{Plain lists}).
4360 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4361 @vindex org-track-ordered-property-with-tag
4362 @cindex property, ORDERED
4363 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4364 be checked off in sequence.  A property is used for this behavior because
4365 this should be local to the current entry, not inherited like a tag.
4366 However, if you would like to @i{track} the value of this property with a tag
4367 for better visibility, customize the variable
4368 @code{org-track-ordered-property-with-tag}.
4369 @orgcmd{C-c #,org-update-statistics-cookies}
4370 Update the statistics cookie in the current outline entry.  When called with
4371 a @kbd{C-u} prefix, update the entire file.  Checkbox statistic cookies are
4372 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4373 new ones with @kbd{M-S-@key{RET}}.  TODO statistics cookies update when
4374 changing TODO states.  If you delete boxes/entries or add/change them by
4375 hand, use this command to get things back into sync.
4376 @end table
4377
4378 @node Tags, Properties and Columns, TODO Items, Top
4379 @chapter Tags
4380 @cindex tags
4381 @cindex headline tagging
4382 @cindex matching, tags
4383 @cindex sparse tree, tag based
4384
4385 An excellent way to implement labels and contexts for cross-correlating
4386 information is to assign @i{tags} to headlines.  Org-mode has extensive
4387 support for tags.
4388
4389 @vindex org-tag-faces
4390 Every headline can contain a list of tags; they occur at the end of the
4391 headline.  Tags are normal words containing letters, numbers, @samp{_}, and
4392 @samp{@@}.  Tags must be preceded and followed by a single colon, e.g.,
4393 @samp{:work:}.  Several tags can be specified, as in @samp{:work:urgent:}.
4394 Tags will by default be in bold face with the same color as the headline.
4395 You may specify special faces for specific tags using the variable
4396 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4397 (@pxref{Faces for TODO keywords}).
4398
4399 @menu
4400 * Tag inheritance::             Tags use the tree structure of the outline
4401 * Setting tags::                How to assign tags to a headline
4402 * Tag searches::                Searching for combinations of tags
4403 @end menu
4404
4405 @node Tag inheritance, Setting tags, Tags, Tags
4406 @section Tag inheritance
4407 @cindex tag inheritance
4408 @cindex inheritance, of tags
4409 @cindex sublevels, inclusion into tags match
4410
4411 @i{Tags} make use of the hierarchical structure of outline trees.  If a
4412 heading has a certain tag, all subheadings will inherit the tag as
4413 well.  For example, in the list
4414
4415 @example
4416 * Meeting with the French group      :work:
4417 ** Summary by Frank                  :boss:notes:
4418 *** TODO Prepare slides for him      :action:
4419 @end example
4420
4421 @noindent
4422 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4423 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4424 explicitly marked with those tags.  You can also set tags that all entries in
4425 a file should inherit just as if these tags were defined in a hypothetical
4426 level zero that surrounds the entire file.  Use a line like this@footnote{As
4427 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4428 changes in the line.}:
4429
4430 @cindex #+FILETAGS
4431 @example
4432 #+FILETAGS: :Peter:Boss:Secret:
4433 @end example
4434
4435 @noindent
4436 @vindex org-use-tag-inheritance
4437 @vindex org-tags-exclude-from-inheritance
4438 To limit tag inheritance to specific tags, or to turn it off entirely, use
4439 the variables @code{org-use-tag-inheritance} and
4440 @code{org-tags-exclude-from-inheritance}.
4441
4442 @vindex org-tags-match-list-sublevels
4443 When a headline matches during a tags search while tag inheritance is turned
4444 on, all the sublevels in the same tree will (for a simple match form) match
4445 as well@footnote{This is only true if the search does not involve more
4446 complex tests including properties (@pxref{Property searches}).}.  The list