org.texi: Remove outdated footnote
[org-mode.git] / doc / org.texi
blobb22898bbef5504c120a41fb7e4e1a641fd2622b6
1 \input texinfo
2 @c %**start of header
3 @setfilename ../../info/org
4 @settitle The Org Manual
6 @include org-version.inc
8 @c Version and Contact Info
9 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page}
10 @set AUTHOR Carsten Dominik
11 @set MAINTAINER Carsten Dominik
12 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
13 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
14 @documentencoding UTF-8
15 @c %**end of header
16 @finalout
19 @c -----------------------------------------------------------------------------
21 @c Macro definitions for commands and keys
22 @c =======================================
24 @c The behavior of the key/command macros will depend on the flag cmdnames
25 @c When set, commands names are shown.  When clear, they are not shown.
27 @set cmdnames
29 @c Below we define the following macros for Org key tables:
31 @c orgkey{key}                        A key item
32 @c orgcmd{key,cmd}                    Key with command name
33 @c xorgcmd{key,cmd}                   Key with command name as @itemx
34 @c orgcmdnki{key,cmd}                 Like orgcmd, but do not index the key
35 @c orgcmdtkc{text,key,cmd}            Like orgcmd,special text instead of key
36 @c orgcmdkkc{key1,key2,cmd}           Two keys with one command name, use "or"
37 @c orgcmdkxkc{key1,key2,cmd}          Two keys with one command name, but
38 @c                                    different functions, so format as @itemx
39 @c orgcmdkskc{key1,key2,cmd}          Same as orgcmdkkc, but use "or short"
40 @c xorgcmdkskc{key1,key2,cmd}         Same as previous, but use @itemx
41 @c orgcmdkkcc{key1,key2,cmd1,cmd2}    Two keys and two commands
43 @c a key but no command
44 @c    Inserts:    @item key
45 @macro orgkey{key}
46 @kindex \key\
47 @item @kbd{\key\}
48 @end macro
50 @macro xorgkey{key}
51 @kindex \key\
52 @itemx @kbd{\key\}
53 @end macro
55 @c one key with a command
56 @c   Inserts:    @item KEY               COMMAND
57 @macro orgcmd{key,command}
58 @ifset cmdnames
59 @kindex \key\
60 @findex \command\
61 @iftex
62 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
63 @end iftex
64 @ifnottex
65 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
66 @end ifnottex
67 @end ifset
68 @ifclear cmdnames
69 @kindex \key\
70 @item @kbd{\key\}
71 @end ifclear
72 @end macro
74 @c One key with one command, formatted using @itemx
75 @c   Inserts:    @itemx KEY               COMMAND
76 @macro xorgcmd{key,command}
77 @ifset cmdnames
78 @kindex \key\
79 @findex \command\
80 @iftex
81 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
82 @end iftex
83 @ifnottex
84 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
85 @end ifnottex
86 @end ifset
87 @ifclear cmdnames
88 @kindex \key\
89 @itemx @kbd{\key\}
90 @end ifclear
91 @end macro
93 @c one key with a command, bit do not index the key
94 @c   Inserts:    @item KEY               COMMAND
95 @macro orgcmdnki{key,command}
96 @ifset cmdnames
97 @findex \command\
98 @iftex
99 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
100 @end iftex
101 @ifnottex
102 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
103 @end ifnottex
104 @end ifset
105 @ifclear cmdnames
106 @item @kbd{\key\}
107 @end ifclear
108 @end macro
110 @c one key with a command, and special text to replace key in item
111 @c   Inserts:    @item TEXT                    COMMAND
112 @macro orgcmdtkc{text,key,command}
113 @ifset cmdnames
114 @kindex \key\
115 @findex \command\
116 @iftex
117 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
118 @end iftex
119 @ifnottex
120 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
121 @end ifnottex
122 @end ifset
123 @ifclear cmdnames
124 @kindex \key\
125 @item @kbd{\text\}
126 @end ifclear
127 @end macro
129 @c two keys with one command
130 @c   Inserts:    @item KEY1 or KEY2            COMMAND
131 @macro orgcmdkkc{key1,key2,command}
132 @ifset cmdnames
133 @kindex \key1\
134 @kindex \key2\
135 @findex \command\
136 @iftex
137 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
138 @end iftex
139 @ifnottex
140 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
141 @end ifnottex
142 @end ifset
143 @ifclear cmdnames
144 @kindex \key1\
145 @kindex \key2\
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
147 @end ifclear
148 @end macro
150 @c Two keys with one command name, but different functions, so format as
151 @c @itemx
152 @c   Inserts:    @item KEY1
153 @c               @itemx KEY2                COMMAND
154 @macro orgcmdkxkc{key1,key2,command}
155 @ifset cmdnames
156 @kindex \key1\
157 @kindex \key2\
158 @findex \command\
159 @iftex
160 @item @kbd{\key1\}
161 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
162 @end iftex
163 @ifnottex
164 @item @kbd{\key1\}
165 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
166 @end ifnottex
167 @end ifset
168 @ifclear cmdnames
169 @kindex \key1\
170 @kindex \key2\
171 @item @kbd{\key1\}
172 @itemx @kbd{\key2\}
173 @end ifclear
174 @end macro
176 @c Same as previous, but use "or short"
177 @c   Inserts:    @item KEY1 or short KEY2            COMMAND
178 @macro orgcmdkskc{key1,key2,command}
179 @ifset cmdnames
180 @kindex \key1\
181 @kindex \key2\
182 @findex \command\
183 @iftex
184 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
185 @end iftex
186 @ifnottex
187 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
188 @end ifnottex
189 @end ifset
190 @ifclear cmdnames
191 @kindex \key1\
192 @kindex \key2\
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
194 @end ifclear
195 @end macro
197 @c Same as previous, but use @itemx
198 @c   Inserts:    @itemx KEY1 or short KEY2            COMMAND
199 @macro xorgcmdkskc{key1,key2,command}
200 @ifset cmdnames
201 @kindex \key1\
202 @kindex \key2\
203 @findex \command\
204 @iftex
205 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
206 @end iftex
207 @ifnottex
208 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
209 @end ifnottex
210 @end ifset
211 @ifclear cmdnames
212 @kindex \key1\
213 @kindex \key2\
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
215 @end ifclear
216 @end macro
218 @c two keys with two commands
219 @c   Inserts:    @item KEY1                        COMMAND1
220 @c               @itemx KEY2                       COMMAND2
221 @macro orgcmdkkcc{key1,key2,command1,command2}
222 @ifset cmdnames
223 @kindex \key1\
224 @kindex \key2\
225 @findex \command1\
226 @findex \command2\
227 @iftex
228 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
229 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
230 @end iftex
231 @ifnottex
232 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
233 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
234 @end ifnottex
235 @end ifset
236 @ifclear cmdnames
237 @kindex \key1\
238 @kindex \key2\
239 @item @kbd{\key1\}
240 @itemx @kbd{\key2\}
241 @end ifclear
242 @end macro
243 @c -----------------------------------------------------------------------------
245 @iftex
246 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
247 @end iftex
249 @c Subheadings inside a table.
250 @macro tsubheading{text}
251 @ifinfo
252 @subsubheading \text\
253 @end ifinfo
254 @ifnotinfo
255 @item @b{\text\}
256 @end ifnotinfo
257 @end macro
259 @copying
260 This manual is for Org version @value{VERSION}.
262 Copyright @copyright{} 2004--2014 Free Software Foundation, Inc.
264 @quotation
265 Permission is granted to copy, distribute and/or modify this document
266 under the terms of the GNU Free Documentation License, Version 1.3 or
267 any later version published by the Free Software Foundation; with no
268 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
269 and with the Back-Cover Texts as in (a) below.  A copy of the license
270 is included in the section entitled ``GNU Free Documentation License.''
272 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
273 modify this GNU manual.''
274 @end quotation
275 @end copying
277 @dircategory Emacs editing modes
278 @direntry
279 * Org Mode: (org).      Outline-based notes management and organizer
280 @end direntry
282 @titlepage
283 @title The Org Manual
285 @subtitle Release @value{VERSION}
286 @author by Carsten Dominik
287 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan
288 Davison, Eric Schulte, Thomas Dye, Jambunathan K and Nicolas Goaziou.
290 @c The following two commands start the copyright page.
291 @page
292 @vskip 0pt plus 1filll
293 @insertcopying
294 @end titlepage
296 @c Output the table of contents at the beginning.
297 @contents
299 @ifnottex
300 @c FIXME These hand-written next,prev,up node pointers make editing a lot
301 @c harder.  There should be no need for them, makeinfo can do it
302 @c automatically for any document with a normal structure.
303 @node Top, Introduction, (dir), (dir)
304 @top Org Mode Manual
306 @insertcopying
307 @end ifnottex
309 @menu
310 * Introduction::                Getting started
311 * Document Structure::          A tree works like your brain
312 * Tables::                      Pure magic for quick formatting
313 * Hyperlinks::                  Notes in context
314 * TODO Items::                  Every tree branch can be a TODO item
315 * Tags::                        Tagging headlines and matching sets of tags
316 * Properties and Columns::      Storing information about an entry
317 * Dates and Times::             Making items useful for planning
318 * Capture - Refile - Archive::  The ins and outs for projects
319 * Agenda Views::                Collecting information into views
320 * Markup::                      Prepare text for rich export
321 * Exporting::                   Sharing and publishing notes
322 * Publishing::                  Create a web site of linked Org files
323 * Working With Source Code::    Export, evaluate, and tangle code blocks
324 * Miscellaneous::               All the rest which did not fit elsewhere
325 * Hacking::                     How to hack your way around
326 * MobileOrg::                   Viewing and capture on a mobile device
327 * History and Acknowledgments::  How Org came into being
328 * GNU Free Documentation License::  The license for this documentation.
329 * Main Index::                  An index of Org's concepts and features
330 * Key Index::                   Key bindings and where they are described
331 * Command and Function Index::  Command names and some internal functions
332 * Variable Index::              Variables mentioned in the manual
334 @detailmenu
335  --- The Detailed Node Listing ---
337 Introduction
339 * Summary::                     Brief summary of what Org does
340 * Installation::                Installing Org
341 * Activation::                  How to activate Org for certain buffers
342 * Feedback::                    Bug reports, ideas, patches etc.
343 * Conventions::                 Typesetting conventions in the manual
345 Document structure
347 * Outlines::                    Org is based on Outline mode
348 * Headlines::                   How to typeset Org tree headlines
349 * Visibility cycling::          Show and hide, much simplified
350 * Motion::                      Jumping to other headlines
351 * Structure editing::           Changing sequence and level of headlines
352 * Sparse trees::                Matches embedded in context
353 * Plain lists::                 Additional structure within an entry
354 * Drawers::                     Tucking stuff away
355 * Blocks::                      Folding blocks
356 * Footnotes::                   How footnotes are defined in Org's syntax
357 * Orgstruct mode::              Structure editing outside Org
358 * Org syntax::                  Formal description of Org's syntax
360 Visibility cycling
362 * Global and local cycling::    Cycling through various visibility states
363 * Initial visibility::          Setting the initial visibility state
364 * Catching invisible edits::    Preventing mistakes when editing invisible parts
366 Global and local cycling
368 * Initial visibility::          Setting the initial visibility state
369 * Catching invisible edits::    Preventing mistakes when editing invisible parts
371 Tables
373 * Built-in table editor::       Simple tables
374 * Column width and alignment::  Overrule the automatic settings
375 * Column groups::               Grouping to trigger vertical lines
376 * Orgtbl mode::                 The table editor as minor mode
377 * The spreadsheet::             The table editor has spreadsheet capabilities
378 * Org-Plot::                    Plotting from org tables
380 The spreadsheet
382 * References::                  How to refer to another field or range
383 * Formula syntax for Calc::     Using Calc to compute stuff
384 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
385 * Durations and time values::   How to compute durations and time values
386 * Field and range formulas::    Formula for specific (ranges of) fields
387 * Column formulas::             Formulas valid for an entire column
388 * Lookup functions::            Lookup functions for searching tables
389 * Editing and debugging formulas::  Fixing formulas
390 * Updating the table::          Recomputing all dependent fields
391 * Advanced features::           Field and column names, parameters and automatic recalc
393 Hyperlinks
395 * Link format::                 How links in Org are formatted
396 * Internal links::              Links to other places in the current file
397 * External links::              URL-like links to the world
398 * Handling links::              Creating, inserting and following
399 * Using links outside Org::     Linking from my C source code?
400 * Link abbreviations::          Shortcuts for writing complex links
401 * Search options::              Linking to a specific location
402 * Custom searches::             When the default search is not enough
404 Internal links
406 * Radio targets::               Make targets trigger links in plain text
408 TODO items
410 * TODO basics::                 Marking and displaying TODO entries
411 * TODO extensions::             Workflow and assignments
412 * Progress logging::            Dates and notes for progress
413 * Priorities::                  Some things are more important than others
414 * Breaking down tasks::         Splitting a task into manageable pieces
415 * Checkboxes::                  Tick-off lists
417 Extended use of TODO keywords
419 * Workflow states::             From TODO to DONE in steps
420 * TODO types::                  I do this, Fred does the rest
421 * Multiple sets in one file::   Mixing it all, and still finding your way
422 * Fast access to TODO states::  Single letter selection of a state
423 * Per-file keywords::           Different files, different requirements
424 * Faces for TODO keywords::     Highlighting states
425 * TODO dependencies::           When one task needs to wait for others
427 Progress logging
429 * Closing items::               When was this entry marked DONE?
430 * Tracking TODO state changes::  When did the status change?
431 * Tracking your habits::        How consistent have you been?
433 Tags
435 * Tag inheritance::             Tags use the tree structure of the outline
436 * Setting tags::                How to assign tags to a headline
437 * Tag groups::                  Use one tag to search for several tags
438 * Tag searches::                Searching for combinations of tags
440 Properties and columns
442 * Property syntax::             How properties are spelled out
443 * Special properties::          Access to other Org mode features
444 * Property searches::           Matching property values
445 * Property inheritance::        Passing values down the tree
446 * Column view::                 Tabular viewing and editing
447 * Property API::                Properties for Lisp programmers
449 Column view
451 * Defining columns::            The COLUMNS format property
452 * Using column view::           How to create and use column view
453 * Capturing column view::       A dynamic block for column view
455 Defining columns
457 * Scope of column definitions::  Where defined, where valid?
458 * Column attributes::           Appearance and content of a column
460 Dates and times
462 * Timestamps::                  Assigning a time to a tree entry
463 * Creating timestamps::         Commands which insert timestamps
464 * Deadlines and scheduling::    Planning your work
465 * Clocking work time::          Tracking how long you spend on a task
466 * Effort estimates::            Planning work effort in advance
467 * Relative timer::              Notes with a running timer
468 * Countdown timer::             Starting a countdown timer for a task
470 Creating timestamps
472 * The date/time prompt::        How Org mode helps you entering date and time
473 * Custom time format::          Making dates look different
475 Deadlines and scheduling
477 * Inserting deadline/schedule::  Planning items
478 * Repeated tasks::              Items that show up again and again
480 Clocking work time
482 * Clocking commands::           Starting and stopping a clock
483 * The clock table::             Detailed reports
484 * Resolving idle time::         Resolving time when you've been idle
486 Capture - Refile - Archive
488 * Capture::                     Capturing new stuff
489 * Attachments::                 Add files to tasks
490 * RSS Feeds::                   Getting input from RSS feeds
491 * Protocols::                   External (e.g., Browser) access to Emacs and Org
492 * Refile and copy::             Moving/copying a tree from one place to another
493 * Archiving::                   What to do with finished projects
495 Capture
497 * Setting up capture::          Where notes will be stored
498 * Using capture::               Commands to invoke and terminate capture
499 * Capture templates::           Define the outline of different note types
501 Capture templates
503 * Template elements::           What is needed for a complete template entry
504 * Template expansion::          Filling in information about time and context
505 * Templates in contexts::       Only show a template in a specific context
507 Archiving
509 * Moving subtrees::             Moving a tree to an archive file
510 * Internal archiving::          Switch off a tree but keep it in the file
512 Agenda views
514 * Agenda files::                Files being searched for agenda information
515 * Agenda dispatcher::           Keyboard access to agenda views
516 * Built-in agenda views::       What is available out of the box?
517 * Presentation and sorting::    How agenda items are prepared for display
518 * Agenda commands::             Remote editing of Org trees
519 * Custom agenda views::         Defining special searches and views
520 * Exporting Agenda Views::      Writing a view to a file
521 * Agenda column view::          Using column view for collected entries
523 The built-in agenda views
525 * Weekly/daily agenda::         The calendar page with current tasks
526 * Global TODO list::            All unfinished action items
527 * Matching tags and properties::  Structured information with fine-tuned search
528 * Timeline::                    Time-sorted view for single file
529 * Search view::                 Find entries by searching for text
530 * Stuck projects::              Find projects you need to review
532 Presentation and sorting
534 * Categories::                  Not all tasks are equal
535 * Time-of-day specifications::  How the agenda knows the time
536 * Sorting agenda items::        The order of things
537 * Filtering/limiting agenda items::  Dynamically narrow the agenda
539 Custom agenda views
541 * Storing searches::            Type once, use often
542 * Block agenda::                All the stuff you need in a single buffer
543 * Setting Options::             Changing the rules
545 Markup for rich export
547 * Structural markup elements::  The basic structure as seen by the exporter
548 * Images and tables::           Images, tables and caption mechanism
549 * Literal examples::            Source code examples with special formatting
550 * Include files::               Include additional files into a document
551 * Index entries::               Making an index
552 * Macro replacement::           Use macros to create templates
553 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
554 * Special blocks::              Containers targeted at export back-ends
556 Structural markup elements
558 * Document title::              Where the title is taken from
559 * Headings and sections::       The document structure as seen by the exporter
560 * Table of contents::           The if and where of the table of contents
561 * Lists::                       Lists
562 * Paragraphs::                  Paragraphs
563 * Footnote markup::             Footnotes
564 * Emphasis and monospace::      Bold, italic, etc.
565 * Horizontal rules::            Make a line
566 * Comment lines::               What will *not* be exported
568 Embedded @LaTeX{}
570 * Special symbols::             Greek letters and other symbols
571 * Subscripts and superscripts::  Simple syntax for raising/lowering text
572 * @LaTeX{} fragments::          Complex formulas made easy
573 * Previewing @LaTeX{} fragments::  What will this snippet look like?
574 * CDLaTeX mode::                Speed up entering of formulas
576 Exporting
578 * The Export Dispatcher::       The main exporter interface
579 * Export back-ends::            Built-in export formats
580 * Export settings::             Generic export settings
581 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
582 * Beamer export::               Exporting as a Beamer presentation
583 * HTML export::                 Exporting to HTML
584 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
585 * Markdown export::             Exporting to Markdown
586 * OpenDocument Text export::    Exporting to OpenDocument Text
587 * Org export::                  Exporting to Org
588 * Texinfo export::              Exporting to Texinfo
589 * iCalendar export::            Exporting to iCalendar
590 * Other built-in back-ends::    Exporting to a man page
591 * Export in foreign buffers::   Author tables and lists in Org syntax
592 * Advanced configuration::      Fine-tuning the export output
594 HTML export
596 * HTML Export commands::        How to invoke HTML export
597 * HTML doctypes::               Org can export to various (X)HTML flavors
598 * HTML preamble and postamble::  How to insert a preamble and a postamble
599 * Quoting HTML tags::           Using direct HTML in Org mode
600 * Links in HTML export::        How links will be interpreted and formatted
601 * Tables in HTML export::       How to modify the formatting of tables
602 * Images in HTML export::       How to insert figures into HTML output
603 * Math formatting in HTML export::  Beautiful math also on the web
604 * Text areas in HTML export::   An alternative way to show an example
605 * CSS support::                 Changing the appearance of the output
606 * JavaScript support::          Info and Folding in a web browser
608 @LaTeX{} and PDF export
610 * @LaTeX{} export commands::    How to export to LaTeX and PDF
611 * Header and sectioning::       Setting up the export file structure
612 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
613 * @LaTeX{} specific attributes::  Controlling @LaTeX{} output
615 OpenDocument Text export
617 * Pre-requisites for ODT export::  What packages ODT exporter relies on
618 * ODT export commands::         How to invoke ODT export
619 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
620 * Applying custom styles::      How to apply custom styles to the output
621 * Links in ODT export::         How links will be interpreted and formatted
622 * Tables in ODT export::        How Tables are exported
623 * Images in ODT export::        How to insert images
624 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
625 * Labels and captions in ODT export::  How captions are rendered
626 * Literal examples in ODT export::  How source and example blocks are formatted
627 * Advanced topics in ODT export::  Read this if you are a power user
629 Math formatting in ODT export
631 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
632 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
634 Advanced topics in ODT export
636 * Configuring a document converter::  How to register a document converter
637 * Working with OpenDocument style files::  Explore the internals
638 * Creating one-off styles::     How to produce custom highlighting etc
639 * Customizing tables in ODT export::  How to define and use Table templates
640 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
642 Texinfo export
644 * Texinfo export commands::     How to invoke Texinfo export
645 * Document preamble::           File header, title and copyright page
646 * Headings and sectioning structure:: Building document structure
647 * Indices::                     Creating indices
648 * Quoting Texinfo code::        Incorporating literal Texinfo code
649 * Texinfo specific attributes:: Controlling Texinfo output
650 * An example::
652 Publishing
654 * Configuration::               Defining projects
655 * Uploading files::             How to get files up on the server
656 * Sample configuration::        Example projects
657 * Triggering publication::      Publication commands
659 Configuration
661 * Project alist::               The central configuration variable
662 * Sources and destinations::    From here to there
663 * Selecting files::             What files are part of the project?
664 * Publishing action::           Setting the function doing the publishing
665 * Publishing options::          Tweaking HTML/@LaTeX{} export
666 * Publishing links::            Which links keep working after publishing?
667 * Sitemap::                     Generating a list of all pages
668 * Generating an index::         An index that reaches across pages
670 Sample configuration
672 * Simple example::              One-component publishing
673 * Complex example::             A multi-component publishing example
675 Working with source code
677 * Structure of code blocks::    Code block syntax described
678 * Editing source code::         Language major-mode editing
679 * Exporting code blocks::       Export contents and/or results
680 * Extracting source code::      Create pure source code files
681 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
682 * Library of Babel::            Use and contribute to a library of useful code blocks
683 * Languages::                   List of supported code block languages
684 * Header arguments::            Configure code block functionality
685 * Results of evaluation::       How evaluation results are handled
686 * Noweb reference syntax::      Literate programming in Org mode
687 * Key bindings and useful functions::  Work quickly with code blocks
688 * Batch execution::             Call functions from the command line
690 Header arguments
692 * Using header arguments::      Different ways to set header arguments
693 * Specific header arguments::   List of header arguments
695 Using header arguments
697 * System-wide header arguments::  Set global default values
698 * Language-specific header arguments::  Set default values by language
699 * Header arguments in Org mode properties::  Set default values for a buffer or heading
700 * Language-specific header arguments in Org mode properties::  Set language-specific default values for a buffer or heading
701 * Code block specific header arguments::  The most common way to set values
702 * Header arguments in function calls::  The most specific level
704 Specific header arguments
706 * var::                         Pass arguments to code blocks
707 * results::                     Specify the type of results and how they will
708                                 be collected and handled
709 * file::                        Specify a path for file output
710 * file-desc::                   Specify a description for file results
711 * dir::                         Specify the default (possibly remote)
712                                 directory for code block execution
713 * exports::                     Export code and/or results
714 * tangle::                      Toggle tangling and specify file name
715 * mkdirp::                      Toggle creation of parent directories of target
716                                 files during tangling
717 * comments::                    Toggle insertion of comments in tangled
718                                 code files
719 * padline::                     Control insertion of padding lines in tangled
720                                 code files
721 * no-expand::                   Turn off variable assignment and noweb
722                                 expansion during tangling
723 * session::                     Preserve the state of code evaluation
724 * noweb::                       Toggle expansion of noweb references
725 * noweb-ref::                   Specify block's noweb reference resolution target
726 * noweb-sep::                   String used to separate noweb references
727 * cache::                       Avoid re-evaluating unchanged code blocks
728 * sep::                         Delimiter for writing tabular results outside Org
729 * hlines::                      Handle horizontal lines in tables
730 * colnames::                    Handle column names in tables
731 * rownames::                    Handle row names in tables
732 * shebang::                     Make tangled files executable
733 * tangle-mode::                 Set permission of tangled files
734 * eval::                        Limit evaluation of specific code blocks
735 * wrap::                        Mark source block evaluation results
736 * post::                        Post processing of code block results
737 * prologue::                    Text to prepend to code block body
738 * epilogue::                    Text to append to code block body
740 Miscellaneous
742 * Completion::                  M-TAB knows what you need
743 * Easy Templates::              Quick insertion of structural elements
744 * Speed keys::                  Electric commands at the beginning of a headline
745 * Code evaluation security::    Org mode files evaluate inline code
746 * Customization::               Adapting Org to your taste
747 * In-buffer settings::          Overview of the #+KEYWORDS
748 * The very busy C-c C-c key::   When in doubt, press C-c C-c
749 * Clean view::                  Getting rid of leading stars in the outline
750 * TTY keys::                    Using Org on a tty
751 * Interaction::                 Other Emacs packages
752 * org-crypt::                   Encrypting Org files
754 Interaction with other packages
756 * Cooperation::                 Packages Org cooperates with
757 * Conflicts::                   Packages that lead to conflicts
759 Hacking
761 * Hooks::                       How to reach into Org's internals
762 * Add-on packages::             Available extensions
763 * Adding hyperlink types::      New custom link types
764 * Adding export back-ends::     How to write new export back-ends
765 * Context-sensitive commands::  How to add functionality to such commands
766 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
767 * Dynamic blocks::              Automatically filled blocks
768 * Special agenda views::        Customized views
769 * Speeding up your agendas::    Tips on how to speed up your agendas
770 * Extracting agenda information::  Post-processing of agenda information
771 * Using the property API::      Writing programs that use entry properties
772 * Using the mapping API::       Mapping over all or selected entries
774 Tables and lists in arbitrary syntax
776 * Radio tables::                Sending and receiving radio tables
777 * A @LaTeX{} example::          Step by step, almost a tutorial
778 * Translator functions::        Copy and modify
779 * Radio lists::                 Sending and receiving lists
781 MobileOrg
783 * Setting up the staging area::  Where to interact with the mobile device
784 * Pushing to MobileOrg::        Uploading Org files and agendas
785 * Pulling from MobileOrg::      Integrating captured and flagged items
787 @end detailmenu
788 @end menu
790 @node Introduction, Document Structure, Top, Top
791 @chapter Introduction
792 @cindex introduction
794 @menu
795 * Summary::                     Brief summary of what Org does
796 * Installation::                Installing Org
797 * Activation::                  How to activate Org for certain buffers
798 * Feedback::                    Bug reports, ideas, patches etc.
799 * Conventions::                 Typesetting conventions in the manual
800 @end menu
802 @node Summary, Installation, Introduction, Introduction
803 @section Summary
804 @cindex summary
806 Org is a mode for keeping notes, maintaining TODO lists, and doing
807 project planning with a fast and effective plain-text system.
809 Org develops organizational tasks around NOTES files that contain
810 lists or information about projects as plain text.  Org is
811 implemented on top of Outline mode, which makes it possible to keep the
812 content of large files well structured.  Visibility cycling and
813 structure editing help to work with the tree.  Tables are easily created
814 with a built-in table editor.  Org supports TODO items, deadlines,
815 timestamps, and scheduling.  It dynamically compiles entries into an
816 agenda that utilizes and smoothly integrates much of the Emacs calendar
817 and diary.  Plain text URL-like links connect to websites, emails,
818 Usenet messages, BBDB entries, and any files related to the projects.
819 For printing and sharing notes, an Org file can be exported as a
820 structured ASCII file, as HTML, or (TODO and agenda items only) as an
821 iCalendar file.  It can also serve as a publishing tool for a set of
822 linked web pages.
824 As a project planning environment, Org works by adding metadata to outline
825 nodes.  Based on this data, specific entries can be extracted in queries and
826 create dynamic @i{agenda views}.
828 Org mode contains the Org Babel environment which allows you to work with
829 embedded source code blocks in a file, to facilitate code evaluation,
830 documentation, and literate programming techniques.
832 Org's automatic, context-sensitive table editor with spreadsheet
833 capabilities can be integrated into any major mode by activating the
834 minor Orgtbl mode.  Using a translation step, it can be used to maintain
835 tables in arbitrary file types, for example in @LaTeX{}.  The structure
836 editing and list creation capabilities can be used outside Org with
837 the minor Orgstruct mode.
839 Org keeps simple things simple.  When first fired up, it should
840 feel like a straightforward, easy to use outliner.  Complexity is not
841 imposed, but a large amount of functionality is available when you need
842 it.  Org is a toolbox and can be used in different ways and for different
843 ends, for example:
845 @example
846 @r{@bullet{} an outline extension with visibility cycling and structure editing}
847 @r{@bullet{} an ASCII system and table editor for taking structured notes}
848 @r{@bullet{} a TODO list editor}
849 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
850 @pindex GTD, Getting Things Done
851 @r{@bullet{} an environment in which to implement David Allen's GTD system}
852 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
853 @r{@bullet{} a publishing tool to create a set of interlinked web pages}
854 @r{@bullet{} an environment for literate programming}
855 @end example
857 @cindex FAQ
858 There is a website for Org which provides links to the newest
859 version of Org, as well as additional information, frequently asked
860 questions (FAQ), links to tutorials, etc.  This page is located at
861 @uref{http://orgmode.org}.
863 @cindex print edition
864 The version 7.3 of this manual is available as a
865 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
866 Theory Ltd.}
868 @page
871 @node Installation, Activation, Summary, Introduction
872 @section Installation
873 @cindex installation
874 @cindex XEmacs
876 Org is part of recent distributions of GNU Emacs, so you normally don't need
877 to install it.  If, for one reason or another, you want to install Org on top
878 of this pre-packaged version, there are three ways to do it:
880 @itemize @bullet
881 @item By using Emacs package system.
882 @item By downloading Org as an archive.
883 @item By using Org's git repository.
884 @end itemize
886 We @b{strongly recommend} to stick to a single installation method.
888 @subsubheading Using Emacs packaging system
890 Recent Emacs distributions include a packaging system which lets you install
891 Elisp libraries.  You can install Org with @kbd{M-x package-install RET org}.
893 @noindent @b{Important}: you need to do this in a session where no @code{.org} file has
894 been visited, i.e. where no Org built-in function have been loaded.
895 Otherwise autoload Org functions will mess up the installation.
897 Then, to make sure your Org configuration is taken into account, initialize
898 the package system with @code{(package-initialize)} in your @file{.emacs}
899 before setting any Org option.  If you want to use Org's package repository,
900 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
902 @subsubheading Downloading Org as an archive
904 You can download Org latest release from @uref{http://orgmode.org/, Org's
905 website}.  In this case, make sure you set the load-path correctly in your
906 @file{.emacs}:
908 @lisp
909 (add-to-list 'load-path "~/path/to/orgdir/lisp")
910 @end lisp
912 The downloaded archive contains contributed libraries that are not included
913 in Emacs.  If you want to use them, add the @file{contrib} directory to your
914 load-path:
916 @lisp
917 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
918 @end lisp
920 Optionally, you can compile the files and/or install them in your system.
921 Run @code{make help} to list compilation and installation options.
923 @subsubheading Using Org's git repository
925 You can clone Org's repository and install Org like this:
927 @example
928 $ cd ~/src/
929 $ git clone git://orgmode.org/org-mode.git
930 $ make autoloads
931 @end example
933 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
934 version in @file{org-version.el} and Org's autoloads in
935 @file{org-loaddefs.el}.
937 Remember to add the correct load-path as described in the method above.
939 You can also compile with @code{make}, generate the documentation with
940 @code{make doc}, create a local configuration with @code{make config} and
941 install Org with @code{make install}.  Please run @code{make help} to get
942 the list of compilation/installation options.
944 For more detailed explanations on Org's build system, please check the Org
945 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
946 Worg}.
948 @node Activation, Feedback, Installation, Introduction
949 @section Activation
950 @cindex activation
951 @cindex autoload
952 @cindex ELPA
953 @cindex global key bindings
954 @cindex key bindings, global
955 @findex org-agenda
956 @findex org-capture
957 @findex org-store-link
958 @findex org-iswitchb
960 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
961 default.  If you are using an earlier version of Emacs, add this line to your
962 @file{.emacs} file:
964 @lisp
965 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
966 @end lisp
968 Org mode buffers need font-lock to be turned on: this is the default in
969 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
970 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
972 There are compatibility issues between Org mode and some other Elisp
973 packages, please take the time to check the list (@pxref{Conflicts}).
975 The four Org commands @command{org-store-link}, @command{org-capture},
976 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
977 global keys (i.e., anywhere in Emacs, not just in Org buffers).  Here are
978 suggested bindings for these keys, please modify the keys to your own
979 liking.
980 @lisp
981 (global-set-key "\C-cl" 'org-store-link)
982 (global-set-key "\C-cc" 'org-capture)
983 (global-set-key "\C-ca" 'org-agenda)
984 (global-set-key "\C-cb" 'org-iswitchb)
985 @end lisp
987 @cindex Org mode, turning on
988 With this setup, all files with extension @samp{.org} will be put
989 into Org mode.  As an alternative, make the first line of a file look
990 like this:
992 @example
993 MY PROJECTS    -*- mode: org; -*-
994 @end example
996 @vindex org-insert-mode-line-in-empty-file
997 @noindent which will select Org mode for this buffer no matter what
998 the file's name is.  See also the variable
999 @code{org-insert-mode-line-in-empty-file}.
1001 Many commands in Org work on the region if the region is @i{active}.  To make
1002 use of this, you need to have @code{transient-mark-mode}
1003 (@code{zmacs-regions} in XEmacs) turned on.  In Emacs 23 this is the default,
1004 in Emacs 22 you need to do this yourself with
1005 @lisp
1006 (transient-mark-mode 1)
1007 @end lisp
1008 @noindent If you do not like @code{transient-mark-mode}, you can create an
1009 active region by using the mouse to select a region, or pressing
1010 @kbd{C-@key{SPC}} twice before moving the cursor.
1012 @node Feedback, Conventions, Activation, Introduction
1013 @section Feedback
1014 @cindex feedback
1015 @cindex bug reports
1016 @cindex maintainer
1017 @cindex author
1019 If you find problems with Org, or if you have questions, remarks, or ideas
1020 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1021 If you are not a member of the mailing list, your mail will be passed to the
1022 list after a moderator has approved it@footnote{Please consider subscribing
1023 to the mailing list, in order to minimize the work the mailing list
1024 moderators have to do.}.
1026 For bug reports, please first try to reproduce the bug with the latest
1027 version of Org available---if you are running an outdated version, it is
1028 quite possible that the bug has been fixed already.  If the bug persists,
1029 prepare a report and provide as much information as possible, including the
1030 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1031 (@kbd{M-x org-version RET}), as well as the Org related setup in
1032 @file{.emacs}.  The easiest way to do this is to use the command
1033 @example
1034 @kbd{M-x org-submit-bug-report RET}
1035 @end example
1036 @noindent which will put all this information into an Emacs mail buffer so
1037 that you only need to add your description.  If you re not sending the Email
1038 from within Emacs, please copy and paste the content into your Email program.
1040 Sometimes you might face a problem due to an error in your Emacs or Org mode
1041 setup.  Before reporting a bug, it is very helpful to start Emacs with minimal
1042 customizations and reproduce the problem.  Doing so often helps you determine
1043 if the problem is with your customization or with Org mode itself.  You can
1044 start a typical minimal session with a command like the example below.
1046 @example
1047 $ emacs -Q -l /path/to/minimal-org.el
1048 @end example
1050 However if you are using Org mode as distributed with Emacs, a minimal setup
1051 is not necessary.  In that case it is sufficient to start Emacs as
1052 @code{emacs -Q}.  The @code{minimal-org.el} setup file can have contents as
1053 shown below.
1055 @lisp
1056 ;;; Minimal setup to load latest `org-mode'
1058 ;; activate debugging
1059 (setq debug-on-error t
1060       debug-on-signal nil
1061       debug-on-quit nil)
1063 ;; add latest org-mode to load path
1064 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1065 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1066 @end lisp
1068 If an error occurs, a backtrace can be very useful (see below on how to
1069 create one).  Often a small example file helps, along with clear information
1070 about:
1072 @enumerate
1073 @item What exactly did you do?
1074 @item What did you expect to happen?
1075 @item What happened instead?
1076 @end enumerate
1077 @noindent Thank you for helping to improve this program.
1079 @subsubheading How to create a useful backtrace
1081 @cindex backtrace of an error
1082 If working with Org produces an error with a message you don't
1083 understand, you may have hit a bug.  The best way to report this is by
1084 providing, in addition to what was mentioned above, a @emph{backtrace}.
1085 This is information from the built-in debugger about where and how the
1086 error occurred.  Here is how to produce a useful backtrace:
1088 @enumerate
1089 @item
1090 Reload uncompiled versions of all Org mode Lisp files.  The backtrace
1091 contains much more information if it is produced with uncompiled code.
1092 To do this, use
1093 @example
1094 @kbd{C-u M-x org-reload RET}
1095 @end example
1096 @noindent
1097 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1098 menu.
1099 @item
1100 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1101 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1102 @item
1103 Do whatever you have to do to hit the error.  Don't forget to
1104 document the steps you take.
1105 @item
1106 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1107 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
1108 attach it to your bug report.
1109 @end enumerate
1111 @node Conventions,  , Feedback, Introduction
1112 @section Typesetting conventions used in this manual
1114 @subsubheading TODO keywords, tags, properties, etc.
1116 Org mainly uses three types of keywords: TODO keywords, tags and property
1117 names.  In this manual we use the following conventions:
1119 @table @code
1120 @item TODO
1121 @itemx WAITING
1122 TODO keywords are written with all capitals, even if they are
1123 user-defined.
1124 @item boss
1125 @itemx ARCHIVE
1126 User-defined tags are written in lowercase; built-in tags with special
1127 meaning are written with all capitals.
1128 @item Release
1129 @itemx PRIORITY
1130 User-defined properties are capitalized; built-in properties with
1131 special meaning are written with all capitals.
1132 @end table
1134 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1135 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1136 environment).  They are written in uppercase in the manual to enhance its
1137 readability, but you can use lowercase in your Org files@footnote{Easy
1138 templates insert lowercase keywords and Babel dynamically inserts
1139 @code{#+results}.}.
1141 @subsubheading Keybindings and commands
1142 @kindex C-c a
1143 @findex org-agenda
1144 @kindex C-c c
1145 @findex org-capture
1147 The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda}
1148 and @kbd{C-c c} for @code{org-capture}.  These are only suggestions, but the
1149 rest of the manual assumes that you are using these keybindings.
1151 Also, the manual lists both the keys and the corresponding commands for
1152 accessing a functionality.  Org mode often uses the same key for different
1153 functions, depending on context.  The command that is bound to such keys has
1154 a generic name, like @code{org-metaright}.  In the manual we will, wherever
1155 possible, give the function that is internally called by the generic command.
1156 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1157 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1158 will be listed to call @code{org-table-move-column-right}.  If you prefer,
1159 you can compile the manual without the command names by unsetting the flag
1160 @code{cmdnames} in @file{org.texi}.
1162 @node Document Structure, Tables, Introduction, Top
1163 @chapter Document structure
1164 @cindex document structure
1165 @cindex structure of document
1167 Org is based on Outline mode and provides flexible commands to
1168 edit the structure of the document.
1170 @menu
1171 * Outlines::                    Org is based on Outline mode
1172 * Headlines::                   How to typeset Org tree headlines
1173 * Visibility cycling::          Show and hide, much simplified
1174 * Motion::                      Jumping to other headlines
1175 * Structure editing::           Changing sequence and level of headlines
1176 * Sparse trees::                Matches embedded in context
1177 * Plain lists::                 Additional structure within an entry
1178 * Drawers::                     Tucking stuff away
1179 * Blocks::                      Folding blocks
1180 * Footnotes::                   How footnotes are defined in Org's syntax
1181 * Orgstruct mode::              Structure editing outside Org
1182 * Org syntax::                  Formal description of Org's syntax
1183 @end menu
1185 @node Outlines, Headlines, Document Structure, Document Structure
1186 @section Outlines
1187 @cindex outlines
1188 @cindex Outline mode
1190 Org is implemented on top of Outline mode.  Outlines allow a
1191 document to be organized in a hierarchical structure, which (at least
1192 for me) is the best representation of notes and thoughts.  An overview
1193 of this structure is achieved by folding (hiding) large parts of the
1194 document to show only the general document structure and the parts
1195 currently being worked on.  Org greatly simplifies the use of
1196 outlines by compressing the entire show/hide functionality into a single
1197 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1199 @node Headlines, Visibility cycling, Outlines, Document Structure
1200 @section Headlines
1201 @cindex headlines
1202 @cindex outline tree
1203 @vindex org-special-ctrl-a/e
1204 @vindex org-special-ctrl-k
1205 @vindex org-ctrl-k-protect-subtree
1207 Headlines define the structure of an outline tree.  The headlines in Org
1208 start with one or more stars, on the left margin@footnote{See the variables
1209 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1210 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1211 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1212 headings indented less then 30 stars.}.  For example:
1214 @example
1215 * Top level headline
1216 ** Second level
1217 *** 3rd level
1218     some text
1219 *** 3rd level
1220     more text
1222 * Another top level headline
1223 @end example
1225 @noindent Some people find the many stars too noisy and would prefer an
1226 outline that has whitespace followed by a single star as headline
1227 starters.  @ref{Clean view}, describes a setup to realize this.
1229 @vindex org-cycle-separator-lines
1230 An empty line after the end of a subtree is considered part of it and
1231 will be hidden when the subtree is folded.  However, if you leave at
1232 least two empty lines, one empty line will remain visible after folding
1233 the subtree, in order to structure the collapsed view.  See the
1234 variable @code{org-cycle-separator-lines} to modify this behavior.
1236 @node Visibility cycling, Motion, Headlines, Document Structure
1237 @section Visibility cycling
1238 @cindex cycling, visibility
1239 @cindex visibility cycling
1240 @cindex trees, visibility
1241 @cindex show hidden text
1242 @cindex hide text
1244 @menu
1245 * Global and local cycling::    Cycling through various visibility states
1246 * Initial visibility::          Setting the initial visibility state
1247 * Catching invisible edits::    Preventing mistakes when editing invisible parts
1248 @end menu
1250 @node Global and local cycling, Initial visibility, Visibility cycling, Visibility cycling
1251 @subsection Global and local cycling
1253 Outlines make it possible to hide parts of the text in the buffer.
1254 Org uses just two commands, bound to @key{TAB} and
1255 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1257 @cindex subtree visibility states
1258 @cindex subtree cycling
1259 @cindex folded, subtree visibility state
1260 @cindex children, subtree visibility state
1261 @cindex subtree, subtree visibility state
1262 @table @asis
1263 @orgcmd{@key{TAB},org-cycle}
1264 @emph{Subtree cycling}: Rotate current subtree among the states
1266 @example
1267 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1268 '-----------------------------------'
1269 @end example
1271 @vindex org-cycle-emulate-tab
1272 @vindex org-cycle-global-at-bob
1273 The cursor must be on a headline for this to work@footnote{see, however,
1274 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
1275 beginning of the buffer and the first line is not a headline, then
1276 @key{TAB} actually runs global cycling (see below)@footnote{see the
1277 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
1278 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1280 @cindex global visibility states
1281 @cindex global cycling
1282 @cindex overview, global visibility state
1283 @cindex contents, global visibility state
1284 @cindex show all, global visibility state
1285 @orgcmd{S-@key{TAB},org-global-cycle}
1286 @itemx C-u @key{TAB}
1287 @emph{Global cycling}: Rotate the entire buffer among the states
1289 @example
1290 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1291 '--------------------------------------'
1292 @end example
1294 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1295 CONTENTS view up to headlines of level N will be shown.  Note that inside
1296 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1298 @cindex set startup visibility, command
1299 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1300 Switch back to the startup visibility of the buffer (@pxref{Initial visibility}).
1301 @cindex show all, command
1302 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1303 Show all, including drawers.
1304 @cindex revealing context
1305 @orgcmd{C-c C-r,org-reveal}
1306 Reveal context around point, showing the current entry, the following heading
1307 and the hierarchy above.  Useful for working near a location that has been
1308 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1309 (@pxref{Agenda commands}).  With a prefix argument show, on each
1310 level, all sibling headings.  With a double prefix argument, also show the
1311 entire subtree of the parent.
1312 @cindex show branches, command
1313 @orgcmd{C-c C-k,show-branches}
1314 Expose all the headings of the subtree, CONTENT view for just one subtree.
1315 @cindex show children, command
1316 @orgcmd{C-c @key{TAB},show-children}
1317 Expose all direct children of the subtree.  With a numeric prefix argument N,
1318 expose all children down to level N@.
1319 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1320 Show the current subtree in an indirect buffer@footnote{The indirect
1321 buffer
1322 @ifinfo
1323 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1324 @end ifinfo
1325 @ifnotinfo
1326 (see the Emacs manual for more information about indirect buffers)
1327 @end ifnotinfo
1328 will contain the entire buffer, but will be narrowed to the current
1329 tree.  Editing the indirect buffer will also change the original buffer,
1330 but without affecting visibility in that buffer.}.  With a numeric
1331 prefix argument N, go up to level N and then take that tree.  If N is
1332 negative then go up that many levels.  With a @kbd{C-u} prefix, do not remove
1333 the previously used indirect buffer.
1334 @orgcmd{C-c C-x v,org-copy-visible}
1335 Copy the @i{visible} text in the region into the kill ring.
1336 @end table
1338 @menu
1339 * Initial visibility::          Setting the initial visibility state
1340 * Catching invisible edits::    Preventing mistakes when editing invisible parts
1341 @end menu
1343 @node Initial visibility, Catching invisible edits, Global and local cycling, Visibility cycling
1344 @subsection Initial visibility
1346 @cindex visibility, initialize
1347 @vindex org-startup-folded
1348 @vindex org-agenda-inhibit-startup
1349 @cindex @code{overview}, STARTUP keyword
1350 @cindex @code{content}, STARTUP keyword
1351 @cindex @code{showall}, STARTUP keyword
1352 @cindex @code{showeverything}, STARTUP keyword
1354 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1355 i.e., only the top level headlines are visible@footnote{When
1356 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1357 visibility state when first opening a file for the agenda (@pxref{Speeding up
1358 your agendas}).}.  This can be configured through the variable
1359 @code{org-startup-folded}, or on a per-file basis by adding one of the
1360 following lines anywhere in the buffer:
1362 @example
1363 #+STARTUP: overview
1364 #+STARTUP: content
1365 #+STARTUP: showall
1366 #+STARTUP: showeverything
1367 @end example
1369 The startup visibility options are ignored when the file is open for the
1370 first time during the agenda generation: if you want the agenda to honor
1371 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1373 @cindex property, VISIBILITY
1374 @noindent
1375 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1376 and Columns}) will get their visibility adapted accordingly.  Allowed values
1377 for this property are @code{folded}, @code{children}, @code{content}, and
1378 @code{all}.
1380 @table @asis
1381 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1382 Switch back to the startup visibility of the buffer, i.e., whatever is
1383 requested by startup options and @samp{VISIBILITY} properties in individual
1384 entries.
1385 @end table
1387 @node Catching invisible edits,  , Initial visibility, Visibility cycling
1388 @subsection Catching invisible edits
1390 @vindex org-catch-invisible-edits
1391 @cindex edits, catching invisible
1392 Sometimes you may inadvertently edit an invisible part of the buffer and be
1393 confused on what has been edited and how to undo the mistake.  Setting
1394 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this.  See the
1395 docstring of this option on how Org should catch invisible edits and process
1396 them.
1398 @node Motion, Structure editing, Visibility cycling, Document Structure
1399 @section Motion
1400 @cindex motion, between headlines
1401 @cindex jumping, to headlines
1402 @cindex headline navigation
1403 The following commands jump to other headlines in the buffer.
1405 @table @asis
1406 @orgcmd{C-c C-n,outline-next-visible-heading}
1407 Next heading.
1408 @orgcmd{C-c C-p,outline-previous-visible-heading}
1409 Previous heading.
1410 @orgcmd{C-c C-f,org-forward-same-level}
1411 Next heading same level.
1412 @orgcmd{C-c C-b,org-backward-same-level}
1413 Previous heading same level.
1414 @orgcmd{C-c C-u,outline-up-heading}
1415 Backward to higher level heading.
1416 @orgcmd{C-c C-j,org-goto}
1417 Jump to a different place without changing the current outline
1418 visibility.  Shows the document structure in a temporary buffer, where
1419 you can use the following keys to find your destination:
1420 @vindex org-goto-auto-isearch
1421 @example
1422 @key{TAB}         @r{Cycle visibility.}
1423 @key{down} / @key{up}   @r{Next/previous visible headline.}
1424 @key{RET}         @r{Select this location.}
1425 @kbd{/}           @r{Do a Sparse-tree search}
1426 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1427 n / p        @r{Next/previous visible headline.}
1428 f / b        @r{Next/previous headline same level.}
1429 u            @r{One level up.}
1430 0-9          @r{Digit argument.}
1431 q            @r{Quit}
1432 @end example
1433 @vindex org-goto-interface
1434 @noindent
1435 See also the option @code{org-goto-interface}.
1436 @end table
1438 @node Structure editing, Sparse trees, Motion, Document Structure
1439 @section Structure editing
1440 @cindex structure editing
1441 @cindex headline, promotion and demotion
1442 @cindex promotion, of subtrees
1443 @cindex demotion, of subtrees
1444 @cindex subtree, cut and paste
1445 @cindex pasting, of subtrees
1446 @cindex cutting, of subtrees
1447 @cindex copying, of subtrees
1448 @cindex sorting, of subtrees
1449 @cindex subtrees, cut and paste
1451 @table @asis
1452 @orgcmd{M-@key{RET},org-insert-heading}
1453 @vindex org-M-RET-may-split-line
1454 Insert a new heading/item with the same level than the one at point.
1455 If the cursor is in a plain list item, a new item is created
1456 (@pxref{Plain lists}).  To prevent this behavior in lists, call the
1457 command with a prefix argument.  When this command is used in the
1458 middle of a line, the line is split and the rest of the line becomes
1459 the new item or headline@footnote{If you do not want the line to be
1460 split, customize the variable @code{org-M-RET-may-split-line}.}.  If
1461 the command is used at the @emph{beginning} of a headline, the new
1462 headline is created before the current line.  If the command is used
1463 at the @emph{end} of a folded subtree (i.e., behind the ellipses at
1464 the end of a headline), then a headline will be
1465 inserted after the end of the subtree.  Calling this command with
1466 @kbd{C-u C-u} will unconditionally respect the headline's content and
1467 create a new item at the end of the parent subtree.
1468 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1469 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1470 current heading, the new heading is placed after the body instead of before
1471 it.  This command works from anywhere in the entry.
1472 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1473 @vindex org-treat-insert-todo-heading-as-state-change
1474 Insert new TODO entry with same level as current heading.  See also the
1475 variable @code{org-treat-insert-todo-heading-as-state-change}.
1476 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1477 Insert new TODO entry with same level as current heading.  Like
1478 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1479 subtree.
1480 @orgcmd{@key{TAB},org-cycle}
1481 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1482 become a child of the previous one.  The next @key{TAB} makes it a parent,
1483 and so on, all the way to top level.  Yet another @key{TAB}, and you are back
1484 to the initial level.
1485 @orgcmd{M-@key{left},org-do-promote}
1486 Promote current heading by one level.
1487 @orgcmd{M-@key{right},org-do-demote}
1488 Demote current heading by one level.
1489 @orgcmd{M-S-@key{left},org-promote-subtree}
1490 Promote the current subtree by one level.
1491 @orgcmd{M-S-@key{right},org-demote-subtree}
1492 Demote the current subtree by one level.
1493 @orgcmd{M-S-@key{up},org-move-subtree-up}
1494 Move subtree up (swap with previous subtree of same
1495 level).
1496 @orgcmd{M-S-@key{down},org-move-subtree-down}
1497 Move subtree down (swap with next subtree of same level).
1498 @orgcmd{M-h,org-mark-element}
1499 Mark the element at point.  Hitting repeatedly will mark subsequent elements
1500 of the one just marked.  E.g., hitting @key{M-h} on a paragraph will mark it,
1501 hitting @key{M-h} immediately again will mark the next one.
1502 @orgcmd{C-c @@,org-mark-subtree}
1503 Mark the subtree at point.  Hitting repeatedly will mark subsequent subtrees
1504 of the same level than the marked subtree.
1505 @orgcmd{C-c C-x C-w,org-cut-subtree}
1506 Kill subtree, i.e., remove it from buffer but save in kill ring.
1507 With a numeric prefix argument N, kill N sequential subtrees.
1508 @orgcmd{C-c C-x M-w,org-copy-subtree}
1509 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
1510 sequential subtrees.
1511 @orgcmd{C-c C-x C-y,org-paste-subtree}
1512 Yank subtree from kill ring.  This does modify the level of the subtree to
1513 make sure the tree fits in nicely at the yank position.  The yank level can
1514 also be specified with a numeric prefix argument, or by yanking after a
1515 headline marker like @samp{****}.
1516 @orgcmd{C-y,org-yank}
1517 @vindex org-yank-adjusted-subtrees
1518 @vindex org-yank-folded-subtrees
1519 Depending on the options @code{org-yank-adjusted-subtrees} and
1520 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1521 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1522 C-x C-y}.  With the default settings, no level adjustment will take place,
1523 but the yanked tree will be folded unless doing so would swallow text
1524 previously visible.  Any prefix argument to this command will force a normal
1525 @code{yank} to be executed, with the prefix passed along.  A good way to
1526 force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
1527 yank, it will yank previous kill items plainly, without adjustment and
1528 folding.
1529 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1530 Clone a subtree by making a number of sibling copies of it.  You will be
1531 prompted for the number of copies to make, and you can also specify if any
1532 timestamps in the entry should be shifted.  This can be useful, for example,
1533 to create a number of tasks related to a series of lectures to prepare.  For
1534 more details, see the docstring of the command
1535 @code{org-clone-subtree-with-time-shift}.
1536 @orgcmd{C-c C-w,org-refile}
1537 Refile entry or region to a different location.  @xref{Refile and copy}.
1538 @orgcmd{C-c ^,org-sort}
1539 Sort same-level entries.  When there is an active region, all entries in the
1540 region will be sorted.  Otherwise the children of the current headline are
1541 sorted.  The command prompts for the sorting method, which can be
1542 alphabetically, numerically, by time (first timestamp with active preferred,
1543 creation time, scheduled time, deadline time), by priority, by TODO keyword
1544 (in the sequence the keywords have been defined in the setup) or by the value
1545 of a property.  Reverse sorting is possible as well.  You can also supply
1546 your own function to extract the sorting key.  With a @kbd{C-u} prefix,
1547 sorting will be case-sensitive.
1548 @orgcmd{C-x n s,org-narrow-to-subtree}
1549 Narrow buffer to current subtree.
1550 @orgcmd{C-x n b,org-narrow-to-block}
1551 Narrow buffer to current block.
1552 @orgcmd{C-x n w,widen}
1553 Widen buffer to remove narrowing.
1554 @orgcmd{C-c *,org-toggle-heading}
1555 Turn a normal line or plain list item into a headline (so that it becomes a
1556 subheading at its location).  Also turn a headline into a normal line by
1557 removing the stars.  If there is an active region, turn all lines in the
1558 region into headlines.  If the first line in the region was an item, turn
1559 only the item lines into headlines.  Finally, if the first line is a
1560 headline, remove the stars from all headlines in the region.
1561 @end table
1563 @cindex region, active
1564 @cindex active region
1565 @cindex transient mark mode
1566 When there is an active region (Transient Mark mode), promotion and
1567 demotion work on all headlines in the region.  To select a region of
1568 headlines, it is best to place both point and mark at the beginning of a
1569 line, mark at the beginning of the first headline, and point at the line
1570 just after the last headline to change.  Note that when the cursor is
1571 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1572 functionality.
1575 @node Sparse trees, Plain lists, Structure editing, Document Structure
1576 @section Sparse trees
1577 @cindex sparse trees
1578 @cindex trees, sparse
1579 @cindex folding, sparse trees
1580 @cindex occur, command
1582 @vindex org-show-hierarchy-above
1583 @vindex org-show-following-heading
1584 @vindex org-show-siblings
1585 @vindex org-show-entry-below
1586 An important feature of Org mode is the ability to construct @emph{sparse
1587 trees} for selected information in an outline tree, so that the entire
1588 document is folded as much as possible, but the selected information is made
1589 visible along with the headline structure above it@footnote{See also the
1590 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1591 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1592 control on how much context is shown around each match.}.  Just try it out
1593 and you will see immediately how it works.
1595 Org mode contains several commands creating such trees, all these
1596 commands can be accessed through a dispatcher:
1598 @table @asis
1599 @orgcmd{C-c /,org-sparse-tree}
1600 This prompts for an extra key to select a sparse-tree creating command.
1601 @orgcmd{C-c / r,org-occur}
1602 @vindex org-remove-highlights-with-change
1603 Prompts for a regexp and shows a sparse tree with all matches.  If
1604 the match is in a headline, the headline is made visible.  If the match is in
1605 the body of an entry, headline and body are made visible.  In order to
1606 provide minimal context, also the full hierarchy of headlines above the match
1607 is shown, as well as the headline following the match.  Each match is also
1608 highlighted; the highlights disappear when the buffer is changed by an
1609 editing command@footnote{This depends on the option
1610 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1611 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1612 so several calls to this command can be stacked.
1613 @orgcmdkkc{M-g n,M-g M-n,next-error}
1614 Jump to the next sparse tree match in this buffer.
1615 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1616 Jump to the previous sparse tree match in this buffer.
1617 @end table
1619 @noindent
1620 @vindex org-agenda-custom-commands
1621 For frequently used sparse trees of specific search strings, you can
1622 use the option @code{org-agenda-custom-commands} to define fast
1623 keyboard access to specific sparse trees.  These commands will then be
1624 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1625 For example:
1627 @lisp
1628 (setq org-agenda-custom-commands
1629       '(("f" occur-tree "FIXME")))
1630 @end lisp
1632 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1633 a sparse tree matching the string @samp{FIXME}.
1635 The other sparse tree commands select headings based on TODO keywords,
1636 tags, or properties and will be discussed later in this manual.
1638 @kindex C-c C-e C-v
1639 @cindex printing sparse trees
1640 @cindex visible text, printing
1641 To print a sparse tree, you can use the Emacs command
1642 @code{ps-print-buffer-with-faces} which does not print invisible parts
1643 of the document @footnote{This does not work under XEmacs, because
1644 XEmacs uses selective display for outlining, not text properties.}.
1645 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1646 the document and print the resulting file.
1648 @node Plain lists, Drawers, Sparse trees, Document Structure
1649 @section Plain lists
1650 @cindex plain lists
1651 @cindex lists, plain
1652 @cindex lists, ordered
1653 @cindex ordered lists
1655 Within an entry of the outline tree, hand-formatted lists can provide
1656 additional structure.  They also provide a way to create lists of checkboxes
1657 (@pxref{Checkboxes}).  Org supports editing such lists, and every exporter
1658 (@pxref{Exporting}) can parse and format them.
1660 Org knows ordered lists, unordered lists, and description lists.
1661 @itemize @bullet
1662 @item
1663 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1664 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1665 they will be seen as top-level headlines.  Also, when you are hiding leading
1666 stars to get a clean outline view, plain list items starting with a star may
1667 be hard to distinguish from true headlines.  In short: even though @samp{*}
1668 is supported, it may be better to not use it for plain list items.}  as
1669 bullets.
1670 @item
1671 @vindex org-plain-list-ordered-item-terminator
1672 @vindex org-list-allow-alphabetical
1673 @emph{Ordered} list items start with a numeral followed by either a period or
1674 a right parenthesis@footnote{You can filter out any of them by configuring
1675 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1676 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1677 @samp{A)} by configuring @code{org-list-allow-alphabetical}.  To minimize
1678 confusion with normal text, those are limited to one character only.  Beyond
1679 that limit, bullets will automatically fallback to numbers.}.  If you want a
1680 list to start with a different value (e.g., 20), start the text of the item
1681 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1682 must be put @emph{before} the checkbox.  If you have activated alphabetical
1683 lists, you can also use counters like @code{[@@b]}.}.  Those constructs can
1684 be used in any item of the list in order to enforce a particular numbering.
1685 @item
1686 @emph{Description} list items are unordered list items, and contain the
1687 separator @samp{ :: } to distinguish the description @emph{term} from the
1688 description.
1689 @end itemize
1691 Items belonging to the same list must have the same indentation on the first
1692 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1693 2--digit numbers must be written left-aligned with the other numbers in the
1694 list.  An item ends before the next line that is less or equally indented
1695 than its bullet/number.
1697 @vindex org-list-empty-line-terminates-plain-lists
1698 A list ends whenever every item has ended, which means before any line less
1699 or equally indented than items at top level.  It also ends before two blank
1700 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1701 In that case, all items are closed.  Here is an example:
1703 @example
1704 @group
1705 ** Lord of the Rings
1706    My favorite scenes are (in this order)
1707    1. The attack of the Rohirrim
1708    2. Eowyn's fight with the witch king
1709       + this was already my favorite scene in the book
1710       + I really like Miranda Otto.
1711    3. Peter Jackson being shot by Legolas
1712       - on DVD only
1713       He makes a really funny face when it happens.
1714    But in the end, no individual scenes matter but the film as a whole.
1715    Important actors in this film are:
1716    - @b{Elijah Wood} :: He plays Frodo
1717    - @b{Sean Austin} :: He plays Sam, Frodo's friend.  I still remember
1718      him very well from his role as Mikey Walsh in @i{The Goonies}.
1719 @end group
1720 @end example
1722 Org supports these lists by tuning filling and wrapping commands to deal with
1723 them correctly@footnote{Org only changes the filling settings for Emacs.  For
1724 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}.  To turn this on,
1725 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1726 properly (@pxref{Exporting}).  Since indentation is what governs the
1727 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1728 blocks can be indented to signal that they belong to a particular item.
1730 @vindex org-list-demote-modify-bullet
1731 @vindex org-list-indent-offset
1732 If you find that using a different bullet for a sub-list (than that used for
1733 the current list-level) improves readability, customize the variable
1734 @code{org-list-demote-modify-bullet}.  To get a greater difference of
1735 indentation between items and theirs sub-items, customize
1736 @code{org-list-indent-offset}.
1738 @vindex org-list-automatic-rules
1739 The following commands act on items when the cursor is in the first line of
1740 an item (the line with the bullet or number).  Some of them imply the
1741 application of automatic rules to keep list structure intact.  If some of
1742 these actions get in your way, configure @code{org-list-automatic-rules}
1743 to disable them individually.
1745 @table @asis
1746 @orgcmd{@key{TAB},org-cycle}
1747 @cindex cycling, in plain lists
1748 @vindex org-cycle-include-plain-lists
1749 Items can be folded just like headline levels.  Normally this works only if
1750 the cursor is on a plain list item.  For more details, see the variable
1751 @code{org-cycle-include-plain-lists}.  If this variable is set to
1752 @code{integrate}, plain list items will be treated like low-level
1753 headlines.  The level of an item is then given by the indentation of the
1754 bullet/number.  Items are always subordinate to real headlines, however; the
1755 hierarchies remain completely separated.  In a new item with no text yet, the
1756 first @key{TAB} demotes the item to become a child of the previous
1757 one.  Subsequent @key{TAB}s move the item to meaningful levels in the list
1758 and eventually get it back to its initial position.
1759 @orgcmd{M-@key{RET},org-insert-heading}
1760 @vindex org-M-RET-may-split-line
1761 @vindex org-list-automatic-rules
1762 Insert new item at current level.  With a prefix argument, force a new
1763 heading (@pxref{Structure editing}).  If this command is used in the middle
1764 of an item, that item is @emph{split} in two, and the second part becomes the
1765 new item@footnote{If you do not want the item to be split, customize the
1766 variable @code{org-M-RET-may-split-line}.}.  If this command is executed
1767 @emph{before item's body}, the new item is created @emph{before} the current
1768 one.
1769 @end table
1771 @table @kbd
1772 @kindex M-S-@key{RET}
1773 @item M-S-@key{RET}
1774 Insert a new item with a checkbox (@pxref{Checkboxes}).
1775 @kindex S-@key{down}
1776 @item S-up
1777 @itemx S-down
1778 @cindex shift-selection-mode
1779 @vindex org-support-shift-select
1780 @vindex org-list-use-circular-motion
1781 Jump to the previous/next item in the current list@footnote{If you want to
1782 cycle around items that way, you may customize
1783 @code{org-list-use-circular-motion}.}, but only if
1784 @code{org-support-shift-select} is off.  If not, you can still use paragraph
1785 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1786 similar effect.
1787 @kindex M-@key{up}
1788 @kindex M-@key{down}
1789 @item M-up
1790 @itemx M-down
1791 Move the item including subitems up/down@footnote{See
1792 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1793 previous/next item of same indentation).  If the list is ordered, renumbering
1794 is automatic.
1795 @kindex M-@key{left}
1796 @kindex M-@key{right}
1797 @item M-left
1798 @itemx M-right
1799 Decrease/increase the indentation of an item, leaving children alone.
1800 @kindex M-S-@key{left}
1801 @kindex M-S-@key{right}
1802 @item M-S-@key{left}
1803 @itemx M-S-@key{right}
1804 Decrease/increase the indentation of the item, including subitems.
1805 Initially, the item tree is selected based on current indentation.  When
1806 these commands are executed several times in direct succession, the initially
1807 selected region is used, even if the new indentation would imply a different
1808 hierarchy.  To use the new hierarchy, break the command chain with a cursor
1809 motion or so.
1811 As a special case, using this command on the very first item of a list will
1812 move the whole list.  This behavior can be disabled by configuring
1813 @code{org-list-automatic-rules}.  The global indentation of a list has no
1814 influence on the text @emph{after} the list.
1815 @kindex C-c C-c
1816 @item C-c C-c
1817 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1818 state of the checkbox.  In any case, verify bullets and indentation
1819 consistency in the whole list.
1820 @kindex C-c -
1821 @vindex org-plain-list-ordered-item-terminator
1822 @item C-c -
1823 Cycle the entire list level through the different itemize/enumerate bullets
1824 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1825 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1826 and its indentation.  With a numeric prefix argument N, select the Nth bullet
1827 from this list.  If there is an active region when calling this, selected
1828 text will be changed into an item.  With a prefix argument, all lines will be
1829 converted to list items.  If the first line already was a list item, any item
1830 marker will be removed from the list.  Finally, even without an active
1831 region, a normal line will be converted into a list item.
1832 @kindex C-c *
1833 @item C-c *
1834 Turn a plain list item into a headline (so that it becomes a subheading at
1835 its location).  @xref{Structure editing}, for a detailed explanation.
1836 @kindex C-c C-*
1837 @item C-c C-*
1838 Turn the whole plain list into a subtree of the current heading.  Checkboxes
1839 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1840 (resp. checked).
1841 @kindex S-@key{left}
1842 @kindex S-@key{right}
1843 @item S-left/right
1844 @vindex org-support-shift-select
1845 This command also cycles bullet styles when the cursor in on the bullet or
1846 anywhere in an item line, details depending on
1847 @code{org-support-shift-select}.
1848 @kindex C-c ^
1849 @cindex sorting, of plain list
1850 @item C-c ^
1851 Sort the plain list.  You will be prompted for the sorting method:
1852 numerically, alphabetically, by time, by checked status for check lists,
1853 or by a custom function.
1854 @end table
1856 @node Drawers, Blocks, Plain lists, Document Structure
1857 @section Drawers
1858 @cindex drawers
1859 @cindex #+DRAWERS
1860 @cindex visibility cycling, drawers
1862 @vindex org-drawers
1863 @cindex org-insert-drawer
1864 @kindex C-c C-x d
1865 Sometimes you want to keep information associated with an entry, but you
1866 normally don't want to see it.  For this, Org mode has @emph{drawers}.
1867 Drawers need to be configured with the option @code{org-drawers}@footnote{You
1868 can define additional drawers on a per-file basis with a line like
1869 @code{#+DRAWERS: HIDDEN STATE}}.  Drawers look like this:
1871 @example
1872 ** This is a headline
1873    Still outside the drawer
1874    :DRAWERNAME:
1875    This is inside the drawer.
1876    :END:
1877    After the drawer.
1878 @end example
1880 You can interactively insert drawers at point by calling
1881 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}.  With an active
1882 region, this command will put the region inside the drawer.  With a prefix
1883 argument, this command calls @code{org-insert-property-drawer} and add a
1884 property drawer right below the current headline.  Completion over drawer
1885 keywords is also possible using @key{M-TAB}.
1887 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1888 show the entry, but keep the drawer collapsed to a single line.  In order to
1889 look inside the drawer, you need to move the cursor to the drawer line and
1890 press @key{TAB} there.  Org mode uses the @code{PROPERTIES} drawer for
1891 storing properties (@pxref{Properties and Columns}), and you can also arrange
1892 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1893 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.  If you
1894 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1896 @table @kbd
1897 @kindex C-c C-z
1898 @item C-c C-z
1899 Add a time-stamped note to the LOGBOOK drawer.
1900 @end table
1902 @vindex org-export-with-drawers
1903 You can select the name of the drawers which should be exported with
1904 @code{org-export-with-drawers}.  In that case, drawer contents will appear in
1905 export output.  Property drawers are not affected by this variable and are
1906 never exported.
1908 @node Blocks, Footnotes, Drawers, Document Structure
1909 @section Blocks
1911 @vindex org-hide-block-startup
1912 @cindex blocks, folding
1913 Org mode uses begin...end blocks for various purposes from including source
1914 code examples (@pxref{Literal examples}) to capturing time logging
1915 information (@pxref{Clocking work time}).  These blocks can be folded and
1916 unfolded by pressing TAB in the begin line.  You can also get all blocks
1917 folded at startup by configuring the option @code{org-hide-block-startup}
1918 or on a per-file basis by using
1920 @cindex @code{hideblocks}, STARTUP keyword
1921 @cindex @code{nohideblocks}, STARTUP keyword
1922 @example
1923 #+STARTUP: hideblocks
1924 #+STARTUP: nohideblocks
1925 @end example
1927 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1928 @section Footnotes
1929 @cindex footnotes
1931 Org mode supports the creation of footnotes.  In contrast to the
1932 @file{footnote.el} package, Org mode's footnotes are designed for work on
1933 a larger document, not only for one-off documents like emails.
1935 A footnote is started by a footnote marker in square brackets in column 0, no
1936 indentation allowed.  It ends at the next footnote definition, headline, or
1937 after two consecutive empty lines.  The footnote reference is simply the
1938 marker in square brackets, inside text.  For example:
1940 @example
1941 The Org homepage[fn:1] now looks a lot better than it used to.
1943 [fn:1] The link is: http://orgmode.org
1944 @end example
1946 Org mode extends the number-based syntax to @emph{named} footnotes and
1947 optional inline definition.  Using plain numbers as markers (as
1948 @file{footnote.el} does) is supported for backward compatibility, but not
1949 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1950 @LaTeX{}}).  Here are the valid references:
1952 @table @code
1953 @item [1]
1954 A plain numeric footnote marker.  Compatible with @file{footnote.el}, but not
1955 recommended because something like @samp{[1]} could easily be part of a code
1956 snippet.
1957 @item [fn:name]
1958 A named footnote reference, where @code{name} is a unique label word, or, for
1959 simplicity of automatic creation, a number.
1960 @item [fn:: This is the inline definition of this footnote]
1961 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1962 reference point.
1963 @item [fn:name: a definition]
1964 An inline definition of a footnote, which also specifies a name for the note.
1965 Since Org allows multiple references to the same note, you can then use
1966 @code{[fn:name]} to create additional references.
1967 @end table
1969 @vindex org-footnote-auto-label
1970 Footnote labels can be created automatically, or you can create names yourself.
1971 This is handled by the variable @code{org-footnote-auto-label} and its
1972 corresponding @code{#+STARTUP} keywords.  See the docstring of that variable
1973 for details.
1975 @noindent The following command handles footnotes:
1977 @table @kbd
1978 @kindex C-c C-x f
1979 @item C-c C-x f
1980 The footnote action command.
1982 When the cursor is on a footnote reference, jump to the definition.  When it
1983 is at a definition, jump to the (first) reference.
1985 @vindex org-footnote-define-inline
1986 @vindex org-footnote-section
1987 @vindex org-footnote-auto-adjust
1988 Otherwise, create a new footnote.  Depending on the option
1989 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1990 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1991 definition will be placed right into the text as part of the reference, or
1992 separately into the location determined by the option
1993 @code{org-footnote-section}.
1995 When this command is called with a prefix argument, a menu of additional
1996 options is offered:
1997 @example
1998 s   @r{Sort the footnote definitions by reference sequence.  During editing,}
1999     @r{Org makes no effort to sort footnote definitions into a particular}
2000     @r{sequence.  If you want them sorted, use this command, which will}
2001     @r{also move entries according to @code{org-footnote-section}.  Automatic}
2002     @r{sorting after each insertion/deletion can be configured using the}
2003     @r{option @code{org-footnote-auto-adjust}.}
2004 r   @r{Renumber the simple @code{fn:N} footnotes.  Automatic renumbering}
2005     @r{after each insertion/deletion can be configured using the option}
2006     @r{@code{org-footnote-auto-adjust}.}
2007 S   @r{Short for first @code{r}, then @code{s} action.}
2008 n   @r{Normalize the footnotes by collecting all definitions (including}
2009     @r{inline definitions) into a special section, and then numbering them}
2010     @r{in sequence.  The references will then also be numbers.  This is}
2011     @r{meant to be the final step before finishing a document (e.g., sending}
2012     @r{off an email).}
2013 d   @r{Delete the footnote at point, and all definitions of and references}
2014     @r{to it.}
2015 @end example
2016 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
2017 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
2018 renumbering and sorting footnotes can be automatic after each insertion or
2019 deletion.
2021 @kindex C-c C-c
2022 @item C-c C-c
2023 If the cursor is on a footnote reference, jump to the definition.  If it is a
2024 the definition, jump back to the reference.  When called at a footnote
2025 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
2026 @kindex C-c C-o
2027 @kindex mouse-1
2028 @kindex mouse-2
2029 @item C-c C-o  @r{or} mouse-1/2
2030 Footnote labels are also links to the corresponding definition/reference, and
2031 you can use the usual commands to follow these links.
2032 @end table
2034 @node Orgstruct mode, Org syntax, Footnotes, Document Structure
2035 @section The Orgstruct minor mode
2036 @cindex Orgstruct mode
2037 @cindex minor mode for structure editing
2039 If you like the intuitive way the Org mode structure editing and list
2040 formatting works, you might want to use these commands in other modes like
2041 Text mode or Mail mode as well.  The minor mode @code{orgstruct-mode} makes
2042 this possible.   Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2043 turn it on by default, for example in Message mode, with one of:
2045 @lisp
2046 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2047 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2048 @end lisp
2050 When this mode is active and the cursor is on a line that looks to Org like a
2051 headline or the first line of a list item, most structure editing commands
2052 will work, even if the same keys normally have different functionality in the
2053 major mode you are using.  If the cursor is not in one of those special
2054 lines, Orgstruct mode lurks silently in the shadows.
2056 When you use @code{orgstruct++-mode}, Org will also export indentation and
2057 autofill settings into that mode, and detect item context after the first
2058 line of an item.
2060 @vindex orgstruct-heading-prefix-regexp
2061 You can also use Org structure editing to fold and unfold headlines in
2062 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2063 the regular expression must match the local prefix to use before Org's
2064 headlines.  For example, if you set this variable to @code{";; "} in Emacs
2065 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2066 commented lines.  Some commands like @code{org-demote} are disabled when the
2067 prefix is set, but folding/unfolding will work correctly.
2069 @node Org syntax,  , Orgstruct mode, Document Structure
2070 @section Org syntax
2071 @cindex Org syntax
2073 A reference document providing a formal description of Org's syntax is
2074 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2075 Worg}, written and maintained by Nicolas Goaziou.  It defines Org's core
2076 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2077 keywords}, @code{(greater) elements} and @code{objects}.  Each part of an Org
2078 file falls into one of the categories above.
2080 To explore the abstract structure of an Org buffer, run this in a buffer:
2082 @lisp
2083 M-: (org-element-parse-buffer) RET
2084 @end lisp
2086 It will output a list containing the buffer's content represented as an
2087 abstract structure.  The export engine relies on the information stored in
2088 this list.  Most interactive commands (e.g., for structure editing) also
2089 rely on the syntactic meaning of the surrounding context.
2091 @node Tables, Hyperlinks, Document Structure, Top
2092 @chapter Tables
2093 @cindex tables
2094 @cindex editing tables
2096 Org comes with a fast and intuitive table editor.  Spreadsheet-like
2097 calculations are supported using the Emacs @file{calc} package
2098 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2100 @menu
2101 * Built-in table editor::       Simple tables
2102 * Column width and alignment::  Overrule the automatic settings
2103 * Column groups::               Grouping to trigger vertical lines
2104 * Orgtbl mode::                 The table editor as minor mode
2105 * The spreadsheet::             The table editor has spreadsheet capabilities
2106 * Org-Plot::                    Plotting from org tables
2107 @end menu
2109 @node Built-in table editor, Column width and alignment, Tables, Tables
2110 @section The built-in table editor
2111 @cindex table editor, built-in
2113 Org makes it easy to format tables in plain ASCII@.  Any line with @samp{|} as
2114 the first non-whitespace character is considered part of a table.  @samp{|}
2115 is also the column separator@footnote{To insert a vertical bar into a table
2116 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}.  A table
2117 might look like this:
2119 @example
2120 | Name  | Phone | Age |
2121 |-------+-------+-----|
2122 | Peter |  1234 |  17 |
2123 | Anna  |  4321 |  25 |
2124 @end example
2126 A table is re-aligned automatically each time you press @key{TAB} or
2127 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
2128 the next field (@key{RET} to the next row) and creates new table rows
2129 at the end of the table or before horizontal lines.  The indentation
2130 of the table is set by the first line.  Any line starting with
2131 @samp{|-} is considered as a horizontal separator line and will be
2132 expanded on the next re-align to span the whole table width.  So, to
2133 create the above table, you would only type
2135 @example
2136 |Name|Phone|Age|
2138 @end example
2140 @noindent and then press @key{TAB} to align the table and start filling in
2141 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
2142 @kbd{C-c @key{RET}}.
2144 @vindex org-enable-table-editor
2145 @vindex org-table-auto-blank-field
2146 When typing text into a field, Org treats @key{DEL},
2147 @key{Backspace}, and all character keys in a special way, so that
2148 inserting and deleting avoids shifting other fields.  Also, when
2149 typing @emph{immediately after the cursor was moved into a new field
2150 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2151 field is automatically made blank.  If this behavior is too
2152 unpredictable for you, configure the options
2153 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2155 @table @kbd
2156 @tsubheading{Creation and conversion}
2157 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2158 Convert the active region to table.  If every line contains at least one
2159 TAB character, the function assumes that the material is tab separated.
2160 If every line contains a comma, comma-separated values (CSV) are assumed.
2161 If not, lines are split at whitespace into fields.  You can use a prefix
2162 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2163 C-u} forces TAB, and a numeric argument N indicates that at least N
2164 consecutive spaces, or alternatively a TAB will be the separator.
2166 If there is no active region, this command creates an empty Org
2167 table.  But it is easier just to start typing, like
2168 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2170 @tsubheading{Re-aligning and field motion}
2171 @orgcmd{C-c C-c,org-table-align}
2172 Re-align the table and don't move to another field.
2174 @orgcmd{<TAB>,org-table-next-field}
2175 Re-align the table, move to the next field.  Creates a new row if
2176 necessary.
2178 @orgcmd{S-@key{TAB},org-table-previous-field}
2179 Re-align, move to previous field.
2181 @orgcmd{@key{RET},org-table-next-row}
2182 Re-align the table and move down to next row.  Creates a new row if
2183 necessary.  At the beginning or end of a line, @key{RET} still does
2184 NEWLINE, so it can be used to split a table.
2186 @orgcmd{M-a,org-table-beginning-of-field}
2187 Move to beginning of the current table field, or on to the previous field.
2188 @orgcmd{M-e,org-table-end-of-field}
2189 Move to end of the current table field, or on to the next field.
2191 @tsubheading{Column and row editing}
2192 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2193 Move the current column left/right.
2195 @orgcmd{M-S-@key{left},org-table-delete-column}
2196 Kill the current column.
2198 @orgcmd{M-S-@key{right},org-table-insert-column}
2199 Insert a new column to the left of the cursor position.
2201 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2202 Move the current row up/down.
2204 @orgcmd{M-S-@key{up},org-table-kill-row}
2205 Kill the current row or horizontal line.
2207 @orgcmd{M-S-@key{down},org-table-insert-row}
2208 Insert a new row above the current row.  With a prefix argument, the line is
2209 created below the current one.
2211 @orgcmd{C-c -,org-table-insert-hline}
2212 Insert a horizontal line below current row.  With a prefix argument, the line
2213 is created above the current line.
2215 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2216 Insert a horizontal line below current row, and move the cursor into the row
2217 below that line.
2219 @orgcmd{C-c ^,org-table-sort-lines}
2220 Sort the table lines in the region.  The position of point indicates the
2221 column to be used for sorting, and the range of lines is the range
2222 between the nearest horizontal separator lines, or the entire table.  If
2223 point is before the first column, you will be prompted for the sorting
2224 column.  If there is an active region, the mark specifies the first line
2225 and the sorting column, while point should be in the last line to be
2226 included into the sorting.  The command prompts for the sorting type
2227 (alphabetically, numerically, or by time).  When called with a prefix
2228 argument, alphabetic sorting will be case-sensitive.
2230 @tsubheading{Regions}
2231 @orgcmd{C-c C-x M-w,org-table-copy-region}
2232 Copy a rectangular region from a table to a special clipboard.  Point and
2233 mark determine edge fields of the rectangle.  If there is no active region,
2234 copy just the current field.  The process ignores horizontal separator lines.
2236 @orgcmd{C-c C-x C-w,org-table-cut-region}
2237 Copy a rectangular region from a table to a special clipboard, and
2238 blank all fields in the rectangle.  So this is the ``cut'' operation.
2240 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2241 Paste a rectangular region into a table.
2242 The upper left corner ends up in the current field.  All involved fields
2243 will be overwritten.  If the rectangle does not fit into the present table,
2244 the table is enlarged as needed.  The process ignores horizontal separator
2245 lines.
2247 @orgcmd{M-@key{RET},org-table-wrap-region}
2248 Split the current field at the cursor position and move the rest to the line
2249 below.  If there is an active region, and both point and mark are in the same
2250 column, the text in the column is wrapped to minimum width for the given
2251 number of lines.  A numeric prefix argument may be used to change the number
2252 of desired lines.  If there is no region, but you specify a prefix argument,
2253 the current field is made blank, and the content is appended to the field
2254 above.
2256 @tsubheading{Calculations}
2257 @cindex formula, in tables
2258 @cindex calculations, in tables
2259 @cindex region, active
2260 @cindex active region
2261 @cindex transient mark mode
2262 @orgcmd{C-c +,org-table-sum}
2263 Sum the numbers in the current column, or in the rectangle defined by
2264 the active region.  The result is shown in the echo area and can
2265 be inserted with @kbd{C-y}.
2267 @orgcmd{S-@key{RET},org-table-copy-down}
2268 @vindex org-table-copy-increment
2269 When current field is empty, copy from first non-empty field above.  When not
2270 empty, copy current field down to next row and move cursor along with it.
2271 Depending on the option @code{org-table-copy-increment}, integer field
2272 values will be incremented during copy.  Integers that are too large will not
2273 be incremented.  Also, a @code{0} prefix argument temporarily disables the
2274 increment.  This key is also used by shift-selection and related modes
2275 (@pxref{Conflicts}).
2277 @tsubheading{Miscellaneous}
2278 @orgcmd{C-c `,org-table-edit-field}
2279 Edit the current field in a separate window.  This is useful for fields that
2280 are not fully visible (@pxref{Column width and alignment}).  When called with
2281 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2282 edited in place.  When called with two @kbd{C-u} prefixes, make the editor
2283 window follow the cursor through the table and always show the current
2284 field.  The follow mode exits automatically when the cursor leaves the table,
2285 or when you repeat this command with @kbd{C-u C-u C-c `}.
2287 @item M-x org-table-import RET
2288 Import a file as a table.  The table should be TAB or whitespace
2289 separated.  Use, for example, to import a spreadsheet table or data
2290 from a database, because these programs generally can write
2291 TAB-separated text files.  This command works by inserting the file into
2292 the buffer and then converting the region to a table.  Any prefix
2293 argument is passed on to the converter, which uses it to determine the
2294 separator.
2295 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2296 Tables can also be imported by pasting tabular text into the Org
2297 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2298 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2300 @item M-x org-table-export RET
2301 @findex org-table-export
2302 @vindex org-table-export-default-format
2303 Export the table, by default as a TAB-separated file.  Use for data
2304 exchange with, for example, spreadsheet or database programs.  The format
2305 used to export the file can be configured in the option
2306 @code{org-table-export-default-format}.  You may also use properties
2307 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2308 name and the format for table export in a subtree.  Org supports quite
2309 general formats for exported tables.  The exporter format is the same as the
2310 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2311 detailed description.
2312 @end table
2314 If you don't like the automatic table editor because it gets in your
2315 way on lines which you would like to start with @samp{|}, you can turn
2316 it off with
2318 @lisp
2319 (setq org-enable-table-editor nil)
2320 @end lisp
2322 @noindent Then the only table command that still works is
2323 @kbd{C-c C-c} to do a manual re-align.
2325 @node Column width and alignment, Column groups, Built-in table editor, Tables
2326 @section Column width and alignment
2327 @cindex narrow columns in tables
2328 @cindex alignment in tables
2330 The width of columns is automatically determined by the table editor.  And
2331 also the alignment of a column is determined automatically from the fraction
2332 of number-like versus non-number fields in the column.
2334 Sometimes a single field or a few fields need to carry more text, leading to
2335 inconveniently wide columns.  Or maybe you want to make a table with several
2336 columns having a fixed width, regardless of content.  To set@footnote{This
2337 feature does not work on XEmacs.} the width of a column, one field anywhere
2338 in the column may contain just the string @samp{<N>} where @samp{N} is an
2339 integer specifying the width of the column in characters.  The next re-align
2340 will then set the width of this column to this value.
2342 @example
2343 @group
2344 |---+------------------------------|               |---+--------|
2345 |   |                              |               |   | <6>    |
2346 | 1 | one                          |               | 1 | one    |
2347 | 2 | two                          |     ----\     | 2 | two    |
2348 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
2349 | 4 | four                         |               | 4 | four   |
2350 |---+------------------------------|               |---+--------|
2351 @end group
2352 @end example
2354 @noindent
2355 Fields that are wider become clipped and end in the string @samp{=>}.
2356 Note that the full text is still in the buffer but is hidden.
2357 To see the full text, hold the mouse over the field---a tool-tip window
2358 will show the full content.  To edit such a field, use the command
2359 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
2360 open a new window with the full field.  Edit it and finish with @kbd{C-c
2361 C-c}.
2363 @vindex org-startup-align-all-tables
2364 When visiting a file containing a table with narrowed columns, the
2365 necessary character hiding has not yet happened, and the table needs to
2366 be aligned before it looks nice.  Setting the option
2367 @code{org-startup-align-all-tables} will realign all tables in a file
2368 upon visiting, but also slow down startup.  You can also set this option
2369 on a per-file basis with:
2371 @example
2372 #+STARTUP: align
2373 #+STARTUP: noalign
2374 @end example
2376 If you would like to overrule the automatic alignment of number-rich columns
2377 to the right and of string-rich column to the left, you can use @samp{<r>},
2378 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2379 effect when exporting to HTML.} or @samp{<l>} in a similar fashion.  You may
2380 also combine alignment and field width like this: @samp{<r10>}.
2382 Lines which only contain these formatting cookies will be removed
2383 automatically when exporting the document.
2385 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2386 @section Column groups
2387 @cindex grouping columns in tables
2389 When Org exports tables, it does so by default without vertical
2390 lines because that is visually more satisfying in general.  Occasionally
2391 however, vertical lines can be useful to structure a table into groups
2392 of columns, much like horizontal lines can do for groups of rows.  In
2393 order to specify column groups, you can use a special row where the
2394 first field contains only @samp{/}.  The further fields can either
2395 contain @samp{<} to indicate that this column should start a group,
2396 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2397 and @samp{>}) to make a column
2398 a group of its own.  Boundaries between column groups will upon export be
2399 marked with vertical lines.  Here is an example:
2401 @example
2402 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2403 |---+-----+-----+-----+---------+------------|
2404 | / |   < |     |   > |       < |          > |
2405 | 1 |   1 |   1 |   1 |       1 |          1 |
2406 | 2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
2407 | 3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
2408 |---+-----+-----+-----+---------+------------|
2409 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2410 @end example
2412 It is also sufficient to just insert the column group starters after
2413 every vertical line you would like to have:
2415 @example
2416 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2417 |----+-----+-----+-----+---------+------------|
2418 | /  | <   |     |     | <       |            |
2419 @end example
2421 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2422 @section The Orgtbl minor mode
2423 @cindex Orgtbl mode
2424 @cindex minor mode for tables
2426 If you like the intuitive way the Org table editor works, you
2427 might also want to use it in other modes like Text mode or Mail mode.
2428 The minor mode Orgtbl mode makes this possible.  You can always toggle
2429 the mode with @kbd{M-x orgtbl-mode RET}.  To turn it on by default, for
2430 example in Message mode, use
2432 @lisp
2433 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2434 @end lisp
2436 Furthermore, with some special setup, it is possible to maintain tables
2437 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
2438 construct @LaTeX{} tables with the underlying ease and power of
2439 Orgtbl mode, including spreadsheet capabilities.  For details, see
2440 @ref{Tables in arbitrary syntax}.
2442 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2443 @section The spreadsheet
2444 @cindex calculations, in tables
2445 @cindex spreadsheet capabilities
2446 @cindex @file{calc} package
2448 The table editor makes use of the Emacs @file{calc} package to implement
2449 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
2450 derive fields from other fields.  While fully featured, Org's implementation
2451 is not identical to other spreadsheets.  For example, Org knows the concept
2452 of a @emph{column formula} that will be applied to all non-header fields in a
2453 column without having to copy the formula to each relevant field.  There is
2454 also a formula debugger, and a formula editor with features for highlighting
2455 fields in the table corresponding to the references at the point in the
2456 formula, moving these references by arrow keys
2458 @menu
2459 * References::                  How to refer to another field or range
2460 * Formula syntax for Calc::     Using Calc to compute stuff
2461 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
2462 * Durations and time values::   How to compute durations and time values
2463 * Field and range formulas::    Formula for specific (ranges of) fields
2464 * Column formulas::             Formulas valid for an entire column
2465 * Lookup functions::            Lookup functions for searching tables
2466 * Editing and debugging formulas::  Fixing formulas
2467 * Updating the table::          Recomputing all dependent fields
2468 * Advanced features::           Field and column names, parameters and automatic recalc
2469 @end menu
2471 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2472 @subsection References
2473 @cindex references
2475 To compute fields in the table from other fields, formulas must
2476 reference other fields or ranges.  In Org, fields can be referenced
2477 by name, by absolute coordinates, and by relative coordinates.  To find
2478 out what the coordinates of a field are, press @kbd{C-c ?} in that
2479 field, or press @kbd{C-c @}} to toggle the display of a grid.
2481 @subsubheading Field references
2482 @cindex field references
2483 @cindex references, to fields
2485 Formulas can reference the value of another field in two ways.  Like in
2486 any other spreadsheet, you may reference fields with a letter/number
2487 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2488 @vindex org-table-use-standard-references
2489 However, Org prefers@footnote{Org will understand references typed by the
2490 user as @samp{B4}, but it will not use this syntax when offering a formula
2491 for editing.  You can customize this behavior using the option
2492 @code{org-table-use-standard-references}.} to use another, more general
2493 representation that looks like this:
2494 @example
2495 @@@var{row}$@var{column}
2496 @end example
2498 Column specifications can be absolute like @code{$1},
2499 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2500 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2501 @code{$<} and @code{$>} are immutable references to the first and last
2502 column, respectively, and you can use @code{$>>>} to indicate the third
2503 column from the right.
2505 The row specification only counts data lines and ignores horizontal separator
2506 lines (hlines).  Like with columns, you can use absolute row numbers
2507 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2508 current row like @code{@@+3} or @code{@@-1}.  @code{@@<} and @code{@@>} are
2509 immutable references the first and last@footnote{For backward compatibility
2510 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2511 a stable way to the 5th and 12th field in the last row of the table.
2512 However, this syntax is deprecated, it should not be used for new documents.
2513 Use @code{@@>$} instead.} row in the table, respectively.  You may also
2514 specify the row relative to one of the hlines: @code{@@I} refers to the first
2515 hline, @code{@@II} to the second, etc.  @code{@@-I} refers to the first such
2516 line above the current line, @code{@@+I} to the first such line below the
2517 current line.  You can also write @code{@@III+2} which is the second data line
2518 after the third hline in the table.
2520 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2521 i.e., to the row/column for the field being computed.  Also, if you omit
2522 either the column or the row part of the reference, the current row/column is
2523 implied.
2525 Org's references with @emph{unsigned} numbers are fixed references
2526 in the sense that if you use the same reference in the formula for two
2527 different fields, the same field will be referenced each time.
2528 Org's references with @emph{signed} numbers are floating
2529 references because the same reference operator can reference different
2530 fields depending on the field being calculated by the formula.
2532 Here are a few examples:
2534 @example
2535 @@2$3      @r{2nd row, 3rd column (same as @code{C2})}
2536 $5        @r{column 5 in the current row (same as @code{E&})}
2537 @@2        @r{current column, row 2}
2538 @@-1$-3    @r{the field one row up, three columns to the left}
2539 @@-I$2     @r{field just under hline above current row, column 2}
2540 @@>$5      @r{field in the last row, in column 5}
2541 @end example
2543 @subsubheading Range references
2544 @cindex range references
2545 @cindex references, to ranges
2547 You may reference a rectangular range of fields by specifying two field
2548 references connected by two dots @samp{..}.  If both fields are in the
2549 current row, you may simply use @samp{$2..$7}, but if at least one field
2550 is in a different row, you need to use the general @code{@@row$column}
2551 format at least for the first field (i.e the reference must start with
2552 @samp{@@} in order to be interpreted correctly).  Examples:
2554 @example
2555 $1..$3        @r{first three fields in the current row}
2556 $P..$Q        @r{range, using column names (see under Advanced)}
2557 $<<<..$>>     @r{start in third column, continue to the one but last}
2558 @@2$1..@@4$3    @r{6 fields between these two fields (same as @code{A2..C4})}
2559 @@-1$-2..@@-1   @r{3 fields in the row above, starting from 2 columns on the left}
2560 @@I..II        @r{between first and second hline, short for @code{@@I..@@II}}
2561 @end example
2563 @noindent Range references return a vector of values that can be fed
2564 into Calc vector functions.  Empty fields in ranges are normally suppressed,
2565 so that the vector contains only the non-empty fields.  For other options
2566 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2567 for Calc}.
2569 @subsubheading Field coordinates in formulas
2570 @cindex field coordinates
2571 @cindex coordinates, of field
2572 @cindex row, of field coordinates
2573 @cindex column, of field coordinates
2575 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2576 get the row or column number of the field where the formula result goes.
2577 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2578 and @code{org-table-current-column}.  Examples:
2580 @example
2581 if(@@# % 2, $#, string(""))   @r{column number on odd lines only}
2582 $3 = remote(FOO, @@@@#$2)      @r{copy column 2 from table FOO into}
2583                              @r{column 3 of the current table}
2584 @end example
2586 @noindent For the second example, table FOO must have at least as many rows
2587 as the current table.  Note that this is inefficient@footnote{The computation time scales as
2588 O(N^2) because table FOO is parsed for each field to be copied.} for large
2589 number of rows.
2591 @subsubheading Named references
2592 @cindex named references
2593 @cindex references, named
2594 @cindex name, of column or field
2595 @cindex constants, in calculations
2596 @cindex #+CONSTANTS
2598 @vindex org-table-formula-constants
2599 @samp{$name} is interpreted as the name of a column, parameter or
2600 constant.  Constants are defined globally through the option
2601 @code{org-table-formula-constants}, and locally (for the file) through a
2602 line like
2604 @example
2605 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2606 @end example
2608 @noindent
2609 @vindex constants-unit-system
2610 @pindex constants.el
2611 Also properties (@pxref{Properties and Columns}) can be used as
2612 constants in table formulas: for a property @samp{:Xyz:} use the name
2613 @samp{$PROP_Xyz}, and the property will be searched in the current
2614 outline entry and in the hierarchy above it.  If you have the
2615 @file{constants.el} package, it will also be used to resolve constants,
2616 including natural constants like @samp{$h} for Planck's constant, and
2617 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2618 supply the values of constants in two different unit systems, @code{SI}
2619 and @code{cgs}.  Which one is used depends on the value of the variable
2620 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
2621 @code{constSI} and @code{constcgs} to set this value for the current
2622 buffer.}.  Column names and parameters can be specified in special table
2623 lines.  These are described below, see @ref{Advanced features}.  All
2624 names must start with a letter, and further consist of letters and
2625 numbers.
2627 @subsubheading Remote references
2628 @cindex remote references
2629 @cindex references, remote
2630 @cindex references, to a different table
2631 @cindex name, of column or field
2632 @cindex constants, in calculations
2633 @cindex #+NAME, for table
2635 You may also reference constants, fields and ranges from a different table,
2636 either in the current file or even in a different file.  The syntax is
2638 @example
2639 remote(NAME-OR-ID,REF)
2640 @end example
2642 @noindent
2643 where NAME can be the name of a table in the current file as set by a
2644 @code{#+NAME: Name} line before the table.  It can also be the ID of an
2645 entry, even in a different file, and the reference then refers to the first
2646 table in that entry.  REF is an absolute field or range reference as
2647 described above for example @code{@@3$3} or @code{$somename}, valid in the
2648 referenced table.
2650 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2651 @subsection Formula syntax for Calc
2652 @cindex formula syntax, Calc
2653 @cindex syntax, of formulas
2655 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2656 package.  Note that @file{calc} has the non-standard convention that @samp{/}
2657 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2658 @samp{a/(b*c)}.  Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2659 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2660 GNU Emacs Calc Manual}), variable substitution takes place according to the
2661 rules described above.
2662 @cindex vectors, in table calculations
2663 The range vectors can be directly fed into the Calc vector functions
2664 like @samp{vmean} and @samp{vsum}.
2666 @cindex format specifier
2667 @cindex mode, for @file{calc}
2668 @vindex org-calc-default-modes
2669 A formula can contain an optional mode string after a semicolon.  This
2670 string consists of flags to influence Calc and other modes during
2671 execution.  By default, Org uses the standard Calc modes (precision
2672 12, angular units degrees, fraction and symbolic modes off).  The display
2673 format, however, has been changed to @code{(float 8)} to keep tables
2674 compact.  The default settings can be configured using the option
2675 @code{org-calc-default-modes}.
2677 @noindent List of modes:
2679 @table @asis
2680 @item @code{p20}
2681 Set the internal Calc calculation precision to 20 digits.
2682 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2683 Normal, scientific, engineering or fixed format of the result of Calc passed
2684 back to Org.  Calc formatting is unlimited in precision as long as the Calc
2685 calculation precision is greater.
2686 @item @code{D}, @code{R}
2687 Degree and radian angle modes of Calc.
2688 @item @code{F}, @code{S}
2689 Fraction and symbolic modes of Calc.
2690 @item @code{T}, @code{t}
2691 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2692 @item @code{E}
2693 If and how to consider empty fields.  Without @samp{E} empty fields in range
2694 references are suppressed so that the Calc vector or Lisp list contains only
2695 the non-empty fields.  With @samp{E} the empty fields are kept.  For empty
2696 fields in ranges or empty field references the value @samp{nan} (not a
2697 number) is used in Calc formulas and the empty string is used for Lisp
2698 formulas.  Add @samp{N} to use 0 instead for both formula types.  For the
2699 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2700 @item @code{N}
2701 Interpret all fields as numbers, use 0 for non-numbers.  See the next section
2702 to see how this is essential for computations with Lisp formulas.  In Calc
2703 formulas it is used only occasionally because there number strings are
2704 already interpreted as numbers without @samp{N}.
2705 @item @code{L}
2706 Literal, for Lisp formulas only.  See the next section.
2707 @end table
2709 @noindent
2710 Unless you use large integer numbers or high-precision-calculation and
2711 -display for floating point numbers you may alternatively provide a
2712 @samp{printf} format specifier to reformat the Calc result after it has been
2713 passed back to Org instead of letting Calc already do the
2714 formatting@footnote{The @samp{printf} reformatting is limited in precision
2715 because the value passed to it is converted into an @samp{integer} or
2716 @samp{double}.  The @samp{integer} is limited in size by truncating the
2717 signed value to 32 bits.  The @samp{double} is limited in precision to 64
2718 bits overall which leaves approximately 16 significant decimal digits.}.  A
2719 few examples:
2721 @example
2722 $1+$2                @r{Sum of first and second field}
2723 $1+$2;%.2f           @r{Same, format result to two decimals}
2724 exp($2)+exp($1)      @r{Math functions can be used}
2725 $0;%.1f              @r{Reformat current cell to 1 decimal}
2726 ($3-32)*5/9          @r{Degrees F -> C conversion}
2727 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
2728 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
2729 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
2730 taylor($3,x=7,2)     @r{Taylor series of $3, at x=7, second degree}
2731 @end example
2733 Calc also contains a complete set of logical operations, (@pxref{Logical
2734 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}).  For example
2736 @table @code
2737 @item if($1 < 20, teen, string(""))
2738 "teen" if age $1 is less than 20, else the Org table result field is set to
2739 empty with the empty string.
2740 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1
2741 Sum of the first two columns.  When at least one of the input fields is empty
2742 the Org table result field is set to empty.  @samp{E} is required to not
2743 convert empty fields to 0.  @samp{f-1} is an optional Calc format string
2744 similar to @samp{%.1f} but leaves empty results empty.
2745 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2746 Mean value of a range unless there is any empty field.  Every field in the
2747 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2748 in @samp{nan}.  Then @samp{typeof == 12} detects the @samp{nan} from
2749 @samp{vmean} and the Org table result field is set to empty.  Use this when
2750 the sample set is expected to never have missing values.
2751 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2752 Mean value of a range with empty fields skipped.  Every field in the range
2753 that is empty is skipped.  When all fields in the range are empty the mean
2754 value is not defined and the Org table result field is set to empty.  Use
2755 this when the sample set can have a variable size.
2756 @item vmean($1..$7); EN
2757 To complete the example before: Mean value of a range with empty fields
2758 counting as samples with value 0.  Use this only when incomplete sample sets
2759 should be padded with 0 to the full size.
2760 @end table
2762 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2763 and use them in formula syntax for Calc.
2765 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2766 @subsection Emacs Lisp forms as formulas
2767 @cindex Lisp forms, as table formulas
2769 It is also possible to write a formula in Emacs Lisp.  This can be useful
2770 for string manipulation and control structures, if Calc's functionality is
2771 not enough.
2773 If a formula starts with a single-quote followed by an opening parenthesis,
2774 then it is evaluated as a Lisp form.  The evaluation should return either a
2775 string or a number.  Just as with @file{calc} formulas, you can specify modes
2776 and a printf format after a semicolon.
2778 With Emacs Lisp forms, you need to be conscious about the way field
2779 references are interpolated into the form.  By default, a reference will be
2780 interpolated as a Lisp string (in double-quotes) containing the field.  If
2781 you provide the @samp{N} mode switch, all referenced elements will be numbers
2782 (non-number fields will be zero) and interpolated as Lisp numbers, without
2783 quotes.  If you provide the @samp{L} flag, all fields will be interpolated
2784 literally, without quotes.  I.e., if you want a reference to be interpreted
2785 as a string by the Lisp form, enclose the reference operator itself in
2786 double-quotes, like @code{"$3"}.  Ranges are inserted as space-separated
2787 fields, so you can embed them in list or vector syntax.
2789 Here are a few examples---note how the @samp{N} mode is used when we do
2790 computations in Lisp:
2792 @table @code
2793 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2794 Swap the first two characters of the content of column 1.
2795 @item '(+ $1 $2);N
2796 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2797 @item '(apply '+ '($1..$4));N
2798 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2799 @end table
2801 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2802 @subsection Durations and time values
2803 @cindex Duration, computing
2804 @cindex Time, computing
2805 @vindex org-table-duration-custom-format
2807 If you want to compute time values use the @code{T} flag, either in Calc
2808 formulas or Elisp formulas:
2810 @example
2811 @group
2812   |  Task 1 |   Task 2 |    Total |
2813   |---------+----------+----------|
2814   |    2:12 |     1:47 | 03:59:00 |
2815   | 3:02:20 | -2:07:00 |     0.92 |
2816   #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2817 @end group
2818 @end example
2820 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2821 are optional.  With the @code{T} flag, computed durations will be displayed
2822 as @code{HH:MM:SS} (see the first formula above).  With the @code{t} flag,
2823 computed durations will be displayed according to the value of the option
2824 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2825 will display the result as a fraction of hours (see the second formula in the
2826 example above).
2828 Negative duration values can be manipulated as well, and integers will be
2829 considered as seconds in addition and subtraction.
2831 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2832 @subsection Field and range formulas
2833 @cindex field formula
2834 @cindex range formula
2835 @cindex formula, for individual table field
2836 @cindex formula, for range of fields
2838 To assign a formula to a particular field, type it directly into the field,
2839 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}.  When you press
2840 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2841 the formula will be stored as the formula for this field, evaluated, and the
2842 current field will be replaced with the result.
2844 @cindex #+TBLFM
2845 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2846 below the table.  If you type the equation in the 4th field of the 3rd data
2847 line in the table, the formula will look like @samp{@@3$4=$1+$2}.  When
2848 inserting/deleting/swapping column and rows with the appropriate commands,
2849 @i{absolute references} (but not relative ones) in stored formulas are
2850 modified in order to still reference the same field.  To avoid this from
2851 happening, in particular in range references, anchor ranges at the table
2852 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2853 using the @code{@@I} notation.  Automatic adaptation of field references does
2854 of course not happen if you edit the table structure with normal editing
2855 commands---then you must fix the equations yourself.
2857 Instead of typing an equation into the field, you may also use the following
2858 command
2860 @table @kbd
2861 @orgcmd{C-u C-c =,org-table-eval-formula}
2862 Install a new formula for the current field.  The command prompts for a
2863 formula with default taken from the @samp{#+TBLFM:} line, applies
2864 it to the current field, and stores it.
2865 @end table
2867 The left-hand side of a formula can also be a special expression in order to
2868 assign the formula to a number of different fields.  There is no keyboard
2869 shortcut to enter such range formulas.  To add them, use the formula editor
2870 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2871 directly.
2873 @table @code
2874 @item $2=
2875 Column formula, valid for the entire column.  This is so common that Org
2876 treats these formulas in a special way, see @ref{Column formulas}.
2877 @item @@3=
2878 Row formula, applies to all fields in the specified row.  @code{@@>=} means
2879 the last row.
2880 @item @@1$2..@@4$3=
2881 Range formula, applies to all fields in the given rectangular range.  This
2882 can also be used to assign a formula to some but not all fields in a row.
2883 @item $name=
2884 Named field, see @ref{Advanced features}.
2885 @end table
2887 @node Column formulas, Lookup functions, Field and range formulas, The spreadsheet
2888 @subsection Column formulas
2889 @cindex column formula
2890 @cindex formula, for table column
2892 When you assign a formula to a simple column reference like @code{$3=}, the
2893 same formula will be used in all fields of that column, with the following
2894 very convenient exceptions: (i) If the table contains horizontal separator
2895 hlines with rows above and below, everything before the first such hline is
2896 considered part of the table @emph{header} and will not be modified by column
2897 formulas.  Therefore a header is mandatory when you use column formulas and
2898 want to add hlines to group rows, like for example to separate a total row at
2899 the bottom from the summand rows above.  (ii) Fields that already get a value
2900 from a field/range formula will be left alone by column formulas.  These
2901 conditions make column formulas very easy to use.
2903 To assign a formula to a column, type it directly into any field in the
2904 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2905 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2906 the formula will be stored as the formula for the current column, evaluated
2907 and the current field replaced with the result.  If the field contains only
2908 @samp{=}, the previously stored formula for this column is used.  For each
2909 column, Org will only remember the most recently used formula.  In the
2910 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}.  The
2911 left-hand side of a column formula can not be the name of column, it must be
2912 the numeric column reference or @code{$>}.
2914 Instead of typing an equation into the field, you may also use the
2915 following command:
2917 @table @kbd
2918 @orgcmd{C-c =,org-table-eval-formula}
2919 Install a new formula for the current column and replace current field with
2920 the result of the formula.  The command prompts for a formula, with default
2921 taken from the @samp{#+TBLFM} line, applies it to the current field and
2922 stores it.  With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2923 will apply it to that many consecutive fields in the current column.
2924 @end table
2926 @node Lookup functions, Editing and debugging formulas, Column formulas, The spreadsheet
2927 @subsection Lookup functions
2928 @cindex lookup functions in tables
2929 @cindex table lookup functions
2931 Org has three predefined Emacs Lisp functions for lookups in tables.
2932 @table @code
2933 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2934 @findex org-lookup-first
2935 Searches for the first element @code{S} in list @code{S-LIST} for which
2936 @lisp
2937 (PREDICATE VAL S)
2938 @end lisp
2939 is @code{t}; returns the value from the corresponding position in list
2940 @code{R-LIST}.  The default @code{PREDICATE} is @code{equal}.  Note that the
2941 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2942 order as the corresponding parameters are in the call to
2943 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}.  If
2944 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2945 is returned.
2946 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2947 @findex org-lookup-last
2948 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2949 element for which @code{PREDICATE} is @code{t}.
2950 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2951 @findex org-lookup-all
2952 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2953 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2954 values.  This function can not be used by itself in a formula, because it
2955 returns a list of values.  However, powerful lookups can be built when this
2956 function is combined with other Emacs Lisp functions.
2957 @end table
2959 If the ranges used in these functions contain empty fields, the @code{E} mode
2960 for the formula should usually be specified: otherwise empty fields will not be
2961 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2962 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2963 element of @code{R-LIST}.
2965 These three functions can be used to implement associative arrays, count
2966 matching cells, rank results, group data etc.  For practical examples
2967 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2968 tutorial on Worg}.
2970 @node Editing and debugging formulas, Updating the table, Lookup functions, The spreadsheet
2971 @subsection Editing and debugging formulas
2972 @cindex formula editing
2973 @cindex editing, of table formulas
2975 @vindex org-table-use-standard-references
2976 You can edit individual formulas in the minibuffer or directly in the field.
2977 Org can also prepare a special buffer with all active formulas of a table.
2978 When offering a formula for editing, Org converts references to the standard
2979 format (like @code{B3} or @code{D&}) if possible.  If you prefer to only work
2980 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2981 option @code{org-table-use-standard-references}.
2983 @table @kbd
2984 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2985 Edit the formula associated with the current column/field in the
2986 minibuffer.  See @ref{Column formulas}, and @ref{Field and range formulas}.
2987 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2988 Re-insert the active formula (either a
2989 field formula, or a column formula) into the current field, so that you
2990 can edit it directly in the field.  The advantage over editing in the
2991 minibuffer is that you can use the command @kbd{C-c ?}.
2992 @orgcmd{C-c ?,org-table-field-info}
2993 While editing a formula in a table field, highlight the field(s)
2994 referenced by the reference at the cursor position in the formula.
2995 @kindex C-c @}
2996 @findex org-table-toggle-coordinate-overlays
2997 @item C-c @}
2998 Toggle the display of row and column numbers for a table, using overlays
2999 (@command{org-table-toggle-coordinate-overlays}).  These are updated each
3000 time the table is aligned; you can force it with @kbd{C-c C-c}.
3001 @kindex C-c @{
3002 @findex org-table-toggle-formula-debugger
3003 @item C-c @{
3004 Toggle the formula debugger on and off
3005 (@command{org-table-toggle-formula-debugger}).  See below.
3006 @orgcmd{C-c ',org-table-edit-formulas}
3007 Edit all formulas for the current table in a special buffer, where the
3008 formulas will be displayed one per line.  If the current field has an
3009 active formula, the cursor in the formula editor will mark it.
3010 While inside the special buffer, Org will automatically highlight
3011 any field or range reference at the cursor position.  You may edit,
3012 remove and add formulas, and use the following commands:
3014 @table @kbd
3015 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
3016 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
3017 prefix, also apply the new formulas to the entire table.
3018 @orgcmd{C-c C-q,org-table-fedit-abort}
3019 Exit the formula editor without installing changes.
3020 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3021 Toggle all references in the formula editor between standard (like
3022 @code{B3}) and internal (like @code{@@3$2}).
3023 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3024 Pretty-print or indent Lisp formula at point.  When in a line containing
3025 a Lisp formula, format the formula according to Emacs Lisp rules.
3026 Another @key{TAB} collapses the formula back again.  In the open
3027 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3028 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3029 Complete Lisp symbols, just like in Emacs Lisp mode.
3030 @kindex S-@key{up}
3031 @kindex S-@key{down}
3032 @kindex S-@key{left}
3033 @kindex S-@key{right}
3034 @findex org-table-fedit-ref-up
3035 @findex org-table-fedit-ref-down
3036 @findex org-table-fedit-ref-left
3037 @findex org-table-fedit-ref-right
3038 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3039 Shift the reference at point.  For example, if the reference is
3040 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3041 This also works for relative references and for hline references.
3042 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3043 Move the test line for column formulas in the Org buffer up and
3044 down.
3045 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3046 Scroll the window displaying the table.
3047 @kindex C-c @}
3048 @findex org-table-toggle-coordinate-overlays
3049 @item C-c @}
3050 Turn the coordinate grid in the table on and off.
3051 @end table
3052 @end table
3054 Making a table field blank does not remove the formula associated with
3055 the field, because that is stored in a different line (the @samp{#+TBLFM}
3056 line)---during the next recalculation the field will be filled again.
3057 To remove a formula from a field, you have to give an empty reply when
3058 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3060 @kindex C-c C-c
3061 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3062 equations with @kbd{C-c C-c} in that line or with the normal
3063 recalculation commands in the table.
3065 @anchor{Using multiple #+TBLFM lines}
3066 @subsubheading Using multiple #+TBLFM lines
3067 @cindex #+TBLFM line, multiple
3068 @cindex #+TBLFM
3069 @cindex #+TBLFM, switching
3070 @kindex C-c C-c
3072 You may apply the formula temporarily.  This is useful when you
3073 switch the formula.  Place multiple @samp{#+TBLFM} lines right
3074 after the table, and then press @kbd{C-c C-c} on the formula to
3075 apply.  Here is an example:
3077 @example
3078 | x | y |
3079 |---+---|
3080 | 1 |   |
3081 | 2 |   |
3082 #+TBLFM: $2=$1*1
3083 #+TBLFM: $2=$1*2
3084 @end example
3086 @noindent
3087 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3089 @example
3090 | x | y |
3091 |---+---|
3092 | 1 | 2 |
3093 | 2 | 4 |
3094 #+TBLFM: $2=$1*1
3095 #+TBLFM: $2=$1*2
3096 @end example
3098 @noindent
3099 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3100 will get the following result of applying only the first @samp{#+TBLFM} line.
3102 @example
3103 | x | y |
3104 |---+---|
3105 | 1 | 1 |
3106 | 2 | 2 |
3107 #+TBLFM: $2=$1*1
3108 #+TBLFM: $2=$1*2
3109 @end example
3111 @subsubheading Debugging formulas
3112 @cindex formula debugging
3113 @cindex debugging, of table formulas
3114 When the evaluation of a formula leads to an error, the field content
3115 becomes the string @samp{#ERROR}.  If you would like see what is going
3116 on during variable substitution and calculation in order to find a bug,
3117 turn on formula debugging in the @code{Tbl} menu and repeat the
3118 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3119 field.  Detailed information will be displayed.
3121 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
3122 @subsection Updating the table
3123 @cindex recomputing table fields
3124 @cindex updating, table
3126 Recalculation of a table is normally not automatic, but needs to be
3127 triggered by a command.  See @ref{Advanced features}, for a way to make
3128 recalculation at least semi-automatic.
3130 In order to recalculate a line of a table or the entire table, use the
3131 following commands:
3133 @table @kbd
3134 @orgcmd{C-c *,org-table-recalculate}
3135 Recalculate the current row by first applying the stored column formulas
3136 from left to right, and all field/range formulas in the current row.
3138 @kindex C-u C-c *
3139 @item C-u C-c *
3140 @kindex C-u C-c C-c
3141 @itemx C-u C-c C-c
3142 Recompute the entire table, line by line.  Any lines before the first
3143 hline are left alone, assuming that these are part of the table header.
3145 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3146 Iterate the table by recomputing it until no further changes occur.
3147 This may be necessary if some computed fields use the value of other
3148 fields that are computed @i{later} in the calculation sequence.
3149 @item M-x org-table-recalculate-buffer-tables RET
3150 @findex org-table-recalculate-buffer-tables
3151 Recompute all tables in the current buffer.
3152 @item M-x org-table-iterate-buffer-tables RET
3153 @findex org-table-iterate-buffer-tables
3154 Iterate all tables in the current buffer, in order to converge table-to-table
3155 dependencies.
3156 @end table
3158 @node Advanced features,  , Updating the table, The spreadsheet
3159 @subsection Advanced features
3161 If you want the recalculation of fields to happen automatically, or if you
3162 want to be able to assign @i{names}@footnote{Such names must start by an
3163 alphabetic character and use only alphanumeric/underscore characters.} to
3164 fields and columns, you need to reserve the first column of the table for
3165 special marking characters.
3167 @table @kbd
3168 @orgcmd{C-#,org-table-rotate-recalc-marks}
3169 Rotate the calculation mark in first column through the states @samp{ },
3170 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
3171 change all marks in the region.
3172 @end table
3174 Here is an example of a table that collects exam results of students and
3175 makes use of these features:
3177 @example
3178 @group
3179 |---+---------+--------+--------+--------+-------+------|
3180 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3181 |---+---------+--------+--------+--------+-------+------|
3182 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
3183 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
3184 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
3185 |---+---------+--------+--------+--------+-------+------|
3186 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
3187 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
3188 |---+---------+--------+--------+--------+-------+------|
3189 |   | Average |        |        |        |  25.0 |      |
3190 | ^ |         |        |        |        |    at |      |
3191 | $ | max=50  |        |        |        |       |      |
3192 |---+---------+--------+--------+--------+-------+------|
3193 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3194 @end group
3195 @end example
3197 @noindent @b{Important}: please note that for these special tables,
3198 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3199 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3200 to the field itself.  The column formulas are not applied in rows with
3201 empty first field.
3203 @cindex marking characters, tables
3204 The marking characters have the following meaning:
3206 @table @samp
3207 @item !
3208 The fields in this line define names for the columns, so that you may
3209 refer to a column as @samp{$Tot} instead of @samp{$6}.
3210 @item ^
3211 This row defines names for the fields @emph{above} the row.  With such
3212 a definition, any formula in the table may use @samp{$m1} to refer to
3213 the value @samp{10}.  Also, if you assign a formula to a names field, it
3214 will be stored as @samp{$name=...}.
3215 @item _
3216 Similar to @samp{^}, but defines names for the fields in the row
3217 @emph{below}.
3218 @item $
3219 Fields in this row can define @emph{parameters} for formulas.  For
3220 example, if a field in a @samp{$} row contains @samp{max=50}, then
3221 formulas in this table can refer to the value 50 using @samp{$max}.
3222 Parameters work exactly like constants, only that they can be defined on
3223 a per-table basis.
3224 @item #
3225 Fields in this row are automatically recalculated when pressing
3226 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
3227 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
3228 lines will be left alone by this command.
3229 @item *
3230 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3231 not for automatic recalculation.  Use this when automatic
3232 recalculation slows down editing too much.
3233 @item @w{ }
3234 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3235 All lines that should be recalculated should be marked with @samp{#}
3236 or @samp{*}.
3237 @item /
3238 Do not export this line.  Useful for lines that contain the narrowing
3239 @samp{<N>} markers or column group markers.
3240 @end table
3242 Finally, just to whet your appetite for what can be done with the
3243 fantastic @file{calc.el} package, here is a table that computes the Taylor
3244 series of degree @code{n} at location @code{x} for a couple of
3245 functions.
3247 @example
3248 @group
3249 |---+-------------+---+-----+--------------------------------------|
3250 |   | Func        | n | x   | Result                               |
3251 |---+-------------+---+-----+--------------------------------------|
3252 | # | exp(x)      | 1 | x   | 1 + x                                |
3253 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
3254 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
3255 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3256 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
3257 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
3258 |---+-------------+---+-----+--------------------------------------|
3259 #+TBLFM: $5=taylor($2,$4,$3);n3
3260 @end group
3261 @end example
3263 @node Org-Plot,  , The spreadsheet, Tables
3264 @section Org-Plot
3265 @cindex graph, in tables
3266 @cindex plot tables using Gnuplot
3267 @cindex #+PLOT
3269 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3270 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3271 @uref{http://xafs.org/BruceRavel/GnuplotMode}.  To see this in action, ensure
3272 that you have both Gnuplot and Gnuplot mode installed on your system, then
3273 call @code{org-plot/gnuplot} on the following table.
3275 @example
3276 @group
3277 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3278 | Sede      | Max cites | H-index |
3279 |-----------+-----------+---------|
3280 | Chile     |    257.72 |   21.39 |
3281 | Leeds     |    165.77 |   19.68 |
3282 | Sao Paolo |     71.00 |   11.50 |
3283 | Stockholm |    134.19 |   14.33 |
3284 | Morelia   |    257.56 |   17.67 |
3285 @end group
3286 @end example
3288 Notice that Org Plot is smart enough to apply the table's headers as labels.
3289 Further control over the labels, type, content, and appearance of plots can
3290 be exercised through the @code{#+PLOT:} lines preceding a table.  See below
3291 for a complete list of Org-plot options.  For more information and examples
3292 see the Org-plot tutorial at
3293 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3295 @subsubheading Plot Options
3297 @table @code
3298 @item set
3299 Specify any @command{gnuplot} option to be set when graphing.
3301 @item title
3302 Specify the title of the plot.
3304 @item ind
3305 Specify which column of the table to use as the @code{x} axis.
3307 @item deps
3308 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3309 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3310 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3311 column).
3313 @item type
3314 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3316 @item with
3317 Specify a @code{with} option to be inserted for every col being plotted
3318 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3319 Defaults to @code{lines}.
3321 @item file
3322 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3324 @item labels
3325 List of labels to be used for the @code{deps} (defaults to the column headers
3326 if they exist).
3328 @item line
3329 Specify an entire line to be inserted in the Gnuplot script.
3331 @item map
3332 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3333 flat mapping rather than a @code{3d} slope.
3335 @item timefmt
3336 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3337 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3339 @item script
3340 If you want total control, you can specify a script file (place the file name
3341 between double-quotes) which will be used to plot.  Before plotting, every
3342 instance of @code{$datafile} in the specified script will be replaced with
3343 the path to the generated data file.  Note: even if you set this option, you
3344 may still want to specify the plot type, as that can impact the content of
3345 the data file.
3346 @end table
3348 @node Hyperlinks, TODO Items, Tables, Top
3349 @chapter Hyperlinks
3350 @cindex hyperlinks
3352 Like HTML, Org provides links inside a file, external links to
3353 other files, Usenet articles, emails, and much more.
3355 @menu
3356 * Link format::                 How links in Org are formatted
3357 * Internal links::              Links to other places in the current file
3358 * External links::              URL-like links to the world
3359 * Handling links::              Creating, inserting and following
3360 * Using links outside Org::     Linking from my C source code?
3361 * Link abbreviations::          Shortcuts for writing complex links
3362 * Search options::              Linking to a specific location
3363 * Custom searches::             When the default search is not enough
3364 @end menu
3366 @node Link format, Internal links, Hyperlinks, Hyperlinks
3367 @section Link format
3368 @cindex link format
3369 @cindex format, of links
3371 Org will recognize plain URL-like links and activate them as
3372 clickable links.  The general link format, however, looks like this:
3374 @example
3375 [[link][description]]       @r{or alternatively}           [[link]]
3376 @end example
3378 @noindent
3379 Once a link in the buffer is complete (all brackets present), Org
3380 will change the display so that @samp{description} is displayed instead
3381 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3382 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
3383 which by default is an underlined face.  You can directly edit the
3384 visible part of a link.  Note that this can be either the @samp{link}
3385 part (if there is no description) or the @samp{description} part.  To
3386 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3387 cursor on the link.
3389 If you place the cursor at the beginning or just behind the end of the
3390 displayed text and press @key{BACKSPACE}, you will remove the
3391 (invisible) bracket at that location.  This makes the link incomplete
3392 and the internals are again displayed as plain text.  Inserting the
3393 missing bracket hides the link internals again.  To show the
3394 internal structure of all links, use the menu entry
3395 @code{Org->Hyperlinks->Literal links}.
3397 @node Internal links, External links, Link format, Hyperlinks
3398 @section Internal links
3399 @cindex internal links
3400 @cindex links, internal
3401 @cindex targets, for links
3403 @cindex property, CUSTOM_ID
3404 If the link does not look like a URL, it is considered to be internal in the
3405 current file.  The most important case is a link like
3406 @samp{[[#my-custom-id]]} which will link to the entry with the
3407 @code{CUSTOM_ID} property @samp{my-custom-id}.  You are responsible yourself
3408 to make sure these custom IDs are unique in a file.
3410 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3411 lead to a text search in the current file.
3413 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3414 or with a mouse click (@pxref{Handling links}).  Links to custom IDs will
3415 point to the corresponding headline.  The preferred match for a text link is
3416 a @i{dedicated target}: the same string in double angular brackets, like
3417 @samp{<<My Target>>}.
3419 @cindex #+NAME
3420 If no dedicated target exists, the link will then try to match the exact name
3421 of an element within the buffer.  Naming is done with the @code{#+NAME}
3422 keyword, which has to be put the line before the element it refers to, as in
3423 the following example
3425 @example
3426 #+NAME: My Target
3427 | a  | table      |
3428 |----+------------|
3429 | of | four cells |
3430 @end example
3432 If none of the above succeeds, Org will search for a headline that is exactly
3433 the link text but may also include a TODO keyword and tags@footnote{To insert
3434 a link targeting a headline, in-buffer completion can be used.  Just type
3435 a star followed by a few optional letters into the buffer and press
3436 @kbd{M-@key{TAB}}.  All headlines in the current buffer will be offered as
3437 completions.}.
3439 During export, internal links will be used to mark objects and assign them
3440 a number.  Marked objects will then be referenced by links pointing to them.
3441 In particular, links without a description will appear as the number assigned
3442 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3443 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3444 (@pxref{Images and tables}).}.  In the following excerpt from an Org buffer
3446 @example
3447 - one item
3448 - <<target>>another item
3449 Here we refer to item [[target]].
3450 @end example
3452 @noindent
3453 The last sentence will appear as @samp{Here we refer to item 2} when
3454 exported.
3456 In non-Org files, the search will look for the words in the link text.  In
3457 the above example the search would be for @samp{my target}.
3459 Following a link pushes a mark onto Org's own mark ring.  You can
3460 return to the previous position with @kbd{C-c &}.  Using this command
3461 several times in direct succession goes back to positions recorded
3462 earlier.
3464 @menu
3465 * Radio targets::               Make targets trigger links in plain text
3466 @end menu
3468 @node Radio targets,  , Internal links, Internal links
3469 @subsection Radio targets
3470 @cindex radio targets
3471 @cindex targets, radio
3472 @cindex links, radio targets
3474 Org can automatically turn any occurrences of certain target names
3475 in normal text into a link.  So without explicitly creating a link, the
3476 text connects to the target radioing its position.  Radio targets are
3477 enclosed by triple angular brackets.  For example, a target @samp{<<<My
3478 Target>>>} causes each occurrence of @samp{my target} in normal text to
3479 become activated as a link.  The Org file is scanned automatically
3480 for radio targets only when the file is first loaded into Emacs.  To
3481 update the target list during editing, press @kbd{C-c C-c} with the
3482 cursor on or at a target.
3484 @node External links, Handling links, Internal links, Hyperlinks
3485 @section External links
3486 @cindex links, external
3487 @cindex external links
3488 @cindex Gnus links
3489 @cindex BBDB links
3490 @cindex IRC links
3491 @cindex URL links
3492 @cindex file links
3493 @cindex RMAIL links
3494 @cindex MH-E links
3495 @cindex USENET links
3496 @cindex SHELL links
3497 @cindex Info links
3498 @cindex Elisp links
3500 Org supports links to files, websites, Usenet and email messages, BBDB
3501 database entries and links to both IRC conversations and their logs.
3502 External links are URL-like locators.  They start with a short identifying
3503 string followed by a colon.  There can be no space after the colon.  The
3504 following list shows examples for each link type.
3506 @example
3507 http://www.astro.uva.nl/~dominik          @r{on the web}
3508 doi:10.1000/182                           @r{DOI for an electronic resource}
3509 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
3510 /home/dominik/images/jupiter.jpg          @r{same as above}
3511 file:papers/last.pdf                      @r{file, relative path}
3512 ./papers/last.pdf                         @r{same as above}
3513 file:/myself@@some.where:papers/last.pdf   @r{file, path on remote machine}
3514 /myself@@some.where:papers/last.pdf        @r{same as above}
3515 file:sometextfile::NNN                    @r{file, jump to line number}
3516 file:projects.org                         @r{another Org file}
3517 file:projects.org::some words             @r{text search in Org file}@footnote{
3518 The actual behavior of the search will depend on the value of
3519 the option @code{org-link-search-must-match-exact-headline}.  If its value
3520 is @code{nil}, then a fuzzy text search will be done.  If it is t, then only the
3521 exact headline will be matched.  If the value is @code{'query-to-create},
3522 then an exact headline will be searched; if it is not found, then the user
3523 will be queried to create it.}
3524 file:projects.org::*task title            @r{heading search in Org file}
3525 file+sys:/path/to/file                    @r{open via OS, like double-click}
3526 file+emacs:/path/to/file                  @r{force opening by Emacs}
3527 docview:papers/last.pdf::NNN              @r{open in doc-view mode at page}
3528 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
3529 news:comp.emacs                           @r{Usenet link}
3530 mailto:adent@@galaxy.net                   @r{Mail link}
3531 mhe:folder                                @r{MH-E folder link}
3532 mhe:folder#id                             @r{MH-E message link}
3533 rmail:folder                              @r{RMAIL folder link}
3534 rmail:folder#id                           @r{RMAIL message link}
3535 gnus:group                                @r{Gnus group link}
3536 gnus:group#id                             @r{Gnus article link}
3537 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
3538 irc:/irc.com/#emacs/bob                   @r{IRC link}
3539 info:org#External links                   @r{Info node link}
3540 shell:ls *.org                            @r{A shell command}
3541 elisp:org-agenda                          @r{Interactive Elisp command}
3542 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3543 @end example
3545 @cindex VM links
3546 @cindex WANDERLUST links
3547 On top of these built-in link types, some are available through the
3548 @code{contrib/} directory (@pxref{Installation}).  For example, these links
3549 to VM or Wanderlust messages are available when you load the corresponding
3550 libraries from the @code{contrib/} directory:
3552 @example
3553 vm:folder                                 @r{VM folder link}
3554 vm:folder#id                              @r{VM message link}
3555 vm://myself@@some.where.org/folder#id      @r{VM on remote machine}
3556 vm-imap:account:folder                    @r{VM IMAP folder link}
3557 vm-imap:account:folder#id                 @r{VM IMAP message link}
3558 wl:folder                                 @r{WANDERLUST folder link}
3559 wl:folder#id                              @r{WANDERLUST message link}
3560 @end example
3562 For customizing Org to add new link types @ref{Adding hyperlink types}.
3564 A link should be enclosed in double brackets and may contain a descriptive
3565 text to be displayed instead of the URL (@pxref{Link format}), for example:
3567 @example
3568 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3569 @end example
3571 @noindent
3572 If the description is a file name or URL that points to an image, HTML
3573 export (@pxref{HTML export}) will inline the image as a clickable
3574 button.  If there is no description at all and the link points to an
3575 image,
3576 that image will be inlined into the exported HTML file.
3578 @cindex square brackets, around links
3579 @cindex plain text external links
3580 Org also finds external links in the normal text and activates them
3581 as links.  If spaces must be part of the link (for example in
3582 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3583 about the end of the link, enclose them in square brackets.
3585 @node Handling links, Using links outside Org, External links, Hyperlinks
3586 @section Handling links
3587 @cindex links, handling
3589 Org provides methods to create a link in the correct syntax, to
3590 insert it into an Org file, and to follow the link.
3592 @table @kbd
3593 @orgcmd{C-c l,org-store-link}
3594 @cindex storing links
3595 Store a link to the current location.  This is a @emph{global} command (you
3596 must create the key binding yourself) which can be used in any buffer to
3597 create a link.  The link will be stored for later insertion into an Org
3598 buffer (see below).  What kind of link will be created depends on the current
3599 buffer:
3601 @b{Org mode buffers}@*
3602 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3603 to the target.  Otherwise it points to the current headline, which will also
3604 be the description@footnote{If the headline contains a timestamp, it will be
3605 removed from the link and result in a wrong link---you should avoid putting
3606 timestamp in the headline.}.
3608 @vindex org-id-link-to-org-use-id
3609 @cindex property, CUSTOM_ID
3610 @cindex property, ID
3611 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3612 will be stored.  In addition or alternatively (depending on the value of
3613 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3614 be created and/or used to construct a link@footnote{The library
3615 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3616 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3617 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3618 potentially create two links: a human-readable from the custom ID, and one
3619 that is globally unique and works even if the entry is moved from file to
3620 file.  Later, when inserting the link, you need to decide which one to use.
3622 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3623 Pretty much all Emacs mail clients are supported.  The link will point to the
3624 current article, or, in some GNUS buffers, to the group.  The description is
3625 constructed from the author and the subject.
3627 @b{Web browsers: W3 and W3M}@*
3628 Here the link will be the current URL, with the page title as description.
3630 @b{Contacts: BBDB}@*
3631 Links created in a BBDB buffer will point to the current entry.
3633 @b{Chat: IRC}@*
3634 @vindex org-irc-link-to-logs
3635 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3636 a @samp{file:/} style link to the relevant point in the logs for the current
3637 conversation is created.  Otherwise an @samp{irc:/} style link to the
3638 user/channel/server under the point will be stored.
3640 @b{Other files}@*
3641 For any other files, the link will point to the file, with a search string
3642 (@pxref{Search options}) pointing to the contents of the current line.  If
3643 there is an active region, the selected words will form the basis of the
3644 search string.  If the automatically created link is not working correctly or
3645 accurately enough, you can write custom functions to select the search string
3646 and to do the search for particular file types---see @ref{Custom searches}.
3647 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3649 @b{Agenda view}@*
3650 When the cursor is in an agenda view, the created link points to the
3651 entry referenced by the current line.
3654 @orgcmd{C-c C-l,org-insert-link}
3655 @cindex link completion
3656 @cindex completion, of links
3657 @cindex inserting links
3658 @vindex org-keep-stored-link-after-insertion
3659 Insert a link@footnote{ Note that you don't have to use this command to
3660 insert a link.  Links in Org are plain text, and you can type or paste them
3661 straight into the buffer.  By using this command, the links are automatically
3662 enclosed in double brackets, and you will be asked for the optional
3663 descriptive text.}.  This prompts for a link to be inserted into the buffer.
3664 You can just type a link, using text for an internal link, or one of the link
3665 type prefixes mentioned in the examples above.  The link will be inserted
3666 into the buffer@footnote{After insertion of a stored link, the link will be
3667 removed from the list of stored links.  To keep it in the list later use, use
3668 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3669 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3670 If some text was selected when this command is called, the selected text
3671 becomes the default description.
3673 @b{Inserting stored links}@*
3674 All links stored during the
3675 current session are part of the history for this prompt, so you can access
3676 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3678 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3679 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3680 defined through link abbreviations (@pxref{Link abbreviations}).  If you
3681 press @key{RET} after inserting only the @var{prefix}, Org will offer
3682 specific completion support for some link types@footnote{This works by
3683 calling a special function @code{org-PREFIX-complete-link}.}  For
3684 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3685 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3686 @key{RET}} you can complete contact names.
3687 @orgkey C-u C-c C-l
3688 @cindex file name completion
3689 @cindex completion, of file names
3690 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3691 a file will be inserted and you may use file name completion to select
3692 the name of the file.  The path to the file is inserted relative to the
3693 directory of the current Org file, if the linked file is in the current
3694 directory or in a sub-directory of it, or if the path is written relative
3695 to the current directory using @samp{../}.  Otherwise an absolute path
3696 is used, if possible with @samp{~/} for your home directory.  You can
3697 force an absolute path with two @kbd{C-u} prefixes.
3699 @item C-c C-l @ @r{(with cursor on existing link)}
3700 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3701 link and description parts of the link.
3703 @cindex following links
3704 @orgcmd{C-c C-o,org-open-at-point}
3705 @vindex org-file-apps
3706 @vindex org-link-frame-setup
3707 Open link at point.  This will launch a web browser for URLs (using
3708 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3709 the corresponding links, and execute the command in a shell link.  When the
3710 cursor is on an internal link, this command runs the corresponding search.
3711 When the cursor is on a TAG list in a headline, it creates the corresponding
3712 TAGS view.  If the cursor is on a timestamp, it compiles the agenda for that
3713 date.  Furthermore, it will visit text and remote files in @samp{file:} links
3714 with Emacs and select a suitable application for local non-text files.
3715 Classification of files is based on file extension only.  See option
3716 @code{org-file-apps}.  If you want to override the default application and
3717 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
3718 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3719 If the cursor is on a headline, but not on a link, offer all links in the
3720 headline and entry text.  If you want to setup the frame configuration for
3721 following links, customize @code{org-link-frame-setup}.
3723 @orgkey @key{RET}
3724 @vindex org-return-follows-link
3725 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3726 the link at point.
3728 @kindex mouse-2
3729 @kindex mouse-1
3730 @item mouse-2
3731 @itemx mouse-1
3732 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3733 would.  Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3735 @kindex mouse-3
3736 @item mouse-3
3737 @vindex org-display-internal-link-with-indirect-buffer
3738 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3739 internal links to be displayed in another window@footnote{See the
3740 option @code{org-display-internal-link-with-indirect-buffer}}.
3742 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3743 @cindex inlining images
3744 @cindex images, inlining
3745 @vindex org-startup-with-inline-images
3746 @cindex @code{inlineimages}, STARTUP keyword
3747 @cindex @code{noinlineimages}, STARTUP keyword
3748 Toggle the inline display of linked images.  Normally this will only inline
3749 images that have no description part in the link, i.e., images that will also
3750 be inlined during export.  When called with a prefix argument, also display
3751 images that do have a link description.  You can ask for inline images to be
3752 displayed at startup by configuring the variable
3753 @code{org-startup-with-inline-images}@footnote{with corresponding
3754 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3755 @orgcmd{C-c %,org-mark-ring-push}
3756 @cindex mark ring
3757 Push the current position onto the mark ring, to be able to return
3758 easily.  Commands following an internal link do this automatically.
3760 @orgcmd{C-c &,org-mark-ring-goto}
3761 @cindex links, returning to
3762 Jump back to a recorded position.  A position is recorded by the
3763 commands following internal links, and by @kbd{C-c %}.  Using this
3764 command several times in direct succession moves through a ring of
3765 previously recorded positions.
3767 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3768 @cindex links, finding next/previous
3769 Move forward/backward to the next link in the buffer.  At the limit of
3770 the buffer, the search fails once, and then wraps around.  The key
3771 bindings for this are really too long; you might want to bind this also
3772 to @kbd{C-n} and @kbd{C-p}
3773 @lisp
3774 (add-hook 'org-load-hook
3775   (lambda ()
3776     (define-key org-mode-map "\C-n" 'org-next-link)
3777     (define-key org-mode-map "\C-p" 'org-previous-link)))
3778 @end lisp
3779 @end table
3781 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3782 @section Using links outside Org
3784 You can insert and follow links that have Org syntax not only in
3785 Org, but in any Emacs buffer.  For this, you should create two
3786 global commands, like this (please select suitable global keys
3787 yourself):
3789 @lisp
3790 (global-set-key "\C-c L" 'org-insert-link-global)
3791 (global-set-key "\C-c o" 'org-open-at-point-global)
3792 @end lisp
3794 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3795 @section Link abbreviations
3796 @cindex link abbreviations
3797 @cindex abbreviation, links
3799 Long URLs can be cumbersome to type, and often many similar links are
3800 needed in a document.  For this you can use link abbreviations.  An
3801 abbreviated link looks like this
3803 @example
3804 [[linkword:tag][description]]
3805 @end example
3807 @noindent
3808 @vindex org-link-abbrev-alist
3809 where the tag is optional.
3810 The @i{linkword} must be a word, starting with a letter, followed by
3811 letters, numbers, @samp{-}, and @samp{_}.  Abbreviations are resolved
3812 according to the information in the variable @code{org-link-abbrev-alist}
3813 that relates the linkwords to replacement text.  Here is an example:
3815 @smalllisp
3816 @group
3817 (setq org-link-abbrev-alist
3818   '(("bugzilla"  . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3819     ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3820     ("google"    . "http://www.google.com/search?q=")
3821     ("gmap"      . "http://maps.google.com/maps?q=%s")
3822     ("omap"      . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3823     ("ads"       . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3824 @end group
3825 @end smalllisp
3827 If the replacement text contains the string @samp{%s}, it will be
3828 replaced with the tag.  Using @samp{%h} instead of @samp{%s} will
3829 url-encode the tag (see the example above, where we need to encode
3830 the URL parameter.)  Using @samp{%(my-function)} will pass the tag
3831 to a custom function, and replace it by the resulting string.
3833 If the replacement text don't contain any specifier, it will simply
3834 be appended to the string in order to create the link.
3836 Instead of a string, you may also specify a function that will be
3837 called with the tag as the only argument to create the link.
3839 With the above setting, you could link to a specific bug with
3840 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3841 @code{[[google:OrgMode]]}, show the map location of the Free Software
3842 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3843 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3844 what the Org author is doing besides Emacs hacking with
3845 @code{[[ads:Dominik,C]]}.
3847 If you need special abbreviations just for a single Org buffer, you
3848 can define them in the file with
3850 @cindex #+LINK
3851 @example
3852 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
3853 #+LINK: google    http://www.google.com/search?q=%s
3854 @end example
3856 @noindent
3857 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3858 complete link abbreviations.  You may also define a function
3859 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3860 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
3861 not accept any arguments, and return the full link with prefix.
3863 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3864 @section Search options in file links
3865 @cindex search option in file links
3866 @cindex file links, searching
3868 File links can contain additional information to make Emacs jump to a
3869 particular location in the file when following a link.  This can be a
3870 line number or a search option after a double@footnote{For backward
3871 compatibility, line numbers can also follow a single colon.} colon.  For
3872 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3873 links}) to a file, it encodes the words in the current line as a search
3874 string that can be used to find this line back later when following the
3875 link with @kbd{C-c C-o}.
3877 Here is the syntax of the different ways to attach a search to a file
3878 link, together with an explanation:
3880 @example
3881 [[file:~/code/main.c::255]]
3882 [[file:~/xx.org::My Target]]
3883 [[file:~/xx.org::*My Target]]
3884 [[file:~/xx.org::#my-custom-id]]
3885 [[file:~/xx.org::/regexp/]]
3886 @end example
3888 @table @code
3889 @item 255
3890 Jump to line 255.
3891 @item My Target
3892 Search for a link target @samp{<<My Target>>}, or do a text search for
3893 @samp{my target}, similar to the search in internal links, see
3894 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
3895 link will become an HTML reference to the corresponding named anchor in
3896 the linked file.
3897 @item *My Target
3898 In an Org file, restrict search to headlines.
3899 @item #my-custom-id
3900 Link to a heading with a @code{CUSTOM_ID} property
3901 @item /regexp/
3902 Do a regular expression search for @code{regexp}.  This uses the Emacs
3903 command @code{occur} to list all matches in a separate window.  If the
3904 target file is in Org mode, @code{org-occur} is used to create a
3905 sparse tree with the matches.
3906 @c If the target file is a directory,
3907 @c @code{grep} will be used to search all files in the directory.
3908 @end table
3910 As a degenerate case, a file link with an empty file name can be used
3911 to search the current file.  For example, @code{[[file:::find me]]} does
3912 a search for @samp{find me} in the current file, just as
3913 @samp{[[find me]]} would.
3915 @node Custom searches,  , Search options, Hyperlinks
3916 @section Custom Searches
3917 @cindex custom search strings
3918 @cindex search strings, custom
3920 The default mechanism for creating search strings and for doing the
3921 actual search related to a file link may not work correctly in all
3922 cases.  For example, Bib@TeX{} database files have many entries like
3923 @samp{year="1993"} which would not result in good search strings,
3924 because the only unique identification for a Bib@TeX{} entry is the
3925 citation key.
3927 @vindex org-create-file-search-functions
3928 @vindex org-execute-file-search-functions
3929 If you come across such a problem, you can write custom functions to set
3930 the right search string for a particular file type, and to do the search
3931 for the string in the file.  Using @code{add-hook}, these functions need
3932 to be added to the hook variables
3933 @code{org-create-file-search-functions} and
3934 @code{org-execute-file-search-functions}.  See the docstring for these
3935 variables for more information.  Org actually uses this mechanism
3936 for Bib@TeX{} database files, and you can use the corresponding code as
3937 an implementation example.  See the file @file{org-bibtex.el}.
3939 @node TODO Items, Tags, Hyperlinks, Top
3940 @chapter TODO items
3941 @cindex TODO items
3943 Org mode does not maintain TODO lists as separate documents@footnote{Of
3944 course, you can make a document that contains only long lists of TODO items,
3945 but this is not required.}.  Instead, TODO items are an integral part of the
3946 notes file, because TODO items usually come up while taking notes!  With Org
3947 mode, simply mark any entry in a tree as being a TODO item.  In this way,
3948 information is not duplicated, and the entire context from which the TODO
3949 item emerged is always present.
3951 Of course, this technique for managing TODO items scatters them
3952 throughout your notes file.  Org mode compensates for this by providing
3953 methods to give you an overview of all the things that you have to do.
3955 @menu
3956 * TODO basics::                 Marking and displaying TODO entries
3957 * TODO extensions::             Workflow and assignments
3958 * Progress logging::            Dates and notes for progress
3959 * Priorities::                  Some things are more important than others
3960 * Breaking down tasks::         Splitting a task into manageable pieces
3961 * Checkboxes::                  Tick-off lists
3962 @end menu
3964 @node TODO basics, TODO extensions, TODO Items, TODO Items
3965 @section Basic TODO functionality
3967 Any headline becomes a TODO item when it starts with the word
3968 @samp{TODO}, for example:
3970 @example
3971 *** TODO Write letter to Sam Fortune
3972 @end example
3974 @noindent
3975 The most important commands to work with TODO entries are:
3977 @table @kbd
3978 @orgcmd{C-c C-t,org-todo}
3979 @cindex cycling, of TODO states
3980 @vindex org-use-fast-todo-selection
3982 Rotate the TODO state of the current item among
3984 @example
3985 ,-> (unmarked) -> TODO -> DONE --.
3986 '--------------------------------'
3987 @end example
3989 If TODO keywords have fast access keys (see @ref{Fast access to TODO
3990 states}), you will be prompted for a TODO keyword through the fast selection
3991 interface; this is the default behavior when
3992 @code{org-use-fast-todo-selection} is non-@code{nil}.
3994 The same rotation can also be done ``remotely'' from the timeline and agenda
3995 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3997 @orgkey{C-u C-c C-t}
3998 When TODO keywords have no selection keys, select a specific keyword using
3999 completion; otherwise force cycling through TODO states with no prompt.  When
4000 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
4001 selection interface.
4003 @kindex S-@key{right}
4004 @kindex S-@key{left}
4005 @item S-@key{right} @ @r{/} @ S-@key{left}
4006 @vindex org-treat-S-cursor-todo-selection-as-state-change
4007 Select the following/preceding TODO state, similar to cycling.  Useful
4008 mostly if more than two TODO states are possible (@pxref{TODO
4009 extensions}).  See also @ref{Conflicts}, for a discussion of the interaction
4010 with @code{shift-selection-mode}.  See also the variable
4011 @code{org-treat-S-cursor-todo-selection-as-state-change}.
4012 @orgcmd{C-c / t,org-show-todo-tree}
4013 @cindex sparse tree, for TODO
4014 @vindex org-todo-keywords
4015 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
4016 entire buffer, but shows all TODO items (with not-DONE state) and the
4017 headings hierarchy above them.  With a prefix argument (or by using @kbd{C-c
4018 / T}), search for a specific TODO@.  You will be prompted for the keyword,
4019 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
4020 entries that match any one of these keywords.  With a numeric prefix argument
4021 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
4022 With two prefix arguments, find all TODO states, both un-done and done.
4023 @orgcmd{C-c a t,org-todo-list}
4024 Show the global TODO list.  Collects the TODO items (with not-DONE states)
4025 from all agenda files (@pxref{Agenda Views}) into a single buffer.  The new
4026 buffer will be in @code{agenda-mode}, which provides commands to examine and
4027 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4028 @xref{Global TODO list}, for more information.
4029 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4030 Insert a new TODO entry below the current one.
4031 @end table
4033 @noindent
4034 @vindex org-todo-state-tags-triggers
4035 Changing a TODO state can also trigger tag changes.  See the docstring of the
4036 option @code{org-todo-state-tags-triggers} for details.
4038 @node TODO extensions, Progress logging, TODO basics, TODO Items
4039 @section Extended use of TODO keywords
4040 @cindex extended TODO keywords
4042 @vindex org-todo-keywords
4043 By default, marked TODO entries have one of only two states: TODO and
4044 DONE@.  Org mode allows you to classify TODO items in more complex ways
4045 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
4046 special setup, the TODO keyword system can work differently in different
4047 files.
4049 Note that @i{tags} are another way to classify headlines in general and
4050 TODO items in particular (@pxref{Tags}).
4052 @menu
4053 * Workflow states::             From TODO to DONE in steps
4054 * TODO types::                  I do this, Fred does the rest
4055 * Multiple sets in one file::   Mixing it all, and still finding your way
4056 * Fast access to TODO states::  Single letter selection of a state
4057 * Per-file keywords::           Different files, different requirements
4058 * Faces for TODO keywords::     Highlighting states
4059 * TODO dependencies::           When one task needs to wait for others
4060 @end menu
4062 @node Workflow states, TODO types, TODO extensions, TODO extensions
4063 @subsection TODO keywords as workflow states
4064 @cindex TODO workflow
4065 @cindex workflow states as TODO keywords
4067 You can use TODO keywords to indicate different @emph{sequential} states
4068 in the process of working on an item, for example@footnote{Changing
4069 this variable only becomes effective after restarting Org mode in a
4070 buffer.}:
4072 @lisp
4073 (setq org-todo-keywords
4074   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4075 @end lisp
4077 The vertical bar separates the TODO keywords (states that @emph{need
4078 action}) from the DONE states (which need @emph{no further action}).  If
4079 you don't provide the separator bar, the last state is used as the DONE
4080 state.
4081 @cindex completion, of TODO keywords
4082 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4083 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@.  You may
4084 also use a numeric prefix argument to quickly select a specific state.  For
4085 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4086 Or you can use @kbd{S-@key{left}} to go backward through the sequence.  If you
4087 define many keywords, you can use in-buffer completion
4088 (@pxref{Completion}) or even a special one-key selection scheme
4089 (@pxref{Fast access to TODO states}) to insert these words into the
4090 buffer.  Changing a TODO state can be logged with a timestamp, see
4091 @ref{Tracking TODO state changes}, for more information.
4093 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
4094 @subsection TODO keywords as types
4095 @cindex TODO types
4096 @cindex names as TODO keywords
4097 @cindex types as TODO keywords
4099 The second possibility is to use TODO keywords to indicate different
4100 @emph{types} of action items.  For example, you might want to indicate
4101 that items are for ``work'' or ``home''.  Or, when you work with several
4102 people on a single project, you might want to assign action items
4103 directly to persons, by using their names as TODO keywords.  This would
4104 be set up like this:
4106 @lisp
4107 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4108 @end lisp
4110 In this case, different keywords do not indicate a sequence, but rather
4111 different types.  So the normal work flow would be to assign a task to a
4112 person, and later to mark it DONE@.  Org mode supports this style by adapting
4113 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4114 @kbd{t} command in the timeline and agenda buffers.}.  When used several
4115 times in succession, it will still cycle through all names, in order to first
4116 select the right type for a task.  But when you return to the item after some
4117 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4118 to DONE@.  Use prefix arguments or completion to quickly select a specific
4119 name.  You can also review the items of a specific TODO type in a sparse tree
4120 by using a numeric prefix to @kbd{C-c / t}.  For example, to see all things
4121 Lucy has to do, you would use @kbd{C-3 C-c / t}.  To collect Lucy's items
4122 from all agenda files into a single buffer, you would use the numeric prefix
4123 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4125 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
4126 @subsection Multiple keyword sets in one file
4127 @cindex TODO keyword sets
4129 Sometimes you may want to use different sets of TODO keywords in
4130 parallel.  For example, you may want to have the basic
4131 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4132 separate state indicating that an item has been canceled (so it is not
4133 DONE, but also does not require action).  Your setup would then look
4134 like this:
4136 @lisp
4137 (setq org-todo-keywords
4138       '((sequence "TODO" "|" "DONE")
4139         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4140         (sequence "|" "CANCELED")))
4141 @end lisp
4143 The keywords should all be different, this helps Org mode to keep track
4144 of which subsequence should be used for a given entry.  In this setup,
4145 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4146 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4147 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
4148 select the correct sequence.  Besides the obvious ways like typing a
4149 keyword or using completion, you may also apply the following commands:
4151 @table @kbd
4152 @kindex C-S-@key{right}
4153 @kindex C-S-@key{left}
4154 @kindex C-u C-u C-c C-t
4155 @item C-u C-u C-c C-t
4156 @itemx C-S-@key{right}
4157 @itemx C-S-@key{left}
4158 These keys jump from one TODO subset to the next.  In the above example,
4159 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4160 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4161 @code{CANCELED}.  Note that the @kbd{C-S-} key binding conflict with
4162 @code{shift-selection-mode} (@pxref{Conflicts}).
4163 @kindex S-@key{right}
4164 @kindex S-@key{left}
4165 @item S-@key{right}
4166 @itemx S-@key{left}
4167 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
4168 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
4169 from @code{DONE} to @code{REPORT} in the example above.  See also
4170 @ref{Conflicts}, for a discussion of the interaction with
4171 @code{shift-selection-mode}.
4172 @end table
4174 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
4175 @subsection Fast access to TODO states
4177 If you would like to quickly change an entry to an arbitrary TODO state
4178 instead of cycling through the states, you can set up keys for single-letter
4179 access to the states.  This is done by adding the selection character after
4180 each keyword, in parentheses@footnote{All characters are allowed except
4181 @code{@@^!}, which have a special meaning here.}.  For example:
4183 @lisp
4184 (setq org-todo-keywords
4185       '((sequence "TODO(t)" "|" "DONE(d)")
4186         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4187         (sequence "|" "CANCELED(c)")))
4188 @end lisp
4190 @vindex org-fast-tag-selection-include-todo
4191 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4192 will be switched to this state.  @kbd{SPC} can be used to remove any TODO
4193 keyword from an entry.@footnote{Check also the option
4194 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4195 state through the tags interface (@pxref{Setting tags}), in case you like to
4196 mingle the two concepts.  Note that this means you need to come up with
4197 unique keys across both sets of keywords.}
4199 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
4200 @subsection Setting up keywords for individual files
4201 @cindex keyword options
4202 @cindex per-file keywords
4203 @cindex #+TODO
4204 @cindex #+TYP_TODO
4205 @cindex #+SEQ_TODO
4207 It can be very useful to use different aspects of the TODO mechanism in
4208 different files.  For file-local settings, you need to add special lines
4209 to the file which set the keywords and interpretation for that file
4210 only.  For example, to set one of the two examples discussed above, you
4211 need one of the following lines, starting in column zero anywhere in the
4212 file:
4214 @example
4215 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4216 @end example
4217 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4218 interpretation, but it means the same as @code{#+TODO}), or
4219 @example
4220 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4221 @end example
4223 A setup for using several sets in parallel would be:
4225 @example
4226 #+TODO: TODO | DONE
4227 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4228 #+TODO: | CANCELED
4229 @end example
4231 @cindex completion, of option keywords
4232 @kindex M-@key{TAB}
4233 @noindent To make sure you are using the correct keyword, type
4234 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4236 @cindex DONE, final TODO keyword
4237 Remember that the keywords after the vertical bar (or the last keyword
4238 if no bar is there) must always mean that the item is DONE (although you
4239 may use a different word).  After changing one of these lines, use
4240 @kbd{C-c C-c} with the cursor still in the line to make the changes
4241 known to Org mode@footnote{Org mode parses these lines only when
4242 Org mode is activated after visiting a file.  @kbd{C-c C-c} with the
4243 cursor in a line starting with @samp{#+} is simply restarting Org mode
4244 for the current buffer.}.
4246 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
4247 @subsection Faces for TODO keywords
4248 @cindex faces, for TODO keywords
4250 @vindex org-todo @r{(face)}
4251 @vindex org-done @r{(face)}
4252 @vindex org-todo-keyword-faces
4253 Org mode highlights TODO keywords with special faces: @code{org-todo}
4254 for keywords indicating that an item still has to be acted upon, and
4255 @code{org-done} for keywords indicating that an item is finished.  If
4256 you are using more than 2 different states, you might want to use
4257 special faces for some of them.  This can be done using the option
4258 @code{org-todo-keyword-faces}.  For example:
4260 @lisp
4261 @group
4262 (setq org-todo-keyword-faces
4263       '(("TODO" . org-warning) ("STARTED" . "yellow")
4264         ("CANCELED" . (:foreground "blue" :weight bold))))
4265 @end group
4266 @end lisp
4268 While using a list with face properties as shown for CANCELED @emph{should}
4269 work, this does not always seem to be the case.  If necessary, define a
4270 special face and use that.  A string is interpreted as a color.  The option
4271 @code{org-faces-easy-properties} determines if that color is interpreted as a
4272 foreground or a background color.
4274 @node TODO dependencies,  , Faces for TODO keywords, TODO extensions
4275 @subsection TODO dependencies
4276 @cindex TODO dependencies
4277 @cindex dependencies, of TODO states
4279 @vindex org-enforce-todo-dependencies
4280 @cindex property, ORDERED
4281 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4282 dependencies.  Usually, a parent TODO task should not be marked DONE until
4283 all subtasks (defined as children tasks) are marked as DONE@.  And sometimes
4284 there is a logical sequence to a number of (sub)tasks, so that one task
4285 cannot be acted upon before all siblings above it are done.  If you customize
4286 the option @code{org-enforce-todo-dependencies}, Org will block entries
4287 from changing state to DONE while they have children that are not DONE@.
4288 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4289 will be blocked until all earlier siblings are marked DONE@.  Here is an
4290 example:
4292 @example
4293 * TODO Blocked until (two) is done
4294 ** DONE one
4295 ** TODO two
4297 * Parent
4298   :PROPERTIES:
4299   :ORDERED: t
4300   :END:
4301 ** TODO a
4302 ** TODO b, needs to wait for (a)
4303 ** TODO c, needs to wait for (a) and (b)
4304 @end example
4306 @table @kbd
4307 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4308 @vindex org-track-ordered-property-with-tag
4309 @cindex property, ORDERED
4310 Toggle the @code{ORDERED} property of the current entry.  A property is used
4311 for this behavior because this should be local to the current entry, not
4312 inherited like a tag.  However, if you would like to @i{track} the value of
4313 this property with a tag for better visibility, customize the option
4314 @code{org-track-ordered-property-with-tag}.
4315 @orgkey{C-u C-u C-u C-c C-t}
4316 Change TODO state, circumventing any state blocking.
4317 @end table
4319 @vindex org-agenda-dim-blocked-tasks
4320 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4321 that cannot be closed because of such dependencies will be shown in a dimmed
4322 font or even made invisible in agenda views (@pxref{Agenda Views}).
4324 @cindex checkboxes and TODO dependencies
4325 @vindex org-enforce-todo-dependencies
4326 You can also block changes of TODO states by looking at checkboxes
4327 (@pxref{Checkboxes}).  If you set the option
4328 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4329 checkboxes will be blocked from switching to DONE.
4331 If you need more complex dependency structures, for example dependencies
4332 between entries in different trees or files, check out the contributed
4333 module @file{org-depend.el}.
4335 @page
4336 @node Progress logging, Priorities, TODO extensions, TODO Items
4337 @section Progress logging
4338 @cindex progress logging
4339 @cindex logging, of progress
4341 Org mode can automatically record a timestamp and possibly a note when
4342 you mark a TODO item as DONE, or even each time you change the state of
4343 a TODO item.  This system is highly configurable; settings can be on a
4344 per-keyword basis and can be localized to a file or even a subtree.  For
4345 information on how to clock working time for a task, see @ref{Clocking
4346 work time}.
4348 @menu
4349 * Closing items::               When was this entry marked DONE?
4350 * Tracking TODO state changes::  When did the status change?
4351 * Tracking your habits::        How consistent have you been?
4352 @end menu
4354 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4355 @subsection Closing items
4357 The most basic logging is to keep track of @emph{when} a certain TODO
4358 item was finished.  This is achieved with@footnote{The corresponding
4359 in-buffer setting is: @code{#+STARTUP: logdone}}
4361 @lisp
4362 (setq org-log-done 'time)
4363 @end lisp
4365 @vindex org-closed-keep-when-no-todo
4366 @noindent
4367 Then each time you turn an entry from a TODO (not-done) state into any of the
4368 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4369 the headline.  If you turn the entry back into a TODO item through further
4370 state cycling, that line will be removed again.  If you turn the entry back
4371 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4372 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4373 non-@code{nil}.  If you want to record a note along with the timestamp,
4374 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4375 lognotedone}.}
4377 @lisp
4378 (setq org-log-done 'note)
4379 @end lisp
4381 @noindent
4382 You will then be prompted for a note, and that note will be stored below
4383 the entry with a @samp{Closing Note} heading.
4385 In the timeline (@pxref{Timeline}) and in the agenda
4386 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4387 display the TODO items with a @samp{CLOSED} timestamp on each day,
4388 giving you an overview of what has been done.
4390 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4391 @subsection Tracking TODO state changes
4392 @cindex drawer, for state change recording
4394 @vindex org-log-states-order-reversed
4395 @vindex org-log-into-drawer
4396 @cindex property, LOG_INTO_DRAWER
4397 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4398 might want to keep track of when a state change occurred and maybe take a
4399 note about this change.  You can either record just a timestamp, or a
4400 time-stamped note for a change.  These records will be inserted after the
4401 headline as an itemized list, newest first@footnote{See the option
4402 @code{org-log-states-order-reversed}}.  When taking a lot of notes, you might
4403 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4404 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4405 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4406 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4407 show an entry---use @key{C-u SPC} to keep it folded here}.  You can also
4408 overrule the setting of this variable for a subtree by setting a
4409 @code{LOG_INTO_DRAWER} property.
4411 Since it is normally too much to record a note for every state, Org mode
4412 expects configuration on a per-keyword basis for this.  This is achieved by
4413 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4414 with timestamp) in parentheses after each keyword.  For example, with the
4415 setting
4417 @lisp
4418 (setq org-todo-keywords
4419   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4420 @end lisp
4422 To record a timestamp without a note for TODO keywords configured with
4423 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4425 @noindent
4426 @vindex org-log-done
4427 You not only define global TODO keywords and fast access keys, but also
4428 request that a time is recorded when the entry is set to
4429 DONE@footnote{It is possible that Org mode will record two timestamps
4430 when you are using both @code{org-log-done} and state change logging.
4431 However, it will never prompt for two notes---if you have configured
4432 both, the state change recording note will take precedence and cancel
4433 the @samp{Closing Note}.}, and that a note is recorded when switching to
4434 WAIT or CANCELED@.  The setting for WAIT is even more special: the
4435 @samp{!} after the slash means that in addition to the note taken when
4436 entering the state, a timestamp should be recorded when @i{leaving} the
4437 WAIT state, if and only if the @i{target} state does not configure
4438 logging for entering it.  So it has no effect when switching from WAIT
4439 to DONE, because DONE is configured to record a timestamp only.  But
4440 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4441 setting now triggers a timestamp even though TODO has no logging
4442 configured.
4444 You can use the exact same syntax for setting logging preferences local
4445 to a buffer:
4446 @example
4447 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4448 @end example
4450 @cindex property, LOGGING
4451 In order to define logging settings that are local to a subtree or a
4452 single item, define a LOGGING property in this entry.  Any non-empty
4453 LOGGING property resets all logging settings to @code{nil}.  You may then turn
4454 on logging for this specific tree using STARTUP keywords like
4455 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4456 settings like @code{TODO(!)}.  For example
4458 @example
4459 * TODO Log each state with only a time
4460   :PROPERTIES:
4461   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4462   :END:
4463 * TODO Only log when switching to WAIT, and when repeating
4464   :PROPERTIES:
4465   :LOGGING: WAIT(@@) logrepeat
4466   :END:
4467 * TODO No logging at all
4468   :PROPERTIES:
4469   :LOGGING: nil
4470   :END:
4471 @end example
4473 @node Tracking your habits,  , Tracking TODO state changes, Progress logging
4474 @subsection Tracking your habits
4475 @cindex habits
4477 Org has the ability to track the consistency of a special category of TODOs,
4478 called ``habits''.  A habit has the following properties:
4480 @enumerate
4481 @item
4482 You have enabled the @code{habits} module by customizing @code{org-modules}.
4483 @item
4484 The habit is a TODO item, with a TODO keyword representing an open state.
4485 @item
4486 The property @code{STYLE} is set to the value @code{habit}.
4487 @item
4488 The TODO has a scheduled date, usually with a @code{.+} style repeat
4489 interval.  A @code{++} style may be appropriate for habits with time
4490 constraints, e.g., must be done on weekends, or a @code{+} style for an
4491 unusual habit that can have a backlog, e.g., weekly reports.
4492 @item
4493 The TODO may also have minimum and maximum ranges specified by using the
4494 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4495 three days, but at most every two days.
4496 @item
4497 You must also have state logging for the @code{DONE} state enabled
4498 (@pxref{Tracking TODO state changes}), in order for historical data to be
4499 represented in the consistency graph.  If it is not enabled it is not an
4500 error, but the consistency graphs will be largely meaningless.
4501 @end enumerate
4503 To give you an idea of what the above rules look like in action, here's an
4504 actual habit with some history:
4506 @example
4507 ** TODO Shave
4508    SCHEDULED: <2009-10-17 Sat .+2d/4d>
4509    - State "DONE"       from "TODO"       [2009-10-15 Thu]
4510    - State "DONE"       from "TODO"       [2009-10-12 Mon]
4511    - State "DONE"       from "TODO"       [2009-10-10 Sat]
4512    - State "DONE"       from "TODO"       [2009-10-04 Sun]
4513    - State "DONE"       from "TODO"       [2009-10-02 Fri]
4514    - State "DONE"       from "TODO"       [2009-09-29 Tue]
4515    - State "DONE"       from "TODO"       [2009-09-25 Fri]
4516    - State "DONE"       from "TODO"       [2009-09-19 Sat]
4517    - State "DONE"       from "TODO"       [2009-09-16 Wed]
4518    - State "DONE"       from "TODO"       [2009-09-12 Sat]
4519    :PROPERTIES:
4520    :STYLE:    habit
4521    :LAST_REPEAT: [2009-10-19 Mon 00:36]
4522    :END:
4523 @end example
4525 What this habit says is: I want to shave at most every 2 days (given by the
4526 @code{SCHEDULED} date and repeat interval) and at least every 4 days.  If
4527 today is the 15th, then the habit first appears in the agenda on Oct 17,
4528 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4529 after four days have elapsed.
4531 What's really useful about habits is that they are displayed along with a
4532 consistency graph, to show how consistent you've been at getting that task
4533 done in the past.  This graph shows every day that the task was done over the
4534 past three weeks, with colors for each day.  The colors used are:
4536 @table @code
4537 @item Blue
4538 If the task wasn't to be done yet on that day.
4539 @item Green
4540 If the task could have been done on that day.
4541 @item Yellow
4542 If the task was going to be overdue the next day.
4543 @item Red
4544 If the task was overdue on that day.
4545 @end table
4547 In addition to coloring each day, the day is also marked with an asterisk if
4548 the task was actually done that day, and an exclamation mark to show where
4549 the current day falls in the graph.
4551 There are several configuration variables that can be used to change the way
4552 habits are displayed in the agenda.
4554 @table @code
4555 @item org-habit-graph-column
4556 The buffer column at which the consistency graph should be drawn.  This will
4557 overwrite any text in that column, so it is a good idea to keep your habits'
4558 titles brief and to the point.
4559 @item org-habit-preceding-days
4560 The amount of history, in days before today, to appear in consistency graphs.
4561 @item org-habit-following-days
4562 The number of days after today that will appear in consistency graphs.
4563 @item org-habit-show-habits-only-for-today
4564 If non-@code{nil}, only show habits in today's agenda view.  This is set to true by
4565 default.
4566 @end table
4568 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4569 temporarily be disabled and they won't appear at all.  Press @kbd{K} again to
4570 bring them back.  They are also subject to tag filtering, if you have habits
4571 which should only be done in certain contexts, for example.
4573 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4574 @section Priorities
4575 @cindex priorities
4577 If you use Org mode extensively, you may end up with enough TODO items that
4578 it starts to make sense to prioritize them.  Prioritizing can be done by
4579 placing a @emph{priority cookie} into the headline of a TODO item, like this
4581 @example
4582 *** TODO [#A] Write letter to Sam Fortune
4583 @end example
4585 @noindent
4586 @vindex org-priority-faces
4587 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4588 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie is
4589 treated just like priority @samp{B}.  Priorities make a difference only for
4590 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4591 have no inherent meaning to Org mode.  The cookies can be highlighted with
4592 special faces by customizing @code{org-priority-faces}.
4594 Priorities can be attached to any outline node; they do not need to be TODO
4595 items.
4597 @table @kbd
4598 @item @kbd{C-c ,}
4599 @kindex @kbd{C-c ,}
4600 @findex org-priority
4601 Set the priority of the current headline (@command{org-priority}).  The
4602 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4603 When you press @key{SPC} instead, the priority cookie is removed from the
4604 headline.  The priorities can also be changed ``remotely'' from the timeline
4605 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4607 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4608 @vindex org-priority-start-cycle-with-default
4609 Increase/decrease priority of current headline@footnote{See also the option
4610 @code{org-priority-start-cycle-with-default}.}.  Note that these keys are
4611 also used to modify timestamps (@pxref{Creating timestamps}).  See also
4612 @ref{Conflicts}, for a discussion of the interaction with
4613 @code{shift-selection-mode}.
4614 @end table
4616 @vindex org-highest-priority
4617 @vindex org-lowest-priority
4618 @vindex org-default-priority
4619 You can change the range of allowed priorities by setting the options
4620 @code{org-highest-priority}, @code{org-lowest-priority}, and
4621 @code{org-default-priority}.  For an individual buffer, you may set
4622 these values (highest, lowest, default) like this (please make sure that
4623 the highest priority is earlier in the alphabet than the lowest
4624 priority):
4626 @cindex #+PRIORITIES
4627 @example
4628 #+PRIORITIES: A C B
4629 @end example
4631 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4632 @section Breaking tasks down into subtasks
4633 @cindex tasks, breaking down
4634 @cindex statistics, for TODO items
4636 @vindex org-agenda-todo-list-sublevels
4637 It is often advisable to break down large tasks into smaller, manageable
4638 subtasks.  You can do this by creating an outline tree below a TODO item,
4639 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4640 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.  To keep
4641 the overview over the fraction of subtasks that are already completed, insert
4642 either @samp{[/]} or @samp{[%]} anywhere in the headline.  These cookies will
4643 be updated each time the TODO status of a child changes, or when pressing
4644 @kbd{C-c C-c} on the cookie.  For example:
4646 @example
4647 * Organize Party [33%]
4648 ** TODO Call people [1/2]
4649 *** TODO Peter
4650 *** DONE Sarah
4651 ** TODO Buy food
4652 ** DONE Talk to neighbor
4653 @end example
4655 @cindex property, COOKIE_DATA
4656 If a heading has both checkboxes and TODO children below it, the meaning of
4657 the statistics cookie become ambiguous.  Set the property
4658 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4659 this issue.
4661 @vindex org-hierarchical-todo-statistics
4662 If you would like to have the statistics cookie count any TODO entries in the
4663 subtree (not just direct children), configure
4664 @code{org-hierarchical-todo-statistics}.  To do this for a single subtree,
4665 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4666 property.
4668 @example
4669 * Parent capturing statistics [2/20]
4670   :PROPERTIES:
4671   :COOKIE_DATA: todo recursive
4672   :END:
4673 @end example
4675 If you would like a TODO entry to automatically change to DONE
4676 when all children are done, you can use the following setup:
4678 @example
4679 (defun org-summary-todo (n-done n-not-done)
4680   "Switch entry to DONE when all subentries are done, to TODO otherwise."
4681   (let (org-log-done org-log-states)   ; turn off logging
4682     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4684 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4685 @end example
4688 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4689 large number of subtasks (@pxref{Checkboxes}).
4692 @node Checkboxes,  , Breaking down tasks, TODO Items
4693 @section Checkboxes
4694 @cindex checkboxes
4696 @vindex org-list-automatic-rules
4697 Every item in a plain list@footnote{With the exception of description
4698 lists.  But you can allow it by modifying @code{org-list-automatic-rules}
4699 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4700 it with the string @samp{[ ]}.  This feature is similar to TODO items
4701 (@pxref{TODO Items}), but is more lightweight.  Checkboxes are not included
4702 in the global TODO list, so they are often great to split a task into a
4703 number of simple steps.  Or you can use them in a shopping list.  To toggle a
4704 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4705 @file{org-mouse.el}).
4707 Here is an example of a checkbox list.
4709 @example
4710 * TODO Organize party [2/4]
4711   - [-] call people [1/3]
4712     - [ ] Peter
4713     - [X] Sarah
4714     - [ ] Sam
4715   - [X] order food
4716   - [ ] think about what music to play
4717   - [X] talk to the neighbors
4718 @end example
4720 Checkboxes work hierarchically, so if a checkbox item has children that
4721 are checkboxes, toggling one of the children checkboxes will make the
4722 parent checkbox reflect if none, some, or all of the children are
4723 checked.
4725 @cindex statistics, for checkboxes
4726 @cindex checkbox statistics
4727 @cindex property, COOKIE_DATA
4728 @vindex org-checkbox-hierarchical-statistics
4729 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4730 indicating how many checkboxes present in this entry have been checked off,
4731 and the total number of checkboxes present.  This can give you an idea on how
4732 many checkboxes remain, even without opening a folded entry.  The cookies can
4733 be placed into a headline or into (the first line of) a plain list item.
4734 Each cookie covers checkboxes of direct children structurally below the
4735 headline/item on which the cookie appears@footnote{Set the option
4736 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4737 count all checkboxes below the cookie, not just those belonging to direct
4738 children.}.  You have to insert the cookie yourself by typing either
4739 @samp{[/]} or @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m}
4740 result, as in the examples above.  With @samp{[%]} you get information about
4741 the percentage of checkboxes checked (in the above example, this would be
4742 @samp{[50%]} and @samp{[33%]}, respectively).  In a headline, a cookie can
4743 count either checkboxes below the heading or TODO states of children, and it
4744 will display whatever was changed last.  Set the property @code{COOKIE_DATA}
4745 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4747 @cindex blocking, of checkboxes
4748 @cindex checkbox blocking
4749 @cindex property, ORDERED
4750 If the current outline node has an @code{ORDERED} property, checkboxes must
4751 be checked off in sequence, and an error will be thrown if you try to check
4752 off a box while there are unchecked boxes above it.
4754 @noindent The following commands work with checkboxes:
4756 @table @kbd
4757 @orgcmd{C-c C-c,org-toggle-checkbox}
4758 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4759 With a single prefix argument, add an empty checkbox or remove the current
4760 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4761 will add checkboxes to the rest of the list.}.  With a double prefix argument, set it to @samp{[-]}, which is
4762 considered to be an intermediate state.
4763 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4764 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
4765 double prefix argument, set it to @samp{[-]}, which is considered to be an
4766 intermediate state.
4767 @itemize @minus
4768 @item
4769 If there is an active region, toggle the first checkbox in the region
4770 and set all remaining boxes to the same status as the first.  With a prefix
4771 arg, add or remove the checkbox for all items in the region.
4772 @item
4773 If the cursor is in a headline, toggle checkboxes in the region between
4774 this headline and the next (so @emph{not} the entire subtree).
4775 @item
4776 If there is no active region, just toggle the checkbox at point.
4777 @end itemize
4778 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4779 Insert a new item with a checkbox.  This works only if the cursor is already
4780 in a plain list item (@pxref{Plain lists}).
4781 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4782 @vindex org-track-ordered-property-with-tag
4783 @cindex property, ORDERED
4784 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4785 be checked off in sequence.  A property is used for this behavior because
4786 this should be local to the current entry, not inherited like a tag.
4787 However, if you would like to @i{track} the value of this property with a tag
4788 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4789 @orgcmd{C-c #,org-update-statistics-cookies}
4790 Update the statistics cookie in the current outline entry.  When called with
4791 a @kbd{C-u} prefix, update the entire file.  Checkbox statistic cookies are
4792 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4793 new ones with @kbd{M-S-@key{RET}}.  TODO statistics cookies update when
4794 changing TODO states.  If you delete boxes/entries or add/change them by
4795 hand, use this command to get things back into sync.
4796 @end table
4798 @node Tags, Properties and Columns, TODO Items, Top
4799 @chapter Tags
4800 @cindex tags
4801 @cindex headline tagging
4802 @cindex matching, tags
4803 @cindex sparse tree, tag based
4805 An excellent way to implement labels and contexts for cross-correlating
4806 information is to assign @i{tags} to headlines.  Org mode has extensive
4807 support for tags.
4809 @vindex org-tag-faces
4810 Every headline can contain a list of tags; they occur at the end of the
4811 headline.  Tags are normal words containing letters, numbers, @samp{_}, and
4812 @samp{@@}.  Tags must be preceded and followed by a single colon, e.g.,
4813 @samp{:work:}.  Several tags can be specified, as in @samp{:work:urgent:}.
4814 Tags will by default be in bold face with the same color as the headline.
4815 You may specify special faces for specific tags using the option
4816 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4817 (@pxref{Faces for TODO keywords}).
4819 @menu
4820 * Tag inheritance::             Tags use the tree structure of the outline
4821 * Setting tags::                How to assign tags to a headline
4822 * Tag groups::                  Use one tag to search for several tags
4823 * Tag searches::                Searching for combinations of tags
4824 @end menu
4826 @node Tag inheritance, Setting tags, Tags, Tags
4827 @section Tag inheritance
4828 @cindex tag inheritance
4829 @cindex inheritance, of tags
4830 @cindex sublevels, inclusion into tags match
4832 @i{Tags} make use of the hierarchical structure of outline trees.  If a
4833 heading has a certain tag, all subheadings will inherit the tag as
4834 well.  For example, in the list
4836 @example
4837 * Meeting with the French group      :work:
4838 ** Summary by Frank                  :boss:notes:
4839 *** TODO Prepare slides for him      :action:
4840 @end example
4842 @noindent
4843 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4844 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4845 explicitly marked with those tags.  You can also set tags that all entries in
4846 a file should inherit just as if these tags were defined in a hypothetical
4847 level zero that surrounds the entire file.  Use a line like this@footnote{As
4848 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4849 changes in the line.}:
4851 @cindex #+FILETAGS
4852 @example
4853 #+FILETAGS: :Peter:Boss:Secret:
4854 @end example
4856 @noindent
4857 @vindex org-use-tag-inheritance
4858 @vindex org-tags-exclude-from-inheritance
4859 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4860 To turn it off entirely, use @code{org-use-tag-inheritance}.
4862 @vindex org-tags-match-list-sublevels
4863 When a headline matches during a tags search while tag inheritance is turned
4864 on, all the sublevels in the same tree will (for a simple match form) match
4865 as well@footnote{This is only true if the search does not involve more
4866 complex tests including properties (@pxref{Property searches}).}.  The list
4867 of matches may then become very long.  If you only want to see the first tags
4868 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4869 recommended).
4871 @vindex org-agenda-use-tag-inheritance
4872 Tag inheritance is relevant when the agenda search tries to match a tag,
4873 either in the @code{tags} or @code{tags-todo} agenda types.  In other agenda
4874 types, @code{org-use-tag-inheritance} has no effect.  Still, you may want to
4875 have your tags correctly set in the agenda, so that tag filtering works fine,
4876 with inherited tags.  Set @code{org-agenda-use-tag-inheritance} to control
4877 this: the default value includes all agenda types, but setting this to @code{nil}
4878 can really speed up agenda generation.
4880 @node Setting tags, Tag groups, Tag inheritance, Tags
4881 @section Setting tags
4882 @cindex setting tags
4883 @cindex tags, setting
4885 @kindex M-@key{TAB}
4886 Tags can simply be typed into the buffer at the end of a headline.
4887 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
4888 also a special command for inserting tags:
4890 @table @kbd
4891 @orgcmd{C-c C-q,org-set-tags-command}
4892 @cindex completion, of tags
4893 @vindex org-tags-column
4894 Enter new tags for the current headline.  Org mode will either offer
4895 completion or a special single-key interface for setting tags, see
4896 below.  After pressing @key{RET}, the tags will be inserted and aligned
4897 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
4898 tags in the current buffer will be aligned to that column, just to make
4899 things look nice.  TAGS are automatically realigned after promotion,
4900 demotion, and TODO state changes (@pxref{TODO basics}).
4902 @orgcmd{C-c C-c,org-set-tags-command}
4903 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4904 @end table
4906 @vindex org-tag-alist
4907 Org supports tag insertion based on a @emph{list of tags}.  By
4908 default this list is constructed dynamically, containing all tags
4909 currently used in the buffer.  You may also globally specify a hard list
4910 of tags with the variable @code{org-tag-alist}.  Finally you can set
4911 the default tags for a given file with lines like
4913 @cindex #+TAGS
4914 @example
4915 #+TAGS: @@work @@home @@tennisclub
4916 #+TAGS: laptop car pc sailboat
4917 @end example
4919 If you have globally defined your preferred set of tags using the
4920 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4921 in a specific file, add an empty TAGS option line to that file:
4923 @example
4924 #+TAGS:
4925 @end example
4927 @vindex org-tag-persistent-alist
4928 If you have a preferred set of tags that you would like to use in every file,
4929 in addition to those defined on a per-file basis by TAGS option lines, then
4930 you may specify a list of tags with the variable
4931 @code{org-tag-persistent-alist}.  You may turn this off on a per-file basis
4932 by adding a STARTUP option line to that file:
4934 @example
4935 #+STARTUP: noptag
4936 @end example
4938 By default Org mode uses the standard minibuffer completion facilities for
4939 entering tags.  However, it also implements another, quicker, tag selection
4940 method called @emph{fast tag selection}.  This allows you to select and
4941 deselect tags with just a single key press.  For this to work well you should
4942 assign unique letters to most of your commonly used tags.  You can do this
4943 globally by configuring the variable @code{org-tag-alist} in your
4944 @file{.emacs} file.  For example, you may find the need to tag many items in
4945 different files with @samp{:@@home:}.  In this case you can set something
4946 like:
4948 @lisp
4949 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4950 @end lisp
4952 @noindent If the tag is only relevant to the file you are working on, then you
4953 can instead set the TAGS option line as:
4955 @example
4956 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
4957 @end example
4959 @noindent The tags interface will show the available tags in a splash
4960 window.  If you want to start a new line after a specific tag, insert
4961 @samp{\n} into the tag list
4963 @example
4964 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t) \n laptop(l)  pc(p)
4965 @end example
4967 @noindent or write them in two lines:
4969 @example
4970 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)
4971 #+TAGS: laptop(l)  pc(p)
4972 @end example
4974 @noindent
4975 You can also group together tags that are mutually exclusive by using
4976 braces, as in:
4978 @example
4979 #+TAGS: @{ @@work(w)  @@home(h)  @@tennisclub(t) @}  laptop(l)  pc(p)
4980 @end example
4982 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4983 and @samp{@@tennisclub} should be selected.  Multiple such groups are allowed.
4985 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4986 these lines to activate any changes.
4988 @noindent
4989 To set these mutually exclusive groups in the variable @code{org-tag-alist},
4990 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4991 of the braces.  Similarly, you can use @code{:newline} to indicate a line
4992 break.  The previous example would be set globally by the following
4993 configuration:
4995 @lisp
4996 (setq org-tag-alist '((:startgroup . nil)
4997                       ("@@work" . ?w) ("@@home" . ?h)
4998                       ("@@tennisclub" . ?t)
4999                       (:endgroup . nil)
5000                       ("laptop" . ?l) ("pc" . ?p)))
5001 @end lisp
5003 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
5004 automatically present you with a special interface, listing inherited tags,
5005 the tags of the current headline, and a list of all valid tags with
5006 corresponding keys@footnote{Keys will automatically be assigned to tags which
5007 have no configured keys.}.  In this interface, you can use the following
5008 keys:
5010 @table @kbd
5011 @item a-z...
5012 Pressing keys assigned to tags will add or remove them from the list of
5013 tags in the current line.  Selecting a tag in a group of mutually
5014 exclusive tags will turn off any other tags from that group.
5015 @kindex @key{TAB}
5016 @item @key{TAB}
5017 Enter a tag in the minibuffer, even if the tag is not in the predefined
5018 list.  You will be able to complete on all tags present in the buffer.
5019 You can also add several tags: just separate them with a comma.
5021 @kindex @key{SPC}
5022 @item @key{SPC}
5023 Clear all tags for this line.
5024 @kindex @key{RET}
5025 @item @key{RET}
5026 Accept the modified set.
5027 @item C-g
5028 Abort without installing changes.
5029 @item q
5030 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5031 @item !
5032 Turn off groups of mutually exclusive tags.  Use this to (as an
5033 exception) assign several tags from such a group.
5034 @item C-c
5035 Toggle auto-exit after the next change (see below).
5036 If you are using expert mode, the first @kbd{C-c} will display the
5037 selection window.
5038 @end table
5040 @noindent
5041 This method lets you assign tags to a headline with very few keys.  With
5042 the above setup, you could clear the current tags and set @samp{@@home},
5043 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5044 C-c @key{SPC} h l p @key{RET}}.  Switching from @samp{@@home} to
5045 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5046 alternatively with @kbd{C-c C-c C-c w}.  Adding the non-predefined tag
5047 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5048 @key{RET} @key{RET}}.
5050 @vindex org-fast-tag-selection-single-key
5051 If you find that most of the time you need only a single key press to
5052 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5053 Then you no longer have to press @key{RET} to exit fast tag selection---it
5054 will immediately exit after the first change.  If you then occasionally
5055 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5056 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5057 instead of @kbd{C-c C-c}).  If you set the variable to the value
5058 @code{expert}, the special window is not even shown for single-key tag
5059 selection, it comes up only when you press an extra @kbd{C-c}.
5061 @node Tag groups, Tag searches, Setting tags, Tags
5062 @section Tag groups
5064 @cindex group tags
5065 @cindex tags, groups
5066 In a set of mutually exclusive tags, the first tag can be defined as a
5067 @emph{group tag}.  When you search for a group tag, it will return matches
5068 for all members in the group.  In an agenda view, filtering by a group tag
5069 will display headlines tagged with at least one of the members of the
5070 group.  This makes tag searches and filters even more flexible.
5072 You can set group tags by inserting a colon between the group tag and other
5073 tags---beware that all whitespaces are mandatory so that Org can parse this
5074 line correctly:
5076 @example
5077 #+TAGS: @{ @@read : @@read_book @@read_ebook @}
5078 @end example
5080 In this example, @samp{@@read} is a @emph{group tag} for a set of three
5081 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
5083 You can also use the @code{:grouptags} keyword directly when setting
5084 @code{org-tag-alist}:
5086 @lisp
5087 (setq org-tag-alist '((:startgroup . nil)
5088                       ("@@read" . nil)
5089                       (:grouptags . nil)
5090                       ("@@read_book" . nil)
5091                       ("@@read_ebook" . nil)
5092                       (:endgroup . nil)))
5093 @end lisp
5095 You cannot nest group tags or use a group tag as a tag in another group.
5097 @kindex C-c C-x q
5098 @vindex org-group-tags
5099 If you want to ignore group tags temporarily, toggle group tags support
5100 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}.  If you
5101 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5103 @node Tag searches,  , Tag groups, Tags
5104 @section Tag searches
5105 @cindex tag searches
5106 @cindex searching for tags
5108 Once a system of tags has been set up, it can be used to collect related
5109 information into special lists.
5111 @table @kbd
5112 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5113 Create a sparse tree with all headlines matching a tags/property/TODO search.
5114 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5115 @xref{Matching tags and properties}.
5116 @orgcmd{C-c a m,org-tags-view}
5117 Create a global list of tag matches from all agenda files.  @xref{Matching
5118 tags and properties}.
5119 @orgcmd{C-c a M,org-tags-view}
5120 @vindex org-tags-match-list-sublevels
5121 Create a global list of tag matches from all agenda files, but check
5122 only TODO items and force checking subitems (see the option
5123 @code{org-tags-match-list-sublevels}).
5124 @end table
5126 These commands all prompt for a match string which allows basic Boolean logic
5127 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5128 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5129 which are tagged, like @samp{Kathy} or @samp{Sally}.  The full syntax of the search
5130 string is rich and allows also matching against TODO keywords, entry levels
5131 and properties.  For a complete description with many examples, see
5132 @ref{Matching tags and properties}.
5135 @node Properties and Columns, Dates and Times, Tags, Top
5136 @chapter Properties and columns
5137 @cindex properties
5139 A property is a key-value pair associated with an entry.  Properties can be
5140 set so they are associated with a single entry, with every entry in a tree,
5141 or with every entry in an Org mode file.
5143 There are two main applications for properties in Org mode.  First,
5144 properties are like tags, but with a value.  Imagine maintaining a file where
5145 you document bugs and plan releases for a piece of software.  Instead of
5146 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5147 property, say @code{:Release:}, that in different subtrees has different
5148 values, such as @code{1.0} or @code{2.0}.  Second, you can use properties to
5149 implement (very basic) database capabilities in an Org buffer.  Imagine
5150 keeping track of your music CDs, where properties could be things such as the
5151 album, artist, date of release, number of tracks, and so on.
5153 Properties can be conveniently edited and viewed in column view
5154 (@pxref{Column view}).
5156 @menu
5157 * Property syntax::             How properties are spelled out
5158 * Special properties::          Access to other Org mode features
5159 * Property searches::           Matching property values
5160 * Property inheritance::        Passing values down the tree
5161 * Column view::                 Tabular viewing and editing
5162 * Property API::                Properties for Lisp programmers
5163 @end menu
5165 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
5166 @section Property syntax
5167 @cindex property syntax
5168 @cindex drawer, for properties
5170 Properties are key-value pairs.  When they are associated with a single entry
5171 or with a tree they need to be inserted into a special
5172 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}.  Each property
5173 is specified on a single line, with the key (surrounded by colons)
5174 first, and the value after it.  Here is an example:
5176 @example
5177 * CD collection
5178 ** Classic
5179 *** Goldberg Variations
5180     :PROPERTIES:
5181     :Title:     Goldberg Variations
5182     :Composer:  J.S. Bach
5183     :Artist:    Glen Gould
5184     :Publisher: Deutsche Grammophon
5185     :NDisks:    1
5186     :END:
5187 @end example
5189 Depending on the value of @code{org-use-property-inheritance}, a property set
5190 this way will either be associated with a single entry, or the sub-tree
5191 defined by the entry, see @ref{Property inheritance}.
5193 You may define the allowed values for a particular property @samp{:Xyz:}
5194 by setting a property @samp{:Xyz_ALL:}.  This special property is
5195 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5196 the entire tree.  When allowed values are defined, setting the
5197 corresponding property becomes easier and is less prone to typing
5198 errors.  For the example with the CD collection, we can predefine
5199 publishers and the number of disks in a box like this:
5201 @example
5202 * CD collection
5203   :PROPERTIES:
5204   :NDisks_ALL:  1 2 3 4
5205   :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5206   :END:
5207 @end example
5209 If you want to set properties that can be inherited by any entry in a
5210 file, use a line like
5211 @cindex property, _ALL
5212 @cindex #+PROPERTY
5213 @example
5214 #+PROPERTY: NDisks_ALL 1 2 3 4
5215 @end example
5217 Contrary to properties set from a special drawer, you have to refresh the
5218 buffer with @kbd{C-c C-c} to activate this changes.
5220 If you want to add to the value of an existing property, append a @code{+} to
5221 the property name.  The following results in the property @code{var} having
5222 the value ``foo=1 bar=2''.
5223 @cindex property, +
5224 @example
5225 #+PROPERTY: var  foo=1
5226 #+PROPERTY: var+ bar=2
5227 @end example
5229 It is also possible to add to the values of inherited properties.  The
5230 following results in the @code{genres} property having the value ``Classic
5231 Baroque'' under the @code{Goldberg Variations} subtree.
5232 @cindex property, +
5233 @example
5234 * CD collection
5235 ** Classic
5236     :PROPERTIES:
5237     :GENRES: Classic
5238     :END:
5239 *** Goldberg Variations
5240     :PROPERTIES:
5241     :Title:     Goldberg Variations
5242     :Composer:  J.S. Bach
5243     :Artist:    Glen Gould
5244     :Publisher: Deutsche Grammophon
5245     :NDisks:    1
5246     :GENRES+:   Baroque
5247     :END:
5248 @end example
5249 Note that a property can only have one entry per Drawer.
5251 @vindex org-global-properties
5252 Property values set with the global variable
5253 @code{org-global-properties} can be inherited by all entries in all
5254 Org files.
5256 @noindent
5257 The following commands help to work with properties:
5259 @table @kbd
5260 @orgcmd{M-@key{TAB},pcomplete}
5261 After an initial colon in a line, complete property keys.  All keys used
5262 in the current file will be offered as possible completions.
5263 @orgcmd{C-c C-x p,org-set-property}
5264 Set a property.  This prompts for a property name and a value.  If
5265 necessary, the property drawer is created as well.
5266 @item C-u M-x org-insert-drawer RET
5267 @cindex org-insert-drawer
5268 Insert a property drawer into the current entry.  The drawer will be
5269 inserted early in the entry, but after the lines with planning
5270 information like deadlines.
5271 @orgcmd{C-c C-c,org-property-action}
5272 With the cursor in a property drawer, this executes property commands.
5273 @orgcmd{C-c C-c s,org-set-property}
5274 Set a property in the current entry.  Both the property and the value
5275 can be inserted using completion.
5276 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5277 Switch property at point to the next/previous allowed value.
5278 @orgcmd{C-c C-c d,org-delete-property}
5279 Remove a property from the current entry.
5280 @orgcmd{C-c C-c D,org-delete-property-globally}
5281 Globally remove a property, from all entries in the current file.
5282 @orgcmd{C-c C-c c,org-compute-property-at-point}
5283 Compute the property at point, using the operator and scope from the
5284 nearest column format definition.
5285 @end table
5287 @node Special properties, Property searches, Property syntax, Properties and Columns
5288 @section Special properties
5289 @cindex properties, special
5291 Special properties provide an alternative access method to Org mode features,
5292 like the TODO state or the priority of an entry, discussed in the previous
5293 chapters.  This interface exists so that you can include these states in a
5294 column view (@pxref{Column view}), or to use them in queries.  The following
5295 property names are special and (except for @code{:CATEGORY:}) should not be
5296 used as keys in the properties drawer:
5298 @cindex property, special, ID
5299 @cindex property, special, TODO
5300 @cindex property, special, TAGS
5301 @cindex property, special, ALLTAGS
5302 @cindex property, special, CATEGORY
5303 @cindex property, special, PRIORITY
5304 @cindex property, special, DEADLINE
5305 @cindex property, special, SCHEDULED
5306 @cindex property, special, CLOSED
5307 @cindex property, special, TIMESTAMP
5308 @cindex property, special, TIMESTAMP_IA
5309 @cindex property, special, CLOCKSUM
5310 @cindex property, special, CLOCKSUM_T
5311 @cindex property, special, BLOCKED
5312 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5313 @cindex property, special, ITEM
5314 @cindex property, special, FILE
5315 @example
5316 ID           @r{A globally unique ID used for synchronization during}
5317              @r{iCalendar or MobileOrg export.}
5318 TODO         @r{The TODO keyword of the entry.}
5319 TAGS         @r{The tags defined directly in the headline.}
5320 ALLTAGS      @r{All tags, including inherited ones.}
5321 CATEGORY     @r{The category of an entry.}
5322 PRIORITY     @r{The priority of the entry, a string with a single letter.}
5323 DEADLINE     @r{The deadline time string, without the angular brackets.}
5324 SCHEDULED    @r{The scheduling timestamp, without the angular brackets.}
5325 CLOSED       @r{When was this entry closed?}
5326 TIMESTAMP    @r{The first keyword-less timestamp in the entry.}
5327 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5328 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
5329              @r{must be run first to compute the values in the current buffer.}
5330 CLOCKSUM_T   @r{The sum of CLOCK intervals in the subtree for today.}
5331              @r{@code{org-clock-sum-today} must be run first to compute the}
5332              @r{values in the current buffer.}
5333 BLOCKED      @r{"t" if task is currently blocked by children or siblings}
5334 ITEM         @r{The headline of the entry.}
5335 FILE         @r{The filename the entry is located in.}
5336 @end example
5338 @node Property searches, Property inheritance, Special properties, Properties and Columns
5339 @section Property searches
5340 @cindex properties, searching
5341 @cindex searching, of properties
5343 To create sparse trees and special lists with selection based on properties,
5344 the same commands are used as for tag searches (@pxref{Tag searches}).
5346 @table @kbd
5347 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5348 Create a sparse tree with all matching entries.  With a
5349 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5350 @orgcmd{C-c a m,org-tags-view}
5351 Create a global list of tag/property  matches from all agenda files.
5352 @xref{Matching tags and properties}.
5353 @orgcmd{C-c a M,org-tags-view}
5354 @vindex org-tags-match-list-sublevels
5355 Create a global list of tag matches from all agenda files, but check
5356 only TODO items and force checking of subitems (see the option
5357 @code{org-tags-match-list-sublevels}).
5358 @end table
5360 The syntax for the search string is described in @ref{Matching tags and
5361 properties}.
5363 There is also a special command for creating sparse trees based on a
5364 single property:
5366 @table @kbd
5367 @orgkey{C-c / p}
5368 Create a sparse tree based on the value of a property.  This first
5369 prompts for the name of a property, and then for a value.  A sparse tree
5370 is created with all entries that define this property with the given
5371 value.  If you enclose the value in curly braces, it is interpreted as
5372 a regular expression and matched against the property values.
5373 @end table
5375 @node Property inheritance, Column view, Property searches, Properties and Columns
5376 @section Property Inheritance
5377 @cindex properties, inheritance
5378 @cindex inheritance, of properties
5380 @vindex org-use-property-inheritance
5381 The outline structure of Org mode documents lends itself to an
5382 inheritance model of properties: if the parent in a tree has a certain
5383 property, the children can inherit this property.  Org mode does not
5384 turn this on by default, because it can slow down property searches
5385 significantly and is often not needed.  However, if you find inheritance
5386 useful, you can turn it on by setting the variable
5387 @code{org-use-property-inheritance}.  It may be set to @code{t} to make
5388 all properties inherited from the parent, to a list of properties
5389 that should be inherited, or to a regular expression that matches
5390 inherited properties.  If a property has the value @code{nil}, this is
5391 interpreted as an explicit undefine of the property, so that inheritance
5392 search will stop at this value and return @code{nil}.
5394 Org mode has a few properties for which inheritance is hard-coded, at
5395 least for the special applications for which they are used:
5397 @cindex property, COLUMNS
5398 @table @code
5399 @item COLUMNS
5400 The @code{:COLUMNS:} property defines the format of column view
5401 (@pxref{Column view}).  It is inherited in the sense that the level
5402 where a @code{:COLUMNS:} property is defined is used as the starting
5403 point for a column view table, independently of the location in the
5404 subtree from where columns view is turned on.
5405 @item CATEGORY
5406 @cindex property, CATEGORY
5407 For agenda view, a category set through a @code{:CATEGORY:} property
5408 applies to the entire subtree.
5409 @item ARCHIVE
5410 @cindex property, ARCHIVE
5411 For archiving, the @code{:ARCHIVE:} property may define the archive
5412 location for the entire subtree (@pxref{Moving subtrees}).
5413 @item LOGGING
5414 @cindex property, LOGGING
5415 The LOGGING property may define logging settings for an entry or a
5416 subtree (@pxref{Tracking TODO state changes}).
5417 @end table
5419 @node Column view, Property API, Property inheritance, Properties and Columns
5420 @section Column view
5422 A great way to view and edit properties in an outline tree is
5423 @emph{column view}.  In column view, each outline node is turned into a
5424 table row.  Columns in this table provide access to properties of the
5425 entries.  Org mode implements columns by overlaying a tabular structure
5426 over the headline of each item.  While the headlines have been turned
5427 into a table row, you can still change the visibility of the outline
5428 tree.  For example, you get a compact table by switching to CONTENTS
5429 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5430 is active), but you can still open, read, and edit the entry below each
5431 headline.  Or, you can switch to column view after executing a sparse
5432 tree command and in this way get a table only for the selected items.
5433 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5434 queries have collected selected items, possibly from a number of files.
5436 @menu
5437 * Defining columns::            The COLUMNS format property
5438 * Using column view::           How to create and use column view
5439 * Capturing column view::       A dynamic block for column view
5440 @end menu
5442 @node Defining columns, Using column view, Column view, Column view
5443 @subsection Defining columns
5444 @cindex column view, for properties
5445 @cindex properties, column view
5447 Setting up a column view first requires defining the columns.  This is
5448 done by defining a column format line.
5450 @menu
5451 * Scope of column definitions::  Where defined, where valid?
5452 * Column attributes::           Appearance and content of a column
5453 @end menu
5455 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5456 @subsubsection Scope of column definitions
5458 To define a column format for an entire file, use a line like
5460 @cindex #+COLUMNS
5461 @example
5462 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5463 @end example
5465 To specify a format that only applies to a specific tree, add a
5466 @code{:COLUMNS:} property to the top node of that tree, for example:
5468 @example
5469 ** Top node for columns view
5470    :PROPERTIES:
5471    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5472    :END:
5473 @end example
5475 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5476 for the entry itself, and for the entire subtree below it.  Since the
5477 column definition is part of the hierarchical structure of the document,
5478 you can define columns on level 1 that are general enough for all
5479 sublevels, and more specific columns further down, when you edit a
5480 deeper part of the tree.
5482 @node Column attributes,  , Scope of column definitions, Defining columns
5483 @subsubsection Column attributes
5484 A column definition sets the attributes of a column.  The general
5485 definition looks like this:
5487 @example
5488  %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5489 @end example
5491 @noindent
5492 Except for the percent sign and the property name, all items are
5493 optional.  The individual parts have the following meaning:
5495 @example
5496 @var{width}           @r{An integer specifying the width of the column in characters.}
5497                 @r{If omitted, the width will be determined automatically.}
5498 @var{property}        @r{The property that should be edited in this column.}
5499                 @r{Special properties representing meta data are allowed here}
5500                 @r{as well (@pxref{Special properties})}
5501 @var{title}           @r{The header text for the column.  If omitted, the property}
5502                 @r{name is used.}
5503 @{@var{summary-type}@}  @r{The summary type.  If specified, the column values for}
5504                 @r{parent nodes are computed from the children.}
5505                 @r{Supported summary types are:}
5506                 @{+@}       @r{Sum numbers in this column.}
5507                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
5508                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
5509                 @{:@}       @r{Sum times, HH:MM, plain numbers are hours.}
5510                 @{X@}       @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5511                 @{X/@}      @r{Checkbox status, @samp{[n/m]}.}
5512                 @{X%@}      @r{Checkbox status, @samp{[n%]}.}
5513                 @{min@}     @r{Smallest number in column.}
5514                 @{max@}     @r{Largest number.}
5515                 @{mean@}    @r{Arithmetic mean of numbers.}
5516                 @{:min@}    @r{Smallest time value in column.}
5517                 @{:max@}    @r{Largest time value.}
5518                 @{:mean@}   @r{Arithmetic mean of time values.}
5519                 @{@@min@}    @r{Minimum age (in days/hours/mins/seconds).}
5520                 @{@@max@}    @r{Maximum age (in days/hours/mins/seconds).}
5521                 @{@@mean@}   @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5522                 @{est+@}    @r{Add low-high estimates.}
5523 @end example
5525 @noindent
5526 Be aware that you can only have one summary type for any property you
5527 include.  Subsequent columns referencing the same property will all display the
5528 same summary information.
5530 The @code{est+} summary type requires further explanation.  It is used for
5531 combining estimates, expressed as low-high ranges.  For example, instead
5532 of estimating a particular task will take 5 days, you might estimate it as
5533 5--6 days if you're fairly confident you know how much work is required, or
5534 1--10 days if you don't really know what needs to be done.  Both ranges
5535 average at 5.5 days, but the first represents a more predictable delivery.
5537 When combining a set of such estimates, simply adding the lows and highs
5538 produces an unrealistically wide result.  Instead, @code{est+} adds the
5539 statistical mean and variance of the sub-tasks, generating a final estimate
5540 from the sum.  For example, suppose you had ten tasks, each of which was
5541 estimated at 0.5 to 2 days of work.  Straight addition produces an estimate
5542 of 5 to 20 days, representing what to expect if everything goes either
5543 extremely well or extremely poorly.  In contrast, @code{est+} estimates the
5544 full job more realistically, at 10--15 days.
5546 Numbers are right-aligned when a format specifier with an explicit width like
5547 @code{%5d} or @code{%5.1f} is used.
5549 Here is an example for a complete columns definition, along with allowed
5550 values.
5552 @example
5553 :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.}
5554                    %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5555 :Owner_ALL:    Tammy Mark Karl Lisa Don
5556 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
5557 :Approved_ALL: "[ ]" "[X]"
5558 @end example
5560 @noindent
5561 The first column, @samp{%25ITEM}, means the first 25 characters of the
5562 item itself, i.e., of the headline.  You probably always should start the
5563 column definition with the @samp{ITEM} specifier.  The other specifiers
5564 create columns @samp{Owner} with a list of names as allowed values, for
5565 @samp{Status} with four different possible values, and for a checkbox
5566 field @samp{Approved}.  When no width is given after the @samp{%}
5567 character, the column will be exactly as wide as it needs to be in order
5568 to fully display all values.  The @samp{Approved} column does have a
5569 modified title (@samp{Approved?}, with a question mark).  Summaries will
5570 be created for the @samp{Time_Estimate} column by adding time duration
5571 expressions like HH:MM, and for the @samp{Approved} column, by providing
5572 an @samp{[X]} status if all children have been checked.  The
5573 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5574 sums of CLOCK intervals in the subtree, either for all clocks or just for
5575 today.
5577 @node Using column view, Capturing column view, Defining columns, Column view
5578 @subsection Using column view
5580 @table @kbd
5581 @tsubheading{Turning column view on and off}
5582 @orgcmd{C-c C-x C-c,org-columns}
5583 @vindex org-columns-default-format
5584 Turn on column view.  If the cursor is before the first headline in the file,
5585 column view is turned on for the entire file, using the @code{#+COLUMNS}
5586 definition.  If the cursor is somewhere inside the outline, this command
5587 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5588 defines a format.  When one is found, the column view table is established
5589 for the tree starting at the entry that contains the @code{:COLUMNS:}
5590 property.  If no such property is found, the format is taken from the
5591 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5592 and column view is established for the current entry and its subtree.
5593 @orgcmd{r,org-columns-redo}
5594 Recreate the column view, to include recent changes made in the buffer.
5595 @orgcmd{g,org-columns-redo}
5596 Same as @kbd{r}.
5597 @orgcmd{q,org-columns-quit}
5598 Exit column view.
5599 @tsubheading{Editing values}
5600 @item @key{left} @key{right} @key{up} @key{down}
5601 Move through the column view from field to field.
5602 @kindex S-@key{left}
5603 @kindex S-@key{right}
5604 @item  S-@key{left}/@key{right}
5605 Switch to the next/previous allowed value of the field.  For this, you
5606 have to have specified allowed values for a property.
5607 @item 1..9,0
5608 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5609 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5610 Same as @kbd{S-@key{left}/@key{right}}
5611 @orgcmd{e,org-columns-edit-value}
5612 Edit the property at point.  For the special properties, this will
5613 invoke the same interface that you normally use to change that
5614 property.  For example, when editing a TAGS property, the tag completion
5615 or fast selection interface will pop up.
5616 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5617 When there is a checkbox at point, toggle it.
5618 @orgcmd{v,org-columns-show-value}
5619 View the full value of this property.  This is useful if the width of
5620 the column is smaller than that of the value.
5621 @orgcmd{a,org-columns-edit-allowed}
5622 Edit the list of allowed values for this property.  If the list is found
5623 in the hierarchy, the modified values is stored there.  If no list is
5624 found, the new value is stored in the first entry that is part of the
5625 current column view.
5626 @tsubheading{Modifying the table structure}
5627 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5628 Make the column narrower/wider by one character.
5629 @orgcmd{S-M-@key{right},org-columns-new}
5630 Insert a new column, to the left of the current column.
5631 @orgcmd{S-M-@key{left},org-columns-delete}
5632 Delete the current column.
5633 @end table
5635 @node Capturing column view,  , Using column view, Column view
5636 @subsection Capturing column view
5638 Since column view is just an overlay over a buffer, it cannot be
5639 exported or printed directly.  If you want to capture a column view, use
5640 a @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
5641 of this block looks like this:
5643 @cindex #+BEGIN, columnview
5644 @example
5645 * The column view
5646 #+BEGIN: columnview :hlines 1 :id "label"
5648 #+END:
5649 @end example
5651 @noindent This dynamic block has the following parameters:
5653 @table @code
5654 @item :id
5655 This is the most important parameter.  Column view is a feature that is
5656 often localized to a certain (sub)tree, and the capture block might be
5657 at a different location in the file.  To identify the tree whose view to
5658 capture, you can use 4 values:
5659 @cindex property, ID
5660 @example
5661 local     @r{use the tree in which the capture block is located}
5662 global    @r{make a global view, including all headings in the file}
5663 "file:@var{path-to-file}"
5664           @r{run column view at the top of this file}
5665 "@var{ID}"      @r{call column view in the tree that has an @code{:ID:}}
5666           @r{property with the value @i{label}.  You can use}
5667           @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5668           @r{the current entry and copy it to the kill-ring.}
5669 @end example
5670 @item :hlines
5671 When @code{t}, insert an hline after every line.  When a number @var{N}, insert
5672 an hline before each headline with level @code{<= @var{N}}.
5673 @item :vlines
5674 When set to @code{t}, force column groups to get vertical lines.
5675 @item :maxlevel
5676 When set to a number, don't capture entries below this level.
5677 @item :skip-empty-rows
5678 When set to @code{t}, skip rows where the only non-empty specifier of the
5679 column view is @code{ITEM}.
5681 @end table
5683 @noindent
5684 The following commands insert or update the dynamic block:
5686 @table @kbd
5687 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5688 Insert a dynamic block capturing a column view.  You will be prompted
5689 for the scope or ID of the view.
5690 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5691 Update dynamic block at point.  The cursor needs to be in the
5692 @code{#+BEGIN} line of the dynamic block.
5693 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5694 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
5695 you have several clock table blocks, column-capturing blocks or other dynamic
5696 blocks in a buffer.
5697 @end table
5699 You can add formulas to the column view table and you may add plotting
5700 instructions in front of the table---these will survive an update of the
5701 block.  If there is a @code{#+TBLFM:} after the table, the table will
5702 actually be recalculated automatically after an update.
5704 An alternative way to capture and process property values into a table is
5705 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5706 package@footnote{Contributed packages are not part of Emacs, but are
5707 distributed with the main distribution of Org (visit
5708 @uref{http://orgmode.org}).}.  It provides a general API to collect
5709 properties from entries in a certain scope, and arbitrary Lisp expressions to
5710 process these values before inserting them into a table or a dynamic block.
5712 @node Property API,  , Column view, Properties and Columns
5713 @section The Property API
5714 @cindex properties, API
5715 @cindex API, for properties
5717 There is a full API for accessing and changing properties.  This API can
5718 be used by Emacs Lisp programs to work with properties and to implement
5719 features based on them.  For more information see @ref{Using the
5720 property API}.
5722 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5723 @chapter Dates and times
5724 @cindex dates
5725 @cindex times
5726 @cindex timestamp
5727 @cindex date stamp
5729 To assist project planning, TODO items can be labeled with a date and/or
5730 a time.  The specially formatted string carrying the date and time
5731 information is called a @emph{timestamp} in Org mode.  This may be a
5732 little confusing because timestamp is often used as indicating when
5733 something was created or last changed.  However, in Org mode this term
5734 is used in a much wider sense.
5736 @menu
5737 * Timestamps::                  Assigning a time to a tree entry
5738 * Creating timestamps::         Commands which insert timestamps
5739 * Deadlines and scheduling::    Planning your work
5740 * Clocking work time::          Tracking how long you spend on a task
5741 * Effort estimates::            Planning work effort in advance
5742 * Relative timer::              Notes with a running timer
5743 * Countdown timer::             Starting a countdown timer for a task
5744 @end menu
5747 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5748 @section Timestamps, deadlines, and scheduling
5749 @cindex timestamps
5750 @cindex ranges, time
5751 @cindex date stamps
5752 @cindex deadlines
5753 @cindex scheduling
5755 A timestamp is a specification of a date (possibly with a time or a range of
5756 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5757 simplest form, the day name is optional when you type the date yourself.
5758 However, any dates inserted or modified by Org will add that day name, for
5759 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5760 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5761 date/time format.  To use an alternative format, see @ref{Custom time
5762 format}.}.  A timestamp can appear anywhere in the headline or body of an Org
5763 tree entry.  Its presence causes entries to be shown on specific dates in the
5764 agenda (@pxref{Weekly/daily agenda}).  We distinguish:
5766 @table @var
5767 @item Plain timestamp; Event; Appointment
5768 @cindex timestamp
5769 @cindex appointment
5770 A simple timestamp just assigns a date/time to an item.  This is just
5771 like writing down an appointment or event in a paper agenda.  In the
5772 timeline and agenda displays, the headline of an entry associated with a
5773 plain timestamp will be shown exactly on that date.
5775 @example
5776 * Meet Peter at the movies
5777   <2006-11-01 Wed 19:15>
5778 * Discussion on climate change
5779   <2006-11-02 Thu 20:00-22:00>
5780 @end example
5782 @item Timestamp with repeater interval
5783 @cindex timestamp, with repeater interval
5784 A timestamp may contain a @emph{repeater interval}, indicating that it
5785 applies not only on the given date, but again and again after a certain
5786 interval of N days (d), weeks (w), months (m), or years (y).  The
5787 following will show up in the agenda every Wednesday:
5789 @example
5790 * Pick up Sam at school
5791   <2007-05-16 Wed 12:30 +1w>
5792 @end example
5794 @item Diary-style sexp entries
5795 For more complex date specifications, Org mode supports using the special
5796 sexp diary entries implemented in the Emacs calendar/diary
5797 package@footnote{When working with the standard diary sexp functions, you
5798 need to be very careful with the order of the arguments.  That order depend
5799 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5800 versions, @code{european-calendar-style}).  For example, to specify a date
5801 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5802 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5803 the settings.  This has been the source of much confusion.  Org mode users
5804 can resort to special versions of these functions like @code{org-date} or
5805 @code{org-anniversary}.  These work just like the corresponding @code{diary-}
5806 functions, but with stable ISO order of arguments (year, month, day) wherever
5807 applicable, independent of the value of @code{calendar-date-style}.}.  For
5808 example with optional time
5810 @example
5811 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5812   <%%(diary-float t 4 2)>
5813 @end example
5815 @item Time/Date range
5816 @cindex timerange
5817 @cindex date range
5818 Two timestamps connected by @samp{--} denote a range.  The headline
5819 will be shown on the first and last day of the range, and on any dates
5820 that are displayed and fall in the range.  Here is an example:
5822 @example
5823 ** Meeting in Amsterdam
5824    <2004-08-23 Mon>--<2004-08-26 Thu>
5825 @end example
5827 @item Inactive timestamp
5828 @cindex timestamp, inactive
5829 @cindex inactive timestamp
5830 Just like a plain timestamp, but with square brackets instead of
5831 angular ones.  These timestamps are inactive in the sense that they do
5832 @emph{not} trigger an entry to show up in the agenda.
5834 @example
5835 * Gillian comes late for the fifth time
5836   [2006-11-01 Wed]
5837 @end example
5839 @end table
5841 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5842 @section Creating timestamps
5843 @cindex creating timestamps
5844 @cindex timestamps, creating
5846 For Org mode to recognize timestamps, they need to be in the specific
5847 format.  All commands listed below produce timestamps in the correct
5848 format.
5850 @table @kbd
5851 @orgcmd{C-c .,org-time-stamp}
5852 Prompt for a date and insert a corresponding timestamp.  When the cursor is
5853 at an existing timestamp in the buffer, the command is used to modify this
5854 timestamp instead of inserting a new one.  When this command is used twice in
5855 succession, a time range is inserted.
5857 @orgcmd{C-c !,org-time-stamp-inactive}
5858 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5859 an agenda entry.
5861 @kindex C-u C-c .
5862 @kindex C-u C-c !
5863 @item C-u C-c .
5864 @itemx C-u C-c !
5865 @vindex org-time-stamp-rounding-minutes
5866 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5867 contains date and time.  The default time can be rounded to multiples of 5
5868 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5870 @orgkey{C-c C-c}
5871 Normalize timestamp, insert/fix day name if missing or wrong.
5873 @orgcmd{C-c <,org-date-from-calendar}
5874 Insert a timestamp corresponding to the cursor date in the Calendar.
5876 @orgcmd{C-c >,org-goto-calendar}
5877 Access the Emacs calendar for the current date.  If there is a
5878 timestamp in the current line, go to the corresponding date
5879 instead.
5881 @orgcmd{C-c C-o,org-open-at-point}
5882 Access the agenda for the date given by the timestamp or -range at
5883 point (@pxref{Weekly/daily agenda}).
5885 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5886 Change date at cursor by one day.  These key bindings conflict with
5887 shift-selection and related modes (@pxref{Conflicts}).
5889 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5890 Change the item under the cursor in a timestamp.  The cursor can be on a
5891 year, month, day, hour or minute.  When the timestamp contains a time range
5892 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5893 shifting the time block with constant length.  To change the length, modify
5894 the second time.  Note that if the cursor is in a headline and not at a
5895 timestamp, these same keys modify the priority of an item.
5896 (@pxref{Priorities}).  The key bindings also conflict with shift-selection and
5897 related modes (@pxref{Conflicts}).
5899 @orgcmd{C-c C-y,org-evaluate-time-range}
5900 @cindex evaluate time range
5901 Evaluate a time range by computing the difference between start and end.
5902 With a prefix argument, insert result after the time range (in a table: into
5903 the following column).
5904 @end table
5907 @menu
5908 * The date/time prompt::        How Org mode helps you entering date and time
5909 * Custom time format::          Making dates look different
5910 @end menu
5912 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5913 @subsection The date/time prompt
5914 @cindex date, reading in minibuffer
5915 @cindex time, reading in minibuffer
5917 @vindex org-read-date-prefer-future
5918 When Org mode prompts for a date/time, the default is shown in default
5919 date/time format, and the prompt therefore seems to ask for a specific
5920 format.  But it will in fact accept date/time information in a variety of
5921 formats.  Generally, the information should start at the beginning of the
5922 string.  Org mode will find whatever information is in
5923 there and derive anything you have not specified from the @emph{default date
5924 and time}.  The default is usually the current date and time, but when
5925 modifying an existing timestamp, or when entering the second stamp of a
5926 range, it is taken from the stamp in the buffer.  When filling in
5927 information, Org mode assumes that most of the time you will want to enter a
5928 date in the future: if you omit the month/year and the given day/month is
5929 @i{before} today, it will assume that you mean a future date@footnote{See the
5930 variable @code{org-read-date-prefer-future}.  You may set that variable to
5931 the symbol @code{time} to even make a time before now shift the date to
5932 tomorrow.}.  If the date has been automatically shifted into the future, the
5933 time prompt will show this with @samp{(=>F).}
5935 For example, let's assume that today is @b{June 13, 2006}.  Here is how
5936 various inputs will be interpreted, the items filled in by Org mode are
5937 in @b{bold}.
5939 @example
5940 3-2-5         @result{} 2003-02-05
5941 2/5/3         @result{} 2003-02-05
5942 14            @result{} @b{2006}-@b{06}-14
5943 12            @result{} @b{2006}-@b{07}-12
5944 2/5           @result{} @b{2007}-02-05
5945 Fri           @result{} nearest Friday after the default date
5946 sep 15        @result{} @b{2006}-09-15
5947 feb 15        @result{} @b{2007}-02-15
5948 sep 12 9      @result{} 2009-09-12
5949 12:45         @result{} @b{2006}-@b{06}-@b{13} 12:45
5950 22 sept 0:34  @result{} @b{2006}-09-22 0:34
5951 w4            @result{} ISO week for of the current year @b{2006}
5952 2012 w4 fri   @result{} Friday of ISO week 4 in 2012
5953 2012-w04-5    @result{} Same as above
5954 @end example
5956 Furthermore you can specify a relative date by giving, as the @emph{first}
5957 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
5958 indicate change in hours, days, weeks, months, or years.  With a single plus
5959 or minus, the date is always relative to today.  With a double plus or minus,
5960 it is relative to the default date.  If instead of a single letter, you use
5961 the abbreviation of day name, the date will be the Nth such day, e.g.:
5963 @example
5964 +0            @result{} today
5965 .             @result{} today
5966 +4d           @result{} four days from today
5967 +4            @result{} same as above
5968 +2w           @result{} two weeks from today
5969 ++5           @result{} five days from default date
5970 +2tue         @result{} second Tuesday from now
5971 -wed          @result{} last Wednesday
5972 @end example
5974 @vindex parse-time-months
5975 @vindex parse-time-weekdays
5976 The function understands English month and weekday abbreviations.  If
5977 you want to use unabbreviated names and/or other languages, configure
5978 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5980 @vindex org-read-date-force-compatible-dates
5981 Not all dates can be represented in a given Emacs implementation.  By default
5982 Org mode forces dates into the compatibility range 1970--2037 which works on
5983 all Emacs implementations.  If you want to use dates outside of this range,
5984 read the docstring of the variable
5985 @code{org-read-date-force-compatible-dates}.
5987 You can specify a time range by giving start and end times or by giving a
5988 start time and a duration (in HH:MM format).  Use one or two dash(es) as the
5989 separator in the former case and use '+' as the separator in the latter
5990 case, e.g.:
5992 @example
5993 11am-1:15pm    @result{} 11:00-13:15
5994 11am--1:15pm   @result{} same as above
5995 11am+2:15      @result{} same as above
5996 @end example
5998 @cindex calendar, for selecting date
5999 @vindex org-popup-calendar-for-date-prompt
6000 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
6001 you don't need/want the calendar, configure the variable
6002 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
6003 prompt, either by clicking on a date in the calendar, or by pressing
6004 @key{RET}, the date selected in the calendar will be combined with the
6005 information entered at the prompt.  You can control the calendar fully
6006 from the minibuffer:
6008 @kindex <
6009 @kindex >
6010 @kindex M-v
6011 @kindex C-v
6012 @kindex mouse-1
6013 @kindex S-@key{right}
6014 @kindex S-@key{left}
6015 @kindex S-@key{down}
6016 @kindex S-@key{up}
6017 @kindex M-S-@key{right}
6018 @kindex M-S-@key{left}
6019 @kindex @key{RET}
6020 @example
6021 @key{RET}           @r{Choose date at cursor in calendar.}
6022 mouse-1        @r{Select date by clicking on it.}
6023 S-@key{right}/@key{left}     @r{One day forward/backward.}
6024 S-@key{down}/@key{up}     @r{One week forward/backward.}
6025 M-S-@key{right}/@key{left}   @r{One month forward/backward.}
6026 > / <          @r{Scroll calendar forward/backward by one month.}
6027 M-v / C-v      @r{Scroll calendar forward/backward by 3 months.}
6028 @end example
6030 @vindex org-read-date-display-live
6031 The actions of the date/time prompt may seem complex, but I assure you they
6032 will grow on you, and you will start getting annoyed by pretty much any other
6033 way of entering a date/time out there.  To help you understand what is going
6034 on, the current interpretation of your input will be displayed live in the
6035 minibuffer@footnote{If you find this distracting, turn the display off with
6036 @code{org-read-date-display-live}.}.
6038 @node Custom time format,  , The date/time prompt, Creating timestamps
6039 @subsection Custom time format
6040 @cindex custom date/time format
6041 @cindex time format, custom
6042 @cindex date format, custom
6044 @vindex org-display-custom-times
6045 @vindex org-time-stamp-custom-formats
6046 Org mode uses the standard ISO notation for dates and times as it is
6047 defined in ISO 8601.  If you cannot get used to this and require another
6048 representation of date and time to keep you happy, you can get it by
6049 customizing the options @code{org-display-custom-times} and
6050 @code{org-time-stamp-custom-formats}.
6052 @table @kbd
6053 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6054 Toggle the display of custom formats for dates and times.
6055 @end table
6057 @noindent
6058 Org mode needs the default format for scanning, so the custom date/time
6059 format does not @emph{replace} the default format---instead it is put
6060 @emph{over} the default format using text properties.  This has the
6061 following consequences:
6062 @itemize @bullet
6063 @item
6064 You cannot place the cursor onto a timestamp anymore, only before or
6065 after.
6066 @item
6067 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6068 each component of a timestamp.  If the cursor is at the beginning of
6069 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6070 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
6071 time will be changed by one minute.
6072 @item
6073 If the timestamp contains a range of clock times or a repeater, these
6074 will not be overlaid, but remain in the buffer as they were.
6075 @item
6076 When you delete a timestamp character-by-character, it will only
6077 disappear from the buffer after @emph{all} (invisible) characters
6078 belonging to the ISO timestamp have been removed.
6079 @item
6080 If the custom timestamp format is longer than the default and you are
6081 using dates in tables, table alignment will be messed up.  If the custom
6082 format is shorter, things do work as expected.
6083 @end itemize
6086 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
6087 @section Deadlines and scheduling
6089 A timestamp may be preceded by special keywords to facilitate planning:
6091 @table @var
6092 @item DEADLINE
6093 @cindex DEADLINE keyword
6095 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6096 to be finished on that date.
6098 @vindex org-deadline-warning-days
6099 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6100 On the deadline date, the task will be listed in the agenda.  In
6101 addition, the agenda for @emph{today} will carry a warning about the
6102 approaching or missed deadline, starting
6103 @code{org-deadline-warning-days} before the due date, and continuing
6104 until the entry is marked DONE@.  An example:
6106 @example
6107 *** TODO write article about the Earth for the Guide
6108     DEADLINE: <2004-02-29 Sun>
6109     The editor in charge is [[bbdb:Ford Prefect]]
6110 @end example
6112 You can specify a different lead time for warnings for a specific
6113 deadlines using the following syntax.  Here is an example with a warning
6114 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.  This warning is
6115 deactivated if the task get scheduled and you set
6116 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6118 @item SCHEDULED
6119 @cindex SCHEDULED keyword
6121 Meaning: you are planning to start working on that task on the given
6122 date.
6124 @vindex org-agenda-skip-scheduled-if-done
6125 The headline will be listed under the given date@footnote{It will still
6126 be listed on that date after it has been marked DONE@.  If you don't like
6127 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
6128 addition, a reminder that the scheduled date has passed will be present
6129 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6130 the task will automatically be forwarded until completed.
6132 @example
6133 *** TODO Call Trillian for a date on New Years Eve.
6134     SCHEDULED: <2004-12-25 Sat>
6135 @end example
6137 @vindex org-scheduled-delay-days
6138 @vindex org-agenda-skip-scheduled-delay-if-deadline
6139 If you want to @emph{delay} the display of this task in the agenda, use
6140 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6141 25th but will appear two days later.  In case the task contains a repeater,
6142 the delay is considered to affect all occurrences; if you want the delay to
6143 only affect the first scheduled occurrence of the task, use @code{--2d}
6144 instead.  See @code{org-scheduled-delay-days} and
6145 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6146 control this globally or per agenda.
6148 @noindent
6149 @b{Important:} Scheduling an item in Org mode should @i{not} be
6150 understood in the same way that we understand @i{scheduling a meeting}.
6151 Setting a date for a meeting is just a simple appointment, you should
6152 mark this entry with a simple plain timestamp, to get this item shown
6153 on the date where it applies.  This is a frequent misunderstanding by
6154 Org users.  In Org mode, @i{scheduling} means setting a date when you
6155 want to start working on an action item.
6156 @end table
6158 You may use timestamps with repeaters in scheduling and deadline
6159 entries.  Org mode will issue early and late warnings based on the
6160 assumption that the timestamp represents the @i{nearest instance} of
6161 the repeater.  However, the use of diary sexp entries like
6163 @code{<%%(diary-float t 42)>}
6165 in scheduling and deadline timestamps is limited.  Org mode does not
6166 know enough about the internals of each sexp function to issue early and
6167 late warnings.  However, it will show the item on each day where the
6168 sexp entry matches.
6170 @menu
6171 * Inserting deadline/schedule::  Planning items
6172 * Repeated tasks::              Items that show up again and again
6173 @end menu
6175 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
6176 @subsection Inserting deadlines or schedules
6178 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6179 @samp{DEADLINE} dates are inserted on the line right below the headline.  Don't put
6180 any text between this line and the headline.} a deadline or to schedule
6181 an item:
6183 @table @kbd
6185 @orgcmd{C-c C-d,org-deadline}
6186 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will happen
6187 in the line directly following the headline.  Any CLOSED timestamp will be
6188 removed.  When called with a prefix arg, an existing deadline will be removed
6189 from the entry.  Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6190 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6191 and @code{nologredeadline}}, a note will be taken when changing an existing
6192 deadline.
6194 @orgcmd{C-c C-s,org-schedule}
6195 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
6196 happen in the line directly following the headline.  Any CLOSED timestamp
6197 will be removed.  When called with a prefix argument, remove the scheduling
6198 date from the entry.  Depending on the variable
6199 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6200 keywords @code{logreschedule}, @code{lognotereschedule}, and
6201 @code{nologreschedule}}, a note will be taken when changing an existing
6202 scheduling time.
6204 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
6205 @kindex k a
6206 @kindex k s
6207 Mark the current entry for agenda action.  After you have marked the entry
6208 like this, you can open the agenda or the calendar to find an appropriate
6209 date.  With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
6210 schedule the marked item.
6212 @orgcmd{C-c / d,org-check-deadlines}
6213 @cindex sparse tree, for deadlines
6214 @vindex org-deadline-warning-days
6215 Create a sparse tree with all deadlines that are either past-due, or
6216 which will become due within @code{org-deadline-warning-days}.
6217 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
6218 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
6219 all deadlines due tomorrow.
6221 @orgcmd{C-c / b,org-check-before-date}
6222 Sparse tree for deadlines and scheduled items before a given date.
6224 @orgcmd{C-c / a,org-check-after-date}
6225 Sparse tree for deadlines and scheduled items after a given date.
6226 @end table
6228 Note that @code{org-schedule} and @code{org-deadline} supports
6229 setting the date by indicating a relative time: e.g., +1d will set
6230 the date to the next day after today, and --1w will set the date
6231 to the previous week before any current timestamp.
6233 @node Repeated tasks,  , Inserting deadline/schedule, Deadlines and scheduling
6234 @subsection Repeated tasks
6235 @cindex tasks, repeated
6236 @cindex repeated tasks
6238 Some tasks need to be repeated again and again.  Org mode helps to
6239 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6240 or plain timestamp.  In the following example
6241 @example
6242 ** TODO Pay the rent
6243    DEADLINE: <2005-10-01 Sat +1m>
6244 @end example
6245 @noindent
6246 the @code{+1m} is a repeater; the intended interpretation is that the task
6247 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6248 from that time.  You can use yearly, monthly, weekly, daily and hourly repeat
6249 cookies by using the @code{y/w/m/d/h} letters.  If you need both a repeater
6250 and a special warning period in a deadline entry, the repeater should come
6251 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6253 @vindex org-todo-repeat-to-state
6254 Deadlines and scheduled items produce entries in the agenda when they are
6255 over-due, so it is important to be able to mark such an entry as completed
6256 once you have done so.  When you mark a DEADLINE or a SCHEDULE with the TODO
6257 keyword DONE, it will no longer produce entries in the agenda.  The problem
6258 with this is, however, that then also the @emph{next} instance of the
6259 repeated entry will not be active.  Org mode deals with this in the following
6260 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6261 shift the base date of the repeating timestamp by the repeater interval, and
6262 immediately set the entry state back to TODO@footnote{In fact, the target
6263 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6264 the variable @code{org-todo-repeat-to-state}.  If neither of these is
6265 specified, the target state defaults to the first state of the TODO state
6266 sequence.}.  In the example above, setting the state to DONE would actually
6267 switch the date like this:
6269 @example
6270 ** TODO Pay the rent
6271    DEADLINE: <2005-11-01 Tue +1m>
6272 @end example
6274 @vindex org-log-repeat
6275 A timestamp@footnote{You can change this using the option
6276 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6277 @code{lognoterepeat}, and @code{nologrepeat}.  With @code{lognoterepeat}, you
6278 will also be prompted for a note.} will be added under the deadline, to keep
6279 a record that you actually acted on the previous instance of this deadline.
6281 As a consequence of shifting the base date, this entry will no longer be
6282 visible in the agenda when checking past dates, but all future instances
6283 will be visible.
6285 With the @samp{+1m} cookie, the date shift will always be exactly one
6286 month.  So if you have not paid the rent for three months, marking this
6287 entry DONE will still keep it as an overdue deadline.  Depending on the
6288 task, this may not be the best way to handle it.  For example, if you
6289 forgot to call your father for 3 weeks, it does not make sense to call
6290 him 3 times in a single day to make up for it.  Finally, there are tasks
6291 like changing batteries which should always repeat a certain time
6292 @i{after} the last time you did it.  For these tasks, Org mode has
6293 special repeaters  @samp{++} and @samp{.+}.  For example:
6295 @example
6296 ** TODO Call Father
6297    DEADLINE: <2008-02-10 Sun ++1w>
6298    Marking this DONE will shift the date by at least one week,
6299    but also by as many weeks as it takes to get this date into
6300    the future.  However, it stays on a Sunday, even if you called
6301    and marked it done on Saturday.
6302 ** TODO Check the batteries in the smoke detectors
6303    DEADLINE: <2005-11-01 Tue .+1m>
6304    Marking this DONE will shift the date to one month after
6305    today.
6306 @end example
6308 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6309 You may have both scheduling and deadline information for a specific task.
6310 If the repeater is set for the scheduling information only, you probably want
6311 the repeater to be ignored after the deadline.  If so, set the variable
6312 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6313 @code{repeated-after-deadline}.  If you want both scheduling and deadline
6314 information to repeat after the same interval, set the same repeater for both
6315 timestamps.
6317 An alternative to using a repeater is to create a number of copies of a task
6318 subtree, with dates shifted in each copy.  The command @kbd{C-c C-x c} was
6319 created for this purpose, it is described in @ref{Structure editing}.
6322 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
6323 @section Clocking work time
6324 @cindex clocking time
6325 @cindex time clocking
6327 Org mode allows you to clock the time you spend on specific tasks in a
6328 project.  When you start working on an item, you can start the clock.  When
6329 you stop working on that task, or when you mark the task done, the clock is
6330 stopped and the corresponding time interval is recorded.  It also computes
6331 the total time spent on each subtree@footnote{Clocking only works if all
6332 headings are indented with less than 30 stars.  This is a hardcoded
6333 limitation of `lmax' in `org-clock-sum'.} of a project.  And it remembers a
6334 history or tasks recently clocked, to that you can jump quickly between a
6335 number of tasks absorbing your time.
6337 To save the clock history across Emacs sessions, use
6338 @lisp
6339 (setq org-clock-persist 'history)
6340 (org-clock-persistence-insinuate)
6341 @end lisp
6342 When you clock into a new task after resuming Emacs, the incomplete
6343 clock@footnote{To resume the clock under the assumption that you have worked
6344 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6345 will be found (@pxref{Resolving idle time}) and you will be prompted about
6346 what to do with it.
6348 @menu
6349 * Clocking commands::           Starting and stopping a clock
6350 * The clock table::             Detailed reports
6351 * Resolving idle time::         Resolving time when you've been idle
6352 @end menu
6354 @node Clocking commands, The clock table, Clocking work time, Clocking work time
6355 @subsection Clocking commands
6357 @table @kbd
6358 @orgcmd{C-c C-x C-i,org-clock-in}
6359 @vindex org-clock-into-drawer
6360 @vindex org-clock-continuously
6361 @cindex property, LOG_INTO_DRAWER
6362 Start the clock on the current item (clock-in).  This inserts the CLOCK
6363 keyword together with a timestamp.  If this is not the first clocking of
6364 this item, the multiple CLOCK lines will be wrapped into a
6365 @code{:LOGBOOK:} drawer (see also the variable
6366 @code{org-clock-into-drawer}).  You can also overrule
6367 the setting of this variable for a subtree by setting a
6368 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6369 When called with a @kbd{C-u} prefix argument,
6370 select the task from a list of recently clocked tasks.  With two @kbd{C-u
6371 C-u} prefixes, clock into the task at point and mark it as the default task;
6372 the default task will then always be available with letter @kbd{d} when
6373 selecting a clocking task.  With three @kbd{C-u C-u C-u} prefixes, force
6374 continuous clocking by starting the clock when the last clock stopped.@*
6375 @cindex property: CLOCK_MODELINE_TOTAL
6376 @cindex property: LAST_REPEAT
6377 @vindex org-clock-modeline-total
6378 While the clock is running, the current clocking time is shown in the mode
6379 line, along with the title of the task.  The clock time shown will be all
6380 time ever clocked for this task and its children.  If the task has an effort
6381 estimate (@pxref{Effort estimates}), the mode line displays the current
6382 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6383 hook a function doing this to @code{org-clock-in-prepare-hook}.}  If the task
6384 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6385 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6386 will be shown.  More control over what time is shown can be exercised with
6387 the @code{CLOCK_MODELINE_TOTAL} property.  It may have the values
6388 @code{current} to show only the current clocking instance, @code{today} to
6389 show all time clocked on this tasks today (see also the variable
6390 @code{org-extend-today-until}), @code{all} to include all time, or
6391 @code{auto} which is the default@footnote{See also the variable
6392 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6393 mode line entry will pop up a menu with clocking options.
6395 @orgcmd{C-c C-x C-o,org-clock-out}
6396 @vindex org-log-note-clock-out
6397 Stop the clock (clock-out).  This inserts another timestamp at the same
6398 location where the clock was last started.  It also directly computes
6399 the resulting time in inserts it after the time range as @samp{=>
6400 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
6401 possibility to record an additional note together with the clock-out
6402 timestamp@footnote{The corresponding in-buffer setting is:
6403 @code{#+STARTUP: lognoteclock-out}}.
6404 @orgcmd{C-c C-x C-x,org-clock-in-last}
6405 @vindex org-clock-continuously
6406 Reclock the last clocked task.  With one @kbd{C-u} prefix argument,
6407 select the task from the clock history.  With two @kbd{C-u} prefixes,
6408 force continuous clocking by starting the clock when the last clock
6409 stopped.
6410 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6411 Update the effort estimate for the current clock task.
6412 @kindex C-c C-y
6413 @kindex C-c C-c
6414 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6415 Recompute the time interval after changing one of the timestamps.  This
6416 is only necessary if you edit the timestamps directly.  If you change
6417 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6418 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6419 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6420 clock duration keeps the same.
6421 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6422 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6423 the one of the previous (or the next clock) timestamp by the same duration.
6424 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6425 by five minutes, then the clocked-in timestamp of the next clock will be
6426 increased by five minutes.
6427 @orgcmd{C-c C-t,org-todo}
6428 Changing the TODO state of an item to DONE automatically stops the clock
6429 if it is running in this same item.
6430 @orgcmd{C-c C-x C-q,org-clock-cancel}
6431 Cancel the current clock.  This is useful if a clock was started by
6432 mistake, or if you ended up working on something else.
6433 @orgcmd{C-c C-x C-j,org-clock-goto}
6434 Jump to the headline of the currently clocked in task.  With a @kbd{C-u}
6435 prefix arg, select the target task from a list of recently clocked tasks.
6436 @orgcmd{C-c C-x C-d,org-clock-display}
6437 @vindex org-remove-highlights-with-change
6438 Display time summaries for each subtree in the current buffer.  This puts
6439 overlays at the end of each headline, showing the total time recorded under
6440 that heading, including the time of any subheadings.  You can use visibility
6441 cycling to study the tree, but the overlays disappear when you change the
6442 buffer (see variable @code{org-remove-highlights-with-change}) or press
6443 @kbd{C-c C-c}.
6444 @end table
6446 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6447 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6448 worked on or closed during a day.
6450 @strong{Important:} note that both @code{org-clock-out} and
6451 @code{org-clock-in-last} can have a global keybinding and will not
6452 modify the window disposition.
6454 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6455 @subsection The clock table
6456 @cindex clocktable, dynamic block
6457 @cindex report, of clocked time
6459 Org mode can produce quite complex reports based on the time clocking
6460 information.  Such a report is called a @emph{clock table}, because it is
6461 formatted as one or several Org tables.
6463 @table @kbd
6464 @orgcmd{C-c C-x C-r,org-clock-report}
6465 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6466 report as an Org mode table into the current file.  When the cursor is
6467 at an existing clock table, just update it.  When called with a prefix
6468 argument, jump to the first clock report in the current document and
6469 update it.  The clock table always includes also trees with
6470 @code{:ARCHIVE:} tag.
6471 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6472 Update dynamic block at point.  The cursor needs to be in the
6473 @code{#+BEGIN} line of the dynamic block.
6474 @orgkey{C-u C-c C-x C-u}
6475 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
6476 you have several clock table blocks in a buffer.
6477 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6478 Shift the current @code{:block} interval and update the table.  The cursor
6479 needs to be in the @code{#+BEGIN: clocktable} line for this command.  If
6480 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6481 @end table
6484 Here is an example of the frame for a clock table as it is inserted into the
6485 buffer with the @kbd{C-c C-x C-r} command:
6487 @cindex #+BEGIN, clocktable
6488 @example
6489 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6490 #+END: clocktable
6491 @end example
6492 @noindent
6493 @vindex org-clocktable-defaults
6494 The @samp{BEGIN} line and specify a number of options to define the scope,
6495 structure, and formatting of the report.  Defaults for all these options can
6496 be configured in the variable @code{org-clocktable-defaults}.
6498 @noindent First there are options that determine which clock entries are to
6499 be selected:
6500 @example
6501 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
6502              @r{Clocks at deeper levels will be summed into the upper level.}
6503 :scope       @r{The scope to consider.  This can be any of the following:}
6504              nil        @r{the current buffer or narrowed region}
6505              file       @r{the full current buffer}
6506              subtree    @r{the subtree where the clocktable is located}
6507              tree@var{N}      @r{the surrounding level @var{N} tree, for example @code{tree3}}
6508              tree       @r{the surrounding level 1 tree}
6509              agenda     @r{all agenda files}
6510              ("file"..) @r{scan these files}
6511              file-with-archives    @r{current file and its archives}
6512              agenda-with-archives  @r{all agenda files, including archives}
6513 :block       @r{The time block to consider.  This block is specified either}
6514              @r{absolute, or relative to the current time and may be any of}
6515              @r{these formats:}
6516              2007-12-31    @r{New year eve 2007}
6517              2007-12       @r{December 2007}
6518              2007-W50      @r{ISO-week 50 in 2007}
6519              2007-Q2       @r{2nd quarter in 2007}
6520              2007          @r{the year 2007}
6521              today, yesterday, today-@var{N}          @r{a relative day}
6522              thisweek, lastweek, thisweek-@var{N}     @r{a relative week}
6523              thismonth, lastmonth, thismonth-@var{N}  @r{a relative month}
6524              thisyear, lastyear, thisyear-@var{N}     @r{a relative year}
6525              @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6526 :tstart      @r{A time string specifying when to start considering times.}
6527              @r{Relative times like @code{"<-2w>"} can also be used.  See}
6528              @r{@ref{Matching tags and properties} for relative time syntax.}
6529 :tend        @r{A time string specifying when to stop considering times.}
6530              @r{Relative times like @code{"<now>"} can also be used.  See}
6531              @r{@ref{Matching tags and properties} for relative time syntax.}
6532 :wstart      @r{The starting day of the week.  The default is 1 for monday.}
6533 :mstart      @r{The starting day of the month.  The default 1 is for the first}
6534              @r{day of the month.}
6535 :step        @r{@code{week} or @code{day}, to split the table into chunks.}
6536              @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6537 :stepskip0   @r{Do not show steps that have zero time.}
6538 :fileskip0   @r{Do not show table sections from files which did not contribute.}
6539 :tags        @r{A tags match to select entries that should contribute.  See}
6540              @r{@ref{Matching tags and properties} for the match syntax.}
6541 @end example
6543 Then there are options which determine the formatting of the table.  There
6544 options are interpreted by the function @code{org-clocktable-write-default},
6545 but you can specify your own function using the @code{:formatter} parameter.
6546 @example
6547 :emphasize   @r{When @code{t}, emphasize level one and level two items.}
6548 :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".}
6549 :link        @r{Link the item headlines in the table to their origins.}
6550 :narrow      @r{An integer to limit the width of the headline column in}
6551              @r{the org table.  If you write it like @samp{50!}, then the}
6552              @r{headline will also be shortened in export.}
6553 :indent      @r{Indent each headline field according to its level.}
6554 :tcolumns    @r{Number of columns to be used for times.  If this is smaller}
6555              @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6556 :level       @r{Should a level number column be included?}
6557 :compact     @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6558              @r{All are overwritten except if there is an explicit @code{:narrow}}
6559 :timestamp   @r{A timestamp for the entry, when available.  Look for SCHEDULED,}
6560              @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6561 :properties  @r{List of properties that should be shown in the table.  Each}
6562              @r{property will get its own column.}
6563 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6564 :formula     @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6565              @r{As a special case, @samp{:formula %} adds a column with % time.}
6566              @r{If you do not specify a formula here, any existing formula}
6567              @r{below the clock table will survive updates and be evaluated.}
6568 :formatter   @r{A function to format clock data and insert it into the buffer.}
6569 @end example
6570 To get a clock summary of the current level 1 tree, for the current
6571 day, you could write
6572 @example
6573 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6574 #+END: clocktable
6575 @end example
6576 @noindent
6577 and to use a specific time range you could write@footnote{Note that all
6578 parameters must be specified in a single line---the line is broken here
6579 only to fit it into the manual.}
6580 @example
6581 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6582                     :tend "<2006-08-10 Thu 12:00>"
6583 #+END: clocktable
6584 @end example
6585 A range starting a week ago and ending right now could be written as
6586 @example
6587 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6588 #+END: clocktable
6589 @end example
6590 A summary of the current subtree with % times would be
6591 @example
6592 #+BEGIN: clocktable :scope subtree :link t :formula %
6593 #+END: clocktable
6594 @end example
6595 A horizontally compact representation of everything clocked during last week
6596 would be
6597 @example
6598 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6599 #+END: clocktable
6600 @end example
6602 @node Resolving idle time,  , The clock table, Clocking work time
6603 @subsection Resolving idle time and continuous clocking
6605 @subsubheading Resolving idle time
6606 @cindex resolve idle time
6607 @vindex org-clock-x11idle-program-name
6609 @cindex idle, resolve, dangling
6610 If you clock in on a work item, and then walk away from your
6611 computer---perhaps to take a phone call---you often need to ``resolve'' the
6612 time you were away by either subtracting it from the current clock, or
6613 applying it to another one.
6615 @vindex org-clock-idle-time
6616 By customizing the variable @code{org-clock-idle-time} to some integer, such
6617 as 10 or 15, Emacs can alert you when you get back to your computer after
6618 being idle for that many minutes@footnote{On computers using Mac OS X,
6619 idleness is based on actual user idleness, not just Emacs' idle time.  For
6620 X11, you can install a utility program @file{x11idle.c}, available in the
6621 @code{contrib/scripts} directory of the Org git distribution, or install the
6622 @file{xprintidle} package and set it to the variable
6623 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6624 same general treatment of idleness.  On other systems, idle time refers to
6625 Emacs idle time only.}, and ask what you want to do with the idle time.
6626 There will be a question waiting for you when you get back, indicating how
6627 much idle time has passed (constantly updated with the current amount), as
6628 well as a set of choices to correct the discrepancy:
6630 @table @kbd
6631 @item k
6632 To keep some or all of the minutes and stay clocked in, press @kbd{k}.  Org
6633 will ask how many of the minutes to keep.  Press @key{RET} to keep them all,
6634 effectively changing nothing, or enter a number to keep that many minutes.
6635 @item K
6636 If you use the shift key and press @kbd{K}, it will keep however many minutes
6637 you request and then immediately clock out of that task.  If you keep all of
6638 the minutes, this is the same as just clocking out of the current task.
6639 @item s
6640 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6641 the clock, and then check back in from the moment you returned.
6642 @item S
6643 To keep none of the minutes and just clock out at the start of the away time,
6644 use the shift key and press @kbd{S}.  Remember that using shift will always
6645 leave you clocked out, no matter which option you choose.
6646 @item C
6647 To cancel the clock altogether, use @kbd{C}.  Note that if instead of
6648 canceling you subtract the away time, and the resulting clock amount is less
6649 than a minute, the clock will still be canceled rather than clutter up the
6650 log with an empty entry.
6651 @end table
6653 What if you subtracted those away minutes from the current clock, and now
6654 want to apply them to a new clock?  Simply clock in to any task immediately
6655 after the subtraction.  Org will notice that you have subtracted time ``on
6656 the books'', so to speak, and will ask if you want to apply those minutes to
6657 the next task you clock in on.
6659 There is one other instance when this clock resolution magic occurs.  Say you
6660 were clocked in and hacking away, and suddenly your cat chased a mouse who
6661 scared a hamster that crashed into your UPS's power button!  You suddenly
6662 lose all your buffers, but thanks to auto-save you still have your recent Org
6663 mode changes, including your last clock in.
6665 If you restart Emacs and clock into any task, Org will notice that you have a
6666 dangling clock which was never clocked out from your last session.  Using
6667 that clock's starting time as the beginning of the unaccounted-for period,
6668 Org will ask how you want to resolve that time.  The logic and behavior is
6669 identical to dealing with away time due to idleness; it is just happening due
6670 to a recovery event rather than a set amount of idle time.
6672 You can also check all the files visited by your Org agenda for dangling
6673 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6675 @subsubheading Continuous clocking
6676 @cindex continuous clocking
6677 @vindex org-clock-continuously
6679 You may want to start clocking from the time when you clocked out the
6680 previous task.  To enable this systematically, set @code{org-clock-continuously}
6681 to @code{t}.  Each time you clock in, Org retrieves the clock-out time of the
6682 last clocked entry for this session, and start the new clock from there.
6684 If you only want this from time to time, use three universal prefix arguments
6685 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6687 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6688 @section Effort estimates
6689 @cindex effort estimates
6691 @cindex property, Effort
6692 @vindex org-effort-property
6693 If you want to plan your work in a very detailed way, or if you need to
6694 produce offers with quotations of the estimated work effort, you may want to
6695 assign effort estimates to entries.  If you are also clocking your work, you
6696 may later want to compare the planned effort with the actual working time,
6697 a great way to improve planning estimates.  Effort estimates are stored in
6698 a special property @code{EFFORT}.  You can set the effort for an entry with
6699 the following commands:
6701 @table @kbd
6702 @orgcmd{C-c C-x e,org-set-effort}
6703 Set the effort estimate for the current entry.  With a numeric prefix
6704 argument, set it to the Nth allowed value (see below).  This command is also
6705 accessible from the agenda with the @kbd{e} key.
6706 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6707 Modify the effort estimate of the item currently being clocked.
6708 @end table
6710 Clearly the best way to work with effort estimates is through column view
6711 (@pxref{Column view}).  You should start by setting up discrete values for
6712 effort estimates, and a @code{COLUMNS} format that displays these values
6713 together with clock sums (if you want to clock your time).  For a specific
6714 buffer you can use
6716 @example
6717 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6718 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6719 @end example
6721 @noindent
6722 @vindex org-global-properties
6723 @vindex org-columns-default-format
6724 or, even better, you can set up these values globally by customizing the
6725 variables @code{org-global-properties} and @code{org-columns-default-format}.
6726 In particular if you want to use this setup also in the agenda, a global
6727 setup may be advised.
6729 The way to assign estimates to individual items is then to switch to column
6730 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6731 value.  The values you enter will immediately be summed up in the hierarchy.
6732 In the column next to it, any clocked time will be displayed.
6734 @vindex org-agenda-columns-add-appointments-to-effort-sum
6735 If you switch to column view in the daily/weekly agenda, the effort column
6736 will summarize the estimated work effort for each day@footnote{Please note
6737 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6738 column view}).}, and you can use this to find space in your schedule.  To get
6739 an overview of the entire part of the day that is committed, you can set the
6740 option @code{org-agenda-columns-add-appointments-to-effort-sum}.  The
6741 appointments on a day that take place over a specified time interval will
6742 then also be added to the load estimate of the day.
6744 Effort estimates can be used in secondary agenda filtering that is triggered
6745 with the @kbd{/} key in the agenda (@pxref{Agenda commands}).  If you have
6746 these estimates defined consistently, two or three key presses will narrow
6747 down the list to stuff that fits into an available time slot.
6749 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6750 @section Taking notes with a relative timer
6751 @cindex relative timer
6753 When taking notes during, for example, a meeting or a video viewing, it can
6754 be useful to have access to times relative to a starting time.  Org provides
6755 such a relative timer and make it easy to create timed notes.
6757 @table @kbd
6758 @orgcmd{C-c C-x .,org-timer}
6759 Insert a relative time into the buffer.  The first time you use this, the
6760 timer will be started.  When called with a prefix argument, the timer is
6761 restarted.
6762 @orgcmd{C-c C-x -,org-timer-item}
6763 Insert a description list item with the current relative time.  With a prefix
6764 argument, first reset the timer to 0.
6765 @orgcmd{M-@key{RET},org-insert-heading}
6766 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6767 new timer items.
6768 @c for key sequences with a comma, command name macros fail :(
6769 @kindex C-c C-x ,
6770 @item C-c C-x ,
6771 Pause the timer, or continue it if it is already paused
6772 (@command{org-timer-pause-or-continue}).
6773 @c removed the sentence because it is redundant to the following item
6774 @kindex C-u C-c C-x ,
6775 @item C-u C-c C-x ,
6776 Stop the timer.  After this, you can only start a new timer, not continue the
6777 old one.  This command also removes the timer from the mode line.
6778 @orgcmd{C-c C-x 0,org-timer-start}
6779 Reset the timer without inserting anything into the buffer.  By default, the
6780 timer is reset to 0.  When called with a @kbd{C-u} prefix, reset the timer to
6781 specific starting offset.  The user is prompted for the offset, with a
6782 default taken from a timer string at point, if any, So this can be used to
6783 restart taking notes after a break in the process.  When called with a double
6784 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6785 by a certain amount.  This can be used to fix timer strings if the timer was
6786 not started at exactly the right moment.
6787 @end table
6789 @node Countdown timer,  , Relative timer, Dates and Times
6790 @section Countdown timer
6791 @cindex Countdown timer
6792 @kindex C-c C-x ;
6793 @kindex ;
6795 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6796 timer.  Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6798 @code{org-timer-set-timer} prompts the user for a duration and displays a
6799 countdown timer in the modeline.  @code{org-timer-default-timer} sets the
6800 default countdown value.  Giving a prefix numeric argument overrides this
6801 default value.
6803 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6804 @chapter Capture - Refile - Archive
6805 @cindex capture
6807 An important part of any organization system is the ability to quickly
6808 capture new ideas and tasks, and to associate reference material with them.
6809 Org does this using a process called @i{capture}.  It also can store files
6810 related to a task (@i{attachments}) in a special directory.  Once in the
6811 system, tasks and projects need to be moved around.  Moving completed project
6812 trees to an archive file keeps the system compact and fast.
6814 @menu
6815 * Capture::                     Capturing new stuff
6816 * Attachments::                 Add files to tasks
6817 * RSS Feeds::                   Getting input from RSS feeds
6818 * Protocols::                   External (e.g., Browser) access to Emacs and Org
6819 * Refile and copy::             Moving/copying a tree from one place to another
6820 * Archiving::                   What to do with finished projects
6821 @end menu
6823 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6824 @section Capture
6825 @cindex capture
6827 Capture lets you quickly store notes with little interruption of your work
6828 flow.  Org's method for capturing new items is heavily inspired by John
6829 Wiegley excellent @file{remember.el} package.  Up to version 6.36, Org
6830 used a special setup for @file{remember.el}, then replaced it with
6831 @file{org-remember.el}.  As of version 8.0, @file{org-remember.el} has
6832 been completely replaced by @file{org-capture.el}.
6834 If your configuration depends on @file{org-remember.el}, you need to update
6835 it and use the setup described below.  To convert your
6836 @code{org-remember-templates}, run the command
6837 @example
6838 @kbd{M-x org-capture-import-remember-templates RET}
6839 @end example
6840 @noindent and then customize the new variable with @kbd{M-x
6841 customize-variable org-capture-templates}, check the result, and save the
6842 customization.
6844 @menu
6845 * Setting up capture::          Where notes will be stored
6846 * Using capture::               Commands to invoke and terminate capture
6847 * Capture templates::           Define the outline of different note types
6848 @end menu
6850 @node Setting up capture, Using capture, Capture, Capture
6851 @subsection Setting up capture
6853 The following customization sets a default target file for notes, and defines
6854 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6855 suggestion.}  for capturing new material.
6857 @vindex org-default-notes-file
6858 @smalllisp
6859 @group
6860 (setq org-default-notes-file (concat org-directory "/notes.org"))
6861 (define-key global-map "\C-cc" 'org-capture)
6862 @end group
6863 @end smalllisp
6865 @node Using capture, Capture templates, Setting up capture, Capture
6866 @subsection Using capture
6868 @table @kbd
6869 @orgcmd{C-c c,org-capture}
6870 Call the command @code{org-capture}.  Note that this keybinding is global and
6871 not active by default: you need to install it.  If you have templates
6872 @cindex date tree
6873 defined @pxref{Capture templates}, it will offer these templates for
6874 selection or use a new Org outline node as the default template.  It will
6875 insert the template into the target file and switch to an indirect buffer
6876 narrowed to this new node.  You may then insert the information you want.
6878 @orgcmd{C-c C-c,org-capture-finalize}
6879 Once you have finished entering information into the capture buffer, @kbd{C-c
6880 C-c} will return you to the window configuration before the capture process,
6881 so that you can resume your work without further distraction.  When called
6882 with a prefix arg, finalize and then jump to the captured item.
6884 @orgcmd{C-c C-w,org-capture-refile}
6885 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6886 a different place.  Please realize that this is a normal refiling command
6887 that will be executed---so the cursor position at the moment you run this
6888 command is important.  If you have inserted a tree with a parent and
6889 children, first move the cursor back to the parent.  Any prefix argument
6890 given to this command will be passed on to the @code{org-refile} command.
6892 @orgcmd{C-c C-k,org-capture-kill}
6893 Abort the capture process and return to the previous state.
6895 @end table
6897 You can also call @code{org-capture} in a special way from the agenda, using
6898 the @kbd{k c} key combination.  With this access, any timestamps inserted by
6899 the selected capture template will default to the cursor date in the agenda,
6900 rather than to the current date.
6902 To find the locations of the last stored capture, use @code{org-capture} with
6903 prefix commands:
6905 @table @kbd
6906 @orgkey{C-u C-c c}
6907 Visit the target location of a capture template.  You get to select the
6908 template in the usual way.
6909 @orgkey{C-u C-u C-c c}
6910 Visit the last stored capture item in its buffer.
6911 @end table
6913 @vindex org-capture-bookmark
6914 @cindex org-capture-last-stored
6915 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6916 automatically be created unless you set @code{org-capture-bookmark} to
6917 @code{nil}.
6919 To insert the capture at point in an Org buffer, call @code{org-capture} with
6920 a @code{C-0} prefix argument.
6922 @node Capture templates,  , Using capture, Capture
6923 @subsection Capture templates
6924 @cindex templates, for Capture
6926 You can use templates for different types of capture items, and
6927 for different target locations.  The easiest way to create such templates is
6928 through the customize interface.
6930 @table @kbd
6931 @orgkey{C-c c C}
6932 Customize the variable @code{org-capture-templates}.
6933 @end table
6935 Before we give the formal description of template definitions, let's look at
6936 an example.  Say you would like to use one template to create general TODO
6937 entries, and you want to put these entries under the heading @samp{Tasks} in
6938 your file @file{~/org/gtd.org}.  Also, a date tree in the file
6939 @file{journal.org} should capture journal entries.  A possible configuration
6940 would look like:
6942 @smalllisp
6943 @group
6944 (setq org-capture-templates
6945  '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6946         "* TODO %?\n  %i\n  %a")
6947    ("j" "Journal" entry (file+datetree "~/org/journal.org")
6948         "* %?\nEntered on %U\n  %i\n  %a")))
6949 @end group
6950 @end smalllisp
6952 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6953 for you like this:
6954 @example
6955 * TODO
6956   [[file:@var{link to where you initiated capture}]]
6957 @end example
6959 @noindent
6960 During expansion of the template, @code{%a} has been replaced by a link to
6961 the location from where you called the capture command.  This can be
6962 extremely useful for deriving tasks from emails, for example.  You fill in
6963 the task definition, press @kbd{C-c C-c} and Org returns you to the same
6964 place where you started the capture process.
6966 To define special keys to capture to a particular template without going
6967 through the interactive template selection, you can create your key binding
6968 like this:
6970 @lisp
6971 (define-key global-map "\C-cx"
6972    (lambda () (interactive) (org-capture nil "x")))
6973 @end lisp
6975 @menu
6976 * Template elements::           What is needed for a complete template entry
6977 * Template expansion::          Filling in information about time and context
6978 * Templates in contexts::       Only show a template in a specific context
6979 @end menu
6981 @node Template elements, Template expansion, Capture templates, Capture templates
6982 @subsubsection Template elements
6984 Now lets look at the elements of a template definition.  Each entry in
6985 @code{org-capture-templates} is a list with the following items:
6987 @table @var
6988 @item keys
6989 The keys that will select the template, as a string, characters
6990 only, for example @code{"a"} for a template to be selected with a
6991 single key, or @code{"bt"} for selection with two keys.  When using
6992 several keys, keys using the same prefix key must be sequential
6993 in the list and preceded by a 2-element entry explaining the
6994 prefix key, for example
6995 @smalllisp
6996          ("b" "Templates for marking stuff to buy")
6997 @end smalllisp
6998 @noindent If you do not define a template for the @kbd{C} key, this key will
6999 be used to open the customize buffer for this complex variable.
7001 @item description
7002 A short string describing the template, which will be shown during
7003 selection.
7005 @item type
7006 The type of entry, a symbol.  Valid values are:
7008 @table @code
7009 @item entry
7010 An Org mode node, with a headline.  Will be filed as the child of the target
7011 entry or as a top-level entry.  The target file should be an Org mode file.
7012 @item item
7013 A plain list item, placed in the first plain  list at the target
7014 location.  Again the target file should be an Org file.
7015 @item checkitem
7016 A checkbox item.  This only differs from the plain list item by the
7017 default template.
7018 @item table-line
7019 a new line in the first table at the target location.  Where exactly the
7020 line will be inserted depends on the properties @code{:prepend} and
7021 @code{:table-line-pos} (see below).
7022 @item plain
7023 Text to be inserted as it is.
7024 @end table
7026 @item target
7027 @vindex org-default-notes-file
7028 Specification of where the captured item should be placed.  In Org mode
7029 files, targets usually define a node.  Entries will become children of this
7030 node.  Other types will be added to the table or list in the body of this
7031 node.  Most target specifications contain a file name.  If that file name is
7032 the empty string, it defaults to @code{org-default-notes-file}.  A file can
7033 also be given as a variable, function, or Emacs Lisp form.
7035 Valid values are:
7037 @table @code
7038 @item (file "path/to/file")
7039 Text will be placed at the beginning or end of that file.
7041 @item (id "id of existing org entry")
7042 Filing as child of this entry, or in the body of the entry.
7044 @item (file+headline "path/to/file" "node headline")
7045 Fast configuration if the target heading is unique in the file.
7047 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7048 For non-unique headings, the full path is safer.
7050 @item (file+regexp  "path/to/file" "regexp to find location")
7051 Use a regular expression to position the cursor.
7053 @item (file+datetree "path/to/file")
7054 Will create a heading in a date tree for today's date@footnote{Datetree
7055 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7056 and @code{* 2013} in your file, the capture will refile the note to the first
7057 one matched.}.
7059 @item (file+datetree+prompt "path/to/file")
7060 Will create a heading in a date tree, but will prompt for the date.
7062 @item (file+function "path/to/file" function-finding-location)
7063 A function to find the right location in the file.
7065 @item (clock)
7066 File to the entry that is currently being clocked.
7068 @item (function function-finding-location)
7069 Most general way, write your own function to find both
7070 file and location.
7071 @end table
7073 @item template
7074 The template for creating the capture item.  If you leave this empty, an
7075 appropriate default template will be used.  Otherwise this is a string with
7076 escape codes, which will be replaced depending on time and context of the
7077 capture call.  The string with escapes may be loaded from a template file,
7078 using the special syntax @code{(file "path/to/template")}.  See below for
7079 more details.
7081 @item properties
7082 The rest of the entry is a property list of additional options.
7083 Recognized properties are:
7085 @table @code
7086 @item :prepend
7087 Normally new captured information will be appended at
7088 the target location (last child, last table line, last list item...).
7089 Setting this property will change that.
7091 @item :immediate-finish
7092 When set, do not offer to edit the information, just
7093 file it away immediately.  This makes sense if the template only needs
7094 information that can be added automatically.
7096 @item :empty-lines
7097 Set this to the number of lines to insert
7098 before and after the new item.  Default 0, only common other value is 1.
7100 @item :clock-in
7101 Start the clock in this item.
7103 @item :clock-keep
7104 Keep the clock running when filing the captured entry.
7106 @item :clock-resume
7107 If starting the capture interrupted a clock, restart that clock when finished
7108 with the capture.  Note that @code{:clock-keep} has precedence over
7109 @code{:clock-resume}.  When setting both to @code{t}, the current clock will
7110 run and the previous one will not be resumed.
7112 @item :unnarrowed
7113 Do not narrow the target buffer, simply show the full buffer.  Default is to
7114 narrow it so that you only see the new material.
7116 @item :table-line-pos
7117 Specification of the location in the table where the new line should be
7118 inserted.  It should be a string like @code{"II-3"} meaning that the new
7119 line should become the third line before the second horizontal separator
7120 line.
7122 @item :kill-buffer
7123 If the target file was not yet visited when capture was invoked, kill the
7124 buffer again after capture is completed.
7125 @end table
7126 @end table
7128 @node Template expansion, Templates in contexts, Template elements, Capture templates
7129 @subsubsection Template expansion
7131 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7132 these sequences literally, escape the @kbd{%} with a backslash.} allow
7133 dynamic insertion of content.  The templates are expanded in the order given here:
7135 @smallexample
7136 %[@var{file}]     @r{Insert the contents of the file given by @var{file}.}
7137 %(@var{sexp})     @r{Evaluate Elisp @var{sexp} and replace with the result.}
7138                   @r{For convenience, %:keyword (see below) placeholders}
7139                   @r{within the expression will be expanded prior to this.}
7140                   @r{The sexp must return a string.}
7141 %<...>      @r{The result of format-time-string on the ... format specification.}
7142 %t          @r{Timestamp, date only.}
7143 %T          @r{Timestamp, with date and time.}
7144 %u, %U      @r{Like the above, but inactive timestamps.}
7145 %i          @r{Initial content, the region when capture is called while the}
7146             @r{region is active.}
7147             @r{The entire text will be indented like @code{%i} itself.}
7148 %a          @r{Annotation, normally the link created with @code{org-store-link}.}
7149 %A          @r{Like @code{%a}, but prompt for the description part.}
7150 %l          @r{Like %a, but only insert the literal link.}
7151 %c          @r{Current kill ring head.}
7152 %x          @r{Content of the X clipboard.}
7153 %k          @r{Title of the currently clocked task.}
7154 %K          @r{Link to the currently clocked task.}
7155 %n          @r{User name (taken from @code{user-full-name}).}
7156 %f          @r{File visited by current buffer when org-capture was called.}
7157 %F          @r{Full path of the file or directory visited by current buffer.}
7158 %:keyword   @r{Specific information for certain link types, see below.}
7159 %^g         @r{Prompt for tags, with completion on tags in target file.}
7160 %^G         @r{Prompt for tags, with completion all tags in all agenda files.}
7161 %^t         @r{Like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7162             @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7163 %^C         @r{Interactive selection of which kill or clip to use.}
7164 %^L         @r{Like @code{%^C}, but insert as link.}
7165 %^@{@var{prop}@}p   @r{Prompt the user for a value for property @var{prop}.}
7166 %^@{@var{prompt}@}  @r{prompt the user for a string and replace this sequence with it.}
7167             @r{You may specify a default value and a completion table with}
7168             @r{%^@{prompt|default|completion2|completion3...@}.}
7169             @r{The arrow keys access a prompt-specific history.}
7170 %\n         @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7171             @r{a number, starting from 1.}
7172 %?          @r{After completing the template, position cursor here.}
7173 @end smallexample
7175 @noindent
7176 For specific link types, the following keywords will be
7177 defined@footnote{If you define your own link types (@pxref{Adding
7178 hyperlink types}), any property you store with
7179 @code{org-store-link-props} can be accessed in capture templates in a
7180 similar way.}:
7182 @vindex org-from-is-user-regexp
7183 @smallexample
7184 Link type                        |  Available keywords
7185 ---------------------------------+----------------------------------------------
7186 bbdb                             |  %:name %:company
7187 irc                              |  %:server %:port %:nick
7188 vm, vm-imap, wl, mh, mew, rmail  |  %:type %:subject %:message-id
7189                                  |  %:from %:fromname %:fromaddress
7190                                  |  %:to   %:toname   %:toaddress
7191                                  |  %:date @r{(message date header field)}
7192                                  |  %:date-timestamp @r{(date as active timestamp)}
7193                                  |  %:date-timestamp-inactive @r{(date as inactive timestamp)}
7194                                  |  %: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}.}}
7195 gnus                             |  %:group, @r{for messages also all email fields}
7196 w3, w3m                          |  %:url
7197 info                             |  %:file %:node
7198 calendar                         |  %:date
7199 @end smallexample
7201 @noindent
7202 To place the cursor after template expansion use:
7204 @smallexample
7205 %?          @r{After completing the template, position cursor here.}
7206 @end smallexample
7208 @node Templates in contexts,  , Template expansion, Capture templates
7209 @subsubsection Templates in contexts
7211 @vindex org-capture-templates-contexts
7212 To control whether a capture template should be accessible from a specific
7213 context, you can customize @code{org-capture-templates-contexts}.  Let's say
7214 for example that you have a capture template @code{"p"} for storing Gnus
7215 emails containing patches.  Then you would configure this option like this:
7217 @smalllisp
7218 (setq org-capture-templates-contexts
7219       '(("p" (in-mode . "message-mode"))))
7220 @end smalllisp
7222 You can also tell that the command key @code{"p"} should refer to another
7223 template.  In that case, add this command key like this:
7225 @smalllisp
7226 (setq org-capture-templates-contexts
7227       '(("p" "q" (in-mode . "message-mode"))))
7228 @end smalllisp
7230 See the docstring of the variable for more information.
7232 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
7233 @section Attachments
7234 @cindex attachments
7236 @vindex org-attach-directory
7237 It is often useful to associate reference material with an outline node/task.
7238 Small chunks of plain text can simply be stored in the subtree of a project.
7239 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7240 files that live elsewhere on your computer or in the cloud, like emails or
7241 source code files belonging to a project.  Another method is @i{attachments},
7242 which are files located in a directory belonging to an outline node.  Org
7243 uses directories named by the unique ID of each entry.  These directories are
7244 located in the @file{data} directory which lives in the same directory where
7245 your Org file lives@footnote{If you move entries or Org files from one
7246 directory to another, you may want to configure @code{org-attach-directory}
7247 to contain an absolute path.}.  If you initialize this directory with
7248 @code{git init}, Org will automatically commit changes when it sees them.
7249 The attachment system has been contributed to Org by John Wiegley.
7251 In cases where it seems better to do so, you can also attach a directory of your
7252 choice to an entry.  You can also make children inherit the attachment
7253 directory from a parent, so that an entire subtree uses the same attached
7254 directory.
7256 @noindent The following commands deal with attachments:
7258 @table @kbd
7259 @orgcmd{C-c C-a,org-attach}
7260 The dispatcher for commands related to the attachment system.  After these
7261 keys, a list of commands is displayed and you must press an additional key
7262 to select a command:
7264 @table @kbd
7265 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7266 @vindex org-attach-method
7267 Select a file and move it into the task's attachment directory.  The file
7268 will be copied, moved, or linked, depending on @code{org-attach-method}.
7269 Note that hard links are not supported on all systems.
7271 @kindex C-c C-a c
7272 @kindex C-c C-a m
7273 @kindex C-c C-a l
7274 @item c/m/l
7275 Attach a file using the copy/move/link method.
7276 Note that hard links are not supported on all systems.
7278 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7279 Create a new attachment as an Emacs buffer.
7281 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7282 Synchronize the current task with its attachment directory, in case you added
7283 attachments yourself.
7285 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7286 @vindex org-file-apps
7287 Open current task's attachment.  If there is more than one, prompt for a
7288 file name first.  Opening will follow the rules set by @code{org-file-apps}.
7289 For more details, see the information on following hyperlinks
7290 (@pxref{Handling links}).
7292 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7293 Also open the attachment, but force opening the file in Emacs.
7295 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7296 Open the current task's attachment directory.
7298 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7299 Also open the directory, but force using @command{dired} in Emacs.
7301 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7302 Select and delete a single attachment.
7304 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7305 Delete all of a task's attachments.  A safer way is to open the directory in
7306 @command{dired} and delete from there.
7308 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7309 @cindex property, ATTACH_DIR
7310 Set a specific directory as the entry's attachment directory.  This works by
7311 putting the directory path into the @code{ATTACH_DIR} property.
7313 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7314 @cindex property, ATTACH_DIR_INHERIT
7315 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7316 same directory for attachments as the parent does.
7317 @end table
7318 @end table
7320 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
7321 @section RSS feeds
7322 @cindex RSS feeds
7323 @cindex Atom feeds
7325 Org can add and change entries based on information found in RSS feeds and
7326 Atom feeds.  You could use this to make a task out of each new podcast in a
7327 podcast feed.  Or you could use a phone-based note-creating service on the
7328 web to import tasks into Org.  To access feeds, configure the variable
7329 @code{org-feed-alist}.  The docstring of this variable has detailed
7330 information.  Here is just an example:
7332 @smalllisp
7333 @group
7334 (setq org-feed-alist
7335      '(("Slashdot"
7336          "http://rss.slashdot.org/Slashdot/slashdot"
7337          "~/txt/org/feeds.org" "Slashdot Entries")))
7338 @end group
7339 @end smalllisp
7341 @noindent
7342 will configure that new items from the feed provided by
7343 @code{rss.slashdot.org} will result in new entries in the file
7344 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7345 the following command is used:
7347 @table @kbd
7348 @orgcmd{C-c C-x g,org-feed-update-all}
7349 @item C-c C-x g
7350 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7351 them.
7352 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7353 Prompt for a feed name and go to the inbox configured for this feed.
7354 @end table
7356 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7357 it will store information about the status of items in the feed, to avoid
7358 adding the same item several times.  You should add @samp{FEEDSTATUS} to the
7359 list of drawers in that file:
7361 @example
7362 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
7363 @end example
7365 For more information, including how to read atom feeds, see
7366 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7368 @node Protocols, Refile and copy, RSS Feeds, Capture - Refile - Archive
7369 @section Protocols for external access
7370 @cindex protocols, for external access
7371 @cindex emacsserver
7373 You can set up Org for handling protocol calls from outside applications that
7374 are passed to Emacs through the @file{emacsserver}.  For example, you can
7375 configure bookmarks in your web browser to send a link to the current page to
7376 Org and create a note from it using capture (@pxref{Capture}).  Or you
7377 could create a bookmark that will tell Emacs to open the local source file of
7378 a remote website you are looking at with the browser.  See
7379 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7380 documentation and setup instructions.
7382 @node Refile and copy, Archiving, Protocols, Capture - Refile - Archive
7383 @section Refile and copy
7384 @cindex refiling notes
7385 @cindex copying notes
7387 When reviewing the captured data, you may want to refile or to copy some of
7388 the entries into a different list, for example into a project.  Cutting,
7389 finding the right location, and then pasting the note is cumbersome.  To
7390 simplify this process, you can use the following special command:
7392 @table @kbd
7393 @orgcmd{C-c M-w,org-copy}
7394 @findex org-copy
7395 Copying works like refiling, except that the original note is not deleted.
7396 @orgcmd{C-c C-w,org-refile}
7397 @findex org-refile
7398 @vindex org-reverse-note-order
7399 @vindex org-refile-targets
7400 @vindex org-refile-use-outline-path
7401 @vindex org-outline-path-complete-in-steps
7402 @vindex org-refile-allow-creating-parent-nodes
7403 @vindex org-log-refile
7404 @vindex org-refile-use-cache
7405 @vindex org-refile-keep
7406 Refile the entry or region at point.  This command offers possible locations
7407 for refiling the entry and lets you select one with completion.  The item (or
7408 all items in the region) is filed below the target heading as a subitem.
7409 Depending on @code{org-reverse-note-order}, it will be either the first or
7410 last subitem.@*
7411 By default, all level 1 headlines in the current buffer are considered to be
7412 targets, but you can have more complex definitions across a number of files.
7413 See the variable @code{org-refile-targets} for details.  If you would like to
7414 select a location via a file-path-like completion along the outline path, see
7415 the variables @code{org-refile-use-outline-path} and
7416 @code{org-outline-path-complete-in-steps}.  If you would like to be able to
7417 create new nodes as new parents for refiling on the fly, check the
7418 variable @code{org-refile-allow-creating-parent-nodes}.
7419 When the variable @code{org-log-refile}@footnote{with corresponding
7420 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7421 and @code{nologrefile}} is set, a timestamp or a note will be
7422 recorded when an entry has been refiled.
7423 @orgkey{C-u C-c C-w}
7424 Use the refile interface to jump to a heading.
7425 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7426 Jump to the location where @code{org-refile} last moved a tree to.
7427 @item C-2 C-c C-w
7428 Refile as the child of the item currently being clocked.
7429 @item C-3 C-c C-w
7430 Refile and keep the entry in place.  Also see @code{org-refile-keep} to make
7431 this the default behavior, and beware that this may result in duplicated
7432 @code{ID} properties.
7433 @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}
7434 Clear the target cache.  Caching of refile targets can be turned on by
7435 setting @code{org-refile-use-cache}.  To make the command see new possible
7436 targets, you have to clear the cache with this command.
7437 @end table
7439 @node Archiving,  , Refile and copy, Capture - Refile - Archive
7440 @section Archiving
7441 @cindex archiving
7443 When a project represented by a (sub)tree is finished, you may want
7444 to move the tree out of the way and to stop it from contributing to the
7445 agenda.  Archiving is important to keep your working files compact and global
7446 searches like the construction of agenda views fast.
7448 @table @kbd
7449 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7450 @vindex org-archive-default-command
7451 Archive the current entry using the command specified in the variable
7452 @code{org-archive-default-command}.
7453 @end table
7455 @menu
7456 * Moving subtrees::             Moving a tree to an archive file
7457 * Internal archiving::          Switch off a tree but keep it in the file
7458 @end menu
7460 @node Moving subtrees, Internal archiving, Archiving, Archiving
7461 @subsection Moving a tree to the archive file
7462 @cindex external archiving
7464 The most common archiving action is to move a project tree to another file,
7465 the archive file.
7467 @table @kbd
7468 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7469 @vindex org-archive-location
7470 Archive the subtree starting at the cursor position to the location
7471 given by @code{org-archive-location}.
7472 @orgkey{C-u C-c C-x C-s}
7473 Check if any direct children of the current headline could be moved to
7474 the archive.  To do this, each subtree is checked for open TODO entries.
7475 If none are found, the command offers to move it to the archive
7476 location.  If the cursor is @emph{not} on a headline when this command
7477 is invoked, the level 1 trees will be checked.
7478 @end table
7480 @cindex archive locations
7481 The default archive location is a file in the same directory as the
7482 current file, with the name derived by appending @file{_archive} to the
7483 current file name.  You can also choose what heading to file archived
7484 items under, with the possibility to add them to a datetree in a file.
7485 For information and examples on how to specify the file and the heading,
7486 see the documentation string of the variable
7487 @code{org-archive-location}.
7489 There is also an in-buffer option for setting this variable, for
7490 example@footnote{For backward compatibility, the following also works:
7491 If there are several such lines in a file, each specifies the archive
7492 location for the text below it.  The first such line also applies to any
7493 text before its definition.  However, using this method is
7494 @emph{strongly} deprecated as it is incompatible with the outline
7495 structure of the document.  The correct method for setting multiple
7496 archive locations in a buffer is using properties.}:
7498 @cindex #+ARCHIVE
7499 @example
7500 #+ARCHIVE: %s_done::
7501 @end example
7503 @cindex property, ARCHIVE
7504 @noindent
7505 If you would like to have a special ARCHIVE location for a single entry
7506 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7507 location as the value (@pxref{Properties and Columns}).
7509 @vindex org-archive-save-context-info
7510 When a subtree is moved, it receives a number of special properties that
7511 record context information like the file from where the entry came, its
7512 outline path the archiving time etc.  Configure the variable
7513 @code{org-archive-save-context-info} to adjust the amount of information
7514 added.
7517 @node Internal archiving,  , Moving subtrees, Archiving
7518 @subsection Internal archiving
7520 If you want to just switch off (for agenda views) certain subtrees without
7521 moving them to a different file, you can use the @code{ARCHIVE tag}.
7523 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7524 its location in the outline tree, but behaves in the following way:
7525 @itemize @minus
7526 @item
7527 @vindex org-cycle-open-archived-trees
7528 It does not open when you attempt to do so with a visibility cycling
7529 command (@pxref{Visibility cycling}).  You can force cycling archived
7530 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7531 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
7532 @code{show-all} will open archived subtrees.
7533 @item
7534 @vindex org-sparse-tree-open-archived-trees
7535 During sparse tree construction (@pxref{Sparse trees}), matches in
7536 archived subtrees are not exposed, unless you configure the option
7537 @code{org-sparse-tree-open-archived-trees}.
7538 @item
7539 @vindex org-agenda-skip-archived-trees
7540 During agenda view construction (@pxref{Agenda Views}), the content of
7541 archived trees is ignored unless you configure the option
7542 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7543 be included.  In the agenda you can press @kbd{v a} to get archives
7544 temporarily included.
7545 @item
7546 @vindex org-export-with-archived-trees
7547 Archived trees are not exported (@pxref{Exporting}), only the headline
7548 is.  Configure the details using the variable
7549 @code{org-export-with-archived-trees}.
7550 @item
7551 @vindex org-columns-skip-archived-trees
7552 Archived trees are excluded from column view unless the variable
7553 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7554 @end itemize
7556 The following commands help manage the ARCHIVE tag:
7558 @table @kbd
7559 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7560 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
7561 the headline changes to a shadowed face, and the subtree below it is
7562 hidden.
7563 @orgkey{C-u C-c C-x a}
7564 Check if any direct children of the current headline should be archived.
7565 To do this, each subtree is checked for open TODO entries.  If none are
7566 found, the command offers to set the ARCHIVE tag for the child.  If the
7567 cursor is @emph{not} on a headline when this command is invoked, the
7568 level 1 trees will be checked.
7569 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7570 Cycle a tree even if it is tagged with ARCHIVE.
7571 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7572 Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
7573 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}.  The
7574 entry becomes a child of that sibling and in this way retains a lot of its
7575 original context, including inherited tags and approximate position in the
7576 outline.
7577 @end table
7580 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7581 @chapter Agenda views
7582 @cindex agenda views
7584 Due to the way Org works, TODO items, time-stamped items, and
7585 tagged headlines can be scattered throughout a file or even a number of
7586 files.  To get an overview of open action items, or of events that are
7587 important for a particular date, this information must be collected,
7588 sorted and displayed in an organized way.
7590 Org can select items based on various criteria and display them
7591 in a separate buffer.  Seven different view types are provided:
7593 @itemize @bullet
7594 @item
7595 an @emph{agenda} that is like a calendar and shows information
7596 for specific dates,
7597 @item
7598 a @emph{TODO list} that covers all unfinished
7599 action items,
7600 @item
7601 a @emph{match view}, showings headlines based on the tags, properties, and
7602 TODO state associated with them,
7603 @item
7604 a @emph{timeline view} that shows all events in a single Org file,
7605 in time-sorted view,
7606 @item
7607 a @emph{text search view} that shows all entries from multiple files
7608 that contain specified keywords,
7609 @item
7610 a @emph{stuck projects view} showing projects that currently don't move
7611 along, and
7612 @item
7613 @emph{custom views} that are special searches and combinations of different
7614 views.
7615 @end itemize
7617 @noindent
7618 The extracted information is displayed in a special @emph{agenda
7619 buffer}.  This buffer is read-only, but provides commands to visit the
7620 corresponding locations in the original Org files, and even to
7621 edit these files remotely.
7623 @vindex org-agenda-window-setup
7624 @vindex org-agenda-restore-windows-after-quit
7625 Two variables control how the agenda buffer is displayed and whether the
7626 window configuration is restored when the agenda exits:
7627 @code{org-agenda-window-setup} and
7628 @code{org-agenda-restore-windows-after-quit}.
7630 @menu
7631 * Agenda files::                Files being searched for agenda information
7632 * Agenda dispatcher::           Keyboard access to agenda views
7633 * Built-in agenda views::       What is available out of the box?
7634 * Presentation and sorting::    How agenda items are prepared for display
7635 * Agenda commands::             Remote editing of Org trees
7636 * Custom agenda views::         Defining special searches and views
7637 * Exporting Agenda Views::      Writing a view to a file
7638 * Agenda column view::          Using column view for collected entries
7639 @end menu
7641 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7642 @section Agenda files
7643 @cindex agenda files
7644 @cindex files for agenda
7646 @vindex org-agenda-files
7647 The information to be shown is normally collected from all @emph{agenda
7648 files}, the files listed in the variable
7649 @code{org-agenda-files}@footnote{If the value of that variable is not a
7650 list, but a single file name, then the list of agenda files will be
7651 maintained in that external file.}.  If a directory is part of this list,
7652 all files with the extension @file{.org} in this directory will be part
7653 of the list.
7655 Thus, even if you only work with a single Org file, that file should
7656 be put into the list@footnote{When using the dispatcher, pressing
7657 @kbd{<} before selecting a command will actually limit the command to
7658 the current file, and ignore @code{org-agenda-files} until the next
7659 dispatcher command.}.  You can customize @code{org-agenda-files}, but
7660 the easiest way to maintain it is through the following commands
7662 @cindex files, adding to agenda list
7663 @table @kbd
7664 @orgcmd{C-c [,org-agenda-file-to-front}
7665 Add current file to the list of agenda files.  The file is added to
7666 the front of the list.  If it was already in the list, it is moved to
7667 the front.  With a prefix argument, file is added/moved to the end.
7668 @orgcmd{C-c ],org-remove-file}
7669 Remove current file from the list of agenda files.
7670 @kindex C-,
7671 @cindex cycling, of agenda files
7672 @orgcmd{C-',org-cycle-agenda-files}
7673 @itemx C-,
7674 Cycle through agenda file list, visiting one file after the other.
7675 @kindex M-x org-iswitchb
7676 @item M-x org-iswitchb RET
7677 Command to use an @code{iswitchb}-like interface to switch to and between Org
7678 buffers.
7679 @end table
7681 @noindent
7682 The Org menu contains the current list of files and can be used
7683 to visit any of them.
7685 If you would like to focus the agenda temporarily on a file not in
7686 this list, or on just one file in the list, or even on only a subtree in a
7687 file, then this can be done in different ways.  For a single agenda command,
7688 you may press @kbd{<} once or several times in the dispatcher
7689 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
7690 extended period, use the following commands:
7692 @table @kbd
7693 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7694 Permanently restrict the agenda to the current subtree.  When with a
7695 prefix argument, or with the cursor before the first headline in a file,
7696 the agenda scope is set to the entire file.  This restriction remains in
7697 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7698 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
7699 agenda view, the new restriction takes effect immediately.
7700 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7701 Remove the permanent restriction created by @kbd{C-c C-x <}.
7702 @end table
7704 @noindent
7705 When working with @file{speedbar.el}, you can use the following commands in
7706 the Speedbar frame:
7708 @table @kbd
7709 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7710 Permanently restrict the agenda to the item---either an Org file or a subtree
7711 in such a file---at the cursor in the Speedbar frame.
7712 If there is a window displaying an agenda view, the new restriction takes
7713 effect immediately.
7714 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7715 Lift the restriction.
7716 @end table
7718 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7719 @section The agenda dispatcher
7720 @cindex agenda dispatcher
7721 @cindex dispatching agenda commands
7722 The views are created through a dispatcher, which should be bound to a
7723 global key---for example @kbd{C-c a} (@pxref{Activation}).  In the
7724 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7725 is accessed and list keyboard access to commands accordingly.  After
7726 pressing @kbd{C-c a}, an additional letter is required to execute a
7727 command.  The dispatcher offers the following default commands:
7729 @table @kbd
7730 @item a
7731 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7732 @item t @r{/} T
7733 Create a list of all TODO items (@pxref{Global TODO list}).
7734 @item m @r{/} M
7735 Create a list of headlines matching a TAGS expression (@pxref{Matching
7736 tags and properties}).
7737 @item L
7738 Create the timeline view for the current buffer (@pxref{Timeline}).
7739 @item s
7740 Create a list of entries selected by a boolean expression of keywords
7741 and/or regular expressions that must or must not occur in the entry.
7742 @item /
7743 @vindex org-agenda-text-search-extra-files
7744 Search for a regular expression in all agenda files and additionally in
7745 the files listed in @code{org-agenda-text-search-extra-files}.  This
7746 uses the Emacs command @code{multi-occur}.  A prefix argument can be
7747 used to specify the number of context lines for each match, default is
7749 @item # @r{/} !
7750 Create a list of stuck projects (@pxref{Stuck projects}).
7751 @item <
7752 Restrict an agenda command to the current buffer@footnote{For backward
7753 compatibility, you can also press @kbd{1} to restrict to the current
7754 buffer.}.  After pressing @kbd{<}, you still need to press the character
7755 selecting the command.
7756 @item < <
7757 If there is an active region, restrict the following agenda command to
7758 the region.  Otherwise, restrict it to the current subtree@footnote{For
7759 backward compatibility, you can also press @kbd{0} to restrict to the
7760 current region/subtree.}.  After pressing @kbd{< <}, you still need to press the
7761 character selecting the command.
7763 @item *
7764 @vindex org-agenda-sticky
7765 Toggle sticky agenda views.  By default, Org maintains only a single agenda
7766 buffer and rebuilds it each time you change the view, to make sure everything
7767 is always up to date.  If you switch between views often and the build time
7768 bothers you, you can turn on sticky agenda buffers (make this the default by
7769 customizing the variable @code{org-agenda-sticky}).  With sticky agendas, the
7770 dispatcher only switches to the selected view, you need to update it by hand
7771 with @kbd{r} or @kbd{g}.  You can toggle sticky agenda view any time with
7772 @code{org-toggle-sticky-agenda}.
7773 @end table
7775 You can also define custom commands that will be accessible through the
7776 dispatcher, just like the default commands.  This includes the
7777 possibility to create extended agenda buffers that contain several
7778 blocks together, for example the weekly agenda, the global TODO list and
7779 a number of special tags matches.  @xref{Custom agenda views}.
7781 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7782 @section The built-in agenda views
7784 In this section we describe the built-in views.
7786 @menu
7787 * Weekly/daily agenda::         The calendar page with current tasks
7788 * Global TODO list::            All unfinished action items
7789 * Matching tags and properties::  Structured information with fine-tuned search
7790 * Timeline::                    Time-sorted view for single file
7791 * Search view::                 Find entries by searching for text
7792 * Stuck projects::              Find projects you need to review
7793 @end menu
7795 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7796 @subsection The weekly/daily agenda
7797 @cindex agenda
7798 @cindex weekly agenda
7799 @cindex daily agenda
7801 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7802 paper agenda, showing all the tasks for the current week or day.
7804 @table @kbd
7805 @cindex org-agenda, command
7806 @orgcmd{C-c a a,org-agenda-list}
7807 Compile an agenda for the current week from a list of Org files.  The agenda
7808 shows the entries for each day.  With a numeric prefix@footnote{For backward
7809 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7810 listed before the agenda.  This feature is deprecated, use the dedicated TODO
7811 list, or a block agenda instead (@pxref{Block agenda}).}  (like @kbd{C-u 2 1
7812 C-c a a}) you may set the number of days to be displayed.
7813 @end table
7815 @vindex org-agenda-span
7816 @vindex org-agenda-ndays
7817 @vindex org-agenda-start-day
7818 @vindex org-agenda-start-on-weekday
7819 The default number of days displayed in the agenda is set by the variable
7820 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}).  This
7821 variable can be set to any number of days you want to see by default in the
7822 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7823 @code{year}.  For weekly agendas, the default is to start on the previous
7824 monday (see @code{org-agenda-start-on-weekday}).  You can also set the start
7825 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7826 start the agenda ten days from today in the future.
7828 Remote editing from the agenda buffer means, for example, that you can
7829 change the dates of deadlines and appointments from the agenda buffer.
7830 The commands available in the Agenda buffer are listed in @ref{Agenda
7831 commands}.
7833 @subsubheading Calendar/Diary integration
7834 @cindex calendar integration
7835 @cindex diary integration
7837 Emacs contains the calendar and diary by Edward M. Reingold.  The
7838 calendar displays a three-month calendar with holidays from different
7839 countries and cultures.  The diary allows you to keep track of
7840 anniversaries, lunar phases, sunrise/set, recurrent appointments
7841 (weekly, monthly) and more.  In this way, it is quite complementary to
7842 Org.  It can be very useful to combine output from Org with
7843 the diary.
7845 In order to include entries from the Emacs diary into Org mode's
7846 agenda, you only need to customize the variable
7848 @lisp
7849 (setq org-agenda-include-diary t)
7850 @end lisp
7852 @noindent After that, everything will happen automatically.  All diary
7853 entries including holidays, anniversaries, etc., will be included in the
7854 agenda buffer created by Org mode.  @key{SPC}, @key{TAB}, and
7855 @key{RET} can be used from the agenda buffer to jump to the diary
7856 file in order to edit existing diary entries.  The @kbd{i} command to
7857 insert new entries for the current date works in the agenda buffer, as
7858 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7859 Sunrise/Sunset times, show lunar phases and to convert to other
7860 calendars, respectively.  @kbd{c} can be used to switch back and forth
7861 between calendar and agenda.
7863 If you are using the diary only for sexp entries and holidays, it is
7864 faster to not use the above setting, but instead to copy or even move
7865 the entries into an Org file.  Org mode evaluates diary-style sexp
7866 entries, and does it faster because there is no overhead for first
7867 creating the diary display.  Note that the sexp entries must start at
7868 the left margin, no whitespace is allowed before them.  For example,
7869 the following segment of an Org file will be processed and entries
7870 will be made in the agenda:
7872 @example
7873 * Birthdays and similar stuff
7874 #+CATEGORY: Holiday
7875 %%(org-calendar-holiday)   ; special function for holiday names
7876 #+CATEGORY: Ann
7877 %%(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
7878 %%(org-anniversary 1869 10  2) Mahatma Gandhi would be %d years old
7879 @end example
7881 @subsubheading Anniversaries from BBDB
7882 @cindex BBDB, anniversaries
7883 @cindex anniversaries, from BBDB
7885 If you are using the Big Brothers Database to store your contacts, you will
7886 very likely prefer to store anniversaries in BBDB rather than in a
7887 separate Org or diary file.  Org supports this and will show BBDB
7888 anniversaries as part of the agenda.  All you need to do is to add the
7889 following to one of your agenda files:
7891 @example
7892 * Anniversaries
7893   :PROPERTIES:
7894   :CATEGORY: Anniv
7895   :END:
7896 %%(org-bbdb-anniversaries)
7897 @end example
7899 You can then go ahead and define anniversaries for a BBDB record.  Basically,
7900 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7901 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7902 followed by a space and the class of the anniversary (@samp{birthday} or
7903 @samp{wedding}, or a format string).  If you omit the class, it will default to
7904 @samp{birthday}.  Here are a few examples, the header for the file
7905 @file{org-bbdb.el} contains more detailed information.
7907 @example
7908 1973-06-22
7909 06-22
7910 1955-08-02 wedding
7911 2008-04-14 %s released version 6.01 of org mode, %d years ago
7912 @end example
7914 After a change to BBDB, or for the first agenda display during an Emacs
7915 session, the agenda display will suffer a short delay as Org updates its
7916 hash with anniversaries.  However, from then on things will be very fast---much
7917 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7918 in an Org or Diary file.
7920 @subsubheading Appointment reminders
7921 @cindex @file{appt.el}
7922 @cindex appointment reminders
7923 @cindex appointment
7924 @cindex reminders
7926 Org can interact with Emacs appointments notification facility.  To add the
7927 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7928 This command lets you filter through the list of your appointments and add
7929 only those belonging to a specific category or matching a regular expression.
7930 It also reads a @code{APPT_WARNTIME} property which will then override the
7931 value of @code{appt-message-warning-time} for this appointment.  See the
7932 docstring for details.
7934 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7935 @subsection The global TODO list
7936 @cindex global TODO list
7937 @cindex TODO list, global
7939 The global TODO list contains all unfinished TODO items formatted and
7940 collected into a single place.
7942 @table @kbd
7943 @orgcmd{C-c a t,org-todo-list}
7944 Show the global TODO list.  This collects the TODO items from all agenda
7945 files (@pxref{Agenda Views}) into a single buffer.  By default, this lists
7946 items with a state the is not a DONE state.  The buffer is in
7947 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7948 entries directly from that buffer (@pxref{Agenda commands}).
7949 @orgcmd{C-c a T,org-todo-list}
7950 @cindex TODO keyword matching
7951 @vindex org-todo-keywords
7952 Like the above, but allows selection of a specific TODO keyword.  You can
7953 also do this by specifying a prefix argument to @kbd{C-c a t}.  You are
7954 prompted for a keyword, and you may also specify several keywords by
7955 separating them with @samp{|} as the boolean OR operator.  With a numeric
7956 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7957 @kindex r
7958 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7959 a prefix argument to this command to change the selected TODO keyword,
7960 for example @kbd{3 r}.  If you often need a search for a specific
7961 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7962 Matching specific TODO keywords can also be done as part of a tags
7963 search (@pxref{Tag searches}).
7964 @end table
7966 Remote editing of TODO items means that you can change the state of a
7967 TODO entry with a single key press.  The commands available in the
7968 TODO list are described in @ref{Agenda commands}.
7970 @cindex sublevels, inclusion into TODO list
7971 Normally the global TODO list simply shows all headlines with TODO
7972 keywords.  This list can become very long.  There are two ways to keep
7973 it more compact:
7974 @itemize @minus
7975 @item
7976 @vindex org-agenda-todo-ignore-scheduled
7977 @vindex org-agenda-todo-ignore-deadlines
7978 @vindex org-agenda-todo-ignore-timestamp
7979 @vindex org-agenda-todo-ignore-with-date
7980 Some people view a TODO item that has been @emph{scheduled} for execution or
7981 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7982 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7983 @code{org-agenda-todo-ignore-deadlines},
7984 @code{org-agenda-todo-ignore-timestamp} and/or
7985 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7986 TODO list.
7987 @item
7988 @vindex org-agenda-todo-list-sublevels
7989 TODO items may have sublevels to break up the task into subtasks.  In
7990 such cases it may be enough to list only the highest level TODO headline
7991 and omit the sublevels from the global list.  Configure the variable
7992 @code{org-agenda-todo-list-sublevels} to get this behavior.
7993 @end itemize
7995 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7996 @subsection Matching tags and properties
7997 @cindex matching, of tags
7998 @cindex matching, of properties
7999 @cindex tags view
8000 @cindex match view
8002 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
8003 or have properties (@pxref{Properties and Columns}), you can select headlines
8004 based on this metadata and collect them into an agenda buffer.  The match
8005 syntax described here also applies when creating sparse trees with @kbd{C-c /
8008 @table @kbd
8009 @orgcmd{C-c a m,org-tags-view}
8010 Produce a list of all headlines that match a given set of tags.  The
8011 command prompts for a selection criterion, which is a boolean logic
8012 expression with tags, like @samp{+work+urgent-withboss} or
8013 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
8014 define a custom command for it (@pxref{Agenda dispatcher}).
8015 @orgcmd{C-c a M,org-tags-view}
8016 @vindex org-tags-match-list-sublevels
8017 @vindex org-agenda-tags-todo-honor-ignore-options
8018 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
8019 not-DONE state and force checking subitems (see variable
8020 @code{org-tags-match-list-sublevels}).  To exclude scheduled/deadline items,
8021 see the variable @code{org-agenda-tags-todo-honor-ignore-options}.  Matching
8022 specific TODO keywords together with a tags match is also possible, see
8023 @ref{Tag searches}.
8024 @end table
8026 The commands available in the tags list are described in @ref{Agenda
8027 commands}.
8029 @subsubheading Match syntax
8031 @cindex Boolean logic, for tag/property searches
8032 A search string can use Boolean operators @samp{&} for @code{AND} and
8033 @samp{|} for @code{OR}@.  @samp{&} binds more strongly than @samp{|}.
8034 Parentheses are not implemented.  Each element in the search is either a
8035 tag, a regular expression matching tags, or an expression like
8036 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8037 property value.  Each element may be preceded by @samp{-}, to select
8038 against it, and @samp{+} is syntactic sugar for positive selection.  The
8039 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8040 present.  Here are some examples, using only tags.
8042 @table @samp
8043 @item work
8044 Select headlines tagged @samp{:work:}.
8045 @item work&boss
8046 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8047 @item +work-boss
8048 Select headlines tagged @samp{:work:}, but discard those also tagged
8049 @samp{:boss:}.
8050 @item work|laptop
8051 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8052 @item work|laptop+night
8053 Like before, but require the @samp{:laptop:} lines to be tagged also
8054 @samp{:night:}.
8055 @end table
8057 @cindex regular expressions, with tags search
8058 Instead of a tag, you may also specify a regular expression enclosed in curly
8059 braces.  For example,
8060 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8061 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8063 @cindex group tags, as regular expressions
8064 Group tags (@pxref{Tag groups}) are expanded as regular expressions.  E.g.,
8065 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8066 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8067 and searching for @samp{-work} will search for all headlines but those with
8068 one of the tag in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8070 @cindex TODO keyword matching, with tags search
8071 @cindex level, require for tags/property match
8072 @cindex category, require for tags/property match
8073 @vindex org-odd-levels-only
8074 You may also test for properties (@pxref{Properties and Columns}) at the same
8075 time as matching tags.  The properties may be real properties, or special
8076 properties that represent other metadata (@pxref{Special properties}).  For
8077 example, the ``property'' @code{TODO} represents the TODO keyword of the
8078 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8079 the entry.  The ITEM special property cannot currently be used in tags/property
8080 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
8081 ,skipping entries based on regexp}.}.
8083 Except the @pxref{Special properties}, one other ``property'' can also be
8084 used. @code{LEVEL} represents the level of an entry.  So a search
8085 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8086 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8087 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8088 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8090 Here are more examples:
8092 @table @samp
8093 @item work+TODO="WAITING"
8094 Select @samp{:work:}-tagged TODO lines with the specific TODO
8095 keyword @samp{WAITING}.
8096 @item work+TODO="WAITING"|home+TODO="WAITING"
8097 Waiting tasks both at work and at home.
8098 @end table
8100 When matching properties, a number of different operators can be used to test
8101 the value of a property.  Here is a complex example:
8103 @example
8104 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
8105          +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8106 @end example
8108 @noindent
8109 The type of comparison will depend on how the comparison value is written:
8110 @itemize @minus
8111 @item
8112 If the comparison value is a plain number, a numerical comparison is done,
8113 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8114 @samp{>=}, and @samp{<>}.
8115 @item
8116 If the comparison value is enclosed in double-quotes,
8117 a string comparison is done, and the same operators are allowed.
8118 @item
8119 If the comparison value is enclosed in double-quotes @emph{and} angular
8120 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8121 assumed to be date/time specifications in the standard Org way, and the
8122 comparison will be done accordingly.  Special values that will be recognized
8123 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8124 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8125 specification.  Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8126 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8127 respectively, can be used.
8128 @item
8129 If the comparison value is enclosed
8130 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8131 regexp matches the property value, and @samp{<>} meaning that it does not
8132 match.
8133 @end itemize
8135 So the search string in the example finds entries tagged @samp{:work:} but
8136 not @samp{:boss:}, which also have a priority value @samp{A}, a
8137 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8138 property that is numerically smaller than 2, a @samp{:With:} property that is
8139 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8140 on or after October 11, 2008.
8142 Accessing TODO, LEVEL, and CATEGORY during a search is fast.  Accessing any
8143 other properties will slow down the search.  However, once you have paid the
8144 price by accessing one property, testing additional properties is cheap
8145 again.
8147 You can configure Org mode to use property inheritance during a search, but
8148 beware that this can slow down searches considerably.  See @ref{Property
8149 inheritance}, for details.
8151 For backward compatibility, and also for typing speed, there is also a
8152 different way to test TODO states in a search.  For this, terminate the
8153 tags/property part of the search string (which may include several terms
8154 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8155 expression just for TODO keywords.  The syntax is then similar to that for
8156 tags, but should be applied with care: for example, a positive selection on
8157 several TODO keywords cannot meaningfully be combined with boolean AND@.
8158 However, @emph{negative selection} combined with AND can be meaningful.  To
8159 make sure that only lines are checked that actually have any TODO keyword
8160 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8161 part after the slash with @samp{!}.  Using @kbd{C-c a M} or @samp{/!} will
8162 not match TODO keywords in a DONE state.  Examples:
8164 @table @samp
8165 @item work/WAITING
8166 Same as @samp{work+TODO="WAITING"}
8167 @item work/!-WAITING-NEXT
8168 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8169 nor @samp{NEXT}
8170 @item work/!+WAITING|+NEXT
8171 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8172 @samp{NEXT}.
8173 @end table
8175 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
8176 @subsection Timeline for a single file
8177 @cindex timeline, single file
8178 @cindex time-sorted view
8180 The timeline summarizes all time-stamped items from a single Org mode
8181 file in a @emph{time-sorted view}.  The main purpose of this command is
8182 to give an overview over events in a project.
8184 @table @kbd
8185 @orgcmd{C-c a L,org-timeline}
8186 Show a time-sorted view of the Org file, with all time-stamped items.
8187 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8188 (scheduled or not) are also listed under the current date.
8189 @end table
8191 @noindent
8192 The commands available in the timeline buffer are listed in
8193 @ref{Agenda commands}.
8195 @node Search view, Stuck projects, Timeline, Built-in agenda views
8196 @subsection Search view
8197 @cindex search view
8198 @cindex text search
8199 @cindex searching, for text
8201 This agenda view is a general text search facility for Org mode entries.
8202 It is particularly useful to find notes.
8204 @table @kbd
8205 @orgcmd{C-c a s,org-search-view}
8206 This is a special search that lets you select entries by matching a substring
8207 or specific words using a boolean logic.
8208 @end table
8209 For example, the search string @samp{computer equipment} will find entries
8210 that contain @samp{computer equipment} as a substring.  If the two words are
8211 separated by more space or a line break, the search will still match.
8212 Search view can also search for specific keywords in the entry, using Boolean
8213 logic.  The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8214 will search for note entries that contain the keywords @code{computer}
8215 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8216 not matched by the regular expression @code{8\.11[bg]}, meaning to
8217 exclude both 8.11b and 8.11g.  The first @samp{+} is necessary to turn on
8218 word search, other @samp{+} characters are optional.  For more details, see
8219 the docstring of the command @code{org-search-view}.
8221 @vindex org-agenda-text-search-extra-files
8222 Note that in addition to the agenda files, this command will also search
8223 the files listed in @code{org-agenda-text-search-extra-files}.
8225 @node Stuck projects,  , Search view, Built-in agenda views
8226 @subsection Stuck projects
8227 @pindex GTD, Getting Things Done
8229 If you are following a system like David Allen's GTD to organize your
8230 work, one of the ``duties'' you have is a regular review to make sure
8231 that all projects move along.  A @emph{stuck} project is a project that
8232 has no defined next actions, so it will never show up in the TODO lists
8233 Org mode produces.  During the review, you need to identify such
8234 projects and define next actions for them.
8236 @table @kbd
8237 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8238 List projects that are stuck.
8239 @kindex C-c a !
8240 @item C-c a !
8241 @vindex org-stuck-projects
8242 Customize the variable @code{org-stuck-projects} to define what a stuck
8243 project is and how to find it.
8244 @end table
8246 You almost certainly will have to configure this view before it will
8247 work for you.  The built-in default assumes that all your projects are
8248 level-2 headlines, and that a project is not stuck if it has at least
8249 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8251 Let's assume that you, in your own way of using Org mode, identify
8252 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8253 indicate a project that should not be considered yet.  Let's further
8254 assume that the TODO keyword DONE marks finished projects, and that NEXT
8255 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
8256 is a next action even without the NEXT tag.  Finally, if the project
8257 contains the special word IGNORE anywhere, it should not be listed
8258 either.  In this case you would start by identifying eligible projects
8259 with a tags/todo match@footnote{@xref{Tag searches}.}
8260 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8261 IGNORE in the subtree to identify projects that are not stuck.  The
8262 correct customization for this is
8264 @lisp
8265 (setq org-stuck-projects
8266       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8267                                "\\<IGNORE\\>"))
8268 @end lisp
8270 Note that if a project is identified as non-stuck, the subtree of this entry
8271 will still be searched for stuck projects.
8273 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
8274 @section Presentation and sorting
8275 @cindex presentation, of agenda items
8277 @vindex org-agenda-prefix-format
8278 @vindex org-agenda-tags-column
8279 Before displaying items in an agenda view, Org mode visually prepares the
8280 items and sorts them.  Each item occupies a single line.  The line starts
8281 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8282 of the item and other important information.  You can customize in which
8283 column tags will be displayed through @code{org-agenda-tags-column}.  You can
8284 also customize the prefix using the option @code{org-agenda-prefix-format}.
8285 This prefix is followed by a cleaned-up version of the outline headline
8286 associated with the item.
8288 @menu
8289 * Categories::                  Not all tasks are equal
8290 * Time-of-day specifications::  How the agenda knows the time
8291 * Sorting agenda items::        The order of things
8292 * Filtering/limiting agenda items::  Dynamically narrow the agenda
8293 @end menu
8295 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
8296 @subsection Categories
8298 @cindex category
8299 @cindex #+CATEGORY
8300 The category is a broad label assigned to each agenda item.  By default,
8301 the category is simply derived from the file name, but you can also
8302 specify it with a special line in the buffer, like this@footnote{For
8303 backward compatibility, the following also works: if there are several
8304 such lines in a file, each specifies the category for the text below it.
8305 The first category also applies to any text before the first CATEGORY
8306 line.  However, using this method is @emph{strongly} deprecated as it is
8307 incompatible with the outline structure of the document.  The correct
8308 method for setting multiple categories in a buffer is using a
8309 property.}:
8311 @example
8312 #+CATEGORY: Thesis
8313 @end example
8315 @noindent
8316 @cindex property, CATEGORY
8317 If you would like to have a special CATEGORY for a single entry or a
8318 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8319 special category you want to apply as the value.
8321 @noindent
8322 The display in the agenda buffer looks best if the category is not
8323 longer than 10 characters.
8325 @noindent
8326 You can set up icons for category by customizing the
8327 @code{org-agenda-category-icon-alist} variable.
8329 @node Time-of-day specifications, Sorting agenda items, Categories, Presentation and sorting
8330 @subsection Time-of-day specifications
8331 @cindex time-of-day specification
8333 Org mode checks each agenda item for a time-of-day specification.  The
8334 time can be part of the timestamp that triggered inclusion into the
8335 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
8336 ranges can be specified with two timestamps, like
8338 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8340 In the headline of the entry itself, a time(range) may also appear as
8341 plain text (like @samp{12:45} or a @samp{8:30-1pm}).  If the agenda
8342 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8343 specifications in diary entries are recognized as well.
8345 For agenda display, Org mode extracts the time and displays it in a
8346 standard 24 hour format as part of the prefix.  The example times in
8347 the previous paragraphs would end up in the agenda like this:
8349 @example
8350     8:30-13:00 Arthur Dent lies in front of the bulldozer
8351    12:45...... Ford Prefect arrives and takes Arthur to the pub
8352    19:00...... The Vogon reads his poem
8353    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8354 @end example
8356 @cindex time grid
8357 If the agenda is in single-day mode, or for the display of today, the
8358 timed entries are embedded in a time grid, like
8360 @example
8361     8:00...... ------------------
8362     8:30-13:00 Arthur Dent lies in front of the bulldozer
8363    10:00...... ------------------
8364    12:00...... ------------------
8365    12:45...... Ford Prefect arrives and takes Arthur to the pub
8366    14:00...... ------------------
8367    16:00...... ------------------
8368    18:00...... ------------------
8369    19:00...... The Vogon reads his poem
8370    20:00...... ------------------
8371    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8372 @end example
8374 @vindex org-agenda-use-time-grid
8375 @vindex org-agenda-time-grid
8376 The time grid can be turned on and off with the variable
8377 @code{org-agenda-use-time-grid}, and can be configured with
8378 @code{org-agenda-time-grid}.
8380 @node Sorting agenda items, Filtering/limiting agenda items, Time-of-day specifications, Presentation and sorting
8381 @subsection Sorting agenda items
8382 @cindex sorting, of agenda items
8383 @cindex priorities, of agenda items
8384 Before being inserted into a view, the items are sorted.  How this is
8385 done depends on the type of view.
8386 @itemize @bullet
8387 @item
8388 @vindex org-agenda-files
8389 For the daily/weekly agenda, the items for each day are sorted.  The
8390 default order is to first collect all items containing an explicit
8391 time-of-day specification.  These entries will be shown at the beginning
8392 of the list, as a @emph{schedule} for the day.  After that, items remain
8393 grouped in categories, in the sequence given by @code{org-agenda-files}.
8394 Within each category, items are sorted by priority (@pxref{Priorities}),
8395 which is composed of the base priority (2000 for priority @samp{A}, 1000
8396 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8397 overdue scheduled or deadline items.
8398 @item
8399 For the TODO list, items remain in the order of categories, but within
8400 each category, sorting takes place according to priority
8401 (@pxref{Priorities}).  The priority used for sorting derives from the
8402 priority cookie, with additions depending on how close an item is to its due
8403 or scheduled date.
8404 @item
8405 For tags matches, items are not sorted at all, but just appear in the
8406 sequence in which they are found in the agenda files.
8407 @end itemize
8409 @vindex org-agenda-sorting-strategy
8410 Sorting can be customized using the variable
8411 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8412 the estimated effort of an entry (@pxref{Effort estimates}).
8414 @node Filtering/limiting agenda items,  , Sorting agenda items, Presentation and sorting
8415 @subsection Filtering/limiting agenda items
8417 Agenda built-in or customized commands are statically defined.  Agenda
8418 filters and limits provide two ways of dynamically narrowing down the list of
8419 agenda entries: @emph{fitlers} and @emph{limits}.  Filters only act on the
8420 display of the items, while limits take effect before the list of agenda
8421 entries is built.  Filter are more often used interactively, while limits are
8422 mostly useful when defined as local variables within custom agenda commands.
8424 @subsubheading Filtering in the agenda
8425 @cindex filtering, by tag, category, top headline and effort, in agenda
8426 @cindex tag filtering, in agenda
8427 @cindex category filtering, in agenda
8428 @cindex top headline filtering, in agenda
8429 @cindex effort filtering, in agenda
8430 @cindex query editing, in agenda
8432 @table @kbd
8433 @orgcmd{/,org-agenda-filter-by-tag}
8434 @vindex org-agenda-tag-filter-preset
8435 Filter the agenda view with respect to a tag and/or effort estimates.  The
8436 difference between this and a custom agenda command is that filtering is very
8437 fast, so that you can switch quickly between different filters without having
8438 to recreate the agenda.@footnote{Custom commands can preset a filter by
8439 binding the variable @code{org-agenda-tag-filter-preset} as an option.  This
8440 filter will then be applied to the view and persist as a basic filter through
8441 refreshes and more secondary filtering.  The filter is a global property of
8442 the entire agenda view---in a block agenda, you should only set this in the
8443 global options section, not in the section of an individual block.}
8445 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8446 all.  Pressing @key{TAB} at that prompt will offer use completion to select a
8447 tag (including any tags that do not have a selection character).  The command
8448 then hides all entries that do not contain or inherit this tag.  When called
8449 with prefix arg, remove the entries that @emph{do} have the tag.  A second
8450 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8451 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8452 will be narrowed by requiring or forbidding the selected additional tag.
8453 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8454 immediately use the @kbd{\} command.
8456 @vindex org-sort-agenda-noeffort-is-high
8457 In order to filter for effort estimates, you should set up allowed
8458 efforts globally, for example
8459 @lisp
8460 (setq org-global-properties
8461     '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8462 @end lisp
8463 You can then filter for an effort by first typing an operator, one of
8464 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8465 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8466 The filter will then restrict to entries with effort smaller-or-equal, equal,
8467 or larger-or-equal than the selected value.  If the digits 0--9 are not used
8468 as fast access keys to tags, you can also simply press the index digit
8469 directly without an operator.  In this case, @kbd{<} will be assumed.  For
8470 application of the operator, entries without a defined effort will be treated
8471 according to the value of @code{org-sort-agenda-noeffort-is-high}.  To filter
8472 for tasks without effort definition, press @kbd{?} as the operator.
8474 Org also supports automatic, context-aware tag filtering.  If the variable
8475 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8476 that function can decide which tags should be excluded from the agenda
8477 automatically.  Once this is set, the @kbd{/} command then accepts @kbd{RET}
8478 as a sub-option key and runs the auto exclusion logic.  For example, let's
8479 say you use a @code{Net} tag to identify tasks which need network access, an
8480 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8481 calls.  You could auto-exclude these tags based on the availability of the
8482 Internet, and outside of business hours, with something like this:
8484 @smalllisp
8485 @group
8486 (defun org-my-auto-exclude-function (tag)
8487   (and (cond
8488         ((string= tag "Net")
8489          (/= 0 (call-process "/sbin/ping" nil nil nil
8490                              "-c1" "-q" "-t1" "mail.gnu.org")))
8491         ((or (string= tag "Errand") (string= tag "Call"))
8492          (let ((hour (nth 2 (decode-time))))
8493            (or (< hour 8) (> hour 21)))))
8494        (concat "-" tag)))
8496 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8497 @end group
8498 @end smalllisp
8500 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8501 Narrow the current agenda filter by an additional condition.  When called with
8502 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8503 the effort criterion.  You can achieve the same effect by pressing @kbd{+} or
8504 @kbd{-} as the first key after the @kbd{/} command.
8507 @kindex [
8508 @kindex ]
8509 @kindex @{
8510 @kindex @}
8511 @item [ ] @{ @}
8512 @table @i
8513 @item @r{in} search view
8514 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8515 (@kbd{@{} and @kbd{@}}) to the query string.  The opening bracket/brace will
8516 add a positive search term prefixed by @samp{+}, indicating that this search
8517 term @i{must} occur/match in the entry.  The closing bracket/brace will add a
8518 negative search term which @i{must not} occur/match in the entry for it to be
8519 selected.
8520 @end table
8522 @orgcmd{<,org-agenda-filter-by-category}
8523 @vindex org-agenda-category-filter-preset
8525 Filter the current agenda view with respect to the category of the item at
8526 point.  Pressing @code{<} another time will remove this filter.  You can add
8527 a filter preset through the option @code{org-agenda-category-filter-preset}
8528 (see below.)
8530 @orgcmd{^,org-agenda-filter-by-top-headline}
8531 Filter the current agenda view and only display the siblings and the parent
8532 headline of the one at point.
8534 @orgcmd{=,org-agenda-filter-by-regexp}
8535 @vindex org-agenda-regexp-filter-preset
8537 Filter the agenda view by a regular expression: only show agenda entries
8538 matching the regular expression the user entered.  When called with a prefix
8539 argument, it will filter @emph{out} entries matching the regexp.  With two
8540 universal prefix arguments, it will remove all the regexp filters, which can
8541 be accumulated.  You can add a filter preset through the option
8542 @code{org-agenda-category-filter-preset} (see below.)
8544 @orgcmd{|,org-agenda-filter-remove-all}
8545 Remove all filters in the current agenda view.
8546 @end table
8548 @subsubheading Setting limits for the agenda
8549 @cindex limits, in agenda
8550 @vindex org-agenda-max-entries
8551 @vindex org-agenda-max-effort
8552 @vindex org-agenda-max-todos
8553 @vindex org-agenda-max-tags
8555 Here is a list of options that you can set, either globally, or locally in
8556 your custom agenda views@pxref{Custom agenda views}.
8558 @table @var
8559 @item org-agenda-max-entries
8560 Limit the number of entries.
8561 @item org-agenda-max-effort
8562 Limit the duration of accumulated efforts (as minutes).
8563 @item org-agenda-max-todos
8564 Limit the number of entries with TODO keywords.
8565 @item org-agenda-max-tags
8566 Limit the number of tagged entries.
8567 @end table
8569 When set to a positive integer, each option will exclude entries from other
8570 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8571 the agenda to 100 minutes of effort and exclude any entry that as no effort
8572 property.  If you want to include entries with no effort property, use a
8573 negative value for @code{org-agenda-max-effort}.
8575 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8576 command.  For example, this custom command will display the next five entries
8577 with a @code{NEXT} TODO keyword.
8579 @smalllisp
8580 (setq org-agenda-custom-commands
8581       '(("n" todo "NEXT"
8582          ((org-agenda-max-entries 5)))))
8583 @end smalllisp
8585 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8586 will again the next five entries again, including the first entry that was
8587 excluded so far.
8589 You can also dynamically set temporary limits@footnote{Those temporary limits
8590 are lost when rebuilding the agenda.}:
8592 @table @kbd
8593 @orgcmd{~,org-agenda-limit-interactively}
8594 This prompts for the type of limit to apply and its value.
8595 @end table
8597 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
8598 @section Commands in the agenda buffer
8599 @cindex commands, in agenda buffer
8601 Entries in the agenda buffer are linked back to the Org file or diary
8602 file where they originate.  You are not allowed to edit the agenda
8603 buffer itself, but commands are provided to show and jump to the
8604 original entry location, and to edit the Org files ``remotely'' from
8605 the agenda buffer.  In this way, all information is stored only once,
8606 removing the risk that your agenda and note files may diverge.
8608 Some commands can be executed with mouse clicks on agenda lines.  For
8609 the other commands, the cursor needs to be in the desired line.
8611 @table @kbd
8612 @tsubheading{Motion}
8613 @cindex motion commands in agenda
8614 @orgcmd{n,org-agenda-next-line}
8615 Next line (same as @key{down} and @kbd{C-n}).
8616 @orgcmd{p,org-agenda-previous-line}
8617 Previous line (same as @key{up} and @kbd{C-p}).
8618 @tsubheading{View/Go to Org file}
8619 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8620 Display the original location of the item in another window.
8621 With prefix arg, make sure that the entire entry is made visible in the
8622 outline, not only the heading.
8624 @orgcmd{L,org-agenda-recenter}
8625 Display original location and recenter that window.
8627 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8628 Go to the original location of the item in another window.
8630 @orgcmd{@key{RET},org-agenda-switch-to}
8631 Go to the original location of the item and delete other windows.
8633 @orgcmd{F,org-agenda-follow-mode}
8634 @vindex org-agenda-start-with-follow-mode
8635 Toggle Follow mode.  In Follow mode, as you move the cursor through
8636 the agenda buffer, the other window always shows the corresponding
8637 location in the Org file.  The initial setting for this mode in new
8638 agenda buffers can be set with the variable
8639 @code{org-agenda-start-with-follow-mode}.
8641 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8642 Display the entire subtree of the current item in an indirect buffer.  With a
8643 numeric prefix argument N, go up to level N and then take that tree.  If N is
8644 negative, go up that many levels.  With a @kbd{C-u} prefix, do not remove the
8645 previously used indirect buffer.
8647 @orgcmd{C-c C-o,org-agenda-open-link}
8648 Follow a link in the entry.  This will offer a selection of any links in the
8649 text belonging to the referenced Org node.  If there is only one link, it
8650 will be followed without a selection prompt.
8652 @tsubheading{Change display}
8653 @cindex display changing, in agenda
8654 @kindex A
8655 @item A
8656 Interactively select another agenda view and append it to the current view.
8658 @kindex o
8659 @item o
8660 Delete other windows.
8662 @orgcmdkskc{v d,d,org-agenda-day-view}
8663 @xorgcmdkskc{v w,w,org-agenda-week-view}
8664 @xorgcmd{v t,org-agenda-fortnight-view}
8665 @xorgcmd{v m,org-agenda-month-view}
8666 @xorgcmd{v y,org-agenda-year-view}
8667 @xorgcmd{v SPC,org-agenda-reset-view}
8668 @vindex org-agenda-span
8669 Switch to day/week/month/year view.  When switching to day or week view, this
8670 setting becomes the default for subsequent agenda refreshes.  Since month and
8671 year views are slow to create, they do not become the default.  A numeric
8672 prefix argument may be used to jump directly to a specific day of the year,
8673 ISO week, month, or year, respectively.  For example, @kbd{32 d} jumps to
8674 February 1st, @kbd{9 w} to ISO week number 9.  When setting day, week, or
8675 month view, a year may be encoded in the prefix argument as well.  For
8676 example, @kbd{200712 w} will jump to week 12 in 2007.  If such a year
8677 specification has only one or two digits, it will be mapped to the interval
8678 1938--2037.  @kbd{v @key{SPC}} will reset to what is set in
8679 @code{org-agenda-span}.
8681 @orgcmd{f,org-agenda-later}
8682 Go forward in time to display the following @code{org-agenda-current-span} days.
8683 For example, if the display covers a week, switch to the following week.
8684 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8686 @orgcmd{b,org-agenda-earlier}
8687 Go backward in time to display earlier dates.
8689 @orgcmd{.,org-agenda-goto-today}
8690 Go to today.
8692 @orgcmd{j,org-agenda-goto-date}
8693 Prompt for a date and go there.
8695 @orgcmd{J,org-agenda-clock-goto}
8696 Go to the currently clocked-in task @i{in the agenda buffer}.
8698 @orgcmd{D,org-agenda-toggle-diary}
8699 Toggle the inclusion of diary entries.  See @ref{Weekly/daily agenda}.
8701 @orgcmdkskc{v l,l,org-agenda-log-mode}
8702 @kindex v L
8703 @vindex org-log-done
8704 @vindex org-agenda-log-mode-items
8705 Toggle Logbook mode.  In Logbook mode, entries that were marked DONE while
8706 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8707 entries that have been clocked on that day.  You can configure the entry
8708 types that should be included in log mode using the variable
8709 @code{org-agenda-log-mode-items}.  When called with a @kbd{C-u} prefix, show
8710 all possible logbook entries, including state changes.  When called with two
8711 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8712 @kbd{v L} is equivalent to @kbd{C-u v l}.
8714 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8715 Include inactive timestamps into the current view.  Only for weekly/daily
8716 agenda and timeline views.
8718 @orgcmd{v a,org-agenda-archives-mode}
8719 @xorgcmd{v A,org-agenda-archives-mode 'files}
8720 Toggle Archives mode.  In Archives mode, trees that are marked
8721 @code{ARCHIVED} are also scanned when producing the agenda.  When you use the
8722 capital @kbd{A}, even all archive files are included.  To exit archives mode,
8723 press @kbd{v a} again.
8725 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8726 @vindex org-agenda-start-with-clockreport-mode
8727 @vindex org-clock-report-include-clocking-task
8728 Toggle Clockreport mode.  In Clockreport mode, the daily/weekly agenda will
8729 always show a table with the clocked times for the time span and file scope
8730 covered by the current agenda view.  The initial setting for this mode in new
8731 agenda buffers can be set with the variable
8732 @code{org-agenda-start-with-clockreport-mode}.  By using a prefix argument
8733 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8734 contributions from entries that are hidden by agenda filtering@footnote{Only
8735 tags filtering will be respected here, effort filtering is ignored.}.  See
8736 also the variable @code{org-clock-report-include-clocking-task}.
8738 @orgkey{v c}
8739 @vindex org-agenda-clock-consistency-checks
8740 Show overlapping clock entries, clocking gaps, and other clocking problems in
8741 the current agenda range.  You can then visit clocking lines and fix them
8742 manually.  See the variable @code{org-agenda-clock-consistency-checks} for
8743 information on how to customize the definition of what constituted a clocking
8744 problem.  To return to normal agenda display, press @kbd{l} to exit Logbook
8745 mode.
8747 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8748 @vindex org-agenda-start-with-entry-text-mode
8749 @vindex org-agenda-entry-text-maxlines
8750 Toggle entry text mode.  In entry text mode, a number of lines from the Org
8751 outline node referenced by an agenda line will be displayed below the line.
8752 The maximum number of lines is given by the variable
8753 @code{org-agenda-entry-text-maxlines}.  Calling this command with a numeric
8754 prefix argument will temporarily modify that number to the prefix value.
8756 @orgcmd{G,org-agenda-toggle-time-grid}
8757 @vindex org-agenda-use-time-grid
8758 @vindex org-agenda-time-grid
8759 Toggle the time grid on and off.  See also the variables
8760 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8762 @orgcmd{r,org-agenda-redo}
8763 Recreate the agenda buffer, for example to reflect the changes after
8764 modification of the timestamps of items with @kbd{S-@key{left}} and
8765 @kbd{S-@key{right}}.  When the buffer is the global TODO list, a prefix
8766 argument is interpreted to create a selective list for a specific TODO
8767 keyword.
8768 @orgcmd{g,org-agenda-redo}
8769 Same as @kbd{r}.
8771 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8772 Save all Org buffers in the current Emacs session, and also the locations of
8773 IDs.
8775 @orgcmd{C-c C-x C-c,org-agenda-columns}
8776 @vindex org-columns-default-format
8777 Invoke column view (@pxref{Column view}) in the agenda buffer.  The column
8778 view format is taken from the entry at point, or (if there is no entry at
8779 point), from the first entry in the agenda view.  So whatever the format for
8780 that entry would be in the original buffer (taken from a property, from a
8781 @code{#+COLUMNS} line, or from the default variable
8782 @code{org-columns-default-format}), will be used in the agenda.
8784 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8785 Remove the restriction lock on the agenda, if it is currently restricted to a
8786 file or subtree (@pxref{Agenda files}).
8788 @tsubheading{Secondary filtering and query editing}
8790 For a detailed description of these commands, see @pxref{Filtering/limiting
8791 agenda items}.
8793 @orgcmd{/,org-agenda-filter-by-tag}
8794 @vindex org-agenda-tag-filter-preset
8795 Filter the agenda view with respect to a tag and/or effort estimates.
8797 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8798 Narrow the current agenda filter by an additional condition.
8800 @orgcmd{<,org-agenda-filter-by-category}
8801 @vindex org-agenda-category-filter-preset
8803 Filter the current agenda view with respect to the category of the item at
8804 point.  Pressing @code{<} another time will remove this filter.
8806 @orgcmd{^,org-agenda-filter-by-top-headline}
8807 Filter the current agenda view and only display the siblings and the parent
8808 headline of the one at point.
8810 @orgcmd{=,org-agenda-filter-by-regexp}
8811 @vindex org-agenda-regexp-filter-preset
8813 Filter the agenda view by a regular expression: only show agenda entries
8814 matching the regular expression the user entered.  When called with a prefix
8815 argument, it will filter @emph{out} entries matching the regexp.  With two
8816 universal prefix arguments, it will remove all the regexp filters, which can
8817 be accumulated.  You can add a filter preset through the option
8818 @code{org-agenda-category-filter-preset} (see below.)
8820 @orgcmd{|,org-agenda-filter-remove-all}
8821 Remove all filters in the current agenda view.
8823 @tsubheading{Remote editing}
8824 @cindex remote editing, from agenda
8826 @item 0--9
8827 Digit argument.
8829 @cindex undoing remote-editing events
8830 @cindex remote editing, undo
8831 @orgcmd{C-_,org-agenda-undo}
8832 Undo a change due to a remote editing command.  The change is undone
8833 both in the agenda buffer and in the remote buffer.
8835 @orgcmd{t,org-agenda-todo}
8836 Change the TODO state of the item, both in the agenda and in the
8837 original org file.
8839 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8840 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8841 Switch to the next/previous set of TODO keywords.
8843 @orgcmd{C-k,org-agenda-kill}
8844 @vindex org-agenda-confirm-kill
8845 Delete the current agenda item along with the entire subtree belonging
8846 to it in the original Org file.  If the text to be deleted remotely
8847 is longer than one line, the kill needs to be confirmed by the user.  See
8848 variable @code{org-agenda-confirm-kill}.
8850 @orgcmd{C-c C-w,org-agenda-refile}
8851 Refile the entry at point.
8853 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8854 @vindex org-archive-default-command
8855 Archive the subtree corresponding to the entry at point using the default
8856 archiving command set in @code{org-archive-default-command}.  When using the
8857 @code{a} key, confirmation will be required.
8859 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8860 Toggle the ARCHIVE tag for the current headline.
8862 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8863 Move the subtree corresponding to the current entry to its @emph{archive
8864 sibling}.
8866 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8867 Archive the subtree corresponding to the current headline.  This means the
8868 entry will be moved to the configured archive location, most likely a
8869 different file.
8871 @orgcmd{T,org-agenda-show-tags}
8872 @vindex org-agenda-show-inherited-tags
8873 Show all tags associated with the current item.  This is useful if you have
8874 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8875 tags of a headline occasionally.
8877 @orgcmd{:,org-agenda-set-tags}
8878 Set tags for the current headline.  If there is an active region in the
8879 agenda, change a tag for all headings in the region.
8881 @kindex ,
8882 @item ,
8883 Set the priority for the current item (@command{org-agenda-priority}).
8884 Org mode prompts for the priority character.  If you reply with @key{SPC},
8885 the priority cookie is removed from the entry.
8887 @orgcmd{P,org-agenda-show-priority}
8888 Display weighted priority of current item.
8890 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8891 Increase the priority of the current item.  The priority is changed in
8892 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
8893 key for this.
8895 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8896 Decrease the priority of the current item.
8898 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8899 @vindex org-log-into-drawer
8900 Add a note to the entry.  This note will be recorded, and then filed to the
8901 same location where state change notes are put.  Depending on
8902 @code{org-log-into-drawer}, this may be inside a drawer.
8904 @orgcmd{C-c C-a,org-attach}
8905 Dispatcher for all command related to attachments.
8907 @orgcmd{C-c C-s,org-agenda-schedule}
8908 Schedule this item.  With prefix arg remove the scheduling timestamp
8910 @orgcmd{C-c C-d,org-agenda-deadline}
8911 Set a deadline for this item.  With prefix arg remove the deadline.
8913 @orgcmd{S-@key{right},org-agenda-do-date-later}
8914 Change the timestamp associated with the current line by one day into the
8915 future.  If the date is in the past, the first call to this command will move
8916 it to today.@*
8917 With a numeric prefix argument, change it by that many days.  For example,
8918 @kbd{3 6 5 S-@key{right}} will change it by a year.  With a @kbd{C-u} prefix,
8919 change the time by one hour.  If you immediately repeat the command, it will
8920 continue to change hours even without the prefix arg.  With a double @kbd{C-u
8921 C-u} prefix, do the same for changing minutes.@*
8922 The stamp is changed in the original Org file, but the change is not directly
8923 reflected in the agenda buffer.  Use @kbd{r} or @kbd{g} to update the buffer.
8925 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8926 Change the timestamp associated with the current line by one day
8927 into the past.
8929 @orgcmd{>,org-agenda-date-prompt}
8930 Change the timestamp associated with the current line.  The key @kbd{>} has
8931 been chosen, because it is the same as @kbd{S-.}  on my keyboard.
8933 @orgcmd{I,org-agenda-clock-in}
8934 Start the clock on the current item.  If a clock is running already, it
8935 is stopped first.
8937 @orgcmd{O,org-agenda-clock-out}
8938 Stop the previously started clock.
8940 @orgcmd{X,org-agenda-clock-cancel}
8941 Cancel the currently running clock.
8943 @orgcmd{J,org-agenda-clock-goto}
8944 Jump to the running clock in another window.
8946 @orgcmd{k,org-agenda-capture}
8947 Like @code{org-capture}, but use the date at point as the default date for
8948 the capture template.  See @code{org-capture-use-agenda-date} to make this
8949 the default behavior of @code{org-capture}.
8950 @cindex capturing, from agenda
8951 @vindex org-capture-use-agenda-date
8953 @tsubheading{Dragging agenda lines forward/backward}
8954 @cindex dragging, agenda lines
8956 @orgcmd{M-<up>,org-agenda-drag-line-backward}
8957 Drag the line at point backward one line@footnote{Moving agenda lines does
8958 not persist after an agenda refresh and does not modify the contributing
8959 @file{.org} files}.  With a numeric prefix argument, drag backward by that
8960 many lines.
8962 @orgcmd{M-<down>,org-agenda-drag-line-forward}
8963 Drag the line at point forward one line.  With a numeric prefix argument,
8964 drag forward by that many lines.
8966 @tsubheading{Bulk remote editing selected entries}
8967 @cindex remote editing, bulk, from agenda
8968 @vindex org-agenda-bulk-custom-functions
8970 @orgcmd{m,org-agenda-bulk-mark}
8971 Mark the entry at point for bulk action.  With numeric prefix argument, mark
8972 that many successive entries.
8974 @orgcmd{*,org-agenda-bulk-mark-all}
8975 Mark all visible agenda entries for bulk action.
8977 @orgcmd{u,org-agenda-bulk-unmark}
8978 Unmark entry at point for bulk action.
8980 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8981 Unmark all marked entries for bulk action.
8983 @orgcmd{M-m,org-agenda-bulk-toggle}
8984 Toggle mark of the entry at point for bulk action.
8986 @orgcmd{M-*,org-agenda-bulk-toggle-all}
8987 Toggle marks of all visible entries for bulk action.
8989 @orgcmd{%,org-agenda-bulk-mark-regexp}
8990 Mark entries matching a regular expression for bulk action.
8992 @orgcmd{B,org-agenda-bulk-action}
8993 Bulk action: act on all marked entries in the agenda.  This will prompt for
8994 another key to select the action to be applied.  The prefix arg to @kbd{B}
8995 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8996 these special timestamps.  By default, marks are removed after the bulk.  If
8997 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
8998 @code{t} or hit @kbd{p} at the prompt.
9000 @table @kbd
9001 @item *
9002 Toggle persistent marks.
9003 @item $
9004 Archive all selected entries.
9005 @item A
9006 Archive entries by moving them to their respective archive siblings.
9007 @item t
9008 Change TODO state.  This prompts for a single TODO keyword and changes the
9009 state of all selected entries, bypassing blocking and suppressing logging
9010 notes (but not timestamps).
9011 @item +
9012 Add a tag to all selected entries.
9013 @item -
9014 Remove a tag from all selected entries.
9015 @item s
9016 Schedule all items to a new date.  To shift existing schedule dates by a
9017 fixed number of days, use something starting with double plus at the prompt,
9018 for example @samp{++8d} or @samp{++2w}.
9019 @item d
9020 Set deadline to a specific date.
9021 @item r
9022 Prompt for a single refile target and move all entries.  The entries will no
9023 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9024 @item S
9025 Reschedule randomly into the coming N days.  N will be prompted for.  With
9026 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9027 @item f
9028 Apply a function@footnote{You can also create persistent custom functions
9029 through @code{org-agenda-bulk-custom-functions}.} to marked entries.  For
9030 example, the function below sets the CATEGORY property of the entries to web.
9032 @lisp
9033 @group
9034 (defun set-category ()
9035   (interactive "P")
9036   (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9037                      (org-agenda-error)))
9038          (buffer (marker-buffer marker)))
9039     (with-current-buffer buffer
9040       (save-excursion
9041         (save-restriction
9042           (widen)
9043           (goto-char marker)
9044           (org-back-to-heading t)
9045           (org-set-property "CATEGORY" "web"))))))
9046 @end group
9047 @end lisp
9048 @end table
9050 @tsubheading{Calendar commands}
9051 @cindex calendar commands, from agenda
9053 @orgcmd{c,org-agenda-goto-calendar}
9054 Open the Emacs calendar and move to the date at the agenda cursor.
9056 @orgcmd{c,org-calendar-goto-agenda}
9057 When in the calendar, compute and show the Org mode agenda for the
9058 date at the cursor.
9060 @cindex diary entries, creating from agenda
9061 @orgcmd{i,org-agenda-diary-entry}
9062 @vindex org-agenda-diary-file
9063 Insert a new entry into the diary, using the date at the cursor and (for
9064 block entries) the date at the mark.  This will add to the Emacs diary
9065 file@footnote{This file is parsed for the agenda when
9066 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9067 command in the calendar.  The diary file will pop up in another window, where
9068 you can add the entry.
9070 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9071 Org will create entries (in Org mode syntax) in that file instead.  Most
9072 entries will be stored in a date-based outline tree that will later make it
9073 easy to archive appointments from previous months/years.  The tree will be
9074 built under an entry with a @code{DATE_TREE} property, or else with years as
9075 top-level entries.  Emacs will prompt you for the entry text---if you specify
9076 it, the entry will be created in @code{org-agenda-diary-file} without further
9077 interaction.  If you directly press @key{RET} at the prompt without typing
9078 text, the target file will be shown in another window for you to finish the
9079 entry there.  See also the @kbd{k r} command.
9081 @orgcmd{M,org-agenda-phases-of-moon}
9082 Show the phases of the moon for the three months around current date.
9084 @orgcmd{S,org-agenda-sunrise-sunset}
9085 Show sunrise and sunset times.  The geographical location must be set
9086 with calendar variables, see the documentation for the Emacs calendar.
9088 @orgcmd{C,org-agenda-convert-date}
9089 Convert the date at cursor into many other cultural and historic
9090 calendars.
9092 @orgcmd{H,org-agenda-holidays}
9093 Show holidays for three months around the cursor date.
9095 @item M-x org-icalendar-combine-agenda-files RET
9096 Export a single iCalendar file containing entries from all agenda files.
9097 This is a globally available command, and also available in the agenda menu.
9099 @tsubheading{Exporting to a file}
9100 @orgcmd{C-x C-w,org-agenda-write}
9101 @cindex exporting agenda views
9102 @cindex agenda views, exporting
9103 @vindex org-agenda-exporter-settings
9104 Write the agenda view to a file.  Depending on the extension of the selected
9105 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9106 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9107 (any other extension).  When exporting to Org, only the body of original
9108 headlines are exported, not subtrees or inherited tags.  When called with a
9109 @kbd{C-u} prefix argument, immediately open the newly created file.  Use the
9110 variable @code{org-agenda-exporter-settings} to set options for
9111 @file{ps-print} and for @file{htmlize} to be used during export.
9113 @tsubheading{Quit and Exit}
9114 @orgcmd{q,org-agenda-quit}
9115 Quit agenda, remove the agenda buffer.
9117 @cindex agenda files, removing buffers
9118 @orgcmd{x,org-agenda-exit}
9119 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9120 for the compilation of the agenda.  Buffers created by the user to
9121 visit Org files will not be removed.
9122 @end table
9125 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
9126 @section Custom agenda views
9127 @cindex custom agenda views
9128 @cindex agenda views, custom
9130 Custom agenda commands serve two purposes: to store and quickly access
9131 frequently used TODO and tags searches, and to create special composite
9132 agenda buffers.  Custom agenda commands will be accessible through the
9133 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9135 @menu
9136 * Storing searches::            Type once, use often
9137 * Block agenda::                All the stuff you need in a single buffer
9138 * Setting Options::             Changing the rules
9139 @end menu
9141 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
9142 @subsection Storing searches
9144 The first application of custom searches is the definition of keyboard
9145 shortcuts for frequently used searches, either creating an agenda
9146 buffer, or a sparse tree (the latter covering of course only the current
9147 buffer).
9148 @kindex C-c a C
9149 @vindex org-agenda-custom-commands
9150 @cindex agenda views, main example
9151 @cindex agenda, as an agenda views
9152 @cindex agenda*, as an agenda views
9153 @cindex tags, as an agenda view
9154 @cindex todo, as an agenda view
9155 @cindex tags-todo
9156 @cindex todo-tree
9157 @cindex occur-tree
9158 @cindex tags-tree
9160 Custom commands are configured in the variable
9161 @code{org-agenda-custom-commands}.  You can customize this variable, for
9162 example by pressing @kbd{C-c a C}.  You can also directly set it with Emacs
9163 Lisp in @file{.emacs}.  The following example contains all valid agenda
9164 views:
9166 @lisp
9167 @group
9168 (setq org-agenda-custom-commands
9169       '(("x" agenda)
9170         ("y" agenda*)
9171         ("w" todo "WAITING")
9172         ("W" todo-tree "WAITING")
9173         ("u" tags "+boss-urgent")
9174         ("v" tags-todo "+boss-urgent")
9175         ("U" tags-tree "+boss-urgent")
9176         ("f" occur-tree "\\<FIXME\\>")
9177         ("h" . "HOME+Name tags searches") ; description for "h" prefix
9178         ("hl" tags "+home+Lisa")
9179         ("hp" tags "+home+Peter")
9180         ("hk" tags "+home+Kim")))
9181 @end group
9182 @end lisp
9184 @noindent
9185 The initial string in each entry defines the keys you have to press
9186 after the dispatcher command @kbd{C-c a} in order to access the command.
9187 Usually this will be just a single character, but if you have many
9188 similar commands, you can also define two-letter combinations where the
9189 first character is the same in several combinations and serves as a
9190 prefix key@footnote{You can provide a description for a prefix key by
9191 inserting a cons cell with the prefix and the description.}.  The second
9192 parameter is the search type, followed by the string or regular
9193 expression to be used for the matching.  The example above will
9194 therefore define:
9196 @table @kbd
9197 @item C-c a x
9198 as a global search for agenda entries planned@footnote{@emph{Planned} means
9199 here that these entries have some planning information attached to them, like
9200 a time-stamp, a scheduled or a deadline string.  See
9201 @code{org-agenda-entry-types} on how to set what planning information will be
9202 taken into account.} this week/day.
9203 @item C-c a y
9204 as a global search for agenda entries planned this week/day, but only those
9205 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9206 @item C-c a w
9207 as a global search for TODO entries with @samp{WAITING} as the TODO
9208 keyword
9209 @item C-c a W
9210 as the same search, but only in the current buffer and displaying the
9211 results as a sparse tree
9212 @item C-c a u
9213 as a global tags search for headlines marked @samp{:boss:} but not
9214 @samp{:urgent:}
9215 @item C-c a v
9216 as the same search as @kbd{C-c a u}, but limiting the search to
9217 headlines that are also TODO items
9218 @item C-c a U
9219 as the same search as @kbd{C-c a u}, but only in the current buffer and
9220 displaying the result as a sparse tree
9221 @item C-c a f
9222 to create a sparse tree (again: current buffer only) with all entries
9223 containing the word @samp{FIXME}
9224 @item C-c a h
9225 as a prefix command for a HOME tags search where you have to press an
9226 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9227 Peter, or Kim) as additional tag to match.
9228 @end table
9230 Note that the @code{*-tree} agenda views need to be called from an
9231 Org buffer as they operate on the current buffer only.
9233 @node Block agenda, Setting Options, Storing searches, Custom agenda views
9234 @subsection Block agenda
9235 @cindex block agenda
9236 @cindex agenda, with block views
9238 Another possibility is the construction of agenda views that comprise
9239 the results of @emph{several} commands, each of which creates a block in
9240 the agenda buffer.  The available commands include @code{agenda} for the
9241 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9242 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9243 matching commands discussed above: @code{todo}, @code{tags}, and
9244 @code{tags-todo}.  Here are two examples:
9246 @lisp
9247 @group
9248 (setq org-agenda-custom-commands
9249       '(("h" "Agenda and Home-related tasks"
9250          ((agenda "")
9251           (tags-todo "home")
9252           (tags "garden")))
9253         ("o" "Agenda and Office-related tasks"
9254          ((agenda "")
9255           (tags-todo "work")
9256           (tags "office")))))
9257 @end group
9258 @end lisp
9260 @noindent
9261 This will define @kbd{C-c a h} to create a multi-block view for stuff
9262 you need to attend to at home.  The resulting agenda buffer will contain
9263 your agenda for the current week, all TODO items that carry the tag
9264 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
9265 command @kbd{C-c a o} provides a similar view for office tasks.
9267 @node Setting Options,  , Block agenda, Custom agenda views
9268 @subsection Setting options for custom commands
9269 @cindex options, for custom agenda views
9271 @vindex org-agenda-custom-commands
9272 Org mode contains a number of variables regulating agenda construction
9273 and display.  The global variables define the behavior for all agenda
9274 commands, including the custom commands.  However, if you want to change
9275 some settings just for a single custom view, you can do so.  Setting
9276 options requires inserting a list of variable names and values at the
9277 right spot in @code{org-agenda-custom-commands}.  For example:
9279 @lisp
9280 @group
9281 (setq org-agenda-custom-commands
9282       '(("w" todo "WAITING"
9283          ((org-agenda-sorting-strategy '(priority-down))
9284           (org-agenda-prefix-format "  Mixed: ")))
9285         ("U" tags-tree "+boss-urgent"
9286          ((org-show-following-heading nil)
9287           (org-show-hierarchy-above nil)))
9288         ("N" search ""
9289          ((org-agenda-files '("~org/notes.org"))
9290           (org-agenda-text-search-extra-files nil)))))
9291 @end group
9292 @end lisp
9294 @noindent
9295 Now the @kbd{C-c a w} command will sort the collected entries only by
9296 priority, and the prefix format is modified to just say @samp{  Mixed: }
9297 instead of giving the category of the entry.  The sparse tags tree of
9298 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9299 headline hierarchy above the match, nor the headline following the match
9300 will be shown.  The command @kbd{C-c a N} will do a text search limited
9301 to only a single file.
9303 @vindex org-agenda-custom-commands
9304 For command sets creating a block agenda,
9305 @code{org-agenda-custom-commands} has two separate spots for setting
9306 options.  You can add options that should be valid for just a single
9307 command in the set, and options that should be valid for all commands in
9308 the set.  The former are just added to the command entry; the latter
9309 must come after the list of command entries.  Going back to the block
9310 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9311 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9312 the results for GARDEN tags query in the opposite order,
9313 @code{priority-up}.  This would look like this:
9315 @lisp
9316 @group
9317 (setq org-agenda-custom-commands
9318       '(("h" "Agenda and Home-related tasks"
9319          ((agenda)
9320           (tags-todo "home")
9321           (tags "garden"
9322                 ((org-agenda-sorting-strategy '(priority-up)))))
9323          ((org-agenda-sorting-strategy '(priority-down))))
9324         ("o" "Agenda and Office-related tasks"
9325          ((agenda)
9326           (tags-todo "work")
9327           (tags "office")))))
9328 @end group
9329 @end lisp
9331 As you see, the values and parentheses setting is a little complex.
9332 When in doubt, use the customize interface to set this variable---it
9333 fully supports its structure.  Just one caveat: when setting options in
9334 this interface, the @emph{values} are just Lisp expressions.  So if the
9335 value is a string, you need to add the double-quotes around the value
9336 yourself.
9338 @vindex org-agenda-custom-commands-contexts
9339 To control whether an agenda command should be accessible from a specific
9340 context, you can customize @code{org-agenda-custom-commands-contexts}.  Let's
9341 say for example that you have an agenda commands @code{"o"} displaying a view
9342 that you only need when reading emails.  Then you would configure this option
9343 like this:
9345 @lisp
9346 (setq org-agenda-custom-commands-contexts
9347       '(("o" (in-mode . "message-mode"))))
9348 @end lisp
9350 You can also tell that the command key @code{"o"} should refer to another
9351 command key @code{"r"}.  In that case, add this command key like this:
9353 @lisp
9354 (setq org-agenda-custom-commands-contexts
9355       '(("o" "r" (in-mode . "message-mode"))))
9356 @end lisp
9358 See the docstring of the variable for more information.
9360 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
9361 @section Exporting Agenda Views
9362 @cindex agenda views, exporting
9364 If you are away from your computer, it can be very useful to have a printed
9365 version of some agenda views to carry around.  Org mode can export custom
9366 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9367 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9368 ghostscript @file{ps2pdf} utility must be installed on the system.  Selecting
9369 a PDF file will also create the postscript file.}, and iCalendar files.  If
9370 you want to do this only occasionally, use the command
9372 @table @kbd
9373 @orgcmd{C-x C-w,org-agenda-write}
9374 @cindex exporting agenda views
9375 @cindex agenda views, exporting
9376 @vindex org-agenda-exporter-settings
9377 Write the agenda view to a file.  Depending on the extension of the selected
9378 file name, the view will be exported as HTML (extension @file{.html} or
9379 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9380 @file{.ics}), or plain text (any other extension).  Use the variable
9381 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9382 for @file{htmlize} to be used during export, for example
9384 @vindex org-agenda-add-entry-text-maxlines
9385 @vindex htmlize-output-type
9386 @vindex ps-number-of-columns
9387 @vindex ps-landscape-mode
9388 @lisp
9389 (setq org-agenda-exporter-settings
9390       '((ps-number-of-columns 2)
9391         (ps-landscape-mode t)
9392         (org-agenda-add-entry-text-maxlines 5)
9393         (htmlize-output-type 'css)))
9394 @end lisp
9395 @end table
9397 If you need to export certain agenda views frequently, you can associate
9398 any custom agenda command with a list of output file names
9399 @footnote{If you want to store standard views like the weekly agenda
9400 or the global TODO list as well, you need to define custom commands for
9401 them in order to be able to specify file names.}.  Here is an example
9402 that first defines custom commands for the agenda and the global
9403 TODO list, together with a number of files to which to export them.
9404 Then we define two block agenda commands and specify file names for them
9405 as well.  File names can be relative to the current working directory,
9406 or absolute.
9408 @lisp
9409 @group
9410 (setq org-agenda-custom-commands
9411       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9412         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9413         ("h" "Agenda and Home-related tasks"
9414          ((agenda "")
9415           (tags-todo "home")
9416           (tags "garden"))
9417          nil
9418          ("~/views/home.html"))
9419         ("o" "Agenda and Office-related tasks"
9420          ((agenda)
9421           (tags-todo "work")
9422           (tags "office"))
9423          nil
9424          ("~/views/office.ps" "~/calendars/office.ics"))))
9425 @end group
9426 @end lisp
9428 The extension of the file name determines the type of export.  If it is
9429 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9430 the buffer to HTML and save it to this file name.  If the extension is
9431 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9432 Postscript output.  If the extension is @file{.ics}, iCalendar export is
9433 run export over all files that were used to construct the agenda, and
9434 limit the export to entries listed in the agenda.  Any other
9435 extension produces a plain ASCII file.
9437 The export files are @emph{not} created when you use one of those
9438 commands interactively because this might use too much overhead.
9439 Instead, there is a special command to produce @emph{all} specified
9440 files in one step:
9442 @table @kbd
9443 @orgcmd{C-c a e,org-store-agenda-views}
9444 Export all agenda views that have export file names associated with
9445 them.
9446 @end table
9448 You can use the options section of the custom agenda commands to also
9449 set options for the export commands.  For example:
9451 @lisp
9452 (setq org-agenda-custom-commands
9453       '(("X" agenda ""
9454          ((ps-number-of-columns 2)
9455           (ps-landscape-mode t)
9456           (org-agenda-prefix-format " [ ] ")
9457           (org-agenda-with-colors nil)
9458           (org-agenda-remove-tags t))
9459          ("theagenda.ps"))))
9460 @end lisp
9462 @noindent
9463 This command sets two options for the Postscript exporter, to make it
9464 print in two columns in landscape format---the resulting page can be cut
9465 in two and then used in a paper agenda.  The remaining settings modify
9466 the agenda prefix to omit category and scheduling information, and
9467 instead include a checkbox to check off items.  We also remove the tags
9468 to make the lines compact, and we don't want to use colors for the
9469 black-and-white printer.  Settings specified in
9470 @code{org-agenda-exporter-settings} will also apply, but the settings
9471 in @code{org-agenda-custom-commands} take precedence.
9473 @noindent
9474 From the command line you may also use
9475 @example
9476 emacs -eval (org-batch-store-agenda-views) -kill
9477 @end example
9478 @noindent
9479 or, if you need to modify some parameters@footnote{Quoting depends on the
9480 system you use, please check the FAQ for examples.}
9481 @example
9482 emacs -eval '(org-batch-store-agenda-views                      \
9483               org-agenda-span (quote month)                     \
9484               org-agenda-start-day "2007-11-01"                 \
9485               org-agenda-include-diary nil                      \
9486               org-agenda-files (quote ("~/org/project.org")))'  \
9487       -kill
9488 @end example
9489 @noindent
9490 which will create the agenda views restricted to the file
9491 @file{~/org/project.org}, without diary entries and with a 30-day
9492 extent.
9494 You can also extract agenda information in a way that allows further
9495 processing by other programs.  See @ref{Extracting agenda information}, for
9496 more information.
9499 @node Agenda column view,  , Exporting Agenda Views, Agenda Views
9500 @section Using column view in the agenda
9501 @cindex column view, in agenda
9502 @cindex agenda, column view
9504 Column view (@pxref{Column view}) is normally used to view and edit
9505 properties embedded in the hierarchical structure of an Org file.  It can be
9506 quite useful to use column view also from the agenda, where entries are
9507 collected by certain criteria.
9509 @table @kbd
9510 @orgcmd{C-c C-x C-c,org-agenda-columns}
9511 Turn on column view in the agenda.
9512 @end table
9514 To understand how to use this properly, it is important to realize that the
9515 entries in the agenda are no longer in their proper outline environment.
9516 This causes the following issues:
9518 @enumerate
9519 @item
9520 @vindex org-columns-default-format
9521 @vindex org-overriding-columns-format
9522 Org needs to make a decision which @code{COLUMNS} format to use.  Since the
9523 entries in the agenda are collected from different files, and different files
9524 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9525 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9526 currently set, and if so, takes the format from there.  Otherwise it takes
9527 the format associated with the first item in the agenda, or, if that item
9528 does not have a specific format (defined in a property, or in its file), it
9529 uses @code{org-columns-default-format}.
9530 @item
9531 @cindex property, special, CLOCKSUM
9532 If any of the columns has a summary type defined (@pxref{Column attributes}),
9533 turning on column view in the agenda will visit all relevant agenda files and
9534 make sure that the computations of this property are up to date.  This is
9535 also true for the special @code{CLOCKSUM} property.  Org will then sum the
9536 values displayed in the agenda.  In the daily/weekly agenda, the sums will
9537 cover a single day; in all other views they cover the entire block.  It is
9538 vital to realize that the agenda may show the same entry @emph{twice} (for
9539 example as scheduled and as a deadline), and it may show two entries from the
9540 same hierarchy (for example a @emph{parent} and its @emph{child}).  In these
9541 cases, the summation in the agenda will lead to incorrect results because
9542 some values will count double.
9543 @item
9544 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9545 the entire clocked time for this item.  So even in the daily/weekly agenda,
9546 the clocksum listed in column view may originate from times outside the
9547 current view.  This has the advantage that you can compare these values with
9548 a column listing the planned total effort for a task---one of the major
9549 applications for column view in the agenda.  If you want information about
9550 clocked time in the displayed period use clock table mode (press @kbd{R} in
9551 the agenda).
9553 @item
9554 @cindex property, special, CLOCKSUM_T
9555 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9556 always today's clocked time for this item.  So even in the weekly agenda,
9557 the clocksum listed in column view only originates from today.  This lets
9558 you compare the time you spent on a task for today, with the time already
9559 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9560 @end enumerate
9563 @node Markup, Exporting, Agenda Views, Top
9564 @chapter Markup for rich export
9566 When exporting Org mode documents, the exporter tries to reflect the
9567 structure of the document as accurately as possible in the back-end.  Since
9568 export targets like HTML, @LaTeX{} allow much richer formatting, Org mode has
9569 rules on how to prepare text for rich export.  This section summarizes the
9570 markup rules used in an Org mode buffer.
9572 @menu
9573 * Structural markup elements::  The basic structure as seen by the exporter
9574 * Images and tables::           Images, tables and caption mechanism
9575 * Literal examples::            Source code examples with special formatting
9576 * Include files::               Include additional files into a document
9577 * Index entries::               Making an index
9578 * Macro replacement::           Use macros to create templates
9579 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
9580 * Special blocks::              Containers targeted at export back-ends
9581 @end menu
9583 @node Structural markup elements, Images and tables, Markup, Markup
9584 @section Structural markup elements
9586 @menu
9587 * Document title::              Where the title is taken from
9588 * Headings and sections::       The document structure as seen by the exporter
9589 * Table of contents::           The if and where of the table of contents
9590 * Lists::                       Lists
9591 * Paragraphs::                  Paragraphs
9592 * Footnote markup::             Footnotes
9593 * Emphasis and monospace::      Bold, italic, etc.
9594 * Horizontal rules::            Make a line
9595 * Comment lines::               What will *not* be exported
9596 @end menu
9598 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
9599 @subheading Document title
9600 @cindex document title, markup rules
9602 @noindent
9603 The title of the exported document is taken from the special line
9605 @cindex #+TITLE
9606 @example
9607 #+TITLE: This is the title of the document
9608 @end example
9610 @noindent
9611 If this line does not exist, the title will be the name of the file
9612 associated to buffer, without extension, or the buffer name.
9614 @cindex property, EXPORT_TITLE
9615 If you are exporting only a subtree, its heading will become the title of the
9616 document.  If the subtree has a property @code{EXPORT_TITLE}, that will take
9617 precedence.
9619 @node Headings and sections, Table of contents, Document title, Structural markup elements
9620 @subheading Headings and sections
9621 @cindex headings and sections, markup rules
9623 @vindex org-export-headline-levels
9624 The outline structure of the document as described in @ref{Document
9625 Structure}, forms the basis for defining sections of the exported document.
9626 However, since the outline structure is also used for (for example) lists of
9627 tasks, only the first three outline levels will be used as headings.  Deeper
9628 levels will become itemized lists.  You can change the location of this
9629 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9630 per-file basis with a line
9632 @cindex #+OPTIONS
9633 @example
9634 #+OPTIONS: H:4
9635 @end example
9637 @node Table of contents, Lists, Headings and sections, Structural markup elements
9638 @subheading Table of contents
9639 @cindex table of contents, markup rules
9641 @cindex #+TOC
9642 @vindex org-export-with-toc
9643 The table of contents is normally inserted directly before the first headline
9644 of the file.  The depth of the table is by default the same as the number of
9645 headline levels, but you can choose a smaller number, or turn off the table
9646 of contents entirely, by configuring the variable @code{org-export-with-toc},
9647 or on a per-file basis with a line like
9649 @example
9650 #+OPTIONS: toc:2          (only to two levels in TOC)
9651 #+OPTIONS: toc:nil        (no default TOC at all)
9652 @end example
9654 If you would like to move the table of contents to a different location, you
9655 should turn off the default table using @code{org-export-with-toc} or
9656 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9657 location(s).
9659 @example
9660 #+OPTIONS: toc:nil        (no default TOC)
9662 #+TOC: headlines 2        (insert TOC here, with two headline levels)
9663 @end example
9665 Multiple @code{#+TOC: headline} lines are allowed.  The same @code{TOC}
9666 keyword can also generate a list of all tables (resp.@: all listings) with a
9667 caption in the buffer.
9669 @example
9670 #+TOC: listings           (build a list of listings)
9671 #+TOC: tables             (build a list of tables)
9672 @end example
9674 @cindex property, ALT_TITLE
9675 The headline's title usually determines its corresponding entry in a table of
9676 contents.  However, it is possible to specify an alternative title by
9677 setting @code{ALT_TITLE} property accordingly.  It will then be used when
9678 building the table.
9680 @node Lists, Paragraphs, Table of contents, Structural markup elements
9681 @subheading Lists
9682 @cindex lists, markup rules
9684 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9685 syntax for such lists.  Most back-ends support unordered, ordered, and
9686 description lists.
9688 @node Paragraphs, Footnote markup, Lists, Structural markup elements
9689 @subheading Paragraphs, line breaks, and quoting
9690 @cindex paragraphs, markup rules
9692 Paragraphs are separated by at least one empty line.  If you need to enforce
9693 a line break within a paragraph, use @samp{\\} at the end of a line.
9695 To keep the line breaks in a region, but otherwise use normal formatting, you
9696 can use this construct, which can also be used to format poetry.
9698 @cindex #+BEGIN_VERSE
9699 @example
9700 #+BEGIN_VERSE
9701  Great clouds overhead
9702  Tiny black birds rise and fall
9703  Snow covers Emacs
9705      -- AlexSchroeder
9706 #+END_VERSE
9707 @end example
9709 When quoting a passage from another document, it is customary to format this
9710 as a paragraph that is indented on both the left and the right margin.  You
9711 can include quotations in Org mode documents like this:
9713 @cindex #+BEGIN_QUOTE
9714 @example
9715 #+BEGIN_QUOTE
9716 Everything should be made as simple as possible,
9717 but not any simpler -- Albert Einstein
9718 #+END_QUOTE
9719 @end example
9721 If you would like to center some text, do it like this:
9722 @cindex #+BEGIN_CENTER
9723 @example
9724 #+BEGIN_CENTER
9725 Everything should be made as simple as possible, \\
9726 but not any simpler
9727 #+END_CENTER
9728 @end example
9731 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
9732 @subheading Footnote markup
9733 @cindex footnotes, markup rules
9734 @cindex @file{footnote.el}
9736 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9737 by all back-ends.  Org allows multiple references to the same note, and
9738 multiple footnotes side by side.
9740 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
9741 @subheading Emphasis and monospace
9743 @cindex underlined text, markup rules
9744 @cindex bold text, markup rules
9745 @cindex italic text, markup rules
9746 @cindex verbatim text, markup rules
9747 @cindex code text, markup rules
9748 @cindex strike-through text, markup rules
9749 @vindex org-fontify-emphasized-text
9750 @vindex org-emphasis-regexp-components
9751 @vindex org-emphasis-alist
9752 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9753 and @code{~code~}, and, if you must, @samp{+strike-through+}.  Text
9754 in the code and verbatim string is not processed for Org mode specific
9755 syntax, it is exported verbatim.
9757 To turn off fontification for marked up text, you can set
9758 @code{org-fontify-emphasized-text} to @code{nil}.  To narrow down the list of
9759 available markup syntax, you can customize @code{org-emphasis-alist}.  To fine
9760 tune what characters are allowed before and after the markup characters, you
9761 can tweak @code{org-emphasis-regexp-components}.  Beware that changing one of
9762 the above variables will no take effect until you reload Org, for which you
9763 may need to restart Emacs.
9765 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
9766 @subheading  Horizontal rules
9767 @cindex horizontal rules, markup rules
9768 A line consisting of only dashes, and at least 5 of them, will be exported as
9769 a horizontal line.
9771 @node Comment lines,  , Horizontal rules, Structural markup elements
9772 @subheading Comment lines
9773 @cindex comment lines
9774 @cindex exporting, not
9775 @cindex #+BEGIN_COMMENT
9777 Lines starting with zero or more whitespace characters followed by one
9778 @samp{#} and a whitespace are treated as comments and will never be exported.
9779 Also entire subtrees starting with the word @samp{COMMENT} will never be
9780 exported.  Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
9781 ... @samp{#+END_COMMENT} will not be exported.
9783 @table @kbd
9784 @kindex C-c ;
9785 @item C-c ;
9786 Toggle the COMMENT keyword at the beginning of an entry.
9787 @end table
9790 @node Images and tables, Literal examples, Structural markup elements, Markup
9791 @section Images and Tables
9793 @cindex tables, markup rules
9794 @cindex #+CAPTION
9795 @cindex #+NAME
9796 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9797 the @file{table.el} package will be exported properly.  For Org mode tables,
9798 the lines before the first horizontal separator line will become table header
9799 lines.  You can use the following lines somewhere before the table to assign
9800 a caption and a label for cross references, and in the text you can refer to
9801 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9803 @example
9804 #+CAPTION: This is the caption for the next table (or link)
9805 #+NAME:   tab:basic-data
9806    | ... | ...|
9807    |-----|----|
9808 @end example
9810 Optionally, the caption can take the form:
9811 @example
9812 #+CAPTION[Caption for list of tables]: Caption for table.
9813 @end example
9815 @cindex inlined images, markup rules
9816 Some back-ends allow you to directly include images into the exported
9817 document.  Org does this, if a link to an image files does not have
9818 a description part, for example @code{[[./img/a.jpg]]}.  If you wish to
9819 define a caption for the image and maybe a label for internal cross
9820 references, make sure that the link is on a line by itself and precede it
9821 with @code{#+CAPTION} and @code{#+NAME} as follows:
9823 @example
9824 #+CAPTION: This is the caption for the next figure link (or table)
9825 #+NAME:   fig:SED-HR4049
9826 [[./img/a.jpg]]
9827 @end example
9829 @noindent
9830 Such images can be displayed within the buffer.  @xref{Handling links,the
9831 discussion of image links}.
9833 Even though images and tables are prominent examples of captioned structures,
9834 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9835 equations, source code blocks).  Depending on the export back-end, those may
9836 or may not be handled.
9838 @node Literal examples, Include files, Images and tables, Markup
9839 @section Literal examples
9840 @cindex literal examples, markup rules
9841 @cindex code line references, markup rules
9843 You can include literal examples that should not be subjected to
9844 markup.  Such examples will be typeset in monospace, so this is well suited
9845 for source code and similar examples.
9846 @cindex #+BEGIN_EXAMPLE
9848 @example
9849 #+BEGIN_EXAMPLE
9850 Some example from a text file.
9851 #+END_EXAMPLE
9852 @end example
9854 Note that such blocks may be @i{indented} in order to align nicely with
9855 indented text and in particular with plain list structure (@pxref{Plain
9856 lists}).  For simplicity when using small examples, you can also start the
9857 example lines with a colon followed by a space.  There may also be additional
9858 whitespace before the colon:
9860 @example
9861 Here is an example
9862    : Some example from a text file.
9863 @end example
9865 @cindex formatting source code, markup rules
9866 If the example is source code from a programming language, or any other text
9867 that can be marked up by font-lock in Emacs, you can ask for the example to
9868 look like the fontified Emacs buffer@footnote{This works automatically for
9869 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9870 which is distributed with Org).  Fontified code chunks in @LaTeX{} can be
9871 achieved using either the listings or the
9872 @url{http://code.google.com/p/minted, minted,} package.  Refer to
9873 @code{org-latex-listings} documentation for details.}.  This is done
9874 with the @samp{src} block, where you also need to specify the name of the
9875 major mode that should be used to fontify the example@footnote{Code in
9876 @samp{src} blocks may also be evaluated either interactively or on export.
9877 See @pxref{Working With Source Code} for more information on evaluating code
9878 blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code
9879 blocks.
9880 @cindex #+BEGIN_SRC
9882 @example
9883 #+BEGIN_SRC emacs-lisp
9884   (defun org-xor (a b)
9885      "Exclusive or."
9886      (if a (not b) b))
9887 #+END_SRC
9888 @end example
9890 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9891 switch to the end of the @code{BEGIN} line, to get the lines of the example
9892 numbered.  If you use a @code{+n} switch, the numbering from the previous
9893 numbered snippet will be continued in the current one.  In literal examples,
9894 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9895 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9896 enclosed in single parenthesis).  In HTML, hovering the mouse over such a
9897 link will remote-highlight the corresponding code line, which is kind of
9898 cool.
9900 You can also add a @code{-r} switch which @i{removes} the labels from the
9901 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9902 labels in the source code while using line numbers for the links, which might
9903 be useful to explain those in an Org mode example code.}.  With the @code{-n}
9904 switch, links to these references will be labeled by the line numbers from
9905 the code listing, otherwise links will use the labels with no parentheses.
9906 Here is an example:
9908 @example
9909 #+BEGIN_SRC emacs-lisp -n -r
9910 (save-excursion                  (ref:sc)
9911    (goto-char (point-min)))      (ref:jump)
9912 #+END_SRC
9913 In line [[(sc)]] we remember the current position.  [[(jump)][Line (jump)]]
9914 jumps to point-min.
9915 @end example
9917 @vindex org-coderef-label-format
9918 If the syntax for the label format conflicts with the language syntax, use a
9919 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9920 -n -r -l "((%s))"}.  See also the variable @code{org-coderef-label-format}.
9922 HTML export also allows examples to be published as text areas (@pxref{Text
9923 areas in HTML export}).
9925 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9926 so often, shortcuts are provided using the Easy Templates facility
9927 (@pxref{Easy Templates}).
9929 @table @kbd
9930 @kindex C-c '
9931 @item C-c '
9932 Edit the source code example at point in its native mode.  This works by
9933 switching to a temporary buffer with the source code.  You need to exit by
9934 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9935 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9936 from being interpreted by Org as outline nodes or special syntax.  These
9937 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9938 The edited version will then replace the old version in the Org buffer.
9939 Fixed-width regions (where each line starts with a colon followed by a space)
9940 will be edited using @code{artist-mode}@footnote{You may select
9941 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9942 to allow creating ASCII drawings easily.  Using this command in an empty line
9943 will create a new fixed-width region.
9944 @kindex C-c l
9945 @item C-c l
9946 Calling @code{org-store-link} while editing a source code example in a
9947 temporary buffer created with @kbd{C-c '} will prompt for a label.  Make sure
9948 that it is unique in the current buffer, and insert it with the proper
9949 formatting like @samp{(ref:label)} at the end of the current line.  Then the
9950 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9951 @end table
9954 @node Include files, Index entries, Literal examples, Markup
9955 @section Include files
9956 @cindex include files, markup rules
9958 During export, you can include the content of another file.  For example, to
9959 include your @file{.emacs} file, you could use:
9960 @cindex #+INCLUDE
9962 @example
9963 #+INCLUDE: "~/.emacs" src emacs-lisp
9964 @end example
9966 @noindent
9967 The optional second and third parameter are the markup (i.e., @samp{example}
9968 or @samp{src}), and, if the markup is @samp{src}, the language for formatting
9969 the contents.  The markup is optional; if it is not given, the text will be
9970 assumed to be in Org mode format and will be processed normally.
9972 Contents of the included file will belong to the same structure (headline,
9973 item) containing the @code{INCLUDE} keyword.  In particular, headlines within
9974 the file will become children of the current section.  That behavior can be
9975 changed by providing an additional keyword parameter, @code{:minlevel}.  In
9976 that case, all headlines in the included file will be shifted so the one with
9977 the lowest level reaches that specified level.  For example, to make a file
9978 become a sibling of the current top-level headline, use
9980 @example
9981 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
9982 @end example
9984 You can also include a portion of a file by specifying a lines range using
9985 the @code{:lines} parameter.  The line at the upper end of the range will not
9986 be included.  The start and/or the end of the range may be omitted to use the
9987 obvious defaults.
9989 @example
9990 #+INCLUDE: "~/.emacs" :lines "5-10"   @r{Include lines 5 to 10, 10 excluded}
9991 #+INCLUDE: "~/.emacs" :lines "-10"    @r{Include lines 1 to 10, 10 excluded}
9992 #+INCLUDE: "~/.emacs" :lines "10-"    @r{Include lines from 10 to EOF}
9993 @end example
9995 @table @kbd
9996 @kindex C-c '
9997 @item C-c '
9998 Visit the include file at point.
9999 @end table
10001 @node Index entries, Macro replacement, Include files, Markup
10002 @section Index entries
10003 @cindex index entries, for publishing
10005 You can specify entries that will be used for generating an index during
10006 publishing.  This is done by lines starting with @code{#+INDEX}.  An entry
10007 the contains an exclamation mark will create a sub item.  See @ref{Generating
10008 an index} for more information.
10010 @example
10011 * Curriculum Vitae
10012 #+INDEX: CV
10013 #+INDEX: Application!CV
10014 @end example
10019 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
10020 @section Macro replacement
10021 @cindex macro replacement, during export
10022 @cindex #+MACRO
10024 You can define text snippets with
10026 @example
10027 #+MACRO: name   replacement text $1, $2 are arguments
10028 @end example
10030 @noindent which can be referenced in
10031 paragraphs, verse blocks, table cells and some keywords with
10032 @code{@{@{@{name(arg1,arg2)@}@}@}}@footnote{Since commas separate arguments,
10033 commas within arguments have to be escaped with a backslash character.
10034 Conversely, backslash characters before a comma, and only them, need to be
10035 escaped with another backslash character.}.  In addition to defined macros,
10036 @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will reference
10037 information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and similar lines.
10038 Also, @code{@{@{@{time(@var{FORMAT})@}@}@}} and
10039 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
10040 and to the modification time of the file being exported, respectively.
10041 @var{FORMAT} should be a format string understood by
10042 @code{format-time-string}.
10044 Macro expansion takes place during export.
10047 @node Embedded @LaTeX{}, Special blocks, Macro replacement, Markup
10048 @section Embedded @LaTeX{}
10049 @cindex @TeX{} interpretation
10050 @cindex @LaTeX{} interpretation
10052 Plain ASCII is normally sufficient for almost all note taking.  Exceptions
10053 include scientific notes, which often require mathematical symbols and the
10054 occasional formula.  @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10055 Donald E. Knuth's @TeX{} system.  Many of the features described here as
10056 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10057 distinction.}  is widely used to typeset scientific documents.  Org mode
10058 supports embedding @LaTeX{} code into its files, because many academics are
10059 used to writing and reading @LaTeX{} source code, and because it can be
10060 readily processed to produce pretty output for a number of export back-ends.
10062 @menu
10063 * Special symbols::             Greek letters and other symbols
10064 * Subscripts and superscripts::  Simple syntax for raising/lowering text
10065 * @LaTeX{} fragments::          Complex formulas made easy
10066 * Previewing @LaTeX{} fragments::  What will this snippet look like?
10067 * CDLaTeX mode::                Speed up entering of formulas
10068 @end menu
10070 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
10071 @subsection Special symbols
10072 @cindex math symbols
10073 @cindex special symbols
10074 @cindex @TeX{} macros
10075 @cindex @LaTeX{} fragments, markup rules
10076 @cindex HTML entities
10077 @cindex @LaTeX{} entities
10079 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10080 to indicate the Greek letter, or @samp{\to} to indicate an arrow.  Completion
10081 for these symbols is available, just type @samp{\} and maybe a few letters,
10082 and press @kbd{M-@key{TAB}} to see possible completions.  Unlike @LaTeX{}
10083 code, Org mode allows these symbols to be present without surrounding math
10084 delimiters, for example:
10086 @example
10087 Angles are written as Greek letters \alpha, \beta and \gamma.
10088 @end example
10090 @vindex org-entities
10091 During export, these symbols will be transformed into the native format of
10092 the exporter back-end.  Strings like @code{\alpha} will be exported as
10093 @code{&alpha;} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
10094 output.  Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
10095 @code{~} in @LaTeX{}.  If you need such a symbol inside a word, terminate it
10096 like this: @samp{\Aacute@{@}stor}.
10098 A large number of entities is provided, with names taken from both HTML and
10099 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10100 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10101 @samp{...} are all converted into special commands creating hyphens of
10102 different lengths or a compact set of dots.
10104 If you would like to see entities displayed as UTF-8 characters, use the
10105 following command@footnote{You can turn this on by default by setting the
10106 variable @code{org-pretty-entities}, or on a per-file base with the
10107 @code{#+STARTUP} option @code{entitiespretty}.}:
10109 @table @kbd
10110 @cindex @code{entitiespretty}, STARTUP keyword
10111 @kindex C-c C-x \
10112 @item C-c C-x \
10113 Toggle display of entities as UTF-8 characters.  This does not change the
10114 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10115 for display purposes only.
10116 @end table
10118 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
10119 @subsection Subscripts and superscripts
10120 @cindex subscript
10121 @cindex superscript
10123 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10124 subscripts.  Again, these can be used without embedding them in math-mode
10125 delimiters.  To increase the readability of ASCII text, it is not necessary
10126 (but OK) to surround multi-character sub- and superscripts with curly braces.
10127 For example
10129 @example
10130 The mass of the sun is M_sun = 1.989 x 10^30 kg.  The radius of
10131 the sun is R_@{sun@} = 6.96 x 10^8 m.
10132 @end example
10134 @vindex org-use-sub-superscripts
10135 If you write a text where the underscore is often used in a different
10136 context, Org's convention to always interpret these as subscripts can get in
10137 your way.  Configure the variable @code{org-use-sub-superscripts} to change
10138 this convention.  For example, when setting this variable to @code{@{@}},
10139 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10141 @table @kbd
10142 @kindex C-c C-x \
10143 @item C-c C-x \
10144 In addition to showing entities as UTF-8 characters, this command will also
10145 format sub- and superscripts in a WYSIWYM way.
10146 @end table
10148 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
10149 @subsection @LaTeX{} fragments
10150 @cindex @LaTeX{} fragments
10152 @vindex org-format-latex-header
10153 Going beyond symbols and sub- and superscripts, a full formula language is
10154 needed.  Org mode can contain @LaTeX{} math fragments, and it supports ways
10155 to process these for several export back-ends.  When exporting to @LaTeX{},
10156 the code is obviously left as it is.  When exporting to HTML, Org invokes the
10157 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
10158 HTML export}) to process and display the math@footnote{If you plan to use
10159 this regularly or on pages with significant page views, you should install
10160 @file{MathJax} on your own server in order to limit the load of our server.}.
10161 Finally, it can also process the mathematical expressions into
10162 images@footnote{For this to work you need to be on a system with a working
10163 @LaTeX{} installation.  You also need the @file{dvipng} program or the
10164 @file{convert}, respectively available at
10165 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10166 suite.  The @LaTeX{} header that will be used when processing a fragment can
10167 be configured with the variable @code{org-format-latex-header}.} that can be
10168 displayed in a browser.
10170 @LaTeX{} fragments don't need any special marking at all.  The following
10171 snippets will be identified as @LaTeX{} source code:
10172 @itemize @bullet
10173 @item
10174 Environments of any kind@footnote{When @file{MathJax} is used, only the
10175 environments recognized by @file{MathJax} will be processed.  When
10176 @file{dvipng} program or @file{imagemagick} suite is used to create images,
10177 any @LaTeX{} environment will be handled.}.  The only requirement is that the
10178 @code{\begin} and @code{\end} statements appear on a new line, at the
10179 beginning of the line or after whitespaces only.
10180 @item
10181 Text within the usual @LaTeX{} math delimiters.  To avoid conflicts with
10182 currency specifications, single @samp{$} characters are only recognized as
10183 math delimiters if the enclosed text contains at most two line breaks, is
10184 directly attached to the @samp{$} characters with no whitespace in between,
10185 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
10186 For the other delimiters, there is no such restriction, so when in doubt, use
10187 @samp{\(...\)} as inline math delimiters.
10188 @end itemize
10190 @noindent For example:
10192 @example
10193 \begin@{equation@}
10194 x=\sqrt@{b@}
10195 \end@{equation@}
10197 If $a^2=b$ and \( b=2 \), then the solution must be
10198 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10199 @end example
10201 @c FIXME
10202 @c @noindent
10203 @c @vindex org-format-latex-options
10204 @c If you need any of the delimiter ASCII sequences for other purposes, you
10205 @c can configure the option @code{org-format-latex-options} to deselect the
10206 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10208 @vindex org-export-with-latex
10209 @LaTeX{} processing can be configured with the variable
10210 @code{org-export-with-latex}.  The default setting is @code{t} which means
10211 @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10212 You can also set this variable on a per-file basis using one of these
10213 lines:
10215 @example
10216 #+OPTIONS: tex:t          @r{Do the right thing automatically (MathJax)}
10217 #+OPTIONS: tex:nil        @r{Do not process @LaTeX{} fragments at all}
10218 #+OPTIONS: tex:verbatim   @r{Verbatim export, for jsMath or so}
10219 @end example
10221 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
10222 @subsection Previewing @LaTeX{} fragments
10223 @cindex @LaTeX{} fragments, preview
10225 @vindex org-latex-create-formula-image-program
10226 If you have @file{dvipng} or @file{imagemagick} installed@footnote{Choose the
10227 converter by setting the variable
10228 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10229 fragments can be processed to produce preview images of the typeset
10230 expressions:
10232 @table @kbd
10233 @kindex C-c C-x C-l
10234 @item C-c C-x C-l
10235 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10236 over the source code.  If there is no fragment at point, process all
10237 fragments in the current entry (between two headlines).  When called
10238 with a prefix argument, process the entire subtree.  When called with
10239 two prefix arguments, or when the cursor is before the first headline,
10240 process the entire buffer.
10241 @kindex C-c C-c
10242 @item C-c C-c
10243 Remove the overlay preview images.
10244 @end table
10246 @vindex org-format-latex-options
10247 You can customize the variable @code{org-format-latex-options} to influence
10248 some aspects of the preview.  In particular, the @code{:scale} (and for HTML
10249 export, @code{:html-scale}) property can be used to adjust the size of the
10250 preview images.
10252 @vindex org-startup-with-latex-preview
10253 You can turn on the previewing of all @LaTeX{} fragments in a file with
10255 @example
10256 #+STARTUP: latexpreview
10257 @end example
10259 To disable it, simply use
10261 @example
10262 #+STARTUP: nolatexpreview
10263 @end example
10265 @node CDLaTeX mode,  , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
10266 @subsection Using CD@LaTeX{} to enter math
10267 @cindex CD@LaTeX{}
10269 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10270 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10271 environments and math templates.  Inside Org mode, you can make use of
10272 some of the features of CD@LaTeX{} mode.  You need to install
10273 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10274 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10275 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10276 version @code{org-cdlatex-mode} that comes as part of Org mode.  Turn it
10277 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10278 Org files with
10280 @lisp
10281 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10282 @end lisp
10284 When this mode is enabled, the following features are present (for more
10285 details see the documentation of CD@LaTeX{} mode):
10286 @itemize @bullet
10287 @kindex C-c @{
10288 @item
10289 Environment templates can be inserted with @kbd{C-c @{}.
10290 @item
10291 @kindex @key{TAB}
10292 The @key{TAB} key will do template expansion if the cursor is inside a
10293 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10294 inside such a fragment, see the documentation of the function
10295 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
10296 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10297 correctly inside the first brace.  Another @key{TAB} will get you into
10298 the second brace.  Even outside fragments, @key{TAB} will expand
10299 environment abbreviations at the beginning of a line.  For example, if
10300 you write @samp{equ} at the beginning of a line and press @key{TAB},
10301 this abbreviation will be expanded to an @code{equation} environment.
10302 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10303 @item
10304 @kindex _
10305 @kindex ^
10306 @vindex cdlatex-simplify-sub-super-scripts
10307 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10308 characters together with a pair of braces.  If you use @key{TAB} to move
10309 out of the braces, and if the braces surround only a single character or
10310 macro, they are removed again (depending on the variable
10311 @code{cdlatex-simplify-sub-super-scripts}).
10312 @item
10313 @kindex `
10314 Pressing the backquote @kbd{`} followed by a character inserts math
10315 macros, also outside @LaTeX{} fragments.  If you wait more than 1.5 seconds
10316 after the backquote, a help window will pop up.
10317 @item
10318 @kindex '
10319 Pressing the single-quote @kbd{'} followed by another character modifies
10320 the symbol before point with an accent or a font.  If you wait more than
10321 1.5 seconds after the single-quote, a help window will pop up.  Character
10322 modification will work only inside @LaTeX{} fragments; outside the quote
10323 is normal.
10324 @end itemize
10326 @node Special blocks,  , Embedded @LaTeX{}, Markup
10327 @section Special blocks
10328 @cindex Special blocks
10330 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10331 examples}).  It is also possible to create blocks containing raw code
10332 targeted at a specific back-ends (e.g., @samp{#+BEGIN_LATEX}).
10334 Any other block is a @emph{special block}.
10336 For example, @samp{#+BEGIN_ABSTRACT} and @samp{#+BEGIN_VIDEO} are special
10337 blocks.  The first one is useful when exporting to @LaTeX{}, the second one
10338 when exporting to HTML5.
10340 Each export back-end decides if they should be exported, and how.  When the
10341 block is ignored, its contents are still exported, as if the opening and
10342 closing block lines were not there.  For example, when exporting a
10343 @samp{#+BEGIN_TEST} block, HTML back-end wraps its contents within a
10344 @samp{<div name="test">} tag.
10346 Refer to back-end specific documentation for more information.
10348 @node Exporting, Publishing, Markup, Top
10349 @chapter Exporting
10350 @cindex exporting
10352 The Org mode export facilities can be used to export Org documents or parts
10353 of Org documents to a variety of other formats.  In addition, these
10354 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10355 in foreign buffers so you can author tables and lists in Org syntax and
10356 convert them in place to the target language.
10358 ASCII export produces a readable and simple version of an Org file for
10359 printing and sharing notes.  HTML export allows you to easily publish notes
10360 on the web, or to build full-fledged websites.  @LaTeX{} export lets you use
10361 Org mode and its structured editing functions to create arbitrarily complex
10362 @LaTeX{} files for any kind of document.  OpenDocument Text (ODT) export
10363 allows seamless collaboration across organizational boundaries.  Markdown
10364 export lets you seamlessly collaborate with other developers.  Finally, iCal
10365 export can extract entries with deadlines or appointments to produce a file
10366 in the iCalendar format.
10368 @menu
10369 * The Export Dispatcher::       The main exporter interface
10370 * Export back-ends::            Built-in export formats
10371 * Export settings::             Generic export settings
10372 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
10373 * Beamer export::               Exporting as a Beamer presentation
10374 * HTML export::                 Exporting to HTML
10375 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
10376 * Markdown export::             Exporting to Markdown
10377 * OpenDocument Text export::    Exporting to OpenDocument Text
10378 * Org export::                  Exporting to Org
10379 * Texinfo export::              Exporting to Texinfo
10380 * iCalendar export::            Exporting to iCalendar
10381 * Other built-in back-ends::    Exporting to a man page
10382 * Export in foreign buffers::   Author tables and lists in Org syntax
10383 * Advanced configuration::      Fine-tuning the export output
10384 @end menu
10386 @node The Export Dispatcher, Export back-ends, Exporting, Exporting
10387 @section The Export Dispatcher
10388 @vindex org-export-dispatch-use-expert-ui
10389 @cindex Export, dispatcher
10391 The main entry point for export related tasks is the dispatcher, a
10392 hierarchical menu from which it is possible to select an export format and
10393 toggle export options@footnote{It is also possible to use a less intrusive
10394 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10395 non-@code{nil} value.  In that case, only a prompt is visible from the
10396 minibuffer.  From there one can still switch back to regular menu by pressing
10397 @key{?}.} from which it is possible to select an export format and to toggle
10398 export options.
10400 @c @quotation
10401 @table @asis
10402 @orgcmd{C-c C-e,org-export-dispatch}
10404 Dispatch for export and publishing commands.  When called with a @kbd{C-u}
10405 prefix argument, repeat the last export command on the current buffer while
10406 preserving toggled options.  If the current buffer hasn't changed and subtree
10407 export was activated, the command will affect that same subtree.
10408 @end table
10409 @c @end quotation
10411 Normally the entire buffer is exported, but if there is an active region
10412 only that part of the buffer will be exported.
10414 Several export options (@pxref{Export settings}) can be toggled from the
10415 export dispatcher with the following key combinations:
10417 @table @kbd
10418 @item C-a
10419 @vindex org-export-async-init-file
10420 Toggle asynchronous export.  Asynchronous export uses an external Emacs
10421 process that is configured with a specified initialization file.
10423 While exporting asynchronously, the output is not displayed, but stored in
10424 a place called ``the export stack''.  This stack can be displayed by calling
10425 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10426 from the dispatcher menu.
10428 @vindex org-export-in-background
10429 To make this behavior the default, customize the variable
10430 @code{org-export-in-background}.
10432 @item C-b
10433 Toggle body-only export.  Its effect depends on the back-end used.
10434 Typically, if the back-end has a header section (like @code{<head>...</head>}
10435 in the HTML back-end), a body-only export will not include this header.
10437 @item C-s
10438 @vindex org-export-initial-scope
10439 Toggle subtree export.  The top heading becomes the document title.
10441 You can change the default state of this option by setting
10442 @code{org-export-initial-scope}.
10444 @item C-v
10445 Toggle visible-only export.  Only export the text that is currently
10446 visible, i.e. not hidden by outline visibility in the buffer.
10448 @end table
10450 @vindex org-export-copy-to-kill-ring
10451 With the exception of asynchronous export, a successful export process writes
10452 its output to the kill-ring. You can configure this behavior by altering the
10453 option @code{org-export-copy-to-kill-ring}.
10455 @node Export back-ends, Export settings, The Export Dispatcher, Exporting
10456 @section Export back-ends
10457 @cindex Export, back-ends
10459 An export back-end is a library that translates Org syntax into a foreign
10460 format.  An export format is not available until the proper back-end has been
10461 loaded.
10463 @vindex org-export-backends
10464 By default, the following four back-ends are loaded: @code{ascii},
10465 @code{html}, @code{icalendar} and @code{latex}.  It is possible to add more
10466 (or remove some) by customizing @code{org-export-backends}.
10468 Built-in back-ends include:
10470 @itemize
10471 @item ascii (ASCII format)
10472 @item beamer (@LaTeX{} Beamer format)
10473 @item html (HTML format)
10474 @item icalendar (iCalendar format)
10475 @item latex (@LaTeX{} format)
10476 @item man (Man page format)
10477 @item md (Markdown format)
10478 @item odt (OpenDocument Text format)
10479 @item org (Org format)
10480 @item texinfo (Texinfo format)
10481 @end itemize
10483 Other back-ends might be found in the @code{contrib/} directory
10484 (@pxref{Installation}).
10486 @node Export settings, ASCII/Latin-1/UTF-8 export, Export back-ends, Exporting
10487 @section Export settings
10488 @cindex Export, settings
10490 Export options can be set: globally with variables; for an individual file by
10491 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10492 settings}), by setting individual keywords, or by specifying them in a
10493 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10494 properties (@pxref{Properties and Columns}).  Options set at a specific level
10495 override options set at a more general level.
10497 @cindex #+SETUPFILE
10498 In-buffer settings may appear anywhere in the file, either directly or
10499 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10500 Option keyword sets tailored to a particular back-end can be inserted from
10501 the export dispatcher (@pxref{The Export Dispatcher}) using the @code{Insert
10502 template} command by pressing @key{#}.  To insert keywords individually,
10503 a good way to make sure the keyword is correct is to type @code{#+} and then
10504 to use @kbd{M-<TAB>} for completion.
10506 The export keywords available for every back-end, and their equivalent global
10507 variables, include:
10509 @table @samp
10510 @item AUTHOR
10511 @vindex user-full-name
10512 The document author (@code{user-full-name}).
10514 @item CREATOR
10515 @vindex org-export-creator-string
10516 Entity responsible for output generation (@code{org-export-creator-string}).
10518 @item DATE
10519 @vindex org-export-date-timestamp-format
10520 A date or a time-stamp@footnote{The variable
10521 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10522 exported.}.
10524 @item DESCRIPTION
10525 The document description.  Back-ends handle it as they see fit (e.g., for the
10526 XHTML meta tag), if at all.  You can use several such keywords for long
10527 descriptions.
10529 @item EMAIL
10530 @vindex user-mail-address
10531 The email address (@code{user-mail-address}).
10533 @item KEYWORDS
10534 The keywords defining the contents of the document.  Back-ends handle it as
10535 they see fit (e.g., for the XHTML meta tag), if at all.  You can use several
10536 such keywords if the list is long.
10538 @item LANGUAGE
10539 @vindex org-export-default-language
10540 The language used for translating some strings
10541 (@code{org-export-default-language}).  E.g., @samp{#+LANGUAGE: fr} will tell
10542 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10543 clocktable.
10545 @item SELECT_TAGS
10546 @vindex org-export-select-tags
10547 The tags that select a tree for export (@code{org-export-select-tags}).  The
10548 default value is @code{:export:}.  Within a subtree tagged with
10549 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10550 below).  When headlines are selectively exported with @code{:export:}
10551 anywhere in a file, text before the first headline is ignored.
10553 @item EXCLUDE_TAGS
10554 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10555 The default value is @code{:noexport:}.  Entries with the @code{:noexport:}
10556 tag will be unconditionally excluded from the export, even if they have an
10557 @code{:export:} tag.
10559 @item TITLE
10560 The title to be shown (otherwise derived from buffer's name).  You can use
10561 several such keywords for long titles.
10562 @end table
10564 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10565 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10566 recognizes the following arguments:
10568 @table @code
10569 @item ':
10570 @vindex org-export-with-smart-quotes
10571 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10573 @item *:
10574 Toggle emphasized text (@code{org-export-with-emphasize}).
10576 @item -:
10577 @vindex org-export-with-special-strings
10578 Toggle conversion of special strings
10579 (@code{org-export-with-special-strings}).
10581 @item ::
10582 @vindex org-export-with-fixed-width
10583 Toggle fixed-width sections
10584 (@code{org-export-with-fixed-width}).
10586 @item <:
10587 @vindex org-export-with-timestamps
10588 Toggle inclusion of any time/date active/inactive stamps
10589 (@code{org-export-with-timestamps}).
10591 @item :
10592 @vindex org-export-preserve-breaks
10593 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10595 @item ^:
10596 @vindex org-export-with-sub-superscripts
10597 Toggle @TeX{}-like syntax for sub- and superscripts.  If you write "^:@{@}",
10598 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10599 it is (@code{org-export-with-sub-superscripts}).
10601 @item arch:
10602 @vindex org-export-with-archived-trees
10603 Configure export of archived trees.  Can be set to @code{headline} to only
10604 process the headline, skipping its contents
10605 (@code{org-export-with-archived-trees}).
10607 @item author:
10608 @vindex org-export-with-author
10609 Toggle inclusion of author name into exported file
10610 (@code{org-export-with-author}).
10612 @item c:
10613 @vindex org-export-with-clocks
10614 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10616 @item creator:
10617 @vindex org-export-with-creator
10618 Configure inclusion of creator info into exported file.  It may be set to
10619 @code{comment} (@code{org-export-with-creator}).
10621 @item d:
10622 @vindex org-export-with-drawers
10623 Toggle inclusion of drawers, or list drawers to include
10624 (@code{org-export-with-drawers}).
10626 @item e:
10627 @vindex org-export-with-entities
10628 Toggle inclusion of entities (@code{org-export-with-entities}).
10630 @item email:
10631 @vindex org-export-with-email
10632 Toggle inclusion of the author's e-mail into exported file
10633 (@code{org-export-with-email}).
10635 @item f:
10636 @vindex org-export-with-footnotes
10637 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10639 @item H:
10640 @vindex org-export-headline-levels
10641 Set the number of headline levels for export
10642 (@code{org-export-headline-levels}).  Below that level, headlines are treated
10643 differently.  In most back-ends, they become list items.
10645 @item inline:
10646 @vindex org-export-with-inlinetasks
10647 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10649 @item num:
10650 @vindex org-export-with-section-numbers
10651 Toggle section-numbers (@code{org-export-with-section-numbers}).  It can also
10652 be set to a number @samp{n}, so only headlines at that level or above will be
10653 numbered.
10655 @item p:
10656 @vindex org-export-with-planning
10657 Toggle export of planning information (@code{org-export-with-planning}).
10658 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10659 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10661 @item pri:
10662 @vindex org-export-with-priority
10663 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10665 @item stat:
10666 @vindex org-export-with-statistics-cookies
10667 Toggle inclusion of statistics cookies
10668 (@code{org-export-with-statistics-cookies}).
10670 @item tags:
10671 @vindex org-export-with-tags
10672 Toggle inclusion of tags, may also be @code{not-in-toc}
10673 (@code{org-export-with-tags}).
10675 @item tasks:
10676 @vindex org-export-with-tasks
10677 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10678 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10679 (@code{org-export-with-tasks}).
10681 @item tex:
10682 @vindex org-export-with-latex
10683 Configure export of @LaTeX{} fragments and environments.  It may be set to
10684 @code{verbatim} (@code{org-export-with-latex}).
10686 @item timestamp:
10687 @vindex org-export-time-stamp-file
10688 Toggle inclusion of the creation time into exported file
10689 (@code{org-export-time-stamp-file}).
10691 @item toc:
10692 @vindex org-export-with-toc
10693 Toggle inclusion of the table of contents, or set the level limit
10694 (@code{org-export-with-toc}).
10696 @item todo:
10697 @vindex org-export-with-todo-keywords
10698 Toggle inclusion of TODO keywords into exported text
10699 (@code{org-export-with-todo-keywords}).
10701 @item |:
10702 @vindex org-export-with-tables
10703 Toggle inclusion of tables (@code{org-export-with-tables}).
10704 @end table
10706 When exporting only a subtree, each of the previous keywords@footnote{With
10707 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10708 properties.  These begin with @samp{EXPORT_}, followed by the name of the
10709 keyword they supplant.  For example, @samp{DATE} and @samp{OPTIONS} keywords
10710 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10711 properties.
10713 @cindex #+BIND
10714 @vindex org-export-allow-bind-keywords
10715 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10716 can become buffer-local during export by using the BIND keyword.  Its syntax
10717 is @samp{#+BIND: variable value}.  This is particularly useful for in-buffer
10718 settings that cannot be changed using specific keywords.
10720 @cindex property, EXPORT_FILE_NAME
10721 The name of the output file to be generated is taken from the file associated
10722 to the buffer, when possible, or asked to you otherwise.  For subtree export,
10723 you can also set @samp{EXPORT_FILE_NAME} property.  In all cases, only the
10724 base name of the file is retained, and a back-end specific extension is
10725 added.
10727 @node ASCII/Latin-1/UTF-8 export, Beamer export, Export settings, Exporting
10728 @section ASCII/Latin-1/UTF-8 export
10729 @cindex ASCII export
10730 @cindex Latin-1 export
10731 @cindex UTF-8 export
10733 ASCII export produces a simple and very readable version of an Org mode
10734 file, containing only plain ASCII@.  Latin-1 and UTF-8 export augment the file
10735 with special characters and symbols available in these encodings.
10737 @vindex org-ascii-links-to-notes
10738 Links are exported in a footnote-like style, with the descriptive part in the
10739 text and the link in a note before the next heading.  See the variable
10740 @code{org-ascii-links-to-notes} for details and other options.
10742 @subheading ASCII export commands
10744 @table @kbd
10745 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10746 Export as an ASCII file.  For an Org file, @file{myfile.org}, the ASCII file
10747 will be @file{myfile.txt}.  The file will be overwritten without warning.
10748 When the original file is @file{myfile.txt}, the resulting file becomes
10749 @file{myfile.txt.txt} in order to prevent data loss.
10750 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10751 Export to a temporary buffer.  Do not create a file.
10752 @end table
10754 @subheading Header and sectioning structure
10756 In the exported version, the first three outline levels become headlines,
10757 defining a general document structure.  Additional levels are exported as
10758 lists.  The transition can also occur at a different level (@pxref{Export
10759 settings}).
10761 @subheading Quoting ASCII text
10763 You can insert text that will only appear when using @code{ASCII} back-end
10764 with the following constructs:
10766 @cindex #+ASCII
10767 @cindex #+BEGIN_ASCII
10768 @example
10769 Text @@@@ascii:and additional text@@@@ within a paragraph.
10771 #+ASCII: Some text
10773 #+BEGIN_ASCII
10774 All lines in this block will appear only when using this back-end.
10775 #+END_ASCII
10776 @end example
10778 @subheading ASCII specific attributes
10779 @cindex #+ATTR_ASCII
10780 @cindex horizontal rules, in ASCII export
10782 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10783 specifies the length, in characters, of a given horizontal rule.  It must be
10784 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
10786 @example
10787 #+ATTR_ASCII: :width 10
10788 -----
10789 @end example
10791 @node Beamer export, HTML export, ASCII/Latin-1/UTF-8 export, Exporting
10792 @section Beamer export
10793 @cindex Beamer export
10795 The @LaTeX{} class @emph{Beamer} allows production of high quality
10796 presentations using @LaTeX{} and pdf processing.  Org mode has special
10797 support for turning an Org mode file or tree into a Beamer presentation.
10799 @subheading Beamer export commands
10801 @table @kbd
10802 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
10803 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
10804 file will be @file{myfile.tex}.  The file will be overwritten without
10805 warning.
10806 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
10807 Export to a temporary buffer.  Do not create a file.
10808 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
10809 Export as @LaTeX{} and then process to PDF.
10810 @item C-c C-e l O
10811 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10812 @end table
10814 @subheading Sectioning, Frames and Blocks
10816 Any tree with not-too-deep level nesting should in principle be exportable as
10817 a Beamer presentation.  Headlines fall into three categories: sectioning
10818 elements, frames and blocks.
10820 @itemize @minus
10821 @item
10822 @vindex org-beamer-frame-level
10823 Headlines become frames when their level is equal to
10824 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
10825 (@pxref{Export settings}).
10827 @cindex property, BEAMER_ENV
10828 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
10829 set to either to @code{frame} or @code{fullframe}, its level overrides the
10830 variable.  A @code{fullframe} is a frame with an empty (ignored) title.
10832 @item
10833 @vindex org-beamer-environments-default
10834 @vindex org-beamer-environments-extra
10835 All frame's children become @code{block} environments.  Special block types
10836 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
10837 this property is set, the entry will also get a @code{:B_environment:} tag to
10838 make this visible.  This tag has no semantic meaning, it is only a visual
10839 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
10840 supported values and @code{org-beamer-environments-extra} for adding more).
10842 @item
10843 @cindex property, BEAMER_REF
10844 As a special case, if the @code{BEAMER_ENV} property is set to either
10845 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
10846 headline will become, respectively, an appendix, a note (within frame or
10847 between frame, depending on its level), a note with its title ignored or an
10848 @code{\againframe} command.  In the latter case, a @code{BEAMER_REF} property
10849 is mandatory in order to refer to the frame being resumed, and contents are
10850 ignored.
10852 Also, a headline with an @code{ignoreheading} environment will have its
10853 contents only inserted in the output.  This special value is useful to have
10854 data between frames, or to properly close a @code{column} environment.
10855 @end itemize
10857 @cindex property, BEAMER_ACT
10858 @cindex property, BEAMER_OPT
10859 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
10860 The former is translated as an overlay/action specification, or a default
10861 overlay specification when enclosed within square brackets.  The latter
10862 specifies options@footnote{The @code{fragile} option is added automatically
10863 if it contains code that requires a verbatim environment, though.} for the
10864 current frame or block.  The export back-end will automatically wrap
10865 properties within angular or square brackets when appropriate.
10867 @cindex property, BEAMER_COL
10868 Moreover, headlines handle the @code{BEAMER_COL} property.  Its value should
10869 be a decimal number representing the width of the column as a fraction of the
10870 total text width.  If the headline has no specific environment, its title
10871 will be ignored and its contents will fill the column created.  Otherwise,
10872 the block will fill the whole column and the title will be preserved.  Two
10873 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
10874 @code{columns} @LaTeX{} environment.  It will end before the next headline
10875 without such a property.  This environment is generated automatically.
10876 Although, it can also be explicitly created, with a special @code{columns}
10877 value for @code{BEAMER_ENV} property (if it needs to be set up with some
10878 specific options, for example).
10880 @subheading Beamer specific syntax
10882 Beamer back-end is an extension of @LaTeX{} back-end.  As such, all @LaTeX{}
10883 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
10884 recognized.  See @ref{@LaTeX{} and PDF export} for more information.
10886 @cindex #+BEAMER_THEME
10887 @cindex #+BEAMER_COLOR_THEME
10888 @cindex #+BEAMER_FONT_THEME
10889 @cindex #+BEAMER_INNER_THEME
10890 @cindex #+BEAMER_OUTER_THEME
10891 Beamer export introduces a number of keywords to insert code in the
10892 document's header.  Four control appearance of the presentation:
10893 @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
10894 @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
10895 @code{#+BEAMER_OUTER_THEME}.  All of them accept optional arguments
10896 within square brackets.  The last one, @code{#+BEAMER_HEADER}, is more
10897 generic and allows you to append any line of code in the header.
10899 @example
10900 #+BEAMER_THEME: Rochester [height=20pt]
10901 #+BEAMER_COLOR_THEME: spruce
10902 @end example
10904 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
10905 wrapped within a @code{frame} environment.  Those generated from a @code{TOC}
10906 keyword (@pxref{Table of contents}) are not.  In that case, it is also
10907 possible to specify options, enclosed within square brackets.
10909 @example
10910 #+TOC: headlines [currentsection]
10911 @end example
10913 Beamer specific code can be inserted with the following constructs:
10915 @cindex #+BEAMER
10916 @cindex #+BEGIN_BEAMER
10917 @example
10918 #+BEAMER: \pause
10920 #+BEGIN_BEAMER
10921 All lines in this block will appear only when using this back-end.
10922 #+END_BEAMER
10924 Text @@@@beamer:some code@@@@ within a paragraph.
10925 @end example
10927 In particular, this last example can be used to add overlay specifications to
10928 objects whose type is among @code{bold}, @code{item}, @code{link},
10929 @code{radio-target} and @code{target}, when the value is enclosed within
10930 angular brackets and put at the beginning the object.
10932 @example
10933 A *@@@@beamer:<2->@@@@useful* feature
10934 @end example
10936 @cindex #+ATTR_BEAMER
10937 Eventually, every plain list has support for @code{:environment},
10938 @code{:overlay} and @code{:options} attributes through
10939 @code{ATTR_BEAMER} affiliated keyword.  The first one allows the use
10940 of a different environment, the second sets overlay specifications and
10941 the last one inserts optional arguments in current list environment.
10943 @example
10944 #+ATTR_BEAMER: :overlay +-
10945 - item 1
10946 - item 2
10947 @end example
10949 @subheading Editing support
10951 You can turn on a special minor mode @code{org-beamer-mode} for faster
10952 editing with:
10954 @example
10955 #+STARTUP: beamer
10956 @end example
10958 @table @kbd
10959 @orgcmd{C-c C-b,org-beamer-select-environment}
10960 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
10961 environment or the @code{BEAMER_COL} property.
10962 @end table
10964 Also, a template for useful in-buffer settings or properties can be inserted
10965 into the buffer with @kbd{M-x org-beamer-insert-options-template}.  Among
10966 other things, this will install a column view format which is very handy for
10967 editing special properties used by Beamer.
10969 @subheading An example
10971 Here is a simple example Org document that is intended for Beamer export.
10973 @smallexample
10974 #+TITLE: Example Presentation
10975 #+AUTHOR: Carsten Dominik
10976 #+OPTIONS: H:2
10977 #+LATEX_CLASS: beamer
10978 #+LATEX_CLASS_OPTIONS: [presentation]
10979 #+BEAMER_THEME: Madrid
10980 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
10982 * This is the first structural section
10984 ** Frame 1
10985 *** Thanks to Eric Fraga                                           :B_block:BMCOL:
10986     :PROPERTIES:
10987     :BEAMER_COL: 0.48
10988     :BEAMER_ENV: block
10989     :END:
10990     for the first viable Beamer setup in Org
10991 *** Thanks to everyone else                                        :B_block:BMCOL:
10992     :PROPERTIES:
10993     :BEAMER_COL: 0.48
10994     :BEAMER_ACT: <2->
10995     :BEAMER_ENV: block
10996     :END:
10997     for contributing to the discussion
10998 **** This will be formatted as a beamer note                              :B_note:
10999      :PROPERTIES:
11000      :BEAMER_env: note
11001      :END:
11002 ** Frame 2 (where we will not use columns)
11003 *** Request
11004     Please test this stuff!
11005 @end smallexample
11007 @node HTML export, @LaTeX{} and PDF export, Beamer export, Exporting
11008 @section HTML export
11009 @cindex HTML export
11011 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
11012 HTML formatting, in ways similar to John Gruber's @emph{markdown}
11013 language, but with additional support for tables.
11015 @menu
11016 * HTML Export commands::        How to invoke HTML export
11017 * HTML doctypes::               Org can export to various (X)HTML flavors
11018 * HTML preamble and postamble::  How to insert a preamble and a postamble
11019 * Quoting HTML tags::           Using direct HTML in Org mode
11020 * Links in HTML export::        How links will be interpreted and formatted
11021 * Tables in HTML export::       How to modify the formatting of tables
11022 * Images in HTML export::       How to insert figures into HTML output
11023 * Math formatting in HTML export::  Beautiful math also on the web
11024 * Text areas in HTML export::   An alternative way to show an example
11025 * CSS support::                 Changing the appearance of the output
11026 * JavaScript support::          Info and Folding in a web browser
11027 @end menu
11029 @node HTML Export commands, HTML doctypes, HTML export, HTML export
11030 @subsection HTML export commands
11032 @table @kbd
11033 @orgcmd{C-c C-e h h,org-html-export-to-html}
11034 Export as an HTML file.  For an Org file @file{myfile.org},
11035 the HTML file will be @file{myfile.html}.  The file will be overwritten
11036 without warning.
11037 @kbd{C-c C-e h o}
11038 Export as an HTML file and immediately open it with a browser.
11039 @orgcmd{C-c C-e h H,org-html-export-as-html}
11040 Export to a temporary buffer.  Do not create a file.
11041 @end table
11043 @c FIXME Exporting sublevels
11044 @c @cindex headline levels, for exporting
11045 @c In the exported version, the first 3 outline levels will become headlines,
11046 @c defining a general document structure.  Additional levels will be exported as
11047 @c itemized lists.  If you want that transition to occur at a different level,
11048 @c specify it with a numeric prefix argument.  For example,
11050 @c @example
11051 @c @kbd{C-2 C-c C-e b}
11052 @c @end example
11054 @c @noindent
11055 @c creates two levels of headings and does the rest as items.
11057 @node HTML doctypes, HTML preamble and postamble, HTML Export commands, HTML export
11058 @subsection HTML doctypes
11059 @vindex org-html-doctype
11060 @vindex org-html-doctype-alist
11062 Org can export to various (X)HTML flavors.
11064 Setting the variable @code{org-html-doctype} allows you to export to different
11065 (X)HTML variants.  The exported HTML will be adjusted according to the syntax
11066 requirements of that variant.  You can either set this variable to a doctype
11067 string directly, in which case the exporter will try to adjust the syntax
11068 automatically, or you can use a ready-made doctype.  The ready-made options
11069 are:
11071 @itemize
11072 @item
11073 ``html4-strict''
11074 @item
11075 ``html4-transitional''
11076 @item
11077 ``html4-frameset''
11078 @item
11079 ``xhtml-strict''
11080 @item
11081 ``xhtml-transitional''
11082 @item
11083 ``xhtml-frameset''
11084 @item
11085 ``xhtml-11''
11086 @item
11087 ``html5''
11088 @item
11089 ``xhtml5''
11090 @end itemize
11092 See the variable @code{org-html-doctype-alist} for details.  The default is
11093 ``xhtml-strict''.
11095 @subsubheading Fancy HTML5 export
11096 @vindex org-html-html5-fancy
11097 @vindex org-html-html5-elements
11099 HTML5 introduces several new element types.  By default, Org will not make
11100 use of these element types, but you can set @code{org-html-html5-fancy} to
11101 @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11102 enable a few new block-level elements.  These are created using arbitrary
11103 #+BEGIN and #+END blocks. For instance:
11105 @example
11106 #+BEGIN_ASIDE
11107 Lorem ipsum
11108 #+END_ASIDE
11109 @end example
11111 Will export to:
11113 @example
11114 <aside>
11115   <p>Lorem ipsum</p>
11116 </aside>
11117 @end example
11119 While this:
11121 @example
11122 #+ATTR_HTML: :controls controls :width 350
11123 #+BEGIN_VIDEO
11124 #+HTML: <source src="movie.mp4" type="video/mp4">
11125 #+HTML: <source src="movie.ogg" type="video/ogg">
11126 Your browser does not support the video tag.
11127 #+END_VIDEO
11128 @end example
11130 Becomes:
11132 @example
11133 <video controls="controls" width="350">
11134   <source src="movie.mp4" type="video/mp4">
11135   <source src="movie.ogg" type="video/ogg">
11136   <p>Your browser does not support the video tag.</p>
11137 </video>
11138 @end example
11140 Special blocks that do not correspond to HTML5 elements (see
11141 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11142 @code{#+BEGIN_LEDERHOSEN} will still export to @samp{<div class="lederhosen">}.
11144 Headlines cannot appear within special blocks.  To wrap a headline and its
11145 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11146 @code{HTML_CONTAINER} property on the headline itself.
11148 @node HTML preamble and postamble, Quoting HTML tags, HTML doctypes, HTML export
11149 @subsection HTML preamble and postamble
11150 @vindex org-html-preamble
11151 @vindex org-html-postamble
11152 @vindex org-html-preamble-format
11153 @vindex org-html-postamble-format
11154 @vindex org-html-validation-link
11155 @vindex org-export-creator-string
11156 @vindex org-export-time-stamp-file
11158 The HTML exporter lets you define a preamble and a postamble.
11160 The default value for @code{org-html-preamble} is @code{t}, which means
11161 that the preamble is inserted depending on the relevant format string in
11162 @code{org-html-preamble-format}.
11164 Setting @code{org-html-preamble} to a string will override the default format
11165 string.  If you set it to a function, it will insert the output of the
11166 function, which must be a string.  Setting to @code{nil} will not insert any
11167 preamble.
11169 The default value for @code{org-html-postamble} is @code{'auto}, which means
11170 that the HTML exporter will look for information about the author, the email,
11171 the creator and the date, and build the postamble from these values.  Setting
11172 @code{org-html-postamble} to @code{t} will insert the postamble from the
11173 relevant format string found in @code{org-html-postamble-format}.  Setting it
11174 to @code{nil} will not insert any postamble.
11176 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
11177 @subsection Quoting HTML tags
11179 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
11180 @samp{&gt;} in HTML export.  If you want to include raw HTML code, which
11181 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11182 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}.  For more extensive HTML
11183 that should be copied verbatim to the exported file use either
11185 @cindex #+HTML
11186 @cindex #+BEGIN_HTML
11187 @example
11188 #+HTML: Literal HTML code for export
11189 @end example
11191 @noindent or
11192 @cindex #+BEGIN_HTML
11194 @example
11195 #+BEGIN_HTML
11196 All lines between these markers are exported literally
11197 #+END_HTML
11198 @end example
11201 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
11202 @subsection Links in HTML export
11204 @cindex links, in HTML export
11205 @cindex internal links, in HTML export
11206 @cindex external links, in HTML export
11207 Internal links (@pxref{Internal links}) will continue to work in HTML@.  This
11208 includes automatic links created by radio targets (@pxref{Radio
11209 targets}).  Links to external files will still work if the target file is on
11210 the same @i{relative} path as the published Org file.  Links to other
11211 @file{.org} files will be translated into HTML links under the assumption
11212 that an HTML version also exists of the linked file, at the same relative
11213 path.  @samp{id:} links can then be used to jump to specific entries across
11214 files.  For information related to linking files while publishing them to a
11215 publishing directory see @ref{Publishing links}.
11217 If you want to specify attributes for links, you can do so using a special
11218 @code{#+ATTR_HTML} line to define attributes that will be added to the
11219 @code{<a>} or @code{<img>} tags.  Here is an example that sets @code{title}
11220 and @code{style} attributes for a link:
11222 @cindex #+ATTR_HTML
11223 @example
11224 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11225 [[http://orgmode.org]]
11226 @end example
11228 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
11229 @subsection Tables
11230 @cindex tables, in HTML
11231 @vindex org-html-table-default-attributes
11233 Org mode tables are exported to HTML using the table attributes defined in
11234 @code{org-html-table-default-attributes}.  The default setting makes tables
11235 without cell borders and frame.  If you would like to change this for
11236 individual tables, place something like the following before the table:
11238 @cindex #+CAPTION
11239 @cindex #+ATTR_HTML
11240 @example
11241 #+CAPTION: This is a table with lines around and between cells
11242 #+ATTR_HTML: :border 2 :rules all :frame border
11243 @end example
11245 @vindex org-html-table-row-tags
11246 You can also modify the default tags used for each row by setting
11247 @code{org-html-table-row-tags}.  See the docstring for an example on
11248 how to use this option.
11250 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
11251 @subsection Images in HTML export
11253 @cindex images, inline in HTML
11254 @cindex inlining images in HTML
11255 @vindex org-html-inline-images
11256 HTML export can inline images given as links in the Org file, and
11257 it can make an image the clickable part of a link.  By
11258 default@footnote{But see the variable
11259 @code{org-html-inline-images}.}, images are inlined if a link does
11260 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
11261 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11262 @samp{the image} that points to the image.  If the description part
11263 itself is a @code{file:} link or a @code{http:} URL pointing to an
11264 image, this image will be inlined and activated so that clicking on the
11265 image will activate the link.  For example, to include a thumbnail that
11266 will link to a high resolution version of the image, you could use:
11268 @example
11269 [[file:highres.jpg][file:thumb.jpg]]
11270 @end example
11272 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11273 In the example below we specify the @code{alt} and @code{title} attributes to
11274 support text viewers and accessibility, and align it to the right.
11276 @cindex #+CAPTION
11277 @cindex #+ATTR_HTML
11278 @example
11279 #+CAPTION: A black cat stalking a spider
11280 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11281 [[./img/a.jpg]]
11282 @end example
11284 @noindent
11285 You could use @code{http} addresses just as well.
11287 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
11288 @subsection Math formatting in HTML export
11289 @cindex MathJax
11290 @cindex dvipng
11291 @cindex imagemagick
11293 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11294 different ways on HTML pages.  The default is to use the
11295 @uref{http://www.mathjax.org, MathJax system} which should work out of the
11296 box with Org mode installation because @uref{http://orgmode.org} serves
11297 @file{MathJax} for Org mode users for small applications and for testing
11298 purposes.  @b{If you plan to use this regularly or on pages with significant
11299 page views, you should install@footnote{Installation instructions can be
11300 found on the MathJax website, see
11301 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
11302 your own server in order to limit the load of our server.}  To configure
11303 @file{MathJax}, use the variable @code{org-html-mathjax-options} or
11304 insert something like the following into the buffer:
11306 @example
11307 #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
11308 @end example
11310 @noindent See the docstring of the variable
11311 @code{org-html-mathjax-options} for the meaning of the parameters in
11312 this line.
11314 If you prefer, you can also request that @LaTeX{} fragments are processed
11315 into small images that will be inserted into the browser page.  Before the
11316 availability of MathJax, this was the default method for Org files.  This
11317 method requires that the @file{dvipng} program or @file{imagemagick} suite is
11318 available on your system.  You can still get this processing with
11320 @example
11321 #+OPTIONS: tex:dvipng
11322 @end example
11326 @example
11327 #+OPTIONS: tex:imagemagick
11328 @end example
11330 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
11331 @subsection Text areas in HTML export
11333 @cindex text areas, in HTML
11334 An alternative way to publish literal code examples in HTML is to use text
11335 areas, where the example can even be edited before pasting it into an
11336 application.  It is triggered by @code{:textarea} attribute at an
11337 @code{example} or @code{src} block.
11339 You may also use @code{:height} and @code{:width} attributes to specify the
11340 height and width of the text area, which default to the number of lines in
11341 the example, and 80, respectively.  For example
11343 @example
11344 #+ATTR_HTML: :textarea t :width 40
11345 #+BEGIN_EXAMPLE
11346   (defun org-xor (a b)
11347      "Exclusive or."
11348      (if a (not b) b))
11349 #+END_EXAMPLE
11350 @end example
11353 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
11354 @subsection CSS support
11355 @cindex CSS, for HTML export
11356 @cindex HTML export, CSS
11358 @vindex org-html-todo-kwd-class-prefix
11359 @vindex org-html-tag-class-prefix
11360 You can modify the CSS style definitions for the exported file.  The HTML
11361 exporter assigns the following special CSS classes@footnote{If the classes on
11362 TODO keywords and tags lead to conflicts, use the variables
11363 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11364 make them unique.} to appropriate parts of the document---your style
11365 specifications may change these, in addition to any of the standard classes
11366 like for headlines, tables, etc.
11367 @example
11368 p.author            @r{author information, including email}
11369 p.date              @r{publishing date}
11370 p.creator           @r{creator info, about org mode version}
11371 .title              @r{document title}
11372 .todo               @r{TODO keywords, all not-done states}
11373 .done               @r{the DONE keywords, all states that count as done}
11374 .WAITING            @r{each TODO keyword also uses a class named after itself}
11375 .timestamp          @r{timestamp}
11376 .timestamp-kwd      @r{keyword associated with a timestamp, like SCHEDULED}
11377 .timestamp-wrapper  @r{span around keyword plus timestamp}
11378 .tag                @r{tag in a headline}
11379 ._HOME              @r{each tag uses itself as a class, "@@" replaced by "_"}
11380 .target             @r{target for links}
11381 .linenr             @r{the line number in a code example}
11382 .code-highlighted   @r{for highlighting referenced code lines}
11383 div.outline-N       @r{div for outline level N (headline plus text))}
11384 div.outline-text-N  @r{extra div for text at outline level N}
11385 .section-number-N   @r{section number in headlines, different for each level}
11386 .figure-number      @r{label like "Figure 1:"}
11387 .table-number       @r{label like "Table 1:"}
11388 .listing-number     @r{label like "Listing 1:"}
11389 div.figure          @r{how to format an inlined image}
11390 pre.src             @r{formatted source code}
11391 pre.example         @r{normal example}
11392 p.verse             @r{verse paragraph}
11393 div.footnotes       @r{footnote section headline}
11394 p.footnote          @r{footnote definition paragraph, containing a footnote}
11395 .footref            @r{a footnote reference number (always a <sup>)}
11396 .footnum            @r{footnote number in footnote definition (always <sup>)}
11397 @end example
11399 @vindex org-html-style-default
11400 @vindex org-html-head-include-default-style
11401 @vindex org-html-head
11402 @vindex org-html-head-extra
11403 @cindex #+HTML_INCLUDE_STYLE
11404 Each exported file contains a compact default style that defines these
11405 classes in a basic way@footnote{This style is defined in the constant
11406 @code{org-html-style-default}, which you should not modify.  To turn
11407 inclusion of these defaults off, customize
11408 @code{org-html-head-include-default-style} or set @code{html-style} to
11409 @code{nil} in an @code{OPTIONS} line.}.  You may overwrite these settings, or
11410 add to them by using the variables @code{org-html-head} and
11411 @code{org-html-head-extra}.  You can override the global values of these
11412 variables for each file by using these keywords:
11414 @cindex #+HTML_HEAD
11415 @cindex #+HTML_HEAD_EXTRA
11416 @example
11417 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11418 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11419 @end example
11421 @noindent
11422 For longer style definitions, you can use several such lines.  You could also
11423 directly write a @code{<style>} @code{</style>} section in this way, without
11424 referring to an external file.
11426 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11427 property to assign a class to the tree.  In order to specify CSS styles for a
11428 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11429 property.
11431 @c FIXME: More about header and footer styles
11432 @c FIXME: Talk about links and targets.
11434 @node JavaScript support,  , CSS support, HTML export
11435 @subsection JavaScript supported display of web pages
11437 @cindex Rose, Sebastian
11438 Sebastian Rose has written a JavaScript program especially designed to
11439 enhance the web viewing experience of HTML files created with Org.  This
11440 program allows you to view large files in two different ways.  The first one
11441 is an @emph{Info}-like mode where each section is displayed separately and
11442 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11443 as well, press @kbd{?} for an overview of the available keys).  The second
11444 view type is a @emph{folding} view much like Org provides inside Emacs.  The
11445 script is available at @url{http://orgmode.org/org-info.js} and you can find
11446 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11447 We host the script at our site, but if you use it a lot, you might not want
11448 to be dependent on @url{http://orgmode.org} and prefer to install a local
11449 copy on your own web server.
11451 All it then takes to use this program is adding a single line to the Org
11452 file:
11454 @cindex #+INFOJS_OPT
11455 @example
11456 #+INFOJS_OPT: view:info toc:nil
11457 @end example
11459 @noindent
11460 If this line is found, the HTML header will automatically contain the code
11461 needed to invoke the script.  Using the line above, you can set the following
11462 viewing options:
11464 @example
11465 path:    @r{The path to the script.  The default is to grab the script from}
11466          @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11467          @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11468 view:    @r{Initial view when the website is first shown.  Possible values are:}
11469          info      @r{Info-like interface with one section per page.}
11470          overview  @r{Folding interface, initially showing only top-level.}
11471          content   @r{Folding interface, starting with all headlines visible.}
11472          showall   @r{Folding interface, all headlines and text visible.}
11473 sdepth:  @r{Maximum headline level that will still become an independent}
11474          @r{section for info and folding modes.  The default is taken from}
11475          @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11476          @r{If this is smaller than in @code{org-export-headline-levels}, each}
11477          @r{info/folding section can still contain child headlines.}
11478 toc:     @r{Should the table of contents @emph{initially} be visible?}
11479          @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11480 tdepth:  @r{The depth of the table of contents.  The defaults are taken from}
11481          @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11482 ftoc:    @r{Does the CSS of the page specify a fixed position for the "toc"?}
11483          @r{If yes, the toc will never be displayed as a section.}
11484 ltoc:    @r{Should there be short contents (children) in each section?}
11485          @r{Make this @code{above} if the section should be above initial text.}
11486 mouse:   @r{Headings are highlighted when the mouse is over them.  Should be}
11487          @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11488 buttons: @r{Should view-toggle buttons be everywhere?  When @code{nil} (the}
11489          @r{default), only one such button will be present.}
11490 @end example
11491 @noindent
11492 @vindex org-html-infojs-options
11493 @vindex org-html-use-infojs
11494 You can choose default values for these options by customizing the variable
11495 @code{org-html-infojs-options}.  If you always want to apply the script to your
11496 pages, configure the variable @code{org-html-use-infojs}.
11498 @node @LaTeX{} and PDF export, Markdown export, HTML export, Exporting
11499 @section @LaTeX{} and PDF export
11500 @cindex @LaTeX{} export
11501 @cindex PDF export
11503 @LaTeX{} export can produce an arbitrarily complex LaTeX document of any
11504 standard or custom document class.  With further processing@footnote{The
11505 default @LaTeX{} output is designed for processing with @code{pdftex} or
11506 @LaTeX{}.  It includes packages that are not compatible with @code{xetex} and
11507 possibly @code{luatex}.  The @LaTeX{} exporter can be configured to support
11508 alternative TeX engines, see the options
11509 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}.},
11510 which the @LaTeX{} exporter is able to control, this back-end is able to
11511 produce PDF output.  Because the @LaTeX{} exporter can be configured to use
11512 the @code{hyperref} package, the default setup produces fully-linked PDF
11513 output.
11515 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11516 will not be started if two contiguous syntactical elements are not separated
11517 by an empty line.
11519 This back-end also offers enhanced support for footnotes.  Thus, it handles
11520 nested footnotes, footnotes in tables and footnotes in a list item's
11521 description.
11523 @menu
11524 * @LaTeX{} export commands::    How to export to LaTeX and PDF
11525 * Header and sectioning::       Setting up the export file structure
11526 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
11527 * @LaTeX{} specific attributes::  Controlling @LaTeX{} output
11528 @end menu
11530 @node @LaTeX{} export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
11531 @subsection @LaTeX{} export commands
11533 @table @kbd
11534 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11535 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
11536 file will be @file{myfile.tex}.  The file will be overwritten without
11537 warning.
11538 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11539 Export to a temporary buffer.  Do not create a file.
11540 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11541 Export as @LaTeX{} and then process to PDF.
11542 @item C-c C-e l o
11543 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11544 @end table
11546 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{} export commands, @LaTeX{} and PDF export
11547 @subsection Header and sectioning structure
11548 @cindex @LaTeX{} class
11549 @cindex @LaTeX{} sectioning structure
11550 @cindex @LaTeX{} header
11551 @cindex header, for @LaTeX{} files
11552 @cindex sectioning structure, for @LaTeX{} export
11554 By default, the first three outline levels become headlines, defining a
11555 general document structure.  Additional levels are exported as @code{itemize}
11556 or @code{enumerate} lists.  The transition can also occur at a different
11557 level (@pxref{Export settings}).
11559 By default, the @LaTeX{} output uses the class @code{article}.
11561 @vindex org-latex-default-class
11562 @vindex org-latex-classes
11563 @vindex org-latex-default-packages-alist
11564 @vindex org-latex-packages-alist
11565 You can change this globally by setting a different value for
11566 @code{org-latex-default-class} or locally by adding an option like
11567 @code{#+LATEX_CLASS: myclass} in your file, or with
11568 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11569 containing only this (sub)tree.  The class must be listed in
11570 @code{org-latex-classes}.  This variable defines a header template for each
11571 class@footnote{Into which the values of
11572 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
11573 are spliced.}, and allows you to define the sectioning structure for each
11574 class.  You can also define your own classes there.
11576 @cindex #+LATEX_CLASS
11577 @cindex #+LATEX_CLASS_OPTIONS
11578 @cindex property, EXPORT_LATEX_CLASS
11579 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
11580 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
11581 property can specify the options for the @code{\documentclass} macro.  These
11582 options have to be provided, as expected by @LaTeX{}, within square brackets.
11584 @cindex #+LATEX_HEADER
11585 @cindex #+LATEX_HEADER_EXTRA
11586 You can also use the @code{LATEX_HEADER} and
11587 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
11588 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
11589 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
11590 to add lines to the header.  See the docstring of @code{org-latex-classes} for
11591 more information.
11593 An example is shown below.
11595 @example
11596 #+LATEX_CLASS: article
11597 #+LATEX_CLASS_OPTIONS: [a4paper]
11598 #+LATEX_HEADER: \usepackage@{xyz@}
11600 * Headline 1
11601   some text
11602 @end example
11604 @node Quoting @LaTeX{} code, @LaTeX{} specific attributes, Header and sectioning, @LaTeX{} and PDF export
11605 @subsection Quoting @LaTeX{} code
11607 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11608 inserted into the @LaTeX{} file.  Furthermore, you can add special code that
11609 should only be present in @LaTeX{} export with the following constructs:
11611 @cindex #+LATEX
11612 @cindex #+BEGIN_LATEX
11613 @example
11614 Code within @@@@latex:some code@@@@ a paragraph.
11616 #+LATEX: Literal @LaTeX{} code for export
11618 #+BEGIN_LATEX
11619 All lines between these markers are exported literally
11620 #+END_LATEX
11621 @end example
11623 @node @LaTeX{} specific attributes,  , Quoting @LaTeX{} code, @LaTeX{} and PDF export
11624 @subsection @LaTeX{} specific attributes
11625 @cindex #+ATTR_LATEX
11627 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line.  They
11628 affect tables, images, plain lists, special blocks and source blocks.
11630 @subsubheading Tables in @LaTeX{} export
11631 @cindex tables, in @LaTeX{} export
11633 For @LaTeX{} export of a table, you can specify a label and a caption
11634 (@pxref{Images and tables}).  You can also use attributes to control table
11635 layout and contents.  Valid @LaTeX{} attributes include:
11637 @table @code
11638 @item :mode
11639 @vindex org-latex-default-table-mode
11640 Nature of table's contents.  It can be set to @code{table}, @code{math},
11641 @code{inline-math} or @code{verbatim}.  In particular, when in @code{math} or
11642 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11643 ignored and the table will be wrapped in a math environment.  Also,
11644 contiguous tables sharing the same math mode will be wrapped within the same
11645 environment.  Default mode is determined in
11646 @code{org-latex-default-table-mode}.
11647 @item :environment
11648 @vindex org-latex-default-table-environment
11649 Environment used for the table.  It can be set to any @LaTeX{} table
11650 environment, like @code{tabularx}@footnote{Requires adding the
11651 @code{tabularx} package to @code{org-latex-packages-alist}.},
11652 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
11653 @code{tabu} package to @code{org-latex-packages-alist}.},
11654 @code{bmatrix}@enddots{} It defaults to
11655 @code{org-latex-default-table-environment} value.
11656 @item :caption
11657 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
11658 (@pxref{Images and tables}).  If you need more advanced commands for that
11659 task, you can use @code{:caption} attribute instead.  Its value should be raw
11660 @LaTeX{} code.  It has precedence over @code{#+CAPTION}.
11661 @item :float
11662 @itemx :placement
11663 Float environment for the table.  Possible values are @code{sidewaystable},
11664 @code{multicolumn}, @code{t} and @code{nil}.  When unspecified, a table with
11665 a caption will have a @code{table} environment.  Moreover, @code{:placement}
11666 attribute can specify the positioning of the float.
11667 @item :align
11668 @itemx :font
11669 @itemx :width
11670 Set, respectively, the alignment string of the table, its font size and its
11671 width.  They only apply on regular tables.
11672 @item :spread
11673 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11674 only takes effect when used in conjunction with the @code{:width} attribute.
11675 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
11676 value of @code{:width}.
11677 @item :booktabs
11678 @itemx :center
11679 @itemx :rmlines
11680 @vindex org-latex-tables-booktabs
11681 @vindex org-latex-tables-centered
11682 They toggle, respectively, @code{booktabs} usage (assuming the package is
11683 properly loaded), table centering and removal of every horizontal rule but
11684 the first one (in a "table.el" table only).  In particular,
11685 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
11686 activates the first (respectively second) attribute globally.
11687 @item :math-prefix
11688 @itemx :math-suffix
11689 @itemx :math-arguments
11690 A string that will be inserted, respectively, before the table within the
11691 math environment, after the table within the math environment, and between
11692 the macro name and the contents of the table.  The @code{:math-arguments}
11693 attribute is used for matrix macros that require more than one argument
11694 (e.g., @code{qbordermatrix}).
11695 @end table
11697 Thus, attributes can be used in a wide array of situations, like writing
11698 a table that will span over multiple pages, or a matrix product:
11700 @example
11701 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11702 | ..... | ..... |
11703 | ..... | ..... |
11705 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11706 | a | b |
11707 | c | d |
11708 #+ATTR_LATEX: :mode math :environment bmatrix
11709 | 1 | 2 |
11710 | 3 | 4 |
11711 @end example
11713 In the example below, @LaTeX{} command
11714 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
11716 @example
11717 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11718 | ..... | ..... |
11719 | ..... | ..... |
11720 @end example
11723 @subsubheading Images in @LaTeX{} export
11724 @cindex images, inline in @LaTeX{}
11725 @cindex inlining images in @LaTeX{}
11727 Images that are linked to without a description part in the link, like
11728 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11729 output file resulting from @LaTeX{} processing.  Org will use an
11730 @code{\includegraphics} macro to insert the image@footnote{In the case of
11731 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11732 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
11734 You can specify specify image width or height with, respectively,
11735 @code{:width} and @code{:height} attributes.  It is also possible to add any
11736 other option with the @code{:options} attribute, as shown in the following
11737 example:
11739 @example
11740 #+ATTR_LATEX: :width 5cm :options angle=90
11741 [[./img/sed-hr4049.pdf]]
11742 @end example
11744 If you need a specific command for the caption, use @code{:caption}
11745 attribute.  It will override standard @code{#+CAPTION} value, if any.
11747 @example
11748 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11749 [[./img/sed-hr4049.pdf]]
11750 @end example
11752 If you have specified a caption as described in @ref{Images and tables}, the
11753 picture will be wrapped into a @code{figure} environment and thus become
11754 a floating element.  You can also ask Org to export an image as a float
11755 without specifying caption by setting the @code{:float} attribute.  You may
11756 also set it to:
11757 @itemize @minus
11758 @item
11759 @code{t}: if you want to use the standard @samp{figure} environment.  It is
11760 used by default if you provide a caption to the image.
11761 @item
11762 @code{multicolumn}: if you wish to include an image which spans multiple
11763 columns in a page.  This will export the image wrapped in a @code{figure*}
11764 environment.
11765 @item
11766 @code{wrap}: if you would like to let text flow around the image.  It will
11767 make the figure occupy the left half of the page.
11768 @item
11769 @code{nil}: if you need to avoid any floating environment, even when
11770 a caption is provided.
11771 @end itemize
11772 @noindent
11773 To modify the placement option of any floating environment, set the
11774 @code{placement} attribute.
11776 @example
11777 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
11778 [[./img/hst.png]]
11779 @end example
11781 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
11782 the @LaTeX{} @code{\includegraphics} macro will be commented out.
11784 @subsubheading Plain lists in @LaTeX{} export
11785 @cindex plain lists, in @LaTeX{} export
11787 Plain lists accept two optional attributes: @code{:environment} and
11788 @code{:options}.  The first one allows the use of a non-standard environment
11789 (e.g., @samp{inparaenum}).  The second one specifies additional arguments for
11790 that environment.
11792 @example
11793 #+ATTR_LATEX: :environment compactitem :options [$\circ$]
11794 - you need ``paralist'' package to reproduce this example.
11795 @end example
11797 @subsubheading Source blocks in @LaTeX{} export
11798 @cindex source blocks, in @LaTeX{} export
11800 In addition to syntax defined in @ref{Literal examples}, names and captions
11801 (@pxref{Images and tables}), source blocks also accept a @code{:float}
11802 attribute.  You may set it to:
11803 @itemize @minus
11804 @item
11805 @code{t}: if you want to make the source block a float.  It is the default
11806 value when a caption is provided.
11807 @item
11808 @code{multicolumn}: if you wish to include a source block which spans multiple
11809 columns in a page.
11810 @item
11811 @code{nil}: if you need to avoid any floating environment, even when a caption
11812 is provided.  It is useful for source code that may not fit in a single page.
11813 @end itemize
11815 @example
11816 #+ATTR_LATEX: :float nil
11817 #+BEGIN_SRC emacs-lisp
11818 Code that may not fit in a single page.
11819 #+END_SRC
11820 @end example
11822 @subsubheading Special blocks in @LaTeX{} export
11823 @cindex special blocks, in @LaTeX{} export
11824 @cindex abstract, in @LaTeX{} export
11825 @cindex proof, in @LaTeX{} export
11827 In @LaTeX{} back-end, special blocks become environments of the same name.
11828 Value of @code{:options} attribute will be appended as-is to that
11829 environment's opening string.  For example:
11831 @example
11832 #+BEGIN_ABSTRACT
11833 We demonstrate how to solve the Syracuse problem.
11834 #+END_ABSTRACT
11836 #+ATTR_LATEX: :options [Proof of important theorem]
11837 #+BEGIN_PROOF
11839 Therefore, any even number greater than 2 is the sum of two primes.
11840 #+END_PROOF
11841 @end example
11843 @noindent
11844 becomes
11846 @example
11847 \begin@{abstract@}
11848 We demonstrate how to solve the Syracuse problem.
11849 \end@{abstract@}
11851 \begin@{proof@}[Proof of important theorem]
11853 Therefore, any even number greater than 2 is the sum of two primes.
11854 \end@{proof@}
11855 @end example
11857 If you need to insert a specific caption command, use @code{:caption}
11858 attribute.  It will override standard @code{#+CAPTION} value, if any.  For
11859 example:
11861 @example
11862 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
11863 #+BEGIN_PROOF
11865 #+END_PROOF
11866 @end example
11868 @subsubheading Horizontal rules
11869 @cindex horizontal rules, in @LaTeX{} export
11871 Width and thickness of a given horizontal rule can be controlled with,
11872 respectively, @code{:width} and @code{:thickness} attributes:
11874 @example
11875 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
11876 -----
11877 @end example
11879 @node Markdown export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
11880 @section Markdown export
11881 @cindex Markdown export
11883 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
11884 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
11885 mode buffer.
11887 It is built over HTML back-end: any construct not supported by Markdown
11888 syntax (e.g., tables) will be controlled and translated by @code{html}
11889 back-end (@pxref{HTML export}).
11891 @subheading Markdown export commands
11893 @table @kbd
11894 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
11895 Export as a text file written in Markdown syntax.  For an Org file,
11896 @file{myfile.org}, the resulting file will be @file{myfile.md}.  The file
11897 will be overwritten without warning.
11898 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
11899 Export to a temporary buffer.  Do not create a file.
11900 @item C-c C-e m o
11901 Export as a text file with Markdown syntax, then open it.
11902 @end table
11904 @subheading Header and sectioning structure
11906 @vindex org-md-headline-style
11907 Markdown export can generate both @code{atx} and @code{setext} types for
11908 headlines, according to @code{org-md-headline-style}.  The former introduces
11909 a hard limit of two levels, whereas the latter pushes it to six.  Headlines
11910 below that limit are exported as lists.  You can also set a soft limit before
11911 that one (@pxref{Export settings}).
11913 @c begin opendocument
11915 @node OpenDocument Text export, Org export, Markdown export, Exporting
11916 @section OpenDocument Text export
11917 @cindex ODT
11918 @cindex OpenDocument
11919 @cindex export, OpenDocument
11920 @cindex LibreOffice
11922 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
11923 (ODT) format.  Documents created by this exporter use the
11924 @cite{OpenDocument-v1.2
11925 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11926 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
11927 are compatible with LibreOffice 3.4.
11929 @menu
11930 * Pre-requisites for ODT export::  What packages ODT exporter relies on
11931 * ODT export commands::         How to invoke ODT export
11932 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
11933 * Applying custom styles::      How to apply custom styles to the output
11934 * Links in ODT export::         How links will be interpreted and formatted
11935 * Tables in ODT export::        How Tables are exported
11936 * Images in ODT export::        How to insert images
11937 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
11938 * Labels and captions in ODT export::  How captions are rendered
11939 * Literal examples in ODT export::  How source and example blocks are formatted
11940 * Advanced topics in ODT export::  Read this if you are a power user
11941 @end menu
11943 @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
11944 @subsection Pre-requisites for ODT export
11945 @cindex zip
11946 The ODT exporter relies on the @file{zip} program to create the final
11947 output.  Check the availability of this program before proceeding further.
11949 @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
11950 @subsection ODT export commands
11952 @subsubheading Exporting to ODT
11953 @anchor{x-export-to-odt}
11955 @cindex region, active
11956 @cindex active region
11957 @cindex transient-mark-mode
11958 @table @kbd
11959 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
11960 @cindex property EXPORT_FILE_NAME
11962 Export as OpenDocument Text file.
11964 @vindex org-odt-preferred-output-format
11965 If @code{org-odt-preferred-output-format} is specified, automatically convert
11966 the exported file to that format.  @xref{x-export-to-other-formats, ,
11967 Automatically exporting to other formats}.
11969 For an Org file @file{myfile.org}, the ODT file will be
11970 @file{myfile.odt}.  The file will be overwritten without warning.  If there
11971 is an active region,@footnote{This requires @code{transient-mark-mode} to be
11972 turned on} only the region will be exported.  If the selected region is a
11973 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
11974 tree head will become the document title.  If the tree head entry has, or
11975 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
11976 export.
11978 @kbd{C-c C-e o O}
11979 Export as an OpenDocument Text file and open the resulting file.
11981 @vindex org-odt-preferred-output-format
11982 If @code{org-odt-preferred-output-format} is specified, open the converted
11983 file instead.  @xref{x-export-to-other-formats, , Automatically exporting to
11984 other formats}.
11985 @end table
11987 @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
11988 @subsection Extending ODT export
11990 The ODT exporter can interface with a variety of document
11991 converters and supports popular converters out of the box.  As a result, you
11992 can use it to export to formats like @samp{doc} or convert a document from
11993 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
11995 @cindex @file{unoconv}
11996 @cindex LibreOffice
11997 If you have a working installation of LibreOffice, a document converter is
11998 pre-configured for you and you can use it right away.  If you would like to
11999 use @file{unoconv} as your preferred converter, customize the variable
12000 @code{org-odt-convert-process} to point to @code{unoconv}.  You can
12001 also use your own favorite converter or tweak the default settings of the
12002 @file{LibreOffice} and @samp{unoconv} converters.  @xref{Configuring a
12003 document converter}.
12005 @subsubsection Automatically exporting to other formats
12006 @anchor{x-export-to-other-formats}
12008 @vindex org-odt-preferred-output-format
12009 Very often, you will find yourself exporting to ODT format, only to
12010 immediately save the exported document to other formats like @samp{doc},
12011 @samp{docx}, @samp{rtf}, @samp{pdf} etc.  In such cases, you can specify your
12012 preferred output format by customizing the variable
12013 @code{org-odt-preferred-output-format}.  This way, the export commands
12014 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12015 format that is of immediate interest to you.
12017 @subsubsection Converting between document formats
12018 @anchor{x-convert-to-other-formats}
12020 There are many document converters in the wild which support conversion to
12021 and from various file formats, including, but not limited to the
12022 ODT format.  LibreOffice converter, mentioned above, is one such
12023 converter.  Once a converter is configured, you can interact with it using
12024 the following command.
12026 @vindex org-odt-convert
12027 @table @kbd
12029 @item M-x org-odt-convert RET
12030 Convert an existing document from one format to another.  With a prefix
12031 argument, also open the newly produced file.
12032 @end table
12034 @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
12035 @subsection Applying custom styles
12036 @cindex styles, custom
12037 @cindex template, custom
12039 The ODT exporter ships with a set of OpenDocument styles
12040 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12041 output.  These factory styles, however, may not cater to your specific
12042 tastes.  To customize the output, you can either modify the above styles
12043 files directly, or generate the required styles using an application like
12044 LibreOffice.  The latter method is suitable for expert and non-expert
12045 users alike, and is described here.
12047 @subsubsection Applying custom styles: the easy way
12049 @enumerate
12050 @item
12051 Create a sample @file{example.org} file with the below settings and export it
12052 to ODT format.
12054 @example
12055 #+OPTIONS: H:10 num:t
12056 @end example
12058 @item
12059 Open the above @file{example.odt} using LibreOffice.  Use the @file{Stylist}
12060 to locate the target styles---these typically have the @samp{Org} prefix---and
12061 modify those to your taste.  Save the modified file either as an
12062 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12064 @item
12065 @cindex #+ODT_STYLES_FILE
12066 @vindex org-odt-styles-file
12067 Customize the variable @code{org-odt-styles-file} and point it to the
12068 newly created file.  For additional configuration options
12069 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12071 If you would like to choose a style on a per-file basis, you can use the
12072 @code{#+ODT_STYLES_FILE} option.  A typical setting will look like
12074 @example
12075 #+ODT_STYLES_FILE: "/path/to/example.ott"
12076 @end example
12080 @example
12081 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12082 @end example
12084 @end enumerate
12086 @subsubsection Using third-party styles and templates
12088 You can use third-party styles and templates for customizing your output.
12089 This will produce the desired output only if the template provides all
12090 style names that the @samp{ODT} exporter relies on.  Unless this condition is
12091 met, the output is going to be less than satisfactory.  So it is highly
12092 recommended that you only work with templates that are directly derived from
12093 the factory settings.
12095 @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
12096 @subsection Links in ODT export
12097 @cindex links, in ODT export
12099 ODT exporter creates native cross-references for internal links.  It creates
12100 Internet-style links for all other links.
12102 A link with no description and destined to a regular (un-itemized) outline
12103 heading is replaced with a cross-reference and section number of the heading.
12105 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
12106 with a cross-reference and sequence number of the labeled entity.
12107 @xref{Labels and captions in ODT export}.
12109 @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
12110 @subsection Tables in ODT export
12111 @cindex tables, in ODT export
12113 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12114 tables is supported.  However, export of complex @file{table.el} tables---tables
12115 that have column or row spans---is not supported.  Such tables are
12116 stripped from the exported document.
12118 By default, a table is exported with top and bottom frames and with rules
12119 separating row and column groups (@pxref{Column groups}).  Furthermore, all
12120 tables are typeset to occupy the same width.  If the table specifies
12121 alignment and relative width for its columns (@pxref{Column width and
12122 alignment}) then these are honored on export.@footnote{The column widths are
12123 interpreted as weighted ratios with the default weight being 1}
12125 @cindex #+ATTR_ODT
12126 You can control the width of the table by specifying @code{:rel-width}
12127 property using an @code{#+ATTR_ODT} line.
12129 For example, consider the following table which makes use of all the rules
12130 mentioned above.
12132 @example
12133 #+ATTR_ODT: :rel-width 50
12134 | Area/Month    |   Jan |   Feb |   Mar |   Sum |
12135 |---------------+-------+-------+-------+-------|
12136 | /             |     < |       |       |     < |
12137 | <l13>         |  <r5> |  <r5> |  <r5> |  <r6> |
12138 | North America |     1 |    21 |   926 |   948 |
12139 | Middle East   |     6 |    75 |   844 |   925 |
12140 | Asia Pacific  |     9 |    27 |   790 |   826 |
12141 |---------------+-------+-------+-------+-------|
12142 | Sum           |    16 |   123 |  2560 |  2699 |
12143 @end example
12145 On export, the table will occupy 50% of text area.  The columns will be sized
12146 (roughly) in the ratio of 13:5:5:5:6.  The first column will be left-aligned
12147 and rest of the columns will be right-aligned.  There will be vertical rules
12148 after separating the header and last columns from other columns.  There will
12149 be horizontal rules separating the header and last rows from other rows.
12151 If you are not satisfied with the above formatting options, you can create
12152 custom table styles and associate them with a table using the
12153 @code{#+ATTR_ODT} line.  @xref{Customizing tables in ODT export}.
12155 @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
12156 @subsection Images in ODT export
12157 @cindex images, embedding in ODT
12158 @cindex embedding images in ODT
12160 @subsubheading Embedding images
12161 You can embed images within the exported document by providing a link to the
12162 desired image file with no link description.  For example, to embed
12163 @samp{img.png} do either of the following:
12165 @example
12166 [[file:img.png]]
12167 @end example
12169 @example
12170 [[./img.png]]
12171 @end example
12173 @subsubheading Embedding clickable images
12174 You can create clickable images by providing a link whose description is a
12175 link to an image file.  For example, to embed a image
12176 @file{org-mode-unicorn.png} which when clicked jumps to
12177 @uref{http://Orgmode.org} website, do the following
12179 @example
12180 [[http://orgmode.org][./org-mode-unicorn.png]]
12181 @end example
12183 @subsubheading Sizing and scaling of embedded images
12185 @cindex #+ATTR_ODT
12186 You can control the size and scale of the embedded images using the
12187 @code{#+ATTR_ODT} attribute.
12189 @cindex identify, ImageMagick
12190 @vindex org-odt-pixels-per-inch
12191 The exporter specifies the desired size of the image in the final document in
12192 units of centimeters.  In order to scale the embedded images, the exporter
12193 queries for pixel dimensions of the images using one of a) ImageMagick's
12194 @file{identify} program or b) Emacs `create-image' and `image-size'
12195 APIs@footnote{Use of @file{ImageMagick} is only desirable.  However, if you
12196 routinely produce documents that have large images or you export your Org
12197 files that has images using a Emacs batch script, then the use of
12198 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12199 converted in to units of centimeters using
12200 @code{org-odt-pixels-per-inch}.  The default value of this variable is
12201 set to @code{display-pixels-per-inch}.  You can tweak this variable to
12202 achieve the best results.
12204 The examples below illustrate the various possibilities.
12206 @table @asis
12207 @item Explicitly size the image
12208 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12210 @example
12211 #+ATTR_ODT: :width 10 :height 10
12212 [[./img.png]]
12213 @end example
12215 @item Scale the image
12216 To embed @file{img.png} at half its size, do the following:
12218 @example
12219 #+ATTR_ODT: :scale 0.5
12220 [[./img.png]]
12221 @end example
12223 @item Scale the image to a specific width
12224 To embed @file{img.png} with a width of 10 cm while retaining the original
12225 height:width ratio, do the following:
12227 @example
12228 #+ATTR_ODT: :width 10
12229 [[./img.png]]
12230 @end example
12232 @item Scale the image to a specific height
12233 To embed @file{img.png} with a height of 10 cm while retaining the original
12234 height:width ratio, do the following
12236 @example
12237 #+ATTR_ODT: :height 10
12238 [[./img.png]]
12239 @end example
12240 @end table
12242 @subsubheading Anchoring of images
12244 @cindex #+ATTR_ODT
12245 You can control the manner in which an image is anchored by setting the
12246 @code{:anchor} property of it's @code{#+ATTR_ODT} line.  You can specify one
12247 of the following three values for the @code{:anchor} property:
12248 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12250 To create an image that is anchored to a page, do the following:
12251 @example
12252 #+ATTR_ODT: :anchor "page"
12253 [[./img.png]]
12254 @end example
12256 @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
12257 @subsection Math formatting in ODT export
12259 The ODT exporter has special support for handling math.
12261 @menu
12262 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
12263 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
12264 @end menu
12266 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
12267 @subsubsection Working with @LaTeX{} math snippets
12269 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12270 document in one of the following ways:
12272 @cindex MathML
12273 @enumerate
12274 @item MathML
12276 This option is activated on a per-file basis with
12278 @example
12279 #+OPTIONS: LaTeX:t
12280 @end example
12282 With this option, @LaTeX{} fragments are first converted into MathML
12283 fragments using an external @LaTeX{}-to-MathML converter program.  The
12284 resulting MathML fragments are then embedded as an OpenDocument Formula in
12285 the exported document.
12287 @vindex org-latex-to-mathml-convert-command
12288 @vindex org-latex-to-mathml-jar-file
12290 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12291 @code{org-latex-to-mathml-convert-command} and
12292 @code{org-latex-to-mathml-jar-file}.
12294 If you prefer to use @file{MathToWeb}@footnote{See
12295 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
12296 converter, you can configure the above variables as shown below.
12298 @lisp
12299 (setq org-latex-to-mathml-convert-command
12300       "java -jar %j -unicode -force -df %o %I"
12301       org-latex-to-mathml-jar-file
12302       "/path/to/mathtoweb.jar")
12303 @end lisp
12305 You can use the following commands to quickly verify the reliability of
12306 the @LaTeX{}-to-MathML converter.
12308 @table @kbd
12309 @item M-x org-odt-export-as-odf RET
12310 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12312 @item M-x org-odt-export-as-odf-and-open RET
12313 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12314 and open the formula file with the system-registered application.
12315 @end table
12317 @cindex dvipng
12318 @cindex imagemagick
12319 @item PNG images
12321 This option is activated on a per-file basis with
12323 @example
12324 #+OPTIONS: tex:dvipng
12325 @end example
12329 @example
12330 #+OPTIONS: tex:imagemagick
12331 @end example
12333 With this option, @LaTeX{} fragments are processed into PNG images and the
12334 resulting images are embedded in the exported document.  This method requires
12335 that the @file{dvipng} program or @file{imagemagick} suite be available on
12336 your system.
12337 @end enumerate
12339 @node Working with MathML or OpenDocument formula files,  , Working with @LaTeX{} math snippets, Math formatting in ODT export
12340 @subsubsection Working with MathML or OpenDocument formula files
12342 For various reasons, you may find embedding @LaTeX{} math snippets in an
12343 ODT document less than reliable.  In that case, you can embed a
12344 math equation by linking to its MathML (@file{.mml}) source or its
12345 OpenDocument formula (@file{.odf}) file as shown below:
12347 @example
12348 [[./equation.mml]]
12349 @end example
12353 @example
12354 [[./equation.odf]]
12355 @end example
12357 @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
12358 @subsection Labels and captions in ODT export
12360 You can label and caption various category of objects---an inline image, a
12361 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12362 @code{#+CAPTION} lines.  @xref{Images and tables}.  ODT exporter enumerates
12363 each labeled or captioned object of a given category separately.  As a
12364 result, each such object is assigned a sequence number based on order of it's
12365 appearance in the Org file.
12367 In the exported document, a user-provided caption is augmented with the
12368 category and sequence number.  Consider the following inline image in an Org
12369 file.
12371 @example
12372 #+CAPTION: Bell curve
12373 #+LABEL:   fig:SED-HR4049
12374 [[./img/a.png]]
12375 @end example
12377 It could be rendered as shown below in the exported document.
12379 @example
12380 Figure 2: Bell curve
12381 @end example
12383 @vindex org-odt-category-map-alist
12384 You can modify the category component of the caption by customizing the
12385 option @code{org-odt-category-map-alist}.  For example, to tag all embedded
12386 images with the string @samp{Illustration} (instead of the default
12387 @samp{Figure}) use the following setting:
12389 @lisp
12390 (setq org-odt-category-map-alist
12391       (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12392 @end lisp
12394 With this, previous image will be captioned as below in the exported
12395 document.
12397 @example
12398 Illustration 2: Bell curve
12399 @end example
12401 @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
12402 @subsection Literal examples in ODT export
12404 Export of literal examples (@pxref{Literal examples}) with full fontification
12405 is supported.  Internally, the exporter relies on @file{htmlfontify.el} to
12406 generate all style definitions needed for a fancy listing.@footnote{Your
12407 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
12408 fontification to be turned on.}  The auto-generated styles have @samp{OrgSrc}
12409 as prefix and inherit their color from the faces used by Emacs
12410 @code{font-lock} library for the source language.
12412 @vindex org-odt-fontify-srcblocks
12413 If you prefer to use your own custom styles for fontification, you can do
12414 so by customizing the option
12415 @code{org-odt-create-custom-styles-for-srcblocks}.
12417 @vindex org-odt-create-custom-styles-for-srcblocks
12418 You can turn off fontification of literal examples by customizing the
12419 option @code{org-odt-fontify-srcblocks}.
12421 @node Advanced topics in ODT export,  , Literal examples in ODT export, OpenDocument Text export
12422 @subsection Advanced topics in ODT export
12424 If you rely heavily on ODT export, you may want to exploit the full
12425 set of features that the exporter offers.  This section describes features
12426 that would be of interest to power users.
12428 @menu
12429 * Configuring a document converter::  How to register a document converter
12430 * Working with OpenDocument style files::  Explore the internals
12431 * Creating one-off styles::     How to produce custom highlighting etc
12432 * Customizing tables in ODT export::  How to define and use Table templates
12433 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
12434 @end menu
12436 @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
12437 @subsubsection Configuring a document converter
12438 @cindex convert
12439 @cindex doc, docx, rtf
12440 @cindex converter
12442 The ODT exporter can work with popular converters with little or no
12443 extra configuration from your side. @xref{Extending ODT export}.
12444 If you are using a converter that is not supported by default or if you would
12445 like to tweak the default converter settings, proceed as below.
12447 @enumerate
12448 @item Register the converter
12450 @vindex org-odt-convert-processes
12451 Name your converter and add it to the list of known converters by
12452 customizing the option @code{org-odt-convert-processes}.  Also specify how
12453 the converter can be invoked via command-line to effect the conversion.
12455 @item Configure its capabilities
12457 @vindex org-odt-convert-capabilities
12458 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12459 converter can handle by customizing the variable
12460 @code{org-odt-convert-capabilities}.  Use the default value for this
12461 variable as a guide for configuring your converter.  As suggested by the
12462 default setting, you can specify the full set of formats supported by the
12463 converter and not limit yourself to specifying formats that are related to
12464 just the OpenDocument Text format.
12466 @item Choose the converter
12468 @vindex org-odt-convert-process
12469 Select the newly added converter as the preferred one by customizing the
12470 option @code{org-odt-convert-process}.
12471 @end enumerate
12473 @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
12474 @subsubsection Working with OpenDocument style files
12475 @cindex styles, custom
12476 @cindex template, custom
12478 This section explores the internals of the ODT exporter and the
12479 means by which it produces styled documents.  Read this section if you are
12480 interested in exploring the automatic and custom OpenDocument styles used by
12481 the exporter.
12483 @anchor{x-factory-styles}
12484 @subsubheading Factory styles
12486 The ODT exporter relies on two files for generating its output.
12487 These files are bundled with the distribution under the directory pointed to
12488 by the variable @code{org-odt-styles-dir}.  The two files are:
12490 @itemize
12491 @anchor{x-orgodtstyles-xml}
12492 @item
12493 @file{OrgOdtStyles.xml}
12495 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12496 document.  This file gets modified for the following purposes:
12497 @enumerate
12499 @item
12500 To control outline numbering based on user settings.
12502 @item
12503 To add styles generated by @file{htmlfontify.el} for fontification of code
12504 blocks.
12505 @end enumerate
12507 @anchor{x-orgodtcontenttemplate-xml}
12508 @item
12509 @file{OrgOdtContentTemplate.xml}
12511 This file contributes to the @file{content.xml} file of the final @samp{ODT}
12512 document.  The contents of the Org outline are inserted between the
12513 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
12515 Apart from serving as a template file for the final @file{content.xml}, the
12516 file serves the following purposes:
12517 @enumerate
12519 @item
12520 It contains automatic styles for formatting of tables which are referenced by
12521 the exporter.
12523 @item
12524 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
12525 elements that control how various entities---tables, images, equations,
12526 etc.---are numbered.
12527 @end enumerate
12528 @end itemize
12530 @anchor{x-overriding-factory-styles}
12531 @subsubheading Overriding factory styles
12532 The following two variables control the location from which the ODT
12533 exporter picks up the custom styles and content template files.  You can
12534 customize these variables to override the factory styles used by the
12535 exporter.
12537 @itemize
12538 @anchor{x-org-odt-styles-file}
12539 @item
12540 @code{org-odt-styles-file}
12542 Use this variable to specify the @file{styles.xml} that will be used in the
12543 final output.  You can specify one of the following values:
12545 @enumerate
12546 @item A @file{styles.xml} file
12548 Use this file instead of the default @file{styles.xml}
12550 @item A @file{.odt} or @file{.ott} file
12552 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12553 Template file
12555 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
12557 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12558 Template file.  Additionally extract the specified member files and embed
12559 those within the final @samp{ODT} document.
12561 Use this option if the @file{styles.xml} file references additional files
12562 like header and footer images.
12564 @item @code{nil}
12566 Use the default @file{styles.xml}
12567 @end enumerate
12569 @anchor{x-org-odt-content-template-file}
12570 @item
12571 @code{org-odt-content-template-file}
12573 Use this variable to specify the blank @file{content.xml} that will be used
12574 in the final output.
12575 @end itemize
12577 @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
12578 @subsubsection Creating one-off styles
12580 There are times when you would want one-off formatting in the exported
12581 document.  You can achieve this by embedding raw OpenDocument XML in the Org
12582 file.  The use of this feature is better illustrated with couple of examples.
12584 @enumerate
12585 @item Embedding ODT tags as part of regular text
12587 You can inline OpenDocument syntax by enclosing it within
12588 @samp{@@@@odt:...@@@@} markup.  For example, to highlight a region of text do
12589 the following:
12591 @example
12592 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
12593 text</text:span>@@@@.  But this is a regular text.
12594 @end example
12596 @strong{Hint:} To see the above example in action, edit your
12597 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12598 custom @samp{Highlight} style as shown below.
12600 @example
12601 <style:style style:name="Highlight" style:family="text">
12602   <style:text-properties fo:background-color="#ff0000"/>
12603 </style:style>
12604 @end example
12606 @item Embedding a one-line OpenDocument XML
12608 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
12609 directive.  For example, to force a page break do the following:
12611 @example
12612 #+ODT: <text:p text:style-name="PageBreak"/>
12613 @end example
12615 @strong{Hint:} To see the above example in action, edit your
12616 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12617 custom @samp{PageBreak} style as shown below.
12619 @example
12620 <style:style style:name="PageBreak" style:family="paragraph"
12621              style:parent-style-name="Text_20_body">
12622   <style:paragraph-properties fo:break-before="page"/>
12623 </style:style>
12624 @end example
12626 @item Embedding a block of OpenDocument XML
12628 You can add a large block of OpenDocument XML using the
12629 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
12631 For example, to create a one-off paragraph that uses bold text, do the
12632 following:
12634 @example
12635 #+BEGIN_ODT
12636 <text:p text:style-name="Text_20_body_20_bold">
12637 This paragraph is specially formatted and uses bold text.
12638 </text:p>
12639 #+END_ODT
12640 @end example
12642 @end enumerate
12644 @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
12645 @subsubsection Customizing tables in ODT export
12646 @cindex tables, in ODT export
12648 @cindex #+ATTR_ODT
12649 You can override the default formatting of the table by specifying a custom
12650 table style with the @code{#+ATTR_ODT} line.  For a discussion on default
12651 formatting of tables @pxref{Tables in ODT export}.
12653 This feature closely mimics the way table templates are defined in the
12654 OpenDocument-v1.2
12655 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12656 OpenDocument-v1.2 Specification}}
12658 @subsubheading Custom table styles: an illustration
12660 @vindex org-odt-table-styles
12661 To have a quick preview of this feature, install the below setting and
12662 export the table that follows:
12664 @lisp
12665 (setq org-odt-table-styles
12666       (append org-odt-table-styles
12667             '(("TableWithHeaderRowAndColumn" "Custom"
12668                 ((use-first-row-styles . t)
12669                  (use-first-column-styles . t)))
12670                 ("TableWithFirstRowandLastRow" "Custom"
12671                  ((use-first-row-styles . t)
12672                  (use-last-row-styles . t))))))
12673 @end lisp
12675 @example
12676 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12677 | Name  | Phone | Age |
12678 | Peter |  1234 |  17 |
12679 | Anna  |  4321 |  25 |
12680 @end example
12682 In the above example, you used a template named @samp{Custom} and installed
12683 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12684 @samp{TableWithFirstRowandLastRow}.  (@strong{Important:} The OpenDocument
12685 styles needed for producing the above template have been pre-defined for
12686 you.  These styles are available under the section marked @samp{Custom
12687 Table Template} in @file{OrgOdtContentTemplate.xml}
12688 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}).  If you need
12689 additional templates you have to define these styles yourselves.
12691 @subsubheading Custom table styles: the nitty-gritty
12692 To use this feature proceed as follows:
12694 @enumerate
12695 @item
12696 Create a table template@footnote{See the @code{<table:table-template>}
12697 element of the OpenDocument-v1.2 specification}
12699 A table template is nothing but a set of @samp{table-cell} and
12700 @samp{paragraph} styles for each of the following table cell categories:
12702 @itemize @minus
12703 @item Body
12704 @item First column
12705 @item Last column
12706 @item First row
12707 @item Last row
12708 @item Even row
12709 @item Odd row
12710 @item Even column
12711 @item Odd Column
12712 @end itemize
12714 The names for the above styles must be chosen based on the name of the table
12715 template using a well-defined convention.
12717 The naming convention is better illustrated with an example.  For a table
12718 template with the name @samp{Custom}, the needed style names are listed in
12719 the following table.
12721 @multitable  {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12722 @headitem Table cell type
12723 @tab @code{table-cell} style
12724 @tab @code{paragraph} style
12725 @item
12726 @tab
12727 @tab
12728 @item Body
12729 @tab @samp{CustomTableCell}
12730 @tab @samp{CustomTableParagraph}
12731 @item First column
12732 @tab @samp{CustomFirstColumnTableCell}
12733 @tab @samp{CustomFirstColumnTableParagraph}
12734 @item Last column
12735 @tab @samp{CustomLastColumnTableCell}
12736 @tab @samp{CustomLastColumnTableParagraph}
12737 @item First row
12738 @tab @samp{CustomFirstRowTableCell}
12739 @tab @samp{CustomFirstRowTableParagraph}
12740 @item Last row
12741 @tab @samp{CustomLastRowTableCell}
12742 @tab @samp{CustomLastRowTableParagraph}
12743 @item Even row
12744 @tab @samp{CustomEvenRowTableCell}
12745 @tab @samp{CustomEvenRowTableParagraph}
12746 @item Odd row
12747 @tab @samp{CustomOddRowTableCell}
12748 @tab @samp{CustomOddRowTableParagraph}
12749 @item Even column
12750 @tab @samp{CustomEvenColumnTableCell}
12751 @tab @samp{CustomEvenColumnTableParagraph}
12752 @item Odd column
12753 @tab @samp{CustomOddColumnTableCell}
12754 @tab @samp{CustomOddColumnTableParagraph}
12755 @end multitable
12757 To create a table template with the name @samp{Custom}, define the above
12758 styles in the
12759 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
12760 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
12761 styles}).
12763 @item
12764 Define a table style@footnote{See the attributes @code{table:template-name},
12765 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
12766 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
12767 @code{table:use-banding-rows-styles}, and
12768 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
12769 the OpenDocument-v1.2 specification}
12771 @vindex org-odt-table-styles
12772 To define a table style, create an entry for the style in the variable
12773 @code{org-odt-table-styles} and specify the following:
12775 @itemize @minus
12776 @item the name of the table template created in step (1)
12777 @item the set of cell styles in that template that are to be activated
12778 @end itemize
12780 For example, the entry below defines two different table styles
12781 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
12782 based on the same template @samp{Custom}.  The styles achieve their intended
12783 effect by selectively activating the individual cell styles in that template.
12785 @lisp
12786 (setq org-odt-table-styles
12787       (append org-odt-table-styles
12788               '(("TableWithHeaderRowAndColumn" "Custom"
12789                  ((use-first-row-styles . t)
12790                   (use-first-column-styles . t)))
12791                 ("TableWithFirstRowandLastRow" "Custom"
12792                  ((use-first-row-styles . t)
12793                   (use-last-row-styles . t))))))
12794 @end lisp
12796 @item
12797 Associate a table with the table style
12799 To do this, specify the table style created in step (2) as part of
12800 the @code{ATTR_ODT} line as shown below.
12802 @example
12803 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12804 | Name  | Phone | Age |
12805 | Peter |  1234 |  17 |
12806 | Anna  |  4321 |  25 |
12807 @end example
12808 @end enumerate
12810 @node Validating OpenDocument XML,  , Customizing tables in ODT export, Advanced topics in ODT export
12811 @subsubsection Validating OpenDocument XML
12813 Occasionally, you will discover that the document created by the
12814 ODT exporter cannot be opened by your favorite application.  One of
12815 the common reasons for this is that the @file{.odt} file is corrupt.  In such
12816 cases, you may want to validate the document against the OpenDocument RELAX
12817 NG Compact Syntax (RNC) schema.
12819 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
12820 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}.  For
12821 general help with validation (and schema-sensitive editing) of XML files:
12822 @inforef{Introduction,,nxml-mode}.
12824 @vindex org-odt-schema-dir
12825 If you have ready access to OpenDocument @file{.rnc} files and the needed
12826 schema-locating rules in a single folder, you can customize the variable
12827 @code{org-odt-schema-dir} to point to that directory.  The ODT exporter
12828 will take care of updating the @code{rng-schema-locating-files} for you.
12830 @c end opendocument
12832 @node Org export
12833 @section Org export
12834 @cindex Org export
12836 @code{org} export back-end creates a normalized version of the Org document
12837 in current buffer.  In particular, it evaluates Babel code (@pxref{Evaluating
12838 code blocks}) and removes other back-ends specific contents.
12840 @subheading Org export commands
12842 @table @kbd
12843 @orgcmd{C-c C-e O o,org-org-export-to-org}
12844 Export as an Org document.  For an Org file, @file{myfile.org}, the resulting
12845 file will be @file{myfile.org.org}.  The file will be overwritten without
12846 warning.
12847 @orgcmd{C-c C-e O O,org-org-export-as-org}
12848 Export to a temporary buffer.  Do not create a file.
12849 @item C-c C-e O v
12850 Export to an Org file, then open it.
12851 @end table
12853 @node Texinfo export, iCalendar export, Org export, Exporting
12854 @section Texinfo export
12855 @cindex Texinfo export
12857 @samp{texinfo} export back-end generates Texinfo code and can compile it into
12858 an Info file.
12860 @menu
12861 * Texinfo export commands::     How to invoke Texinfo export
12862 * Document preamble::           File header, title and copyright page
12863 * Headings and sectioning structure:: Building document structure
12864 * Indices::                     Creating indices
12865 * Quoting Texinfo code::        Incorporating literal Texinfo code
12866 * Texinfo specific attributes:: Controlling Texinfo output
12867 * An example::
12868 @end menu
12870 @node Texinfo export commands, Document preamble, Texinfo export, Texinfo export
12871 @subsection Texinfo export commands
12873 @vindex org-texinfo-info-process
12874 @table @kbd
12875 @orgcmd{C-c C-e i t,org-texinfo-export-to-texinfo}
12876 Export as a Texinfo file.  For an Org file, @file{myfile.org}, the resulting
12877 file will be @file{myfile.texi}.  The file will be overwritten without
12878 warning.
12879 @orgcmd{C-c C-e i i,org-texinfo-export-to-info}
12880 Export to Texinfo and then process to an Info file@footnote{By setting
12881 @code{org-texinfo-info-process}, it is possible to generate other formats,
12882 including DocBook.}.
12883 @end table
12885 @node Document preamble, Headings and sectioning structure, Texinfo export commands, Texinfo export
12886 @subsection Document preamble
12888 When processing a document, @samp{texinfo} back-end generates a minimal file
12889 header along with a title page, a copyright page, and a menu.  You control
12890 the latter through the structure of the document (@pxref{Headings and
12891 sectioning structure}).  Various keywords allow to tweak the other parts.  It
12892 is also possible to give directions to install the document in the @samp{Top}
12893 node.
12895 @subsubheading File header
12897 @cindex #+TEXINFO_FILENAME
12898 Upon creating the header of a Texinfo file, the back-end guesses a name for
12899 the Info file to be compiled.  This may not be a sensible choice, e.g., if
12900 you want to produce the final document in a different directory.  Specify an
12901 alternate path with @code{#+TEXINFO_FILENAME} keyword to override the default
12902 destination.
12904 @vindex org-texinfo-coding-system
12905 @vindex org-texinfo-classes
12906 @cindex #+TEXINFO_HEADER
12907 @cindex #+TEXINFO_CLASS
12908 Along with the output file name, the header contains information about the
12909 language (@pxref{Export settings}) and current encoding used@footnote{See
12910 @code{org-texinfo-coding-system} for more information.}.  Insert
12911 a @code{#+TEXINFO_HEADER} keyword for each additional command needed, e.g.,
12912 @@code@{@@synindex@}.
12914 If you happen to regularly install the same set of commands, it may be easier
12915 to define your own class in @code{org-texinfo-classes}, which see.  Set
12916 @code{#+TEXINFO_CLASS} keyword accordingly in your document to activate it.
12918 @subsubheading Title and copyright page
12920 @cindex #+TEXINFO_PRINTED_TITLE
12921 @cindex #+SUBTITLE
12922 The default template includes a title page for hard copy output.  The title
12923 and author displayed on this page are extracted from, respectively,
12924 @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}).  It is
12925 also possible to print a different, more specific, title with
12926 @code{#+TEXINFO_PRINTED_TITLE} keyword, and add subtitles with
12927 @code{#+SUBTITLE} keyword.  Both expect raw Texinfo code in their value.
12929 @cindex #+SUBAUTHOR
12930 Likewise, information brought by @code{#+AUTHOR} may not be enough.  You can
12931 include other authors with several @code{#+SUBAUTHOR} keywords.  Values are
12932 also expected to be written in Texinfo code.
12934 @example
12935 #+AUTHOR: Jane Smith
12936 #+SUBAUTHOR: John Doe
12937 #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@}
12938 @end example
12940 @cindex property, COPYING
12941 Copying material is defined in a dedicated headline with a non-nil
12942 @code{:COPYING:} property.  The contents are inserted within
12943 a @code{@@copying} command at the beginning of the document whereas the
12944 heading itself does not appear in the structure of the document.
12946 Copyright information is printed on the back of the title page.
12948 @example
12949 * Copying
12950   :PROPERTIES:
12951   :COPYING: t
12952   :END:
12954   This is a short example of a complete Texinfo file, version 1.0.
12956   Copyright \copy 2014 Free Software Foundation, Inc.
12957 @end example
12959 @subsubheading The Top node
12961 @cindex #+TEXINFO_DIR_CATEGORY
12962 @cindex #+TEXINFO_DIR_TITLE
12963 @cindex #+TEXINFO_DIR_DESC
12964 You may ultimately want to install your new Info file to your system.  You
12965 can write an appropriate entry in the top level directory specifying its
12966 category and title with, respectively, @code{#+TEXINFO_DIR_CATEGORY} and
12967 @code{#+TEXINFO_DIR_TITLE}.  Optionally, you can add a short description
12968 using @code{#+TEXINFO_DIR_DESC}.  The following example would write an entry
12969 similar to Org's in the @samp{Top} node.
12971 @example
12972 #+TEXINFO_DIR_CATEGORY: Emacs
12973 #+TEXINFO_DIR_TITLE: Org Mode: (org)
12974 #+TEXINFO_DIR_DESC: Outline-based notes management and organizer
12975 @end example
12977 @node Headings and sectioning structure, Indices, Document preamble, Texinfo export
12978 @subsection Headings and sectioning structure
12980 @vindex org-texinfo-classes
12981 @vindex org-texinfo-default-class
12982 @cindex #+TEXINFO_CLASS
12983 @samp{texinfo} uses a pre-defined scheme, or class, to convert headlines into
12984 Texinfo structuring commands.  For example, a top level headline appears as
12985 @code{@@chapter} if it should be numbered or as @code{@@unnumbered}
12986 otherwise.  If you need to use a different set of commands, e.g., to start
12987 with @code{@@part} instead of @code{@@chapter}, install a new class in
12988 @code{org-texinfo-classes}, then activate it with @code{#+TEXINFO_CLASS}
12989 keyword.  Export process defaults to @code{org-texinfo-default-class} when
12990 there is no such keyword in the document.
12992 If a headline's level has no associated structuring command, or is below
12993 a certain threshold @pxref{Export settings}, that headline becomes a list in
12994 Texinfo output.
12996 @cindex property, APPENDIX
12997 As an exception, a headline with a non-nil @code{:APPENDIX:} property becomes
12998 an appendix, independently on its level and the class used.
13000 @cindex property, DESCRIPTION
13001 Each regular sectioning structure creates a menu entry, named after the
13002 heading.  You can provide a different, e.g., shorter, title in
13003 @code{:ALT_TITLE:} property (@pxref{Table of contents}).  Optionally, you can
13004 specify a description for the item in @code{:DESCRIPTION:} property.  E.g.,
13006 @example
13007 * Controlling Screen Display
13008   :PROPERTIES:
13009   :ALT_TITLE: Display
13010   :DESCRIPTION: Controlling Screen Display
13011   :END:
13012 @end example
13014 @node Indices, Quoting Texinfo code, Headings and sectioning structure, Texinfo export
13015 @subsection Indices
13017 @cindex #+CINDEX
13018 @cindex #+FINDEX
13019 @cindex #+KINDEX
13020 @cindex #+PINDEX
13021 @cindex #+TINDEX
13022 @cindex #+VINDEX
13023 Index entries are created using dedicated keywords.  @samp{texinfo} back-end
13024 provides one for each predefined type: @code{#+CINDEX}, @code{#+FINDEX},
13025 @code{#+KINDEX}, @code{#+PINDEX}, @code{#+TINDEX} and @code{#+VINDEX}.  For
13026 custom indices, you can write raw Texinfo code (@pxref{Quoting Texinfo
13027 code}).
13029 @example
13030 #+CINDEX: Defining indexing entries
13031 @end example
13033 @cindex property, INDEX
13034 To generate an index, you need to set the @code{:INDEX:} property of
13035 a headline to an appropriate abbreviation (e.g., @samp{cp} or @samp{vr}).
13036 The headline is then exported as an unnumbered chapter or section command and
13037 the index is inserted after its contents.
13039 @example
13040 * Concept Index
13041   :PROPERTIES:
13042   :INDEX: cp
13043   :END:
13044 @end example
13046 @node Quoting Texinfo code, Texinfo specific attributes, Indices, Texinfo export
13047 @subsection Quoting Texinfo code
13049 It is possible to insert raw Texinfo code using any of the following
13050 constructs
13052 @cindex #+TEXINFO
13053 @cindex #+BEGIN_TEXINFO
13054 @example
13055 Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU.
13057 #+TEXINFO: @@need800
13058 This paragraph is preceded by...
13060 #+BEGIN_TEXINFO
13061 @@auindex Johnson, Mark
13062 @@auindex Lakoff, George
13063 #+END_TEXINFO
13064 @end example
13066 @node Texinfo specific attributes, An example, Quoting Texinfo code, Texinfo export
13067 @subsection Texinfo specific attributes
13069 @cindex #+ATTR_TEXINFO
13070 @samp{texinfo} back-end understands several attributes in plain lists and
13071 tables.  They must be specified using an @code{#+ATTR_TEXINFO} keyword,
13072 written just above the list or table.
13074 @subsubheading Plain lists
13076 In Texinfo output, description lists appear as two-column tables, using the
13077 default command @code{@@table}.  You can use @code{@@ftable} or
13078 @code{@@vtable}@footnote{For more information, @inforef{Two-column
13079 Tables,,texinfo}.} instead with @code{:table-type} attribute.
13081 @vindex org-texinfo-def-table-markup
13082 In any case, these constructs require a highlighting command for entries in
13083 the list.  You can provide one with @code{:indic} attribute.  If you do not,
13084 it defaults to the value stored in @code{org-texinfo-def-table-markup}, which
13085 see.
13087 @example
13088 #+ATTR_TEXINFO: :indic @@asis
13089 - foo :: This is the text for /foo/, with no highlighting.
13090 @end example
13092 @subsubheading Tables
13094 When exporting a table, column widths are deduced from the longest cell in
13095 each column.  You can also define them explicitly as fractions of the line
13096 length, using @code{:columns} attribute.
13098 @example
13099 #+ATTR_TEXINFO: :columns .5 .5
13100 | a cell | another cell |
13101 @end example
13103 @node An example,  , Texinfo specific attributes, Texinfo export
13104 @subsection An example
13106 Here is a thorough example, taken from @inforef{GNU Sample Texts,,texinfo}.
13108 @smallexample
13109 #+MACRO: version 2.0
13110 #+MACRO: updated last updated 4 March 2014
13112 #+OPTIONS: ':t toc:t author:t email:t
13113 #+TITLE: GNU Sample @{@{@{version@}@}@}
13114 #+AUTHOR: A.U. Thor
13115 #+EMAIL: bug-sample@@gnu.org
13116 #+LANGUAGE: en
13118 #+TEXINFO_FILENAME: sample.info
13119 #+TEXINFO_HEADER: @@syncodeindex pg cp
13121 #+TEXINFO_DIR_CATEGORY: Texinfo documentation system
13122 #+TEXINFO_DIR_TITLE: sample: (sample)
13123 #+TEXINFO_DIR_DESC: Invoking sample
13125 #+TEXINFO_PRINTED_TITLE: GNU Sample
13126 #+SUBTITLE: for version 2.0, last updated 4 March 2014
13128 * Copying 
13129   :PROPERTIES:
13130   :COPYING:  t
13131   :END:
13133   This manual is for GNU Sample (version @{@{@{version@}@}@},
13134   @{@{@{updated@}@}@}), which is an example in the Texinfo documentation.
13136   Copyright @@@@texinfo:@@copyright@{@}@@@@ 2013 Free Software Foundation,
13137   Inc.
13139   #+BEGIN_QUOTE
13140   Permission is granted to copy, distribute and/or modify this
13141   document under the terms of the GNU Free Documentation License,
13142   Version 1.3 or any later version published by the Free Software
13143   Foundation; with no Invariant Sections, with no Front-Cover Texts,
13144   and with no Back-Cover Texts.  A copy of the license is included in
13145   the section entitled "GNU Free Documentation License".
13146   #+END_QUOTE
13148 * Invoking sample
13150   #+PINDEX: sample
13151   #+CINDEX: invoking @@command@{sample@}
13153   This is a sample manual.  There is no sample program to invoke, but
13154   if there were, you could see its basic usage and command line
13155   options here.
13157 * GNU Free Documentation License
13158   :PROPERTIES:
13159   :APPENDIX: t
13160   :END:
13162   #+TEXINFO: @@include fdl.texi
13164 * Index
13165   :PROPERTIES:
13166   :INDEX:    cp
13167   :END:
13168 @end smallexample
13170 @node iCalendar export, Other built-in back-ends, Texinfo export, Exporting
13171 @section iCalendar export
13172 @cindex iCalendar export
13174 @vindex org-icalendar-include-todo
13175 @vindex org-icalendar-use-deadline
13176 @vindex org-icalendar-use-scheduled
13177 @vindex org-icalendar-categories
13178 @vindex org-icalendar-alarm-time
13179 Some people use Org mode for keeping track of projects, but still prefer a
13180 standard calendar application for anniversaries and appointments.  In this
13181 case it can be useful to show deadlines and other time-stamped items in Org
13182 files in the calendar application.  Org mode can export calendar information
13183 in the standard iCalendar format.  If you also want to have TODO entries
13184 included in the export, configure the variable
13185 @code{org-icalendar-include-todo}.  Plain timestamps are exported as VEVENT,
13186 and TODO items as VTODO@.  It will also create events from deadlines that are
13187 in non-TODO items.  Deadlines and scheduling dates in TODO items will be used
13188 to set the start and due dates for the TODO entry@footnote{See the variables
13189 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
13190 As categories, it will use the tags locally defined in the heading, and the
13191 file/tree category@footnote{To add inherited tags or the TODO state,
13192 configure the variable @code{org-icalendar-categories}.}.  See the variable
13193 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
13194 time.
13196 @vindex org-icalendar-store-UID
13197 @cindex property, ID
13198 The iCalendar standard requires each entry to have a globally unique
13199 identifier (UID).  Org creates these identifiers during export.  If you set
13200 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
13201 @code{:ID:} property of the entry and re-used next time you report this
13202 entry.  Since a single entry can give rise to multiple iCalendar entries (as
13203 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
13204 prefixes to the UID, depending on what triggered the inclusion of the entry.
13205 In this way the UID remains unique, but a synchronization program can still
13206 figure out from which entry all the different instances originate.
13208 @table @kbd
13209 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
13210 Create iCalendar entries for the current buffer and store them in the same
13211 directory, using a file extension @file{.ics}.
13212 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
13213 @vindex org-agenda-files
13214 Like @kbd{C-c C-e c f}, but do this for all files in
13215 @code{org-agenda-files}.  For each of these files, a separate iCalendar
13216 file will be written.
13217 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
13218 @vindex org-icalendar-combined-agenda-file
13219 Create a single large iCalendar file from all files in
13220 @code{org-agenda-files} and write it to the file given by
13221 @code{org-icalendar-combined-agenda-file}.
13222 @end table
13224 @vindex org-use-property-inheritance
13225 @vindex org-icalendar-include-body
13226 @cindex property, SUMMARY
13227 @cindex property, DESCRIPTION
13228 @cindex property, LOCATION
13229 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
13230 property can be inherited from higher in the hierarchy if you configure
13231 @code{org-use-property-inheritance} accordingly.} properties if the selected
13232 entries have them.  If not, the summary will be derived from the headline,
13233 and the description from the body (limited to
13234 @code{org-icalendar-include-body} characters).
13236 How this calendar is best read and updated, depends on the application
13237 you are using.  The FAQ covers this issue.
13239 @node Other built-in back-ends, Export in foreign buffers, iCalendar export, Exporting
13240 @section Other built-in back-ends
13241 @cindex export back-ends, built-in
13242 @vindex org-export-backends
13244 On top of the aforementioned back-ends, Org comes with other built-in ones:
13246 @itemize
13247 @item @file{ox-man.el}: export to a man page.
13248 @end itemize
13250 To activate these export back-end, customize @code{org-export-backends} or
13251 load them directly with e.g., @code{(require 'ox-man)}.  This will add new
13252 keys in the export dispatcher (@pxref{The Export Dispatcher}).
13254 See the comment section of these files for more information on how to use
13255 them.
13257 @node Export in foreign buffers, Advanced configuration, Other built-in back-ends, Exporting
13258 @section Export in foreign buffers
13260 Most built-in back-ends come with a command to convert the selected region
13261 into a selected format and replace this region by the exported output.  Here
13262 is a list of such conversion commands:
13264 @table @code
13265 @item org-html-convert-region-to-html
13266 Convert the selected region into HTML.
13267 @item org-latex-convert-region-to-latex
13268 Convert the selected region into @LaTeX{}.
13269 @item org-texinfo-convert-region-to-texinfo
13270 Convert the selected region into @code{Texinfo}.
13271 @item org-md-convert-region-to-md
13272 Convert the selected region into @code{MarkDown}.
13273 @end table
13275 This is particularly useful for converting tables and lists in foreign
13276 buffers.  E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
13277 use Org commands for editing a list, and finally select and convert the list
13278 with @code{M-x org-html-convert-region-to-html RET}.
13280 @node Advanced configuration,  , Export in foreign buffers, Exporting
13281 @section Advanced configuration
13283 @subheading Hooks
13285 @vindex org-export-before-processing-hook
13286 @vindex org-export-before-parsing-hook
13287 Two hooks are run during the first steps of the export process.  The first
13288 one, @code{org-export-before-processing-hook} is called before expanding
13289 macros, Babel code and include keywords in the buffer.  The second one,
13290 @code{org-export-before-parsing-hook}, as its name suggests, happens just
13291 before parsing the buffer.  Their main use is for heavy duties, that is
13292 duties involving structural modifications of the document.  For example, one
13293 may want to remove every headline in the buffer during export.  The following
13294 code can achieve this:
13296 @lisp
13297 @group
13298 (defun my-headline-removal (backend)
13299   "Remove all headlines in the current buffer.
13300 BACKEND is the export back-end being used, as a symbol."
13301   (org-map-entries
13302    (lambda () (delete-region (point) (progn (forward-line) (point))))))
13304 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
13305 @end group
13306 @end lisp
13308 Note that functions used in these hooks require a mandatory argument,
13309 a symbol representing the back-end used.
13311 @subheading Filters
13313 @cindex Filters, exporting
13314 Filters are lists of functions applied on a specific part of the output from
13315 a given back-end.  More explicitly, each time a back-end transforms an Org
13316 object or element into another language, all functions within a given filter
13317 type are called in turn on the string produced.  The string returned by the
13318 last function will be the one used in the final output.
13320 There are filters sets for each type of element or object, for plain text,
13321 for the parse tree, for the export options and for the final output.  They
13322 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
13323 where @code{TYPE} is the type targeted by the filter.  Valid types are:
13325 @multitable @columnfractions .33 .33 .33
13326 @item bold
13327 @tab babel-call
13328 @tab center-block
13329 @item clock
13330 @tab code
13331 @tab comment
13332 @item comment-block
13333 @tab diary-sexp
13334 @tab drawer
13335 @item dynamic-block
13336 @tab entity
13337 @tab example-block
13338 @item export-block
13339 @tab export-snippet
13340 @tab final-output
13341 @item fixed-width
13342 @tab footnote-definition
13343 @tab footnote-reference
13344 @item headline
13345 @tab horizontal-rule
13346 @tab inline-babel-call
13347 @item inline-src-block
13348 @tab inlinetask
13349 @tab italic
13350 @item item
13351 @tab keyword
13352 @tab latex-environment
13353 @item latex-fragment
13354 @tab line-break
13355 @tab link
13356 @item node-property
13357 @tab options
13358 @tab paragraph
13359 @item parse-tree
13360 @tab plain-list
13361 @tab plain-text
13362 @item planning
13363 @tab property-drawer
13364 @tab quote-block
13365 @item quote-section
13366 @tab radio-target
13367 @tab section
13368 @item special-block
13369 @tab src-block
13370 @tab statistics-cookie
13371 @item strike-through
13372 @tab subscript
13373 @tab superscript
13374 @item table
13375 @tab table-cell
13376 @tab table-row
13377 @item target
13378 @tab timestamp
13379 @tab underline
13380 @item verbatim
13381 @tab verse-block
13382 @tab
13383 @end multitable
13385 For example, the following snippet allows me to use non-breaking spaces in
13386 the Org buffer and get them translated into @LaTeX{} without using the
13387 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
13389 @lisp
13390 @group
13391 (defun my-latex-filter-nobreaks (text backend info)
13392   "Ensure \" \" are properly handled in LaTeX export."
13393   (when (org-export-derived-backend-p backend 'latex)
13394         (replace-regexp-in-string " " "~" text)))
13396 (add-to-list 'org-export-filter-plain-text-functions
13397              'my-latex-filter-nobreaks)
13398 @end group
13399 @end lisp
13401 Three arguments must be provided to a filter: the code being changed, the
13402 back-end used, and some information about the export process.  You can safely
13403 ignore the third argument for most purposes.  Note the use of
13404 @code{org-export-derived-backend-p}, which ensures that the filter will only
13405 be applied when using @code{latex} back-end or any other back-end derived
13406 from it (e.g., @code{beamer}).
13408 @subheading Extending an existing back-end
13410 This is obviously the most powerful customization, since the changes happen
13411 at the parser level.  Indeed, some export back-ends are built as extensions
13412 of other ones (e.g. Markdown back-end an extension of HTML back-end).
13414 Extending a back-end means that if an element type is not transcoded by the
13415 new back-end, it will be handled by the original one.  Hence you can extend
13416 specific parts of a back-end without too much work.
13418 As an example, imagine we want the @code{ascii} back-end to display the
13419 language used in a source block, when it is available, but only when some
13420 attribute is non-@code{nil}, like the following:
13422 @example
13423 #+ATTR_ASCII: :language t
13424 @end example
13426 Because that back-end is lacking in that area, we are going to create a new
13427 back-end, @code{my-ascii} that will do the job.
13429 @lisp
13430 @group
13431 (defun my-ascii-src-block (src-block contents info)
13432   "Transcode a SRC-BLOCK element from Org to ASCII.
13433 CONTENTS is nil.  INFO is a plist used as a communication
13434 channel."
13435   (if (not (org-export-read-attribute :attr_ascii src-block :language))
13436     (org-export-with-backend 'ascii src-block contents info)
13437   (concat
13438    (format ",--[ %s ]--\n%s`----"
13439            (org-element-property :language src-block)
13440            (replace-regexp-in-string
13441             "^" "| "
13442             (org-element-normalize-string
13443              (org-export-format-code-default src-block info)))))))
13445 (org-export-define-derived-backend 'my-ascii 'ascii
13446   :translate-alist '((src-block . my-ascii-src-block)))
13447 @end group
13448 @end lisp
13450 The @code{my-ascii-src-block} function looks at the attribute above the
13451 element.  If it isn't true, it gives hand to the @code{ascii} back-end.
13452 Otherwise, it creates a box around the code, leaving room for the language.
13453 A new back-end is then created.  It only changes its behavior when
13454 translating @code{src-block} type element.  Now, all it takes to use the new
13455 back-end is calling the following from an Org buffer:
13457 @smalllisp
13458 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
13459 @end smalllisp
13461 It is obviously possible to write an interactive function for this, install
13462 it in the export dispatcher menu, and so on.
13464 @node Publishing, Working With Source Code, Exporting, Top
13465 @chapter Publishing
13466 @cindex publishing
13468 Org includes a publishing management system that allows you to configure
13469 automatic HTML conversion of @emph{projects} composed of interlinked org
13470 files.  You can also configure Org to automatically upload your exported HTML
13471 pages and related attachments, such as images and source code files, to a web
13472 server.
13474 You can also use Org to convert files into PDF, or even combine HTML and PDF
13475 conversion so that files are available in both formats on the server.
13477 Publishing has been contributed to Org by David O'Toole.
13479 @menu
13480 * Configuration::               Defining projects
13481 * Uploading files::             How to get files up on the server
13482 * Sample configuration::        Example projects
13483 * Triggering publication::      Publication commands
13484 @end menu
13486 @node Configuration, Uploading files, Publishing, Publishing
13487 @section Configuration
13489 Publishing needs significant configuration to specify files, destination
13490 and many other properties of a project.
13492 @menu
13493 * Project alist::               The central configuration variable
13494 * Sources and destinations::    From here to there
13495 * Selecting files::             What files are part of the project?
13496 * Publishing action::           Setting the function doing the publishing
13497 * Publishing options::          Tweaking HTML/@LaTeX{} export
13498 * Publishing links::            Which links keep working after publishing?
13499 * Sitemap::                     Generating a list of all pages
13500 * Generating an index::         An index that reaches across pages
13501 @end menu
13503 @node Project alist, Sources and destinations, Configuration, Configuration
13504 @subsection The variable @code{org-publish-project-alist}
13505 @cindex org-publish-project-alist
13506 @cindex projects, for publishing
13508 @vindex org-publish-project-alist
13509 Publishing is configured almost entirely through setting the value of one
13510 variable, called @code{org-publish-project-alist}.  Each element of the list
13511 configures one project, and may be in one of the two following forms:
13513 @lisp
13514    ("project-name" :property value :property value ...)
13515      @r{i.e., a well-formed property list with alternating keys and values}
13516 @r{or}
13517    ("project-name" :components ("project-name" "project-name" ...))
13519 @end lisp
13521 In both cases, projects are configured by specifying property values.  A
13522 project defines the set of files that will be published, as well as the
13523 publishing configuration to use when publishing those files.  When a project
13524 takes the second form listed above, the individual members of the
13525 @code{:components} property are taken to be sub-projects, which group
13526 together files requiring different publishing options.  When you publish such
13527 a ``meta-project'', all the components will also be published, in the
13528 sequence given.
13530 @node Sources and destinations, Selecting files, Project alist, Configuration
13531 @subsection Sources and destinations for files
13532 @cindex directories, for publishing
13534 Most properties are optional, but some should always be set.  In
13535 particular, Org needs to know where to look for source files,
13536 and where to put published files.
13538 @multitable @columnfractions 0.3 0.7
13539 @item @code{:base-directory}
13540 @tab Directory containing publishing source files
13541 @item @code{:publishing-directory}
13542 @tab Directory where output files will be published.  You can directly
13543 publish to a web server using a file name syntax appropriate for
13544 the Emacs @file{tramp} package.  Or you can publish to a local directory and
13545 use external tools to upload your website (@pxref{Uploading files}).
13546 @item @code{:preparation-function}
13547 @tab Function or list of functions to be called before starting the
13548 publishing process, for example, to run @code{make} for updating files to be
13549 published.  The project property list is scoped into this call as the
13550 variable @code{project-plist}.
13551 @item @code{:completion-function}
13552 @tab Function or list of functions called after finishing the publishing
13553 process, for example, to change permissions of the resulting files.  The
13554 project property list is scoped into this call as the variable
13555 @code{project-plist}.
13556 @end multitable
13557 @noindent
13559 @node Selecting files, Publishing action, Sources and destinations, Configuration
13560 @subsection Selecting files
13561 @cindex files, selecting for publishing
13563 By default, all files with extension @file{.org} in the base directory
13564 are considered part of the project.  This can be modified by setting the
13565 properties
13566 @multitable @columnfractions 0.25 0.75
13567 @item @code{:base-extension}
13568 @tab Extension (without the dot!) of source files.  This actually is a
13569 regular expression.  Set this to the symbol @code{any} if you want to get all
13570 files in @code{:base-directory}, even without extension.
13572 @item @code{:exclude}
13573 @tab Regular expression to match file names that should not be
13574 published, even though they have been selected on the basis of their
13575 extension.
13577 @item @code{:include}
13578 @tab List of files to be included regardless of @code{:base-extension}
13579 and @code{:exclude}.
13581 @item @code{:recursive}
13582 @tab non-@code{nil} means, check base-directory recursively for files to publish.
13583 @end multitable
13585 @node Publishing action, Publishing options, Selecting files, Configuration
13586 @subsection Publishing action
13587 @cindex action, for publishing
13589 Publishing means that a file is copied to the destination directory and
13590 possibly transformed in the process.  The default transformation is to export
13591 Org files as HTML files, and this is done by the function
13592 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
13593 export}).  But you also can publish your content as PDF files using
13594 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
13595 using the corresponding functions.
13597 If you want to publish the Org file as an @code{.org} file but with the
13598 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
13599 function @code{org-org-publish-to-org}.  This will produce @file{file.org}
13600 and put it in the publishing directory.  If you want a htmlized version of
13601 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
13602 produce @file{file.org.html} in the publishing directory@footnote{If the
13603 publishing directory is the same than the source directory, @file{file.org}
13604 will be exported as @file{file.org.org}, so probably don't want to do this.}.
13606 Other files like images only need to be copied to the publishing destination.
13607 For this you can use @code{org-publish-attachment}.  For non-org files, you
13608 always need to specify the publishing function:
13610 @multitable @columnfractions 0.3 0.7
13611 @item @code{:publishing-function}
13612 @tab Function executing the publication of a file.  This may also be a
13613 list of functions, which will all be called in turn.
13614 @item @code{:htmlized-source}
13615 @tab non-@code{nil} means, publish htmlized source.
13616 @end multitable
13618 The function must accept three arguments: a property list containing at least
13619 a @code{:publishing-directory} property, the name of the file to be published
13620 and the path to the publishing directory of the output file.  It should take
13621 the specified file, make the necessary transformation (if any) and place the
13622 result into the destination folder.
13624 @node Publishing options, Publishing links, Publishing action, Configuration
13625 @subsection Options for the exporters
13626 @cindex options, for publishing
13628 The property list can be used to set many export options for the exporters.
13629 In most cases, these properties correspond to user variables in Org.  The
13630 first table below lists these properties along with the variable they belong
13631 to.  The second table list HTML specific properties.  See the documentation
13632 string of these options for details.
13634 @vindex org-display-custom-times
13635 @vindex org-export-default-language
13636 @vindex org-export-exclude-tags
13637 @vindex org-export-headline-levels
13638 @vindex org-export-preserve-breaks
13639 @vindex org-export-publishing-directory
13640 @vindex org-export-select-tags
13641 @vindex org-export-with-archived-trees
13642 @vindex org-export-with-author
13643 @vindex org-export-with-creator
13644 @vindex org-export-with-drawers
13645 @vindex org-export-with-email
13646 @vindex org-export-with-emphasize
13647 @vindex org-export-with-fixed-width
13648 @vindex org-export-with-footnotes
13649 @vindex org-export-with-latex
13650 @vindex org-export-with-planning
13651 @vindex org-export-with-priority
13652 @vindex org-export-with-section-numbers
13653 @vindex org-export-with-special-strings
13654 @vindex org-export-with-sub-superscripts
13655 @vindex org-export-with-tables
13656 @vindex org-export-with-tags
13657 @vindex org-export-with-tasks
13658 @vindex org-export-with-timestamps
13659 @vindex org-export-with-toc
13660 @vindex org-export-with-todo-keywords
13661 @vindex user-mail-address
13663 @multitable @columnfractions 0.32 0.68
13664 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
13665 @item @code{:exclude-tags}          @tab @code{org-export-exclude-tags}
13666 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
13667 @item @code{:language}              @tab @code{org-export-default-language}
13668 @item @code{:preserve-breaks}       @tab @code{org-export-preserve-breaks}
13669 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
13670 @item @code{:select-tags}           @tab @code{org-export-select-tags}
13671 @item @code{:with-author}           @tab @code{org-export-with-author}
13672 @item @code{:with-creator}          @tab @code{org-export-with-creator}
13673 @item @code{:with-drawers}          @tab @code{org-export-with-drawers}
13674 @item @code{:with-email}            @tab @code{org-export-with-email}
13675 @item @code{:with-emphasize}        @tab @code{org-export-with-emphasize}
13676 @item @code{:with-fixed-width}      @tab @code{org-export-with-fixed-width}
13677 @item @code{:with-footnotes}        @tab @code{org-export-with-footnotes}
13678 @item @code{:with-latex}            @tab @code{org-export-with-latex}
13679 @item @code{:with-planning}         @tab @code{org-export-with-planning}
13680 @item @code{:with-priority}         @tab @code{org-export-with-priority}
13681 @item @code{:with-special-strings}  @tab @code{org-export-with-special-strings}
13682 @item @code{:with-sub-superscript}  @tab @code{org-export-with-sub-superscripts}
13683 @item @code{:with-tables}           @tab @code{org-export-with-tables}
13684 @item @code{:with-tags}             @tab @code{org-export-with-tags}
13685 @item @code{:with-tasks}            @tab @code{org-export-with-tasks}
13686 @item @code{:with-timestamps}       @tab @code{org-export-with-timestamps}
13687 @item @code{:with-toc}              @tab @code{org-export-with-toc}
13688 @item @code{:with-todo-keywords}    @tab @code{org-export-with-todo-keywords}
13689 @end multitable
13691 @vindex org-html-doctype
13692 @vindex org-html-container-element
13693 @vindex org-html-html5-fancy
13694 @vindex org-html-xml-declaration
13695 @vindex org-html-link-up
13696 @vindex org-html-link-home
13697 @vindex org-html-link-org-files-as-html
13698 @vindex org-html-link-use-abs-url
13699 @vindex org-html-head
13700 @vindex org-html-head-extra
13701 @vindex org-html-inline-images
13702 @vindex org-html-extension
13703 @vindex org-html-preamble
13704 @vindex org-html-postamble
13705 @vindex org-html-table-default-attributes
13706 @vindex org-html-table-row-tags
13707 @vindex org-html-head-include-default-style
13708 @vindex org-html-head-include-scripts
13709 @multitable @columnfractions 0.32 0.68
13710 @item @code{:html-doctype}          @tab @code{org-html-doctype}
13711 @item @code{:html-container}        @tab @code{org-html-container-element}
13712 @item @code{:html-html5-fancy}      @tab @code{org-html-html5-fancy}
13713 @item @code{:html-xml-declaration}  @tab @code{org-html-xml-declaration}
13714 @item @code{:html-link-up}          @tab @code{org-html-link-up}
13715 @item @code{:html-link-home}        @tab @code{org-html-link-home}
13716 @item @code{:html-link-org-as-html} @tab @code{org-html-link-org-files-as-html}
13717 @item @code{:html-link-use-abs-url} @tab @code{org-html-link-use-abs-url}
13718 @item @code{:html-head}             @tab @code{org-html-head}
13719 @item @code{:html-head-extra}       @tab @code{org-html-head-extra}
13720 @item @code{:html-inline-images}    @tab @code{org-html-inline-images}
13721 @item @code{:html-extension}        @tab @code{org-html-extension}
13722 @item @code{:html-preamble}         @tab @code{org-html-preamble}
13723 @item @code{:html-postamble}        @tab @code{org-html-postamble}
13724 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
13725 @item @code{:html-table-row-tags}   @tab @code{org-html-table-row-tags}
13726 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
13727 @item @code{:html-head-include-scripts} @tab @code{org-html-head-include-scripts}
13728 @end multitable
13730 Most of the @code{org-export-with-*} variables have the same effect in each
13731 exporter.
13733 @vindex org-publish-project-alist
13734 When a property is given a value in @code{org-publish-project-alist}, its
13735 setting overrides the value of the corresponding user variable (if any)
13736 during publishing.  Options set within a file (@pxref{Export settings}),
13737 however, override everything.
13739 @node Publishing links, Sitemap, Publishing options, Configuration
13740 @subsection Links between published files
13741 @cindex links, publishing
13743 To create a link from one Org file to another, you would use something like
13744 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
13745 (@pxref{Hyperlinks}).  When published, this link becomes a link to
13746 @file{foo.html}.  You can thus interlink the pages of your "org web" project
13747 and the links will work as expected when you publish them to HTML@.  If you
13748 also publish the Org source file and want to link to it, use an @code{http:}
13749 link instead of a @code{file:} link, because @code{file:} links are converted
13750 to link to the corresponding @file{html} file.
13752 You may also link to related files, such as images.  Provided you are careful
13753 with relative file names, and provided you have also configured Org to upload
13754 the related files, these links will work too.  See @ref{Complex example}, for
13755 an example of this usage.
13757 @node Sitemap, Generating an index, Publishing links, Configuration
13758 @subsection Generating a sitemap
13759 @cindex sitemap, of published pages
13761 The following properties may be used to control publishing of
13762 a map of files for a given project.
13764 @multitable @columnfractions 0.35 0.65
13765 @item @code{:auto-sitemap}
13766 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
13767 or @code{org-publish-all}.
13769 @item @code{:sitemap-filename}
13770 @tab Filename for output of sitemap.  Defaults to @file{sitemap.org} (which
13771 becomes @file{sitemap.html}).
13773 @item @code{:sitemap-title}
13774 @tab Title of sitemap page.  Defaults to name of file.
13776 @item @code{:sitemap-function}
13777 @tab Plug-in function to use for generation of the sitemap.
13778 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
13779 of links to all files in the project.
13781 @item @code{:sitemap-sort-folders}
13782 @tab Where folders should appear in the sitemap.  Set this to @code{first}
13783 (default) or @code{last} to display folders first or last,
13784 respectively.  Any other value will mix files and folders.
13786 @item @code{:sitemap-sort-files}
13787 @tab How the files are sorted in the site map.  Set this to
13788 @code{alphabetically} (default), @code{chronologically} or
13789 @code{anti-chronologically}.  @code{chronologically} sorts the files with
13790 older date first while @code{anti-chronologically} sorts the files with newer
13791 date first.  @code{alphabetically} sorts the files alphabetically.  The date of
13792 a file is retrieved with @code{org-publish-find-date}.
13794 @item @code{:sitemap-ignore-case}
13795 @tab Should sorting be case-sensitive?  Default @code{nil}.
13797 @item @code{:sitemap-file-entry-format}
13798 @tab With this option one can tell how a sitemap's entry is formatted in the
13799 sitemap.  This is a format string with some escape sequences: @code{%t} stands
13800 for the title of the file, @code{%a} stands for the author of the file and
13801 @code{%d} stands for the date of the file.  The date is retrieved with the
13802 @code{org-publish-find-date} function and formatted with
13803 @code{org-publish-sitemap-date-format}.  Default @code{%t}.
13805 @item @code{:sitemap-date-format}
13806 @tab Format string for the @code{format-time-string} function that tells how
13807 a sitemap entry's date is to be formatted.  This property bypasses
13808 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
13810 @item @code{:sitemap-sans-extension}
13811 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
13812 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
13813 Defaults to @code{nil}.
13815 @end multitable
13817 @node Generating an index,  , Sitemap, Configuration
13818 @subsection Generating an index
13819 @cindex index, in a publishing project
13821 Org mode can generate an index across the files of a publishing project.
13823 @multitable @columnfractions 0.25 0.75
13824 @item @code{:makeindex}
13825 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
13826 publish it as @file{theindex.html}.
13827 @end multitable
13829 The file will be created when first publishing a project with the
13830 @code{:makeindex} set.  The file only contains a statement @code{#+INCLUDE:
13831 "theindex.inc"}.  You can then build around this include statement by adding
13832 a title, style information, etc.
13834 @node Uploading files, Sample configuration, Configuration, Publishing
13835 @section Uploading files
13836 @cindex rsync
13837 @cindex unison
13839 For those people already utilizing third party sync tools such as
13840 @command{rsync} or @command{unison}, it might be preferable not to use the built in
13841 @i{remote} publishing facilities of Org mode which rely heavily on
13842 Tramp.  Tramp, while very useful and powerful, tends not to be
13843 so efficient for multiple file transfer and has been known to cause problems
13844 under heavy usage.
13846 Specialized synchronization utilities offer several advantages.  In addition
13847 to timestamp comparison, they also do content and permissions/attribute
13848 checks.  For this reason you might prefer to publish your web to a local
13849 directory (possibly even @i{in place} with your Org files) and then use
13850 @file{unison} or @file{rsync} to do the synchronization with the remote host.
13852 Since Unison (for example) can be configured as to which files to transfer to
13853 a certain remote destination, it can greatly simplify the project publishing
13854 definition.  Simply keep all files in the correct location, process your Org
13855 files with @code{org-publish} and let the synchronization tool do the rest.
13856 You do not need, in this scenario, to include attachments such as @file{jpg},
13857 @file{css} or @file{gif} files in the project definition since the 3rd party
13858 tool syncs them.
13860 Publishing to a local directory is also much faster than to a remote one, so
13861 that you can afford more easily to republish entire projects.  If you set
13862 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
13863 benefit of re-including any changed external files such as source example
13864 files you might include with @code{#+INCLUDE:}.  The timestamp mechanism in
13865 Org is not smart enough to detect if included files have been modified.
13867 @node Sample configuration, Triggering publication, Uploading files, Publishing
13868 @section Sample configuration
13870 Below we provide two example configurations.  The first one is a simple
13871 project publishing only a set of Org files.  The second example is
13872 more complex, with a multi-component project.
13874 @menu
13875 * Simple example::              One-component publishing
13876 * Complex example::             A multi-component publishing example
13877 @end menu
13879 @node Simple example, Complex example, Sample configuration, Sample configuration
13880 @subsection Example: simple publishing configuration
13882 This example publishes a set of Org files to the @file{public_html}
13883 directory on the local machine.
13885 @lisp
13886 (setq org-publish-project-alist
13887       '(("org"
13888          :base-directory "~/org/"
13889          :publishing-directory "~/public_html"
13890          :section-numbers nil
13891          :with-toc nil
13892          :html-head "<link rel=\"stylesheet\"
13893                     href=\"../other/mystyle.css\"
13894                     type=\"text/css\"/>")))
13895 @end lisp
13897 @node Complex example,  , Simple example, Sample configuration
13898 @subsection Example: complex publishing configuration
13900 This more complicated example publishes an entire website, including
13901 Org files converted to HTML, image files, Emacs Lisp source code, and
13902 style sheets.  The publishing directory is remote and private files are
13903 excluded.
13905 To ensure that links are preserved, care should be taken to replicate
13906 your directory structure on the web server, and to use relative file
13907 paths.  For example, if your Org files are kept in @file{~/org} and your
13908 publishable images in @file{~/images}, you would link to an image with
13910 @example
13911 file:../images/myimage.png
13912 @end example
13914 On the web server, the relative path to the image should be the
13915 same.  You can accomplish this by setting up an "images" folder in the
13916 right place on the web server, and publishing images to it.
13918 @lisp
13919 (setq org-publish-project-alist
13920       '(("orgfiles"
13921           :base-directory "~/org/"
13922           :base-extension "org"
13923           :publishing-directory "/ssh:user@@host:~/html/notebook/"
13924           :publishing-function org-html-publish-to-html
13925           :exclude "PrivatePage.org"   ;; regexp
13926           :headline-levels 3
13927           :section-numbers nil
13928           :with-toc nil
13929           :html-head "<link rel=\"stylesheet\"
13930                   href=\"../other/mystyle.css\" type=\"text/css\"/>"
13931           :html-preamble t)
13933          ("images"
13934           :base-directory "~/images/"
13935           :base-extension "jpg\\|gif\\|png"
13936           :publishing-directory "/ssh:user@@host:~/html/images/"
13937           :publishing-function org-publish-attachment)
13939          ("other"
13940           :base-directory "~/other/"
13941           :base-extension "css\\|el"
13942           :publishing-directory "/ssh:user@@host:~/html/other/"
13943           :publishing-function org-publish-attachment)
13944          ("website" :components ("orgfiles" "images" "other"))))
13945 @end lisp
13947 @node Triggering publication,  , Sample configuration, Publishing
13948 @section Triggering publication
13950 Once properly configured, Org can publish with the following commands:
13952 @table @kbd
13953 @orgcmd{C-c C-e P x,org-publish}
13954 Prompt for a specific project and publish all files that belong to it.
13955 @orgcmd{C-c C-e P p,org-publish-current-project}
13956 Publish the project containing the current file.
13957 @orgcmd{C-c C-e P f,org-publish-current-file}
13958 Publish only the current file.
13959 @orgcmd{C-c C-e P a,org-publish-all}
13960 Publish every project.
13961 @end table
13963 @vindex org-publish-use-timestamps-flag
13964 Org uses timestamps to track when a file has changed.  The above functions
13965 normally only publish changed files.  You can override this and force
13966 publishing of all files by giving a prefix argument to any of the commands
13967 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
13968 This may be necessary in particular if files include other files via
13969 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
13971 @comment  node-name,  next,  previous,  up
13972 @comment Working With Source Code, Miscellaneous, Publishing, Top
13974 @node Working With Source Code, Miscellaneous, Publishing, Top
13975 @chapter Working with source code
13976 @cindex Schulte, Eric
13977 @cindex Davison, Dan
13978 @cindex source code, working with
13980 Source code can be included in Org mode documents using a @samp{src} block,
13981 e.g.:
13983 @example
13984 #+BEGIN_SRC emacs-lisp
13985   (defun org-xor (a b)
13986      "Exclusive or."
13987      (if a (not b) b))
13988 #+END_SRC
13989 @end example
13991 Org mode provides a number of features for working with live source code,
13992 including editing of code blocks in their native major-mode, evaluation of
13993 code blocks, converting code blocks into source files (known as @dfn{tangling}
13994 in literate programming), and exporting code blocks and their
13995 results in several formats.  This functionality was contributed by Eric
13996 Schulte and Dan Davison, and was originally named Org-babel.
13998 The following sections describe Org mode's code block handling facilities.
14000 @menu
14001 * Structure of code blocks::    Code block syntax described
14002 * Editing source code::         Language major-mode editing
14003 * Exporting code blocks::       Export contents and/or results
14004 * Extracting source code::      Create pure source code files
14005 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
14006 * Library of Babel::            Use and contribute to a library of useful code blocks
14007 * Languages::                   List of supported code block languages
14008 * Header arguments::            Configure code block functionality
14009 * Results of evaluation::       How evaluation results are handled
14010 * Noweb reference syntax::      Literate programming in Org mode
14011 * Key bindings and useful functions::  Work quickly with code blocks
14012 * Batch execution::             Call functions from the command line
14013 @end menu
14015 @comment  node-name,  next,  previous,  up
14016 @comment  Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
14018 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
14019 @section Structure of code blocks
14020 @cindex code block, structure
14021 @cindex source code, block structure
14022 @cindex #+NAME
14023 @cindex #+BEGIN_SRC
14025 Live code blocks can be specified with a @samp{src} block or
14026 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
14027 @ref{Easy Templates} system}  The structure of a @samp{src} block is
14029 @example
14030 #+NAME: <name>
14031 #+BEGIN_SRC <language> <switches> <header arguments>
14032   <body>
14033 #+END_SRC
14034 @end example
14036 The @code{#+NAME:} line is optional, and can be used to name the code
14037 block.  Live code blocks require that a language be specified on the
14038 @code{#+BEGIN_SRC} line.  Switches and header arguments are optional.
14039 @cindex source code, inline
14041 Live code blocks can also be specified inline using
14043 @example
14044 src_<language>@{<body>@}
14045 @end example
14049 @example
14050 src_<language>[<header arguments>]@{<body>@}
14051 @end example
14053 @table @code
14054 @item <#+NAME: name>
14055 This line associates a name with the code block.  This is similar to the
14056 @code{#+NAME: Name} lines that can be used to name tables in Org mode
14057 files.  Referencing the name of a code block makes it possible to evaluate
14058 the block from other places in the file, from other files, or from Org mode
14059 table formulas (see @ref{The spreadsheet}).  Names are assumed to be unique
14060 and the behavior of Org mode when two or more blocks share the same name is
14061 undefined.
14062 @cindex #+NAME
14063 @item <language>
14064 The language of the code in the block (see @ref{Languages}).
14065 @cindex source code, language
14066 @item <switches>
14067 Optional switches control code block export (see the discussion of switches in
14068 @ref{Literal examples})
14069 @cindex source code, switches
14070 @item <header arguments>
14071 Optional header arguments control many aspects of evaluation, export and
14072 tangling of code blocks (see @ref{Header arguments}).
14073 Header arguments can also be set on a per-buffer or per-subtree
14074 basis using properties.
14075 @item source code, header arguments
14076 @item <body>
14077 Source code in the specified language.
14078 @end table
14080 @comment  node-name,  next,  previous,  up
14081 @comment  Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
14083 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
14084 @section Editing source code
14085 @cindex code block, editing
14086 @cindex source code, editing
14088 @vindex org-edit-src-auto-save-idle-delay
14089 @vindex org-edit-src-turn-on-auto-save
14090 @kindex C-c '
14091 Use @kbd{C-c '} to edit the current code block.  This brings up a language
14092 major-mode edit buffer containing the body of the code block.  Manually
14093 saving this buffer with @key{C-x C-s} will write the contents back to the Org
14094 buffer.  You can also set @code{org-edit-src-auto-save-idle-delay} to save the
14095 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
14096 to auto-save this buffer into a separate file using @code{auto-save-mode}.
14097 Use @kbd{C-c '} again to exit.
14099 The @code{org-src-mode} minor mode will be active in the edit buffer.  The
14100 following variables can be used to configure the behavior of the edit
14101 buffer.  See also the customization group @code{org-edit-structure} for
14102 further configuration options.
14104 @table @code
14105 @item org-src-lang-modes
14106 If an Emacs major-mode named @code{<lang>-mode} exists, where
14107 @code{<lang>} is the language named in the header line of the code block,
14108 then the edit buffer will be placed in that major-mode.  This variable
14109 can be used to map arbitrary language names to existing major modes.
14110 @item org-src-window-setup
14111 Controls the way Emacs windows are rearranged when the edit buffer is created.
14112 @item org-src-preserve-indentation
14113 By default, the value is @code{nil}, which means that when code blocks are
14114 evaluated during export or tangled, they are re-inserted into the code block,
14115 which may replace sequences of spaces with tab characters.  When non-nil,
14116 whitespace in code blocks will be preserved during export or tangling,
14117 exactly as it appears.  This variable is especially useful for tangling
14118 languages such as Python, in which whitespace indentation in the output is
14119 critical.
14120 @item org-src-ask-before-returning-to-edit-buffer
14121 By default, Org will ask before returning to an open edit buffer.  Set this
14122 variable to @code{nil} to switch without asking.
14123 @end table
14125 To turn on native code fontification in the @emph{Org} buffer, configure the
14126 variable @code{org-src-fontify-natively}.
14128 @comment  node-name,  next,  previous,  up
14129 @comment  Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
14131 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
14132 @section Exporting code blocks
14133 @cindex code block, exporting
14134 @cindex source code, exporting
14136 It is possible to export the @emph{code} of code blocks, the @emph{results}
14137 of code block evaluation, @emph{both} the code and the results of code block
14138 evaluation, or @emph{none}.  For most languages, the default exports code.
14139 However, for some languages (e.g., @code{ditaa}) the default exports the
14140 results of code block evaluation.  For information on exporting code block
14141 bodies, see @ref{Literal examples}.
14143 The @code{:exports} header argument can be used to specify export
14144 behavior:
14146 @subsubheading Header arguments:
14148 @table @code
14149 @item :exports code
14150 The default in most languages.  The body of the code block is exported, as
14151 described in @ref{Literal examples}.
14152 @item :exports results
14153 The code block will be evaluated and the results will be placed in the
14154 Org mode buffer for export, either updating previous results of the code
14155 block located anywhere in the buffer or, if no previous results exist,
14156 placing the results immediately after the code block.  The body of the code
14157 block will not be exported.
14158 @item :exports both
14159 Both the code block and its results will be exported.
14160 @item :exports none
14161 Neither the code block nor its results will be exported.
14162 @end table
14164 It is possible to inhibit the evaluation of code blocks during export.
14165 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
14166 ensure that no code blocks are evaluated as part of the export process.  This
14167 can be useful in situations where potentially untrusted Org mode files are
14168 exported in an automated fashion, for example when Org mode is used as the
14169 markup language for a wiki.  It is also possible to set this variable to
14170 @code{'inline-only}.  In that case, only inline code blocks will be
14171 evaluated, in order to insert their results.  Non-inline code blocks are
14172 assumed to have their results already inserted in the buffer by manual
14173 evaluation.  This setting is useful to avoid expensive recalculations during
14174 export, not to provide security.
14176 @comment  node-name,  next,  previous,  up
14177 @comment  Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
14178 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
14179 @section Extracting source code
14180 @cindex tangling
14181 @cindex source code, extracting
14182 @cindex code block, extracting source code
14184 Creating pure source code files by extracting code from source blocks is
14185 referred to as ``tangling''---a term adopted from the literate programming
14186 community.  During ``tangling'' of code blocks their bodies are expanded
14187 using @code{org-babel-expand-src-block} which can expand both variable and
14188 ``noweb'' style references  (see @ref{Noweb reference syntax}).
14190 @subsubheading Header arguments
14192 @table @code
14193 @item :tangle no
14194 The default.  The code block is not included in the tangled output.
14195 @item :tangle yes
14196 Include the code block in the tangled output.  The output file name is the
14197 name of the org file with the extension @samp{.org} replaced by the extension
14198 for the block language.
14199 @item :tangle filename
14200 Include the code block in the tangled output to file @samp{filename}.
14201 @end table
14203 @kindex  C-c C-v t
14204 @subsubheading Functions
14206 @table @code
14207 @item org-babel-tangle
14208 Tangle the current file.  Bound to @kbd{C-c C-v t}.
14210 With prefix argument only tangle the current code block.
14211 @item org-babel-tangle-file
14212 Choose a file to tangle.  Bound to @kbd{C-c C-v f}.
14213 @end table
14215 @subsubheading Hooks
14217 @table @code
14218 @item org-babel-post-tangle-hook
14219 This hook is run from within code files tangled by @code{org-babel-tangle}.
14220 Example applications could include post-processing, compilation or evaluation
14221 of tangled code files.
14222 @end table
14224 @subsubheading Jumping between code and Org
14226 When tangling code from an Org-mode buffer to a source code file, you'll
14227 frequently find yourself viewing the file of tangled source code (e.g., many
14228 debuggers point to lines of the source code file).  It is useful to be able
14229 to navigate from the tangled source to the Org-mode buffer from which the
14230 code originated.
14232 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
14233 code to Org-mode functionality.  Two header arguments are required for
14234 jumping to work, first the @code{padline} (@ref{padline}) option must be set
14235 to true (the default setting), second the @code{comments} (@ref{comments})
14236 header argument must be set to @code{links}, which will insert comments into
14237 the source code buffer which point back to the original Org-mode file.
14239 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
14240 @section Evaluating code blocks
14241 @cindex code block, evaluating
14242 @cindex source code, evaluating
14243 @cindex #+RESULTS
14245 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
14246 potential for that code to do harm.  Org mode provides safeguards to ensure
14247 that code is only evaluated after explicit confirmation from the user.  For
14248 information on these safeguards (and on how to disable them) see @ref{Code
14249 evaluation security}.} and the results of evaluation optionally placed in the
14250 Org mode buffer.  The results of evaluation are placed following a line that
14251 begins by default with @code{#+RESULTS} and optionally a cache identifier
14252 and/or the name of the evaluated code block.  The default value of
14253 @code{#+RESULTS} can be changed with the customizable variable
14254 @code{org-babel-results-keyword}.
14256 By default, the evaluation facility is only enabled for Lisp code blocks
14257 specified as @code{emacs-lisp}.  However, source code blocks in many languages
14258 can be evaluated within Org mode (see @ref{Languages} for a list of supported
14259 languages and @ref{Structure of code blocks} for information on the syntax
14260 used to define a code block).
14262 @kindex C-c C-c
14263 There are a number of ways to evaluate code blocks.  The simplest is to press
14264 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
14265 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
14266 evaluation from the @kbd{C-c C-c} key binding.}.  This will call the
14267 @code{org-babel-execute-src-block} function to evaluate the block and insert
14268 its results into the Org mode buffer.
14269 @cindex #+CALL
14271 It is also possible to evaluate named code blocks from anywhere in an Org
14272 mode buffer or an Org mode table.  Live code blocks located in the current
14273 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
14274 can be executed.  Named code blocks can be executed with a separate
14275 @code{#+CALL:} line or inline within a block of text.
14277 The syntax of the @code{#+CALL:} line is
14279 @example
14280 #+CALL: <name>(<arguments>)
14281 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
14282 @end example
14284 The syntax for inline evaluation of named code blocks is
14286 @example
14287 ... call_<name>(<arguments>) ...
14288 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
14289 @end example
14291 @table @code
14292 @item <name>
14293 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
14294 @item <arguments>
14295 Arguments specified in this section will be passed to the code block.  These
14296 arguments use standard function call syntax, rather than
14297 header argument syntax.  For example, a @code{#+CALL:} line that passes the
14298 number four to a code block named @code{double}, which declares the header
14299 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
14300 @item <inside header arguments>
14301 Inside header arguments are passed through and applied to the named code
14302 block.  These arguments use header argument syntax rather than standard
14303 function call syntax.  Inside header arguments affect how the code block is
14304 evaluated.  For example, @code{[:results output]} will collect the results of
14305 everything printed to @code{STDOUT} during execution of the code block.
14306 @item <end header arguments>
14307 End header arguments are applied to the calling instance and do not affect
14308 evaluation of the named code block.  They affect how the results are
14309 incorporated into the Org mode buffer and how the call line is exported.  For
14310 example, @code{:results html} will insert the results of the call line
14311 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
14313 For more examples of passing header arguments to @code{#+CALL:} lines see
14314 @ref{Header arguments in function calls}.
14315 @end table
14317 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
14318 @section Library of Babel
14319 @cindex babel, library of
14320 @cindex source code, library
14321 @cindex code block, library
14323 The ``Library of Babel'' consists of code blocks that can be called from any
14324 Org mode file.  Code blocks defined in the ``Library of Babel'' can be called
14325 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
14326 code blocks} for information on the syntax of remote code block evaluation).
14329 The central repository of code blocks in the ``Library of Babel'' is housed
14330 in an Org mode file located in the @samp{contrib} directory of Org mode.
14332 Users can add code blocks they believe to be generally useful to their
14333 ``Library of Babel.''  The code blocks can be stored in any Org mode file and
14334 then loaded into the library with @code{org-babel-lob-ingest}.
14337 @kindex C-c C-v i
14338 Code blocks located in any Org mode file can be loaded into the ``Library of
14339 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
14342 @node Languages, Header arguments, Library of Babel, Working With Source Code
14343 @section Languages
14344 @cindex babel, languages
14345 @cindex source code, languages
14346 @cindex code block, languages
14348 Code blocks in the following languages are supported.
14350 @multitable @columnfractions 0.28 0.3 0.22 0.2
14351 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
14352 @item Asymptote @tab asymptote @tab Awk @tab awk
14353 @item Emacs Calc @tab calc @tab C @tab C
14354 @item C++ @tab C++ @tab Clojure @tab clojure
14355 @item CSS @tab css @tab ditaa @tab ditaa
14356 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
14357 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
14358 @item Java @tab java @tab @tab
14359 @item Javascript @tab js @tab LaTeX @tab latex
14360 @item Ledger @tab ledger @tab Lisp @tab lisp
14361 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
14362 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
14363 @item Octave @tab octave @tab Org mode @tab org
14364 @item Oz @tab oz @tab Perl @tab perl
14365 @item Plantuml @tab plantuml @tab Python @tab python
14366 @item R @tab R @tab Ruby @tab ruby
14367 @item Sass @tab sass @tab Scheme @tab scheme
14368 @item GNU Screen @tab screen @tab shell @tab sh
14369 @item SQL @tab sql @tab SQLite @tab sqlite
14370 @end multitable
14372 Language-specific documentation is available for some languages.  If
14373 available, it can be found at
14374 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
14376 The option @code{org-babel-load-languages} controls which languages are
14377 enabled for evaluation (by default only @code{emacs-lisp} is enabled).  This
14378 variable can be set using the customization interface or by adding code like
14379 the following to your emacs configuration.
14381 @quotation
14382 The following disables @code{emacs-lisp} evaluation and enables evaluation of
14383 @code{R} code blocks.
14384 @end quotation
14386 @lisp
14387 (org-babel-do-load-languages
14388  'org-babel-load-languages
14389  '((emacs-lisp . nil)
14390    (R . t)))
14391 @end lisp
14393 It is also possible to enable support for a language by loading the related
14394 elisp file with @code{require}.
14396 @quotation
14397 The following adds support for evaluating @code{clojure} code blocks.
14398 @end quotation
14400 @lisp
14401 (require 'ob-clojure)
14402 @end lisp
14404 @node Header arguments, Results of evaluation, Languages, Working With Source Code
14405 @section Header arguments
14406 @cindex code block, header arguments
14407 @cindex source code, block header arguments
14409 Code block functionality can be configured with header arguments.  This
14410 section provides an overview of the use of header arguments, and then
14411 describes each header argument in detail.
14413 @menu
14414 * Using header arguments::      Different ways to set header arguments
14415 * Specific header arguments::   List of header arguments
14416 @end menu
14418 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
14419 @subsection Using header arguments
14421 The values of header arguments can be set in several way.  When the header
14422 arguments in each layer have been determined, they are combined in order from
14423 the first, least specific (having the lowest priority) up to the last, most
14424 specific (having the highest priority).  A header argument with a higher
14425 priority replaces the same header argument specified at lower priority.
14426 @menu
14427 * System-wide header arguments::  Set global default values
14428 * Language-specific header arguments::  Set default values by language
14429 * Header arguments in Org mode properties::  Set default values for a buffer or heading
14430 * Language-specific header arguments in Org mode properties::  Set language-specific default values for a buffer or heading
14431 * Code block specific header arguments::  The most common way to set values
14432 * Header arguments in function calls::  The most specific level
14433 @end menu
14436 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
14437 @subsubheading System-wide header arguments
14438 @vindex org-babel-default-header-args
14439 System-wide values of header arguments can be specified by adapting the
14440 @code{org-babel-default-header-args} variable:
14442 @example
14443 :session    => "none"
14444 :results    => "replace"
14445 :exports    => "code"
14446 :cache      => "no"
14447 :noweb      => "no"
14448 @end example
14450 For example, the following example could be used to set the default value of
14451 @code{:noweb} header arguments to @code{yes}.  This would have the effect of
14452 expanding @code{:noweb} references by default when evaluating source code
14453 blocks.
14455 @lisp
14456 (setq org-babel-default-header-args
14457       (cons '(:noweb . "yes")
14458             (assq-delete-all :noweb org-babel-default-header-args)))
14459 @end lisp
14461 @node Language-specific header arguments, Header arguments in Org mode properties, System-wide header arguments, Using header arguments
14462 @subsubheading Language-specific header arguments
14463 Each language can define its own set of default header arguments in variable
14464 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
14465 of the language.  See the language-specific documentation available online at
14466 @uref{http://orgmode.org/worg/org-contrib/babel}.
14468 @node Header arguments in Org mode properties, Language-specific header arguments in Org mode properties, Language-specific header arguments, Using header arguments
14469 @subsubheading Header arguments in Org mode properties
14471 Buffer-wide header arguments may be specified as properties through the use
14472 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
14473 @ref{Property syntax}).
14475 For example the following would set @code{session} to @code{*R*} (only for R
14476 code blocks), and @code{results} to @code{silent} for every code block in the
14477 buffer, ensuring that all execution took place in the same session, and no
14478 results would be inserted into the buffer.
14480 @example
14481 #+PROPERTY: header-args:R  :session *R*
14482 #+PROPERTY: header-args    :results silent
14483 @end example
14485 Header arguments read from Org mode properties can also be set on a
14486 per-subtree basis using property drawers (see @ref{Property syntax}).
14487 @vindex org-use-property-inheritance
14488 When properties are used to set default header arguments, they are always
14489 looked up with inheritance, regardless of the value of
14490 @code{org-use-property-inheritance}.  Properties are evaluated as seen by the
14491 outermost call or source block.@footnote{The deprecated syntax for default
14492 header argument properties, using the name of the header argument as a
14493 property name directly, evaluates the property as seen by the corresponding
14494 source block definition.  This behavior has been kept for backwards
14495 compatibility.}
14497 In the following example the value of
14498 the @code{:cache} header argument will default to @code{yes} in all code
14499 blocks in the subtree rooted at the following heading:
14501 @example
14502 * outline header
14503   :PROPERTIES:
14504   :header-args:    :cache yes
14505   :END:
14506 @end example
14508 @kindex C-c C-x p
14509 @vindex org-babel-default-header-args
14510 Properties defined in this way override the properties set in
14511 @code{org-babel-default-header-args} and are applied for all activated
14512 languages.  It is convenient to use the @code{org-set-property} function
14513 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
14515 @node Language-specific header arguments in Org mode properties, Code block specific header arguments, Header arguments in Org mode properties, Using header arguments
14516 @subsubheading Language-specific header arguments in Org mode properties
14518 Language-specific header arguments are also read from properties
14519 @code{header-args:<lang>} where @code{<lang>} is the name of the language
14520 targeted.  As an example
14522 @example
14523 * Heading
14524   :PROPERTIES:
14525   :header-args:clojure:    :session *clojure-1*
14526   :header-args:R:          :session *R*
14527   :END:
14528 ** Subheading
14529   :PROPERTIES:
14530   :header-args:clojure:    :session *clojure-2*
14531   :END:
14532 @end example
14534 would independently set a default session header argument for R and clojure
14535 for calls and source blocks under subtree ``Heading'' and change to a
14536 different clojure setting for evaluations under subtree ``Subheading'', while
14537 the R session is inherited from ``Heading'' and therefore unchanged.
14539 @node Code block specific header arguments, Header arguments in function calls, Language-specific header arguments in Org mode properties, Using header arguments
14540 @subsubheading Code block specific header arguments
14542 The most common way to assign values to header arguments is at the
14543 code block level.  This can be done by listing a sequence of header
14544 arguments and their values as part of the @code{#+BEGIN_SRC} line.
14545 Properties set in this way override both the values of
14546 @code{org-babel-default-header-args} and header arguments specified as
14547 properties.  In the following example, the @code{:results} header argument
14548 is set to @code{silent}, meaning the results of execution will not be
14549 inserted in the buffer, and the @code{:exports} header argument is set to
14550 @code{code}, meaning only the body of the code block will be
14551 preserved on export to HTML or @LaTeX{}.
14553 @example
14554 #+NAME: factorial
14555 #+BEGIN_SRC haskell :results silent :exports code :var n=0
14556 fac 0 = 1
14557 fac n = n * fac (n-1)
14558 #+END_SRC
14559 @end example
14560 Similarly, it is possible to set header arguments for inline code blocks
14562 @example
14563 src_haskell[:exports both]@{fac 5@}
14564 @end example
14566 Code block header arguments can span multiple lines using @code{#+HEADER:} or
14567 @code{#+HEADERS:} lines preceding a code block or nested between the
14568 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
14569 @cindex #+HEADER:
14570 @cindex #+HEADERS:
14572 Multi-line header arguments on an un-named code block:
14574 @example
14575  #+HEADERS: :var data1=1
14576  #+BEGIN_SRC emacs-lisp :var data2=2
14577    (message "data1:%S, data2:%S" data1 data2)
14578  #+END_SRC
14580  #+RESULTS:
14581  : data1:1, data2:2
14582 @end example
14584 Multi-line header arguments on a named code block:
14586 @example
14587    #+NAME: named-block
14588    #+HEADER: :var data=2
14589    #+BEGIN_SRC emacs-lisp
14590      (message "data:%S" data)
14591    #+END_SRC
14593    #+RESULTS: named-block
14594    : data:2
14595 @end example
14597 @node Header arguments in function calls,  , Code block specific header arguments, Using header arguments
14598 @comment  node-name,  next,  previous,  up
14599 @subsubheading Header arguments in function calls
14601 At the most specific level, header arguments for ``Library of Babel'' or
14602 @code{#+CALL:} lines can be set as shown in the two examples below.  For more
14603 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
14604 blocks}.
14606 The following will apply the @code{:exports results} header argument to the
14607 evaluation of the @code{#+CALL:} line.
14609 @example
14610 #+CALL: factorial(n=5) :exports results
14611 @end example
14613 The following will apply the @code{:session special} header argument to the
14614 evaluation of the @code{factorial} code block.
14616 @example
14617 #+CALL: factorial[:session special](n=5)
14618 @end example
14620 @node Specific header arguments,  , Using header arguments, Header arguments
14621 @subsection Specific header arguments
14622 Header arguments consist of an initial colon followed by the name of the
14623 argument in lowercase letters.  The following header arguments are defined:
14625 @menu
14626 * var::                         Pass arguments to code blocks
14627 * results::                     Specify the type of results and how they will
14628                                 be collected and handled
14629 * file::                        Specify a path for file output
14630 * file-desc::                   Specify a description for file results
14631 * dir::                         Specify the default (possibly remote)
14632                                 directory for code block execution
14633 * exports::                     Export code and/or results
14634 * tangle::                      Toggle tangling and specify file name
14635 * mkdirp::                      Toggle creation of parent directories of target
14636                                 files during tangling
14637 * comments::                    Toggle insertion of comments in tangled
14638                                 code files
14639 * padline::                     Control insertion of padding lines in tangled
14640                                 code files
14641 * no-expand::                   Turn off variable assignment and noweb
14642                                 expansion during tangling
14643 * session::                     Preserve the state of code evaluation
14644 * noweb::                       Toggle expansion of noweb references
14645 * noweb-ref::                   Specify block's noweb reference resolution target
14646 * noweb-sep::                   String used to separate noweb references
14647 * cache::                       Avoid re-evaluating unchanged code blocks
14648 * sep::                         Delimiter for writing tabular results outside Org
14649 * hlines::                      Handle horizontal lines in tables
14650 * colnames::                    Handle column names in tables
14651 * rownames::                    Handle row names in tables
14652 * shebang::                     Make tangled files executable
14653 * tangle-mode::                 Set permission of tangled files
14654 * eval::                        Limit evaluation of specific code blocks
14655 * wrap::                        Mark source block evaluation results
14656 * post::                        Post processing of code block results
14657 * prologue::                    Text to prepend to code block body
14658 * epilogue::                    Text to append to code block body
14659 @end menu
14661 Additional header arguments are defined on a language-specific basis, see
14662 @ref{Languages}.
14664 @node var, results, Specific header arguments, Specific header arguments
14665 @subsubsection @code{:var}
14666 The @code{:var} header argument is used to pass arguments to code blocks.
14667 The specifics of how arguments are included in a code block vary by language;
14668 these are addressed in the language-specific documentation.  However, the
14669 syntax used to specify arguments is the same across all languages.  In every
14670 case, variables require a default value when they are declared.
14672 The values passed to arguments can either be literal values, references, or
14673 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
14674 References include anything in the Org mode file that takes a @code{#+NAME:}
14675 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
14676 other code blocks and the results of other code blocks.
14678 Note: When a reference is made to another code block, the referenced block
14679 will be evaluated unless it has current cached results (see @ref{cache}).
14681 Argument values can be indexed in a manner similar to arrays (see @ref{var,
14682 Indexable variable values}).
14684 The following syntax is used to pass arguments to code blocks using the
14685 @code{:var} header argument.
14687 @example
14688 :var name=assign
14689 @end example
14691 The argument, @code{assign}, can either be a literal value, such as a string
14692 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
14693 literal example, another code block (with or without arguments), or the
14694 results of evaluating another code block.
14696 Here are examples of passing values by reference:
14698 @table @dfn
14700 @item table
14701 an Org mode table named with either a @code{#+NAME:} line
14703 @example
14704 #+NAME: example-table
14705 | 1 |
14706 | 2 |
14707 | 3 |
14708 | 4 |
14710 #+NAME: table-length
14711 #+BEGIN_SRC emacs-lisp :var table=example-table
14712 (length table)
14713 #+END_SRC
14715 #+RESULTS: table-length
14716 : 4
14717 @end example
14719 @item list
14720 a simple list named with a @code{#+NAME:} line (note that nesting is not
14721 carried through to the source code block)
14723 @example
14724 #+NAME: example-list
14725   - simple
14726     - not
14727     - nested
14728   - list
14730 #+BEGIN_SRC emacs-lisp :var x=example-list
14731   (print x)
14732 #+END_SRC
14734 #+RESULTS:
14735 | simple | list |
14736 @end example
14738 @item code block without arguments
14739 a code block name (from the example above), as assigned by @code{#+NAME:},
14740 optionally followed by parentheses
14742 @example
14743 #+BEGIN_SRC emacs-lisp :var length=table-length()
14744 (* 2 length)
14745 #+END_SRC
14747 #+RESULTS:
14748 : 8
14749 @end example
14751 @item code block with arguments
14752 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
14753 optional arguments passed within the parentheses following the
14754 code block name using standard function call syntax
14756 @example
14757 #+NAME: double
14758 #+BEGIN_SRC emacs-lisp :var input=8
14759 (* 2 input)
14760 #+END_SRC
14762 #+RESULTS: double
14763 : 16
14765 #+NAME: squared
14766 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
14767 (* input input)
14768 #+END_SRC
14770 #+RESULTS: squared
14771 : 4
14772 @end example
14774 @item literal example
14775 a literal example block named with a @code{#+NAME:} line
14777 @example
14778 #+NAME: literal-example
14779 #+BEGIN_EXAMPLE
14780 A literal example
14781 on two lines
14782 #+END_EXAMPLE
14784 #+NAME: read-literal-example
14785 #+BEGIN_SRC emacs-lisp :var x=literal-example
14786   (concatenate 'string x " for you.")
14787 #+END_SRC
14789 #+RESULTS: read-literal-example
14790 : A literal example
14791 : on two lines for you.
14793 @end example
14795 @end table
14797 @subsubheading Indexable variable values
14798 It is possible to reference portions of variable values by ``indexing'' into
14799 the variables.  Indexes are 0 based with negative values counting back from
14800 the end.  If an index is separated by @code{,}s then each subsequent section
14801 will index into the next deepest nesting or dimension of the value.  Note
14802 that this indexing occurs @emph{before} other table related header arguments
14803 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied.  The
14804 following example assigns the last cell of the first row the table
14805 @code{example-table} to the variable @code{data}:
14807 @example
14808 #+NAME: example-table
14809 | 1 | a |
14810 | 2 | b |
14811 | 3 | c |
14812 | 4 | d |
14814 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
14815   data
14816 #+END_SRC
14818 #+RESULTS:
14819 : a
14820 @end example
14822 Ranges of variable values can be referenced using two integers separated by a
14823 @code{:}, in which case the entire inclusive range is referenced.  For
14824 example the following assigns the middle three rows of @code{example-table}
14825 to @code{data}.
14827 @example
14828 #+NAME: example-table
14829 | 1 | a |
14830 | 2 | b |
14831 | 3 | c |
14832 | 4 | d |
14833 | 5 | 3 |
14835 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
14836   data
14837 #+END_SRC
14839 #+RESULTS:
14840 | 2 | b |
14841 | 3 | c |
14842 | 4 | d |
14843 @end example
14845 Additionally, an empty index, or the single character @code{*}, are both
14846 interpreted to mean the entire range and as such are equivalent to
14847 @code{0:-1}, as shown in the following example in which the entire first
14848 column is referenced.
14850 @example
14851 #+NAME: example-table
14852 | 1 | a |
14853 | 2 | b |
14854 | 3 | c |
14855 | 4 | d |
14857 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
14858   data
14859 #+END_SRC
14861 #+RESULTS:
14862 | 1 | 2 | 3 | 4 |
14863 @end example
14865 It is possible to index into the results of code blocks as well as tables.
14866 Any number of dimensions can be indexed.  Dimensions are separated from one
14867 another by commas, as shown in the following example.
14869 @example
14870 #+NAME: 3D
14871 #+BEGIN_SRC emacs-lisp
14872   '(((1  2  3)  (4  5  6)  (7  8  9))
14873     ((10 11 12) (13 14 15) (16 17 18))
14874     ((19 20 21) (22 23 24) (25 26 27)))
14875 #+END_SRC
14877 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
14878   data
14879 #+END_SRC
14881 #+RESULTS:
14882 | 11 | 14 | 17 |
14883 @end example
14885 @subsubheading Emacs Lisp evaluation of variables
14887 Emacs lisp code can be used to initialize variable values.  When a variable
14888 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
14889 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
14890 the variable value.  The following example demonstrates use of this
14891 evaluation to reliably pass the file-name of the Org mode buffer to a code
14892 block---note that evaluation of header arguments is guaranteed to take place
14893 in the original Org mode file, while there is no such guarantee for
14894 evaluation of the code block body.
14896 @example
14897 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
14898   wc -w $filename
14899 #+END_SRC
14900 @end example
14902 Note that values read from tables and lists will not be evaluated as
14903 Emacs Lisp, as shown in the following example.
14905 @example
14906 #+NAME: table
14907 | (a b c) |
14909 #+HEADERS: :var data=table[0,0]
14910 #+BEGIN_SRC perl
14911   $data
14912 #+END_SRC
14914 #+RESULTS:
14915 : (a b c)
14916 @end example
14918 @node results, file, var, Specific header arguments
14919 @subsubsection @code{:results}
14921 There are four classes of @code{:results} header argument.  Only one option
14922 per class may be supplied per code block.
14924 @itemize @bullet
14925 @item
14926 @b{collection} header arguments specify how the results should be collected
14927 from the code block
14928 @item
14929 @b{type} header arguments specify what type of result the code block will
14930 return---which has implications for how they will be processed before
14931 insertion into the Org mode buffer
14932 @item
14933 @b{format} header arguments specify what type of result the code block will
14934 return---which has implications for how they will be inserted into the
14935 Org mode buffer
14936 @item
14937 @b{handling} header arguments specify how the results of evaluating the code
14938 block should be handled.
14939 @end itemize
14941 @subsubheading Collection
14942 The following options are mutually exclusive, and specify how the results
14943 should be collected from the code block.
14945 @itemize @bullet
14946 @item @code{value}
14947 This is the default.  The result is the value of the last statement in the
14948 code block.  This header argument places the evaluation in functional
14949 mode.  Note that in some languages, e.g., Python, use of this result type
14950 requires that a @code{return} statement be included in the body of the source
14951 code block.  E.g., @code{:results value}.
14952 @item @code{output}
14953 The result is the collection of everything printed to STDOUT during the
14954 execution of the code block.  This header argument places the
14955 evaluation in scripting mode.  E.g., @code{:results output}.
14956 @end itemize
14958 @subsubheading Type
14960 The following options are mutually exclusive and specify what type of results
14961 the code block will return.  By default, results are inserted as either a
14962 table or scalar depending on their value.
14964 @itemize @bullet
14965 @item @code{table}, @code{vector}
14966 The results should be interpreted as an Org mode table.  If a single value is
14967 returned, it will be converted into a table with one row and one column.
14968 E.g., @code{:results value table}.
14969 @item @code{list}
14970 The results should be interpreted as an Org mode list.  If a single scalar
14971 value is returned it will be converted into a list with only one element.
14972 @item @code{scalar}, @code{verbatim}
14973 The results should be interpreted literally---they will not be
14974 converted into a table.  The results will be inserted into the Org mode
14975 buffer as quoted text.  E.g., @code{:results value verbatim}.
14976 @item @code{file}
14977 The results will be interpreted as the path to a file, and will be inserted
14978 into the Org mode buffer as a file link.  E.g., @code{:results value file}.
14979 @end itemize
14981 @subsubheading Format
14983 The following options are mutually exclusive and specify what type of results
14984 the code block will return.  By default, results are inserted according to the
14985 type as specified above.
14987 @itemize @bullet
14988 @item @code{raw}
14989 The results are interpreted as raw Org mode code and are inserted directly
14990 into the buffer.  If the results look like a table they will be aligned as
14991 such by Org mode.  E.g., @code{:results value raw}.
14992 @item @code{org}
14993 The results are will be enclosed in a @code{BEGIN_SRC org} block.
14994 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
14995 in the block and/or if you export the file.  E.g., @code{:results value org}.
14996 @item @code{html}
14997 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
14998 block.  E.g., @code{:results value html}.
14999 @item @code{latex}
15000 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
15001 E.g., @code{:results value latex}.
15002 @item @code{code}
15003 Result are assumed to be parsable code and are enclosed in a code block.
15004 E.g., @code{:results value code}.
15005 @item @code{pp}
15006 The result is converted to pretty-printed code and is enclosed in a code
15007 block.  This option currently supports Emacs Lisp, Python, and Ruby.  E.g.,
15008 @code{:results value pp}.
15009 @item @code{drawer}
15010 The result is wrapped in a RESULTS drawer.  This can be useful for
15011 inserting @code{raw} or @code{org} syntax results in such a way that their
15012 extent is known and they can be automatically removed or replaced.
15013 @end itemize
15015 @subsubheading Handling
15016 The following results options indicate what happens with the
15017 results once they are collected.
15019 @itemize @bullet
15020 @item @code{silent}
15021 The results will be echoed in the minibuffer but will not be inserted into
15022 the Org mode buffer.  E.g., @code{:results output silent}.
15023 @item @code{replace}
15024 The default value.  Any existing results will be removed, and the new results
15025 will be inserted into the Org mode buffer in their place.  E.g.,
15026 @code{:results output replace}.
15027 @item @code{append}
15028 If there are pre-existing results of the code block then the new results will
15029 be appended to the existing results.  Otherwise the new results will be
15030 inserted as with @code{replace}.
15031 @item @code{prepend}
15032 If there are pre-existing results of the code block then the new results will
15033 be prepended to the existing results.  Otherwise the new results will be
15034 inserted as with @code{replace}.
15035 @end itemize
15037 @node file, file-desc, results, Specific header arguments
15038 @subsubsection @code{:file}
15040 The header argument @code{:file} is used to specify an external file in which
15041 to save code block results.  After code block evaluation an Org mode style
15042 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
15043 into the Org mode buffer.  Some languages including R, gnuplot, dot, and
15044 ditaa provide special handling of the @code{:file} header argument
15045 automatically wrapping the code block body in the boilerplate code required
15046 to save output to the specified file.  This is often useful for saving
15047 graphical output of a code block to the specified file.
15049 The argument to @code{:file} should be either a string specifying the path to
15050 a file, or a list of two strings in which case the first element of the list
15051 should be the path to a file and the second a description for the link.
15053 @node file-desc, dir, file, Specific header arguments
15054 @subsubsection @code{:file-desc}
15056 The value of the @code{:file-desc} header argument is used to provide a
15057 description for file code block results which are inserted as Org mode links
15058 (see @ref{Link format}).  If the @code{:file-desc} header argument is given
15059 with no value the link path will be placed in both the ``link'' and the
15060 ``description'' portion of the Org mode link.
15062 @node dir, exports, file-desc, Specific header arguments
15063 @subsubsection @code{:dir} and remote execution
15065 While the @code{:file} header argument can be used to specify the path to the
15066 output file, @code{:dir} specifies the default directory during code block
15067 execution.  If it is absent, then the directory associated with the current
15068 buffer is used.  In other words, supplying @code{:dir path} temporarily has
15069 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
15070 then not supplying @code{:dir}.  Under the surface, @code{:dir} simply sets
15071 the value of the Emacs variable @code{default-directory}.
15073 When using @code{:dir}, you should supply a relative path for file output
15074 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
15075 case that path will be interpreted relative to the default directory.
15077 In other words, if you want your plot to go into a folder called @file{Work}
15078 in your home directory, you could use
15080 @example
15081 #+BEGIN_SRC R :file myplot.png :dir ~/Work
15082 matplot(matrix(rnorm(100), 10), type="l")
15083 #+END_SRC
15084 @end example
15086 @subsubheading Remote execution
15087 A directory on a remote machine can be specified using tramp file syntax, in
15088 which case the code will be evaluated on the remote machine.  An example is
15090 @example
15091 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
15092 plot(1:10, main=system("hostname", intern=TRUE))
15093 #+END_SRC
15094 @end example
15096 Text results will be returned to the local Org mode buffer as usual, and file
15097 output will be created on the remote machine with relative paths interpreted
15098 relative to the remote directory.  An Org mode link to the remote file will be
15099 created.
15101 So, in the above example a plot will be created on the remote machine,
15102 and a link of the following form will be inserted in the org buffer:
15104 @example
15105 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
15106 @end example
15108 Most of this functionality follows immediately from the fact that @code{:dir}
15109 sets the value of the Emacs variable @code{default-directory}, thanks to
15110 tramp.  Those using XEmacs, or GNU Emacs prior to version 23 may need to
15111 install tramp separately in order for these features to work correctly.
15113 @subsubheading Further points
15115 @itemize @bullet
15116 @item
15117 If @code{:dir} is used in conjunction with @code{:session}, although it will
15118 determine the starting directory for a new session as expected, no attempt is
15119 currently made to alter the directory associated with an existing session.
15120 @item
15121 @code{:dir} should typically not be used to create files during export with
15122 @code{:exports results} or @code{:exports both}.  The reason is that, in order
15123 to retain portability of exported material between machines, during export
15124 links inserted into the buffer will @emph{not} be expanded against @code{default
15125 directory}.  Therefore, if @code{default-directory} is altered using
15126 @code{:dir}, it is probable that the file will be created in a location to
15127 which the link does not point.
15128 @end itemize
15130 @node exports, tangle, dir, Specific header arguments
15131 @subsubsection @code{:exports}
15133 The @code{:exports} header argument specifies what should be included in HTML
15134 or @LaTeX{} exports of the Org mode file.
15136 @itemize @bullet
15137 @item @code{code}
15138 The default.  The body of code is included into the exported file.  E.g.,
15139 @code{:exports code}.
15140 @item @code{results}
15141 The result of evaluating the code is included in the exported file.  E.g.,
15142 @code{:exports results}.
15143 @item @code{both}
15144 Both the code and results are included in the exported file.  E.g.,
15145 @code{:exports both}.
15146 @item @code{none}
15147 Nothing is included in the exported file.  E.g., @code{:exports none}.
15148 @end itemize
15150 @node tangle, mkdirp, exports, Specific header arguments
15151 @subsubsection @code{:tangle}
15153 The @code{:tangle} header argument specifies whether or not the code
15154 block should be included in tangled extraction of source code files.
15156 @itemize @bullet
15157 @item @code{tangle}
15158 The code block is exported to a source code file named after the full path
15159 (including the directory) and file name (w/o extension) of the Org mode file.
15160 E.g., @code{:tangle yes}.
15161 @item @code{no}
15162 The default.  The code block is not exported to a source code file.
15163 E.g., @code{:tangle no}.
15164 @item other
15165 Any other string passed to the @code{:tangle} header argument is interpreted
15166 as a path (directory and file name relative to the directory of the Org mode
15167 file) to which the block will be exported.  E.g., @code{:tangle path}.
15168 @end itemize
15170 @node mkdirp, comments, tangle, Specific header arguments
15171 @subsubsection @code{:mkdirp}
15173 The @code{:mkdirp} header argument can be used to create parent directories
15174 of tangled files when missing.  This can be set to @code{yes} to enable
15175 directory creation or to @code{no} to inhibit directory creation.
15177 @node comments, padline, mkdirp, Specific header arguments
15178 @subsubsection @code{:comments}
15179 By default code blocks are tangled to source-code files without any insertion
15180 of comments beyond those which may already exist in the body of the code
15181 block.  The @code{:comments} header argument can be set as follows to control
15182 the insertion of extra comments into the tangled code file.
15184 @itemize @bullet
15185 @item @code{no}
15186 The default.  No extra comments are inserted during tangling.
15187 @item @code{link}
15188 The code block is wrapped in comments which contain pointers back to the
15189 original Org file from which the code was tangled.
15190 @item @code{yes}
15191 A synonym for ``link'' to maintain backwards compatibility.
15192 @item @code{org}
15193 Include text from the Org mode file as a comment.
15194 The text is picked from the leading context of the tangled code and is
15195 limited by the nearest headline or source block as the case may be.
15196 @item @code{both}
15197 Turns on both the ``link'' and ``org'' comment options.
15198 @item @code{noweb}
15199 Turns on the ``link'' comment option, and additionally wraps expanded noweb
15200 references in the code block body in link comments.
15201 @end itemize
15203 @node padline, no-expand, comments, Specific header arguments
15204 @subsubsection @code{:padline}
15205 Control in insertion of padding lines around code block bodies in tangled
15206 code files.  The default value is @code{yes} which results in insertion of
15207 newlines before and after each tangled code block.  The following arguments
15208 are accepted.
15210 @itemize @bullet
15211 @item @code{yes}
15212 Insert newlines before and after each code block body in tangled code files.
15213 @item @code{no}
15214 Do not insert any newline padding in tangled output.
15215 @end itemize
15217 @node no-expand, session, padline, Specific header arguments
15218 @subsubsection @code{:no-expand}
15220 By default, code blocks are expanded with @code{org-babel-expand-src-block}
15221 during tangling.  This has the effect of assigning values to variables
15222 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
15223 references (see @ref{Noweb reference syntax}) with their targets.  The
15224 @code{:no-expand} header argument can be used to turn off this behavior.
15226 @node session, noweb, no-expand, Specific header arguments
15227 @subsubsection @code{:session}
15229 The @code{:session} header argument starts a session for an interpreted
15230 language where state is preserved.
15232 By default, a session is not started.
15234 A string passed to the @code{:session} header argument will give the session
15235 a name.  This makes it possible to run concurrent sessions for each
15236 interpreted language.
15238 @node noweb, noweb-ref, session, Specific header arguments
15239 @subsubsection @code{:noweb}
15241 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
15242 references (see @ref{Noweb reference syntax}) when the code block is
15243 evaluated, tangled, or exported.  The @code{:noweb} header argument can have
15244 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
15245 @code{no-export} @code{strip-export}.
15247 @itemize @bullet
15248 @item @code{no}
15249 The default.  ``Noweb'' syntax references in the body of the code block will
15250 not be expanded before the code block is evaluated, tangled or exported.
15251 @item @code{yes}
15252 ``Noweb'' syntax references in the body of the code block will be
15253 expanded before the code block is evaluated, tangled or exported.
15254 @item @code{tangle}
15255 ``Noweb'' syntax references in the body of the code block will be expanded
15256 before the code block is tangled.  However, ``noweb'' syntax references will
15257 not be expanded when the code block is evaluated or exported.
15258 @item @code{no-export}
15259 ``Noweb'' syntax references in the body of the code block will be expanded
15260 before the block is evaluated or tangled.  However, ``noweb'' syntax
15261 references will not be expanded when the code block is exported.
15262 @item @code{strip-export}
15263 ``Noweb'' syntax references in the body of the code block will be expanded
15264 before the block is evaluated or tangled.  However, ``noweb'' syntax
15265 references will be removed when the code block is exported.
15266 @item @code{eval}
15267 ``Noweb'' syntax references in the body of the code block will only be
15268 expanded before the block is evaluated.
15269 @end itemize
15271 @subsubheading Noweb prefix lines
15272 Noweb insertions are now placed behind the line prefix of the
15273 @code{<<reference>>}.
15274 This behavior is illustrated in the following example.  Because the
15275 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
15276 each line of the expanded noweb reference will be commented.
15278 This code block:
15280 @example
15281 -- <<example>>
15282 @end example
15284 expands to:
15286 @example
15287 -- this is the
15288 -- multi-line body of example
15289 @end example
15291 Note that noweb replacement text that does not contain any newlines will not
15292 be affected by this change, so it is still possible to use inline noweb
15293 references.
15295 @node noweb-ref, noweb-sep, noweb, Specific header arguments
15296 @subsubsection @code{:noweb-ref}
15297 When expanding ``noweb'' style references the bodies of all code block with
15298 @emph{either} a block name matching the reference name @emph{or} a
15299 @code{:noweb-ref} header argument matching the reference name will be
15300 concatenated together to form the replacement text.
15302 By setting this header argument at the sub-tree or file level, simple code
15303 block concatenation may be achieved.  For example, when tangling the
15304 following Org mode file, the bodies of code blocks will be concatenated into
15305 the resulting pure code file@footnote{(The example needs property inheritance
15306 to be turned on for the @code{noweb-ref} property, see @ref{Property
15307 inheritance}).}.
15309 @example
15310  #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
15311    <<fullest-disk>>
15312  #+END_SRC
15313  * the mount point of the fullest disk
15314    :PROPERTIES:
15315    :noweb-ref: fullest-disk
15316    :END:
15318  ** query all mounted disks
15319  #+BEGIN_SRC sh
15320    df \
15321  #+END_SRC
15323  ** strip the header row
15324  #+BEGIN_SRC sh
15325    |sed '1d' \
15326  #+END_SRC
15328  ** sort by the percent full
15329  #+BEGIN_SRC sh
15330    |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
15331  #+END_SRC
15333  ** extract the mount point
15334  #+BEGIN_SRC sh
15335    |awk '@{print $2@}'
15336  #+END_SRC
15337 @end example
15339 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
15340 used to separate accumulate noweb references like those above.  By default a
15341 newline is used.
15343 @node noweb-sep, cache, noweb-ref, Specific header arguments
15344 @subsubsection @code{:noweb-sep}
15346 The @code{:noweb-sep} header argument holds the string used to separate
15347 accumulate noweb references (see @ref{noweb-ref}).  By default a newline is
15348 used.
15350 @node cache, sep, noweb-sep, Specific header arguments
15351 @subsubsection @code{:cache}
15353 The @code{:cache} header argument controls the use of in-buffer caching of
15354 the results of evaluating code blocks.  It can be used to avoid re-evaluating
15355 unchanged code blocks.  Note that the @code{:cache} header argument will not
15356 attempt to cache results when the @code{:session} header argument is used,
15357 because the results of the code block execution may be stored in the session
15358 outside of the Org mode buffer.  The @code{:cache} header argument can have
15359 one of two values: @code{yes} or @code{no}.
15361 @itemize @bullet
15362 @item @code{no}
15363 The default.  No caching takes place, and the code block will be evaluated
15364 every time it is called.
15365 @item @code{yes}
15366 Every time the code block is run a SHA1 hash of the code and arguments
15367 passed to the block will be generated.  This hash is packed into the
15368 @code{#+RESULTS:} line and will be checked on subsequent
15369 executions of the code block.  If the code block has not
15370 changed since the last time it was evaluated, it will not be re-evaluated.
15371 @end itemize
15373 Code block caches notice if the value of a variable argument
15374 to the code block has changed.  If this is the case, the cache is
15375 invalidated and the code block is re-run.  In the following example,
15376 @code{caller} will not be re-run unless the results of @code{random} have
15377 changed since it was last run.
15379 @example
15380  #+NAME: random
15381  #+BEGIN_SRC R :cache yes
15382  runif(1)
15383  #+END_SRC
15385  #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
15386  0.4659510825295
15388  #+NAME: caller
15389  #+BEGIN_SRC emacs-lisp :var x=random :cache yes
15391  #+END_SRC
15393  #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
15394  0.254227238707244
15395 @end example
15397 @node sep, hlines, cache, Specific header arguments
15398 @subsubsection @code{:sep}
15400 The @code{:sep} header argument can be used to control the delimiter used
15401 when writing tabular results out to files external to Org mode.  This is used
15402 either when opening tabular results of a code block by calling the
15403 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
15404 or when writing code block results to an external file (see @ref{file})
15405 header argument.
15407 By default, when @code{:sep} is not specified output tables are tab
15408 delimited.
15410 @node hlines, colnames, sep, Specific header arguments
15411 @subsubsection @code{:hlines}
15413 Tables are frequently represented with one or more horizontal lines, or
15414 hlines.  The @code{:hlines} argument to a code block accepts the
15415 values @code{yes} or @code{no}, with a default value of @code{no}.
15417 @itemize @bullet
15418 @item @code{no}
15419 Strips horizontal lines from the input table.  In most languages this is the
15420 desired effect because an @code{hline} symbol is interpreted as an unbound
15421 variable and raises an error.  Setting @code{:hlines no} or relying on the
15422 default value yields the following results.
15424 @example
15425 #+NAME: many-cols
15426 | a | b | c |
15427 |---+---+---|
15428 | d | e | f |
15429 |---+---+---|
15430 | g | h | i |
15432 #+NAME: echo-table
15433 #+BEGIN_SRC python :var tab=many-cols
15434   return tab
15435 #+END_SRC
15437 #+RESULTS: echo-table
15438 | a | b | c |
15439 | d | e | f |
15440 | g | h | i |
15441 @end example
15443 @item @code{yes}
15444 Leaves hlines in the table.  Setting @code{:hlines yes} has this effect.
15446 @example
15447 #+NAME: many-cols
15448 | a | b | c |
15449 |---+---+---|
15450 | d | e | f |
15451 |---+---+---|
15452 | g | h | i |
15454 #+NAME: echo-table
15455 #+BEGIN_SRC python :var tab=many-cols :hlines yes
15456   return tab
15457 #+END_SRC
15459 #+RESULTS: echo-table
15460 | a | b | c |
15461 |---+---+---|
15462 | d | e | f |
15463 |---+---+---|
15464 | g | h | i |
15465 @end example
15466 @end itemize
15468 @node colnames, rownames, hlines, Specific header arguments
15469 @subsubsection @code{:colnames}
15471 The @code{:colnames} header argument accepts the values @code{yes},
15472 @code{no}, or @code{nil} for unassigned.  The default value is @code{nil}.
15473 Note that the behavior of the @code{:colnames} header argument may differ
15474 across languages.
15476 @itemize @bullet
15477 @item @code{nil}
15478 If an input table looks like it has column names
15479 (because its second row is an hline), then the column
15480 names will be removed from the table before
15481 processing, then reapplied to the results.
15483 @example
15484 #+NAME: less-cols
15485 | a |
15486 |---|
15487 | b |
15488 | c |
15490 #+NAME: echo-table-again
15491 #+BEGIN_SRC python :var tab=less-cols
15492   return [[val + '*' for val in row] for row in tab]
15493 #+END_SRC
15495 #+RESULTS: echo-table-again
15496 | a  |
15497 |----|
15498 | b* |
15499 | c* |
15500 @end example
15502 Please note that column names are not removed before the table is indexed
15503 using variable indexing @xref{var, Indexable variable values}.
15505 @item @code{no}
15506 No column name pre-processing takes place
15508 @item @code{yes}
15509 Column names are removed and reapplied as with @code{nil} even if the table
15510 does not ``look like'' it has column names (i.e., the second row is not an
15511 hline)
15512 @end itemize
15514 @node rownames, shebang, colnames, Specific header arguments
15515 @subsubsection @code{:rownames}
15517 The @code{:rownames} header argument can take on the values @code{yes} or
15518 @code{no}, with a default value of @code{no}.  Note that Emacs Lisp code
15519 blocks ignore the @code{:rownames} header argument entirely given the ease
15520 with which tables with row names may be handled directly in Emacs Lisp.
15522 @itemize @bullet
15523 @item @code{no}
15524 No row name pre-processing will take place.
15526 @item @code{yes}
15527 The first column of the table is removed from the table before processing,
15528 and is then reapplied to the results.
15530 @example
15531 #+NAME: with-rownames
15532 | one | 1 | 2 | 3 | 4 |  5 |
15533 | two | 6 | 7 | 8 | 9 | 10 |
15535 #+NAME: echo-table-once-again
15536 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
15537   return [[val + 10 for val in row] for row in tab]
15538 #+END_SRC
15540 #+RESULTS: echo-table-once-again
15541 | one | 11 | 12 | 13 | 14 | 15 |
15542 | two | 16 | 17 | 18 | 19 | 20 |
15543 @end example
15545 Please note that row names are not removed before the table is indexed using
15546 variable indexing @xref{var, Indexable variable values}.
15548 @end itemize
15550 @node shebang, tangle-mode, rownames, Specific header arguments
15551 @subsubsection @code{:shebang}
15553 Setting the @code{:shebang} header argument to a string value
15554 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
15555 first line of any tangled file holding the code block, and the file
15556 permissions of the tangled file are set to make it executable.
15559 @node tangle-mode, eval, shebang, Specific header arguments
15560 @subsubsection @code{:tangle-mode}
15562 The @code{tangle-mode} header argument controls the permission set on tangled
15563 files.  The value of this header argument will be passed to
15564 @code{set-file-modes}.  For example, to set a tangled file as read only use
15565 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
15566 use @code{:tangle-mode (identity #o755)}.  Blocks with @code{shebang}
15567 (@ref{shebang}) header arguments will automatically be made executable unless
15568 the @code{tangle-mode} header argument is also used.  The behavior is
15569 undefined if multiple code blocks with different values for the
15570 @code{tangle-mode} header argument are tangled to the same file.
15572 @node eval, wrap, tangle-mode, Specific header arguments
15573 @subsubsection @code{:eval}
15574 The @code{:eval} header argument can be used to limit the evaluation of
15575 specific code blocks.  The @code{:eval} header argument can be useful for
15576 protecting against the evaluation of dangerous code blocks or to ensure that
15577 evaluation will require a query regardless of the value of the
15578 @code{org-confirm-babel-evaluate} variable.  The possible values of
15579 @code{:eval} and their effects are shown below.
15581 @table @code
15582 @item never or no
15583 The code block will not be evaluated under any circumstances.
15584 @item query
15585 Evaluation of the code block will require a query.
15586 @item never-export or no-export
15587 The code block will not be evaluated during export but may still be called
15588 interactively.
15589 @item query-export
15590 Evaluation of the code block during export will require a query.
15591 @end table
15593 If this header argument is not set then evaluation is determined by the value
15594 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
15595 security}.
15597 @node wrap, post, eval, Specific header arguments
15598 @subsubsection @code{:wrap}
15599 The @code{:wrap} header argument is used to mark the results of source block
15600 evaluation.  The header argument can be passed a string that will be appended
15601 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
15602 results.  If not string is specified then the results will be wrapped in a
15603 @code{#+BEGIN/END_RESULTS} block.
15605 @node post, prologue, wrap, Specific header arguments
15606 @subsubsection @code{:post}
15607 The @code{:post} header argument is used to post-process the results of a
15608 code block execution.  When a post argument is given, the results of the code
15609 block will temporarily be bound to the @code{*this*} variable.  This variable
15610 may then be included in header argument forms such as those used in @ref{var}
15611 header argument specifications allowing passing of results to other code
15612 blocks, or direct execution via Emacs Lisp.
15614 The following example illustrates the usage of the @code{:post} header
15615 argument.
15617 @example
15618 #+name: attr_wrap
15619 #+begin_src sh :var data="" :var width="\\textwidth" :results output
15620   echo "#+ATTR_LATEX :width $width"
15621   echo "$data"
15622 #+end_src
15624 #+header: :file /tmp/it.png
15625 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
15626   digraph@{
15627           a -> b;
15628           b -> c;
15629           c -> a;
15630   @}
15631 #+end_src
15633 #+RESULTS:
15634 :RESULTS:
15635 #+ATTR_LATEX :width 5cm
15636 [[file:/tmp/it.png]]
15637 :END:
15638 @end example
15640 @node prologue, epilogue, post, Specific header arguments
15641 @subsubsection @code{:prologue}
15642 The value of the @code{prologue} header argument will be prepended to the
15643 code block body before execution.  For example, @code{:prologue "reset"} may
15644 be used to reset a gnuplot session before execution of a particular code
15645 block, or the following configuration may be used to do this for all gnuplot
15646 code blocks.  Also see @ref{epilogue}.
15648 @lisp
15649 (add-to-list 'org-babel-default-header-args:gnuplot
15650              '((:prologue . "reset")))
15651 @end lisp
15653 @node epilogue, , prologue, Specific header arguments
15654 @subsubsection @code{:epilogue}
15655 The value of the @code{epilogue} header argument will be appended to the code
15656 block body before execution.  Also see @ref{prologue}.
15658 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
15659 @section Results of evaluation
15660 @cindex code block, results of evaluation
15661 @cindex source code, results of evaluation
15663 The way in which results are handled depends on whether a session is invoked,
15664 as well as on whether @code{:results value} or @code{:results output} is
15665 used.  The following table shows the table possibilities.  For a full listing
15666 of the possible results header arguments see @ref{results}.
15668 @multitable @columnfractions 0.26 0.33 0.41
15669 @item @tab @b{Non-session} @tab @b{Session}
15670 @item @code{:results value} @tab value of last expression @tab value of last expression
15671 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
15672 @end multitable
15674 Note: With @code{:results value}, the result in both @code{:session} and
15675 non-session is returned to Org mode as a table (a one- or two-dimensional
15676 vector of strings or numbers) when appropriate.
15678 @subsection Non-session
15679 @subsubsection @code{:results value}
15680 This is the default.  Internally, the value is obtained by wrapping the code
15681 in a function definition in the external language, and evaluating that
15682 function.  Therefore, code should be written as if it were the body of such a
15683 function.  In particular, note that Python does not automatically return a
15684 value from a function unless a @code{return} statement is present, and so a
15685 @samp{return} statement will usually be required in Python.
15687 This is the only one of the four evaluation contexts in which the code is
15688 automatically wrapped in a function definition.
15690 @subsubsection @code{:results output}
15691 The code is passed to the interpreter as an external process, and the
15692 contents of the standard output stream are returned as text.  (In certain
15693 languages this also contains the error output stream; this is an area for
15694 future work.)
15696 @subsection Session
15697 @subsubsection @code{:results value}
15698 The code is passed to an interpreter running as an interactive Emacs inferior
15699 process.  Only languages which provide tools for interactive evaluation of
15700 code have session support, so some language (e.g., C and ditaa) do not
15701 support the @code{:session} header argument, and in other languages (e.g.,
15702 Python and Haskell) which have limitations on the code which may be entered
15703 into interactive sessions, those limitations apply to the code in code blocks
15704 using the @code{:session} header argument as well.
15706 Unless the @code{:results output} option is supplied (see below) the result
15707 returned is the result of the last evaluation performed by the
15708 interpreter.  (This is obtained in a language-specific manner: the value of
15709 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
15710 in R).
15712 @subsubsection @code{:results output}
15713 The code is passed to the interpreter running as an interactive Emacs
15714 inferior process.  The result returned is the concatenation of the sequence of
15715 (text) output from the interactive interpreter.  Notice that this is not
15716 necessarily the same as what would be sent to @code{STDOUT} if the same code
15717 were passed to a non-interactive interpreter running as an external
15718 process.  For example, compare the following two blocks:
15720 @example
15721 #+BEGIN_SRC python :results output
15722  print "hello"
15724  print "bye"
15725 #+END_SRC
15727 #+RESULTS:
15728 : hello
15729 : bye
15730 @end example
15732 In non-session mode, the `2' is not printed and does not appear.
15734 @example
15735 #+BEGIN_SRC python :results output :session
15736  print "hello"
15738  print "bye"
15739 #+END_SRC
15741 #+RESULTS:
15742 : hello
15743 : 2
15744 : bye
15745 @end example
15747 But in @code{:session} mode, the interactive interpreter receives input `2'
15748 and prints out its value, `2'.  (Indeed, the other print statements are
15749 unnecessary here).
15751 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
15752 @section Noweb reference syntax
15753 @cindex code block, noweb reference
15754 @cindex syntax, noweb
15755 @cindex source code, noweb reference
15757 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
15758 Programming system allows named blocks of code to be referenced by using the
15759 familiar Noweb syntax:
15761 @example
15762 <<code-block-name>>
15763 @end example
15765 When a code block is tangled or evaluated, whether or not ``noweb''
15766 references are expanded depends upon the value of the @code{:noweb} header
15767 argument.  If @code{:noweb yes}, then a Noweb reference is expanded before
15768 evaluation.  If @code{:noweb no}, the default, then the reference is not
15769 expanded before evaluation.  See the @ref{noweb-ref} header argument for
15770 a more flexible way to resolve noweb references.
15772 It is possible to include the @emph{results} of a code block rather than the
15773 body.  This is done by appending parenthesis to the code block name which may
15774 optionally contain arguments to the code block as shown below.
15776 @example
15777 <<code-block-name(optional arguments)>>
15778 @end example
15780 Note: the default value, @code{:noweb no}, was chosen to ensure that
15781 correct code is not broken in a language, such as Ruby, where
15782 @code{<<arg>>} is a syntactically valid construct.  If @code{<<arg>>} is not
15783 syntactically valid in languages that you use, then please consider setting
15784 the default value.
15786 Note: if noweb tangling is slow in large Org mode files consider setting the
15787 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
15788 This will result in faster noweb reference resolution at the expense of not
15789 correctly resolving inherited values of the @code{:noweb-ref} header
15790 argument.
15792 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
15793 @section Key bindings and useful functions
15794 @cindex code block, key bindings
15796 Many common Org mode key sequences are re-bound depending on
15797 the context.
15799 Within a code block, the following key bindings
15800 are active:
15802 @multitable @columnfractions 0.25 0.75
15803 @kindex C-c C-c
15804 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
15805 @kindex C-c C-o
15806 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
15807 @kindex M-up
15808 @item @kbd{M-@key{up}}    @tab @code{org-babel-load-in-session}
15809 @kindex M-down
15810 @item @kbd{M-@key{down}}  @tab @code{org-babel-switch-to-session}
15811 @end multitable
15813 In an Org mode buffer, the following key bindings are active:
15815 @multitable @columnfractions 0.45 0.55
15816 @kindex C-c C-v p
15817 @kindex C-c C-v C-p
15818 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
15819 @kindex C-c C-v n
15820 @kindex C-c C-v C-n
15821 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
15822 @kindex C-c C-v e
15823 @kindex C-c C-v C-e
15824 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
15825 @kindex C-c C-v o
15826 @kindex C-c C-v C-o
15827 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
15828 @kindex C-c C-v v
15829 @kindex C-c C-v C-v
15830 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
15831 @kindex C-c C-v u
15832 @kindex C-c C-v C-u
15833 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
15834 @kindex C-c C-v g
15835 @kindex C-c C-v C-g
15836 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
15837 @kindex C-c C-v r
15838 @kindex C-c C-v C-r
15839 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
15840 @kindex C-c C-v b
15841 @kindex C-c C-v C-b
15842 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
15843 @kindex C-c C-v s
15844 @kindex C-c C-v C-s
15845 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
15846 @kindex C-c C-v d
15847 @kindex C-c C-v C-d
15848 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
15849 @kindex C-c C-v t
15850 @kindex C-c C-v C-t
15851 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
15852 @kindex C-c C-v f
15853 @kindex C-c C-v C-f
15854 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
15855 @kindex C-c C-v c
15856 @kindex C-c C-v C-c
15857 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
15858 @kindex C-c C-v j
15859 @kindex C-c C-v C-j
15860 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
15861 @kindex C-c C-v l
15862 @kindex C-c C-v C-l
15863 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
15864 @kindex C-c C-v i
15865 @kindex C-c C-v C-i
15866 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
15867 @kindex C-c C-v I
15868 @kindex C-c C-v C-I
15869 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
15870 @kindex C-c C-v z
15871 @kindex C-c C-v C-z
15872 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session-with-code}
15873 @kindex C-c C-v a
15874 @kindex C-c C-v C-a
15875 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
15876 @kindex C-c C-v h
15877 @kindex C-c C-v C-h
15878 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
15879 @kindex C-c C-v x
15880 @kindex C-c C-v C-x
15881 @item @kbd{C-c C-v x} @ @ @r{or} @ @ @kbd{C-c C-v C-x} @tab @code{org-babel-do-key-sequence-in-edit-buffer}
15882 @end multitable
15884 @c When possible these keybindings were extended to work when the control key is
15885 @c kept pressed, resulting in the following additional keybindings.
15887 @c @multitable @columnfractions 0.25 0.75
15888 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
15889 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
15890 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
15891 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
15892 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
15893 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
15894 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
15895 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
15896 @c @end multitable
15898 @node Batch execution,  , Key bindings and useful functions, Working With Source Code
15899 @section Batch execution
15900 @cindex code block, batch execution
15901 @cindex source code, batch execution
15903 It is possible to call functions from the command line.  This shell
15904 script calls @code{org-babel-tangle} on every one of its arguments.
15906 Be sure to adjust the paths to fit your system.
15908 @example
15909 #!/bin/sh
15910 # -*- mode: shell-script -*-
15912 # tangle files with org-mode
15914 DIR=`pwd`
15915 FILES=""
15917 # wrap each argument in the code required to call tangle on it
15918 for i in $@@; do
15919     FILES="$FILES \"$i\""
15920 done
15922 emacs -Q --batch \
15923 --eval "(progn
15924 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
15925 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
15926 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
15927 (mapc (lambda (file)
15928        (find-file (expand-file-name file \"$DIR\"))
15929        (org-babel-tangle)
15930        (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
15931 @end example
15933 @node Miscellaneous, Hacking, Working With Source Code, Top
15934 @chapter Miscellaneous
15936 @menu
15937 * Completion::                  M-TAB knows what you need
15938 * Easy Templates::              Quick insertion of structural elements
15939 * Speed keys::                  Electric commands at the beginning of a headline
15940 * Code evaluation security::    Org mode files evaluate inline code
15941 * Customization::               Adapting Org to your taste
15942 * In-buffer settings::          Overview of the #+KEYWORDS
15943 * The very busy C-c C-c key::   When in doubt, press C-c C-c
15944 * Clean view::                  Getting rid of leading stars in the outline
15945 * TTY keys::                    Using Org on a tty
15946 * Interaction::                 Other Emacs packages
15947 * org-crypt::                   Encrypting Org files
15948 @end menu
15951 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
15952 @section Completion
15953 @cindex completion, of @TeX{} symbols
15954 @cindex completion, of TODO keywords
15955 @cindex completion, of dictionary words
15956 @cindex completion, of option keywords
15957 @cindex completion, of tags
15958 @cindex completion, of property keys
15959 @cindex completion, of link abbreviations
15960 @cindex @TeX{} symbol completion
15961 @cindex TODO keywords completion
15962 @cindex dictionary word completion
15963 @cindex option keyword completion
15964 @cindex tag completion
15965 @cindex link abbreviations, completion of
15967 Emacs would not be Emacs without completion, and Org mode uses it whenever it
15968 makes sense.  If you prefer an @i{iswitchb}- or @i{ido}-like interface for
15969 some of the completion prompts, you can specify your preference by setting at
15970 most one of the variables @code{org-completion-use-iswitchb}
15971 @code{org-completion-use-ido}.
15973 Org supports in-buffer completion.  This type of completion does
15974 not make use of the minibuffer.  You simply type a few letters into
15975 the buffer and use the key to complete text right there.
15977 @table @kbd
15978 @kindex M-@key{TAB}
15979 @item M-@key{TAB}
15980 Complete word at point
15981 @itemize @bullet
15982 @item
15983 At the beginning of a headline, complete TODO keywords.
15984 @item
15985 After @samp{\}, complete @TeX{} symbols supported by the exporter.
15986 @item
15987 After @samp{*}, complete headlines in the current buffer so that they
15988 can be used in search links like @samp{[[*find this headline]]}.
15989 @item
15990 After @samp{:} in a headline, complete tags.  The list of tags is taken
15991 from the variable @code{org-tag-alist} (possibly set through the
15992 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
15993 dynamically from all tags used in the current buffer.
15994 @item
15995 After @samp{:} and not in a headline, complete property keys.  The list
15996 of keys is constructed dynamically from all keys used in the current
15997 buffer.
15998 @item
15999 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
16000 @item
16001 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
16002 @samp{OPTIONS} which set file-specific options for Org mode.  When the
16003 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
16004 will insert example settings for this keyword.
16005 @item
16006 In the line after @samp{#+STARTUP: }, complete startup keywords,
16007 i.e., valid keys for this line.
16008 @item
16009 Elsewhere, complete dictionary words using Ispell.
16010 @end itemize
16011 @end table
16013 @node Easy Templates, Speed keys, Completion, Miscellaneous
16014 @section Easy Templates
16015 @cindex template insertion
16016 @cindex insertion, of templates
16018 Org mode supports insertion of empty structural elements (like
16019 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
16020 strokes.  This is achieved through a native template expansion mechanism.
16021 Note that Emacs has several other template mechanisms which could be used in
16022 a similar way, for example @file{yasnippet}.
16024 To insert a structural element, type a @samp{<}, followed by a template
16025 selector and @kbd{@key{TAB}}.  Completion takes effect only when the above
16026 keystrokes are typed on a line by itself.
16028 The following template selectors are currently supported.
16030 @multitable @columnfractions 0.1 0.9
16031 @item @kbd{s} @tab @code{#+BEGIN_SRC     ... #+END_SRC}
16032 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
16033 @item @kbd{q} @tab @code{#+BEGIN_QUOTE   ... #+END_QUOTE}
16034 @item @kbd{v} @tab @code{#+BEGIN_VERSE   ... #+END_VERSE}
16035 @item @kbd{c} @tab @code{#+BEGIN_CENTER  ... #+END_CENTER}
16036 @item @kbd{l} @tab @code{#+BEGIN_LaTeX   ... #+END_LaTeX}
16037 @item @kbd{L} @tab @code{#+LaTeX:}
16038 @item @kbd{h} @tab @code{#+BEGIN_HTML    ... #+END_HTML}
16039 @item @kbd{H} @tab @code{#+HTML:}
16040 @item @kbd{a} @tab @code{#+BEGIN_ASCII   ... #+END_ASCII}
16041 @item @kbd{A} @tab @code{#+ASCII:}
16042 @item @kbd{i} @tab @code{#+INDEX:} line
16043 @item @kbd{I} @tab @code{#+INCLUDE:} line
16044 @end multitable
16046 For example, on an empty line, typing "<e" and then pressing TAB, will expand
16047 into a complete EXAMPLE template.
16049 You can install additional templates by customizing the variable
16050 @code{org-structure-template-alist}.  See the docstring of the variable for
16051 additional details.
16053 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
16054 @section Speed keys
16055 @cindex speed keys
16056 @vindex org-use-speed-commands
16057 @vindex org-speed-commands-user
16059 Single keys can be made to execute commands when the cursor is at the
16060 beginning of a headline, i.e., before the first star.  Configure the variable
16061 @code{org-use-speed-commands} to activate this feature.  There is a
16062 pre-defined list of commands, and you can add more such commands using the
16063 variable @code{org-speed-commands-user}.  Speed keys do not only speed up
16064 navigation and other commands, but they also provide an alternative way to
16065 execute commands bound to keys that are not or not easily available on a TTY,
16066 or on a small mobile device with a limited keyboard.
16068 To see which commands are available, activate the feature and press @kbd{?}
16069 with the cursor at the beginning of a headline.
16071 @node Code evaluation security, Customization, Speed keys, Miscellaneous
16072 @section Code evaluation and security issues
16074 Org provides tools to work with the code snippets, including evaluating them.
16076 Running code on your machine always comes with a security risk.  Badly
16077 written or malicious code can be executed on purpose or by accident.  Org has
16078 default settings which will only evaluate such code if you give explicit
16079 permission to do so, and as a casual user of these features you should leave
16080 these precautions intact.
16082 For people who regularly work with such code, the confirmation prompts can
16083 become annoying, and you might want to turn them off.  This can be done, but
16084 you must be aware of the risks that are involved.
16086 Code evaluation can happen under the following circumstances:
16088 @table @i
16089 @item Source code blocks
16090 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
16091 C-c} in the block.  The most important thing to realize here is that Org mode
16092 files which contain code snippets are, in a certain sense, like executable
16093 files.  So you should accept them and load them into Emacs only from trusted
16094 sources---just like you would do with a program you install on your computer.
16096 Make sure you know what you are doing before customizing the variables
16097 which take off the default security brakes.
16099 @defopt org-confirm-babel-evaluate
16100 When t (the default), the user is asked before every code block evaluation.
16101 When @code{nil}, the user is not asked.  When set to a function, it is called with
16102 two arguments (language and body of the code block) and should return t to
16103 ask and @code{nil} not to ask.
16104 @end defopt
16106 For example, here is how to execute "ditaa" code (which is considered safe)
16107 without asking:
16109 @lisp
16110 (defun my-org-confirm-babel-evaluate (lang body)
16111   (not (string= lang "ditaa")))  ; don't ask for ditaa
16112 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
16113 @end lisp
16115 @item Following @code{shell} and @code{elisp} links
16116 Org has two link types that can directly evaluate code (@pxref{External
16117 links}).  These links can be problematic because the code to be evaluated is
16118 not visible.
16120 @defopt org-confirm-shell-link-function
16121 Function to queries user about shell link execution.
16122 @end defopt
16123 @defopt org-confirm-elisp-link-function
16124 Functions to query user for Emacs Lisp link execution.
16125 @end defopt
16127 @item Formulas in tables
16128 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
16129 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
16130 @end table
16132 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
16133 @section Customization
16134 @cindex customization
16135 @cindex options, for customization
16136 @cindex variables, for customization
16138 There are more than 500 variables that can be used to customize
16139 Org.  For the sake of compactness of the manual, I am not
16140 describing the variables here.  A structured overview of customization
16141 variables is available with @kbd{M-x org-customize RET}.  Or select
16142 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
16143 settings can also be activated on a per-file basis, by putting special
16144 lines into the buffer (@pxref{In-buffer settings}).
16146 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
16147 @section Summary of in-buffer settings
16148 @cindex in-buffer settings
16149 @cindex special keywords
16151 Org mode uses special lines in the buffer to define settings on a
16152 per-file basis.  These lines start with a @samp{#+} followed by a
16153 keyword, a colon, and then individual words defining a setting.  Several
16154 setting words can be in the same line, but you can also have multiple
16155 lines for the keyword.  While these settings are described throughout
16156 the manual, here is a summary.  After changing any of those lines in the
16157 buffer, press @kbd{C-c C-c} with the cursor still in the line to
16158 activate the changes immediately.  Otherwise they become effective only
16159 when the file is visited again in a new Emacs session.
16161 @vindex org-archive-location
16162 @table @kbd
16163 @item #+ARCHIVE: %s_done::
16164 This line sets the archive location for the agenda file.  It applies for
16165 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
16166 of the file.  The first such line also applies to any entries before it.
16167 The corresponding variable is @code{org-archive-location}.
16168 @item #+CATEGORY:
16169 This line sets the category for the agenda file.  The category applies
16170 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
16171 end of the file.  The first such line also applies to any entries before it.
16172 @item #+COLUMNS: %25ITEM ...
16173 @cindex property, COLUMNS
16174 Set the default format for columns view.  This format applies when
16175 columns view is invoked in locations where no @code{COLUMNS} property
16176 applies.
16177 @item #+CONSTANTS: name1=value1 ...
16178 @vindex org-table-formula-constants
16179 @vindex org-table-formula
16180 Set file-local values for constants to be used in table formulas.  This
16181 line sets the local variable @code{org-table-formula-constants-local}.
16182 The global version of this variable is
16183 @code{org-table-formula-constants}.
16184 @item #+FILETAGS: :tag1:tag2:tag3:
16185 Set tags that can be inherited by any entry in the file, including the
16186 top-level entries.
16187 @item #+DRAWERS: NAME1 ...
16188 @vindex org-drawers
16189 Set the file-local set of additional drawers.  The corresponding global
16190 variable is @code{org-drawers}.
16191 @item #+LINK: linkword replace
16192 @vindex org-link-abbrev-alist
16193 These lines (several are allowed) specify link abbreviations.
16194 @xref{Link abbreviations}.  The corresponding variable is
16195 @code{org-link-abbrev-alist}.
16196 @item #+PRIORITIES: highest lowest default
16197 @vindex org-highest-priority
16198 @vindex org-lowest-priority
16199 @vindex org-default-priority
16200 This line sets the limits and the default for the priorities.  All three
16201 must be either letters A--Z or numbers 0--9.  The highest priority must
16202 have a lower ASCII number than the lowest priority.
16203 @item #+PROPERTY: Property_Name Value
16204 This line sets a default inheritance value for entries in the current
16205 buffer, most useful for specifying the allowed values of a property.
16206 @cindex #+SETUPFILE
16207 @item #+SETUPFILE: file
16208 This line defines a file that holds more in-buffer setup.  Normally this is
16209 entirely ignored.  Only when the buffer is parsed for option-setting lines
16210 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
16211 settings line, or when exporting), then the contents of this file are parsed
16212 as if they had been included in the buffer.  In particular, the file can be
16213 any other Org mode file with internal setup.  You can visit the file the
16214 cursor is in the line with @kbd{C-c '}.
16215 @item #+STARTUP:
16216 @cindex #+STARTUP
16217 This line sets options to be used at startup of Org mode, when an
16218 Org file is being visited.
16220 The first set of options deals with the initial visibility of the outline
16221 tree.  The corresponding variable for global default settings is
16222 @code{org-startup-folded}, with a default value @code{t}, which means
16223 @code{overview}.
16224 @vindex org-startup-folded
16225 @cindex @code{overview}, STARTUP keyword
16226 @cindex @code{content}, STARTUP keyword
16227 @cindex @code{showall}, STARTUP keyword
16228 @cindex @code{showeverything}, STARTUP keyword
16229 @example
16230 overview         @r{top-level headlines only}
16231 content          @r{all headlines}
16232 showall          @r{no folding of any entries}
16233 showeverything   @r{show even drawer contents}
16234 @end example
16236 @vindex org-startup-indented
16237 @cindex @code{indent}, STARTUP keyword
16238 @cindex @code{noindent}, STARTUP keyword
16239 Dynamic virtual indentation is controlled by the variable
16240 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
16241 @example
16242 indent     @r{start with @code{org-indent-mode} turned on}
16243 noindent   @r{start with @code{org-indent-mode} turned off}
16244 @end example
16246 @vindex org-startup-align-all-tables
16247 Then there are options for aligning tables upon visiting a file.  This
16248 is useful in files containing narrowed table columns.  The corresponding
16249 variable is @code{org-startup-align-all-tables}, with a default value
16250 @code{nil}.
16251 @cindex @code{align}, STARTUP keyword
16252 @cindex @code{noalign}, STARTUP keyword
16253 @example
16254 align      @r{align all tables}
16255 noalign    @r{don't align tables on startup}
16256 @end example
16258 @vindex org-startup-with-inline-images
16259 When visiting a file, inline images can be automatically displayed.  The
16260 corresponding variable is @code{org-startup-with-inline-images}, with a
16261 default value @code{nil} to avoid delays when visiting a file.
16262 @cindex @code{inlineimages}, STARTUP keyword
16263 @cindex @code{noinlineimages}, STARTUP keyword
16264 @example
16265 inlineimages   @r{show inline images}
16266 noinlineimages @r{don't show inline images on startup}
16267 @end example
16269 @vindex org-startup-with-latex-preview
16270 When visiting a file, @LaTeX{} fragments can be converted to images
16271 automatically.  The variable @code{org-startup-with-latex-preview} which
16272 controls this behavior, is set to @code{nil} by default to avoid delays on
16273 startup.
16274 @cindex @code{latexpreview}, STARTUP keyword
16275 @cindex @code{nolatexpreview}, STARTUP keyword
16276 @example
16277 latexpreview   @r{preview @LaTeX{} fragments}
16278 nolatexpreview @r{don't preview @LaTeX{} fragments}
16279 @end example
16281 @vindex org-log-done
16282 @vindex org-log-note-clock-out
16283 @vindex org-log-repeat
16284 Logging the closing and reopening of TODO items and clock intervals can be
16285 configured using these options (see variables @code{org-log-done},
16286 @code{org-log-note-clock-out} and @code{org-log-repeat})
16287 @cindex @code{logdone}, STARTUP keyword
16288 @cindex @code{lognotedone}, STARTUP keyword
16289 @cindex @code{nologdone}, STARTUP keyword
16290 @cindex @code{lognoteclock-out}, STARTUP keyword
16291 @cindex @code{nolognoteclock-out}, STARTUP keyword
16292 @cindex @code{logrepeat}, STARTUP keyword
16293 @cindex @code{lognoterepeat}, STARTUP keyword
16294 @cindex @code{nologrepeat}, STARTUP keyword
16295 @cindex @code{logreschedule}, STARTUP keyword
16296 @cindex @code{lognotereschedule}, STARTUP keyword
16297 @cindex @code{nologreschedule}, STARTUP keyword
16298 @cindex @code{logredeadline}, STARTUP keyword
16299 @cindex @code{lognoteredeadline}, STARTUP keyword
16300 @cindex @code{nologredeadline}, STARTUP keyword
16301 @cindex @code{logrefile}, STARTUP keyword
16302 @cindex @code{lognoterefile}, STARTUP keyword
16303 @cindex @code{nologrefile}, STARTUP keyword
16304 @cindex @code{logdrawer}, STARTUP keyword
16305 @cindex @code{nologdrawer}, STARTUP keyword
16306 @cindex @code{logstatesreversed}, STARTUP keyword
16307 @cindex @code{nologstatesreversed}, STARTUP keyword
16308 @example
16309 logdone             @r{record a timestamp when an item is marked DONE}
16310 lognotedone         @r{record timestamp and a note when DONE}
16311 nologdone           @r{don't record when items are marked DONE}
16312 logrepeat           @r{record a time when reinstating a repeating item}
16313 lognoterepeat       @r{record a note when reinstating a repeating item}
16314 nologrepeat         @r{do not record when reinstating repeating item}
16315 lognoteclock-out    @r{record a note when clocking out}
16316 nolognoteclock-out  @r{don't record a note when clocking out}
16317 logreschedule       @r{record a timestamp when scheduling time changes}
16318 lognotereschedule   @r{record a note when scheduling time changes}
16319 nologreschedule     @r{do not record when a scheduling date changes}
16320 logredeadline       @r{record a timestamp when deadline changes}
16321 lognoteredeadline   @r{record a note when deadline changes}
16322 nologredeadline     @r{do not record when a deadline date changes}
16323 logrefile           @r{record a timestamp when refiling}
16324 lognoterefile       @r{record a note when refiling}
16325 nologrefile         @r{do not record when refiling}
16326 logdrawer           @r{store log into drawer}
16327 nologdrawer         @r{store log outside of drawer}
16328 logstatesreversed   @r{reverse the order of states notes}
16329 nologstatesreversed @r{do not reverse the order of states notes}
16330 @end example
16332 @vindex org-hide-leading-stars
16333 @vindex org-odd-levels-only
16334 Here are the options for hiding leading stars in outline headings, and for
16335 indenting outlines.  The corresponding variables are
16336 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
16337 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
16338 @cindex @code{hidestars}, STARTUP keyword
16339 @cindex @code{showstars}, STARTUP keyword
16340 @cindex @code{odd}, STARTUP keyword
16341 @cindex @code{even}, STARTUP keyword
16342 @example
16343 hidestars  @r{make all but one of the stars starting a headline invisible.}
16344 showstars  @r{show all stars starting a headline}
16345 indent     @r{virtual indentation according to outline level}
16346 noindent   @r{no virtual indentation according to outline level}
16347 odd        @r{allow only odd outline levels (1,3,...)}
16348 oddeven    @r{allow all outline levels}
16349 @end example
16351 @vindex org-put-time-stamp-overlays
16352 @vindex org-time-stamp-overlay-formats
16353 To turn on custom format overlays over timestamps (variables
16354 @code{org-put-time-stamp-overlays} and
16355 @code{org-time-stamp-overlay-formats}), use
16356 @cindex @code{customtime}, STARTUP keyword
16357 @example
16358 customtime @r{overlay custom time format}
16359 @end example
16361 @vindex constants-unit-system
16362 The following options influence the table spreadsheet (variable
16363 @code{constants-unit-system}).
16364 @cindex @code{constcgs}, STARTUP keyword
16365 @cindex @code{constSI}, STARTUP keyword
16366 @example
16367 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
16368 constSI    @r{@file{constants.el} should use the SI unit system}
16369 @end example
16371 @vindex org-footnote-define-inline
16372 @vindex org-footnote-auto-label
16373 @vindex org-footnote-auto-adjust
16374 To influence footnote settings, use the following keywords.  The
16375 corresponding variables are @code{org-footnote-define-inline},
16376 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
16377 @cindex @code{fninline}, STARTUP keyword
16378 @cindex @code{nofninline}, STARTUP keyword
16379 @cindex @code{fnlocal}, STARTUP keyword
16380 @cindex @code{fnprompt}, STARTUP keyword
16381 @cindex @code{fnauto}, STARTUP keyword
16382 @cindex @code{fnconfirm}, STARTUP keyword
16383 @cindex @code{fnplain}, STARTUP keyword
16384 @cindex @code{fnadjust}, STARTUP keyword
16385 @cindex @code{nofnadjust}, STARTUP keyword
16386 @example
16387 fninline    @r{define footnotes inline}
16388 fnnoinline  @r{define footnotes in separate section}
16389 fnlocal     @r{define footnotes near first reference, but not inline}
16390 fnprompt    @r{prompt for footnote labels}
16391 fnauto      @r{create @code{[fn:1]}-like labels automatically (default)}
16392 fnconfirm   @r{offer automatic label for editing or confirmation}
16393 fnplain     @r{create @code{[1]}-like labels automatically}
16394 fnadjust    @r{automatically renumber and sort footnotes}
16395 nofnadjust  @r{do not renumber and sort automatically}
16396 @end example
16398 @cindex org-hide-block-startup
16399 To hide blocks on startup, use these keywords.  The corresponding variable is
16400 @code{org-hide-block-startup}.
16401 @cindex @code{hideblocks}, STARTUP keyword
16402 @cindex @code{nohideblocks}, STARTUP keyword
16403 @example
16404 hideblocks   @r{Hide all begin/end blocks on startup}
16405 nohideblocks @r{Do not hide blocks on startup}
16406 @end example
16408 @cindex org-pretty-entities
16409 The display of entities as UTF-8 characters is governed by the variable
16410 @code{org-pretty-entities} and the keywords
16411 @cindex @code{entitiespretty}, STARTUP keyword
16412 @cindex @code{entitiesplain}, STARTUP keyword
16413 @example
16414 entitiespretty  @r{Show entities as UTF-8 characters where possible}
16415 entitiesplain   @r{Leave entities plain}
16416 @end example
16418 @item #+TAGS:  TAG1(c1) TAG2(c2)
16419 @vindex org-tag-alist
16420 These lines (several such lines are allowed) specify the valid tags in
16421 this file, and (potentially) the corresponding @emph{fast tag selection}
16422 keys.  The corresponding variable is @code{org-tag-alist}.
16423 @cindex #+TBLFM
16424 @item #+TBLFM:
16425 This line contains the formulas for the table directly above the line.
16427 Table can have multiple lines containing @samp{#+TBLFM:}.  Note
16428 that only the first line of @samp{#+TBLFM:} will be applied when
16429 you recalculate the table.  For more details see @ref{Using
16430 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
16432 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
16433 @itemx #+OPTIONS:, #+BIND:,
16434 @itemx #+DESCRIPTION:, #+KEYWORDS:,
16435 @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
16436 @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
16437 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
16438 These lines provide settings for exporting files.  For more details see
16439 @ref{Export settings}.
16440 @item #+TODO:    #+SEQ_TODO:   #+TYP_TODO:
16441 @vindex org-todo-keywords
16442 These lines set the TODO keywords and their interpretation in the
16443 current file.  The corresponding variable is @code{org-todo-keywords}.
16444 @end table
16446 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
16447 @section The very busy C-c C-c key
16448 @kindex C-c C-c
16449 @cindex C-c C-c, overview
16451 The key @kbd{C-c C-c} has many purposes in Org, which are all
16452 mentioned scattered throughout this manual.  One specific function of
16453 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
16454 other circumstances it means something like @emph{``Hey Org, look
16455 here and update according to what you see here''}.  Here is a summary of
16456 what this means in different contexts.
16458 @itemize @minus
16459 @item
16460 If there are highlights in the buffer from the creation of a sparse
16461 tree, or from clock display, remove these highlights.
16462 @item
16463 If the cursor is in one of the special @code{#+KEYWORD} lines, this
16464 triggers scanning the buffer for these lines and updating the
16465 information.
16466 @item
16467 If the cursor is inside a table, realign the table.  This command
16468 works even if the automatic table editor has been turned off.
16469 @item
16470 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
16471 the entire table.
16472 @item
16473 If the current buffer is a capture buffer, close the note and file it.
16474 With a prefix argument, file it, without further interaction, to the
16475 default location.
16476 @item
16477 If the cursor is on a @code{<<<target>>>}, update radio targets and
16478 corresponding links in this buffer.
16479 @item
16480 If the cursor is in a property line or at the start or end of a property
16481 drawer, offer property commands.
16482 @item
16483 If the cursor is at a footnote reference, go to the corresponding
16484 definition, and @emph{vice versa}.
16485 @item
16486 If the cursor is on a statistics cookie, update it.
16487 @item
16488 If the cursor is in a plain list item with a checkbox, toggle the status
16489 of the checkbox.
16490 @item
16491 If the cursor is on a numbered item in a plain list, renumber the
16492 ordered list.
16493 @item
16494 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
16495 block is updated.
16496 @item
16497 If the cursor is at a timestamp, fix the day name in the timestamp.
16498 @end itemize
16500 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
16501 @section A cleaner outline view
16502 @cindex hiding leading stars
16503 @cindex dynamic indentation
16504 @cindex odd-levels-only outlines
16505 @cindex clean outline view
16507 Some people find it noisy and distracting that the Org headlines start with a
16508 potentially large number of stars, and that text below the headlines is not
16509 indented.  While this is no problem when writing a @emph{book-like} document
16510 where the outline headings are really section headings, in a more
16511 @emph{list-oriented} outline, indented structure is a lot cleaner:
16513 @example
16514 @group
16515 * Top level headline             |    * Top level headline
16516 ** Second level                  |      * Second level
16517 *** 3rd level                    |        * 3rd level
16518 some text                        |          some text
16519 *** 3rd level                    |        * 3rd level
16520 more text                        |          more text
16521 * Another top level headline     |    * Another top level headline
16522 @end group
16523 @end example
16525 @noindent
16527 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
16528 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
16529 be achieved dynamically at display time using @code{org-indent-mode}.  In
16530 this minor mode, all lines are prefixed for display with the necessary amount
16531 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
16532 property, such that @code{visual-line-mode} (or purely setting
16533 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
16534 }.  Also headlines are prefixed with additional stars, so that the amount of
16535 indentation shifts by two@footnote{See the variable
16536 @code{org-indent-indentation-per-level}.}  spaces per level.  All headline
16537 stars but the last one are made invisible using the @code{org-hide}
16538 face@footnote{Turning on @code{org-indent-mode} sets
16539 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
16540 @code{nil}.}; see below under @samp{2.} for more information on how this
16541 works.  You can turn on @code{org-indent-mode} for all files by customizing
16542 the variable @code{org-startup-indented}, or you can turn it on for
16543 individual files using
16545 @example
16546 #+STARTUP: indent
16547 @end example
16549 If you want a similar effect in an earlier version of Emacs and/or Org, or if
16550 you want the indentation to be hard space characters so that the plain text
16551 file looks as similar as possible to the Emacs display, Org supports you in
16552 the following way:
16554 @enumerate
16555 @item
16556 @emph{Indentation of text below headlines}@*
16557 You may indent text below each headline to make the left boundary line up
16558 with the headline, like
16560 @example
16561 *** 3rd level
16562     more text, now indented
16563 @end example
16565 @vindex org-adapt-indentation
16566 Org supports this with paragraph filling, line wrapping, and structure
16567 editing@footnote{See also the variable @code{org-adapt-indentation}.},
16568 preserving or adapting the indentation as appropriate.
16570 @item
16571 @vindex org-hide-leading-stars
16572 @emph{Hiding leading stars}@* You can modify the display in such a way that
16573 all leading stars become invisible.  To do this in a global way, configure
16574 the variable @code{org-hide-leading-stars} or change this on a per-file basis
16575 with
16577 @example
16578 #+STARTUP: hidestars
16579 #+STARTUP: showstars
16580 @end example
16582 With hidden stars, the tree becomes:
16584 @example
16585 @group
16586 * Top level headline
16587  * Second level
16588   * 3rd level
16589   ...
16590 @end group
16591 @end example
16593 @noindent
16594 @vindex org-hide @r{(face)}
16595 The leading stars are not truly replaced by whitespace, they are only
16596 fontified with the face @code{org-hide} that uses the background color as
16597 font color.  If you are not using either white or black background, you may
16598 have to customize this face to get the wanted effect.  Another possibility is
16599 to set this font such that the extra stars are @i{almost} invisible, for
16600 example using the color @code{grey90} on a white background.
16602 @item
16603 @vindex org-odd-levels-only
16604 Things become cleaner still if you skip all the even levels and use only odd
16605 levels 1, 3, 5..., effectively adding two stars to go from one outline level
16606 to the next@footnote{When you need to specify a level for a property search
16607 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}.  In this
16608 way we get the outline view shown at the beginning of this section.  In order
16609 to make the structure editing and export commands handle this convention
16610 correctly, configure the variable @code{org-odd-levels-only}, or set this on
16611 a per-file basis with one of the following lines:
16613 @example
16614 #+STARTUP: odd
16615 #+STARTUP: oddeven
16616 @end example
16618 You can convert an Org file from single-star-per-level to the
16619 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
16620 RET} in that file.  The reverse operation is @kbd{M-x
16621 org-convert-to-oddeven-levels}.
16622 @end enumerate
16624 @node TTY keys, Interaction, Clean view, Miscellaneous
16625 @section Using Org on a tty
16626 @cindex tty key bindings
16628 Because Org contains a large number of commands, by default many of
16629 Org's core commands are bound to keys that are generally not
16630 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
16631 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
16632 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
16633 these commands on a tty when special keys are unavailable, the following
16634 alternative bindings can be used.  The tty bindings below will likely be
16635 more cumbersome; you may find for some of the bindings below that a
16636 customized workaround suits you better.  For example, changing a timestamp
16637 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
16638 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
16640 @multitable @columnfractions 0.15 0.2 0.1 0.2
16641 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
16642 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab @kbd{C} @tab
16643 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
16644 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab @kbd{L} @tab
16645 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x r}           @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
16646 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab @kbd{R} @tab
16647 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
16648 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab @kbd{U} @tab
16649 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
16650 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab @kbd{D} @tab
16651 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab @kbd{ } @tab
16652 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
16653 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab @kbd{ } @tab
16654 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab @kbd{ } @tab
16655 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab @kbd{ } @tab
16656 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab @kbd{ } @tab
16657 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab @kbd{ } @tab
16658 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab @kbd{ } @tab
16659 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
16660 @end multitable
16663 @node Interaction, org-crypt, TTY keys, Miscellaneous
16664 @section Interaction with other packages
16665 @cindex packages, interaction with other
16666 Org lives in the world of GNU Emacs and interacts in various ways
16667 with other code out there.
16669 @menu
16670 * Cooperation::                 Packages Org cooperates with
16671 * Conflicts::                   Packages that lead to conflicts
16672 @end menu
16674 @node Cooperation, Conflicts, Interaction, Interaction
16675 @subsection Packages that Org cooperates with
16677 @table @asis
16678 @cindex @file{calc.el}
16679 @cindex Gillespie, Dave
16680 @item @file{calc.el} by Dave Gillespie
16681 Org uses the Calc package for implementing spreadsheet
16682 functionality in its tables (@pxref{The spreadsheet}).  Org
16683 checks for the availability of Calc by looking for the function
16684 @code{calc-eval} which will have been autoloaded during setup if Calc has
16685 been installed properly.  As of Emacs 22, Calc is part of the Emacs
16686 distribution.  Another possibility for interaction between the two
16687 packages is using Calc for embedded calculations.  @xref{Embedded Mode,
16688 , Embedded Mode, calc, GNU Emacs Calc Manual}.
16689 @item @file{constants.el} by Carsten Dominik
16690 @cindex @file{constants.el}
16691 @cindex Dominik, Carsten
16692 @vindex org-table-formula-constants
16693 In a table formula (@pxref{The spreadsheet}), it is possible to use
16694 names for natural constants or units.  Instead of defining your own
16695 constants in the variable @code{org-table-formula-constants}, install
16696 the @file{constants} package which defines a large number of constants
16697 and units, and lets you use unit prefixes like @samp{M} for
16698 @samp{Mega}, etc.  You will need version 2.0 of this package, available
16699 at @url{http://www.astro.uva.nl/~dominik/Tools}.  Org checks for
16700 the function @code{constants-get}, which has to be autoloaded in your
16701 setup.  See the installation instructions in the file
16702 @file{constants.el}.
16703 @item @file{cdlatex.el} by Carsten Dominik
16704 @cindex @file{cdlatex.el}
16705 @cindex Dominik, Carsten
16706 Org mode can make use of the CD@LaTeX{} package to efficiently enter
16707 @LaTeX{} fragments into Org files.  See @ref{CDLaTeX mode}.
16708 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
16709 @cindex @file{imenu.el}
16710 Imenu allows menu access to an index of items in a file.  Org mode
16711 supports Imenu---all you need to do to get the index is the following:
16712 @lisp
16713 (add-hook 'org-mode-hook
16714           (lambda () (imenu-add-to-menubar "Imenu")))
16715 @end lisp
16716 @vindex org-imenu-depth
16717 By default the index is two levels deep---you can modify the depth using
16718 the option @code{org-imenu-depth}.
16719 @item @file{remember.el} by John Wiegley
16720 @cindex @file{remember.el}
16721 @cindex Wiegley, John
16722 Org used to use this package for capture, but no longer does.
16723 @item @file{speedbar.el} by Eric M. Ludlam
16724 @cindex @file{speedbar.el}
16725 @cindex Ludlam, Eric M.
16726 Speedbar is a package that creates a special frame displaying files and
16727 index items in files.  Org mode supports Speedbar and allows you to
16728 drill into Org files directly from the Speedbar.  It also allows you to
16729 restrict the scope of agenda commands to a file or a subtree by using
16730 the command @kbd{<} in the Speedbar frame.
16731 @cindex @file{table.el}
16732 @item @file{table.el} by Takaaki Ota
16733 @kindex C-c C-c
16734 @cindex table editor, @file{table.el}
16735 @cindex @file{table.el}
16736 @cindex Ota, Takaaki
16738 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
16739 and alignment can be created using the Emacs table package by Takaaki Ota
16740 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
16741 Org mode will recognize these tables and export them properly.  Because of
16742 interference with other Org mode functionality, you unfortunately cannot edit
16743 these tables directly in the buffer.  Instead, you need to use the command
16744 @kbd{C-c '} to edit them, similar to source code snippets.
16746 @table @kbd
16747 @orgcmd{C-c ',org-edit-special}
16748 Edit a @file{table.el} table.  Works when the cursor is in a table.el table.
16750 @orgcmd{C-c ~,org-table-create-with-table.el}
16751 Insert a @file{table.el} table.  If there is already a table at point, this
16752 command converts it between the @file{table.el} format and the Org mode
16753 format.  See the documentation string of the command
16754 @code{org-convert-table} for the restrictions under which this is
16755 possible.
16756 @end table
16757 @file{table.el} is part of Emacs since Emacs 22.
16758 @item @file{footnote.el} by Steven L. Baur
16759 @cindex @file{footnote.el}
16760 @cindex Baur, Steven L.
16761 Org mode recognizes numerical footnotes as provided by this package.
16762 However, Org mode also has its own footnote support (@pxref{Footnotes}),
16763 which makes using @file{footnote.el} unnecessary.
16764 @end table
16766 @node Conflicts,  , Cooperation, Interaction
16767 @subsection Packages that lead to conflicts with Org mode
16769 @table @asis
16771 @cindex @code{shift-selection-mode}
16772 @vindex org-support-shift-select
16773 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
16774 cursor motions combined with the shift key should start or enlarge regions.
16775 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
16776 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
16777 at such a location.  By default, @kbd{S-@key{cursor}} commands outside
16778 special contexts don't do anything, but you can customize the variable
16779 @code{org-support-shift-select}.  Org mode then tries to accommodate shift
16780 selection by (i) using it outside of the special contexts where special
16781 commands apply, and by (ii) extending an existing active region even if the
16782 cursor moves across a special context.
16784 @item @file{CUA.el} by Kim. F. Storm
16785 @cindex @file{CUA.el}
16786 @cindex Storm, Kim. F.
16787 @vindex org-replace-disputed-keys
16788 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
16789 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
16790 region.  In fact, Emacs 23 has this built-in in the form of
16791 @code{shift-selection-mode}, see previous paragraph.  If you are using Emacs
16792 23, you probably don't want to use another package for this purpose.  However,
16793 if you prefer to leave these keys to a different package while working in
16794 Org mode, configure the variable @code{org-replace-disputed-keys}.  When set,
16795 Org will move the following key bindings in Org files, and in the agenda
16796 buffer (but not during date selection).
16798 @example
16799 S-UP      @result{}  M-p             S-DOWN     @result{}  M-n
16800 S-LEFT    @result{}  M--             S-RIGHT    @result{}  M-+
16801 C-S-LEFT  @result{}  M-S--           C-S-RIGHT  @result{}  M-S-+
16802 @end example
16804 @vindex org-disputed-keys
16805 Yes, these are unfortunately more difficult to remember.  If you want
16806 to have other replacement keys, look at the variable
16807 @code{org-disputed-keys}.
16809 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
16810 @cindex @file{ecomplete.el}
16812 Ecomplete provides ``electric'' address completion in address header
16813 lines in message buffers.  Sadly Orgtbl mode cuts ecompletes power
16814 supply: No completion happens when Orgtbl mode is enabled in message
16815 buffers while entering text in address header lines.  If one wants to
16816 use ecomplete one should @emph{not} follow the advice to automagically
16817 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
16818 instead---after filling in the message headers---turn on Orgtbl mode
16819 manually when needed in the messages body.
16821 @item @file{filladapt.el} by Kyle Jones
16822 @cindex @file{filladapt.el}
16824 Org mode tries to do the right thing when filling paragraphs, list items and
16825 other elements.  Many users reported they had problems using both
16826 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
16827 this:
16829 @lisp
16830 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
16831 @end lisp
16833 @item @file{yasnippet.el}
16834 @cindex @file{yasnippet.el}
16835 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
16836 @code{"\t"}) overrules YASnippet's access to this key.  The following code
16837 fixed this problem:
16839 @lisp
16840 (add-hook 'org-mode-hook
16841           (lambda ()
16842             (org-set-local 'yas/trigger-key [tab])
16843             (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
16844 @end lisp
16846 The latest version of yasnippet doesn't play well with Org mode.  If the
16847 above code does not fix the conflict, start by defining the following
16848 function:
16850 @lisp
16851 (defun yas/org-very-safe-expand ()
16852   (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
16853 @end lisp
16855 Then, tell Org mode what to do with the new function:
16857 @lisp
16858 (add-hook 'org-mode-hook
16859           (lambda ()
16860             (make-variable-buffer-local 'yas/trigger-key)
16861             (setq yas/trigger-key [tab])
16862             (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
16863             (define-key yas/keymap [tab] 'yas/next-field)))
16864 @end lisp
16866 @item @file{windmove.el} by Hovav Shacham
16867 @cindex @file{windmove.el}
16868 This package also uses the @kbd{S-<cursor>} keys, so everything written
16869 in the paragraph above about CUA mode also applies here.  If you want make
16870 the windmove function active in locations where Org mode does not have
16871 special functionality on @kbd{S-@key{cursor}}, add this to your
16872 configuration:
16874 @lisp
16875 ;; Make windmove work in org-mode:
16876 (add-hook 'org-shiftup-final-hook 'windmove-up)
16877 (add-hook 'org-shiftleft-final-hook 'windmove-left)
16878 (add-hook 'org-shiftdown-final-hook 'windmove-down)
16879 (add-hook 'org-shiftright-final-hook 'windmove-right)
16880 @end lisp
16882 @item @file{viper.el} by Michael Kifer
16883 @cindex @file{viper.el}
16884 @kindex C-c /
16885 Viper uses @kbd{C-c /} and therefore makes this key not access the
16886 corresponding Org mode command @code{org-sparse-tree}.  You need to find
16887 another key for this command, or override the key in
16888 @code{viper-vi-global-user-map} with
16890 @lisp
16891 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
16892 @end lisp
16896 @end table
16898 @node org-crypt,  , Interaction, Miscellaneous
16899 @section org-crypt.el
16900 @cindex @file{org-crypt.el}
16901 @cindex @code{org-decrypt-entry}
16903 Org-crypt will encrypt the text of an entry, but not the headline, or
16904 properties.  Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
16905 files.
16907 Any text below a headline that has a @samp{:crypt:} tag will be automatically
16908 be encrypted when the file is saved.  If you want to use a different tag just
16909 customize the @code{org-crypt-tag-matcher} setting.
16911 To use org-crypt it is suggested that you have the following in your
16912 @file{.emacs}:
16914 @lisp
16915 (require 'org-crypt)
16916 (org-crypt-use-before-save-magic)
16917 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
16919 (setq org-crypt-key nil)
16920   ;; GPG key to use for encryption
16921   ;; Either the Key ID or set to nil to use symmetric encryption.
16923 (setq auto-save-default nil)
16924   ;; Auto-saving does not cooperate with org-crypt.el: so you need
16925   ;; to turn it off if you plan to use org-crypt.el quite often.
16926   ;; Otherwise, you'll get an (annoying) message each time you
16927   ;; start Org.
16929   ;; To turn it off only locally, you can insert this:
16930   ;;
16931   ;; # -*- buffer-auto-save-file-name: nil; -*-
16932 @end lisp
16934 Excluding the crypt tag from inheritance prevents already encrypted text
16935 being encrypted again.
16937 @node Hacking, MobileOrg, Miscellaneous, Top
16938 @appendix Hacking
16939 @cindex hacking
16941 This appendix covers some aspects where users can extend the functionality of
16942 Org.
16944 @menu
16945 * Hooks::                       How to reach into Org's internals
16946 * Add-on packages::             Available extensions
16947 * Adding hyperlink types::      New custom link types
16948 * Adding export back-ends::     How to write new export back-ends
16949 * Context-sensitive commands::  How to add functionality to such commands
16950 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
16951 * Dynamic blocks::              Automatically filled blocks
16952 * Special agenda views::        Customized views
16953 * Speeding up your agendas::    Tips on how to speed up your agendas
16954 * Extracting agenda information::  Post-processing of agenda information
16955 * Using the property API::      Writing programs that use entry properties
16956 * Using the mapping API::       Mapping over all or selected entries
16957 @end menu
16959 @node Hooks, Add-on packages, Hacking, Hacking
16960 @section Hooks
16961 @cindex hooks
16963 Org has a large number of hook variables that can be used to add
16964 functionality.  This appendix about hacking is going to illustrate the
16965 use of some of them.  A complete list of all hooks with documentation is
16966 maintained by the Worg project and can be found at
16967 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
16969 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
16970 @section Add-on packages
16971 @cindex add-on packages
16973 A large number of add-on packages have been written by various authors.
16975 These packages are not part of Emacs, but they are distributed as contributed
16976 packages with the separate release available at @uref{http://orgmode.org}.
16977 See the @file{contrib/README} file in the source code directory for a list of
16978 contributed files.  You may also find some more information on the Worg page:
16979 @uref{http://orgmode.org/worg/org-contrib/}.
16981 @node Adding hyperlink types, Adding export back-ends, Add-on packages, Hacking
16982 @section Adding hyperlink types
16983 @cindex hyperlinks, adding new types
16985 Org has a large number of hyperlink types built-in
16986 (@pxref{Hyperlinks}).  If you would like to add new link types, Org
16987 provides an interface for doing so.  Let's look at an example file,
16988 @file{org-man.el}, that will add support for creating links like
16989 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
16990 Emacs:
16992 @lisp
16993 ;;; org-man.el - Support for links to manpages in Org
16995 (require 'org)
16997 (org-add-link-type "man" 'org-man-open)
16998 (add-hook 'org-store-link-functions 'org-man-store-link)
17000 (defcustom org-man-command 'man
17001   "The Emacs command to be used to display a man page."
17002   :group 'org-link
17003   :type '(choice (const man) (const woman)))
17005 (defun org-man-open (path)
17006   "Visit the manpage on PATH.
17007 PATH should be a topic that can be thrown at the man command."
17008   (funcall org-man-command path))
17010 (defun org-man-store-link ()
17011   "Store a link to a manpage."
17012   (when (memq major-mode '(Man-mode woman-mode))
17013     ;; This is a man page, we do make this link
17014     (let* ((page (org-man-get-page-name))
17015            (link (concat "man:" page))
17016            (description (format "Manpage for %s" page)))
17017       (org-store-link-props
17018        :type "man"
17019        :link link
17020        :description description))))
17022 (defun org-man-get-page-name ()
17023   "Extract the page name from the buffer name."
17024   ;; This works for both `Man-mode' and `woman-mode'.
17025   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
17026       (match-string 1 (buffer-name))
17027     (error "Cannot create link to this man page")))
17029 (provide 'org-man)
17031 ;;; org-man.el ends here
17032 @end lisp
17034 @noindent
17035 You would activate this new link type in @file{.emacs} with
17037 @lisp
17038 (require 'org-man)
17039 @end lisp
17041 @noindent
17042 Let's go through the file and see what it does.
17043 @enumerate
17044 @item
17045 It does @code{(require 'org)} to make sure that @file{org.el} has been
17046 loaded.
17047 @item
17048 The next line calls @code{org-add-link-type} to define a new link type
17049 with prefix @samp{man}.  The call also contains the name of a function
17050 that will be called to follow such a link.
17051 @item
17052 @vindex org-store-link-functions
17053 The next line adds a function to @code{org-store-link-functions}, in
17054 order to allow the command @kbd{C-c l} to record a useful link in a
17055 buffer displaying a man page.
17056 @end enumerate
17058 The rest of the file defines the necessary variables and functions.
17059 First there is a customization variable that determines which Emacs
17060 command should be used to display man pages.  There are two options,
17061 @code{man} and @code{woman}.  Then the function to follow a link is
17062 defined.  It gets the link path as an argument---in this case the link
17063 path is just a topic for the manual command.  The function calls the
17064 value of @code{org-man-command} to display the man page.
17066 Finally the function @code{org-man-store-link} is defined.  When you try
17067 to store a link with @kbd{C-c l}, this function will be called to
17068 try to make a link.  The function must first decide if it is supposed to
17069 create the link for this buffer type; we do this by checking the value
17070 of the variable @code{major-mode}.  If not, the function must exit and
17071 return the value @code{nil}.  If yes, the link is created by getting the
17072 manual topic from the buffer name and prefixing it with the string
17073 @samp{man:}.  Then it must call the command @code{org-store-link-props}
17074 and set the @code{:type} and @code{:link} properties.  Optionally you
17075 can also set the @code{:description} property to provide a default for
17076 the link description when the link is later inserted into an Org
17077 buffer with @kbd{C-c C-l}.
17079 When it makes sense for your new link type, you may also define a function
17080 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
17081 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
17082 not accept any arguments, and return the full link with prefix.
17084 @node Adding export back-ends, Context-sensitive commands, Adding hyperlink types, Hacking
17085 @section Adding export back-ends
17086 @cindex Export, writing back-ends
17088 Org 8.0 comes with a completely rewritten export engine which makes it easy
17089 to write new export back-ends, either from scratch, or from deriving them
17090 from existing ones.
17092 Your two entry points are respectively @code{org-export-define-backend} and
17093 @code{org-export-define-derived-backend}.  To grok these functions, you
17094 should first have a look at @file{ox-latex.el} (for how to define a new
17095 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
17096 back-end from an existing one.
17098 When creating a new back-end from scratch, the basic idea is to set the name
17099 of the back-end (as a symbol) and an an alist of elements and export
17100 functions.  On top of this, you will need to set additional keywords like
17101 @code{:menu-entry} (to display the back-end in the export dispatcher),
17102 @code{:export-block} (to specify what blocks should not be exported by this
17103 back-end), and @code{:options-alist} (to let the user set export options that
17104 are specific to this back-end.)
17106 Deriving a new back-end is similar, except that you need to set
17107 @code{:translate-alist} to an alist of export functions that should be used
17108 instead of the parent back-end functions.
17110 For a complete reference documentation, see
17111 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
17112 Reference on Worg}.
17114 @node Context-sensitive commands, Tables in arbitrary syntax, Adding export back-ends, Hacking
17115 @section Context-sensitive commands
17116 @cindex context-sensitive commands, hooks
17117 @cindex add-ons, context-sensitive commands
17118 @vindex org-ctrl-c-ctrl-c-hook
17120 Org has several commands that act differently depending on context.  The most
17121 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
17122 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
17124 Add-ons can tap into this functionality by providing a function that detects
17125 special context for that add-on and executes functionality appropriate for
17126 the context.  Here is an example from Dan Davison's @file{org-R.el} which
17127 allows you to evaluate commands based on the @file{R} programming language
17128 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
17129 described in @ref{Working With Source Code} and is now obsolete.}.  For this
17130 package, special contexts are lines that start with @code{#+R:} or
17131 @code{#+RR:}.
17133 @lisp
17134 (defun org-R-apply-maybe ()
17135   "Detect if this is context for org-R and execute R commands."
17136   (if (save-excursion
17137         (beginning-of-line 1)
17138         (looking-at "#\\+RR?:"))
17139       (progn (call-interactively 'org-R-apply)
17140              t) ;; to signal that we took action
17141     nil)) ;; to signal that we did not
17143 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
17144 @end lisp
17146 The function first checks if the cursor is in such a line.  If that is the
17147 case, @code{org-R-apply} is called and the function returns @code{t} to
17148 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
17149 contexts.  If the function finds it should do nothing locally, it returns
17150 @code{nil} so that other, similar functions can have a try.
17153 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
17154 @section Tables and lists in arbitrary syntax
17155 @cindex tables, in other modes
17156 @cindex lists, in other modes
17157 @cindex Orgtbl mode
17159 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
17160 frequent feature request has been to make it work with native tables in
17161 specific languages, for example @LaTeX{}.  However, this is extremely
17162 hard to do in a general way, would lead to a customization nightmare,
17163 and would take away much of the simplicity of the Orgtbl mode table
17164 editor.
17166 This appendix describes a different approach.  We keep the Orgtbl mode
17167 table in its native format (the @i{source table}), and use a custom
17168 function to @i{translate} the table to the correct syntax, and to
17169 @i{install} it in the right location (the @i{target table}).  This puts
17170 the burden of writing conversion functions on the user, but it allows
17171 for a very flexible system.
17173 Bastien added the ability to do the same with lists, in Orgstruct mode.  You
17174 can use Org's facilities to edit and structure lists by turning
17175 @code{orgstruct-mode} on, then locally exporting such lists in another format
17176 (HTML, @LaTeX{} or Texinfo.)
17179 @menu
17180 * Radio tables::                Sending and receiving radio tables
17181 * A @LaTeX{} example::          Step by step, almost a tutorial
17182 * Translator functions::        Copy and modify
17183 * Radio lists::                 Sending and receiving lists
17184 @end menu
17186 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
17187 @subsection Radio tables
17188 @cindex radio tables
17190 To define the location of the target table, you first need to create two
17191 lines that are comments in the current mode, but contain magic words
17192 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find.  Orgtbl mode will
17193 insert the translated table between these lines, replacing whatever was there
17194 before.  For example in C mode where comments are between @code{/* ... */}:
17196 @example
17197 /* BEGIN RECEIVE ORGTBL table_name */
17198 /* END RECEIVE ORGTBL table_name */
17199 @end example
17201 @noindent
17202 Just above the source table, we put a special line that tells
17203 Orgtbl mode how to translate this table and where to install it.  For
17204 example:
17205 @cindex #+ORGTBL
17206 @example
17207 #+ORGTBL: SEND table_name translation_function arguments...
17208 @end example
17210 @noindent
17211 @code{table_name} is the reference name for the table that is also used
17212 in the receiver lines.  @code{translation_function} is the Lisp function
17213 that does the translation.  Furthermore, the line can contain a list of
17214 arguments (alternating key and value) at the end.  The arguments will be
17215 passed as a property list to the translation function for
17216 interpretation.  A few standard parameters are already recognized and
17217 acted upon before the translation function is called:
17219 @table @code
17220 @item :skip N
17221 Skip the first N lines of the table.  Hlines do count as separate lines for
17222 this parameter!
17224 @item :skipcols (n1 n2 ...)
17225 List of columns that should be skipped.  If the table has a column with
17226 calculation marks, that column is automatically discarded as well.
17227 Please note that the translator function sees the table @emph{after} the
17228 removal of these columns, the function never knows that there have been
17229 additional columns.
17231 @item :no-escape t
17232 When non-@code{nil}, do not escape special characters @code{&%#_^} when exporting
17233 the table.  The default value is @code{nil}.
17234 @end table
17236 @noindent
17237 The one problem remaining is how to keep the source table in the buffer
17238 without disturbing the normal workings of the file, for example during
17239 compilation of a C file or processing of a @LaTeX{} file.  There are a
17240 number of different solutions:
17242 @itemize @bullet
17243 @item
17244 The table could be placed in a block comment if that is supported by the
17245 language.  For example, in C mode you could wrap the table between
17246 @samp{/*} and @samp{*/} lines.
17247 @item
17248 Sometimes it is possible to put the table after some kind of @i{END}
17249 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
17250 in @LaTeX{}.
17251 @item
17252 You can just comment the table line-by-line whenever you want to process
17253 the file, and uncomment it whenever you need to edit the table.  This
17254 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
17255 makes this comment-toggling very easy, in particular if you bind it to a
17256 key.
17257 @end itemize
17259 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
17260 @subsection A @LaTeX{} example of radio tables
17261 @cindex @LaTeX{}, and Orgtbl mode
17263 The best way to wrap the source table in @LaTeX{} is to use the
17264 @code{comment} environment provided by @file{comment.sty}.  It has to be
17265 activated by placing @code{\usepackage@{comment@}} into the document
17266 header.  Orgtbl mode can insert a radio table skeleton@footnote{By
17267 default this works only for @LaTeX{}, HTML, and Texinfo.  Configure the
17268 variable @code{orgtbl-radio-table-templates} to install templates for other
17269 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table RET}.  You will
17270 be prompted for a table name, let's say we use @samp{salesfigures}.  You
17271 will then get the following template:
17273 @cindex #+ORGTBL, SEND
17274 @example
17275 % BEGIN RECEIVE ORGTBL salesfigures
17276 % END RECEIVE ORGTBL salesfigures
17277 \begin@{comment@}
17278 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17279 | | |
17280 \end@{comment@}
17281 @end example
17283 @noindent
17284 @vindex @LaTeX{}-verbatim-environments
17285 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
17286 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
17287 into the receiver location with name @code{salesfigures}.  You may now
17288 fill in the table---feel free to use the spreadsheet features@footnote{If
17289 the @samp{#+TBLFM} line contains an odd number of dollar characters,
17290 this may cause problems with font-lock in @LaTeX{} mode.  As shown in the
17291 example you can fix this by adding an extra line inside the
17292 @code{comment} environment that is used to balance the dollar
17293 expressions.  If you are using AUC@TeX{} with the font-latex library, a
17294 much better solution is to add the @code{comment} environment to the
17295 variable @code{LaTeX-verbatim-environments}.}:
17297 @example
17298 % BEGIN RECEIVE ORGTBL salesfigures
17299 % END RECEIVE ORGTBL salesfigures
17300 \begin@{comment@}
17301 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17302 | Month | Days | Nr sold | per day |
17303 |-------+------+---------+---------|
17304 | Jan   |   23 |      55 |     2.4 |
17305 | Feb   |   21 |      16 |     0.8 |
17306 | March |   22 |     278 |    12.6 |
17307 #+TBLFM: $4=$3/$2;%.1f
17308 % $ (optional extra dollar to keep font-lock happy, see footnote)
17309 \end@{comment@}
17310 @end example
17312 @noindent
17313 When you are done, press @kbd{C-c C-c} in the table to get the converted
17314 table inserted between the two marker lines.
17316 Now let's assume you want to make the table header by hand, because you
17317 want to control how columns are aligned, etc.  In this case we make sure
17318 that the table translator skips the first 2 lines of the source
17319 table, and tell the command to work as a @i{splice}, i.e., to not produce
17320 header and footer commands of the target table:
17322 @example
17323 \begin@{tabular@}@{lrrr@}
17324 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
17325 % BEGIN RECEIVE ORGTBL salesfigures
17326 % END RECEIVE ORGTBL salesfigures
17327 \end@{tabular@}
17329 \begin@{comment@}
17330 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
17331 | Month | Days | Nr sold | per day |
17332 |-------+------+---------+---------|
17333 | Jan   |   23 |      55 |     2.4 |
17334 | Feb   |   21 |      16 |     0.8 |
17335 | March |   22 |     278 |    12.6 |
17336 #+TBLFM: $4=$3/$2;%.1f
17337 \end@{comment@}
17338 @end example
17340 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
17341 Orgtbl mode.  It uses a @code{tabular} environment to typeset the table
17342 and marks horizontal lines with @code{\hline}.  Furthermore, it
17343 interprets the following parameters (see also @pxref{Translator functions}):
17345 @table @code
17346 @item :splice nil/t
17347 When set to t, return only table body lines, don't wrap them into a
17348 tabular environment.  Default is @code{nil}.
17350 @item :fmt fmt
17351 A format to be used to wrap each field, it should contain @code{%s} for the
17352 original field value.  For example, to wrap each field value in dollars,
17353 you could use @code{:fmt "$%s$"}.  This may also be a property list with
17354 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
17355 A function of one argument can be used in place of the strings; the
17356 function must return a formatted string.
17358 @item :efmt efmt
17359 Use this format to print numbers with exponentials.  The format should
17360 have @code{%s} twice for inserting mantissa and exponent, for example
17361 @code{"%s\\times10^@{%s@}"}.  The default is @code{"%s\\,(%s)"}.  This
17362 may also be a property list with column numbers and formats, for example
17363 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}.  After
17364 @code{efmt} has been applied to a value, @code{fmt} will also be
17365 applied.  Similar to @code{fmt}, functions of two arguments can be
17366 supplied instead of strings.
17367 @end table
17369 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
17370 @subsection Translator functions
17371 @cindex HTML, and Orgtbl mode
17372 @cindex translator function
17374 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
17375 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
17376 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
17377 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
17378 code that produces tables during HTML export.}, these all use a generic
17379 translator, @code{orgtbl-to-generic}.  For example, @code{orgtbl-to-latex}
17380 itself is a very short function that computes the column definitions for the
17381 @code{tabular} environment, defines a few field and line separators and then
17382 hands processing over to the generic translator.  Here is the entire code:
17384 @lisp
17385 @group
17386 (defun orgtbl-to-latex (table params)
17387   "Convert the Orgtbl mode TABLE to LaTeX."
17388   (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
17389                                org-table-last-alignment ""))
17390          (params2
17391           (list
17392            :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
17393            :tend "\\end@{tabular@}"
17394            :lstart "" :lend " \\\\" :sep " & "
17395            :efmt "%s\\,(%s)" :hline "\\hline")))
17396     (orgtbl-to-generic table (org-combine-plists params2 params))))
17397 @end group
17398 @end lisp
17400 As you can see, the properties passed into the function (variable
17401 @var{PARAMS}) are combined with the ones newly defined in the function
17402 (variable @var{PARAMS2}).  The ones passed into the function (i.e., the
17403 ones set by the @samp{ORGTBL SEND} line) take precedence.  So if you
17404 would like to use the @LaTeX{} translator, but wanted the line endings to
17405 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
17406 overrule the default with
17408 @example
17409 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
17410 @end example
17412 For a new language, you can either write your own converter function in
17413 analogy with the @LaTeX{} translator, or you can use the generic function
17414 directly.  For example, if you have a language where a table is started
17415 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
17416 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
17417 separator is a TAB, you could call the generic translator like this (on
17418 a single line!):
17420 @example
17421 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
17422                               :lstart "!BL! " :lend " !EL!" :sep "\t"
17423 @end example
17425 @noindent
17426 Please check the documentation string of the function
17427 @code{orgtbl-to-generic} for a full list of parameters understood by
17428 that function, and remember that you can pass each of them into
17429 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
17430 using the generic function.
17432 Of course you can also write a completely new function doing complicated
17433 things the generic translator cannot do.  A translator function takes
17434 two arguments.  The first argument is the table, a list of lines, each
17435 line either the symbol @code{hline} or a list of fields.  The second
17436 argument is the property list containing all parameters specified in the
17437 @samp{#+ORGTBL: SEND} line.  The function must return a single string
17438 containing the formatted table.  If you write a generally useful
17439 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
17440 others can benefit from your work.
17442 @node Radio lists,  , Translator functions, Tables in arbitrary syntax
17443 @subsection Radio lists
17444 @cindex radio lists
17445 @cindex org-list-insert-radio-list
17447 Sending and receiving radio lists works exactly the same way as sending and
17448 receiving radio tables (@pxref{Radio tables}).  As for radio tables, you can
17449 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
17450 @code{org-list-insert-radio-list}.
17452 Here are the differences with radio tables:
17454 @itemize @minus
17455 @item
17456 Orgstruct mode must be active.
17457 @item
17458 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
17459 @item
17460 The available translation functions for radio lists don't take
17461 parameters.
17462 @item
17463 @kbd{C-c C-c} will work when pressed on the first item of the list.
17464 @end itemize
17466 Here is a @LaTeX{} example.  Let's say that you have this in your
17467 @LaTeX{} file:
17469 @cindex #+ORGLST
17470 @example
17471 % BEGIN RECEIVE ORGLST to-buy
17472 % END RECEIVE ORGLST to-buy
17473 \begin@{comment@}
17474 #+ORGLST: SEND to-buy org-list-to-latex
17475 - a new house
17476 - a new computer
17477   + a new keyboard
17478   + a new mouse
17479 - a new life
17480 \end@{comment@}
17481 @end example
17483 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
17484 @LaTeX{} list between the two marker lines.
17486 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
17487 @section Dynamic blocks
17488 @cindex dynamic blocks
17490 Org documents can contain @emph{dynamic blocks}.  These are
17491 specially marked regions that are updated by some user-written function.
17492 A good example for such a block is the clock table inserted by the
17493 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
17495 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
17496 to the block and can also specify parameters for the function producing
17497 the content of the block.
17499 @cindex #+BEGIN:dynamic block
17500 @example
17501 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
17503 #+END:
17504 @end example
17506 Dynamic blocks are updated with the following commands
17508 @table @kbd
17509 @orgcmd{C-c C-x C-u,org-dblock-update}
17510 Update dynamic block at point.
17511 @orgkey{C-u C-c C-x C-u}
17512 Update all dynamic blocks in the current file.
17513 @end table
17515 Updating a dynamic block means to remove all the text between BEGIN and
17516 END, parse the BEGIN line for parameters and then call the specific
17517 writer function for this block to insert the new content.  If you want
17518 to use the original content in the writer function, you can use the
17519 extra parameter @code{:content}.
17521 For a block with name @code{myblock}, the writer function is
17522 @code{org-dblock-write:myblock} with as only parameter a property list
17523 with the parameters given in the begin line.  Here is a trivial example
17524 of a block that keeps track of when the block update function was last
17525 run:
17527 @example
17528 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
17530 #+END:
17531 @end example
17533 @noindent
17534 The corresponding block writer function could look like this:
17536 @lisp
17537 (defun org-dblock-write:block-update-time (params)
17538   (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
17539     (insert "Last block update at: "
17540             (format-time-string fmt (current-time)))))
17541 @end lisp
17543 If you want to make sure that all dynamic blocks are always up-to-date,
17544 you could add the function @code{org-update-all-dblocks} to a hook, for
17545 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
17546 written in a way such that it does nothing in buffers that are not in
17547 @code{org-mode}.
17549 You can narrow the current buffer to the current dynamic block (like any
17550 other block) with @code{org-narrow-to-block}.
17552 @node Special agenda views, Speeding up your agendas, Dynamic blocks, Hacking
17553 @section Special agenda views
17554 @cindex agenda views, user-defined
17556 @vindex org-agenda-skip-function
17557 @vindex org-agenda-skip-function-global
17558 Org provides a special hook that can be used to narrow down the selection
17559 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
17560 @code{agenda*} view is the same than @code{agenda} except that it only
17561 considers @emph{appointments}, i.e., scheduled and deadline items that have a
17562 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
17563 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}.  You may
17564 specify a function that is used at each match to verify if the match should
17565 indeed be part of the agenda view, and if not, how much should be skipped.
17566 You can specify a global condition that will be applied to all agenda views,
17567 this condition would be stored in the variable
17568 @code{org-agenda-skip-function-global}.  More commonly, such a definition is
17569 applied only to specific custom searches, using
17570 @code{org-agenda-skip-function}.
17572 Let's say you want to produce a list of projects that contain a WAITING
17573 tag anywhere in the project tree.  Let's further assume that you have
17574 marked all tree headings that define a project with the TODO keyword
17575 PROJECT@.  In this case you would run a TODO search for the keyword
17576 PROJECT, but skip the match unless there is a WAITING tag anywhere in
17577 the subtree belonging to the project line.
17579 To achieve this, you must write a function that searches the subtree for
17580 the tag.  If the tag is found, the function must return @code{nil} to
17581 indicate that this match should not be skipped.  If there is no such
17582 tag, return the location of the end of the subtree, to indicate that
17583 search should continue from there.
17585 @lisp
17586 (defun my-skip-unless-waiting ()
17587   "Skip trees that are not waiting"
17588   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
17589     (if (re-search-forward ":waiting:" subtree-end t)
17590         nil          ; tag found, do not skip
17591       subtree-end))) ; tag not found, continue after end of subtree
17592 @end lisp
17594 Now you may use this function in an agenda custom command, for example
17595 like this:
17597 @lisp
17598 (org-add-agenda-custom-command
17599  '("b" todo "PROJECT"
17600    ((org-agenda-skip-function 'my-skip-unless-waiting)
17601     (org-agenda-overriding-header "Projects waiting for something: "))))
17602 @end lisp
17604 @vindex org-agenda-overriding-header
17605 Note that this also binds @code{org-agenda-overriding-header} to get a
17606 meaningful header in the agenda view.
17608 @vindex org-odd-levels-only
17609 @vindex org-agenda-skip-function
17610 A general way to create custom searches is to base them on a search for
17611 entries with a certain level limit.  If you want to study all entries with
17612 your custom search function, simply do a search for
17613 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
17614 level number corresponds to order in the hierarchy, not to the number of
17615 stars.}, and then use @code{org-agenda-skip-function} to select the entries
17616 you really want to have.
17618 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
17619 particular, you may use the functions @code{org-agenda-skip-entry-if}
17620 and @code{org-agenda-skip-subtree-if} in this form, for example:
17622 @table @code
17623 @item (org-agenda-skip-entry-if 'scheduled)
17624 Skip current entry if it has been scheduled.
17625 @item (org-agenda-skip-entry-if 'notscheduled)
17626 Skip current entry if it has not been scheduled.
17627 @item (org-agenda-skip-entry-if 'deadline)
17628 Skip current entry if it has a deadline.
17629 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
17630 Skip current entry if it has a deadline, or if it is scheduled.
17631 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
17632 Skip current entry if the TODO keyword is TODO or WAITING.
17633 @item (org-agenda-skip-entry-if 'todo 'done)
17634 Skip current entry if the TODO keyword marks a DONE state.
17635 @item (org-agenda-skip-entry-if 'timestamp)
17636 Skip current entry if it has any timestamp, may also be deadline or scheduled.
17637 @anchor{x-agenda-skip-entry-regexp}
17638 @item (org-agenda-skip-entry-if 'regexp "regular expression")
17639 Skip current entry if the regular expression matches in the entry.
17640 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
17641 Skip current entry unless the regular expression matches.
17642 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
17643 Same as above, but check and skip the entire subtree.
17644 @end table
17646 Therefore we could also have written the search for WAITING projects
17647 like this, even without defining a special function:
17649 @lisp
17650 (org-add-agenda-custom-command
17651  '("b" todo "PROJECT"
17652    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
17653                                 'regexp ":waiting:"))
17654     (org-agenda-overriding-header "Projects waiting for something: "))))
17655 @end lisp
17657 @node Speeding up your agendas, Extracting agenda information, Special agenda views, Hacking
17658 @section Speeding up your agendas
17659 @cindex agenda views, optimization
17661 When your Org files grow in both number and size, agenda commands may start
17662 to become slow.  Below are some tips on how to speed up the agenda commands.
17664 @enumerate
17665 @item
17666 Reduce the number of Org agenda files: this will reduce the slowness caused
17667 by accessing a hard drive.
17668 @item
17669 Reduce the number of DONE and archived headlines: this way the agenda does
17670 not need to skip them.
17671 @item
17672 @vindex org-agenda-dim-blocked-tasks
17673 Inhibit the dimming of blocked tasks:
17674 @lisp
17675 (setq org-agenda-dim-blocked-tasks nil)
17676 @end lisp
17677 @item
17678 @vindex org-startup-folded
17679 @vindex org-agenda-inhibit-startup
17680 Inhibit agenda files startup options:
17681 @lisp
17682 (setq org-agenda-inhibit-startup nil)
17683 @end lisp
17684 @item
17685 @vindex org-agenda-show-inherited-tags
17686 @vindex org-agenda-use-tag-inheritance
17687 Disable tag inheritance in agenda:
17688 @lisp
17689 (setq org-agenda-use-tag-inheritance nil)
17690 @end lisp
17691 @end enumerate
17693 You can set these options for specific agenda views only.  See the docstrings
17694 of these variables for details on why they affect the agenda generation, and
17695 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
17696 page} for further explanations.
17698 @node Extracting agenda information, Using the property API, Speeding up your agendas, Hacking
17699 @section Extracting agenda information
17700 @cindex agenda, pipe
17701 @cindex Scripts, for agenda processing
17703 @vindex org-agenda-custom-commands
17704 Org provides commands to access agenda information for the command
17705 line in Emacs batch mode.  This extracted information can be sent
17706 directly to a printer, or it can be read by a program that does further
17707 processing of the data.  The first of these commands is the function
17708 @code{org-batch-agenda}, that produces an agenda view and sends it as
17709 ASCII text to STDOUT@.  The command takes a single string as parameter.
17710 If the string has length 1, it is used as a key to one of the commands
17711 you have configured in @code{org-agenda-custom-commands}, basically any
17712 key you can use after @kbd{C-c a}.  For example, to directly print the
17713 current TODO list, you could use
17715 @example
17716 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
17717 @end example
17719 If the parameter is a string with 2 or more characters, it is used as a
17720 tags/TODO match string.  For example, to print your local shopping list
17721 (all items with the tag @samp{shop}, but excluding the tag
17722 @samp{NewYork}), you could use
17724 @example
17725 emacs -batch -l ~/.emacs                                      \
17726       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
17727 @end example
17729 @noindent
17730 You may also modify parameters on the fly like this:
17732 @example
17733 emacs -batch -l ~/.emacs                                      \
17734    -eval '(org-batch-agenda "a"                               \
17735             org-agenda-span (quote month)                     \
17736             org-agenda-include-diary nil                      \
17737             org-agenda-files (quote ("~/org/project.org")))'  \
17738    | lpr
17739 @end example
17741 @noindent
17742 which will produce a 30-day agenda, fully restricted to the Org file
17743 @file{~/org/projects.org}, not even including the diary.
17745 If you want to process the agenda data in more sophisticated ways, you
17746 can use the command @code{org-batch-agenda-csv} to get a comma-separated
17747 list of values for each agenda item.  Each line in the output will
17748 contain a number of fields separated by commas.  The fields in a line
17749 are:
17751 @example
17752 category     @r{The category of the item}
17753 head         @r{The headline, without TODO keyword, TAGS and PRIORITY}
17754 type         @r{The type of the agenda entry, can be}
17755                 todo               @r{selected in TODO match}
17756                 tagsmatch          @r{selected in tags match}
17757                 diary              @r{imported from diary}
17758                 deadline           @r{a deadline}
17759                 scheduled          @r{scheduled}
17760                 timestamp          @r{appointment, selected by timestamp}
17761                 closed             @r{entry was closed on date}
17762                 upcoming-deadline  @r{warning about nearing deadline}
17763                 past-scheduled     @r{forwarded scheduled item}
17764                 block              @r{entry has date block including date}
17765 todo         @r{The TODO keyword, if any}
17766 tags         @r{All tags including inherited ones, separated by colons}
17767 date         @r{The relevant date, like 2007-2-14}
17768 time         @r{The time, like 15:00-16:50}
17769 extra        @r{String with extra planning info}
17770 priority-l   @r{The priority letter if any was given}
17771 priority-n   @r{The computed numerical priority}
17772 @end example
17774 @noindent
17775 Time and date will only be given if a timestamp (or deadline/scheduled)
17776 led to the selection of the item.
17778 A CSV list like this is very easy to use in a post-processing script.
17779 For example, here is a Perl program that gets the TODO list from
17780 Emacs/Org and prints all the items, preceded by a checkbox:
17782 @example
17783 #!/usr/bin/perl
17785 # define the Emacs command to run
17786 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
17788 # run it and capture the output
17789 $agenda = qx@{$cmd 2>/dev/null@};
17791 # loop over all lines
17792 foreach $line (split(/\n/,$agenda)) @{
17793   # get the individual values
17794   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
17795    $priority_l,$priority_n) = split(/,/,$line);
17796   # process and print
17797   print "[ ] $head\n";
17799 @end example
17801 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
17802 @section Using the property API
17803 @cindex API, for properties
17804 @cindex properties, API
17806 Here is a description of the functions that can be used to work with
17807 properties.
17809 @defun org-entry-properties &optional pom which
17810 Get all properties of the entry at point-or-marker POM.@*
17811 This includes the TODO keyword, the tags, time strings for deadline,
17812 scheduled, and clocking, and any additional properties defined in the
17813 entry.  The return value is an alist.  Keys may occur multiple times
17814 if the property key was used several times.@*
17815 POM may also be @code{nil}, in which case the current entry is used.
17816 If WHICH is @code{nil} or `all', get all properties.  If WHICH is
17817 `special' or `standard', only get that subclass.
17818 @end defun
17819 @vindex org-use-property-inheritance
17820 @findex org-insert-property-drawer
17821 @defun org-entry-get pom property &optional inherit
17822 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@.  By default,
17823 this only looks at properties defined locally in the entry.  If @code{INHERIT}
17824 is non-@code{nil} and the entry does not have the property, then also check
17825 higher levels of the hierarchy.  If @code{INHERIT} is the symbol
17826 @code{selective}, use inheritance if and only if the setting of
17827 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
17828 @end defun
17830 @defun org-entry-delete pom property
17831 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
17832 @end defun
17834 @defun org-entry-put pom property value
17835 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
17836 @end defun
17838 @defun org-buffer-property-keys &optional include-specials
17839 Get all property keys in the current buffer.
17840 @end defun
17842 @defun org-insert-property-drawer
17843 Insert a property drawer for the current entry.  Also
17844 @end defun
17846 @defun org-entry-put-multivalued-property pom property &rest values
17847 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
17848 @code{VALUES} should be a list of strings.  They will be concatenated, with
17849 spaces as separators.
17850 @end defun
17852 @defun org-entry-get-multivalued-property pom property
17853 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17854 list of values and return the values as a list of strings.
17855 @end defun
17857 @defun org-entry-add-to-multivalued-property pom property value
17858 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17859 list of values and make sure that @code{VALUE} is in this list.
17860 @end defun
17862 @defun org-entry-remove-from-multivalued-property pom property value
17863 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17864 list of values and make sure that @code{VALUE} is @emph{not} in this list.
17865 @end defun
17867 @defun org-entry-member-in-multivalued-property pom property value
17868 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17869 list of values and check if @code{VALUE} is in this list.
17870 @end defun
17872 @defopt org-property-allowed-value-functions
17873 Hook for functions supplying allowed values for a specific property.
17874 The functions must take a single argument, the name of the property, and
17875 return a flat list of allowed values.  If @samp{:ETC} is one of
17876 the values, use the values as completion help, but allow also other values
17877 to be entered.  The functions must return @code{nil} if they are not
17878 responsible for this property.
17879 @end defopt
17881 @node Using the mapping API,  , Using the property API, Hacking
17882 @section Using the mapping API
17883 @cindex API, for mapping
17884 @cindex mapping entries, API
17886 Org has sophisticated mapping capabilities to find all entries satisfying
17887 certain criteria.  Internally, this functionality is used to produce agenda
17888 views, but there is also an API that can be used to execute arbitrary
17889 functions for each or selected entries.  The main entry point for this API
17892 @defun org-map-entries func &optional match scope &rest skip
17893 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
17895 @code{FUNC} is a function or a Lisp form.  The function will be called
17896 without arguments, with the cursor positioned at the beginning of the
17897 headline.  The return values of all calls to the function will be collected
17898 and returned as a list.
17900 The call to @code{FUNC} will be wrapped into a save-excursion form, so
17901 @code{FUNC} does not need to preserve point.  After evaluation, the cursor
17902 will be moved to the end of the line (presumably of the headline of the
17903 processed entry) and search continues from there.  Under some circumstances,
17904 this may not produce the wanted results.  For example, if you have removed
17905 (e.g., archived) the current (sub)tree it could mean that the next entry will
17906 be skipped entirely.  In such cases, you can specify the position from where
17907 search should continue by making @code{FUNC} set the variable
17908 @code{org-map-continue-from} to the desired buffer position.
17910 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
17911 view.  Only headlines that are matched by this query will be considered
17912 during the iteration.  When @code{MATCH} is @code{nil} or @code{t}, all
17913 headlines will be visited by the iteration.
17915 @code{SCOPE} determines the scope of this command.  It can be any of:
17917 @example
17918 nil     @r{the current buffer, respecting the restriction if any}
17919 tree    @r{the subtree started with the entry at point}
17920 region  @r{The entries within the active region, if any}
17921 file    @r{the current buffer, without restriction}
17922 file-with-archives
17923         @r{the current buffer, and any archives associated with it}
17924 agenda  @r{all agenda files}
17925 agenda-with-archives
17926         @r{all agenda files with any archive files associated with them}
17927 (file1 file2 ...)
17928         @r{if this is a list, all files in the list will be scanned}
17929 @end example
17930 @noindent
17931 The remaining args are treated as settings for the skipping facilities of
17932 the scanner.  The following items can be given here:
17934 @vindex org-agenda-skip-function
17935 @example
17936 archive   @r{skip trees with the archive tag}
17937 comment   @r{skip trees with the COMMENT keyword}
17938 function or Lisp form
17939           @r{will be used as value for @code{org-agenda-skip-function},}
17940           @r{so whenever the function returns t, FUNC}
17941           @r{will not be called for that entry and search will}
17942           @r{continue from the point where the function leaves it}
17943 @end example
17944 @end defun
17946 The function given to that mapping routine can really do anything you like.
17947 It can use the property API (@pxref{Using the property API}) to gather more
17948 information about the entry, or in order to change metadata in the entry.
17949 Here are a couple of functions that might be handy:
17951 @defun org-todo &optional arg
17952 Change the TODO state of the entry.  See the docstring of the functions for
17953 the many possible values for the argument @code{ARG}.
17954 @end defun
17956 @defun org-priority &optional action
17957 Change the priority of the entry.  See the docstring of this function for the
17958 possible values for @code{ACTION}.
17959 @end defun
17961 @defun org-toggle-tag tag &optional onoff
17962 Toggle the tag @code{TAG} in the current entry.  Setting @code{ONOFF} to
17963 either @code{on} or @code{off} will not toggle tag, but ensure that it is
17964 either on or off.
17965 @end defun
17967 @defun org-promote
17968 Promote the current entry.
17969 @end defun
17971 @defun org-demote
17972 Demote the current entry.
17973 @end defun
17975 Here is a simple example that will turn all entries in the current file with
17976 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
17977 Entries in comment trees and in archive trees will be ignored.
17979 @lisp
17980 (org-map-entries
17981  '(org-todo "UPCOMING")
17982  "+TOMORROW" 'file 'archive 'comment)
17983 @end lisp
17985 The following example counts the number of entries with TODO keyword
17986 @code{WAITING}, in all agenda files.
17988 @lisp
17989 (length (org-map-entries t "/+WAITING" 'agenda))
17990 @end lisp
17992 @node MobileOrg, History and Acknowledgments, Hacking, Top
17993 @appendix MobileOrg
17994 @cindex iPhone
17995 @cindex MobileOrg
17997 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
17998 available for iOS and for Android.  @i{MobileOrg} offers offline viewing and
17999 capture support for an Org mode system rooted on a ``real'' computer.  It
18000 does also allow you to record changes to existing entries.  The
18001 @uref{https://github.com/MobileOrg/, iOS implementation} for the
18002 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
18003 and is now in the hands Sean Escriva.  Android users should check out
18004 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
18005 by Matt Jones.  The two implementations are not identical but offer similar
18006 features.
18008 This appendix describes the support Org has for creating agenda views in a
18009 format that can be displayed by @i{MobileOrg}, and for integrating notes
18010 captured and changes made by @i{MobileOrg} into the main system.
18012 For changing tags and TODO states in MobileOrg, you should have set up the
18013 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
18014 cover all important tags and TODO keywords, even if individual files use only
18015 part of these.  MobileOrg will also offer you states and tags set up with
18016 in-buffer settings, but it will understand the logistics of TODO state
18017 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
18018 (@pxref{Setting tags}) only for those set in these variables.
18020 @menu
18021 * Setting up the staging area::  Where to interact with the mobile device
18022 * Pushing to MobileOrg::        Uploading Org files and agendas
18023 * Pulling from MobileOrg::      Integrating captured and flagged items
18024 @end menu
18026 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
18027 @section Setting up the staging area
18029 MobileOrg needs to interact with Emacs through a directory on a server.  If you
18030 are using a public server, you should consider to encrypt the files that are
18031 uploaded to the server.  This can be done with Org mode 7.02 and with
18032 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
18033 installation on your system.  To turn on encryption, set a password in
18034 @i{MobileOrg} and, on the Emacs side, configure the variable
18035 @code{org-mobile-use-encryption}@footnote{If you can safely store the
18036 password in your Emacs setup, you might also want to configure
18037 @code{org-mobile-encryption-password}.  Please read the docstring of that
18038 variable.  Note that encryption will apply only to the contents of the
18039 @file{.org} files.  The file names themselves will remain visible.}.
18041 The easiest way to create that directory is to use a free
18042 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
18043 Dropbox, or if your version of MobileOrg does not support it, you can use a
18044 webdav server.  For more information, check out the documentation of MobileOrg and also this
18045 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
18046 When MobileOrg first connects to your Dropbox, it will create a directory
18047 @i{MobileOrg} inside the Dropbox.  After the directory has been created, tell
18048 Emacs about it:
18050 @lisp
18051 (setq org-mobile-directory "~/Dropbox/MobileOrg")
18052 @end lisp
18054 Org mode has commands to put files for @i{MobileOrg} into that directory,
18055 and to read captured notes from there.
18057 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
18058 @section Pushing to MobileOrg
18060 This operation copies all files currently listed in @code{org-mobile-files}
18061 to the directory @code{org-mobile-directory}.  By default this list contains
18062 all agenda files (as listed in @code{org-agenda-files}), but additional files
18063 can be included by customizing @code{org-mobile-files}.  File names will be
18064 staged with paths relative to @code{org-directory}, so all files should be
18065 inside this directory@footnote{Symbolic links in @code{org-directory} need to
18066 have the same name than their targets.}.
18068 The push operation also creates a special Org file @file{agendas.org} with
18069 all custom agenda view defined by the user@footnote{While creating the
18070 agendas, Org mode will force ID properties on all referenced entries, so that
18071 these entries can be uniquely identified if @i{MobileOrg} flags them for
18072 further action.  If you do not want to get these properties in so many
18073 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
18074 to @code{nil}.  Org mode will then rely on outline paths, in the hope that
18075 these will be unique enough.}.
18077 Finally, Org writes the file @file{index.org}, containing links to all other
18078 files.  @i{MobileOrg} first reads this file from the server, and then
18079 downloads all agendas and Org files listed in it.  To speed up the download,
18080 MobileOrg will only read files whose checksums@footnote{Checksums are stored
18081 automatically in the file @file{checksums.dat}} have changed.
18083 @node Pulling from MobileOrg,  , Pushing to MobileOrg, MobileOrg
18084 @section Pulling from MobileOrg
18086 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
18087 files for viewing.  It also appends captured entries and pointers to flagged
18088 and changed entries to the file @file{mobileorg.org} on the server.  Org has
18089 a @emph{pull} operation that integrates this information into an inbox file
18090 and operates on the pointers to flagged entries.  Here is how it works:
18092 @enumerate
18093 @item
18094 Org moves all entries found in
18095 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
18096 operation.} and appends them to the file pointed to by the variable
18097 @code{org-mobile-inbox-for-pull}.  Each captured entry and each editing event
18098 will be a top-level entry in the inbox file.
18099 @item
18100 After moving the entries, Org will attempt to implement the changes made in
18101 @i{MobileOrg}.  Some changes are applied directly and without user
18102 interaction.  Examples are all changes to tags, TODO state, headline and body
18103 text that can be cleanly applied.  Entries that have been flagged for further
18104 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
18105 again.  When there is a problem finding an entry or applying the change, the
18106 pointer entry will remain in the inbox and will be marked with an error
18107 message.  You need to later resolve these issues by hand.
18108 @item
18109 Org will then generate an agenda view with all flagged entries.  The user
18110 should then go through these entries and do whatever actions are necessary.
18111 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
18112 will be displayed in the echo area when the cursor is on the corresponding
18113 agenda line.
18115 @table @kbd
18116 @kindex ?
18117 @item ?
18118 Pressing @kbd{?} in that special agenda will display the full flagging note in
18119 another window and also push it onto the kill ring.  So you could use @kbd{?
18120 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
18121 Pressing @kbd{?} twice in succession will offer to remove the
18122 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
18123 in a property).  In this way you indicate that the intended processing for
18124 this flagged entry is finished.
18125 @end table
18126 @end enumerate
18128 @kindex C-c a ?
18129 If you are not able to process all flagged entries directly, you can always
18130 return to this agenda view@footnote{Note, however, that there is a subtle
18131 difference.  The view created automatically by @kbd{M-x org-mobile-pull RET}
18132 is guaranteed to search all files that have been addressed by the last pull.
18133 This might include a file that is not currently in your list of agenda files.
18134 If you later use @kbd{C-c a ?} to regenerate the view, only the current
18135 agenda files will be searched.} using @kbd{C-c a ?}.
18137 @node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top
18138 @appendix History and acknowledgments
18139 @cindex acknowledgments
18140 @cindex history
18141 @cindex thanks
18143 @section From Carsten
18145 Org was born in 2003, out of frustration over the user interface of the Emacs
18146 Outline mode.  I was trying to organize my notes and projects, and using
18147 Emacs seemed to be the natural way to go.  However, having to remember eleven
18148 different commands with two or three keys per command, only to hide and show
18149 parts of the outline tree, that seemed entirely unacceptable to me.  Also,
18150 when using outlines to take notes, I constantly wanted to restructure the
18151 tree, organizing it parallel to my thoughts and plans.  @emph{Visibility
18152 cycling} and @emph{structure editing} were originally implemented in the
18153 package @file{outline-magic.el}, but quickly moved to the more general
18154 @file{org.el}.  As this environment became comfortable for project planning,
18155 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
18156 @emph{table support}.  These areas highlighted the two main goals that Org
18157 still has today: to be a new, outline-based, plain text mode with innovative
18158 and intuitive editing features, and to incorporate project planning
18159 functionality directly into a notes file.
18161 Since the first release, literally thousands of emails to me or to
18162 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
18163 reports, feedback, new ideas, and sometimes patches and add-on code.
18164 Many thanks to everyone who has helped to improve this package.  I am
18165 trying to keep here a list of the people who had significant influence
18166 in shaping one or more aspects of Org.  The list may not be
18167 complete, if I have forgotten someone, please accept my apologies and
18168 let me know.
18170 Before I get to this list, a few special mentions are in order:
18172 @table @i
18173 @item Bastien Guerry
18174 Bastien has written a large number of extensions to Org (most of them
18175 integrated into the core by now), including the @LaTeX{} exporter and the plain
18176 list parser.  His support during the early days, when he basically acted as
18177 co-maintainer, was central to the success of this project.  Bastien also
18178 invented Worg, helped establishing the Web presence of Org, and sponsored
18179 hosting costs for the orgmode.org website.
18180 @item Eric Schulte and Dan Davison
18181 Eric and Dan are jointly responsible for the Org-babel system, which turns
18182 Org into a multi-language environment for evaluating code and doing literate
18183 programming and reproducible research.
18184 @item John Wiegley
18185 John has contributed a number of great ideas and patches directly to Org,
18186 including the attachment system (@file{org-attach.el}), integration with
18187 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
18188 items, habit tracking (@file{org-habits.el}), and encryption
18189 (@file{org-crypt.el}).  Also, the capture system is really an extended copy
18190 of his great @file{remember.el}.
18191 @item Sebastian Rose
18192 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
18193 of an ignorant amateur.  Sebastian has pushed this part of Org onto a much
18194 higher level.  He also wrote @file{org-info.js}, a Java script for displaying
18195 web pages derived from Org using an Info-like or a folding interface with
18196 single-key navigation.
18197 @end table
18199 @noindent See below for the full list of contributions!  Again, please
18200 let me know what I am missing here!
18202 @section From Bastien
18204 I (Bastien) have been maintaining Org since January 2011.  This appendix
18205 would not be complete without adding a few more acknowledgements and thanks
18206 to Carsten's ones above.
18208 I am first grateful to Carsten for his trust while handing me over the
18209 maintainership of Org.  His unremitting support is what really helped me
18210 getting more confident over time, with both the community and the code.
18212 When I took over maintainership, I knew I would have to make Org more
18213 collaborative than ever, as I would have to rely on people that are more
18214 knowledgeable than I am on many parts of the code.  Here is a list of the
18215 persons I could rely on, they should really be considered co-maintainers,
18216 either of the code or the community:
18218 @table @i
18219 @item Eric Schulte
18220 Eric is maintaining the Babel parts of Org.  His reactivity here kept me away
18221 from worrying about possible bugs here and let me focus on other parts.
18223 @item Nicolas Goaziou
18224 Nicolas is maintaining the consistency of the deepest parts of Org.  His
18225 work on @file{org-element.el} and @file{ox.el} has been outstanding, and
18226 opened the doors for many new ideas and features.  He rewrote many of the
18227 old exporters to use the new export engine, and helped with documenting
18228 this major change.  More importantly (if that's possible), he has been more
18229 than reliable during all the work done for Org 8.0, and always very
18230 reactive on the mailing list.
18232 @item Achim Gratz
18233 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
18234 into a flexible and conceptually clean process.  He patiently coped with the
18235 many hiccups that such a change can create for users.
18237 @item Nick Dokos
18238 The Org mode mailing list would not be such a nice place without Nick, who
18239 patiently helped users so many times.  It is impossible to overestimate such
18240 a great help, and the list would not be so active without him.
18241 @end table
18243 I received support from so many users that it is clearly impossible to be
18244 fair when shortlisting a few of them, but Org's history would not be
18245 complete if the ones above were not mentioned in this manual.
18247 @section List of contributions
18249 @itemize @bullet
18251 @item
18252 @i{Russel Adams} came up with the idea for drawers.
18253 @item
18254 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
18255 feedback on many features and several patches.
18256 @item
18257 @i{Luis Anaya} wrote @file{ox-man.el}.
18258 @item
18259 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
18260 @item
18261 @i{Michael Brand} helped by reporting many bugs and testing many features.
18262 He also implemented the distinction between empty fields and 0-value fields
18263 in Org's spreadsheets.
18264 @item
18265 @i{Christophe Bataillon} created the great unicorn logo that we use on the
18266 Org mode website.
18267 @item
18268 @i{Alex Bochannek} provided a patch for rounding timestamps.
18269 @item
18270 @i{Jan Böcker} wrote @file{org-docview.el}.
18271 @item
18272 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
18273 @item
18274 @i{Tom Breton} wrote @file{org-choose.el}.
18275 @item
18276 @i{Charles Cave}'s suggestion sparked the implementation of templates
18277 for Remember, which are now templates for capture.
18278 @item
18279 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
18280 specified time.
18281 @item
18282 @i{Gregory Chernov} patched support for Lisp forms into table
18283 calculations and improved XEmacs compatibility, in particular by porting
18284 @file{nouline.el} to XEmacs.
18285 @item
18286 @i{Sacha Chua} suggested copying some linking code from Planner.
18287 @item
18288 @i{Toby S. Cubitt} contributed to the code for clock formats.
18289 @item
18290 @i{Baoqiu Cui} contributed the DocBook exporter.  It has been deleted from
18291 Org 8.0: you can now export to Texinfo and export the @file{.texi} file to
18292 DocBook using @code{makeinfo}.
18293 @item
18294 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
18295 came up with the idea of properties, and that there should be an API for
18296 them.
18297 @item
18298 @i{Nick Dokos} tracked down several nasty bugs.
18299 @item
18300 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
18301 inspired some of the early development, including HTML export.  He also
18302 asked for a way to narrow wide table columns.
18303 @item
18304 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
18305 several years now.  He also sponsored the hosting costs until Rackspace
18306 started to host us for free.
18307 @item
18308 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
18309 the Org-Babel documentation into the manual.
18310 @item
18311 @i{Christian Egli} converted the documentation into Texinfo format, inspired
18312 the agenda, patched CSS formatting into the HTML exporter, and wrote
18313 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
18314 @file{ox-taskjuggler.el} for Org 8.0.
18315 @item
18316 @i{David Emery} provided a patch for custom CSS support in exported
18317 HTML agendas.
18318 @item
18319 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
18320 @item
18321 @i{Nic Ferrier} contributed mailcap and XOXO support.
18322 @item
18323 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
18324 @item
18325 @i{John Foerch} figured out how to make incremental search show context
18326 around a match in a hidden outline tree.
18327 @item
18328 @i{Raimar Finken} wrote @file{org-git-line.el}.
18329 @item
18330 @i{Mikael Fornius} works as a mailing list moderator.
18331 @item
18332 @i{Austin Frank} works as a mailing list moderator.
18333 @item
18334 @i{Eric Fraga} drove the development of BEAMER export with ideas and
18335 testing.
18336 @item
18337 @i{Barry Gidden} did proofreading the manual in preparation for the book
18338 publication through Network Theory Ltd.
18339 @item
18340 @i{Niels Giesen} had the idea to automatically archive DONE trees.
18341 @item
18342 @i{Nicolas Goaziou} rewrote much of the plain list code.  He also wrote
18343 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
18344 in implementing a clean framework for Org exporters.
18345 @item
18346 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
18347 @item
18348 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
18349 book.
18350 @item
18351 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
18352 task state change logging, and the clocktable.  His clear explanations have
18353 been critical when we started to adopt the Git version control system.
18354 @item
18355 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
18356 patches.
18357 @item
18358 @i{Phil Jackson} wrote @file{org-irc.el}.
18359 @item
18360 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
18361 folded entries, and column view for properties.
18362 @item
18363 @i{Matt Jones} wrote @i{MobileOrg Android}.
18364 @item
18365 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
18366 @item
18367 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
18368 @item
18369 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it.  He also
18370 provided frequent feedback and some patches.
18371 @item
18372 @i{Matt Lundin} has proposed last-row references for table formulas and named
18373 invisible anchors.  He has also worked a lot on the FAQ.
18374 @item
18375 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
18376 and is a prolific contributor on the mailing list with competent replies,
18377 small fixes and patches.
18378 @item
18379 @i{Jason F. McBrayer} suggested agenda export to CSV format.
18380 @item
18381 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
18382 @item
18383 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
18384 basis.
18385 @item
18386 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
18387 happy.
18388 @item
18389 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
18390 @item
18391 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
18392 and being able to quickly restrict the agenda to a subtree.
18393 @item
18394 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
18395 @item
18396 @i{Greg Newman} refreshed the unicorn logo into its current form.
18397 @item
18398 @i{Tim O'Callaghan} suggested in-file links, search options for general
18399 file links, and TAGS.
18400 @item
18401 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
18402 version of the reference card.
18403 @item
18404 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
18405 into Japanese.
18406 @item
18407 @i{Oliver Oppitz} suggested multi-state TODO items.
18408 @item
18409 @i{Scott Otterson} sparked the introduction of descriptive text for
18410 links, among other things.
18411 @item
18412 @i{Pete Phillips} helped during the development of the TAGS feature, and
18413 provided frequent feedback.
18414 @item
18415 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
18416 generation.
18417 @item
18418 @i{Martin Pohlack} provided the code snippet to bundle character insertion
18419 into bundles of 20 for undo.
18420 @item
18421 @i{Rackspace.com} is hosting our website for free.  Thank you Rackspace!
18422 @item
18423 @i{T.V. Raman} reported bugs and suggested improvements.
18424 @item
18425 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
18426 control.
18427 @item
18428 @i{Paul Rivier} provided the basic implementation of named footnotes.  He
18429 also acted as mailing list moderator for some time.
18430 @item
18431 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
18432 @item
18433 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
18434 conflict with @file{allout.el}.
18435 @item
18436 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
18437 extensive patches.
18438 @item
18439 @i{Philip Rooke} created the Org reference card, provided lots
18440 of feedback, developed and applied standards to the Org documentation.
18441 @item
18442 @i{Christian Schlauer} proposed angular brackets around links, among
18443 other things.
18444 @item
18445 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
18446 enjoy folding in non-org buffers by using Org headlines in comments.
18447 @item
18448 @i{Paul Sexton} wrote @file{org-ctags.el}.
18449 @item
18450 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
18451 @file{organizer-mode.el}.
18452 @item
18453 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
18454 examples, and remote highlighting for referenced code lines.
18455 @item
18456 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
18457 now packaged into Org's @file{contrib} directory.
18458 @item
18459 @i{Daniel Sinder} came up with the idea of internal archiving by locking
18460 subtrees.
18461 @item
18462 @i{Dale Smith} proposed link abbreviations.
18463 @item
18464 @i{James TD Smith} has contributed a large number of patches for useful
18465 tweaks and features.
18466 @item
18467 @i{Adam Spiers} asked for global linking commands, inspired the link
18468 extension system, added support for mairix, and proposed the mapping API.
18469 @item
18470 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
18471 @LaTeX{}, UTF-8, Latin-1 and ASCII.
18472 @item
18473 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
18474 with links transformation to Org syntax.
18475 @item
18476 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
18477 chapter about publishing.
18478 @item
18479 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
18480 @item
18481 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
18482 enabled source code highlighting in Gnus.
18483 @item
18484 @i{Stefan Vollmar} organized a video-recorded talk at the
18485 Max-Planck-Institute for Neurology.  He also inspired the creation of a
18486 concept index for HTML export.
18487 @item
18488 @i{J@"urgen Vollmer} contributed code generating the table of contents
18489 in HTML output.
18490 @item
18491 @i{Samuel Wales} has provided important feedback and bug reports.
18492 @item
18493 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
18494 keyword.
18495 @item
18496 @i{David Wainberg} suggested archiving, and improvements to the linking
18497 system.
18498 @item
18499 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
18500 linking to Gnus.
18501 @item
18502 @i{Roland Winkler} requested additional key bindings to make Org
18503 work on a tty.
18504 @item
18505 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
18506 and contributed various ideas and code snippets.
18507 @end itemize
18510 @node GNU Free Documentation License, Main Index, History and Acknowledgments, Top
18511 @appendix GNU Free Documentation License
18512 @include doclicense.texi
18515 @node Main Index, Key Index, GNU Free Documentation License, Top
18516 @unnumbered Concept index
18518 @printindex cp
18520 @node Key Index, Command and Function Index, Main Index, Top
18521 @unnumbered Key index
18523 @printindex ky
18525 @node Command and Function Index, Variable Index, Key Index, Top
18526 @unnumbered Command and function index
18528 @printindex fn
18530 @node Variable Index,  , Command and Function Index, Top
18531 @unnumbered Variable index
18533 This is not a complete index of variables and faces, only the ones that are
18534 mentioned in the manual.  For a more complete list, use @kbd{M-x
18535 org-customize @key{RET}} and then click yourself through the tree.
18537 @printindex vr
18539 @bye
18541 @c Local variables:
18542 @c fill-column: 77
18543 @c indent-tabs-mode: nil
18544 @c paragraph-start:    "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[  ]*$"
18545 @c paragraph-separate: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[       \f]*$"
18546 @c End:
18549 @c  LocalWords:  webdavhost pre