Manual: Consistently use 'Org mode'
[org-mode/org-kjn.git] / doc / org.texi
blob9d9dd81fa8a27ca2f7499dd44625736fea99cbd3
2 \input texinfo
3 @c %**start of header
4 @setfilename ../../info/org
5 @settitle The Org Manual
7 @set VERSION 7.8.02
8 @set DATE December 2011
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
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
25 @c -----------------------------------------------------------------------------
27 @c Macro definitions for commands and keys
28 @c =======================================
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.
33 @set cmdnames
35 @c Below we define the following macros for Org key tables:
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
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
56 @macro xorgkey{key}
57 @kindex \key\
58 @itemx @kbd{\key\}
59 @end macro
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
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
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
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
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
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
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
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
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 -----------------------------------------------------------------------------
251 @iftex
252 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
253 @end iftex
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
265 @copying
266 This manual is for Org version @value{VERSION}.
268 Copyright @copyright{} 2004-2011  Free Software Foundation, Inc.
270 @quotation
271 Permission is granted to copy, distribute and/or modify this document
272 under the terms of the GNU Free Documentation License, Version 1.3 or
273 any later version published by the Free Software Foundation; with no
274 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
275 and with the Back-Cover Texts as in (a) below.  A copy of the license
276 is included in the section entitled ``GNU Free Documentation License.''
278 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
279 modify this GNU manual.  Buying copies from the FSF supports it in
280 developing GNU and promoting software freedom.''
282 This document is part of a collection distributed under the GNU Free
283 Documentation License.  If you want to distribute this document
284 separately from the collection, you can do so by adding a copy of the
285 license to the document, as described in section 6 of the license.
286 @end quotation
287 @end copying
289 @dircategory Emacs
290 @direntry
291 * Org Mode: (org).      Outline-based notes management and organizer
292 @end direntry
294 @titlepage
295 @title The Org Manual
297 @subtitle Release @value{VERSION}
298 @author by Carsten Dominik
299 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, Thomas Dye and Jambunathan K.
301 @c The following two commands start the copyright page.
302 @page
303 @vskip 0pt plus 1filll
304 @insertcopying
305 @end titlepage
307 @c Output the table of contents at the beginning.
308 @contents
310 @ifnottex
311 @node Top, Introduction, (dir), (dir)
312 @top Org Mode Manual
314 @insertcopying
315 @end ifnottex
317 @menu
318 * Introduction::                Getting started
319 * Document Structure::          A tree works like your brain
320 * Tables::                      Pure magic for quick formatting
321 * Hyperlinks::                  Notes in context
322 * TODO Items::                  Every tree branch can be a TODO item
323 * Tags::                        Tagging headlines and matching sets of tags
324 * Properties and Columns::      Storing information about an entry
325 * Dates and Times::             Making items useful for planning
326 * Capture - Refile - Archive::  The ins and outs for projects
327 * Agenda Views::                Collecting information into views
328 * Markup::                      Prepare text for rich export
329 * Exporting::                   Sharing and publishing of notes
330 * Publishing::                  Create a web site of linked Org files
331 * Working With Source Code::    Export, evaluate, and tangle code blocks
332 * Miscellaneous::               All the rest which did not fit elsewhere
333 * Hacking::                     How to hack your way around
334 * MobileOrg::                   Viewing and capture on a mobile device
335 * History and Acknowledgments::  How Org came into being
336 * Main Index::                  An index of Org's concepts and features
337 * Key Index::                   Key bindings and where they are described
338 * Command and Function Index::  Command names and some internal functions
339 * Variable Index::              Variables mentioned in the manual
341 @detailmenu
342  --- The Detailed Node Listing ---
344 Introduction
346 * Summary::                     Brief summary of what Org does
347 * Installation::                How to install a downloaded version of Org
348 * Activation::                  How to activate Org for certain buffers
349 * Feedback::                    Bug reports, ideas, patches etc.
350 * Conventions::                 Type-setting conventions in the manual
352 Document structure
354 * Outlines::                    Org is based on Outline mode
355 * Headlines::                   How to typeset Org tree headlines
356 * Visibility cycling::          Show and hide, much simplified
357 * Motion::                      Jumping to other headlines
358 * Structure editing::           Changing sequence and level of headlines
359 * Sparse trees::                Matches embedded in context
360 * Plain lists::                 Additional structure within an entry
361 * Drawers::                     Tucking stuff away
362 * Blocks::                      Folding blocks
363 * Footnotes::                   How footnotes are defined in Org's syntax
364 * Orgstruct mode::              Structure editing outside Org
366 Tables
368 * Built-in table editor::       Simple tables
369 * Column width and alignment::  Overrule the automatic settings
370 * Column groups::               Grouping to trigger vertical lines
371 * Orgtbl mode::                 The table editor as minor mode
372 * The spreadsheet::             The table editor has spreadsheet capabilities
373 * Org-Plot::                    Plotting from org tables
375 The spreadsheet
377 * References::                  How to refer to another field or range
378 * Formula syntax for Calc::     Using Calc to compute stuff
379 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
380 * Durations and time values::   How to compute durations and time values
381 * Field and range formulas::    Formula for specific (ranges of) fields
382 * Column formulas::             Formulas valid for an entire column
383 * Editing and debugging formulas::  Fixing formulas
384 * Updating the table::          Recomputing all dependent fields
385 * Advanced features::           Field and column names, parameters and automatic recalc
387 Hyperlinks
389 * Link format::                 How links in Org are formatted
390 * Internal links::              Links to other places in the current file
391 * External links::              URL-like links to the world
392 * Handling links::              Creating, inserting and following
393 * Using links outside Org::     Linking from my C source code?
394 * Link abbreviations::          Shortcuts for writing complex links
395 * Search options::              Linking to a specific location
396 * Custom searches::             When the default search is not enough
398 Internal links
400 * Radio targets::               Make targets trigger links in plain text
402 TODO items
404 * TODO basics::                 Marking and displaying TODO entries
405 * TODO extensions::             Workflow and assignments
406 * Progress logging::            Dates and notes for progress
407 * Priorities::                  Some things are more important than others
408 * Breaking down tasks::         Splitting a task into manageable pieces
409 * Checkboxes::                  Tick-off lists
411 Extended use of TODO keywords
413 * Workflow states::             From TODO to DONE in steps
414 * TODO types::                  I do this, Fred does the rest
415 * Multiple sets in one file::   Mixing it all, and still finding your way
416 * Fast access to TODO states::  Single letter selection of a state
417 * Per-file keywords::           Different files, different requirements
418 * Faces for TODO keywords::     Highlighting states
419 * TODO dependencies::           When one task needs to wait for others
421 Progress logging
423 * Closing items::               When was this entry marked DONE?
424 * Tracking TODO state changes::  When did the status change?
425 * Tracking your habits::        How consistent have you been?
427 Tags
429 * Tag inheritance::             Tags use the tree structure of the outline
430 * Setting tags::                How to assign tags to a headline
431 * Tag searches::                Searching for combinations of tags
433 Properties and columns
435 * Property syntax::             How properties are spelled out
436 * Special properties::          Access to other Org mode features
437 * Property searches::           Matching property values
438 * Property inheritance::        Passing values down the tree
439 * Column view::                 Tabular viewing and editing
440 * Property API::                Properties for Lisp programmers
442 Column view
444 * Defining columns::            The COLUMNS format property
445 * Using column view::           How to create and use column view
446 * Capturing column view::       A dynamic block for column view
448 Defining columns
450 * Scope of column definitions::  Where defined, where valid?
451 * Column attributes::           Appearance and content of a column
453 Dates and times
455 * Timestamps::                  Assigning a time to a tree entry
456 * Creating timestamps::         Commands which insert timestamps
457 * Deadlines and scheduling::    Planning your work
458 * Clocking work time::          Tracking how long you spend on a task
459 * Effort estimates::            Planning work effort in advance
460 * Relative timer::              Notes with a running timer
461 * Countdown timer::             Starting a countdown timer for a task
463 Creating timestamps
465 * The date/time prompt::        How Org mode helps you entering date and time
466 * Custom time format::          Making dates look different
468 Deadlines and scheduling
470 * Inserting deadline/schedule::  Planning items
471 * Repeated tasks::              Items that show up again and again
473 Clocking work time
475 * Clocking commands::           Starting and stopping a clock
476 * The clock table::             Detailed reports
477 * Resolving idle time::         Resolving time when you've been idle
479 Capture - Refile - Archive
481 * Capture::                     Capturing new stuff
482 * Attachments::                 Add files to tasks
483 * RSS Feeds::                   Getting input from RSS feeds
484 * Protocols::                   External (e.g.@: Browser) access to Emacs and Org
485 * Refiling notes::              Moving a tree from one place to another
486 * Archiving::                   What to do with finished projects
488 Capture
490 * Setting up capture::          Where notes will be stored
491 * Using capture::               Commands to invoke and terminate capture
492 * Capture templates::           Define the outline of different note types
494 Capture templates
496 * Template elements::           What is needed for a complete template entry
497 * Template expansion::          Filling in information about time and context
499 Archiving
501 * Moving subtrees::             Moving a tree to an archive file
502 * Internal archiving::          Switch off a tree but keep it in the file
504 Agenda views
506 * Agenda files::                Files being searched for agenda information
507 * Agenda dispatcher::           Keyboard access to agenda views
508 * Built-in agenda views::       What is available out of the box?
509 * Presentation and sorting::    How agenda items are prepared for display
510 * Agenda commands::             Remote editing of Org trees
511 * Custom agenda views::         Defining special searches and views
512 * Exporting Agenda Views::      Writing a view to a file
513 * Agenda column view::          Using column view for collected entries
515 The built-in agenda views
517 * Weekly/daily agenda::         The calendar page with current tasks
518 * Global TODO list::            All unfinished action items
519 * Matching tags and properties::  Structured information with fine-tuned search
520 * Timeline::                    Time-sorted view for single file
521 * Search view::                 Find entries by searching for text
522 * Stuck projects::              Find projects you need to review
524 Presentation and sorting
526 * Categories::                  Not all tasks are equal
527 * Time-of-day specifications::  How the agenda knows the time
528 * Sorting of agenda items::     The order of things
530 Custom agenda views
532 * Storing searches::            Type once, use often
533 * Block agenda::                All the stuff you need in a single buffer
534 * Setting Options::             Changing the rules
536 Markup for rich export
538 * Structural markup elements::  The basic structure as seen by the exporter
539 * Images and tables::           Tables and Images will be included
540 * Literal examples::            Source code examples with special formatting
541 * Include files::               Include additional files into a document
542 * Index entries::               Making an index
543 * Macro replacement::           Use macros to create complex output
544 * Embedded LaTeX::              LaTeX can be freely used inside Org documents
546 Structural markup elements
548 * Document title::              Where the title is taken from
549 * Headings and sections::       The document structure as seen by the exporter
550 * Table of contents::           The if and where of the table of contents
551 * Initial text::                Text before the first heading?
552 * Lists::                       Lists
553 * Paragraphs::                  Paragraphs
554 * Footnote markup::             Footnotes
555 * Emphasis and monospace::      Bold, italic, etc.
556 * Horizontal rules::            Make a line
557 * Comment lines::               What will *not* be exported
559 Embedded @LaTeX{}
561 * Special symbols::             Greek letters and other symbols
562 * Subscripts and superscripts::  Simple syntax for raising/lowering text
563 * LaTeX fragments::             Complex formulas made easy
564 * Previewing LaTeX fragments::  What will this snippet look like?
565 * CDLaTeX mode::                Speed up entering of formulas
567 Exporting
569 * Selective export::            Using tags to select and exclude trees
570 * Export options::              Per-file export settings
571 * The export dispatcher::       How to access exporter commands
572 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
573 * HTML export::                 Exporting to HTML
574 * LaTeX and PDF export::        Exporting to @LaTeX{}, and processing to PDF
575 * DocBook export::              Exporting to DocBook
576 * OpenDocument Text export::    Exporting to OpenDocument Text
577 * TaskJuggler export::          Exporting to TaskJuggler
578 * Freemind export::             Exporting to Freemind mind maps
579 * XOXO export::                 Exporting to XOXO
580 * iCalendar export::            Exporting in iCalendar format
582 HTML export
584 * HTML Export commands::        How to invoke HTML export
585 * HTML preamble and postamble::  How to insert a preamble and a postamble
586 * Quoting HTML tags::           Using direct HTML in Org mode
587 * Links in HTML export::        How links will be interpreted and formatted
588 * Tables in HTML export::       How to modify the formatting of tables
589 * Images in HTML export::       How to insert figures into HTML output
590 * Math formatting in HTML export::  Beautiful math also on the web
591 * Text areas in HTML export::   An alternative way to show an example
592 * CSS support::                 Changing the appearance of the output
593 * JavaScript support::          Info and Folding in a web browser
595 @LaTeX{} and PDF export
597 * LaTeX/PDF export commands::   Which key invokes which commands
598 * Header and sectioning::       Setting up the export file structure
599 * Quoting LaTeX code::          Incorporating literal @LaTeX{} code
600 * Tables in LaTeX export::      Options for exporting tables to @LaTeX{}
601 * Images in LaTeX export::      How to insert figures into @LaTeX{} output
602 * Beamer class export::         Turning the file into a presentation
604 DocBook export
606 * DocBook export commands::     How to invoke DocBook export
607 * Quoting DocBook code::        Incorporating DocBook code in Org files
608 * Recursive sections::          Recursive sections in DocBook
609 * Tables in DocBook export::    Tables are exported as HTML tables
610 * Images in DocBook export::    How to insert figures into DocBook output
611 * Special characters::          How to handle special characters
613 OpenDocument Text export
615 * Pre-requisites for @acronym{ODT} export::  What packages @acronym{ODT} exporter relies on
616 * @acronym{ODT} export commands::  How to invoke @acronym{ODT} export
617 * Applying custom styles::      How to apply custom styles to the output
618 * Links in @acronym{ODT} export::  How links will be interpreted and formatted
619 * Tables in @acronym{ODT} export::  How Tables are exported
620 * Images in @acronym{ODT} export::  How to insert images
621 * Math formatting in @acronym{ODT} export::  How @LaTeX{} fragments are formatted
622 * Literal examples in @acronym{ODT} export::  How source and example blocks are formatted
623 * Advanced topics in @acronym{ODT} export::  Read this if you are a power user
625 Math formatting in @acronym{ODT} export
627 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
628 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
630 Advanced topics in @acronym{ODT} export
632 * Exporting and converting to other formats::  How to produce @samp{pdf} and other formats
633 * Working with OpenDocument style files::  Explore the internals
634 * Creating one-off styles::     How to produce custom highlighting etc
635 * Customizing tables in @acronym{ODT} export::  How to define and use Table templates
636 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
638 Publishing
640 * Configuration::               Defining projects
641 * Uploading files::             How to get files up on the server
642 * Sample configuration::        Example projects
643 * Triggering publication::      Publication commands
645 Configuration
647 * Project alist::               The central configuration variable
648 * Sources and destinations::    From here to there
649 * Selecting files::             What files are part of the project?
650 * Publishing action::           Setting the function doing the publishing
651 * Publishing options::          Tweaking HTML/@LaTeX{} export
652 * Publishing links::            Which links keep working after publishing?
653 * Sitemap::                     Generating a list of all pages
654 * Generating an index::         An index that reaches across pages
656 Sample configuration
658 * Simple example::              One-component publishing
659 * Complex example::             A multi-component publishing example
661 Working with source code
663 * Structure of code blocks::    Code block syntax described
664 * Editing source code::         Language major-mode editing
665 * Exporting code blocks::       Export contents and/or results
666 * Extracting source code::      Create pure source code files
667 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
668 * Library of Babel::            Use and contribute to a library of useful code blocks
669 * Languages::                   List of supported code block languages
670 * Header arguments::            Configure code block functionality
671 * Results of evaluation::       How evaluation results are handled
672 * Noweb reference syntax::      Literate programming in Org mode
673 * Key bindings and useful functions::  Work quickly with code blocks
674 * Batch execution::             Call functions from the command line
676 Header arguments
678 * Using header arguments::      Different ways to set header arguments
679 * Specific header arguments::   List of header arguments
681 Using header arguments
683 * System-wide header arguments::  Set global default values
684 * Language-specific header arguments::  Set default values by language
685 * Buffer-wide header arguments::  Set default values for a specific buffer
686 * Header arguments in Org mode properties::  Set default values for a buffer or heading
687 * Code block specific header arguments::  The most common way to set values
688 * Header arguments in function calls::  The most specific level
690 Specific header arguments
692 * var::                         Pass arguments to code blocks
693 * results::                     Specify the type of results and how they will
694                                 be collected and handled
695 * file::                        Specify a path for file output
696 * dir::                         Specify the default (possibly remote)
697                                 directory for code block execution
698 * exports::                     Export code and/or results
699 * tangle::                      Toggle tangling and specify file name
700 * mkdirp::                      Toggle creation of parent directories of target
701                                 files during tangling
702 * comments::                    Toggle insertion of comments in tangled
703                                 code files
704 * padline::                     Control insertion of padding lines in tangled
705                                 code files
706 * no-expand::                   Turn off variable assignment and noweb
707                                 expansion during tangling
708 * session::                     Preserve the state of code evaluation
709 * noweb::                       Toggle expansion of noweb references
710 * noweb-ref::                   Specify block's noweb reference resolution target
711 * cache::                       Avoid re-evaluating unchanged code blocks
712 * sep::                         Delimiter for writing tabular results outside Org
713 * hlines::                      Handle horizontal lines in tables
714 * colnames::                    Handle column names in tables
715 * rownames::                    Handle row names in tables
716 * shebang::                     Make tangled files executable
717 * eval::                        Limit evaluation of specific code blocks
719 Miscellaneous
721 * Completion::                  M-TAB knows what you need
722 * Easy Templates::              Quick insertion of structural elements
723 * Speed keys::                  Electric commands at the beginning of a headline
724 * Code evaluation security::    Org mode files evaluate inline code
725 * Customization::               Adapting Org to your taste
726 * In-buffer settings::          Overview of the #+KEYWORDS
727 * The very busy C-c C-c key::   When in doubt, press C-c C-c
728 * Clean view::                  Getting rid of leading stars in the outline
729 * TTY keys::                    Using Org on a tty
730 * Interaction::                 Other Emacs packages
731 * org-crypt.el::                Encrypting Org files
733 Interaction with other packages
735 * Cooperation::                 Packages Org cooperates with
736 * Conflicts::                   Packages that lead to conflicts
738 Hacking
740 * Hooks::                       Who to reach into Org's internals
741 * Add-on packages::             Available extensions
742 * Adding hyperlink types::      New custom link types
743 * Context-sensitive commands::  How to add functionality to such commands
744 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
745 * Dynamic blocks::              Automatically filled blocks
746 * Special agenda views::        Customized views
747 * Extracting agenda information::  Postprocessing of agenda information
748 * Using the property API::      Writing programs that use entry properties
749 * Using the mapping API::       Mapping over all or selected entries
751 Tables and lists in arbitrary syntax
753 * Radio tables::                Sending and receiving radio tables
754 * A LaTeX example::             Step by step, almost a tutorial
755 * Translator functions::        Copy and modify
756 * Radio lists::                 Doing the same for lists
758 MobileOrg
760 * Setting up the staging area::  Where to interact with the mobile device
761 * Pushing to MobileOrg::        Uploading Org files and agendas
762 * Pulling from MobileOrg::      Integrating captured and flagged items
764 @end detailmenu
765 @end menu
767 @node Introduction, Document Structure, Top, Top
768 @chapter Introduction
769 @cindex introduction
771 @menu
772 * Summary::                     Brief summary of what Org does
773 * Installation::                How to install a downloaded version of Org
774 * Activation::                  How to activate Org for certain buffers
775 * Feedback::                    Bug reports, ideas, patches etc.
776 * Conventions::                 Type-setting conventions in the manual
777 @end menu
779 @node Summary, Installation, Introduction, Introduction
780 @section Summary
781 @cindex summary
783 Org is a mode for keeping notes, maintaining TODO lists, and doing
784 project planning with a fast and effective plain-text system.
786 Org develops organizational tasks around NOTES files that contain
787 lists or information about projects as plain text.  Org is
788 implemented on top of Outline mode, which makes it possible to keep the
789 content of large files well structured.  Visibility cycling and
790 structure editing help to work with the tree.  Tables are easily created
791 with a built-in table editor.  Org supports TODO items, deadlines,
792 timestamps, and scheduling.  It dynamically compiles entries into an
793 agenda that utilizes and smoothly integrates much of the Emacs calendar
794 and diary.  Plain text URL-like links connect to websites, emails,
795 Usenet messages, BBDB entries, and any files related to the projects.
796 For printing and sharing of notes, an Org file can be exported as a
797 structured ASCII file, as HTML, or (TODO and agenda items only) as an
798 iCalendar file.  It can also serve as a publishing tool for a set of
799 linked web pages.
801 As a project planning environment, Org works by adding metadata to outline
802 nodes.  Based on this data, specific entries can be extracted in queries and
803 create dynamic @i{agenda views}.
805 Org mode contains the Org Babel environment which allows you to work with
806 embedded source code blocks in a file, to facilitate code evaluation,
807 documentation, and literate programming techniques.
809 Org's automatic, context-sensitive table editor with spreadsheet
810 capabilities can be integrated into any major mode by activating the
811 minor Orgtbl mode.  Using a translation step, it can be used to maintain
812 tables in arbitrary file types, for example in @LaTeX{}.  The structure
813 editing and list creation capabilities can be used outside Org with
814 the minor Orgstruct mode.
816 Org keeps simple things simple.  When first fired up, it should
817 feel like a straightforward, easy to use outliner.  Complexity is not
818 imposed, but a large amount of functionality is available when you need
819 it.  Org is a toolbox and can be used in different ways and for different
820 ends, for example:
822 @example
823 @r{@bullet{} an outline extension with visibility cycling and structure editing}
824 @r{@bullet{} an ASCII system and table editor for taking structured notes}
825 @r{@bullet{} a TODO list editor}
826 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
827 @pindex GTD, Getting Things Done
828 @r{@bullet{} an environment in which to implement David Allen's GTD system}
829 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
830 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
831 @r{@bullet{} an environment for literate programming}
832 @end example
835 @cindex FAQ
836 There is a website for Org which provides links to the newest
837 version of Org, as well as additional information, frequently asked
838 questions (FAQ), links to tutorials, etc@.  This page is located at
839 @uref{http://orgmode.org}.
841 @cindex print edition
842 The version 7.3 of this manual is available as a
843 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
844 Theory Ltd.}
846 @page
849 @node Installation, Activation, Summary, Introduction
850 @section Installation
851 @cindex installation
852 @cindex XEmacs
854 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
855 distribution or an XEmacs package, please skip this section and go directly
856 to @ref{Activation}.  To see what version of Org (if any) is part of your
857 Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x
858 org-version}.}
860 If you have downloaded Org from the Web, either as a distribution @file{.zip}
861 or @file{.tar} file, or as a Git archive, you must take the following steps
862 to install it: go into the unpacked Org distribution directory and edit the
863 top section of the file @file{Makefile}.  You must set the name of the Emacs
864 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
865 directories where local Lisp and Info files are kept.  If you don't have
866 access to the system-wide directories, you can simply run Org directly from
867 the distribution directory by adding the @file{lisp} subdirectory to the
868 Emacs load path.  To do this, add the following line to @file{.emacs}:
870 @example
871 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
872 @end example
874 @noindent
875 If you plan to use code from the @file{contrib} subdirectory, do a similar
876 step for this directory:
878 @example
879 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
880 @end example
882 @noindent Now byte-compile the Lisp files with the shell command:
884 @example
885 make
886 @end example
888 @noindent If you are running Org from the distribution directory, this is
889 all.  If you want to install Org into the system directories, use (as
890 administrator)
892 @example
893 make install
894 @end example
896 Installing Info files is system dependent, because of differences in the
897 @file{install-info} program.  The following should correctly install the Info
898 files on most systems, please send a bug report if not@footnote{The output
899 from install-info (if any) is also system dependent.  In particular Debian
900 and its derivatives use two different versions of install-info and you may
901 see the message:
903 @example
904 This is not dpkg install-info anymore, but GNU install-info
905 See the man page for ginstall-info for command line arguments
906 @end example
908 @noindent which can be safely ignored.}.
910 @example
911 make install-info
912 @end example
914 Then add the following line to @file{.emacs}.  It is needed so that
915 Emacs can autoload functions that are located in files not immediately loaded
916 when Org mode starts.
917 @lisp
918 (require 'org-install)
919 @end lisp
921 Do not forget to activate Org as described in the following section.
922 @page
924 @node Activation, Feedback, Installation, Introduction
925 @section Activation
926 @cindex activation
927 @cindex autoload
928 @cindex global key bindings
929 @cindex key bindings, global
931 To make sure files with extension @file{.org} use Org mode, add the following
932 line to your @file{.emacs} file.
933 @lisp
934 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
935 @end lisp
936 @noindent Org mode buffers need font-lock to be turned on - this is the
937 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
938 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
940 The four Org commands @command{org-store-link}, @command{org-capture},
941 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
942 global keys (i.e.@: anywhere in Emacs, not just in Org buffers).  Here are
943 suggested bindings for these keys, please modify the keys to your own
944 liking.
945 @lisp
946 (global-set-key "\C-cl" 'org-store-link)
947 (global-set-key "\C-cc" 'org-capture)
948 (global-set-key "\C-ca" 'org-agenda)
949 (global-set-key "\C-cb" 'org-iswitchb)
950 @end lisp
952 @cindex Org mode, turning on
953 With this setup, all files with extension @samp{.org} will be put
954 into Org mode.  As an alternative, make the first line of a file look
955 like this:
957 @example
958 MY PROJECTS    -*- mode: org; -*-
959 @end example
961 @vindex org-insert-mode-line-in-empty-file
962 @noindent which will select Org mode for this buffer no matter what
963 the file's name is.  See also the variable
964 @code{org-insert-mode-line-in-empty-file}.
966 Many commands in Org work on the region if the region is @i{active}.  To make
967 use of this, you need to have @code{transient-mark-mode}
968 (@code{zmacs-regions} in XEmacs) turned on.  In Emacs 23 this is the default,
969 in Emacs 22 you need to do this yourself with
970 @lisp
971 (transient-mark-mode 1)
972 @end lisp
973 @noindent If you do not like @code{transient-mark-mode}, you can create an
974 active region by using the mouse to select a region, or pressing
975 @kbd{C-@key{SPC}} twice before moving the cursor.
977 @node Feedback, Conventions, Activation, Introduction
978 @section Feedback
979 @cindex feedback
980 @cindex bug reports
981 @cindex maintainer
982 @cindex author
984 If you find problems with Org, or if you have questions, remarks, or ideas
985 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
986 If you are not a member of the mailing list, your mail will be passed to the
987 list after a moderator has approved it@footnote{Please consider subscribing
988 to the mailing list, in order to minimize the work the mailing list
989 moderators have to do.}.
991 For bug reports, please first try to reproduce the bug with the latest
992 version of Org available---if you are running an outdated version, it is
993 quite possible that the bug has been fixed already.  If the bug persists,
994 prepare a report and provide as much information as possible, including the
995 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
996 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
997 @file{.emacs}.  The easiest way to do this is to use the command
998 @example
999 @kbd{M-x org-submit-bug-report}
1000 @end example
1001 @noindent which will put all this information into an Emacs mail buffer so
1002 that you only need to add your description.  If you re not sending the Email
1003 from within Emacs, please copy and paste the content into your Email program.
1005 Sometimes you might face a problem due to an error in your Emacs or Org mode
1006 setup.  Before reporting a bug, it is very helpful to start Emacs with minimal
1007 customisations and reproduce the problem.  Doing so often helps you determine
1008 if the problem is with your customisation or with Org mode itself.  You can
1009 start a typical minimal session with a command like the example below.
1011 @example
1012 $ emacs -Q -l /path/to/minimal-org.el
1013 @end example
1015 However if you are using Org mode as distributed with Emacs, a minimal setup
1016 is not necessary.  In that case it is sufficient to start Emacs as @code{emacs
1017 -Q}.  The @code{minimal-org.el} setup file can have contents as shown below.
1019 @example
1020 ;;; Minimal setup to load latest `org-mode'
1022 ;; activate debugging
1023 (setq debug-on-error t
1024       debug-on-signal nil
1025       debug-on-quit nil)
1027 ;; add latest org-mode to load path
1028 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1029 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp"))
1031 ;; activate org
1032 (require 'org-install)
1033 @end example
1035 If an error occurs, a backtrace can be very useful (see below on how to
1036 create one).  Often a small example file helps, along with clear information
1037 about:
1039 @enumerate
1040 @item What exactly did you do?
1041 @item What did you expect to happen?
1042 @item What happened instead?
1043 @end enumerate
1044 @noindent Thank you for helping to improve this program.
1046 @subsubheading How to create a useful backtrace
1048 @cindex backtrace of an error
1049 If working with Org produces an error with a message you don't
1050 understand, you may have hit a bug.  The best way to report this is by
1051 providing, in addition to what was mentioned above, a @emph{backtrace}.
1052 This is information from the built-in debugger about where and how the
1053 error occurred.  Here is how to produce a useful backtrace:
1055 @enumerate
1056 @item
1057 Reload uncompiled versions of all Org mode Lisp files.  The backtrace
1058 contains much more information if it is produced with uncompiled code.
1059 To do this, use
1060 @example
1061 C-u M-x org-reload RET
1062 @end example
1063 @noindent
1064 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1065 menu.
1066 @item
1067 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1068 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1069 @item
1070 Do whatever you have to do to hit the error.  Don't forget to
1071 document the steps you take.
1072 @item
1073 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1074 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
1075 attach it to your bug report.
1076 @end enumerate
1078 @node Conventions,  , Feedback, Introduction
1079 @section Typesetting conventions used in this manual
1081 Org uses three types of keywords: TODO keywords, tags, and property
1082 names.  In this manual we use the following conventions:
1084 @table @code
1085 @item TODO
1086 @itemx WAITING
1087 TODO keywords are written with all capitals, even if they are
1088 user-defined.
1089 @item boss
1090 @itemx ARCHIVE
1091 User-defined tags are written in lowercase; built-in tags with special
1092 meaning are written with all capitals.
1093 @item Release
1094 @itemx PRIORITY
1095 User-defined properties are capitalized; built-in properties with
1096 special meaning are written with all capitals.
1097 @end table
1099 The manual lists both the keys and the corresponding commands for accessing
1100 functionality.  Org mode often uses the same key for different functions,
1101 depending on context.  The command that is bound to such keys has a generic
1102 name, like @code{org-metaright}.  In the manual we will, wherever possible,
1103 give the function that is internally called by the generic command.  For
1104 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1105 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1106 be listed to call org-table-move-column-right.
1108 If you prefer, you can compile the manual without the command names by
1109 unsetting the flag @code{cmdnames} in @file{org.texi}.
1111 @node Document Structure, Tables, Introduction, Top
1112 @chapter Document structure
1113 @cindex document structure
1114 @cindex structure of document
1116 Org is based on Outline mode and provides flexible commands to
1117 edit the structure of the document.
1119 @menu
1120 * Outlines::                    Org is based on Outline mode
1121 * Headlines::                   How to typeset Org tree headlines
1122 * Visibility cycling::          Show and hide, much simplified
1123 * Motion::                      Jumping to other headlines
1124 * Structure editing::           Changing sequence and level of headlines
1125 * Sparse trees::                Matches embedded in context
1126 * Plain lists::                 Additional structure within an entry
1127 * Drawers::                     Tucking stuff away
1128 * Blocks::                      Folding blocks
1129 * Footnotes::                   How footnotes are defined in Org's syntax
1130 * Orgstruct mode::              Structure editing outside Org
1131 @end menu
1133 @node Outlines, Headlines, Document Structure, Document Structure
1134 @section Outlines
1135 @cindex outlines
1136 @cindex Outline mode
1138 Org is implemented on top of Outline mode.  Outlines allow a
1139 document to be organized in a hierarchical structure, which (at least
1140 for me) is the best representation of notes and thoughts.  An overview
1141 of this structure is achieved by folding (hiding) large parts of the
1142 document to show only the general document structure and the parts
1143 currently being worked on.  Org greatly simplifies the use of
1144 outlines by compressing the entire show/hide functionality into a single
1145 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1147 @node Headlines, Visibility cycling, Outlines, Document Structure
1148 @section Headlines
1149 @cindex headlines
1150 @cindex outline tree
1151 @vindex org-special-ctrl-a/e
1152 @vindex org-special-ctrl-k
1153 @vindex org-ctrl-k-protect-subtree
1155 Headlines define the structure of an outline tree.  The headlines in Org
1156 start with one or more stars, on the left margin@footnote{See the variables
1157 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1158 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1159 @kbd{C-e}, and @kbd{C-k} in headlines.}.  For example:
1161 @example
1162 * Top level headline
1163 ** Second level
1164 *** 3rd level
1165     some text
1166 *** 3rd level
1167     more text
1169 * Another top level headline
1170 @end example
1172 @noindent Some people find the many stars too noisy and would prefer an
1173 outline that has whitespace followed by a single star as headline
1174 starters.  @ref{Clean view}, describes a setup to realize this.
1176 @vindex org-cycle-separator-lines
1177 An empty line after the end of a subtree is considered part of it and
1178 will be hidden when the subtree is folded.  However, if you leave at
1179 least two empty lines, one empty line will remain visible after folding
1180 the subtree, in order to structure the collapsed view.  See the
1181 variable @code{org-cycle-separator-lines} to modify this behavior.
1183 @node Visibility cycling, Motion, Headlines, Document Structure
1184 @section Visibility cycling
1185 @cindex cycling, visibility
1186 @cindex visibility cycling
1187 @cindex trees, visibility
1188 @cindex show hidden text
1189 @cindex hide text
1191 Outlines make it possible to hide parts of the text in the buffer.
1192 Org uses just two commands, bound to @key{TAB} and
1193 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1195 @cindex subtree visibility states
1196 @cindex subtree cycling
1197 @cindex folded, subtree visibility state
1198 @cindex children, subtree visibility state
1199 @cindex subtree, subtree visibility state
1200 @table @asis
1201 @orgcmd{@key{TAB},org-cycle}
1202 @emph{Subtree cycling}: Rotate current subtree among the states
1204 @example
1205 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1206 '-----------------------------------'
1207 @end example
1209 @vindex org-cycle-emulate-tab
1210 @vindex org-cycle-global-at-bob
1211 The cursor must be on a headline for this to work@footnote{see, however,
1212 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
1213 beginning of the buffer and the first line is not a headline, then
1214 @key{TAB} actually runs global cycling (see below)@footnote{see the
1215 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
1216 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1218 @cindex global visibility states
1219 @cindex global cycling
1220 @cindex overview, global visibility state
1221 @cindex contents, global visibility state
1222 @cindex show all, global visibility state
1223 @orgcmd{S-@key{TAB},org-global-cycle}
1224 @itemx C-u @key{TAB}
1225 @emph{Global cycling}: Rotate the entire buffer among the states
1227 @example
1228 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1229 '--------------------------------------'
1230 @end example
1232 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1233 CONTENTS view up to headlines of level N will be shown.  Note that inside
1234 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1236 @cindex show all, command
1237 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1238 Show all, including drawers.
1239 @orgcmd{C-c C-r,org-reveal}
1240 Reveal context around point, showing the current entry, the following heading
1241 and the hierarchy above.  Useful for working near a location that has been
1242 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1243 (@pxref{Agenda commands}).  With a prefix argument show, on each
1244 level, all sibling headings.  With double prefix arg, also show the entire
1245 subtree of the parent.
1246 @orgcmd{C-c C-k,show-branches}
1247 Expose all the headings of the subtree, CONTENT view for just one subtree.
1248 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1249 Show the current subtree in an indirect buffer@footnote{The indirect
1250 buffer
1251 @ifinfo
1252 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1253 @end ifinfo
1254 @ifnotinfo
1255 (see the Emacs manual for more information about indirect buffers)
1256 @end ifnotinfo
1257 will contain the entire buffer, but will be narrowed to the current
1258 tree.  Editing the indirect buffer will also change the original buffer,
1259 but without affecting visibility in that buffer.}.  With a numeric
1260 prefix argument N, go up to level N and then take that tree.  If N is
1261 negative then go up that many levels.  With a @kbd{C-u} prefix, do not remove
1262 the previously used indirect buffer.
1263 @orgcmd{C-c C-x v,org-copy-visible}
1264 Copy the @i{visible} text in the region into the kill ring.
1265 @end table
1267 @vindex org-startup-folded
1268 @cindex @code{overview}, STARTUP keyword
1269 @cindex @code{content}, STARTUP keyword
1270 @cindex @code{showall}, STARTUP keyword
1271 @cindex @code{showeverything}, STARTUP keyword
1273 When Emacs first visits an Org file, the global state is set to
1274 OVERVIEW, i.e.@: only the top level headlines are visible.  This can be
1275 configured through the variable @code{org-startup-folded}, or on a
1276 per-file basis by adding one of the following lines anywhere in the
1277 buffer:
1279 @example
1280 #+STARTUP: overview
1281 #+STARTUP: content
1282 #+STARTUP: showall
1283 #+STARTUP: showeverything
1284 @end example
1286 @cindex property, VISIBILITY
1287 @noindent
1288 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1289 and Columns}) will get their visibility adapted accordingly.  Allowed values
1290 for this property are @code{folded}, @code{children}, @code{content}, and
1291 @code{all}.
1292 @table @asis
1293 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1294 Switch back to the startup visibility of the buffer, i.e.@: whatever is
1295 requested by startup options and @samp{VISIBILITY} properties in individual
1296 entries.
1297 @end table
1299 @node Motion, Structure editing, Visibility cycling, Document Structure
1300 @section Motion
1301 @cindex motion, between headlines
1302 @cindex jumping, to headlines
1303 @cindex headline navigation
1304 The following commands jump to other headlines in the buffer.
1306 @table @asis
1307 @orgcmd{C-c C-n,outline-next-visible-heading}
1308 Next heading.
1309 @orgcmd{C-c C-p,outline-previous-visible-heading}
1310 Previous heading.
1311 @orgcmd{C-c C-f,org-forward-same-level}
1312 Next heading same level.
1313 @orgcmd{C-c C-b,org-backward-same-level}
1314 Previous heading same level.
1315 @orgcmd{C-c C-u,outline-up-heading}
1316 Backward to higher level heading.
1317 @orgcmd{C-c C-j,org-goto}
1318 Jump to a different place without changing the current outline
1319 visibility.  Shows the document structure in a temporary buffer, where
1320 you can use the following keys to find your destination:
1321 @vindex org-goto-auto-isearch
1322 @example
1323 @key{TAB}         @r{Cycle visibility.}
1324 @key{down} / @key{up}   @r{Next/previous visible headline.}
1325 @key{RET}         @r{Select this location.}
1326 @kbd{/}           @r{Do a Sparse-tree search}
1327 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1328 n / p        @r{Next/previous visible headline.}
1329 f / b        @r{Next/previous headline same level.}
1330 u            @r{One level up.}
1331 0-9          @r{Digit argument.}
1332 q            @r{Quit}
1333 @end example
1334 @vindex org-goto-interface
1335 @noindent
1336 See also the variable @code{org-goto-interface}.
1337 @end table
1339 @node Structure editing, Sparse trees, Motion, Document Structure
1340 @section Structure editing
1341 @cindex structure editing
1342 @cindex headline, promotion and demotion
1343 @cindex promotion, of subtrees
1344 @cindex demotion, of subtrees
1345 @cindex subtree, cut and paste
1346 @cindex pasting, of subtrees
1347 @cindex cutting, of subtrees
1348 @cindex copying, of subtrees
1349 @cindex sorting, of subtrees
1350 @cindex subtrees, cut and paste
1352 @table @asis
1353 @orgcmd{M-@key{RET},org-insert-heading}
1354 @vindex org-M-RET-may-split-line
1355 Insert new heading with same level as current.  If the cursor is in a plain
1356 list item, a new item is created (@pxref{Plain lists}).  To force creation of
1357 a new headline, use a prefix argument.  When this command is used in the
1358 middle of a line, the line is split and the rest of the line becomes the new
1359 headline@footnote{If you do not want the line to be split, customize the
1360 variable @code{org-M-RET-may-split-line}.}.  If the command is used at the
1361 beginning of a headline, the new headline is created before the current line.
1362 If at the beginning of any other line, the content of that line is made the
1363 new heading.  If the command is used at the end of a folded subtree (i.e.@:
1364 behind the ellipses at the end of a headline), then a headline like the
1365 current one will be inserted after the end of the subtree.
1366 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1367 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1368 current heading, the new heading is placed after the body instead of before
1369 it.  This command works from anywhere in the entry.
1370 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1371 @vindex org-treat-insert-todo-heading-as-state-change
1372 Insert new TODO entry with same level as current heading.  See also the
1373 variable @code{org-treat-insert-todo-heading-as-state-change}.
1374 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1375 Insert new TODO entry with same level as current heading.  Like
1376 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1377 subtree.
1378 @orgcmd{@key{TAB},org-cycle}
1379 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1380 become a child of the previous one.  The next @key{TAB} makes it a parent,
1381 and so on, all the way to top level.  Yet another @key{TAB}, and you are back
1382 to the initial level.
1383 @orgcmd{M-@key{left},org-do-promote}
1384 Promote current heading by one level.
1385 @orgcmd{M-@key{right},org-do-demote}
1386 Demote current heading by one level.
1387 @orgcmd{M-S-@key{left},org-promote-subtree}
1388 Promote the current subtree by one level.
1389 @orgcmd{M-S-@key{right},org-demote-subtree}
1390 Demote the current subtree by one level.
1391 @orgcmd{M-S-@key{up},org-move-subtree-up}
1392 Move subtree up (swap with previous subtree of same
1393 level).
1394 @orgcmd{M-S-@key{down},org-move-subtree-down}
1395 Move subtree down (swap with next subtree of same level).
1396 @orgcmd{C-c C-x C-w,org-cut-subtree}
1397 Kill subtree, i.e.@: remove it from buffer but save in kill ring.
1398 With a numeric prefix argument N, kill N sequential subtrees.
1399 @orgcmd{C-c C-x M-w,org-copy-subtree}
1400 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
1401 sequential subtrees.
1402 @orgcmd{C-c C-x C-y,org-paste-subtree}
1403 Yank subtree from kill ring.  This does modify the level of the subtree to
1404 make sure the tree fits in nicely at the yank position.  The yank level can
1405 also be specified with a numeric prefix argument, or by yanking after a
1406 headline marker like @samp{****}.
1407 @orgcmd{C-y,org-yank}
1408 @vindex org-yank-adjusted-subtrees
1409 @vindex org-yank-folded-subtrees
1410 Depending on the variables @code{org-yank-adjusted-subtrees} and
1411 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1412 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1413 C-x C-y}.  With the default settings, no level adjustment will take place,
1414 but the yanked tree will be folded unless doing so would swallow text
1415 previously visible.  Any prefix argument to this command will force a normal
1416 @code{yank} to be executed, with the prefix passed along.  A good way to
1417 force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
1418 yank, it will yank previous kill items plainly, without adjustment and
1419 folding.
1420 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1421 Clone a subtree by making a number of sibling copies of it.  You will be
1422 prompted for the number of copies to make, and you can also specify if any
1423 timestamps in the entry should be shifted.  This can be useful, for example,
1424 to create a number of tasks related to a series of lectures to prepare.  For
1425 more details, see the docstring of the command
1426 @code{org-clone-subtree-with-time-shift}.
1427 @orgcmd{C-c C-w,org-refile}
1428 Refile entry or region to a different location.  @xref{Refiling notes}.
1429 @orgcmd{C-c ^,org-sort-entries-or-items}
1430 Sort same-level entries.  When there is an active region, all entries in the
1431 region will be sorted.  Otherwise the children of the current headline are
1432 sorted.  The command prompts for the sorting method, which can be
1433 alphabetically, numerically, by time (first timestamp with active preferred,
1434 creation time, scheduled time, deadline time), by priority, by TODO keyword
1435 (in the sequence the keywords have been defined in the setup) or by the value
1436 of a property.  Reverse sorting is possible as well.  You can also supply
1437 your own function to extract the sorting key.  With a @kbd{C-u} prefix,
1438 sorting will be case-sensitive.  With two @kbd{C-u C-u} prefixes, duplicate
1439 entries will also be removed.
1440 @orgcmd{C-x n s,org-narrow-to-subtree}
1441 Narrow buffer to current subtree.
1442 @orgcmd{C-x n b,org-narrow-to-block}
1443 Narrow buffer to current block.
1444 @orgcmd{C-x n w,widen}
1445 Widen buffer to remove narrowing.
1446 @orgcmd{C-c *,org-toggle-heading}
1447 Turn a normal line or plain list item into a headline (so that it becomes a
1448 subheading at its location).  Also turn a headline into a normal line by
1449 removing the stars.  If there is an active region, turn all lines in the
1450 region into headlines.  If the first line in the region was an item, turn
1451 only the item lines into headlines.  Finally, if the first line is a
1452 headline, remove the stars from all headlines in the region.
1453 @end table
1455 @cindex region, active
1456 @cindex active region
1457 @cindex transient mark mode
1458 When there is an active region (Transient Mark mode), promotion and
1459 demotion work on all headlines in the region.  To select a region of
1460 headlines, it is best to place both point and mark at the beginning of a
1461 line, mark at the beginning of the first headline, and point at the line
1462 just after the last headline to change.  Note that when the cursor is
1463 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1464 functionality.
1467 @node Sparse trees, Plain lists, Structure editing, Document Structure
1468 @section Sparse trees
1469 @cindex sparse trees
1470 @cindex trees, sparse
1471 @cindex folding, sparse trees
1472 @cindex occur, command
1474 @vindex org-show-hierarchy-above
1475 @vindex org-show-following-heading
1476 @vindex org-show-siblings
1477 @vindex org-show-entry-below
1478 An important feature of Org mode is the ability to construct @emph{sparse
1479 trees} for selected information in an outline tree, so that the entire
1480 document is folded as much as possible, but the selected information is made
1481 visible along with the headline structure above it@footnote{See also the
1482 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1483 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1484 control on how much context is shown around each match.}.  Just try it out
1485 and you will see immediately how it works.
1487 Org mode contains several commands creating such trees, all these
1488 commands can be accessed through a dispatcher:
1490 @table @asis
1491 @orgcmd{C-c /,org-sparse-tree}
1492 This prompts for an extra key to select a sparse-tree creating command.
1493 @orgcmd{C-c / r,org-occur}
1494 @vindex org-remove-highlights-with-change
1495 Prompts for a regexp and shows a sparse tree with all matches.  If
1496 the match is in a headline, the headline is made visible.  If the match is in
1497 the body of an entry, headline and body are made visible.  In order to
1498 provide minimal context, also the full hierarchy of headlines above the match
1499 is shown, as well as the headline following the match.  Each match is also
1500 highlighted; the highlights disappear when the buffer is changed by an
1501 editing command@footnote{This depends on the option
1502 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1503 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1504 so several calls to this command can be stacked.
1505 @orgcmdkkc{M-g n,M-g M-n,next-error}
1506 Jump to the next sparse tree match in this buffer.
1507 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1508 Jump to the previous sparse tree match in this buffer.
1509 @end table
1512 @noindent
1513 @vindex org-agenda-custom-commands
1514 For frequently used sparse trees of specific search strings, you can
1515 use the variable @code{org-agenda-custom-commands} to define fast
1516 keyboard access to specific sparse trees.  These commands will then be
1517 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1518 For example:
1520 @lisp
1521 (setq org-agenda-custom-commands
1522       '(("f" occur-tree "FIXME")))
1523 @end lisp
1525 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1526 a sparse tree matching the string @samp{FIXME}.
1528 The other sparse tree commands select headings based on TODO keywords,
1529 tags, or properties and will be discussed later in this manual.
1531 @kindex C-c C-e v
1532 @cindex printing sparse trees
1533 @cindex visible text, printing
1534 To print a sparse tree, you can use the Emacs command
1535 @code{ps-print-buffer-with-faces} which does not print invisible parts
1536 of the document @footnote{This does not work under XEmacs, because
1537 XEmacs uses selective display for outlining, not text properties.}.
1538 Or you can use the command @kbd{C-c C-e v} to export only the visible
1539 part of the document and print the resulting file.
1541 @node Plain lists, Drawers, Sparse trees, Document Structure
1542 @section Plain lists
1543 @cindex plain lists
1544 @cindex lists, plain
1545 @cindex lists, ordered
1546 @cindex ordered lists
1548 Within an entry of the outline tree, hand-formatted lists can provide
1549 additional structure.  They also provide a way to create lists of checkboxes
1550 (@pxref{Checkboxes}).  Org supports editing such lists, and every exporter
1551 (@pxref{Exporting}) can parse and format them.
1553 Org knows ordered lists, unordered lists, and description lists.
1554 @itemize @bullet
1555 @item
1556 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1557 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1558 they will be seen as top-level headlines.  Also, when you are hiding leading
1559 stars to get a clean outline view, plain list items starting with a star may
1560 be hard to distinguish from true headlines.  In short: even though @samp{*}
1561 is supported, it may be better to not use it for plain list items.}  as
1562 bullets.
1563 @item
1564 @vindex org-plain-list-ordered-item-terminator
1565 @vindex org-alphabetical-lists
1566 @emph{Ordered} list items start with a numeral followed by either a period or
1567 a right parenthesis@footnote{You can filter out any of them by configuring
1568 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1569 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1570 @samp{A)} by configuring @code{org-alphabetical-lists}.  To minimize
1571 confusion with normal text, those are limited to one character only.  Beyond
1572 that limit, bullets will automatically fallback to numbers.}.  If you want a
1573 list to start with a different value (e.g.@: 20), start the text of the item
1574 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1575 must be put @emph{before} the checkbox.  If you have activated alphabetical
1576 lists, you can also use counters like @code{[@@b]}.}.  Those constructs can
1577 be used in any item of the list in order to enforce a particular numbering.
1578 @item
1579 @emph{Description} list items are unordered list items, and contain the
1580 separator @samp{ :: } to distinguish the description @emph{term} from the
1581 description.
1582 @end itemize
1584 Items belonging to the same list must have the same indentation on the first
1585 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1586 2--digit numbers must be written left-aligned with the other numbers in the
1587 list.  An item ends before the next line that is less or equally indented
1588 than its bullet/number.
1590 @vindex org-list-ending-method
1591 @vindex org-list-end-regexp
1592 @vindex org-empty-line-terminates-plain-lists
1593 Two methods@footnote{To disable either of them, configure
1594 @code{org-list-ending-method}.} are provided to terminate lists.  A list ends
1595 whenever every item has ended, which means before any line less or equally
1596 indented than items at top level.  It also ends before two blank
1597 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}.  In
1598 that case, all items are closed.  For finer control, you can end lists with
1599 any pattern set in @code{org-list-end-regexp}.  Here is an example:
1601 @example
1602 @group
1603 ** Lord of the Rings
1604    My favorite scenes are (in this order)
1605    1. The attack of the Rohirrim
1606    2. Eowyn's fight with the witch king
1607       + this was already my favorite scene in the book
1608       + I really like Miranda Otto.
1609    3. Peter Jackson being shot by Legolas
1610       - on DVD only
1611       He makes a really funny face when it happens.
1612    But in the end, no individual scenes matter but the film as a whole.
1613    Important actors in this film are:
1614    - @b{Elijah Wood} :: He plays Frodo
1615    - @b{Sean Austin} :: He plays Sam, Frodo's friend.  I still remember
1616      him very well from his role as Mikey Walsh in @i{The Goonies}.
1617 @end group
1618 @end example
1620 Org supports these lists by tuning filling and wrapping commands to deal with
1621 them correctly@footnote{Org only changes the filling settings for Emacs.  For
1622 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}.  To turn this on,
1623 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1624 properly (@pxref{Exporting}).  Since indentation is what governs the
1625 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1626 blocks can be indented to signal that they belong to a particular item.
1628 @vindex org-list-demote-modify-bullet
1629 @vindex org-list-indent-offset
1630 If you find that using a different bullet for a sub-list (than that used for
1631 the current list-level) improves readability, customize the variable
1632 @code{org-list-demote-modify-bullet}.  To get a greater difference of
1633 indentation between items and theirs sub-items, customize
1634 @code{org-list-indent-offset}.
1636 @vindex org-list-automatic-rules
1637 The following commands act on items when the cursor is in the first line of
1638 an item (the line with the bullet or number).  Some of them imply the
1639 application of automatic rules to keep list structure intact.  If some of
1640 these actions get in your way, configure @code{org-list-automatic-rules}
1641 to disable them individually.
1643 @table @asis
1644 @orgcmd{@key{TAB},org-cycle}
1645 @vindex org-cycle-include-plain-lists
1646 Items can be folded just like headline levels.  Normally this works only if
1647 the cursor is on a plain list item.  For more details, see the variable
1648 @code{org-cycle-include-plain-lists}.  If this variable is set to
1649 @code{integrate}, plain list items will be treated like low-level
1650 headlines.  The level of an item is then given by the
1651 indentation of the bullet/number.  Items are always subordinate to real
1652 headlines, however; the hierarchies remain completely separated.
1653 @orgcmd{M-@key{RET},org-insert-heading}
1654 @vindex org-M-RET-may-split-line
1655 @vindex org-list-automatic-rules
1656 Insert new item at current level.  With a prefix argument, force a new
1657 heading (@pxref{Structure editing}).  If this command is used in the middle
1658 of an item, that item is @emph{split} in two, and the second part becomes the
1659 new item@footnote{If you do not want the item to be split, customize the
1660 variable @code{org-M-RET-may-split-line}.}.  If this command is executed
1661 @emph{before item's body}, the new item is created @emph{before} the current
1662 one.
1663 @kindex M-S-@key{RET}
1664 @item M-S-@key{RET}
1665 Insert a new item with a checkbox (@pxref{Checkboxes}).
1666 @orgcmd{@key{TAB},org-cycle}
1667 In a new item with no text yet, the first @key{TAB} demotes the item to
1668 become a child of the previous one.  Subsequent @key{TAB}s move the item to
1669 meaningful levels in the list and eventually get it back to its initial
1670 position.
1671 @kindex S-@key{down}
1672 @item S-@key{up}
1673 @itemx S-@key{down}
1674 @cindex shift-selection-mode
1675 @vindex org-support-shift-select
1676 @vindex org-list-use-circular-motion
1677 Jump to the previous/next item in the current list@footnote{If you want to
1678 cycle around items that way, you may customize
1679 @code{org-list-use-circular-motion}.}, but only if
1680 @code{org-support-shift-select} is off.  If not, you can still use paragraph
1681 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1682 similar effect.
1683 @kindex M-@key{up}
1684 @kindex M-@key{down}
1685 @item M-@key{up}
1686 @itemx M-@key{down}
1687 Move the item including subitems up/down@footnote{See
1688 @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
1689 previous/next item of same indentation).  If the list is ordered, renumbering
1690 is automatic.
1691 @kindex M-@key{left}
1692 @kindex M-@key{right}
1693 @item M-@key{left}
1694 @itemx M-@key{right}
1695 Decrease/increase the indentation of an item, leaving children alone.
1696 @kindex M-S-@key{left}
1697 @kindex M-S-@key{right}
1698 @item M-S-@key{left}
1699 @itemx M-S-@key{right}
1700 Decrease/increase the indentation of the item, including subitems.
1701 Initially, the item tree is selected based on current indentation.  When
1702 these commands are executed several times in direct succession, the initially
1703 selected region is used, even if the new indentation would imply a different
1704 hierarchy.  To use the new hierarchy, break the command chain with a cursor
1705 motion or so.
1707 As a special case, using this command on the very first item of a list will
1708 move the whole list.  This behavior can be disabled by configuring
1709 @code{org-list-automatic-rules}.  The global indentation of a list has no
1710 influence on the text @emph{after} the list.
1711 @kindex C-c C-c
1712 @item C-c C-c
1713 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1714 state of the checkbox.  In any case, verify bullets and indentation
1715 consistency in the whole list.
1716 @kindex C-c -
1717 @vindex org-plain-list-ordered-item-terminator
1718 @vindex org-list-automatic-rules
1719 @item C-c -
1720 Cycle the entire list level through the different itemize/enumerate bullets
1721 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1722 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1723 and its position@footnote{See @code{bullet} rule in
1724 @code{org-list-automatic-rules} for more information.}.  With a numeric
1725 prefix argument N, select the Nth bullet from this list.  If there is an
1726 active region when calling this, selected text will be changed into an item.
1727 With a prefix argument, all lines will be converted to list items.  If the
1728 first line already was a list item, any item marker will be removed from the
1729 list.  Finally, even without an active region, a normal line will be
1730 converted into a list item.
1731 @kindex C-c *
1732 @item C-c *
1733 Turn a plain list item into a headline (so that it becomes a subheading at
1734 its location).  @xref{Structure editing}, for a detailed explanation.
1735 @kindex C-c C-*
1736 @item C-c C-*
1737 Turn the whole plain list into a subtree of the current heading.  Checkboxes
1738 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1739 (resp. checked).
1740 @kindex S-@key{left}
1741 @kindex S-@key{right}
1742 @item S-@key{left}/@key{right}
1743 @vindex org-support-shift-select
1744 This command also cycles bullet styles when the cursor in on the bullet or
1745 anywhere in an item line, details depending on
1746 @code{org-support-shift-select}.
1747 @kindex C-c ^
1748 @item C-c ^
1749 Sort the plain list.  You will be prompted for the sorting method:
1750 numerically, alphabetically, by time, or by custom function.
1751 @end table
1753 @node Drawers, Blocks, Plain lists, Document Structure
1754 @section Drawers
1755 @cindex drawers
1756 @cindex #+DRAWERS
1757 @cindex visibility cycling, drawers
1759 @vindex org-drawers
1760 Sometimes you want to keep information associated with an entry, but you
1761 normally don't want to see it.  For this, Org mode has @emph{drawers}.
1762 Drawers need to be configured with the variable
1763 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1764 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}.  Drawers
1765 look like this:
1767 @example
1768 ** This is a headline
1769    Still outside the drawer
1770    :DRAWERNAME:
1771    This is inside the drawer.
1772    :END:
1773    After the drawer.
1774 @end example
1776 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1777 show the entry, but keep the drawer collapsed to a single line.  In order to
1778 look inside the drawer, you need to move the cursor to the drawer line and
1779 press @key{TAB} there.  Org mode uses the @code{PROPERTIES} drawer for
1780 storing properties (@pxref{Properties and Columns}), and you can also arrange
1781 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1782 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.  If you
1783 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1785 @table @kbd
1786 @kindex C-c C-z
1787 @item C-c C-z
1788 Add a time-stamped note to the LOGBOOK drawer.
1789 @end table
1791 @node Blocks, Footnotes, Drawers, Document Structure
1792 @section Blocks
1794 @vindex org-hide-block-startup
1795 @cindex blocks, folding
1796 Org mode uses begin...end blocks for various purposes from including source
1797 code examples (@pxref{Literal examples}) to capturing time logging
1798 information (@pxref{Clocking work time}).  These blocks can be folded and
1799 unfolded by pressing TAB in the begin line.  You can also get all blocks
1800 folded at startup by configuring the variable @code{org-hide-block-startup}
1801 or on a per-file basis by using
1803 @cindex @code{hideblocks}, STARTUP keyword
1804 @cindex @code{nohideblocks}, STARTUP keyword
1805 @example
1806 #+STARTUP: hideblocks
1807 #+STARTUP: nohideblocks
1808 @end example
1810 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1811 @section Footnotes
1812 @cindex footnotes
1814 Org mode supports the creation of footnotes.  In contrast to the
1815 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1816 larger document, not only for one-off documents like emails.  The basic
1817 syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
1818 defined in a paragraph that is started by a footnote marker in square
1819 brackets in column 0, no indentation allowed.  If you need a paragraph break
1820 inside a footnote, use the @LaTeX{} idiom @samp{\par}.  The footnote reference
1821 is simply the marker in square brackets, inside text.  For example:
1823 @example
1824 The Org homepage[fn:1] now looks a lot better than it used to.
1826 [fn:1] The link is: http://orgmode.org
1827 @end example
1829 Org mode extends the number-based syntax to @emph{named} footnotes and
1830 optional inline definition.  Using plain numbers as markers (as
1831 @file{footnote.el} does) is supported for backward compatibility, but not
1832 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1833 LaTeX}).  Here are the valid references:
1835 @table @code
1836 @item [1]
1837 A plain numeric footnote marker.  Compatible with @file{footnote.el}, but not
1838 recommended because something like @samp{[1]} could easily be part of a code
1839 snippet.
1840 @item [fn:name]
1841 A named footnote reference, where @code{name} is a unique label word, or, for
1842 simplicity of automatic creation, a number.
1843 @item [fn:: This is the inline definition of this footnote]
1844 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1845 reference point.
1846 @item [fn:name: a definition]
1847 An inline definition of a footnote, which also specifies a name for the note.
1848 Since Org allows multiple references to the same note, you can then use
1849 @code{[fn:name]} to create additional references.
1850 @end table
1852 @vindex org-footnote-auto-label
1853 Footnote labels can be created automatically, or you can create names yourself.
1854 This is handled by the variable @code{org-footnote-auto-label} and its
1855 corresponding @code{#+STARTUP} keywords.  See the docstring of that variable
1856 for details.
1858 @noindent The following command handles footnotes:
1860 @table @kbd
1861 @kindex C-c C-x f
1862 @item C-c C-x f
1863 The footnote action command.
1865 When the cursor is on a footnote reference, jump to the definition.  When it
1866 is at a definition, jump to the (first) reference.
1868 @vindex org-footnote-define-inline
1869 @vindex org-footnote-section
1870 @vindex org-footnote-auto-adjust
1871 Otherwise, create a new footnote.  Depending on the variable
1872 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1873 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1874 definition will be placed right into the text as part of the reference, or
1875 separately into the location determined by the variable
1876 @code{org-footnote-section}.
1878 When this command is called with a prefix argument, a menu of additional
1879 options is offered:
1880 @example
1881 s   @r{Sort the footnote definitions by reference sequence.  During editing,}
1882     @r{Org makes no effort to sort footnote definitions into a particular}
1883     @r{sequence.  If you want them sorted, use this command, which will}
1884     @r{also move entries according to @code{org-footnote-section}.  Automatic}
1885     @r{sorting after each insertion/deletion can be configured using the}
1886     @r{variable @code{org-footnote-auto-adjust}.}
1887 r   @r{Renumber the simple @code{fn:N} footnotes.  Automatic renumbering}
1888     @r{after each insertion/deletion can be configured using the variable}
1889     @r{@code{org-footnote-auto-adjust}.}
1890 S   @r{Short for first @code{r}, then @code{s} action.}
1891 n   @r{Normalize the footnotes by collecting all definitions (including}
1892     @r{inline definitions) into a special section, and then numbering them}
1893     @r{in sequence.  The references will then also be numbers.  This is}
1894     @r{meant to be the final step before finishing a document (e.g.@: sending}
1895     @r{off an email).  The exporters do this automatically, and so could}
1896     @r{something like @code{message-send-hook}.}
1897 d   @r{Delete the footnote at point, and all definitions of and references}
1898     @r{to it.}
1899 @end example
1900 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1901 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1902 renumbering and sorting footnotes can be automatic after each insertion or
1903 deletion.
1905 @kindex C-c C-c
1906 @item C-c C-c
1907 If the cursor is on a footnote reference, jump to the definition.  If it is a
1908 the definition, jump back to the reference.  When called at a footnote
1909 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1910 @kindex C-c C-o
1911 @kindex mouse-1
1912 @kindex mouse-2
1913 @item C-c C-o  @r{or} mouse-1/2
1914 Footnote labels are also links to the corresponding definition/reference, and
1915 you can use the usual commands to follow these links.
1916 @end table
1918 @node Orgstruct mode,  , Footnotes, Document Structure
1919 @section The Orgstruct minor mode
1920 @cindex Orgstruct mode
1921 @cindex minor mode for structure editing
1923 If you like the intuitive way the Org mode structure editing and list
1924 formatting works, you might want to use these commands in other modes like
1925 Text mode or Mail mode as well.  The minor mode @code{orgstruct-mode} makes
1926 this possible.   Toggle the mode with @kbd{M-x orgstruct-mode}, or
1927 turn it on by default, for example in Message mode, with one of:
1929 @lisp
1930 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1931 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1932 @end lisp
1934 When this mode is active and the cursor is on a line that looks to Org like a
1935 headline or the first line of a list item, most structure editing commands
1936 will work, even if the same keys normally have different functionality in the
1937 major mode you are using.  If the cursor is not in one of those special
1938 lines, Orgstruct mode lurks silently in the shadows.  When you use
1939 @code{orgstruct++-mode}, Org will also export indentation and autofill
1940 settings into that mode, and detect item context after the first line of an
1941 item.
1943 @node Tables, Hyperlinks, Document Structure, Top
1944 @chapter Tables
1945 @cindex tables
1946 @cindex editing tables
1948 Org comes with a fast and intuitive table editor.  Spreadsheet-like
1949 calculations are supported using the Emacs @file{calc} package
1950 @ifinfo
1951 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1952 @end ifinfo
1953 @ifnotinfo
1954 (see the Emacs Calculator manual for more information about the Emacs
1955 calculator).
1956 @end ifnotinfo
1958 @menu
1959 * Built-in table editor::       Simple tables
1960 * Column width and alignment::  Overrule the automatic settings
1961 * Column groups::               Grouping to trigger vertical lines
1962 * Orgtbl mode::                 The table editor as minor mode
1963 * The spreadsheet::             The table editor has spreadsheet capabilities
1964 * Org-Plot::                    Plotting from org tables
1965 @end menu
1967 @node Built-in table editor, Column width and alignment, Tables, Tables
1968 @section The built-in table editor
1969 @cindex table editor, built-in
1971 Org makes it easy to format tables in plain ASCII.  Any line with @samp{|} as
1972 the first non-whitespace character is considered part of a table.  @samp{|}
1973 is also the column separator@footnote{To insert a vertical bar into a table
1974 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}.  A table
1975 might look like this:
1977 @example
1978 | Name  | Phone | Age |
1979 |-------+-------+-----|
1980 | Peter |  1234 |  17 |
1981 | Anna  |  4321 |  25 |
1982 @end example
1984 A table is re-aligned automatically each time you press @key{TAB} or
1985 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
1986 the next field (@key{RET} to the next row) and creates new table rows
1987 at the end of the table or before horizontal lines.  The indentation
1988 of the table is set by the first line.  Any line starting with
1989 @samp{|-} is considered as a horizontal separator line and will be
1990 expanded on the next re-align to span the whole table width.  So, to
1991 create the above table, you would only type
1993 @example
1994 |Name|Phone|Age|
1996 @end example
1998 @noindent and then press @key{TAB} to align the table and start filling in
1999 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
2000 @kbd{C-c @key{RET}}.
2002 @vindex org-enable-table-editor
2003 @vindex org-table-auto-blank-field
2004 When typing text into a field, Org treats @key{DEL},
2005 @key{Backspace}, and all character keys in a special way, so that
2006 inserting and deleting avoids shifting other fields.  Also, when
2007 typing @emph{immediately after the cursor was moved into a new field
2008 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2009 field is automatically made blank.  If this behavior is too
2010 unpredictable for you, configure the variables
2011 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2013 @table @kbd
2014 @tsubheading{Creation and conversion}
2015 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2016 Convert the active region to table.  If every line contains at least one
2017 TAB character, the function assumes that the material is tab separated.
2018 If every line contains a comma, comma-separated values (CSV) are assumed.
2019 If not, lines are split at whitespace into fields.  You can use a prefix
2020 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2021 C-u} forces TAB, and a numeric argument N indicates that at least N
2022 consecutive spaces, or alternatively a TAB will be the separator.
2024 If there is no active region, this command creates an empty Org
2025 table.  But it is easier just to start typing, like
2026 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2028 @tsubheading{Re-aligning and field motion}
2029 @orgcmd{C-c C-c,org-table-align}
2030 Re-align the table without moving the cursor.
2032 @orgcmd{<TAB>,org-table-next-field}
2033 Re-align the table, move to the next field.  Creates a new row if
2034 necessary.
2036 @orgcmd{S-@key{TAB},org-table-previous-field}
2037 Re-align, move to previous field.
2039 @orgcmd{@key{RET},org-table-next-row}
2040 Re-align the table and move down to next row.  Creates a new row if
2041 necessary.  At the beginning or end of a line, @key{RET} still does
2042 NEWLINE, so it can be used to split a table.
2044 @orgcmd{M-a,org-table-beginning-of-field}
2045 Move to beginning of the current table field, or on to the previous field.
2046 @orgcmd{M-e,org-table-end-of-field}
2047 Move to end of the current table field, or on to the next field.
2049 @tsubheading{Column and row editing}
2050 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2051 Move the current column left/right.
2053 @orgcmd{M-S-@key{left},org-table-delete-column}
2054 Kill the current column.
2056 @orgcmd{M-S-@key{right},org-table-insert-column}
2057 Insert a new column to the left of the cursor position.
2059 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2060 Move the current row up/down.
2062 @orgcmd{M-S-@key{up},org-table-kill-row}
2063 Kill the current row or horizontal line.
2065 @orgcmd{M-S-@key{down},org-table-insert-row}
2066 Insert a new row above the current row.  With a prefix argument, the line is
2067 created below the current one.
2069 @orgcmd{C-c -,org-table-insert-hline}
2070 Insert a horizontal line below current row.  With a prefix argument, the line
2071 is created above the current line.
2073 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2074 Insert a horizontal line below current row, and move the cursor into the row
2075 below that line.
2077 @orgcmd{C-c ^,org-table-sort-lines}
2078 Sort the table lines in the region.  The position of point indicates the
2079 column to be used for sorting, and the range of lines is the range
2080 between the nearest horizontal separator lines, or the entire table.  If
2081 point is before the first column, you will be prompted for the sorting
2082 column.  If there is an active region, the mark specifies the first line
2083 and the sorting column, while point should be in the last line to be
2084 included into the sorting.  The command prompts for the sorting type
2085 (alphabetically, numerically, or by time).  When called with a prefix
2086 argument, alphabetic sorting will be case-sensitive.
2088 @tsubheading{Regions}
2089 @orgcmd{C-c C-x M-w,org-table-copy-region}
2090 Copy a rectangular region from a table to a special clipboard.  Point and
2091 mark determine edge fields of the rectangle.  If there is no active region,
2092 copy just the current field.  The process ignores horizontal separator lines.
2094 @orgcmd{C-c C-x C-w,org-table-cut-region}
2095 Copy a rectangular region from a table to a special clipboard, and
2096 blank all fields in the rectangle.  So this is the ``cut'' operation.
2098 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2099 Paste a rectangular region into a table.
2100 The upper left corner ends up in the current field.  All involved fields
2101 will be overwritten.  If the rectangle does not fit into the present table,
2102 the table is enlarged as needed.  The process ignores horizontal separator
2103 lines.
2105 @orgcmd{M-@key{RET},org-table-wrap-region}
2106 Split the current field at the cursor position and move the rest to the line
2107 below.  If there is an active region, and both point and mark are in the same
2108 column, the text in the column is wrapped to minimum width for the given
2109 number of lines.  A numeric prefix argument may be used to change the number
2110 of desired lines.  If there is no region, but you specify a prefix argument,
2111 the current field is made blank, and the content is appended to the field
2112 above.
2114 @tsubheading{Calculations}
2115 @cindex formula, in tables
2116 @cindex calculations, in tables
2117 @cindex region, active
2118 @cindex active region
2119 @cindex transient mark mode
2120 @orgcmd{C-c +,org-table-sum}
2121 Sum the numbers in the current column, or in the rectangle defined by
2122 the active region.  The result is shown in the echo area and can
2123 be inserted with @kbd{C-y}.
2125 @orgcmd{S-@key{RET},org-table-copy-down}
2126 @vindex org-table-copy-increment
2127 When current field is empty, copy from first non-empty field above.  When not
2128 empty, copy current field down to next row and move cursor along with it.
2129 Depending on the variable @code{org-table-copy-increment}, integer field
2130 values will be incremented during copy.  Integers that are too large will not
2131 be incremented.  Also, a @code{0} prefix argument temporarily disables the
2132 increment.  This key is also used by shift-selection and related modes
2133 (@pxref{Conflicts}).
2135 @tsubheading{Miscellaneous}
2136 @orgcmd{C-c `,org-table-edit-field}
2137 Edit the current field in a separate window.  This is useful for fields that
2138 are not fully visible (@pxref{Column width and alignment}).  When called with
2139 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2140 edited in place.  When called with two @kbd{C-u} prefixes, make the editor
2141 window follow the cursor through the table and always show the current
2142 field.  The follow mode exits automatically when the cursor leaves the table,
2143 or when you repeat this command with @kbd{C-u C-u C-c `}.
2145 @item M-x org-table-import
2146 Import a file as a table.  The table should be TAB or whitespace
2147 separated.  Use, for example, to import a spreadsheet table or data
2148 from a database, because these programs generally can write
2149 TAB-separated text files.  This command works by inserting the file into
2150 the buffer and then converting the region to a table.  Any prefix
2151 argument is passed on to the converter, which uses it to determine the
2152 separator.
2153 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2154 Tables can also be imported by pasting tabular text into the Org
2155 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2156 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2158 @item M-x org-table-export
2159 @findex org-table-export
2160 @vindex org-table-export-default-format
2161 Export the table, by default as a TAB-separated file.  Use for data
2162 exchange with, for example, spreadsheet or database programs.  The format
2163 used to export the file can be configured in the variable
2164 @code{org-table-export-default-format}.  You may also use properties
2165 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2166 name and the format for table export in a subtree.  Org supports quite
2167 general formats for exported tables.  The exporter format is the same as the
2168 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2169 detailed description.
2170 @end table
2172 If you don't like the automatic table editor because it gets in your
2173 way on lines which you would like to start with @samp{|}, you can turn
2174 it off with
2176 @lisp
2177 (setq org-enable-table-editor nil)
2178 @end lisp
2180 @noindent Then the only table command that still works is
2181 @kbd{C-c C-c} to do a manual re-align.
2183 @node Column width and alignment, Column groups, Built-in table editor, Tables
2184 @section Column width and alignment
2185 @cindex narrow columns in tables
2186 @cindex alignment in tables
2188 The width of columns is automatically determined by the table editor.  And
2189 also the alignment of a column is determined automatically from the fraction
2190 of number-like versus non-number fields in the column.
2192 Sometimes a single field or a few fields need to carry more text, leading to
2193 inconveniently wide columns.  Or maybe you want to make a table with several
2194 columns having a fixed width, regardless of content.  To set@footnote{This
2195 feature does not work on XEmacs.} the width of a column, one field anywhere
2196 in the column may contain just the string @samp{<N>} where @samp{N} is an
2197 integer specifying the width of the column in characters.  The next re-align
2198 will then set the width of this column to this value.
2200 @example
2201 @group
2202 |---+------------------------------|               |---+--------|
2203 |   |                              |               |   | <6>    |
2204 | 1 | one                          |               | 1 | one    |
2205 | 2 | two                          |     ----\     | 2 | two    |
2206 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
2207 | 4 | four                         |               | 4 | four   |
2208 |---+------------------------------|               |---+--------|
2209 @end group
2210 @end example
2212 @noindent
2213 Fields that are wider become clipped and end in the string @samp{=>}.
2214 Note that the full text is still in the buffer but is hidden.
2215 To see the full text, hold the mouse over the field---a tool-tip window
2216 will show the full content.  To edit such a field, use the command
2217 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
2218 open a new window with the full field.  Edit it and finish with @kbd{C-c
2219 C-c}.
2221 @vindex org-startup-align-all-tables
2222 When visiting a file containing a table with narrowed columns, the
2223 necessary character hiding has not yet happened, and the table needs to
2224 be aligned before it looks nice.  Setting the option
2225 @code{org-startup-align-all-tables} will realign all tables in a file
2226 upon visiting, but also slow down startup.  You can also set this option
2227 on a per-file basis with:
2229 @example
2230 #+STARTUP: align
2231 #+STARTUP: noalign
2232 @end example
2234 If you would like to overrule the automatic alignment of number-rich columns
2235 to the right and of string-rich column to the left, you can use @samp{<r>},
2236 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2237 effect when exporting to HTML.} or @samp{<l>} in a similar fashion.  You may
2238 also combine alignment and field width like this: @samp{<l10>}.
2240 Lines which only contain these formatting cookies will be removed
2241 automatically when exporting the document.
2243 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2244 @section Column groups
2245 @cindex grouping columns in tables
2247 When Org exports tables, it does so by default without vertical
2248 lines because that is visually more satisfying in general.  Occasionally
2249 however, vertical lines can be useful to structure a table into groups
2250 of columns, much like horizontal lines can do for groups of rows.  In
2251 order to specify column groups, you can use a special row where the
2252 first field contains only @samp{/}.  The further fields can either
2253 contain @samp{<} to indicate that this column should start a group,
2254 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2255 a group of its own.  Boundaries between column groups will upon export be
2256 marked with vertical lines.  Here is an example:
2258 @example
2259 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2260 |---+-----+-----+-----+---------+------------|
2261 | / |   < |     |   > |       < |          > |
2262 | 1 |   1 |   1 |   1 |       1 |          1 |
2263 | 2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
2264 | 3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
2265 |---+-----+-----+-----+---------+------------|
2266 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2267 @end example
2269 It is also sufficient to just insert the column group starters after
2270 every vertical line you would like to have:
2272 @example
2273 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2274 |----+-----+-----+-----+---------+------------|
2275 | /  | <   |     |     | <       |            |
2276 @end example
2278 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2279 @section The Orgtbl minor mode
2280 @cindex Orgtbl mode
2281 @cindex minor mode for tables
2283 If you like the intuitive way the Org table editor works, you
2284 might also want to use it in other modes like Text mode or Mail mode.
2285 The minor mode Orgtbl mode makes this possible.  You can always toggle
2286 the mode with @kbd{M-x orgtbl-mode}.  To turn it on by default, for
2287 example in Message mode, use
2289 @lisp
2290 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2291 @end lisp
2293 Furthermore, with some special setup, it is possible to maintain tables
2294 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
2295 construct @LaTeX{} tables with the underlying ease and power of
2296 Orgtbl mode, including spreadsheet capabilities.  For details, see
2297 @ref{Tables in arbitrary syntax}.
2299 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2300 @section The spreadsheet
2301 @cindex calculations, in tables
2302 @cindex spreadsheet capabilities
2303 @cindex @file{calc} package
2305 The table editor makes use of the Emacs @file{calc} package to implement
2306 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
2307 derive fields from other fields.  While fully featured, Org's implementation
2308 is not identical to other spreadsheets.  For example, Org knows the concept
2309 of a @emph{column formula} that will be applied to all non-header fields in a
2310 column without having to copy the formula to each relevant field.  There is
2311 also a formula debugger, and a formula editor with features for highlighting
2312 fields in the table corresponding to the references at the point in the
2313 formula, moving these references by arrow keys
2315 @menu
2316 * References::                  How to refer to another field or range
2317 * Formula syntax for Calc::     Using Calc to compute stuff
2318 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
2319 * Durations and time values::   How to compute durations and time values
2320 * Field and range formulas::    Formula for specific (ranges of) fields
2321 * Column formulas::             Formulas valid for an entire column
2322 * Editing and debugging formulas::  Fixing formulas
2323 * Updating the table::          Recomputing all dependent fields
2324 * Advanced features::           Field and column names, parameters and automatic recalc
2325 @end menu
2327 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2328 @subsection References
2329 @cindex references
2331 To compute fields in the table from other fields, formulas must
2332 reference other fields or ranges.  In Org, fields can be referenced
2333 by name, by absolute coordinates, and by relative coordinates.  To find
2334 out what the coordinates of a field are, press @kbd{C-c ?} in that
2335 field, or press @kbd{C-c @}} to toggle the display of a grid.
2337 @subsubheading Field references
2338 @cindex field references
2339 @cindex references, to fields
2341 Formulas can reference the value of another field in two ways.  Like in
2342 any other spreadsheet, you may reference fields with a letter/number
2343 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2344 @vindex org-table-use-standard-references
2345 However, Org prefers@footnote{Org will understand references typed by the
2346 user as @samp{B4}, but it will not use this syntax when offering a formula
2347 for editing.  You can customize this behavior using the variable
2348 @code{org-table-use-standard-references}.}  to use another, more general
2349 representation that looks like this:
2350 @example
2351 @@@var{row}$@var{column}
2352 @end example
2354 Column specifications can be absolute like @code{$1},
2355 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
2356 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2357 @code{$<} and @code{$>} are immutable references to the first and last
2358 column, respectively, and you can use @code{$>>>} to indicate the third
2359 column from the right.
2361 The row specification only counts data lines and ignores horizontal separator
2362 lines (hlines).  Like with columns, you can use absolute row numbers
2363 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2364 current row like @code{@@+3} or @code{@@-1}.  @code{@@<} and @code{@@>} are
2365 immutable references the first and last@footnote{For backward compatibility
2366 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2367 a stable way to the 5th and 12th field in the last row of the table.
2368 However, this syntax is deprecated, it should not be used for new documents.
2369 Use @code{@@>$} instead.} row in the table, respectively.  You may also
2370 specify the row relative to one of the hlines: @code{@@I} refers to the first
2371 hline, @code{@@II} to the second, etc@.  @code{@@-I} refers to the first such
2372 line above the current line, @code{@@+I} to the first such line below the
2373 current line.  You can also write @code{@@III+2} which is the second data line
2374 after the third hline in the table.
2376 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2377 i.e. to the row/column for the field being computed.  Also, if you omit
2378 either the column or the row part of the reference, the current row/column is
2379 implied.
2381 Org's references with @emph{unsigned} numbers are fixed references
2382 in the sense that if you use the same reference in the formula for two
2383 different fields, the same field will be referenced each time.
2384 Org's references with @emph{signed} numbers are floating
2385 references because the same reference operator can reference different
2386 fields depending on the field being calculated by the formula.
2388 Here are a few examples:
2390 @example
2391 @@2$3      @r{2nd row, 3rd column (same as @code{C2})}
2392 $5        @r{column 5 in the current row (same as @code{E&})}
2393 @@2        @r{current column, row 2}
2394 @@-1$-3    @r{the field one row up, three columns to the left}
2395 @@-I$2     @r{field just under hline above current row, column 2}
2396 @@>$5      @r{field in the last row, in column 5}
2397 @end example
2399 @subsubheading Range references
2400 @cindex range references
2401 @cindex references, to ranges
2403 You may reference a rectangular range of fields by specifying two field
2404 references connected by two dots @samp{..}.  If both fields are in the
2405 current row, you may simply use @samp{$2..$7}, but if at least one field
2406 is in a different row, you need to use the general @code{@@row$column}
2407 format at least for the first field (i.e the reference must start with
2408 @samp{@@} in order to be interpreted correctly).  Examples:
2410 @example
2411 $1..$3        @r{first three fields in the current row}
2412 $P..$Q        @r{range, using column names (see under Advanced)}
2413 $<<<..$>>     @r{start in third column, continue to the one but last}
2414 @@2$1..@@4$3    @r{6 fields between these two fields (same as @code{A2..C4})}
2415 @@-1$-2..@@-1   @r{3 numbers from the column to the left, 2 up to current row}
2416 @@I..II        @r{between first and second hline, short for @code{@@I..@@II}}
2417 @end example
2419 @noindent Range references return a vector of values that can be fed
2420 into Calc vector functions.  Empty fields in ranges are normally
2421 suppressed, so that the vector contains only the non-empty fields (but
2422 see the @samp{E} mode switch below).  If there are no non-empty fields,
2423 @samp{[0]} is returned to avoid syntax errors in formulas.
2425 @subsubheading Field coordinates in formulas
2426 @cindex field coordinates
2427 @cindex coordinates, of field
2428 @cindex row, of field coordinates
2429 @cindex column, of field coordinates
2431 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2432 get the row or column number of the field where the formula result goes.
2433 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2434 and @code{org-table-current-column}.  Examples:
2436 @example
2437 if(@@# % 2, $#, string(""))   @r{column number on odd lines only}
2438 $3 = remote(FOO, @@@@#$2)      @r{copy column 2 from table FOO into}
2439                              @r{column 3 of the current table}
2440 @end example
2442 @noindent For the second example, table FOO must have at least as many rows
2443 as the current table.  Note that this is inefficient@footnote{The computation time scales as
2444 O(N^2) because table FOO is parsed for each field to be copied.} for large
2445 number of rows.
2447 @subsubheading Named references
2448 @cindex named references
2449 @cindex references, named
2450 @cindex name, of column or field
2451 @cindex constants, in calculations
2452 @cindex #+CONSTANTS
2454 @vindex org-table-formula-constants
2455 @samp{$name} is interpreted as the name of a column, parameter or
2456 constant.  Constants are defined globally through the variable
2457 @code{org-table-formula-constants}, and locally (for the file) through a
2458 line like
2460 @example
2461 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2462 @end example
2464 @noindent
2465 @vindex constants-unit-system
2466 @pindex constants.el
2467 Also properties (@pxref{Properties and Columns}) can be used as
2468 constants in table formulas: for a property @samp{:Xyz:} use the name
2469 @samp{$PROP_Xyz}, and the property will be searched in the current
2470 outline entry and in the hierarchy above it.  If you have the
2471 @file{constants.el} package, it will also be used to resolve constants,
2472 including natural constants like @samp{$h} for Planck's constant, and
2473 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2474 supply the values of constants in two different unit systems, @code{SI}
2475 and @code{cgs}.  Which one is used depends on the value of the variable
2476 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
2477 @code{constSI} and @code{constcgs} to set this value for the current
2478 buffer.}.  Column names and parameters can be specified in special table
2479 lines.  These are described below, see @ref{Advanced features}.  All
2480 names must start with a letter, and further consist of letters and
2481 numbers.
2483 @subsubheading Remote references
2484 @cindex remote references
2485 @cindex references, remote
2486 @cindex references, to a different table
2487 @cindex name, of column or field
2488 @cindex constants, in calculations
2489 @cindex #+TBLNAME
2491 You may also reference constants, fields and ranges from a different table,
2492 either in the current file or even in a different file.  The syntax is
2494 @example
2495 remote(NAME-OR-ID,REF)
2496 @end example
2498 @noindent
2499 where NAME can be the name of a table in the current file as set by a
2500 @code{#+TBLNAME: NAME} line before the table.  It can also be the ID of an
2501 entry, even in a different file, and the reference then refers to the first
2502 table in that entry.  REF is an absolute field or range reference as
2503 described above for example @code{@@3$3} or @code{$somename}, valid in the
2504 referenced table.
2506 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2507 @subsection Formula syntax for Calc
2508 @cindex formula syntax, Calc
2509 @cindex syntax, of formulas
2511 A formula can be any algebraic expression understood by the Emacs
2512 @file{Calc} package.  @b{Note that @file{calc} has the
2513 non-standard convention that @samp{/} has lower precedence than
2514 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.}  Before
2515 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2516 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2517 Emacs Calc Manual}),
2518 @c FIXME:  The link to the Calc manual in HTML does not work.
2519 variable substitution takes place according to the rules described above.
2520 @cindex vectors, in table calculations
2521 The range vectors can be directly fed into the Calc vector functions
2522 like @samp{vmean} and @samp{vsum}.
2524 @cindex format specifier
2525 @cindex mode, for @file{calc}
2526 @vindex org-calc-default-modes
2527 A formula can contain an optional mode string after a semicolon.  This
2528 string consists of flags to influence Calc and other modes during
2529 execution.  By default, Org uses the standard Calc modes (precision
2530 12, angular units degrees, fraction and symbolic modes off).  The display
2531 format, however, has been changed to @code{(float 8)} to keep tables
2532 compact.  The default settings can be configured using the variable
2533 @code{org-calc-default-modes}.
2535 @example
2536 p20           @r{set the internal Calc calculation precision to 20 digits}
2537 n3 s3 e2 f4   @r{Normal, scientific, engineering, or fixed}
2538               @r{format of the result of Calc passed back to Org.}
2539               @r{Calc formatting is unlimited in precision as}
2540               @r{long as the Calc calculation precision is greater.}
2541 D R           @r{angle modes: degrees, radians}
2542 F S           @r{fraction and symbolic modes}
2543 N             @r{interpret all fields as numbers, use 0 for non-numbers}
2544 E             @r{keep empty fields in ranges}
2545 L             @r{literal}
2546 @end example
2548 @noindent
2549 Unless you use large integer numbers or high-precision-calculation
2550 and -display for floating point numbers you may alternatively provide a
2551 @code{printf} format specifier to reformat the Calc result after it has been
2552 passed back to Org instead of letting Calc already do the
2553 formatting@footnote{The @code{printf} reformatting is limited in precision
2554 because the value passed to it is converted into an @code{integer} or
2555 @code{double}.  The @code{integer} is limited in size by truncating the
2556 signed value to 32 bits.  The @code{double} is limited in precision to 64
2557 bits overall which leaves approximately 16 significant decimal digits.}.
2558 A few examples:
2560 @example
2561 $1+$2                @r{Sum of first and second field}
2562 $1+$2;%.2f           @r{Same, format result to two decimals}
2563 exp($2)+exp($1)      @r{Math functions can be used}
2564 $0;%.1f              @r{Reformat current cell to 1 decimal}
2565 ($3-32)*5/9          @r{Degrees F -> C conversion}
2566 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
2567 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
2568 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
2569 vmean($2..$7)        @r{Compute column range mean, using vector function}
2570 vmean($2..$7);EN     @r{Same, but treat empty fields as 0}
2571 taylor($3,x=7,2)     @r{Taylor series of $3, at x=7, second degree}
2572 @end example
2574 Calc also contains a complete set of logical operations.  For example
2576 @example
2577 if($1<20,teen,string(""))  @r{"teen" if age $1 less than 20, else empty}
2578 @end example
2580 Note that you can also use two org-specific flags @code{T} and @code{t} for
2581 durations computations @ref{Durations and time values}.
2583 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2584 @subsection Emacs Lisp forms as formulas
2585 @cindex Lisp forms, as table formulas
2587 It is also possible to write a formula in Emacs Lisp; this can be useful for
2588 string manipulation and control structures, if Calc's functionality is not
2589 enough.  If a formula starts with a single-quote followed by an opening
2590 parenthesis, then it is evaluated as a Lisp form.  The evaluation should
2591 return either a string or a number.  Just as with @file{calc} formulas, you
2592 can specify modes and a printf format after a semicolon.  With Emacs Lisp
2593 forms, you need to be conscious about the way field references are
2594 interpolated into the form.  By default, a reference will be interpolated as
2595 a Lisp string (in double-quotes) containing the field.  If you provide the
2596 @samp{N} mode switch, all referenced elements will be numbers (non-number
2597 fields will be zero) and interpolated as Lisp numbers, without quotes.  If
2598 you provide the @samp{L} flag, all fields will be interpolated literally,
2599 without quotes.  I.e., if you want a reference to be interpreted as a string
2600 by the Lisp form, enclose the reference operator itself in double-quotes,
2601 like @code{"$3"}.  Ranges are inserted as space-separated fields, so you can
2602 embed them in list or vector syntax.  Here are a few examples---note how the
2603 @samp{N} mode is used when we do computations in Lisp:
2605 @example
2606 @r{Swap the first two characters of the content of column 1}
2607   '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2608 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2609   '(+ $1 $2);N
2610 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2611   '(apply '+ '($1..$4));N
2612 @end example
2614 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2615 @subsection Durations and time values
2616 @cindex Duration, computing
2617 @cindex Time, computing
2618 @vindex org-table-duration-custom-format
2620 If you want to compute time values use the @code{T} flag, either in Calc
2621 formulas or Elisp formulas:
2623 @example
2624 @group
2625   |  Task 1 |   Task 2 |    Total |
2626   |---------+----------+----------|
2627   |    2:12 |     1:47 | 03:59:00 |
2628   | 3:02:20 | -2:07:00 |     0.92 |
2629   #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2630 @end group
2631 @end example
2633 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2634 are optional.  With the @code{T} flag, computed durations will be displayed
2635 as @code{[HH:MM:SS} (see the first formula above).  With the @code{t} flag,
2636 computed durations will be displayed according to the value of the variable
2637 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2638 will display the result as a fraction of hours (see the second formula in the
2639 example above).
2641 Negative duration values can be manipulated as well, and integers will be
2642 considered as seconds in addition and subtraction.
2644 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2645 @subsection Field and range formulas
2646 @cindex field formula
2647 @cindex range formula
2648 @cindex formula, for individual table field
2649 @cindex formula, for range of fields
2651 To assign a formula to a particular field, type it directly into the field,
2652 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}.  When you press
2653 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2654 the formula will be stored as the formula for this field, evaluated, and the
2655 current field will be replaced with the result.
2657 @cindex #+TBLFM
2658 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2659 below the table.  If you type the equation in the 4th field of the 3rd data
2660 line in the table, the formula will look like @samp{@@3$4=$1+$2}.  When
2661 inserting/deleting/swapping column and rows with the appropriate commands,
2662 @i{absolute references} (but not relative ones) in stored formulas are
2663 modified in order to still reference the same field.  To avoid this from
2664 happening, in particular in range references, anchor ranges at the table
2665 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2666 using the @code{@@I} notation.  Automatic adaptation of field references does
2667 of cause not happen if you edit the table structure with normal editing
2668 commands---then you must fix the equations yourself.
2670 Instead of typing an equation into the field, you may also use the following
2671 command
2673 @table @kbd
2674 @orgcmd{C-u C-c =,org-table-eval-formula}
2675 Install a new formula for the current field.  The command prompts for a
2676 formula with default taken from the @samp{#+TBLFM:} line, applies
2677 it to the current field, and stores it.
2678 @end table
2680 The left-hand side of a formula can also be a special expression in order to
2681 assign the formula to a number of different fields.  There is no keyboard
2682 shortcut to enter such range formulas.  To add them, use the formula editor
2683 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2684 directly.
2686 @table @code
2687 @item $2=
2688 Column formula, valid for the entire column.  This is so common that Org
2689 treats these formulas in a special way, see @ref{Column formulas}.
2690 @item @@3=
2691 Row formula, applies to all fields in the specified row.  @code{@@>=} means
2692 the last row.
2693 @item @@1$2..@@4$3=
2694 Range formula, applies to all fields in the given rectangular range.  This
2695 can also be used to assign a formula to some but not all fields in a row.
2696 @item $name=
2697 Named field, see @ref{Advanced features}.
2698 @end table
2700 @node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
2701 @subsection Column formulas
2702 @cindex column formula
2703 @cindex formula, for table column
2705 When you assign a formula to a simple column reference like @code{$3=}, the
2706 same formula will be used in all fields of that column, with the following
2707 very convenient exceptions: (i) If the table contains horizontal separator
2708 hlines, everything before the first such line is considered part of the table
2709 @emph{header} and will not be modified by column formulas.  (ii) Fields that
2710 already get a value from a field/range formula will be left alone by column
2711 formulas.  These conditions make column formulas very easy to use.
2713 To assign a formula to a column, type it directly into any field in the
2714 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2715 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2716 the formula will be stored as the formula for the current column, evaluated
2717 and the current field replaced with the result.  If the field contains only
2718 @samp{=}, the previously stored formula for this column is used.  For each
2719 column, Org will only remember the most recently used formula.  In the
2720 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}.  The
2721 left-hand side of a column formula can not be the name of column, it must be
2722 the numeric column reference or @code{$>}.
2724 Instead of typing an equation into the field, you may also use the
2725 following command:
2727 @table @kbd
2728 @orgcmd{C-c =,org-table-eval-formula}
2729 Install a new formula for the current column and replace current field with
2730 the result of the formula.  The command prompts for a formula, with default
2731 taken from the @samp{#+TBLFM} line, applies it to the current field and
2732 stores it.  With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
2733 will apply it to that many consecutive fields in the current column.
2734 @end table
2736 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2737 @subsection Editing and debugging formulas
2738 @cindex formula editing
2739 @cindex editing, of table formulas
2741 @vindex org-table-use-standard-references
2742 You can edit individual formulas in the minibuffer or directly in the
2743 field.  Org can also prepare a special buffer with all active
2744 formulas of a table.  When offering a formula for editing, Org
2745 converts references to the standard format (like @code{B3} or @code{D&})
2746 if possible.  If you prefer to only work with the internal format (like
2747 @code{@@3$2} or @code{$4}), configure the variable
2748 @code{org-table-use-standard-references}.
2750 @table @kbd
2751 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2752 Edit the formula associated with the current column/field in the
2753 minibuffer.  See @ref{Column formulas}, and @ref{Field and range formulas}.
2754 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2755 Re-insert the active formula (either a
2756 field formula, or a column formula) into the current field, so that you
2757 can edit it directly in the field.  The advantage over editing in the
2758 minibuffer is that you can use the command @kbd{C-c ?}.
2759 @orgcmd{C-c ?,org-table-field-info}
2760 While editing a formula in a table field, highlight the field(s)
2761 referenced by the reference at the cursor position in the formula.
2762 @kindex C-c @}
2763 @findex org-table-toggle-coordinate-overlays
2764 @item C-c @}
2765 Toggle the display of row and column numbers for a table, using overlays
2766 (@command{org-table-toggle-coordinate-overlays}).  These are updated each
2767 time the table is aligned; you can force it with @kbd{C-c C-c}.
2768 @kindex C-c @{
2769 @findex org-table-toggle-formula-debugger
2770 @item C-c @{
2771 Toggle the formula debugger on and off
2772 (@command{org-table-toggle-formula-debugger}).  See below.
2773 @orgcmd{C-c ',org-table-edit-formulas}
2774 Edit all formulas for the current table in a special buffer, where the
2775 formulas will be displayed one per line.  If the current field has an
2776 active formula, the cursor in the formula editor will mark it.
2777 While inside the special buffer, Org will automatically highlight
2778 any field or range reference at the cursor position.  You may edit,
2779 remove and add formulas, and use the following commands:
2780 @table @kbd
2781 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2782 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
2783 prefix, also apply the new formulas to the entire table.
2784 @orgcmd{C-c C-q,org-table-fedit-abort}
2785 Exit the formula editor without installing changes.
2786 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2787 Toggle all references in the formula editor between standard (like
2788 @code{B3}) and internal (like @code{@@3$2}).
2789 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2790 Pretty-print or indent Lisp formula at point.  When in a line containing
2791 a Lisp formula, format the formula according to Emacs Lisp rules.
2792 Another @key{TAB} collapses the formula back again.  In the open
2793 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2794 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2795 Complete Lisp symbols, just like in Emacs Lisp mode.
2796 @kindex S-@key{up}
2797 @kindex S-@key{down}
2798 @kindex S-@key{left}
2799 @kindex S-@key{right}
2800 @findex org-table-fedit-ref-up
2801 @findex org-table-fedit-ref-down
2802 @findex org-table-fedit-ref-left
2803 @findex org-table-fedit-ref-right
2804 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2805 Shift the reference at point.  For example, if the reference is
2806 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2807 This also works for relative references and for hline references.
2808 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2809 Move the test line for column formulas in the Org buffer up and
2810 down.
2811 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2812 Scroll the window displaying the table.
2813 @kindex C-c @}
2814 @findex org-table-toggle-coordinate-overlays
2815 @item C-c @}
2816 Turn the coordinate grid in the table on and off.
2817 @end table
2818 @end table
2820 Making a table field blank does not remove the formula associated with
2821 the field, because that is stored in a different line (the @samp{#+TBLFM}
2822 line)---during the next recalculation the field will be filled again.
2823 To remove a formula from a field, you have to give an empty reply when
2824 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2826 @kindex C-c C-c
2827 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2828 equations with @kbd{C-c C-c} in that line or with the normal
2829 recalculation commands in the table.
2831 @subsubheading Debugging formulas
2832 @cindex formula debugging
2833 @cindex debugging, of table formulas
2834 When the evaluation of a formula leads to an error, the field content
2835 becomes the string @samp{#ERROR}.  If you would like see what is going
2836 on during variable substitution and calculation in order to find a bug,
2837 turn on formula debugging in the @code{Tbl} menu and repeat the
2838 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2839 field.  Detailed information will be displayed.
2841 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2842 @subsection Updating the table
2843 @cindex recomputing table fields
2844 @cindex updating, table
2846 Recalculation of a table is normally not automatic, but needs to be
2847 triggered by a command.  See @ref{Advanced features}, for a way to make
2848 recalculation at least semi-automatic.
2850 In order to recalculate a line of a table or the entire table, use the
2851 following commands:
2853 @table @kbd
2854 @orgcmd{C-c *,org-table-recalculate}
2855 Recalculate the current row by first applying the stored column formulas
2856 from left to right, and all field/range formulas in the current row.
2858 @kindex C-u C-c *
2859 @item C-u C-c *
2860 @kindex C-u C-c C-c
2861 @itemx C-u C-c C-c
2862 Recompute the entire table, line by line.  Any lines before the first
2863 hline are left alone, assuming that these are part of the table header.
2865 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2866 Iterate the table by recomputing it until no further changes occur.
2867 This may be necessary if some computed fields use the value of other
2868 fields that are computed @i{later} in the calculation sequence.
2869 @item M-x org-table-recalculate-buffer-tables
2870 @findex org-table-recalculate-buffer-tables
2871 Recompute all tables in the current buffer.
2872 @item M-x org-table-iterate-buffer-tables
2873 @findex org-table-iterate-buffer-tables
2874 Iterate all tables in the current buffer, in order to converge table-to-table
2875 dependencies.
2876 @end table
2878 @node Advanced features,  , Updating the table, The spreadsheet
2879 @subsection Advanced features
2881 If you want the recalculation of fields to happen automatically, or if you
2882 want to be able to assign @i{names}@footnote{Such names must start by an
2883 alphabetic character and use only alphanumeric/underscore characters.} to
2884 fields and columns, you need to reserve the first column of the table for
2885 special marking characters.
2887 @table @kbd
2888 @orgcmd{C-#,org-table-rotate-recalc-marks}
2889 Rotate the calculation mark in first column through the states @samp{ },
2890 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
2891 change all marks in the region.
2892 @end table
2894 Here is an example of a table that collects exam results of students and
2895 makes use of these features:
2897 @example
2898 @group
2899 |---+---------+--------+--------+--------+-------+------|
2900 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2901 |---+---------+--------+--------+--------+-------+------|
2902 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
2903 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
2904 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
2905 |---+---------+--------+--------+--------+-------+------|
2906 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
2907 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
2908 |---+---------+--------+--------+--------+-------+------|
2909 |   | Average |        |        |        |  29.7 |      |
2910 | ^ |         |        |        |        |    at |      |
2911 | $ | max=50  |        |        |        |       |      |
2912 |---+---------+--------+--------+--------+-------+------|
2913 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2914 @end group
2915 @end example
2917 @noindent @b{Important}: please note that for these special tables,
2918 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2919 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2920 to the field itself.  The column formulas are not applied in rows with
2921 empty first field.
2923 @cindex marking characters, tables
2924 The marking characters have the following meaning:
2925 @table @samp
2926 @item !
2927 The fields in this line define names for the columns, so that you may
2928 refer to a column as @samp{$Tot} instead of @samp{$6}.
2929 @item ^
2930 This row defines names for the fields @emph{above} the row.  With such
2931 a definition, any formula in the table may use @samp{$m1} to refer to
2932 the value @samp{10}.  Also, if you assign a formula to a names field, it
2933 will be stored as @samp{$name=...}.
2934 @item _
2935 Similar to @samp{^}, but defines names for the fields in the row
2936 @emph{below}.
2937 @item $
2938 Fields in this row can define @emph{parameters} for formulas.  For
2939 example, if a field in a @samp{$} row contains @samp{max=50}, then
2940 formulas in this table can refer to the value 50 using @samp{$max}.
2941 Parameters work exactly like constants, only that they can be defined on
2942 a per-table basis.
2943 @item #
2944 Fields in this row are automatically recalculated when pressing
2945 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
2946 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
2947 lines will be left alone by this command.
2948 @item *
2949 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2950 not for automatic recalculation.  Use this when automatic
2951 recalculation slows down editing too much.
2952 @item
2953 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2954 All lines that should be recalculated should be marked with @samp{#}
2955 or @samp{*}.
2956 @item /
2957 Do not export this line.  Useful for lines that contain the narrowing
2958 @samp{<N>} markers or column group markers.
2959 @end table
2961 Finally, just to whet your appetite for what can be done with the
2962 fantastic @file{calc.el} package, here is a table that computes the Taylor
2963 series of degree @code{n} at location @code{x} for a couple of
2964 functions.
2966 @example
2967 @group
2968 |---+-------------+---+-----+--------------------------------------|
2969 |   | Func        | n | x   | Result                               |
2970 |---+-------------+---+-----+--------------------------------------|
2971 | # | exp(x)      | 1 | x   | 1 + x                                |
2972 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
2973 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
2974 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2975 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
2976 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
2977 |---+-------------+---+-----+--------------------------------------|
2978 #+TBLFM: $5=taylor($2,$4,$3);n3
2979 @end group
2980 @end example
2982 @node Org-Plot,  , The spreadsheet, Tables
2983 @section Org-Plot
2984 @cindex graph, in tables
2985 @cindex plot tables using Gnuplot
2986 @cindex #+PLOT
2988 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2989 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2990 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}.  To see
2991 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2992 on your system, then call @code{org-plot/gnuplot} on the following table.
2994 @example
2995 @group
2996 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2997 | Sede      | Max cites | H-index |
2998 |-----------+-----------+---------|
2999 | Chile     |    257.72 |   21.39 |
3000 | Leeds     |    165.77 |   19.68 |
3001 | Sao Paolo |     71.00 |   11.50 |
3002 | Stockholm |    134.19 |   14.33 |
3003 | Morelia   |    257.56 |   17.67 |
3004 @end group
3005 @end example
3007 Notice that Org Plot is smart enough to apply the table's headers as labels.
3008 Further control over the labels, type, content, and appearance of plots can
3009 be exercised through the @code{#+PLOT:} lines preceding a table.  See below
3010 for a complete list of Org-plot options.  For more information and examples
3011 see the Org-plot tutorial at
3012 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3014 @subsubheading Plot Options
3016 @table @code
3017 @item set
3018 Specify any @command{gnuplot} option to be set when graphing.
3020 @item title
3021 Specify the title of the plot.
3023 @item ind
3024 Specify which column of the table to use as the @code{x} axis.
3026 @item deps
3027 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3028 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3029 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3030 column).
3032 @item type
3033 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3035 @item with
3036 Specify a @code{with} option to be inserted for every col being plotted
3037 (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3038 Defaults to @code{lines}.
3040 @item file
3041 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3043 @item labels
3044 List of labels to be used for the @code{deps} (defaults to the column headers
3045 if they exist).
3047 @item line
3048 Specify an entire line to be inserted in the Gnuplot script.
3050 @item map
3051 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3052 flat mapping rather than a @code{3d} slope.
3054 @item timefmt
3055 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3056 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3058 @item script
3059 If you want total control, you can specify a script file (place the file name
3060 between double-quotes) which will be used to plot.  Before plotting, every
3061 instance of @code{$datafile} in the specified script will be replaced with
3062 the path to the generated data file.  Note: even if you set this option, you
3063 may still want to specify the plot type, as that can impact the content of
3064 the data file.
3065 @end table
3067 @node Hyperlinks, TODO Items, Tables, Top
3068 @chapter Hyperlinks
3069 @cindex hyperlinks
3071 Like HTML, Org provides links inside a file, external links to
3072 other files, Usenet articles, emails, and much more.
3074 @menu
3075 * Link format::                 How links in Org are formatted
3076 * Internal links::              Links to other places in the current file
3077 * External links::              URL-like links to the world
3078 * Handling links::              Creating, inserting and following
3079 * Using links outside Org::     Linking from my C source code?
3080 * Link abbreviations::          Shortcuts for writing complex links
3081 * Search options::              Linking to a specific location
3082 * Custom searches::             When the default search is not enough
3083 @end menu
3085 @node Link format, Internal links, Hyperlinks, Hyperlinks
3086 @section Link format
3087 @cindex link format
3088 @cindex format, of links
3090 Org will recognize plain URL-like links and activate them as
3091 clickable links.  The general link format, however, looks like this:
3093 @example
3094 [[link][description]]       @r{or alternatively}           [[link]]
3095 @end example
3097 @noindent
3098 Once a link in the buffer is complete (all brackets present), Org
3099 will change the display so that @samp{description} is displayed instead
3100 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3101 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
3102 which by default is an underlined face.  You can directly edit the
3103 visible part of a link.  Note that this can be either the @samp{link}
3104 part (if there is no description) or the @samp{description} part.  To
3105 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3106 cursor on the link.
3108 If you place the cursor at the beginning or just behind the end of the
3109 displayed text and press @key{BACKSPACE}, you will remove the
3110 (invisible) bracket at that location.  This makes the link incomplete
3111 and the internals are again displayed as plain text.  Inserting the
3112 missing bracket hides the link internals again.  To show the
3113 internal structure of all links, use the menu entry
3114 @code{Org->Hyperlinks->Literal links}.
3116 @node Internal links, External links, Link format, Hyperlinks
3117 @section Internal links
3118 @cindex internal links
3119 @cindex links, internal
3120 @cindex targets, for links
3122 @cindex property, CUSTOM_ID
3123 If the link does not look like a URL, it is considered to be internal in the
3124 current file.  The most important case is a link like
3125 @samp{[[#my-custom-id]]} which will link to the entry with the
3126 @code{CUSTOM_ID} property @samp{my-custom-id}.  Such custom IDs are very good
3127 for HTML export (@pxref{HTML export}) where they produce pretty section
3128 links.  You are responsible yourself to make sure these custom IDs are unique
3129 in a file.
3131 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3132 lead to a text search in the current file.
3134 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3135 or with a mouse click (@pxref{Handling links}).  Links to custom IDs will
3136 point to the corresponding headline.  The preferred match for a text link is
3137 a @i{dedicated target}: the same string in double angular brackets.  Targets
3138 may be located anywhere; sometimes it is convenient to put them into a
3139 comment line.  For example
3141 @example
3142 # <<My Target>>
3143 @end example
3145 @noindent In HTML export (@pxref{HTML export}), such targets will become
3146 named anchors for direct access through @samp{http} links@footnote{Note that
3147 text before the first headline is usually not exported, so the first such
3148 target should be after the first headline, or in the line directly before the
3149 first headline.}.
3151 If no dedicated target exists, Org will search for a headline that is exactly
3152 the link text but may also include a TODO keyword and tags@footnote{To insert
3153 a link targeting a headline, in-buffer completion can be used.  Just type a
3154 star followed by a few optional letters into the buffer and press
3155 @kbd{M-@key{TAB}}.  All headlines in the current buffer will be offered as
3156 completions.}.  In non-Org files, the search will look for the words in the
3157 link text.  In the above example the search would be for @samp{my target}.
3159 Following a link pushes a mark onto Org's own mark ring.  You can
3160 return to the previous position with @kbd{C-c &}.  Using this command
3161 several times in direct succession goes back to positions recorded
3162 earlier.
3164 @menu
3165 * Radio targets::               Make targets trigger links in plain text
3166 @end menu
3168 @node Radio targets,  , Internal links, Internal links
3169 @subsection Radio targets
3170 @cindex radio targets
3171 @cindex targets, radio
3172 @cindex links, radio targets
3174 Org can automatically turn any occurrences of certain target names
3175 in normal text into a link.  So without explicitly creating a link, the
3176 text connects to the target radioing its position.  Radio targets are
3177 enclosed by triple angular brackets.  For example, a target @samp{<<<My
3178 Target>>>} causes each occurrence of @samp{my target} in normal text to
3179 become activated as a link.  The Org file is scanned automatically
3180 for radio targets only when the file is first loaded into Emacs.  To
3181 update the target list during editing, press @kbd{C-c C-c} with the
3182 cursor on or at a target.
3184 @node External links, Handling links, Internal links, Hyperlinks
3185 @section External links
3186 @cindex links, external
3187 @cindex external links
3188 @cindex links, external
3189 @cindex Gnus links
3190 @cindex BBDB links
3191 @cindex IRC links
3192 @cindex URL links
3193 @cindex file links
3194 @cindex VM links
3195 @cindex RMAIL links
3196 @cindex WANDERLUST links
3197 @cindex MH-E links
3198 @cindex USENET links
3199 @cindex SHELL links
3200 @cindex Info links
3201 @cindex Elisp links
3203 Org supports links to files, websites, Usenet and email messages,
3204 BBDB database entries and links to both IRC conversations and their
3205 logs.  External links are URL-like locators.  They start with a short
3206 identifying string followed by a colon.  There can be no space after
3207 the colon.  The following list shows examples for each link type.
3209 @example
3210 http://www.astro.uva.nl/~dominik          @r{on the web}
3211 doi:10.1000/182                           @r{DOI for an electronic resource}
3212 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
3213 /home/dominik/images/jupiter.jpg          @r{same as above}
3214 file:papers/last.pdf                      @r{file, relative path}
3215 ./papers/last.pdf                         @r{same as above}
3216 file:/myself@@some.where:papers/last.pdf   @r{file, path on remote machine}
3217 /myself@@some.where:papers/last.pdf        @r{same as above}
3218 file:sometextfile::NNN                    @r{file, jump to line number}
3219 file:projects.org                         @r{another Org file}
3220 file:projects.org::some words             @r{text search in Org file}@footnote{
3221 The actual behavior of the search will depend on the value of
3222 the variable @code{org-link-search-must-match-exact-headline}.  If its value
3223 is nil, then a fuzzy text search will be done.  If it is t, then only the
3224 exact headline will be matched.  If the value is @code{'query-to-create},
3225 then an exact headline will be searched; if it is not found, then the user
3226 will be queried to create it.}
3227 file:projects.org::*task title            @r{heading search in Org file}
3228 file+sys:/path/to/file                    @r{open via OS, like double-click}
3229 file+emacs:/path/to/file                  @r{force opening by Emacs}
3230 docview:papers/last.pdf::NNN              @r{open in doc-view mode at page}
3231 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
3232 news:comp.emacs                           @r{Usenet link}
3233 mailto:adent@@galaxy.net                   @r{Mail link}
3234 vm:folder                                 @r{VM folder link}
3235 vm:folder#id                              @r{VM message link}
3236 vm://myself@@some.where.org/folder#id      @r{VM on remote machine}
3237 wl:folder                                 @r{WANDERLUST folder link}
3238 wl:folder#id                              @r{WANDERLUST message link}
3239 mhe:folder                                @r{MH-E folder link}
3240 mhe:folder#id                             @r{MH-E message link}
3241 rmail:folder                              @r{RMAIL folder link}
3242 rmail:folder#id                           @r{RMAIL message link}
3243 gnus:group                                @r{Gnus group link}
3244 gnus:group#id                             @r{Gnus article link}
3245 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
3246 irc:/irc.com/#emacs/bob                   @r{IRC link}
3247 info:org#External links                   @r{Info node link}
3248 shell:ls *.org                            @r{A shell command}
3249 elisp:org-agenda                          @r{Interactive Elisp command}
3250 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3251 @end example
3253 For customizing Org to add new link types @ref{Adding hyperlink types}.
3255 A link should be enclosed in double brackets and may contain a
3256 descriptive text to be displayed instead of the URL (@pxref{Link
3257 format}), for example:
3259 @example
3260 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3261 @end example
3263 @noindent
3264 If the description is a file name or URL that points to an image, HTML
3265 export (@pxref{HTML export}) will inline the image as a clickable
3266 button.  If there is no description at all and the link points to an
3267 image,
3268 that image will be inlined into the exported HTML file.
3270 @cindex square brackets, around links
3271 @cindex plain text external links
3272 Org also finds external links in the normal text and activates them
3273 as links.  If spaces must be part of the link (for example in
3274 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3275 about the end of the link, enclose them in square brackets.
3277 @node Handling links, Using links outside Org, External links, Hyperlinks
3278 @section Handling links
3279 @cindex links, handling
3281 Org provides methods to create a link in the correct syntax, to
3282 insert it into an Org file, and to follow the link.
3284 @table @kbd
3285 @orgcmd{C-c l,org-store-link}
3286 @cindex storing links
3287 Store a link to the current location.  This is a @emph{global} command (you
3288 must create the key binding yourself) which can be used in any buffer to
3289 create a link.  The link will be stored for later insertion into an Org
3290 buffer (see below).  What kind of link will be created depends on the current
3291 buffer:
3293 @b{Org mode buffers}@*
3294 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3295 to the target.  Otherwise it points to the current headline, which will also
3296 be the description@footnote{If the headline contains a timestamp, it will be
3297 removed from the link and result in a wrong link -- you should avoid putting
3298 timestamp in the headline.}.
3300 @vindex org-link-to-org-use-id
3301 @cindex property, CUSTOM_ID
3302 @cindex property, ID
3303 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3304 will be stored.  In addition or alternatively (depending on the value of
3305 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3306 created and/or used to construct a link.  So using this command in Org
3307 buffers will potentially create two links: a human-readable from the custom
3308 ID, and one that is globally unique and works even if the entry is moved from
3309 file to file.  Later, when inserting the link, you need to decide which one
3310 to use.
3312 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3313 Pretty much all Emacs mail clients are supported.  The link will point to the
3314 current article, or, in some GNUS buffers, to the group.  The description is
3315 constructed from the author and the subject.
3317 @b{Web browsers: W3 and W3M}@*
3318 Here the link will be the current URL, with the page title as description.
3320 @b{Contacts: BBDB}@*
3321 Links created in a BBDB buffer will point to the current entry.
3323 @b{Chat: IRC}@*
3324 @vindex org-irc-link-to-logs
3325 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3326 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3327 the current conversation is created.  Otherwise an @samp{irc:/} style link to
3328 the user/channel/server under the point will be stored.
3330 @b{Other files}@*
3331 For any other files, the link will point to the file, with a search string
3332 (@pxref{Search options}) pointing to the contents of the current line.  If
3333 there is an active region, the selected words will form the basis of the
3334 search string.  If the automatically created link is not working correctly or
3335 accurately enough, you can write custom functions to select the search string
3336 and to do the search for particular file types---see @ref{Custom searches}.
3337 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3339 @b{Agenda view}@*
3340 When the cursor is in an agenda view, the created link points to the
3341 entry referenced by the current line.
3344 @orgcmd{C-c C-l,org-insert-link}
3345 @cindex link completion
3346 @cindex completion, of links
3347 @cindex inserting links
3348 @vindex org-keep-stored-link-after-insertion
3349 Insert a link@footnote{ Note that you don't have to use this command to
3350 insert a link.  Links in Org are plain text, and you can type or paste them
3351 straight into the buffer.  By using this command, the links are automatically
3352 enclosed in double brackets, and you will be asked for the optional
3353 descriptive text.}.  This prompts for a link to be inserted into the buffer.
3354 You can just type a link, using text for an internal link, or one of the link
3355 type prefixes mentioned in the examples above.  The link will be inserted
3356 into the buffer@footnote{After insertion of a stored link, the link will be
3357 removed from the list of stored links.  To keep it in the list later use, use
3358 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3359 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3360 If some text was selected when this command is called, the selected text
3361 becomes the default description.
3363 @b{Inserting stored links}@*
3364 All links stored during the
3365 current session are part of the history for this prompt, so you can access
3366 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3368 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3369 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3370 defined through link abbreviations (@pxref{Link abbreviations}).  If you
3371 press @key{RET} after inserting only the @var{prefix}, Org will offer
3372 specific completion support for some link types@footnote{This works by
3373 calling a special function @code{org-PREFIX-complete-link}.}  For
3374 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3375 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3376 @key{RET}} you can complete contact names.
3377 @orgkey C-u C-c C-l
3378 @cindex file name completion
3379 @cindex completion, of file names
3380 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3381 a file will be inserted and you may use file name completion to select
3382 the name of the file.  The path to the file is inserted relative to the
3383 directory of the current Org file, if the linked file is in the current
3384 directory or in a sub-directory of it, or if the path is written relative
3385 to the current directory using @samp{../}.  Otherwise an absolute path
3386 is used, if possible with @samp{~/} for your home directory.  You can
3387 force an absolute path with two @kbd{C-u} prefixes.
3389 @item C-c C-l @ @r{(with cursor on existing link)}
3390 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3391 link and description parts of the link.
3393 @cindex following links
3394 @orgcmd{C-c C-o,org-open-at-point}
3395 @vindex org-file-apps
3396 @vindex org-link-frame-setup
3397 Open link at point.  This will launch a web browser for URLs (using
3398 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3399 the corresponding links, and execute the command in a shell link.  When the
3400 cursor is on an internal link, this command runs the corresponding search.
3401 When the cursor is on a TAG list in a headline, it creates the corresponding
3402 TAGS view.  If the cursor is on a timestamp, it compiles the agenda for that
3403 date.  Furthermore, it will visit text and remote files in @samp{file:} links
3404 with Emacs and select a suitable application for local non-text files.
3405 Classification of files is based on file extension only.  See option
3406 @code{org-file-apps}.  If you want to override the default application and
3407 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
3408 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3409 If the cursor is on a headline, but not on a link, offer all links in the
3410 headline and entry text.  If you want to setup the frame configuration for
3411 following links, customize @code{org-link-frame-setup}.
3413 @orgkey @key{RET}
3414 @vindex org-return-follows-link
3415 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3416 the link at point.
3418 @kindex mouse-2
3419 @kindex mouse-1
3420 @item mouse-2
3421 @itemx mouse-1
3422 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3423 would.  Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3425 @kindex mouse-3
3426 @item mouse-3
3427 @vindex org-display-internal-link-with-indirect-buffer
3428 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3429 internal links to be displayed in another window@footnote{See the
3430 variable @code{org-display-internal-link-with-indirect-buffer}}.
3432 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3433 @cindex inlining images
3434 @cindex images, inlining
3435 @vindex org-startup-with-inline-images
3436 @cindex @code{inlineimages}, STARTUP keyword
3437 @cindex @code{noinlineimages}, STARTUP keyword
3438 Toggle the inline display of linked images.  Normally this will only inline
3439 images that have no description part in the link, i.e.@: images that will also
3440 be inlined during export.  When called with a prefix argument, also display
3441 images that do have a link description.  You can ask for inline images to be
3442 displayed at startup by configuring the variable
3443 @code{org-startup-with-inline-images}@footnote{with corresponding
3444 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3445 @orgcmd{C-c %,org-mark-ring-push}
3446 @cindex mark ring
3447 Push the current position onto the mark ring, to be able to return
3448 easily.  Commands following an internal link do this automatically.
3450 @orgcmd{C-c &,org-mark-ring-goto}
3451 @cindex links, returning to
3452 Jump back to a recorded position.  A position is recorded by the
3453 commands following internal links, and by @kbd{C-c %}.  Using this
3454 command several times in direct succession moves through a ring of
3455 previously recorded positions.
3457 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3458 @cindex links, finding next/previous
3459 Move forward/backward to the next link in the buffer.  At the limit of
3460 the buffer, the search fails once, and then wraps around.  The key
3461 bindings for this are really too long; you might want to bind this also
3462 to @kbd{C-n} and @kbd{C-p}
3463 @lisp
3464 (add-hook 'org-load-hook
3465   (lambda ()
3466     (define-key org-mode-map "\C-n" 'org-next-link)
3467     (define-key org-mode-map "\C-p" 'org-previous-link)))
3468 @end lisp
3469 @end table
3471 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3472 @section Using links outside Org
3474 You can insert and follow links that have Org syntax not only in
3475 Org, but in any Emacs buffer.  For this, you should create two
3476 global commands, like this (please select suitable global keys
3477 yourself):
3479 @lisp
3480 (global-set-key "\C-c L" 'org-insert-link-global)
3481 (global-set-key "\C-c o" 'org-open-at-point-global)
3482 @end lisp
3484 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3485 @section Link abbreviations
3486 @cindex link abbreviations
3487 @cindex abbreviation, links
3489 Long URLs can be cumbersome to type, and often many similar links are
3490 needed in a document.  For this you can use link abbreviations.  An
3491 abbreviated link looks like this
3493 @example
3494 [[linkword:tag][description]]
3495 @end example
3497 @noindent
3498 @vindex org-link-abbrev-alist
3499 where the tag is optional.
3500 The @i{linkword} must be a word, starting with a letter, followed by
3501 letters, numbers, @samp{-}, and @samp{_}.  Abbreviations are resolved
3502 according to the information in the variable @code{org-link-abbrev-alist}
3503 that relates the linkwords to replacement text.  Here is an example:
3505 @smalllisp
3506 @group
3507 (setq org-link-abbrev-alist
3508   '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3509     ("google"   . "http://www.google.com/search?q=")
3510     ("gmap"     . "http://maps.google.com/maps?q=%s")
3511     ("omap"     . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3512     ("ads"      . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3513 @end group
3514 @end smalllisp
3516 If the replacement text contains the string @samp{%s}, it will be
3517 replaced with the tag.  Otherwise the tag will be appended to the string
3518 in order to create the link.  You may also specify a function that will
3519 be called with the tag as the only argument to create the link.
3521 With the above setting, you could link to a specific bug with
3522 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3523 @code{[[google:OrgMode]]}, show the map location of the Free Software
3524 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3525 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3526 what the Org author is doing besides Emacs hacking with
3527 @code{[[ads:Dominik,C]]}.
3529 If you need special abbreviations just for a single Org buffer, you
3530 can define them in the file with
3532 @cindex #+LINK
3533 @example
3534 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
3535 #+LINK: google    http://www.google.com/search?q=%s
3536 @end example
3538 @noindent
3539 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3540 complete link abbreviations.  You may also define a function
3541 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
3542 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
3543 not accept any arguments, and return the full link with prefix.
3545 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3546 @section Search options in file links
3547 @cindex search option in file links
3548 @cindex file links, searching
3550 File links can contain additional information to make Emacs jump to a
3551 particular location in the file when following a link.  This can be a
3552 line number or a search option after a double@footnote{For backward
3553 compatibility, line numbers can also follow a single colon.} colon.  For
3554 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3555 links}) to a file, it encodes the words in the current line as a search
3556 string that can be used to find this line back later when following the
3557 link with @kbd{C-c C-o}.
3559 Here is the syntax of the different ways to attach a search to a file
3560 link, together with an explanation:
3562 @example
3563 [[file:~/code/main.c::255]]
3564 [[file:~/xx.org::My Target]]
3565 [[file:~/xx.org::*My Target]]
3566 [[file:~/xx.org::#my-custom-id]]
3567 [[file:~/xx.org::/regexp/]]
3568 @end example
3570 @table @code
3571 @item 255
3572 Jump to line 255.
3573 @item My Target
3574 Search for a link target @samp{<<My Target>>}, or do a text search for
3575 @samp{my target}, similar to the search in internal links, see
3576 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
3577 link will become an HTML reference to the corresponding named anchor in
3578 the linked file.
3579 @item *My Target
3580 In an Org file, restrict search to headlines.
3581 @item #my-custom-id
3582 Link to a heading with a @code{CUSTOM_ID} property
3583 @item /regexp/
3584 Do a regular expression search for @code{regexp}.  This uses the Emacs
3585 command @code{occur} to list all matches in a separate window.  If the
3586 target file is in Org mode, @code{org-occur} is used to create a
3587 sparse tree with the matches.
3588 @c If the target file is a directory,
3589 @c @code{grep} will be used to search all files in the directory.
3590 @end table
3592 As a degenerate case, a file link with an empty file name can be used
3593 to search the current file.  For example, @code{[[file:::find me]]} does
3594 a search for @samp{find me} in the current file, just as
3595 @samp{[[find me]]} would.
3597 @node Custom searches,  , Search options, Hyperlinks
3598 @section Custom Searches
3599 @cindex custom search strings
3600 @cindex search strings, custom
3602 The default mechanism for creating search strings and for doing the
3603 actual search related to a file link may not work correctly in all
3604 cases.  For example, Bib@TeX{} database files have many entries like
3605 @samp{year="1993"} which would not result in good search strings,
3606 because the only unique identification for a Bib@TeX{} entry is the
3607 citation key.
3609 @vindex org-create-file-search-functions
3610 @vindex org-execute-file-search-functions
3611 If you come across such a problem, you can write custom functions to set
3612 the right search string for a particular file type, and to do the search
3613 for the string in the file.  Using @code{add-hook}, these functions need
3614 to be added to the hook variables
3615 @code{org-create-file-search-functions} and
3616 @code{org-execute-file-search-functions}.  See the docstring for these
3617 variables for more information.  Org actually uses this mechanism
3618 for Bib@TeX{} database files, and you can use the corresponding code as
3619 an implementation example.  See the file @file{org-bibtex.el}.
3621 @node TODO Items, Tags, Hyperlinks, Top
3622 @chapter TODO items
3623 @cindex TODO items
3625 Org mode does not maintain TODO lists as separate documents@footnote{Of
3626 course, you can make a document that contains only long lists of TODO items,
3627 but this is not required.}.  Instead, TODO items are an integral part of the
3628 notes file, because TODO items usually come up while taking notes!  With Org
3629 mode, simply mark any entry in a tree as being a TODO item.  In this way,
3630 information is not duplicated, and the entire context from which the TODO
3631 item emerged is always present.
3633 Of course, this technique for managing TODO items scatters them
3634 throughout your notes file.  Org mode compensates for this by providing
3635 methods to give you an overview of all the things that you have to do.
3637 @menu
3638 * TODO basics::                 Marking and displaying TODO entries
3639 * TODO extensions::             Workflow and assignments
3640 * Progress logging::            Dates and notes for progress
3641 * Priorities::                  Some things are more important than others
3642 * Breaking down tasks::         Splitting a task into manageable pieces
3643 * Checkboxes::                  Tick-off lists
3644 @end menu
3646 @node TODO basics, TODO extensions, TODO Items, TODO Items
3647 @section Basic TODO functionality
3649 Any headline becomes a TODO item when it starts with the word
3650 @samp{TODO}, for example:
3652 @example
3653 *** TODO Write letter to Sam Fortune
3654 @end example
3656 @noindent
3657 The most important commands to work with TODO entries are:
3659 @table @kbd
3660 @orgcmd{C-c C-t,org-todo}
3661 @cindex cycling, of TODO states
3662 Rotate the TODO state of the current item among
3664 @example
3665 ,-> (unmarked) -> TODO -> DONE --.
3666 '--------------------------------'
3667 @end example
3669 The same rotation can also be done ``remotely'' from the timeline and
3670 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3672 @orgkey{C-u C-c C-t}
3673 Select a specific keyword using completion or (if it has been set up)
3674 the fast selection interface.  For the latter, you need to assign keys
3675 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3676 more information.
3678 @kindex S-@key{right}
3679 @kindex S-@key{left}
3680 @item S-@key{right} @ @r{/} @ S-@key{left}
3681 @vindex org-treat-S-cursor-todo-selection-as-state-change
3682 Select the following/preceding TODO state, similar to cycling.  Useful
3683 mostly if more than two TODO states are possible (@pxref{TODO
3684 extensions}).  See also @ref{Conflicts}, for a discussion of the interaction
3685 with @code{shift-selection-mode}.  See also the variable
3686 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3687 @orgcmd{C-c / t,org-show-todo-key}
3688 @cindex sparse tree, for TODO
3689 @vindex org-todo-keywords
3690 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
3691 entire buffer, but shows all TODO items (with not-DONE state) and the
3692 headings hierarchy above them.  With a prefix argument (or by using @kbd{C-c
3693 / T}), search for a specific TODO.  You will be prompted for the keyword, and
3694 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3695 entries that match any one of these keywords.  With a numeric prefix argument
3696 N, show the tree for the Nth keyword in the variable
3697 @code{org-todo-keywords}.  With two prefix arguments, find all TODO states,
3698 both un-done and done.
3699 @orgcmd{C-c a t,org-todo-list}
3700 Show the global TODO list.  Collects the TODO items (with not-DONE states)
3701 from all agenda files (@pxref{Agenda Views}) into a single buffer.  The new
3702 buffer will be in @code{agenda-mode}, which provides commands to examine and
3703 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3704 @xref{Global TODO list}, for more information.
3705 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3706 Insert a new TODO entry below the current one.
3707 @end table
3709 @noindent
3710 @vindex org-todo-state-tags-triggers
3711 Changing a TODO state can also trigger tag changes.  See the docstring of the
3712 option @code{org-todo-state-tags-triggers} for details.
3714 @node TODO extensions, Progress logging, TODO basics, TODO Items
3715 @section Extended use of TODO keywords
3716 @cindex extended TODO keywords
3718 @vindex org-todo-keywords
3719 By default, marked TODO entries have one of only two states: TODO and
3720 DONE.  Org mode allows you to classify TODO items in more complex ways
3721 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
3722 special setup, the TODO keyword system can work differently in different
3723 files.
3725 Note that @i{tags} are another way to classify headlines in general and
3726 TODO items in particular (@pxref{Tags}).
3728 @menu
3729 * Workflow states::             From TODO to DONE in steps
3730 * TODO types::                  I do this, Fred does the rest
3731 * Multiple sets in one file::   Mixing it all, and still finding your way
3732 * Fast access to TODO states::  Single letter selection of a state
3733 * Per-file keywords::           Different files, different requirements
3734 * Faces for TODO keywords::     Highlighting states
3735 * TODO dependencies::           When one task needs to wait for others
3736 @end menu
3738 @node Workflow states, TODO types, TODO extensions, TODO extensions
3739 @subsection TODO keywords as workflow states
3740 @cindex TODO workflow
3741 @cindex workflow states as TODO keywords
3743 You can use TODO keywords to indicate different @emph{sequential} states
3744 in the process of working on an item, for example@footnote{Changing
3745 this variable only becomes effective after restarting Org mode in a
3746 buffer.}:
3748 @lisp
3749 (setq org-todo-keywords
3750   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3751 @end lisp
3753 The vertical bar separates the TODO keywords (states that @emph{need
3754 action}) from the DONE states (which need @emph{no further action}).  If
3755 you don't provide the separator bar, the last state is used as the DONE
3756 state.
3757 @cindex completion, of TODO keywords
3758 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3759 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.  You may
3760 also use a numeric prefix argument to quickly select a specific state.  For
3761 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3762 Or you can use @kbd{S-@key{left}} to go backward through the sequence.  If you
3763 define many keywords, you can use in-buffer completion
3764 (@pxref{Completion}) or even a special one-key selection scheme
3765 (@pxref{Fast access to TODO states}) to insert these words into the
3766 buffer.  Changing a TODO state can be logged with a timestamp, see
3767 @ref{Tracking TODO state changes}, for more information.
3769 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3770 @subsection TODO keywords as types
3771 @cindex TODO types
3772 @cindex names as TODO keywords
3773 @cindex types as TODO keywords
3775 The second possibility is to use TODO keywords to indicate different
3776 @emph{types} of action items.  For example, you might want to indicate
3777 that items are for ``work'' or ``home''.  Or, when you work with several
3778 people on a single project, you might want to assign action items
3779 directly to persons, by using their names as TODO keywords.  This would
3780 be set up like this:
3782 @lisp
3783 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3784 @end lisp
3786 In this case, different keywords do not indicate a sequence, but rather
3787 different types.  So the normal work flow would be to assign a task to a
3788 person, and later to mark it DONE.  Org mode supports this style by adapting
3789 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3790 @kbd{t} command in the timeline and agenda buffers.}.  When used several
3791 times in succession, it will still cycle through all names, in order to first
3792 select the right type for a task.  But when you return to the item after some
3793 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3794 to DONE.  Use prefix arguments or completion to quickly select a specific
3795 name.  You can also review the items of a specific TODO type in a sparse tree
3796 by using a numeric prefix to @kbd{C-c / t}.  For example, to see all things
3797 Lucy has to do, you would use @kbd{C-3 C-c / t}.  To collect Lucy's items
3798 from all agenda files into a single buffer, you would use the numeric prefix
3799 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3801 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3802 @subsection Multiple keyword sets in one file
3803 @cindex TODO keyword sets
3805 Sometimes you may want to use different sets of TODO keywords in
3806 parallel.  For example, you may want to have the basic
3807 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3808 separate state indicating that an item has been canceled (so it is not
3809 DONE, but also does not require action).  Your setup would then look
3810 like this:
3812 @lisp
3813 (setq org-todo-keywords
3814       '((sequence "TODO" "|" "DONE")
3815         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3816         (sequence "|" "CANCELED")))
3817 @end lisp
3819 The keywords should all be different, this helps Org mode to keep track
3820 of which subsequence should be used for a given entry.  In this setup,
3821 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3822 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3823 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
3824 select the correct sequence.  Besides the obvious ways like typing a
3825 keyword or using completion, you may also apply the following commands:
3827 @table @kbd
3828 @kindex C-S-@key{right}
3829 @kindex C-S-@key{left}
3830 @kindex C-u C-u C-c C-t
3831 @item C-u C-u C-c C-t
3832 @itemx C-S-@key{right}
3833 @itemx C-S-@key{left}
3834 These keys jump from one TODO subset to the next.  In the above example,
3835 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3836 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3837 @code{CANCELED}.  Note that the @kbd{C-S-} key binding conflict with
3838 @code{shift-selection-mode} (@pxref{Conflicts}).
3839 @kindex S-@key{right}
3840 @kindex S-@key{left}
3841 @item S-@key{right}
3842 @itemx S-@key{left}
3843 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3844 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3845 from @code{DONE} to @code{REPORT} in the example above.  See also
3846 @ref{Conflicts}, for a discussion of the interaction with
3847 @code{shift-selection-mode}.
3848 @end table
3850 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3851 @subsection Fast access to TODO states
3853 If you would like to quickly change an entry to an arbitrary TODO state
3854 instead of cycling through the states, you can set up keys for
3855 single-letter access to the states.  This is done by adding the section
3856 key after each keyword, in parentheses.  For example:
3858 @lisp
3859 (setq org-todo-keywords
3860       '((sequence "TODO(t)" "|" "DONE(d)")
3861         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3862         (sequence "|" "CANCELED(c)")))
3863 @end lisp
3865 @vindex org-fast-tag-selection-include-todo
3866 If you then press @kbd{C-c C-t} followed by the selection key, the entry
3867 will be switched to this state.  @kbd{SPC} can be used to remove any TODO
3868 keyword from an entry.@footnote{Check also the variable
3869 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3870 state through the tags interface (@pxref{Setting tags}), in case you like to
3871 mingle the two concepts.  Note that this means you need to come up with
3872 unique keys across both sets of keywords.}
3874 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3875 @subsection Setting up keywords for individual files
3876 @cindex keyword options
3877 @cindex per-file keywords
3878 @cindex #+TODO
3879 @cindex #+TYP_TODO
3880 @cindex #+SEQ_TODO
3882 It can be very useful to use different aspects of the TODO mechanism in
3883 different files.  For file-local settings, you need to add special lines
3884 to the file which set the keywords and interpretation for that file
3885 only.  For example, to set one of the two examples discussed above, you
3886 need one of the following lines, starting in column zero anywhere in the
3887 file:
3889 @example
3890 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3891 @end example
3892 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3893 interpretation, but it means the same as @code{#+TODO}), or
3894 @example
3895 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3896 @end example
3898 A setup for using several sets in parallel would be:
3900 @example
3901 #+TODO: TODO | DONE
3902 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3903 #+TODO: | CANCELED
3904 @end example
3906 @cindex completion, of option keywords
3907 @kindex M-@key{TAB}
3908 @noindent To make sure you are using the correct keyword, type
3909 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3911 @cindex DONE, final TODO keyword
3912 Remember that the keywords after the vertical bar (or the last keyword
3913 if no bar is there) must always mean that the item is DONE (although you
3914 may use a different word).  After changing one of these lines, use
3915 @kbd{C-c C-c} with the cursor still in the line to make the changes
3916 known to Org mode@footnote{Org mode parses these lines only when
3917 Org mode is activated after visiting a file.  @kbd{C-c C-c} with the
3918 cursor in a line starting with @samp{#+} is simply restarting Org mode
3919 for the current buffer.}.
3921 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3922 @subsection Faces for TODO keywords
3923 @cindex faces, for TODO keywords
3925 @vindex org-todo @r{(face)}
3926 @vindex org-done @r{(face)}
3927 @vindex org-todo-keyword-faces
3928 Org mode highlights TODO keywords with special faces: @code{org-todo}
3929 for keywords indicating that an item still has to be acted upon, and
3930 @code{org-done} for keywords indicating that an item is finished.  If
3931 you are using more than 2 different states, you might want to use
3932 special faces for some of them.  This can be done using the variable
3933 @code{org-todo-keyword-faces}.  For example:
3935 @lisp
3936 @group
3937 (setq org-todo-keyword-faces
3938       '(("TODO" . org-warning) ("STARTED" . "yellow")
3939         ("CANCELED" . (:foreground "blue" :weight bold))))
3940 @end group
3941 @end lisp
3943 While using a list with face properties as shown for CANCELED @emph{should}
3944 work, this does not aways seem to be the case.  If necessary, define a
3945 special face and use that.  A string is interpreted as a color.  The variable
3946 @code{org-faces-easy-properties} determines if that color is interpreted as a
3947 foreground or a background color.
3949 @node TODO dependencies,  , Faces for TODO keywords, TODO extensions
3950 @subsection TODO dependencies
3951 @cindex TODO dependencies
3952 @cindex dependencies, of TODO states
3954 @vindex org-enforce-todo-dependencies
3955 @cindex property, ORDERED
3956 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3957 dependencies.  Usually, a parent TODO task should not be marked DONE until
3958 all subtasks (defined as children tasks) are marked as DONE.  And sometimes
3959 there is a logical sequence to a number of (sub)tasks, so that one task
3960 cannot be acted upon before all siblings above it are done.  If you customize
3961 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3962 from changing state to DONE while they have children that are not DONE.
3963 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3964 will be blocked until all earlier siblings are marked DONE.  Here is an
3965 example:
3967 @example
3968 * TODO Blocked until (two) is done
3969 ** DONE one
3970 ** TODO two
3972 * Parent
3973   :PROPERTIES:
3974   :ORDERED: t
3975   :END:
3976 ** TODO a
3977 ** TODO b, needs to wait for (a)
3978 ** TODO c, needs to wait for (a) and (b)
3979 @end example
3981 @table @kbd
3982 @orgcmd{C-c C-x o,org-toggle-ordered-property}
3983 @vindex org-track-ordered-property-with-tag
3984 @cindex property, ORDERED
3985 Toggle the @code{ORDERED} property of the current entry.  A property is used
3986 for this behavior because this should be local to the current entry, not
3987 inherited like a tag.  However, if you would like to @i{track} the value of
3988 this property with a tag for better visibility, customize the variable
3989 @code{org-track-ordered-property-with-tag}.
3990 @orgkey{C-u C-u C-u C-c C-t}
3991 Change TODO state, circumventing any state blocking.
3992 @end table
3994 @vindex org-agenda-dim-blocked-tasks
3995 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3996 that cannot be closed because of such dependencies will be shown in a dimmed
3997 font or even made invisible in agenda views (@pxref{Agenda Views}).
3999 @cindex checkboxes and TODO dependencies
4000 @vindex org-enforce-todo-dependencies
4001 You can also block changes of TODO states by looking at checkboxes
4002 (@pxref{Checkboxes}).  If you set the variable
4003 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4004 checkboxes will be blocked from switching to DONE.
4006 If you need more complex dependency structures, for example dependencies
4007 between entries in different trees or files, check out the contributed
4008 module @file{org-depend.el}.
4010 @page
4011 @node Progress logging, Priorities, TODO extensions, TODO Items
4012 @section Progress logging
4013 @cindex progress logging
4014 @cindex logging, of progress
4016 Org mode can automatically record a timestamp and possibly a note when
4017 you mark a TODO item as DONE, or even each time you change the state of
4018 a TODO item.  This system is highly configurable, settings can be on a
4019 per-keyword basis and can be localized to a file or even a subtree.  For
4020 information on how to clock working time for a task, see @ref{Clocking
4021 work time}.
4023 @menu
4024 * Closing items::               When was this entry marked DONE?
4025 * Tracking TODO state changes::  When did the status change?
4026 * Tracking your habits::        How consistent have you been?
4027 @end menu
4029 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4030 @subsection Closing items
4032 The most basic logging is to keep track of @emph{when} a certain TODO
4033 item was finished.  This is achieved with@footnote{The corresponding
4034 in-buffer setting is: @code{#+STARTUP: logdone}}
4036 @lisp
4037 (setq org-log-done 'time)
4038 @end lisp
4040 @noindent
4041 Then each time you turn an entry from a TODO (not-done) state into any
4042 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
4043 just after the headline.  If you turn the entry back into a TODO item
4044 through further state cycling, that line will be removed again.  If you
4045 want to record a note along with the timestamp, use@footnote{The
4046 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4048 @lisp
4049 (setq org-log-done 'note)
4050 @end lisp
4052 @noindent
4053 You will then be prompted for a note, and that note will be stored below
4054 the entry with a @samp{Closing Note} heading.
4056 In the timeline (@pxref{Timeline}) and in the agenda
4057 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4058 display the TODO items with a @samp{CLOSED} timestamp on each day,
4059 giving you an overview of what has been done.
4061 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4062 @subsection Tracking TODO state changes
4063 @cindex drawer, for state change recording
4065 @vindex org-log-states-order-reversed
4066 @vindex org-log-into-drawer
4067 @cindex property, LOG_INTO_DRAWER
4068 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4069 might want to keep track of when a state change occurred and maybe take a
4070 note about this change.  You can either record just a timestamp, or a
4071 time-stamped note for a change.  These records will be inserted after the
4072 headline as an itemized list, newest first@footnote{See the variable
4073 @code{org-log-states-order-reversed}}.  When taking a lot of notes, you might
4074 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4075 Customize the variable @code{org-log-into-drawer} to get this
4076 behavior---the recommended drawer for this is called @code{LOGBOOK}.  You can
4077 also overrule the setting of this variable for a subtree by setting a
4078 @code{LOG_INTO_DRAWER} property.
4080 Since it is normally too much to record a note for every state, Org mode
4081 expects configuration on a per-keyword basis for this.  This is achieved by
4082 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4083 with timestamp) in parentheses after each keyword.  For example, with the
4084 setting
4086 @lisp
4087 (setq org-todo-keywords
4088   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4089 @end lisp
4091 To record a timestamp without a note for TODO keywords configured with
4092 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4094 @noindent
4095 @vindex org-log-done
4096 you not only define global TODO keywords and fast access keys, but also
4097 request that a time is recorded when the entry is set to
4098 DONE@footnote{It is possible that Org mode will record two timestamps
4099 when you are using both @code{org-log-done} and state change logging.
4100 However, it will never prompt for two notes---if you have configured
4101 both, the state change recording note will take precedence and cancel
4102 the @samp{Closing Note}.}, and that a note is recorded when switching to
4103 WAIT or CANCELED.  The setting for WAIT is even more special: the
4104 @samp{!} after the slash means that in addition to the note taken when
4105 entering the state, a timestamp should be recorded when @i{leaving} the
4106 WAIT state, if and only if the @i{target} state does not configure
4107 logging for entering it.  So it has no effect when switching from WAIT
4108 to DONE, because DONE is configured to record a timestamp only.  But
4109 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4110 setting now triggers a timestamp even though TODO has no logging
4111 configured.
4113 You can use the exact same syntax for setting logging preferences local
4114 to a buffer:
4115 @example
4116 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4117 @end example
4119 @cindex property, LOGGING
4120 In order to define logging settings that are local to a subtree or a
4121 single item, define a LOGGING property in this entry.  Any non-empty
4122 LOGGING property resets all logging settings to nil.  You may then turn
4123 on logging for this specific tree using STARTUP keywords like
4124 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4125 settings like @code{TODO(!)}.  For example
4127 @example
4128 * TODO Log each state with only a time
4129   :PROPERTIES:
4130   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4131   :END:
4132 * TODO Only log when switching to WAIT, and when repeating
4133   :PROPERTIES:
4134   :LOGGING: WAIT(@@) logrepeat
4135   :END:
4136 * TODO No logging at all
4137   :PROPERTIES:
4138   :LOGGING: nil
4139   :END:
4140 @end example
4142 @node Tracking your habits,  , Tracking TODO state changes, Progress logging
4143 @subsection Tracking your habits
4144 @cindex habits
4146 Org has the ability to track the consistency of a special category of TODOs,
4147 called ``habits''.  A habit has the following properties:
4149 @enumerate
4150 @item
4151 You have enabled the @code{habits} module by customizing the variable
4152 @code{org-modules}.
4153 @item
4154 The habit is a TODO item, with a TODO keyword representing an open state.
4155 @item
4156 The property @code{STYLE} is set to the value @code{habit}.
4157 @item
4158 The TODO has a scheduled date, usually with a @code{.+} style repeat
4159 interval.  A @code{++} style may be appropriate for habits with time
4160 constraints, e.g., must be done on weekends, or a @code{+} style for an
4161 unusual habit that can have a backlog, e.g., weekly reports.
4162 @item
4163 The TODO may also have minimum and maximum ranges specified by using the
4164 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4165 three days, but at most every two days.
4166 @item
4167 You must also have state logging for the @code{DONE} state enabled, in order
4168 for historical data to be represented in the consistency graph.  If it is not
4169 enabled it is not an error, but the consistency graphs will be largely
4170 meaningless.
4171 @end enumerate
4173 To give you an idea of what the above rules look like in action, here's an
4174 actual habit with some history:
4176 @example
4177 ** TODO Shave
4178    SCHEDULED: <2009-10-17 Sat .+2d/4d>
4179    - State "DONE"       from "TODO"       [2009-10-15 Thu]
4180    - State "DONE"       from "TODO"       [2009-10-12 Mon]
4181    - State "DONE"       from "TODO"       [2009-10-10 Sat]
4182    - State "DONE"       from "TODO"       [2009-10-04 Sun]
4183    - State "DONE"       from "TODO"       [2009-10-02 Fri]
4184    - State "DONE"       from "TODO"       [2009-09-29 Tue]
4185    - State "DONE"       from "TODO"       [2009-09-25 Fri]
4186    - State "DONE"       from "TODO"       [2009-09-19 Sat]
4187    - State "DONE"       from "TODO"       [2009-09-16 Wed]
4188    - State "DONE"       from "TODO"       [2009-09-12 Sat]
4189    :PROPERTIES:
4190    :STYLE:    habit
4191    :LAST_REPEAT: [2009-10-19 Mon 00:36]
4192    :END:
4193 @end example
4195 What this habit says is: I want to shave at most every 2 days (given by the
4196 @code{SCHEDULED} date and repeat interval) and at least every 4 days.  If
4197 today is the 15th, then the habit first appears in the agenda on Oct 17,
4198 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4199 after four days have elapsed.
4201 What's really useful about habits is that they are displayed along with a
4202 consistency graph, to show how consistent you've been at getting that task
4203 done in the past.  This graph shows every day that the task was done over the
4204 past three weeks, with colors for each day.  The colors used are:
4206 @table @code
4207 @item Blue
4208 If the task wasn't to be done yet on that day.
4209 @item Green
4210 If the task could have been done on that day.
4211 @item Yellow
4212 If the task was going to be overdue the next day.
4213 @item Red
4214 If the task was overdue on that day.
4215 @end table
4217 In addition to coloring each day, the day is also marked with an asterisk if
4218 the task was actually done that day, and an exclamation mark to show where
4219 the current day falls in the graph.
4221 There are several configuration variables that can be used to change the way
4222 habits are displayed in the agenda.
4224 @table @code
4225 @item org-habit-graph-column
4226 The buffer column at which the consistency graph should be drawn.  This will
4227 overwrite any text in that column, so it is a good idea to keep your habits'
4228 titles brief and to the point.
4229 @item org-habit-preceding-days
4230 The amount of history, in days before today, to appear in consistency graphs.
4231 @item org-habit-following-days
4232 The number of days after today that will appear in consistency graphs.
4233 @item org-habit-show-habits-only-for-today
4234 If non-nil, only show habits in today's agenda view.  This is set to true by
4235 default.
4236 @end table
4238 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4239 temporarily be disabled and they won't appear at all.  Press @kbd{K} again to
4240 bring them back.  They are also subject to tag filtering, if you have habits
4241 which should only be done in certain contexts, for example.
4243 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4244 @section Priorities
4245 @cindex priorities
4247 If you use Org mode extensively, you may end up with enough TODO items that
4248 it starts to make sense to prioritize them.  Prioritizing can be done by
4249 placing a @emph{priority cookie} into the headline of a TODO item, like this
4251 @example
4252 *** TODO [#A] Write letter to Sam Fortune
4253 @end example
4255 @noindent
4256 @vindex org-priority-faces
4257 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4258 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie is
4259 treated just like priority @samp{B}.  Priorities make a difference only for
4260 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4261 have no inherent meaning to Org mode.  The cookies can be highlighted with
4262 special faces by customizing the variable @code{org-priority-faces}.
4264 Priorities can be attached to any outline node; they do not need to be TODO
4265 items.
4267 @table @kbd
4268 @item @kbd{C-c ,}
4269 @kindex @kbd{C-c ,}
4270 @findex org-priority
4271 Set the priority of the current headline (@command{org-priority}).  The
4272 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4273 When you press @key{SPC} instead, the priority cookie is removed from the
4274 headline.  The priorities can also be changed ``remotely'' from the timeline
4275 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4277 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4278 @vindex org-priority-start-cycle-with-default
4279 Increase/decrease priority of current headline@footnote{See also the option
4280 @code{org-priority-start-cycle-with-default}.}.  Note that these keys are
4281 also used to modify timestamps (@pxref{Creating timestamps}).  See also
4282 @ref{Conflicts}, for a discussion of the interaction with
4283 @code{shift-selection-mode}.
4284 @end table
4286 @vindex org-highest-priority
4287 @vindex org-lowest-priority
4288 @vindex org-default-priority
4289 You can change the range of allowed priorities by setting the variables
4290 @code{org-highest-priority}, @code{org-lowest-priority}, and
4291 @code{org-default-priority}.  For an individual buffer, you may set
4292 these values (highest, lowest, default) like this (please make sure that
4293 the highest priority is earlier in the alphabet than the lowest
4294 priority):
4296 @cindex #+PRIORITIES
4297 @example
4298 #+PRIORITIES: A C B
4299 @end example
4301 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4302 @section Breaking tasks down into subtasks
4303 @cindex tasks, breaking down
4304 @cindex statistics, for TODO items
4306 @vindex org-agenda-todo-list-sublevels
4307 It is often advisable to break down large tasks into smaller, manageable
4308 subtasks.  You can do this by creating an outline tree below a TODO item,
4309 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4310 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.  To keep
4311 the overview over the fraction of subtasks that are already completed, insert
4312 either @samp{[/]} or @samp{[%]} anywhere in the headline.  These cookies will
4313 be updated each time the TODO status of a child changes, or when pressing
4314 @kbd{C-c C-c} on the cookie.  For example:
4316 @example
4317 * Organize Party [33%]
4318 ** TODO Call people [1/2]
4319 *** TODO Peter
4320 *** DONE Sarah
4321 ** TODO Buy food
4322 ** DONE Talk to neighbor
4323 @end example
4325 @cindex property, COOKIE_DATA
4326 If a heading has both checkboxes and TODO children below it, the meaning of
4327 the statistics cookie become ambiguous.  Set the property
4328 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4329 this issue.
4331 @vindex org-hierarchical-todo-statistics
4332 If you would like to have the statistics cookie count any TODO entries in the
4333 subtree (not just direct children), configure the variable
4334 @code{org-hierarchical-todo-statistics}.  To do this for a single subtree,
4335 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4336 property.
4338 @example
4339 * Parent capturing statistics [2/20]
4340   :PROPERTIES:
4341   :COOKIE_DATA: todo recursive
4342   :END:
4343 @end example
4345 If you would like a TODO entry to automatically change to DONE
4346 when all children are done, you can use the following setup:
4348 @example
4349 (defun org-summary-todo (n-done n-not-done)
4350   "Switch entry to DONE when all subentries are done, to TODO otherwise."
4351   (let (org-log-done org-log-states)   ; turn off logging
4352     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4354 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4355 @end example
4358 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4359 large number of subtasks (@pxref{Checkboxes}).
4362 @node Checkboxes,  , Breaking down tasks, TODO Items
4363 @section Checkboxes
4364 @cindex checkboxes
4366 @vindex org-list-automatic-rules
4367 Every item in a plain list@footnote{With the exception of description
4368 lists.  But you can allow it by modifying @code{org-list-automatic-rules}
4369 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4370 it with the string @samp{[ ]}.  This feature is similar to TODO items
4371 (@pxref{TODO Items}), but is more lightweight.  Checkboxes are not included
4372 into the global TODO list, so they are often great to split a task into a
4373 number of simple steps.  Or you can use them in a shopping list.  To toggle a
4374 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4375 @file{org-mouse.el}).
4377 Here is an example of a checkbox list.
4379 @example
4380 * TODO Organize party [2/4]
4381   - [-] call people [1/3]
4382     - [ ] Peter
4383     - [X] Sarah
4384     - [ ] Sam
4385   - [X] order food
4386   - [ ] think about what music to play
4387   - [X] talk to the neighbors
4388 @end example
4390 Checkboxes work hierarchically, so if a checkbox item has children that
4391 are checkboxes, toggling one of the children checkboxes will make the
4392 parent checkbox reflect if none, some, or all of the children are
4393 checked.
4395 @cindex statistics, for checkboxes
4396 @cindex checkbox statistics
4397 @cindex property, COOKIE_DATA
4398 @vindex org-hierarchical-checkbox-statistics
4399 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4400 indicating how many checkboxes present in this entry have been checked off,
4401 and the total number of checkboxes present.  This can give you an idea on how
4402 many checkboxes remain, even without opening a folded entry.  The cookies can
4403 be placed into a headline or into (the first line of) a plain list item.
4404 Each cookie covers checkboxes of direct children structurally below the
4405 headline/item on which the cookie appears@footnote{Set the variable
4406 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4407 count all checkboxes below the cookie, not just those belonging to direct
4408 children.}.  You have to insert the cookie yourself by typing either
4409 @samp{[/]} or @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m}
4410 result, as in the examples above.  With @samp{[%]} you get information about
4411 the percentage of checkboxes checked (in the above example, this would be
4412 @samp{[50%]} and @samp{[33%]}, respectively).  In a headline, a cookie can
4413 count either checkboxes below the heading or TODO states of children, and it
4414 will display whatever was changed last.  Set the property @code{COOKIE_DATA}
4415 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4417 @cindex blocking, of checkboxes
4418 @cindex checkbox blocking
4419 @cindex property, ORDERED
4420 If the current outline node has an @code{ORDERED} property, checkboxes must
4421 be checked off in sequence, and an error will be thrown if you try to check
4422 off a box while there are unchecked boxes above it.
4424 @noindent The following commands work with checkboxes:
4426 @table @kbd
4427 @orgcmd{C-c C-c,org-toggle-checkbox}
4428 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
4429 double prefix argument, set it to @samp{[-]}, which is considered to be an
4430 intermediate state.
4431 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4432 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
4433 double prefix argument, set it to @samp{[-]}, which is considered to be an
4434 intermediate state.
4435 @itemize @minus
4436 @item
4437 If there is an active region, toggle the first checkbox in the region
4438 and set all remaining boxes to the same status as the first.  With a prefix
4439 arg, add or remove the checkbox for all items in the region.
4440 @item
4441 If the cursor is in a headline, toggle checkboxes in the region between
4442 this headline and the next (so @emph{not} the entire subtree).
4443 @item
4444 If there is no active region, just toggle the checkbox at point.
4445 @end itemize
4446 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4447 Insert a new item with a checkbox.  This works only if the cursor is already
4448 in a plain list item (@pxref{Plain lists}).
4449 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4450 @vindex org-track-ordered-property-with-tag
4451 @cindex property, ORDERED
4452 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4453 be checked off in sequence.  A property is used for this behavior because
4454 this should be local to the current entry, not inherited like a tag.
4455 However, if you would like to @i{track} the value of this property with a tag
4456 for better visibility, customize the variable
4457 @code{org-track-ordered-property-with-tag}.
4458 @orgcmd{C-c #,org-update-statistics-cookies}
4459 Update the statistics cookie in the current outline entry.  When called with
4460 a @kbd{C-u} prefix, update the entire file.  Checkbox statistic cookies are
4461 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4462 new ones with @kbd{M-S-@key{RET}}.  TODO statistics cookies update when
4463 changing TODO states.  If you delete boxes/entries or add/change them by
4464 hand, use this command to get things back into sync.
4465 @end table
4467 @node Tags, Properties and Columns, TODO Items, Top
4468 @chapter Tags
4469 @cindex tags
4470 @cindex headline tagging
4471 @cindex matching, tags
4472 @cindex sparse tree, tag based
4474 An excellent way to implement labels and contexts for cross-correlating
4475 information is to assign @i{tags} to headlines.  Org mode has extensive
4476 support for tags.
4478 @vindex org-tag-faces
4479 Every headline can contain a list of tags; they occur at the end of the
4480 headline.  Tags are normal words containing letters, numbers, @samp{_}, and
4481 @samp{@@}.  Tags must be preceded and followed by a single colon, e.g.,
4482 @samp{:work:}.  Several tags can be specified, as in @samp{:work:urgent:}.
4483 Tags will by default be in bold face with the same color as the headline.
4484 You may specify special faces for specific tags using the variable
4485 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4486 (@pxref{Faces for TODO keywords}).
4488 @menu
4489 * Tag inheritance::             Tags use the tree structure of the outline
4490 * Setting tags::                How to assign tags to a headline
4491 * Tag searches::                Searching for combinations of tags
4492 @end menu
4494 @node Tag inheritance, Setting tags, Tags, Tags
4495 @section Tag inheritance
4496 @cindex tag inheritance
4497 @cindex inheritance, of tags
4498 @cindex sublevels, inclusion into tags match
4500 @i{Tags} make use of the hierarchical structure of outline trees.  If a
4501 heading has a certain tag, all subheadings will inherit the tag as
4502 well.  For example, in the list
4504 @example
4505 * Meeting with the French group      :work:
4506 ** Summary by Frank                  :boss:notes:
4507 *** TODO Prepare slides for him      :action:
4508 @end example
4510 @noindent
4511 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4512 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4513 explicitly marked with those tags.  You can also set tags that all entries in
4514 a file should inherit just as if these tags were defined in a hypothetical
4515 level zero that surrounds the entire file.  Use a line like this@footnote{As
4516 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4517 changes in the line.}:
4519 @cindex #+FILETAGS
4520 @example
4521 #+FILETAGS: :Peter:Boss:Secret:
4522 @end example
4524 @noindent
4525 @vindex org-use-tag-inheritance
4526 @vindex org-tags-exclude-from-inheritance
4527 To limit tag inheritance to specific tags, or to turn it off entirely, use
4528 the variables @code{org-use-tag-inheritance} and
4529 @code{org-tags-exclude-from-inheritance}.
4531 @vindex org-tags-match-list-sublevels
4532 When a headline matches during a tags search while tag inheritance is turned
4533 on, all the sublevels in the same tree will (for a simple match form) match
4534 as well@footnote{This is only true if the search does not involve more
4535 complex tests including properties (@pxref{Property searches}).}.  The list
4536 of matches may then become very long.  If you only want to see the first tags
4537 match in a subtree, configure the variable
4538 @code{org-tags-match-list-sublevels} (not recommended).
4540 @node Setting tags, Tag searches, Tag inheritance, Tags
4541 @section Setting tags
4542 @cindex setting tags
4543 @cindex tags, setting
4545 @kindex M-@key{TAB}
4546 Tags can simply be typed into the buffer at the end of a headline.
4547 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
4548 also a special command for inserting tags:
4550 @table @kbd
4551 @orgcmd{C-c C-q,org-set-tags-command}
4552 @cindex completion, of tags
4553 @vindex org-tags-column
4554 Enter new tags for the current headline.  Org mode will either offer
4555 completion or a special single-key interface for setting tags, see
4556 below.  After pressing @key{RET}, the tags will be inserted and aligned
4557 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
4558 tags in the current buffer will be aligned to that column, just to make
4559 things look nice.  TAGS are automatically realigned after promotion,
4560 demotion, and TODO state changes (@pxref{TODO basics}).
4561 @orgcmd{C-c C-c,org-set-tags-command}
4562 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4563 @end table
4565 @vindex org-tag-alist
4566 Org supports tag insertion based on a @emph{list of tags}.  By
4567 default this list is constructed dynamically, containing all tags
4568 currently used in the buffer.  You may also globally specify a hard list
4569 of tags with the variable @code{org-tag-alist}.  Finally you can set
4570 the default tags for a given file with lines like
4572 @cindex #+TAGS
4573 @example
4574 #+TAGS: @@work @@home @@tennisclub
4575 #+TAGS: laptop car pc sailboat
4576 @end example
4578 If you have globally defined your preferred set of tags using the
4579 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4580 in a specific file, add an empty TAGS option line to that file:
4582 @example
4583 #+TAGS:
4584 @end example
4586 @vindex org-tag-persistent-alist
4587 If you have a preferred set of tags that you would like to use in every file,
4588 in addition to those defined on a per-file basis by TAGS option lines, then
4589 you may specify a list of tags with the variable
4590 @code{org-tag-persistent-alist}.  You may turn this off on a per-file basis
4591 by adding a STARTUP option line to that file:
4593 @example
4594 #+STARTUP: noptag
4595 @end example
4597 By default Org mode uses the standard minibuffer completion facilities for
4598 entering tags.  However, it also implements another, quicker, tag selection
4599 method called @emph{fast tag selection}.  This allows you to select and
4600 deselect tags with just a single key press.  For this to work well you should
4601 assign unique letters to most of your commonly used tags.  You can do this
4602 globally by configuring the variable @code{org-tag-alist} in your
4603 @file{.emacs} file.  For example, you may find the need to tag many items in
4604 different files with @samp{:@@home:}.  In this case you can set something
4605 like:
4607 @lisp
4608 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4609 @end lisp
4611 @noindent If the tag is only relevant to the file you are working on, then you
4612 can instead set the TAGS option line as:
4614 @example
4615 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
4616 @end example
4618 @noindent The tags interface will show the available tags in a splash
4619 window.  If you want to start a new line after a specific tag, insert
4620 @samp{\n} into the tag list
4622 @example
4623 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t) \n laptop(l)  pc(p)
4624 @end example
4626 @noindent or write them in two lines:
4628 @example
4629 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)
4630 #+TAGS: laptop(l)  pc(p)
4631 @end example
4633 @noindent
4634 You can also group together tags that are mutually exclusive by using
4635 braces, as in:
4637 @example
4638 #+TAGS: @{ @@work(w)  @@home(h)  @@tennisclub(t) @}  laptop(l)  pc(p)
4639 @end example
4641 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4642 and @samp{@@tennisclub} should be selected.  Multiple such groups are allowed.
4644 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4645 these lines to activate any changes.
4647 @noindent
4648 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4649 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4650 of the braces.  Similarly, you can use @code{:newline} to indicate a line
4651 break.  The previous example would be set globally by the following
4652 configuration:
4654 @lisp
4655 (setq org-tag-alist '((:startgroup . nil)
4656                       ("@@work" . ?w) ("@@home" . ?h)
4657                       ("@@tennisclub" . ?t)
4658                       (:endgroup . nil)
4659                       ("laptop" . ?l) ("pc" . ?p)))
4660 @end lisp
4662 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4663 automatically present you with a special interface, listing inherited tags,
4664 the tags of the current headline, and a list of all valid tags with
4665 corresponding keys@footnote{Keys will automatically be assigned to tags which
4666 have no configured keys.}.  In this interface, you can use the following
4667 keys:
4669 @table @kbd
4670 @item a-z...
4671 Pressing keys assigned to tags will add or remove them from the list of
4672 tags in the current line.  Selecting a tag in a group of mutually
4673 exclusive tags will turn off any other tags from that group.
4674 @kindex @key{TAB}
4675 @item @key{TAB}
4676 Enter a tag in the minibuffer, even if the tag is not in the predefined
4677 list.  You will be able to complete on all tags present in the buffer.
4678 You can also add several tags: just separate them with a comma.
4680 @kindex @key{SPC}
4681 @item @key{SPC}
4682 Clear all tags for this line.
4683 @kindex @key{RET}
4684 @item @key{RET}
4685 Accept the modified set.
4686 @item C-g
4687 Abort without installing changes.
4688 @item q
4689 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4690 @item !
4691 Turn off groups of mutually exclusive tags.  Use this to (as an
4692 exception) assign several tags from such a group.
4693 @item C-c
4694 Toggle auto-exit after the next change (see below).
4695 If you are using expert mode, the first @kbd{C-c} will display the
4696 selection window.
4697 @end table
4699 @noindent
4700 This method lets you assign tags to a headline with very few keys.  With
4701 the above setup, you could clear the current tags and set @samp{@@home},
4702 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4703 C-c @key{SPC} h l p @key{RET}}.  Switching from @samp{@@home} to
4704 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4705 alternatively with @kbd{C-c C-c C-c w}.  Adding the non-predefined tag
4706 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4707 @key{RET} @key{RET}}.
4709 @vindex org-fast-tag-selection-single-key
4710 If you find that most of the time you need only a single key press to
4711 modify your list of tags, set the variable
4712 @code{org-fast-tag-selection-single-key}.  Then you no longer have to
4713 press @key{RET} to exit fast tag selection---it will immediately exit
4714 after the first change.  If you then occasionally need more keys, press
4715 @kbd{C-c} to turn off auto-exit for the current tag selection process
4716 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4717 C-c}).  If you set the variable to the value @code{expert}, the special
4718 window is not even shown for single-key tag selection, it comes up only
4719 when you press an extra @kbd{C-c}.
4721 @node Tag searches,  , Setting tags, Tags
4722 @section Tag searches
4723 @cindex tag searches
4724 @cindex searching for tags
4726 Once a system of tags has been set up, it can be used to collect related
4727 information into special lists.
4729 @table @kbd
4730 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
4731 Create a sparse tree with all headlines matching a tags search.  With a
4732 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4733 @orgcmd{C-c a m,org-tags-view}
4734 Create a global list of tag matches from all agenda files.
4735 @xref{Matching tags and properties}.
4736 @orgcmd{C-c a M,org-tags-view}
4737 @vindex org-tags-match-list-sublevels
4738 Create a global list of tag matches from all agenda files, but check
4739 only TODO items and force checking subitems (see variable
4740 @code{org-tags-match-list-sublevels}).
4741 @end table
4743 These commands all prompt for a match string which allows basic Boolean logic
4744 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4745 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4746 which are tagged, like @samp{Kathy} or @samp{Sally}.  The full syntax of the search
4747 string is rich and allows also matching against TODO keywords, entry levels
4748 and properties.  For a complete description with many examples, see
4749 @ref{Matching tags and properties}.
4752 @node Properties and Columns, Dates and Times, Tags, Top
4753 @chapter Properties and columns
4754 @cindex properties
4756 A property is a key-value pair associated with an entry.  Properties can be
4757 set so they are associated with a single entry, with every entry in a tree,
4758 or with every entry in an Org mode file.
4760 There are two main applications for properties in Org mode.  First,
4761 properties are like tags, but with a value.  Imagine maintaining a file where
4762 you document bugs and plan releases for a piece of software.  Instead of
4763 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
4764 property, say @code{:Release:}, that in different subtrees has different
4765 values, such as @code{1.0} or @code{2.0}.  Second, you can use properties to
4766 implement (very basic) database capabilities in an Org buffer.  Imagine
4767 keeping track of your music CDs, where properties could be things such as the
4768 album, artist, date of release, number of tracks, and so on.
4770 Properties can be conveniently edited and viewed in column view
4771 (@pxref{Column view}).
4773 @menu
4774 * Property syntax::             How properties are spelled out
4775 * Special properties::          Access to other Org mode features
4776 * Property searches::           Matching property values
4777 * Property inheritance::        Passing values down the tree
4778 * Column view::                 Tabular viewing and editing
4779 * Property API::                Properties for Lisp programmers
4780 @end menu
4782 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4783 @section Property syntax
4784 @cindex property syntax
4785 @cindex drawer, for properties
4787 Properties are key-value pairs.  When they are associated with a single entry
4788 or with a tree they need to be inserted into a special
4789 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}.  Each property
4790 is specified on a single line, with the key (surrounded by colons)
4791 first, and the value after it.  Here is an example:
4793 @example
4794 * CD collection
4795 ** Classic
4796 *** Goldberg Variations
4797     :PROPERTIES:
4798     :Title:     Goldberg Variations
4799     :Composer:  J.S. Bach
4800     :Artist:    Glen Gould
4801     :Publisher: Deutsche Grammophon
4802     :NDisks:    1
4803     :END:
4804 @end example
4806 Depending on the value of @code{org-use-property-inheritance}, a property set
4807 this way will either be associated with a single entry, or the sub-tree
4808 defined by the entry, see @ref{Property inheritance}.
4810 You may define the allowed values for a particular property @samp{:Xyz:}
4811 by setting a property @samp{:Xyz_ALL:}.  This special property is
4812 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4813 the entire tree.  When allowed values are defined, setting the
4814 corresponding property becomes easier and is less prone to typing
4815 errors.  For the example with the CD collection, we can predefine
4816 publishers and the number of disks in a box like this:
4818 @example
4819 * CD collection
4820   :PROPERTIES:
4821   :NDisks_ALL:  1 2 3 4
4822   :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4823   :END:
4824 @end example
4826 If you want to set properties that can be inherited by any entry in a
4827 file, use a line like
4828 @cindex property, _ALL
4829 @cindex #+PROPERTY
4830 @example
4831 #+PROPERTY: NDisks_ALL 1 2 3 4
4832 @end example
4834 If you want to add to the value of an existing property, append a @code{+} to
4835 the property name.  The following results in the property @code{var} having
4836 the value ``foo=1 bar=2''.
4837 @cindex property, +
4838 @example
4839 #+PROPERTY: var  foo=1
4840 #+PROPERTY: var+ bar=2
4841 @end example
4843 It is also possible to add to the values of inherited properties.  The
4844 following results in the @code{genres} property having the value ``Classic
4845 Baroque'' under the @code{Goldberg Variations} subtree.
4846 @cindex property, +
4847 @example
4848 * CD collection
4849 ** Classic
4850     :PROPERTIES:
4851     :GENRES: Classic
4852     :END:
4853 *** Goldberg Variations
4854     :PROPERTIES:
4855     :Title:     Goldberg Variations
4856     :Composer:  J.S. Bach
4857     :Artist:    Glen Gould
4858     :Publisher: Deutsche Grammophon
4859     :NDisks:    1
4860     :GENRES+:   Baroque
4861     :END:
4862 @end example
4863 Note that a property can only have one entry per Drawer.
4865 @vindex org-global-properties
4866 Property values set with the global variable
4867 @code{org-global-properties} can be inherited by all entries in all
4868 Org files.
4870 @noindent
4871 The following commands help to work with properties:
4873 @table @kbd
4874 @orgcmd{M-@key{TAB},pcomplete}
4875 After an initial colon in a line, complete property keys.  All keys used
4876 in the current file will be offered as possible completions.
4877 @orgcmd{C-c C-x p,org-set-property}
4878 Set a property.  This prompts for a property name and a value.  If
4879 necessary, the property drawer is created as well.
4880 @item M-x org-insert-property-drawer
4881 @findex org-insert-property-drawer
4882 Insert a property drawer into the current entry.  The drawer will be
4883 inserted early in the entry, but after the lines with planning
4884 information like deadlines.
4885 @orgcmd{C-c C-c,org-property-action}
4886 With the cursor in a property drawer, this executes property commands.
4887 @orgcmd{C-c C-c s,org-set-property}
4888 Set a property in the current entry.  Both the property and the value
4889 can be inserted using completion.
4890 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4891 Switch property at point to the next/previous allowed value.
4892 @orgcmd{C-c C-c d,org-delete-property}
4893 Remove a property from the current entry.
4894 @orgcmd{C-c C-c D,org-delete-property-globally}
4895 Globally remove a property, from all entries in the current file.
4896 @orgcmd{C-c C-c c,org-compute-property-at-point}
4897 Compute the property at point, using the operator and scope from the
4898 nearest column format definition.
4899 @end table
4901 @node Special properties, Property searches, Property syntax, Properties and Columns
4902 @section Special properties
4903 @cindex properties, special
4905 Special properties provide an alternative access method to Org mode features,
4906 like the TODO state or the priority of an entry, discussed in the previous
4907 chapters.  This interface exists so that you can include these states in a
4908 column view (@pxref{Column view}), or to use them in queries.  The following
4909 property names are special and (except for @code{:CATEGORY:}) should not be
4910 used as keys in the properties drawer:
4912 @cindex property, special, TODO
4913 @cindex property, special, TAGS
4914 @cindex property, special, ALLTAGS
4915 @cindex property, special, CATEGORY
4916 @cindex property, special, PRIORITY
4917 @cindex property, special, DEADLINE
4918 @cindex property, special, SCHEDULED
4919 @cindex property, special, CLOSED
4920 @cindex property, special, TIMESTAMP
4921 @cindex property, special, TIMESTAMP_IA
4922 @cindex property, special, CLOCKSUM
4923 @cindex property, special, BLOCKED
4924 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4925 @cindex property, special, ITEM
4926 @cindex property, special, FILE
4927 @example
4928 TODO         @r{The TODO keyword of the entry.}
4929 TAGS         @r{The tags defined directly in the headline.}
4930 ALLTAGS      @r{All tags, including inherited ones.}
4931 CATEGORY     @r{The category of an entry.}
4932 PRIORITY     @r{The priority of the entry, a string with a single letter.}
4933 DEADLINE     @r{The deadline time string, without the angular brackets.}
4934 SCHEDULED    @r{The scheduling timestamp, without the angular brackets.}
4935 CLOSED       @r{When was this entry closed?}
4936 TIMESTAMP    @r{The first keyword-less timestamp in the entry.}
4937 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4938 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
4939              @r{must be run first to compute the values in the current buffer.}
4940 BLOCKED      @r{"t" if task is currently blocked by children or siblings}
4941 ITEM         @r{The content of the entry.}
4942 FILE         @r{The filename the entry is located in.}
4943 @end example
4945 @node Property searches, Property inheritance, Special properties, Properties and Columns
4946 @section Property searches
4947 @cindex properties, searching
4948 @cindex searching, of properties
4950 To create sparse trees and special lists with selection based on properties,
4951 the same commands are used as for tag searches (@pxref{Tag searches}).
4952 @table @kbd
4953 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4954 Create a sparse tree with all matching entries.  With a
4955 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4956 @orgcmd{C-c a m,org-tags-view}
4957 Create a global list of tag/property  matches from all agenda files.
4958 @xref{Matching tags and properties}.
4959 @orgcmd{C-c a M,org-tags-view}
4960 @vindex org-tags-match-list-sublevels
4961 Create a global list of tag matches from all agenda files, but check
4962 only TODO items and force checking of subitems (see variable
4963 @code{org-tags-match-list-sublevels}).
4964 @end table
4966 The syntax for the search string is described in @ref{Matching tags and
4967 properties}.
4969 There is also a special command for creating sparse trees based on a
4970 single property:
4972 @table @kbd
4973 @orgkey{C-c / p}
4974 Create a sparse tree based on the value of a property.  This first
4975 prompts for the name of a property, and then for a value.  A sparse tree
4976 is created with all entries that define this property with the given
4977 value.  If you enclose the value in curly braces, it is interpreted as
4978 a regular expression and matched against the property values.
4979 @end table
4981 @node Property inheritance, Column view, Property searches, Properties and Columns
4982 @section Property Inheritance
4983 @cindex properties, inheritance
4984 @cindex inheritance, of properties
4986 @vindex org-use-property-inheritance
4987 The outline structure of Org mode documents lends itself to an
4988 inheritance model of properties: if the parent in a tree has a certain
4989 property, the children can inherit this property.  Org mode does not
4990 turn this on by default, because it can slow down property searches
4991 significantly and is often not needed.  However, if you find inheritance
4992 useful, you can turn it on by setting the variable
4993 @code{org-use-property-inheritance}.  It may be set to @code{t} to make
4994 all properties inherited from the parent, to a list of properties
4995 that should be inherited, or to a regular expression that matches
4996 inherited properties.  If a property has the value @samp{nil}, this is
4997 interpreted as an explicit undefine of the property, so that inheritance
4998 search will stop at this value and return @code{nil}.
5000 Org mode has a few properties for which inheritance is hard-coded, at
5001 least for the special applications for which they are used:
5003 @cindex property, COLUMNS
5004 @table @code
5005 @item COLUMNS
5006 The @code{:COLUMNS:} property defines the format of column view
5007 (@pxref{Column view}).  It is inherited in the sense that the level
5008 where a @code{:COLUMNS:} property is defined is used as the starting
5009 point for a column view table, independently of the location in the
5010 subtree from where columns view is turned on.
5011 @item CATEGORY
5012 @cindex property, CATEGORY
5013 For agenda view, a category set through a @code{:CATEGORY:} property
5014 applies to the entire subtree.
5015 @item ARCHIVE
5016 @cindex property, ARCHIVE
5017 For archiving, the @code{:ARCHIVE:} property may define the archive
5018 location for the entire subtree (@pxref{Moving subtrees}).
5019 @item LOGGING
5020 @cindex property, LOGGING
5021 The LOGGING property may define logging settings for an entry or a
5022 subtree (@pxref{Tracking TODO state changes}).
5023 @end table
5025 @node Column view, Property API, Property inheritance, Properties and Columns
5026 @section Column view
5028 A great way to view and edit properties in an outline tree is
5029 @emph{column view}.  In column view, each outline node is turned into a
5030 table row.  Columns in this table provide access to properties of the
5031 entries.  Org mode implements columns by overlaying a tabular structure
5032 over the headline of each item.  While the headlines have been turned
5033 into a table row, you can still change the visibility of the outline
5034 tree.  For example, you get a compact table by switching to CONTENTS
5035 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5036 is active), but you can still open, read, and edit the entry below each
5037 headline.  Or, you can switch to column view after executing a sparse
5038 tree command and in this way get a table only for the selected items.
5039 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5040 queries have collected selected items, possibly from a number of files.
5042 @menu
5043 * Defining columns::            The COLUMNS format property
5044 * Using column view::           How to create and use column view
5045 * Capturing column view::       A dynamic block for column view
5046 @end menu
5048 @node Defining columns, Using column view, Column view, Column view
5049 @subsection Defining columns
5050 @cindex column view, for properties
5051 @cindex properties, column view
5053 Setting up a column view first requires defining the columns.  This is
5054 done by defining a column format line.
5056 @menu
5057 * Scope of column definitions::  Where defined, where valid?
5058 * Column attributes::           Appearance and content of a column
5059 @end menu
5061 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5062 @subsubsection Scope of column definitions
5064 To define a column format for an entire file, use a line like
5066 @cindex #+COLUMNS
5067 @example
5068 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5069 @end example
5071 To specify a format that only applies to a specific tree, add a
5072 @code{:COLUMNS:} property to the top node of that tree, for example:
5074 @example
5075 ** Top node for columns view
5076    :PROPERTIES:
5077    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5078    :END:
5079 @end example
5081 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5082 for the entry itself, and for the entire subtree below it.  Since the
5083 column definition is part of the hierarchical structure of the document,
5084 you can define columns on level 1 that are general enough for all
5085 sublevels, and more specific columns further down, when you edit a
5086 deeper part of the tree.
5088 @node Column attributes,  , Scope of column definitions, Defining columns
5089 @subsubsection Column attributes
5090 A column definition sets the attributes of a column.  The general
5091 definition looks like this:
5093 @example
5094  %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5095 @end example
5097 @noindent
5098 Except for the percent sign and the property name, all items are
5099 optional.  The individual parts have the following meaning:
5101 @example
5102 @var{width}           @r{An integer specifying the width of the column in characters.}
5103                 @r{If omitted, the width will be determined automatically.}
5104 @var{property}        @r{The property that should be edited in this column.}
5105                 @r{Special properties representing meta data are allowed here}
5106                 @r{as well (@pxref{Special properties})}
5107 @var{title}           @r{The header text for the column.  If omitted, the property}
5108                 @r{name is used.}
5109 @{@var{summary-type}@}  @r{The summary type.  If specified, the column values for}
5110                 @r{parent nodes are computed from the children.}
5111                 @r{Supported summary types are:}
5112                 @{+@}       @r{Sum numbers in this column.}
5113                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
5114                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
5115                 @{:@}       @r{Sum times, HH:MM, plain numbers are hours.}
5116                 @{X@}       @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5117                 @{X/@}      @r{Checkbox status, @samp{[n/m]}.}
5118                 @{X%@}      @r{Checkbox status, @samp{[n%]}.}
5119                 @{min@}     @r{Smallest number in column.}
5120                 @{max@}     @r{Largest number.}
5121                 @{mean@}    @r{Arithmetic mean of numbers.}
5122                 @{:min@}    @r{Smallest time value in column.}
5123                 @{:max@}    @r{Largest time value.}
5124                 @{:mean@}   @r{Arithmetic mean of time values.}
5125                 @{@@min@}    @r{Minimum age (in days/hours/mins/seconds).}
5126                 @{@@max@}    @r{Maximum age (in days/hours/mins/seconds).}
5127                 @{@@mean@}   @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5128                 @{est+@}    @r{Add low-high estimates.}
5129 @end example
5131 @noindent
5132 Be aware that you can only have one summary type for any property you
5133 include.  Subsequent columns referencing the same property will all display the
5134 same summary information.
5136 The @code{est+} summary type requires further explanation.  It is used for
5137 combining estimates, expressed as low-high ranges.  For example, instead
5138 of estimating a particular task will take 5 days, you might estimate it as
5139 5-6 days if you're fairly confident you know how much work is required, or
5140 1-10 days if you don't really know what needs to be done.  Both ranges
5141 average at 5.5 days, but the first represents a more predictable delivery.
5143 When combining a set of such estimates, simply adding the lows and highs
5144 produces an unrealistically wide result.  Instead, @code{est+} adds the
5145 statistical mean and variance of the sub-tasks, generating a final estimate
5146 from the sum.  For example, suppose you had ten tasks, each of which was
5147 estimated at 0.5 to 2 days of work.  Straight addition produces an estimate
5148 of 5 to 20 days, representing what to expect if everything goes either
5149 extremely well or extremely poorly.  In contrast, @code{est+} estimates the
5150 full job more realistically, at 10-15 days.
5152 Here is an example for a complete columns definition, along with allowed
5153 values.
5155 @example
5156 :COLUMNS:  %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.}
5157                    %10Time_Estimate@{:@} %CLOCKSUM
5158 :Owner_ALL:    Tammy Mark Karl Lisa Don
5159 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
5160 :Approved_ALL: "[ ]" "[X]"
5161 @end example
5163 @noindent
5164 The first column, @samp{%25ITEM}, means the first 25 characters of the
5165 item itself, i.e.@: of the headline.  You probably always should start the
5166 column definition with the @samp{ITEM} specifier.  The other specifiers
5167 create columns @samp{Owner} with a list of names as allowed values, for
5168 @samp{Status} with four different possible values, and for a checkbox
5169 field @samp{Approved}.  When no width is given after the @samp{%}
5170 character, the column will be exactly as wide as it needs to be in order
5171 to fully display all values.  The @samp{Approved} column does have a
5172 modified title (@samp{Approved?}, with a question mark).  Summaries will
5173 be created for the @samp{Time_Estimate} column by adding time duration
5174 expressions like HH:MM, and for the @samp{Approved} column, by providing
5175 an @samp{[X]} status if all children have been checked.  The
5176 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
5177 in the subtree.
5179 @node Using column view, Capturing column view, Defining columns, Column view
5180 @subsection Using column view
5182 @table @kbd
5183 @tsubheading{Turning column view on and off}
5184 @orgcmd{C-c C-x C-c,org-columns}
5185 @vindex org-columns-default-format
5186 Turn on column view.  If the cursor is before the first headline in the file,
5187 column view is turned on for the entire file, using the @code{#+COLUMNS}
5188 definition.  If the cursor is somewhere inside the outline, this command
5189 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5190 defines a format.  When one is found, the column view table is established
5191 for the tree starting at the entry that contains the @code{:COLUMNS:}
5192 property.  If no such property is found, the format is taken from the
5193 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5194 and column view is established for the current entry and its subtree.
5195 @orgcmd{r,org-columns-redo}
5196 Recreate the column view, to include recent changes made in the buffer.
5197 @orgcmd{g,org-columns-redo}
5198 Same as @kbd{r}.
5199 @orgcmd{q,org-columns-quit}
5200 Exit column view.
5201 @tsubheading{Editing values}
5202 @item @key{left} @key{right} @key{up} @key{down}
5203 Move through the column view from field to field.
5204 @kindex S-@key{left}
5205 @kindex S-@key{right}
5206 @item  S-@key{left}/@key{right}
5207 Switch to the next/previous allowed value of the field.  For this, you
5208 have to have specified allowed values for a property.
5209 @item 1..9,0
5210 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5211 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5212 Same as @kbd{S-@key{left}/@key{right}}
5213 @orgcmd{e,org-columns-edit-value}
5214 Edit the property at point.  For the special properties, this will
5215 invoke the same interface that you normally use to change that
5216 property.  For example, when editing a TAGS property, the tag completion
5217 or fast selection interface will pop up.
5218 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5219 When there is a checkbox at point, toggle it.
5220 @orgcmd{v,org-columns-show-value}
5221 View the full value of this property.  This is useful if the width of
5222 the column is smaller than that of the value.
5223 @orgcmd{a,org-columns-edit-allowed}
5224 Edit the list of allowed values for this property.  If the list is found
5225 in the hierarchy, the modified values is stored there.  If no list is
5226 found, the new value is stored in the first entry that is part of the
5227 current column view.
5228 @tsubheading{Modifying the table structure}
5229 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5230 Make the column narrower/wider by one character.
5231 @orgcmd{S-M-@key{right},org-columns-new}
5232 Insert a new column, to the left of the current column.
5233 @orgcmd{S-M-@key{left},org-columns-delete}
5234 Delete the current column.
5235 @end table
5237 @node Capturing column view,  , Using column view, Column view
5238 @subsection Capturing column view
5240 Since column view is just an overlay over a buffer, it cannot be
5241 exported or printed directly.  If you want to capture a column view, use
5242 a @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
5243 of this block looks like this:
5245 @cindex #+BEGIN, columnview
5246 @example
5247 * The column view
5248 #+BEGIN: columnview :hlines 1 :id "label"
5250 #+END:
5251 @end example
5253 @noindent This dynamic block has the following parameters:
5255 @table @code
5256 @item :id
5257 This is the most important parameter.  Column view is a feature that is
5258 often localized to a certain (sub)tree, and the capture block might be
5259 at a different location in the file.  To identify the tree whose view to
5260 capture, you can use 4 values:
5261 @cindex property, ID
5262 @example
5263 local     @r{use the tree in which the capture block is located}
5264 global    @r{make a global view, including all headings in the file}
5265 "file:@var{path-to-file}"
5266           @r{run column view at the top of this file}
5267 "@var{ID}"      @r{call column view in the tree that has an @code{:ID:}}
5268           @r{property with the value @i{label}.  You can use}
5269           @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5270           @r{the current entry and copy it to the kill-ring.}
5271 @end example
5272 @item :hlines
5273 When @code{t}, insert an hline after every line.  When a number @var{N}, insert
5274 an hline before each headline with level @code{<= @var{N}}.
5275 @item :vlines
5276 When set to @code{t}, force column groups to get vertical lines.
5277 @item :maxlevel
5278 When set to a number, don't capture entries below this level.
5279 @item :skip-empty-rows
5280 When set to @code{t}, skip rows where the only non-empty specifier of the
5281 column view is @code{ITEM}.
5283 @end table
5285 @noindent
5286 The following commands insert or update the dynamic block:
5288 @table @kbd
5289 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5290 Insert a dynamic block capturing a column view.  You will be prompted
5291 for the scope or ID of the view.
5292 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5293 Update dynamic block at point.  The cursor needs to be in the
5294 @code{#+BEGIN} line of the dynamic block.
5295 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5296 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
5297 you have several clock table blocks, column-capturing blocks or other dynamic
5298 blocks in a buffer.
5299 @end table
5301 You can add formulas to the column view table and you may add plotting
5302 instructions in front of the table---these will survive an update of the
5303 block.  If there is a @code{#+TBLFM:} after the table, the table will
5304 actually be recalculated automatically after an update.
5306 An alternative way to capture and process property values into a table is
5307 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5308 package@footnote{Contributed packages are not part of Emacs, but are
5309 distributed with the main distribution of Org (visit
5310 @uref{http://orgmode.org}).}.  It provides a general API to collect
5311 properties from entries in a certain scope, and arbitrary Lisp expressions to
5312 process these values before inserting them into a table or a dynamic block.
5314 @node Property API,  , Column view, Properties and Columns
5315 @section The Property API
5316 @cindex properties, API
5317 @cindex API, for properties
5319 There is a full API for accessing and changing properties.  This API can
5320 be used by Emacs Lisp programs to work with properties and to implement
5321 features based on them.  For more information see @ref{Using the
5322 property API}.
5324 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5325 @chapter Dates and times
5326 @cindex dates
5327 @cindex times
5328 @cindex timestamp
5329 @cindex date stamp
5331 To assist project planning, TODO items can be labeled with a date and/or
5332 a time.  The specially formatted string carrying the date and time
5333 information is called a @emph{timestamp} in Org mode.  This may be a
5334 little confusing because timestamp is often used as indicating when
5335 something was created or last changed.  However, in Org mode this term
5336 is used in a much wider sense.
5338 @menu
5339 * Timestamps::                  Assigning a time to a tree entry
5340 * Creating timestamps::         Commands which insert timestamps
5341 * Deadlines and scheduling::    Planning your work
5342 * Clocking work time::          Tracking how long you spend on a task
5343 * Effort estimates::            Planning work effort in advance
5344 * Relative timer::              Notes with a running timer
5345 * Countdown timer::             Starting a countdown timer for a task
5346 @end menu
5349 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5350 @section Timestamps, deadlines, and scheduling
5351 @cindex timestamps
5352 @cindex ranges, time
5353 @cindex date stamps
5354 @cindex deadlines
5355 @cindex scheduling
5357 A timestamp is a specification of a date (possibly with a time or a range of
5358 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5359 simplest form, the day name is optional when you type the date yourself.
5360 However, any dates inserted or modified by Org will add that day name, for
5361 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5362 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5363 date/time format.  To use an alternative format, see @ref{Custom time
5364 format}.}.  A timestamp can appear anywhere in the headline or body of an Org
5365 tree entry.  Its presence causes entries to be shown on specific dates in the
5366 agenda (@pxref{Weekly/daily agenda}).  We distinguish:
5368 @table @var
5369 @item Plain timestamp; Event; Appointment
5370 @cindex timestamp
5371 @cindex appointment
5372 A simple timestamp just assigns a date/time to an item.  This is just
5373 like writing down an appointment or event in a paper agenda.  In the
5374 timeline and agenda displays, the headline of an entry associated with a
5375 plain timestamp will be shown exactly on that date.
5377 @example
5378 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5379 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5380 @end example
5382 @item Timestamp with repeater interval
5383 @cindex timestamp, with repeater interval
5384 A timestamp may contain a @emph{repeater interval}, indicating that it
5385 applies not only on the given date, but again and again after a certain
5386 interval of N days (d), weeks (w), months (m), or years (y).  The
5387 following will show up in the agenda every Wednesday:
5389 @example
5390 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5391 @end example
5393 @item Diary-style sexp entries
5394 For more complex date specifications, Org mode supports using the special
5395 sexp diary entries implemented in the Emacs calendar/diary
5396 package@footnote{When working with the standard diary sexp functions, you
5397 need to be very careful with the order of the arguments.  That order depend
5398 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5399 versions, @code{european-calendar-style}).  For example, to specify a date
5400 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5401 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5402 the settings.  This has been the source of much confusion.  Org mode users
5403 can resort to special versions of these functions like @code{org-date} or
5404 @code{org-anniversary}.  These work just like the corresponding @code{diary-}
5405 functions, but with stable ISO order of arguments (year, month, day) wherever
5406 applicable, independent of the value of @code{calendar-date-style}.}.  For example
5408 @example
5409 * The nerd meeting on every 2nd Thursday of the month
5410   <%%(org-float t 4 2)>
5411 @end example
5413 @item Time/Date range
5414 @cindex timerange
5415 @cindex date range
5416 Two timestamps connected by @samp{--} denote a range.  The headline
5417 will be shown on the first and last day of the range, and on any dates
5418 that are displayed and fall in the range.  Here is an example:
5420 @example
5421 ** Meeting in Amsterdam
5422    <2004-08-23 Mon>--<2004-08-26 Thu>
5423 @end example
5425 @item Inactive timestamp
5426 @cindex timestamp, inactive
5427 @cindex inactive timestamp
5428 Just like a plain timestamp, but with square brackets instead of
5429 angular ones.  These timestamps are inactive in the sense that they do
5430 @emph{not} trigger an entry to show up in the agenda.
5432 @example
5433 * Gillian comes late for the fifth time [2006-11-01 Wed]
5434 @end example
5436 @end table
5438 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5439 @section Creating timestamps
5440 @cindex creating timestamps
5441 @cindex timestamps, creating
5443 For Org mode to recognize timestamps, they need to be in the specific
5444 format.  All commands listed below produce timestamps in the correct
5445 format.
5447 @table @kbd
5448 @orgcmd{C-c .,org-time-stamp}
5449 Prompt for a date and insert a corresponding timestamp.  When the cursor is
5450 at an existing timestamp in the buffer, the command is used to modify this
5451 timestamp instead of inserting a new one.  When this command is used twice in
5452 succession, a time range is inserted.
5454 @orgcmd{C-c !,org-time-stamp-inactive}
5455 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5456 an agenda entry.
5458 @kindex C-u C-c .
5459 @kindex C-u C-c !
5460 @item C-u C-c .
5461 @itemx C-u C-c !
5462 @vindex org-time-stamp-rounding-minutes
5463 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5464 contains date and time.  The default time can be rounded to multiples of 5
5465 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5467 @orgkey{C-c C-c}
5468 Normalize timestamp, insert/fix day name if missing or wrong.
5470 @orgcmd{C-c <,org-date-from-calendar}
5471 Insert a timestamp corresponding to the cursor date in the Calendar.
5473 @orgcmd{C-c >,org-goto-calendar}
5474 Access the Emacs calendar for the current date.  If there is a
5475 timestamp in the current line, go to the corresponding date
5476 instead.
5478 @orgcmd{C-c C-o,org-open-at-point}
5479 Access the agenda for the date given by the timestamp or -range at
5480 point (@pxref{Weekly/daily agenda}).
5482 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5483 Change date at cursor by one day.  These key bindings conflict with
5484 shift-selection and related modes (@pxref{Conflicts}).
5486 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5487 Change the item under the cursor in a timestamp.  The cursor can be on a
5488 year, month, day, hour or minute.  When the timestamp contains a time range
5489 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5490 shifting the time block with constant length.  To change the length, modify
5491 the second time.  Note that if the cursor is in a headline and not at a
5492 timestamp, these same keys modify the priority of an item.
5493 (@pxref{Priorities}).  The key bindings also conflict with shift-selection and
5494 related modes (@pxref{Conflicts}).
5496 @orgcmd{C-c C-y,org-evaluate-time-range}
5497 @cindex evaluate time range
5498 Evaluate a time range by computing the difference between start and end.
5499 With a prefix argument, insert result after the time range (in a table: into
5500 the following column).
5501 @end table
5504 @menu
5505 * The date/time prompt::        How Org mode helps you entering date and time
5506 * Custom time format::          Making dates look different
5507 @end menu
5509 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5510 @subsection The date/time prompt
5511 @cindex date, reading in minibuffer
5512 @cindex time, reading in minibuffer
5514 @vindex org-read-date-prefer-future
5515 When Org mode prompts for a date/time, the default is shown in default
5516 date/time format, and the prompt therefore seems to ask for a specific
5517 format.  But it will in fact accept any string containing some date and/or
5518 time information, and it is really smart about interpreting your input.  You
5519 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5520 copied from an email message.  Org mode will find whatever information is in
5521 there and derive anything you have not specified from the @emph{default date
5522 and time}.  The default is usually the current date and time, but when
5523 modifying an existing timestamp, or when entering the second stamp of a
5524 range, it is taken from the stamp in the buffer.  When filling in
5525 information, Org mode assumes that most of the time you will want to enter a
5526 date in the future: if you omit the month/year and the given day/month is
5527 @i{before} today, it will assume that you mean a future date@footnote{See the
5528 variable @code{org-read-date-prefer-future}.  You may set that variable to
5529 the symbol @code{time} to even make a time before now shift the date to
5530 tomorrow.}.  If the date has been automatically shifted into the future, the
5531 time prompt will show this with @samp{(=>F).}
5533 For example, let's assume that today is @b{June 13, 2006}.  Here is how
5534 various inputs will be interpreted, the items filled in by Org mode are
5535 in @b{bold}.
5537 @example
5538 3-2-5         @result{} 2003-02-05
5539 2/5/3         @result{} 2003-02-05
5540 14            @result{} @b{2006}-@b{06}-14
5541 12            @result{} @b{2006}-@b{07}-12
5542 2/5           @result{} @b{2007}-02-05
5543 Fri           @result{} nearest Friday (default date or later)
5544 sep 15        @result{} @b{2006}-09-15
5545 feb 15        @result{} @b{2007}-02-15
5546 sep 12 9      @result{} 2009-09-12
5547 12:45         @result{} @b{2006}-@b{06}-@b{13} 12:45
5548 22 sept 0:34  @result{} @b{2006}-09-22 0:34
5549 w4            @result{} ISO week for of the current year @b{2006}
5550 2012 w4 fri   @result{} Friday of ISO week 4 in 2012
5551 2012-w04-5    @result{} Same as above
5552 @end example
5554 Furthermore you can specify a relative date by giving, as the
5555 @emph{first} thing in the input: a plus/minus sign, a number and a
5556 letter ([dwmy]) to indicate change in days, weeks, months, or years.  With a
5557 single plus or minus, the date is always relative to today.  With a
5558 double plus or minus, it is relative to the default date.  If instead of
5559 a single letter, you use the abbreviation of day name, the date will be
5560 the Nth such day, e.g.@:
5562 @example
5563 +0            @result{} today
5564 .             @result{} today
5565 +4d           @result{} four days from today
5566 +4            @result{} same as above
5567 +2w           @result{} two weeks from today
5568 ++5           @result{} five days from default date
5569 +2tue         @result{} second Tuesday from now.
5570 @end example
5572 @vindex parse-time-months
5573 @vindex parse-time-weekdays
5574 The function understands English month and weekday abbreviations.  If
5575 you want to use unabbreviated names and/or other languages, configure
5576 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5578 @vindex org-read-date-force-compatible-dates
5579 Not all dates can be represented in a given Emacs implementation.  By default
5580 Org mode forces dates into the compatibility range 1970--2037 which works on
5581 all Emacs implementations.  If you want to use dates outside of this range,
5582 read the docstring of the variable
5583 @code{org-read-date-force-compatible-dates}.
5585 You can specify a time range by giving start and end times or by giving a
5586 start time and a duration (in HH:MM format).  Use one or two dash(es) as the
5587 separator in the former case and use '+' as the separator in the latter
5588 case, e.g.@:
5590 @example
5591 11am-1:15pm    @result{} 11:00-13:15
5592 11am--1:15pm   @result{} same as above
5593 11am+2:15      @result{} same as above
5594 @end example
5596 @cindex calendar, for selecting date
5597 @vindex org-popup-calendar-for-date-prompt
5598 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5599 you don't need/want the calendar, configure the variable
5600 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
5601 prompt, either by clicking on a date in the calendar, or by pressing
5602 @key{RET}, the date selected in the calendar will be combined with the
5603 information entered at the prompt.  You can control the calendar fully
5604 from the minibuffer:
5606 @kindex <
5607 @kindex >
5608 @kindex M-v
5609 @kindex C-v
5610 @kindex mouse-1
5611 @kindex S-@key{right}
5612 @kindex S-@key{left}
5613 @kindex S-@key{down}
5614 @kindex S-@key{up}
5615 @kindex M-S-@key{right}
5616 @kindex M-S-@key{left}
5617 @kindex @key{RET}
5618 @example
5619 @key{RET}           @r{Choose date at cursor in calendar.}
5620 mouse-1        @r{Select date by clicking on it.}
5621 S-@key{right}/@key{left}     @r{One day forward/backward.}
5622 S-@key{down}/@key{up}     @r{One week forward/backward.}
5623 M-S-@key{right}/@key{left}   @r{One month forward/backward.}
5624 > / <          @r{Scroll calendar forward/backward by one month.}
5625 M-v / C-v      @r{Scroll calendar forward/backward by 3 months.}
5626 @end example
5628 @vindex org-read-date-display-live
5629 The actions of the date/time prompt may seem complex, but I assure you they
5630 will grow on you, and you will start getting annoyed by pretty much any other
5631 way of entering a date/time out there.  To help you understand what is going
5632 on, the current interpretation of your input will be displayed live in the
5633 minibuffer@footnote{If you find this distracting, turn the display of with
5634 @code{org-read-date-display-live}.}.
5636 @node Custom time format,  , The date/time prompt, Creating timestamps
5637 @subsection Custom time format
5638 @cindex custom date/time format
5639 @cindex time format, custom
5640 @cindex date format, custom
5642 @vindex org-display-custom-times
5643 @vindex org-time-stamp-custom-formats
5644 Org mode uses the standard ISO notation for dates and times as it is
5645 defined in ISO 8601.  If you cannot get used to this and require another
5646 representation of date and time to keep you happy, you can get it by
5647 customizing the variables @code{org-display-custom-times} and
5648 @code{org-time-stamp-custom-formats}.
5650 @table @kbd
5651 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5652 Toggle the display of custom formats for dates and times.
5653 @end table
5655 @noindent
5656 Org mode needs the default format for scanning, so the custom date/time
5657 format does not @emph{replace} the default format---instead it is put
5658 @emph{over} the default format using text properties.  This has the
5659 following consequences:
5660 @itemize @bullet
5661 @item
5662 You cannot place the cursor onto a timestamp anymore, only before or
5663 after.
5664 @item
5665 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5666 each component of a timestamp.  If the cursor is at the beginning of
5667 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5668 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
5669 time will be changed by one minute.
5670 @item
5671 If the timestamp contains a range of clock times or a repeater, these
5672 will not be overlaid, but remain in the buffer as they were.
5673 @item
5674 When you delete a timestamp character-by-character, it will only
5675 disappear from the buffer after @emph{all} (invisible) characters
5676 belonging to the ISO timestamp have been removed.
5677 @item
5678 If the custom timestamp format is longer than the default and you are
5679 using dates in tables, table alignment will be messed up.  If the custom
5680 format is shorter, things do work as expected.
5681 @end itemize
5684 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5685 @section Deadlines and scheduling
5687 A timestamp may be preceded by special keywords to facilitate planning:
5689 @table @var
5690 @item DEADLINE
5691 @cindex DEADLINE keyword
5693 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5694 to be finished on that date.
5696 @vindex org-deadline-warning-days
5697 On the deadline date, the task will be listed in the agenda.  In
5698 addition, the agenda for @emph{today} will carry a warning about the
5699 approaching or missed deadline, starting
5700 @code{org-deadline-warning-days} before the due date, and continuing
5701 until the entry is marked DONE.  An example:
5703 @example
5704 *** TODO write article about the Earth for the Guide
5705     The editor in charge is [[bbdb:Ford Prefect]]
5706     DEADLINE: <2004-02-29 Sun>
5707 @end example
5709 You can specify a different lead time for warnings for a specific
5710 deadlines using the following syntax.  Here is an example with a warning
5711 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5713 @item SCHEDULED
5714 @cindex SCHEDULED keyword
5716 Meaning: you are planning to start working on that task on the given
5717 date.
5719 @vindex org-agenda-skip-scheduled-if-done
5720 The headline will be listed under the given date@footnote{It will still
5721 be listed on that date after it has been marked DONE.  If you don't like
5722 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
5723 addition, a reminder that the scheduled date has passed will be present
5724 in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
5725 the task will automatically be forwarded until completed.
5727 @example
5728 *** TODO Call Trillian for a date on New Years Eve.
5729     SCHEDULED: <2004-12-25 Sat>
5730 @end example
5732 @noindent
5733 @b{Important:} Scheduling an item in Org mode should @i{not} be
5734 understood in the same way that we understand @i{scheduling a meeting}.
5735 Setting a date for a meeting is just a simple appointment, you should
5736 mark this entry with a simple plain timestamp, to get this item shown
5737 on the date where it applies.  This is a frequent misunderstanding by
5738 Org users.  In Org mode, @i{scheduling} means setting a date when you
5739 want to start working on an action item.
5740 @end table
5742 You may use timestamps with repeaters in scheduling and deadline
5743 entries.  Org mode will issue early and late warnings based on the
5744 assumption that the timestamp represents the @i{nearest instance} of
5745 the repeater.  However, the use of diary sexp entries like
5747 @code{<%%(org-float t 42)>}
5749 in scheduling and deadline timestamps is limited.  Org mode does not
5750 know enough about the internals of each sexp function to issue early and
5751 late warnings.  However, it will show the item on each day where the
5752 sexp entry matches.
5754 @menu
5755 * Inserting deadline/schedule::  Planning items
5756 * Repeated tasks::              Items that show up again and again
5757 @end menu
5759 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5760 @subsection Inserting deadlines or schedules
5762 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
5763 @samp{DEADLINE} dates are inserted on the line right below the headline.  Don't put
5764 any text between this line and the headline.} a deadline or to schedule
5765 an item:
5767 @table @kbd
5769 @orgcmd{C-c C-d,org-deadline}
5770 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will happen
5771 in the line directly following the headline.  Any CLOSED timestamp will be
5772 removed.  When called with a prefix arg, an existing deadline will be removed
5773 from the entry.  Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
5774 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5775 and @code{nologredeadline}}, a note will be taken when changing an existing
5776 deadline.
5778 @orgcmd{C-c C-s,org-schedule}
5779 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
5780 happen in the line directly following the headline.  Any CLOSED timestamp
5781 will be removed.  When called with a prefix argument, remove the scheduling
5782 date from the entry.  Depending on the variable
5783 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5784 keywords @code{logreschedule}, @code{lognotereschedule}, and
5785 @code{nologreschedule}}, a note will be taken when changing an existing
5786 scheduling time.
5788 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5789 @kindex k a
5790 @kindex k s
5791 Mark the current entry for agenda action.  After you have marked the entry
5792 like this, you can open the agenda or the calendar to find an appropriate
5793 date.  With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5794 schedule the marked item.
5796 @orgcmd{C-c / d,org-check-deadlines}
5797 @cindex sparse tree, for deadlines
5798 @vindex org-deadline-warning-days
5799 Create a sparse tree with all deadlines that are either past-due, or
5800 which will become due within @code{org-deadline-warning-days}.
5801 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
5802 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
5803 all deadlines due tomorrow.
5805 @orgcmd{C-c / b,org-check-before-date}
5806 Sparse tree for deadlines and scheduled items before a given date.
5808 @orgcmd{C-c / a,org-check-after-date}
5809 Sparse tree for deadlines and scheduled items after a given date.
5810 @end table
5812 Note that @code{org-schedule} and @code{org-deadline} supports
5813 setting the date by indicating a relative time: e.g. +1d will set
5814 the date to the next day after today, and --1w will set the date
5815 to the previous week before any current timestamp.
5817 @node Repeated tasks,  , Inserting deadline/schedule, Deadlines and scheduling
5818 @subsection Repeated tasks
5819 @cindex tasks, repeated
5820 @cindex repeated tasks
5822 Some tasks need to be repeated again and again.  Org mode helps to
5823 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5824 or plain timestamp.  In the following example
5825 @example
5826 ** TODO Pay the rent
5827    DEADLINE: <2005-10-01 Sat +1m>
5828 @end example
5829 @noindent
5830 the @code{+1m} is a repeater; the intended interpretation is that the task
5831 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5832 from that time.  If you need both a repeater and a special warning period in
5833 a deadline entry, the repeater should come first and the warning period last:
5834 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5836 @vindex org-todo-repeat-to-state
5837 Deadlines and scheduled items produce entries in the agenda when they are
5838 over-due, so it is important to be able to mark such an entry as completed
5839 once you have done so.  When you mark a DEADLINE or a SCHEDULE with the TODO
5840 keyword DONE, it will no longer produce entries in the agenda.  The problem
5841 with this is, however, that then also the @emph{next} instance of the
5842 repeated entry will not be active.  Org mode deals with this in the following
5843 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5844 shift the base date of the repeating timestamp by the repeater interval, and
5845 immediately set the entry state back to TODO@footnote{In fact, the target
5846 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5847 the variable @code{org-todo-repeat-to-state}.  If neither of these is
5848 specified, the target state defaults to the first state of the TODO state
5849 sequence.}.  In the example above, setting the state to DONE would actually
5850 switch the date like this:
5852 @example
5853 ** TODO Pay the rent
5854    DEADLINE: <2005-11-01 Tue +1m>
5855 @end example
5857 @vindex org-log-repeat
5858 A timestamp@footnote{You can change this using the option
5859 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5860 @code{lognoterepeat}, and @code{nologrepeat}.  With @code{lognoterepeat}, you
5861 will also be prompted for a note.} will be added under the deadline, to keep
5862 a record that you actually acted on the previous instance of this deadline.
5864 As a consequence of shifting the base date, this entry will no longer be
5865 visible in the agenda when checking past dates, but all future instances
5866 will be visible.
5868 With the @samp{+1m} cookie, the date shift will always be exactly one
5869 month.  So if you have not paid the rent for three months, marking this
5870 entry DONE will still keep it as an overdue deadline.  Depending on the
5871 task, this may not be the best way to handle it.  For example, if you
5872 forgot to call your father for 3 weeks, it does not make sense to call
5873 him 3 times in a single day to make up for it.  Finally, there are tasks
5874 like changing batteries which should always repeat a certain time
5875 @i{after} the last time you did it.  For these tasks, Org mode has
5876 special repeaters  @samp{++} and @samp{.+}.  For example:
5878 @example
5879 ** TODO Call Father
5880    DEADLINE: <2008-02-10 Sun ++1w>
5881    Marking this DONE will shift the date by at least one week,
5882    but also by as many weeks as it takes to get this date into
5883    the future.  However, it stays on a Sunday, even if you called
5884    and marked it done on Saturday.
5885 ** TODO Check the batteries in the smoke detectors
5886    DEADLINE: <2005-11-01 Tue .+1m>
5887    Marking this DONE will shift the date to one month after
5888    today.
5889 @end example
5891 You may have both scheduling and deadline information for a specific
5892 task---just make sure that the repeater intervals on both are the same.
5894 An alternative to using a repeater is to create a number of copies of a task
5895 subtree, with dates shifted in each copy.  The command @kbd{C-c C-x c} was
5896 created for this purpose, it is described in @ref{Structure editing}.
5899 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5900 @section Clocking work time
5901 @cindex clocking time
5902 @cindex time clocking
5904 Org mode allows you to clock the time you spend on specific tasks in a
5905 project.  When you start working on an item, you can start the clock.
5906 When you stop working on that task, or when you mark the task done, the
5907 clock is stopped and the corresponding time interval is recorded.  It
5908 also computes the total time spent on each subtree of a project.  And it
5909 remembers a history or tasks recently clocked, to that you can jump quickly
5910 between a number of tasks absorbing your time.
5912 To save the clock history across Emacs sessions, use
5913 @lisp
5914 (setq org-clock-persist 'history)
5915 (org-clock-persistence-insinuate)
5916 @end lisp
5917 When you clock into a new task after resuming Emacs, the incomplete
5918 clock@footnote{To resume the clock under the assumption that you have worked
5919 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5920 will be found (@pxref{Resolving idle time}) and you will be prompted about
5921 what to do with it.
5923 @menu
5924 * Clocking commands::           Starting and stopping a clock
5925 * The clock table::             Detailed reports
5926 * Resolving idle time::         Resolving time when you've been idle
5927 @end menu
5929 @node Clocking commands, The clock table, Clocking work time, Clocking work time
5930 @subsection Clocking commands
5932 @table @kbd
5933 @orgcmd{C-c C-x C-i,org-clock-in}
5934 @vindex org-clock-into-drawer
5935 @cindex property, LOG_INTO_DRAWER
5936 Start the clock on the current item (clock-in).  This inserts the CLOCK
5937 keyword together with a timestamp.  If this is not the first clocking of
5938 this item, the multiple CLOCK lines will be wrapped into a
5939 @code{:LOGBOOK:} drawer (see also the variable
5940 @code{org-clock-into-drawer}).  You can also overrule
5941 the setting of this variable for a subtree by setting a
5942 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
5943 When called with a @kbd{C-u} prefix argument,
5944 select the task from a list of recently clocked tasks.  With two @kbd{C-u
5945 C-u} prefixes, clock into the task at point and mark it as the default task.
5946 The default task will always be available when selecting a clocking task,
5947 with letter @kbd{d}.@*
5948 @cindex property: CLOCK_MODELINE_TOTAL
5949 @cindex property: LAST_REPEAT
5950 @vindex org-clock-modeline-total
5951 While the clock is running, the current clocking time is shown in the mode
5952 line, along with the title of the task.  The clock time shown will be all
5953 time ever clocked for this task and its children.  If the task has an effort
5954 estimate (@pxref{Effort estimates}), the mode line displays the current
5955 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5956 hook a function doing this to @code{org-clock-in-prepare-hook}.}  If the task
5957 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5958 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5959 will be shown.  More control over what time is shown can be exercised with
5960 the @code{CLOCK_MODELINE_TOTAL} property.  It may have the values
5961 @code{current} to show only the current clocking instance, @code{today} to
5962 show all time clocked on this tasks today (see also the variable
5963 @code{org-extend-today-until}), @code{all} to include all time, or
5964 @code{auto} which is the default@footnote{See also the variable
5965 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5966 mode line entry will pop up a menu with clocking options.
5968 @orgcmd{C-c C-x C-o,org-clock-out}
5969 @vindex org-log-note-clock-out
5970 Stop the clock (clock-out).  This inserts another timestamp at the same
5971 location where the clock was last started.  It also directly computes
5972 the resulting time in inserts it after the time range as @samp{=>
5973 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
5974 possibility to record an additional note together with the clock-out
5975 timestamp@footnote{The corresponding in-buffer setting is:
5976 @code{#+STARTUP: lognoteclock-out}}.
5977 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5978 Update the effort estimate for the current clock task.
5979 @kindex C-c C-y
5980 @kindex C-c C-c
5981 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
5982 Recompute the time interval after changing one of the timestamps.  This
5983 is only necessary if you edit the timestamps directly.  If you change
5984 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5985 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
5986 On @code{CLOCK} log lines, increase/decrease both timestamps at the same
5987 time so that duration keeps the same.
5988 @orgcmd{C-c C-t,org-todo}
5989 Changing the TODO state of an item to DONE automatically stops the clock
5990 if it is running in this same item.
5991 @orgcmd{C-c C-x C-x,org-clock-cancel}
5992 Cancel the current clock.  This is useful if a clock was started by
5993 mistake, or if you ended up working on something else.
5994 @orgcmd{C-c C-x C-j,org-clock-goto}
5995 Jump to the headline of the currently clocked in task.  With a @kbd{C-u}
5996 prefix arg, select the target task from a list of recently clocked tasks.
5997 @orgcmd{C-c C-x C-d,org-clock-display}
5998 @vindex org-remove-highlights-with-change
5999 Display time summaries for each subtree in the current buffer.  This puts
6000 overlays at the end of each headline, showing the total time recorded under
6001 that heading, including the time of any subheadings.  You can use visibility
6002 cycling to study the tree, but the overlays disappear when you change the
6003 buffer (see variable @code{org-remove-highlights-with-change}) or press
6004 @kbd{C-c C-c}.
6005 @end table
6007 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6008 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6009 worked on or closed during a day.
6011 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6012 @subsection The clock table
6013 @cindex clocktable, dynamic block
6014 @cindex report, of clocked time
6016 Org mode can produce quite complex reports based on the time clocking
6017 information.  Such a report is called a @emph{clock table}, because it is
6018 formatted as one or several Org tables.
6020 @table @kbd
6021 @orgcmd{C-c C-x C-r,org-clock-report}
6022 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6023 report as an Org mode table into the current file.  When the cursor is
6024 at an existing clock table, just update it.  When called with a prefix
6025 argument, jump to the first clock report in the current document and
6026 update it.  The clock table always includes also trees with
6027 @code{:ARCHIVE:} tag.
6028 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6029 Update dynamic block at point.  The cursor needs to be in the
6030 @code{#+BEGIN} line of the dynamic block.
6031 @orgkey{C-u C-c C-x C-u}
6032 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
6033 you have several clock table blocks in a buffer.
6034 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6035 Shift the current @code{:block} interval and update the table.  The cursor
6036 needs to be in the @code{#+BEGIN: clocktable} line for this command.  If
6037 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6038 @end table
6041 Here is an example of the frame for a clock table as it is inserted into the
6042 buffer with the @kbd{C-c C-x C-r} command:
6044 @cindex #+BEGIN, clocktable
6045 @example
6046 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6047 #+END: clocktable
6048 @end example
6049 @noindent
6050 @vindex org-clocktable-defaults
6051 The @samp{BEGIN} line and specify a number of options to define the scope,
6052 structure, and formatting of the report.  Defaults for all these options can
6053 be configured in the variable @code{org-clocktable-defaults}.
6055 @noindent First there are options that determine which clock entries are to
6056 be selected:
6057 @example
6058 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
6059              @r{Clocks at deeper levels will be summed into the upper level.}
6060 :scope       @r{The scope to consider.  This can be any of the following:}
6061              nil        @r{the current buffer or narrowed region}
6062              file       @r{the full current buffer}
6063              subtree    @r{the subtree where the clocktable is located}
6064              tree@var{N}      @r{the surrounding level @var{N} tree, for example @code{tree3}}
6065              tree       @r{the surrounding level 1 tree}
6066              agenda     @r{all agenda files}
6067              ("file"..) @r{scan these files}
6068              file-with-archives    @r{current file and its archives}
6069              agenda-with-archives  @r{all agenda files, including archives}
6070 :block       @r{The time block to consider.  This block is specified either}
6071              @r{absolute, or relative to the current time and may be any of}
6072              @r{these formats:}
6073              2007-12-31    @r{New year eve 2007}
6074              2007-12       @r{December 2007}
6075              2007-W50      @r{ISO-week 50 in 2007}
6076              2007-Q2       @r{2nd quarter in 2007}
6077              2007          @r{the year 2007}
6078              today, yesterday, today-@var{N}          @r{a relative day}
6079              thisweek, lastweek, thisweek-@var{N}     @r{a relative week}
6080              thismonth, lastmonth, thismonth-@var{N}  @r{a relative month}
6081              thisyear, lastyear, thisyear-@var{N}     @r{a relative year}
6082              @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6083 :tstart      @r{A time string specifying when to start considering times.}
6084 :tend        @r{A time string specifying when to stop considering times.}
6085 :step        @r{@code{week} or @code{day}, to split the table into chunks.}
6086              @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6087 :stepskip0   @r{Do not show steps that have zero time.}
6088 :fileskip0   @r{Do not show table sections from files which did not contribute.}
6089 :tags        @r{A tags match to select entries that should contribute.  See}
6090              @r{@ref{Matching tags and properties} for the match syntax.}
6091 @end example
6093 Then there are options which determine the formatting of the table.  There
6094 options are interpreted by the function @code{org-clocktable-write-default},
6095 but you can specify your own function using the @code{:formatter} parameter.
6096 @example
6097 :emphasize   @r{When @code{t}, emphasize level one and level two items.}
6098 :lang        @r{Language@footnote{Language terms can be set through the variable @code{org-clock-clocktable-language-setup}.} to use for descriptive cells like "Task".}
6099 :link        @r{Link the item headlines in the table to their origins.}
6100 :narrow      @r{An integer to limit the width of the headline column in}
6101              @r{the org table.  If you write it like @samp{50!}, then the}
6102              @r{headline will also be shortened in export.}
6103 :indent      @r{Indent each headline field according to its level.}
6104 :tcolumns    @r{Number of columns to be used for times.  If this is smaller}
6105              @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6106 :level       @r{Should a level number column be included?}
6107 :compact     @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6108              @r{All are overwritten except if there is an explicit @code{:narrow}}
6109 :timestamp   @r{A timestamp for the entry, when available.  Look for SCHEDULED,}
6110              @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6111 :properties  @r{List of properties that should be shown in the table.  Each}
6112              @r{property will get its own column.}
6113 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6114 :formula     @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6115              @r{As a special case, @samp{:formula %} adds a column with % time.}
6116              @r{If you do not specify a formula here, any existing formula}
6117              @r{below the clock table will survive updates and be evaluated.}
6118 :formatter   @r{A function to format clock data and insert it into the buffer.}
6119 @end example
6120 To get a clock summary of the current level 1 tree, for the current
6121 day, you could write
6122 @example
6123 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6124 #+END: clocktable
6125 @end example
6126 @noindent
6127 and to use a specific time range you could write@footnote{Note that all
6128 parameters must be specified in a single line---the line is broken here
6129 only to fit it into the manual.}
6130 @example
6131 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6132                     :tend "<2006-08-10 Thu 12:00>"
6133 #+END: clocktable
6134 @end example
6135 A summary of the current subtree with % times would be
6136 @example
6137 #+BEGIN: clocktable :scope subtree :link t :formula %
6138 #+END: clocktable
6139 @end example
6140 A horizontally compact representation of everything clocked during last week
6141 would be
6142 @example
6143 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6144 #+END: clocktable
6145 @end example
6147 @node Resolving idle time,  , The clock table, Clocking work time
6148 @subsection Resolving idle time
6149 @cindex resolve idle time
6151 @cindex idle, resolve, dangling
6152 If you clock in on a work item, and then walk away from your
6153 computer---perhaps to take a phone call---you often need to ``resolve'' the
6154 time you were away by either subtracting it from the current clock, or
6155 applying it to another one.
6157 @vindex org-clock-idle-time
6158 By customizing the variable @code{org-clock-idle-time} to some integer, such
6159 as 10 or 15, Emacs can alert you when you get back to your computer after
6160 being idle for that many minutes@footnote{On computers using Mac OS X,
6161 idleness is based on actual user idleness, not just Emacs' idle time.  For
6162 X11, you can install a utility program @file{x11idle.c}, available in the
6163 UTILITIES directory of the Org git distribution, to get the same general
6164 treatment of idleness.  On other systems, idle time refers to Emacs idle time
6165 only.}, and ask what you want to do with the idle time.  There will be a
6166 question waiting for you when you get back, indicating how much idle time has
6167 passed (constantly updated with the current amount), as well as a set of
6168 choices to correct the discrepancy:
6170 @table @kbd
6171 @item k
6172 To keep some or all of the minutes and stay clocked in, press @kbd{k}.  Org
6173 will ask how many of the minutes to keep.  Press @key{RET} to keep them all,
6174 effectively changing nothing, or enter a number to keep that many minutes.
6175 @item K
6176 If you use the shift key and press @kbd{K}, it will keep however many minutes
6177 you request and then immediately clock out of that task.  If you keep all of
6178 the minutes, this is the same as just clocking out of the current task.
6179 @item s
6180 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6181 the clock, and then check back in from the moment you returned.
6182 @item S
6183 To keep none of the minutes and just clock out at the start of the away time,
6184 use the shift key and press @kbd{S}.  Remember that using shift will always
6185 leave you clocked out, no matter which option you choose.
6186 @item C
6187 To cancel the clock altogether, use @kbd{C}.  Note that if instead of
6188 canceling you subtract the away time, and the resulting clock amount is less
6189 than a minute, the clock will still be canceled rather than clutter up the
6190 log with an empty entry.
6191 @end table
6193 What if you subtracted those away minutes from the current clock, and now
6194 want to apply them to a new clock?  Simply clock in to any task immediately
6195 after the subtraction.  Org will notice that you have subtracted time ``on
6196 the books'', so to speak, and will ask if you want to apply those minutes to
6197 the next task you clock in on.
6199 There is one other instance when this clock resolution magic occurs.  Say you
6200 were clocked in and hacking away, and suddenly your cat chased a mouse who
6201 scared a hamster that crashed into your UPS's power button!  You suddenly
6202 lose all your buffers, but thanks to auto-save you still have your recent Org
6203 mode changes, including your last clock in.
6205 If you restart Emacs and clock into any task, Org will notice that you have a
6206 dangling clock which was never clocked out from your last session.  Using
6207 that clock's starting time as the beginning of the unaccounted-for period,
6208 Org will ask how you want to resolve that time.  The logic and behavior is
6209 identical to dealing with away time due to idleness; it is just happening due
6210 to a recovery event rather than a set amount of idle time.
6212 You can also check all the files visited by your Org agenda for dangling
6213 clocks at any time using @kbd{M-x org-resolve-clocks}.
6215 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6216 @section Effort estimates
6217 @cindex effort estimates
6219 @cindex property, Effort
6220 @vindex org-effort-property
6221 If you want to plan your work in a very detailed way, or if you need to
6222 produce offers with quotations of the estimated work effort, you may want to
6223 assign effort estimates to entries.  If you are also clocking your work, you
6224 may later want to compare the planned effort with the actual working time, a
6225 great way to improve planning estimates.  Effort estimates are stored in a
6226 special property @samp{Effort}@footnote{You may change the property being
6227 used with the variable @code{org-effort-property}.}.  You can set the effort
6228 for an entry with the following commands:
6230 @table @kbd
6231 @orgcmd{C-c C-x e,org-set-effort}
6232 Set the effort estimate for the current entry.  With a numeric prefix
6233 argument, set it to the Nth allowed value (see below).  This command is also
6234 accessible from the agenda with the @kbd{e} key.
6235 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6236 Modify the effort estimate of the item currently being clocked.
6237 @end table
6239 Clearly the best way to work with effort estimates is through column view
6240 (@pxref{Column view}).  You should start by setting up discrete values for
6241 effort estimates, and a @code{COLUMNS} format that displays these values
6242 together with clock sums (if you want to clock your time).  For a specific
6243 buffer you can use
6245 @example
6246 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6247 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6248 @end example
6250 @noindent
6251 @vindex org-global-properties
6252 @vindex org-columns-default-format
6253 or, even better, you can set up these values globally by customizing the
6254 variables @code{org-global-properties} and @code{org-columns-default-format}.
6255 In particular if you want to use this setup also in the agenda, a global
6256 setup may be advised.
6258 The way to assign estimates to individual items is then to switch to column
6259 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6260 value.  The values you enter will immediately be summed up in the hierarchy.
6261 In the column next to it, any clocked time will be displayed.
6263 @vindex org-agenda-columns-add-appointments-to-effort-sum
6264 If you switch to column view in the daily/weekly agenda, the effort column
6265 will summarize the estimated work effort for each day@footnote{Please note
6266 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6267 column view}).}, and you can use this to find space in your schedule.  To get
6268 an overview of the entire part of the day that is committed, you can set the
6269 option @code{org-agenda-columns-add-appointments-to-effort-sum}.  The
6270 appointments on a day that take place over a specified time interval will
6271 then also be added to the load estimate of the day.
6273 Effort estimates can be used in secondary agenda filtering that is triggered
6274 with the @kbd{/} key in the agenda (@pxref{Agenda commands}).  If you have
6275 these estimates defined consistently, two or three key presses will narrow
6276 down the list to stuff that fits into an available time slot.
6278 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6279 @section Taking notes with a relative timer
6280 @cindex relative timer
6282 When taking notes during, for example, a meeting or a video viewing, it can
6283 be useful to have access to times relative to a starting time.  Org provides
6284 such a relative timer and make it easy to create timed notes.
6286 @table @kbd
6287 @orgcmd{C-c C-x .,org-timer}
6288 Insert a relative time into the buffer.  The first time you use this, the
6289 timer will be started.  When called with a prefix argument, the timer is
6290 restarted.
6291 @orgcmd{C-c C-x -,org-timer-item}
6292 Insert a description list item with the current relative time.  With a prefix
6293 argument, first reset the timer to 0.
6294 @orgcmd{M-@key{RET},org-insert-heading}
6295 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6296 new timer items.
6297 @c for key sequences with a comma, command name macros fail :(
6298 @kindex C-c C-x ,
6299 @item C-c C-x ,
6300 Pause the timer, or continue it if it is already paused
6301 (@command{org-timer-pause-or-continue}).
6302 @c removed the sentence because it is redundant to the following item
6303 @kindex C-u C-c C-x ,
6304 @item C-u C-c C-x ,
6305 Stop the timer.  After this, you can only start a new timer, not continue the
6306 old one.  This command also removes the timer from the mode line.
6307 @orgcmd{C-c C-x 0,org-timer-start}
6308 Reset the timer without inserting anything into the buffer.  By default, the
6309 timer is reset to 0.  When called with a @kbd{C-u} prefix, reset the timer to
6310 specific starting offset.  The user is prompted for the offset, with a
6311 default taken from a timer string at point, if any, So this can be used to
6312 restart taking notes after a break in the process.  When called with a double
6313 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6314 by a certain amount.  This can be used to fix timer strings if the timer was
6315 not started at exactly the right moment.
6316 @end table
6318 @node Countdown timer,  , Relative timer, Dates and Times
6319 @section Countdown timer
6320 @cindex Countdown timer
6321 @kindex C-c C-x ;
6322 @kindex ;
6324 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6325 timer.  Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everwhere else.
6327 @code{org-timer-set-timer} prompts the user for a duration and displays a
6328 countdown timer in the modeline.  @code{org-timer-default-timer} sets the
6329 default countdown value.  Giving a prefix numeric argument overrides this
6330 default value.
6332 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6333 @chapter Capture - Refile - Archive
6334 @cindex capture
6336 An important part of any organization system is the ability to quickly
6337 capture new ideas and tasks, and to associate reference material with them.
6338 Org does this using a process called @i{capture}.  It also can store files
6339 related to a task (@i{attachments}) in a special directory.  Once in the
6340 system, tasks and projects need to be moved around.  Moving completed project
6341 trees to an archive file keeps the system compact and fast.
6343 @menu
6344 * Capture::                     Capturing new stuff
6345 * Attachments::                 Add files to tasks
6346 * RSS Feeds::                   Getting input from RSS feeds
6347 * Protocols::                   External (e.g.@: Browser) access to Emacs and Org
6348 * Refiling notes::              Moving a tree from one place to another
6349 * Archiving::                   What to do with finished projects
6350 @end menu
6352 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6353 @section Capture
6354 @cindex capture
6356 Org's method for capturing new items is heavily inspired by John Wiegley
6357 excellent remember package.  Up to version 6.36 Org used a special setup
6358 for @file{remember.el}.  @file{org-remember.el} is still part of Org mode for
6359 backward compatibility with existing setups.  You can find the documentation
6360 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6362 The new capturing setup described here is preferred and should be used by new
6363 users.  To convert your @code{org-remember-templates}, run the command
6364 @example
6365 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6366 @end example
6367 @noindent and then customize the new variable with @kbd{M-x
6368 customize-variable org-capture-templates}, check the result, and save the
6369 customization.  You can then use both remember and capture until
6370 you are familiar with the new mechanism.
6372 Capture lets you quickly store notes with little interruption of your work
6373 flow.  The basic process of capturing is very similar to remember, but Org
6374 does enhance it with templates and more.
6376 @menu
6377 * Setting up capture::          Where notes will be stored
6378 * Using capture::               Commands to invoke and terminate capture
6379 * Capture templates::           Define the outline of different note types
6380 @end menu
6382 @node Setting up capture, Using capture, Capture, Capture
6383 @subsection Setting up capture
6385 The following customization sets a default target file for notes, and defines
6386 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6387 suggestion.}  for capturing new material.
6389 @vindex org-default-notes-file
6390 @example
6391 (setq org-default-notes-file (concat org-directory "/notes.org"))
6392 (define-key global-map "\C-cc" 'org-capture)
6393 @end example
6395 @node Using capture, Capture templates, Setting up capture, Capture
6396 @subsection Using capture
6398 @table @kbd
6399 @orgcmd{C-c c,org-capture}
6400 Call the command @code{org-capture}.  Note that this keybinding is global and
6401 not active by default - you need to install it.  If you have templates
6402 @cindex date tree
6403 defined @pxref{Capture templates}, it will offer these templates for
6404 selection or use a new Org outline node as the default template.  It will
6405 insert the template into the target file and switch to an indirect buffer
6406 narrowed to this new node.  You may then insert the information you want.
6408 @orgcmd{C-c C-c,org-capture-finalize}
6409 Once you have finished entering information into the capture buffer, @kbd{C-c
6410 C-c} will return you to the window configuration before the capture process,
6411 so that you can resume your work without further distraction.  When called
6412 with a prefix arg, finalize and then jump to the captured item.
6414 @orgcmd{C-c C-w,org-capture-refile}
6415 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6416 a different place.  Please realize that this is a normal refiling command
6417 that will be executed---so the cursor position at the moment you run this
6418 command is important.  If you have inserted a tree with a parent and
6419 children, first move the cursor back to the parent.  Any prefix argument
6420 given to this command will be passed on to the @code{org-refile} command.
6422 @orgcmd{C-c C-k,org-capture-kill}
6423 Abort the capture process and return to the previous state.
6425 @end table
6427 You can also call @code{org-capture} in a special way from the agenda, using
6428 the @kbd{k c} key combination.  With this access, any timestamps inserted by
6429 the selected capture template will default to the cursor date in the agenda,
6430 rather than to the current date.
6432 To find the locations of the last stored capture, use @code{org-capture} with
6433 prefix commands:
6435 @table @kbd
6436 @orgkey{C-u C-c c}
6437 Visit the target location of a capture template.  You get to select the
6438 template in the usual way.
6439 @orgkey{C-u C-u C-c c}
6440 Visit the last stored capture item in its buffer.
6441 @end table
6443 @node Capture templates,  , Using capture, Capture
6444 @subsection Capture templates
6445 @cindex templates, for Capture
6447 You can use templates for different types of capture items, and
6448 for different target locations.  The easiest way to create such templates is
6449 through the customize interface.
6451 @table @kbd
6452 @orgkey{C-c c C}
6453 Customize the variable @code{org-capture-templates}.
6454 @end table
6456 Before we give the formal description of template definitions, let's look at
6457 an example.  Say you would like to use one template to create general TODO
6458 entries, and you want to put these entries under the heading @samp{Tasks} in
6459 your file @file{~/org/gtd.org}.  Also, a date tree in the file
6460 @file{journal.org} should capture journal entries.  A possible configuration
6461 would look like:
6463 @example
6464 (setq org-capture-templates
6465  '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6466         "* TODO %?\n  %i\n  %a")
6467    ("j" "Journal" entry (file+datetree "~/org/journal.org")
6468         "* %?\nEntered on %U\n  %i\n  %a")))
6469 @end example
6471 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6472 for you like this:
6473 @example
6474 * TODO
6475   [[file:@var{link to where you initiated capture}]]
6476 @end example
6478 @noindent
6479 During expansion of the template, @code{%a} has been replaced by a link to
6480 the location from where you called the capture command.  This can be
6481 extremely useful for deriving tasks from emails, for example.  You fill in
6482 the task definition, press @code{C-c C-c} and Org returns you to the same
6483 place where you started the capture process.
6485 To define special keys to capture to a particular template without going
6486 through the interactive template selection, you can create your key binding
6487 like this:
6489 @lisp
6490 (define-key global-map "\C-cx"
6491    (lambda () (interactive) (org-capture nil "x")))
6492 @end lisp
6494 @menu
6495 * Template elements::           What is needed for a complete template entry
6496 * Template expansion::          Filling in information about time and context
6497 @end menu
6499 @node Template elements, Template expansion, Capture templates, Capture templates
6500 @subsubsection Template elements
6502 Now lets look at the elements of a template definition.  Each entry in
6503 @code{org-capture-templates} is a list with the following items:
6505 @table @var
6506 @item keys
6507 The keys that will select the template, as a string, characters
6508 only, for example @code{"a"} for a template to be selected with a
6509 single key, or @code{"bt"} for selection with two keys.  When using
6510 several keys, keys using the same prefix key must be sequential
6511 in the list and preceded by a 2-element entry explaining the
6512 prefix key, for example
6513 @example
6514          ("b" "Templates for marking stuff to buy")
6515 @end example
6516 @noindent If you do not define a template for the @kbd{C} key, this key will
6517 be used to open the customize buffer for this complex variable.
6519 @item description
6520 A short string describing the template, which will be shown during
6521 selection.
6523 @item type
6524 The type of entry, a symbol.  Valid values are:
6525 @table @code
6526 @item entry
6527 An Org mode node, with a headline.  Will be filed as the child of the target
6528 entry or as a top-level entry.  The target file should be an Org mode file.
6529 @item item
6530 A plain list item, placed in the first plain  list at the target
6531 location.  Again the target file should be an Org file.
6532 @item checkitem
6533 A checkbox item.  This only differs from the plain list item by the
6534 default template.
6535 @item table-line
6536 a new line in the first table at the target location.  Where exactly the
6537 line will be inserted depends on the properties @code{:prepend} and
6538 @code{:table-line-pos} (see below).
6539 @item plain
6540 Text to be inserted as it is.
6541 @end table
6543 @item target
6544 @vindex org-default-notes-file
6545 Specification of where the captured item should be placed.  In Org mode
6546 files, targets usually define a node.  Entries will become children of this
6547 node.  Other types will be added to the table or list in the body of this
6548 node.  Most target specifications contain a file name.  If that file name is
6549 the empty string, it defaults to @code{org-default-notes-file}.  A file can
6550 also be given as a variable, function, or Emacs Lisp form.
6552 Valid values are:
6553 @table @code
6554 @item (file "path/to/file")
6555 Text will be placed at the beginning or end of that file.
6557 @item (id "id of existing org entry")
6558 Filing as child of this entry, or in the body of the entry.
6560 @item (file+headline "path/to/file" "node headline")
6561 Fast configuration if the target heading is unique in the file.
6563 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6564 For non-unique headings, the full path is safer.
6566 @item (file+regexp  "path/to/file" "regexp to find location")
6567 Use a regular expression to position the cursor.
6569 @item (file+datetree "path/to/file")
6570 Will create a heading in a date tree for today's date.
6572 @item (file+datetree+prompt "path/to/file")
6573 Will create a heading in a date tree, but will prompt for the date.
6575 @item (file+function "path/to/file" function-finding-location)
6576 A function to find the right location in the file.
6578 @item (clock)
6579 File to the entry that is currently being clocked.
6581 @item (function function-finding-location)
6582 Most general way, write your own function to find both
6583 file and location.
6584 @end table
6586 @item template
6587 The template for creating the capture item.  If you leave this empty, an
6588 appropriate default template will be used.  Otherwise this is a string with
6589 escape codes, which will be replaced depending on time and context of the
6590 capture call.  The string with escapes may be loaded from a template file,
6591 using the special syntax @code{(file "path/to/template")}.  See below for
6592 more details.
6594 @item properties
6595 The rest of the entry is a property list of additional options.
6596 Recognized properties are:
6597 @table @code
6598 @item :prepend
6599 Normally new captured information will be appended at
6600 the target location (last child, last table line, last list item...).
6601 Setting this property will change that.
6603 @item :immediate-finish
6604 When set, do not offer to edit the information, just
6605 file it away immediately.  This makes sense if the template only needs
6606 information that can be added automatically.
6608 @item :empty-lines
6609 Set this to the number of lines to insert
6610 before and after the new item.  Default 0, only common other value is 1.
6612 @item :clock-in
6613 Start the clock in this item.
6615 @item :clock-keep
6616 Keep the clock running when filing the captured entry.
6618 @item :clock-resume
6619 If starting the capture interrupted a clock, restart that clock when finished
6620 with the capture.  Note that @code{:clock-keep} has precedence over
6621 @code{:clock-resume}.  When setting both to @code{t}, the current clock will
6622 run and the previous one will not be resumed.
6624 @item :unnarrowed
6625 Do not narrow the target buffer, simply show the full buffer.  Default is to
6626 narrow it so that you only see the new material.
6628 @item :table-line-pos
6629 Specification of the location in the table where the new line should be
6630 inserted.  It should be a string like @code{"II-3"} meaning that the new
6631 line should become the third line before the second horizontal separator
6632 line.
6634 @item :kill-buffer
6635 If the target file was not yet visited when capture was invoked, kill the
6636 buffer again after capture is completed.
6637 @end table
6638 @end table
6640 @node Template expansion,  , Template elements, Capture templates
6641 @subsubsection Template expansion
6643 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6644 these sequences literally, escape the @kbd{%} with a backslash.}  allow
6645 dynamic insertion of content.  The templates are expanded in the order given here:
6647 @smallexample
6648 %[@var{file}]     @r{insert the contents of the file given by @var{file}.}
6649 %(@var{sexp})     @r{evaluate Elisp @var{sexp} and replace with the result.}
6650 %<...>      @r{the result of format-time-string on the ... format specification.}
6651 %t          @r{timestamp, date only.}
6652 %T          @r{timestamp with date and time.}
6653 %u, %U      @r{like the above, but inactive timestamps.}
6654 %a          @r{annotation, normally the link created with @code{org-store-link}.}
6655 %i          @r{initial content, the region when capture is called while the}
6656             @r{region is active.}
6657             @r{The entire text will be indented like @code{%i} itself.}
6658 %A          @r{like @code{%a}, but prompt for the description part.}
6659 %c          @r{Current kill ring head.}
6660 %x          @r{Content of the X clipboard.}
6661 %k          @r{title of the currently clocked task.}
6662 %K          @r{link to the currently clocked task.}
6663 %n          @r{user name (taken from @code{user-full-name}).}
6664 %f          @r{file visited by current buffer when org-capture was called.}
6665 %F          @r{full path of the file or directory visited by current buffer.}
6666 %:keyword   @r{specific information for certain link types, see below.}
6667 %^g         @r{prompt for tags, with completion on tags in target file.}
6668 %^G         @r{prompt for tags, with completion all tags in all agenda files.}
6669 %^t         @r{like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
6670             @r{You may define a prompt like @code{%^@{Birthday@}t}.}
6671 %^C         @r{Interactive selection of which kill or clip to use.}
6672 %^L         @r{Like @code{%^C}, but insert as link.}
6673 %^@{@var{prop}@}p   @r{Prompt the user for a value for property @var{prop}.}
6674 %^@{@var{prompt}@}  @r{prompt the user for a string and replace this sequence with it.}
6675             @r{You may specify a default value and a completion table with}
6676             @r{%^@{prompt|default|completion2|completion3...@}.}
6677             @r{The arrow keys access a prompt-specific history.}
6678 @end smallexample
6680 @noindent
6681 For specific link types, the following keywords will be
6682 defined@footnote{If you define your own link types (@pxref{Adding
6683 hyperlink types}), any property you store with
6684 @code{org-store-link-props} can be accessed in capture templates in a
6685 similar way.}:
6687 @vindex org-from-is-user-regexp
6688 @smallexample
6689 Link type               |  Available keywords
6690 ------------------------+----------------------------------------------
6691 bbdb                    |  %:name %:company
6692 irc                     |  %:server %:port %:nick
6693 vm, wl, mh, mew, rmail  |  %:type %:subject %:message-id
6694                         |  %:from %:fromname %:fromaddress
6695                         |  %:to   %:toname   %:toaddress
6696                         |  %:date @r{(message date header field)}
6697                         |  %:date-timestamp @r{(date as active timestamp)}
6698                         |  %:date-timestamp-inactive @r{(date as inactive timestamp)}
6699                         |  %:fromto @r{(either "to NAME" or "from NAME")@footnote{This will always be the other, not the user.  See the variable @code{org-from-is-user-regexp}.}}
6700 gnus                    |  %:group, @r{for messages also all email fields}
6701 w3, w3m                 |  %:url
6702 info                    |  %:file %:node
6703 calendar                |  %:date
6704 @end smallexample
6706 @noindent
6707 To place the cursor after template expansion use:
6709 @smallexample
6710 %?          @r{After completing the template, position cursor here.}
6711 @end smallexample
6714 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6715 @section Attachments
6716 @cindex attachments
6718 @vindex org-attach-directory
6719 It is often useful to associate reference material with an outline node/task.
6720 Small chunks of plain text can simply be stored in the subtree of a project.
6721 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6722 files that live elsewhere on your computer or in the cloud, like emails or
6723 source code files belonging to a project.  Another method is @i{attachments},
6724 which are files located in a directory belonging to an outline node.  Org
6725 uses directories named by the unique ID of each entry.  These directories are
6726 located in the @file{data} directory which lives in the same directory where
6727 your Org file lives@footnote{If you move entries or Org files from one
6728 directory to another, you may want to configure @code{org-attach-directory}
6729 to contain an absolute path.}.  If you initialize this directory with
6730 @code{git init}, Org will automatically commit changes when it sees them.
6731 The attachment system has been contributed to Org by John Wiegley.
6733 In cases where it seems better to do so, you can also attach a directory of your
6734 choice to an entry.  You can also make children inherit the attachment
6735 directory from a parent, so that an entire subtree uses the same attached
6736 directory.
6738 @noindent The following commands deal with attachments:
6740 @table @kbd
6742 @orgcmd{C-c C-a,org-attach}
6743 The dispatcher for commands related to the attachment system.  After these
6744 keys, a list of commands is displayed and you must press an additional key
6745 to select a command:
6747 @table @kbd
6748 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6749 @vindex org-attach-method
6750 Select a file and move it into the task's attachment directory.  The file
6751 will be copied, moved, or linked, depending on @code{org-attach-method}.
6752 Note that hard links are not supported on all systems.
6754 @kindex C-c C-a c
6755 @kindex C-c C-a m
6756 @kindex C-c C-a l
6757 @item c/m/l
6758 Attach a file using the copy/move/link method.
6759 Note that hard links are not supported on all systems.
6761 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6762 Create a new attachment as an Emacs buffer.
6764 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6765 Synchronize the current task with its attachment directory, in case you added
6766 attachments yourself.
6768 @orgcmdtkc{o,C-c C-a o,org-attach-open}
6769 @vindex org-file-apps
6770 Open current task's attachment.  If there is more than one, prompt for a
6771 file name first.  Opening will follow the rules set by @code{org-file-apps}.
6772 For more details, see the information on following hyperlinks
6773 (@pxref{Handling links}).
6775 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6776 Also open the attachment, but force opening the file in Emacs.
6778 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6779 Open the current task's attachment directory.
6781 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6782 Also open the directory, but force using @command{dired} in Emacs.
6784 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6785 Select and delete a single attachment.
6787 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6788 Delete all of a task's attachments.  A safer way is to open the directory in
6789 @command{dired} and delete from there.
6791 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6792 @cindex property, ATTACH_DIR
6793 Set a specific directory as the entry's attachment directory.  This works by
6794 putting the directory path into the @code{ATTACH_DIR} property.
6796 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6797 @cindex property, ATTACH_DIR_INHERIT
6798 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6799 same directory for attachments as the parent does.
6800 @end table
6801 @end table
6803 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6804 @section RSS feeds
6805 @cindex RSS feeds
6806 @cindex Atom feeds
6808 Org can add and change entries based on information found in RSS feeds and
6809 Atom feeds.  You could use this to make a task out of each new podcast in a
6810 podcast feed.  Or you could use a phone-based note-creating service on the
6811 web to import tasks into Org.  To access feeds, configure the variable
6812 @code{org-feed-alist}.  The docstring of this variable has detailed
6813 information.  Here is just an example:
6815 @example
6816 (setq org-feed-alist
6817      '(("Slashdot"
6818          "http://rss.slashdot.org/Slashdot/slashdot"
6819          "~/txt/org/feeds.org" "Slashdot Entries")))
6820 @end example
6822 @noindent
6823 will configure that new items from the feed provided by
6824 @code{rss.slashdot.org} will result in new entries in the file
6825 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6826 the following command is used:
6828 @table @kbd
6829 @orgcmd{C-c C-x g,org-feed-update-all}
6830 @item C-c C-x g
6831 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6832 them.
6833 @orgcmd{C-c C-x G,org-feed-goto-inbox}
6834 Prompt for a feed name and go to the inbox configured for this feed.
6835 @end table
6837 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6838 it will store information about the status of items in the feed, to avoid
6839 adding the same item several times.  You should add @samp{FEEDSTATUS} to the
6840 list of drawers in that file:
6842 @example
6843 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6844 @end example
6846 For more information, including how to read atom feeds, see
6847 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6849 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6850 @section Protocols for external access
6851 @cindex protocols, for external access
6852 @cindex emacsserver
6854 You can set up Org for handling protocol calls from outside applications that
6855 are passed to Emacs through the @file{emacsserver}.  For example, you can
6856 configure bookmarks in your web browser to send a link to the current page to
6857 Org and create a note from it using capture (@pxref{Capture}).  Or you
6858 could create a bookmark that will tell Emacs to open the local source file of
6859 a remote website you are looking at with the browser.  See
6860 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6861 documentation and setup instructions.
6863 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6864 @section Refiling notes
6865 @cindex refiling notes
6867 When reviewing the captured data, you may want to refile some of the entries
6868 into a different list, for example into a project.  Cutting, finding the
6869 right location, and then pasting the note is cumbersome.  To simplify this
6870 process, you can use the following special command:
6872 @table @kbd
6873 @orgcmd{C-c C-w,org-refile}
6874 @vindex org-reverse-note-order
6875 @vindex org-refile-targets
6876 @vindex org-refile-use-outline-path
6877 @vindex org-outline-path-complete-in-steps
6878 @vindex org-refile-allow-creating-parent-nodes
6879 @vindex org-log-refile
6880 @vindex org-refile-use-cache
6881 Refile the entry or region at point.  This command offers possible locations
6882 for refiling the entry and lets you select one with completion.  The item (or
6883 all items in the region) is filed below the target heading as a subitem.
6884 Depending on @code{org-reverse-note-order}, it will be either the first or
6885 last subitem.@*
6886 By default, all level 1 headlines in the current buffer are considered to be
6887 targets, but you can have more complex definitions across a number of files.
6888 See the variable @code{org-refile-targets} for details.  If you would like to
6889 select a location via a file-path-like completion along the outline path, see
6890 the variables @code{org-refile-use-outline-path} and
6891 @code{org-outline-path-complete-in-steps}.  If you would like to be able to
6892 create new nodes as new parents for refiling on the fly, check the
6893 variable @code{org-refile-allow-creating-parent-nodes}.
6894 When the variable @code{org-log-refile}@footnote{with corresponding
6895 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6896 and @code{nologrefile}} is set, a timestamp or a note will be
6897 recorded when an entry has been refiled.
6898 @orgkey{C-u C-c C-w}
6899 Use the refile interface to jump to a heading.
6900 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
6901 Jump to the location where @code{org-refile} last moved a tree to.
6902 @item C-2 C-c C-w
6903 Refile as the child of the item currently being clocked.
6904 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6906 @orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C-w,org-refile-cache-clear}
6908 Clear the target cache.  Caching of refile targets can be turned on by
6909 setting @code{org-refile-use-cache}.  To make the command see new possible
6910 targets, you have to clear the cache with this command.
6911 @end table
6913 @node Archiving,  , Refiling notes, Capture - Refile - Archive
6914 @section Archiving
6915 @cindex archiving
6917 When a project represented by a (sub)tree is finished, you may want
6918 to move the tree out of the way and to stop it from contributing to the
6919 agenda.  Archiving is important to keep your working files compact and global
6920 searches like the construction of agenda views fast.
6922 @table @kbd
6923 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
6924 @vindex org-archive-default-command
6925 Archive the current entry using the command specified in the variable
6926 @code{org-archive-default-command}.
6927 @end table
6929 @menu
6930 * Moving subtrees::             Moving a tree to an archive file
6931 * Internal archiving::          Switch off a tree but keep it in the file
6932 @end menu
6934 @node Moving subtrees, Internal archiving, Archiving, Archiving
6935 @subsection Moving a tree to the archive file
6936 @cindex external archiving
6938 The most common archiving action is to move a project tree to another file,
6939 the archive file.
6941 @table @kbd
6942 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
6943 @vindex org-archive-location
6944 Archive the subtree starting at the cursor position to the location
6945 given by @code{org-archive-location}.
6946 @orgkey{C-u C-c C-x C-s}
6947 Check if any direct children of the current headline could be moved to
6948 the archive.  To do this, each subtree is checked for open TODO entries.
6949 If none are found, the command offers to move it to the archive
6950 location.  If the cursor is @emph{not} on a headline when this command
6951 is invoked, the level 1 trees will be checked.
6952 @end table
6954 @cindex archive locations
6955 The default archive location is a file in the same directory as the
6956 current file, with the name derived by appending @file{_archive} to the
6957 current file name.  For information and examples on how to change this,
6958 see the documentation string of the variable
6959 @code{org-archive-location}.  There is also an in-buffer option for
6960 setting this variable, for example@footnote{For backward compatibility,
6961 the following also works: If there are several such lines in a file,
6962 each specifies the archive location for the text below it.  The first
6963 such line also applies to any text before its definition.  However,
6964 using this method is @emph{strongly} deprecated as it is incompatible
6965 with the outline structure of the document.  The correct method for
6966 setting multiple archive locations in a buffer is using properties.}:
6968 @cindex #+ARCHIVE
6969 @example
6970 #+ARCHIVE: %s_done::
6971 @end example
6973 @cindex property, ARCHIVE
6974 @noindent
6975 If you would like to have a special ARCHIVE location for a single entry
6976 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6977 location as the value (@pxref{Properties and Columns}).
6979 @vindex org-archive-save-context-info
6980 When a subtree is moved, it receives a number of special properties that
6981 record context information like the file from where the entry came, its
6982 outline path the archiving time etc.  Configure the variable
6983 @code{org-archive-save-context-info} to adjust the amount of information
6984 added.
6987 @node Internal archiving,  , Moving subtrees, Archiving
6988 @subsection Internal archiving
6990 If you want to just switch off (for agenda views) certain subtrees without
6991 moving them to a different file, you can use the @code{ARCHIVE tag}.
6993 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6994 its location in the outline tree, but behaves in the following way:
6995 @itemize @minus
6996 @item
6997 @vindex org-cycle-open-archived-trees
6998 It does not open when you attempt to do so with a visibility cycling
6999 command (@pxref{Visibility cycling}).  You can force cycling archived
7000 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7001 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
7002 @code{show-all} will open archived subtrees.
7003 @item
7004 @vindex org-sparse-tree-open-archived-trees
7005 During sparse tree construction (@pxref{Sparse trees}), matches in
7006 archived subtrees are not exposed, unless you configure the option
7007 @code{org-sparse-tree-open-archived-trees}.
7008 @item
7009 @vindex org-agenda-skip-archived-trees
7010 During agenda view construction (@pxref{Agenda Views}), the content of
7011 archived trees is ignored unless you configure the option
7012 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7013 be included.  In the agenda you can press @kbd{v a} to get archives
7014 temporarily included.
7015 @item
7016 @vindex org-export-with-archived-trees
7017 Archived trees are not exported (@pxref{Exporting}), only the headline
7018 is.  Configure the details using the variable
7019 @code{org-export-with-archived-trees}.
7020 @item
7021 @vindex org-columns-skip-archived-trees
7022 Archived trees are excluded from column view unless the variable
7023 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7024 @end itemize
7026 The following commands help manage the ARCHIVE tag:
7028 @table @kbd
7029 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7030 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
7031 the headline changes to a shadowed face, and the subtree below it is
7032 hidden.
7033 @orgkey{C-u C-c C-x a}
7034 Check if any direct children of the current headline should be archived.
7035 To do this, each subtree is checked for open TODO entries.  If none are
7036 found, the command offers to set the ARCHIVE tag for the child.  If the
7037 cursor is @emph{not} on a headline when this command is invoked, the
7038 level 1 trees will be checked.
7039 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7040 Cycle a tree even if it is tagged with ARCHIVE.
7041 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7042 Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
7043 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}.  The
7044 entry becomes a child of that sibling and in this way retains a lot of its
7045 original context, including inherited tags and approximate position in the
7046 outline.
7047 @end table
7050 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7051 @chapter Agenda views
7052 @cindex agenda views
7054 Due to the way Org works, TODO items, time-stamped items, and
7055 tagged headlines can be scattered throughout a file or even a number of
7056 files.  To get an overview of open action items, or of events that are
7057 important for a particular date, this information must be collected,
7058 sorted and displayed in an organized way.
7060 Org can select items based on various criteria and display them
7061 in a separate buffer.  Seven different view types are provided:
7063 @itemize @bullet
7064 @item
7065 an @emph{agenda} that is like a calendar and shows information
7066 for specific dates,
7067 @item
7068 a @emph{TODO list} that covers all unfinished
7069 action items,
7070 @item
7071 a @emph{match view}, showings headlines based on the tags, properties, and
7072 TODO state associated with them,
7073 @item
7074 a @emph{timeline view} that shows all events in a single Org file,
7075 in time-sorted view,
7076 @item
7077 a @emph{text search view} that shows all entries from multiple files
7078 that contain specified keywords,
7079 @item
7080 a @emph{stuck projects view} showing projects that currently don't move
7081 along, and
7082 @item
7083 @emph{custom views} that are special searches and combinations of different
7084 views.
7085 @end itemize
7087 @noindent
7088 The extracted information is displayed in a special @emph{agenda
7089 buffer}.  This buffer is read-only, but provides commands to visit the
7090 corresponding locations in the original Org files, and even to
7091 edit these files remotely.
7093 @vindex org-agenda-window-setup
7094 @vindex org-agenda-restore-windows-after-quit
7095 Two variables control how the agenda buffer is displayed and whether the
7096 window configuration is restored when the agenda exits:
7097 @code{org-agenda-window-setup} and
7098 @code{org-agenda-restore-windows-after-quit}.
7100 @menu
7101 * Agenda files::                Files being searched for agenda information
7102 * Agenda dispatcher::           Keyboard access to agenda views
7103 * Built-in agenda views::       What is available out of the box?
7104 * Presentation and sorting::    How agenda items are prepared for display
7105 * Agenda commands::             Remote editing of Org trees
7106 * Custom agenda views::         Defining special searches and views
7107 * Exporting Agenda Views::      Writing a view to a file
7108 * Agenda column view::          Using column view for collected entries
7109 @end menu
7111 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7112 @section Agenda files
7113 @cindex agenda files
7114 @cindex files for agenda
7116 @vindex org-agenda-files
7117 The information to be shown is normally collected from all @emph{agenda
7118 files}, the files listed in the variable
7119 @code{org-agenda-files}@footnote{If the value of that variable is not a
7120 list, but a single file name, then the list of agenda files will be
7121 maintained in that external file.}.  If a directory is part of this list,
7122 all files with the extension @file{.org} in this directory will be part
7123 of the list.
7125 Thus, even if you only work with a single Org file, that file should
7126 be put into the list@footnote{When using the dispatcher, pressing
7127 @kbd{<} before selecting a command will actually limit the command to
7128 the current file, and ignore @code{org-agenda-files} until the next
7129 dispatcher command.}.  You can customize @code{org-agenda-files}, but
7130 the easiest way to maintain it is through the following commands
7132 @cindex files, adding to agenda list
7133 @table @kbd
7134 @orgcmd{C-c [,org-agenda-file-to-front}
7135 Add current file to the list of agenda files.  The file is added to
7136 the front of the list.  If it was already in the list, it is moved to
7137 the front.  With a prefix argument, file is added/moved to the end.
7138 @orgcmd{C-c ],org-remove-file}
7139 Remove current file from the list of agenda files.
7140 @kindex C-,
7141 @orgcmd{C-',org-cycle-agenda-files}
7142 @itemx C-,
7143 Cycle through agenda file list, visiting one file after the other.
7144 @kindex M-x org-iswitchb
7145 @item M-x org-iswitchb
7146 Command to use an @code{iswitchb}-like interface to switch to and between Org
7147 buffers.
7148 @end table
7150 @noindent
7151 The Org menu contains the current list of files and can be used
7152 to visit any of them.
7154 If you would like to focus the agenda temporarily on a file not in
7155 this list, or on just one file in the list, or even on only a subtree in a
7156 file, then this can be done in different ways.  For a single agenda command,
7157 you may press @kbd{<} once or several times in the dispatcher
7158 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
7159 extended period, use the following commands:
7161 @table @kbd
7162 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7163 Permanently restrict the agenda to the current subtree.  When with a
7164 prefix argument, or with the cursor before the first headline in a file,
7165 the agenda scope is set to the entire file.  This restriction remains in
7166 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7167 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
7168 agenda view, the new restriction takes effect immediately.
7169 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7170 Remove the permanent restriction created by @kbd{C-c C-x <}.
7171 @end table
7173 @noindent
7174 When working with @file{speedbar.el}, you can use the following commands in
7175 the Speedbar frame:
7176 @table @kbd
7177 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7178 Permanently restrict the agenda to the item---either an Org file or a subtree
7179 in such a file---at the cursor in the Speedbar frame.
7180 If there is a window displaying an agenda view, the new restriction takes
7181 effect immediately.
7182 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7183 Lift the restriction.
7184 @end table
7186 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7187 @section The agenda dispatcher
7188 @cindex agenda dispatcher
7189 @cindex dispatching agenda commands
7190 The views are created through a dispatcher, which should be bound to a
7191 global key---for example @kbd{C-c a} (@pxref{Activation}).  In the
7192 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7193 is accessed and list keyboard access to commands accordingly.  After
7194 pressing @kbd{C-c a}, an additional letter is required to execute a
7195 command.  The dispatcher offers the following default commands:
7196 @table @kbd
7197 @item a
7198 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7199 @item t @r{/} T
7200 Create a list of all TODO items (@pxref{Global TODO list}).
7201 @item m @r{/} M
7202 Create a list of headlines matching a TAGS expression (@pxref{Matching
7203 tags and properties}).
7204 @item L
7205 Create the timeline view for the current buffer (@pxref{Timeline}).
7206 @item s
7207 Create a list of entries selected by a boolean expression of keywords
7208 and/or regular expressions that must or must not occur in the entry.
7209 @item /
7210 @vindex org-agenda-text-search-extra-files
7211 Search for a regular expression in all agenda files and additionally in
7212 the files listed in @code{org-agenda-text-search-extra-files}.  This
7213 uses the Emacs command @code{multi-occur}.  A prefix argument can be
7214 used to specify the number of context lines for each match, default is
7216 @item # @r{/} !
7217 Create a list of stuck projects (@pxref{Stuck projects}).
7218 @item <
7219 Restrict an agenda command to the current buffer@footnote{For backward
7220 compatibility, you can also press @kbd{1} to restrict to the current
7221 buffer.}.  After pressing @kbd{<}, you still need to press the character
7222 selecting the command.
7223 @item < <
7224 If there is an active region, restrict the following agenda command to
7225 the region.  Otherwise, restrict it to the current subtree@footnote{For
7226 backward compatibility, you can also press @kbd{0} to restrict to the
7227 current region/subtree.}.  After pressing @kbd{< <}, you still need to press the
7228 character selecting the command.
7229 @end table
7231 You can also define custom commands that will be accessible through the
7232 dispatcher, just like the default commands.  This includes the
7233 possibility to create extended agenda buffers that contain several
7234 blocks together, for example the weekly agenda, the global TODO list and
7235 a number of special tags matches.  @xref{Custom agenda views}.
7237 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7238 @section The built-in agenda views
7240 In this section we describe the built-in views.
7242 @menu
7243 * Weekly/daily agenda::         The calendar page with current tasks
7244 * Global TODO list::            All unfinished action items
7245 * Matching tags and properties::  Structured information with fine-tuned search
7246 * Timeline::                    Time-sorted view for single file
7247 * Search view::                 Find entries by searching for text
7248 * Stuck projects::              Find projects you need to review
7249 @end menu
7251 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7252 @subsection The weekly/daily agenda
7253 @cindex agenda
7254 @cindex weekly agenda
7255 @cindex daily agenda
7257 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7258 paper agenda, showing all the tasks for the current week or day.
7260 @table @kbd
7261 @cindex org-agenda, command
7262 @orgcmd{C-c a a,org-agenda-list}
7263 Compile an agenda for the current week from a list of Org files.  The agenda
7264 shows the entries for each day.  With a numeric prefix@footnote{For backward
7265 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7266 listed before the agenda.  This feature is deprecated, use the dedicated TODO
7267 list, or a block agenda instead (@pxref{Block agenda}).}  (like @kbd{C-u 2 1
7268 C-c a a}) you may set the number of days to be displayed.
7269 @end table
7271 @vindex org-agenda-span
7272 @vindex org-agenda-ndays
7273 The default number of days displayed in the agenda is set by the variable
7274 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}).  This
7275 variable can be set to any number of days you want to see by default in the
7276 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7277 @code{year}.
7279 Remote editing from the agenda buffer means, for example, that you can
7280 change the dates of deadlines and appointments from the agenda buffer.
7281 The commands available in the Agenda buffer are listed in @ref{Agenda
7282 commands}.
7284 @subsubheading Calendar/Diary integration
7285 @cindex calendar integration
7286 @cindex diary integration
7288 Emacs contains the calendar and diary by Edward M. Reingold.  The
7289 calendar displays a three-month calendar with holidays from different
7290 countries and cultures.  The diary allows you to keep track of
7291 anniversaries, lunar phases, sunrise/set, recurrent appointments
7292 (weekly, monthly) and more.  In this way, it is quite complementary to
7293 Org.  It can be very useful to combine output from Org with
7294 the diary.
7296 In order to include entries from the Emacs diary into Org mode's
7297 agenda, you only need to customize the variable
7299 @lisp
7300 (setq org-agenda-include-diary t)
7301 @end lisp
7303 @noindent After that, everything will happen automatically.  All diary
7304 entries including holidays, anniversaries, etc., will be included in the
7305 agenda buffer created by Org mode.  @key{SPC}, @key{TAB}, and
7306 @key{RET} can be used from the agenda buffer to jump to the diary
7307 file in order to edit existing diary entries.  The @kbd{i} command to
7308 insert new entries for the current date works in the agenda buffer, as
7309 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7310 Sunrise/Sunset times, show lunar phases and to convert to other
7311 calendars, respectively.  @kbd{c} can be used to switch back and forth
7312 between calendar and agenda.
7314 If you are using the diary only for sexp entries and holidays, it is
7315 faster to not use the above setting, but instead to copy or even move
7316 the entries into an Org file.  Org mode evaluates diary-style sexp
7317 entries, and does it faster because there is no overhead for first
7318 creating the diary display.  Note that the sexp entries must start at
7319 the left margin, no whitespace is allowed before them.  For example,
7320 the following segment of an Org file will be processed and entries
7321 will be made in the agenda:
7323 @example
7324 * Birthdays and similar stuff
7325 #+CATEGORY: Holiday
7326 %%(org-calendar-holiday)   ; special function for holiday names
7327 #+CATEGORY: Ann
7328 %%(org-anniversary 1956  5 14)@footnote{@code{org-anniversary} is just like @code{diary-anniversary}, but the argument order is always according to ISO and therefore independent of the value of @code{calendar-date-style}.} Arthur Dent is %d years old
7329 %%(org-anniversary 1869 10  2) Mahatma Gandhi would be %d years old
7330 @end example
7332 @subsubheading Anniversaries from BBDB
7333 @cindex BBDB, anniversaries
7334 @cindex anniversaries, from BBDB
7336 If you are using the Big Brothers Database to store your contacts, you will
7337 very likely prefer to store anniversaries in BBDB rather than in a
7338 separate Org or diary file.  Org supports this and will show BBDB
7339 anniversaries as part of the agenda.  All you need to do is to add the
7340 following to one your your agenda files:
7342 @example
7343 * Anniversaries
7344   :PROPERTIES:
7345   :CATEGORY: Anniv
7346   :END:
7347 %%(org-bbdb-anniversaries)
7348 @end example
7350 You can then go ahead and define anniversaries for a BBDB record.  Basically,
7351 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7352 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7353 followed by a space and the class of the anniversary (@samp{birthday} or
7354 @samp{wedding}, or a format string).  If you omit the class, it will default to
7355 @samp{birthday}.  Here are a few examples, the header for the file
7356 @file{org-bbdb.el} contains more detailed information.
7358 @example
7359 1973-06-22
7360 06-22
7361 1955-08-02 wedding
7362 2008-04-14 %s released version 6.01 of org mode, %d years ago
7363 @end example
7365 After a change to BBDB, or for the first agenda display during an Emacs
7366 session, the agenda display will suffer a short delay as Org updates its
7367 hash with anniversaries.  However, from then on things will be very fast---much
7368 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7369 in an Org or Diary file.
7371 @subsubheading Appointment reminders
7372 @cindex @file{appt.el}
7373 @cindex appointment reminders
7374 @cindex appointment
7375 @cindex reminders
7377 Org can interact with Emacs appointments notification facility.  To add all
7378 the appointments of your agenda files, use the command
7379 @code{org-agenda-to-appt}.  This command also lets you filter through the
7380 list of your appointments and add only those belonging to a specific category
7381 or matching a regular expression.  See the docstring for details.
7383 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7384 @subsection The global TODO list
7385 @cindex global TODO list
7386 @cindex TODO list, global
7388 The global TODO list contains all unfinished TODO items formatted and
7389 collected into a single place.
7391 @table @kbd
7392 @orgcmd{C-c a t,org-todo-list}
7393 Show the global TODO list.  This collects the TODO items from all agenda
7394 files (@pxref{Agenda Views}) into a single buffer.  By default, this lists
7395 items with a state the is not a DONE state.  The buffer is in
7396 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7397 entries directly from that buffer (@pxref{Agenda commands}).
7398 @orgcmd{C-c a T,org-todo-list}
7399 @cindex TODO keyword matching
7400 @vindex org-todo-keywords
7401 Like the above, but allows selection of a specific TODO keyword.  You can
7402 also do this by specifying a prefix argument to @kbd{C-c a t}.  You are
7403 prompted for a keyword, and you may also specify several keywords by
7404 separating them with @samp{|} as the boolean OR operator.  With a numeric
7405 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7406 @kindex r
7407 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7408 a prefix argument to this command to change the selected TODO keyword,
7409 for example @kbd{3 r}.  If you often need a search for a specific
7410 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7411 Matching specific TODO keywords can also be done as part of a tags
7412 search (@pxref{Tag searches}).
7413 @end table
7415 Remote editing of TODO items means that you can change the state of a
7416 TODO entry with a single key press.  The commands available in the
7417 TODO list are described in @ref{Agenda commands}.
7419 @cindex sublevels, inclusion into TODO list
7420 Normally the global TODO list simply shows all headlines with TODO
7421 keywords.  This list can become very long.  There are two ways to keep
7422 it more compact:
7423 @itemize @minus
7424 @item
7425 @vindex org-agenda-todo-ignore-scheduled
7426 @vindex org-agenda-todo-ignore-deadlines
7427 @vindex org-agenda-todo-ignore-timestamp
7428 @vindex org-agenda-todo-ignore-with-date
7429 Some people view a TODO item that has been @emph{scheduled} for execution or
7430 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7431 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7432 @code{org-agenda-todo-ignore-deadlines},
7433 @code{org-agenda-todo-ignore-timestamp} and/or
7434 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7435 TODO list.
7436 @item
7437 @vindex org-agenda-todo-list-sublevels
7438 TODO items may have sublevels to break up the task into subtasks.  In
7439 such cases it may be enough to list only the highest level TODO headline
7440 and omit the sublevels from the global list.  Configure the variable
7441 @code{org-agenda-todo-list-sublevels} to get this behavior.
7442 @end itemize
7444 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7445 @subsection Matching tags and properties
7446 @cindex matching, of tags
7447 @cindex matching, of properties
7448 @cindex tags view
7449 @cindex match view
7451 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7452 or have properties (@pxref{Properties and Columns}), you can select headlines
7453 based on this metadata and collect them into an agenda buffer.  The match
7454 syntax described here also applies when creating sparse trees with @kbd{C-c /
7457 @table @kbd
7458 @orgcmd{C-c a m,org-tags-view}
7459 Produce a list of all headlines that match a given set of tags.  The
7460 command prompts for a selection criterion, which is a boolean logic
7461 expression with tags, like @samp{+work+urgent-withboss} or
7462 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
7463 define a custom command for it (@pxref{Agenda dispatcher}).
7464 @orgcmd{C-c a M,org-tags-view}
7465 @vindex org-tags-match-list-sublevels
7466 @vindex org-agenda-tags-todo-honor-ignore-options
7467 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7468 not-DONE state and force checking subitems (see variable
7469 @code{org-tags-match-list-sublevels}).  To exclude scheduled/deadline items,
7470 see the variable @code{org-agenda-tags-todo-honor-ignore-options}.  Matching
7471 specific TODO keywords together with a tags match is also possible, see
7472 @ref{Tag searches}.
7473 @end table
7475 The commands available in the tags list are described in @ref{Agenda
7476 commands}.
7478 @subsubheading Match syntax
7480 @cindex Boolean logic, for tag/property searches
7481 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7482 OR.  @samp{&} binds more strongly than @samp{|}.  Parentheses are currently
7483 not implemented.  Each element in the search is either a tag, a regular
7484 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7485 VALUE} with a comparison operator, accessing a property value.  Each element
7486 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7487 sugar for positive selection.  The AND operator @samp{&} is optional when
7488 @samp{+} or @samp{-} is present.  Here are some examples, using only tags.
7490 @table @samp
7491 @item +work-boss
7492 Select headlines tagged @samp{:work:}, but discard those also tagged
7493 @samp{:boss:}.
7494 @item work|laptop
7495 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7496 @item work|laptop+night
7497 Like before, but require the @samp{:laptop:} lines to be tagged also
7498 @samp{:night:}.
7499 @end table
7501 @cindex regular expressions, with tags search
7502 Instead of a tag, you may also specify a regular expression enclosed in curly
7503 braces.  For example,
7504 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7505 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7507 @cindex TODO keyword matching, with tags search
7508 @cindex level, require for tags/property match
7509 @cindex category, require for tags/property match
7510 @vindex org-odd-levels-only
7511 You may also test for properties (@pxref{Properties and Columns}) at the same
7512 time as matching tags.  The properties may be real properties, or special
7513 properties that represent other metadata (@pxref{Special properties}).  For
7514 example, the ``property'' @code{TODO} represents the TODO keyword of the
7515 entry.  Or, the ``property'' @code{LEVEL} represents the level of an entry.
7516 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7517 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7518 DONE.  In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7519 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7521 Here are more examples:
7522 @table @samp
7523 @item work+TODO="WAITING"
7524 Select @samp{:work:}-tagged TODO lines with the specific TODO
7525 keyword @samp{WAITING}.
7526 @item work+TODO="WAITING"|home+TODO="WAITING"
7527 Waiting tasks both at work and at home.
7528 @end table
7530 When matching properties, a number of different operators can be used to test
7531 the value of a property.  Here is a complex example:
7533 @example
7534 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
7535          +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7536 @end example
7538 @noindent
7539 The type of comparison will depend on how the comparison value is written:
7540 @itemize @minus
7541 @item
7542 If the comparison value is a plain number, a numerical comparison is done,
7543 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7544 @samp{>=}, and @samp{<>}.
7545 @item
7546 If the comparison value is enclosed in double-quotes,
7547 a string comparison is done, and the same operators are allowed.
7548 @item
7549 If the comparison value is enclosed in double-quotes @emph{and} angular
7550 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7551 assumed to be date/time specifications in the standard Org way, and the
7552 comparison will be done accordingly.  Special values that will be recognized
7553 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7554 @code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
7555 specification.  Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7556 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7557 respectively, can be used.
7558 @item
7559 If the comparison value is enclosed
7560 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7561 regexp matches the property value, and @samp{<>} meaning that it does not
7562 match.
7563 @end itemize
7565 So the search string in the example finds entries tagged @samp{:work:} but
7566 not @samp{:boss:}, which also have a priority value @samp{A}, a
7567 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7568 property that is numerically smaller than 2, a @samp{:With:} property that is
7569 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7570 on or after October 11, 2008.
7572 Accessing TODO, LEVEL, and CATEGORY during a search is fast.  Accessing any
7573 other properties will slow down the search.  However, once you have paid the
7574 price by accessing one property, testing additional properties is cheap
7575 again.
7577 You can configure Org mode to use property inheritance during a search, but
7578 beware that this can slow down searches considerably.  See @ref{Property
7579 inheritance}, for details.
7581 For backward compatibility, and also for typing speed, there is also a
7582 different way to test TODO states in a search.  For this, terminate the
7583 tags/property part of the search string (which may include several terms
7584 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7585 expression just for TODO keywords.  The syntax is then similar to that for
7586 tags, but should be applied with care: for example, a positive selection on
7587 several TODO keywords cannot meaningfully be combined with boolean AND.
7588 However, @emph{negative selection} combined with AND can be meaningful.  To
7589 make sure that only lines are checked that actually have any TODO keyword
7590 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7591 part after the slash with @samp{!}.  Using @kbd{C-c a M} or @samp{/!} will
7592 not match TODO keywords in a DONE state.  Examples:
7594 @table @samp
7595 @item work/WAITING
7596 Same as @samp{work+TODO="WAITING"}
7597 @item work/!-WAITING-NEXT
7598 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7599 nor @samp{NEXT}
7600 @item work/!+WAITING|+NEXT
7601 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7602 @samp{NEXT}.
7603 @end table
7605 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7606 @subsection Timeline for a single file
7607 @cindex timeline, single file
7608 @cindex time-sorted view
7610 The timeline summarizes all time-stamped items from a single Org mode
7611 file in a @emph{time-sorted view}.  The main purpose of this command is
7612 to give an overview over events in a project.
7614 @table @kbd
7615 @orgcmd{C-c a L,org-timeline}
7616 Show a time-sorted view of the Org file, with all time-stamped items.
7617 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7618 (scheduled or not) are also listed under the current date.
7619 @end table
7621 @noindent
7622 The commands available in the timeline buffer are listed in
7623 @ref{Agenda commands}.
7625 @node Search view, Stuck projects, Timeline, Built-in agenda views
7626 @subsection Search view
7627 @cindex search view
7628 @cindex text search
7629 @cindex searching, for text
7631 This agenda view is a general text search facility for Org mode entries.
7632 It is particularly useful to find notes.
7634 @table @kbd
7635 @orgcmd{C-c a s,org-search-view}
7636 This is a special search that lets you select entries by matching a substring
7637 or specific words using a boolean logic.
7638 @end table
7639 For example, the search string @samp{computer equipment} will find entries
7640 that contain @samp{computer equipment} as a substring.  If the two words are
7641 separated by more space or a line break, the search will still match.
7642 Search view can also search for specific keywords in the entry, using Boolean
7643 logic.  The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7644 will search for note entries that contain the keywords @code{computer}
7645 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7646 not matched by the regular expression @code{8\.11[bg]}, meaning to
7647 exclude both 8.11b and 8.11g.  The first @samp{+} is necessary to turn on
7648 word search, other @samp{+} characters are optional.  For more details, see
7649 the docstring of the command @code{org-search-view}.
7651 @vindex org-agenda-text-search-extra-files
7652 Note that in addition to the agenda files, this command will also search
7653 the files listed in @code{org-agenda-text-search-extra-files}.
7655 @node Stuck projects,  , Search view, Built-in agenda views
7656 @subsection Stuck projects
7657 @pindex GTD, Getting Things Done
7659 If you are following a system like David Allen's GTD to organize your
7660 work, one of the ``duties'' you have is a regular review to make sure
7661 that all projects move along.  A @emph{stuck} project is a project that
7662 has no defined next actions, so it will never show up in the TODO lists
7663 Org mode produces.  During the review, you need to identify such
7664 projects and define next actions for them.
7666 @table @kbd
7667 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7668 List projects that are stuck.
7669 @kindex C-c a !
7670 @item C-c a !
7671 @vindex org-stuck-projects
7672 Customize the variable @code{org-stuck-projects} to define what a stuck
7673 project is and how to find it.
7674 @end table
7676 You almost certainly will have to configure this view before it will
7677 work for you.  The built-in default assumes that all your projects are
7678 level-2 headlines, and that a project is not stuck if it has at least
7679 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7681 Let's assume that you, in your own way of using Org mode, identify
7682 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7683 indicate a project that should not be considered yet.  Let's further
7684 assume that the TODO keyword DONE marks finished projects, and that NEXT
7685 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
7686 is a next action even without the NEXT tag.  Finally, if the project
7687 contains the special word IGNORE anywhere, it should not be listed
7688 either.  In this case you would start by identifying eligible projects
7689 with a tags/todo match@footnote{@xref{Tag searches}.}
7690 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7691 IGNORE in the subtree to identify projects that are not stuck.  The
7692 correct customization for this is
7694 @lisp
7695 (setq org-stuck-projects
7696       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7697                                "\\<IGNORE\\>"))
7698 @end lisp
7700 Note that if a project is identified as non-stuck, the subtree of this entry
7701 will still be searched for stuck projects.
7703 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7704 @section Presentation and sorting
7705 @cindex presentation, of agenda items
7707 @vindex org-agenda-prefix-format
7708 @vindex org-agenda-tags-column
7709 Before displaying items in an agenda view, Org mode visually prepares the
7710 items and sorts them.  Each item occupies a single line.  The line starts
7711 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
7712 of the item and other important information.  You can customize in which
7713 column tags will be displayed through @code{org-agenda-tags-column}.  You can
7714 also customize the prefix using the option @code{org-agenda-prefix-format}.
7715 This prefix is followed by a cleaned-up version of the outline headline
7716 associated with the item.
7718 @menu
7719 * Categories::                  Not all tasks are equal
7720 * Time-of-day specifications::  How the agenda knows the time
7721 * Sorting of agenda items::     The order of things
7722 @end menu
7724 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7725 @subsection Categories
7727 @cindex category
7728 @cindex #+CATEGORY
7729 The category is a broad label assigned to each agenda item.  By default,
7730 the category is simply derived from the file name, but you can also
7731 specify it with a special line in the buffer, like this@footnote{For
7732 backward compatibility, the following also works: if there are several
7733 such lines in a file, each specifies the category for the text below it.
7734 The first category also applies to any text before the first CATEGORY
7735 line.  However, using this method is @emph{strongly} deprecated as it is
7736 incompatible with the outline structure of the document.  The correct
7737 method for setting multiple categories in a buffer is using a
7738 property.}:
7740 @example
7741 #+CATEGORY: Thesis
7742 @end example
7744 @noindent
7745 @cindex property, CATEGORY
7746 If you would like to have a special CATEGORY for a single entry or a
7747 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7748 special category you want to apply as the value.
7750 @noindent
7751 The display in the agenda buffer looks best if the category is not
7752 longer than 10 characters.
7754 @noindent
7755 You can set up icons for category by customizing the
7756 @code{org-agenda-category-icon-alist} variable.
7758 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7759 @subsection Time-of-day specifications
7760 @cindex time-of-day specification
7762 Org mode checks each agenda item for a time-of-day specification.  The
7763 time can be part of the timestamp that triggered inclusion into the
7764 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
7765 ranges can be specified with two timestamps, like
7767 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7769 In the headline of the entry itself, a time(range) may also appear as
7770 plain text (like @samp{12:45} or a @samp{8:30-1pm}).  If the agenda
7771 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7772 specifications in diary entries are recognized as well.
7774 For agenda display, Org mode extracts the time and displays it in a
7775 standard 24 hour format as part of the prefix.  The example times in
7776 the previous paragraphs would end up in the agenda like this:
7778 @example
7779     8:30-13:00 Arthur Dent lies in front of the bulldozer
7780    12:45...... Ford Prefect arrives and takes Arthur to the pub
7781    19:00...... The Vogon reads his poem
7782    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7783 @end example
7785 @cindex time grid
7786 If the agenda is in single-day mode, or for the display of today, the
7787 timed entries are embedded in a time grid, like
7789 @example
7790     8:00...... ------------------
7791     8:30-13:00 Arthur Dent lies in front of the bulldozer
7792    10:00...... ------------------
7793    12:00...... ------------------
7794    12:45...... Ford Prefect arrives and takes Arthur to the pub
7795    14:00...... ------------------
7796    16:00...... ------------------
7797    18:00...... ------------------
7798    19:00...... The Vogon reads his poem
7799    20:00...... ------------------
7800    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7801 @end example
7803 @vindex org-agenda-use-time-grid
7804 @vindex org-agenda-time-grid
7805 The time grid can be turned on and off with the variable
7806 @code{org-agenda-use-time-grid}, and can be configured with
7807 @code{org-agenda-time-grid}.
7809 @node Sorting of agenda items,  , Time-of-day specifications, Presentation and sorting
7810 @subsection Sorting of agenda items
7811 @cindex sorting, of agenda items
7812 @cindex priorities, of agenda items
7813 Before being inserted into a view, the items are sorted.  How this is
7814 done depends on the type of view.
7815 @itemize @bullet
7816 @item
7817 @vindex org-agenda-files
7818 For the daily/weekly agenda, the items for each day are sorted.  The
7819 default order is to first collect all items containing an explicit
7820 time-of-day specification.  These entries will be shown at the beginning
7821 of the list, as a @emph{schedule} for the day.  After that, items remain
7822 grouped in categories, in the sequence given by @code{org-agenda-files}.
7823 Within each category, items are sorted by priority (@pxref{Priorities}),
7824 which is composed of the base priority (2000 for priority @samp{A}, 1000
7825 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7826 overdue scheduled or deadline items.
7827 @item
7828 For the TODO list, items remain in the order of categories, but within
7829 each category, sorting takes place according to priority
7830 (@pxref{Priorities}).  The priority used for sorting derives from the
7831 priority cookie, with additions depending on how close an item is to its due
7832 or scheduled date.
7833 @item
7834 For tags matches, items are not sorted at all, but just appear in the
7835 sequence in which they are found in the agenda files.
7836 @end itemize
7838 @vindex org-agenda-sorting-strategy
7839 Sorting can be customized using the variable
7840 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7841 the estimated effort of an entry (@pxref{Effort estimates}).
7843 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7844 @section Commands in the agenda buffer
7845 @cindex commands, in agenda buffer
7847 Entries in the agenda buffer are linked back to the Org file or diary
7848 file where they originate.  You are not allowed to edit the agenda
7849 buffer itself, but commands are provided to show and jump to the
7850 original entry location, and to edit the Org files ``remotely'' from
7851 the agenda buffer.  In this way, all information is stored only once,
7852 removing the risk that your agenda and note files may diverge.
7854 Some commands can be executed with mouse clicks on agenda lines.  For
7855 the other commands, the cursor needs to be in the desired line.
7857 @table @kbd
7858 @tsubheading{Motion}
7859 @cindex motion commands in agenda
7860 @orgcmd{n,org-agenda-next-line}
7861 Next line (same as @key{up} and @kbd{C-p}).
7862 @orgcmd{p,org-agenda-previous-line}
7863 Previous line (same as @key{down} and @kbd{C-n}).
7864 @tsubheading{View/Go to Org file}
7865 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
7866 Display the original location of the item in another window.
7867 With prefix arg, make sure that the entire entry is made visible in the
7868 outline, not only the heading.
7870 @orgcmd{L,org-agenda-recenter}
7871 Display original location and recenter that window.
7873 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
7874 Go to the original location of the item in another window.
7876 @orgcmd{@key{RET},org-agenda-switch-to}
7877 Go to the original location of the item and delete other windows.
7879 @orgcmd{F,org-agenda-follow-mode}
7880 @vindex org-agenda-start-with-follow-mode
7881 Toggle Follow mode.  In Follow mode, as you move the cursor through
7882 the agenda buffer, the other window always shows the corresponding
7883 location in the Org file.  The initial setting for this mode in new
7884 agenda buffers can be set with the variable
7885 @code{org-agenda-start-with-follow-mode}.
7887 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
7888 Display the entire subtree of the current item in an indirect buffer.  With a
7889 numeric prefix argument N, go up to level N and then take that tree.  If N is
7890 negative, go up that many levels.  With a @kbd{C-u} prefix, do not remove the
7891 previously used indirect buffer.
7893 @orgcmd{C-c C-o,org-agenda-open-link}
7894 Follow a link in the entry.  This will offer a selection of any links in the
7895 text belonging to the referenced Org node.  If there is only one link, it
7896 will be followed without a selection prompt.
7898 @tsubheading{Change display}
7899 @cindex display changing, in agenda
7900 @kindex A
7901 @item A
7902 Interactively select another agenda view and append it to the current view.
7904 @kindex o
7905 @item o
7906 Delete other windows.
7908 @orgcmdkskc{v d,d,org-agenda-day-view}
7909 @xorgcmdkskc{v w,w,org-agenda-day-view}
7910 @xorgcmd{v m,org-agenda-month-view}
7911 @xorgcmd{v y,org-agenda-month-year}
7912 @xorgcmd{v SPC,org-agenda-reset-view}
7913 @vindex org-agenda-span
7914 Switch to day/week/month/year view.  When switching to day or week view, this
7915 setting becomes the default for subsequent agenda refreshes.  Since month and
7916 year views are slow to create, they do not become the default.  A numeric
7917 prefix argument may be used to jump directly to a specific day of the year,
7918 ISO week, month, or year, respectively.  For example, @kbd{32 d} jumps to
7919 February 1st, @kbd{9 w} to ISO week number 9.  When setting day, week, or
7920 month view, a year may be encoded in the prefix argument as well.  For
7921 example, @kbd{200712 w} will jump to week 12 in 2007.  If such a year
7922 specification has only one or two digits, it will be mapped to the interval
7923 1938-2037.  @kbd{v @key{SPC}} will reset to what is set in
7924 @code{org-agenda-span}.
7926 @orgcmd{f,org-agenda-later}
7927 Go forward in time to display the following @code{org-agenda-current-span} days.
7928 For example, if the display covers a week, switch to the following week.
7929 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
7931 @orgcmd{b,org-agenda-earlier}
7932 Go backward in time to display earlier dates.
7934 @orgcmd{.,org-agenda-goto-today}
7935 Go to today.
7937 @orgcmd{j,org-agenda-goto-date}
7938 Prompt for a date and go there.
7940 @orgcmd{J,org-agenda-clock-goto}
7941 Go to the currently clocked-in task @i{in the agenda buffer}.
7943 @orgcmd{D,org-agenda-toggle-diary}
7944 Toggle the inclusion of diary entries.  See @ref{Weekly/daily agenda}.
7946 @orgcmdkskc{v l,l,org-agenda-log-mode}
7947 @kindex v L
7948 @vindex org-log-done
7949 @vindex org-agenda-log-mode-items
7950 Toggle Logbook mode.  In Logbook mode, entries that were marked DONE while
7951 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7952 entries that have been clocked on that day.  You can configure the entry
7953 types that should be included in log mode using the variable
7954 @code{org-agenda-log-mode-items}.  When called with a @kbd{C-u} prefix, show
7955 all possible logbook entries, including state changes.  When called with two
7956 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7957 @kbd{v L} is equivalent to @kbd{C-u v l}.
7959 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
7960 Include inactive timestamps into the current view.  Only for weekly/daily
7961 agenda and timeline views.
7963 @orgcmd{v a,org-agenda-archives-mode}
7964 @xorgcmd{v A,org-agenda-archives-mode 'files}
7965 Toggle Archives mode.  In Archives mode, trees that are marked
7966 @code{ARCHIVED} are also scanned when producing the agenda.  When you use the
7967 capital @kbd{A}, even all archive files are included.  To exit archives mode,
7968 press @kbd{v a} again.
7970 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
7971 @vindex org-agenda-start-with-clockreport-mode
7972 @vindex org-clock-report-include-clocking-task
7973 Toggle Clockreport mode.  In Clockreport mode, the daily/weekly agenda will
7974 always show a table with the clocked times for the timespan and file scope
7975 covered by the current agenda view.  The initial setting for this mode in new
7976 agenda buffers can be set with the variable
7977 @code{org-agenda-start-with-clockreport-mode}.  By using a prefix argument
7978 when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
7979 contributions from entries that are hidden by agenda filtering@footnote{Only
7980 tags filtering will be respected here, effort filtering is ignored.}.  See
7981 also the variable @code{org-clock-report-include-clocking-task}.
7983 @orgkey{v c}
7984 @vindex org-agenda-clock-consistency-checks
7985 Show overlapping clock entries, clocking gaps, and other clocking problems in
7986 the current agenda range.  You can then visit clocking lines and fix them
7987 manually.  See the variable @code{org-agenda-clock-consistency-checks} for
7988 information on how to customize the definition of what constituted a clocking
7989 problem.  To return to normal agenda display, press @kbd{l} to exit Logbook
7990 mode.
7992 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
7993 @vindex org-agenda-start-with-entry-text-mode
7994 @vindex org-agenda-entry-text-maxlines
7995 Toggle entry text mode.  In entry text mode, a number of lines from the Org
7996 outline node referenced by an agenda line will be displayed below the line.
7997 The maximum number of lines is given by the variable
7998 @code{org-agenda-entry-text-maxlines}.  Calling this command with a numeric
7999 prefix argument will temporarily modify that number to the prefix value.
8001 @orgcmd{G,org-agenda-toggle-time-grid}
8002 @vindex org-agenda-use-time-grid
8003 @vindex org-agenda-time-grid
8004 Toggle the time grid on and off.  See also the variables
8005 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8007 @orgcmd{r,org-agenda-redo}
8008 Recreate the agenda buffer, for example to reflect the changes after
8009 modification of the timestamps of items with @kbd{S-@key{left}} and
8010 @kbd{S-@key{right}}.  When the buffer is the global TODO list, a prefix
8011 argument is interpreted to create a selective list for a specific TODO
8012 keyword.
8013 @orgcmd{g,org-agenda-redo}
8014 Same as @kbd{r}.
8016 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8017 Save all Org buffers in the current Emacs session, and also the locations of
8018 IDs.
8020 @orgcmd{C-c C-x C-c,org-agenda-columns}
8021 @vindex org-columns-default-format
8022 Invoke column view (@pxref{Column view}) in the agenda buffer.  The column
8023 view format is taken from the entry at point, or (if there is no entry at
8024 point), from the first entry in the agenda view.  So whatever the format for
8025 that entry would be in the original buffer (taken from a property, from a
8026 @code{#+COLUMNS} line, or from the default variable
8027 @code{org-columns-default-format}), will be used in the agenda.
8029 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8030 Remove the restriction lock on the agenda, if it is currently restricted to a
8031 file or subtree (@pxref{Agenda files}).
8033 @tsubheading{Secondary filtering and query editing}
8034 @cindex filtering, by tag and effort, in agenda
8035 @cindex tag filtering, in agenda
8036 @cindex effort filtering, in agenda
8037 @cindex query editing, in agenda
8039 @orgcmd{/,org-agenda-filter-by-tag}
8040 @vindex org-agenda-filter-preset
8041 Filter the current agenda view with respect to a tag and/or effort estimates.
8042 The difference between this and a custom agenda command is that filtering is
8043 very fast, so that you can switch quickly between different filters without
8044 having to recreate the agenda.@footnote{Custom commands can preset a filter by
8045 binding the variable @code{org-agenda-filter-preset} as an option.  This
8046 filter will then be applied to the view and persist as a basic filter through
8047 refreshes and more secondary filtering.  The filter is a global property of
8048 the entire agenda view---in a block agenda, you should only set this in the
8049 global options section, not in the section of an individual block.}
8051 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8052 all.  Pressing @key{TAB} at that prompt will offer use completion to select a
8053 tag (including any tags that do not have a selection character).  The command
8054 then hides all entries that do not contain or inherit this tag.  When called
8055 with prefix arg, remove the entries that @emph{do} have the tag.  A second
8056 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8057 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8058 will be narrowed by requiring or forbidding the selected additional tag.
8059 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8060 immediately use the @kbd{\} command.
8062 @vindex org-sort-agenda-noeffort-is-high
8063 In order to filter for effort estimates, you should set up allowed
8064 efforts globally, for example
8065 @lisp
8066 (setq org-global-properties
8067     '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8068 @end lisp
8069 You can then filter for an effort by first typing an operator, one of
8070 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8071 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8072 The filter will then restrict to entries with effort smaller-or-equal, equal,
8073 or larger-or-equal than the selected value.  If the digits 0-9 are not used
8074 as fast access keys to tags, you can also simply press the index digit
8075 directly without an operator.  In this case, @kbd{<} will be assumed.  For
8076 application of the operator, entries without a defined effort will be treated
8077 according to the value of @code{org-sort-agenda-noeffort-is-high}.  To filter
8078 for tasks without effort definition, press @kbd{?} as the operator.
8080 Org also supports automatic, context-aware tag filtering.  If the variable
8081 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8082 that function can decide which tags should be excluded from the agenda
8083 automatically.  Once this is set, the @kbd{/} command then accepts @kbd{RET}
8084 as a sub-option key and runs the auto exclusion logic.  For example, let's
8085 say you use a @code{Net} tag to identify tasks which need network access, an
8086 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8087 calls.  You could auto-exclude these tags based on the availability of the
8088 Internet, and outside of business hours, with something like this:
8090 @lisp
8091 @group
8092 (defun org-my-auto-exclude-function (tag)
8093   (and (cond
8094         ((string= tag "Net")
8095          (/= 0 (call-process "/sbin/ping" nil nil nil
8096                              "-c1" "-q" "-t1" "mail.gnu.org")))
8097         ((or (string= tag "Errand") (string= tag "Call"))
8098          (let ((hour (nth 2 (decode-time))))
8099            (or (< hour 8) (> hour 21)))))
8100        (concat "-" tag)))
8102 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8103 @end group
8104 @end lisp
8106 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8107 Narrow the current agenda filter by an additional condition.  When called with
8108 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8109 the effort criterion.  You can achieve the same effect by pressing @kbd{+} or
8110 @kbd{-} as the first key after the @kbd{/} command.
8113 @kindex [
8114 @kindex ]
8115 @kindex @{
8116 @kindex @}
8117 @item [ ] @{ @}
8118 @table @i
8119 @item @r{in} search view
8120 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8121 (@kbd{@{} and @kbd{@}}) to the query string.  The opening bracket/brace will
8122 add a positive search term prefixed by @samp{+}, indicating that this search
8123 term @i{must} occur/match in the entry.  The closing bracket/brace will add a
8124 negative search term which @i{must not} occur/match in the entry for it to be
8125 selected.
8126 @end table
8128 @tsubheading{Remote editing}
8129 @cindex remote editing, from agenda
8131 @item 0-9
8132 Digit argument.
8134 @cindex undoing remote-editing events
8135 @cindex remote editing, undo
8136 @orgcmd{C-_,org-agenda-undo}
8137 Undo a change due to a remote editing command.  The change is undone
8138 both in the agenda buffer and in the remote buffer.
8140 @orgcmd{t,org-agenda-todo}
8141 Change the TODO state of the item, both in the agenda and in the
8142 original org file.
8144 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8145 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8146 Switch to the next/previous set of TODO keywords.
8148 @orgcmd{C-k,org-agenda-kill}
8149 @vindex org-agenda-confirm-kill
8150 Delete the current agenda item along with the entire subtree belonging
8151 to it in the original Org file.  If the text to be deleted remotely
8152 is longer than one line, the kill needs to be confirmed by the user.  See
8153 variable @code{org-agenda-confirm-kill}.
8155 @orgcmd{C-c C-w,org-agenda-refile}
8156 Refile the entry at point.
8158 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8159 @vindex org-archive-default-command
8160 Archive the subtree corresponding to the entry at point using the default
8161 archiving command set in @code{org-archive-default-command}.  When using the
8162 @code{a} key, confirmation will be required.
8164 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8165 Toggle the ARCHIVE tag for the current headline.
8167 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8168 Move the subtree corresponding to the current entry to its @emph{archive
8169 sibling}.
8171 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8172 Archive the subtree corresponding to the current headline.  This means the
8173 entry will be moved to the configured archive location, most likely a
8174 different file.
8176 @orgcmd{T,org-agenda-show-tags}
8177 @vindex org-agenda-show-inherited-tags
8178 Show all tags associated with the current item.  This is useful if you have
8179 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8180 tags of a headline occasionally.
8182 @orgcmd{:,org-agenda-set-tags}
8183 Set tags for the current headline.  If there is an active region in the
8184 agenda, change a tag for all headings in the region.
8186 @kindex ,
8187 @item ,
8188 Set the priority for the current item (@command{org-agenda-priority}).
8189 Org mode prompts for the priority character.  If you reply with @key{SPC},
8190 the priority cookie is removed from the entry.
8192 @orgcmd{P,org-agenda-show-priority}
8193 Display weighted priority of current item.
8195 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8196 Increase the priority of the current item.  The priority is changed in
8197 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
8198 key for this.
8200 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8201 Decrease the priority of the current item.
8203 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8204 @vindex org-log-into-drawer
8205 Add a note to the entry.  This note will be recorded, and then filed to the
8206 same location where state change notes are put.  Depending on
8207 @code{org-log-into-drawer}, this may be inside a drawer.
8209 @orgcmd{C-c C-a,org-attach}
8210 Dispatcher for all command related to attachments.
8212 @orgcmd{C-c C-s,org-agenda-schedule}
8213 Schedule this item.  With prefix arg remove the scheduling timestamp
8215 @orgcmd{C-c C-d,org-agenda-deadline}
8216 Set a deadline for this item.  With prefix arg remove the deadline.
8218 @orgcmd{k,org-agenda-action}
8219 Agenda actions, to set dates for selected items to the cursor date.
8220 This command also works in the calendar!  The command prompts for an
8221 additional key:
8222 @example
8223 m   @r{Mark the entry at point for action.  You can also make entries}
8224     @r{in Org files with @kbd{C-c C-x C-k}.}
8225 d   @r{Set the deadline of the marked entry to the date at point.}
8226 s   @r{Schedule the marked entry at the date at point.}
8227 r   @r{Call @code{org-capture} with the cursor date as default date.}
8228 @end example
8229 @noindent
8230 Press @kbd{r} afterward to refresh the agenda and see the effect of the
8231 command.
8233 @orgcmd{S-@key{right},org-agenda-do-date-later}
8234 Change the timestamp associated with the current line by one day into the
8235 future.  If the date is in the past, the first call to this command will move
8236 it to today.@*
8237 With a numeric prefix argument, change it by that many days.  For example,
8238 @kbd{3 6 5 S-@key{right}} will change it by a year.  With a @kbd{C-u} prefix,
8239 change the time by one hour.  If you immediately repeat the command, it will
8240 continue to change hours even without the prefix arg.  With a double @kbd{C-u
8241 C-u} prefix, do the same for changing minutes.@*
8242 The stamp is changed in the original Org file, but the change is not directly
8243 reflected in the agenda buffer.  Use @kbd{r} or @kbd{g} to update the buffer.
8245 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8246 Change the timestamp associated with the current line by one day
8247 into the past.
8249 @orgcmd{>,org-agenda-date-prompt}
8250 Change the timestamp associated with the current line.  The key @kbd{>} has
8251 been chosen, because it is the same as @kbd{S-.}  on my keyboard.
8253 @orgcmd{I,org-agenda-clock-in}
8254 Start the clock on the current item.  If a clock is running already, it
8255 is stopped first.
8257 @orgcmd{O,org-agenda-clock-out}
8258 Stop the previously started clock.
8260 @orgcmd{X,org-agenda-clock-cancel}
8261 Cancel the currently running clock.
8263 @orgcmd{J,org-agenda-clock-goto}
8264 Jump to the running clock in another window.
8266 @tsubheading{Bulk remote editing selected entries}
8267 @cindex remote editing, bulk, from agenda
8269 @orgcmd{m,org-agenda-bulk-mark}
8270 Mark the entry at point for bulk action.  With prefix arg, mark that many
8271 successive entries.
8273 @orgcmd{%,org-agenda-bulk-mark-regexp}
8274 Mark entries matching a regular expression for bulk action.
8276 @orgcmd{u,org-agenda-bulk-unmark}
8277 Unmark entry for bulk action.
8279 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8280 Unmark all marked entries for bulk action.
8282 @orgcmd{B,org-agenda-bulk-action}
8283 Bulk action: act on all marked entries in the agenda.  This will prompt for
8284 another key to select the action to be applied.  The prefix arg to @kbd{B}
8285 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8286 these special timestamps.
8287 @example
8288 r  @r{Prompt for a single refile target and move all entries.  The entries}
8289    @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8290 $  @r{Archive all selected entries.}
8291 A  @r{Archive entries by moving them to their respective archive siblings.}
8292 t  @r{Change TODO state.  This prompts for a single TODO keyword and}
8293    @r{changes the state of all selected entries, bypassing blocking and}
8294    @r{suppressing logging notes (but not timestamps).}
8295 +  @r{Add a tag to all selected entries.}
8296 -  @r{Remove a tag from all selected entries.}
8297 s  @r{Schedule all items to a new date.  To shift existing schedule dates}
8298    @r{by a fixed number of days, use something starting with double plus}
8299    @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8300 S  @r{Reschedule randomly into the coming N days.  N will be prompted for.}
8301    @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
8302 d  @r{Set deadline to a specific date.}
8303 f  @r{Apply a function to marked entries.}
8304    @r{For example, the function below sets the CATEGORY property of the}
8305    @r{entries to web.}
8306    @r{(defun set-category ()}
8307    @r{  (interactive "P")}
8308    @r{  (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
8309    @r{                     (org-agenda-error)))}
8310    @r{            (buffer (marker-buffer marker)))}
8311    @r{       (with-current-buffer buffer}
8312    @r{         (save-excursion}
8313    @r{           (save-restriction}
8314    @r{             (widen)}
8315    @r{             (goto-char marker)}
8316    @r{             (org-back-to-heading t)}
8317    @r{             (org-set-property "CATEGORY" "web"))))))}
8318 @end example
8321 @tsubheading{Calendar commands}
8322 @cindex calendar commands, from agenda
8324 @orgcmd{c,org-agenda-goto-calendar}
8325 Open the Emacs calendar and move to the date at the agenda cursor.
8327 @orgcmd{c,org-calendar-goto-agenda}
8328 When in the calendar, compute and show the Org mode agenda for the
8329 date at the cursor.
8331 @cindex diary entries, creating from agenda
8332 @orgcmd{i,org-agenda-diary-entry}
8333 @vindex org-agenda-diary-file
8334 Insert a new entry into the diary, using the date at the cursor and (for
8335 block entries) the date at the mark.  This will add to the Emacs diary
8336 file@footnote{This file is parsed for the agenda when
8337 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8338 command in the calendar.  The diary file will pop up in another window, where
8339 you can add the entry.
8341 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
8342 Org will create entries (in Org mode syntax) in that file instead.  Most
8343 entries will be stored in a date-based outline tree that will later make it
8344 easy to archive appointments from previous months/years.  The tree will be
8345 built under an entry with a @code{DATE_TREE} property, or else with years as
8346 top-level entries.  Emacs will prompt you for the entry text---if you specify
8347 it, the entry will be created in @code{org-agenda-diary-file} without further
8348 interaction.  If you directly press @key{RET} at the prompt without typing
8349 text, the target file will be shown in another window for you to finish the
8350 entry there.  See also the @kbd{k r} command.
8352 @orgcmd{M,org-agenda-phases-of-moon}
8353 Show the phases of the moon for the three months around current date.
8355 @orgcmd{S,org-agenda-sunrise-sunset}
8356 Show sunrise and sunset times.  The geographical location must be set
8357 with calendar variables, see the documentation for the Emacs calendar.
8359 @orgcmd{C,org-agenda-convert-date}
8360 Convert the date at cursor into many other cultural and historic
8361 calendars.
8363 @orgcmd{H,org-agenda-holidays}
8364 Show holidays for three months around the cursor date.
8366 @item M-x org-export-icalendar-combine-agenda-files
8367 Export a single iCalendar file containing entries from all agenda files.
8368 This is a globally available command, and also available in the agenda menu.
8370 @tsubheading{Exporting to a file}
8371 @orgcmd{C-x C-w,org-write-agenda}
8372 @cindex exporting agenda views
8373 @cindex agenda views, exporting
8374 @vindex org-agenda-exporter-settings
8375 Write the agenda view to a file.  Depending on the extension of the selected
8376 file name, the view will be exported as HTML (extension @file{.html} or
8377 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8378 and plain text (any other extension).  When called with a @kbd{C-u} prefix
8379 argument, immediately open the newly created file.  Use the variable
8380 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8381 for @file{htmlize} to be used during export.
8383 @tsubheading{Quit and Exit}
8384 @orgcmd{q,org-agenda-quit}
8385 Quit agenda, remove the agenda buffer.
8387 @cindex agenda files, removing buffers
8388 @orgcmd{x,org-agenda-exit}
8389 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8390 for the compilation of the agenda.  Buffers created by the user to
8391 visit Org files will not be removed.
8392 @end table
8395 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8396 @section Custom agenda views
8397 @cindex custom agenda views
8398 @cindex agenda views, custom
8400 Custom agenda commands serve two purposes: to store and quickly access
8401 frequently used TODO and tags searches, and to create special composite
8402 agenda buffers.  Custom agenda commands will be accessible through the
8403 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8405 @menu
8406 * Storing searches::            Type once, use often
8407 * Block agenda::                All the stuff you need in a single buffer
8408 * Setting Options::             Changing the rules
8409 @end menu
8411 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8412 @subsection Storing searches
8414 The first application of custom searches is the definition of keyboard
8415 shortcuts for frequently used searches, either creating an agenda
8416 buffer, or a sparse tree (the latter covering of course only the current
8417 buffer).
8418 @kindex C-c a C
8419 @vindex org-agenda-custom-commands
8420 Custom commands are configured in the variable
8421 @code{org-agenda-custom-commands}.  You can customize this variable, for
8422 example by pressing @kbd{C-c a C}.  You can also directly set it with
8423 Emacs Lisp in @file{.emacs}.  The following example contains all valid
8424 search types:
8426 @lisp
8427 @group
8428 (setq org-agenda-custom-commands
8429       '(("w" todo "WAITING")
8430         ("W" todo-tree "WAITING")
8431         ("u" tags "+boss-urgent")
8432         ("v" tags-todo "+boss-urgent")
8433         ("U" tags-tree "+boss-urgent")
8434         ("f" occur-tree "\\<FIXME\\>")
8435         ("h" . "HOME+Name tags searches") ; description for "h" prefix
8436         ("hl" tags "+home+Lisa")
8437         ("hp" tags "+home+Peter")
8438         ("hk" tags "+home+Kim")))
8439 @end group
8440 @end lisp
8442 @noindent
8443 The initial string in each entry defines the keys you have to press
8444 after the dispatcher command @kbd{C-c a} in order to access the command.
8445 Usually this will be just a single character, but if you have many
8446 similar commands, you can also define two-letter combinations where the
8447 first character is the same in several combinations and serves as a
8448 prefix key@footnote{You can provide a description for a prefix key by
8449 inserting a cons cell with the prefix and the description.}.  The second
8450 parameter is the search type, followed by the string or regular
8451 expression to be used for the matching.  The example above will
8452 therefore define:
8454 @table @kbd
8455 @item C-c a w
8456 as a global search for TODO entries with @samp{WAITING} as the TODO
8457 keyword
8458 @item C-c a W
8459 as the same search, but only in the current buffer and displaying the
8460 results as a sparse tree
8461 @item C-c a u
8462 as a global tags search for headlines marked @samp{:boss:} but not
8463 @samp{:urgent:}
8464 @item C-c a v
8465 as the same search as @kbd{C-c a u}, but limiting the search to
8466 headlines that are also TODO items
8467 @item C-c a U
8468 as the same search as @kbd{C-c a u}, but only in the current buffer and
8469 displaying the result as a sparse tree
8470 @item C-c a f
8471 to create a sparse tree (again: current buffer only) with all entries
8472 containing the word @samp{FIXME}
8473 @item C-c a h
8474 as a prefix command for a HOME tags search where you have to press an
8475 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8476 Peter, or Kim) as additional tag to match.
8477 @end table
8479 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8480 @subsection Block agenda
8481 @cindex block agenda
8482 @cindex agenda, with block views
8484 Another possibility is the construction of agenda views that comprise
8485 the results of @emph{several} commands, each of which creates a block in
8486 the agenda buffer.  The available commands include @code{agenda} for the
8487 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8488 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8489 matching commands discussed above: @code{todo}, @code{tags}, and
8490 @code{tags-todo}.  Here are two examples:
8492 @lisp
8493 @group
8494 (setq org-agenda-custom-commands
8495       '(("h" "Agenda and Home-related tasks"
8496          ((agenda "")
8497           (tags-todo "home")
8498           (tags "garden")))
8499         ("o" "Agenda and Office-related tasks"
8500          ((agenda "")
8501           (tags-todo "work")
8502           (tags "office")))))
8503 @end group
8504 @end lisp
8506 @noindent
8507 This will define @kbd{C-c a h} to create a multi-block view for stuff
8508 you need to attend to at home.  The resulting agenda buffer will contain
8509 your agenda for the current week, all TODO items that carry the tag
8510 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
8511 command @kbd{C-c a o} provides a similar view for office tasks.
8513 @node Setting Options,  , Block agenda, Custom agenda views
8514 @subsection Setting options for custom commands
8515 @cindex options, for custom agenda views
8517 @vindex org-agenda-custom-commands
8518 Org mode contains a number of variables regulating agenda construction
8519 and display.  The global variables define the behavior for all agenda
8520 commands, including the custom commands.  However, if you want to change
8521 some settings just for a single custom view, you can do so.  Setting
8522 options requires inserting a list of variable names and values at the
8523 right spot in @code{org-agenda-custom-commands}.  For example:
8525 @lisp
8526 @group
8527 (setq org-agenda-custom-commands
8528       '(("w" todo "WAITING"
8529          ((org-agenda-sorting-strategy '(priority-down))
8530           (org-agenda-prefix-format "  Mixed: ")))
8531         ("U" tags-tree "+boss-urgent"
8532          ((org-show-following-heading nil)
8533           (org-show-hierarchy-above nil)))
8534         ("N" search ""
8535          ((org-agenda-files '("~org/notes.org"))
8536           (org-agenda-text-search-extra-files nil)))))
8537 @end group
8538 @end lisp
8540 @noindent
8541 Now the @kbd{C-c a w} command will sort the collected entries only by
8542 priority, and the prefix format is modified to just say @samp{  Mixed: }
8543 instead of giving the category of the entry.  The sparse tags tree of
8544 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8545 headline hierarchy above the match, nor the headline following the match
8546 will be shown.  The command @kbd{C-c a N} will do a text search limited
8547 to only a single file.
8549 @vindex org-agenda-custom-commands
8550 For command sets creating a block agenda,
8551 @code{org-agenda-custom-commands} has two separate spots for setting
8552 options.  You can add options that should be valid for just a single
8553 command in the set, and options that should be valid for all commands in
8554 the set.  The former are just added to the command entry; the latter
8555 must come after the list of command entries.  Going back to the block
8556 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8557 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8558 the results for GARDEN tags query in the opposite order,
8559 @code{priority-up}.  This would look like this:
8561 @lisp
8562 @group
8563 (setq org-agenda-custom-commands
8564       '(("h" "Agenda and Home-related tasks"
8565          ((agenda)
8566           (tags-todo "home")
8567           (tags "garden"
8568                 ((org-agenda-sorting-strategy '(priority-up)))))
8569          ((org-agenda-sorting-strategy '(priority-down))))
8570         ("o" "Agenda and Office-related tasks"
8571          ((agenda)
8572           (tags-todo "work")
8573           (tags "office")))))
8574 @end group
8575 @end lisp
8577 As you see, the values and parentheses setting is a little complex.
8578 When in doubt, use the customize interface to set this variable---it
8579 fully supports its structure.  Just one caveat: when setting options in
8580 this interface, the @emph{values} are just Lisp expressions.  So if the
8581 value is a string, you need to add the double-quotes around the value
8582 yourself.
8585 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8586 @section Exporting Agenda Views
8587 @cindex agenda views, exporting
8589 If you are away from your computer, it can be very useful to have a printed
8590 version of some agenda views to carry around.  Org mode can export custom
8591 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8592 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8593 ghostscript @file{ps2pdf} utility must be installed on the system.  Selecting
8594 a PDF file will also create the postscript file.}, and iCalendar files.  If
8595 you want to do this only occasionally, use the command
8597 @table @kbd
8598 @orgcmd{C-x C-w,org-write-agenda}
8599 @cindex exporting agenda views
8600 @cindex agenda views, exporting
8601 @vindex org-agenda-exporter-settings
8602 Write the agenda view to a file.  Depending on the extension of the selected
8603 file name, the view will be exported as HTML (extension @file{.html} or
8604 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8605 @file{.ics}), or plain text (any other extension).  Use the variable
8606 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8607 for @file{htmlize} to be used during export, for example
8609 @vindex org-agenda-add-entry-text-maxlines
8610 @vindex htmlize-output-type
8611 @vindex ps-number-of-columns
8612 @vindex ps-landscape-mode
8613 @lisp
8614 (setq org-agenda-exporter-settings
8615       '((ps-number-of-columns 2)
8616         (ps-landscape-mode t)
8617         (org-agenda-add-entry-text-maxlines 5)
8618         (htmlize-output-type 'css)))
8619 @end lisp
8620 @end table
8622 If you need to export certain agenda views frequently, you can associate
8623 any custom agenda command with a list of output file names
8624 @footnote{If you want to store standard views like the weekly agenda
8625 or the global TODO list as well, you need to define custom commands for
8626 them in order to be able to specify file names.}.  Here is an example
8627 that first defines custom commands for the agenda and the global
8628 TODO list, together with a number of files to which to export them.
8629 Then we define two block agenda commands and specify file names for them
8630 as well.  File names can be relative to the current working directory,
8631 or absolute.
8633 @lisp
8634 @group
8635 (setq org-agenda-custom-commands
8636       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8637         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8638         ("h" "Agenda and Home-related tasks"
8639          ((agenda "")
8640           (tags-todo "home")
8641           (tags "garden"))
8642          nil
8643          ("~/views/home.html"))
8644         ("o" "Agenda and Office-related tasks"
8645          ((agenda)
8646           (tags-todo "work")
8647           (tags "office"))
8648          nil
8649          ("~/views/office.ps" "~/calendars/office.ics"))))
8650 @end group
8651 @end lisp
8653 The extension of the file name determines the type of export.  If it is
8654 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
8655 the buffer to HTML and save it to this file name.  If the extension is
8656 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8657 Postscript output.  If the extension is @file{.ics}, iCalendar export is
8658 run export over all files that were used to construct the agenda, and
8659 limit the export to entries listed in the agenda.  Any other
8660 extension produces a plain ASCII file.
8662 The export files are @emph{not} created when you use one of those
8663 commands interactively because this might use too much overhead.
8664 Instead, there is a special command to produce @emph{all} specified
8665 files in one step:
8667 @table @kbd
8668 @orgcmd{C-c a e,org-store-agenda-views}
8669 Export all agenda views that have export file names associated with
8670 them.
8671 @end table
8673 You can use the options section of the custom agenda commands to also
8674 set options for the export commands.  For example:
8676 @lisp
8677 (setq org-agenda-custom-commands
8678       '(("X" agenda ""
8679          ((ps-number-of-columns 2)
8680           (ps-landscape-mode t)
8681           (org-agenda-prefix-format " [ ] ")
8682           (org-agenda-with-colors nil)
8683           (org-agenda-remove-tags t))
8684          ("theagenda.ps"))))
8685 @end lisp
8687 @noindent
8688 This command sets two options for the Postscript exporter, to make it
8689 print in two columns in landscape format---the resulting page can be cut
8690 in two and then used in a paper agenda.  The remaining settings modify
8691 the agenda prefix to omit category and scheduling information, and
8692 instead include a checkbox to check off items.  We also remove the tags
8693 to make the lines compact, and we don't want to use colors for the
8694 black-and-white printer.  Settings specified in
8695 @code{org-agenda-exporter-settings} will also apply, but the settings
8696 in @code{org-agenda-custom-commands} take precedence.
8698 @noindent
8699 From the command line you may also use
8700 @example
8701 emacs -eval (org-batch-store-agenda-views) -kill
8702 @end example
8703 @noindent
8704 or, if you need to modify some parameters@footnote{Quoting depends on the
8705 system you use, please check the FAQ for examples.}
8706 @example
8707 emacs -eval '(org-batch-store-agenda-views                      \
8708               org-agenda-span (quote month)                     \
8709               org-agenda-start-day "2007-11-01"                 \
8710               org-agenda-include-diary nil                      \
8711               org-agenda-files (quote ("~/org/project.org")))'  \
8712       -kill
8713 @end example
8714 @noindent
8715 which will create the agenda views restricted to the file
8716 @file{~/org/project.org}, without diary entries and with a 30-day
8717 extent.
8719 You can also extract agenda information in a way that allows further
8720 processing by other programs.  See @ref{Extracting agenda information}, for
8721 more information.
8724 @node Agenda column view,  , Exporting Agenda Views, Agenda Views
8725 @section Using column view in the agenda
8726 @cindex column view, in agenda
8727 @cindex agenda, column view
8729 Column view (@pxref{Column view}) is normally used to view and edit
8730 properties embedded in the hierarchical structure of an Org file.  It can be
8731 quite useful to use column view also from the agenda, where entries are
8732 collected by certain criteria.
8734 @table @kbd
8735 @orgcmd{C-c C-x C-c,org-agenda-columns}
8736 Turn on column view in the agenda.
8737 @end table
8739 To understand how to use this properly, it is important to realize that the
8740 entries in the agenda are no longer in their proper outline environment.
8741 This causes the following issues:
8743 @enumerate
8744 @item
8745 @vindex org-columns-default-format
8746 @vindex org-overriding-columns-format
8747 Org needs to make a decision which @code{COLUMNS} format to use.  Since the
8748 entries in the agenda are collected from different files, and different files
8749 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8750 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
8751 currently set, and if so, takes the format from there.  Otherwise it takes
8752 the format associated with the first item in the agenda, or, if that item
8753 does not have a specific format (defined in a property, or in its file), it
8754 uses @code{org-columns-default-format}.
8755 @item
8756 @cindex property, special, CLOCKSUM
8757 If any of the columns has a summary type defined (@pxref{Column attributes}),
8758 turning on column view in the agenda will visit all relevant agenda files and
8759 make sure that the computations of this property are up to date.  This is
8760 also true for the special @code{CLOCKSUM} property.  Org will then sum the
8761 values displayed in the agenda.  In the daily/weekly agenda, the sums will
8762 cover a single day; in all other views they cover the entire block.  It is
8763 vital to realize that the agenda may show the same entry @emph{twice} (for
8764 example as scheduled and as a deadline), and it may show two entries from the
8765 same hierarchy (for example a @emph{parent} and its @emph{child}).  In these
8766 cases, the summation in the agenda will lead to incorrect results because
8767 some values will count double.
8768 @item
8769 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8770 the entire clocked time for this item.  So even in the daily/weekly agenda,
8771 the clocksum listed in column view may originate from times outside the
8772 current view.  This has the advantage that you can compare these values with
8773 a column listing the planned total effort for a task---one of the major
8774 applications for column view in the agenda.  If you want information about
8775 clocked time in the displayed period use clock table mode (press @kbd{R} in
8776 the agenda).
8777 @end enumerate
8780 @node Markup, Exporting, Agenda Views, Top
8781 @chapter Markup for rich export
8783 When exporting Org mode documents, the exporter tries to reflect the
8784 structure of the document as accurately as possible in the backend.  Since
8785 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
8786 Org mode has rules on how to prepare text for rich export.  This section
8787 summarizes the markup rules used in an Org mode buffer.
8789 @menu
8790 * Structural markup elements::  The basic structure as seen by the exporter
8791 * Images and tables::           Tables and Images will be included
8792 * Literal examples::            Source code examples with special formatting
8793 * Include files::               Include additional files into a document
8794 * Index entries::               Making an index
8795 * Macro replacement::           Use macros to create complex output
8796 * Embedded LaTeX::              LaTeX can be freely used inside Org documents
8797 @end menu
8799 @node Structural markup elements, Images and tables, Markup, Markup
8800 @section Structural markup elements
8802 @menu
8803 * Document title::              Where the title is taken from
8804 * Headings and sections::       The document structure as seen by the exporter
8805 * Table of contents::           The if and where of the table of contents
8806 * Initial text::                Text before the first heading?
8807 * Lists::                       Lists
8808 * Paragraphs::                  Paragraphs
8809 * Footnote markup::             Footnotes
8810 * Emphasis and monospace::      Bold, italic, etc.
8811 * Horizontal rules::            Make a line
8812 * Comment lines::               What will *not* be exported
8813 @end menu
8815 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8816 @subheading Document title
8817 @cindex document title, markup rules
8819 @noindent
8820 The title of the exported document is taken from the special line
8822 @cindex #+TITLE
8823 @example
8824 #+TITLE: This is the title of the document
8825 @end example
8827 @noindent
8828 If this line does not exist, the title is derived from the first non-empty,
8829 non-comment line in the buffer.  If no such line exists, or if you have
8830 turned off exporting of the text before the first headline (see below), the
8831 title will be the file name without extension.
8833 @cindex property, EXPORT_TITLE
8834 If you are exporting only a subtree by marking is as the region, the heading
8835 of the subtree will become the title of the document.  If the subtree has a
8836 property @code{EXPORT_TITLE}, that will take precedence.
8838 @node Headings and sections, Table of contents, Document title, Structural markup elements
8839 @subheading Headings and sections
8840 @cindex headings and sections, markup rules
8842 @vindex org-export-headline-levels
8843 The outline structure of the document as described in @ref{Document
8844 Structure}, forms the basis for defining sections of the exported document.
8845 However, since the outline structure is also used for (for example) lists of
8846 tasks, only the first three outline levels will be used as headings.  Deeper
8847 levels will become itemized lists.  You can change the location of this
8848 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8849 per-file basis with a line
8851 @cindex #+OPTIONS
8852 @example
8853 #+OPTIONS: H:4
8854 @end example
8856 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8857 @subheading Table of contents
8858 @cindex table of contents, markup rules
8860 @vindex org-export-with-toc
8861 The table of contents is normally inserted directly before the first headline
8862 of the file.  If you would like to get it to a different location, insert the
8863 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8864 location.  The depth of the table of contents is by default the same as the
8865 number of headline levels, but you can choose a smaller number, or turn off
8866 the table of contents entirely, by configuring the variable
8867 @code{org-export-with-toc}, or on a per-file basis with a line like
8869 @example
8870 #+OPTIONS: toc:2          (only to two levels in TOC)
8871 #+OPTIONS: toc:nil        (no TOC at all)
8872 @end example
8874 @node Initial text, Lists, Table of contents, Structural markup elements
8875 @subheading Text before the first headline
8876 @cindex text before first headline, markup rules
8877 @cindex #+TEXT
8879 Org mode normally exports the text before the first headline, and even uses
8880 the first line as the document title.  The text will be fully marked up.  If
8881 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
8882 constructs described below in the sections for the individual exporters.
8884 @vindex org-export-skip-text-before-1st-heading
8885 Some people like to use the space before the first headline for setup and
8886 internal links and therefore would like to control the exported text before
8887 the first headline in a different way.  You can do so by setting the variable
8888 @code{org-export-skip-text-before-1st-heading} to @code{t}.  On a per-file
8889 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8891 @noindent
8892 If you still want to have some text before the first headline, use the
8893 @code{#+TEXT} construct:
8895 @example
8896 #+OPTIONS: skip:t
8897 #+TEXT: This text will go before the *first* headline.
8898 #+TEXT: [TABLE-OF-CONTENTS]
8899 #+TEXT: This goes between the table of contents and the *first* headline
8900 @end example
8902 @node Lists, Paragraphs, Initial text, Structural markup elements
8903 @subheading Lists
8904 @cindex lists, markup rules
8906 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8907 syntax for such lists.  Most backends support unordered, ordered, and
8908 description lists.
8910 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8911 @subheading Paragraphs, line breaks, and quoting
8912 @cindex paragraphs, markup rules
8914 Paragraphs are separated by at least one empty line.  If you need to enforce
8915 a line break within a paragraph, use @samp{\\} at the end of a line.
8917 To keep the line breaks in a region, but otherwise use normal formatting, you
8918 can use this construct, which can also be used to format poetry.
8920 @cindex #+BEGIN_VERSE
8921 @example
8922 #+BEGIN_VERSE
8923  Great clouds overhead
8924  Tiny black birds rise and fall
8925  Snow covers Emacs
8927      -- AlexSchroeder
8928 #+END_VERSE
8929 @end example
8931 When quoting a passage from another document, it is customary to format this
8932 as a paragraph that is indented on both the left and the right margin.  You
8933 can include quotations in Org mode documents like this:
8935 @cindex #+BEGIN_QUOTE
8936 @example
8937 #+BEGIN_QUOTE
8938 Everything should be made as simple as possible,
8939 but not any simpler -- Albert Einstein
8940 #+END_QUOTE
8941 @end example
8943 If you would like to center some text, do it like this:
8944 @cindex #+BEGIN_CENTER
8945 @example
8946 #+BEGIN_CENTER
8947 Everything should be made as simple as possible, \\
8948 but not any simpler
8949 #+END_CENTER
8950 @end example
8953 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8954 @subheading Footnote markup
8955 @cindex footnotes, markup rules
8956 @cindex @file{footnote.el}
8958 Footnotes defined in the way described in @ref{Footnotes}, will be exported
8959 by all backends.  Org allows multiple references to the same note, and
8960 multiple footnotes side by side.
8962 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8963 @subheading Emphasis and monospace
8965 @cindex underlined text, markup rules
8966 @cindex bold text, markup rules
8967 @cindex italic text, markup rules
8968 @cindex verbatim text, markup rules
8969 @cindex code text, markup rules
8970 @cindex strike-through text, markup rules
8971 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8972 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}.  Text
8973 in the code and verbatim string is not processed for Org mode specific
8974 syntax; it is exported verbatim.
8976 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8977 @subheading  Horizontal rules
8978 @cindex horizontal rules, markup rules
8979 A line consisting of only dashes, and at least 5 of them, will be exported as
8980 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
8982 @node Comment lines,  , Horizontal rules, Structural markup elements
8983 @subheading Comment lines
8984 @cindex comment lines
8985 @cindex exporting, not
8986 @cindex #+BEGIN_COMMENT
8988 Lines starting with @samp{#} in column zero are treated as comments and will
8989 never be exported.  If you want an indented line to be treated as a comment,
8990 start it with @samp{#+ }.  Also entire subtrees starting with the word
8991 @samp{COMMENT} will never be exported.  Finally, regions surrounded by
8992 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8994 @table @kbd
8995 @kindex C-c ;
8996 @item C-c ;
8997 Toggle the COMMENT keyword at the beginning of an entry.
8998 @end table
9001 @node Images and tables, Literal examples, Structural markup elements, Markup
9002 @section Images and Tables
9004 @cindex tables, markup rules
9005 @cindex #+CAPTION
9006 @cindex #+LABEL
9007 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9008 the @file{table.el} package will be exported properly.  For Org mode tables,
9009 the lines before the first horizontal separator line will become table header
9010 lines.  You can use the following lines somewhere before the table to assign
9011 a caption and a label for cross references, and in the text you can refer to
9012 the object with @code{\ref@{tab:basic-data@}}:
9014 @example
9015 #+CAPTION: This is the caption for the next table (or link)
9016 #+LABEL:   tbl:basic-data
9017    | ... | ...|
9018    |-----|----|
9019 @end example
9021 Optionally, the caption can take the form:
9022 @example
9023 #+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
9024 @end example
9026 @cindex inlined images, markup rules
9027 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
9028 images into the exported document.  Org does this, if a link to an image
9029 files does not have a description part, for example @code{[[./img/a.jpg]]}.
9030 If you wish to define a caption for the image and maybe a label for internal
9031 cross references, make sure that the link is on a line by itself and precede
9032 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
9034 @example
9035 #+CAPTION: This is the caption for the next figure link (or table)
9036 #+LABEL:   fig:SED-HR4049
9037 [[./img/a.jpg]]
9038 @end example
9040 You may also define additional attributes for the figure.  As this is
9041 backend-specific, see the sections about the individual backends for more
9042 information.
9044 @xref{Handling links,the discussion of image links}.
9046 @node Literal examples, Include files, Images and tables, Markup
9047 @section Literal examples
9048 @cindex literal examples, markup rules
9049 @cindex code line references, markup rules
9051 You can include literal examples that should not be subjected to
9052 markup.  Such examples will be typeset in monospace, so this is well suited
9053 for source code and similar examples.
9054 @cindex #+BEGIN_EXAMPLE
9056 @example
9057 #+BEGIN_EXAMPLE
9058 Some example from a text file.
9059 #+END_EXAMPLE
9060 @end example
9062 Note that such blocks may be @i{indented} in order to align nicely with
9063 indented text and in particular with plain list structure (@pxref{Plain
9064 lists}).  For simplicity when using small examples, you can also start the
9065 example lines with a colon followed by a space.  There may also be additional
9066 whitespace before the colon:
9068 @example
9069 Here is an example
9070    : Some example from a text file.
9071 @end example
9073 @cindex formatting source code, markup rules
9074 If the example is source code from a programming language, or any other text
9075 that can be marked up by font-lock in Emacs, you can ask for the example to
9076 look like the fontified Emacs buffer@footnote{This works automatically for
9077 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
9078 which is distributed with Org).  Fontified code chunks in LaTeX can be
9079 achieved using either the listings or the
9080 @url{http://code.google.com/p/minted, minted,} package.  To use listings, turn
9081 on the variable @code{org-export-latex-listings} and ensure that the listings
9082 package is included by the LaTeX header (e.g.@: by configuring
9083 @code{org-export-latex-packages-alist}).  See the listings documentation for
9084 configuration options, including obtaining colored output.  For minted it is
9085 necessary to install the program @url{http://pygments.org, pygments}, in
9086 addition to setting @code{org-export-latex-minted}, ensuring that the minted
9087 package is included by the LaTeX header, and ensuring that the
9088 @code{-shell-escape} option is passed to @file{pdflatex} (see
9089 @code{org-latex-to-pdf-process}).  See the documentation of the variables
9090 @code{org-export-latex-listings} and @code{org-export-latex-minted} for
9091 further details.}.  This is done with the @samp{src} block, where you also
9092 need to specify the name of the major mode that should be used to fontify the
9093 example@footnote{Code in @samp{src} blocks may also be evaluated either
9094 interactively or on export.  See @pxref{Working With Source Code} for more
9095 information on evaluating code blocks.}, see @ref{Easy Templates} for
9096 shortcuts to easily insert code blocks.
9097 @cindex #+BEGIN_SRC
9099 @example
9100 #+BEGIN_SRC emacs-lisp
9101   (defun org-xor (a b)
9102      "Exclusive or."
9103      (if a (not b) b))
9104 #+END_SRC
9105 @end example
9107 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9108 switch to the end of the @code{BEGIN} line, to get the lines of the example
9109 numbered.  If you use a @code{+n} switch, the numbering from the previous
9110 numbered snippet will be continued in the current one.  In literal examples,
9111 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9112 targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
9113 enclosed in single parenthesis).  In HTML, hovering the mouse over such a
9114 link will remote-highlight the corresponding code line, which is kind of
9115 cool.
9117 You can also add a @code{-r} switch which @i{removes} the labels from the
9118 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9119 labels in the source code while using line numbers for the links, which might
9120 be useful to explain those in an Org mode example code.}.  With the @code{-n}
9121 switch, links to these references will be labeled by the line numbers from
9122 the code listing, otherwise links will use the labels with no parentheses.
9123 Here is an example:
9125 @example
9126 #+BEGIN_SRC emacs-lisp -n -r
9127 (save-excursion                  (ref:sc)
9128    (goto-char (point-min))       (ref:jump)
9129 #+END_SRC
9130 In line [[(sc)]] we remember the current position.  [[(jump)][Line (jump)]]
9131 jumps to point-min.
9132 @end example
9134 @vindex org-coderef-label-format
9135 If the syntax for the label format conflicts with the language syntax, use a
9136 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9137 -n -r -l "((%s))"}.  See also the variable @code{org-coderef-label-format}.
9139 HTML export also allows examples to be published as text areas (@pxref{Text
9140 areas in HTML export}).
9142 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9143 so often, shortcuts are provided using the Easy Templates facility
9144 (@pxref{Easy Templates}).
9146 @table @kbd
9147 @kindex C-c '
9148 @item C-c '
9149 Edit the source code example at point in its native mode.  This works by
9150 switching to a temporary buffer with the source code.  You need to exit by
9151 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
9152 or @samp{#} will get a comma prepended, to keep them from being interpreted
9153 by Org as outline nodes or special comments.  These commas will be stripped
9154 for editing with @kbd{C-c '}, and also for export.}.  The edited version will
9155 then replace the old version in the Org buffer.  Fixed-width regions
9156 (where each line starts with a colon followed by a space) will be edited
9157 using @code{artist-mode}@footnote{You may select a different-mode with the
9158 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
9159 drawings easily.  Using this command in an empty line will create a new
9160 fixed-width region.
9161 @kindex C-c l
9162 @item C-c l
9163 Calling @code{org-store-link} while editing a source code example in a
9164 temporary buffer created with @kbd{C-c '} will prompt for a label.  Make sure
9165 that it is unique in the current buffer, and insert it with the proper
9166 formatting like @samp{(ref:label)} at the end of the current line.  Then the
9167 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9168 @end table
9171 @node Include files, Index entries, Literal examples, Markup
9172 @section Include files
9173 @cindex include files, markup rules
9175 During export, you can include the content of another file.  For example, to
9176 include your @file{.emacs} file, you could use:
9177 @cindex #+INCLUDE
9179 @example
9180 #+INCLUDE: "~/.emacs" src emacs-lisp
9181 @end example
9182 @noindent
9183 The optional second and third parameter are the markup (e.g.@: @samp{quote},
9184 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9185 language for formatting the contents.  The markup is optional; if it is not
9186 given, the text will be assumed to be in Org mode format and will be
9187 processed normally.  The include line will also allow additional keyword
9188 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
9189 first line and for each following line, @code{:minlevel} in order to get
9190 Org mode content demoted to a specified level, as well as any options
9191 accepted by the selected markup.  For example, to include a file as an item,
9194 @example
9195 #+INCLUDE: "~/snippets/xx" :prefix1 "   + " :prefix "     "
9196 @end example
9198 You can also include a portion of a file by specifying a lines range using
9199 the @code{:lines} parameter.  The line at the upper end of the range will not
9200 be included.  The start and/or the end of the range may be omitted to use the
9201 obvious defaults.
9203 @example
9204 #+INCLUDE: "~/.emacs" :lines "5-10"   @r{Include lines 5 to 10, 10 excluded}
9205 #+INCLUDE: "~/.emacs" :lines "-10"    @r{Include lines 1 to 10, 10 excluded}
9206 #+INCLUDE: "~/.emacs" :lines "10-"    @r{Include lines from 10 to EOF}
9207 @end example
9209 @table @kbd
9210 @kindex C-c '
9211 @item C-c '
9212 Visit the include file at point.
9213 @end table
9215 @node Index entries, Macro replacement, Include files, Markup
9216 @section Index entries
9217 @cindex index entries, for publishing
9219 You can specify entries that will be used for generating an index during
9220 publishing.  This is done by lines starting with @code{#+INDEX}.  An entry
9221 the contains an exclamation mark will create a sub item.  See @ref{Generating
9222 an index} for more information.
9224 @example
9225 * Curriculum Vitae
9226 #+INDEX: CV
9227 #+INDEX: Application!CV
9228 @end example
9233 @node Macro replacement, Embedded LaTeX, Index entries, Markup
9234 @section Macro replacement
9235 @cindex macro replacement, during export
9236 @cindex #+MACRO
9238 You can define text snippets with
9240 @example
9241 #+MACRO: name   replacement text $1, $2 are arguments
9242 @end example
9244 @noindent which can be referenced anywhere in the document (even in
9245 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}.  In addition to
9246 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
9247 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
9248 similar lines.  Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9249 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9250 and to the modification time of the file being exported, respectively.
9251 @var{FORMAT} should be a format string understood by
9252 @code{format-time-string}.
9254 Macro expansion takes place during export, and some people use it to
9255 construct complex HTML code.
9258 @node Embedded LaTeX,  , Macro replacement, Markup
9259 @section Embedded @LaTeX{}
9260 @cindex @TeX{} interpretation
9261 @cindex @LaTeX{} interpretation
9263 Plain ASCII is normally sufficient for almost all note taking.  Exceptions
9264 include scientific notes, which often require mathematical symbols and the
9265 occasional formula.  @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9266 Donald E. Knuth's @TeX{} system.  Many of the features described here as
9267 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9268 distinction.}  is widely used to typeset scientific documents.  Org mode
9269 supports embedding @LaTeX{} code into its files, because many academics are
9270 used to writing and reading @LaTeX{} source code, and because it can be
9271 readily processed to produce pretty output for a number of export backends.
9273 @menu
9274 * Special symbols::             Greek letters and other symbols
9275 * Subscripts and superscripts::  Simple syntax for raising/lowering text
9276 * LaTeX fragments::             Complex formulas made easy
9277 * Previewing LaTeX fragments::  What will this snippet look like?
9278 * CDLaTeX mode::                Speed up entering of formulas
9279 @end menu
9281 @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
9282 @subsection Special symbols
9283 @cindex math symbols
9284 @cindex special symbols
9285 @cindex @TeX{} macros
9286 @cindex @LaTeX{} fragments, markup rules
9287 @cindex HTML entities
9288 @cindex @LaTeX{} entities
9290 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
9291 indicate the Greek letter, or @samp{\to} to indicate an arrow.  Completion
9292 for these macros is available, just type @samp{\} and maybe a few letters,
9293 and press @kbd{M-@key{TAB}} to see possible completions.  Unlike @LaTeX{}
9294 code, Org mode allows these macros to be present without surrounding math
9295 delimiters, for example:
9297 @example
9298 Angles are written as Greek letters \alpha, \beta and \gamma.
9299 @end example
9301 @vindex org-entities
9302 During export, these symbols will be transformed into the native format of
9303 the exporter backend.  Strings like @code{\alpha} will be exported as
9304 @code{&alpha;} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9305 output.  Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
9306 @code{~} in @LaTeX{}.  If you need such a symbol inside a word, terminate it
9307 like this: @samp{\Aacute@{@}stor}.
9309 A large number of entities is provided, with names taken from both HTML and
9310 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9311 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9312 @samp{...} are all converted into special commands creating hyphens of
9313 different lengths or a compact set of dots.
9315 If you would like to see entities displayed as UTF8 characters, use the
9316 following command@footnote{You can turn this on by default by setting the
9317 variable @code{org-pretty-entities}, or on a per-file base with the
9318 @code{#+STARTUP} option @code{entitiespretty}.}:
9320 @table @kbd
9321 @kindex C-c C-x \
9322 @item C-c C-x \
9323 Toggle display of entities as UTF-8 characters.  This does not change the
9324 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9325 for display purposes only.
9326 @end table
9328 @node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
9329 @subsection Subscripts and superscripts
9330 @cindex subscript
9331 @cindex superscript
9333 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9334 and subscripts.  Again, these can be used without embedding them in
9335 math-mode delimiters.  To increase the readability of ASCII text, it is
9336 not necessary (but OK) to surround multi-character sub- and superscripts
9337 with curly braces.  For example
9339 @example
9340 The mass of the sun is M_sun = 1.989 x 10^30 kg.  The radius of
9341 the sun is R_@{sun@} = 6.96 x 10^8 m.
9342 @end example
9344 @vindex org-export-with-sub-superscripts
9345 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9346 @samp{_} with a backslash: @samp{\^} and @samp{\_}.  If you write a text
9347 where the underscore is often used in a different context, Org's convention
9348 to always interpret these as subscripts can get in your way.  Configure the
9349 variable @code{org-export-with-sub-superscripts} to globally change this
9350 convention, or use, on a per-file basis:
9352 @example
9353 #+OPTIONS: ^:@{@}
9354 @end example
9356 @noindent With this setting, @samp{a_b} will not be interpreted as a
9357 subscript, but @samp{a_@{b@}} will.
9359 @table @kbd
9360 @kindex C-c C-x \
9361 @item C-c C-x \
9362 In addition to showing entities as UTF-8 characters, this command will also
9363 format sub- and superscripts in a WYSIWYM way.
9364 @end table
9366 @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
9367 @subsection @LaTeX{} fragments
9368 @cindex @LaTeX{} fragments
9370 @vindex org-format-latex-header
9371 Going beyond symbols and sub- and superscripts, a full formula language is
9372 needed.  Org mode can contain @LaTeX{} math fragments, and it supports ways
9373 to process these for several export backends.  When exporting to @LaTeX{},
9374 the code is obviously left as it is.  When exporting to HTML, Org invokes the
9375 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9376 HTML export}) to process and display the math@footnote{If you plan to use
9377 this regularly or on pages with significant page views, you should install
9378 @file{MathJax} on your own
9379 server in order to limit the load of our server.}.  Finally, it can also
9380 process the mathematical expressions into images@footnote{For this to work
9381 you need to be on a system with a working @LaTeX{} installation.  You also
9382 need the @file{dvipng} program, available at
9383 @url{http://sourceforge.net/projects/dvipng/}.  The @LaTeX{} header that will
9384 be used when processing a fragment can be configured with the variable
9385 @code{org-format-latex-header}.}  that can be displayed in a browser or in
9386 DocBook documents.
9388 @LaTeX{} fragments don't need any special marking at all.  The following
9389 snippets will be identified as @LaTeX{} source code:
9390 @itemize @bullet
9391 @item
9392 Environments of any kind@footnote{When @file{MathJax} is used, only the
9393 environment recognized by @file{MathJax} will be processed.  When
9394 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9395 handled.}.  The only requirement is that the @code{\begin} statement appears
9396 on a new line, preceded by only whitespace.
9397 @item
9398 Text within the usual @LaTeX{} math delimiters.  To avoid conflicts with
9399 currency specifications, single @samp{$} characters are only recognized as
9400 math delimiters if the enclosed text contains at most two line breaks, is
9401 directly attached to the @samp{$} characters with no whitespace in between,
9402 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9403 For the other delimiters, there is no such restriction, so when in doubt, use
9404 @samp{\(...\)} as inline math delimiters.
9405 @end itemize
9407 @noindent For example:
9409 @example
9410 \begin@{equation@}                          % arbitrary environments,
9411 x=\sqrt@{b@}                                % even tables, figures
9412 \end@{equation@}                            % etc
9414 If $a^2=b$ and \( b=2 \), then the solution must be
9415 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9416 @end example
9418 @noindent
9419 @vindex org-format-latex-options
9420 If you need any of the delimiter ASCII sequences for other purposes, you
9421 can configure the option @code{org-format-latex-options} to deselect the
9422 ones you do not wish to have interpreted by the @LaTeX{} converter.
9424 @vindex org-export-with-LaTeX-fragments
9425 LaTeX processing can be configured with the variable
9426 @code{org-export-with-LaTeX-fragments}.  The default setting is @code{t}
9427 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9428 LaTeX backends.  You can also set this variable on a per-file basis using one
9429 of these lines:
9431 @example
9432 #+OPTIONS: LaTeX:t          @r{Do the right thing automatically (MathJax)}
9433 #+OPTIONS: LaTeX:dvipng     @r{Force using dvipng images}
9434 #+OPTIONS: LaTeX:nil        @r{Do not process @LaTeX{} fragments at all}
9435 #+OPTIONS: LaTeX:verbatim   @r{Verbatim export, for jsMath or so}
9436 @end example
9438 @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
9439 @subsection Previewing LaTeX fragments
9440 @cindex LaTeX fragments, preview
9442 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9443 produce preview images of the typeset expressions:
9445 @table @kbd
9446 @kindex C-c C-x C-l
9447 @item C-c C-x C-l
9448 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9449 over the source code.  If there is no fragment at point, process all
9450 fragments in the current entry (between two headlines).  When called
9451 with a prefix argument, process the entire subtree.  When called with
9452 two prefix arguments, or when the cursor is before the first headline,
9453 process the entire buffer.
9454 @kindex C-c C-c
9455 @item C-c C-c
9456 Remove the overlay preview images.
9457 @end table
9459 @vindex org-format-latex-options
9460 You can customize the variable @code{org-format-latex-options} to influence
9461 some aspects of the preview.  In particular, the @code{:scale} (and for HTML
9462 export, @code{:html-scale}) property can be used to adjust the size of the
9463 preview images.
9465 @node CDLaTeX mode,  , Previewing LaTeX fragments, Embedded LaTeX
9466 @subsection Using CDLa@TeX{} to enter math
9467 @cindex CDLa@TeX{}
9469 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
9470 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9471 environments and math templates.  Inside Org mode, you can make use of
9472 some of the features of CDLa@TeX{} mode.  You need to install
9473 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9474 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9475 Don't use CDLa@TeX{} mode itself under Org mode, but use the light
9476 version @code{org-cdlatex-mode} that comes as part of Org mode.  Turn it
9477 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9478 Org files with
9480 @lisp
9481 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9482 @end lisp
9484 When this mode is enabled, the following features are present (for more
9485 details see the documentation of CDLa@TeX{} mode):
9486 @itemize @bullet
9487 @kindex C-c @{
9488 @item
9489 Environment templates can be inserted with @kbd{C-c @{}.
9490 @item
9491 @kindex @key{TAB}
9492 The @key{TAB} key will do template expansion if the cursor is inside a
9493 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
9494 inside such a fragment, see the documentation of the function
9495 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
9496 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9497 correctly inside the first brace.  Another @key{TAB} will get you into
9498 the second brace.  Even outside fragments, @key{TAB} will expand
9499 environment abbreviations at the beginning of a line.  For example, if
9500 you write @samp{equ} at the beginning of a line and press @key{TAB},
9501 this abbreviation will be expanded to an @code{equation} environment.
9502 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9503 @item
9504 @kindex _
9505 @kindex ^
9506 @vindex cdlatex-simplify-sub-super-scripts
9507 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9508 characters together with a pair of braces.  If you use @key{TAB} to move
9509 out of the braces, and if the braces surround only a single character or
9510 macro, they are removed again (depending on the variable
9511 @code{cdlatex-simplify-sub-super-scripts}).
9512 @item
9513 @kindex `
9514 Pressing the backquote @kbd{`} followed by a character inserts math
9515 macros, also outside @LaTeX{} fragments.  If you wait more than 1.5 seconds
9516 after the backquote, a help window will pop up.
9517 @item
9518 @kindex '
9519 Pressing the single-quote @kbd{'} followed by another character modifies
9520 the symbol before point with an accent or a font.  If you wait more than
9521 1.5 seconds after the single-quote, a help window will pop up.  Character
9522 modification will work only inside @LaTeX{} fragments; outside the quote
9523 is normal.
9524 @end itemize
9526 @node Exporting, Publishing, Markup, Top
9527 @chapter Exporting
9528 @cindex exporting
9530 Org mode documents can be exported into a variety of other formats.  For
9531 printing and sharing of notes, ASCII export produces a readable and simple
9532 version of an Org file.  HTML export allows you to publish a notes file on
9533 the web, while the XOXO format provides a solid base for exchange with a
9534 broad range of other applications.  @LaTeX{} export lets you use Org mode and
9535 its structured editing functions to easily create @LaTeX{} files.  DocBook
9536 export makes it possible to convert Org files to many other formats using
9537 DocBook tools.  OpenDocument Text(@acronym{ODT}) export allows seamless
9538 colloboration across organizational boundaries.  For project management you
9539 can create gantt and resource charts by using TaskJuggler export.  To
9540 incorporate entries with associated times like deadlines or appointments into
9541 a desktop calendar program like iCal, Org mode can also produce extracts in
9542 the iCalendar format.  Currently Org mode only supports export, not import of
9543 these different formats.
9545 Org supports export of selected regions when @code{transient-mark-mode} is
9546 enabled (default in Emacs 23).
9548 @menu
9549 * Selective export::            Using tags to select and exclude trees
9550 * Export options::              Per-file export settings
9551 * The export dispatcher::       How to access exporter commands
9552 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
9553 * HTML export::                 Exporting to HTML
9554 * LaTeX and PDF export::        Exporting to @LaTeX{}, and processing to PDF
9555 * DocBook export::              Exporting to DocBook
9556 * OpenDocument Text export::    Exporting to OpenDocument Text
9557 * TaskJuggler export::          Exporting to TaskJuggler
9558 * Freemind export::             Exporting to Freemind mind maps
9559 * XOXO export::                 Exporting to XOXO
9560 * iCalendar export::            Exporting in iCalendar format
9561 @end menu
9563 @node Selective export, Export options, Exporting, Exporting
9564 @section Selective export
9565 @cindex export, selective by tags or TODO keyword
9567 @vindex org-export-select-tags
9568 @vindex org-export-exclude-tags
9569 @cindex org-export-with-tasks
9570 You may use tags to select the parts of a document that should be exported,
9571 or to exclude parts from export.  This behavior is governed by two variables:
9572 @code{org-export-select-tags} and @code{org-export-exclude-tags},
9573 respectively defaulting to @code{'(:export:)} and @code{'(:noexport:)}.
9575 @enumerate
9576 @item
9577 Org first checks if any of the @emph{select} tags is present in the
9578 buffer.  If yes, all trees that do not carry one of these tags will be
9579 excluded.  If a selected tree is a subtree, the heading hierarchy above it
9580 will also be selected for export, but not the text below those headings.
9582 @item
9583 If none of the select tags is found, the whole buffer will be selected for
9584 export.
9586 @item
9587 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9588 be removed from the export buffer.
9589 @end enumerate
9591 The variable @code{org-export-with-tasks} can be configured to select which
9592 kind of tasks should be included for export.  See the docstring of the
9593 variable for more information.
9595 @node Export options, The export dispatcher, Selective export, Exporting
9596 @section Export options
9597 @cindex options, for export
9599 @cindex completion, of option keywords
9600 The exporter recognizes special lines in the buffer which provide
9601 additional information.  These lines may be put anywhere in the file.
9602 The whole set of lines can be inserted into the buffer with @kbd{C-c
9603 C-e t}.  For individual lines, a good way to make sure the keyword is
9604 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9605 (@pxref{Completion}).   For a summary of other in-buffer settings not
9606 specifically related to export, see @ref{In-buffer settings}.
9607 In particular, note that you can place commonly-used (export) options in
9608 a separate file which can be included using @code{#+SETUPFILE}.
9610 @table @kbd
9611 @orgcmd{C-c C-e t,org-insert-export-options-template}
9612 Insert template with export options, see example below.
9613 @end table
9615 @cindex #+TITLE
9616 @cindex #+AUTHOR
9617 @cindex #+DATE
9618 @cindex #+EMAIL
9619 @cindex #+DESCRIPTION
9620 @cindex #+KEYWORDS
9621 @cindex #+LANGUAGE
9622 @cindex #+TEXT
9623 @cindex #+OPTIONS
9624 @cindex #+BIND
9625 @cindex #+LINK_UP
9626 @cindex #+LINK_HOME
9627 @cindex #+EXPORT_SELECT_TAGS
9628 @cindex #+EXPORT_EXCLUDE_TAGS
9629 @cindex #+XSLT
9630 @cindex #+LATEX_HEADER
9631 @vindex user-full-name
9632 @vindex user-mail-address
9633 @vindex org-export-default-language
9634 @example
9635 #+TITLE:       the title to be shown (default is the buffer name)
9636 #+AUTHOR:      the author (default taken from @code{user-full-name})
9637 #+DATE:        a date, fixed, or a format string for @code{format-time-string}
9638 #+EMAIL:       his/her email address (default from @code{user-mail-address})
9639 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
9640 #+KEYWORDS:    the page keywords, e.g.@: for the XHTML meta tag
9641 #+LANGUAGE:    language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
9642 #+TEXT:        Some descriptive text to be inserted at the beginning.
9643 #+TEXT:        Several lines may be given.
9644 #+OPTIONS:     H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9645 #+BIND:        lisp-var lisp-val, e.g.@:: org-export-latex-low-levels itemize
9646                @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9647 #+LINK_UP:     the ``up'' link of an exported page
9648 #+LINK_HOME:   the ``home'' link of an exported page
9649 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
9650 #+EXPORT_SELECT_TAGS:   Tags that select a tree for export
9651 #+EXPORT_EXCLUDE_TAGS:  Tags that exclude a tree from export
9652 #+XSLT:        the XSLT stylesheet used by DocBook exporter to generate FO file
9653 @end example
9655 @noindent
9656 The OPTIONS line is a compact@footnote{If you want to configure many options
9657 this way, you can use several OPTIONS lines.} form to specify export
9658 settings.  Here you can:
9659 @cindex headline levels
9660 @cindex section-numbers
9661 @cindex table of contents
9662 @cindex line-break preservation
9663 @cindex quoted HTML tags
9664 @cindex fixed-width sections
9665 @cindex tables
9666 @cindex @TeX{}-like syntax for sub- and superscripts
9667 @cindex footnotes
9668 @cindex special strings
9669 @cindex emphasized text
9670 @cindex @TeX{} macros
9671 @cindex @LaTeX{} fragments
9672 @cindex author info, in export
9673 @cindex time info, in export
9674 @vindex org-export-plist-vars
9675 @vindex org-export-author-info
9676 @vindex org-export-creator-info
9677 @vindex org-export-email-info
9678 @vindex org-export-time-stamp-file
9679 @example
9680 H:         @r{set the number of headline levels for export}
9681 num:       @r{turn on/off section-numbers}
9682 toc:       @r{turn on/off table of contents, or set level limit (integer)}
9683 \n:        @r{turn on/off line-break-preservation (DOES NOT WORK)}
9684 @@:         @r{turn on/off quoted HTML tags}
9685 ::         @r{turn on/off fixed-width sections}
9686 |:         @r{turn on/off tables}
9687 ^:         @r{turn on/off @TeX{}-like syntax for sub- and superscripts.  If}
9688            @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9689            @r{the simple @code{a_b} will be left as it is.}
9690 -:         @r{turn on/off conversion of special strings.}
9691 f:         @r{turn on/off footnotes like this[1].}
9692 todo:      @r{turn on/off inclusion of TODO keywords into exported text}
9693 tasks:     @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
9694            @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
9695 pri:       @r{turn on/off priority cookies}
9696 tags:      @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9697 <:         @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9698 *:         @r{turn on/off emphasized text (bold, italic, underlined)}
9699 TeX:       @r{turn on/off simple @TeX{} macros in plain text}
9700 LaTeX:     @r{configure export of @LaTeX{} fragments.  Default @code{auto}}
9701 skip:      @r{turn on/off skipping the text before the first heading}
9702 author:    @r{turn on/off inclusion of author name/email into exported file}
9703 email:     @r{turn on/off inclusion of author email into exported file}
9704 creator:   @r{turn on/off inclusion of creator info into exported file}
9705 timestamp: @r{turn on/off inclusion creation time into exported file}
9706 d:         @r{turn on/off inclusion of drawers}
9707 @end example
9708 @noindent
9709 These options take effect in both the HTML and @LaTeX{} export, except for
9710 @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
9711 @code{nil} for the @LaTeX{} export.
9713 The default values for these and many other options are given by a set of
9714 variables.  For a list of such variables, the corresponding OPTIONS keys and
9715 also the publishing keys (@pxref{Project alist}), see the constant
9716 @code{org-export-plist-vars}.
9718 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9719 calling an export command, the subtree can overrule some of the file's export
9720 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9721 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9722 @code{EXPORT_OPTIONS}.
9724 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9725 @section The export dispatcher
9726 @cindex dispatcher, for export commands
9728 All export commands can be reached using the export dispatcher, which is a
9729 prefix key that prompts for an additional key specifying the command.
9730 Normally the entire file is exported, but if there is an active region that
9731 contains one outline tree, the first heading is used as document title and
9732 the subtrees are exported.
9734 @table @kbd
9735 @orgcmd{C-c C-e,org-export}
9736 @vindex org-export-run-in-background
9737 Dispatcher for export and publishing commands.  Displays a help-window
9738 listing the additional key(s) needed to launch an export or publishing
9739 command.  The prefix arg is passed through to the exporter.  A double prefix
9740 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9741 separate Emacs process@footnote{To make this behavior the default, customize
9742 the variable @code{org-export-run-in-background}.}.
9743 @orgcmd{C-c C-e v,org-export-visible}
9744 Like @kbd{C-c C-e}, but only export the text that is currently visible
9745 (i.e.@: not hidden by outline visibility).
9746 @orgcmd{C-u C-u C-c C-e,org-export}
9747 @vindex org-export-run-in-background
9748 Call the exporter, but reverse the setting of
9749 @code{org-export-run-in-background}, i.e.@: request background processing if
9750 not set, or force processing in the current Emacs process if set.
9751 @end table
9753 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9754 @section ASCII/Latin-1/UTF-8 export
9755 @cindex ASCII export
9756 @cindex Latin-1 export
9757 @cindex UTF-8 export
9759 ASCII export produces a simple and very readable version of an Org mode
9760 file, containing only plain ASCII.  Latin-1 and UTF-8 export augment the file
9761 with special characters and symbols available in these encodings.
9763 @cindex region, active
9764 @cindex active region
9765 @cindex transient-mark-mode
9766 @table @kbd
9767 @orgcmd{C-c C-e a,org-export-as-ascii}
9768 @cindex property, EXPORT_FILE_NAME
9769 Export as ASCII file.  For an Org file, @file{myfile.org}, the ASCII file
9770 will be @file{myfile.txt}.  The file will be overwritten without
9771 warning.  If there is an active region@footnote{This requires
9772 @code{transient-mark-mode} be turned on.}, only the region will be
9773 exported.  If the selected region is a single tree@footnote{To select the
9774 current subtree, use @kbd{C-c @@}.}, the tree head will
9775 become the document title.  If the tree head entry has or inherits an
9776 @code{EXPORT_FILE_NAME} property, that name will be used for the
9777 export.
9778 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9779 Export to a temporary buffer.  Do not create a file.
9780 @orgcmd{C-c C-e n,org-export-as-latin1}
9781 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
9782 Like the above commands, but use Latin-1 encoding.
9783 @orgcmd{C-c C-e u,org-export-as-utf8}
9784 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
9785 Like the above commands, but use UTF-8 encoding.
9786 @item C-c C-e v a/n/u
9787 Export only the visible part of the document.
9788 @end table
9790 @cindex headline levels, for exporting
9791 In the exported version, the first 3 outline levels will become
9792 headlines, defining a general document structure.  Additional levels
9793 will be exported as itemized lists.  If you want that transition to occur
9794 at a different level, specify it with a prefix argument.  For example,
9796 @example
9797 @kbd{C-1 C-c C-e a}
9798 @end example
9800 @noindent
9801 creates only top level headlines and does the rest as items.  When
9802 headlines are converted to items, the indentation of the text following
9803 the headline is changed to fit nicely under the item.  This is done with
9804 the assumption that the first body line indicates the base indentation of
9805 the body text.  Any indentation larger than this is adjusted to preserve
9806 the layout relative to the first line.  Should there be lines with less
9807 indentation than the first, these are left alone.
9809 @vindex org-export-ascii-links-to-notes
9810 Links will be exported in a footnote-like style, with the descriptive part in
9811 the text and the link in a note before the next heading.  See the variable
9812 @code{org-export-ascii-links-to-notes} for details and other options.
9814 @node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9815 @section HTML export
9816 @cindex HTML export
9818 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9819 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9820 language, but with additional support for tables.
9822 @menu
9823 * HTML Export commands::        How to invoke HTML export
9824 * HTML preamble and postamble::  How to insert a preamble and a postamble
9825 * Quoting HTML tags::           Using direct HTML in Org mode
9826 * Links in HTML export::        How links will be interpreted and formatted
9827 * Tables in HTML export::       How to modify the formatting of tables
9828 * Images in HTML export::       How to insert figures into HTML output
9829 * Math formatting in HTML export::  Beautiful math also on the web
9830 * Text areas in HTML export::   An alternative way to show an example
9831 * CSS support::                 Changing the appearance of the output
9832 * JavaScript support::          Info and Folding in a web browser
9833 @end menu
9835 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
9836 @subsection HTML export commands
9838 @cindex region, active
9839 @cindex active region
9840 @cindex transient-mark-mode
9841 @table @kbd
9842 @orgcmd{C-c C-e h,org-export-as-html}
9843 @cindex property, EXPORT_FILE_NAME
9844 Export as HTML file.  For an Org file @file{myfile.org},
9845 the HTML file will be @file{myfile.html}.  The file will be overwritten
9846 without warning.  If there is an active region@footnote{This requires
9847 @code{transient-mark-mode} be turned on.}, only the region will be
9848 exported.  If the selected region is a single tree@footnote{To select the
9849 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9850 title.  If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9851 property, that name will be used for the export.
9852 @orgcmd{C-c C-e b,org-export-as-html-and-open}
9853 Export as HTML file and immediately open it with a browser.
9854 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
9855 Export to a temporary buffer.  Do not create a file.
9856 @orgcmd{C-c C-e R,org-export-region-as-html}
9857 Export the active region to a temporary buffer.  With a prefix argument, do
9858 not produce the file header and footer, but just the plain HTML section for
9859 the region.  This is good for cut-and-paste operations.
9860 @item C-c C-e v h/b/H/R
9861 Export only the visible part of the document.
9862 @item M-x org-export-region-as-html
9863 Convert the region to HTML under the assumption that it was Org mode
9864 syntax before.  This is a global command that can be invoked in any
9865 buffer.
9866 @item M-x org-replace-region-by-HTML
9867 Replace the active region (assumed to be in Org mode syntax) by HTML
9868 code.
9869 @end table
9871 @cindex headline levels, for exporting
9872 In the exported version, the first 3 outline levels will become headlines,
9873 defining a general document structure.  Additional levels will be exported as
9874 itemized lists.  If you want that transition to occur at a different level,
9875 specify it with a numeric prefix argument.  For example,
9877 @example
9878 @kbd{C-2 C-c C-e b}
9879 @end example
9881 @noindent
9882 creates two levels of headings and does the rest as items.
9885 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
9886 @subsection HTML preamble and postamble
9887 @vindex org-export-html-preamble
9888 @vindex org-export-html-postamble
9889 @vindex org-export-html-preamble-format
9890 @vindex org-export-html-postamble-format
9891 @vindex org-export-html-validation-link
9892 @vindex org-export-author-info
9893 @vindex org-export-email-info
9894 @vindex org-export-creator-info
9895 @vindex org-export-time-stamp-file
9897 The HTML exporter lets you define a preamble and a postamble.
9899 The default value for @code{org-export-html-preamble} is @code{t}, which
9900 means that the preamble is inserted depending on the relevant formatting
9901 string in @code{org-export-html-preamble-format}.
9903 Setting @code{org-export-html-preamble} to a string will override the default
9904 formatting string.  Setting it to a function, will insert the output of the
9905 function, which must be a string; such a function takes no argument but you
9906 can check against the value of @code{opt-plist}, which contains the list of
9907 publishing properties for the current file.  Setting to @code{nil} will not
9908 insert any preamble.
9910 The default value for @code{org-export-html-postamble} is @code{'auto}, which
9911 means that the HTML exporter will look for the value of
9912 @code{org-export-author-info}, @code{org-export-email-info},
9913 @code{org-export-creator-info} and @code{org-export-time-stamp-file},
9914 @code{org-export-html-validation-link} and build the postamble from these
9915 values.  Setting @code{org-export-html-postamble} to @code{t} will insert the
9916 postamble from the relevant formatting string found in
9917 @code{org-export-html-postamble-format}.  Setting it to @code{nil} will not
9918 insert any postamble.
9920 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
9921 @subsection Quoting HTML tags
9923 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
9924 @samp{&gt;} in HTML export.  If you want to include simple HTML tags
9925 which should be interpreted as such, mark them with @samp{@@} as in
9926 @samp{@@<b>bold text@@</b>}.  Note that this really works only for
9927 simple tags.  For more extensive HTML that should be copied verbatim to
9928 the exported file use either
9930 @cindex #+HTML
9931 @cindex #+BEGIN_HTML
9932 @example
9933 #+HTML: Literal HTML code for export
9934 @end example
9936 @noindent or
9937 @cindex #+BEGIN_HTML
9939 @example
9940 #+BEGIN_HTML
9941 All lines between these markers are exported literally
9942 #+END_HTML
9943 @end example
9946 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9947 @subsection Links in HTML export
9949 @cindex links, in HTML export
9950 @cindex internal links, in HTML export
9951 @cindex external links, in HTML export
9952 Internal links (@pxref{Internal links}) will continue to work in HTML.  This
9953 includes automatic links created by radio targets (@pxref{Radio
9954 targets}).  Links to external files will still work if the target file is on
9955 the same @i{relative} path as the published Org file.  Links to other
9956 @file{.org} files will be translated into HTML links under the assumption
9957 that an HTML version also exists of the linked file, at the same relative
9958 path.  @samp{id:} links can then be used to jump to specific entries across
9959 files.  For information related to linking files while publishing them to a
9960 publishing directory see @ref{Publishing links}.
9962 If you want to specify attributes for links, you can do so using a special
9963 @code{#+ATTR_HTML} line to define attributes that will be added to the
9964 @code{<a>} or @code{<img>} tags.  Here is an example that sets @code{title}
9965 and @code{style} attributes for a link:
9967 @cindex #+ATTR_HTML
9968 @example
9969 #+ATTR_HTML: title="The Org mode homepage" style="color:red;"
9970 [[http://orgmode.org]]
9971 @end example
9973 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9974 @subsection Tables
9975 @cindex tables, in HTML
9976 @vindex org-export-html-table-tag
9978 Org mode tables are exported to HTML using the table tag defined in
9979 @code{org-export-html-table-tag}.  The default setting makes tables without
9980 cell borders and frame.  If you would like to change this for individual
9981 tables, place something like the following before the table:
9983 @cindex #+CAPTION
9984 @cindex #+ATTR_HTML
9985 @example
9986 #+CAPTION: This is a table with lines around and between cells
9987 #+ATTR_HTML: border="2" rules="all" frame="border"
9988 @end example
9990 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
9991 @subsection Images in HTML export
9993 @cindex images, inline in HTML
9994 @cindex inlining images in HTML
9995 @vindex org-export-html-inline-images
9996 HTML export can inline images given as links in the Org file, and
9997 it can make an image the clickable part of a link.  By
9998 default@footnote{But see the variable
9999 @code{org-export-html-inline-images}.}, images are inlined if a link does
10000 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
10001 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
10002 @samp{the image} that points to the image.  If the description part
10003 itself is a @code{file:} link or a @code{http:} URL pointing to an
10004 image, this image will be inlined and activated so that clicking on the
10005 image will activate the link.  For example, to include a thumbnail that
10006 will link to a high resolution version of the image, you could use:
10008 @example
10009 [[file:highres.jpg][file:thumb.jpg]]
10010 @end example
10012 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
10013 In the example below we specify the @code{alt} and @code{title} attributes to
10014 support text viewers and accessibility, and align it to the right.
10016 @cindex #+CAPTION
10017 @cindex #+ATTR_HTML
10018 @example
10019 #+CAPTION: A black cat stalking a spider
10020 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
10021 [[./img/a.jpg]]
10022 @end example
10024 @noindent
10025 You could use @code{http} addresses just as well.
10027 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
10028 @subsection Math formatting in HTML export
10029 @cindex MathJax
10030 @cindex dvipng
10032 @LaTeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two
10033 different ways on HTML pages.  The default is to use the
10034 @uref{http://www.mathjax.org, MathJax system} which should work out of the
10035 box with Org mode installation because @code{http://orgmode.org} serves
10036 @file{MathJax} for Org mode users for small applications and for testing
10037 purposes.  @b{If you plan to use this regularly or on pages with significant
10038 page views, you should install@footnote{Installation instructions can be
10039 found on the MathJax website, see
10040 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
10041 your own server in order to limit the load of our server.}  To configure
10042 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
10043 insert something like the following into the buffer:
10045 @example
10046 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
10047 @end example
10049 @noindent See the docstring of the variable
10050 @code{org-export-html-mathjax-options} for the meaning of the parameters in
10051 this line.
10053 If you prefer, you can also request that @LaTeX{} fragments are processed
10054 into small images that will be inserted into the browser page.  Before the
10055 availability of MathJax, this was the default method for Org files.  This
10056 method requires that the @file{dvipng} program is available on your system.
10057 You can still get this processing with
10059 @example
10060 #+OPTIONS: LaTeX:dvipng
10061 @end example
10063 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
10064 @subsection Text areas in HTML export
10066 @cindex text areas, in HTML
10067 An alternative way to publish literal code examples in HTML is to use text
10068 areas, where the example can even be edited before pasting it into an
10069 application.  It is triggered by a @code{-t} switch at an @code{example} or
10070 @code{src} block.  Using this switch disables any options for syntax and
10071 label highlighting, and line numbering, which may be present.  You may also
10072 use @code{-h} and @code{-w} switches to specify the height and width of the
10073 text area, which default to the number of lines in the example, and 80,
10074 respectively.  For example
10076 @example
10077 #+BEGIN_EXAMPLE -t -w 40
10078   (defun org-xor (a b)
10079      "Exclusive or."
10080      (if a (not b) b))
10081 #+END_EXAMPLE
10082 @end example
10085 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
10086 @subsection CSS support
10087 @cindex CSS, for HTML export
10088 @cindex HTML export, CSS
10090 @vindex org-export-html-todo-kwd-class-prefix
10091 @vindex org-export-html-tag-class-prefix
10092 You can also give style information for the exported file.  The HTML exporter
10093 assigns the following special CSS classes@footnote{If the classes on TODO
10094 keywords and tags lead to conflicts, use the variables
10095 @code{org-export-html-todo-kwd-class-prefix} and
10096 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
10097 parts of the document---your style specifications may change these, in
10098 addition to any of the standard classes like for headlines, tables, etc.
10099 @example
10100 p.author            @r{author information, including email}
10101 p.date              @r{publishing date}
10102 p.creator           @r{creator info, about org mode version}
10103 .title              @r{document title}
10104 .todo               @r{TODO keywords, all not-done states}
10105 .done               @r{the DONE keywords, all states that count as done}
10106 .WAITING            @r{each TODO keyword also uses a class named after itself}
10107 .timestamp          @r{timestamp}
10108 .timestamp-kwd      @r{keyword associated with a timestamp, like SCHEDULED}
10109 .timestamp-wrapper  @r{span around keyword plus timestamp}
10110 .tag                @r{tag in a headline}
10111 ._HOME              @r{each tag uses itself as a class, "@@" replaced by "_"}
10112 .target             @r{target for links}
10113 .linenr             @r{the line number in a code example}
10114 .code-highlighted   @r{for highlighting referenced code lines}
10115 div.outline-N       @r{div for outline level N (headline plus text))}
10116 div.outline-text-N  @r{extra div for text at outline level N}
10117 .section-number-N   @r{section number in headlines, different for each level}
10118 div.figure          @r{how to format an inlined image}
10119 pre.src             @r{formatted source code}
10120 pre.example         @r{normal example}
10121 p.verse             @r{verse paragraph}
10122 div.footnotes       @r{footnote section headline}
10123 p.footnote          @r{footnote definition paragraph, containing a footnote}
10124 .footref            @r{a footnote reference number (always a <sup>)}
10125 .footnum            @r{footnote number in footnote definition (always <sup>)}
10126 @end example
10128 @vindex org-export-html-style-default
10129 @vindex org-export-html-style-include-default
10130 @vindex org-export-html-style
10131 @vindex org-export-html-extra
10132 @vindex org-export-html-style-default
10133 Each exported file contains a compact default style that defines these
10134 classes in a basic way@footnote{This style is defined in the constant
10135 @code{org-export-html-style-default}, which you should not modify.  To turn
10136 inclusion of these defaults off, customize
10137 @code{org-export-html-style-include-default}}.  You may overwrite these
10138 settings, or add to them by using the variables @code{org-export-html-style}
10139 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
10140 fine-grained settings, like file-local settings).  To set the latter variable
10141 individually for each file, you can use
10143 @cindex #+STYLE
10144 @example
10145 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
10146 @end example
10148 @noindent
10149 For longer style definitions, you can use several such lines.  You could also
10150 directly write a @code{<style>} @code{</style>} section in this way, without
10151 referring to an external file.
10153 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
10154 property to assign a class to the tree.  In order to specify CSS styles for a
10155 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
10156 property.
10158 @c FIXME: More about header and footer styles
10159 @c FIXME: Talk about links and targets.
10161 @node JavaScript support,  , CSS support, HTML export
10162 @subsection JavaScript supported display of web pages
10164 @cindex Rose, Sebastian
10165 Sebastian Rose has written a JavaScript program especially designed to
10166 enhance the web viewing experience of HTML files created with Org.  This
10167 program allows you to view large files in two different ways.  The first one
10168 is an @emph{Info}-like mode where each section is displayed separately and
10169 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
10170 as well, press @kbd{?} for an overview of the available keys).  The second
10171 view type is a @emph{folding} view much like Org provides inside Emacs.  The
10172 script is available at @url{http://orgmode.org/org-info.js} and you can find
10173 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
10174 We host the script at our site, but if you use it a lot, you might
10175 not want to be dependent on @url{orgmode.org} and prefer to install a local
10176 copy on your own web server.
10178 To use the script, you need to make sure that the @file{org-jsinfo.el} module
10179 gets loaded.  It should be loaded by default, but you can try @kbd{M-x
10180 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
10181 this is indeed the case.  All it then takes to make use of the program is
10182 adding a single line to the Org file:
10184 @cindex #+INFOJS_OPT
10185 @example
10186 #+INFOJS_OPT: view:info toc:nil
10187 @end example
10189 @noindent
10190 If this line is found, the HTML header will automatically contain the code
10191 needed to invoke the script.  Using the line above, you can set the following
10192 viewing options:
10194 @example
10195 path:    @r{The path to the script.  The default is to grab the script from}
10196          @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
10197          @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
10198 view:    @r{Initial view when website is first shown.  Possible values are:}
10199          info      @r{Info-like interface with one section per page.}
10200          overview  @r{Folding interface, initially showing only top-level.}
10201          content   @r{Folding interface, starting with all headlines visible.}
10202          showall   @r{Folding interface, all headlines and text visible.}
10203 sdepth:  @r{Maximum headline level that will still become an independent}
10204          @r{section for info and folding modes.  The default is taken from}
10205          @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
10206          @r{If this is smaller than in @code{org-export-headline-levels}, each}
10207          @r{info/folding section can still contain child headlines.}
10208 toc:     @r{Should the table of contents @emph{initially} be visible?}
10209          @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
10210 tdepth:  @r{The depth of the table of contents.  The defaults are taken from}
10211          @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
10212 ftoc:    @r{Does the CSS of the page specify a fixed position for the "toc"?}
10213          @r{If yes, the toc will never be displayed as a section.}
10214 ltoc:    @r{Should there be short contents (children) in each section?}
10215          @r{Make this @code{above} if the section should be above initial text.}
10216 mouse:   @r{Headings are highlighted when the mouse is over them.  Should be}
10217          @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
10218 buttons: @r{Should view-toggle buttons be everywhere?  When @code{nil} (the}
10219          @r{default), only one such button will be present.}
10220 @end example
10221 @noindent
10222 @vindex org-infojs-options
10223 @vindex org-export-html-use-infojs
10224 You can choose default values for these options by customizing the variable
10225 @code{org-infojs-options}.  If you always want to apply the script to your
10226 pages, configure the variable @code{org-export-html-use-infojs}.
10228 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
10229 @section @LaTeX{} and PDF export
10230 @cindex @LaTeX{} export
10231 @cindex PDF export
10232 @cindex Guerry, Bastien
10234 Org mode contains a @LaTeX{} exporter written by Bastien Guerry.  With
10235 further processing@footnote{The default LaTeX output is designed for
10236 processing with pdftex or latex.  It includes packages that are not
10237 compatible with xetex and possibly luatex.  See the variables
10238 @code{org-export-latex-default-packages-alist} and
10239 @code{org-export-latex-packages-alist}.}, this backend is also used to
10240 produce PDF output.  Since the @LaTeX{} output uses @file{hyperref} to
10241 implement links and cross references, the PDF output file will be fully
10242 linked.  Beware of the fact that your @code{org} file has to be properly
10243 structured in order to be correctly exported: respect the hierarchy of
10244 sections.
10246 @menu
10247 * LaTeX/PDF export commands::   Which key invokes which commands
10248 * Header and sectioning::       Setting up the export file structure
10249 * Quoting LaTeX code::          Incorporating literal @LaTeX{} code
10250 * Tables in LaTeX export::      Options for exporting tables to @LaTeX{}
10251 * Images in LaTeX export::      How to insert figures into @LaTeX{} output
10252 * Beamer class export::         Turning the file into a presentation
10253 @end menu
10255 @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
10256 @subsection @LaTeX{} export commands
10258 @cindex region, active
10259 @cindex active region
10260 @cindex transient-mark-mode
10261 @table @kbd
10262 @orgcmd{C-c C-e l,org-export-as-latex}
10263 @cindex property EXPORT_FILE_NAME
10264 Export as @LaTeX{} file.  For an Org file
10265 @file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}.  The file will
10266 be overwritten without warning.  If there is an active region@footnote{This
10267 requires @code{transient-mark-mode} be turned on.}, only the region will be
10268 exported.  If the selected region is a single tree@footnote{To select the
10269 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10270 title.  If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
10271 property, that name will be used for the export.
10272 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
10273 Export to a temporary buffer.  Do not create a file.
10274 @item C-c C-e v l/L
10275 Export only the visible part of the document.
10276 @item M-x org-export-region-as-latex
10277 Convert the region to @LaTeX{} under the assumption that it was Org mode
10278 syntax before.  This is a global command that can be invoked in any
10279 buffer.
10280 @item M-x org-replace-region-by-latex
10281 Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
10282 code.
10283 @orgcmd{C-c C-e p,org-export-as-pdf}
10284 Export as @LaTeX{} and then process to PDF.
10285 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
10286 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10287 @end table
10289 @cindex headline levels, for exporting
10290 @vindex org-latex-low-levels
10291 In the exported version, the first 3 outline levels will become
10292 headlines, defining a general document structure.  Additional levels
10293 will be exported as description lists.  The exporter can ignore them or
10294 convert them to a custom string depending on
10295 @code{org-latex-low-levels}.
10297 If you want that transition to occur at a different level, specify it
10298 with a numeric prefix argument.  For example,
10300 @example
10301 @kbd{C-2 C-c C-e l}
10302 @end example
10304 @noindent
10305 creates two levels of headings and does the rest as items.
10307 @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
10308 @subsection Header and sectioning structure
10309 @cindex @LaTeX{} class
10310 @cindex @LaTeX{} sectioning structure
10311 @cindex @LaTeX{} header
10312 @cindex header, for LaTeX files
10313 @cindex sectioning structure, for LaTeX export
10315 By default, the @LaTeX{} output uses the class @code{article}.
10317 @vindex org-export-latex-default-class
10318 @vindex org-export-latex-classes
10319 @vindex org-export-latex-default-packages-alist
10320 @vindex org-export-latex-packages-alist
10321 @cindex #+LATEX_HEADER
10322 @cindex #+LATEX_CLASS
10323 @cindex #+LATEX_CLASS_OPTIONS
10324 @cindex property, LATEX_CLASS
10325 @cindex property, LATEX_CLASS_OPTIONS
10326 You can change this globally by setting a different value for
10327 @code{org-export-latex-default-class} or locally by adding an option like
10328 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
10329 property that applies when exporting a region containing only this (sub)tree.
10330 The class must be listed in @code{org-export-latex-classes}.  This variable
10331 defines a header template for each class@footnote{Into which the values of
10332 @code{org-export-latex-default-packages-alist} and
10333 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
10334 define the sectioning structure for each class.  You can also define your own
10335 classes there.  @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
10336 property can specify the options for the @code{\documentclass} macro.  You
10337 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
10338 header.  See the docstring of @code{org-export-latex-classes} for more
10339 information.
10341 @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export
10342 @subsection Quoting @LaTeX{} code
10344 Embedded @LaTeX{} as described in @ref{Embedded LaTeX}, will be correctly
10345 inserted into the @LaTeX{} file.  This includes simple macros like
10346 @samp{\ref@{LABEL@}} to create a cross reference to a figure.  Furthermore,
10347 you can add special code that should only be present in @LaTeX{} export with
10348 the following constructs:
10350 @cindex #+LaTeX
10351 @cindex #+BEGIN_LaTeX
10352 @example
10353 #+LaTeX: Literal LaTeX code for export
10354 @end example
10356 @noindent or
10357 @cindex #+BEGIN_LaTeX
10359 @example
10360 #+BEGIN_LaTeX
10361 All lines between these markers are exported literally
10362 #+END_LaTeX
10363 @end example
10366 @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
10367 @subsection Tables in @LaTeX{} export
10368 @cindex tables, in @LaTeX{} export
10370 For @LaTeX{} export of a table, you can specify a label, a caption and
10371 placement options (@pxref{Images and tables}).  You can also use the
10372 @code{ATTR_LaTeX} line to request a @code{longtable} environment for the
10373 table, so that it may span several pages, or to change the default table
10374 environment from @code{table} to @code{table*} or to change the default inner
10375 tabular environment to @code{tabularx} or @code{tabulary}.  Finally, you can
10376 set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
10377 width:
10379 @cindex #+CAPTION
10380 @cindex #+LABEL
10381 @cindex #+ATTR_LaTeX
10382 @example
10383 #+CAPTION: A long table
10384 #+LABEL: tbl:long
10385 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10386 | ..... | ..... |
10387 | ..... | ..... |
10388 @end example
10390 or to specify a multicolumn table with @code{tabulary}
10392 @cindex #+CAPTION
10393 @cindex #+LABEL
10394 @cindex #+ATTR_LaTeX
10395 @example
10396 #+CAPTION: A wide table with tabulary
10397 #+LABEL: tbl:wide
10398 #+ATTR_LaTeX: table* tabulary width=\textwidth
10399 | ..... | ..... |
10400 | ..... | ..... |
10401 @end example
10403 @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
10404 @subsection Images in @LaTeX{} export
10405 @cindex images, inline in @LaTeX{}
10406 @cindex inlining images in @LaTeX{}
10408 Images that are linked to without a description part in the link, like
10409 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10410 output file resulting from @LaTeX{} processing.  Org will use an
10411 @code{\includegraphics} macro to insert the image.  If you have specified a
10412 caption and/or a label as described in @ref{Images and tables}, the figure
10413 will be wrapped into a @code{figure} environment and thus become a floating
10414 element.  You can use an @code{#+ATTR_LaTeX:} line to specify various other
10415 options.  You can ask org to export an image as a float without specifying
10416 a label or a caption by using the keyword @code{float} in this line.  Various
10417 optional arguments to the @code{\includegraphics} macro can also be specified
10418 in this fashion.  To modify the placement option of the floating environment,
10419 add something like @samp{placement=[h!]} to the attributes.  It is to be noted
10420 this option can be used with tables as well@footnote{One can also take
10421 advantage of this option to pass other, unrelated options into the figure or
10422 table environment.  For an example see the section ``Exporting org files'' in
10423 @url{http://orgmode.org/worg/org-hacks.html}}.  For example the
10424 @code{#+ATTR_LaTeX:} line below is exported as the @code{figure} environment
10425 below it.
10427 If you would like to let text flow around the image, add the word @samp{wrap}
10428 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10429 half of the page.  To fine-tune, the @code{placement} field will be the set
10430 of additional arguments needed by the @code{wrapfigure} environment.  Note
10431 that if you change the size of the image, you need to use compatible settings
10432 for @code{\includegraphics} and @code{wrapfigure}.
10434 @cindex #+CAPTION
10435 @cindex #+LABEL
10436 @cindex #+ATTR_LaTeX
10437 @example
10438 #+CAPTION:    The black-body emission of the disk around HR 4049
10439 #+LABEL:      fig:SED-HR4049
10440 #+ATTR_LaTeX: width=5cm,angle=90
10441 [[./img/sed-hr4049.pdf]]
10443 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10444 [[./img/hst.png]]
10445 @end example
10447 If you wish to include an image which spans multiple columns in a page, you
10448 can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line.  This
10449 will export the image wrapped in a @code{figure*} environment.
10451 If you need references to a label created in this way, write
10452 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10454 @node Beamer class export,  , Images in LaTeX export, LaTeX and PDF export
10455 @subsection Beamer class export
10457 The LaTeX class @file{beamer} allows production of high quality presentations
10458 using LaTeX and pdf processing.  Org mode has special support for turning an
10459 Org mode file or tree into a @file{beamer} presentation.
10461 When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS:
10462 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10463 @code{beamer}, a special export mode will turn the file or tree into a beamer
10464 presentation.  Any tree with not-too-deep level nesting should in principle be
10465 exportable as a beamer presentation.  By default, the top-level entries (or
10466 the first level below the selected subtree heading) will be turned into
10467 frames, and the outline structure below this level will become itemize lists.
10468 You can also configure the variable @code{org-beamer-frame-level} to a
10469 different level---then the hierarchy above frames will produce the sectioning
10470 structure of the presentation.
10472 A template for useful in-buffer settings or properties can be inserted into
10473 the buffer with @kbd{M-x org-insert-beamer-options-template}.  Among other
10474 things, this will install a column view format which is very handy for
10475 editing special properties used by beamer.
10477 You can influence the structure of the presentation using the following
10478 properties:
10480 @table @code
10481 @item BEAMER_env
10482 The environment that should be used to format this entry.  Valid environments
10483 are defined in the constant @code{org-beamer-environments-default}, and you
10484 can define more in @code{org-beamer-environments-extra}.  If this property is
10485 set, the entry will also get a @code{:B_environment:} tag to make this
10486 visible.  This tag has no semantic meaning, it is only a visual aid.
10487 @item BEAMER_envargs
10488 The beamer-special arguments that should be used for the environment, like
10489 @code{[t]} or @code{[<+->]} of @code{<2-3>}.  If the @code{BEAMER_col}
10490 property is also set, something like @code{C[t]} can be added here as well to
10491 set an options argument for the implied @code{columns} environment.
10492 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10493 environment.
10494 @item BEAMER_col
10495 The width of a column that should start with this entry.  If this property is
10496 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10497 Also this tag is only a visual aid.  When this is a plain number, it will be
10498 interpreted as a fraction of @code{\textwidth}.  Otherwise it will be assumed
10499 that you have specified the units, like @samp{3cm}.  The first such property
10500 in a frame will start a @code{columns} environment to surround the columns.
10501 This environment is closed when an entry has a @code{BEAMER_col} property
10502 with value 0 or 1, or automatically at the end of the frame.
10503 @item BEAMER_extra
10504 Additional commands that should be inserted after the environment has been
10505 opened.  For example, when creating a frame, this can be used to specify
10506 transitions.
10507 @end table
10509 Frames will automatically receive a @code{fragile} option if they contain
10510 source code that uses the verbatim environment.  Special @file{beamer}
10511 specific code can be inserted using @code{#+BEAMER:} and
10512 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
10513 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10514 in the presentation as well.
10516 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10517 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10518 into @code{\note@{...@}}.  The former will include the heading as part of the
10519 note text, the latter will ignore the heading of that node.  To simplify note
10520 generation, it is actually enough to mark the note with a @emph{tag} (either
10521 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10522 @code{BEAMER_env} property.
10524 You can turn on a special minor mode @code{org-beamer-mode} for editing
10525 support with
10527 @example
10528 #+STARTUP: beamer
10529 @end example
10531 @table @kbd
10532 @orgcmd{C-c C-b,org-beamer-select-environment}
10533 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10534 environment or the @code{BEAMER_col} property.
10535 @end table
10537 Column view provides a great way to set the environment of a node and other
10538 important parameters.  Make sure you are using a COLUMN format that is geared
10539 toward this special purpose.  The command @kbd{M-x
10540 org-insert-beamer-options-template} defines such a format.
10542 Here is a simple example Org document that is intended for beamer export.
10544 @smallexample
10545 #+LaTeX_CLASS: beamer
10546 #+TITLE: Example Presentation
10547 #+AUTHOR: Carsten Dominik
10548 #+LaTeX_CLASS_OPTIONS: [presentation]
10549 #+BEAMER_FRAME_LEVEL: 2
10550 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10551 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10553 * This is the first structural section
10555 ** Frame 1 \\ with a subtitle
10556 *** Thanks to Eric Fraga                                      :BMCOL:B_block:
10557     :PROPERTIES:
10558     :BEAMER_env: block
10559     :BEAMER_envargs: C[t]
10560     :BEAMER_col: 0.5
10561     :END:
10562     for the first viable beamer setup in Org
10563 *** Thanks to everyone else                                   :BMCOL:B_block:
10564     :PROPERTIES:
10565     :BEAMER_col: 0.5
10566     :BEAMER_env: block
10567     :BEAMER_envargs: <2->
10568     :END:
10569     for contributing to the discussion
10570 **** This will be formatted as a beamer note                  :B_note:
10571 ** Frame 2 \\ where we will not use columns
10572 *** Request                                                   :B_block:
10573     Please test this stuff!
10574     :PROPERTIES:
10575     :BEAMER_env: block
10576     :END:
10577 @end smallexample
10579 For more information, see the documentation on Worg.
10581 @node DocBook export, OpenDocument Text export, LaTeX and PDF export, Exporting
10582 @section DocBook export
10583 @cindex DocBook export
10584 @cindex PDF export
10585 @cindex Cui, Baoqiu
10587 Org contains a DocBook exporter written by Baoqiu Cui.  Once an Org file is
10588 exported to DocBook format, it can be further processed to produce other
10589 formats, including PDF, HTML, man pages, etc., using many available DocBook
10590 tools and stylesheets.
10592 Currently DocBook exporter only supports DocBook V5.0.
10594 @menu
10595 * DocBook export commands::     How to invoke DocBook export
10596 * Quoting DocBook code::        Incorporating DocBook code in Org files
10597 * Recursive sections::          Recursive sections in DocBook
10598 * Tables in DocBook export::    Tables are exported as HTML tables
10599 * Images in DocBook export::    How to insert figures into DocBook output
10600 * Special characters::          How to handle special characters
10601 @end menu
10603 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10604 @subsection DocBook export commands
10606 @cindex region, active
10607 @cindex active region
10608 @cindex transient-mark-mode
10609 @table @kbd
10610 @orgcmd{C-c C-e D,org-export-as-docbook}
10611 @cindex property EXPORT_FILE_NAME
10612 Export as DocBook file.  For an Org file, @file{myfile.org}, the DocBook XML
10613 file will be @file{myfile.xml}.  The file will be overwritten without
10614 warning.  If there is an active region@footnote{This requires
10615 @code{transient-mark-mode} to be turned on}, only the region will be
10616 exported.  If the selected region is a single tree@footnote{To select the
10617 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10618 title.  If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10619 property, that name will be used for the export.
10620 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10621 Export as DocBook file, process to PDF, then open the resulting PDF file.
10623 @vindex org-export-docbook-xslt-proc-command
10624 @vindex org-export-docbook-xsl-fo-proc-command
10625 Note that, in order to produce PDF output based on exported DocBook file, you
10626 need to have XSLT processor and XSL-FO processor software installed on your
10627 system.  Check variables @code{org-export-docbook-xslt-proc-command} and
10628 @code{org-export-docbook-xsl-fo-proc-command}.
10630 @vindex org-export-docbook-xslt-stylesheet
10631 The stylesheet argument @code{%s} in variable
10632 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10633 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10634 the user.  You can also overrule this global setting on a per-file basis by
10635 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10637 @orgkey{C-c C-e v D}
10638 Export only the visible part of the document.
10639 @end table
10641 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10642 @subsection Quoting DocBook code
10644 You can quote DocBook code in Org files and copy it verbatim into exported
10645 DocBook file with the following constructs:
10647 @cindex #+DOCBOOK
10648 @cindex #+BEGIN_DOCBOOK
10649 @example
10650 #+DOCBOOK: Literal DocBook code for export
10651 @end example
10653 @noindent or
10654 @cindex #+BEGIN_DOCBOOK
10656 @example
10657 #+BEGIN_DOCBOOK
10658 All lines between these markers are exported by DocBook exporter
10659 literally.
10660 #+END_DOCBOOK
10661 @end example
10663 For example, you can use the following lines to include a DocBook warning
10664 admonition.  As to what this warning says, you should pay attention to the
10665 document context when quoting DocBook code in Org files.  You may make
10666 exported DocBook XML files invalid by not quoting DocBook code correctly.
10668 @example
10669 #+BEGIN_DOCBOOK
10670 <warning>
10671   <para>You should know what you are doing when quoting DocBook XML code
10672   in your Org file.  Invalid DocBook XML may be generated by
10673   DocBook exporter if you are not careful!</para>
10674 </warning>
10675 #+END_DOCBOOK
10676 @end example
10678 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10679 @subsection Recursive sections
10680 @cindex DocBook recursive sections
10682 DocBook exporter exports Org files as articles using the @code{article}
10683 element in DocBook.  Recursive sections, i.e.@: @code{section} elements, are
10684 used in exported articles.  Top level headlines in Org files are exported as
10685 top level sections, and lower level headlines are exported as nested
10686 sections.  The entire structure of Org files will be exported completely, no
10687 matter how many nested levels of headlines there are.
10689 Using recursive sections makes it easy to port and reuse exported DocBook
10690 code in other DocBook document types like @code{book} or @code{set}.
10692 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10693 @subsection Tables in DocBook export
10694 @cindex tables, in DocBook export
10696 Tables in Org files are exported as HTML tables, which have been supported since
10697 DocBook V4.3.
10699 If a table does not have a caption, an informal table is generated using the
10700 @code{informaltable} element; otherwise, a formal table will be generated
10701 using the @code{table} element.
10703 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10704 @subsection Images in DocBook export
10705 @cindex images, inline in DocBook
10706 @cindex inlining images in DocBook
10708 Images that are linked to without a description part in the link, like
10709 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10710 using @code{mediaobject} elements.  Each @code{mediaobject} element contains
10711 an @code{imageobject} that wraps an @code{imagedata} element.  If you have
10712 specified a caption for an image as described in @ref{Images and tables}, a
10713 @code{caption} element will be added in @code{mediaobject}.  If a label is
10714 also specified, it will be exported as an @code{xml:id} attribute of the
10715 @code{mediaobject} element.
10717 @vindex org-export-docbook-default-image-attributes
10718 Image attributes supported by the @code{imagedata} element, like @code{align}
10719 or @code{width}, can be specified in two ways: you can either customize
10720 variable @code{org-export-docbook-default-image-attributes} or use the
10721 @code{#+ATTR_DOCBOOK:} line.  Attributes specified in variable
10722 @code{org-export-docbook-default-image-attributes} are applied to all inline
10723 images in the Org file to be exported (unless they are overridden by image
10724 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10726 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10727 attributes or override default image attributes for individual images.  If
10728 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10729 variable @code{org-export-docbook-default-image-attributes}, the former
10730 takes precedence.  Here is an example about how image attributes can be
10731 set:
10733 @cindex #+CAPTION
10734 @cindex #+LABEL
10735 @cindex #+ATTR_DOCBOOK
10736 @example
10737 #+CAPTION:    The logo of Org mode
10738 #+LABEL:      unicorn-svg
10739 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10740 [[./img/org-mode-unicorn.svg]]
10741 @end example
10743 @vindex org-export-docbook-inline-image-extensions
10744 By default, DocBook exporter recognizes the following image file types:
10745 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}.  You can
10746 customize variable @code{org-export-docbook-inline-image-extensions} to add
10747 more types to this list as long as DocBook supports them.
10749 @node Special characters,  , Images in DocBook export, DocBook export
10750 @subsection Special characters in DocBook export
10751 @cindex Special characters in DocBook export
10753 @vindex org-export-docbook-doctype
10754 @vindex org-entities
10755 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10756 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter.  These
10757 characters are rewritten to XML entities, like @code{&alpha;},
10758 @code{&Gamma;}, and @code{&Zeta;}, based on the list saved in variable
10759 @code{org-entities}.  As long as the generated DocBook file includes the
10760 corresponding entities, these special characters are recognized.
10762 You can customize variable @code{org-export-docbook-doctype} to include the
10763 entities you need.  For example, you can set variable
10764 @code{org-export-docbook-doctype} to the following value to recognize all
10765 special characters included in XHTML entities:
10767 @example
10768 "<!DOCTYPE article [
10769 <!ENTITY % xhtml1-symbol PUBLIC
10770 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10771 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10773 %xhtml1-symbol;
10776 @end example
10778 @c begin opendocument
10780 @node OpenDocument Text export, TaskJuggler export, DocBook export, Exporting
10781 @section OpenDocument Text export
10782 @cindex K, Jambunathan
10783 @cindex ODT
10784 @cindex OpenDocument
10785 @cindex export, OpenDocument
10786 @cindex LibreOffice
10787 @cindex org-odt.el
10788 @cindex org-modules
10790 Orgmode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
10791 (@acronym{ODT}) format using the @file{org-odt.el} module.  Documents created
10792 by this exporter use the @cite{OpenDocument-v1.2
10793 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
10794 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
10795 are compatible with LibreOffice 3.4.
10797 @menu
10798 * Pre-requisites for @acronym{ODT} export::  What packages @acronym{ODT} exporter relies on
10799 * @acronym{ODT} export commands::  How to invoke @acronym{ODT} export
10800 * Applying custom styles::      How to apply custom styles to the output
10801 * Links in @acronym{ODT} export::  How links will be interpreted and formatted
10802 * Tables in @acronym{ODT} export::  How Tables are exported
10803 * Images in @acronym{ODT} export::  How to insert images
10804 * Math formatting in @acronym{ODT} export::  How @LaTeX{} fragments are formatted
10805 * Literal examples in @acronym{ODT} export::  How source and example blocks are formatted
10806 * Advanced topics in @acronym{ODT} export::  Read this if you are a power user
10807 @end menu
10809 @node Pre-requisites for @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export, OpenDocument Text export
10810 @subsection Pre-requisites for @acronym{ODT} export
10811 @cindex zip
10812 The @acronym{ODT} exporter relies on the @file{zip} program to create the final
10813 output.  Check the availability of this program before proceeding further.
10815 @node @acronym{ODT} export commands, Applying custom styles, Pre-requisites for @acronym{ODT} export, OpenDocument Text export
10816 @subsection @acronym{ODT} export commands
10818 @subsubheading Exporting to @acronym{ODT}
10819 @anchor{x-export-to-odt}
10821 @cindex region, active
10822 @cindex active region
10823 @cindex transient-mark-mode
10824 @table @kbd
10825 @orgcmd{C-c C-e o,org-export-as-odt}
10826 @cindex property EXPORT_FILE_NAME
10828 Export as OpenDocument Text file.
10829 @vindex org-export-odt-preferred-output-format
10830 If @code{org-export-odt-preferred-output-format} is specified, automatically
10831 convert the exported file to that format.
10832 @xref{x-export-to-other-formats,,Automatically exporting to other formats}.
10834 For an Org file @file{myfile.org}, the @acronym{ODT} file will be
10835 @file{myfile.odt}.  The file will be overwritten without warning.  If there
10836 is an active region,@footnote{This requires @code{transient-mark-mode} to be
10837 turned on} only the region will be exported.  If the selected region is a
10838 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
10839 tree head will become the document title.  If the tree head entry has, or
10840 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
10841 export.
10843 @orgcmd{C-c C-e O,org-export-as-odt-and-open}
10844 Export as OpenDocument Text file and open the resulting file.
10845 @vindex org-export-odt-preferred-output-format
10846 If @code{org-export-odt-preferred-output-format} is specified, open the
10847 converted file instead.
10848 @xref{x-export-to-other-formats,,Automatically exporting to other formats}.
10849 @end table
10851 @subsubheading Automatically exporting to other formats
10852 @anchor{x-export-to-other-formats}
10853 @vindex org-export-odt-preferred-output-format
10854 Very often, you will find yourself exporting to @acronym{ODT} format, only to
10855 immediately save the exported document to a different format like @samp{pdf}.
10856 In such cases, you will find it convenient to configure a converter
10857 (@pxref{Exporting and converting to other formats}) and specify your
10858 preferred output format by customizing the variable
10859 @code{org-export-odt-preferred-output-format}.  This way, the export commands
10860 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to also export to
10861 the preferred format.
10863 @node Applying custom styles, Links in @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export
10864 @subsection Applying custom styles
10865 @cindex styles, custom
10866 @cindex template, custom
10868 The @acronym{ODT} exporter ships with a set of OpenDocument styles
10869 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
10870 output.  These factory styles, however, may not cater to your specific
10871 tastes.  To customize the output, you can either modify the above styles
10872 files directly, or generate the required styles using an application like
10873 LibreOffice.  The latter method is suitable for expert and non-expert
10874 users alike, and is described here.
10876 @subsubsection Applying custom styles - the easy way
10878 @enumerate
10879 @item
10880 Create a sample @file{example.org} file with the below settings and export it
10881 to @acronym{ODT} format.
10883 @example
10884 #+OPTIONS: H:10 num:t
10885 @end example
10887 @item
10888 Open the above @file{example.odt} using LibreOffice.  Use the @file{Stylist}
10889 to locate the target styles - these typically have the @samp{Org} prefix -
10890 and modify those to your taste.  Save the modified file either as an
10891 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
10893 @item
10894 @cindex #+ODT_STYLES_FILE
10895 @vindex org-export-odt-styles-file
10896 Customize the variable @code{org-export-odt-styles-file} and point it to the
10897 newly created file.  For additional configuration options
10898 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
10900 If you would like to choose a style on a per-file basis, you can use the
10901 @code{#+ODT_STYLES_FILE} option.  A typical setting will look like
10903 @example
10904 #+ODT_STYLES_FILE: "/path/to/example.ott"
10905 @end example
10909 @example
10910 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
10911 @end example
10913 @end enumerate
10915 @subsubsection Using third-party styles and templates
10917 You can use third-party styles and templates for customizing your output.
10918 This will produce the desired output only if the template provides all
10919 style names that the @samp{ODT} exporter relies on.  Unless this condition is
10920 met, the output is going to be less than satisfactory.  So it is highly
10921 recommended that you only work with templates that are directly derived from
10922 the factory settings.
10924 @node Links in @acronym{ODT} export, Tables in @acronym{ODT} export, Applying custom styles, OpenDocument Text export
10925 @subsection Links in @acronym{ODT} export
10926 @cindex tables, in DocBook export
10928 The @acronym{ODT} exporter creates cross-references (aka bookmarks) for
10929 internal links.  It creates Internet-style links for all other links.
10931 @node Tables in @acronym{ODT} export, Images in @acronym{ODT} export, Links in @acronym{ODT} export, OpenDocument Text export
10932 @subsection Tables in @acronym{ODT} export
10933 @cindex tables, in DocBook export
10935 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
10936 tables is supported.  However, export of complex @file{table.el} tables -
10937 tables that have column or row spans - is not supported.  Such tables are
10938 stripped from the exported document.
10940 By default, a table is exported with top and bottom frames and with
10941 rules separating row and column groups (@pxref{Column groups}).  If the table
10942 specifies alignment and relative width for its columns (@pxref{Column width
10943 and alignment}) then these are honored on export.@footnote{The column widths
10944 are interpreted as weighted ratios with the default weight being 1}
10946 @cindex #+ATTR_ODT
10947 If you are not satisfied with the default formatting of tables, you can
10948 create custom table styles and associate them with a table using
10949 the @code{#+ATTR_ODT} line.  @xref{Customizing tables in @acronym{ODT} export}.
10951 @node Images in @acronym{ODT} export, Math formatting in @acronym{ODT} export, Tables in @acronym{ODT} export, OpenDocument Text export
10952 @subsection Images in @acronym{ODT} export
10953 @cindex images, embedding in @acronym{ODT}
10954 @cindex embedding images in @acronym{ODT}
10956 @subsubheading Embedding images
10957 You can embed images within the exported document by providing a link to the
10958 desired image file with no link description.  For example, to embed
10959 @samp{img.png} do either of the following:
10961 @example
10962 [[file:img.png]]
10963 @end example
10965 @example
10966 [[./img.png]]
10967 @end example
10969 @subsubheading Embedding clickable images
10970 You can create clickable images by providing a link whose description is a
10971 link to an image file.  For example, to embed a image
10972 @file{org-mode-unicorn.png} which when clicked jumps to
10973 @uref{http://Orgmode.org} website, do the following
10975 @example
10976 [[http://orgmode.org][./org-mode-unicorn.png]]
10977 @end example
10979 @subsubheading Sizing and scaling of embedded images
10981 You can control the size and scale of the embedded images using the
10982 @code{#+ATTR_ODT} attribute.
10984 @vindex org-export-odt-pixels-per-inch
10985 Note that the exporter specifies the desired size of the image in the final
10986 document in units of centimetres.  In order to scale the embedded images, the
10987 exporter needs to compute the size of the image.  This is done by retrieving
10988 the image size in pixels and converting the pixel units to centimetres using
10989 @code{org-export-odt-pixels-per-inch}.  The default value of this variable is
10990 set to @code{display-pixels-per-inch}.  You can tweak this variable to
10991 achieve the best results.
10993 The examples below illustrate the various possibilities.
10995 @table @asis
10997 @item Explicitly size the image
10998 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
11000 @example
11001 #+ATTR_ODT: :width 10 :height 10
11002 [[./img.png]]
11003 @end example
11005 @item Scale the image
11006 To embed @file{img.png} at half its size, do the following:
11008 @example
11009 #+ATTR_ODT: :scale 0.5
11010 [[./img.png]]
11011 @end example
11013 @item Scale the image to a specific width
11014 To embed @file{img.png} with a width of 10 cm while retaining the original
11015 height:width ratio, do the following:
11017 @example
11018 #+ATTR_ODT: :width 10
11019 [[./img.png]]
11020 @end example
11022 @item Scale the image to a specific height
11023 To embed @file{img.png} with a height of 10 cm while retaining the original
11024 height:width ratio, do the following
11026 @example
11027 #+ATTR_ODT: :height 10
11028 [[./img.png]]
11029 @end example
11030 @end table
11032 @node Math formatting in @acronym{ODT} export, Literal examples in @acronym{ODT} export, Images in @acronym{ODT} export, OpenDocument Text export
11033 @subsection Math formatting in @acronym{ODT} export
11035 The @acronym{ODT} exporter has special support for handling math.
11037 @menu
11038 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
11039 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
11040 @end menu
11042 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in @acronym{ODT} export, Math formatting in @acronym{ODT} export
11043 @subsubsection Working with @LaTeX{} math snippets
11045 @LaTeX{} math snippets (@pxref{LaTeX fragments}) can be embedded in the ODT
11046 document in one of the following ways:
11048 @cindex MathML
11049 @enumerate
11050 @item MathML
11052 This option is activated on a per-file basis with
11054 @example
11055 #+OPTIONS: LaTeX:t
11056 @end example
11058 With this option, @LaTeX{} fragments are first converted into MathML
11059 fragments using an external @LaTeX{}-to-MathML converter program.  The
11060 resulting MathML fragments are then embedded as an OpenDocument Formula in
11061 the exported document.
11063 @vindex org-latex-to-mathml-convert-command
11064 @vindex org-latex-to-mathml-jar-file
11066 You can specify the LaTeX-to-MathML converter by customizing the variables
11067 @code{org-latex-to-mathml-convert-command} and
11068 @code{org-latex-to-mathml-jar-file}.
11070 If you prefer to use @file{MathToWeb}@footnote{See
11071 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
11072 converter, you can configure the above variables as shown below.
11074 @lisp
11075 (setq org-latex-to-mathml-convert-command
11076       "java -jar %j -unicode -force -df %o %I"
11077       org-latex-to-mathml-jar-file
11078       "/path/to/mathtoweb.jar")
11079 @end lisp
11081 You can use the following commands to quickly verify the reliability of
11082 the @LaTeX{}-to-MathML converter.
11084 @table @kbd
11086 @item M-x org-export-as-odf
11087 Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file.
11089 @item M-x org-export-as-odf-and-open
11090 Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file and
11091 open the formula file with the system-registered application.
11092 @end table
11094 @cindex dvipng
11095 @item PNG images
11097 This option is activated on a per-file basis with
11099 @example
11100 #+OPTIONS: LaTeX:dvipng
11101 @end example
11103 With this option, @LaTeX{} fragments are processed into PNG images and the
11104 resulting images are embedded in the exported document.  This method requires
11105 that the @file{dvipng} program be available on your system.
11106 @end enumerate
11108 @node Working with MathML or OpenDocument formula files,  , Working with @LaTeX{} math snippets, Math formatting in @acronym{ODT} export
11109 @subsubsection Working with MathML or OpenDocument formula files
11111 For various reasons, you may find embedding @LaTeX{} math snippets in an
11112 @acronym{ODT} document less than reliable.  In that case, you can embed a
11113 math equation by linking to its MathML(@file{.mml}) source or its
11114 OpenDocument formula (@file{.odf}) file as shown below:
11116 @example
11117 [[./equation.mml]]
11118 @end example
11122 @example
11123 [[./equation.odf]]
11124 @end example
11126 @node Literal examples in @acronym{ODT} export, Advanced topics in @acronym{ODT} export, Math formatting in @acronym{ODT} export, OpenDocument Text export
11127 @subsection Literal examples in @acronym{ODT} export
11129 Export of literal examples (@pxref{Literal examples}) with full fontification
11130 is supported.  This feature is enabled by default and is activated
11131 automatically if an enhanced version of @file{htmlfontify.el} is available in
11132 the @code{load-path}.@footnote{The @file{htmlfontify.el} that ships with
11133 standard Emacs <= 24.1 has no support for @acronym{ODT} fontification.  A
11134 copy of the proposed version is available as an attachment to
11135 @url{http://debbugs.gnu.org/cgi/bugreport.cgi?msg=5;filename=htmlfontify.el;att=9;bug=9914,
11136 Emacs Bug #9914}.}
11138 @vindex org-export-odt-fontify-srcblocks
11140 The character styles used for fontification of the literal blocks are
11141 auto-generated by the exporter in conjunction with @file{htmlfontify.el}
11142 library and need not be included in the default @file{styles.xml} file.
11143 These auto-generated styles have the @samp{OrgSrc} prefix and inherit their color
11144 based on the face used by Emacs @code{font-lock} library.
11146 @vindex org-export-odt-create-custom-styles-for-srcblocks
11147 If you prefer to use your own custom styles for fontification and disable
11148 their auto-generation altogether, you can do so by customizing the variable
11149 @code{org-export-odt-create-custom-styles-for-srcblocks}.
11151 You can turn off fontification support for literal examples by customizing
11152 the variable @code{org-export-odt-fontify-srcblocks}.
11155 @node Advanced topics in @acronym{ODT} export,  , Literal examples in @acronym{ODT} export, OpenDocument Text export
11156 @subsection Advanced topics in @acronym{ODT} export
11158 If you rely heavily on @acronym{ODT} export, you may want to exploit the full
11159 set of features that the exporter offers.  This section describes features
11160 that would be of interest to power users.
11162 @menu
11163 * Exporting and converting to other formats::  How to produce @samp{pdf} and other formats
11164 * Working with OpenDocument style files::  Explore the internals
11165 * Creating one-off styles::     How to produce custom highlighting etc
11166 * Customizing tables in @acronym{ODT} export::  How to define and use Table templates
11167 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
11168 @end menu
11170 @node Exporting and converting to other formats, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
11171 @subsubsection Exporting and converting to other formats
11172 @cindex convert
11173 @cindex doc, docx
11175 The @acronym{ODT} exporter adds support for exporting Org outlines to formats
11176 that are not supported natively by Org.  It also adds support to convert
11177 document from one format to another.  To use these features, you need to
11178 configure a command-line converter.  Once a command-line converter is
11179 configured you can use it to extend the list of formats to which Org can
11180 export.  @xref{x-export-to-other-formats,,Automatically exporting to other
11181 formats}.  You can also use it to perform one-off document conversion as
11182 detailed below.
11184 @vindex org-export-odt-convert
11185 @table @kbd
11187 @item M-x org-export-odt-convert
11188 Convert an existing document from one format to another as determined by the
11189 variable @code{org-export-odt-convert-capabilities}
11190 (@pxref{x-odt-converter-capabilities,,Configure converter
11191 capabilities}).  @strong{Please note} that you can use this command to even
11192 convert documents that are produced outside of Org and in other formats than
11193 @acronym{ODT} format.
11194 @end table
11196 @subsubheading Pre-configured converters
11198 @cindex converter
11199 The @acronym{ODT} exporter supports two converters out of the box:
11201 @enumerate
11203 @cindex @file{unoconv}
11204 @item @file{unoconv}
11206 This converter is available as an installable package in your favorite
11207 distribution.
11209 @cindex @file{BasicODConverter}
11210 @item @file{BasicODConverter}
11212 @vindex org-odt-data-dir
11213 This converter is distributed as a LibreOffice extension and can be found in
11214 your Org distribution.  See the subdirectory pointed to by the variable
11215 @code{org-odt-data-dir}.
11217 @end enumerate
11219 @subsubheading Installing a new converter
11220 If you prefer to use a converter other than the two mentioned above, then you
11221 may have to do additional configuration.  You can proceed as follows:
11223 @enumerate
11224 @item Register the converter
11226 @vindex org-export-odt-convert-processes
11227 Name your converter and add it to the list of known converters by customizing
11228 the variable @code{org-export-odt-convert-processes}.  Also specify how the
11229 converter can be invoked via command-line to effect the conversion.
11231 @item Configure its capabilities
11232 @vindex org-export-odt-convert-capabilities
11234 @anchor{x-odt-converter-capabilities}
11236 Specify the set of formats the converter can handle by customizing the
11237 variable @code{org-export-odt-convert-capabilities}.  Use the default value
11238 for this variable as a guide for configuring your converter.  As suggested by
11239 the default setting, you can specify the full set of formats supported by the
11240 converter and not limit yourself to specifying formats that are related to
11241 just the OpenDocument Text format.
11243 @item Choose the converter
11245 @vindex org-export-odt-convert-process
11246 Select the newly added converter as the preferred one by customizing the
11247 variable @code{org-export-odt-convert-process}.
11248 @end enumerate
11250 @node Working with OpenDocument style files, Creating one-off styles, Exporting and converting to other formats, Advanced topics in @acronym{ODT} export
11251 @subsubsection Working with OpenDocument style files
11252 @cindex styles, custom
11253 @cindex template, custom
11255 This section explores the internals of the @acronym{ODT} exporter and the
11256 means by which it produces styled documents.  Read this section if you are
11257 interested in exploring the automatic and custom OpenDocument styles used by
11258 the exporter.
11260 @anchor{x-factory-styles}
11261 @subsubheading Factory styles
11263 The @acronym{ODT} exporter relies on two files for generating its output.
11264 These files are bundled with the distribution under the directory pointed to
11265 by the variable @code{org-odt-styles-dir}.  The two files are:
11267 @itemize
11268 @anchor{x-orgodtstyles-xml}
11269 @item
11270 @file{OrgOdtStyles.xml}
11272 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
11273 document.  This file gets modified for the following purposes:
11274 @enumerate
11276 @item
11277 To control outline numbering based on user settings.
11279 @item
11280 To add styles generated by @file{htmlfontify.el} for fontification of code
11281 blocks.
11282 @end enumerate
11284 @anchor{x-orgodtcontenttemplate-xml}
11285 @item
11286 @file{OrgOdtContentTemplate.xml}
11288 This file contributes to the @file{content.xml} file of the final @samp{ODT}
11289 document.  The contents of the Org outline are inserted between the
11290 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
11292 Apart from serving as a template file for the final @file{content.xml}, the
11293 file serves the following purposes:
11294 @enumerate
11296 @item
11297 It contains automatic styles for formatting of tables which are referenced by
11298 the exporter.
11300 @item
11301 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
11302 elements that control how various entities - tables, images, equations etc -
11303 are numbered.
11304 @end enumerate
11305 @end itemize
11307 @anchor{x-overriding-factory-styles}
11308 @subsubheading Overriding factory styles
11309 The following two variables control the location from which the @acronym{ODT}
11310 exporter picks up the custom styles and content template files.  You can
11311 customize these variables to override the factory styles used by the
11312 exporter.
11314 @itemize
11315 @anchor{x-org-export-odt-styles-file}
11316 @item
11317 @code{org-export-odt-styles-file}
11319 Use this variable to specify the @file{styles.xml} that will be used in the
11320 final output.  You can specify one of the following values:
11322 @enumerate
11323 @item A @file{styles.xml} file
11325 Use this file instead of the default @file{styles.xml}
11327 @item A @file{.odt} or @file{.ott} file
11329 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11330 Template file
11332 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
11334 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11335 Template file.  Additionally extract the specified member files and embed
11336 those within the final @samp{ODT} document.
11338 Use this option if the @file{styles.xml} file references additional files
11339 like header and footer images.
11341 @item @code{nil}
11343 Use the default @file{styles.xml}
11344 @end enumerate
11346 @anchor{x-org-export-odt-content-template-file}
11347 @item
11348 @code{org-export-odt-content-template-file}
11350 Use this variable to specify the blank @file{content.xml} that will be used
11351 in the final output.
11352 @end itemize
11354 @node Creating one-off styles, Customizing tables in @acronym{ODT} export, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export
11355 @subsubsection Creating one-off styles
11357 There are times when you would want one-off formatting in the exported
11358 document.  You can achieve this by embedding raw OpenDocument XML in the Org
11359 file.  The use of this feature is better illustrated with couple of examples.
11361 @enumerate
11362 @item Embedding ODT tags as part of regular text
11364 You can include simple OpenDocument tags by prefixing them with
11365 @samp{@@}.  For example, to highlight a region of text do the following:
11367 @example
11368 @@<text:span text:style-name="Highlight">This is a
11369 highlighted text@@</text:span>.  But this is a
11370 regular text.
11371 @end example
11373 @strong{Hint:} To see the above example in action, edit your
11374 @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11375 custom @samp{Highlight} style as shown below.
11377 @example
11378 <style:style style:name="Highlight" style:family="text">
11379   <style:text-properties fo:background-color="#ff0000"/>
11380 </style:style>
11381 @end example
11383 @item Embedding a one-line OpenDocument XML
11385 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
11386 directive.  For example, to force a page break do the following:
11388 @example
11389 #+ODT: <text:p text:style-name="PageBreak"/>
11390 @end example
11392 @strong{Hint:} To see the above example in action, edit your
11393 @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11394 custom @samp{PageBreak} style as shown below.
11396 @example
11397 <style:style style:name="PageBreak" style:family="paragraph"
11398              style:parent-style-name="Text_20_body">
11399   <style:paragraph-properties fo:break-before="page"/>
11400 </style:style>
11401 @end example
11403 @item Embedding a block of OpenDocument XML
11405 You can add a large block of OpenDocument XML using the
11406 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
11408 For example, to create a one-off paragraph that uses bold text, do the
11409 following:
11411 @example
11412 #+BEGIN_ODT
11413 <text:p text:style-name="Text_20_body_20_bold">
11414 This paragraph is specially formatted and uses bold text.
11415 </text:p>
11416 #+END_ODT
11417 @end example
11419 @end enumerate
11421 @node Customizing tables in @acronym{ODT} export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in @acronym{ODT} export
11422 @subsubsection Customizing tables in @acronym{ODT} export
11423 @cindex tables, in ODT export
11425 @cindex #+ATTR_ODT
11426 You can override the default formatting of the table by specifying a custom
11427 table style with the @code{#+ATTR_ODT} line.  For a discussion on default
11428 formatting of tables @pxref{Tables in @acronym{ODT} export}.
11430 This feature closely mimics the way table templates are defined in the
11431 OpenDocument-v1.2
11432 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11433 OpenDocument-v1.2 Specification}}
11437 @subsubheading Custom table styles - an illustration
11439 To have a quick preview of this feature, install the below setting and export
11440 the table that follows.
11442 @lisp
11443 (setq org-export-odt-table-styles
11444       (append org-export-odt-table-styles
11445               '(("TableWithHeaderRowAndColumn" "Custom"
11446                  ((use-first-row-styles . t)
11447                   (use-first-column-styles . t)))
11448                 ("TableWithFirstRowandLastRow" "Custom"
11449                  ((use-first-row-styles . t)
11450                   (use-last-row-styles . t))))))
11451 @end lisp
11453 @example
11454 #+ATTR_ODT: TableWithHeaderRowAndColumn
11455 | Name  | Phone | Age |
11456 | Peter |  1234 |  17 |
11457 | Anna  |  4321 |  25 |
11458 @end example
11460 In the above example, you used a template named @samp{Custom} and installed
11461 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
11462 @samp{TableWithFirstRowandLastRow}.  (@strong{Important:} The OpenDocument
11463 styles needed for producing the above template have been pre-defined for you.
11464 These styles are available under the section marked @samp{Custom Table
11465 Template} in @file{OrgOdtContentTemplate.xml}
11466 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}).  If you need
11467 additional templates you have to define these styles yourselves.
11469 @subsubheading Custom table styles - the nitty-gritty
11470 To use this feature proceed as follows:
11472 @enumerate
11473 @item
11474 Create a table template@footnote{See the @code{<table:table-template>}
11475 element of the OpenDocument-v1.2 specification}
11477 A table template is nothing but a set of @samp{table-cell} and
11478 @samp{paragraph} styles for each of the following table cell categories:
11480 @itemize @minus
11481 @item Body
11482 @item First column
11483 @item Last column
11484 @item First row
11485 @item Last row
11486 @item Even row
11487 @item Odd row
11488 @item Even column
11489 @item Odd Column
11490 @end itemize
11492 The names for the above styles must be chosen based on the name of the table
11493 template using a well-defined convention.
11495 The naming convention is better illustrated with an example.  For a table
11496 template with the name @samp{Custom}, the needed style names are listed in
11497 the following table.
11499 @multitable  {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
11500 @headitem Table cell type
11501 @tab @code{table-cell} style
11502 @tab @code{paragraph} style
11503 @item
11504 @tab
11505 @tab
11506 @item Body
11507 @tab @samp{CustomTableCell}
11508 @tab @samp{CustomTableParagraph}
11509 @item First column
11510 @tab @samp{CustomFirstColumnTableCell}
11511 @tab @samp{CustomFirstColumnTableParagraph}
11512 @item Last column
11513 @tab @samp{CustomLastColumnTableCell}
11514 @tab @samp{CustomLastColumnTableParagraph}
11515 @item First row
11516 @tab @samp{CustomFirstRowTableCell}
11517 @tab @samp{CustomFirstRowTableParagraph}
11518 @item Last row
11519 @tab @samp{CustomLastRowTableCell}
11520 @tab @samp{CustomLastRowTableParagraph}
11521 @item Even row
11522 @tab @samp{CustomEvenRowTableCell}
11523 @tab @samp{CustomEvenRowTableParagraph}
11524 @item Odd row
11525 @tab @samp{CustomOddRowTableCell}
11526 @tab @samp{CustomOddRowTableParagraph}
11527 @item Even column
11528 @tab @samp{CustomEvenColumnTableCell}
11529 @tab @samp{CustomEvenColumnTableParagraph}
11530 @item Odd column
11531 @tab @samp{CustomOddColumnTableCell}
11532 @tab @samp{CustomOddColumnTableParagraph}
11533 @end multitable
11535 To create a table template with the name @samp{Custom}, define the above
11536 styles in the
11537 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
11538 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
11539 styles}).
11541 @item
11542 Define a table style@footnote{See the attributes @code{table:template-name},
11543 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
11544 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
11545 @code{table:use-banding-rows-styles}, and
11546 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
11547 the OpenDocument-v1.2 specification}
11549 @vindex org-export-odt-table-styles
11550 To define a table style, create an entry for the style in the variable
11551 @code{org-export-odt-table-styles} and specify the following:
11553 @itemize @minus
11554 @item the name of the table template created in step (1)
11555 @item the set of cell styles in that template that are to be activated
11556 @end itemize
11558 For example, the entry below defines two different table styles
11559 @samp{TableWithHeaderRowsAndColumns} and @samp{TableWithHeaderColumns} based
11560 on the same template @samp{Custom}.  The styles achieve their intended effect
11561 by selectively activating the individual cell styles in that template.
11563 @lisp
11564 (setq org-export-odt-table-styles
11565       (append org-export-odt-table-styles
11566               '(("TableWithHeaderRowAndColumn" "Custom"
11567                  ((use-first-row-styles . t)
11568                   (use-first-column-styles . t)))
11569                 ("TableWithFirstRowandLastRow" "Custom"
11570                  ((use-first-row-styles . t)
11571                   (use-last-row-styles . t))))))
11572 @end lisp
11574 @item
11575 Associate a table with the table style
11577 To do this, specify the table style created in step (2) as part of
11578 the @code{ATTR_ODT} line as shown below.
11580 @example
11581 #+ATTR_ODT: TableWithHeaderRowAndColumn
11582 | Name  | Phone | Age |
11583 | Peter |  1234 |  17 |
11584 | Anna  |  4321 |  25 |
11585 @end example
11586 @end enumerate
11588 @node Validating OpenDocument XML,  , Customizing tables in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
11589 @subsubsection Validating OpenDocument XML
11591 Occasionally, you will discover that the document created by the
11592 @acronym{ODT} exporter cannot be opened by your favorite application.  One of
11593 the common reasons for this is that the @file{.odt} file is corrupt.  In such
11594 cases, you may want to validate the document against the OpenDocument RELAX
11595 NG Compact Syntax (RNC) schema.
11597 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
11598 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}.  For
11599 general help with validation (and schema-sensitive editing) of XML files:
11600 @inforef{Introduction,,nxml-mode}.
11602 @vindex org-export-odt-schema-dir
11603 If you have ready access to OpenDocument @file{.rnc} files and the needed
11604 schema-locating rules in a single folder, you can customize the variable
11605 @code{org-export-odt-schema-dir} to point to that directory.  The
11606 @acronym{ODT} exporter will take care of updating the
11607 @code{rng-schema-locating-files} for you.
11609 @c end opendocument
11611 @node  TaskJuggler export, Freemind export, OpenDocument Text export, Exporting
11612 @section TaskJuggler export
11613 @cindex TaskJuggler export
11614 @cindex Project management
11616 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
11617 It provides an optimizing scheduler that computes your project time lines and
11618 resource assignments based on the project outline and the constraints that
11619 you have provided.
11621 The TaskJuggler exporter is a bit different from other exporters, such as the
11622 HTML and LaTeX exporters for example, in that it does not export all the
11623 nodes of a document or strictly follow the order of the nodes in the
11624 document.
11626 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
11627 a optionally tree that defines the resources for this project.  It then
11628 creates a TaskJuggler file based on these trees and the attributes defined in
11629 all the nodes.
11631 @subsection TaskJuggler export commands
11633 @table @kbd
11634 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
11635 Export as TaskJuggler file.
11637 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
11638 Export as TaskJuggler file and then open the file with TaskJugglerUI.
11639 @end table
11641 @subsection Tasks
11643 @vindex org-export-taskjuggler-project-tag
11644 Create your tasks as you usually do with Org mode.  Assign efforts to each
11645 task using properties (it is easiest to do this in the column view).  You
11646 should end up with something similar to the example by Peter Jones in
11647 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
11648 Now mark the top node of your tasks with a tag named
11649 @code{:taskjuggler_project:} (or whatever you customized
11650 @code{org-export-taskjuggler-project-tag} to).  You are now ready to export
11651 the project plan with @kbd{C-c C-e J} which will export the project plan and
11652 open a gantt chart in TaskJugglerUI.
11654 @subsection Resources
11656 @vindex org-export-taskjuggler-resource-tag
11657 Next you can define resources and assign those to work on specific tasks.  You
11658 can group your resources hierarchically.  Tag the top node of the resources
11659 with @code{:taskjuggler_resource:} (or whatever you customized
11660 @code{org-export-taskjuggler-resource-tag} to).  You can optionally assign an
11661 identifier (named @samp{resource_id}) to the resources (using the standard
11662 Org properties commands, @pxref{Property syntax}) or you can let the exporter
11663 generate identifiers automatically (the exporter picks the first word of the
11664 headline as the identifier as long as it is unique---see the documentation of
11665 @code{org-taskjuggler-get-unique-id}).  Using that identifier you can then
11666 allocate resources to tasks.  This is again done with the @samp{allocate}
11667 property on the tasks.  Do this in column view or when on the task type
11668 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
11670 Once the allocations are done you can again export to TaskJuggler and check
11671 in the Resource Allocation Graph which person is working on what task at what
11672 time.
11674 @subsection Export of properties
11676 The exporter also takes TODO state information into consideration, i.e.@: if a
11677 task is marked as done it will have the corresponding attribute in
11678 TaskJuggler (@samp{complete 100}).  Also it will export any property on a task
11679 resource or resource node which is known to TaskJuggler, such as
11680 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
11681 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
11682 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
11683 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
11684 @samp{scheduling}, etc for tasks.
11686 @subsection Dependencies
11688 The exporter will handle dependencies that are defined in the tasks either
11689 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
11690 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
11691 @samp{depends} attribute.  Both the @samp{BLOCKER} and the @samp{depends}
11692 attribute can be either @samp{previous-sibling} or a reference to an
11693 identifier (named @samp{task_id}) which is defined for another task in the
11694 project.  @samp{BLOCKER} and the @samp{depends} attribute can define multiple
11695 dependencies separated by either space or comma.  You can also specify
11696 optional attributes on the dependency by simply appending it.  The following
11697 examples should illustrate this:
11699 @example
11700 * Preparation
11701   :PROPERTIES:
11702   :task_id:  preparation
11703   :ORDERED:  t
11704   :END:
11705 * Training material
11706   :PROPERTIES:
11707   :task_id:  training_material
11708   :ORDERED:  t
11709   :END:
11710 ** Markup Guidelines
11711    :PROPERTIES:
11712    :Effort:   2d
11713    :END:
11714 ** Workflow Guidelines
11715    :PROPERTIES:
11716    :Effort:   2d
11717    :END:
11718 * Presentation
11719   :PROPERTIES:
11720   :Effort:   2d
11721   :BLOCKER:  training_material @{ gapduration 1d @} preparation
11722   :END:
11723 @end example
11725 @subsection Reports
11727 @vindex org-export-taskjuggler-default-reports
11728 TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
11729 allocation, etc).  The user defines what kind of reports should be generated
11730 for a project in the TaskJuggler file.  The exporter will automatically insert
11731 some default reports in the file.  These defaults are defined in
11732 @code{org-export-taskjuggler-default-reports}.  They can be modified using
11733 customize along with a number of other options.  For a more complete list, see
11734 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
11736 For more information and examples see the Org-taskjuggler tutorial at
11737 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
11739 @node Freemind export, XOXO export, TaskJuggler export, Exporting
11740 @section Freemind export
11741 @cindex Freemind export
11742 @cindex mind map
11744 The Freemind exporter was written by Lennart Borgman.
11746 @table @kbd
11747 @orgcmd{C-c C-e m,org-export-as-freemind}
11748 Export as Freemind mind map.  For an Org file @file{myfile.org}, the Freemind
11749 file will be @file{myfile.mm}.
11750 @end table
11752 @node XOXO export, iCalendar export, Freemind export, Exporting
11753 @section XOXO export
11754 @cindex XOXO export
11756 Org mode contains an exporter that produces XOXO-style output.
11757 Currently, this exporter only handles the general outline structure and
11758 does not interpret any additional Org mode features.
11760 @table @kbd
11761 @orgcmd{C-c C-e x,org-export-as-xoxo}
11762 Export as XOXO file.  For an Org file @file{myfile.org}, the XOXO file will be
11763 @file{myfile.html}.
11764 @orgkey{C-c C-e v x}
11765 Export only the visible part of the document.
11766 @end table
11768 @node iCalendar export,  , XOXO export, Exporting
11769 @section iCalendar export
11770 @cindex iCalendar export
11772 @vindex org-icalendar-include-todo
11773 @vindex org-icalendar-use-deadline
11774 @vindex org-icalendar-use-scheduled
11775 @vindex org-icalendar-categories
11776 @vindex org-icalendar-alarm-time
11777 Some people use Org mode for keeping track of projects, but still prefer a
11778 standard calendar application for anniversaries and appointments.  In this
11779 case it can be useful to show deadlines and other time-stamped items in Org
11780 files in the calendar application.  Org mode can export calendar information
11781 in the standard iCalendar format.  If you also want to have TODO entries
11782 included in the export, configure the variable
11783 @code{org-icalendar-include-todo}.  Plain timestamps are exported as VEVENT,
11784 and TODO items as VTODO.  It will also create events from deadlines that are
11785 in non-TODO items.  Deadlines and scheduling dates in TODO items will be used
11786 to set the start and due dates for the TODO entry@footnote{See the variables
11787 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
11788 As categories, it will use the tags locally defined in the heading, and the
11789 file/tree category@footnote{To add inherited tags or the TODO state,
11790 configure the variable @code{org-icalendar-categories}.}.  See the variable
11791 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
11792 time.
11794 @vindex org-icalendar-store-UID
11795 @cindex property, ID
11796 The iCalendar standard requires each entry to have a globally unique
11797 identifier (UID).  Org creates these identifiers during export.  If you set
11798 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
11799 @code{:ID:} property of the entry and re-used next time you report this
11800 entry.  Since a single entry can give rise to multiple iCalendar entries (as
11801 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
11802 prefixes to the UID, depending on what triggered the inclusion of the entry.
11803 In this way the UID remains unique, but a synchronization program can still
11804 figure out from which entry all the different instances originate.
11806 @table @kbd
11807 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
11808 Create iCalendar entries for the current file and store them in the same
11809 directory, using a file extension @file{.ics}.
11810 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
11811 @vindex org-agenda-files
11812 Like @kbd{C-c C-e i}, but do this for all files in
11813 @code{org-agenda-files}.  For each of these files, a separate iCalendar
11814 file will be written.
11815 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
11816 @vindex org-combined-agenda-icalendar-file
11817 Create a single large iCalendar file from all files in
11818 @code{org-agenda-files} and write it to the file given by
11819 @code{org-combined-agenda-icalendar-file}.
11820 @end table
11822 @vindex org-use-property-inheritance
11823 @vindex org-icalendar-include-body
11824 @cindex property, SUMMARY
11825 @cindex property, DESCRIPTION
11826 @cindex property, LOCATION
11827 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
11828 property can be inherited from higher in the hierarchy if you configure
11829 @code{org-use-property-inheritance} accordingly.} properties if the selected
11830 entries have them.  If not, the summary will be derived from the headline,
11831 and the description from the body (limited to
11832 @code{org-icalendar-include-body} characters).
11834 How this calendar is best read and updated, depends on the application
11835 you are using.  The FAQ covers this issue.
11837 @node Publishing, Working With Source Code, Exporting, Top
11838 @chapter Publishing
11839 @cindex publishing
11841 Org includes a publishing management system that allows you to configure
11842 automatic HTML conversion of @emph{projects} composed of interlinked org
11843 files.  You can also configure Org to automatically upload your exported HTML
11844 pages and related attachments, such as images and source code files, to a web
11845 server.
11847 You can also use Org to convert files into PDF, or even combine HTML and PDF
11848 conversion so that files are available in both formats on the server.
11850 Publishing has been contributed to Org by David O'Toole.
11852 @menu
11853 * Configuration::               Defining projects
11854 * Uploading files::             How to get files up on the server
11855 * Sample configuration::        Example projects
11856 * Triggering publication::      Publication commands
11857 @end menu
11859 @node Configuration, Uploading files, Publishing, Publishing
11860 @section Configuration
11862 Publishing needs significant configuration to specify files, destination
11863 and many other properties of a project.
11865 @menu
11866 * Project alist::               The central configuration variable
11867 * Sources and destinations::    From here to there
11868 * Selecting files::             What files are part of the project?
11869 * Publishing action::           Setting the function doing the publishing
11870 * Publishing options::          Tweaking HTML/@LaTeX{} export
11871 * Publishing links::            Which links keep working after publishing?
11872 * Sitemap::                     Generating a list of all pages
11873 * Generating an index::         An index that reaches across pages
11874 @end menu
11876 @node Project alist, Sources and destinations, Configuration, Configuration
11877 @subsection The variable @code{org-publish-project-alist}
11878 @cindex org-publish-project-alist
11879 @cindex projects, for publishing
11881 @vindex org-publish-project-alist
11882 Publishing is configured almost entirely through setting the value of one
11883 variable, called @code{org-publish-project-alist}.  Each element of the list
11884 configures one project, and may be in one of the two following forms:
11886 @lisp
11887    ("project-name" :property value :property value ...)
11888      @r{i.e.@: a well-formed property list with alternating keys and values}
11889 @r{or}
11890    ("project-name" :components ("project-name" "project-name" ...))
11892 @end lisp
11894 In both cases, projects are configured by specifying property values.  A
11895 project defines the set of files that will be published, as well as the
11896 publishing configuration to use when publishing those files.  When a project
11897 takes the second form listed above, the individual members of the
11898 @code{:components} property are taken to be sub-projects, which group
11899 together files requiring different publishing options.  When you publish such
11900 a ``meta-project'', all the components will also be published, in the
11901 sequence given.
11903 @node Sources and destinations, Selecting files, Project alist, Configuration
11904 @subsection Sources and destinations for files
11905 @cindex directories, for publishing
11907 Most properties are optional, but some should always be set.  In
11908 particular, Org needs to know where to look for source files,
11909 and where to put published files.
11911 @multitable @columnfractions 0.3 0.7
11912 @item @code{:base-directory}
11913 @tab Directory containing publishing source files
11914 @item @code{:publishing-directory}
11915 @tab Directory where output files will be published.  You can directly
11916 publish to a webserver using a file name syntax appropriate for
11917 the Emacs @file{tramp} package.  Or you can publish to a local directory and
11918 use external tools to upload your website (@pxref{Uploading files}).
11919 @item @code{:preparation-function}
11920 @tab Function or list of functions to be called before starting the
11921 publishing process, for example, to run @code{make} for updating files to be
11922 published.  The project property list is scoped into this call as the
11923 variable @code{project-plist}.
11924 @item @code{:completion-function}
11925 @tab Function or list of functions called after finishing the publishing
11926 process, for example, to change permissions of the resulting files.  The
11927 project property list is scoped into this call as the variable
11928 @code{project-plist}.
11929 @end multitable
11930 @noindent
11932 @node Selecting files, Publishing action, Sources and destinations, Configuration
11933 @subsection Selecting files
11934 @cindex files, selecting for publishing
11936 By default, all files with extension @file{.org} in the base directory
11937 are considered part of the project.  This can be modified by setting the
11938 properties
11939 @multitable @columnfractions 0.25 0.75
11940 @item @code{:base-extension}
11941 @tab Extension (without the dot!) of source files.  This actually is a
11942 regular expression.  Set this to the symbol @code{any} if you want to get all
11943 files in @code{:base-directory}, even without extension.
11945 @item @code{:exclude}
11946 @tab Regular expression to match file names that should not be
11947 published, even though they have been selected on the basis of their
11948 extension.
11950 @item @code{:include}
11951 @tab List of files to be included regardless of @code{:base-extension}
11952 and @code{:exclude}.
11954 @item @code{:recursive}
11955 @tab Non-nil means, check base-directory recursively for files to publish.
11956 @end multitable
11958 @node Publishing action, Publishing options, Selecting files, Configuration
11959 @subsection Publishing action
11960 @cindex action, for publishing
11962 Publishing means that a file is copied to the destination directory and
11963 possibly transformed in the process.  The default transformation is to export
11964 Org files as HTML files, and this is done by the function
11965 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
11966 export}).  But you also can publish your content as PDF files using
11967 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
11968 @code{utf8} encoded files using the corresponding functions.  If you want to
11969 publish the Org file itself, but with @i{archived}, @i{commented}, and
11970 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
11971 parameters @code{:plain-source} and/or @code{:htmlized-source}.  This will
11972 produce @file{file.org} and @file{file.org.html} in the publishing
11973 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
11974 source and publishing directories are equal.  Note that with this kind of
11975 setup, you need to add @code{:exclude "-source\\.org"} to the project
11976 definition in @code{org-publish-project-alist} to prevent the published
11977 source files from being considered as new org files the next time the project
11978 is published.}.  Other files like images only need to be copied to the
11979 publishing destination; for this you may use @code{org-publish-attachment}.
11980 For non-Org files, you always need to specify the publishing function:
11982 @multitable @columnfractions 0.3 0.7
11983 @item @code{:publishing-function}
11984 @tab Function executing the publication of a file.  This may also be a
11985 list of functions, which will all be called in turn.
11986 @item @code{:plain-source}
11987 @tab Non-nil means, publish plain source.
11988 @item @code{:htmlized-source}
11989 @tab Non-nil means, publish htmlized source.
11990 @end multitable
11992 The function must accept three arguments: a property list containing at least
11993 a @code{:publishing-directory} property, the name of the file to be
11994 published, and the path to the publishing directory of the output file.  It
11995 should take the specified file, make the necessary transformation (if any)
11996 and place the result into the destination folder.
11998 @node Publishing options, Publishing links, Publishing action, Configuration
11999 @subsection Options for the HTML/@LaTeX{} exporters
12000 @cindex options, for publishing
12002 The property list can be used to set many export options for the HTML
12003 and @LaTeX{} exporters.  In most cases, these properties correspond to user
12004 variables in Org.  The table below lists these properties along
12005 with the variable they belong to.  See the documentation string for the
12006 respective variable for details.
12008 @vindex org-export-html-link-up
12009 @vindex org-export-html-link-home
12010 @vindex org-export-default-language
12011 @vindex org-display-custom-times
12012 @vindex org-export-headline-levels
12013 @vindex org-export-with-section-numbers
12014 @vindex org-export-section-number-format
12015 @vindex org-export-with-toc
12016 @vindex org-export-preserve-breaks
12017 @vindex org-export-with-archived-trees
12018 @vindex org-export-with-emphasize
12019 @vindex org-export-with-sub-superscripts
12020 @vindex org-export-with-special-strings
12021 @vindex org-export-with-footnotes
12022 @vindex org-export-with-drawers
12023 @vindex org-export-with-tags
12024 @vindex org-export-with-todo-keywords
12025 @vindex org-export-with-tasks
12026 @vindex org-export-with-done-tasks
12027 @vindex org-export-with-priority
12028 @vindex org-export-with-TeX-macros
12029 @vindex org-export-with-LaTeX-fragments
12030 @vindex org-export-skip-text-before-1st-heading
12031 @vindex org-export-with-fixed-width
12032 @vindex org-export-with-timestamps
12033 @vindex org-export-author-info
12034 @vindex org-export-email-info
12035 @vindex org-export-creator-info
12036 @vindex org-export-time-stamp-file
12037 @vindex org-export-with-tables
12038 @vindex org-export-highlight-first-table-line
12039 @vindex org-export-html-style-include-default
12040 @vindex org-export-html-style-include-scripts
12041 @vindex org-export-html-style
12042 @vindex org-export-html-style-extra
12043 @vindex org-export-html-link-org-files-as-html
12044 @vindex org-export-html-inline-images
12045 @vindex org-export-html-extension
12046 @vindex org-export-html-table-tag
12047 @vindex org-export-html-expand
12048 @vindex org-export-html-with-timestamp
12049 @vindex org-export-publishing-directory
12050 @vindex org-export-html-preamble
12051 @vindex org-export-html-postamble
12052 @vindex user-full-name
12053 @vindex user-mail-address
12054 @vindex org-export-select-tags
12055 @vindex org-export-exclude-tags
12057 @multitable @columnfractions 0.32 0.68
12058 @item @code{:link-up}               @tab @code{org-export-html-link-up}
12059 @item @code{:link-home}             @tab @code{org-export-html-link-home}
12060 @item @code{:language}              @tab @code{org-export-default-language}
12061 @item @code{:customtime}            @tab @code{org-display-custom-times}
12062 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
12063 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
12064 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
12065 @item @code{:table-of-contents}     @tab @code{org-export-with-toc}
12066 @item @code{:preserve-breaks}       @tab @code{org-export-preserve-breaks}
12067 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
12068 @item @code{:emphasize}             @tab @code{org-export-with-emphasize}
12069 @item @code{:sub-superscript}       @tab @code{org-export-with-sub-superscripts}
12070 @item @code{:special-strings}       @tab @code{org-export-with-special-strings}
12071 @item @code{:footnotes}             @tab @code{org-export-with-footnotes}
12072 @item @code{:drawers}               @tab @code{org-export-with-drawers}
12073 @item @code{:tags}                  @tab @code{org-export-with-tags}
12074 @item @code{:todo-keywords}         @tab @code{org-export-with-todo-keywords}
12075 @item @code{:tasks}                 @tab @code{org-export-with-tasks}
12076 @item @code{:priority}              @tab @code{org-export-with-priority}
12077 @item @code{:TeX-macros}            @tab @code{org-export-with-TeX-macros}
12078 @item @code{:LaTeX-fragments}       @tab @code{org-export-with-LaTeX-fragments}
12079 @item @code{:latex-listings}        @tab @code{org-export-latex-listings}
12080 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
12081 @item @code{:fixed-width}           @tab @code{org-export-with-fixed-width}
12082 @item @code{:timestamps}            @tab @code{org-export-with-timestamps}
12083 @item @code{:author}                @tab @code{user-full-name}
12084 @item @code{:email}                 @tab @code{user-mail-address} : @code{addr;addr;..}
12085 @item @code{:author-info}           @tab @code{org-export-author-info}
12086 @item @code{:email-info}            @tab @code{org-export-email-info}
12087 @item @code{:creator-info}          @tab @code{org-export-creator-info}
12088 @item @code{:tables}                @tab @code{org-export-with-tables}
12089 @item @code{:table-auto-headline}   @tab @code{org-export-highlight-first-table-line}
12090 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
12091 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
12092 @item @code{:style}                 @tab @code{org-export-html-style}
12093 @item @code{:style-extra}           @tab @code{org-export-html-style-extra}
12094 @item @code{:convert-org-links}     @tab @code{org-export-html-link-org-files-as-html}
12095 @item @code{:inline-images}         @tab @code{org-export-html-inline-images}
12096 @item @code{:html-extension}        @tab @code{org-export-html-extension}
12097 @item @code{:html-preamble}         @tab @code{org-export-html-preamble}
12098 @item @code{:html-postamble}        @tab @code{org-export-html-postamble}
12099 @item @code{:xml-declaration}       @tab @code{org-export-html-xml-declaration}
12100 @item @code{:html-table-tag}        @tab @code{org-export-html-table-tag}
12101 @item @code{:expand-quoted-html}    @tab @code{org-export-html-expand}
12102 @item @code{:timestamp}             @tab @code{org-export-html-with-timestamp}
12103 @item @code{:publishing-directory}  @tab @code{org-export-publishing-directory}
12104 @item @code{:select-tags}           @tab @code{org-export-select-tags}
12105 @item @code{:exclude-tags}          @tab @code{org-export-exclude-tags}
12106 @item @code{:latex-image-options}   @tab @code{org-export-latex-image-default-option}
12107 @end multitable
12109 Most of the @code{org-export-with-*} variables have the same effect in
12110 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
12111 @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
12112 @LaTeX{} export.  See @code{org-export-plist-vars} to check this list of
12113 options.
12117 @vindex org-publish-project-alist
12118 When a property is given a value in @code{org-publish-project-alist},
12119 its setting overrides the value of the corresponding user variable (if
12120 any) during publishing.  Options set within a file (@pxref{Export
12121 options}), however, override everything.
12123 @node Publishing links, Sitemap, Publishing options, Configuration
12124 @subsection Links between published files
12125 @cindex links, publishing
12127 To create a link from one Org file to another, you would use
12128 something like @samp{[[file:foo.org][The foo]]} or simply
12129 @samp{file:foo.org.} (@pxref{Hyperlinks}).  When published, this link
12130 becomes a link to @file{foo.html}.  In this way, you can interlink the
12131 pages of your "org web" project and the links will work as expected when
12132 you publish them to HTML.  If you also publish the Org source file and want
12133 to link to that, use an @code{http:} link instead of a @code{file:} link,
12134 because @code{file:} links are converted to link to the corresponding
12135 @file{html} file.
12137 You may also link to related files, such as images.  Provided you are careful
12138 with relative file names, and provided you have also configured Org to upload
12139 the related files, these links will work too.  See @ref{Complex example}, for
12140 an example of this usage.
12142 Sometimes an Org file to be published may contain links that are
12143 only valid in your production environment, but not in the publishing
12144 location.  In this case, use the property
12146 @multitable @columnfractions 0.4 0.6
12147 @item @code{:link-validation-function}
12148 @tab Function to validate links
12149 @end multitable
12151 @noindent
12152 to define a function for checking link validity.  This function must
12153 accept two arguments, the file name and a directory relative to which
12154 the file name is interpreted in the production environment.  If this
12155 function returns @code{nil}, then the HTML generator will only insert a
12156 description into the HTML file, but no link.  One option for this
12157 function is @code{org-publish-validate-link} which checks if the given
12158 file is part of any project in @code{org-publish-project-alist}.
12160 @node Sitemap, Generating an index, Publishing links, Configuration
12161 @subsection Generating a sitemap
12162 @cindex sitemap, of published pages
12164 The following properties may be used to control publishing of
12165 a map of files for a given project.
12167 @multitable @columnfractions 0.35 0.65
12168 @item @code{:auto-sitemap}
12169 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
12170 or @code{org-publish-all}.
12172 @item @code{:sitemap-filename}
12173 @tab Filename for output of sitemap.  Defaults to @file{sitemap.org} (which
12174 becomes @file{sitemap.html}).
12176 @item @code{:sitemap-title}
12177 @tab Title of sitemap page.  Defaults to name of file.
12179 @item @code{:sitemap-function}
12180 @tab Plug-in function to use for generation of the sitemap.
12181 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
12182 of links to all files in the project.
12184 @item @code{:sitemap-sort-folders}
12185 @tab Where folders should appear in the sitemap.  Set this to @code{first}
12186 (default) or @code{last} to display folders first or last,
12187 respectively.  Any other value will mix files and folders.
12189 @item @code{:sitemap-sort-files}
12190 @tab How the files are sorted in the site map.  Set this to
12191 @code{alphabetically} (default), @code{chronologically} or
12192 @code{anti-chronologically}.  @code{chronologically} sorts the files with
12193 older date first while @code{anti-chronologically} sorts the files with newer
12194 date first.  @code{alphabetically} sorts the files alphabetically.  The date of
12195 a file is retrieved with @code{org-publish-find-date}.
12197 @item @code{:sitemap-ignore-case}
12198 @tab Should sorting be case-sensitive?  Default @code{nil}.
12200 @item @code{:sitemap-file-entry-format}
12201 @tab With this option one can tell how a sitemap's entry is formatted in the
12202 sitemap.  This is a format string with some escape sequences: @code{%t} stands
12203 for the title of the file, @code{%a} stands for the author of the file and
12204 @code{%d} stands for the date of the file.  The date is retrieved with the
12205 @code{org-publish-find-date} function and formatted with
12206 @code{org-publish-sitemap-date-format}.  Default @code{%t}.
12208 @item @code{:sitemap-date-format}
12209 @tab Format string for the @code{format-time-string} function that tells how
12210 a sitemap entry's date is to be formatted.  This property bypasses
12211 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
12213 @item @code{:sitemap-sans-extension}
12214 @tab When non-nil, remove filenames' extensions from the generated sitemap.
12215 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
12216 Defaults to @code{nil}.
12218 @end multitable
12220 @node Generating an index,  , Sitemap, Configuration
12221 @subsection Generating an index
12222 @cindex index, in a publishing project
12224 Org mode can generate an index across the files of a publishing project.
12226 @multitable @columnfractions 0.25 0.75
12227 @item @code{:makeindex}
12228 @tab When non-nil, generate in index in the file @file{theindex.org} and
12229 publish it as @file{theindex.html}.
12230 @end multitable
12232 The file will be created when first publishing a project with the
12233 @code{:makeindex} set.  The file only contains a statement @code{#+include:
12234 "theindex.inc"}.  You can then build around this include statement by adding
12235 a title, style information, etc.
12237 @node Uploading files, Sample configuration, Configuration, Publishing
12238 @section Uploading files
12239 @cindex rsync
12240 @cindex unison
12242 For those people already utilizing third party sync tools such as
12243 @command{rsync} or @command{unison}, it might be preferable not to use the built in
12244 @i{remote} publishing facilities of Org mode which rely heavily on
12245 Tramp.  Tramp, while very useful and powerful, tends not to be
12246 so efficient for multiple file transfer and has been known to cause problems
12247 under heavy usage.
12249 Specialized synchronization utilities offer several advantages.  In addition
12250 to timestamp comparison, they also do content and permissions/attribute
12251 checks.  For this reason you might prefer to publish your web to a local
12252 directory (possibly even @i{in place} with your Org files) and then use
12253 @file{unison} or @file{rsync} to do the synchronization with the remote host.
12255 Since Unison (for example) can be configured as to which files to transfer to
12256 a certain remote destination, it can greatly simplify the project publishing
12257 definition.  Simply keep all files in the correct location, process your Org
12258 files with @code{org-publish} and let the synchronization tool do the rest.
12259 You do not need, in this scenario, to include attachments such as @file{jpg},
12260 @file{css} or @file{gif} files in the project definition since the 3rd party
12261 tool syncs them.
12263 Publishing to a local directory is also much faster than to a remote one, so
12264 that you can afford more easily to republish entire projects.  If you set
12265 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
12266 benefit of re-including any changed external files such as source example
12267 files you might include with @code{#+INCLUDE}.  The timestamp mechanism in
12268 Org is not smart enough to detect if included files have been modified.
12270 @node Sample configuration, Triggering publication, Uploading files, Publishing
12271 @section Sample configuration
12273 Below we provide two example configurations.  The first one is a simple
12274 project publishing only a set of Org files.  The second example is
12275 more complex, with a multi-component project.
12277 @menu
12278 * Simple example::              One-component publishing
12279 * Complex example::             A multi-component publishing example
12280 @end menu
12282 @node Simple example, Complex example, Sample configuration, Sample configuration
12283 @subsection Example: simple publishing configuration
12285 This example publishes a set of Org files to the @file{public_html}
12286 directory on the local machine.
12288 @lisp
12289 (setq org-publish-project-alist
12290       '(("org"
12291          :base-directory "~/org/"
12292          :publishing-directory "~/public_html"
12293          :section-numbers nil
12294          :table-of-contents nil
12295          :style "<link rel=\"stylesheet\"
12296                 href=\"../other/mystyle.css\"
12297                 type=\"text/css\"/>")))
12298 @end lisp
12300 @node Complex example,  , Simple example, Sample configuration
12301 @subsection Example: complex publishing configuration
12303 This more complicated example publishes an entire website, including
12304 Org files converted to HTML, image files, Emacs Lisp source code, and
12305 style sheets.  The publishing directory is remote and private files are
12306 excluded.
12308 To ensure that links are preserved, care should be taken to replicate
12309 your directory structure on the web server, and to use relative file
12310 paths.  For example, if your Org files are kept in @file{~/org} and your
12311 publishable images in @file{~/images}, you would link to an image with
12313 @example
12314 file:../images/myimage.png
12315 @end example
12317 On the web server, the relative path to the image should be the
12318 same.  You can accomplish this by setting up an "images" folder in the
12319 right place on the web server, and publishing images to it.
12321 @lisp
12322 (setq org-publish-project-alist
12323       '(("orgfiles"
12324           :base-directory "~/org/"
12325           :base-extension "org"
12326           :publishing-directory "/ssh:user@@host:~/html/notebook/"
12327           :publishing-function org-publish-org-to-html
12328           :exclude "PrivatePage.org"   ;; regexp
12329           :headline-levels 3
12330           :section-numbers nil
12331           :table-of-contents nil
12332           :style "<link rel=\"stylesheet\"
12333                   href=\"../other/mystyle.css\" type=\"text/css\"/>"
12334           :html-preamble t)
12336          ("images"
12337           :base-directory "~/images/"
12338           :base-extension "jpg\\|gif\\|png"
12339           :publishing-directory "/ssh:user@@host:~/html/images/"
12340           :publishing-function org-publish-attachment)
12342          ("other"
12343           :base-directory "~/other/"
12344           :base-extension "css\\|el"
12345           :publishing-directory "/ssh:user@@host:~/html/other/"
12346           :publishing-function org-publish-attachment)
12347          ("website" :components ("orgfiles" "images" "other"))))
12348 @end lisp
12350 @node Triggering publication,  , Sample configuration, Publishing
12351 @section Triggering publication
12353 Once properly configured, Org can publish with the following commands:
12355 @table @kbd
12356 @orgcmd{C-c C-e X,org-publish}
12357 Prompt for a specific project and publish all files that belong to it.
12358 @orgcmd{C-c C-e P,org-publish-current-project}
12359 Publish the project containing the current file.
12360 @orgcmd{C-c C-e F,org-publish-current-file}
12361 Publish only the current file.
12362 @orgcmd{C-c C-e E,org-publish-all}
12363 Publish every project.
12364 @end table
12366 @vindex org-publish-use-timestamps-flag
12367 Org uses timestamps to track when a file has changed.  The above functions
12368 normally only publish changed files.  You can override this and force
12369 publishing of all files by giving a prefix argument to any of the commands
12370 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
12371 This may be necessary in particular if files include other files via
12372 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
12374 @comment  node-name,  next,  previous,  up
12375 @comment Working With Source Code, Miscellaneous, Publishing, Top
12377 @node Working With Source Code, Miscellaneous, Publishing, Top
12378 @chapter Working with source code
12379 @cindex Schulte, Eric
12380 @cindex Davison, Dan
12381 @cindex source code, working with
12383 Source code can be included in Org mode documents using a @samp{src} block,
12384 e.g.@:
12386 @example
12387 #+BEGIN_SRC emacs-lisp
12388   (defun org-xor (a b)
12389      "Exclusive or."
12390      (if a (not b) b))
12391 #+END_SRC
12392 @end example
12394 Org mode provides a number of features for working with live source code,
12395 including editing of code blocks in their native major-mode, evaluation of
12396 code blocks, converting code blocks into source files (known as @dfn{tangling}
12397 in literate programming), and exporting code blocks and their
12398 results in several formats.  This functionality was contributed by Eric
12399 Schulte and Dan Davison, and was originally named Org-babel.
12401 The following sections describe Org mode's code block handling facilities.
12403 @menu
12404 * Structure of code blocks::    Code block syntax described
12405 * Editing source code::         Language major-mode editing
12406 * Exporting code blocks::       Export contents and/or results
12407 * Extracting source code::      Create pure source code files
12408 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
12409 * Library of Babel::            Use and contribute to a library of useful code blocks
12410 * Languages::                   List of supported code block languages
12411 * Header arguments::            Configure code block functionality
12412 * Results of evaluation::       How evaluation results are handled
12413 * Noweb reference syntax::      Literate programming in Org mode
12414 * Key bindings and useful functions::  Work quickly with code blocks
12415 * Batch execution::             Call functions from the command line
12416 @end menu
12418 @comment  node-name,  next,  previous,  up
12419 @comment  Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12421 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12422 @section Structure of code blocks
12423 @cindex code block, structure
12424 @cindex source code, block structure
12425 @cindex #+NAME
12426 @cindex #+BEGIN_SRC
12428 Live code blocks can be specified with a @samp{src} block or
12429 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
12430 @ref{Easy Templates} system}  The structure of a @samp{src} block is
12432 @example
12433 #+NAME: <name>
12434 #+BEGIN_SRC <language> <switches> <header arguments>
12435   <body>
12436 #+END_SRC
12437 @end example
12439 The @code{#+NAME:} line is optional, and can be used to name the code
12440 block.  Live code blocks require that a language be specified on the
12441 @code{#+BEGIN_SRC} line.  Switches and header arguments are optional.
12442 @cindex source code, inline
12444 Live code blocks can also be specified inline using
12446 @example
12447 src_<language>@{<body>@}
12448 @end example
12452 @example
12453 src_<language>[<header arguments>]@{<body>@}
12454 @end example
12456 @table @code
12457 @item <#+NAME: name>
12458 This line associates a name with the code block.  This is similar to the
12459 @code{#+TBLNAME: NAME} lines that can be used to name tables in Org mode
12460 files.  Referencing the name of a code block makes it possible to evaluate
12461 the block from other places in the file, from other files, or from Org mode
12462 table formulas (see @ref{The spreadsheet}).  Names are assumed to be unique
12463 and the behavior of Org mode when two or more blocks share the same name is
12464 undefined.
12465 @cindex #+NAME
12466 @item <language>
12467 The language of the code in the block (see @ref{Languages}).
12468 @cindex source code, language
12469 @item <switches>
12470 Optional switches control code block export (see the discussion of switches in
12471 @ref{Literal examples})
12472 @cindex source code, switches
12473 @item <header arguments>
12474 Optional header arguments control many aspects of evaluation, export and
12475 tangling of code blocks (see @ref{Header arguments}).
12476 Header arguments can also be set on a per-buffer or per-subtree
12477 basis using properties.
12478 @item source code, header arguments
12479 @item <body>
12480 Source code in the specified language.
12481 @end table
12483 @comment  node-name,  next,  previous,  up
12484 @comment  Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12486 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12487 @section Editing source code
12488 @cindex code block, editing
12489 @cindex source code, editing
12491 @kindex C-c '
12492 Use @kbd{C-c '} to edit the current code block.  This brings up
12493 a language major-mode edit buffer containing the body of the code
12494 block.  Saving this buffer will write the new contents back to the Org
12495 buffer.  Use @kbd{C-c '} again to exit.
12497 The @code{org-src-mode} minor mode will be active in the edit buffer.  The
12498 following variables can be used to configure the behavior of the edit
12499 buffer.  See also the customization group @code{org-edit-structure} for
12500 further configuration options.
12502 @table @code
12503 @item org-src-lang-modes
12504 If an Emacs major-mode named @code{<lang>-mode} exists, where
12505 @code{<lang>} is the language named in the header line of the code block,
12506 then the edit buffer will be placed in that major-mode.  This variable
12507 can be used to map arbitrary language names to existing major modes.
12508 @item org-src-window-setup
12509 Controls the way Emacs windows are rearranged when the edit buffer is created.
12510 @item org-src-preserve-indentation
12511 This variable is especially useful for tangling languages such as
12512 Python, in which whitespace indentation in the output is critical.
12513 @item org-src-ask-before-returning-to-edit-buffer
12514 By default, Org will ask before returning to an open edit buffer.  Set this
12515 variable to nil to switch without asking.
12516 @end table
12518 To turn on native code fontification in the @emph{Org} buffer, configure the
12519 variable @code{org-src-fontify-natively}.
12521 @comment  node-name,  next,  previous,  up
12522 @comment  Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12524 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12525 @section Exporting code blocks
12526 @cindex code block, exporting
12527 @cindex source code, exporting
12529 It is possible to export the @emph{code} of code blocks, the @emph{results}
12530 of code block evaluation, @emph{both} the code and the results of code block
12531 evaluation, or @emph{none}.  For most languages, the default exports code.
12532 However, for some languages (e.g.@: @code{ditaa}) the default exports the
12533 results of code block evaluation.  For information on exporting code block
12534 bodies, see @ref{Literal examples}.
12536 The @code{:exports} header argument can be used to specify export
12537 behavior:
12539 @subsubheading Header arguments:
12540 @table @code
12541 @item :exports code
12542 The default in most languages.  The body of the code block is exported, as
12543 described in @ref{Literal examples}.
12544 @item :exports results
12545 The code block will be evaluated and the results will be placed in the
12546 Org mode buffer for export, either updating previous results of the code
12547 block located anywhere in the buffer or, if no previous results exist,
12548 placing the results immediately after the code block.  The body of the code
12549 block will not be exported.
12550 @item :exports both
12551 Both the code block and its results will be exported.
12552 @item :exports none
12553 Neither the code block nor its results will be exported.
12554 @end table
12556 It is possible to inhibit the evaluation of code blocks during export.
12557 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
12558 ensure that no code blocks are evaluated as part of the export process.  This
12559 can be useful in situations where potentially untrusted Org mode files are
12560 exported in an automated fashion, for example when Org mode is used as the
12561 markup language for a wiki.
12563 @comment  node-name,  next,  previous,  up
12564 @comment  Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12565 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12566 @section Extracting source code
12567 @cindex tangling
12568 @cindex source code, extracting
12569 @cindex code block, extracting source code
12571 Creating pure source code files by extracting code from source blocks is
12572 referred to as ``tangling''---a term adopted from the literate programming
12573 community.  During ``tangling'' of code blocks their bodies are expanded
12574 using @code{org-babel-expand-src-block} which can expand both variable and
12575 ``noweb'' style references  (see @ref{Noweb reference syntax}).
12577 @subsubheading Header arguments
12578 @table @code
12579 @item :tangle no
12580 The default.  The code block is not included in the tangled output.
12581 @item :tangle yes
12582 Include the code block in the tangled output.  The output file name is the
12583 name of the org file with the extension @samp{.org} replaced by the extension
12584 for the block language.
12585 @item :tangle filename
12586 Include the code block in the tangled output to file @samp{filename}.
12587 @end table
12589 @kindex  C-c C-v t
12590 @subsubheading Functions
12591 @table @code
12592 @item org-babel-tangle
12593 Tangle the current file.  Bound to @kbd{C-c C-v t}.
12594 @item org-babel-tangle-file
12595 Choose a file to tangle.  Bound to @kbd{C-c C-v f}.
12596 @end table
12598 @subsubheading Hooks
12599 @table @code
12600 @item org-babel-post-tangle-hook
12601 This hook is run from within code files tangled by @code{org-babel-tangle}.
12602 Example applications could include post-processing, compilation or evaluation
12603 of tangled code files.
12604 @end table
12606 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
12607 @section Evaluating code blocks
12608 @cindex code block, evaluating
12609 @cindex source code, evaluating
12611 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
12612 potential for that code to do harm.  Org mode provides safeguards to ensure
12613 that code is only evaluated after explicit confirmation from the user.  For
12614 information on these safeguards (and on how to disable them) see @ref{Code
12615 evaluation security}.} and the results of evaluation optionally placed in the
12616 Org mode buffer.  By default, the evaluation facility is only enabled for
12617 Lisp code blocks specified as @code{emacs-lisp}. However, souce code blocks
12618 in many languages can be evaluated within Org mode (see @ref{Languages} for a
12619 list of supported languages and @ref{Structure of code blocks} for
12620 information on the syntax used to define a code block).
12622 @kindex C-c C-c
12623 There are a number of ways to evaluate code blocks.  The simplest is to press
12624 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
12625 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
12626 evaluation from the @kbd{C-c C-c} key binding.}.  This will call the
12627 @code{org-babel-execute-src-block} function to evaluate the block and insert
12628 its results into the Org mode buffer.
12629 @cindex #+CALL
12631 It is also possible to evaluate named code blocks from anywhere in an
12632 Org mode buffer or an Org mode table. Live code blocks located in the current
12633 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
12634 can be executed.  Named code blocks can be executed with a separate
12635 @code{#+CALL:} line or inline within a block of text.
12637 The syntax of the @code{#+CALL:} line is
12639 @example
12640 #+CALL: <name>(<arguments>)
12641 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
12642 @end example
12644 The syntax for inline evaluation of named code blocks is
12646 @example
12647 ... call_<name>(<arguments>) ...
12648 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
12649 @end example
12651 @table @code
12652 @item <name>
12653 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
12654 @item <arguments>
12655 Arguments specified in this section will be passed to the code block.  These
12656 arguments use standard function call syntax, rather than
12657 header argument syntax.  For example, a @code{#+CALL:} line that passes the
12658 number four to a code block named @code{double}, which declares the header
12659 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
12660 @item <inside header arguments>
12661 Inside header arguments are passed through and applied to the named code
12662 block.  These arguments use header argument syntax rather than standard
12663 function call syntax.  Inside header arguments affect how the code block is
12664 evaluated.  For example, @code{[:results output]} will collect the results of
12665 everything printed to @code{STDOUT} during execution of the code block.
12666 @item <end header arguments>
12667 End header arguments are applied to the calling instance and do not affect
12668 evaluation of the named code block.  They affect how the results are
12669 incorporated into the Org mode buffer and how the call line is exported.  For
12670 example, @code{:results html} will insert the results of the call line
12671 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
12673 For more examples of passing header arguments to @code{#+CALL:} lines see
12674 @ref{Header arguments in function calls}.
12675 @end table
12677 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
12678 @section Library of Babel
12679 @cindex babel, library of
12680 @cindex source code, library
12681 @cindex code block, library
12683 The ``Library of Babel'' consists of code blocks that can be called from any
12684 Org mode file.  Code blocks defined in the ``Library of Babel'' can be called
12685 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
12686 code blocks} for information on the syntax of remote code block evaluation).
12689 The central repository of code blocks in the ``Library of Babel'' is housed
12690 in an Org mode file located in the @samp{contrib} directory of Org mode.
12692 Users can add code blocks they believe to be generally useful to their
12693 ``Library of Babel.''  The code blocks can be stored in any Org mode file and
12694 then loaded into the library with @code{org-babel-lob-ingest}.
12697 @kindex C-c C-v i
12698 Code blocks located in any Org mode file can be loaded into the ``Library of
12699 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
12702 @node Languages, Header arguments, Library of Babel, Working With Source Code
12703 @section Languages
12704 @cindex babel, languages
12705 @cindex source code, languages
12706 @cindex code block, languages
12708 Code blocks in the following languages are supported.
12710 @multitable @columnfractions 0.28 0.3 0.22 0.2
12711 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
12712 @item Asymptote @tab asymptote @tab Awk @tab awk
12713 @item Emacs Calc @tab calc @tab C @tab C
12714 @item C++ @tab C++ @tab Clojure @tab clojure
12715 @item CSS @tab css @tab ditaa @tab ditaa
12716 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
12717 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
12718 @item Java @tab java @tab @tab
12719 @item Javascript @tab js @tab LaTeX @tab latex
12720 @item Ledger @tab ledger @tab Lisp @tab lisp
12721 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
12722 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
12723 @item Octave @tab octave @tab Org mode @tab org
12724 @item Oz @tab oz @tab Perl @tab perl
12725 @item Plantuml @tab plantuml @tab Python @tab python
12726 @item R @tab R @tab Ruby @tab ruby
12727 @item Sass @tab sass @tab Scheme @tab scheme
12728 @item GNU Screen @tab screen @tab shell @tab sh
12729 @item SQL @tab sql @tab SQLite @tab sqlite
12730 @end multitable
12732 Language-specific documentation is available for some languages.  If
12733 available, it can be found at
12734 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
12736 The @code{org-babel-load-languages} controls which languages are enabled for
12737 evaluation (by default only @code{emacs-lisp} is enabled).  This variable can
12738 be set using the customization interface or by adding code like the following
12739 to your emacs configuration.
12741 @quotation
12742 The following disables @code{emacs-lisp} evaluation and enables evaluation of
12743 @code{R} code blocks.
12744 @end quotation
12746 @lisp
12747 (org-babel-do-load-languages
12748  'org-babel-load-languages
12749  '((emacs-lisp . nil)
12750    (R . t)))
12751 @end lisp
12753 It is also possible to enable support for a language by loading the related
12754 elisp file with @code{require}.
12756 @quotation
12757 The following adds support for evaluating @code{clojure} code blocks.
12758 @end quotation
12760 @lisp
12761 (require 'ob-clojure)
12762 @end lisp
12764 @node Header arguments, Results of evaluation, Languages, Working With Source Code
12765 @section Header arguments
12766 @cindex code block, header arguments
12767 @cindex source code, block header arguments
12769 Code block functionality can be configured with header arguments.  This
12770 section provides an overview of the use of header arguments, and then
12771 describes each header argument in detail.
12773 @menu
12774 * Using header arguments::      Different ways to set header arguments
12775 * Specific header arguments::   List of header arguments
12776 @end menu
12778 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
12779 @subsection Using header arguments
12781 The values of header arguments can be set in six different ways, each more
12782 specific (and having higher priority) than the last.
12783 @menu
12784 * System-wide header arguments::  Set global default values
12785 * Language-specific header arguments::  Set default values by language
12786 * Buffer-wide header arguments::  Set default values for a specific buffer
12787 * Header arguments in Org mode properties::  Set default values for a buffer or heading
12788 * Code block specific header arguments::  The most common way to set values
12789 * Header arguments in function calls::  The most specific level
12790 @end menu
12793 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
12794 @subsubheading System-wide header arguments
12795 @vindex org-babel-default-header-args
12796 System-wide values of header arguments can be specified by customizing the
12797 @code{org-babel-default-header-args} variable:
12799 @example
12800 :session    => "none"
12801 :results    => "replace"
12802 :exports    => "code"
12803 :cache      => "no"
12804 :noweb      => "no"
12805 @end example
12807 @c @example
12808 @c   org-babel-default-header-args is a variable defined in `org-babel.el'.
12809 @c   Its value is
12810 @c   ((:session . "none")
12811 @c    (:results . "replace")
12812 @c    (:exports . "code")
12813 @c    (:cache . "no")
12814 @c    (:noweb . "no"))
12817 @c   Documentation:
12818 @c   Default arguments to use when evaluating a code block.
12819 @c @end example
12821 For example, the following example could be used to set the default value of
12822 @code{:noweb} header arguments to @code{yes}.  This would have the effect of
12823 expanding @code{:noweb} references by default when evaluating source code
12824 blocks.
12826 @lisp
12827 (setq org-babel-default-header-args
12828 (cons '(:noweb . "yes")
12829 (assq-delete-all :noweb org-babel-default-header-args)))
12830 @end lisp
12832 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
12833 @subsubheading Language-specific header arguments
12834 Each language can define its own set of default header arguments.  See the
12835 language-specific documentation available online at
12836 @uref{http://orgmode.org/worg/org-contrib/babel}.
12838 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
12839 @subsubheading Buffer-wide header arguments
12840 Buffer-wide header arguments may be specified as properties through the use
12841 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
12842 @ref{Property syntax}).
12844 For example the following would set @code{session} to @code{*R*}, and
12845 @code{results} to @code{silent} for every code block in the buffer, ensuring
12846 that all execution took place in the same session, and no results would be
12847 inserted into the buffer.
12849 @example
12850 #+PROPERTY: session *R*
12851 #+PROPERTY: results silent
12852 @end example
12854 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
12855 @subsubheading Header arguments in Org mode properties
12857 Header arguments are also read from Org mode properties (see @ref{Property
12858 syntax}), which can be set on a buffer-wide or per-heading basis.  An example
12859 of setting a header argument for all code blocks in a buffer is
12861 @example
12862 #+PROPERTY: tangle yes
12863 @end example
12865 @vindex org-use-property-inheritance
12866 When properties are used to set default header arguments, they are looked up
12867 with inheritance, regardless of the value of
12868 @code{org-use-property-inheritance}.  In the following example the value of
12869 the @code{:cache} header argument will default to @code{yes} in all code
12870 blocks in the subtree rooted at the following heading:
12872 @example
12873 * outline header
12874 :PROPERTIES:
12875 :cache:    yes
12876 :END:
12877 @end example
12879 @kindex C-c C-x p
12880 @vindex org-babel-default-header-args
12881 Properties defined in this way override the properties set in
12882 @code{org-babel-default-header-args}.  It is convenient to use the
12883 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
12884 in Org mode documents.
12886 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
12887 @subsubheading Code block specific header arguments
12889 The most common way to assign values to header arguments is at the
12890 code block level.  This can be done by listing a sequence of header
12891 arguments and their values as part of the @code{#+BEGIN_SRC} line.
12892 Properties set in this way override both the values of
12893 @code{org-babel-default-header-args} and header arguments specified as
12894 properties.  In the following example, the @code{:results} header argument
12895 is set to @code{silent}, meaning the results of execution will not be
12896 inserted in the buffer, and the @code{:exports} header argument is set to
12897 @code{code}, meaning only the body of the code block will be
12898 preserved on export to HTML or LaTeX.
12900 @example
12901 #+NAME: factorial
12902 #+BEGIN_SRC haskell :results silent :exports code :var n=0
12903 fac 0 = 1
12904 fac n = n * fac (n-1)
12905 #+END_SRC
12906 @end example
12907 Similarly, it is possible to set header arguments for inline code blocks
12909 @example
12910 src_haskell[:exports both]@{fac 5@}
12911 @end example
12913 Code block header arguments can span multiple lines using @code{#+HEADER:} or
12914 @code{#+HEADERS:} lines preceding a code block or nested between the
12915 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
12916 @cindex #+HEADER:
12917 @cindex #+HEADERS:
12919 Multi-line header arguments on an un-named code block:
12920 @example
12921  #+HEADERS: :var data1=1
12922  #+BEGIN_SRC emacs-lisp :var data2=2
12923    (message "data1:%S, data2:%S" data1 data2)
12924  #+END_SRC
12926  #+results:
12927  : data1:1, data2:2
12928 @end example
12930 Multi-line header arguments on a named code block:
12931 @example
12932    #+NAME: named-block
12933    #+HEADER: :var data=2
12934    #+BEGIN_SRC emacs-lisp
12935      (message "data:%S" data)
12936    #+END_SRC
12938    #+results: named-block
12939    : data:2
12940 @end example
12942 @node Header arguments in function calls,  , Code block specific header arguments, Using header arguments
12943 @comment  node-name,  next,  previous,  up
12944 @subsubheading Header arguments in function calls
12946 At the most specific level, header arguments for ``Library of Babel'' or
12947 @code{#+CALL:} lines can be set as shown in the two examples below.  For more
12948 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
12949 blocks}.
12951 The following will apply the @code{:exports results} header argument to the
12952 evaluation of the @code{#+CALL:} line.
12953 @example
12954 #+CALL: factorial(n=5) :exports results
12955 @end example
12957 The following will apply the @code{:session special} header argument to the
12958 evaluation of the @code{factorial} code block.
12959 @example
12960 #+CALL: factorial[:session special](n=5)
12961 @end example
12963 @node Specific header arguments,  , Using header arguments, Header arguments
12964 @subsection Specific header arguments
12965 Header arguments consist of an initial colon followed by the name of the
12966 argument in lowercase letters.  The following header arguments are defined:
12968 @menu
12969 * var::                         Pass arguments to code blocks
12970 * results::                     Specify the type of results and how they will
12971                                 be collected and handled
12972 * file::                        Specify a path for file output
12973 * dir::                         Specify the default (possibly remote)
12974                                 directory for code block execution
12975 * exports::                     Export code and/or results
12976 * tangle::                      Toggle tangling and specify file name
12977 * mkdirp::                      Toggle creation of parent directories of target
12978                                 files during tangling
12979 * comments::                    Toggle insertion of comments in tangled
12980                                 code files
12981 * padline::                     Control insertion of padding lines in tangled
12982                                 code files
12983 * no-expand::                   Turn off variable assignment and noweb
12984                                 expansion during tangling
12985 * session::                     Preserve the state of code evaluation
12986 * noweb::                       Toggle expansion of noweb references
12987 * noweb-ref::                   Specify block's noweb reference resolution target
12988 * cache::                       Avoid re-evaluating unchanged code blocks
12989 * sep::                         Delimiter for writing tabular results outside Org
12990 * hlines::                      Handle horizontal lines in tables
12991 * colnames::                    Handle column names in tables
12992 * rownames::                    Handle row names in tables
12993 * shebang::                     Make tangled files executable
12994 * eval::                        Limit evaluation of specific code blocks
12995 @end menu
12997 Additional header arguments are defined on a language-specific basis, see
12998 @ref{Languages}.
13000 @node var, results, Specific header arguments, Specific header arguments
13001 @subsubsection @code{:var}
13002 The @code{:var} header argument is used to pass arguments to code blocks.
13003 The specifics of how arguments are included in a code block vary by language;
13004 these are addressed in the language-specific documentation.  However, the
13005 syntax used to specify arguments is the same across all languages.  In every
13006 case, variables require a default value when they are declared.
13008 The values passed to arguments can either be literal values, references, or
13009 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
13010 include anything in the Org mode file that takes a @code{#+NAME:},
13011 @code{#+TBLNAME:}, or @code{#+RESULTS:} line.  This includes tables, lists,
13012 @code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
13013 code blocks.
13015 Argument values can be indexed in a manner similar to arrays (see @ref{var,
13016 Indexable variable values}).
13018 The following syntax is used to pass arguments to code blocks using the
13019 @code{:var} header argument.
13021 @example
13022 :var name=assign
13023 @end example
13025 The argument, @code{assign}, can either be a literal value, such as a string
13026 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
13027 literal example, another code block (with or without arguments), or the
13028 results of evaluating another code block.
13030 Here are examples of passing values by reference:
13032 @table @dfn
13034 @item table
13035 an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
13036 @example
13037 #+TBLNAME: example-table
13038 | 1 |
13039 | 2 |
13040 | 3 |
13041 | 4 |
13043 #+NAME: table-length
13044 #+BEGIN_SRC emacs-lisp :var table=example-table
13045 (length table)
13046 #+END_SRC
13048 #+results: table-length
13049 : 4
13050 @end example
13052 @item list
13053 a simple list named with a @code{#+NAME:} line (note that nesting is not
13054 carried through to the source code block)
13056 @example
13057 #+NAME: example-list
13058   - simple
13059     - not
13060     - nested
13061   - list
13063 #+BEGIN_SRC emacs-lisp :var x=example-list
13064   (print x)
13065 #+END_SRC
13067 #+results:
13068 | simple | list |
13069 @end example
13071 @item code block without arguments
13072 a code block name (from the example above), as assigned by @code{#+NAME:},
13073 optionally followed by parentheses
13075 @example
13076 #+BEGIN_SRC emacs-lisp :var length=table-length()
13077 (* 2 length)
13078 #+END_SRC
13080 #+results:
13081 : 8
13082 @end example
13084 @item code block with arguments
13085 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
13086 optional arguments passed within the parentheses following the
13087 code block name using standard function call syntax
13089 @example
13090 #+NAME: double
13091 #+BEGIN_SRC emacs-lisp :var input=8
13092 (* 2 input)
13093 #+END_SRC
13095 #+results: double
13096 : 16
13098 #+NAME: squared
13099 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
13100 (* input input)
13101 #+END_SRC
13103 #+results: squared
13104 : 4
13105 @end example
13107 @item literal example
13108 a literal example block named with a @code{#+NAME:} line
13110 @example
13111 #+NAME: literal-example
13112 #+BEGIN_EXAMPLE
13113 A literal example
13114 on two lines
13115 #+END_EXAMPLE
13117 #+NAME: read-literal-example
13118 #+BEGIN_SRC emacs-lisp :var x=literal-example
13119   (concatenate 'string x " for you.")
13120 #+END_SRC
13122 #+results: read-literal-example
13123 : A literal example
13124 : on two lines for you.
13126 @end example
13128 @end table
13130 @subsubheading Alternate argument syntax
13131 It is also possible to specify arguments in a potentially more natural way
13132 using the @code{#+NAME:} line of a code block.  As in the following
13133 example, arguments can be packed inside of parentheses, separated by commas,
13134 following the source name.
13136 @example
13137 #+NAME: double(input=0, x=2)
13138 #+BEGIN_SRC emacs-lisp
13139 (* 2 (+ input x))
13140 #+END_SRC
13141 @end example
13143 @subsubheading Indexable variable values
13144 It is possible to reference portions of variable values by ``indexing'' into
13145 the variables.  Indexes are 0 based with negative values counting back from
13146 the end.  If an index is separated by @code{,}s then each subsequent section
13147 will index into the next deepest nesting or dimension of the value.  Note
13148 that this indexing occurs @emph{before} other table related header arguments
13149 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied.  The
13150 following example assigns the last cell of the first row the table
13151 @code{example-table} to the variable @code{data}:
13153 @example
13154 #+NAME: example-table
13155 | 1 | a |
13156 | 2 | b |
13157 | 3 | c |
13158 | 4 | d |
13160 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
13161   data
13162 #+END_SRC
13164 #+results:
13165 : a
13166 @end example
13168 Ranges of variable values can be referenced using two integers separated by a
13169 @code{:}, in which case the entire inclusive range is referenced.  For
13170 example the following assigns the middle three rows of @code{example-table}
13171 to @code{data}.
13173 @example
13174 #+NAME: example-table
13175 | 1 | a |
13176 | 2 | b |
13177 | 3 | c |
13178 | 4 | d |
13179 | 5 | 3 |
13181 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
13182   data
13183 #+END_SRC
13185 #+results:
13186 | 2 | b |
13187 | 3 | c |
13188 | 4 | d |
13189 @end example
13191 Additionally, an empty index, or the single character @code{*}, are both
13192 interpreted to mean the entire range and as such are equivalent to
13193 @code{0:-1}, as shown in the following example in which the entire first
13194 column is referenced.
13196 @example
13197 #+NAME: example-table
13198 | 1 | a |
13199 | 2 | b |
13200 | 3 | c |
13201 | 4 | d |
13203 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
13204   data
13205 #+END_SRC
13207 #+results:
13208 | 1 | 2 | 3 | 4 |
13209 @end example
13211 It is possible to index into the results of code blocks as well as tables.
13212 Any number of dimensions can be indexed.  Dimensions are separated from one
13213 another by commas, as shown in the following example.
13215 @example
13216 #+NAME: 3D
13217 #+BEGIN_SRC emacs-lisp
13218   '(((1  2  3)  (4  5  6)  (7  8  9))
13219     ((10 11 12) (13 14 15) (16 17 18))
13220     ((19 20 21) (22 23 24) (25 26 27)))
13221 #+END_SRC
13223 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
13224   data
13225 #+END_SRC
13227 #+results:
13228 | 11 | 14 | 17 |
13229 @end example
13231 @subsubheading Emacs Lisp evaluation of variables
13233 Emacs lisp code can be used to initialize variable values.  When a variable
13234 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
13235 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
13236 the variable value.  The following example demonstrates use of this
13237 evaluation to reliably pass the file-name of the Org mode buffer to a code
13238 block---note that evaluation of header arguments is guaranteed to take place
13239 in the original Org mode file, while there is no such guarantee for
13240 evaluation of the code block body.
13242 @example
13243 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
13244   wc -w $filename
13245 #+END_SRC
13246 @end example
13248 Note that values read from tables and lists will not be evaluated as
13249 Emacs Lisp, as shown in the following example.
13251 @example
13252 #+NAME: table
13253 | (a b c) |
13255 #+HEADERS: :var data=table[0,0]
13256 #+BEGIN_SRC perl
13257   $data
13258 #+END_SRC
13260 #+results:
13261 : (a b c)
13262 @end example
13264 @node results, file, var, Specific header arguments
13265 @subsubsection @code{:results}
13267 There are three classes of @code{:results} header argument.  Only one option
13268 per class may be supplied per code block.
13270 @itemize @bullet
13271 @item
13272 @b{collection} header arguments specify how the results should be collected
13273 from the code block
13274 @item
13275 @b{type} header arguments specify what type of result the code block will
13276 return---which has implications for how they will be inserted into the
13277 Org mode buffer
13278 @item
13279 @b{handling} header arguments specify how the results of evaluating the code
13280 block should be handled.
13281 @end itemize
13283 @subsubheading Collection
13284 The following options are mutually exclusive, and specify how the results
13285 should be collected from the code block.
13287 @itemize @bullet
13288 @item @code{value}
13289 This is the default.  The result is the value of the last statement in the
13290 code block.  This header argument places the evaluation in functional
13291 mode.  Note that in some languages, e.g., Python, use of this result type
13292 requires that a @code{return} statement be included in the body of the source
13293 code block.  E.g., @code{:results value}.
13294 @item @code{output}
13295 The result is the collection of everything printed to STDOUT during the
13296 execution of the code block.  This header argument places the
13297 evaluation in scripting mode.  E.g., @code{:results output}.
13298 @end itemize
13300 @subsubheading Type
13302 The following options are mutually exclusive and specify what type of results
13303 the code block will return.  By default, results are inserted as either a
13304 table or scalar depending on their value.
13306 @itemize @bullet
13307 @item @code{table}, @code{vector}
13308 The results should be interpreted as an Org mode table.  If a single value is
13309 returned, it will be converted into a table with one row and one column.
13310 E.g., @code{:results value table}.
13311 @item @code{list}
13312 The results should be interpreted as an Org mode list.  If a single scalar
13313 value is returned it will be converted into a list with only one element.
13314 @item @code{scalar}, @code{verbatim}
13315 The results should be interpreted literally---they will not be
13316 converted into a table.  The results will be inserted into the Org mode
13317 buffer as quoted text.  E.g., @code{:results value verbatim}.
13318 @item @code{file}
13319 The results will be interpreted as the path to a file, and will be inserted
13320 into the Org mode buffer as a file link.  E.g., @code{:results value file}.
13321 @item @code{raw}, @code{org}
13322 The results are interpreted as raw Org mode code and are inserted directly
13323 into the buffer.  If the results look like a table they will be aligned as
13324 such by Org mode.  E.g., @code{:results value raw}.
13325 @item @code{html}
13326 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
13327 block.  E.g., @code{:results value html}.
13328 @item @code{latex}
13329 Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block.
13330 E.g., @code{:results value latex}.
13331 @item @code{code}
13332 Result are assumed to be parsable code and are enclosed in a code block.
13333 E.g., @code{:results value code}.
13334 @item @code{pp}
13335 The result is converted to pretty-printed code and is enclosed in a code
13336 block.  This option currently supports Emacs Lisp, Python, and Ruby.  E.g.,
13337 @code{:results value pp}.
13338 @item @code{wrap}
13339 The result is wrapped in a @code{begin_result} block.  This can be useful for
13340 inserting @code{raw} or @code{org} syntax results in such a way that their
13341 extend is known and they can be automatically removed or replaced.
13342 @end itemize
13344 @subsubheading Handling
13345 The following results options indicate what happens with the
13346 results once they are collected.
13348 @itemize @bullet
13349 @item @code{silent}
13350 The results will be echoed in the minibuffer but will not be inserted into
13351 the Org mode buffer.  E.g., @code{:results output silent}.
13352 @item @code{replace}
13353 The default value.  Any existing results will be removed, and the new results
13354 will be inserted into the Org mode buffer in their place.  E.g.,
13355 @code{:results output replace}.
13356 @item @code{append}
13357 If there are pre-existing results of the code block then the new results will
13358 be appended to the existing results.  Otherwise the new results will be
13359 inserted as with @code{replace}.
13360 @item @code{prepend}
13361 If there are pre-existing results of the code block then the new results will
13362 be prepended to the existing results.  Otherwise the new results will be
13363 inserted as with @code{replace}.
13364 @end itemize
13366 @node file, dir, results, Specific header arguments
13367 @subsubsection @code{:file}
13369 The header argument @code{:file} is used to specify an external file in which
13370 to save code block results.  After code block evaluation an Org mode style
13371 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
13372 into the Org mode buffer.  Some languages including R, gnuplot, dot, and
13373 ditaa provide special handling of the @code{:file} header argument
13374 automatically wrapping the code block body in the boilerplate code required
13375 to save output to the specified file.  This is often useful for saving
13376 graphical output of a code block to the specified file.
13378 The argument to @code{:file} should be either a string specifying the path to
13379 a file, or a list of two strings in which case the first element of the list
13380 should be the path to a file and the second a description for the link.
13382 @node dir, exports, file, Specific header arguments
13383 @subsubsection @code{:dir} and remote execution
13385 While the @code{:file} header argument can be used to specify the path to the
13386 output file, @code{:dir} specifies the default directory during code block
13387 execution.  If it is absent, then the directory associated with the current
13388 buffer is used.  In other words, supplying @code{:dir path} temporarily has
13389 the same effect as changing the current directory with @kbd{M-x cd path}, and
13390 then not supplying @code{:dir}.  Under the surface, @code{:dir} simply sets
13391 the value of the Emacs variable @code{default-directory}.
13393 When using @code{:dir}, you should supply a relative path for file output
13394 (e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
13395 case that path will be interpreted relative to the default directory.
13397 In other words, if you want your plot to go into a folder called @file{Work}
13398 in your home directory, you could use
13400 @example
13401 #+BEGIN_SRC R :file myplot.png :dir ~/Work
13402 matplot(matrix(rnorm(100), 10), type="l")
13403 #+END_SRC
13404 @end example
13406 @subsubheading Remote execution
13407 A directory on a remote machine can be specified using tramp file syntax, in
13408 which case the code will be evaluated on the remote machine.  An example is
13410 @example
13411 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
13412 plot(1:10, main=system("hostname", intern=TRUE))
13413 #+END_SRC
13414 @end example
13416 Text results will be returned to the local Org mode buffer as usual, and file
13417 output will be created on the remote machine with relative paths interpreted
13418 relative to the remote directory.  An Org mode link to the remote file will be
13419 created.
13421 So, in the above example a plot will be created on the remote machine,
13422 and a link of the following form will be inserted in the org buffer:
13424 @example
13425 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
13426 @end example
13428 Most of this functionality follows immediately from the fact that @code{:dir}
13429 sets the value of the Emacs variable @code{default-directory}, thanks to
13430 tramp.  Those using XEmacs, or GNU Emacs prior to version 23 may need to
13431 install tramp separately in order for these features to work correctly.
13433 @subsubheading Further points
13435 @itemize @bullet
13436 @item
13437 If @code{:dir} is used in conjunction with @code{:session}, although it will
13438 determine the starting directory for a new session as expected, no attempt is
13439 currently made to alter the directory associated with an existing session.
13440 @item
13441 @code{:dir} should typically not be used to create files during export with
13442 @code{:exports results} or @code{:exports both}.  The reason is that, in order
13443 to retain portability of exported material between machines, during export
13444 links inserted into the buffer will @emph{not} be expanded against @code{default
13445 directory}.  Therefore, if @code{default-directory} is altered using
13446 @code{:dir}, it is probable that the file will be created in a location to
13447 which the link does not point.
13448 @end itemize
13450 @node exports, tangle, dir, Specific header arguments
13451 @subsubsection @code{:exports}
13453 The @code{:exports} header argument specifies what should be included in HTML
13454 or LaTeX exports of the Org mode file.
13456 @itemize @bullet
13457 @item @code{code}
13458 The default.  The body of code is included into the exported file.  E.g.,
13459 @code{:exports code}.
13460 @item @code{results}
13461 The result of evaluating the code is included in the exported file.  E.g.,
13462 @code{:exports results}.
13463 @item @code{both}
13464 Both the code and results are included in the exported file.  E.g.,
13465 @code{:exports both}.
13466 @item @code{none}
13467 Nothing is included in the exported file.  E.g., @code{:exports none}.
13468 @end itemize
13470 @node tangle, mkdirp, exports, Specific header arguments
13471 @subsubsection @code{:tangle}
13473 The @code{:tangle} header argument specifies whether or not the code
13474 block should be included in tangled extraction of source code files.
13476 @itemize @bullet
13477 @item @code{tangle}
13478 The code block is exported to a source code file named after the full path
13479 (including the directory) and file name (w/o extension) of the Org mode file.
13480 E.g., @code{:tangle yes}.
13481 @item @code{no}
13482 The default.  The code block is not exported to a source code file.
13483 E.g., @code{:tangle no}.
13484 @item other
13485 Any other string passed to the @code{:tangle} header argument is interpreted
13486 as a path (directory and file name relative to the directory of the Org mode
13487 file) to which the block will be exported.  E.g., @code{:tangle path}.
13488 @end itemize
13490 @node mkdirp, comments, tangle, Specific header arguments
13491 @subsubsection @code{:mkdirp}
13493 The @code{:mkdirp} header argument can be used to create parent directories
13494 of tangled files when missing.  This can be set to @code{yes} to enable
13495 directory creation or to @code{no} to inhibit directory creation.
13497 @node comments, padline, mkdirp, Specific header arguments
13498 @subsubsection @code{:comments}
13499 By default code blocks are tangled to source-code files without any insertion
13500 of comments beyond those which may already exist in the body of the code
13501 block.  The @code{:comments} header argument can be set as follows to control
13502 the insertion of extra comments into the tangled code file.
13504 @itemize @bullet
13505 @item @code{no}
13506 The default.  No extra comments are inserted during tangling.
13507 @item @code{link}
13508 The code block is wrapped in comments which contain pointers back to the
13509 original Org file from which the code was tangled.
13510 @item @code{yes}
13511 A synonym for ``link'' to maintain backwards compatibility.
13512 @item @code{org}
13513 Include text from the Org mode file as a comment.
13515 The text is picked from the leading context of the tangled code and is
13516 limited by the nearest headline or source block as the case may be.
13517 @item @code{both}
13518 Turns on both the ``link'' and ``org'' comment options.
13519 @item @code{noweb}
13520 Turns on the ``link'' comment option, and additionally wraps expanded noweb
13521 references in the code block body in link comments.
13522 @end itemize
13524 @node padline, no-expand, comments, Specific header arguments
13525 @subsubsection @code{:padline}
13526 Control in insertion of padding lines around code block bodies in tangled
13527 code files.  The default value is @code{yes} which results in insertion of
13528 newlines before and after each tangled code block.  The following arguments
13529 are accepted.
13531 @itemize @bullet
13532 @item @code{yes}
13533 Insert newlines before and after each code block body in tangled code files.
13534 @item @code{no}
13535 Do not insert any newline padding in tangled output.
13536 @end itemize
13538 @node no-expand, session, padline, Specific header arguments
13539 @subsubsection @code{:no-expand}
13541 By default, code blocks are expanded with @code{org-babel-expand-src-block}
13542 during tangling.  This has the effect of assigning values to variables
13543 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
13544 references (see @ref{Noweb reference syntax}) with their targets.  The
13545 @code{:no-expand} header argument can be used to turn off this behavior.
13547 @node session, noweb, no-expand, Specific header arguments
13548 @subsubsection @code{:session}
13550 The @code{:session} header argument starts a session for an interpreted
13551 language where state is preserved.
13553 By default, a session is not started.
13555 A string passed to the @code{:session} header argument will give the session
13556 a name.  This makes it possible to run concurrent sessions for each
13557 interpreted language.
13559 @node noweb, noweb-ref, session, Specific header arguments
13560 @subsubsection @code{:noweb}
13562 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
13563 @ref{Noweb reference syntax}) references in a code block.  This header
13564 argument can have one of three values: @code{yes}, @code{no}, or @code{tangle}.
13566 @itemize @bullet
13567 @item @code{yes}
13568 All ``noweb'' syntax references in the body of the code block will be
13569 expanded before the block is evaluated, tangled or exported.
13570 @item @code{no}
13571 The default.  No ``noweb'' syntax specific action is taken on evaluating
13572 code blocks, However, noweb references will still be expanded during
13573 tangling.
13574 @item @code{tangle}
13575 All ``noweb'' syntax references in the body of the code block will be
13576 expanded before the block is tangled, however ``noweb'' references will not
13577 be expanded when the block is evaluated or exported.
13578 @end itemize
13580 @subsubheading Noweb prefix lines
13581 Noweb insertions are now placed behind the line prefix of the
13582 @code{<<reference>>}.
13583 This behavior is illustrated in the following example.  Because the
13584 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
13585 each line of the expanded noweb reference will be commented.
13587 This code block:
13589 @example
13590 -- <<example>>
13591 @end example
13594 expands to:
13596 @example
13597 -- this is the
13598 -- multi-line body of example
13599 @end example
13601 Note that noweb replacement text that does not contain any newlines will not
13602 be affected by this change, so it is still possible to use inline noweb
13603 references.
13605 @node noweb-ref, cache, noweb, Specific header arguments
13606 @subsubsection @code{:noweb-ref}
13607 When expanding ``noweb'' style references the bodies of all code block with
13608 @emph{either} a block name matching the reference name @emph{or} a
13609 @code{:noweb-ref} header argument matching the reference name will be
13610 concatenated together to form the replacement text.
13612 By setting this header argument at the sub-tree or file level, simple code
13613 block concatenation may be achieved.  For example, when tangling the
13614 following Org mode file, the bodies of code blocks will be concatenated into
13615 the resulting pure code file.
13617 @example
13618  #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
13619    <<fullest-disk>>
13620  #+END_SRC
13621  * the mount point of the fullest disk
13622    :PROPERTIES:
13623    :noweb-ref: fullest-disk
13624    :END:
13626  ** query all mounted disks
13627  #+BEGIN_SRC sh
13628    df \
13629  #+END_SRC
13631  ** strip the header row
13632  #+BEGIN_SRC sh
13633    |sed '1d' \
13634  #+END_SRC
13636  ** sort by the percent full
13637  #+BEGIN_SRC sh
13638    |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
13639  #+END_SRC
13641  ** extract the mount point
13642  #+BEGIN_SRC sh
13643    |awk '@{print $2@}'
13644  #+END_SRC
13645 @end example
13647 @node cache, sep, noweb-ref, Specific header arguments
13648 @subsubsection @code{:cache}
13650 The @code{:cache} header argument controls the use of in-buffer caching of
13651 the results of evaluating code blocks.  It can be used to avoid re-evaluating
13652 unchanged code blocks.  This header argument can have one of two
13653 values: @code{yes} or @code{no}.
13655 @itemize @bullet
13656 @item @code{no}
13657 The default.  No caching takes place, and the code block will be evaluated
13658 every time it is called.
13659 @item @code{yes}
13660 Every time the code block is run a SHA1 hash of the code and arguments
13661 passed to the block will be generated.  This hash is packed into the
13662 @code{#+results:} line and will be checked on subsequent
13663 executions of the code block.  If the code block has not
13664 changed since the last time it was evaluated, it will not be re-evaluated.
13665 @end itemize
13667 Code block caches notice if the value of a variable argument
13668 to the code block has changed.  If this is the case, the cache is
13669 invalidated and the code block is re-run.  In the following example,
13670 @code{caller} will not be re-run unless the results of @code{random} have
13671 changed since it was last run.
13673 @example
13674  #+NAME: random
13675  #+BEGIN_SRC R :cache yes
13676  runif(1)
13677  #+END_SRC
13679  #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
13680  0.4659510825295
13682  #+NAME: caller
13683  #+BEGIN_SRC emacs-lisp :var x=random :cache yes
13685  #+END_SRC
13687  #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
13688  0.254227238707244
13689 @end example
13691 @node sep, hlines, cache, Specific header arguments
13692 @subsubsection @code{:sep}
13694 The @code{:sep} header argument can be used to control the delimiter used
13695 when writing tabular results out to files external to Org mode.  This is used
13696 either when opening tabular results of a code block by calling the
13697 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
13698 or when writing code block results to an external file (see @ref{file})
13699 header argument.
13701 By default, when @code{:sep} is not specified output tables are tab
13702 delimited.
13704 @node hlines, colnames, sep, Specific header arguments
13705 @subsubsection @code{:hlines}
13707 Tables are frequently represented with one or more horizontal lines, or
13708 hlines.  The @code{:hlines} argument to a code block accepts the
13709 values @code{yes} or @code{no}, with a default value of @code{no}.
13711 @itemize @bullet
13712 @item @code{no}
13713 Strips horizontal lines from the input table.  In most languages this is the
13714 desired effect because an @code{hline} symbol is interpreted as an unbound
13715 variable and raises an error.  Setting @code{:hlines no} or relying on the
13716 default value yields the following results.
13718 @example
13719 #+TBLNAME: many-cols
13720 | a | b | c |
13721 |---+---+---|
13722 | d | e | f |
13723 |---+---+---|
13724 | g | h | i |
13726 #+NAME: echo-table
13727 #+BEGIN_SRC python :var tab=many-cols
13728   return tab
13729 #+END_SRC
13731 #+results: echo-table
13732 | a | b | c |
13733 | d | e | f |
13734 | g | h | i |
13735 @end example
13737 @item @code{yes}
13738 Leaves hlines in the table.  Setting @code{:hlines yes} has this effect.
13740 @example
13741 #+TBLNAME: many-cols
13742 | a | b | c |
13743 |---+---+---|
13744 | d | e | f |
13745 |---+---+---|
13746 | g | h | i |
13748 #+NAME: echo-table
13749 #+BEGIN_SRC python :var tab=many-cols :hlines yes
13750   return tab
13751 #+END_SRC
13753 #+results: echo-table
13754 | a | b | c |
13755 |---+---+---|
13756 | d | e | f |
13757 |---+---+---|
13758 | g | h | i |
13759 @end example
13760 @end itemize
13762 @node colnames, rownames, hlines, Specific header arguments
13763 @subsubsection @code{:colnames}
13765 The @code{:colnames} header argument accepts the values @code{yes},
13766 @code{no}, or @code{nil} for unassigned.  The default value is @code{nil}.
13767 Note that the behavior of the @code{:colnames} header argument may differ
13768 across languages.  For example Emacs Lisp code blocks ignore the
13769 @code{:colnames} header argument entirely given the ease with which tables
13770 with column names may be handled directly in Emacs Lisp.
13772 @itemize @bullet
13773 @item @code{nil}
13774 If an input table looks like it has column names
13775 (because its second row is an hline), then the column
13776 names will be removed from the table before
13777 processing, then reapplied to the results.
13779 @example
13780 #+TBLNAME: less-cols
13781 | a |
13782 |---|
13783 | b |
13784 | c |
13786 #+NAME: echo-table-again
13787 #+BEGIN_SRC python :var tab=less-cols
13788   return [[val + '*' for val in row] for row in tab]
13789 #+END_SRC
13791 #+results: echo-table-again
13792 | a  |
13793 |----|
13794 | b* |
13795 | c* |
13796 @end example
13798 Please note that column names are not removed before the table is indexed
13799 using variable indexing @xref{var, Indexable variable values}.
13801 @item @code{no}
13802 No column name pre-processing takes place
13804 @item @code{yes}
13805 Column names are removed and reapplied as with @code{nil} even if the table
13806 does not ``look like'' it has column names (i.e.@: the second row is not an
13807 hline)
13808 @end itemize
13810 @node rownames, shebang, colnames, Specific header arguments
13811 @subsubsection @code{:rownames}
13813 The @code{:rownames} header argument can take on the values @code{yes}
13814 or @code{no}, with a default value of @code{no}.
13816 @itemize @bullet
13817 @item @code{no}
13818 No row name pre-processing will take place.
13820 @item @code{yes}
13821 The first column of the table is removed from the table before processing,
13822 and is then reapplied to the results.
13824 @example
13825 #+TBLNAME: with-rownames
13826 | one | 1 | 2 | 3 | 4 |  5 |
13827 | two | 6 | 7 | 8 | 9 | 10 |
13829 #+NAME: echo-table-once-again
13830 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
13831   return [[val + 10 for val in row] for row in tab]
13832 #+END_SRC
13834 #+results: echo-table-once-again
13835 | one | 11 | 12 | 13 | 14 | 15 |
13836 | two | 16 | 17 | 18 | 19 | 20 |
13837 @end example
13839 Please note that row names are not removed before the table is indexed using
13840 variable indexing @xref{var, Indexable variable values}.
13842 @end itemize
13844 @node shebang, eval, rownames, Specific header arguments
13845 @subsubsection @code{:shebang}
13847 Setting the @code{:shebang} header argument to a string value
13848 (e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
13849 first line of any tangled file holding the code block, and the file
13850 permissions of the tangled file are set to make it executable.
13852 @node eval,  , shebang, Specific header arguments
13853 @subsubsection @code{:eval}
13854 The @code{:eval} header argument can be used to limit the evaluation of
13855 specific code blocks.  The @code{:eval} header argument can be useful for
13856 protecting against the evaluation of dangerous code blocks or to ensure that
13857 evaluation will require a query regardless of the value of the
13858 @code{org-confirm-babel-evaluate} variable.  The possible values of
13859 @code{:eval} and their effects are shown below.
13861 @table @code
13862 @item never or no
13863 The code block will not be evaluated under any circumstances.
13864 @item query
13865 Evaluation of the code block will require a query.
13866 @item never-export or no-export
13867 The code block will not be evaluated during export but may still be called
13868 interactively.
13869 @item query-export
13870 Evaluation of the code block during export will require a query.
13871 @end table
13873 If this header argument is not set then evaluation is determined by the value
13874 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
13875 security}.
13877 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
13878 @section Results of evaluation
13879 @cindex code block, results of evaluation
13880 @cindex source code, results of evaluation
13882 The way in which results are handled depends on whether a session is invoked,
13883 as well as on whether @code{:results value} or @code{:results output} is
13884 used.  The following table shows the table possibilities.  For a full listing
13885 of the possible results header arguments see @ref{results}.
13887 @multitable @columnfractions 0.26 0.33 0.41
13888 @item @tab @b{Non-session} @tab @b{Session}
13889 @item @code{:results value} @tab value of last expression @tab value of last expression
13890 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
13891 @end multitable
13893 Note: With @code{:results value}, the result in both @code{:session} and
13894 non-session is returned to Org mode as a table (a one- or two-dimensional
13895 vector of strings or numbers) when appropriate.
13897 @subsection Non-session
13898 @subsubsection @code{:results value}
13899 This is the default.  Internally, the value is obtained by wrapping the code
13900 in a function definition in the external language, and evaluating that
13901 function.  Therefore, code should be written as if it were the body of such a
13902 function.  In particular, note that Python does not automatically return a
13903 value from a function unless a @code{return} statement is present, and so a
13904 @samp{return} statement will usually be required in Python.
13906 This is the only one of the four evaluation contexts in which the code is
13907 automatically wrapped in a function definition.
13909 @subsubsection @code{:results output}
13910 The code is passed to the interpreter as an external process, and the
13911 contents of the standard output stream are returned as text.  (In certain
13912 languages this also contains the error output stream; this is an area for
13913 future work.)
13915 @subsection Session
13916 @subsubsection @code{:results value}
13917 The code is passed to an interpreter running as an interactive Emacs inferior
13918 process.  Only languages which provide tools for interactive evaluation of
13919 code have session support, so some language (e.g., C and ditaa) do not
13920 support the @code{:session} header argument, and in other languages (e.g.,
13921 Python and Haskell) which have limitations on the code which may be entered
13922 into interactive sessions, those limitations apply to the code in code blocks
13923 using the @code{:session} header argument as well.
13925 Unless the @code{:results output} option is supplied (see below) the result
13926 returned is the result of the last evaluation performed by the
13927 interpreter.  (This is obtained in a language-specific manner: the value of
13928 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
13929 in R).
13931 @subsubsection @code{:results output}
13932 The code is passed to the interpreter running as an interactive Emacs
13933 inferior process.  The result returned is the concatenation of the sequence of
13934 (text) output from the interactive interpreter.  Notice that this is not
13935 necessarily the same as what would be sent to @code{STDOUT} if the same code
13936 were passed to a non-interactive interpreter running as an external
13937 process.  For example, compare the following two blocks:
13939 @example
13940 #+BEGIN_SRC python :results output
13941  print "hello"
13943  print "bye"
13944 #+END_SRC
13946 #+results:
13947 : hello
13948 : bye
13949 @end example
13951 In non-session mode, the `2' is not printed and does not appear.
13952 @example
13953 #+BEGIN_SRC python :results output :session
13954  print "hello"
13956  print "bye"
13957 #+END_SRC
13959 #+results:
13960 : hello
13961 : 2
13962 : bye
13963 @end example
13965 But in @code{:session} mode, the interactive interpreter receives input `2'
13966 and prints out its value, `2'.  (Indeed, the other print statements are
13967 unnecessary here).
13969 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
13970 @section Noweb reference syntax
13971 @cindex code block, noweb reference
13972 @cindex syntax, noweb
13973 @cindex source code, noweb reference
13975 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
13976 Programming system allows named blocks of code to be referenced by using the
13977 familiar Noweb syntax:
13979 @example
13980 <<code-block-name>>
13981 @end example
13983 When a code block is tangled or evaluated, whether or not ``noweb''
13984 references are expanded depends upon the value of the @code{:noweb} header
13985 argument.  If @code{:noweb yes}, then a Noweb reference is expanded before
13986 evaluation.  If @code{:noweb no}, the default, then the reference is not
13987 expanded before evaluation.
13989 Note: the default value, @code{:noweb no}, was chosen to ensure that
13990 correct code is not broken in a language, such as Ruby, where
13991 @code{<<arg>>} is a syntactically valid construct.  If @code{<<arg>>} is not
13992 syntactically valid in languages that you use, then please consider setting
13993 the default value.
13995 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
13996 @section Key bindings and useful functions
13997 @cindex code block, key bindings
13999 Many common Org mode key sequences are re-bound depending on
14000 the context.
14002 Within a code block, the following key bindings
14003 are active:
14005 @multitable @columnfractions 0.25 0.75
14006 @kindex C-c C-c
14007 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
14008 @kindex C-c C-o
14009 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
14010 @kindex C-up
14011 @item @kbd{C-@key{up}}    @tab @code{org-babel-load-in-session}
14012 @kindex M-down
14013 @item @kbd{M-@key{down}}  @tab @code{org-babel-pop-to-session}
14014 @end multitable
14016 In an Org mode buffer, the following key bindings are active:
14018 @multitable @columnfractions 0.45 0.55
14019 @kindex C-c C-v a
14020 @kindex C-c C-v C-a
14021 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14022 @kindex C-c C-v b
14023 @kindex C-c C-v C-b
14024 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14025 @kindex C-c C-v f
14026 @kindex C-c C-v C-f
14027 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14028 @kindex C-c C-v g
14029 @item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block}
14030 @kindex C-c C-v h
14031 @item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings}
14032 @kindex C-c C-v l
14033 @kindex C-c C-v C-l
14034 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14035 @kindex C-c C-v p
14036 @kindex C-c C-v C-p
14037 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14038 @kindex C-c C-v s
14039 @kindex C-c C-v C-s
14040 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14041 @kindex C-c C-v t
14042 @kindex C-c C-v C-t
14043 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14044 @kindex C-c C-v z
14045 @kindex C-c C-v C-z
14046 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14047 @end multitable
14049 @c When possible these keybindings were extended to work when the control key is
14050 @c kept pressed, resulting in the following additional keybindings.
14052 @c @multitable @columnfractions 0.25 0.75
14053 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14054 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14055 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14056 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14057 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14058 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14059 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14060 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14061 @c @end multitable
14063 @node Batch execution,  , Key bindings and useful functions, Working With Source Code
14064 @section Batch execution
14065 @cindex code block, batch execution
14066 @cindex source code, batch execution
14068 It is possible to call functions from the command line.  This shell
14069 script calls @code{org-babel-tangle} on every one of its arguments.
14071 Be sure to adjust the paths to fit your system.
14073 @example
14074 #!/bin/sh
14075 # -*- mode: shell-script -*-
14077 # tangle files with org-mode
14079 DIR=`pwd`
14080 FILES=""
14081 ORGINSTALL="~/src/org/lisp/org-install.el"
14083 # wrap each argument in the code required to call tangle on it
14084 for i in $@@; do
14085     FILES="$FILES \"$i\""
14086 done
14088 emacs -Q --batch -l $ORGINSTALL \
14089 --eval "(progn
14090 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
14091 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
14092 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
14093 (mapc (lambda (file)
14094        (find-file (expand-file-name file \"$DIR\"))
14095        (org-babel-tangle)
14096        (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
14097 @end example
14099 @node Miscellaneous, Hacking, Working With Source Code, Top
14100 @chapter Miscellaneous
14102 @menu
14103 * Completion::                  M-TAB knows what you need
14104 * Easy Templates::              Quick insertion of structural elements
14105 * Speed keys::                  Electric commands at the beginning of a headline
14106 * Code evaluation security::    Org mode files evaluate inline code
14107 * Customization::               Adapting Org to your taste
14108 * In-buffer settings::          Overview of the #+KEYWORDS
14109 * The very busy C-c C-c key::   When in doubt, press C-c C-c
14110 * Clean view::                  Getting rid of leading stars in the outline
14111 * TTY keys::                    Using Org on a tty
14112 * Interaction::                 Other Emacs packages
14113 * org-crypt.el::                Encrypting Org files
14114 @end menu
14117 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
14118 @section Completion
14119 @cindex completion, of @TeX{} symbols
14120 @cindex completion, of TODO keywords
14121 @cindex completion, of dictionary words
14122 @cindex completion, of option keywords
14123 @cindex completion, of tags
14124 @cindex completion, of property keys
14125 @cindex completion, of link abbreviations
14126 @cindex @TeX{} symbol completion
14127 @cindex TODO keywords completion
14128 @cindex dictionary word completion
14129 @cindex option keyword completion
14130 @cindex tag completion
14131 @cindex link abbreviations, completion of
14133 Emacs would not be Emacs without completion, and Org mode uses it whenever it
14134 makes sense.  If you prefer an @i{iswitchb}- or @i{ido}-like interface for
14135 some of the completion prompts, you can specify your preference by setting at
14136 most one of the variables @code{org-completion-use-iswitchb}
14137 @code{org-completion-use-ido}.
14139 Org supports in-buffer completion.  This type of completion does
14140 not make use of the minibuffer.  You simply type a few letters into
14141 the buffer and use the key to complete text right there.
14143 @table @kbd
14144 @kindex M-@key{TAB}
14145 @item M-@key{TAB}
14146 Complete word at point
14147 @itemize @bullet
14148 @item
14149 At the beginning of a headline, complete TODO keywords.
14150 @item
14151 After @samp{\}, complete @TeX{} symbols supported by the exporter.
14152 @item
14153 After @samp{*}, complete headlines in the current buffer so that they
14154 can be used in search links like @samp{[[*find this headline]]}.
14155 @item
14156 After @samp{:} in a headline, complete tags.  The list of tags is taken
14157 from the variable @code{org-tag-alist} (possibly set through the
14158 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
14159 dynamically from all tags used in the current buffer.
14160 @item
14161 After @samp{:} and not in a headline, complete property keys.  The list
14162 of keys is constructed dynamically from all keys used in the current
14163 buffer.
14164 @item
14165 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
14166 @item
14167 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
14168 @samp{OPTIONS} which set file-specific options for Org mode.  When the
14169 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
14170 will insert example settings for this keyword.
14171 @item
14172 In the line after @samp{#+STARTUP: }, complete startup keywords,
14173 i.e.@: valid keys for this line.
14174 @item
14175 Elsewhere, complete dictionary words using Ispell.
14176 @end itemize
14177 @end table
14179 @node Easy Templates, Speed keys, Completion, Miscellaneous
14180 @section Easy Templates
14181 @cindex template insertion
14182 @cindex insertion, of templates
14184 Org mode supports insertion of empty structural elements (like
14185 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
14186 strokes.  This is achieved through a native template expansion mechanism.
14187 Note that Emacs has several other template mechanisms which could be used in
14188 a similar way, for example @file{yasnippet}.
14190 To insert a structural element, type a @samp{<}, followed by a template
14191 selector and @kbd{@key{TAB}}.  Completion takes effect only when the above
14192 keystrokes are typed on a line by itself.
14194 The following template selectors are currently supported.
14196 @multitable @columnfractions 0.1 0.9
14197 @item @kbd{s} @tab @code{#+begin_src     ... #+end_src}
14198 @item @kbd{e} @tab @code{#+begin_example ... #+end_example}
14199 @item @kbd{q} @tab @code{#+begin_quote   ... #+end_quote}
14200 @item @kbd{v} @tab @code{#+begin_verse   ... #+end_verse}
14201 @item @kbd{c} @tab @code{#+begin_center  ... #+end_center}
14202 @item @kbd{l} @tab @code{#+begin_latex   ... #+end_latex}
14203 @item @kbd{L} @tab @code{#+latex:}
14204 @item @kbd{h} @tab @code{#+begin_html    ... #+end_html}
14205 @item @kbd{H} @tab @code{#+html:}
14206 @item @kbd{a} @tab @code{#+begin_ascii   ... #+end_ascii}
14207 @item @kbd{A} @tab @code{#+ascii:}
14208 @item @kbd{i} @tab @code{#+index:} line
14209 @item @kbd{I} @tab @code{#+include:} line
14210 @end multitable
14212 For example, on an empty line, typing "<e" and then pressing TAB, will expand
14213 into a complete EXAMPLE template.
14215 You can install additional templates by customizing the variable
14216 @code{org-structure-template-alist}.  See the docstring of the variable for
14217 additional details.
14219 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
14220 @section Speed keys
14221 @cindex speed keys
14222 @vindex org-use-speed-commands
14223 @vindex org-speed-commands-user
14225 Single keys can be made to execute commands when the cursor is at the
14226 beginning of a headline, i.e.@: before the first star.  Configure the variable
14227 @code{org-use-speed-commands} to activate this feature.  There is a
14228 pre-defined list of commands, and you can add more such commands using the
14229 variable @code{org-speed-commands-user}.  Speed keys do not only speed up
14230 navigation and other commands, but they also provide an alternative way to
14231 execute commands bound to keys that are not or not easily available on a TTY,
14232 or on a small mobile device with a limited keyboard.
14234 To see which commands are available, activate the feature and press @kbd{?}
14235 with the cursor at the beginning of a headline.
14237 @node Code evaluation security, Customization, Speed keys, Miscellaneous
14238 @section Code evaluation and security issues
14240 Org provides tools to work with the code snippets, including evaluating them.
14242 Running code on your machine always comes with a security risk.  Badly
14243 written or malicious code can be executed on purpose or by accident.  Org has
14244 default settings which will only evaluate such code if you give explicit
14245 permission to do so, and as a casual user of these features you should leave
14246 these precautions intact.
14248 For people who regularly work with such code, the confirmation prompts can
14249 become annoying, and you might want to turn them off.  This can be done, but
14250 you must be aware of the risks that are involved.
14252 Code evaluation can happen under the following circumstances:
14254 @table @i
14255 @item Source code blocks
14256 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
14257 C-c} in the block.  The most important thing to realize here is that Org mode
14258 files which contain code snippets are, in a certain sense, like executable
14259 files.  So you should accept them and load them into Emacs only from trusted
14260 sources---just like you would do with a program you install on your computer.
14262 Make sure you know what you are doing before customizing the variables
14263 which take off the default security brakes.
14265 @defopt org-confirm-babel-evaluate
14266 When t (the default), the user is asked before every code block evaluation.
14267 When nil, the user is not asked.  When set to a function, it is called with
14268 two arguments (language and body of the code block) and should return t to
14269 ask and nil not to ask.
14270 @end defopt
14272 For example, here is how to execute "ditaa" code (which is considered safe)
14273 without asking:
14274 @example
14275 (defun my-org-confirm-babel-evaluate (lang body)
14276   (not (string= lang "ditaa")))  ; don't ask for ditaa
14277 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
14278 @end example
14280 @item Following @code{shell} and @code{elisp} links
14281 Org has two link types that can directly evaluate code (@pxref{External
14282 links}).  These links can be problematic because the code to be evaluated is
14283 not visible.
14285 @defopt org-confirm-shell-link-function
14286 Function to queries user about shell link execution.
14287 @end defopt
14288 @defopt org-confirm-elisp-link-function
14289 Functions to query user for Emacs Lisp link execution.
14290 @end defopt
14292 @item Formulas in tables
14293 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
14294 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
14295 @end table
14297 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
14298 @section Customization
14299 @cindex customization
14300 @cindex options, for customization
14301 @cindex variables, for customization
14303 There are more than 180 variables that can be used to customize
14304 Org.  For the sake of compactness of the manual, I am not
14305 describing the variables here.  A structured overview of customization
14306 variables is available with @kbd{M-x org-customize}.  Or select
14307 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
14308 settings can also be activated on a per-file basis, by putting special
14309 lines into the buffer (@pxref{In-buffer settings}).
14311 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
14312 @section Summary of in-buffer settings
14313 @cindex in-buffer settings
14314 @cindex special keywords
14316 Org mode uses special lines in the buffer to define settings on a
14317 per-file basis.  These lines start with a @samp{#+} followed by a
14318 keyword, a colon, and then individual words defining a setting.  Several
14319 setting words can be in the same line, but you can also have multiple
14320 lines for the keyword.  While these settings are described throughout
14321 the manual, here is a summary.  After changing any of those lines in the
14322 buffer, press @kbd{C-c C-c} with the cursor still in the line to
14323 activate the changes immediately.  Otherwise they become effective only
14324 when the file is visited again in a new Emacs session.
14326 @vindex org-archive-location
14327 @table @kbd
14328 @item #+ARCHIVE: %s_done::
14329 This line sets the archive location for the agenda file.  It applies for
14330 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
14331 of the file.  The first such line also applies to any entries before it.
14332 The corresponding variable is @code{org-archive-location}.
14333 @item #+CATEGORY:
14334 This line sets the category for the agenda file.  The category applies
14335 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
14336 end of the file.  The first such line also applies to any entries before it.
14337 @item #+COLUMNS: %25ITEM .....
14338 @cindex property, COLUMNS
14339 Set the default format for columns view.  This format applies when
14340 columns view is invoked in locations where no @code{COLUMNS} property
14341 applies.
14342 @item #+CONSTANTS: name1=value1 ...
14343 @vindex org-table-formula-constants
14344 @vindex org-table-formula
14345 Set file-local values for constants to be used in table formulas.  This
14346 line sets the local variable @code{org-table-formula-constants-local}.
14347 The global version of this variable is
14348 @code{org-table-formula-constants}.
14349 @item #+FILETAGS: :tag1:tag2:tag3:
14350 Set tags that can be inherited by any entry in the file, including the
14351 top-level entries.
14352 @item #+DRAWERS: NAME1 .....
14353 @vindex org-drawers
14354 Set the file-local set of drawers.  The corresponding global variable is
14355 @code{org-drawers}.
14356 @item #+LINK:  linkword replace
14357 @vindex org-link-abbrev-alist
14358 These lines (several are allowed) specify link abbreviations.
14359 @xref{Link abbreviations}.  The corresponding variable is
14360 @code{org-link-abbrev-alist}.
14361 @item #+PRIORITIES: highest lowest default
14362 @vindex org-highest-priority
14363 @vindex org-lowest-priority
14364 @vindex org-default-priority
14365 This line sets the limits and the default for the priorities.  All three
14366 must be either letters A-Z or numbers 0-9.  The highest priority must
14367 have a lower ASCII number than the lowest priority.
14368 @item #+PROPERTY: Property_Name Value
14369 This line sets a default inheritance value for entries in the current
14370 buffer, most useful for specifying the allowed values of a property.
14371 @cindex #+SETUPFILE
14372 @item #+SETUPFILE: file
14373 This line defines a file that holds more in-buffer setup.  Normally this is
14374 entirely ignored.  Only when the buffer is parsed for option-setting lines
14375 (i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
14376 settings line, or when exporting), then the contents of this file are parsed
14377 as if they had been included in the buffer.  In particular, the file can be
14378 any other Org mode file with internal setup.  You can visit the file the
14379 cursor is in the line with @kbd{C-c '}.
14380 @item #+STARTUP:
14381 @cindex #+STARTUP:
14382 This line sets options to be used at startup of Org mode, when an
14383 Org file is being visited.
14385 The first set of options deals with the initial visibility of the outline
14386 tree.  The corresponding variable for global default settings is
14387 @code{org-startup-folded}, with a default value @code{t}, which means
14388 @code{overview}.
14389 @vindex org-startup-folded
14390 @cindex @code{overview}, STARTUP keyword
14391 @cindex @code{content}, STARTUP keyword
14392 @cindex @code{showall}, STARTUP keyword
14393 @cindex @code{showeverything}, STARTUP keyword
14394 @example
14395 overview         @r{top-level headlines only}
14396 content          @r{all headlines}
14397 showall          @r{no folding of any entries}
14398 showeverything   @r{show even drawer contents}
14399 @end example
14401 @vindex org-startup-indented
14402 @cindex @code{indent}, STARTUP keyword
14403 @cindex @code{noindent}, STARTUP keyword
14404 Dynamic virtual indentation is controlled by the variable
14405 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
14406 @example
14407 indent     @r{start with @code{org-indent-mode} turned on}
14408 noindent   @r{start with @code{org-indent-mode} turned off}
14409 @end example
14411 @vindex org-startup-align-all-tables
14412 Then there are options for aligning tables upon visiting a file.  This
14413 is useful in files containing narrowed table columns.  The corresponding
14414 variable is @code{org-startup-align-all-tables}, with a default value
14415 @code{nil}.
14416 @cindex @code{align}, STARTUP keyword
14417 @cindex @code{noalign}, STARTUP keyword
14418 @example
14419 align      @r{align all tables}
14420 noalign    @r{don't align tables on startup}
14421 @end example
14423 @vindex org-startup-with-inline-images
14424 When visiting a file, inline images can be automatically displayed.  The
14425 corresponding variable is @code{org-startup-with-inline-images}, with a
14426 default value @code{nil} to avoid delays when visiting a file.
14427 @cindex @code{inlineimages}, STARTUP keyword
14428 @cindex @code{noinlineimages}, STARTUP keyword
14429 @example
14430 inlineimages   @r{show inline images}
14431 noinlineimages @r{don't show inline images on startup}
14432 @end example
14434 @vindex org-log-done
14435 @vindex org-log-note-clock-out
14436 @vindex org-log-repeat
14437 Logging the closing and reopening of TODO items and clock intervals can be
14438 configured using these options (see variables @code{org-log-done},
14439 @code{org-log-note-clock-out} and @code{org-log-repeat})
14440 @cindex @code{logdone}, STARTUP keyword
14441 @cindex @code{lognotedone}, STARTUP keyword
14442 @cindex @code{nologdone}, STARTUP keyword
14443 @cindex @code{lognoteclock-out}, STARTUP keyword
14444 @cindex @code{nolognoteclock-out}, STARTUP keyword
14445 @cindex @code{logrepeat}, STARTUP keyword
14446 @cindex @code{lognoterepeat}, STARTUP keyword
14447 @cindex @code{nologrepeat}, STARTUP keyword
14448 @cindex @code{logreschedule}, STARTUP keyword
14449 @cindex @code{lognotereschedule}, STARTUP keyword
14450 @cindex @code{nologreschedule}, STARTUP keyword
14451 @cindex @code{logredeadline}, STARTUP keyword
14452 @cindex @code{lognoteredeadline}, STARTUP keyword
14453 @cindex @code{nologredeadline}, STARTUP keyword
14454 @cindex @code{logrefile}, STARTUP keyword
14455 @cindex @code{lognoterefile}, STARTUP keyword
14456 @cindex @code{nologrefile}, STARTUP keyword
14457 @example
14458 logdone            @r{record a timestamp when an item is marked DONE}
14459 lognotedone        @r{record timestamp and a note when DONE}
14460 nologdone          @r{don't record when items are marked DONE}
14461 logrepeat          @r{record a time when reinstating a repeating item}
14462 lognoterepeat      @r{record a note when reinstating a repeating item}
14463 nologrepeat        @r{do not record when reinstating repeating item}
14464 lognoteclock-out   @r{record a note when clocking out}
14465 nolognoteclock-out @r{don't record a note when clocking out}
14466 logreschedule      @r{record a timestamp when scheduling time changes}
14467 lognotereschedule  @r{record a note when scheduling time changes}
14468 nologreschedule    @r{do not record when a scheduling date changes}
14469 logredeadline      @r{record a timestamp when deadline changes}
14470 lognoteredeadline  @r{record a note when deadline changes}
14471 nologredeadline    @r{do not record when a deadline date changes}
14472 logrefile          @r{record a timestamp when refiling}
14473 lognoterefile      @r{record a note when refiling}
14474 nologrefile        @r{do not record when refiling}
14475 @end example
14476 @vindex org-hide-leading-stars
14477 @vindex org-odd-levels-only
14478 Here are the options for hiding leading stars in outline headings, and for
14479 indenting outlines.  The corresponding variables are
14480 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
14481 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
14482 @cindex @code{hidestars}, STARTUP keyword
14483 @cindex @code{showstars}, STARTUP keyword
14484 @cindex @code{odd}, STARTUP keyword
14485 @cindex @code{even}, STARTUP keyword
14486 @example
14487 hidestars  @r{make all but one of the stars starting a headline invisible.}
14488 showstars  @r{show all stars starting a headline}
14489 indent     @r{virtual indentation according to outline level}
14490 noindent   @r{no virtual indentation according to outline level}
14491 odd        @r{allow only odd outline levels (1,3,...)}
14492 oddeven    @r{allow all outline levels}
14493 @end example
14494 @vindex org-put-time-stamp-overlays
14495 @vindex org-time-stamp-overlay-formats
14496 To turn on custom format overlays over timestamps (variables
14497 @code{org-put-time-stamp-overlays} and
14498 @code{org-time-stamp-overlay-formats}), use
14499 @cindex @code{customtime}, STARTUP keyword
14500 @example
14501 customtime @r{overlay custom time format}
14502 @end example
14503 @vindex constants-unit-system
14504 The following options influence the table spreadsheet (variable
14505 @code{constants-unit-system}).
14506 @cindex @code{constcgs}, STARTUP keyword
14507 @cindex @code{constSI}, STARTUP keyword
14508 @example
14509 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
14510 constSI    @r{@file{constants.el} should use the SI unit system}
14511 @end example
14512 @vindex org-footnote-define-inline
14513 @vindex org-footnote-auto-label
14514 @vindex org-footnote-auto-adjust
14515 To influence footnote settings, use the following keywords.  The
14516 corresponding variables are @code{org-footnote-define-inline},
14517 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
14518 @cindex @code{fninline}, STARTUP keyword
14519 @cindex @code{nofninline}, STARTUP keyword
14520 @cindex @code{fnlocal}, STARTUP keyword
14521 @cindex @code{fnprompt}, STARTUP keyword
14522 @cindex @code{fnauto}, STARTUP keyword
14523 @cindex @code{fnconfirm}, STARTUP keyword
14524 @cindex @code{fnplain}, STARTUP keyword
14525 @cindex @code{fnadjust}, STARTUP keyword
14526 @cindex @code{nofnadjust}, STARTUP keyword
14527 @example
14528 fninline    @r{define footnotes inline}
14529 fnnoinline  @r{define footnotes in separate section}
14530 fnlocal     @r{define footnotes near first reference, but not inline}
14531 fnprompt    @r{prompt for footnote labels}
14532 fnauto      @r{create @code{[fn:1]}-like labels automatically (default)}
14533 fnconfirm   @r{offer automatic label for editing or confirmation}
14534 fnplain     @r{create @code{[1]}-like labels automatically}
14535 fnadjust    @r{automatically renumber and sort footnotes}
14536 nofnadjust  @r{do not renumber and sort automatically}
14537 @end example
14538 @cindex org-hide-block-startup
14539 To hide blocks on startup, use these keywords.  The corresponding variable is
14540 @code{org-hide-block-startup}.
14541 @cindex @code{hideblocks}, STARTUP keyword
14542 @cindex @code{nohideblocks}, STARTUP keyword
14543 @example
14544 hideblocks   @r{Hide all begin/end blocks on startup}
14545 nohideblocks @r{Do not hide blocks on startup}
14546 @end example
14547 @cindex org-pretty-entities
14548 The display of entities as UTF-8 characters is governed by the variable
14549 @code{org-pretty-entities} and the keywords
14550 @cindex @code{entitiespretty}, STARTUP keyword
14551 @cindex @code{entitiesplain}, STARTUP keyword
14552 @example
14553 entitiespretty  @r{Show entities as UTF-8 characters where possible}
14554 entitiesplain   @r{Leave entities plain}
14555 @end example
14556 @item #+TAGS:  TAG1(c1) TAG2(c2)
14557 @vindex org-tag-alist
14558 These lines (several such lines are allowed) specify the valid tags in
14559 this file, and (potentially) the corresponding @emph{fast tag selection}
14560 keys.  The corresponding variable is @code{org-tag-alist}.
14561 @item #+TBLFM:
14562 This line contains the formulas for the table directly above the line.
14563 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
14564 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
14565 @itemx #+DESCRIPTION:, #+KEYWORDS:,
14566 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
14567 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
14568 These lines provide settings for exporting files.  For more details see
14569 @ref{Export options}.
14570 @item #+TODO:    #+SEQ_TODO:   #+TYP_TODO:
14571 @vindex org-todo-keywords
14572 These lines set the TODO keywords and their interpretation in the
14573 current file.  The corresponding variable is @code{org-todo-keywords}.
14574 @end table
14576 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
14577 @section The very busy C-c C-c key
14578 @kindex C-c C-c
14579 @cindex C-c C-c, overview
14581 The key @kbd{C-c C-c} has many purposes in Org, which are all
14582 mentioned scattered throughout this manual.  One specific function of
14583 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
14584 other circumstances it means something like @emph{``Hey Org, look
14585 here and update according to what you see here''}.  Here is a summary of
14586 what this means in different contexts.
14588 @itemize @minus
14589 @item
14590 If there are highlights in the buffer from the creation of a sparse
14591 tree, or from clock display, remove these highlights.
14592 @item
14593 If the cursor is in one of the special @code{#+KEYWORD} lines, this
14594 triggers scanning the buffer for these lines and updating the
14595 information.
14596 @item
14597 If the cursor is inside a table, realign the table.  This command
14598 works even if the automatic table editor has been turned off.
14599 @item
14600 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
14601 the entire table.
14602 @item
14603 If the current buffer is a capture buffer, close the note and file it.
14604 With a prefix argument, file it, without further interaction, to the
14605 default location.
14606 @item
14607 If the cursor is on a @code{<<<target>>>}, update radio targets and
14608 corresponding links in this buffer.
14609 @item
14610 If the cursor is in a property line or at the start or end of a property
14611 drawer, offer property commands.
14612 @item
14613 If the cursor is at a footnote reference, go to the corresponding
14614 definition, and vice versa.
14615 @item
14616 If the cursor is on a statistics cookie, update it.
14617 @item
14618 If the cursor is in a plain list item with a checkbox, toggle the status
14619 of the checkbox.
14620 @item
14621 If the cursor is on a numbered item in a plain list, renumber the
14622 ordered list.
14623 @item
14624 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
14625 block is updated.
14626 @item
14627 If the cursor is at a timestamp, fix the day name in the timestamp.
14628 @end itemize
14630 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
14631 @section A cleaner outline view
14632 @cindex hiding leading stars
14633 @cindex dynamic indentation
14634 @cindex odd-levels-only outlines
14635 @cindex clean outline view
14637 Some people find it noisy and distracting that the Org headlines start with a
14638 potentially large number of stars, and that text below the headlines is not
14639 indented.  While this is no problem when writing a @emph{book-like} document
14640 where the outline headings are really section headings, in a more
14641 @emph{list-oriented} outline, indented structure is a lot cleaner:
14643 @example
14644 @group
14645 * Top level headline             |    * Top level headline
14646 ** Second level                  |      * Second level
14647 *** 3rd level                    |        * 3rd level
14648 some text                        |          some text
14649 *** 3rd level                    |        * 3rd level
14650 more text                        |          more text
14651 * Another top level headline     |    * Another top level headline
14652 @end group
14653 @end example
14655 @noindent
14657 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
14658 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
14659 be achieved dynamically at display time using @code{org-indent-mode}.  In
14660 this minor mode, all lines are prefixed for display with the necessary amount
14661 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
14662 property, such that @code{visual-line-mode} (or purely setting
14663 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
14664 }.  Also headlines are prefixed with additional stars, so that the amount of
14665 indentation shifts by two@footnote{See the variable
14666 @code{org-indent-indentation-per-level}.}  spaces per level.  All headline
14667 stars but the last one are made invisible using the @code{org-hide}
14668 face@footnote{Turning on @code{org-indent-mode} sets
14669 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
14670 @code{nil}.} - see below under @samp{2.} for more information on how this
14671 works.  You can turn on @code{org-indent-mode} for all files by customizing
14672 the variable @code{org-startup-indented}, or you can turn it on for
14673 individual files using
14675 @example
14676 #+STARTUP: indent
14677 @end example
14679 If you want a similar effect in an earlier version of Emacs and/or Org, or if
14680 you want the indentation to be hard space characters so that the plain text
14681 file looks as similar as possible to the Emacs display, Org supports you in
14682 the following way:
14684 @enumerate
14685 @item
14686 @emph{Indentation of text below headlines}@*
14687 You may indent text below each headline to make the left boundary line up
14688 with the headline, like
14690 @example
14691 *** 3rd level
14692     more text, now indented
14693 @end example
14695 @vindex org-adapt-indentation
14696 Org supports this with paragraph filling, line wrapping, and structure
14697 editing@footnote{See also the variable @code{org-adapt-indentation}.},
14698 preserving or adapting the indentation as appropriate.
14700 @item
14701 @vindex org-hide-leading-stars
14702 @emph{Hiding leading stars}@* You can modify the display in such a way that
14703 all leading stars become invisible.  To do this in a global way, configure
14704 the variable @code{org-hide-leading-stars} or change this on a per-file basis
14705 with
14707 @example
14708 #+STARTUP: hidestars
14709 #+STARTUP: showstars
14710 @end example
14712 With hidden stars, the tree becomes:
14714 @example
14715 @group
14716 * Top level headline
14717  * Second level
14718   * 3rd level
14719   ...
14720 @end group
14721 @end example
14723 @noindent
14724 @vindex org-hide @r{(face)}
14725 The leading stars are not truly replaced by whitespace, they are only
14726 fontified with the face @code{org-hide} that uses the background color as
14727 font color.  If you are not using either white or black background, you may
14728 have to customize this face to get the wanted effect.  Another possibility is
14729 to set this font such that the extra stars are @i{almost} invisible, for
14730 example using the color @code{grey90} on a white background.
14732 @item
14733 @vindex org-odd-levels-only
14734 Things become cleaner still if you skip all the even levels and use only odd
14735 levels 1, 3, 5..., effectively adding two stars to go from one outline level
14736 to the next@footnote{When you need to specify a level for a property search
14737 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}.  In this
14738 way we get the outline view shown at the beginning of this section.  In order
14739 to make the structure editing and export commands handle this convention
14740 correctly, configure the variable @code{org-odd-levels-only}, or set this on
14741 a per-file basis with one of the following lines:
14743 @example
14744 #+STARTUP: odd
14745 #+STARTUP: oddeven
14746 @end example
14748 You can convert an Org file from single-star-per-level to the
14749 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
14750 RET} in that file.  The reverse operation is @kbd{M-x
14751 org-convert-to-oddeven-levels}.
14752 @end enumerate
14754 @node TTY keys, Interaction, Clean view, Miscellaneous
14755 @section Using Org on a tty
14756 @cindex tty key bindings
14758 Because Org contains a large number of commands, by default many of
14759 Org's core commands are bound to keys that are generally not
14760 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
14761 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
14762 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
14763 these commands on a tty when special keys are unavailable, the following
14764 alternative bindings can be used.  The tty bindings below will likely be
14765 more cumbersome; you may find for some of the bindings below that a
14766 customized workaround suits you better.  For example, changing a timestamp
14767 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
14768 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
14770 @multitable @columnfractions 0.15 0.2 0.1 0.2
14771 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
14772 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab @kbd{C} @tab
14773 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
14774 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab @kbd{L} @tab
14775 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x r}           @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
14776 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab @kbd{R} @tab
14777 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
14778 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab @kbd{U} @tab
14779 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
14780 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab @kbd{D} @tab
14781 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab @kbd{ } @tab
14782 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
14783 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab @kbd{ } @tab
14784 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab @kbd{ } @tab
14785 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab @kbd{ } @tab
14786 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab @kbd{ } @tab
14787 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab @kbd{ } @tab
14788 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab @kbd{ } @tab
14789 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
14790 @end multitable
14793 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
14794 @section Interaction with other packages
14795 @cindex packages, interaction with other
14796 Org lives in the world of GNU Emacs and interacts in various ways
14797 with other code out there.
14799 @menu
14800 * Cooperation::                 Packages Org cooperates with
14801 * Conflicts::                   Packages that lead to conflicts
14802 @end menu
14804 @node Cooperation, Conflicts, Interaction, Interaction
14805 @subsection Packages that Org cooperates with
14807 @table @asis
14808 @cindex @file{calc.el}
14809 @cindex Gillespie, Dave
14810 @item @file{calc.el} by Dave Gillespie
14811 Org uses the Calc package for implementing spreadsheet
14812 functionality in its tables (@pxref{The spreadsheet}).  Org
14813 checks for the availability of Calc by looking for the function
14814 @code{calc-eval} which will have been autoloaded during setup if Calc has
14815 been installed properly.  As of Emacs 22, Calc is part of the Emacs
14816 distribution.  Another possibility for interaction between the two
14817 packages is using Calc for embedded calculations.  @xref{Embedded Mode,
14818 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
14819 @item @file{constants.el} by Carsten Dominik
14820 @cindex @file{constants.el}
14821 @cindex Dominik, Carsten
14822 @vindex org-table-formula-constants
14823 In a table formula (@pxref{The spreadsheet}), it is possible to use
14824 names for natural constants or units.  Instead of defining your own
14825 constants in the variable @code{org-table-formula-constants}, install
14826 the @file{constants} package which defines a large number of constants
14827 and units, and lets you use unit prefixes like @samp{M} for
14828 @samp{Mega}, etc@.  You will need version 2.0 of this package, available
14829 at @url{http://www.astro.uva.nl/~dominik/Tools}.  Org checks for
14830 the function @code{constants-get}, which has to be autoloaded in your
14831 setup.  See the installation instructions in the file
14832 @file{constants.el}.
14833 @item @file{cdlatex.el} by Carsten Dominik
14834 @cindex @file{cdlatex.el}
14835 @cindex Dominik, Carsten
14836 Org mode can make use of the CDLa@TeX{} package to efficiently enter
14837 @LaTeX{} fragments into Org files.  See @ref{CDLaTeX mode}.
14838 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
14839 @cindex @file{imenu.el}
14840 Imenu allows menu access to an index of items in a file.  Org mode
14841 supports Imenu---all you need to do to get the index is the following:
14842 @lisp
14843 (add-hook 'org-mode-hook
14844           (lambda () (imenu-add-to-menubar "Imenu")))
14845 @end lisp
14846 @vindex org-imenu-depth
14847 By default the index is two levels deep---you can modify the depth using
14848 the option @code{org-imenu-depth}.
14849 @item @file{remember.el} by John Wiegley
14850 @cindex @file{remember.el}
14851 @cindex Wiegley, John
14852 Org used to use this package for capture, but no longer does.
14853 @item @file{speedbar.el} by Eric M. Ludlam
14854 @cindex @file{speedbar.el}
14855 @cindex Ludlam, Eric M.
14856 Speedbar is a package that creates a special frame displaying files and
14857 index items in files.  Org mode supports Speedbar and allows you to
14858 drill into Org files directly from the Speedbar.  It also allows you to
14859 restrict the scope of agenda commands to a file or a subtree by using
14860 the command @kbd{<} in the Speedbar frame.
14861 @cindex @file{table.el}
14862 @item @file{table.el} by Takaaki Ota
14863 @kindex C-c C-c
14864 @cindex table editor, @file{table.el}
14865 @cindex @file{table.el}
14866 @cindex Ota, Takaaki
14868 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
14869 and alignment can be created using the Emacs table package by Takaaki Ota
14870 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
14871 Org mode will recognize these tables and export them properly.  Because of
14872 interference with other Org mode functionality, you unfortunately cannot edit
14873 these tables directly in the buffer.  Instead, you need to use the command
14874 @kbd{C-c '} to edit them, similar to source code snippets.
14876 @table @kbd
14877 @orgcmd{C-c ',org-edit-special}
14878 Edit a @file{table.el} table.  Works when the cursor is in a table.el table.
14880 @orgcmd{C-c ~,org-table-create-with-table.el}
14881 Insert a @file{table.el} table.  If there is already a table at point, this
14882 command converts it between the @file{table.el} format and the Org mode
14883 format.  See the documentation string of the command
14884 @code{org-convert-table} for the restrictions under which this is
14885 possible.
14886 @end table
14887 @file{table.el} is part of Emacs since Emacs 22.
14888 @item @file{footnote.el} by Steven L. Baur
14889 @cindex @file{footnote.el}
14890 @cindex Baur, Steven L.
14891 Org mode recognizes numerical footnotes as provided by this package.
14892 However, Org mode also has its own footnote support (@pxref{Footnotes}),
14893 which makes using @file{footnote.el} unnecessary.
14894 @end table
14896 @node Conflicts,  , Cooperation, Interaction
14897 @subsection Packages that lead to conflicts with Org mode
14899 @table @asis
14901 @cindex @code{shift-selection-mode}
14902 @vindex org-support-shift-select
14903 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
14904 cursor motions combined with the shift key should start or enlarge regions.
14905 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
14906 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
14907 at such a location.  By default, @kbd{S-@key{cursor}} commands outside
14908 special contexts don't do anything, but you can customize the variable
14909 @code{org-support-shift-select}.  Org mode then tries to accommodate shift
14910 selection by (i) using it outside of the special contexts where special
14911 commands apply, and by (ii) extending an existing active region even if the
14912 cursor moves across a special context.
14914 @item @file{CUA.el} by Kim. F. Storm
14915 @cindex @file{CUA.el}
14916 @cindex Storm, Kim. F.
14917 @vindex org-replace-disputed-keys
14918 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
14919 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
14920 region.  In fact, Emacs 23 has this built-in in the form of
14921 @code{shift-selection-mode}, see previous paragraph.  If you are using Emacs
14922 23, you probably don't want to use another package for this purpose.  However,
14923 if you prefer to leave these keys to a different package while working in
14924 Org mode, configure the variable @code{org-replace-disputed-keys}.  When set,
14925 Org will move the following key bindings in Org files, and in the agenda
14926 buffer (but not during date selection).
14928 @example
14929 S-UP      @result{}  M-p             S-DOWN     @result{}  M-n
14930 S-LEFT    @result{}  M--             S-RIGHT    @result{}  M-+
14931 C-S-LEFT  @result{}  M-S--           C-S-RIGHT  @result{}  M-S-+
14932 @end example
14934 @vindex org-disputed-keys
14935 Yes, these are unfortunately more difficult to remember.  If you want
14936 to have other replacement keys, look at the variable
14937 @code{org-disputed-keys}.
14939 @item @file{yasnippet.el}
14940 @cindex @file{yasnippet.el}
14941 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
14942 @code{"\t"}) overrules YASnippet's access to this key.  The following code
14943 fixed this problem:
14945 @lisp
14946 (add-hook 'org-mode-hook
14947           (lambda ()
14948             (org-set-local 'yas/trigger-key [tab])
14949             (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
14950 @end lisp
14952 The latest version of yasnippet doesn't play well with Org mode.  If the
14953 above code does not fix the conflict, start by defining the following
14954 function:
14956 @lisp
14957 (defun yas/org-very-safe-expand ()
14958        (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
14959 @end lisp
14961 Then, tell Org mode what to do with the new function:
14963 @lisp
14964 (add-hook 'org-mode-hook
14965           (lambda ()
14966               (make-variable-buffer-local 'yas/trigger-key)
14967               (setq yas/trigger-key [tab])
14968               (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
14969               (define-key yas/keymap [tab] 'yas/next-field)))
14970 @end lisp
14972 @item @file{windmove.el} by Hovav Shacham
14973 @cindex @file{windmove.el}
14974 This package also uses the @kbd{S-<cursor>} keys, so everything written
14975 in the paragraph above about CUA mode also applies here.  If you want make
14976 the windmove function active in locations where Org mode does not have
14977 special functionality on @kbd{S-@key{cursor}}, add this to your
14978 configuration:
14980 @lisp
14981 ;; Make windmove work in org-mode:
14982 (add-hook 'org-shiftup-final-hook 'windmove-up)
14983 (add-hook 'org-shiftleft-final-hook 'windmove-left)
14984 (add-hook 'org-shiftdown-final-hook 'windmove-down)
14985 (add-hook 'org-shiftright-final-hook 'windmove-right)
14986 @end lisp
14988 @item @file{viper.el} by Michael Kifer
14989 @cindex @file{viper.el}
14990 @kindex C-c /
14991 Viper uses @kbd{C-c /} and therefore makes this key not access the
14992 corresponding Org mode command @code{org-sparse-tree}.  You need to find
14993 another key for this command, or override the key in
14994 @code{viper-vi-global-user-map} with
14996 @lisp
14997 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
14998 @end lisp
15000 @end table
15002 @node org-crypt.el,  , Interaction, Miscellaneous
15003 @section org-crypt.el
15004 @cindex @file{org-crypt.el}
15005 @cindex @code{org-decrypt-entry}
15007 Org-crypt will encrypt the text of an entry, but not the headline, or
15008 properties.  Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
15009 files.
15011 Any text below a headline that has a @samp{:crypt:} tag will be automatically
15012 be encrypted when the file is saved.  If you want to use a different tag just
15013 customize the @code{org-crypt-tag-matcher} setting.
15015 To use org-crypt it is suggested that you have the following in your
15016 @file{.emacs}:
15018 @example
15019 (require 'org-crypt)
15020 (org-crypt-use-before-save-magic)
15021 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
15023 (setq org-crypt-key nil)
15024   ;; GPG key to use for encryption
15025   ;; Either the Key ID or set to nil to use symmetric encryption.
15027 (setq auto-save-default nil)
15028   ;; Auto-saving does not cooperate with org-crypt.el: so you need
15029   ;; to turn it off if you plan to use org-crypt.el quite often.
15030   ;; Otherwise, you'll get an (annoying) message each time you
15031   ;; start Org.
15033   ;; To turn it off only locally, you can insert this:
15034   ;;
15035   ;; # -*- buffer-auto-save-file-name: nil; -*-
15036 @end example
15038 Excluding the crypt tag from inheritance prevents already encrypted text
15039 being encrypted again.
15041 @node Hacking, MobileOrg, Miscellaneous, Top
15042 @appendix Hacking
15043 @cindex hacking
15045 This appendix covers some aspects where users can extend the functionality of
15046 Org.
15048 @menu
15049 * Hooks::                       Who to reach into Org's internals
15050 * Add-on packages::             Available extensions
15051 * Adding hyperlink types::      New custom link types
15052 * Context-sensitive commands::  How to add functionality to such commands
15053 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
15054 * Dynamic blocks::              Automatically filled blocks
15055 * Special agenda views::        Customized views
15056 * Extracting agenda information::  Postprocessing of agenda information
15057 * Using the property API::      Writing programs that use entry properties
15058 * Using the mapping API::       Mapping over all or selected entries
15059 @end menu
15061 @node Hooks, Add-on packages, Hacking, Hacking
15062 @section Hooks
15063 @cindex hooks
15065 Org has a large number of hook variables that can be used to add
15066 functionality.  This appendix about hacking is going to illustrate the
15067 use of some of them.  A complete list of all hooks with documentation is
15068 maintained by the Worg project and can be found at
15069 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
15071 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
15072 @section Add-on packages
15073 @cindex add-on packages
15075 A large number of add-on packages have been written by various authors.
15076 These packages are not part of Emacs, but they are distributed as contributed
15077 packages with the separate release available at the Org mode home page at
15078 @uref{http://orgmode.org}.  The list of contributed packages, along with
15079 documentation about each package, is maintained by the Worg project at
15080 @uref{http://orgmode.org/worg/org-contrib/}.
15084 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
15085 @section Adding hyperlink types
15086 @cindex hyperlinks, adding new types
15088 Org has a large number of hyperlink types built-in
15089 (@pxref{Hyperlinks}).  If you would like to add new link types, Org
15090 provides an interface for doing so.  Let's look at an example file,
15091 @file{org-man.el}, that will add support for creating links like
15092 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
15093 Emacs:
15095 @lisp
15096 ;;; org-man.el - Support for links to manpages in Org
15098 (require 'org)
15100 (org-add-link-type "man" 'org-man-open)
15101 (add-hook 'org-store-link-functions 'org-man-store-link)
15103 (defcustom org-man-command 'man
15104   "The Emacs command to be used to display a man page."
15105   :group 'org-link
15106   :type '(choice (const man) (const woman)))
15108 (defun org-man-open (path)
15109   "Visit the manpage on PATH.
15110 PATH should be a topic that can be thrown at the man command."
15111   (funcall org-man-command path))
15113 (defun org-man-store-link ()
15114   "Store a link to a manpage."
15115   (when (memq major-mode '(Man-mode woman-mode))
15116     ;; This is a man page, we do make this link
15117     (let* ((page (org-man-get-page-name))
15118            (link (concat "man:" page))
15119            (description (format "Manpage for %s" page)))
15120       (org-store-link-props
15121        :type "man"
15122        :link link
15123        :description description))))
15125 (defun org-man-get-page-name ()
15126   "Extract the page name from the buffer name."
15127   ;; This works for both `Man-mode' and `woman-mode'.
15128   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
15129       (match-string 1 (buffer-name))
15130     (error "Cannot create link to this man page")))
15132 (provide 'org-man)
15134 ;;; org-man.el ends here
15135 @end lisp
15137 @noindent
15138 You would activate this new link type in @file{.emacs} with
15140 @lisp
15141 (require 'org-man)
15142 @end lisp
15144 @noindent
15145 Let's go through the file and see what it does.
15146 @enumerate
15147 @item
15148 It does @code{(require 'org)} to make sure that @file{org.el} has been
15149 loaded.
15150 @item
15151 The next line calls @code{org-add-link-type} to define a new link type
15152 with prefix @samp{man}.  The call also contains the name of a function
15153 that will be called to follow such a link.
15154 @item
15155 @vindex org-store-link-functions
15156 The next line adds a function to @code{org-store-link-functions}, in
15157 order to allow the command @kbd{C-c l} to record a useful link in a
15158 buffer displaying a man page.
15159 @end enumerate
15161 The rest of the file defines the necessary variables and functions.
15162 First there is a customization variable that determines which Emacs
15163 command should be used to display man pages.  There are two options,
15164 @code{man} and @code{woman}.  Then the function to follow a link is
15165 defined.  It gets the link path as an argument---in this case the link
15166 path is just a topic for the manual command.  The function calls the
15167 value of @code{org-man-command} to display the man page.
15169 Finally the function @code{org-man-store-link} is defined.  When you try
15170 to store a link with @kbd{C-c l}, this function will be called to
15171 try to make a link.  The function must first decide if it is supposed to
15172 create the link for this buffer type; we do this by checking the value
15173 of the variable @code{major-mode}.  If not, the function must exit and
15174 return the value @code{nil}.  If yes, the link is created by getting the
15175 manual topic from the buffer name and prefixing it with the string
15176 @samp{man:}.  Then it must call the command @code{org-store-link-props}
15177 and set the @code{:type} and @code{:link} properties.  Optionally you
15178 can also set the @code{:description} property to provide a default for
15179 the link description when the link is later inserted into an Org
15180 buffer with @kbd{C-c C-l}.
15182 When it makes sense for your new link type, you may also define a function
15183 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
15184 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
15185 not accept any arguments, and return the full link with prefix.
15187 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
15188 @section Context-sensitive commands
15189 @cindex context-sensitive commands, hooks
15190 @cindex add-ons, context-sensitive commands
15191 @vindex org-ctrl-c-ctrl-c-hook
15193 Org has several commands that act differently depending on context.  The most
15194 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
15195 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
15197 Add-ons can tap into this functionality by providing a function that detects
15198 special context for that add-on and executes functionality appropriate for
15199 the context.  Here is an example from Dan Davison's @file{org-R.el} which
15200 allows you to evaluate commands based on the @file{R} programming language
15201 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
15202 described in @ref{Working With Source Code} and is now obsolete.}.  For this
15203 package, special contexts are lines that start with @code{#+R:} or
15204 @code{#+RR:}.
15206 @lisp
15207 (defun org-R-apply-maybe ()
15208   "Detect if this is context for org-R and execute R commands."
15209   (if (save-excursion
15210         (beginning-of-line 1)
15211         (looking-at "#\\+RR?:"))
15212       (progn (call-interactively 'org-R-apply)
15213              t) ;; to signal that we took action
15214     nil)) ;; to signal that we did not
15216 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
15217 @end lisp
15219 The function first checks if the cursor is in such a line.  If that is the
15220 case, @code{org-R-apply} is called and the function returns @code{t} to
15221 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
15222 contexts.  If the function finds it should do nothing locally, it returns
15223 @code{nil} so that other, similar functions can have a try.
15226 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
15227 @section Tables and lists in arbitrary syntax
15228 @cindex tables, in other modes
15229 @cindex lists, in other modes
15230 @cindex Orgtbl mode
15232 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
15233 frequent feature request has been to make it work with native tables in
15234 specific languages, for example @LaTeX{}.  However, this is extremely
15235 hard to do in a general way, would lead to a customization nightmare,
15236 and would take away much of the simplicity of the Orgtbl mode table
15237 editor.
15239 This appendix describes a different approach.  We keep the Orgtbl mode
15240 table in its native format (the @i{source table}), and use a custom
15241 function to @i{translate} the table to the correct syntax, and to
15242 @i{install} it in the right location (the @i{target table}).  This puts
15243 the burden of writing conversion functions on the user, but it allows
15244 for a very flexible system.
15246 Bastien added the ability to do the same with lists, in Orgstruct mode.  You
15247 can use Org's facilities to edit and structure lists by turning
15248 @code{orgstruct-mode} on, then locally exporting such lists in another format
15249 (HTML, @LaTeX{} or Texinfo.)
15252 @menu
15253 * Radio tables::                Sending and receiving radio tables
15254 * A LaTeX example::             Step by step, almost a tutorial
15255 * Translator functions::        Copy and modify
15256 * Radio lists::                 Doing the same for lists
15257 @end menu
15259 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
15260 @subsection Radio tables
15261 @cindex radio tables
15263 To define the location of the target table, you first need to create two
15264 lines that are comments in the current mode, but contain magic words for
15265 Orgtbl mode to find.  Orgtbl mode will insert the translated table
15266 between these lines, replacing whatever was there before.  For example:
15268 @example
15269 /* BEGIN RECEIVE ORGTBL table_name */
15270 /* END RECEIVE ORGTBL table_name */
15271 @end example
15273 @noindent
15274 Just above the source table, we put a special line that tells
15275 Orgtbl mode how to translate this table and where to install it.  For
15276 example:
15277 @cindex #+ORGTBL
15278 @example
15279 #+ORGTBL: SEND table_name translation_function arguments....
15280 @end example
15282 @noindent
15283 @code{table_name} is the reference name for the table that is also used
15284 in the receiver lines.  @code{translation_function} is the Lisp function
15285 that does the translation.  Furthermore, the line can contain a list of
15286 arguments (alternating key and value) at the end.  The arguments will be
15287 passed as a property list to the translation function for
15288 interpretation.  A few standard parameters are already recognized and
15289 acted upon before the translation function is called:
15291 @table @code
15292 @item :skip N
15293 Skip the first N lines of the table.  Hlines do count as separate lines for
15294 this parameter!
15296 @item :skipcols (n1 n2 ...)
15297 List of columns that should be skipped.  If the table has a column with
15298 calculation marks, that column is automatically discarded as well.
15299 Please note that the translator function sees the table @emph{after} the
15300 removal of these columns, the function never knows that there have been
15301 additional columns.
15302 @end table
15304 @noindent
15305 The one problem remaining is how to keep the source table in the buffer
15306 without disturbing the normal workings of the file, for example during
15307 compilation of a C file or processing of a @LaTeX{} file.  There are a
15308 number of different solutions:
15310 @itemize @bullet
15311 @item
15312 The table could be placed in a block comment if that is supported by the
15313 language.  For example, in C mode you could wrap the table between
15314 @samp{/*} and @samp{*/} lines.
15315 @item
15316 Sometimes it is possible to put the table after some kind of @i{END}
15317 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
15318 in @LaTeX{}.
15319 @item
15320 You can just comment the table line-by-line whenever you want to process
15321 the file, and uncomment it whenever you need to edit the table.  This
15322 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
15323 makes this comment-toggling very easy, in particular if you bind it to a
15324 key.
15325 @end itemize
15327 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
15328 @subsection A @LaTeX{} example of radio tables
15329 @cindex @LaTeX{}, and Orgtbl mode
15331 The best way to wrap the source table in @LaTeX{} is to use the
15332 @code{comment} environment provided by @file{comment.sty}.  It has to be
15333 activated by placing @code{\usepackage@{comment@}} into the document
15334 header.  Orgtbl mode can insert a radio table skeleton@footnote{By
15335 default this works only for @LaTeX{}, HTML, and Texinfo.  Configure the
15336 variable @code{orgtbl-radio-tables} to install templates for other
15337 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table}.  You will
15338 be prompted for a table name, let's say we use @samp{salesfigures}.  You
15339 will then get the following template:
15341 @cindex #+ORGTBL, SEND
15342 @example
15343 % BEGIN RECEIVE ORGTBL salesfigures
15344 % END RECEIVE ORGTBL salesfigures
15345 \begin@{comment@}
15346 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15347 | | |
15348 \end@{comment@}
15349 @end example
15351 @noindent
15352 @vindex @LaTeX{}-verbatim-environments
15353 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
15354 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
15355 into the receiver location with name @code{salesfigures}.  You may now
15356 fill in the table---feel free to use the spreadsheet features@footnote{If
15357 the @samp{#+TBLFM} line contains an odd number of dollar characters,
15358 this may cause problems with font-lock in @LaTeX{} mode.  As shown in the
15359 example you can fix this by adding an extra line inside the
15360 @code{comment} environment that is used to balance the dollar
15361 expressions.  If you are using AUC@TeX{} with the font-latex library, a
15362 much better solution is to add the @code{comment} environment to the
15363 variable @code{LaTeX-verbatim-environments}.}:
15365 @example
15366 % BEGIN RECEIVE ORGTBL salesfigures
15367 % END RECEIVE ORGTBL salesfigures
15368 \begin@{comment@}
15369 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15370 | Month | Days | Nr sold | per day |
15371 |-------+------+---------+---------|
15372 | Jan   |   23 |      55 |     2.4 |
15373 | Feb   |   21 |      16 |     0.8 |
15374 | March |   22 |     278 |    12.6 |
15375 #+TBLFM: $4=$3/$2;%.1f
15376 % $ (optional extra dollar to keep font-lock happy, see footnote)
15377 \end@{comment@}
15378 @end example
15380 @noindent
15381 When you are done, press @kbd{C-c C-c} in the table to get the converted
15382 table inserted between the two marker lines.
15384 Now let's assume you want to make the table header by hand, because you
15385 want to control how columns are aligned, etc@.  In this case we make sure
15386 that the table translator skips the first 2 lines of the source
15387 table, and tell the command to work as a @i{splice}, i.e.@: to not produce
15388 header and footer commands of the target table:
15390 @example
15391 \begin@{tabular@}@{lrrr@}
15392 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
15393 % BEGIN RECEIVE ORGTBL salesfigures
15394 % END RECEIVE ORGTBL salesfigures
15395 \end@{tabular@}
15397 \begin@{comment@}
15398 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
15399 | Month | Days | Nr sold | per day |
15400 |-------+------+---------+---------|
15401 | Jan   |   23 |      55 |     2.4 |
15402 | Feb   |   21 |      16 |     0.8 |
15403 | March |   22 |     278 |    12.6 |
15404 #+TBLFM: $4=$3/$2;%.1f
15405 \end@{comment@}
15406 @end example
15408 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
15409 Orgtbl mode.  It uses a @code{tabular} environment to typeset the table
15410 and marks horizontal lines with @code{\hline}.  Furthermore, it
15411 interprets the following parameters (see also @pxref{Translator functions}):
15413 @table @code
15414 @item :splice nil/t
15415 When set to t, return only table body lines, don't wrap them into a
15416 tabular environment.  Default is nil.
15418 @item :fmt fmt
15419 A format to be used to wrap each field, it should contain @code{%s} for the
15420 original field value.  For example, to wrap each field value in dollars,
15421 you could use @code{:fmt "$%s$"}.  This may also be a property list with
15422 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
15423 A function of one argument can be used in place of the strings; the
15424 function must return a formatted string.
15426 @item :efmt efmt
15427 Use this format to print numbers with exponentials.  The format should
15428 have @code{%s} twice for inserting mantissa and exponent, for example
15429 @code{"%s\\times10^@{%s@}"}.  The default is @code{"%s\\,(%s)"}.  This
15430 may also be a property list with column numbers and formats, for example
15431 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}.  After
15432 @code{efmt} has been applied to a value, @code{fmt} will also be
15433 applied.  Similar to @code{fmt}, functions of two arguments can be
15434 supplied instead of strings.
15435 @end table
15437 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
15438 @subsection Translator functions
15439 @cindex HTML, and Orgtbl mode
15440 @cindex translator function
15442 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
15443 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
15444 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
15445 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
15446 code that produces tables during HTML export.}, these all use a generic
15447 translator, @code{orgtbl-to-generic}.  For example, @code{orgtbl-to-latex}
15448 itself is a very short function that computes the column definitions for the
15449 @code{tabular} environment, defines a few field and line separators and then
15450 hands processing over to the generic translator.  Here is the entire code:
15452 @lisp
15453 @group
15454 (defun orgtbl-to-latex (table params)
15455   "Convert the Orgtbl mode TABLE to LaTeX."
15456   (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
15457                                org-table-last-alignment ""))
15458          (params2
15459           (list
15460            :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
15461            :tend "\\end@{tabular@}"
15462            :lstart "" :lend " \\\\" :sep " & "
15463            :efmt "%s\\,(%s)" :hline "\\hline")))
15464     (orgtbl-to-generic table (org-combine-plists params2 params))))
15465 @end group
15466 @end lisp
15468 As you can see, the properties passed into the function (variable
15469 @var{PARAMS}) are combined with the ones newly defined in the function
15470 (variable @var{PARAMS2}).  The ones passed into the function (i.e.@: the
15471 ones set by the @samp{ORGTBL SEND} line) take precedence.  So if you
15472 would like to use the @LaTeX{} translator, but wanted the line endings to
15473 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
15474 overrule the default with
15476 @example
15477 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
15478 @end example
15480 For a new language, you can either write your own converter function in
15481 analogy with the @LaTeX{} translator, or you can use the generic function
15482 directly.  For example, if you have a language where a table is started
15483 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
15484 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
15485 separator is a TAB, you could call the generic translator like this (on
15486 a single line!):
15488 @example
15489 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
15490                               :lstart "!BL! " :lend " !EL!" :sep "\t"
15491 @end example
15493 @noindent
15494 Please check the documentation string of the function
15495 @code{orgtbl-to-generic} for a full list of parameters understood by
15496 that function, and remember that you can pass each of them into
15497 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
15498 using the generic function.
15500 Of course you can also write a completely new function doing complicated
15501 things the generic translator cannot do.  A translator function takes
15502 two arguments.  The first argument is the table, a list of lines, each
15503 line either the symbol @code{hline} or a list of fields.  The second
15504 argument is the property list containing all parameters specified in the
15505 @samp{#+ORGTBL: SEND} line.  The function must return a single string
15506 containing the formatted table.  If you write a generally useful
15507 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
15508 others can benefit from your work.
15510 @node Radio lists,  , Translator functions, Tables in arbitrary syntax
15511 @subsection Radio lists
15512 @cindex radio lists
15513 @cindex org-list-insert-radio-list
15515 Sending and receiving radio lists works exactly the same way as sending and
15516 receiving radio tables (@pxref{Radio tables}).  As for radio tables, you can
15517 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
15518 @code{org-list-insert-radio-list}.
15520 Here are the differences with radio tables:
15522 @itemize @minus
15523 @item
15524 Orgstruct mode must be active.
15525 @item
15526 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
15527 @item
15528 The available translation functions for radio lists don't take
15529 parameters.
15530 @item
15531 @kbd{C-c C-c} will work when pressed on the first item of the list.
15532 @end itemize
15534 Here is a @LaTeX{} example.  Let's say that you have this in your
15535 @LaTeX{} file:
15537 @cindex #+ORGLST
15538 @example
15539 % BEGIN RECEIVE ORGLST to-buy
15540 % END RECEIVE ORGLST to-buy
15541 \begin@{comment@}
15542 #+ORGLST: SEND to-buy org-list-to-latex
15543 - a new house
15544 - a new computer
15545   + a new keyboard
15546   + a new mouse
15547 - a new life
15548 \end@{comment@}
15549 @end example
15551 Pressing `C-c C-c' on @code{a new house} and will insert the converted
15552 @LaTeX{} list between the two marker lines.
15554 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
15555 @section Dynamic blocks
15556 @cindex dynamic blocks
15558 Org documents can contain @emph{dynamic blocks}.  These are
15559 specially marked regions that are updated by some user-written function.
15560 A good example for such a block is the clock table inserted by the
15561 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
15563 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
15564 to the block and can also specify parameters for the function producing
15565 the content of the block.
15567 @cindex #+BEGIN:dynamic block
15568 @example
15569 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
15571 #+END:
15572 @end example
15574 Dynamic blocks are updated with the following commands
15576 @table @kbd
15577 @orgcmd{C-c C-x C-u,org-dblock-update}
15578 Update dynamic block at point.
15579 @orgkey{C-u C-c C-x C-u}
15580 Update all dynamic blocks in the current file.
15581 @end table
15583 Updating a dynamic block means to remove all the text between BEGIN and
15584 END, parse the BEGIN line for parameters and then call the specific
15585 writer function for this block to insert the new content.  If you want
15586 to use the original content in the writer function, you can use the
15587 extra parameter @code{:content}.
15589 For a block with name @code{myblock}, the writer function is
15590 @code{org-dblock-write:myblock} with as only parameter a property list
15591 with the parameters given in the begin line.  Here is a trivial example
15592 of a block that keeps track of when the block update function was last
15593 run:
15595 @example
15596 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
15598 #+END:
15599 @end example
15601 @noindent
15602 The corresponding block writer function could look like this:
15604 @lisp
15605 (defun org-dblock-write:block-update-time (params)
15606    (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
15607      (insert "Last block update at: "
15608              (format-time-string fmt (current-time)))))
15609 @end lisp
15611 If you want to make sure that all dynamic blocks are always up-to-date,
15612 you could add the function @code{org-update-all-dblocks} to a hook, for
15613 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
15614 written in a way such that it does nothing in buffers that are not in
15615 @code{org-mode}.
15617 You can narrow the current buffer to the current dynamic block (like any
15618 other block) with @code{org-narrow-to-block}.
15620 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
15621 @section Special agenda views
15622 @cindex agenda views, user-defined
15624 @vindex org-agenda-skip-function
15625 @vindex org-agenda-skip-function-global
15626 Org provides a special hook that can be used to narrow down the selection
15627 made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
15628 @code{tags}, @code{tags-todo}, @code{tags-tree}.  You may specify a function
15629 that is used at each match to verify if the match should indeed be part of
15630 the agenda view, and if not, how much should be skipped.  You can specify a
15631 global condition that will be applied to all agenda views, this condition
15632 would be stored in the variable @code{org-agenda-skip-function-global}.  More
15633 commonly, such a definition is applied only to specific custom searches,
15634 using @code{org-agenda-skip-function}.
15636 Let's say you want to produce a list of projects that contain a WAITING
15637 tag anywhere in the project tree.  Let's further assume that you have
15638 marked all tree headings that define a project with the TODO keyword
15639 PROJECT.  In this case you would run a TODO search for the keyword
15640 PROJECT, but skip the match unless there is a WAITING tag anywhere in
15641 the subtree belonging to the project line.
15643 To achieve this, you must write a function that searches the subtree for
15644 the tag.  If the tag is found, the function must return @code{nil} to
15645 indicate that this match should not be skipped.  If there is no such
15646 tag, return the location of the end of the subtree, to indicate that
15647 search should continue from there.
15649 @lisp
15650 (defun my-skip-unless-waiting ()
15651   "Skip trees that are not waiting"
15652   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
15653     (if (re-search-forward ":waiting:" subtree-end t)
15654         nil          ; tag found, do not skip
15655       subtree-end))) ; tag not found, continue after end of subtree
15656 @end lisp
15658 Now you may use this function in an agenda custom command, for example
15659 like this:
15661 @lisp
15662 (org-add-agenda-custom-command
15663  '("b" todo "PROJECT"
15664    ((org-agenda-skip-function 'my-skip-unless-waiting)
15665     (org-agenda-overriding-header "Projects waiting for something: "))))
15666 @end lisp
15668 @vindex org-agenda-overriding-header
15669 Note that this also binds @code{org-agenda-overriding-header} to get a
15670 meaningful header in the agenda view.
15672 @vindex org-odd-levels-only
15673 @vindex org-agenda-skip-function
15674 A general way to create custom searches is to base them on a search for
15675 entries with a certain level limit.  If you want to study all entries with
15676 your custom search function, simply do a search for
15677 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
15678 level number corresponds to order in the hierarchy, not to the number of
15679 stars.}, and then use @code{org-agenda-skip-function} to select the entries
15680 you really want to have.
15682 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
15683 particular, you may use the functions @code{org-agenda-skip-entry-if}
15684 and @code{org-agenda-skip-subtree-if} in this form, for example:
15686 @table @code
15687 @item (org-agenda-skip-entry-if 'scheduled)
15688 Skip current entry if it has been scheduled.
15689 @item (org-agenda-skip-entry-if 'notscheduled)
15690 Skip current entry if it has not been scheduled.
15691 @item (org-agenda-skip-entry-if 'deadline)
15692 Skip current entry if it has a deadline.
15693 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
15694 Skip current entry if it has a deadline, or if it is scheduled.
15695 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
15696 Skip current entry if the TODO keyword is TODO or WAITING.
15697 @item (org-agenda-skip-entry-if 'todo 'done)
15698 Skip current entry if the TODO keyword marks a DONE state.
15699 @item (org-agenda-skip-entry-if 'timestamp)
15700 Skip current entry if it has any timestamp, may also be deadline or scheduled.
15701 @item (org-agenda-skip-entry 'regexp "regular expression")
15702 Skip current entry if the regular expression matches in the entry.
15703 @item (org-agenda-skip-entry 'notregexp "regular expression")
15704 Skip current entry unless the regular expression matches.
15705 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
15706 Same as above, but check and skip the entire subtree.
15707 @end table
15709 Therefore we could also have written the search for WAITING projects
15710 like this, even without defining a special function:
15712 @lisp
15713 (org-add-agenda-custom-command
15714  '("b" todo "PROJECT"
15715    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
15716                                 'regexp ":waiting:"))
15717     (org-agenda-overriding-header "Projects waiting for something: "))))
15718 @end lisp
15720 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
15721 @section Extracting agenda information
15722 @cindex agenda, pipe
15723 @cindex Scripts, for agenda processing
15725 @vindex org-agenda-custom-commands
15726 Org provides commands to access agenda information for the command
15727 line in Emacs batch mode.  This extracted information can be sent
15728 directly to a printer, or it can be read by a program that does further
15729 processing of the data.  The first of these commands is the function
15730 @code{org-batch-agenda}, that produces an agenda view and sends it as
15731 ASCII text to STDOUT.  The command takes a single string as parameter.
15732 If the string has length 1, it is used as a key to one of the commands
15733 you have configured in @code{org-agenda-custom-commands}, basically any
15734 key you can use after @kbd{C-c a}.  For example, to directly print the
15735 current TODO list, you could use
15737 @example
15738 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
15739 @end example
15741 If the parameter is a string with 2 or more characters, it is used as a
15742 tags/TODO match string.  For example, to print your local shopping list
15743 (all items with the tag @samp{shop}, but excluding the tag
15744 @samp{NewYork}), you could use
15746 @example
15747 emacs -batch -l ~/.emacs                                      \
15748       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
15749 @end example
15751 @noindent
15752 You may also modify parameters on the fly like this:
15754 @example
15755 emacs -batch -l ~/.emacs                                      \
15756    -eval '(org-batch-agenda "a"                               \
15757             org-agenda-span (quote month)                     \
15758             org-agenda-include-diary nil                      \
15759             org-agenda-files (quote ("~/org/project.org")))'  \
15760    | lpr
15761 @end example
15763 @noindent
15764 which will produce a 30-day agenda, fully restricted to the Org file
15765 @file{~/org/projects.org}, not even including the diary.
15767 If you want to process the agenda data in more sophisticated ways, you
15768 can use the command @code{org-batch-agenda-csv} to get a comma-separated
15769 list of values for each agenda item.  Each line in the output will
15770 contain a number of fields separated by commas.  The fields in a line
15771 are:
15773 @example
15774 category     @r{The category of the item}
15775 head         @r{The headline, without TODO keyword, TAGS and PRIORITY}
15776 type         @r{The type of the agenda entry, can be}
15777                 todo               @r{selected in TODO match}
15778                 tagsmatch          @r{selected in tags match}
15779                 diary              @r{imported from diary}
15780                 deadline           @r{a deadline}
15781                 scheduled          @r{scheduled}
15782                 timestamp          @r{appointment, selected by timestamp}
15783                 closed             @r{entry was closed on date}
15784                 upcoming-deadline  @r{warning about nearing deadline}
15785                 past-scheduled     @r{forwarded scheduled item}
15786                 block              @r{entry has date block including date}
15787 todo         @r{The TODO keyword, if any}
15788 tags         @r{All tags including inherited ones, separated by colons}
15789 date         @r{The relevant date, like 2007-2-14}
15790 time         @r{The time, like 15:00-16:50}
15791 extra        @r{String with extra planning info}
15792 priority-l   @r{The priority letter if any was given}
15793 priority-n   @r{The computed numerical priority}
15794 @end example
15796 @noindent
15797 Time and date will only be given if a timestamp (or deadline/scheduled)
15798 led to the selection of the item.
15800 A CSV list like this is very easy to use in a post-processing script.
15801 For example, here is a Perl program that gets the TODO list from
15802 Emacs/Org and prints all the items, preceded by a checkbox:
15804 @example
15805 #!/usr/bin/perl
15807 # define the Emacs command to run
15808 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
15810 # run it and capture the output
15811 $agenda = qx@{$cmd 2>/dev/null@};
15813 # loop over all lines
15814 foreach $line (split(/\n/,$agenda)) @{
15815   # get the individual values
15816   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
15817    $priority_l,$priority_n) = split(/,/,$line);
15818   # process and print
15819   print "[ ] $head\n";
15821 @end example
15823 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
15824 @section Using the property API
15825 @cindex API, for properties
15826 @cindex properties, API
15828 Here is a description of the functions that can be used to work with
15829 properties.
15831 @defun org-entry-properties &optional pom which
15832 Get all properties of the entry at point-or-marker POM.@*
15833 This includes the TODO keyword, the tags, time strings for deadline,
15834 scheduled, and clocking, and any additional properties defined in the
15835 entry.  The return value is an alist.  Keys may occur multiple times
15836 if the property key was used several times.@*
15837 POM may also be nil, in which case the current entry is used.
15838 If WHICH is nil or `all', get all properties.  If WHICH is
15839 `special' or `standard', only get that subclass.
15840 @end defun
15841 @vindex org-use-property-inheritance
15842 @defun org-entry-get pom property &optional inherit
15843 Get value of PROPERTY for entry at point-or-marker POM.  By default,
15844 this only looks at properties defined locally in the entry.  If INHERIT
15845 is non-nil and the entry does not have the property, then also check
15846 higher levels of the hierarchy.  If INHERIT is the symbol
15847 @code{selective}, use inheritance if and only if the setting of
15848 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
15849 @end defun
15851 @defun org-entry-delete pom property
15852 Delete the property PROPERTY from entry at point-or-marker POM.
15853 @end defun
15855 @defun org-entry-put pom property value
15856 Set PROPERTY to VALUE for entry at point-or-marker POM.
15857 @end defun
15859 @defun org-buffer-property-keys &optional include-specials
15860 Get all property keys in the current buffer.
15861 @end defun
15863 @defun org-insert-property-drawer
15864 Insert a property drawer at point.
15865 @end defun
15867 @defun org-entry-put-multivalued-property pom property &rest values
15868 Set PROPERTY at point-or-marker POM to VALUES.  VALUES should be a list of
15869 strings.  They will be concatenated, with spaces as separators.
15870 @end defun
15872 @defun org-entry-get-multivalued-property pom property
15873 Treat the value of the property PROPERTY as a whitespace-separated list of
15874 values and return the values as a list of strings.
15875 @end defun
15877 @defun org-entry-add-to-multivalued-property pom property value
15878 Treat the value of the property PROPERTY as a whitespace-separated list of
15879 values and make sure that VALUE is in this list.
15880 @end defun
15882 @defun org-entry-remove-from-multivalued-property pom property value
15883 Treat the value of the property PROPERTY as a whitespace-separated list of
15884 values and make sure that VALUE is @emph{not} in this list.
15885 @end defun
15887 @defun org-entry-member-in-multivalued-property pom property value
15888 Treat the value of the property PROPERTY as a whitespace-separated list of
15889 values and check if VALUE is in this list.
15890 @end defun
15892 @defopt org-property-allowed-value-functions
15893 Hook for functions supplying allowed values for a specific property.
15894 The functions must take a single argument, the name of the property, and
15895 return a flat list of allowed values.  If @samp{:ETC} is one of
15896 the values, use the values as completion help, but allow also other values
15897 to be entered.  The functions must return @code{nil} if they are not
15898 responsible for this property.
15899 @end defopt
15901 @node Using the mapping API,  , Using the property API, Hacking
15902 @section Using the mapping API
15903 @cindex API, for mapping
15904 @cindex mapping entries, API
15906 Org has sophisticated mapping capabilities to find all entries satisfying
15907 certain criteria.  Internally, this functionality is used to produce agenda
15908 views, but there is also an API that can be used to execute arbitrary
15909 functions for each or selected entries.  The main entry point for this API
15912 @defun org-map-entries func &optional match scope &rest skip
15913 Call FUNC at each headline selected by MATCH in SCOPE.
15915 FUNC is a function or a Lisp form.  The function will be called without
15916 arguments, with the cursor positioned at the beginning of the headline.
15917 The return values of all calls to the function will be collected and
15918 returned as a list.
15920 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15921 does not need to preserve point.  After evaluation, the cursor will be
15922 moved to the end of the line (presumably of the headline of the
15923 processed entry) and search continues from there.  Under some
15924 circumstances, this may not produce the wanted results.  For example,
15925 if you have removed (e.g.@: archived) the current (sub)tree it could
15926 mean that the next entry will be skipped entirely.  In such cases, you
15927 can specify the position from where search should continue by making
15928 FUNC set the variable `org-map-continue-from' to the desired buffer
15929 position.
15931 MATCH is a tags/property/todo match as it is used in the agenda match view.
15932 Only headlines that are matched by this query will be considered during
15933 the iteration.  When MATCH is nil or t, all headlines will be
15934 visited by the iteration.
15936 SCOPE determines the scope of this command.  It can be any of:
15938 @example
15939 nil     @r{the current buffer, respecting the restriction if any}
15940 tree    @r{the subtree started with the entry at point}
15941 region  @r{The entries within the active region, if any}
15942 file    @r{the current buffer, without restriction}
15943 file-with-archives
15944         @r{the current buffer, and any archives associated with it}
15945 agenda  @r{all agenda files}
15946 agenda-with-archives
15947         @r{all agenda files with any archive files associated with them}
15948 (file1 file2 ...)
15949         @r{if this is a list, all files in the list will be scanned}
15950 @end example
15951 @noindent
15952 The remaining args are treated as settings for the skipping facilities of
15953 the scanner.  The following items can be given here:
15955 @vindex org-agenda-skip-function
15956 @example
15957 archive   @r{skip trees with the archive tag}
15958 comment   @r{skip trees with the COMMENT keyword}
15959 function or Lisp form
15960           @r{will be used as value for @code{org-agenda-skip-function},}
15961           @r{so whenever the function returns t, FUNC}
15962           @r{will not be called for that entry and search will}
15963           @r{continue from the point where the function leaves it}
15964 @end example
15965 @end defun
15967 The function given to that mapping routine can really do anything you like.
15968 It can use the property API (@pxref{Using the property API}) to gather more
15969 information about the entry, or in order to change metadata in the entry.
15970 Here are a couple of functions that might be handy:
15972 @defun org-todo &optional arg
15973 Change the TODO state of the entry.  See the docstring of the functions for
15974 the many possible values for the argument ARG.
15975 @end defun
15977 @defun org-priority &optional action
15978 Change the priority of the entry.  See the docstring of this function for the
15979 possible values for ACTION.
15980 @end defun
15982 @defun org-toggle-tag tag &optional onoff
15983 Toggle the tag TAG in the current entry.  Setting ONOFF to either @code{on}
15984 or @code{off} will not toggle tag, but ensure that it is either on or off.
15985 @end defun
15987 @defun org-promote
15988 Promote the current entry.
15989 @end defun
15991 @defun org-demote
15992 Demote the current entry.
15993 @end defun
15995 Here is a simple example that will turn all entries in the current file with
15996 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
15997 Entries in comment trees and in archive trees will be ignored.
15999 @lisp
16000 (org-map-entries
16001    '(org-todo "UPCOMING")
16002    "+TOMORROW" 'file 'archive 'comment)
16003 @end lisp
16005 The following example counts the number of entries with TODO keyword
16006 @code{WAITING}, in all agenda files.
16008 @lisp
16009 (length (org-map-entries t "/+WAITING" 'agenda))
16010 @end lisp
16012 @node MobileOrg, History and Acknowledgments, Hacking, Top
16013 @appendix MobileOrg
16014 @cindex iPhone
16015 @cindex MobileOrg
16017 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
16018 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
16019 @i{MobileOrg} offers offline viewing and capture support for an Org mode
16020 system rooted on a ``real'' computer.  It does also allow you to record
16021 changes to existing entries.  Android users should check out
16022 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
16023 by Matt Jones.
16025 This appendix describes the support Org has for creating agenda views in a
16026 format that can be displayed by @i{MobileOrg}, and for integrating notes
16027 captured and changes made by @i{MobileOrg} into the main system.
16029 For changing tags and TODO states in MobileOrg, you should have set up the
16030 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
16031 cover all important tags and TODO keywords, even if individual files use only
16032 part of these.  MobileOrg will also offer you states and tags set up with
16033 in-buffer settings, but it will understand the logistics of TODO state
16034 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
16035 (@pxref{Setting tags}) only for those set in these variables.
16037 @menu
16038 * Setting up the staging area::  Where to interact with the mobile device
16039 * Pushing to MobileOrg::        Uploading Org files and agendas
16040 * Pulling from MobileOrg::      Integrating captured and flagged items
16041 @end menu
16043 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
16044 @section Setting up the staging area
16046 MobileOrg needs to interact with Emacs through a directory on a server.  If you
16047 are using a public server, you should consider to encrypt the files that are
16048 uploaded to the server.  This can be done with Org mode 7.02 and with
16049 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
16050 installation on your system.  To turn on encryption, set a password in
16051 @i{MobileOrg} and, on the Emacs side, configure the variable
16052 @code{org-mobile-use-encryption}@footnote{If you can safely store the
16053 password in your Emacs setup, you might also want to configure
16054 @code{org-mobile-encryption-password}.  Please read the docstring of that
16055 variable.  Note that encryption will apply only to the contents of the
16056 @file{.org} files.  The file names themselves will remain visible.}.
16058 The easiest way to create that directory is to use a free
16059 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
16060 Dropbox, or if your version of MobileOrg does not support it, you can use a
16061 webdav server.  For more information, check out the documentation of MobileOrg and also this
16062 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
16063 When MobileOrg first connects to your Dropbox, it will create a directory
16064 @i{MobileOrg} inside the Dropbox.  After the directory has been created, tell
16065 Emacs about it:
16067 @lisp
16068 (setq org-mobile-directory "~/Dropbox/MobileOrg")
16069 @end lisp
16071 Org mode has commands to put files for @i{MobileOrg} into that directory,
16072 and to read captured notes from there.
16074 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
16075 @section Pushing to MobileOrg
16077 This operation copies all files currently listed in @code{org-mobile-files}
16078 to the directory @code{org-mobile-directory}.  By default this list contains
16079 all agenda files (as listed in @code{org-agenda-files}), but additional files
16080 can be included by customizing @code{org-mobile-files}.  File names will be
16081 staged with paths relative to @code{org-directory}, so all files should be
16082 inside this directory.  The push operation also creates a special Org file
16083 @file{agendas.org} with all custom agenda view defined by the
16084 user@footnote{While creating the agendas, Org mode will force ID properties
16085 on all referenced entries, so that these entries can be uniquely identified
16086 if @i{MobileOrg} flags them for further action.  If you do not want to get
16087 these properties in so many entries, you can set the variable
16088 @code{org-mobile-force-id-on-agenda-items} to @code{nil}.  Org mode will then
16089 rely on outline paths, in the hope that these will be unique enough.}.
16090 Finally, Org writes the file @file{index.org}, containing links to all other
16091 files.  @i{MobileOrg} first reads this file from the server, and then
16092 downloads all agendas and Org files listed in it.  To speed up the download,
16093 MobileOrg will only read files whose checksums@footnote{stored automatically
16094 in the file @file{checksums.dat}} have changed.
16096 @node Pulling from MobileOrg,  , Pushing to MobileOrg, MobileOrg
16097 @section Pulling from MobileOrg
16099 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
16100 files for viewing.  It also appends captured entries and pointers to flagged
16101 and changed entries to the file @file{mobileorg.org} on the server.  Org has
16102 a @emph{pull} operation that integrates this information into an inbox file
16103 and operates on the pointers to flagged entries.  Here is how it works:
16105 @enumerate
16106 @item
16107 Org moves all entries found in
16108 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
16109 operation.} and appends them to the file pointed to by the variable
16110 @code{org-mobile-inbox-for-pull}.  Each captured entry and each editing event
16111 will be a top-level entry in the inbox file.
16112 @item
16113 After moving the entries, Org will attempt to implement the changes made in
16114 @i{MobileOrg}.  Some changes are applied directly and without user
16115 interaction.  Examples are all changes to tags, TODO state, headline and body
16116 text that can be cleanly applied.  Entries that have been flagged for further
16117 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
16118 again.  When there is a problem finding an entry or applying the change, the
16119 pointer entry will remain in the inbox and will be marked with an error
16120 message.  You need to later resolve these issues by hand.
16121 @item
16122 Org will then generate an agenda view with all flagged entries.  The user
16123 should then go through these entries and do whatever actions are necessary.
16124 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
16125 will be displayed in the echo area when the cursor is on the corresponding
16126 agenda line.
16127 @table @kbd
16128 @kindex ?
16129 @item ?
16130 Pressing @kbd{?} in that special agenda will display the full flagging note in
16131 another window and also push it onto the kill ring.  So you could use @kbd{?
16132 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
16133 Pressing @kbd{?} twice in succession will offer to remove the
16134 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
16135 in a property).  In this way you indicate that the intended processing for
16136 this flagged entry is finished.
16137 @end table
16138 @end enumerate
16140 @kindex C-c a ?
16141 If you are not able to process all flagged entries directly, you can always
16142 return to this agenda view@footnote{Note, however, that there is a subtle
16143 difference.  The view created automatically by @kbd{M-x org-mobile-pull
16144 @key{RET}} is guaranteed to search all files that have been addressed by the
16145 last pull.  This might include a file that is not currently in your list of
16146 agenda files.  If you later use @kbd{C-c a ?} to regenerate the view, only
16147 the current agenda files will be searched.} using @kbd{C-c a ?}.
16149 @node History and Acknowledgments, Main Index, MobileOrg, Top
16150 @appendix History and acknowledgments
16151 @cindex acknowledgments
16152 @cindex history
16153 @cindex thanks
16155 Org was born in 2003, out of frustration over the user interface of the Emacs
16156 Outline mode.  I was trying to organize my notes and projects, and using
16157 Emacs seemed to be the natural way to go.  However, having to remember eleven
16158 different commands with two or three keys per command, only to hide and show
16159 parts of the outline tree, that seemed entirely unacceptable to me.  Also,
16160 when using outlines to take notes, I constantly wanted to restructure the
16161 tree, organizing it parallel to my thoughts and plans.  @emph{Visibility
16162 cycling} and @emph{structure editing} were originally implemented in the
16163 package @file{outline-magic.el}, but quickly moved to the more general
16164 @file{org.el}.  As this environment became comfortable for project planning,
16165 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
16166 @emph{table support}.  These areas highlighted the two main goals that Org
16167 still has today: to be a new, outline-based, plain text mode with innovative
16168 and intuitive editing features, and to incorporate project planning
16169 functionality directly into a notes file.
16171 Since the first release, literally thousands of emails to me or to
16172 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
16173 reports, feedback, new ideas, and sometimes patches and add-on code.
16174 Many thanks to everyone who has helped to improve this package.  I am
16175 trying to keep here a list of the people who had significant influence
16176 in shaping one or more aspects of Org.  The list may not be
16177 complete, if I have forgotten someone, please accept my apologies and
16178 let me know.
16180 Before I get to this list, a few special mentions are in order:
16182 @table @i
16183 @item Bastien Guerry
16184 Bastien has written a large number of extensions to Org (most of them
16185 integrated into the core by now), including the LaTeX exporter and the plain
16186 list parser.  His support during the early days, when he basically acted as
16187 co-maintainer, was central to the success of this project.  Bastien also
16188 invented Worg, helped establishing the Web presence of Org, and sponsors
16189 hosting costs for the orgmode.org website.
16190 @item Eric Schulte and Dan Davison
16191 Eric and Dan are jointly responsible for the Org-babel system, which turns
16192 Org into a multi-language environment for evaluating code and doing literate
16193 programming and reproducible research.
16194 @item John Wiegley
16195 John has contributed a number of great ideas and patches directly to Org,
16196 including the attachment system (@file{org-attach.el}), integration with
16197 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
16198 items, habit tracking (@file{org-habits.el}), and encryption
16199 (@file{org-crypt.el}).  Also, the capture system is really an extended copy
16200 of his great @file{remember.el}.
16201 @item Sebastian Rose
16202 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
16203 of an ignorant amateur.  Sebastian has pushed this part of Org onto a much
16204 higher level.  He also wrote @file{org-info.js}, a Java script for displaying
16205 webpages derived from Org using an Info-like or a folding interface with
16206 single-key navigation.
16207 @end table
16209 @noindent OK, now to the full list of contributions!  Again, please let me
16210 know what I am missing here!
16212 @itemize @bullet
16214 @item
16215 @i{Russel Adams} came up with the idea for drawers.
16216 @item
16217 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
16218 @item
16219 @i{Christophe Bataillon} created the great unicorn logo that we use on the
16220 Org mode website.
16221 @item
16222 @i{Alex Bochannek} provided a patch for rounding timestamps.
16223 @item
16224 @i{Jan Böcker} wrote @file{org-docview.el}.
16225 @item
16226 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
16227 @item
16228 @i{Tom Breton} wrote @file{org-choose.el}.
16229 @item
16230 @i{Charles Cave}'s suggestion sparked the implementation of templates
16231 for Remember, which are now templates for capture.
16232 @item
16233 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
16234 specified time.
16235 @item
16236 @i{Gregory Chernov} patched support for Lisp forms into table
16237 calculations and improved XEmacs compatibility, in particular by porting
16238 @file{nouline.el} to XEmacs.
16239 @item
16240 @i{Sacha Chua} suggested copying some linking code from Planner.
16241 @item
16242 @i{Baoqiu Cui} contributed the DocBook exporter.
16243 @item
16244 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
16245 came up with the idea of properties, and that there should be an API for
16246 them.
16247 @item
16248 @i{Nick Dokos} tracked down several nasty bugs.
16249 @item
16250 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
16251 inspired some of the early development, including HTML export.  He also
16252 asked for a way to narrow wide table columns.
16253 @item
16254 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
16255 the Org-Babel documentation into the manual.
16256 @item
16257 @i{Christian Egli} converted the documentation into Texinfo format, inspired
16258 the agenda, patched CSS formatting into the HTML exporter, and wrote
16259 @file{org-taskjuggler.el}.
16260 @item
16261 @i{David Emery} provided a patch for custom CSS support in exported
16262 HTML agendas.
16263 @item
16264 @i{Nic Ferrier} contributed mailcap and XOXO support.
16265 @item
16266 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
16267 @item
16268 @i{John Foerch} figured out how to make incremental search show context
16269 around a match in a hidden outline tree.
16270 @item
16271 @i{Raimar Finken} wrote @file{org-git-line.el}.
16272 @item
16273 @i{Mikael Fornius} works as a mailing list moderator.
16274 @item
16275 @i{Austin Frank} works as a mailing list moderator.
16276 @item
16277 @i{Eric Fraga} drove the development of BEAMER export with ideas and
16278 testing.
16279 @item
16280 @i{Barry Gidden} did proofreading the manual in preparation for the book
16281 publication through Network Theory Ltd.
16282 @item
16283 @i{Niels Giesen} had the idea to automatically archive DONE trees.
16284 @item
16285 @i{Nicolas Goaziou} rewrote much of the plain list code.
16286 @item
16287 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
16288 @item
16289 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
16290 book.
16291 @item
16292 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
16293 task state change logging, and the clocktable.  His clear explanations have
16294 been critical when we started to adopt the Git version control system.
16295 @item
16296 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
16297 patches.
16298 @item
16299 @i{Phil Jackson} wrote @file{org-irc.el}.
16300 @item
16301 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
16302 folded entries, and column view for properties.
16303 @item
16304 @i{Matt Jones} wrote @i{MobileOrg Android}.
16305 @item
16306 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
16307 @item
16308 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it.  He also
16309 provided frequent feedback and some patches.
16310 @item
16311 @i{Matt Lundin} has proposed last-row references for table formulas and named
16312 invisible anchors.  He has also worked a lot on the FAQ.
16313 @item
16314 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
16315 and is a prolific contributor on the mailing list with competent replies,
16316 small fixes and patches.
16317 @item
16318 @i{Jason F. McBrayer} suggested agenda export to CSV format.
16319 @item
16320 @i{Max Mikhanosha} came up with the idea of refiling.
16321 @item
16322 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
16323 basis.
16324 @item
16325 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
16326 happy.
16327 @item
16328 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
16329 @item
16330 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
16331 and being able to quickly restrict the agenda to a subtree.
16332 @item
16333 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
16334 @item
16335 @i{Greg Newman} refreshed the unicorn logo into its current form.
16336 @item
16337 @i{Tim O'Callaghan} suggested in-file links, search options for general
16338 file links, and TAGS.
16339 @item
16340 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
16341 version of the reference card.
16342 @item
16343 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
16344 into Japanese.
16345 @item
16346 @i{Oliver Oppitz} suggested multi-state TODO items.
16347 @item
16348 @i{Scott Otterson} sparked the introduction of descriptive text for
16349 links, among other things.
16350 @item
16351 @i{Pete Phillips} helped during the development of the TAGS feature, and
16352 provided frequent feedback.
16353 @item
16354 @i{Martin Pohlack} provided the code snippet to bundle character insertion
16355 into bundles of 20 for undo.
16356 @item
16357 @i{T.V. Raman} reported bugs and suggested improvements.
16358 @item
16359 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
16360 control.
16361 @item
16362 @i{Paul Rivier} provided the basic implementation of named footnotes.  He
16363 also acted as mailing list moderator for some time.
16364 @item
16365 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
16366 @item
16367 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
16368 conflict with @file{allout.el}.
16369 @item
16370 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
16371 extensive patches.
16372 @item
16373 @i{Philip Rooke} created the Org reference card, provided lots
16374 of feedback, developed and applied standards to the Org documentation.
16375 @item
16376 @i{Christian Schlauer} proposed angular brackets around links, among
16377 other things.
16378 @item
16379 @i{Paul Sexton} wrote @file{org-ctags.el}.
16380 @item
16381 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
16382 @file{organizer-mode.el}.
16383 @item
16384 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
16385 examples, and remote highlighting for referenced code lines.
16386 @item
16387 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
16388 now packaged into Org's @file{contrib} directory.
16389 @item
16390 @i{Daniel Sinder} came up with the idea of internal archiving by locking
16391 subtrees.
16392 @item
16393 @i{Dale Smith} proposed link abbreviations.
16394 @item
16395 @i{James TD Smith} has contributed a large number of patches for useful
16396 tweaks and features.
16397 @item
16398 @i{Adam Spiers} asked for global linking commands, inspired the link
16399 extension system, added support for mairix, and proposed the mapping API.
16400 @item
16401 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
16402 LaTeX, UTF-8, Latin-1 and ASCII.
16403 @item
16404 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
16405 with links transformation to Org syntax.
16406 @item
16407 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
16408 chapter about publishing.
16409 @item
16410 @i{Jambunathan K} contributed the @acronym{ODT} exporter.
16411 @item
16412 @i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and
16413 enabled source code highlighling in Gnus.
16414 @item
16415 @i{Stefan Vollmar} organized a video-recorded talk at the
16416 Max-Planck-Institute for Neurology.  He also inspired the creation of a
16417 concept index for HTML export.
16418 @item
16419 @i{J@"urgen Vollmer} contributed code generating the table of contents
16420 in HTML output.
16421 @item
16422 @i{Samuel Wales} has provided important feedback and bug reports.
16423 @item
16424 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
16425 keyword.
16426 @item
16427 @i{David Wainberg} suggested archiving, and improvements to the linking
16428 system.
16429 @item
16430 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
16431 linking to Gnus.
16432 @item
16433 @i{Roland Winkler} requested additional key bindings to make Org
16434 work on a tty.
16435 @item
16436 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
16437 and contributed various ideas and code snippets.
16438 @item
16439 @end itemize
16442 @node Main Index, Key Index, History and Acknowledgments, Top
16443 @unnumbered Concept index
16445 @printindex cp
16447 @node Key Index, Command and Function Index, Main Index, Top
16448 @unnumbered Key index
16450 @printindex ky
16452 @node Command and Function Index, Variable Index, Key Index, Top
16453 @unnumbered Command and function index
16455 @printindex fn
16457 @node Variable Index,  , Command and Function Index, Top
16458 @unnumbered Variable index
16460 This is not a complete index of variables and faces, only the ones that are
16461 mentioned in the manual.  For a more complete list, use @kbd{M-x
16462 org-customize @key{RET}} and then click yourself through the tree.
16464 @printindex vr
16466 @bye
16468 @c Local variables:
16469 @c fill-column: 77
16470 @c indent-tabs-mode: nil
16471 @c paragraph-start:    "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[  ]*$"
16472 @c paragraph-separate: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[       \f]*$"
16473 @c End:
16476 @c  LocalWords:  webdavhost pre