org.texi: Small documentation fix
[org-mode/org-tableheadings.git] / doc / org.texi
blob402fe9b5b449b33b9fc35711e4e68deb6d5ffc8f
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 * iCalendar export::            Exporting to iCalendar
589 * Other built-in back-ends::    Exporting to @code{Texinfo} or a man page
590 * Export in foreign buffers::   Author tables and lists in Org syntax
591 * Advanced configuration::      Fine-tuning the export output
593 HTML export
595 * HTML Export commands::        How to invoke HTML export
596 * HTML doctypes::               Org can export to various (X)HTML flavors
597 * HTML preamble and postamble::  How to insert a preamble and a postamble
598 * Quoting HTML tags::           Using direct HTML in Org mode
599 * Links in HTML export::        How links will be interpreted and formatted
600 * Tables in HTML export::       How to modify the formatting of tables
601 * Images in HTML export::       How to insert figures into HTML output
602 * Math formatting in HTML export::  Beautiful math also on the web
603 * Text areas in HTML export::   An alternative way to show an example
604 * CSS support::                 Changing the appearance of the output
605 * JavaScript support::          Info and Folding in a web browser
607 @LaTeX{} and PDF export
609 * @LaTeX{} export commands::    How to export to LaTeX and PDF
610 * Header and sectioning::       Setting up the export file structure
611 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
612 * @LaTeX{} specific attributes::  Controlling @LaTeX{} output
614 OpenDocument Text export
616 * Pre-requisites for ODT export::  What packages ODT exporter relies on
617 * ODT export commands::         How to invoke ODT export
618 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
619 * Applying custom styles::      How to apply custom styles to the output
620 * Links in ODT export::         How links will be interpreted and formatted
621 * Tables in ODT export::        How Tables are exported
622 * Images in ODT export::        How to insert images
623 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
624 * Labels and captions in ODT export::  How captions are rendered
625 * Literal examples in ODT export::  How source and example blocks are formatted
626 * Advanced topics in ODT export::  Read this if you are a power user
628 Math formatting in ODT export
630 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
631 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
633 Advanced topics in ODT export
635 * Configuring a document converter::  How to register a document converter
636 * Working with OpenDocument style files::  Explore the internals
637 * Creating one-off styles::     How to produce custom highlighting etc
638 * Customizing tables in ODT export::  How to define and use Table templates
639 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
641 Publishing
643 * Configuration::               Defining projects
644 * Uploading files::             How to get files up on the server
645 * Sample configuration::        Example projects
646 * Triggering publication::      Publication commands
648 Configuration
650 * Project alist::               The central configuration variable
651 * Sources and destinations::    From here to there
652 * Selecting files::             What files are part of the project?
653 * Publishing action::           Setting the function doing the publishing
654 * Publishing options::          Tweaking HTML/@LaTeX{} export
655 * Publishing links::            Which links keep working after publishing?
656 * Sitemap::                     Generating a list of all pages
657 * Generating an index::         An index that reaches across pages
659 Sample configuration
661 * Simple example::              One-component publishing
662 * Complex example::             A multi-component publishing example
664 Working with source code
666 * Structure of code blocks::    Code block syntax described
667 * Editing source code::         Language major-mode editing
668 * Exporting code blocks::       Export contents and/or results
669 * Extracting source code::      Create pure source code files
670 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
671 * Library of Babel::            Use and contribute to a library of useful code blocks
672 * Languages::                   List of supported code block languages
673 * Header arguments::            Configure code block functionality
674 * Results of evaluation::       How evaluation results are handled
675 * Noweb reference syntax::      Literate programming in Org mode
676 * Key bindings and useful functions::  Work quickly with code blocks
677 * Batch execution::             Call functions from the command line
679 Header arguments
681 * Using header arguments::      Different ways to set header arguments
682 * Specific header arguments::   List of header arguments
684 Using header arguments
686 * System-wide header arguments::  Set global default values
687 * Language-specific header arguments::  Set default values by language
688 * Header arguments in Org mode properties::  Set default values for a buffer or heading
689 * Language-specific header arguments in Org mode properties::  Set language-specific default values for a buffer or heading
690 * Code block specific header arguments::  The most common way to set values
691 * Header arguments in function calls::  The most specific level
693 Specific header arguments
695 * var::                         Pass arguments to code blocks
696 * results::                     Specify the type of results and how they will
697                                 be collected and handled
698 * file::                        Specify a path for file output
699 * file-desc::                   Specify a description for file results
700 * dir::                         Specify the default (possibly remote)
701                                 directory for code block execution
702 * exports::                     Export code and/or results
703 * tangle::                      Toggle tangling and specify file name
704 * mkdirp::                      Toggle creation of parent directories of target
705                                 files during tangling
706 * comments::                    Toggle insertion of comments in tangled
707                                 code files
708 * padline::                     Control insertion of padding lines in tangled
709                                 code files
710 * no-expand::                   Turn off variable assignment and noweb
711                                 expansion during tangling
712 * session::                     Preserve the state of code evaluation
713 * noweb::                       Toggle expansion of noweb references
714 * noweb-ref::                   Specify block's noweb reference resolution target
715 * noweb-sep::                   String used to separate noweb references
716 * cache::                       Avoid re-evaluating unchanged code blocks
717 * sep::                         Delimiter for writing tabular results outside Org
718 * hlines::                      Handle horizontal lines in tables
719 * colnames::                    Handle column names in tables
720 * rownames::                    Handle row names in tables
721 * shebang::                     Make tangled files executable
722 * tangle-mode::                 Set permission of tangled files
723 * eval::                        Limit evaluation of specific code blocks
724 * wrap::                        Mark source block evaluation results
725 * post::                        Post processing of code block results
726 * prologue::                    Text to prepend to code block body
727 * epilogue::                    Text to append to code block body
729 Miscellaneous
731 * Completion::                  M-TAB knows what you need
732 * Easy Templates::              Quick insertion of structural elements
733 * Speed keys::                  Electric commands at the beginning of a headline
734 * Code evaluation security::    Org mode files evaluate inline code
735 * Customization::               Adapting Org to your taste
736 * In-buffer settings::          Overview of the #+KEYWORDS
737 * The very busy C-c C-c key::   When in doubt, press C-c C-c
738 * Clean view::                  Getting rid of leading stars in the outline
739 * TTY keys::                    Using Org on a tty
740 * Interaction::                 Other Emacs packages
741 * org-crypt::                   Encrypting Org files
743 Interaction with other packages
745 * Cooperation::                 Packages Org cooperates with
746 * Conflicts::                   Packages that lead to conflicts
748 Hacking
750 * Hooks::                       How to reach into Org's internals
751 * Add-on packages::             Available extensions
752 * Adding hyperlink types::      New custom link types
753 * Adding export back-ends::     How to write new export back-ends
754 * Context-sensitive commands::  How to add functionality to such commands
755 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
756 * Dynamic blocks::              Automatically filled blocks
757 * Special agenda views::        Customized views
758 * Speeding up your agendas::    Tips on how to speed up your agendas
759 * Extracting agenda information::  Post-processing of agenda information
760 * Using the property API::      Writing programs that use entry properties
761 * Using the mapping API::       Mapping over all or selected entries
763 Tables and lists in arbitrary syntax
765 * Radio tables::                Sending and receiving radio tables
766 * A @LaTeX{} example::          Step by step, almost a tutorial
767 * Translator functions::        Copy and modify
768 * Radio lists::                 Sending and receiving lists
770 MobileOrg
772 * Setting up the staging area::  Where to interact with the mobile device
773 * Pushing to MobileOrg::        Uploading Org files and agendas
774 * Pulling from MobileOrg::      Integrating captured and flagged items
776 @end detailmenu
777 @end menu
779 @node Introduction, Document Structure, Top, Top
780 @chapter Introduction
781 @cindex introduction
783 @menu
784 * Summary::                     Brief summary of what Org does
785 * Installation::                Installing Org
786 * Activation::                  How to activate Org for certain buffers
787 * Feedback::                    Bug reports, ideas, patches etc.
788 * Conventions::                 Typesetting conventions in the manual
789 @end menu
791 @node Summary, Installation, Introduction, Introduction
792 @section Summary
793 @cindex summary
795 Org is a mode for keeping notes, maintaining TODO lists, and doing
796 project planning with a fast and effective plain-text system.
798 Org develops organizational tasks around NOTES files that contain
799 lists or information about projects as plain text.  Org is
800 implemented on top of Outline mode, which makes it possible to keep the
801 content of large files well structured.  Visibility cycling and
802 structure editing help to work with the tree.  Tables are easily created
803 with a built-in table editor.  Org supports TODO items, deadlines,
804 timestamps, and scheduling.  It dynamically compiles entries into an
805 agenda that utilizes and smoothly integrates much of the Emacs calendar
806 and diary.  Plain text URL-like links connect to websites, emails,
807 Usenet messages, BBDB entries, and any files related to the projects.
808 For printing and sharing notes, an Org file can be exported as a
809 structured ASCII file, as HTML, or (TODO and agenda items only) as an
810 iCalendar file.  It can also serve as a publishing tool for a set of
811 linked web pages.
813 As a project planning environment, Org works by adding metadata to outline
814 nodes.  Based on this data, specific entries can be extracted in queries and
815 create dynamic @i{agenda views}.
817 Org mode contains the Org Babel environment which allows you to work with
818 embedded source code blocks in a file, to facilitate code evaluation,
819 documentation, and literate programming techniques.
821 Org's automatic, context-sensitive table editor with spreadsheet
822 capabilities can be integrated into any major mode by activating the
823 minor Orgtbl mode.  Using a translation step, it can be used to maintain
824 tables in arbitrary file types, for example in @LaTeX{}.  The structure
825 editing and list creation capabilities can be used outside Org with
826 the minor Orgstruct mode.
828 Org keeps simple things simple.  When first fired up, it should
829 feel like a straightforward, easy to use outliner.  Complexity is not
830 imposed, but a large amount of functionality is available when you need
831 it.  Org is a toolbox and can be used in different ways and for different
832 ends, for example:
834 @example
835 @r{@bullet{} an outline extension with visibility cycling and structure editing}
836 @r{@bullet{} an ASCII system and table editor for taking structured notes}
837 @r{@bullet{} a TODO list editor}
838 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
839 @pindex GTD, Getting Things Done
840 @r{@bullet{} an environment in which to implement David Allen's GTD system}
841 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
842 @r{@bullet{} a publishing tool to create a set of interlinked web pages}
843 @r{@bullet{} an environment for literate programming}
844 @end example
846 @cindex FAQ
847 There is a website for Org which provides links to the newest
848 version of Org, as well as additional information, frequently asked
849 questions (FAQ), links to tutorials, etc.  This page is located at
850 @uref{http://orgmode.org}.
852 @cindex print edition
853 The version 7.3 of this manual is available as a
854 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
855 Theory Ltd.}
857 @page
860 @node Installation, Activation, Summary, Introduction
861 @section Installation
862 @cindex installation
863 @cindex XEmacs
865 Org is part of recent distributions of GNU Emacs, so you normally don't need
866 to install it.  If, for one reason or another, you want to install Org on top
867 of this pre-packaged version, there are three ways to do it:
869 @itemize @bullet
870 @item By using Emacs package system.
871 @item By downloading Org as an archive.
872 @item By using Org's git repository.
873 @end itemize
875 We @b{strongly recommend} to stick to a single installation method.
877 @subsubheading Using Emacs packaging system
879 Recent Emacs distributions include a packaging system which lets you install
880 Elisp libraries.  You can install Org with @kbd{M-x package-install RET org}.
882 @noindent @b{Important}: you need to do this in a session where no @code{.org} file has
883 been visited, i.e. where no Org built-in function have been loaded.
884 Otherwise autoload Org functions will mess up the installation.
886 Then, to make sure your Org configuration is taken into account, initialize
887 the package system with @code{(package-initialize)} in your @file{.emacs}
888 before setting any Org option.  If you want to use Org's package repository,
889 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
891 @subsubheading Downloading Org as an archive
893 You can download Org latest release from @uref{http://orgmode.org/, Org's
894 website}.  In this case, make sure you set the load-path correctly in your
895 @file{.emacs}:
897 @lisp
898 (add-to-list 'load-path "~/path/to/orgdir/lisp")
899 @end lisp
901 The downloaded archive contains contributed libraries that are not included
902 in Emacs.  If you want to use them, add the @file{contrib} directory to your
903 load-path:
905 @lisp
906 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
907 @end lisp
909 Optionally, you can compile the files and/or install them in your system.
910 Run @code{make help} to list compilation and installation options.
912 @subsubheading Using Org's git repository
914 You can clone Org's repository and install Org like this:
916 @example
917 $ cd ~/src/
918 $ git clone git://orgmode.org/org-mode.git
919 $ make autoloads
920 @end example
922 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
923 version in @file{org-version.el} and Org's autoloads in
924 @file{org-loaddefs.el}.
926 Remember to add the correct load-path as described in the method above.
928 You can also compile with @code{make}, generate the documentation with
929 @code{make doc}, create a local configuration with @code{make config} and
930 install Org with @code{make install}.  Please run @code{make help} to get
931 the list of compilation/installation options.
933 For more detailed explanations on Org's build system, please check the Org
934 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
935 Worg}.
937 @node Activation, Feedback, Installation, Introduction
938 @section Activation
939 @cindex activation
940 @cindex autoload
941 @cindex ELPA
942 @cindex global key bindings
943 @cindex key bindings, global
944 @findex org-agenda
945 @findex org-capture
946 @findex org-store-link
947 @findex org-iswitchb
949 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
950 default.  If you are using an earlier version of Emacs, add this line to your
951 @file{.emacs} file:
953 @lisp
954 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
955 @end lisp
957 Org mode buffers need font-lock to be turned on: this is the default in
958 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
959 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
961 There are compatibility issues between Org mode and some other Elisp
962 packages, please take the time to check the list (@pxref{Conflicts}).
964 The four Org commands @command{org-store-link}, @command{org-capture},
965 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
966 global keys (i.e., anywhere in Emacs, not just in Org buffers).  Here are
967 suggested bindings for these keys, please modify the keys to your own
968 liking.
969 @lisp
970 (global-set-key "\C-cl" 'org-store-link)
971 (global-set-key "\C-cc" 'org-capture)
972 (global-set-key "\C-ca" 'org-agenda)
973 (global-set-key "\C-cb" 'org-iswitchb)
974 @end lisp
976 @cindex Org mode, turning on
977 With this setup, all files with extension @samp{.org} will be put
978 into Org mode.  As an alternative, make the first line of a file look
979 like this:
981 @example
982 MY PROJECTS    -*- mode: org; -*-
983 @end example
985 @vindex org-insert-mode-line-in-empty-file
986 @noindent which will select Org mode for this buffer no matter what
987 the file's name is.  See also the variable
988 @code{org-insert-mode-line-in-empty-file}.
990 Many commands in Org work on the region if the region is @i{active}.  To make
991 use of this, you need to have @code{transient-mark-mode}
992 (@code{zmacs-regions} in XEmacs) turned on.  In Emacs 23 this is the default,
993 in Emacs 22 you need to do this yourself with
994 @lisp
995 (transient-mark-mode 1)
996 @end lisp
997 @noindent If you do not like @code{transient-mark-mode}, you can create an
998 active region by using the mouse to select a region, or pressing
999 @kbd{C-@key{SPC}} twice before moving the cursor.
1001 @node Feedback, Conventions, Activation, Introduction
1002 @section Feedback
1003 @cindex feedback
1004 @cindex bug reports
1005 @cindex maintainer
1006 @cindex author
1008 If you find problems with Org, or if you have questions, remarks, or ideas
1009 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1010 If you are not a member of the mailing list, your mail will be passed to the
1011 list after a moderator has approved it@footnote{Please consider subscribing
1012 to the mailing list, in order to minimize the work the mailing list
1013 moderators have to do.}.
1015 For bug reports, please first try to reproduce the bug with the latest
1016 version of Org available---if you are running an outdated version, it is
1017 quite possible that the bug has been fixed already.  If the bug persists,
1018 prepare a report and provide as much information as possible, including the
1019 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1020 (@kbd{M-x org-version RET}), as well as the Org related setup in
1021 @file{.emacs}.  The easiest way to do this is to use the command
1022 @example
1023 @kbd{M-x org-submit-bug-report RET}
1024 @end example
1025 @noindent which will put all this information into an Emacs mail buffer so
1026 that you only need to add your description.  If you re not sending the Email
1027 from within Emacs, please copy and paste the content into your Email program.
1029 Sometimes you might face a problem due to an error in your Emacs or Org mode
1030 setup.  Before reporting a bug, it is very helpful to start Emacs with minimal
1031 customizations and reproduce the problem.  Doing so often helps you determine
1032 if the problem is with your customization or with Org mode itself.  You can
1033 start a typical minimal session with a command like the example below.
1035 @example
1036 $ emacs -Q -l /path/to/minimal-org.el
1037 @end example
1039 However if you are using Org mode as distributed with Emacs, a minimal setup
1040 is not necessary.  In that case it is sufficient to start Emacs as
1041 @code{emacs -Q}.  The @code{minimal-org.el} setup file can have contents as
1042 shown below.
1044 @lisp
1045 ;;; Minimal setup to load latest `org-mode'
1047 ;; activate debugging
1048 (setq debug-on-error t
1049       debug-on-signal nil
1050       debug-on-quit nil)
1052 ;; add latest org-mode to load path
1053 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1054 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1055 @end lisp
1057 If an error occurs, a backtrace can be very useful (see below on how to
1058 create one).  Often a small example file helps, along with clear information
1059 about:
1061 @enumerate
1062 @item What exactly did you do?
1063 @item What did you expect to happen?
1064 @item What happened instead?
1065 @end enumerate
1066 @noindent Thank you for helping to improve this program.
1068 @subsubheading How to create a useful backtrace
1070 @cindex backtrace of an error
1071 If working with Org produces an error with a message you don't
1072 understand, you may have hit a bug.  The best way to report this is by
1073 providing, in addition to what was mentioned above, a @emph{backtrace}.
1074 This is information from the built-in debugger about where and how the
1075 error occurred.  Here is how to produce a useful backtrace:
1077 @enumerate
1078 @item
1079 Reload uncompiled versions of all Org mode Lisp files.  The backtrace
1080 contains much more information if it is produced with uncompiled code.
1081 To do this, use
1082 @example
1083 @kbd{C-u M-x org-reload RET}
1084 @end example
1085 @noindent
1086 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1087 menu.
1088 @item
1089 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1090 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1091 @item
1092 Do whatever you have to do to hit the error.  Don't forget to
1093 document the steps you take.
1094 @item
1095 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1096 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
1097 attach it to your bug report.
1098 @end enumerate
1100 @node Conventions,  , Feedback, Introduction
1101 @section Typesetting conventions used in this manual
1103 @subsubheading TODO keywords, tags, properties, etc.
1105 Org mainly uses three types of keywords: TODO keywords, tags and property
1106 names.  In this manual we use the following conventions:
1108 @table @code
1109 @item TODO
1110 @itemx WAITING
1111 TODO keywords are written with all capitals, even if they are
1112 user-defined.
1113 @item boss
1114 @itemx ARCHIVE
1115 User-defined tags are written in lowercase; built-in tags with special
1116 meaning are written with all capitals.
1117 @item Release
1118 @itemx PRIORITY
1119 User-defined properties are capitalized; built-in properties with
1120 special meaning are written with all capitals.
1121 @end table
1123 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1124 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1125 environment).  They are written in uppercase in the manual to enhance its
1126 readability, but you can use lowercase in your Org files@footnote{Easy
1127 templates insert lowercase keywords and Babel dynamically inserts
1128 @code{#+results}.}.
1130 @subsubheading Keybindings and commands
1131 @kindex C-c a
1132 @findex org-agenda
1133 @kindex C-c c
1134 @findex org-capture
1136 The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda}
1137 and @kbd{C-c c} for @code{org-capture}.  These are only suggestions, but the
1138 rest of the manual assumes that you are using these keybindings.
1140 Also, the manual lists both the keys and the corresponding commands for
1141 accessing a functionality.  Org mode often uses the same key for different
1142 functions, depending on context.  The command that is bound to such keys has
1143 a generic name, like @code{org-metaright}.  In the manual we will, wherever
1144 possible, give the function that is internally called by the generic command.
1145 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1146 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1147 will be listed to call @code{org-table-move-column-right}.  If you prefer,
1148 you can compile the manual without the command names by unsetting the flag
1149 @code{cmdnames} in @file{org.texi}.
1151 @node Document Structure, Tables, Introduction, Top
1152 @chapter Document structure
1153 @cindex document structure
1154 @cindex structure of document
1156 Org is based on Outline mode and provides flexible commands to
1157 edit the structure of the document.
1159 @menu
1160 * Outlines::                    Org is based on Outline mode
1161 * Headlines::                   How to typeset Org tree headlines
1162 * Visibility cycling::          Show and hide, much simplified
1163 * Motion::                      Jumping to other headlines
1164 * Structure editing::           Changing sequence and level of headlines
1165 * Sparse trees::                Matches embedded in context
1166 * Plain lists::                 Additional structure within an entry
1167 * Drawers::                     Tucking stuff away
1168 * Blocks::                      Folding blocks
1169 * Footnotes::                   How footnotes are defined in Org's syntax
1170 * Orgstruct mode::              Structure editing outside Org
1171 * Org syntax::                  Formal description of Org's syntax
1172 @end menu
1174 @node Outlines, Headlines, Document Structure, Document Structure
1175 @section Outlines
1176 @cindex outlines
1177 @cindex Outline mode
1179 Org is implemented on top of Outline mode.  Outlines allow a
1180 document to be organized in a hierarchical structure, which (at least
1181 for me) is the best representation of notes and thoughts.  An overview
1182 of this structure is achieved by folding (hiding) large parts of the
1183 document to show only the general document structure and the parts
1184 currently being worked on.  Org greatly simplifies the use of
1185 outlines by compressing the entire show/hide functionality into a single
1186 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1188 @node Headlines, Visibility cycling, Outlines, Document Structure
1189 @section Headlines
1190 @cindex headlines
1191 @cindex outline tree
1192 @vindex org-special-ctrl-a/e
1193 @vindex org-special-ctrl-k
1194 @vindex org-ctrl-k-protect-subtree
1196 Headlines define the structure of an outline tree.  The headlines in Org
1197 start with one or more stars, on the left margin@footnote{See the variables
1198 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1199 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1200 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1201 headings indented less then 30 stars.}.  For example:
1203 @example
1204 * Top level headline
1205 ** Second level
1206 *** 3rd level
1207     some text
1208 *** 3rd level
1209     more text
1211 * Another top level headline
1212 @end example
1214 @noindent Some people find the many stars too noisy and would prefer an
1215 outline that has whitespace followed by a single star as headline
1216 starters.  @ref{Clean view}, describes a setup to realize this.
1218 @vindex org-cycle-separator-lines
1219 An empty line after the end of a subtree is considered part of it and
1220 will be hidden when the subtree is folded.  However, if you leave at
1221 least two empty lines, one empty line will remain visible after folding
1222 the subtree, in order to structure the collapsed view.  See the
1223 variable @code{org-cycle-separator-lines} to modify this behavior.
1225 @node Visibility cycling, Motion, Headlines, Document Structure
1226 @section Visibility cycling
1227 @cindex cycling, visibility
1228 @cindex visibility cycling
1229 @cindex trees, visibility
1230 @cindex show hidden text
1231 @cindex hide text
1233 @menu
1234 * Global and local cycling::    Cycling through various visibility states
1235 * Initial visibility::          Setting the initial visibility state
1236 * Catching invisible edits::    Preventing mistakes when editing invisible parts
1237 @end menu
1239 @node Global and local cycling, Initial visibility, Visibility cycling, Visibility cycling
1240 @subsection Global and local cycling
1242 Outlines make it possible to hide parts of the text in the buffer.
1243 Org uses just two commands, bound to @key{TAB} and
1244 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1246 @cindex subtree visibility states
1247 @cindex subtree cycling
1248 @cindex folded, subtree visibility state
1249 @cindex children, subtree visibility state
1250 @cindex subtree, subtree visibility state
1251 @table @asis
1252 @orgcmd{@key{TAB},org-cycle}
1253 @emph{Subtree cycling}: Rotate current subtree among the states
1255 @example
1256 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1257 '-----------------------------------'
1258 @end example
1260 @vindex org-cycle-emulate-tab
1261 @vindex org-cycle-global-at-bob
1262 The cursor must be on a headline for this to work@footnote{see, however,
1263 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
1264 beginning of the buffer and the first line is not a headline, then
1265 @key{TAB} actually runs global cycling (see below)@footnote{see the
1266 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
1267 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1269 @cindex global visibility states
1270 @cindex global cycling
1271 @cindex overview, global visibility state
1272 @cindex contents, global visibility state
1273 @cindex show all, global visibility state
1274 @orgcmd{S-@key{TAB},org-global-cycle}
1275 @itemx C-u @key{TAB}
1276 @emph{Global cycling}: Rotate the entire buffer among the states
1278 @example
1279 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1280 '--------------------------------------'
1281 @end example
1283 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1284 CONTENTS view up to headlines of level N will be shown.  Note that inside
1285 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1287 @cindex set startup visibility, command
1288 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1289 Switch back to the startup visibility of the buffer (@pxref{Initial visibility}).
1290 @cindex show all, command
1291 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1292 Show all, including drawers.
1293 @cindex revealing context
1294 @orgcmd{C-c C-r,org-reveal}
1295 Reveal context around point, showing the current entry, the following heading
1296 and the hierarchy above.  Useful for working near a location that has been
1297 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1298 (@pxref{Agenda commands}).  With a prefix argument show, on each
1299 level, all sibling headings.  With a double prefix argument, also show the
1300 entire subtree of the parent.
1301 @cindex show branches, command
1302 @orgcmd{C-c C-k,show-branches}
1303 Expose all the headings of the subtree, CONTENT view for just one subtree.
1304 @cindex show children, command
1305 @orgcmd{C-c @key{TAB},show-children}
1306 Expose all direct children of the subtree.  With a numeric prefix argument N,
1307 expose all children down to level N@.
1308 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1309 Show the current subtree in an indirect buffer@footnote{The indirect
1310 buffer
1311 @ifinfo
1312 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1313 @end ifinfo
1314 @ifnotinfo
1315 (see the Emacs manual for more information about indirect buffers)
1316 @end ifnotinfo
1317 will contain the entire buffer, but will be narrowed to the current
1318 tree.  Editing the indirect buffer will also change the original buffer,
1319 but without affecting visibility in that buffer.}.  With a numeric
1320 prefix argument N, go up to level N and then take that tree.  If N is
1321 negative then go up that many levels.  With a @kbd{C-u} prefix, do not remove
1322 the previously used indirect buffer.
1323 @orgcmd{C-c C-x v,org-copy-visible}
1324 Copy the @i{visible} text in the region into the kill ring.
1325 @end table
1327 @menu
1328 * Initial visibility::          Setting the initial visibility state
1329 * Catching invisible edits::    Preventing mistakes when editing invisible parts
1330 @end menu
1332 @node Initial visibility, Catching invisible edits, Global and local cycling, Visibility cycling
1333 @subsection Initial visibility
1335 @cindex visibility, initialize
1336 @vindex org-startup-folded
1337 @vindex org-agenda-inhibit-startup
1338 @cindex @code{overview}, STARTUP keyword
1339 @cindex @code{content}, STARTUP keyword
1340 @cindex @code{showall}, STARTUP keyword
1341 @cindex @code{showeverything}, STARTUP keyword
1343 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1344 i.e., only the top level headlines are visible@footnote{When
1345 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1346 visibility state when first opening a file for the agenda (@pxref{Speeding up
1347 your agendas}).}.  This can be configured through the variable
1348 @code{org-startup-folded}, or on a per-file basis by adding one of the
1349 following lines anywhere in the buffer:
1351 @example
1352 #+STARTUP: overview
1353 #+STARTUP: content
1354 #+STARTUP: showall
1355 #+STARTUP: showeverything
1356 @end example
1358 The startup visibility options are ignored when the file is open for the
1359 first time during the agenda generation: if you want the agenda to honor
1360 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1362 @cindex property, VISIBILITY
1363 @noindent
1364 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1365 and Columns}) will get their visibility adapted accordingly.  Allowed values
1366 for this property are @code{folded}, @code{children}, @code{content}, and
1367 @code{all}.
1369 @table @asis
1370 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1371 Switch back to the startup visibility of the buffer, i.e., whatever is
1372 requested by startup options and @samp{VISIBILITY} properties in individual
1373 entries.
1374 @end table
1376 @node Catching invisible edits,  , Initial visibility, Visibility cycling
1377 @subsection Catching invisible edits
1379 @vindex org-catch-invisible-edits
1380 @cindex edits, catching invisible
1381 Sometimes you may inadvertently edit an invisible part of the buffer and be
1382 confused on what has been edited and how to undo the mistake.  Setting
1383 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this.  See the
1384 docstring of this option on how Org should catch invisible edits and process
1385 them.
1387 @node Motion, Structure editing, Visibility cycling, Document Structure
1388 @section Motion
1389 @cindex motion, between headlines
1390 @cindex jumping, to headlines
1391 @cindex headline navigation
1392 The following commands jump to other headlines in the buffer.
1394 @table @asis
1395 @orgcmd{C-c C-n,outline-next-visible-heading}
1396 Next heading.
1397 @orgcmd{C-c C-p,outline-previous-visible-heading}
1398 Previous heading.
1399 @orgcmd{C-c C-f,org-forward-same-level}
1400 Next heading same level.
1401 @orgcmd{C-c C-b,org-backward-same-level}
1402 Previous heading same level.
1403 @orgcmd{C-c C-u,outline-up-heading}
1404 Backward to higher level heading.
1405 @orgcmd{C-c C-j,org-goto}
1406 Jump to a different place without changing the current outline
1407 visibility.  Shows the document structure in a temporary buffer, where
1408 you can use the following keys to find your destination:
1409 @vindex org-goto-auto-isearch
1410 @example
1411 @key{TAB}         @r{Cycle visibility.}
1412 @key{down} / @key{up}   @r{Next/previous visible headline.}
1413 @key{RET}         @r{Select this location.}
1414 @kbd{/}           @r{Do a Sparse-tree search}
1415 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1416 n / p        @r{Next/previous visible headline.}
1417 f / b        @r{Next/previous headline same level.}
1418 u            @r{One level up.}
1419 0-9          @r{Digit argument.}
1420 q            @r{Quit}
1421 @end example
1422 @vindex org-goto-interface
1423 @noindent
1424 See also the option @code{org-goto-interface}.
1425 @end table
1427 @node Structure editing, Sparse trees, Motion, Document Structure
1428 @section Structure editing
1429 @cindex structure editing
1430 @cindex headline, promotion and demotion
1431 @cindex promotion, of subtrees
1432 @cindex demotion, of subtrees
1433 @cindex subtree, cut and paste
1434 @cindex pasting, of subtrees
1435 @cindex cutting, of subtrees
1436 @cindex copying, of subtrees
1437 @cindex sorting, of subtrees
1438 @cindex subtrees, cut and paste
1440 @table @asis
1441 @orgcmd{M-@key{RET},org-insert-heading}
1442 @vindex org-M-RET-may-split-line
1443 Insert a new heading/item with the same level than the one at point.
1444 If the cursor is in a plain list item, a new item is created
1445 (@pxref{Plain lists}).  To prevent this behavior in lists, call the
1446 command with a prefix argument.  When this command is used in the
1447 middle of a line, the line is split and the rest of the line becomes
1448 the new item or headline@footnote{If you do not want the line to be
1449 split, customize the variable @code{org-M-RET-may-split-line}.}.  If
1450 the command is used at the @emph{beginning} of a headline, the new
1451 headline is created before the current line.  If the command is used
1452 at the @emph{end} of a folded subtree (i.e., behind the ellipses at
1453 the end of a headline), then a headline will be
1454 inserted after the end of the subtree.  Calling this command with
1455 @kbd{C-u C-u} will unconditionally respect the headline's content and
1456 create a new item at the end of the parent subtree.
1457 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1458 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1459 current heading, the new heading is placed after the body instead of before
1460 it.  This command works from anywhere in the entry.
1461 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1462 @vindex org-treat-insert-todo-heading-as-state-change
1463 Insert new TODO entry with same level as current heading.  See also the
1464 variable @code{org-treat-insert-todo-heading-as-state-change}.
1465 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1466 Insert new TODO entry with same level as current heading.  Like
1467 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1468 subtree.
1469 @orgcmd{@key{TAB},org-cycle}
1470 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1471 become a child of the previous one.  The next @key{TAB} makes it a parent,
1472 and so on, all the way to top level.  Yet another @key{TAB}, and you are back
1473 to the initial level.
1474 @orgcmd{M-@key{left},org-do-promote}
1475 Promote current heading by one level.
1476 @orgcmd{M-@key{right},org-do-demote}
1477 Demote current heading by one level.
1478 @orgcmd{M-S-@key{left},org-promote-subtree}
1479 Promote the current subtree by one level.
1480 @orgcmd{M-S-@key{right},org-demote-subtree}
1481 Demote the current subtree by one level.
1482 @orgcmd{M-S-@key{up},org-move-subtree-up}
1483 Move subtree up (swap with previous subtree of same
1484 level).
1485 @orgcmd{M-S-@key{down},org-move-subtree-down}
1486 Move subtree down (swap with next subtree of same level).
1487 @orgcmd{M-h,org-mark-element}
1488 Mark the element at point.  Hitting repeatedly will mark subsequent elements
1489 of the one just marked.  E.g., hitting @key{M-h} on a paragraph will mark it,
1490 hitting @key{M-h} immediately again will mark the next one.
1491 @orgcmd{C-c @@,org-mark-subtree}
1492 Mark the subtree at point.  Hitting repeatedly will mark subsequent subtrees
1493 of the same level than the marked subtree.
1494 @orgcmd{C-c C-x C-w,org-cut-subtree}
1495 Kill subtree, i.e., remove it from buffer but save in kill ring.
1496 With a numeric prefix argument N, kill N sequential subtrees.
1497 @orgcmd{C-c C-x M-w,org-copy-subtree}
1498 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
1499 sequential subtrees.
1500 @orgcmd{C-c C-x C-y,org-paste-subtree}
1501 Yank subtree from kill ring.  This does modify the level of the subtree to
1502 make sure the tree fits in nicely at the yank position.  The yank level can
1503 also be specified with a numeric prefix argument, or by yanking after a
1504 headline marker like @samp{****}.
1505 @orgcmd{C-y,org-yank}
1506 @vindex org-yank-adjusted-subtrees
1507 @vindex org-yank-folded-subtrees
1508 Depending on the options @code{org-yank-adjusted-subtrees} and
1509 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1510 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1511 C-x C-y}.  With the default settings, no level adjustment will take place,
1512 but the yanked tree will be folded unless doing so would swallow text
1513 previously visible.  Any prefix argument to this command will force a normal
1514 @code{yank} to be executed, with the prefix passed along.  A good way to
1515 force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
1516 yank, it will yank previous kill items plainly, without adjustment and
1517 folding.
1518 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1519 Clone a subtree by making a number of sibling copies of it.  You will be
1520 prompted for the number of copies to make, and you can also specify if any
1521 timestamps in the entry should be shifted.  This can be useful, for example,
1522 to create a number of tasks related to a series of lectures to prepare.  For
1523 more details, see the docstring of the command
1524 @code{org-clone-subtree-with-time-shift}.
1525 @orgcmd{C-c C-w,org-refile}
1526 Refile entry or region to a different location.  @xref{Refile and copy}.
1527 @orgcmd{C-c ^,org-sort}
1528 Sort same-level entries.  When there is an active region, all entries in the
1529 region will be sorted.  Otherwise the children of the current headline are
1530 sorted.  The command prompts for the sorting method, which can be
1531 alphabetically, numerically, by time (first timestamp with active preferred,
1532 creation time, scheduled time, deadline time), by priority, by TODO keyword
1533 (in the sequence the keywords have been defined in the setup) or by the value
1534 of a property.  Reverse sorting is possible as well.  You can also supply
1535 your own function to extract the sorting key.  With a @kbd{C-u} prefix,
1536 sorting will be case-sensitive.
1537 @orgcmd{C-x n s,org-narrow-to-subtree}
1538 Narrow buffer to current subtree.
1539 @orgcmd{C-x n b,org-narrow-to-block}
1540 Narrow buffer to current block.
1541 @orgcmd{C-x n w,widen}
1542 Widen buffer to remove narrowing.
1543 @orgcmd{C-c *,org-toggle-heading}
1544 Turn a normal line or plain list item into a headline (so that it becomes a
1545 subheading at its location).  Also turn a headline into a normal line by
1546 removing the stars.  If there is an active region, turn all lines in the
1547 region into headlines.  If the first line in the region was an item, turn
1548 only the item lines into headlines.  Finally, if the first line is a
1549 headline, remove the stars from all headlines in the region.
1550 @end table
1552 @cindex region, active
1553 @cindex active region
1554 @cindex transient mark mode
1555 When there is an active region (Transient Mark mode), promotion and
1556 demotion work on all headlines in the region.  To select a region of
1557 headlines, it is best to place both point and mark at the beginning of a
1558 line, mark at the beginning of the first headline, and point at the line
1559 just after the last headline to change.  Note that when the cursor is
1560 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1561 functionality.
1564 @node Sparse trees, Plain lists, Structure editing, Document Structure
1565 @section Sparse trees
1566 @cindex sparse trees
1567 @cindex trees, sparse
1568 @cindex folding, sparse trees
1569 @cindex occur, command
1571 @vindex org-show-hierarchy-above
1572 @vindex org-show-following-heading
1573 @vindex org-show-siblings
1574 @vindex org-show-entry-below
1575 An important feature of Org mode is the ability to construct @emph{sparse
1576 trees} for selected information in an outline tree, so that the entire
1577 document is folded as much as possible, but the selected information is made
1578 visible along with the headline structure above it@footnote{See also the
1579 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1580 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1581 control on how much context is shown around each match.}.  Just try it out
1582 and you will see immediately how it works.
1584 Org mode contains several commands creating such trees, all these
1585 commands can be accessed through a dispatcher:
1587 @table @asis
1588 @orgcmd{C-c /,org-sparse-tree}
1589 This prompts for an extra key to select a sparse-tree creating command.
1590 @orgcmd{C-c / r,org-occur}
1591 @vindex org-remove-highlights-with-change
1592 Prompts for a regexp and shows a sparse tree with all matches.  If
1593 the match is in a headline, the headline is made visible.  If the match is in
1594 the body of an entry, headline and body are made visible.  In order to
1595 provide minimal context, also the full hierarchy of headlines above the match
1596 is shown, as well as the headline following the match.  Each match is also
1597 highlighted; the highlights disappear when the buffer is changed by an
1598 editing command@footnote{This depends on the option
1599 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1600 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1601 so several calls to this command can be stacked.
1602 @orgcmdkkc{M-g n,M-g M-n,next-error}
1603 Jump to the next sparse tree match in this buffer.
1604 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1605 Jump to the previous sparse tree match in this buffer.
1606 @end table
1608 @noindent
1609 @vindex org-agenda-custom-commands
1610 For frequently used sparse trees of specific search strings, you can
1611 use the option @code{org-agenda-custom-commands} to define fast
1612 keyboard access to specific sparse trees.  These commands will then be
1613 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1614 For example:
1616 @lisp
1617 (setq org-agenda-custom-commands
1618       '(("f" occur-tree "FIXME")))
1619 @end lisp
1621 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1622 a sparse tree matching the string @samp{FIXME}.
1624 The other sparse tree commands select headings based on TODO keywords,
1625 tags, or properties and will be discussed later in this manual.
1627 @kindex C-c C-e C-v
1628 @cindex printing sparse trees
1629 @cindex visible text, printing
1630 To print a sparse tree, you can use the Emacs command
1631 @code{ps-print-buffer-with-faces} which does not print invisible parts
1632 of the document @footnote{This does not work under XEmacs, because
1633 XEmacs uses selective display for outlining, not text properties.}.
1634 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1635 the document and print the resulting file.
1637 @node Plain lists, Drawers, Sparse trees, Document Structure
1638 @section Plain lists
1639 @cindex plain lists
1640 @cindex lists, plain
1641 @cindex lists, ordered
1642 @cindex ordered lists
1644 Within an entry of the outline tree, hand-formatted lists can provide
1645 additional structure.  They also provide a way to create lists of checkboxes
1646 (@pxref{Checkboxes}).  Org supports editing such lists, and every exporter
1647 (@pxref{Exporting}) can parse and format them.
1649 Org knows ordered lists, unordered lists, and description lists.
1650 @itemize @bullet
1651 @item
1652 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1653 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1654 they will be seen as top-level headlines.  Also, when you are hiding leading
1655 stars to get a clean outline view, plain list items starting with a star may
1656 be hard to distinguish from true headlines.  In short: even though @samp{*}
1657 is supported, it may be better to not use it for plain list items.}  as
1658 bullets.
1659 @item
1660 @vindex org-plain-list-ordered-item-terminator
1661 @vindex org-list-allow-alphabetical
1662 @emph{Ordered} list items start with a numeral followed by either a period or
1663 a right parenthesis@footnote{You can filter out any of them by configuring
1664 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1665 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1666 @samp{A)} by configuring @code{org-list-allow-alphabetical}.  To minimize
1667 confusion with normal text, those are limited to one character only.  Beyond
1668 that limit, bullets will automatically fallback to numbers.}.  If you want a
1669 list to start with a different value (e.g., 20), start the text of the item
1670 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1671 must be put @emph{before} the checkbox.  If you have activated alphabetical
1672 lists, you can also use counters like @code{[@@b]}.}.  Those constructs can
1673 be used in any item of the list in order to enforce a particular numbering.
1674 @item
1675 @emph{Description} list items are unordered list items, and contain the
1676 separator @samp{ :: } to distinguish the description @emph{term} from the
1677 description.
1678 @end itemize
1680 Items belonging to the same list must have the same indentation on the first
1681 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1682 2--digit numbers must be written left-aligned with the other numbers in the
1683 list.  An item ends before the next line that is less or equally indented
1684 than its bullet/number.
1686 @vindex org-list-empty-line-terminates-plain-lists
1687 A list ends whenever every item has ended, which means before any line less
1688 or equally indented than items at top level.  It also ends before two blank
1689 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1690 In that case, all items are closed.  Here is an example:
1692 @example
1693 @group
1694 ** Lord of the Rings
1695    My favorite scenes are (in this order)
1696    1. The attack of the Rohirrim
1697    2. Eowyn's fight with the witch king
1698       + this was already my favorite scene in the book
1699       + I really like Miranda Otto.
1700    3. Peter Jackson being shot by Legolas
1701       - on DVD only
1702       He makes a really funny face when it happens.
1703    But in the end, no individual scenes matter but the film as a whole.
1704    Important actors in this film are:
1705    - @b{Elijah Wood} :: He plays Frodo
1706    - @b{Sean Austin} :: He plays Sam, Frodo's friend.  I still remember
1707      him very well from his role as Mikey Walsh in @i{The Goonies}.
1708 @end group
1709 @end example
1711 Org supports these lists by tuning filling and wrapping commands to deal with
1712 them correctly@footnote{Org only changes the filling settings for Emacs.  For
1713 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}.  To turn this on,
1714 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1715 properly (@pxref{Exporting}).  Since indentation is what governs the
1716 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1717 blocks can be indented to signal that they belong to a particular item.
1719 @vindex org-list-demote-modify-bullet
1720 @vindex org-list-indent-offset
1721 If you find that using a different bullet for a sub-list (than that used for
1722 the current list-level) improves readability, customize the variable
1723 @code{org-list-demote-modify-bullet}.  To get a greater difference of
1724 indentation between items and theirs sub-items, customize
1725 @code{org-list-indent-offset}.
1727 @vindex org-list-automatic-rules
1728 The following commands act on items when the cursor is in the first line of
1729 an item (the line with the bullet or number).  Some of them imply the
1730 application of automatic rules to keep list structure intact.  If some of
1731 these actions get in your way, configure @code{org-list-automatic-rules}
1732 to disable them individually.
1734 @table @asis
1735 @orgcmd{@key{TAB},org-cycle}
1736 @cindex cycling, in plain lists
1737 @vindex org-cycle-include-plain-lists
1738 Items can be folded just like headline levels.  Normally this works only if
1739 the cursor is on a plain list item.  For more details, see the variable
1740 @code{org-cycle-include-plain-lists}.  If this variable is set to
1741 @code{integrate}, plain list items will be treated like low-level
1742 headlines.  The level of an item is then given by the indentation of the
1743 bullet/number.  Items are always subordinate to real headlines, however; the
1744 hierarchies remain completely separated.  In a new item with no text yet, the
1745 first @key{TAB} demotes the item to become a child of the previous
1746 one.  Subsequent @key{TAB}s move the item to meaningful levels in the list
1747 and eventually get it back to its initial position.
1748 @orgcmd{M-@key{RET},org-insert-heading}
1749 @vindex org-M-RET-may-split-line
1750 @vindex org-list-automatic-rules
1751 Insert new item at current level.  With a prefix argument, force a new
1752 heading (@pxref{Structure editing}).  If this command is used in the middle
1753 of an item, that item is @emph{split} in two, and the second part becomes the
1754 new item@footnote{If you do not want the item to be split, customize the
1755 variable @code{org-M-RET-may-split-line}.}.  If this command is executed
1756 @emph{before item's body}, the new item is created @emph{before} the current
1757 one.
1758 @end table
1760 @table @kbd
1761 @kindex M-S-@key{RET}
1762 @item M-S-@key{RET}
1763 Insert a new item with a checkbox (@pxref{Checkboxes}).
1764 @kindex S-@key{down}
1765 @item S-up
1766 @itemx S-down
1767 @cindex shift-selection-mode
1768 @vindex org-support-shift-select
1769 @vindex org-list-use-circular-motion
1770 Jump to the previous/next item in the current list@footnote{If you want to
1771 cycle around items that way, you may customize
1772 @code{org-list-use-circular-motion}.}, but only if
1773 @code{org-support-shift-select} is off.  If not, you can still use paragraph
1774 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1775 similar effect.
1776 @kindex M-@key{up}
1777 @kindex M-@key{down}
1778 @item M-up
1779 @itemx M-down
1780 Move the item including subitems up/down@footnote{See
1781 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1782 previous/next item of same indentation).  If the list is ordered, renumbering
1783 is automatic.
1784 @kindex M-@key{left}
1785 @kindex M-@key{right}
1786 @item M-left
1787 @itemx M-right
1788 Decrease/increase the indentation of an item, leaving children alone.
1789 @kindex M-S-@key{left}
1790 @kindex M-S-@key{right}
1791 @item M-S-@key{left}
1792 @itemx M-S-@key{right}
1793 Decrease/increase the indentation of the item, including subitems.
1794 Initially, the item tree is selected based on current indentation.  When
1795 these commands are executed several times in direct succession, the initially
1796 selected region is used, even if the new indentation would imply a different
1797 hierarchy.  To use the new hierarchy, break the command chain with a cursor
1798 motion or so.
1800 As a special case, using this command on the very first item of a list will
1801 move the whole list.  This behavior can be disabled by configuring
1802 @code{org-list-automatic-rules}.  The global indentation of a list has no
1803 influence on the text @emph{after} the list.
1804 @kindex C-c C-c
1805 @item C-c C-c
1806 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1807 state of the checkbox.  In any case, verify bullets and indentation
1808 consistency in the whole list.
1809 @kindex C-c -
1810 @vindex org-plain-list-ordered-item-terminator
1811 @item C-c -
1812 Cycle the entire list level through the different itemize/enumerate bullets
1813 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1814 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1815 and its indentation.  With a numeric prefix argument N, select the Nth bullet
1816 from this list.  If there is an active region when calling this, selected
1817 text will be changed into an item.  With a prefix argument, all lines will be
1818 converted to list items.  If the first line already was a list item, any item
1819 marker will be removed from the list.  Finally, even without an active
1820 region, a normal line will be converted into a list item.
1821 @kindex C-c *
1822 @item C-c *
1823 Turn a plain list item into a headline (so that it becomes a subheading at
1824 its location).  @xref{Structure editing}, for a detailed explanation.
1825 @kindex C-c C-*
1826 @item C-c C-*
1827 Turn the whole plain list into a subtree of the current heading.  Checkboxes
1828 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1829 (resp. checked).
1830 @kindex S-@key{left}
1831 @kindex S-@key{right}
1832 @item S-left/right
1833 @vindex org-support-shift-select
1834 This command also cycles bullet styles when the cursor in on the bullet or
1835 anywhere in an item line, details depending on
1836 @code{org-support-shift-select}.
1837 @kindex C-c ^
1838 @cindex sorting, of plain list
1839 @item C-c ^
1840 Sort the plain list.  You will be prompted for the sorting method:
1841 numerically, alphabetically, by time, by checked status for check lists,
1842 or by a custom function.
1843 @end table
1845 @node Drawers, Blocks, Plain lists, Document Structure
1846 @section Drawers
1847 @cindex drawers
1848 @cindex #+DRAWERS
1849 @cindex visibility cycling, drawers
1851 @vindex org-drawers
1852 @cindex org-insert-drawer
1853 @kindex C-c C-x d
1854 Sometimes you want to keep information associated with an entry, but you
1855 normally don't want to see it.  For this, Org mode has @emph{drawers}.
1856 Drawers need to be configured with the option @code{org-drawers}@footnote{You
1857 can define additional drawers on a per-file basis with a line like
1858 @code{#+DRAWERS: HIDDEN STATE}}.  Drawers look like this:
1860 @example
1861 ** This is a headline
1862    Still outside the drawer
1863    :DRAWERNAME:
1864    This is inside the drawer.
1865    :END:
1866    After the drawer.
1867 @end example
1869 You can interactively insert drawers at point by calling
1870 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}.  With an active
1871 region, this command will put the region inside the drawer.  With a prefix
1872 argument, this command calls @code{org-insert-property-drawer} and add a
1873 property drawer right below the current headline.  Completion over drawer
1874 keywords is also possible using @key{M-TAB}.
1876 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1877 show the entry, but keep the drawer collapsed to a single line.  In order to
1878 look inside the drawer, you need to move the cursor to the drawer line and
1879 press @key{TAB} there.  Org mode uses the @code{PROPERTIES} drawer for
1880 storing properties (@pxref{Properties and Columns}), and you can also arrange
1881 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1882 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.  If you
1883 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1885 @table @kbd
1886 @kindex C-c C-z
1887 @item C-c C-z
1888 Add a time-stamped note to the LOGBOOK drawer.
1889 @end table
1891 @vindex org-export-with-drawers
1892 You can select the name of the drawers which should be exported with
1893 @code{org-export-with-drawers}.  In that case, drawer contents will appear in
1894 export output.  Property drawers are not affected by this variable and are
1895 never exported.
1897 @node Blocks, Footnotes, Drawers, Document Structure
1898 @section Blocks
1900 @vindex org-hide-block-startup
1901 @cindex blocks, folding
1902 Org mode uses begin...end blocks for various purposes from including source
1903 code examples (@pxref{Literal examples}) to capturing time logging
1904 information (@pxref{Clocking work time}).  These blocks can be folded and
1905 unfolded by pressing TAB in the begin line.  You can also get all blocks
1906 folded at startup by configuring the option @code{org-hide-block-startup}
1907 or on a per-file basis by using
1909 @cindex @code{hideblocks}, STARTUP keyword
1910 @cindex @code{nohideblocks}, STARTUP keyword
1911 @example
1912 #+STARTUP: hideblocks
1913 #+STARTUP: nohideblocks
1914 @end example
1916 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1917 @section Footnotes
1918 @cindex footnotes
1920 Org mode supports the creation of footnotes.  In contrast to the
1921 @file{footnote.el} package, Org mode's footnotes are designed for work on
1922 a larger document, not only for one-off documents like emails.
1924 A footnote is started by a footnote marker in square brackets in column 0, no
1925 indentation allowed.  It ends at the next footnote definition, headline, or
1926 after two consecutive empty lines.  The footnote reference is simply the
1927 marker in square brackets, inside text.  For example:
1929 @example
1930 The Org homepage[fn:1] now looks a lot better than it used to.
1932 [fn:1] The link is: http://orgmode.org
1933 @end example
1935 Org mode extends the number-based syntax to @emph{named} footnotes and
1936 optional inline definition.  Using plain numbers as markers (as
1937 @file{footnote.el} does) is supported for backward compatibility, but not
1938 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1939 @LaTeX{}}).  Here are the valid references:
1941 @table @code
1942 @item [1]
1943 A plain numeric footnote marker.  Compatible with @file{footnote.el}, but not
1944 recommended because something like @samp{[1]} could easily be part of a code
1945 snippet.
1946 @item [fn:name]
1947 A named footnote reference, where @code{name} is a unique label word, or, for
1948 simplicity of automatic creation, a number.
1949 @item [fn:: This is the inline definition of this footnote]
1950 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1951 reference point.
1952 @item [fn:name: a definition]
1953 An inline definition of a footnote, which also specifies a name for the note.
1954 Since Org allows multiple references to the same note, you can then use
1955 @code{[fn:name]} to create additional references.
1956 @end table
1958 @vindex org-footnote-auto-label
1959 Footnote labels can be created automatically, or you can create names yourself.
1960 This is handled by the variable @code{org-footnote-auto-label} and its
1961 corresponding @code{#+STARTUP} keywords.  See the docstring of that variable
1962 for details.
1964 @noindent The following command handles footnotes:
1966 @table @kbd
1967 @kindex C-c C-x f
1968 @item C-c C-x f
1969 The footnote action command.
1971 When the cursor is on a footnote reference, jump to the definition.  When it
1972 is at a definition, jump to the (first) reference.
1974 @vindex org-footnote-define-inline
1975 @vindex org-footnote-section
1976 @vindex org-footnote-auto-adjust
1977 Otherwise, create a new footnote.  Depending on the option
1978 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1979 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1980 definition will be placed right into the text as part of the reference, or
1981 separately into the location determined by the option
1982 @code{org-footnote-section}.
1984 When this command is called with a prefix argument, a menu of additional
1985 options is offered:
1986 @example
1987 s   @r{Sort the footnote definitions by reference sequence.  During editing,}
1988     @r{Org makes no effort to sort footnote definitions into a particular}
1989     @r{sequence.  If you want them sorted, use this command, which will}
1990     @r{also move entries according to @code{org-footnote-section}.  Automatic}
1991     @r{sorting after each insertion/deletion can be configured using the}
1992     @r{option @code{org-footnote-auto-adjust}.}
1993 r   @r{Renumber the simple @code{fn:N} footnotes.  Automatic renumbering}
1994     @r{after each insertion/deletion can be configured using the option}
1995     @r{@code{org-footnote-auto-adjust}.}
1996 S   @r{Short for first @code{r}, then @code{s} action.}
1997 n   @r{Normalize the footnotes by collecting all definitions (including}
1998     @r{inline definitions) into a special section, and then numbering them}
1999     @r{in sequence.  The references will then also be numbers.  This is}
2000     @r{meant to be the final step before finishing a document (e.g., sending}
2001     @r{off an email).}
2002 d   @r{Delete the footnote at point, and all definitions of and references}
2003     @r{to it.}
2004 @end example
2005 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
2006 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
2007 renumbering and sorting footnotes can be automatic after each insertion or
2008 deletion.
2010 @kindex C-c C-c
2011 @item C-c C-c
2012 If the cursor is on a footnote reference, jump to the definition.  If it is a
2013 the definition, jump back to the reference.  When called at a footnote
2014 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
2015 @kindex C-c C-o
2016 @kindex mouse-1
2017 @kindex mouse-2
2018 @item C-c C-o  @r{or} mouse-1/2
2019 Footnote labels are also links to the corresponding definition/reference, and
2020 you can use the usual commands to follow these links.
2021 @end table
2023 @node Orgstruct mode, Org syntax, Footnotes, Document Structure
2024 @section The Orgstruct minor mode
2025 @cindex Orgstruct mode
2026 @cindex minor mode for structure editing
2028 If you like the intuitive way the Org mode structure editing and list
2029 formatting works, you might want to use these commands in other modes like
2030 Text mode or Mail mode as well.  The minor mode @code{orgstruct-mode} makes
2031 this possible.   Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2032 turn it on by default, for example in Message mode, with one of:
2034 @lisp
2035 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2036 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2037 @end lisp
2039 When this mode is active and the cursor is on a line that looks to Org like a
2040 headline or the first line of a list item, most structure editing commands
2041 will work, even if the same keys normally have different functionality in the
2042 major mode you are using.  If the cursor is not in one of those special
2043 lines, Orgstruct mode lurks silently in the shadows.
2045 When you use @code{orgstruct++-mode}, Org will also export indentation and
2046 autofill settings into that mode, and detect item context after the first
2047 line of an item.
2049 @vindex orgstruct-heading-prefix-regexp
2050 You can also use Org structure editing to fold and unfold headlines in
2051 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2052 the regular expression must match the local prefix to use before Org's
2053 headlines.  For example, if you set this variable to @code{";; "} in Emacs
2054 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2055 commented lines.  Some commands like @code{org-demote} are disabled when the
2056 prefix is set, but folding/unfolding will work correctly.
2058 @node Org syntax,  , Orgstruct mode, Document Structure
2059 @section Org syntax
2060 @cindex Org syntax
2062 A reference document providing a formal description of Org's syntax is
2063 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2064 Worg}, written and maintained by Nicolas Goaziou.  It defines Org's core
2065 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2066 keywords}, @code{(greater) elements} and @code{objects}.  Each part of an Org
2067 file falls into one of the categories above.
2069 To explore the abstract structure of an Org buffer, run this in a buffer:
2071 @lisp
2072 M-: (org-element-parse-buffer) RET
2073 @end lisp
2075 It will output a list containing the buffer's content represented as an
2076 abstract structure.  The export engine relies on the information stored in
2077 this list.  Most interactive commands (e.g., for structure editing) also
2078 rely on the syntactic meaning of the surrounding context.
2080 @node Tables, Hyperlinks, Document Structure, Top
2081 @chapter Tables
2082 @cindex tables
2083 @cindex editing tables
2085 Org comes with a fast and intuitive table editor.  Spreadsheet-like
2086 calculations are supported using the Emacs @file{calc} package
2087 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2089 @menu
2090 * Built-in table editor::       Simple tables
2091 * Column width and alignment::  Overrule the automatic settings
2092 * Column groups::               Grouping to trigger vertical lines
2093 * Orgtbl mode::                 The table editor as minor mode
2094 * The spreadsheet::             The table editor has spreadsheet capabilities
2095 * Org-Plot::                    Plotting from org tables
2096 @end menu
2098 @node Built-in table editor, Column width and alignment, Tables, Tables
2099 @section The built-in table editor
2100 @cindex table editor, built-in
2102 Org makes it easy to format tables in plain ASCII@.  Any line with @samp{|} as
2103 the first non-whitespace character is considered part of a table.  @samp{|}
2104 is also the column separator@footnote{To insert a vertical bar into a table
2105 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}.  A table
2106 might look like this:
2108 @example
2109 | Name  | Phone | Age |
2110 |-------+-------+-----|
2111 | Peter |  1234 |  17 |
2112 | Anna  |  4321 |  25 |
2113 @end example
2115 A table is re-aligned automatically each time you press @key{TAB} or
2116 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
2117 the next field (@key{RET} to the next row) and creates new table rows
2118 at the end of the table or before horizontal lines.  The indentation
2119 of the table is set by the first line.  Any line starting with
2120 @samp{|-} is considered as a horizontal separator line and will be
2121 expanded on the next re-align to span the whole table width.  So, to
2122 create the above table, you would only type
2124 @example
2125 |Name|Phone|Age|
2127 @end example
2129 @noindent and then press @key{TAB} to align the table and start filling in
2130 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
2131 @kbd{C-c @key{RET}}.
2133 @vindex org-enable-table-editor
2134 @vindex org-table-auto-blank-field
2135 When typing text into a field, Org treats @key{DEL},
2136 @key{Backspace}, and all character keys in a special way, so that
2137 inserting and deleting avoids shifting other fields.  Also, when
2138 typing @emph{immediately after the cursor was moved into a new field
2139 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2140 field is automatically made blank.  If this behavior is too
2141 unpredictable for you, configure the options
2142 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2144 @table @kbd
2145 @tsubheading{Creation and conversion}
2146 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2147 Convert the active region to table.  If every line contains at least one
2148 TAB character, the function assumes that the material is tab separated.
2149 If every line contains a comma, comma-separated values (CSV) are assumed.
2150 If not, lines are split at whitespace into fields.  You can use a prefix
2151 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2152 C-u} forces TAB, and a numeric argument N indicates that at least N
2153 consecutive spaces, or alternatively a TAB will be the separator.
2155 If there is no active region, this command creates an empty Org
2156 table.  But it is easier just to start typing, like
2157 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2159 @tsubheading{Re-aligning and field motion}
2160 @orgcmd{C-c C-c,org-table-align}
2161 Re-align the table and don't move to another field.
2163 @orgcmd{<TAB>,org-table-next-field}
2164 Re-align the table, move to the next field.  Creates a new row if
2165 necessary.
2167 @orgcmd{S-@key{TAB},org-table-previous-field}
2168 Re-align, move to previous field.
2170 @orgcmd{@key{RET},org-table-next-row}
2171 Re-align the table and move down to next row.  Creates a new row if
2172 necessary.  At the beginning or end of a line, @key{RET} still does
2173 NEWLINE, so it can be used to split a table.
2175 @orgcmd{M-a,org-table-beginning-of-field}
2176 Move to beginning of the current table field, or on to the previous field.
2177 @orgcmd{M-e,org-table-end-of-field}
2178 Move to end of the current table field, or on to the next field.
2180 @tsubheading{Column and row editing}
2181 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2182 Move the current column left/right.
2184 @orgcmd{M-S-@key{left},org-table-delete-column}
2185 Kill the current column.
2187 @orgcmd{M-S-@key{right},org-table-insert-column}
2188 Insert a new column to the left of the cursor position.
2190 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2191 Move the current row up/down.
2193 @orgcmd{M-S-@key{up},org-table-kill-row}
2194 Kill the current row or horizontal line.
2196 @orgcmd{M-S-@key{down},org-table-insert-row}
2197 Insert a new row above the current row.  With a prefix argument, the line is
2198 created below the current one.
2200 @orgcmd{C-c -,org-table-insert-hline}
2201 Insert a horizontal line below current row.  With a prefix argument, the line
2202 is created above the current line.
2204 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2205 Insert a horizontal line below current row, and move the cursor into the row
2206 below that line.
2208 @orgcmd{C-c ^,org-table-sort-lines}
2209 Sort the table lines in the region.  The position of point indicates the
2210 column to be used for sorting, and the range of lines is the range
2211 between the nearest horizontal separator lines, or the entire table.  If
2212 point is before the first column, you will be prompted for the sorting
2213 column.  If there is an active region, the mark specifies the first line
2214 and the sorting column, while point should be in the last line to be
2215 included into the sorting.  The command prompts for the sorting type
2216 (alphabetically, numerically, or by time).  When called with a prefix
2217 argument, alphabetic sorting will be case-sensitive.
2219 @tsubheading{Regions}
2220 @orgcmd{C-c C-x M-w,org-table-copy-region}
2221 Copy a rectangular region from a table to a special clipboard.  Point and
2222 mark determine edge fields of the rectangle.  If there is no active region,
2223 copy just the current field.  The process ignores horizontal separator lines.
2225 @orgcmd{C-c C-x C-w,org-table-cut-region}
2226 Copy a rectangular region from a table to a special clipboard, and
2227 blank all fields in the rectangle.  So this is the ``cut'' operation.
2229 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2230 Paste a rectangular region into a table.
2231 The upper left corner ends up in the current field.  All involved fields
2232 will be overwritten.  If the rectangle does not fit into the present table,
2233 the table is enlarged as needed.  The process ignores horizontal separator
2234 lines.
2236 @orgcmd{M-@key{RET},org-table-wrap-region}
2237 Split the current field at the cursor position and move the rest to the line
2238 below.  If there is an active region, and both point and mark are in the same
2239 column, the text in the column is wrapped to minimum width for the given
2240 number of lines.  A numeric prefix argument may be used to change the number
2241 of desired lines.  If there is no region, but you specify a prefix argument,
2242 the current field is made blank, and the content is appended to the field
2243 above.
2245 @tsubheading{Calculations}
2246 @cindex formula, in tables
2247 @cindex calculations, in tables
2248 @cindex region, active
2249 @cindex active region
2250 @cindex transient mark mode
2251 @orgcmd{C-c +,org-table-sum}
2252 Sum the numbers in the current column, or in the rectangle defined by
2253 the active region.  The result is shown in the echo area and can
2254 be inserted with @kbd{C-y}.
2256 @orgcmd{S-@key{RET},org-table-copy-down}
2257 @vindex org-table-copy-increment
2258 When current field is empty, copy from first non-empty field above.  When not
2259 empty, copy current field down to next row and move cursor along with it.
2260 Depending on the option @code{org-table-copy-increment}, integer field
2261 values will be incremented during copy.  Integers that are too large will not
2262 be incremented.  Also, a @code{0} prefix argument temporarily disables the
2263 increment.  This key is also used by shift-selection and related modes
2264 (@pxref{Conflicts}).
2266 @tsubheading{Miscellaneous}
2267 @orgcmd{C-c `,org-table-edit-field}
2268 Edit the current field in a separate window.  This is useful for fields that
2269 are not fully visible (@pxref{Column width and alignment}).  When called with
2270 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2271 edited in place.  When called with two @kbd{C-u} prefixes, make the editor
2272 window follow the cursor through the table and always show the current
2273 field.  The follow mode exits automatically when the cursor leaves the table,
2274 or when you repeat this command with @kbd{C-u C-u C-c `}.
2276 @item M-x org-table-import RET
2277 Import a file as a table.  The table should be TAB or whitespace
2278 separated.  Use, for example, to import a spreadsheet table or data
2279 from a database, because these programs generally can write
2280 TAB-separated text files.  This command works by inserting the file into
2281 the buffer and then converting the region to a table.  Any prefix
2282 argument is passed on to the converter, which uses it to determine the
2283 separator.
2284 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2285 Tables can also be imported by pasting tabular text into the Org
2286 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2287 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2289 @item M-x org-table-export RET
2290 @findex org-table-export
2291 @vindex org-table-export-default-format
2292 Export the table, by default as a TAB-separated file.  Use for data
2293 exchange with, for example, spreadsheet or database programs.  The format
2294 used to export the file can be configured in the option
2295 @code{org-table-export-default-format}.  You may also use properties
2296 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2297 name and the format for table export in a subtree.  Org supports quite
2298 general formats for exported tables.  The exporter format is the same as the
2299 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2300 detailed description.
2301 @end table
2303 If you don't like the automatic table editor because it gets in your
2304 way on lines which you would like to start with @samp{|}, you can turn
2305 it off with
2307 @lisp
2308 (setq org-enable-table-editor nil)
2309 @end lisp
2311 @noindent Then the only table command that still works is
2312 @kbd{C-c C-c} to do a manual re-align.
2314 @node Column width and alignment, Column groups, Built-in table editor, Tables
2315 @section Column width and alignment
2316 @cindex narrow columns in tables
2317 @cindex alignment in tables
2319 The width of columns is automatically determined by the table editor.  And
2320 also the alignment of a column is determined automatically from the fraction
2321 of number-like versus non-number fields in the column.
2323 Sometimes a single field or a few fields need to carry more text, leading to
2324 inconveniently wide columns.  Or maybe you want to make a table with several
2325 columns having a fixed width, regardless of content.  To set@footnote{This
2326 feature does not work on XEmacs.} the width of a column, one field anywhere
2327 in the column may contain just the string @samp{<N>} where @samp{N} is an
2328 integer specifying the width of the column in characters.  The next re-align
2329 will then set the width of this column to this value.
2331 @example
2332 @group
2333 |---+------------------------------|               |---+--------|
2334 |   |                              |               |   | <6>    |
2335 | 1 | one                          |               | 1 | one    |
2336 | 2 | two                          |     ----\     | 2 | two    |
2337 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
2338 | 4 | four                         |               | 4 | four   |
2339 |---+------------------------------|               |---+--------|
2340 @end group
2341 @end example
2343 @noindent
2344 Fields that are wider become clipped and end in the string @samp{=>}.
2345 Note that the full text is still in the buffer but is hidden.
2346 To see the full text, hold the mouse over the field---a tool-tip window
2347 will show the full content.  To edit such a field, use the command
2348 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
2349 open a new window with the full field.  Edit it and finish with @kbd{C-c
2350 C-c}.
2352 @vindex org-startup-align-all-tables
2353 When visiting a file containing a table with narrowed columns, the
2354 necessary character hiding has not yet happened, and the table needs to
2355 be aligned before it looks nice.  Setting the option
2356 @code{org-startup-align-all-tables} will realign all tables in a file
2357 upon visiting, but also slow down startup.  You can also set this option
2358 on a per-file basis with:
2360 @example
2361 #+STARTUP: align
2362 #+STARTUP: noalign
2363 @end example
2365 If you would like to overrule the automatic alignment of number-rich columns
2366 to the right and of string-rich column to the left, you can use @samp{<r>},
2367 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2368 effect when exporting to HTML.} or @samp{<l>} in a similar fashion.  You may
2369 also combine alignment and field width like this: @samp{<r10>}.
2371 Lines which only contain these formatting cookies will be removed
2372 automatically when exporting the document.
2374 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2375 @section Column groups
2376 @cindex grouping columns in tables
2378 When Org exports tables, it does so by default without vertical
2379 lines because that is visually more satisfying in general.  Occasionally
2380 however, vertical lines can be useful to structure a table into groups
2381 of columns, much like horizontal lines can do for groups of rows.  In
2382 order to specify column groups, you can use a special row where the
2383 first field contains only @samp{/}.  The further fields can either
2384 contain @samp{<} to indicate that this column should start a group,
2385 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2386 and @samp{>}) to make a column
2387 a group of its own.  Boundaries between column groups will upon export be
2388 marked with vertical lines.  Here is an example:
2390 @example
2391 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2392 |---+-----+-----+-----+---------+------------|
2393 | / |   < |     |   > |       < |          > |
2394 | 1 |   1 |   1 |   1 |       1 |          1 |
2395 | 2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
2396 | 3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
2397 |---+-----+-----+-----+---------+------------|
2398 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2399 @end example
2401 It is also sufficient to just insert the column group starters after
2402 every vertical line you would like to have:
2404 @example
2405 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2406 |----+-----+-----+-----+---------+------------|
2407 | /  | <   |     |     | <       |            |
2408 @end example
2410 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2411 @section The Orgtbl minor mode
2412 @cindex Orgtbl mode
2413 @cindex minor mode for tables
2415 If you like the intuitive way the Org table editor works, you
2416 might also want to use it in other modes like Text mode or Mail mode.
2417 The minor mode Orgtbl mode makes this possible.  You can always toggle
2418 the mode with @kbd{M-x orgtbl-mode RET}.  To turn it on by default, for
2419 example in Message mode, use
2421 @lisp
2422 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2423 @end lisp
2425 Furthermore, with some special setup, it is possible to maintain tables
2426 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
2427 construct @LaTeX{} tables with the underlying ease and power of
2428 Orgtbl mode, including spreadsheet capabilities.  For details, see
2429 @ref{Tables in arbitrary syntax}.
2431 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2432 @section The spreadsheet
2433 @cindex calculations, in tables
2434 @cindex spreadsheet capabilities
2435 @cindex @file{calc} package
2437 The table editor makes use of the Emacs @file{calc} package to implement
2438 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
2439 derive fields from other fields.  While fully featured, Org's implementation
2440 is not identical to other spreadsheets.  For example, Org knows the concept
2441 of a @emph{column formula} that will be applied to all non-header fields in a
2442 column without having to copy the formula to each relevant field.  There is
2443 also a formula debugger, and a formula editor with features for highlighting
2444 fields in the table corresponding to the references at the point in the
2445 formula, moving these references by arrow keys
2447 @menu
2448 * References::                  How to refer to another field or range
2449 * Formula syntax for Calc::     Using Calc to compute stuff
2450 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
2451 * Durations and time values::   How to compute durations and time values
2452 * Field and range formulas::    Formula for specific (ranges of) fields
2453 * Column formulas::             Formulas valid for an entire column
2454 * Lookup functions::            Lookup functions for searching tables
2455 * Editing and debugging formulas::  Fixing formulas
2456 * Updating the table::          Recomputing all dependent fields
2457 * Advanced features::           Field and column names, parameters and automatic recalc
2458 @end menu
2460 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2461 @subsection References
2462 @cindex references
2464 To compute fields in the table from other fields, formulas must
2465 reference other fields or ranges.  In Org, fields can be referenced
2466 by name, by absolute coordinates, and by relative coordinates.  To find
2467 out what the coordinates of a field are, press @kbd{C-c ?} in that
2468 field, or press @kbd{C-c @}} to toggle the display of a grid.
2470 @subsubheading Field references
2471 @cindex field references
2472 @cindex references, to fields
2474 Formulas can reference the value of another field in two ways.  Like in
2475 any other spreadsheet, you may reference fields with a letter/number
2476 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2477 @vindex org-table-use-standard-references
2478 However, Org prefers@footnote{Org will understand references typed by the
2479 user as @samp{B4}, but it will not use this syntax when offering a formula
2480 for editing.  You can customize this behavior using the option
2481 @code{org-table-use-standard-references}.} to use another, more general
2482 representation that looks like this:
2483 @example
2484 @@@var{row}$@var{column}
2485 @end example
2487 Column specifications can be absolute like @code{$1},
2488 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2489 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2490 @code{$<} and @code{$>} are immutable references to the first and last
2491 column, respectively, and you can use @code{$>>>} to indicate the third
2492 column from the right.
2494 The row specification only counts data lines and ignores horizontal separator
2495 lines (hlines).  Like with columns, you can use absolute row numbers
2496 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2497 current row like @code{@@+3} or @code{@@-1}.  @code{@@<} and @code{@@>} are
2498 immutable references the first and last@footnote{For backward compatibility
2499 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2500 a stable way to the 5th and 12th field in the last row of the table.
2501 However, this syntax is deprecated, it should not be used for new documents.
2502 Use @code{@@>$} instead.} row in the table, respectively.  You may also
2503 specify the row relative to one of the hlines: @code{@@I} refers to the first
2504 hline, @code{@@II} to the second, etc.  @code{@@-I} refers to the first such
2505 line above the current line, @code{@@+I} to the first such line below the
2506 current line.  You can also write @code{@@III+2} which is the second data line
2507 after the third hline in the table.
2509 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2510 i.e., to the row/column for the field being computed.  Also, if you omit
2511 either the column or the row part of the reference, the current row/column is
2512 implied.
2514 Org's references with @emph{unsigned} numbers are fixed references
2515 in the sense that if you use the same reference in the formula for two
2516 different fields, the same field will be referenced each time.
2517 Org's references with @emph{signed} numbers are floating
2518 references because the same reference operator can reference different
2519 fields depending on the field being calculated by the formula.
2521 Here are a few examples:
2523 @example
2524 @@2$3      @r{2nd row, 3rd column (same as @code{C2})}
2525 $5        @r{column 5 in the current row (same as @code{E&})}
2526 @@2        @r{current column, row 2}
2527 @@-1$-3    @r{the field one row up, three columns to the left}
2528 @@-I$2     @r{field just under hline above current row, column 2}
2529 @@>$5      @r{field in the last row, in column 5}
2530 @end example
2532 @subsubheading Range references
2533 @cindex range references
2534 @cindex references, to ranges
2536 You may reference a rectangular range of fields by specifying two field
2537 references connected by two dots @samp{..}.  If both fields are in the
2538 current row, you may simply use @samp{$2..$7}, but if at least one field
2539 is in a different row, you need to use the general @code{@@row$column}
2540 format at least for the first field (i.e the reference must start with
2541 @samp{@@} in order to be interpreted correctly).  Examples:
2543 @example
2544 $1..$3        @r{first three fields in the current row}
2545 $P..$Q        @r{range, using column names (see under Advanced)}
2546 $<<<..$>>     @r{start in third column, continue to the one but last}
2547 @@2$1..@@4$3    @r{6 fields between these two fields (same as @code{A2..C4})}
2548 @@-1$-2..@@-1   @r{3 fields in the row above, starting from 2 columns on the left}
2549 @@I..II        @r{between first and second hline, short for @code{@@I..@@II}}
2550 @end example
2552 @noindent Range references return a vector of values that can be fed
2553 into Calc vector functions.  Empty fields in ranges are normally suppressed,
2554 so that the vector contains only the non-empty fields.  For other options
2555 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2556 for Calc}.
2558 @subsubheading Field coordinates in formulas
2559 @cindex field coordinates
2560 @cindex coordinates, of field
2561 @cindex row, of field coordinates
2562 @cindex column, of field coordinates
2564 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2565 get the row or column number of the field where the formula result goes.
2566 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2567 and @code{org-table-current-column}.  Examples:
2569 @example
2570 if(@@# % 2, $#, string(""))   @r{column number on odd lines only}
2571 $3 = remote(FOO, @@@@#$2)      @r{copy column 2 from table FOO into}
2572                              @r{column 3 of the current table}
2573 @end example
2575 @noindent For the second example, table FOO must have at least as many rows
2576 as the current table.  Note that this is inefficient@footnote{The computation time scales as
2577 O(N^2) because table FOO is parsed for each field to be copied.} for large
2578 number of rows.
2580 @subsubheading Named references
2581 @cindex named references
2582 @cindex references, named
2583 @cindex name, of column or field
2584 @cindex constants, in calculations
2585 @cindex #+CONSTANTS
2587 @vindex org-table-formula-constants
2588 @samp{$name} is interpreted as the name of a column, parameter or
2589 constant.  Constants are defined globally through the option
2590 @code{org-table-formula-constants}, and locally (for the file) through a
2591 line like
2593 @example
2594 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2595 @end example
2597 @noindent
2598 @vindex constants-unit-system
2599 @pindex constants.el
2600 Also properties (@pxref{Properties and Columns}) can be used as
2601 constants in table formulas: for a property @samp{:Xyz:} use the name
2602 @samp{$PROP_Xyz}, and the property will be searched in the current
2603 outline entry and in the hierarchy above it.  If you have the
2604 @file{constants.el} package, it will also be used to resolve constants,
2605 including natural constants like @samp{$h} for Planck's constant, and
2606 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2607 supply the values of constants in two different unit systems, @code{SI}
2608 and @code{cgs}.  Which one is used depends on the value of the variable
2609 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
2610 @code{constSI} and @code{constcgs} to set this value for the current
2611 buffer.}.  Column names and parameters can be specified in special table
2612 lines.  These are described below, see @ref{Advanced features}.  All
2613 names must start with a letter, and further consist of letters and
2614 numbers.
2616 @subsubheading Remote references
2617 @cindex remote references
2618 @cindex references, remote
2619 @cindex references, to a different table
2620 @cindex name, of column or field
2621 @cindex constants, in calculations
2622 @cindex #+NAME, for table
2624 You may also reference constants, fields and ranges from a different table,
2625 either in the current file or even in a different file.  The syntax is
2627 @example
2628 remote(NAME-OR-ID,REF)
2629 @end example
2631 @noindent
2632 where NAME can be the name of a table in the current file as set by a
2633 @code{#+NAME: Name} line before the table.  It can also be the ID of an
2634 entry, even in a different file, and the reference then refers to the first
2635 table in that entry.  REF is an absolute field or range reference as
2636 described above for example @code{@@3$3} or @code{$somename}, valid in the
2637 referenced table.
2639 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2640 @subsection Formula syntax for Calc
2641 @cindex formula syntax, Calc
2642 @cindex syntax, of formulas
2644 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2645 package.  Note that @file{calc} has the non-standard convention that @samp{/}
2646 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2647 @samp{a/(b*c)}.  Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2648 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2649 GNU Emacs Calc Manual}), variable substitution takes place according to the
2650 rules described above.
2651 @cindex vectors, in table calculations
2652 The range vectors can be directly fed into the Calc vector functions
2653 like @samp{vmean} and @samp{vsum}.
2655 @cindex format specifier
2656 @cindex mode, for @file{calc}
2657 @vindex org-calc-default-modes
2658 A formula can contain an optional mode string after a semicolon.  This
2659 string consists of flags to influence Calc and other modes during
2660 execution.  By default, Org uses the standard Calc modes (precision
2661 12, angular units degrees, fraction and symbolic modes off).  The display
2662 format, however, has been changed to @code{(float 8)} to keep tables
2663 compact.  The default settings can be configured using the option
2664 @code{org-calc-default-modes}.
2666 @noindent List of modes:
2668 @table @asis
2669 @item @code{p20}
2670 Set the internal Calc calculation precision to 20 digits.
2671 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2672 Normal, scientific, engineering or fixed format of the result of Calc passed
2673 back to Org.  Calc formatting is unlimited in precision as long as the Calc
2674 calculation precision is greater.
2675 @item @code{D}, @code{R}
2676 Degree and radian angle modes of Calc.
2677 @item @code{F}, @code{S}
2678 Fraction and symbolic modes of Calc.
2679 @item @code{T}, @code{t}
2680 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2681 @item @code{E}
2682 If and how to consider empty fields.  Without @samp{E} empty fields in range
2683 references are suppressed so that the Calc vector or Lisp list contains only
2684 the non-empty fields.  With @samp{E} the empty fields are kept.  For empty
2685 fields in ranges or empty field references the value @samp{nan} (not a
2686 number) is used in Calc formulas and the empty string is used for Lisp
2687 formulas.  Add @samp{N} to use 0 instead for both formula types.  For the
2688 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2689 @item @code{N}
2690 Interpret all fields as numbers, use 0 for non-numbers.  See the next section
2691 to see how this is essential for computations with Lisp formulas.  In Calc
2692 formulas it is used only occasionally because there number strings are
2693 already interpreted as numbers without @samp{N}.
2694 @item @code{L}
2695 Literal, for Lisp formulas only.  See the next section.
2696 @end table
2698 @noindent
2699 Unless you use large integer numbers or high-precision-calculation and
2700 -display for floating point numbers you may alternatively provide a
2701 @samp{printf} format specifier to reformat the Calc result after it has been
2702 passed back to Org instead of letting Calc already do the
2703 formatting@footnote{The @samp{printf} reformatting is limited in precision
2704 because the value passed to it is converted into an @samp{integer} or
2705 @samp{double}.  The @samp{integer} is limited in size by truncating the
2706 signed value to 32 bits.  The @samp{double} is limited in precision to 64
2707 bits overall which leaves approximately 16 significant decimal digits.}.  A
2708 few examples:
2710 @example
2711 $1+$2                @r{Sum of first and second field}
2712 $1+$2;%.2f           @r{Same, format result to two decimals}
2713 exp($2)+exp($1)      @r{Math functions can be used}
2714 $0;%.1f              @r{Reformat current cell to 1 decimal}
2715 ($3-32)*5/9          @r{Degrees F -> C conversion}
2716 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
2717 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
2718 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
2719 taylor($3,x=7,2)     @r{Taylor series of $3, at x=7, second degree}
2720 @end example
2722 Calc also contains a complete set of logical operations, (@pxref{Logical
2723 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}).  For example
2725 @table @code
2726 @item if($1 < 20, teen, string(""))
2727 "teen" if age $1 is less than 20, else the Org table result field is set to
2728 empty with the empty string.
2729 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E
2730 Sum of the first two columns.  When at least one of the input fields is empty
2731 the Org table result field is set to empty.
2732 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2733 Mean value of a range unless there is any empty field.  Every field in the
2734 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2735 in @samp{nan}.  Then @samp{typeof == 12} detects the @samp{nan} from
2736 @samp{vmean} and the Org table result field is set to empty.  Use this when
2737 the sample set is expected to never have missing values.
2738 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2739 Mean value of a range with empty fields skipped.  Every field in the range
2740 that is empty is skipped.  When all fields in the range are empty the mean
2741 value is not defined and the Org table result field is set to empty.  Use
2742 this when the sample set can have a variable size.
2743 @item vmean($1..$7); EN
2744 To complete the example before: Mean value of a range with empty fields
2745 counting as samples with value 0.  Use this only when incomplete sample sets
2746 should be padded with 0 to the full size.
2747 @end table
2749 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2750 and use them in formula syntax for Calc.
2752 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2753 @subsection Emacs Lisp forms as formulas
2754 @cindex Lisp forms, as table formulas
2756 It is also possible to write a formula in Emacs Lisp.  This can be useful
2757 for string manipulation and control structures, if Calc's functionality is
2758 not enough.
2760 If a formula starts with a single-quote followed by an opening parenthesis,
2761 then it is evaluated as a Lisp form.  The evaluation should return either a
2762 string or a number.  Just as with @file{calc} formulas, you can specify modes
2763 and a printf format after a semicolon.
2765 With Emacs Lisp forms, you need to be conscious about the way field
2766 references are interpolated into the form.  By default, a reference will be
2767 interpolated as a Lisp string (in double-quotes) containing the field.  If
2768 you provide the @samp{N} mode switch, all referenced elements will be numbers
2769 (non-number fields will be zero) and interpolated as Lisp numbers, without
2770 quotes.  If you provide the @samp{L} flag, all fields will be interpolated
2771 literally, without quotes.  I.e., if you want a reference to be interpreted
2772 as a string by the Lisp form, enclose the reference operator itself in
2773 double-quotes, like @code{"$3"}.  Ranges are inserted as space-separated
2774 fields, so you can embed them in list or vector syntax.
2776 Here are a few examples---note how the @samp{N} mode is used when we do
2777 computations in Lisp:
2779 @table @code
2780 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2781 Swap the first two characters of the content of column 1.
2782 @item '(+ $1 $2);N
2783 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2784 @item '(apply '+ '($1..$4));N
2785 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2786 @end table
2788 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2789 @subsection Durations and time values
2790 @cindex Duration, computing
2791 @cindex Time, computing
2792 @vindex org-table-duration-custom-format
2794 If you want to compute time values use the @code{T} flag, either in Calc
2795 formulas or Elisp formulas:
2797 @example
2798 @group
2799   |  Task 1 |   Task 2 |    Total |
2800   |---------+----------+----------|
2801   |    2:12 |     1:47 | 03:59:00 |
2802   | 3:02:20 | -2:07:00 |     0.92 |
2803   #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2804 @end group
2805 @end example
2807 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2808 are optional.  With the @code{T} flag, computed durations will be displayed
2809 as @code{HH:MM:SS} (see the first formula above).  With the @code{t} flag,
2810 computed durations will be displayed according to the value of the option
2811 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2812 will display the result as a fraction of hours (see the second formula in the
2813 example above).
2815 Negative duration values can be manipulated as well, and integers will be
2816 considered as seconds in addition and subtraction.
2818 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2819 @subsection Field and range formulas
2820 @cindex field formula
2821 @cindex range formula
2822 @cindex formula, for individual table field
2823 @cindex formula, for range of fields
2825 To assign a formula to a particular field, type it directly into the field,
2826 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}.  When you press
2827 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2828 the formula will be stored as the formula for this field, evaluated, and the
2829 current field will be replaced with the result.
2831 @cindex #+TBLFM
2832 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2833 below the table.  If you type the equation in the 4th field of the 3rd data
2834 line in the table, the formula will look like @samp{@@3$4=$1+$2}.  When
2835 inserting/deleting/swapping column and rows with the appropriate commands,
2836 @i{absolute references} (but not relative ones) in stored formulas are
2837 modified in order to still reference the same field.  To avoid this from
2838 happening, in particular in range references, anchor ranges at the table
2839 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2840 using the @code{@@I} notation.  Automatic adaptation of field references does
2841 of course not happen if you edit the table structure with normal editing
2842 commands---then you must fix the equations yourself.
2844 Instead of typing an equation into the field, you may also use the following
2845 command
2847 @table @kbd
2848 @orgcmd{C-u C-c =,org-table-eval-formula}
2849 Install a new formula for the current field.  The command prompts for a
2850 formula with default taken from the @samp{#+TBLFM:} line, applies
2851 it to the current field, and stores it.
2852 @end table
2854 The left-hand side of a formula can also be a special expression in order to
2855 assign the formula to a number of different fields.  There is no keyboard
2856 shortcut to enter such range formulas.  To add them, use the formula editor
2857 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2858 directly.
2860 @table @code
2861 @item $2=
2862 Column formula, valid for the entire column.  This is so common that Org
2863 treats these formulas in a special way, see @ref{Column formulas}.
2864 @item @@3=
2865 Row formula, applies to all fields in the specified row.  @code{@@>=} means
2866 the last row.
2867 @item @@1$2..@@4$3=
2868 Range formula, applies to all fields in the given rectangular range.  This
2869 can also be used to assign a formula to some but not all fields in a row.
2870 @item $name=
2871 Named field, see @ref{Advanced features}.
2872 @end table
2874 @node Column formulas, Lookup functions, Field and range formulas, The spreadsheet
2875 @subsection Column formulas
2876 @cindex column formula
2877 @cindex formula, for table column
2879 When you assign a formula to a simple column reference like @code{$3=}, the
2880 same formula will be used in all fields of that column, with the following
2881 very convenient exceptions: (i) If the table contains horizontal separator
2882 hlines with rows above and below, everything before the first such hline is
2883 considered part of the table @emph{header} and will not be modified by column
2884 formulas.  Therefore a header is mandatory when you use column formulas and
2885 want to add hlines to group rows, like for example to separate a total row at
2886 the bottom from the summand rows above.  (ii) Fields that already get a value
2887 from a field/range formula will be left alone by column formulas.  These
2888 conditions make column formulas very easy to use.
2890 To assign a formula to a column, type it directly into any field in the
2891 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2892 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2893 the formula will be stored as the formula for the current column, evaluated
2894 and the current field replaced with the result.  If the field contains only
2895 @samp{=}, the previously stored formula for this column is used.  For each
2896 column, Org will only remember the most recently used formula.  In the
2897 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}.  The
2898 left-hand side of a column formula can not be the name of column, it must be
2899 the numeric column reference or @code{$>}.
2901 Instead of typing an equation into the field, you may also use the
2902 following command:
2904 @table @kbd
2905 @orgcmd{C-c =,org-table-eval-formula}
2906 Install a new formula for the current column and replace current field with
2907 the result of the formula.  The command prompts for a formula, with default
2908 taken from the @samp{#+TBLFM} line, applies it to the current field and
2909 stores it.  With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2910 will apply it to that many consecutive fields in the current column.
2911 @end table
2913 @node Lookup functions, Editing and debugging formulas, Column formulas, The spreadsheet
2914 @subsection Lookup functions
2915 @cindex lookup functions in tables
2916 @cindex table lookup functions
2918 Org has three predefined Emacs Lisp functions for lookups in tables.
2919 @table @code
2920 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2921 @findex org-lookup-first
2922 Searches for the first element @code{S} in list @code{S-LIST} for which
2923 @lisp
2924 (PREDICATE VAL S)
2925 @end lisp
2926 is @code{t}; returns the value from the corresponding position in list
2927 @code{R-LIST}.  The default @code{PREDICATE} is @code{equal}.  Note that the
2928 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2929 order as the corresponding parameters are in the call to
2930 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}.  If
2931 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2932 is returned.
2933 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2934 @findex org-lookup-last
2935 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2936 element for which @code{PREDICATE} is @code{t}.
2937 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2938 @findex org-lookup-all
2939 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2940 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2941 values.  This function can not be used by itself in a formula, because it
2942 returns a list of values.  However, powerful lookups can be built when this
2943 function is combined with other Emacs Lisp functions.
2944 @end table
2946 If the ranges used in these functions contain empty fields, the @code{E} mode
2947 for the formula should usually be specified: otherwise empty fields will not be
2948 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2949 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2950 element of @code{R-LIST}.
2952 These three functions can be used to implement associative arrays, count
2953 matching cells, rank results, group data etc.  For practical examples
2954 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2955 tutorial on Worg}.
2957 @node Editing and debugging formulas, Updating the table, Lookup functions, The spreadsheet
2958 @subsection Editing and debugging formulas
2959 @cindex formula editing
2960 @cindex editing, of table formulas
2962 @vindex org-table-use-standard-references
2963 You can edit individual formulas in the minibuffer or directly in the field.
2964 Org can also prepare a special buffer with all active formulas of a table.
2965 When offering a formula for editing, Org converts references to the standard
2966 format (like @code{B3} or @code{D&}) if possible.  If you prefer to only work
2967 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2968 option @code{org-table-use-standard-references}.
2970 @table @kbd
2971 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2972 Edit the formula associated with the current column/field in the
2973 minibuffer.  See @ref{Column formulas}, and @ref{Field and range formulas}.
2974 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2975 Re-insert the active formula (either a
2976 field formula, or a column formula) into the current field, so that you
2977 can edit it directly in the field.  The advantage over editing in the
2978 minibuffer is that you can use the command @kbd{C-c ?}.
2979 @orgcmd{C-c ?,org-table-field-info}
2980 While editing a formula in a table field, highlight the field(s)
2981 referenced by the reference at the cursor position in the formula.
2982 @kindex C-c @}
2983 @findex org-table-toggle-coordinate-overlays
2984 @item C-c @}
2985 Toggle the display of row and column numbers for a table, using overlays
2986 (@command{org-table-toggle-coordinate-overlays}).  These are updated each
2987 time the table is aligned; you can force it with @kbd{C-c C-c}.
2988 @kindex C-c @{
2989 @findex org-table-toggle-formula-debugger
2990 @item C-c @{
2991 Toggle the formula debugger on and off
2992 (@command{org-table-toggle-formula-debugger}).  See below.
2993 @orgcmd{C-c ',org-table-edit-formulas}
2994 Edit all formulas for the current table in a special buffer, where the
2995 formulas will be displayed one per line.  If the current field has an
2996 active formula, the cursor in the formula editor will mark it.
2997 While inside the special buffer, Org will automatically highlight
2998 any field or range reference at the cursor position.  You may edit,
2999 remove and add formulas, and use the following commands:
3001 @table @kbd
3002 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
3003 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
3004 prefix, also apply the new formulas to the entire table.
3005 @orgcmd{C-c C-q,org-table-fedit-abort}
3006 Exit the formula editor without installing changes.
3007 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3008 Toggle all references in the formula editor between standard (like
3009 @code{B3}) and internal (like @code{@@3$2}).
3010 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3011 Pretty-print or indent Lisp formula at point.  When in a line containing
3012 a Lisp formula, format the formula according to Emacs Lisp rules.
3013 Another @key{TAB} collapses the formula back again.  In the open
3014 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3015 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3016 Complete Lisp symbols, just like in Emacs Lisp mode.
3017 @kindex S-@key{up}
3018 @kindex S-@key{down}
3019 @kindex S-@key{left}
3020 @kindex S-@key{right}
3021 @findex org-table-fedit-ref-up
3022 @findex org-table-fedit-ref-down
3023 @findex org-table-fedit-ref-left
3024 @findex org-table-fedit-ref-right
3025 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3026 Shift the reference at point.  For example, if the reference is
3027 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3028 This also works for relative references and for hline references.
3029 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3030 Move the test line for column formulas in the Org buffer up and
3031 down.
3032 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3033 Scroll the window displaying the table.
3034 @kindex C-c @}
3035 @findex org-table-toggle-coordinate-overlays
3036 @item C-c @}
3037 Turn the coordinate grid in the table on and off.
3038 @end table
3039 @end table
3041 Making a table field blank does not remove the formula associated with
3042 the field, because that is stored in a different line (the @samp{#+TBLFM}
3043 line)---during the next recalculation the field will be filled again.
3044 To remove a formula from a field, you have to give an empty reply when
3045 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3047 @kindex C-c C-c
3048 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3049 equations with @kbd{C-c C-c} in that line or with the normal
3050 recalculation commands in the table.
3052 @anchor{Using multiple #+TBLFM lines}
3053 @subsubheading Using multiple #+TBLFM lines
3054 @cindex #+TBLFM line, multiple
3055 @cindex #+TBLFM
3056 @cindex #+TBLFM, switching
3057 @kindex C-c C-c
3059 You may apply the formula temporarily.  This is useful when you
3060 switch the formula.  Place multiple @samp{#+TBLFM} lines right
3061 after the table, and then press @kbd{C-c C-c} on the formula to
3062 apply.  Here is an example:
3064 @example
3065 | x | y |
3066 |---+---|
3067 | 1 |   |
3068 | 2 |   |
3069 #+TBLFM: $2=$1*1
3070 #+TBLFM: $2=$1*2
3071 @end example
3073 @noindent
3074 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3076 @example
3077 | x | y |
3078 |---+---|
3079 | 1 | 2 |
3080 | 2 | 4 |
3081 #+TBLFM: $2=$1*1
3082 #+TBLFM: $2=$1*2
3083 @end example
3085 @noindent
3086 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3087 will get the following result of applying only the first @samp{#+TBLFM} line.
3089 @example
3090 | x | y |
3091 |---+---|
3092 | 1 | 1 |
3093 | 2 | 2 |
3094 #+TBLFM: $2=$1*1
3095 #+TBLFM: $2=$1*2
3096 @end example
3098 @subsubheading Debugging formulas
3099 @cindex formula debugging
3100 @cindex debugging, of table formulas
3101 When the evaluation of a formula leads to an error, the field content
3102 becomes the string @samp{#ERROR}.  If you would like see what is going
3103 on during variable substitution and calculation in order to find a bug,
3104 turn on formula debugging in the @code{Tbl} menu and repeat the
3105 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3106 field.  Detailed information will be displayed.
3108 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
3109 @subsection Updating the table
3110 @cindex recomputing table fields
3111 @cindex updating, table
3113 Recalculation of a table is normally not automatic, but needs to be
3114 triggered by a command.  See @ref{Advanced features}, for a way to make
3115 recalculation at least semi-automatic.
3117 In order to recalculate a line of a table or the entire table, use the
3118 following commands:
3120 @table @kbd
3121 @orgcmd{C-c *,org-table-recalculate}
3122 Recalculate the current row by first applying the stored column formulas
3123 from left to right, and all field/range formulas in the current row.
3125 @kindex C-u C-c *
3126 @item C-u C-c *
3127 @kindex C-u C-c C-c
3128 @itemx C-u C-c C-c
3129 Recompute the entire table, line by line.  Any lines before the first
3130 hline are left alone, assuming that these are part of the table header.
3132 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3133 Iterate the table by recomputing it until no further changes occur.
3134 This may be necessary if some computed fields use the value of other
3135 fields that are computed @i{later} in the calculation sequence.
3136 @item M-x org-table-recalculate-buffer-tables RET
3137 @findex org-table-recalculate-buffer-tables
3138 Recompute all tables in the current buffer.
3139 @item M-x org-table-iterate-buffer-tables RET
3140 @findex org-table-iterate-buffer-tables
3141 Iterate all tables in the current buffer, in order to converge table-to-table
3142 dependencies.
3143 @end table
3145 @node Advanced features,  , Updating the table, The spreadsheet
3146 @subsection Advanced features
3148 If you want the recalculation of fields to happen automatically, or if you
3149 want to be able to assign @i{names}@footnote{Such names must start by an
3150 alphabetic character and use only alphanumeric/underscore characters.} to
3151 fields and columns, you need to reserve the first column of the table for
3152 special marking characters.
3154 @table @kbd
3155 @orgcmd{C-#,org-table-rotate-recalc-marks}
3156 Rotate the calculation mark in first column through the states @samp{ },
3157 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
3158 change all marks in the region.
3159 @end table
3161 Here is an example of a table that collects exam results of students and
3162 makes use of these features:
3164 @example
3165 @group
3166 |---+---------+--------+--------+--------+-------+------|
3167 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3168 |---+---------+--------+--------+--------+-------+------|
3169 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
3170 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
3171 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
3172 |---+---------+--------+--------+--------+-------+------|
3173 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
3174 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
3175 |---+---------+--------+--------+--------+-------+------|
3176 |   | Average |        |        |        |  25.0 |      |
3177 | ^ |         |        |        |        |    at |      |
3178 | $ | max=50  |        |        |        |       |      |
3179 |---+---------+--------+--------+--------+-------+------|
3180 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3181 @end group
3182 @end example
3184 @noindent @b{Important}: please note that for these special tables,
3185 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3186 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3187 to the field itself.  The column formulas are not applied in rows with
3188 empty first field.
3190 @cindex marking characters, tables
3191 The marking characters have the following meaning:
3193 @table @samp
3194 @item !
3195 The fields in this line define names for the columns, so that you may
3196 refer to a column as @samp{$Tot} instead of @samp{$6}.
3197 @item ^
3198 This row defines names for the fields @emph{above} the row.  With such
3199 a definition, any formula in the table may use @samp{$m1} to refer to
3200 the value @samp{10}.  Also, if you assign a formula to a names field, it
3201 will be stored as @samp{$name=...}.
3202 @item _
3203 Similar to @samp{^}, but defines names for the fields in the row
3204 @emph{below}.
3205 @item $
3206 Fields in this row can define @emph{parameters} for formulas.  For
3207 example, if a field in a @samp{$} row contains @samp{max=50}, then
3208 formulas in this table can refer to the value 50 using @samp{$max}.
3209 Parameters work exactly like constants, only that they can be defined on
3210 a per-table basis.
3211 @item #
3212 Fields in this row are automatically recalculated when pressing
3213 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
3214 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
3215 lines will be left alone by this command.
3216 @item *
3217 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3218 not for automatic recalculation.  Use this when automatic
3219 recalculation slows down editing too much.
3220 @item @w{ }
3221 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3222 All lines that should be recalculated should be marked with @samp{#}
3223 or @samp{*}.
3224 @item /
3225 Do not export this line.  Useful for lines that contain the narrowing
3226 @samp{<N>} markers or column group markers.
3227 @end table
3229 Finally, just to whet your appetite for what can be done with the
3230 fantastic @file{calc.el} package, here is a table that computes the Taylor
3231 series of degree @code{n} at location @code{x} for a couple of
3232 functions.
3234 @example
3235 @group
3236 |---+-------------+---+-----+--------------------------------------|
3237 |   | Func        | n | x   | Result                               |
3238 |---+-------------+---+-----+--------------------------------------|
3239 | # | exp(x)      | 1 | x   | 1 + x                                |
3240 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
3241 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
3242 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3243 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
3244 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
3245 |---+-------------+---+-----+--------------------------------------|
3246 #+TBLFM: $5=taylor($2,$4,$3);n3
3247 @end group
3248 @end example
3250 @node Org-Plot,  , The spreadsheet, Tables
3251 @section Org-Plot
3252 @cindex graph, in tables
3253 @cindex plot tables using Gnuplot
3254 @cindex #+PLOT
3256 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3257 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3258 @uref{http://xafs.org/BruceRavel/GnuplotMode}.  To see this in action, ensure
3259 that you have both Gnuplot and Gnuplot mode installed on your system, then
3260 call @code{org-plot/gnuplot} on the following table.
3262 @example
3263 @group
3264 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3265 | Sede      | Max cites | H-index |
3266 |-----------+-----------+---------|
3267 | Chile     |    257.72 |   21.39 |
3268 | Leeds     |    165.77 |   19.68 |
3269 | Sao Paolo |     71.00 |   11.50 |
3270 | Stockholm |    134.19 |   14.33 |
3271 | Morelia   |    257.56 |   17.67 |
3272 @end group
3273 @end example
3275 Notice that Org Plot is smart enough to apply the table's headers as labels.
3276 Further control over the labels, type, content, and appearance of plots can
3277 be exercised through the @code{#+PLOT:} lines preceding a table.  See below
3278 for a complete list of Org-plot options.  For more information and examples
3279 see the Org-plot tutorial at
3280 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3282 @subsubheading Plot Options
3284 @table @code
3285 @item set
3286 Specify any @command{gnuplot} option to be set when graphing.
3288 @item title
3289 Specify the title of the plot.
3291 @item ind
3292 Specify which column of the table to use as the @code{x} axis.
3294 @item deps
3295 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3296 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3297 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3298 column).
3300 @item type
3301 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3303 @item with
3304 Specify a @code{with} option to be inserted for every col being plotted
3305 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3306 Defaults to @code{lines}.
3308 @item file
3309 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3311 @item labels
3312 List of labels to be used for the @code{deps} (defaults to the column headers
3313 if they exist).
3315 @item line
3316 Specify an entire line to be inserted in the Gnuplot script.
3318 @item map
3319 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3320 flat mapping rather than a @code{3d} slope.
3322 @item timefmt
3323 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3324 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3326 @item script
3327 If you want total control, you can specify a script file (place the file name
3328 between double-quotes) which will be used to plot.  Before plotting, every
3329 instance of @code{$datafile} in the specified script will be replaced with
3330 the path to the generated data file.  Note: even if you set this option, you
3331 may still want to specify the plot type, as that can impact the content of
3332 the data file.
3333 @end table
3335 @node Hyperlinks, TODO Items, Tables, Top
3336 @chapter Hyperlinks
3337 @cindex hyperlinks
3339 Like HTML, Org provides links inside a file, external links to
3340 other files, Usenet articles, emails, and much more.
3342 @menu
3343 * Link format::                 How links in Org are formatted
3344 * Internal links::              Links to other places in the current file
3345 * External links::              URL-like links to the world
3346 * Handling links::              Creating, inserting and following
3347 * Using links outside Org::     Linking from my C source code?
3348 * Link abbreviations::          Shortcuts for writing complex links
3349 * Search options::              Linking to a specific location
3350 * Custom searches::             When the default search is not enough
3351 @end menu
3353 @node Link format, Internal links, Hyperlinks, Hyperlinks
3354 @section Link format
3355 @cindex link format
3356 @cindex format, of links
3358 Org will recognize plain URL-like links and activate them as
3359 clickable links.  The general link format, however, looks like this:
3361 @example
3362 [[link][description]]       @r{or alternatively}           [[link]]
3363 @end example
3365 @noindent
3366 Once a link in the buffer is complete (all brackets present), Org
3367 will change the display so that @samp{description} is displayed instead
3368 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3369 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
3370 which by default is an underlined face.  You can directly edit the
3371 visible part of a link.  Note that this can be either the @samp{link}
3372 part (if there is no description) or the @samp{description} part.  To
3373 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3374 cursor on the link.
3376 If you place the cursor at the beginning or just behind the end of the
3377 displayed text and press @key{BACKSPACE}, you will remove the
3378 (invisible) bracket at that location.  This makes the link incomplete
3379 and the internals are again displayed as plain text.  Inserting the
3380 missing bracket hides the link internals again.  To show the
3381 internal structure of all links, use the menu entry
3382 @code{Org->Hyperlinks->Literal links}.
3384 @node Internal links, External links, Link format, Hyperlinks
3385 @section Internal links
3386 @cindex internal links
3387 @cindex links, internal
3388 @cindex targets, for links
3390 @cindex property, CUSTOM_ID
3391 If the link does not look like a URL, it is considered to be internal in the
3392 current file.  The most important case is a link like
3393 @samp{[[#my-custom-id]]} which will link to the entry with the
3394 @code{CUSTOM_ID} property @samp{my-custom-id}.  You are responsible yourself
3395 to make sure these custom IDs are unique in a file.
3397 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3398 lead to a text search in the current file.
3400 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3401 or with a mouse click (@pxref{Handling links}).  Links to custom IDs will
3402 point to the corresponding headline.  The preferred match for a text link is
3403 a @i{dedicated target}: the same string in double angular brackets, like
3404 @samp{<<My Target>>}.
3406 @cindex #+NAME
3407 If no dedicated target exists, the link will then try to match the exact name
3408 of an element within the buffer.  Naming is done with the @code{#+NAME}
3409 keyword, which has to be put the line before the element it refers to, as in
3410 the following example
3412 @example
3413 #+NAME: My Target
3414 | a  | table      |
3415 |----+------------|
3416 | of | four cells |
3417 @end example
3419 If none of the above succeeds, Org will search for a headline that is exactly
3420 the link text but may also include a TODO keyword and tags@footnote{To insert
3421 a link targeting a headline, in-buffer completion can be used.  Just type
3422 a star followed by a few optional letters into the buffer and press
3423 @kbd{M-@key{TAB}}.  All headlines in the current buffer will be offered as
3424 completions.}.
3426 During export, internal links will be used to mark objects and assign them
3427 a number.  Marked objects will then be referenced by links pointing to them.
3428 In particular, links without a description will appear as the number assigned
3429 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3430 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3431 (@pxref{Images and tables}).}.  In the following excerpt from an Org buffer
3433 @example
3434 - one item
3435 - <<target>>another item
3436 Here we refer to item [[target]].
3437 @end example
3439 @noindent
3440 The last sentence will appear as @samp{Here we refer to item 2} when
3441 exported.
3443 In non-Org files, the search will look for the words in the link text.  In
3444 the above example the search would be for @samp{my target}.
3446 Following a link pushes a mark onto Org's own mark ring.  You can
3447 return to the previous position with @kbd{C-c &}.  Using this command
3448 several times in direct succession goes back to positions recorded
3449 earlier.
3451 @menu
3452 * Radio targets::               Make targets trigger links in plain text
3453 @end menu
3455 @node Radio targets,  , Internal links, Internal links
3456 @subsection Radio targets
3457 @cindex radio targets
3458 @cindex targets, radio
3459 @cindex links, radio targets
3461 Org can automatically turn any occurrences of certain target names
3462 in normal text into a link.  So without explicitly creating a link, the
3463 text connects to the target radioing its position.  Radio targets are
3464 enclosed by triple angular brackets.  For example, a target @samp{<<<My
3465 Target>>>} causes each occurrence of @samp{my target} in normal text to
3466 become activated as a link.  The Org file is scanned automatically
3467 for radio targets only when the file is first loaded into Emacs.  To
3468 update the target list during editing, press @kbd{C-c C-c} with the
3469 cursor on or at a target.
3471 @node External links, Handling links, Internal links, Hyperlinks
3472 @section External links
3473 @cindex links, external
3474 @cindex external links
3475 @cindex Gnus links
3476 @cindex BBDB links
3477 @cindex IRC links
3478 @cindex URL links
3479 @cindex file links
3480 @cindex RMAIL links
3481 @cindex MH-E links
3482 @cindex USENET links
3483 @cindex SHELL links
3484 @cindex Info links
3485 @cindex Elisp links
3487 Org supports links to files, websites, Usenet and email messages, BBDB
3488 database entries and links to both IRC conversations and their logs.
3489 External links are URL-like locators.  They start with a short identifying
3490 string followed by a colon.  There can be no space after the colon.  The
3491 following list shows examples for each link type.
3493 @example
3494 http://www.astro.uva.nl/~dominik          @r{on the web}
3495 doi:10.1000/182                           @r{DOI for an electronic resource}
3496 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
3497 /home/dominik/images/jupiter.jpg          @r{same as above}
3498 file:papers/last.pdf                      @r{file, relative path}
3499 ./papers/last.pdf                         @r{same as above}
3500 file:/myself@@some.where:papers/last.pdf   @r{file, path on remote machine}
3501 /myself@@some.where:papers/last.pdf        @r{same as above}
3502 file:sometextfile::NNN                    @r{file, jump to line number}
3503 file:projects.org                         @r{another Org file}
3504 file:projects.org::some words             @r{text search in Org file}@footnote{
3505 The actual behavior of the search will depend on the value of
3506 the option @code{org-link-search-must-match-exact-headline}.  If its value
3507 is @code{nil}, then a fuzzy text search will be done.  If it is t, then only the
3508 exact headline will be matched.  If the value is @code{'query-to-create},
3509 then an exact headline will be searched; if it is not found, then the user
3510 will be queried to create it.}
3511 file:projects.org::*task title            @r{heading search in Org file}
3512 file+sys:/path/to/file                    @r{open via OS, like double-click}
3513 file+emacs:/path/to/file                  @r{force opening by Emacs}
3514 docview:papers/last.pdf::NNN              @r{open in doc-view mode at page}
3515 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
3516 news:comp.emacs                           @r{Usenet link}
3517 mailto:adent@@galaxy.net                   @r{Mail link}
3518 mhe:folder                                @r{MH-E folder link}
3519 mhe:folder#id                             @r{MH-E message link}
3520 rmail:folder                              @r{RMAIL folder link}
3521 rmail:folder#id                           @r{RMAIL message link}
3522 gnus:group                                @r{Gnus group link}
3523 gnus:group#id                             @r{Gnus article link}
3524 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
3525 irc:/irc.com/#emacs/bob                   @r{IRC link}
3526 info:org#External links                   @r{Info node link}
3527 shell:ls *.org                            @r{A shell command}
3528 elisp:org-agenda                          @r{Interactive Elisp command}
3529 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3530 @end example
3532 @cindex VM links
3533 @cindex WANDERLUST links
3534 On top of these built-in link types, some are available through the
3535 @code{contrib/} directory (@pxref{Installation}).  For example, these links
3536 to VM or Wanderlust messages are available when you load the corresponding
3537 libraries from the @code{contrib/} directory:
3539 @example
3540 vm:folder                                 @r{VM folder link}
3541 vm:folder#id                              @r{VM message link}
3542 vm://myself@@some.where.org/folder#id      @r{VM on remote machine}
3543 vm-imap:account:folder                    @r{VM IMAP folder link}
3544 vm-imap:account:folder#id                 @r{VM IMAP message link}
3545 wl:folder                                 @r{WANDERLUST folder link}
3546 wl:folder#id                              @r{WANDERLUST message link}
3547 @end example
3549 For customizing Org to add new link types @ref{Adding hyperlink types}.
3551 A link should be enclosed in double brackets and may contain a descriptive
3552 text to be displayed instead of the URL (@pxref{Link format}), for example:
3554 @example
3555 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3556 @end example
3558 @noindent
3559 If the description is a file name or URL that points to an image, HTML
3560 export (@pxref{HTML export}) will inline the image as a clickable
3561 button.  If there is no description at all and the link points to an
3562 image,
3563 that image will be inlined into the exported HTML file.
3565 @cindex square brackets, around links
3566 @cindex plain text external links
3567 Org also finds external links in the normal text and activates them
3568 as links.  If spaces must be part of the link (for example in
3569 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3570 about the end of the link, enclose them in square brackets.
3572 @node Handling links, Using links outside Org, External links, Hyperlinks
3573 @section Handling links
3574 @cindex links, handling
3576 Org provides methods to create a link in the correct syntax, to
3577 insert it into an Org file, and to follow the link.
3579 @table @kbd
3580 @orgcmd{C-c l,org-store-link}
3581 @cindex storing links
3582 Store a link to the current location.  This is a @emph{global} command (you
3583 must create the key binding yourself) which can be used in any buffer to
3584 create a link.  The link will be stored for later insertion into an Org
3585 buffer (see below).  What kind of link will be created depends on the current
3586 buffer:
3588 @b{Org mode buffers}@*
3589 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3590 to the target.  Otherwise it points to the current headline, which will also
3591 be the description@footnote{If the headline contains a timestamp, it will be
3592 removed from the link and result in a wrong link---you should avoid putting
3593 timestamp in the headline.}.
3595 @vindex org-id-link-to-org-use-id
3596 @cindex property, CUSTOM_ID
3597 @cindex property, ID
3598 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3599 will be stored.  In addition or alternatively (depending on the value of
3600 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3601 be created and/or used to construct a link@footnote{The library
3602 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3603 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3604 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3605 potentially create two links: a human-readable from the custom ID, and one
3606 that is globally unique and works even if the entry is moved from file to
3607 file.  Later, when inserting the link, you need to decide which one to use.
3609 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3610 Pretty much all Emacs mail clients are supported.  The link will point to the
3611 current article, or, in some GNUS buffers, to the group.  The description is
3612 constructed from the author and the subject.
3614 @b{Web browsers: W3 and W3M}@*
3615 Here the link will be the current URL, with the page title as description.
3617 @b{Contacts: BBDB}@*
3618 Links created in a BBDB buffer will point to the current entry.
3620 @b{Chat: IRC}@*
3621 @vindex org-irc-link-to-logs
3622 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3623 a @samp{file:/} style link to the relevant point in the logs for the current
3624 conversation is created.  Otherwise an @samp{irc:/} style link to the
3625 user/channel/server under the point will be stored.
3627 @b{Other files}@*
3628 For any other files, the link will point to the file, with a search string
3629 (@pxref{Search options}) pointing to the contents of the current line.  If
3630 there is an active region, the selected words will form the basis of the
3631 search string.  If the automatically created link is not working correctly or
3632 accurately enough, you can write custom functions to select the search string
3633 and to do the search for particular file types---see @ref{Custom searches}.
3634 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3636 @b{Agenda view}@*
3637 When the cursor is in an agenda view, the created link points to the
3638 entry referenced by the current line.
3641 @orgcmd{C-c C-l,org-insert-link}
3642 @cindex link completion
3643 @cindex completion, of links
3644 @cindex inserting links
3645 @vindex org-keep-stored-link-after-insertion
3646 Insert a link@footnote{ Note that you don't have to use this command to
3647 insert a link.  Links in Org are plain text, and you can type or paste them
3648 straight into the buffer.  By using this command, the links are automatically
3649 enclosed in double brackets, and you will be asked for the optional
3650 descriptive text.}.  This prompts for a link to be inserted into the buffer.
3651 You can just type a link, using text for an internal link, or one of the link
3652 type prefixes mentioned in the examples above.  The link will be inserted
3653 into the buffer@footnote{After insertion of a stored link, the link will be
3654 removed from the list of stored links.  To keep it in the list later use, use
3655 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3656 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3657 If some text was selected when this command is called, the selected text
3658 becomes the default description.
3660 @b{Inserting stored links}@*
3661 All links stored during the
3662 current session are part of the history for this prompt, so you can access
3663 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3665 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3666 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3667 defined through link abbreviations (@pxref{Link abbreviations}).  If you
3668 press @key{RET} after inserting only the @var{prefix}, Org will offer
3669 specific completion support for some link types@footnote{This works by
3670 calling a special function @code{org-PREFIX-complete-link}.}  For
3671 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3672 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3673 @key{RET}} you can complete contact names.
3674 @orgkey C-u C-c C-l
3675 @cindex file name completion
3676 @cindex completion, of file names
3677 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3678 a file will be inserted and you may use file name completion to select
3679 the name of the file.  The path to the file is inserted relative to the
3680 directory of the current Org file, if the linked file is in the current
3681 directory or in a sub-directory of it, or if the path is written relative
3682 to the current directory using @samp{../}.  Otherwise an absolute path
3683 is used, if possible with @samp{~/} for your home directory.  You can
3684 force an absolute path with two @kbd{C-u} prefixes.
3686 @item C-c C-l @ @r{(with cursor on existing link)}
3687 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3688 link and description parts of the link.
3690 @cindex following links
3691 @orgcmd{C-c C-o,org-open-at-point}
3692 @vindex org-file-apps
3693 @vindex org-link-frame-setup
3694 Open link at point.  This will launch a web browser for URLs (using
3695 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3696 the corresponding links, and execute the command in a shell link.  When the
3697 cursor is on an internal link, this command runs the corresponding search.
3698 When the cursor is on a TAG list in a headline, it creates the corresponding
3699 TAGS view.  If the cursor is on a timestamp, it compiles the agenda for that
3700 date.  Furthermore, it will visit text and remote files in @samp{file:} links
3701 with Emacs and select a suitable application for local non-text files.
3702 Classification of files is based on file extension only.  See option
3703 @code{org-file-apps}.  If you want to override the default application and
3704 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
3705 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3706 If the cursor is on a headline, but not on a link, offer all links in the
3707 headline and entry text.  If you want to setup the frame configuration for
3708 following links, customize @code{org-link-frame-setup}.
3710 @orgkey @key{RET}
3711 @vindex org-return-follows-link
3712 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3713 the link at point.
3715 @kindex mouse-2
3716 @kindex mouse-1
3717 @item mouse-2
3718 @itemx mouse-1
3719 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3720 would.  Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3722 @kindex mouse-3
3723 @item mouse-3
3724 @vindex org-display-internal-link-with-indirect-buffer
3725 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3726 internal links to be displayed in another window@footnote{See the
3727 option @code{org-display-internal-link-with-indirect-buffer}}.
3729 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3730 @cindex inlining images
3731 @cindex images, inlining
3732 @vindex org-startup-with-inline-images
3733 @cindex @code{inlineimages}, STARTUP keyword
3734 @cindex @code{noinlineimages}, STARTUP keyword
3735 Toggle the inline display of linked images.  Normally this will only inline
3736 images that have no description part in the link, i.e., images that will also
3737 be inlined during export.  When called with a prefix argument, also display
3738 images that do have a link description.  You can ask for inline images to be
3739 displayed at startup by configuring the variable
3740 @code{org-startup-with-inline-images}@footnote{with corresponding
3741 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3742 @orgcmd{C-c %,org-mark-ring-push}
3743 @cindex mark ring
3744 Push the current position onto the mark ring, to be able to return
3745 easily.  Commands following an internal link do this automatically.
3747 @orgcmd{C-c &,org-mark-ring-goto}
3748 @cindex links, returning to
3749 Jump back to a recorded position.  A position is recorded by the
3750 commands following internal links, and by @kbd{C-c %}.  Using this
3751 command several times in direct succession moves through a ring of
3752 previously recorded positions.
3754 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3755 @cindex links, finding next/previous
3756 Move forward/backward to the next link in the buffer.  At the limit of
3757 the buffer, the search fails once, and then wraps around.  The key
3758 bindings for this are really too long; you might want to bind this also
3759 to @kbd{C-n} and @kbd{C-p}
3760 @lisp
3761 (add-hook 'org-load-hook
3762   (lambda ()
3763     (define-key org-mode-map "\C-n" 'org-next-link)
3764     (define-key org-mode-map "\C-p" 'org-previous-link)))
3765 @end lisp
3766 @end table
3768 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3769 @section Using links outside Org
3771 You can insert and follow links that have Org syntax not only in
3772 Org, but in any Emacs buffer.  For this, you should create two
3773 global commands, like this (please select suitable global keys
3774 yourself):
3776 @lisp
3777 (global-set-key "\C-c L" 'org-insert-link-global)
3778 (global-set-key "\C-c o" 'org-open-at-point-global)
3779 @end lisp
3781 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3782 @section Link abbreviations
3783 @cindex link abbreviations
3784 @cindex abbreviation, links
3786 Long URLs can be cumbersome to type, and often many similar links are
3787 needed in a document.  For this you can use link abbreviations.  An
3788 abbreviated link looks like this
3790 @example
3791 [[linkword:tag][description]]
3792 @end example
3794 @noindent
3795 @vindex org-link-abbrev-alist
3796 where the tag is optional.
3797 The @i{linkword} must be a word, starting with a letter, followed by
3798 letters, numbers, @samp{-}, and @samp{_}.  Abbreviations are resolved
3799 according to the information in the variable @code{org-link-abbrev-alist}
3800 that relates the linkwords to replacement text.  Here is an example:
3802 @smalllisp
3803 @group
3804 (setq org-link-abbrev-alist
3805   '(("bugzilla"  . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3806     ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3807     ("google"    . "http://www.google.com/search?q=")
3808     ("gmap"      . "http://maps.google.com/maps?q=%s")
3809     ("omap"      . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3810     ("ads"       . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3811 @end group
3812 @end smalllisp
3814 If the replacement text contains the string @samp{%s}, it will be
3815 replaced with the tag.  Using @samp{%h} instead of @samp{%s} will
3816 url-encode the tag (see the example above, where we need to encode
3817 the URL parameter.)  Using @samp{%(my-function)} will pass the tag
3818 to a custom function, and replace it by the resulting string.
3820 If the replacement text don't contain any specifier, it will simply
3821 be appended to the string in order to create the link.
3823 Instead of a string, you may also specify a function that will be
3824 called with the tag as the only argument to create the link.
3826 With the above setting, you could link to a specific bug with
3827 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3828 @code{[[google:OrgMode]]}, show the map location of the Free Software
3829 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3830 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3831 what the Org author is doing besides Emacs hacking with
3832 @code{[[ads:Dominik,C]]}.
3834 If you need special abbreviations just for a single Org buffer, you
3835 can define them in the file with
3837 @cindex #+LINK
3838 @example
3839 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
3840 #+LINK: google    http://www.google.com/search?q=%s
3841 @end example
3843 @noindent
3844 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3845 complete link abbreviations.  You may also define a function
3846 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3847 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
3848 not accept any arguments, and return the full link with prefix.
3850 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3851 @section Search options in file links
3852 @cindex search option in file links
3853 @cindex file links, searching
3855 File links can contain additional information to make Emacs jump to a
3856 particular location in the file when following a link.  This can be a
3857 line number or a search option after a double@footnote{For backward
3858 compatibility, line numbers can also follow a single colon.} colon.  For
3859 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3860 links}) to a file, it encodes the words in the current line as a search
3861 string that can be used to find this line back later when following the
3862 link with @kbd{C-c C-o}.
3864 Here is the syntax of the different ways to attach a search to a file
3865 link, together with an explanation:
3867 @example
3868 [[file:~/code/main.c::255]]
3869 [[file:~/xx.org::My Target]]
3870 [[file:~/xx.org::*My Target]]
3871 [[file:~/xx.org::#my-custom-id]]
3872 [[file:~/xx.org::/regexp/]]
3873 @end example
3875 @table @code
3876 @item 255
3877 Jump to line 255.
3878 @item My Target
3879 Search for a link target @samp{<<My Target>>}, or do a text search for
3880 @samp{my target}, similar to the search in internal links, see
3881 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
3882 link will become an HTML reference to the corresponding named anchor in
3883 the linked file.
3884 @item *My Target
3885 In an Org file, restrict search to headlines.
3886 @item #my-custom-id
3887 Link to a heading with a @code{CUSTOM_ID} property
3888 @item /regexp/
3889 Do a regular expression search for @code{regexp}.  This uses the Emacs
3890 command @code{occur} to list all matches in a separate window.  If the
3891 target file is in Org mode, @code{org-occur} is used to create a
3892 sparse tree with the matches.
3893 @c If the target file is a directory,
3894 @c @code{grep} will be used to search all files in the directory.
3895 @end table
3897 As a degenerate case, a file link with an empty file name can be used
3898 to search the current file.  For example, @code{[[file:::find me]]} does
3899 a search for @samp{find me} in the current file, just as
3900 @samp{[[find me]]} would.
3902 @node Custom searches,  , Search options, Hyperlinks
3903 @section Custom Searches
3904 @cindex custom search strings
3905 @cindex search strings, custom
3907 The default mechanism for creating search strings and for doing the
3908 actual search related to a file link may not work correctly in all
3909 cases.  For example, Bib@TeX{} database files have many entries like
3910 @samp{year="1993"} which would not result in good search strings,
3911 because the only unique identification for a Bib@TeX{} entry is the
3912 citation key.
3914 @vindex org-create-file-search-functions
3915 @vindex org-execute-file-search-functions
3916 If you come across such a problem, you can write custom functions to set
3917 the right search string for a particular file type, and to do the search
3918 for the string in the file.  Using @code{add-hook}, these functions need
3919 to be added to the hook variables
3920 @code{org-create-file-search-functions} and
3921 @code{org-execute-file-search-functions}.  See the docstring for these
3922 variables for more information.  Org actually uses this mechanism
3923 for Bib@TeX{} database files, and you can use the corresponding code as
3924 an implementation example.  See the file @file{org-bibtex.el}.
3926 @node TODO Items, Tags, Hyperlinks, Top
3927 @chapter TODO items
3928 @cindex TODO items
3930 Org mode does not maintain TODO lists as separate documents@footnote{Of
3931 course, you can make a document that contains only long lists of TODO items,
3932 but this is not required.}.  Instead, TODO items are an integral part of the
3933 notes file, because TODO items usually come up while taking notes!  With Org
3934 mode, simply mark any entry in a tree as being a TODO item.  In this way,
3935 information is not duplicated, and the entire context from which the TODO
3936 item emerged is always present.
3938 Of course, this technique for managing TODO items scatters them
3939 throughout your notes file.  Org mode compensates for this by providing
3940 methods to give you an overview of all the things that you have to do.
3942 @menu
3943 * TODO basics::                 Marking and displaying TODO entries
3944 * TODO extensions::             Workflow and assignments
3945 * Progress logging::            Dates and notes for progress
3946 * Priorities::                  Some things are more important than others
3947 * Breaking down tasks::         Splitting a task into manageable pieces
3948 * Checkboxes::                  Tick-off lists
3949 @end menu
3951 @node TODO basics, TODO extensions, TODO Items, TODO Items
3952 @section Basic TODO functionality
3954 Any headline becomes a TODO item when it starts with the word
3955 @samp{TODO}, for example:
3957 @example
3958 *** TODO Write letter to Sam Fortune
3959 @end example
3961 @noindent
3962 The most important commands to work with TODO entries are:
3964 @table @kbd
3965 @orgcmd{C-c C-t,org-todo}
3966 @cindex cycling, of TODO states
3967 @vindex org-use-fast-todo-selection
3969 Rotate the TODO state of the current item among
3971 @example
3972 ,-> (unmarked) -> TODO -> DONE --.
3973 '--------------------------------'
3974 @end example
3976 If TODO keywords have fast access keys (see @ref{Fast access to TODO
3977 states}), you will be prompted for a TODO keyword through the fast selection
3978 interface; this is the default behavior when
3979 @code{org-use-fast-todo-selection} is non-@code{nil}.
3981 The same rotation can also be done ``remotely'' from the timeline and agenda
3982 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3984 @orgkey{C-u C-c C-t}
3985 When TODO keywords have no selection keys, select a specific keyword using
3986 completion; otherwise force cycling through TODO states with no prompt.  When
3987 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
3988 selection interface.
3990 @kindex S-@key{right}
3991 @kindex S-@key{left}
3992 @item S-@key{right} @ @r{/} @ S-@key{left}
3993 @vindex org-treat-S-cursor-todo-selection-as-state-change
3994 Select the following/preceding TODO state, similar to cycling.  Useful
3995 mostly if more than two TODO states are possible (@pxref{TODO
3996 extensions}).  See also @ref{Conflicts}, for a discussion of the interaction
3997 with @code{shift-selection-mode}.  See also the variable
3998 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3999 @orgcmd{C-c / t,org-show-todo-tree}
4000 @cindex sparse tree, for TODO
4001 @vindex org-todo-keywords
4002 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
4003 entire buffer, but shows all TODO items (with not-DONE state) and the
4004 headings hierarchy above them.  With a prefix argument (or by using @kbd{C-c
4005 / T}), search for a specific TODO@.  You will be prompted for the keyword,
4006 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
4007 entries that match any one of these keywords.  With a numeric prefix argument
4008 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
4009 With two prefix arguments, find all TODO states, both un-done and done.
4010 @orgcmd{C-c a t,org-todo-list}
4011 Show the global TODO list.  Collects the TODO items (with not-DONE states)
4012 from all agenda files (@pxref{Agenda Views}) into a single buffer.  The new
4013 buffer will be in @code{agenda-mode}, which provides commands to examine and
4014 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4015 @xref{Global TODO list}, for more information.
4016 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4017 Insert a new TODO entry below the current one.
4018 @end table
4020 @noindent
4021 @vindex org-todo-state-tags-triggers
4022 Changing a TODO state can also trigger tag changes.  See the docstring of the
4023 option @code{org-todo-state-tags-triggers} for details.
4025 @node TODO extensions, Progress logging, TODO basics, TODO Items
4026 @section Extended use of TODO keywords
4027 @cindex extended TODO keywords
4029 @vindex org-todo-keywords
4030 By default, marked TODO entries have one of only two states: TODO and
4031 DONE@.  Org mode allows you to classify TODO items in more complex ways
4032 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
4033 special setup, the TODO keyword system can work differently in different
4034 files.
4036 Note that @i{tags} are another way to classify headlines in general and
4037 TODO items in particular (@pxref{Tags}).
4039 @menu
4040 * Workflow states::             From TODO to DONE in steps
4041 * TODO types::                  I do this, Fred does the rest
4042 * Multiple sets in one file::   Mixing it all, and still finding your way
4043 * Fast access to TODO states::  Single letter selection of a state
4044 * Per-file keywords::           Different files, different requirements
4045 * Faces for TODO keywords::     Highlighting states
4046 * TODO dependencies::           When one task needs to wait for others
4047 @end menu
4049 @node Workflow states, TODO types, TODO extensions, TODO extensions
4050 @subsection TODO keywords as workflow states
4051 @cindex TODO workflow
4052 @cindex workflow states as TODO keywords
4054 You can use TODO keywords to indicate different @emph{sequential} states
4055 in the process of working on an item, for example@footnote{Changing
4056 this variable only becomes effective after restarting Org mode in a
4057 buffer.}:
4059 @lisp
4060 (setq org-todo-keywords
4061   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4062 @end lisp
4064 The vertical bar separates the TODO keywords (states that @emph{need
4065 action}) from the DONE states (which need @emph{no further action}).  If
4066 you don't provide the separator bar, the last state is used as the DONE
4067 state.
4068 @cindex completion, of TODO keywords
4069 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4070 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@.  You may
4071 also use a numeric prefix argument to quickly select a specific state.  For
4072 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4073 Or you can use @kbd{S-@key{left}} to go backward through the sequence.  If you
4074 define many keywords, you can use in-buffer completion
4075 (@pxref{Completion}) or even a special one-key selection scheme
4076 (@pxref{Fast access to TODO states}) to insert these words into the
4077 buffer.  Changing a TODO state can be logged with a timestamp, see
4078 @ref{Tracking TODO state changes}, for more information.
4080 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
4081 @subsection TODO keywords as types
4082 @cindex TODO types
4083 @cindex names as TODO keywords
4084 @cindex types as TODO keywords
4086 The second possibility is to use TODO keywords to indicate different
4087 @emph{types} of action items.  For example, you might want to indicate
4088 that items are for ``work'' or ``home''.  Or, when you work with several
4089 people on a single project, you might want to assign action items
4090 directly to persons, by using their names as TODO keywords.  This would
4091 be set up like this:
4093 @lisp
4094 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4095 @end lisp
4097 In this case, different keywords do not indicate a sequence, but rather
4098 different types.  So the normal work flow would be to assign a task to a
4099 person, and later to mark it DONE@.  Org mode supports this style by adapting
4100 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4101 @kbd{t} command in the timeline and agenda buffers.}.  When used several
4102 times in succession, it will still cycle through all names, in order to first
4103 select the right type for a task.  But when you return to the item after some
4104 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4105 to DONE@.  Use prefix arguments or completion to quickly select a specific
4106 name.  You can also review the items of a specific TODO type in a sparse tree
4107 by using a numeric prefix to @kbd{C-c / t}.  For example, to see all things
4108 Lucy has to do, you would use @kbd{C-3 C-c / t}.  To collect Lucy's items
4109 from all agenda files into a single buffer, you would use the numeric prefix
4110 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4112 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
4113 @subsection Multiple keyword sets in one file
4114 @cindex TODO keyword sets
4116 Sometimes you may want to use different sets of TODO keywords in
4117 parallel.  For example, you may want to have the basic
4118 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4119 separate state indicating that an item has been canceled (so it is not
4120 DONE, but also does not require action).  Your setup would then look
4121 like this:
4123 @lisp
4124 (setq org-todo-keywords
4125       '((sequence "TODO" "|" "DONE")
4126         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4127         (sequence "|" "CANCELED")))
4128 @end lisp
4130 The keywords should all be different, this helps Org mode to keep track
4131 of which subsequence should be used for a given entry.  In this setup,
4132 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4133 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4134 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
4135 select the correct sequence.  Besides the obvious ways like typing a
4136 keyword or using completion, you may also apply the following commands:
4138 @table @kbd
4139 @kindex C-S-@key{right}
4140 @kindex C-S-@key{left}
4141 @kindex C-u C-u C-c C-t
4142 @item C-u C-u C-c C-t
4143 @itemx C-S-@key{right}
4144 @itemx C-S-@key{left}
4145 These keys jump from one TODO subset to the next.  In the above example,
4146 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4147 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4148 @code{CANCELED}.  Note that the @kbd{C-S-} key binding conflict with
4149 @code{shift-selection-mode} (@pxref{Conflicts}).
4150 @kindex S-@key{right}
4151 @kindex S-@key{left}
4152 @item S-@key{right}
4153 @itemx S-@key{left}
4154 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
4155 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
4156 from @code{DONE} to @code{REPORT} in the example above.  See also
4157 @ref{Conflicts}, for a discussion of the interaction with
4158 @code{shift-selection-mode}.
4159 @end table
4161 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
4162 @subsection Fast access to TODO states
4164 If you would like to quickly change an entry to an arbitrary TODO state
4165 instead of cycling through the states, you can set up keys for single-letter
4166 access to the states.  This is done by adding the selection character after
4167 each keyword, in parentheses@footnote{All characters are allowed except
4168 @code{@@^!}, which have a special meaning here.}.  For example:
4170 @lisp
4171 (setq org-todo-keywords
4172       '((sequence "TODO(t)" "|" "DONE(d)")
4173         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4174         (sequence "|" "CANCELED(c)")))
4175 @end lisp
4177 @vindex org-fast-tag-selection-include-todo
4178 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4179 will be switched to this state.  @kbd{SPC} can be used to remove any TODO
4180 keyword from an entry.@footnote{Check also the option
4181 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4182 state through the tags interface (@pxref{Setting tags}), in case you like to
4183 mingle the two concepts.  Note that this means you need to come up with
4184 unique keys across both sets of keywords.}
4186 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
4187 @subsection Setting up keywords for individual files
4188 @cindex keyword options
4189 @cindex per-file keywords
4190 @cindex #+TODO
4191 @cindex #+TYP_TODO
4192 @cindex #+SEQ_TODO
4194 It can be very useful to use different aspects of the TODO mechanism in
4195 different files.  For file-local settings, you need to add special lines
4196 to the file which set the keywords and interpretation for that file
4197 only.  For example, to set one of the two examples discussed above, you
4198 need one of the following lines, starting in column zero anywhere in the
4199 file:
4201 @example
4202 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4203 @end example
4204 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4205 interpretation, but it means the same as @code{#+TODO}), or
4206 @example
4207 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4208 @end example
4210 A setup for using several sets in parallel would be:
4212 @example
4213 #+TODO: TODO | DONE
4214 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4215 #+TODO: | CANCELED
4216 @end example
4218 @cindex completion, of option keywords
4219 @kindex M-@key{TAB}
4220 @noindent To make sure you are using the correct keyword, type
4221 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4223 @cindex DONE, final TODO keyword
4224 Remember that the keywords after the vertical bar (or the last keyword
4225 if no bar is there) must always mean that the item is DONE (although you
4226 may use a different word).  After changing one of these lines, use
4227 @kbd{C-c C-c} with the cursor still in the line to make the changes
4228 known to Org mode@footnote{Org mode parses these lines only when
4229 Org mode is activated after visiting a file.  @kbd{C-c C-c} with the
4230 cursor in a line starting with @samp{#+} is simply restarting Org mode
4231 for the current buffer.}.
4233 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
4234 @subsection Faces for TODO keywords
4235 @cindex faces, for TODO keywords
4237 @vindex org-todo @r{(face)}
4238 @vindex org-done @r{(face)}
4239 @vindex org-todo-keyword-faces
4240 Org mode highlights TODO keywords with special faces: @code{org-todo}
4241 for keywords indicating that an item still has to be acted upon, and
4242 @code{org-done} for keywords indicating that an item is finished.  If
4243 you are using more than 2 different states, you might want to use
4244 special faces for some of them.  This can be done using the option
4245 @code{org-todo-keyword-faces}.  For example:
4247 @lisp
4248 @group
4249 (setq org-todo-keyword-faces
4250       '(("TODO" . org-warning) ("STARTED" . "yellow")
4251         ("CANCELED" . (:foreground "blue" :weight bold))))
4252 @end group
4253 @end lisp
4255 While using a list with face properties as shown for CANCELED @emph{should}
4256 work, this does not always seem to be the case.  If necessary, define a
4257 special face and use that.  A string is interpreted as a color.  The option
4258 @code{org-faces-easy-properties} determines if that color is interpreted as a
4259 foreground or a background color.
4261 @node TODO dependencies,  , Faces for TODO keywords, TODO extensions
4262 @subsection TODO dependencies
4263 @cindex TODO dependencies
4264 @cindex dependencies, of TODO states
4266 @vindex org-enforce-todo-dependencies
4267 @cindex property, ORDERED
4268 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4269 dependencies.  Usually, a parent TODO task should not be marked DONE until
4270 all subtasks (defined as children tasks) are marked as DONE@.  And sometimes
4271 there is a logical sequence to a number of (sub)tasks, so that one task
4272 cannot be acted upon before all siblings above it are done.  If you customize
4273 the option @code{org-enforce-todo-dependencies}, Org will block entries
4274 from changing state to DONE while they have children that are not DONE@.
4275 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4276 will be blocked until all earlier siblings are marked DONE@.  Here is an
4277 example:
4279 @example
4280 * TODO Blocked until (two) is done
4281 ** DONE one
4282 ** TODO two
4284 * Parent
4285   :PROPERTIES:
4286   :ORDERED: t
4287   :END:
4288 ** TODO a
4289 ** TODO b, needs to wait for (a)
4290 ** TODO c, needs to wait for (a) and (b)
4291 @end example
4293 @table @kbd
4294 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4295 @vindex org-track-ordered-property-with-tag
4296 @cindex property, ORDERED
4297 Toggle the @code{ORDERED} property of the current entry.  A property is used
4298 for this behavior because this should be local to the current entry, not
4299 inherited like a tag.  However, if you would like to @i{track} the value of
4300 this property with a tag for better visibility, customize the option
4301 @code{org-track-ordered-property-with-tag}.
4302 @orgkey{C-u C-u C-u C-c C-t}
4303 Change TODO state, circumventing any state blocking.
4304 @end table
4306 @vindex org-agenda-dim-blocked-tasks
4307 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4308 that cannot be closed because of such dependencies will be shown in a dimmed
4309 font or even made invisible in agenda views (@pxref{Agenda Views}).
4311 @cindex checkboxes and TODO dependencies
4312 @vindex org-enforce-todo-dependencies
4313 You can also block changes of TODO states by looking at checkboxes
4314 (@pxref{Checkboxes}).  If you set the option
4315 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4316 checkboxes will be blocked from switching to DONE.
4318 If you need more complex dependency structures, for example dependencies
4319 between entries in different trees or files, check out the contributed
4320 module @file{org-depend.el}.
4322 @page
4323 @node Progress logging, Priorities, TODO extensions, TODO Items
4324 @section Progress logging
4325 @cindex progress logging
4326 @cindex logging, of progress
4328 Org mode can automatically record a timestamp and possibly a note when
4329 you mark a TODO item as DONE, or even each time you change the state of
4330 a TODO item.  This system is highly configurable; settings can be on a
4331 per-keyword basis and can be localized to a file or even a subtree.  For
4332 information on how to clock working time for a task, see @ref{Clocking
4333 work time}.
4335 @menu
4336 * Closing items::               When was this entry marked DONE?
4337 * Tracking TODO state changes::  When did the status change?
4338 * Tracking your habits::        How consistent have you been?
4339 @end menu
4341 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4342 @subsection Closing items
4344 The most basic logging is to keep track of @emph{when} a certain TODO
4345 item was finished.  This is achieved with@footnote{The corresponding
4346 in-buffer setting is: @code{#+STARTUP: logdone}}
4348 @lisp
4349 (setq org-log-done 'time)
4350 @end lisp
4352 @vindex org-closed-keep-when-no-todo
4353 @noindent
4354 Then each time you turn an entry from a TODO (not-done) state into any of the
4355 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4356 the headline.  If you turn the entry back into a TODO item through further
4357 state cycling, that line will be removed again.  If you turn the entry back
4358 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4359 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4360 non-@code{nil}.  If you want to record a note along with the timestamp,
4361 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4362 lognotedone}.}
4364 @lisp
4365 (setq org-log-done 'note)
4366 @end lisp
4368 @noindent
4369 You will then be prompted for a note, and that note will be stored below
4370 the entry with a @samp{Closing Note} heading.
4372 In the timeline (@pxref{Timeline}) and in the agenda
4373 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4374 display the TODO items with a @samp{CLOSED} timestamp on each day,
4375 giving you an overview of what has been done.
4377 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4378 @subsection Tracking TODO state changes
4379 @cindex drawer, for state change recording
4381 @vindex org-log-states-order-reversed
4382 @vindex org-log-into-drawer
4383 @cindex property, LOG_INTO_DRAWER
4384 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4385 might want to keep track of when a state change occurred and maybe take a
4386 note about this change.  You can either record just a timestamp, or a
4387 time-stamped note for a change.  These records will be inserted after the
4388 headline as an itemized list, newest first@footnote{See the option
4389 @code{org-log-states-order-reversed}}.  When taking a lot of notes, you might
4390 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4391 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4392 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4393 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4394 show an entry---use @key{C-u SPC} to keep it folded here}.  You can also
4395 overrule the setting of this variable for a subtree by setting a
4396 @code{LOG_INTO_DRAWER} property.
4398 Since it is normally too much to record a note for every state, Org mode
4399 expects configuration on a per-keyword basis for this.  This is achieved by
4400 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4401 with timestamp) in parentheses after each keyword.  For example, with the
4402 setting
4404 @lisp
4405 (setq org-todo-keywords
4406   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4407 @end lisp
4409 To record a timestamp without a note for TODO keywords configured with
4410 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4412 @noindent
4413 @vindex org-log-done
4414 you not only define global TODO keywords and fast access keys, but also
4415 request that a time is recorded when the entry is set to
4416 DONE@footnote{It is possible that Org mode will record two timestamps
4417 when you are using both @code{org-log-done} and state change logging.
4418 However, it will never prompt for two notes---if you have configured
4419 both, the state change recording note will take precedence and cancel
4420 the @samp{Closing Note}.}, and that a note is recorded when switching to
4421 WAIT or CANCELED@.  The setting for WAIT is even more special: the
4422 @samp{!} after the slash means that in addition to the note taken when
4423 entering the state, a timestamp should be recorded when @i{leaving} the
4424 WAIT state, if and only if the @i{target} state does not configure
4425 logging for entering it.  So it has no effect when switching from WAIT
4426 to DONE, because DONE is configured to record a timestamp only.  But
4427 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4428 setting now triggers a timestamp even though TODO has no logging
4429 configured.
4431 You can use the exact same syntax for setting logging preferences local
4432 to a buffer:
4433 @example
4434 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4435 @end example
4437 @cindex property, LOGGING
4438 In order to define logging settings that are local to a subtree or a
4439 single item, define a LOGGING property in this entry.  Any non-empty
4440 LOGGING property resets all logging settings to @code{nil}.  You may then turn
4441 on logging for this specific tree using STARTUP keywords like
4442 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4443 settings like @code{TODO(!)}.  For example
4445 @example
4446 * TODO Log each state with only a time
4447   :PROPERTIES:
4448   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4449   :END:
4450 * TODO Only log when switching to WAIT, and when repeating
4451   :PROPERTIES:
4452   :LOGGING: WAIT(@@) logrepeat
4453   :END:
4454 * TODO No logging at all
4455   :PROPERTIES:
4456   :LOGGING: nil
4457   :END:
4458 @end example
4460 @node Tracking your habits,  , Tracking TODO state changes, Progress logging
4461 @subsection Tracking your habits
4462 @cindex habits
4464 Org has the ability to track the consistency of a special category of TODOs,
4465 called ``habits''.  A habit has the following properties:
4467 @enumerate
4468 @item
4469 You have enabled the @code{habits} module by customizing @code{org-modules}.
4470 @item
4471 The habit is a TODO item, with a TODO keyword representing an open state.
4472 @item
4473 The property @code{STYLE} is set to the value @code{habit}.
4474 @item
4475 The TODO has a scheduled date, usually with a @code{.+} style repeat
4476 interval.  A @code{++} style may be appropriate for habits with time
4477 constraints, e.g., must be done on weekends, or a @code{+} style for an
4478 unusual habit that can have a backlog, e.g., weekly reports.
4479 @item
4480 The TODO may also have minimum and maximum ranges specified by using the
4481 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4482 three days, but at most every two days.
4483 @item
4484 You must also have state logging for the @code{DONE} state enabled
4485 (@pxref{Tracking TODO state changes}), in order for historical data to be
4486 represented in the consistency graph.  If it is not enabled it is not an
4487 error, but the consistency graphs will be largely meaningless.
4488 @end enumerate
4490 To give you an idea of what the above rules look like in action, here's an
4491 actual habit with some history:
4493 @example
4494 ** TODO Shave
4495    SCHEDULED: <2009-10-17 Sat .+2d/4d>
4496    - State "DONE"       from "TODO"       [2009-10-15 Thu]
4497    - State "DONE"       from "TODO"       [2009-10-12 Mon]
4498    - State "DONE"       from "TODO"       [2009-10-10 Sat]
4499    - State "DONE"       from "TODO"       [2009-10-04 Sun]
4500    - State "DONE"       from "TODO"       [2009-10-02 Fri]
4501    - State "DONE"       from "TODO"       [2009-09-29 Tue]
4502    - State "DONE"       from "TODO"       [2009-09-25 Fri]
4503    - State "DONE"       from "TODO"       [2009-09-19 Sat]
4504    - State "DONE"       from "TODO"       [2009-09-16 Wed]
4505    - State "DONE"       from "TODO"       [2009-09-12 Sat]
4506    :PROPERTIES:
4507    :STYLE:    habit
4508    :LAST_REPEAT: [2009-10-19 Mon 00:36]
4509    :END:
4510 @end example
4512 What this habit says is: I want to shave at most every 2 days (given by the
4513 @code{SCHEDULED} date and repeat interval) and at least every 4 days.  If
4514 today is the 15th, then the habit first appears in the agenda on Oct 17,
4515 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4516 after four days have elapsed.
4518 What's really useful about habits is that they are displayed along with a
4519 consistency graph, to show how consistent you've been at getting that task
4520 done in the past.  This graph shows every day that the task was done over the
4521 past three weeks, with colors for each day.  The colors used are:
4523 @table @code
4524 @item Blue
4525 If the task wasn't to be done yet on that day.
4526 @item Green
4527 If the task could have been done on that day.
4528 @item Yellow
4529 If the task was going to be overdue the next day.
4530 @item Red
4531 If the task was overdue on that day.
4532 @end table
4534 In addition to coloring each day, the day is also marked with an asterisk if
4535 the task was actually done that day, and an exclamation mark to show where
4536 the current day falls in the graph.
4538 There are several configuration variables that can be used to change the way
4539 habits are displayed in the agenda.
4541 @table @code
4542 @item org-habit-graph-column
4543 The buffer column at which the consistency graph should be drawn.  This will
4544 overwrite any text in that column, so it is a good idea to keep your habits'
4545 titles brief and to the point.
4546 @item org-habit-preceding-days
4547 The amount of history, in days before today, to appear in consistency graphs.
4548 @item org-habit-following-days
4549 The number of days after today that will appear in consistency graphs.
4550 @item org-habit-show-habits-only-for-today
4551 If non-@code{nil}, only show habits in today's agenda view.  This is set to true by
4552 default.
4553 @end table
4555 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4556 temporarily be disabled and they won't appear at all.  Press @kbd{K} again to
4557 bring them back.  They are also subject to tag filtering, if you have habits
4558 which should only be done in certain contexts, for example.
4560 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4561 @section Priorities
4562 @cindex priorities
4564 If you use Org mode extensively, you may end up with enough TODO items that
4565 it starts to make sense to prioritize them.  Prioritizing can be done by
4566 placing a @emph{priority cookie} into the headline of a TODO item, like this
4568 @example
4569 *** TODO [#A] Write letter to Sam Fortune
4570 @end example
4572 @noindent
4573 @vindex org-priority-faces
4574 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4575 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie is
4576 treated just like priority @samp{B}.  Priorities make a difference only for
4577 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4578 have no inherent meaning to Org mode.  The cookies can be highlighted with
4579 special faces by customizing @code{org-priority-faces}.
4581 Priorities can be attached to any outline node; they do not need to be TODO
4582 items.
4584 @table @kbd
4585 @item @kbd{C-c ,}
4586 @kindex @kbd{C-c ,}
4587 @findex org-priority
4588 Set the priority of the current headline (@command{org-priority}).  The
4589 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4590 When you press @key{SPC} instead, the priority cookie is removed from the
4591 headline.  The priorities can also be changed ``remotely'' from the timeline
4592 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4594 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4595 @vindex org-priority-start-cycle-with-default
4596 Increase/decrease priority of current headline@footnote{See also the option
4597 @code{org-priority-start-cycle-with-default}.}.  Note that these keys are
4598 also used to modify timestamps (@pxref{Creating timestamps}).  See also
4599 @ref{Conflicts}, for a discussion of the interaction with
4600 @code{shift-selection-mode}.
4601 @end table
4603 @vindex org-highest-priority
4604 @vindex org-lowest-priority
4605 @vindex org-default-priority
4606 You can change the range of allowed priorities by setting the options
4607 @code{org-highest-priority}, @code{org-lowest-priority}, and
4608 @code{org-default-priority}.  For an individual buffer, you may set
4609 these values (highest, lowest, default) like this (please make sure that
4610 the highest priority is earlier in the alphabet than the lowest
4611 priority):
4613 @cindex #+PRIORITIES
4614 @example
4615 #+PRIORITIES: A C B
4616 @end example
4618 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4619 @section Breaking tasks down into subtasks
4620 @cindex tasks, breaking down
4621 @cindex statistics, for TODO items
4623 @vindex org-agenda-todo-list-sublevels
4624 It is often advisable to break down large tasks into smaller, manageable
4625 subtasks.  You can do this by creating an outline tree below a TODO item,
4626 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4627 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.  To keep
4628 the overview over the fraction of subtasks that are already completed, insert
4629 either @samp{[/]} or @samp{[%]} anywhere in the headline.  These cookies will
4630 be updated each time the TODO status of a child changes, or when pressing
4631 @kbd{C-c C-c} on the cookie.  For example:
4633 @example
4634 * Organize Party [33%]
4635 ** TODO Call people [1/2]
4636 *** TODO Peter
4637 *** DONE Sarah
4638 ** TODO Buy food
4639 ** DONE Talk to neighbor
4640 @end example
4642 @cindex property, COOKIE_DATA
4643 If a heading has both checkboxes and TODO children below it, the meaning of
4644 the statistics cookie become ambiguous.  Set the property
4645 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4646 this issue.
4648 @vindex org-hierarchical-todo-statistics
4649 If you would like to have the statistics cookie count any TODO entries in the
4650 subtree (not just direct children), configure
4651 @code{org-hierarchical-todo-statistics}.  To do this for a single subtree,
4652 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4653 property.
4655 @example
4656 * Parent capturing statistics [2/20]
4657   :PROPERTIES:
4658   :COOKIE_DATA: todo recursive
4659   :END:
4660 @end example
4662 If you would like a TODO entry to automatically change to DONE
4663 when all children are done, you can use the following setup:
4665 @example
4666 (defun org-summary-todo (n-done n-not-done)
4667   "Switch entry to DONE when all subentries are done, to TODO otherwise."
4668   (let (org-log-done org-log-states)   ; turn off logging
4669     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4671 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4672 @end example
4675 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4676 large number of subtasks (@pxref{Checkboxes}).
4679 @node Checkboxes,  , Breaking down tasks, TODO Items
4680 @section Checkboxes
4681 @cindex checkboxes
4683 @vindex org-list-automatic-rules
4684 Every item in a plain list@footnote{With the exception of description
4685 lists.  But you can allow it by modifying @code{org-list-automatic-rules}
4686 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4687 it with the string @samp{[ ]}.  This feature is similar to TODO items
4688 (@pxref{TODO Items}), but is more lightweight.  Checkboxes are not included
4689 in the global TODO list, so they are often great to split a task into a
4690 number of simple steps.  Or you can use them in a shopping list.  To toggle a
4691 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4692 @file{org-mouse.el}).
4694 Here is an example of a checkbox list.
4696 @example
4697 * TODO Organize party [2/4]
4698   - [-] call people [1/3]
4699     - [ ] Peter
4700     - [X] Sarah
4701     - [ ] Sam
4702   - [X] order food
4703   - [ ] think about what music to play
4704   - [X] talk to the neighbors
4705 @end example
4707 Checkboxes work hierarchically, so if a checkbox item has children that
4708 are checkboxes, toggling one of the children checkboxes will make the
4709 parent checkbox reflect if none, some, or all of the children are
4710 checked.
4712 @cindex statistics, for checkboxes
4713 @cindex checkbox statistics
4714 @cindex property, COOKIE_DATA
4715 @vindex org-checkbox-hierarchical-statistics
4716 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4717 indicating how many checkboxes present in this entry have been checked off,
4718 and the total number of checkboxes present.  This can give you an idea on how
4719 many checkboxes remain, even without opening a folded entry.  The cookies can
4720 be placed into a headline or into (the first line of) a plain list item.
4721 Each cookie covers checkboxes of direct children structurally below the
4722 headline/item on which the cookie appears@footnote{Set the option
4723 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4724 count all checkboxes below the cookie, not just those belonging to direct
4725 children.}.  You have to insert the cookie yourself by typing either
4726 @samp{[/]} or @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m}
4727 result, as in the examples above.  With @samp{[%]} you get information about
4728 the percentage of checkboxes checked (in the above example, this would be
4729 @samp{[50%]} and @samp{[33%]}, respectively).  In a headline, a cookie can
4730 count either checkboxes below the heading or TODO states of children, and it
4731 will display whatever was changed last.  Set the property @code{COOKIE_DATA}
4732 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4734 @cindex blocking, of checkboxes
4735 @cindex checkbox blocking
4736 @cindex property, ORDERED
4737 If the current outline node has an @code{ORDERED} property, checkboxes must
4738 be checked off in sequence, and an error will be thrown if you try to check
4739 off a box while there are unchecked boxes above it.
4741 @noindent The following commands work with checkboxes:
4743 @table @kbd
4744 @orgcmd{C-c C-c,org-toggle-checkbox}
4745 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4746 With a single prefix argument, add an empty checkbox or remove the current
4747 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4748 will add checkboxes to the rest of the list.}.  With a double prefix argument, set it to @samp{[-]}, which is
4749 considered to be an intermediate state.
4750 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4751 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
4752 double prefix argument, set it to @samp{[-]}, which is considered to be an
4753 intermediate state.
4754 @itemize @minus
4755 @item
4756 If there is an active region, toggle the first checkbox in the region
4757 and set all remaining boxes to the same status as the first.  With a prefix
4758 arg, add or remove the checkbox for all items in the region.
4759 @item
4760 If the cursor is in a headline, toggle checkboxes in the region between
4761 this headline and the next (so @emph{not} the entire subtree).
4762 @item
4763 If there is no active region, just toggle the checkbox at point.
4764 @end itemize
4765 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4766 Insert a new item with a checkbox.  This works only if the cursor is already
4767 in a plain list item (@pxref{Plain lists}).
4768 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4769 @vindex org-track-ordered-property-with-tag
4770 @cindex property, ORDERED
4771 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4772 be checked off in sequence.  A property is used for this behavior because
4773 this should be local to the current entry, not inherited like a tag.
4774 However, if you would like to @i{track} the value of this property with a tag
4775 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4776 @orgcmd{C-c #,org-update-statistics-cookies}
4777 Update the statistics cookie in the current outline entry.  When called with
4778 a @kbd{C-u} prefix, update the entire file.  Checkbox statistic cookies are
4779 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4780 new ones with @kbd{M-S-@key{RET}}.  TODO statistics cookies update when
4781 changing TODO states.  If you delete boxes/entries or add/change them by
4782 hand, use this command to get things back into sync.
4783 @end table
4785 @node Tags, Properties and Columns, TODO Items, Top
4786 @chapter Tags
4787 @cindex tags
4788 @cindex headline tagging
4789 @cindex matching, tags
4790 @cindex sparse tree, tag based
4792 An excellent way to implement labels and contexts for cross-correlating
4793 information is to assign @i{tags} to headlines.  Org mode has extensive
4794 support for tags.
4796 @vindex org-tag-faces
4797 Every headline can contain a list of tags; they occur at the end of the
4798 headline.  Tags are normal words containing letters, numbers, @samp{_}, and
4799 @samp{@@}.  Tags must be preceded and followed by a single colon, e.g.,
4800 @samp{:work:}.  Several tags can be specified, as in @samp{:work:urgent:}.
4801 Tags will by default be in bold face with the same color as the headline.
4802 You may specify special faces for specific tags using the option
4803 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4804 (@pxref{Faces for TODO keywords}).
4806 @menu
4807 * Tag inheritance::             Tags use the tree structure of the outline
4808 * Setting tags::                How to assign tags to a headline
4809 * Tag groups::                  Use one tag to search for several tags
4810 * Tag searches::                Searching for combinations of tags
4811 @end menu
4813 @node Tag inheritance, Setting tags, Tags, Tags
4814 @section Tag inheritance
4815 @cindex tag inheritance
4816 @cindex inheritance, of tags
4817 @cindex sublevels, inclusion into tags match
4819 @i{Tags} make use of the hierarchical structure of outline trees.  If a
4820 heading has a certain tag, all subheadings will inherit the tag as
4821 well.  For example, in the list
4823 @example
4824 * Meeting with the French group      :work:
4825 ** Summary by Frank                  :boss:notes:
4826 *** TODO Prepare slides for him      :action:
4827 @end example
4829 @noindent
4830 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4831 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4832 explicitly marked with those tags.  You can also set tags that all entries in
4833 a file should inherit just as if these tags were defined in a hypothetical
4834 level zero that surrounds the entire file.  Use a line like this@footnote{As
4835 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4836 changes in the line.}:
4838 @cindex #+FILETAGS
4839 @example
4840 #+FILETAGS: :Peter:Boss:Secret:
4841 @end example
4843 @noindent
4844 @vindex org-use-tag-inheritance
4845 @vindex org-tags-exclude-from-inheritance
4846 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4847 To turn it off entirely, use @code{org-use-tag-inheritance}.
4849 @vindex org-tags-match-list-sublevels
4850 When a headline matches during a tags search while tag inheritance is turned
4851 on, all the sublevels in the same tree will (for a simple match form) match
4852 as well@footnote{This is only true if the search does not involve more
4853 complex tests including properties (@pxref{Property searches}).}.  The list
4854 of matches may then become very long.  If you only want to see the first tags
4855 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4856 recommended).
4858 @vindex org-agenda-use-tag-inheritance
4859 Tag inheritance is relevant when the agenda search tries to match a tag,
4860 either in the @code{tags} or @code{tags-todo} agenda types.  In other agenda
4861 types, @code{org-use-tag-inheritance} has no effect.  Still, you may want to
4862 have your tags correctly set in the agenda, so that tag filtering works fine,
4863 with inherited tags.  Set @code{org-agenda-use-tag-inheritance} to control
4864 this: the default value includes all agenda types, but setting this to @code{nil}
4865 can really speed up agenda generation.
4867 @node Setting tags, Tag groups, Tag inheritance, Tags
4868 @section Setting tags
4869 @cindex setting tags
4870 @cindex tags, setting
4872 @kindex M-@key{TAB}
4873 Tags can simply be typed into the buffer at the end of a headline.
4874 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
4875 also a special command for inserting tags:
4877 @table @kbd
4878 @orgcmd{C-c C-q,org-set-tags-command}
4879 @cindex completion, of tags
4880 @vindex org-tags-column
4881 Enter new tags for the current headline.  Org mode will either offer
4882 completion or a special single-key interface for setting tags, see
4883 below.  After pressing @key{RET}, the tags will be inserted and aligned
4884 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
4885 tags in the current buffer will be aligned to that column, just to make
4886 things look nice.  TAGS are automatically realigned after promotion,
4887 demotion, and TODO state changes (@pxref{TODO basics}).
4889 @orgcmd{C-c C-c,org-set-tags-command}
4890 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4891 @end table
4893 @vindex org-tag-alist
4894 Org supports tag insertion based on a @emph{list of tags}.  By
4895 default this list is constructed dynamically, containing all tags
4896 currently used in the buffer.  You may also globally specify a hard list
4897 of tags with the variable @code{org-tag-alist}.  Finally you can set
4898 the default tags for a given file with lines like
4900 @cindex #+TAGS
4901 @example
4902 #+TAGS: @@work @@home @@tennisclub
4903 #+TAGS: laptop car pc sailboat
4904 @end example
4906 If you have globally defined your preferred set of tags using the
4907 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4908 in a specific file, add an empty TAGS option line to that file:
4910 @example
4911 #+TAGS:
4912 @end example
4914 @vindex org-tag-persistent-alist
4915 If you have a preferred set of tags that you would like to use in every file,
4916 in addition to those defined on a per-file basis by TAGS option lines, then
4917 you may specify a list of tags with the variable
4918 @code{org-tag-persistent-alist}.  You may turn this off on a per-file basis
4919 by adding a STARTUP option line to that file:
4921 @example
4922 #+STARTUP: noptag
4923 @end example
4925 By default Org mode uses the standard minibuffer completion facilities for
4926 entering tags.  However, it also implements another, quicker, tag selection
4927 method called @emph{fast tag selection}.  This allows you to select and
4928 deselect tags with just a single key press.  For this to work well you should
4929 assign unique letters to most of your commonly used tags.  You can do this
4930 globally by configuring the variable @code{org-tag-alist} in your
4931 @file{.emacs} file.  For example, you may find the need to tag many items in
4932 different files with @samp{:@@home:}.  In this case you can set something
4933 like:
4935 @lisp
4936 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4937 @end lisp
4939 @noindent If the tag is only relevant to the file you are working on, then you
4940 can instead set the TAGS option line as:
4942 @example
4943 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
4944 @end example
4946 @noindent The tags interface will show the available tags in a splash
4947 window.  If you want to start a new line after a specific tag, insert
4948 @samp{\n} into the tag list
4950 @example
4951 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t) \n laptop(l)  pc(p)
4952 @end example
4954 @noindent or write them in two lines:
4956 @example
4957 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)
4958 #+TAGS: laptop(l)  pc(p)
4959 @end example
4961 @noindent
4962 You can also group together tags that are mutually exclusive by using
4963 braces, as in:
4965 @example
4966 #+TAGS: @{ @@work(w)  @@home(h)  @@tennisclub(t) @}  laptop(l)  pc(p)
4967 @end example
4969 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4970 and @samp{@@tennisclub} should be selected.  Multiple such groups are allowed.
4972 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4973 these lines to activate any changes.
4975 @noindent
4976 To set these mutually exclusive groups in the variable @code{org-tag-alist},
4977 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4978 of the braces.  Similarly, you can use @code{:newline} to indicate a line
4979 break.  The previous example would be set globally by the following
4980 configuration:
4982 @lisp
4983 (setq org-tag-alist '((:startgroup . nil)
4984                       ("@@work" . ?w) ("@@home" . ?h)
4985                       ("@@tennisclub" . ?t)
4986                       (:endgroup . nil)
4987                       ("laptop" . ?l) ("pc" . ?p)))
4988 @end lisp
4990 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4991 automatically present you with a special interface, listing inherited tags,
4992 the tags of the current headline, and a list of all valid tags with
4993 corresponding keys@footnote{Keys will automatically be assigned to tags which
4994 have no configured keys.}.  In this interface, you can use the following
4995 keys:
4997 @table @kbd
4998 @item a-z...
4999 Pressing keys assigned to tags will add or remove them from the list of
5000 tags in the current line.  Selecting a tag in a group of mutually
5001 exclusive tags will turn off any other tags from that group.
5002 @kindex @key{TAB}
5003 @item @key{TAB}
5004 Enter a tag in the minibuffer, even if the tag is not in the predefined
5005 list.  You will be able to complete on all tags present in the buffer.
5006 You can also add several tags: just separate them with a comma.
5008 @kindex @key{SPC}
5009 @item @key{SPC}
5010 Clear all tags for this line.
5011 @kindex @key{RET}
5012 @item @key{RET}
5013 Accept the modified set.
5014 @item C-g
5015 Abort without installing changes.
5016 @item q
5017 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5018 @item !
5019 Turn off groups of mutually exclusive tags.  Use this to (as an
5020 exception) assign several tags from such a group.
5021 @item C-c
5022 Toggle auto-exit after the next change (see below).
5023 If you are using expert mode, the first @kbd{C-c} will display the
5024 selection window.
5025 @end table
5027 @noindent
5028 This method lets you assign tags to a headline with very few keys.  With
5029 the above setup, you could clear the current tags and set @samp{@@home},
5030 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5031 C-c @key{SPC} h l p @key{RET}}.  Switching from @samp{@@home} to
5032 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5033 alternatively with @kbd{C-c C-c C-c w}.  Adding the non-predefined tag
5034 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5035 @key{RET} @key{RET}}.
5037 @vindex org-fast-tag-selection-single-key
5038 If you find that most of the time you need only a single key press to
5039 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5040 Then you no longer have to press @key{RET} to exit fast tag selection---it
5041 will immediately exit after the first change.  If you then occasionally
5042 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5043 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5044 instead of @kbd{C-c C-c}).  If you set the variable to the value
5045 @code{expert}, the special window is not even shown for single-key tag
5046 selection, it comes up only when you press an extra @kbd{C-c}.
5048 @node Tag groups, Tag searches, Setting tags, Tags
5049 @section Tag groups
5051 @cindex group tags
5052 @cindex tags, groups
5053 In a set of mutually exclusive tags, the first tag can be defined as a
5054 @emph{group tag}.  When you search for a group tag, it will return matches
5055 for all members in the group.  In an agenda view, filtering by a group tag
5056 will display headlines tagged with at least one of the members of the
5057 group.  This makes tag searches and filters even more flexible.
5059 You can set group tags by inserting a colon between the group tag and other
5060 tags---beware that all whitespaces are mandatory so that Org can parse this
5061 line correctly:
5063 @example
5064 #+TAGS: @{ @@read : @@read_book @@read_ebook @}
5065 @end example
5067 In this example, @samp{@@read} is a @emph{group tag} for a set of three
5068 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
5070 You can also use the @code{:grouptags} keyword directly when setting
5071 @code{org-tag-alist}:
5073 @lisp
5074 (setq org-tag-alist '((:startgroup . nil)
5075                       ("@@read" . nil)
5076                       (:grouptags . nil)
5077                       ("@@read_book" . nil)
5078                       ("@@read_ebook" . nil)
5079                       (:endgroup . nil)))
5080 @end lisp
5082 You cannot nest group tags or use a group tag as a tag in another group.
5084 @kindex C-c C-x q
5085 @vindex org-group-tags
5086 If you want to ignore group tags temporarily, toggle group tags support
5087 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}.  If you
5088 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5090 @node Tag searches,  , Tag groups, Tags
5091 @section Tag searches
5092 @cindex tag searches
5093 @cindex searching for tags
5095 Once a system of tags has been set up, it can be used to collect related
5096 information into special lists.
5098 @table @kbd
5099 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5100 Create a sparse tree with all headlines matching a tags/property/TODO search.
5101 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5102 @xref{Matching tags and properties}.
5103 @orgcmd{C-c a m,org-tags-view}
5104 Create a global list of tag matches from all agenda files.  @xref{Matching
5105 tags and properties}.
5106 @orgcmd{C-c a M,org-tags-view}
5107 @vindex org-tags-match-list-sublevels
5108 Create a global list of tag matches from all agenda files, but check
5109 only TODO items and force checking subitems (see the option
5110 @code{org-tags-match-list-sublevels}).
5111 @end table
5113 These commands all prompt for a match string which allows basic Boolean logic
5114 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5115 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5116 which are tagged, like @samp{Kathy} or @samp{Sally}.  The full syntax of the search
5117 string is rich and allows also matching against TODO keywords, entry levels
5118 and properties.  For a complete description with many examples, see
5119 @ref{Matching tags and properties}.
5122 @node Properties and Columns, Dates and Times, Tags, Top
5123 @chapter Properties and columns
5124 @cindex properties
5126 A property is a key-value pair associated with an entry.  Properties can be
5127 set so they are associated with a single entry, with every entry in a tree,
5128 or with every entry in an Org mode file.
5130 There are two main applications for properties in Org mode.  First,
5131 properties are like tags, but with a value.  Imagine maintaining a file where
5132 you document bugs and plan releases for a piece of software.  Instead of
5133 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5134 property, say @code{:Release:}, that in different subtrees has different
5135 values, such as @code{1.0} or @code{2.0}.  Second, you can use properties to
5136 implement (very basic) database capabilities in an Org buffer.  Imagine
5137 keeping track of your music CDs, where properties could be things such as the
5138 album, artist, date of release, number of tracks, and so on.
5140 Properties can be conveniently edited and viewed in column view
5141 (@pxref{Column view}).
5143 @menu
5144 * Property syntax::             How properties are spelled out
5145 * Special properties::          Access to other Org mode features
5146 * Property searches::           Matching property values
5147 * Property inheritance::        Passing values down the tree
5148 * Column view::                 Tabular viewing and editing
5149 * Property API::                Properties for Lisp programmers
5150 @end menu
5152 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
5153 @section Property syntax
5154 @cindex property syntax
5155 @cindex drawer, for properties
5157 Properties are key-value pairs.  When they are associated with a single entry
5158 or with a tree they need to be inserted into a special
5159 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}.  Each property
5160 is specified on a single line, with the key (surrounded by colons)
5161 first, and the value after it.  Here is an example:
5163 @example
5164 * CD collection
5165 ** Classic
5166 *** Goldberg Variations
5167     :PROPERTIES:
5168     :Title:     Goldberg Variations
5169     :Composer:  J.S. Bach
5170     :Artist:    Glen Gould
5171     :Publisher: Deutsche Grammophon
5172     :NDisks:    1
5173     :END:
5174 @end example
5176 Depending on the value of @code{org-use-property-inheritance}, a property set
5177 this way will either be associated with a single entry, or the sub-tree
5178 defined by the entry, see @ref{Property inheritance}.
5180 You may define the allowed values for a particular property @samp{:Xyz:}
5181 by setting a property @samp{:Xyz_ALL:}.  This special property is
5182 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5183 the entire tree.  When allowed values are defined, setting the
5184 corresponding property becomes easier and is less prone to typing
5185 errors.  For the example with the CD collection, we can predefine
5186 publishers and the number of disks in a box like this:
5188 @example
5189 * CD collection
5190   :PROPERTIES:
5191   :NDisks_ALL:  1 2 3 4
5192   :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5193   :END:
5194 @end example
5196 If you want to set properties that can be inherited by any entry in a
5197 file, use a line like
5198 @cindex property, _ALL
5199 @cindex #+PROPERTY
5200 @example
5201 #+PROPERTY: NDisks_ALL 1 2 3 4
5202 @end example
5204 Contrary to properties set from a special drawer, you have to refresh the
5205 buffer with @kbd{C-c C-c} to activate this changes.
5207 If you want to add to the value of an existing property, append a @code{+} to
5208 the property name.  The following results in the property @code{var} having
5209 the value ``foo=1 bar=2''.
5210 @cindex property, +
5211 @example
5212 #+PROPERTY: var  foo=1
5213 #+PROPERTY: var+ bar=2
5214 @end example
5216 It is also possible to add to the values of inherited properties.  The
5217 following results in the @code{genres} property having the value ``Classic
5218 Baroque'' under the @code{Goldberg Variations} subtree.
5219 @cindex property, +
5220 @example
5221 * CD collection
5222 ** Classic
5223     :PROPERTIES:
5224     :GENRES: Classic
5225     :END:
5226 *** Goldberg Variations
5227     :PROPERTIES:
5228     :Title:     Goldberg Variations
5229     :Composer:  J.S. Bach
5230     :Artist:    Glen Gould
5231     :Publisher: Deutsche Grammophon
5232     :NDisks:    1
5233     :GENRES+:   Baroque
5234     :END:
5235 @end example
5236 Note that a property can only have one entry per Drawer.
5238 @vindex org-global-properties
5239 Property values set with the global variable
5240 @code{org-global-properties} can be inherited by all entries in all
5241 Org files.
5243 @noindent
5244 The following commands help to work with properties:
5246 @table @kbd
5247 @orgcmd{M-@key{TAB},pcomplete}
5248 After an initial colon in a line, complete property keys.  All keys used
5249 in the current file will be offered as possible completions.
5250 @orgcmd{C-c C-x p,org-set-property}
5251 Set a property.  This prompts for a property name and a value.  If
5252 necessary, the property drawer is created as well.
5253 @item C-u M-x org-insert-drawer RET
5254 @cindex org-insert-drawer
5255 Insert a property drawer into the current entry.  The drawer will be
5256 inserted early in the entry, but after the lines with planning
5257 information like deadlines.
5258 @orgcmd{C-c C-c,org-property-action}
5259 With the cursor in a property drawer, this executes property commands.
5260 @orgcmd{C-c C-c s,org-set-property}
5261 Set a property in the current entry.  Both the property and the value
5262 can be inserted using completion.
5263 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5264 Switch property at point to the next/previous allowed value.
5265 @orgcmd{C-c C-c d,org-delete-property}
5266 Remove a property from the current entry.
5267 @orgcmd{C-c C-c D,org-delete-property-globally}
5268 Globally remove a property, from all entries in the current file.
5269 @orgcmd{C-c C-c c,org-compute-property-at-point}
5270 Compute the property at point, using the operator and scope from the
5271 nearest column format definition.
5272 @end table
5274 @node Special properties, Property searches, Property syntax, Properties and Columns
5275 @section Special properties
5276 @cindex properties, special
5278 Special properties provide an alternative access method to Org mode features,
5279 like the TODO state or the priority of an entry, discussed in the previous
5280 chapters.  This interface exists so that you can include these states in a
5281 column view (@pxref{Column view}), or to use them in queries.  The following
5282 property names are special and (except for @code{:CATEGORY:}) should not be
5283 used as keys in the properties drawer:
5285 @cindex property, special, ID
5286 @cindex property, special, TODO
5287 @cindex property, special, TAGS
5288 @cindex property, special, ALLTAGS
5289 @cindex property, special, CATEGORY
5290 @cindex property, special, PRIORITY
5291 @cindex property, special, DEADLINE
5292 @cindex property, special, SCHEDULED
5293 @cindex property, special, CLOSED
5294 @cindex property, special, TIMESTAMP
5295 @cindex property, special, TIMESTAMP_IA
5296 @cindex property, special, CLOCKSUM
5297 @cindex property, special, CLOCKSUM_T
5298 @cindex property, special, BLOCKED
5299 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5300 @cindex property, special, ITEM
5301 @cindex property, special, FILE
5302 @example
5303 ID           @r{A globally unique ID used for synchronization during}
5304              @r{iCalendar or MobileOrg export.}
5305 TODO         @r{The TODO keyword of the entry.}
5306 TAGS         @r{The tags defined directly in the headline.}
5307 ALLTAGS      @r{All tags, including inherited ones.}
5308 CATEGORY     @r{The category of an entry.}
5309 PRIORITY     @r{The priority of the entry, a string with a single letter.}
5310 DEADLINE     @r{The deadline time string, without the angular brackets.}
5311 SCHEDULED    @r{The scheduling timestamp, without the angular brackets.}
5312 CLOSED       @r{When was this entry closed?}
5313 TIMESTAMP    @r{The first keyword-less timestamp in the entry.}
5314 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5315 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
5316              @r{must be run first to compute the values in the current buffer.}
5317 CLOCKSUM_T   @r{The sum of CLOCK intervals in the subtree for today.}
5318              @r{@code{org-clock-sum-today} must be run first to compute the}
5319              @r{values in the current buffer.}
5320 BLOCKED      @r{"t" if task is currently blocked by children or siblings}
5321 ITEM         @r{The headline of the entry.}
5322 FILE         @r{The filename the entry is located in.}
5323 @end example
5325 @node Property searches, Property inheritance, Special properties, Properties and Columns
5326 @section Property searches
5327 @cindex properties, searching
5328 @cindex searching, of properties
5330 To create sparse trees and special lists with selection based on properties,
5331 the same commands are used as for tag searches (@pxref{Tag searches}).
5333 @table @kbd
5334 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5335 Create a sparse tree with all matching entries.  With a
5336 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5337 @orgcmd{C-c a m,org-tags-view}
5338 Create a global list of tag/property  matches from all agenda files.
5339 @xref{Matching tags and properties}.
5340 @orgcmd{C-c a M,org-tags-view}
5341 @vindex org-tags-match-list-sublevels
5342 Create a global list of tag matches from all agenda files, but check
5343 only TODO items and force checking of subitems (see the option
5344 @code{org-tags-match-list-sublevels}).
5345 @end table
5347 The syntax for the search string is described in @ref{Matching tags and
5348 properties}.
5350 There is also a special command for creating sparse trees based on a
5351 single property:
5353 @table @kbd
5354 @orgkey{C-c / p}
5355 Create a sparse tree based on the value of a property.  This first
5356 prompts for the name of a property, and then for a value.  A sparse tree
5357 is created with all entries that define this property with the given
5358 value.  If you enclose the value in curly braces, it is interpreted as
5359 a regular expression and matched against the property values.
5360 @end table
5362 @node Property inheritance, Column view, Property searches, Properties and Columns
5363 @section Property Inheritance
5364 @cindex properties, inheritance
5365 @cindex inheritance, of properties
5367 @vindex org-use-property-inheritance
5368 The outline structure of Org mode documents lends itself to an
5369 inheritance model of properties: if the parent in a tree has a certain
5370 property, the children can inherit this property.  Org mode does not
5371 turn this on by default, because it can slow down property searches
5372 significantly and is often not needed.  However, if you find inheritance
5373 useful, you can turn it on by setting the variable
5374 @code{org-use-property-inheritance}.  It may be set to @code{t} to make
5375 all properties inherited from the parent, to a list of properties
5376 that should be inherited, or to a regular expression that matches
5377 inherited properties.  If a property has the value @code{nil}, this is
5378 interpreted as an explicit undefine of the property, so that inheritance
5379 search will stop at this value and return @code{nil}.
5381 Org mode has a few properties for which inheritance is hard-coded, at
5382 least for the special applications for which they are used:
5384 @cindex property, COLUMNS
5385 @table @code
5386 @item COLUMNS
5387 The @code{:COLUMNS:} property defines the format of column view
5388 (@pxref{Column view}).  It is inherited in the sense that the level
5389 where a @code{:COLUMNS:} property is defined is used as the starting
5390 point for a column view table, independently of the location in the
5391 subtree from where columns view is turned on.
5392 @item CATEGORY
5393 @cindex property, CATEGORY
5394 For agenda view, a category set through a @code{:CATEGORY:} property
5395 applies to the entire subtree.
5396 @item ARCHIVE
5397 @cindex property, ARCHIVE
5398 For archiving, the @code{:ARCHIVE:} property may define the archive
5399 location for the entire subtree (@pxref{Moving subtrees}).
5400 @item LOGGING
5401 @cindex property, LOGGING
5402 The LOGGING property may define logging settings for an entry or a
5403 subtree (@pxref{Tracking TODO state changes}).
5404 @end table
5406 @node Column view, Property API, Property inheritance, Properties and Columns
5407 @section Column view
5409 A great way to view and edit properties in an outline tree is
5410 @emph{column view}.  In column view, each outline node is turned into a
5411 table row.  Columns in this table provide access to properties of the
5412 entries.  Org mode implements columns by overlaying a tabular structure
5413 over the headline of each item.  While the headlines have been turned
5414 into a table row, you can still change the visibility of the outline
5415 tree.  For example, you get a compact table by switching to CONTENTS
5416 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5417 is active), but you can still open, read, and edit the entry below each
5418 headline.  Or, you can switch to column view after executing a sparse
5419 tree command and in this way get a table only for the selected items.
5420 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5421 queries have collected selected items, possibly from a number of files.
5423 @menu
5424 * Defining columns::            The COLUMNS format property
5425 * Using column view::           How to create and use column view
5426 * Capturing column view::       A dynamic block for column view
5427 @end menu
5429 @node Defining columns, Using column view, Column view, Column view
5430 @subsection Defining columns
5431 @cindex column view, for properties
5432 @cindex properties, column view
5434 Setting up a column view first requires defining the columns.  This is
5435 done by defining a column format line.
5437 @menu
5438 * Scope of column definitions::  Where defined, where valid?
5439 * Column attributes::           Appearance and content of a column
5440 @end menu
5442 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5443 @subsubsection Scope of column definitions
5445 To define a column format for an entire file, use a line like
5447 @cindex #+COLUMNS
5448 @example
5449 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5450 @end example
5452 To specify a format that only applies to a specific tree, add a
5453 @code{:COLUMNS:} property to the top node of that tree, for example:
5455 @example
5456 ** Top node for columns view
5457    :PROPERTIES:
5458    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5459    :END:
5460 @end example
5462 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5463 for the entry itself, and for the entire subtree below it.  Since the
5464 column definition is part of the hierarchical structure of the document,
5465 you can define columns on level 1 that are general enough for all
5466 sublevels, and more specific columns further down, when you edit a
5467 deeper part of the tree.
5469 @node Column attributes,  , Scope of column definitions, Defining columns
5470 @subsubsection Column attributes
5471 A column definition sets the attributes of a column.  The general
5472 definition looks like this:
5474 @example
5475  %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5476 @end example
5478 @noindent
5479 Except for the percent sign and the property name, all items are
5480 optional.  The individual parts have the following meaning:
5482 @example
5483 @var{width}           @r{An integer specifying the width of the column in characters.}
5484                 @r{If omitted, the width will be determined automatically.}
5485 @var{property}        @r{The property that should be edited in this column.}
5486                 @r{Special properties representing meta data are allowed here}
5487                 @r{as well (@pxref{Special properties})}
5488 @var{title}           @r{The header text for the column.  If omitted, the property}
5489                 @r{name is used.}
5490 @{@var{summary-type}@}  @r{The summary type.  If specified, the column values for}
5491                 @r{parent nodes are computed from the children.}
5492                 @r{Supported summary types are:}
5493                 @{+@}       @r{Sum numbers in this column.}
5494                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
5495                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
5496                 @{:@}       @r{Sum times, HH:MM, plain numbers are hours.}
5497                 @{X@}       @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5498                 @{X/@}      @r{Checkbox status, @samp{[n/m]}.}
5499                 @{X%@}      @r{Checkbox status, @samp{[n%]}.}
5500                 @{min@}     @r{Smallest number in column.}
5501                 @{max@}     @r{Largest number.}
5502                 @{mean@}    @r{Arithmetic mean of numbers.}
5503                 @{:min@}    @r{Smallest time value in column.}
5504                 @{:max@}    @r{Largest time value.}
5505                 @{:mean@}   @r{Arithmetic mean of time values.}
5506                 @{@@min@}    @r{Minimum age (in days/hours/mins/seconds).}
5507                 @{@@max@}    @r{Maximum age (in days/hours/mins/seconds).}
5508                 @{@@mean@}   @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5509                 @{est+@}    @r{Add low-high estimates.}
5510 @end example
5512 @noindent
5513 Be aware that you can only have one summary type for any property you
5514 include.  Subsequent columns referencing the same property will all display the
5515 same summary information.
5517 The @code{est+} summary type requires further explanation.  It is used for
5518 combining estimates, expressed as low-high ranges.  For example, instead
5519 of estimating a particular task will take 5 days, you might estimate it as
5520 5--6 days if you're fairly confident you know how much work is required, or
5521 1--10 days if you don't really know what needs to be done.  Both ranges
5522 average at 5.5 days, but the first represents a more predictable delivery.
5524 When combining a set of such estimates, simply adding the lows and highs
5525 produces an unrealistically wide result.  Instead, @code{est+} adds the
5526 statistical mean and variance of the sub-tasks, generating a final estimate
5527 from the sum.  For example, suppose you had ten tasks, each of which was
5528 estimated at 0.5 to 2 days of work.  Straight addition produces an estimate
5529 of 5 to 20 days, representing what to expect if everything goes either
5530 extremely well or extremely poorly.  In contrast, @code{est+} estimates the
5531 full job more realistically, at 10--15 days.
5533 Numbers are right-aligned when a format specifier with an explicit width like
5534 @code{%5d} or @code{%5.1f} is used.
5536 Here is an example for a complete columns definition, along with allowed
5537 values.
5539 @example
5540 :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.}
5541                    %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5542 :Owner_ALL:    Tammy Mark Karl Lisa Don
5543 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
5544 :Approved_ALL: "[ ]" "[X]"
5545 @end example
5547 @noindent
5548 The first column, @samp{%25ITEM}, means the first 25 characters of the
5549 item itself, i.e., of the headline.  You probably always should start the
5550 column definition with the @samp{ITEM} specifier.  The other specifiers
5551 create columns @samp{Owner} with a list of names as allowed values, for
5552 @samp{Status} with four different possible values, and for a checkbox
5553 field @samp{Approved}.  When no width is given after the @samp{%}
5554 character, the column will be exactly as wide as it needs to be in order
5555 to fully display all values.  The @samp{Approved} column does have a
5556 modified title (@samp{Approved?}, with a question mark).  Summaries will
5557 be created for the @samp{Time_Estimate} column by adding time duration
5558 expressions like HH:MM, and for the @samp{Approved} column, by providing
5559 an @samp{[X]} status if all children have been checked.  The
5560 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5561 sums of CLOCK intervals in the subtree, either for all clocks or just for
5562 today.
5564 @node Using column view, Capturing column view, Defining columns, Column view
5565 @subsection Using column view
5567 @table @kbd
5568 @tsubheading{Turning column view on and off}
5569 @orgcmd{C-c C-x C-c,org-columns}
5570 @vindex org-columns-default-format
5571 Turn on column view.  If the cursor is before the first headline in the file,
5572 column view is turned on for the entire file, using the @code{#+COLUMNS}
5573 definition.  If the cursor is somewhere inside the outline, this command
5574 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5575 defines a format.  When one is found, the column view table is established
5576 for the tree starting at the entry that contains the @code{:COLUMNS:}
5577 property.  If no such property is found, the format is taken from the
5578 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5579 and column view is established for the current entry and its subtree.
5580 @orgcmd{r,org-columns-redo}
5581 Recreate the column view, to include recent changes made in the buffer.
5582 @orgcmd{g,org-columns-redo}
5583 Same as @kbd{r}.
5584 @orgcmd{q,org-columns-quit}
5585 Exit column view.
5586 @tsubheading{Editing values}
5587 @item @key{left} @key{right} @key{up} @key{down}
5588 Move through the column view from field to field.
5589 @kindex S-@key{left}
5590 @kindex S-@key{right}
5591 @item  S-@key{left}/@key{right}
5592 Switch to the next/previous allowed value of the field.  For this, you
5593 have to have specified allowed values for a property.
5594 @item 1..9,0
5595 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5596 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5597 Same as @kbd{S-@key{left}/@key{right}}
5598 @orgcmd{e,org-columns-edit-value}
5599 Edit the property at point.  For the special properties, this will
5600 invoke the same interface that you normally use to change that
5601 property.  For example, when editing a TAGS property, the tag completion
5602 or fast selection interface will pop up.
5603 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5604 When there is a checkbox at point, toggle it.
5605 @orgcmd{v,org-columns-show-value}
5606 View the full value of this property.  This is useful if the width of
5607 the column is smaller than that of the value.
5608 @orgcmd{a,org-columns-edit-allowed}
5609 Edit the list of allowed values for this property.  If the list is found
5610 in the hierarchy, the modified values is stored there.  If no list is
5611 found, the new value is stored in the first entry that is part of the
5612 current column view.
5613 @tsubheading{Modifying the table structure}
5614 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5615 Make the column narrower/wider by one character.
5616 @orgcmd{S-M-@key{right},org-columns-new}
5617 Insert a new column, to the left of the current column.
5618 @orgcmd{S-M-@key{left},org-columns-delete}
5619 Delete the current column.
5620 @end table
5622 @node Capturing column view,  , Using column view, Column view
5623 @subsection Capturing column view
5625 Since column view is just an overlay over a buffer, it cannot be
5626 exported or printed directly.  If you want to capture a column view, use
5627 a @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
5628 of this block looks like this:
5630 @cindex #+BEGIN, columnview
5631 @example
5632 * The column view
5633 #+BEGIN: columnview :hlines 1 :id "label"
5635 #+END:
5636 @end example
5638 @noindent This dynamic block has the following parameters:
5640 @table @code
5641 @item :id
5642 This is the most important parameter.  Column view is a feature that is
5643 often localized to a certain (sub)tree, and the capture block might be
5644 at a different location in the file.  To identify the tree whose view to
5645 capture, you can use 4 values:
5646 @cindex property, ID
5647 @example
5648 local     @r{use the tree in which the capture block is located}
5649 global    @r{make a global view, including all headings in the file}
5650 "file:@var{path-to-file}"
5651           @r{run column view at the top of this file}
5652 "@var{ID}"      @r{call column view in the tree that has an @code{:ID:}}
5653           @r{property with the value @i{label}.  You can use}
5654           @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5655           @r{the current entry and copy it to the kill-ring.}
5656 @end example
5657 @item :hlines
5658 When @code{t}, insert an hline after every line.  When a number @var{N}, insert
5659 an hline before each headline with level @code{<= @var{N}}.
5660 @item :vlines
5661 When set to @code{t}, force column groups to get vertical lines.
5662 @item :maxlevel
5663 When set to a number, don't capture entries below this level.
5664 @item :skip-empty-rows
5665 When set to @code{t}, skip rows where the only non-empty specifier of the
5666 column view is @code{ITEM}.
5668 @end table
5670 @noindent
5671 The following commands insert or update the dynamic block:
5673 @table @kbd
5674 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5675 Insert a dynamic block capturing a column view.  You will be prompted
5676 for the scope or ID of the view.
5677 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5678 Update dynamic block at point.  The cursor needs to be in the
5679 @code{#+BEGIN} line of the dynamic block.
5680 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5681 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
5682 you have several clock table blocks, column-capturing blocks or other dynamic
5683 blocks in a buffer.
5684 @end table
5686 You can add formulas to the column view table and you may add plotting
5687 instructions in front of the table---these will survive an update of the
5688 block.  If there is a @code{#+TBLFM:} after the table, the table will
5689 actually be recalculated automatically after an update.
5691 An alternative way to capture and process property values into a table is
5692 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5693 package@footnote{Contributed packages are not part of Emacs, but are
5694 distributed with the main distribution of Org (visit
5695 @uref{http://orgmode.org}).}.  It provides a general API to collect
5696 properties from entries in a certain scope, and arbitrary Lisp expressions to
5697 process these values before inserting them into a table or a dynamic block.
5699 @node Property API,  , Column view, Properties and Columns
5700 @section The Property API
5701 @cindex properties, API
5702 @cindex API, for properties
5704 There is a full API for accessing and changing properties.  This API can
5705 be used by Emacs Lisp programs to work with properties and to implement
5706 features based on them.  For more information see @ref{Using the
5707 property API}.
5709 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5710 @chapter Dates and times
5711 @cindex dates
5712 @cindex times
5713 @cindex timestamp
5714 @cindex date stamp
5716 To assist project planning, TODO items can be labeled with a date and/or
5717 a time.  The specially formatted string carrying the date and time
5718 information is called a @emph{timestamp} in Org mode.  This may be a
5719 little confusing because timestamp is often used as indicating when
5720 something was created or last changed.  However, in Org mode this term
5721 is used in a much wider sense.
5723 @menu
5724 * Timestamps::                  Assigning a time to a tree entry
5725 * Creating timestamps::         Commands which insert timestamps
5726 * Deadlines and scheduling::    Planning your work
5727 * Clocking work time::          Tracking how long you spend on a task
5728 * Effort estimates::            Planning work effort in advance
5729 * Relative timer::              Notes with a running timer
5730 * Countdown timer::             Starting a countdown timer for a task
5731 @end menu
5734 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5735 @section Timestamps, deadlines, and scheduling
5736 @cindex timestamps
5737 @cindex ranges, time
5738 @cindex date stamps
5739 @cindex deadlines
5740 @cindex scheduling
5742 A timestamp is a specification of a date (possibly with a time or a range of
5743 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5744 simplest form, the day name is optional when you type the date yourself.
5745 However, any dates inserted or modified by Org will add that day name, for
5746 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5747 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5748 date/time format.  To use an alternative format, see @ref{Custom time
5749 format}.}.  A timestamp can appear anywhere in the headline or body of an Org
5750 tree entry.  Its presence causes entries to be shown on specific dates in the
5751 agenda (@pxref{Weekly/daily agenda}).  We distinguish:
5753 @table @var
5754 @item Plain timestamp; Event; Appointment
5755 @cindex timestamp
5756 @cindex appointment
5757 A simple timestamp just assigns a date/time to an item.  This is just
5758 like writing down an appointment or event in a paper agenda.  In the
5759 timeline and agenda displays, the headline of an entry associated with a
5760 plain timestamp will be shown exactly on that date.
5762 @example
5763 * Meet Peter at the movies
5764   <2006-11-01 Wed 19:15>
5765 * Discussion on climate change
5766   <2006-11-02 Thu 20:00-22:00>
5767 @end example
5769 @item Timestamp with repeater interval
5770 @cindex timestamp, with repeater interval
5771 A timestamp may contain a @emph{repeater interval}, indicating that it
5772 applies not only on the given date, but again and again after a certain
5773 interval of N days (d), weeks (w), months (m), or years (y).  The
5774 following will show up in the agenda every Wednesday:
5776 @example
5777 * Pick up Sam at school
5778   <2007-05-16 Wed 12:30 +1w>
5779 @end example
5781 @item Diary-style sexp entries
5782 For more complex date specifications, Org mode supports using the special
5783 sexp diary entries implemented in the Emacs calendar/diary
5784 package@footnote{When working with the standard diary sexp functions, you
5785 need to be very careful with the order of the arguments.  That order depend
5786 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5787 versions, @code{european-calendar-style}).  For example, to specify a date
5788 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5789 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5790 the settings.  This has been the source of much confusion.  Org mode users
5791 can resort to special versions of these functions like @code{org-date} or
5792 @code{org-anniversary}.  These work just like the corresponding @code{diary-}
5793 functions, but with stable ISO order of arguments (year, month, day) wherever
5794 applicable, independent of the value of @code{calendar-date-style}.}.  For
5795 example with optional time
5797 @example
5798 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5799   <%%(diary-float t 4 2)>
5800 @end example
5802 @item Time/Date range
5803 @cindex timerange
5804 @cindex date range
5805 Two timestamps connected by @samp{--} denote a range.  The headline
5806 will be shown on the first and last day of the range, and on any dates
5807 that are displayed and fall in the range.  Here is an example:
5809 @example
5810 ** Meeting in Amsterdam
5811    <2004-08-23 Mon>--<2004-08-26 Thu>
5812 @end example
5814 @item Inactive timestamp
5815 @cindex timestamp, inactive
5816 @cindex inactive timestamp
5817 Just like a plain timestamp, but with square brackets instead of
5818 angular ones.  These timestamps are inactive in the sense that they do
5819 @emph{not} trigger an entry to show up in the agenda.
5821 @example
5822 * Gillian comes late for the fifth time
5823   [2006-11-01 Wed]
5824 @end example
5826 @end table
5828 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5829 @section Creating timestamps
5830 @cindex creating timestamps
5831 @cindex timestamps, creating
5833 For Org mode to recognize timestamps, they need to be in the specific
5834 format.  All commands listed below produce timestamps in the correct
5835 format.
5837 @table @kbd
5838 @orgcmd{C-c .,org-time-stamp}
5839 Prompt for a date and insert a corresponding timestamp.  When the cursor is
5840 at an existing timestamp in the buffer, the command is used to modify this
5841 timestamp instead of inserting a new one.  When this command is used twice in
5842 succession, a time range is inserted.
5844 @orgcmd{C-c !,org-time-stamp-inactive}
5845 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5846 an agenda entry.
5848 @kindex C-u C-c .
5849 @kindex C-u C-c !
5850 @item C-u C-c .
5851 @itemx C-u C-c !
5852 @vindex org-time-stamp-rounding-minutes
5853 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5854 contains date and time.  The default time can be rounded to multiples of 5
5855 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5857 @orgkey{C-c C-c}
5858 Normalize timestamp, insert/fix day name if missing or wrong.
5860 @orgcmd{C-c <,org-date-from-calendar}
5861 Insert a timestamp corresponding to the cursor date in the Calendar.
5863 @orgcmd{C-c >,org-goto-calendar}
5864 Access the Emacs calendar for the current date.  If there is a
5865 timestamp in the current line, go to the corresponding date
5866 instead.
5868 @orgcmd{C-c C-o,org-open-at-point}
5869 Access the agenda for the date given by the timestamp or -range at
5870 point (@pxref{Weekly/daily agenda}).
5872 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5873 Change date at cursor by one day.  These key bindings conflict with
5874 shift-selection and related modes (@pxref{Conflicts}).
5876 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5877 Change the item under the cursor in a timestamp.  The cursor can be on a
5878 year, month, day, hour or minute.  When the timestamp contains a time range
5879 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5880 shifting the time block with constant length.  To change the length, modify
5881 the second time.  Note that if the cursor is in a headline and not at a
5882 timestamp, these same keys modify the priority of an item.
5883 (@pxref{Priorities}).  The key bindings also conflict with shift-selection and
5884 related modes (@pxref{Conflicts}).
5886 @orgcmd{C-c C-y,org-evaluate-time-range}
5887 @cindex evaluate time range
5888 Evaluate a time range by computing the difference between start and end.
5889 With a prefix argument, insert result after the time range (in a table: into
5890 the following column).
5891 @end table
5894 @menu
5895 * The date/time prompt::        How Org mode helps you entering date and time
5896 * Custom time format::          Making dates look different
5897 @end menu
5899 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5900 @subsection The date/time prompt
5901 @cindex date, reading in minibuffer
5902 @cindex time, reading in minibuffer
5904 @vindex org-read-date-prefer-future
5905 When Org mode prompts for a date/time, the default is shown in default
5906 date/time format, and the prompt therefore seems to ask for a specific
5907 format.  But it will in fact accept date/time information in a variety of
5908 formats.  Generally, the information should start at the beginning of the
5909 string.  Org mode will find whatever information is in
5910 there and derive anything you have not specified from the @emph{default date
5911 and time}.  The default is usually the current date and time, but when
5912 modifying an existing timestamp, or when entering the second stamp of a
5913 range, it is taken from the stamp in the buffer.  When filling in
5914 information, Org mode assumes that most of the time you will want to enter a
5915 date in the future: if you omit the month/year and the given day/month is
5916 @i{before} today, it will assume that you mean a future date@footnote{See the
5917 variable @code{org-read-date-prefer-future}.  You may set that variable to
5918 the symbol @code{time} to even make a time before now shift the date to
5919 tomorrow.}.  If the date has been automatically shifted into the future, the
5920 time prompt will show this with @samp{(=>F).}
5922 For example, let's assume that today is @b{June 13, 2006}.  Here is how
5923 various inputs will be interpreted, the items filled in by Org mode are
5924 in @b{bold}.
5926 @example
5927 3-2-5         @result{} 2003-02-05
5928 2/5/3         @result{} 2003-02-05
5929 14            @result{} @b{2006}-@b{06}-14
5930 12            @result{} @b{2006}-@b{07}-12
5931 2/5           @result{} @b{2007}-02-05
5932 Fri           @result{} nearest Friday after the default date
5933 sep 15        @result{} @b{2006}-09-15
5934 feb 15        @result{} @b{2007}-02-15
5935 sep 12 9      @result{} 2009-09-12
5936 12:45         @result{} @b{2006}-@b{06}-@b{13} 12:45
5937 22 sept 0:34  @result{} @b{2006}-09-22 0:34
5938 w4            @result{} ISO week for of the current year @b{2006}
5939 2012 w4 fri   @result{} Friday of ISO week 4 in 2012
5940 2012-w04-5    @result{} Same as above
5941 @end example
5943 Furthermore you can specify a relative date by giving, as the @emph{first}
5944 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
5945 indicate change in hours, days, weeks, months, or years.  With a single plus
5946 or minus, the date is always relative to today.  With a double plus or minus,
5947 it is relative to the default date.  If instead of a single letter, you use
5948 the abbreviation of day name, the date will be the Nth such day, e.g.:
5950 @example
5951 +0            @result{} today
5952 .             @result{} today
5953 +4d           @result{} four days from today
5954 +4            @result{} same as above
5955 +2w           @result{} two weeks from today
5956 ++5           @result{} five days from default date
5957 +2tue         @result{} second Tuesday from now
5958 -wed          @result{} last Wednesday
5959 @end example
5961 @vindex parse-time-months
5962 @vindex parse-time-weekdays
5963 The function understands English month and weekday abbreviations.  If
5964 you want to use unabbreviated names and/or other languages, configure
5965 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5967 @vindex org-read-date-force-compatible-dates
5968 Not all dates can be represented in a given Emacs implementation.  By default
5969 Org mode forces dates into the compatibility range 1970--2037 which works on
5970 all Emacs implementations.  If you want to use dates outside of this range,
5971 read the docstring of the variable
5972 @code{org-read-date-force-compatible-dates}.
5974 You can specify a time range by giving start and end times or by giving a
5975 start time and a duration (in HH:MM format).  Use one or two dash(es) as the
5976 separator in the former case and use '+' as the separator in the latter
5977 case, e.g.:
5979 @example
5980 11am-1:15pm    @result{} 11:00-13:15
5981 11am--1:15pm   @result{} same as above
5982 11am+2:15      @result{} same as above
5983 @end example
5985 @cindex calendar, for selecting date
5986 @vindex org-popup-calendar-for-date-prompt
5987 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5988 you don't need/want the calendar, configure the variable
5989 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
5990 prompt, either by clicking on a date in the calendar, or by pressing
5991 @key{RET}, the date selected in the calendar will be combined with the
5992 information entered at the prompt.  You can control the calendar fully
5993 from the minibuffer:
5995 @kindex <
5996 @kindex >
5997 @kindex M-v
5998 @kindex C-v
5999 @kindex mouse-1
6000 @kindex S-@key{right}
6001 @kindex S-@key{left}
6002 @kindex S-@key{down}
6003 @kindex S-@key{up}
6004 @kindex M-S-@key{right}
6005 @kindex M-S-@key{left}
6006 @kindex @key{RET}
6007 @example
6008 @key{RET}           @r{Choose date at cursor in calendar.}
6009 mouse-1        @r{Select date by clicking on it.}
6010 S-@key{right}/@key{left}     @r{One day forward/backward.}
6011 S-@key{down}/@key{up}     @r{One week forward/backward.}
6012 M-S-@key{right}/@key{left}   @r{One month forward/backward.}
6013 > / <          @r{Scroll calendar forward/backward by one month.}
6014 M-v / C-v      @r{Scroll calendar forward/backward by 3 months.}
6015 @end example
6017 @vindex org-read-date-display-live
6018 The actions of the date/time prompt may seem complex, but I assure you they
6019 will grow on you, and you will start getting annoyed by pretty much any other
6020 way of entering a date/time out there.  To help you understand what is going
6021 on, the current interpretation of your input will be displayed live in the
6022 minibuffer@footnote{If you find this distracting, turn the display off with
6023 @code{org-read-date-display-live}.}.
6025 @node Custom time format,  , The date/time prompt, Creating timestamps
6026 @subsection Custom time format
6027 @cindex custom date/time format
6028 @cindex time format, custom
6029 @cindex date format, custom
6031 @vindex org-display-custom-times
6032 @vindex org-time-stamp-custom-formats
6033 Org mode uses the standard ISO notation for dates and times as it is
6034 defined in ISO 8601.  If you cannot get used to this and require another
6035 representation of date and time to keep you happy, you can get it by
6036 customizing the options @code{org-display-custom-times} and
6037 @code{org-time-stamp-custom-formats}.
6039 @table @kbd
6040 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6041 Toggle the display of custom formats for dates and times.
6042 @end table
6044 @noindent
6045 Org mode needs the default format for scanning, so the custom date/time
6046 format does not @emph{replace} the default format---instead it is put
6047 @emph{over} the default format using text properties.  This has the
6048 following consequences:
6049 @itemize @bullet
6050 @item
6051 You cannot place the cursor onto a timestamp anymore, only before or
6052 after.
6053 @item
6054 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6055 each component of a timestamp.  If the cursor is at the beginning of
6056 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6057 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
6058 time will be changed by one minute.
6059 @item
6060 If the timestamp contains a range of clock times or a repeater, these
6061 will not be overlaid, but remain in the buffer as they were.
6062 @item
6063 When you delete a timestamp character-by-character, it will only
6064 disappear from the buffer after @emph{all} (invisible) characters
6065 belonging to the ISO timestamp have been removed.
6066 @item
6067 If the custom timestamp format is longer than the default and you are
6068 using dates in tables, table alignment will be messed up.  If the custom
6069 format is shorter, things do work as expected.
6070 @end itemize
6073 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
6074 @section Deadlines and scheduling
6076 A timestamp may be preceded by special keywords to facilitate planning:
6078 @table @var
6079 @item DEADLINE
6080 @cindex DEADLINE keyword
6082 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6083 to be finished on that date.
6085 @vindex org-deadline-warning-days
6086 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6087 On the deadline date, the task will be listed in the agenda.  In
6088 addition, the agenda for @emph{today} will carry a warning about the
6089 approaching or missed deadline, starting
6090 @code{org-deadline-warning-days} before the due date, and continuing
6091 until the entry is marked DONE@.  An example:
6093 @example
6094 *** TODO write article about the Earth for the Guide
6095     DEADLINE: <2004-02-29 Sun>
6096     The editor in charge is [[bbdb:Ford Prefect]]
6097 @end example
6099 You can specify a different lead time for warnings for a specific
6100 deadlines using the following syntax.  Here is an example with a warning
6101 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.  This warning is
6102 deactivated if the task get scheduled and you set
6103 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6105 @item SCHEDULED
6106 @cindex SCHEDULED keyword
6108 Meaning: you are planning to start working on that task on the given
6109 date.
6111 @vindex org-agenda-skip-scheduled-if-done
6112 The headline will be listed under the given date@footnote{It will still
6113 be listed on that date after it has been marked DONE@.  If you don't like
6114 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
6115 addition, a reminder that the scheduled date has passed will be present
6116 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6117 the task will automatically be forwarded until completed.
6119 @example
6120 *** TODO Call Trillian for a date on New Years Eve.
6121     SCHEDULED: <2004-12-25 Sat>
6122 @end example
6124 @vindex org-scheduled-delay-days
6125 @vindex org-agenda-skip-scheduled-delay-if-deadline
6126 If you want to @emph{delay} the display of this task in the agenda, use
6127 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6128 25th but will appear two days later.  In case the task contains a repeater,
6129 the delay is considered to affect all occurrences; if you want the delay to
6130 only affect the first scheduled occurrence of the task, use @code{--2d}
6131 instead.  See @code{org-scheduled-delay-days} and
6132 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6133 control this globally or per agenda.
6135 @noindent
6136 @b{Important:} Scheduling an item in Org mode should @i{not} be
6137 understood in the same way that we understand @i{scheduling a meeting}.
6138 Setting a date for a meeting is just a simple appointment, you should
6139 mark this entry with a simple plain timestamp, to get this item shown
6140 on the date where it applies.  This is a frequent misunderstanding by
6141 Org users.  In Org mode, @i{scheduling} means setting a date when you
6142 want to start working on an action item.
6143 @end table
6145 You may use timestamps with repeaters in scheduling and deadline
6146 entries.  Org mode will issue early and late warnings based on the
6147 assumption that the timestamp represents the @i{nearest instance} of
6148 the repeater.  However, the use of diary sexp entries like
6150 @code{<%%(diary-float t 42)>}
6152 in scheduling and deadline timestamps is limited.  Org mode does not
6153 know enough about the internals of each sexp function to issue early and
6154 late warnings.  However, it will show the item on each day where the
6155 sexp entry matches.
6157 @menu
6158 * Inserting deadline/schedule::  Planning items
6159 * Repeated tasks::              Items that show up again and again
6160 @end menu
6162 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
6163 @subsection Inserting deadlines or schedules
6165 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6166 @samp{DEADLINE} dates are inserted on the line right below the headline.  Don't put
6167 any text between this line and the headline.} a deadline or to schedule
6168 an item:
6170 @table @kbd
6172 @orgcmd{C-c C-d,org-deadline}
6173 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will happen
6174 in the line directly following the headline.  Any CLOSED timestamp will be
6175 removed.  When called with a prefix arg, an existing deadline will be removed
6176 from the entry.  Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6177 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6178 and @code{nologredeadline}}, a note will be taken when changing an existing
6179 deadline.
6181 @orgcmd{C-c C-s,org-schedule}
6182 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
6183 happen in the line directly following the headline.  Any CLOSED timestamp
6184 will be removed.  When called with a prefix argument, remove the scheduling
6185 date from the entry.  Depending on the variable
6186 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6187 keywords @code{logreschedule}, @code{lognotereschedule}, and
6188 @code{nologreschedule}}, a note will be taken when changing an existing
6189 scheduling time.
6191 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
6192 @kindex k a
6193 @kindex k s
6194 Mark the current entry for agenda action.  After you have marked the entry
6195 like this, you can open the agenda or the calendar to find an appropriate
6196 date.  With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
6197 schedule the marked item.
6199 @orgcmd{C-c / d,org-check-deadlines}
6200 @cindex sparse tree, for deadlines
6201 @vindex org-deadline-warning-days
6202 Create a sparse tree with all deadlines that are either past-due, or
6203 which will become due within @code{org-deadline-warning-days}.
6204 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
6205 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
6206 all deadlines due tomorrow.
6208 @orgcmd{C-c / b,org-check-before-date}
6209 Sparse tree for deadlines and scheduled items before a given date.
6211 @orgcmd{C-c / a,org-check-after-date}
6212 Sparse tree for deadlines and scheduled items after a given date.
6213 @end table
6215 Note that @code{org-schedule} and @code{org-deadline} supports
6216 setting the date by indicating a relative time: e.g., +1d will set
6217 the date to the next day after today, and --1w will set the date
6218 to the previous week before any current timestamp.
6220 @node Repeated tasks,  , Inserting deadline/schedule, Deadlines and scheduling
6221 @subsection Repeated tasks
6222 @cindex tasks, repeated
6223 @cindex repeated tasks
6225 Some tasks need to be repeated again and again.  Org mode helps to
6226 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6227 or plain timestamp.  In the following example
6228 @example
6229 ** TODO Pay the rent
6230    DEADLINE: <2005-10-01 Sat +1m>
6231 @end example
6232 @noindent
6233 the @code{+1m} is a repeater; the intended interpretation is that the task
6234 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6235 from that time.  You can use yearly, monthly, weekly, daily and hourly repeat
6236 cookies by using the @code{y/w/m/d/h} letters.  If you need both a repeater
6237 and a special warning period in a deadline entry, the repeater should come
6238 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6240 @vindex org-todo-repeat-to-state
6241 Deadlines and scheduled items produce entries in the agenda when they are
6242 over-due, so it is important to be able to mark such an entry as completed
6243 once you have done so.  When you mark a DEADLINE or a SCHEDULE with the TODO
6244 keyword DONE, it will no longer produce entries in the agenda.  The problem
6245 with this is, however, that then also the @emph{next} instance of the
6246 repeated entry will not be active.  Org mode deals with this in the following
6247 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6248 shift the base date of the repeating timestamp by the repeater interval, and
6249 immediately set the entry state back to TODO@footnote{In fact, the target
6250 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6251 the variable @code{org-todo-repeat-to-state}.  If neither of these is
6252 specified, the target state defaults to the first state of the TODO state
6253 sequence.}.  In the example above, setting the state to DONE would actually
6254 switch the date like this:
6256 @example
6257 ** TODO Pay the rent
6258    DEADLINE: <2005-11-01 Tue +1m>
6259 @end example
6261 @vindex org-log-repeat
6262 A timestamp@footnote{You can change this using the option
6263 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6264 @code{lognoterepeat}, and @code{nologrepeat}.  With @code{lognoterepeat}, you
6265 will also be prompted for a note.} will be added under the deadline, to keep
6266 a record that you actually acted on the previous instance of this deadline.
6268 As a consequence of shifting the base date, this entry will no longer be
6269 visible in the agenda when checking past dates, but all future instances
6270 will be visible.
6272 With the @samp{+1m} cookie, the date shift will always be exactly one
6273 month.  So if you have not paid the rent for three months, marking this
6274 entry DONE will still keep it as an overdue deadline.  Depending on the
6275 task, this may not be the best way to handle it.  For example, if you
6276 forgot to call your father for 3 weeks, it does not make sense to call
6277 him 3 times in a single day to make up for it.  Finally, there are tasks
6278 like changing batteries which should always repeat a certain time
6279 @i{after} the last time you did it.  For these tasks, Org mode has
6280 special repeaters  @samp{++} and @samp{.+}.  For example:
6282 @example
6283 ** TODO Call Father
6284    DEADLINE: <2008-02-10 Sun ++1w>
6285    Marking this DONE will shift the date by at least one week,
6286    but also by as many weeks as it takes to get this date into
6287    the future.  However, it stays on a Sunday, even if you called
6288    and marked it done on Saturday.
6289 ** TODO Check the batteries in the smoke detectors
6290    DEADLINE: <2005-11-01 Tue .+1m>
6291    Marking this DONE will shift the date to one month after
6292    today.
6293 @end example
6295 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6296 You may have both scheduling and deadline information for a specific task.
6297 If the repeater is set for the scheduling information only, you probably want
6298 the repeater to be ignored after the deadline.  If so, set the variable
6299 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6300 @code{repeated-after-deadline}.  If you want both scheduling and deadline
6301 information to repeat after the same interval, set the same repeater for both
6302 timestamps.
6304 An alternative to using a repeater is to create a number of copies of a task
6305 subtree, with dates shifted in each copy.  The command @kbd{C-c C-x c} was
6306 created for this purpose, it is described in @ref{Structure editing}.
6309 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
6310 @section Clocking work time
6311 @cindex clocking time
6312 @cindex time clocking
6314 Org mode allows you to clock the time you spend on specific tasks in a
6315 project.  When you start working on an item, you can start the clock.  When
6316 you stop working on that task, or when you mark the task done, the clock is
6317 stopped and the corresponding time interval is recorded.  It also computes
6318 the total time spent on each subtree@footnote{Clocking only works if all
6319 headings are indented with less than 30 stars.  This is a hardcoded
6320 limitation of `lmax' in `org-clock-sum'.} of a project.  And it remembers a
6321 history or tasks recently clocked, to that you can jump quickly between a
6322 number of tasks absorbing your time.
6324 To save the clock history across Emacs sessions, use
6325 @lisp
6326 (setq org-clock-persist 'history)
6327 (org-clock-persistence-insinuate)
6328 @end lisp
6329 When you clock into a new task after resuming Emacs, the incomplete
6330 clock@footnote{To resume the clock under the assumption that you have worked
6331 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6332 will be found (@pxref{Resolving idle time}) and you will be prompted about
6333 what to do with it.
6335 @menu
6336 * Clocking commands::           Starting and stopping a clock
6337 * The clock table::             Detailed reports
6338 * Resolving idle time::         Resolving time when you've been idle
6339 @end menu
6341 @node Clocking commands, The clock table, Clocking work time, Clocking work time
6342 @subsection Clocking commands
6344 @table @kbd
6345 @orgcmd{C-c C-x C-i,org-clock-in}
6346 @vindex org-clock-into-drawer
6347 @vindex org-clock-continuously
6348 @cindex property, LOG_INTO_DRAWER
6349 Start the clock on the current item (clock-in).  This inserts the CLOCK
6350 keyword together with a timestamp.  If this is not the first clocking of
6351 this item, the multiple CLOCK lines will be wrapped into a
6352 @code{:LOGBOOK:} drawer (see also the variable
6353 @code{org-clock-into-drawer}).  You can also overrule
6354 the setting of this variable for a subtree by setting a
6355 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6356 When called with a @kbd{C-u} prefix argument,
6357 select the task from a list of recently clocked tasks.  With two @kbd{C-u
6358 C-u} prefixes, clock into the task at point and mark it as the default task;
6359 the default task will then always be available with letter @kbd{d} when
6360 selecting a clocking task.  With three @kbd{C-u C-u C-u} prefixes, force
6361 continuous clocking by starting the clock when the last clock stopped.@*
6362 @cindex property: CLOCK_MODELINE_TOTAL
6363 @cindex property: LAST_REPEAT
6364 @vindex org-clock-modeline-total
6365 While the clock is running, the current clocking time is shown in the mode
6366 line, along with the title of the task.  The clock time shown will be all
6367 time ever clocked for this task and its children.  If the task has an effort
6368 estimate (@pxref{Effort estimates}), the mode line displays the current
6369 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6370 hook a function doing this to @code{org-clock-in-prepare-hook}.}  If the task
6371 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6372 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6373 will be shown.  More control over what time is shown can be exercised with
6374 the @code{CLOCK_MODELINE_TOTAL} property.  It may have the values
6375 @code{current} to show only the current clocking instance, @code{today} to
6376 show all time clocked on this tasks today (see also the variable
6377 @code{org-extend-today-until}), @code{all} to include all time, or
6378 @code{auto} which is the default@footnote{See also the variable
6379 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6380 mode line entry will pop up a menu with clocking options.
6382 @orgcmd{C-c C-x C-o,org-clock-out}
6383 @vindex org-log-note-clock-out
6384 Stop the clock (clock-out).  This inserts another timestamp at the same
6385 location where the clock was last started.  It also directly computes
6386 the resulting time in inserts it after the time range as @samp{=>
6387 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
6388 possibility to record an additional note together with the clock-out
6389 timestamp@footnote{The corresponding in-buffer setting is:
6390 @code{#+STARTUP: lognoteclock-out}}.
6391 @orgcmd{C-c C-x C-x,org-clock-in-last}
6392 @vindex org-clock-continuously
6393 Reclock the last clocked task.  With one @kbd{C-u} prefix argument,
6394 select the task from the clock history.  With two @kbd{C-u} prefixes,
6395 force continuous clocking by starting the clock when the last clock
6396 stopped.
6397 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6398 Update the effort estimate for the current clock task.
6399 @kindex C-c C-y
6400 @kindex C-c C-c
6401 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6402 Recompute the time interval after changing one of the timestamps.  This
6403 is only necessary if you edit the timestamps directly.  If you change
6404 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6405 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6406 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6407 clock duration keeps the same.
6408 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6409 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6410 the one of the previous (or the next clock) timestamp by the same duration.
6411 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6412 by five minutes, then the clocked-in timestamp of the next clock will be
6413 increased by five minutes.
6414 @orgcmd{C-c C-t,org-todo}
6415 Changing the TODO state of an item to DONE automatically stops the clock
6416 if it is running in this same item.
6417 @orgcmd{C-c C-x C-q,org-clock-cancel}
6418 Cancel the current clock.  This is useful if a clock was started by
6419 mistake, or if you ended up working on something else.
6420 @orgcmd{C-c C-x C-j,org-clock-goto}
6421 Jump to the headline of the currently clocked in task.  With a @kbd{C-u}
6422 prefix arg, select the target task from a list of recently clocked tasks.
6423 @orgcmd{C-c C-x C-d,org-clock-display}
6424 @vindex org-remove-highlights-with-change
6425 Display time summaries for each subtree in the current buffer.  This puts
6426 overlays at the end of each headline, showing the total time recorded under
6427 that heading, including the time of any subheadings.  You can use visibility
6428 cycling to study the tree, but the overlays disappear when you change the
6429 buffer (see variable @code{org-remove-highlights-with-change}) or press
6430 @kbd{C-c C-c}.
6431 @end table
6433 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6434 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6435 worked on or closed during a day.
6437 @strong{Important:} note that both @code{org-clock-out} and
6438 @code{org-clock-in-last} can have a global keybinding and will not
6439 modify the window disposition.
6441 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6442 @subsection The clock table
6443 @cindex clocktable, dynamic block
6444 @cindex report, of clocked time
6446 Org mode can produce quite complex reports based on the time clocking
6447 information.  Such a report is called a @emph{clock table}, because it is
6448 formatted as one or several Org tables.
6450 @table @kbd
6451 @orgcmd{C-c C-x C-r,org-clock-report}
6452 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6453 report as an Org mode table into the current file.  When the cursor is
6454 at an existing clock table, just update it.  When called with a prefix
6455 argument, jump to the first clock report in the current document and
6456 update it.  The clock table always includes also trees with
6457 @code{:ARCHIVE:} tag.
6458 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6459 Update dynamic block at point.  The cursor needs to be in the
6460 @code{#+BEGIN} line of the dynamic block.
6461 @orgkey{C-u C-c C-x C-u}
6462 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
6463 you have several clock table blocks in a buffer.
6464 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6465 Shift the current @code{:block} interval and update the table.  The cursor
6466 needs to be in the @code{#+BEGIN: clocktable} line for this command.  If
6467 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6468 @end table
6471 Here is an example of the frame for a clock table as it is inserted into the
6472 buffer with the @kbd{C-c C-x C-r} command:
6474 @cindex #+BEGIN, clocktable
6475 @example
6476 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6477 #+END: clocktable
6478 @end example
6479 @noindent
6480 @vindex org-clocktable-defaults
6481 The @samp{BEGIN} line and specify a number of options to define the scope,
6482 structure, and formatting of the report.  Defaults for all these options can
6483 be configured in the variable @code{org-clocktable-defaults}.
6485 @noindent First there are options that determine which clock entries are to
6486 be selected:
6487 @example
6488 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
6489              @r{Clocks at deeper levels will be summed into the upper level.}
6490 :scope       @r{The scope to consider.  This can be any of the following:}
6491              nil        @r{the current buffer or narrowed region}
6492              file       @r{the full current buffer}
6493              subtree    @r{the subtree where the clocktable is located}
6494              tree@var{N}      @r{the surrounding level @var{N} tree, for example @code{tree3}}
6495              tree       @r{the surrounding level 1 tree}
6496              agenda     @r{all agenda files}
6497              ("file"..) @r{scan these files}
6498              file-with-archives    @r{current file and its archives}
6499              agenda-with-archives  @r{all agenda files, including archives}
6500 :block       @r{The time block to consider.  This block is specified either}
6501              @r{absolute, or relative to the current time and may be any of}
6502              @r{these formats:}
6503              2007-12-31    @r{New year eve 2007}
6504              2007-12       @r{December 2007}
6505              2007-W50      @r{ISO-week 50 in 2007}
6506              2007-Q2       @r{2nd quarter in 2007}
6507              2007          @r{the year 2007}
6508              today, yesterday, today-@var{N}          @r{a relative day}
6509              thisweek, lastweek, thisweek-@var{N}     @r{a relative week}
6510              thismonth, lastmonth, thismonth-@var{N}  @r{a relative month}
6511              thisyear, lastyear, thisyear-@var{N}     @r{a relative year}
6512              @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6513 :tstart      @r{A time string specifying when to start considering times.}
6514              @r{Relative times like @code{"<-2w>"} can also be used.  See}
6515              @r{@ref{Matching tags and properties} for relative time syntax.}
6516 :tend        @r{A time string specifying when to stop considering times.}
6517              @r{Relative times like @code{"<now>"} can also be used.  See}
6518              @r{@ref{Matching tags and properties} for relative time syntax.}
6519 :wstart      @r{The starting day of the week.  The default is 1 for monday.}
6520 :mstart      @r{The starting day of the month.  The default 1 is for the first}
6521              @r{day of the month.}
6522 :step        @r{@code{week} or @code{day}, to split the table into chunks.}
6523              @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6524 :stepskip0   @r{Do not show steps that have zero time.}
6525 :fileskip0   @r{Do not show table sections from files which did not contribute.}
6526 :tags        @r{A tags match to select entries that should contribute.  See}
6527              @r{@ref{Matching tags and properties} for the match syntax.}
6528 @end example
6530 Then there are options which determine the formatting of the table.  There
6531 options are interpreted by the function @code{org-clocktable-write-default},
6532 but you can specify your own function using the @code{:formatter} parameter.
6533 @example
6534 :emphasize   @r{When @code{t}, emphasize level one and level two items.}
6535 :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".}
6536 :link        @r{Link the item headlines in the table to their origins.}
6537 :narrow      @r{An integer to limit the width of the headline column in}
6538              @r{the org table.  If you write it like @samp{50!}, then the}
6539              @r{headline will also be shortened in export.}
6540 :indent      @r{Indent each headline field according to its level.}
6541 :tcolumns    @r{Number of columns to be used for times.  If this is smaller}
6542              @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6543 :level       @r{Should a level number column be included?}
6544 :compact     @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6545              @r{All are overwritten except if there is an explicit @code{:narrow}}
6546 :timestamp   @r{A timestamp for the entry, when available.  Look for SCHEDULED,}
6547              @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6548 :properties  @r{List of properties that should be shown in the table.  Each}
6549              @r{property will get its own column.}
6550 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6551 :formula     @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6552              @r{As a special case, @samp{:formula %} adds a column with % time.}
6553              @r{If you do not specify a formula here, any existing formula}
6554              @r{below the clock table will survive updates and be evaluated.}
6555 :formatter   @r{A function to format clock data and insert it into the buffer.}
6556 @end example
6557 To get a clock summary of the current level 1 tree, for the current
6558 day, you could write
6559 @example
6560 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6561 #+END: clocktable
6562 @end example
6563 @noindent
6564 and to use a specific time range you could write@footnote{Note that all
6565 parameters must be specified in a single line---the line is broken here
6566 only to fit it into the manual.}
6567 @example
6568 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6569                     :tend "<2006-08-10 Thu 12:00>"
6570 #+END: clocktable
6571 @end example
6572 A range starting a week ago and ending right now could be written as
6573 @example
6574 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6575 #+END: clocktable
6576 @end example
6577 A summary of the current subtree with % times would be
6578 @example
6579 #+BEGIN: clocktable :scope subtree :link t :formula %
6580 #+END: clocktable
6581 @end example
6582 A horizontally compact representation of everything clocked during last week
6583 would be
6584 @example
6585 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6586 #+END: clocktable
6587 @end example
6589 @node Resolving idle time,  , The clock table, Clocking work time
6590 @subsection Resolving idle time and continuous clocking
6592 @subsubheading Resolving idle time
6593 @cindex resolve idle time
6594 @vindex org-clock-x11idle-program-name
6596 @cindex idle, resolve, dangling
6597 If you clock in on a work item, and then walk away from your
6598 computer---perhaps to take a phone call---you often need to ``resolve'' the
6599 time you were away by either subtracting it from the current clock, or
6600 applying it to another one.
6602 @vindex org-clock-idle-time
6603 By customizing the variable @code{org-clock-idle-time} to some integer, such
6604 as 10 or 15, Emacs can alert you when you get back to your computer after
6605 being idle for that many minutes@footnote{On computers using Mac OS X,
6606 idleness is based on actual user idleness, not just Emacs' idle time.  For
6607 X11, you can install a utility program @file{x11idle.c}, available in the
6608 @code{contrib/scripts} directory of the Org git distribution, or install the
6609 @file{xprintidle} package and set it to the variable
6610 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6611 same general treatment of idleness.  On other systems, idle time refers to
6612 Emacs idle time only.}, and ask what you want to do with the idle time.
6613 There will be a question waiting for you when you get back, indicating how
6614 much idle time has passed (constantly updated with the current amount), as
6615 well as a set of choices to correct the discrepancy:
6617 @table @kbd
6618 @item k
6619 To keep some or all of the minutes and stay clocked in, press @kbd{k}.  Org
6620 will ask how many of the minutes to keep.  Press @key{RET} to keep them all,
6621 effectively changing nothing, or enter a number to keep that many minutes.
6622 @item K
6623 If you use the shift key and press @kbd{K}, it will keep however many minutes
6624 you request and then immediately clock out of that task.  If you keep all of
6625 the minutes, this is the same as just clocking out of the current task.
6626 @item s
6627 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6628 the clock, and then check back in from the moment you returned.
6629 @item S
6630 To keep none of the minutes and just clock out at the start of the away time,
6631 use the shift key and press @kbd{S}.  Remember that using shift will always
6632 leave you clocked out, no matter which option you choose.
6633 @item C
6634 To cancel the clock altogether, use @kbd{C}.  Note that if instead of
6635 canceling you subtract the away time, and the resulting clock amount is less
6636 than a minute, the clock will still be canceled rather than clutter up the
6637 log with an empty entry.
6638 @end table
6640 What if you subtracted those away minutes from the current clock, and now
6641 want to apply them to a new clock?  Simply clock in to any task immediately
6642 after the subtraction.  Org will notice that you have subtracted time ``on
6643 the books'', so to speak, and will ask if you want to apply those minutes to
6644 the next task you clock in on.
6646 There is one other instance when this clock resolution magic occurs.  Say you
6647 were clocked in and hacking away, and suddenly your cat chased a mouse who
6648 scared a hamster that crashed into your UPS's power button!  You suddenly
6649 lose all your buffers, but thanks to auto-save you still have your recent Org
6650 mode changes, including your last clock in.
6652 If you restart Emacs and clock into any task, Org will notice that you have a
6653 dangling clock which was never clocked out from your last session.  Using
6654 that clock's starting time as the beginning of the unaccounted-for period,
6655 Org will ask how you want to resolve that time.  The logic and behavior is
6656 identical to dealing with away time due to idleness; it is just happening due
6657 to a recovery event rather than a set amount of idle time.
6659 You can also check all the files visited by your Org agenda for dangling
6660 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6662 @subsubheading Continuous clocking
6663 @cindex continuous clocking
6664 @vindex org-clock-continuously
6666 You may want to start clocking from the time when you clocked out the
6667 previous task.  To enable this systematically, set @code{org-clock-continuously}
6668 to @code{t}.  Each time you clock in, Org retrieves the clock-out time of the
6669 last clocked entry for this session, and start the new clock from there.
6671 If you only want this from time to time, use three universal prefix arguments
6672 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6674 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6675 @section Effort estimates
6676 @cindex effort estimates
6678 @cindex property, Effort
6679 @vindex org-effort-property
6680 If you want to plan your work in a very detailed way, or if you need to
6681 produce offers with quotations of the estimated work effort, you may want to
6682 assign effort estimates to entries.  If you are also clocking your work, you
6683 may later want to compare the planned effort with the actual working time, a
6684 great way to improve planning estimates.  Effort estimates are stored in a
6685 special property @samp{Effort}@footnote{You may change the property being
6686 used with the variable @code{org-effort-property}.}.  You can set the effort
6687 for an entry with the following commands:
6689 @table @kbd
6690 @orgcmd{C-c C-x e,org-set-effort}
6691 Set the effort estimate for the current entry.  With a numeric prefix
6692 argument, set it to the Nth allowed value (see below).  This command is also
6693 accessible from the agenda with the @kbd{e} key.
6694 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6695 Modify the effort estimate of the item currently being clocked.
6696 @end table
6698 Clearly the best way to work with effort estimates is through column view
6699 (@pxref{Column view}).  You should start by setting up discrete values for
6700 effort estimates, and a @code{COLUMNS} format that displays these values
6701 together with clock sums (if you want to clock your time).  For a specific
6702 buffer you can use
6704 @example
6705 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6706 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6707 @end example
6709 @noindent
6710 @vindex org-global-properties
6711 @vindex org-columns-default-format
6712 or, even better, you can set up these values globally by customizing the
6713 variables @code{org-global-properties} and @code{org-columns-default-format}.
6714 In particular if you want to use this setup also in the agenda, a global
6715 setup may be advised.
6717 The way to assign estimates to individual items is then to switch to column
6718 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6719 value.  The values you enter will immediately be summed up in the hierarchy.
6720 In the column next to it, any clocked time will be displayed.
6722 @vindex org-agenda-columns-add-appointments-to-effort-sum
6723 If you switch to column view in the daily/weekly agenda, the effort column
6724 will summarize the estimated work effort for each day@footnote{Please note
6725 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6726 column view}).}, and you can use this to find space in your schedule.  To get
6727 an overview of the entire part of the day that is committed, you can set the
6728 option @code{org-agenda-columns-add-appointments-to-effort-sum}.  The
6729 appointments on a day that take place over a specified time interval will
6730 then also be added to the load estimate of the day.
6732 Effort estimates can be used in secondary agenda filtering that is triggered
6733 with the @kbd{/} key in the agenda (@pxref{Agenda commands}).  If you have
6734 these estimates defined consistently, two or three key presses will narrow
6735 down the list to stuff that fits into an available time slot.
6737 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6738 @section Taking notes with a relative timer
6739 @cindex relative timer
6741 When taking notes during, for example, a meeting or a video viewing, it can
6742 be useful to have access to times relative to a starting time.  Org provides
6743 such a relative timer and make it easy to create timed notes.
6745 @table @kbd
6746 @orgcmd{C-c C-x .,org-timer}
6747 Insert a relative time into the buffer.  The first time you use this, the
6748 timer will be started.  When called with a prefix argument, the timer is
6749 restarted.
6750 @orgcmd{C-c C-x -,org-timer-item}
6751 Insert a description list item with the current relative time.  With a prefix
6752 argument, first reset the timer to 0.
6753 @orgcmd{M-@key{RET},org-insert-heading}
6754 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6755 new timer items.
6756 @c for key sequences with a comma, command name macros fail :(
6757 @kindex C-c C-x ,
6758 @item C-c C-x ,
6759 Pause the timer, or continue it if it is already paused
6760 (@command{org-timer-pause-or-continue}).
6761 @c removed the sentence because it is redundant to the following item
6762 @kindex C-u C-c C-x ,
6763 @item C-u C-c C-x ,
6764 Stop the timer.  After this, you can only start a new timer, not continue the
6765 old one.  This command also removes the timer from the mode line.
6766 @orgcmd{C-c C-x 0,org-timer-start}
6767 Reset the timer without inserting anything into the buffer.  By default, the
6768 timer is reset to 0.  When called with a @kbd{C-u} prefix, reset the timer to
6769 specific starting offset.  The user is prompted for the offset, with a
6770 default taken from a timer string at point, if any, So this can be used to
6771 restart taking notes after a break in the process.  When called with a double
6772 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6773 by a certain amount.  This can be used to fix timer strings if the timer was
6774 not started at exactly the right moment.
6775 @end table
6777 @node Countdown timer,  , Relative timer, Dates and Times
6778 @section Countdown timer
6779 @cindex Countdown timer
6780 @kindex C-c C-x ;
6781 @kindex ;
6783 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6784 timer.  Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6786 @code{org-timer-set-timer} prompts the user for a duration and displays a
6787 countdown timer in the modeline.  @code{org-timer-default-timer} sets the
6788 default countdown value.  Giving a prefix numeric argument overrides this
6789 default value.
6791 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6792 @chapter Capture - Refile - Archive
6793 @cindex capture
6795 An important part of any organization system is the ability to quickly
6796 capture new ideas and tasks, and to associate reference material with them.
6797 Org does this using a process called @i{capture}.  It also can store files
6798 related to a task (@i{attachments}) in a special directory.  Once in the
6799 system, tasks and projects need to be moved around.  Moving completed project
6800 trees to an archive file keeps the system compact and fast.
6802 @menu
6803 * Capture::                     Capturing new stuff
6804 * Attachments::                 Add files to tasks
6805 * RSS Feeds::                   Getting input from RSS feeds
6806 * Protocols::                   External (e.g., Browser) access to Emacs and Org
6807 * Refile and copy::             Moving/copying a tree from one place to another
6808 * Archiving::                   What to do with finished projects
6809 @end menu
6811 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6812 @section Capture
6813 @cindex capture
6815 Capture lets you quickly store notes with little interruption of your work
6816 flow.  Org's method for capturing new items is heavily inspired by John
6817 Wiegley excellent @file{remember.el} package.  Up to version 6.36, Org
6818 used a special setup for @file{remember.el}, then replaced it with
6819 @file{org-remember.el}.  As of version 8.0, @file{org-remember.el} has
6820 been completely replaced by @file{org-capture.el}.
6822 If your configuration depends on @file{org-remember.el}, you need to update
6823 it and use the setup described below.  To convert your
6824 @code{org-remember-templates}, run the command
6825 @example
6826 @kbd{M-x org-capture-import-remember-templates RET}
6827 @end example
6828 @noindent and then customize the new variable with @kbd{M-x
6829 customize-variable org-capture-templates}, check the result, and save the
6830 customization.
6832 @menu
6833 * Setting up capture::          Where notes will be stored
6834 * Using capture::               Commands to invoke and terminate capture
6835 * Capture templates::           Define the outline of different note types
6836 @end menu
6838 @node Setting up capture, Using capture, Capture, Capture
6839 @subsection Setting up capture
6841 The following customization sets a default target file for notes, and defines
6842 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6843 suggestion.}  for capturing new material.
6845 @vindex org-default-notes-file
6846 @smalllisp
6847 @group
6848 (setq org-default-notes-file (concat org-directory "/notes.org"))
6849 (define-key global-map "\C-cc" 'org-capture)
6850 @end group
6851 @end smalllisp
6853 @node Using capture, Capture templates, Setting up capture, Capture
6854 @subsection Using capture
6856 @table @kbd
6857 @orgcmd{C-c c,org-capture}
6858 Call the command @code{org-capture}.  Note that this keybinding is global and
6859 not active by default: you need to install it.  If you have templates
6860 @cindex date tree
6861 defined @pxref{Capture templates}, it will offer these templates for
6862 selection or use a new Org outline node as the default template.  It will
6863 insert the template into the target file and switch to an indirect buffer
6864 narrowed to this new node.  You may then insert the information you want.
6866 @orgcmd{C-c C-c,org-capture-finalize}
6867 Once you have finished entering information into the capture buffer, @kbd{C-c
6868 C-c} will return you to the window configuration before the capture process,
6869 so that you can resume your work without further distraction.  When called
6870 with a prefix arg, finalize and then jump to the captured item.
6872 @orgcmd{C-c C-w,org-capture-refile}
6873 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6874 a different place.  Please realize that this is a normal refiling command
6875 that will be executed---so the cursor position at the moment you run this
6876 command is important.  If you have inserted a tree with a parent and
6877 children, first move the cursor back to the parent.  Any prefix argument
6878 given to this command will be passed on to the @code{org-refile} command.
6880 @orgcmd{C-c C-k,org-capture-kill}
6881 Abort the capture process and return to the previous state.
6883 @end table
6885 You can also call @code{org-capture} in a special way from the agenda, using
6886 the @kbd{k c} key combination.  With this access, any timestamps inserted by
6887 the selected capture template will default to the cursor date in the agenda,
6888 rather than to the current date.
6890 To find the locations of the last stored capture, use @code{org-capture} with
6891 prefix commands:
6893 @table @kbd
6894 @orgkey{C-u C-c c}
6895 Visit the target location of a capture template.  You get to select the
6896 template in the usual way.
6897 @orgkey{C-u C-u C-c c}
6898 Visit the last stored capture item in its buffer.
6899 @end table
6901 @vindex org-capture-bookmark
6902 @cindex org-capture-last-stored
6903 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6904 automatically be created unless you set @code{org-capture-bookmark} to
6905 @code{nil}.
6907 To insert the capture at point in an Org buffer, call @code{org-capture} with
6908 a @code{C-0} prefix argument.
6910 @node Capture templates,  , Using capture, Capture
6911 @subsection Capture templates
6912 @cindex templates, for Capture
6914 You can use templates for different types of capture items, and
6915 for different target locations.  The easiest way to create such templates is
6916 through the customize interface.
6918 @table @kbd
6919 @orgkey{C-c c C}
6920 Customize the variable @code{org-capture-templates}.
6921 @end table
6923 Before we give the formal description of template definitions, let's look at
6924 an example.  Say you would like to use one template to create general TODO
6925 entries, and you want to put these entries under the heading @samp{Tasks} in
6926 your file @file{~/org/gtd.org}.  Also, a date tree in the file
6927 @file{journal.org} should capture journal entries.  A possible configuration
6928 would look like:
6930 @smalllisp
6931 @group
6932 (setq org-capture-templates
6933  '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6934         "* TODO %?\n  %i\n  %a")
6935    ("j" "Journal" entry (file+datetree "~/org/journal.org")
6936         "* %?\nEntered on %U\n  %i\n  %a")))
6937 @end group
6938 @end smalllisp
6940 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6941 for you like this:
6942 @example
6943 * TODO
6944   [[file:@var{link to where you initiated capture}]]
6945 @end example
6947 @noindent
6948 During expansion of the template, @code{%a} has been replaced by a link to
6949 the location from where you called the capture command.  This can be
6950 extremely useful for deriving tasks from emails, for example.  You fill in
6951 the task definition, press @kbd{C-c C-c} and Org returns you to the same
6952 place where you started the capture process.
6954 To define special keys to capture to a particular template without going
6955 through the interactive template selection, you can create your key binding
6956 like this:
6958 @lisp
6959 (define-key global-map "\C-cx"
6960    (lambda () (interactive) (org-capture nil "x")))
6961 @end lisp
6963 @menu
6964 * Template elements::           What is needed for a complete template entry
6965 * Template expansion::          Filling in information about time and context
6966 * Templates in contexts::       Only show a template in a specific context
6967 @end menu
6969 @node Template elements, Template expansion, Capture templates, Capture templates
6970 @subsubsection Template elements
6972 Now lets look at the elements of a template definition.  Each entry in
6973 @code{org-capture-templates} is a list with the following items:
6975 @table @var
6976 @item keys
6977 The keys that will select the template, as a string, characters
6978 only, for example @code{"a"} for a template to be selected with a
6979 single key, or @code{"bt"} for selection with two keys.  When using
6980 several keys, keys using the same prefix key must be sequential
6981 in the list and preceded by a 2-element entry explaining the
6982 prefix key, for example
6983 @smalllisp
6984          ("b" "Templates for marking stuff to buy")
6985 @end smalllisp
6986 @noindent If you do not define a template for the @kbd{C} key, this key will
6987 be used to open the customize buffer for this complex variable.
6989 @item description
6990 A short string describing the template, which will be shown during
6991 selection.
6993 @item type
6994 The type of entry, a symbol.  Valid values are:
6996 @table @code
6997 @item entry
6998 An Org mode node, with a headline.  Will be filed as the child of the target
6999 entry or as a top-level entry.  The target file should be an Org mode file.
7000 @item item
7001 A plain list item, placed in the first plain  list at the target
7002 location.  Again the target file should be an Org file.
7003 @item checkitem
7004 A checkbox item.  This only differs from the plain list item by the
7005 default template.
7006 @item table-line
7007 a new line in the first table at the target location.  Where exactly the
7008 line will be inserted depends on the properties @code{:prepend} and
7009 @code{:table-line-pos} (see below).
7010 @item plain
7011 Text to be inserted as it is.
7012 @end table
7014 @item target
7015 @vindex org-default-notes-file
7016 Specification of where the captured item should be placed.  In Org mode
7017 files, targets usually define a node.  Entries will become children of this
7018 node.  Other types will be added to the table or list in the body of this
7019 node.  Most target specifications contain a file name.  If that file name is
7020 the empty string, it defaults to @code{org-default-notes-file}.  A file can
7021 also be given as a variable, function, or Emacs Lisp form.
7023 Valid values are:
7025 @table @code
7026 @item (file "path/to/file")
7027 Text will be placed at the beginning or end of that file.
7029 @item (id "id of existing org entry")
7030 Filing as child of this entry, or in the body of the entry.
7032 @item (file+headline "path/to/file" "node headline")
7033 Fast configuration if the target heading is unique in the file.
7035 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7036 For non-unique headings, the full path is safer.
7038 @item (file+regexp  "path/to/file" "regexp to find location")
7039 Use a regular expression to position the cursor.
7041 @item (file+datetree "path/to/file")
7042 Will create a heading in a date tree for today's date@footnote{Datetree
7043 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7044 and @code{* 2013} in your file, the capture will refile the note to the first
7045 one matched.}.
7047 @item (file+datetree+prompt "path/to/file")
7048 Will create a heading in a date tree, but will prompt for the date.
7050 @item (file+function "path/to/file" function-finding-location)
7051 A function to find the right location in the file.
7053 @item (clock)
7054 File to the entry that is currently being clocked.
7056 @item (function function-finding-location)
7057 Most general way, write your own function to find both
7058 file and location.
7059 @end table
7061 @item template
7062 The template for creating the capture item.  If you leave this empty, an
7063 appropriate default template will be used.  Otherwise this is a string with
7064 escape codes, which will be replaced depending on time and context of the
7065 capture call.  The string with escapes may be loaded from a template file,
7066 using the special syntax @code{(file "path/to/template")}.  See below for
7067 more details.
7069 @item properties
7070 The rest of the entry is a property list of additional options.
7071 Recognized properties are:
7073 @table @code
7074 @item :prepend
7075 Normally new captured information will be appended at
7076 the target location (last child, last table line, last list item...).
7077 Setting this property will change that.
7079 @item :immediate-finish
7080 When set, do not offer to edit the information, just
7081 file it away immediately.  This makes sense if the template only needs
7082 information that can be added automatically.
7084 @item :empty-lines
7085 Set this to the number of lines to insert
7086 before and after the new item.  Default 0, only common other value is 1.
7088 @item :clock-in
7089 Start the clock in this item.
7091 @item :clock-keep
7092 Keep the clock running when filing the captured entry.
7094 @item :clock-resume
7095 If starting the capture interrupted a clock, restart that clock when finished
7096 with the capture.  Note that @code{:clock-keep} has precedence over
7097 @code{:clock-resume}.  When setting both to @code{t}, the current clock will
7098 run and the previous one will not be resumed.
7100 @item :unnarrowed
7101 Do not narrow the target buffer, simply show the full buffer.  Default is to
7102 narrow it so that you only see the new material.
7104 @item :table-line-pos
7105 Specification of the location in the table where the new line should be
7106 inserted.  It should be a string like @code{"II-3"} meaning that the new
7107 line should become the third line before the second horizontal separator
7108 line.
7110 @item :kill-buffer
7111 If the target file was not yet visited when capture was invoked, kill the
7112 buffer again after capture is completed.
7113 @end table
7114 @end table
7116 @node Template expansion, Templates in contexts, Template elements, Capture templates
7117 @subsubsection Template expansion
7119 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7120 these sequences literally, escape the @kbd{%} with a backslash.} allow
7121 dynamic insertion of content.  The templates are expanded in the order given here:
7123 @smallexample
7124 %[@var{file}]     @r{Insert the contents of the file given by @var{file}.}
7125 %(@var{sexp})     @r{Evaluate Elisp @var{sexp} and replace with the result.}
7126                   @r{For convenience, %:keyword (see below) placeholders}
7127                   @r{within the expression will be expanded prior to this.}
7128                   @r{The sexp must return a string.}
7129 %<...>      @r{The result of format-time-string on the ... format specification.}
7130 %t          @r{Timestamp, date only.}
7131 %T          @r{Timestamp, with date and time.}
7132 %u, %U      @r{Like the above, but inactive timestamps.}
7133 %i          @r{Initial content, the region when capture is called while the}
7134             @r{region is active.}
7135             @r{The entire text will be indented like @code{%i} itself.}
7136 %a          @r{Annotation, normally the link created with @code{org-store-link}.}
7137 %A          @r{Like @code{%a}, but prompt for the description part.}
7138 %l          @r{Like %a, but only insert the literal link.}
7139 %c          @r{Current kill ring head.}
7140 %x          @r{Content of the X clipboard.}
7141 %k          @r{Title of the currently clocked task.}
7142 %K          @r{Link to the currently clocked task.}
7143 %n          @r{User name (taken from @code{user-full-name}).}
7144 %f          @r{File visited by current buffer when org-capture was called.}
7145 %F          @r{Full path of the file or directory visited by current buffer.}
7146 %:keyword   @r{Specific information for certain link types, see below.}
7147 %^g         @r{Prompt for tags, with completion on tags in target file.}
7148 %^G         @r{Prompt for tags, with completion all tags in all agenda files.}
7149 %^t         @r{Like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7150             @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7151 %^C         @r{Interactive selection of which kill or clip to use.}
7152 %^L         @r{Like @code{%^C}, but insert as link.}
7153 %^@{@var{prop}@}p   @r{Prompt the user for a value for property @var{prop}.}
7154 %^@{@var{prompt}@}  @r{prompt the user for a string and replace this sequence with it.}
7155             @r{You may specify a default value and a completion table with}
7156             @r{%^@{prompt|default|completion2|completion3...@}.}
7157             @r{The arrow keys access a prompt-specific history.}
7158 %\n         @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7159             @r{a number, starting from 1.}
7160 %?          @r{After completing the template, position cursor here.}
7161 @end smallexample
7163 @noindent
7164 For specific link types, the following keywords will be
7165 defined@footnote{If you define your own link types (@pxref{Adding
7166 hyperlink types}), any property you store with
7167 @code{org-store-link-props} can be accessed in capture templates in a
7168 similar way.}:
7170 @vindex org-from-is-user-regexp
7171 @smallexample
7172 Link type                        |  Available keywords
7173 ---------------------------------+----------------------------------------------
7174 bbdb                             |  %:name %:company
7175 irc                              |  %:server %:port %:nick
7176 vm, vm-imap, wl, mh, mew, rmail  |  %:type %:subject %:message-id
7177                                  |  %:from %:fromname %:fromaddress
7178                                  |  %:to   %:toname   %:toaddress
7179                                  |  %:date @r{(message date header field)}
7180                                  |  %:date-timestamp @r{(date as active timestamp)}
7181                                  |  %:date-timestamp-inactive @r{(date as inactive timestamp)}
7182                                  |  %: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}.}}
7183 gnus                             |  %:group, @r{for messages also all email fields}
7184 w3, w3m                          |  %:url
7185 info                             |  %:file %:node
7186 calendar                         |  %:date
7187 @end smallexample
7189 @noindent
7190 To place the cursor after template expansion use:
7192 @smallexample
7193 %?          @r{After completing the template, position cursor here.}
7194 @end smallexample
7196 @node Templates in contexts,  , Template expansion, Capture templates
7197 @subsubsection Templates in contexts
7199 @vindex org-capture-templates-contexts
7200 To control whether a capture template should be accessible from a specific
7201 context, you can customize @code{org-capture-templates-contexts}.  Let's say
7202 for example that you have a capture template @code{"p"} for storing Gnus
7203 emails containing patches.  Then you would configure this option like this:
7205 @smalllisp
7206 (setq org-capture-templates-contexts
7207       '(("p" (in-mode . "message-mode"))))
7208 @end smalllisp
7210 You can also tell that the command key @code{"p"} should refer to another
7211 template.  In that case, add this command key like this:
7213 @smalllisp
7214 (setq org-capture-templates-contexts
7215       '(("p" "q" (in-mode . "message-mode"))))
7216 @end smalllisp
7218 See the docstring of the variable for more information.
7220 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
7221 @section Attachments
7222 @cindex attachments
7224 @vindex org-attach-directory
7225 It is often useful to associate reference material with an outline node/task.
7226 Small chunks of plain text can simply be stored in the subtree of a project.
7227 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7228 files that live elsewhere on your computer or in the cloud, like emails or
7229 source code files belonging to a project.  Another method is @i{attachments},
7230 which are files located in a directory belonging to an outline node.  Org
7231 uses directories named by the unique ID of each entry.  These directories are
7232 located in the @file{data} directory which lives in the same directory where
7233 your Org file lives@footnote{If you move entries or Org files from one
7234 directory to another, you may want to configure @code{org-attach-directory}
7235 to contain an absolute path.}.  If you initialize this directory with
7236 @code{git init}, Org will automatically commit changes when it sees them.
7237 The attachment system has been contributed to Org by John Wiegley.
7239 In cases where it seems better to do so, you can also attach a directory of your
7240 choice to an entry.  You can also make children inherit the attachment
7241 directory from a parent, so that an entire subtree uses the same attached
7242 directory.
7244 @noindent The following commands deal with attachments:
7246 @table @kbd
7247 @orgcmd{C-c C-a,org-attach}
7248 The dispatcher for commands related to the attachment system.  After these
7249 keys, a list of commands is displayed and you must press an additional key
7250 to select a command:
7252 @table @kbd
7253 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7254 @vindex org-attach-method
7255 Select a file and move it into the task's attachment directory.  The file
7256 will be copied, moved, or linked, depending on @code{org-attach-method}.
7257 Note that hard links are not supported on all systems.
7259 @kindex C-c C-a c
7260 @kindex C-c C-a m
7261 @kindex C-c C-a l
7262 @item c/m/l
7263 Attach a file using the copy/move/link method.
7264 Note that hard links are not supported on all systems.
7266 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7267 Create a new attachment as an Emacs buffer.
7269 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7270 Synchronize the current task with its attachment directory, in case you added
7271 attachments yourself.
7273 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7274 @vindex org-file-apps
7275 Open current task's attachment.  If there is more than one, prompt for a
7276 file name first.  Opening will follow the rules set by @code{org-file-apps}.
7277 For more details, see the information on following hyperlinks
7278 (@pxref{Handling links}).
7280 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7281 Also open the attachment, but force opening the file in Emacs.
7283 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7284 Open the current task's attachment directory.
7286 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7287 Also open the directory, but force using @command{dired} in Emacs.
7289 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7290 Select and delete a single attachment.
7292 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7293 Delete all of a task's attachments.  A safer way is to open the directory in
7294 @command{dired} and delete from there.
7296 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7297 @cindex property, ATTACH_DIR
7298 Set a specific directory as the entry's attachment directory.  This works by
7299 putting the directory path into the @code{ATTACH_DIR} property.
7301 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7302 @cindex property, ATTACH_DIR_INHERIT
7303 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7304 same directory for attachments as the parent does.
7305 @end table
7306 @end table
7308 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
7309 @section RSS feeds
7310 @cindex RSS feeds
7311 @cindex Atom feeds
7313 Org can add and change entries based on information found in RSS feeds and
7314 Atom feeds.  You could use this to make a task out of each new podcast in a
7315 podcast feed.  Or you could use a phone-based note-creating service on the
7316 web to import tasks into Org.  To access feeds, configure the variable
7317 @code{org-feed-alist}.  The docstring of this variable has detailed
7318 information.  Here is just an example:
7320 @smalllisp
7321 @group
7322 (setq org-feed-alist
7323      '(("Slashdot"
7324          "http://rss.slashdot.org/Slashdot/slashdot"
7325          "~/txt/org/feeds.org" "Slashdot Entries")))
7326 @end group
7327 @end smalllisp
7329 @noindent
7330 will configure that new items from the feed provided by
7331 @code{rss.slashdot.org} will result in new entries in the file
7332 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7333 the following command is used:
7335 @table @kbd
7336 @orgcmd{C-c C-x g,org-feed-update-all}
7337 @item C-c C-x g
7338 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7339 them.
7340 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7341 Prompt for a feed name and go to the inbox configured for this feed.
7342 @end table
7344 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7345 it will store information about the status of items in the feed, to avoid
7346 adding the same item several times.  You should add @samp{FEEDSTATUS} to the
7347 list of drawers in that file:
7349 @example
7350 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
7351 @end example
7353 For more information, including how to read atom feeds, see
7354 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7356 @node Protocols, Refile and copy, RSS Feeds, Capture - Refile - Archive
7357 @section Protocols for external access
7358 @cindex protocols, for external access
7359 @cindex emacsserver
7361 You can set up Org for handling protocol calls from outside applications that
7362 are passed to Emacs through the @file{emacsserver}.  For example, you can
7363 configure bookmarks in your web browser to send a link to the current page to
7364 Org and create a note from it using capture (@pxref{Capture}).  Or you
7365 could create a bookmark that will tell Emacs to open the local source file of
7366 a remote website you are looking at with the browser.  See
7367 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7368 documentation and setup instructions.
7370 @node Refile and copy, Archiving, Protocols, Capture - Refile - Archive
7371 @section Refile and copy
7372 @cindex refiling notes
7373 @cindex copying notes
7375 When reviewing the captured data, you may want to refile or to copy some of
7376 the entries into a different list, for example into a project.  Cutting,
7377 finding the right location, and then pasting the note is cumbersome.  To
7378 simplify this process, you can use the following special command:
7380 @table @kbd
7381 @orgcmd{C-c M-w,org-copy}
7382 @findex org-copy
7383 Copying works like refiling, except that the original note is not deleted.
7384 @orgcmd{C-c C-w,org-refile}
7385 @findex org-refile
7386 @vindex org-reverse-note-order
7387 @vindex org-refile-targets
7388 @vindex org-refile-use-outline-path
7389 @vindex org-outline-path-complete-in-steps
7390 @vindex org-refile-allow-creating-parent-nodes
7391 @vindex org-log-refile
7392 @vindex org-refile-use-cache
7393 @vindex org-refile-keep
7394 Refile the entry or region at point.  This command offers possible locations
7395 for refiling the entry and lets you select one with completion.  The item (or
7396 all items in the region) is filed below the target heading as a subitem.
7397 Depending on @code{org-reverse-note-order}, it will be either the first or
7398 last subitem.@*
7399 By default, all level 1 headlines in the current buffer are considered to be
7400 targets, but you can have more complex definitions across a number of files.
7401 See the variable @code{org-refile-targets} for details.  If you would like to
7402 select a location via a file-path-like completion along the outline path, see
7403 the variables @code{org-refile-use-outline-path} and
7404 @code{org-outline-path-complete-in-steps}.  If you would like to be able to
7405 create new nodes as new parents for refiling on the fly, check the
7406 variable @code{org-refile-allow-creating-parent-nodes}.
7407 When the variable @code{org-log-refile}@footnote{with corresponding
7408 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7409 and @code{nologrefile}} is set, a timestamp or a note will be
7410 recorded when an entry has been refiled.
7411 @orgkey{C-u C-c C-w}
7412 Use the refile interface to jump to a heading.
7413 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7414 Jump to the location where @code{org-refile} last moved a tree to.
7415 @item C-2 C-c C-w
7416 Refile as the child of the item currently being clocked.
7417 @item C-3 C-c C-w
7418 Refile and keep the entry in place.  Also see @code{org-refile-keep} to make
7419 this the default behavior, and beware that this may result in duplicated
7420 @code{ID} properties.
7421 @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}
7422 Clear the target cache.  Caching of refile targets can be turned on by
7423 setting @code{org-refile-use-cache}.  To make the command see new possible
7424 targets, you have to clear the cache with this command.
7425 @end table
7427 @node Archiving,  , Refile and copy, Capture - Refile - Archive
7428 @section Archiving
7429 @cindex archiving
7431 When a project represented by a (sub)tree is finished, you may want
7432 to move the tree out of the way and to stop it from contributing to the
7433 agenda.  Archiving is important to keep your working files compact and global
7434 searches like the construction of agenda views fast.
7436 @table @kbd
7437 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7438 @vindex org-archive-default-command
7439 Archive the current entry using the command specified in the variable
7440 @code{org-archive-default-command}.
7441 @end table
7443 @menu
7444 * Moving subtrees::             Moving a tree to an archive file
7445 * Internal archiving::          Switch off a tree but keep it in the file
7446 @end menu
7448 @node Moving subtrees, Internal archiving, Archiving, Archiving
7449 @subsection Moving a tree to the archive file
7450 @cindex external archiving
7452 The most common archiving action is to move a project tree to another file,
7453 the archive file.
7455 @table @kbd
7456 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7457 @vindex org-archive-location
7458 Archive the subtree starting at the cursor position to the location
7459 given by @code{org-archive-location}.
7460 @orgkey{C-u C-c C-x C-s}
7461 Check if any direct children of the current headline could be moved to
7462 the archive.  To do this, each subtree is checked for open TODO entries.
7463 If none are found, the command offers to move it to the archive
7464 location.  If the cursor is @emph{not} on a headline when this command
7465 is invoked, the level 1 trees will be checked.
7466 @end table
7468 @cindex archive locations
7469 The default archive location is a file in the same directory as the
7470 current file, with the name derived by appending @file{_archive} to the
7471 current file name.  You can also choose what heading to file archived
7472 items under, with the possibility to add them to a datetree in a file.
7473 For information and examples on how to specify the file and the heading,
7474 see the documentation string of the variable
7475 @code{org-archive-location}.
7477 There is also an in-buffer option for setting this variable, for
7478 example@footnote{For backward compatibility, the following also works:
7479 If there are several such lines in a file, each specifies the archive
7480 location for the text below it.  The first such line also applies to any
7481 text before its definition.  However, using this method is
7482 @emph{strongly} deprecated as it is incompatible with the outline
7483 structure of the document.  The correct method for setting multiple
7484 archive locations in a buffer is using properties.}:
7486 @cindex #+ARCHIVE
7487 @example
7488 #+ARCHIVE: %s_done::
7489 @end example
7491 @cindex property, ARCHIVE
7492 @noindent
7493 If you would like to have a special ARCHIVE location for a single entry
7494 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7495 location as the value (@pxref{Properties and Columns}).
7497 @vindex org-archive-save-context-info
7498 When a subtree is moved, it receives a number of special properties that
7499 record context information like the file from where the entry came, its
7500 outline path the archiving time etc.  Configure the variable
7501 @code{org-archive-save-context-info} to adjust the amount of information
7502 added.
7505 @node Internal archiving,  , Moving subtrees, Archiving
7506 @subsection Internal archiving
7508 If you want to just switch off (for agenda views) certain subtrees without
7509 moving them to a different file, you can use the @code{ARCHIVE tag}.
7511 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7512 its location in the outline tree, but behaves in the following way:
7513 @itemize @minus
7514 @item
7515 @vindex org-cycle-open-archived-trees
7516 It does not open when you attempt to do so with a visibility cycling
7517 command (@pxref{Visibility cycling}).  You can force cycling archived
7518 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7519 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
7520 @code{show-all} will open archived subtrees.
7521 @item
7522 @vindex org-sparse-tree-open-archived-trees
7523 During sparse tree construction (@pxref{Sparse trees}), matches in
7524 archived subtrees are not exposed, unless you configure the option
7525 @code{org-sparse-tree-open-archived-trees}.
7526 @item
7527 @vindex org-agenda-skip-archived-trees
7528 During agenda view construction (@pxref{Agenda Views}), the content of
7529 archived trees is ignored unless you configure the option
7530 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7531 be included.  In the agenda you can press @kbd{v a} to get archives
7532 temporarily included.
7533 @item
7534 @vindex org-export-with-archived-trees
7535 Archived trees are not exported (@pxref{Exporting}), only the headline
7536 is.  Configure the details using the variable
7537 @code{org-export-with-archived-trees}.
7538 @item
7539 @vindex org-columns-skip-archived-trees
7540 Archived trees are excluded from column view unless the variable
7541 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7542 @end itemize
7544 The following commands help manage the ARCHIVE tag:
7546 @table @kbd
7547 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7548 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
7549 the headline changes to a shadowed face, and the subtree below it is
7550 hidden.
7551 @orgkey{C-u C-c C-x a}
7552 Check if any direct children of the current headline should be archived.
7553 To do this, each subtree is checked for open TODO entries.  If none are
7554 found, the command offers to set the ARCHIVE tag for the child.  If the
7555 cursor is @emph{not} on a headline when this command is invoked, the
7556 level 1 trees will be checked.
7557 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7558 Cycle a tree even if it is tagged with ARCHIVE.
7559 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7560 Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
7561 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}.  The
7562 entry becomes a child of that sibling and in this way retains a lot of its
7563 original context, including inherited tags and approximate position in the
7564 outline.
7565 @end table
7568 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7569 @chapter Agenda views
7570 @cindex agenda views
7572 Due to the way Org works, TODO items, time-stamped items, and
7573 tagged headlines can be scattered throughout a file or even a number of
7574 files.  To get an overview of open action items, or of events that are
7575 important for a particular date, this information must be collected,
7576 sorted and displayed in an organized way.
7578 Org can select items based on various criteria and display them
7579 in a separate buffer.  Seven different view types are provided:
7581 @itemize @bullet
7582 @item
7583 an @emph{agenda} that is like a calendar and shows information
7584 for specific dates,
7585 @item
7586 a @emph{TODO list} that covers all unfinished
7587 action items,
7588 @item
7589 a @emph{match view}, showings headlines based on the tags, properties, and
7590 TODO state associated with them,
7591 @item
7592 a @emph{timeline view} that shows all events in a single Org file,
7593 in time-sorted view,
7594 @item
7595 a @emph{text search view} that shows all entries from multiple files
7596 that contain specified keywords,
7597 @item
7598 a @emph{stuck projects view} showing projects that currently don't move
7599 along, and
7600 @item
7601 @emph{custom views} that are special searches and combinations of different
7602 views.
7603 @end itemize
7605 @noindent
7606 The extracted information is displayed in a special @emph{agenda
7607 buffer}.  This buffer is read-only, but provides commands to visit the
7608 corresponding locations in the original Org files, and even to
7609 edit these files remotely.
7611 @vindex org-agenda-window-setup
7612 @vindex org-agenda-restore-windows-after-quit
7613 Two variables control how the agenda buffer is displayed and whether the
7614 window configuration is restored when the agenda exits:
7615 @code{org-agenda-window-setup} and
7616 @code{org-agenda-restore-windows-after-quit}.
7618 @menu
7619 * Agenda files::                Files being searched for agenda information
7620 * Agenda dispatcher::           Keyboard access to agenda views
7621 * Built-in agenda views::       What is available out of the box?
7622 * Presentation and sorting::    How agenda items are prepared for display
7623 * Agenda commands::             Remote editing of Org trees
7624 * Custom agenda views::         Defining special searches and views
7625 * Exporting Agenda Views::      Writing a view to a file
7626 * Agenda column view::          Using column view for collected entries
7627 @end menu
7629 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7630 @section Agenda files
7631 @cindex agenda files
7632 @cindex files for agenda
7634 @vindex org-agenda-files
7635 The information to be shown is normally collected from all @emph{agenda
7636 files}, the files listed in the variable
7637 @code{org-agenda-files}@footnote{If the value of that variable is not a
7638 list, but a single file name, then the list of agenda files will be
7639 maintained in that external file.}.  If a directory is part of this list,
7640 all files with the extension @file{.org} in this directory will be part
7641 of the list.
7643 Thus, even if you only work with a single Org file, that file should
7644 be put into the list@footnote{When using the dispatcher, pressing
7645 @kbd{<} before selecting a command will actually limit the command to
7646 the current file, and ignore @code{org-agenda-files} until the next
7647 dispatcher command.}.  You can customize @code{org-agenda-files}, but
7648 the easiest way to maintain it is through the following commands
7650 @cindex files, adding to agenda list
7651 @table @kbd
7652 @orgcmd{C-c [,org-agenda-file-to-front}
7653 Add current file to the list of agenda files.  The file is added to
7654 the front of the list.  If it was already in the list, it is moved to
7655 the front.  With a prefix argument, file is added/moved to the end.
7656 @orgcmd{C-c ],org-remove-file}
7657 Remove current file from the list of agenda files.
7658 @kindex C-,
7659 @cindex cycling, of agenda files
7660 @orgcmd{C-',org-cycle-agenda-files}
7661 @itemx C-,
7662 Cycle through agenda file list, visiting one file after the other.
7663 @kindex M-x org-iswitchb
7664 @item M-x org-iswitchb RET
7665 Command to use an @code{iswitchb}-like interface to switch to and between Org
7666 buffers.
7667 @end table
7669 @noindent
7670 The Org menu contains the current list of files and can be used
7671 to visit any of them.
7673 If you would like to focus the agenda temporarily on a file not in
7674 this list, or on just one file in the list, or even on only a subtree in a
7675 file, then this can be done in different ways.  For a single agenda command,
7676 you may press @kbd{<} once or several times in the dispatcher
7677 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
7678 extended period, use the following commands:
7680 @table @kbd
7681 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7682 Permanently restrict the agenda to the current subtree.  When with a
7683 prefix argument, or with the cursor before the first headline in a file,
7684 the agenda scope is set to the entire file.  This restriction remains in
7685 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7686 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
7687 agenda view, the new restriction takes effect immediately.
7688 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7689 Remove the permanent restriction created by @kbd{C-c C-x <}.
7690 @end table
7692 @noindent
7693 When working with @file{speedbar.el}, you can use the following commands in
7694 the Speedbar frame:
7696 @table @kbd
7697 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7698 Permanently restrict the agenda to the item---either an Org file or a subtree
7699 in such a file---at the cursor in the Speedbar frame.
7700 If there is a window displaying an agenda view, the new restriction takes
7701 effect immediately.
7702 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7703 Lift the restriction.
7704 @end table
7706 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7707 @section The agenda dispatcher
7708 @cindex agenda dispatcher
7709 @cindex dispatching agenda commands
7710 The views are created through a dispatcher, which should be bound to a
7711 global key---for example @kbd{C-c a} (@pxref{Activation}).  In the
7712 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7713 is accessed and list keyboard access to commands accordingly.  After
7714 pressing @kbd{C-c a}, an additional letter is required to execute a
7715 command.  The dispatcher offers the following default commands:
7717 @table @kbd
7718 @item a
7719 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7720 @item t @r{/} T
7721 Create a list of all TODO items (@pxref{Global TODO list}).
7722 @item m @r{/} M
7723 Create a list of headlines matching a TAGS expression (@pxref{Matching
7724 tags and properties}).
7725 @item L
7726 Create the timeline view for the current buffer (@pxref{Timeline}).
7727 @item s
7728 Create a list of entries selected by a boolean expression of keywords
7729 and/or regular expressions that must or must not occur in the entry.
7730 @item /
7731 @vindex org-agenda-text-search-extra-files
7732 Search for a regular expression in all agenda files and additionally in
7733 the files listed in @code{org-agenda-text-search-extra-files}.  This
7734 uses the Emacs command @code{multi-occur}.  A prefix argument can be
7735 used to specify the number of context lines for each match, default is
7737 @item # @r{/} !
7738 Create a list of stuck projects (@pxref{Stuck projects}).
7739 @item <
7740 Restrict an agenda command to the current buffer@footnote{For backward
7741 compatibility, you can also press @kbd{1} to restrict to the current
7742 buffer.}.  After pressing @kbd{<}, you still need to press the character
7743 selecting the command.
7744 @item < <
7745 If there is an active region, restrict the following agenda command to
7746 the region.  Otherwise, restrict it to the current subtree@footnote{For
7747 backward compatibility, you can also press @kbd{0} to restrict to the
7748 current region/subtree.}.  After pressing @kbd{< <}, you still need to press the
7749 character selecting the command.
7751 @item *
7752 @vindex org-agenda-sticky
7753 Toggle sticky agenda views.  By default, Org maintains only a single agenda
7754 buffer and rebuilds it each time you change the view, to make sure everything
7755 is always up to date.  If you switch between views often and the build time
7756 bothers you, you can turn on sticky agenda buffers (make this the default by
7757 customizing the variable @code{org-agenda-sticky}).  With sticky agendas, the
7758 dispatcher only switches to the selected view, you need to update it by hand
7759 with @kbd{r} or @kbd{g}.  You can toggle sticky agenda view any time with
7760 @code{org-toggle-sticky-agenda}.
7761 @end table
7763 You can also define custom commands that will be accessible through the
7764 dispatcher, just like the default commands.  This includes the
7765 possibility to create extended agenda buffers that contain several
7766 blocks together, for example the weekly agenda, the global TODO list and
7767 a number of special tags matches.  @xref{Custom agenda views}.
7769 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7770 @section The built-in agenda views
7772 In this section we describe the built-in views.
7774 @menu
7775 * Weekly/daily agenda::         The calendar page with current tasks
7776 * Global TODO list::            All unfinished action items
7777 * Matching tags and properties::  Structured information with fine-tuned search
7778 * Timeline::                    Time-sorted view for single file
7779 * Search view::                 Find entries by searching for text
7780 * Stuck projects::              Find projects you need to review
7781 @end menu
7783 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7784 @subsection The weekly/daily agenda
7785 @cindex agenda
7786 @cindex weekly agenda
7787 @cindex daily agenda
7789 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7790 paper agenda, showing all the tasks for the current week or day.
7792 @table @kbd
7793 @cindex org-agenda, command
7794 @orgcmd{C-c a a,org-agenda-list}
7795 Compile an agenda for the current week from a list of Org files.  The agenda
7796 shows the entries for each day.  With a numeric prefix@footnote{For backward
7797 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7798 listed before the agenda.  This feature is deprecated, use the dedicated TODO
7799 list, or a block agenda instead (@pxref{Block agenda}).}  (like @kbd{C-u 2 1
7800 C-c a a}) you may set the number of days to be displayed.
7801 @end table
7803 @vindex org-agenda-span
7804 @vindex org-agenda-ndays
7805 @vindex org-agenda-start-day
7806 @vindex org-agenda-start-on-weekday
7807 The default number of days displayed in the agenda is set by the variable
7808 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}).  This
7809 variable can be set to any number of days you want to see by default in the
7810 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7811 @code{year}.  For weekly agendas, the default is to start on the previous
7812 monday (see @code{org-agenda-start-on-weekday}).  You can also set the start
7813 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7814 start the agenda ten days from today in the future.
7816 Remote editing from the agenda buffer means, for example, that you can
7817 change the dates of deadlines and appointments from the agenda buffer.
7818 The commands available in the Agenda buffer are listed in @ref{Agenda
7819 commands}.
7821 @subsubheading Calendar/Diary integration
7822 @cindex calendar integration
7823 @cindex diary integration
7825 Emacs contains the calendar and diary by Edward M. Reingold.  The
7826 calendar displays a three-month calendar with holidays from different
7827 countries and cultures.  The diary allows you to keep track of
7828 anniversaries, lunar phases, sunrise/set, recurrent appointments
7829 (weekly, monthly) and more.  In this way, it is quite complementary to
7830 Org.  It can be very useful to combine output from Org with
7831 the diary.
7833 In order to include entries from the Emacs diary into Org mode's
7834 agenda, you only need to customize the variable
7836 @lisp
7837 (setq org-agenda-include-diary t)
7838 @end lisp
7840 @noindent After that, everything will happen automatically.  All diary
7841 entries including holidays, anniversaries, etc., will be included in the
7842 agenda buffer created by Org mode.  @key{SPC}, @key{TAB}, and
7843 @key{RET} can be used from the agenda buffer to jump to the diary
7844 file in order to edit existing diary entries.  The @kbd{i} command to
7845 insert new entries for the current date works in the agenda buffer, as
7846 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7847 Sunrise/Sunset times, show lunar phases and to convert to other
7848 calendars, respectively.  @kbd{c} can be used to switch back and forth
7849 between calendar and agenda.
7851 If you are using the diary only for sexp entries and holidays, it is
7852 faster to not use the above setting, but instead to copy or even move
7853 the entries into an Org file.  Org mode evaluates diary-style sexp
7854 entries, and does it faster because there is no overhead for first
7855 creating the diary display.  Note that the sexp entries must start at
7856 the left margin, no whitespace is allowed before them.  For example,
7857 the following segment of an Org file will be processed and entries
7858 will be made in the agenda:
7860 @example
7861 * Birthdays and similar stuff
7862 #+CATEGORY: Holiday
7863 %%(org-calendar-holiday)   ; special function for holiday names
7864 #+CATEGORY: Ann
7865 %%(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
7866 %%(org-anniversary 1869 10  2) Mahatma Gandhi would be %d years old
7867 @end example
7869 @subsubheading Anniversaries from BBDB
7870 @cindex BBDB, anniversaries
7871 @cindex anniversaries, from BBDB
7873 If you are using the Big Brothers Database to store your contacts, you will
7874 very likely prefer to store anniversaries in BBDB rather than in a
7875 separate Org or diary file.  Org supports this and will show BBDB
7876 anniversaries as part of the agenda.  All you need to do is to add the
7877 following to one of your agenda files:
7879 @example
7880 * Anniversaries
7881   :PROPERTIES:
7882   :CATEGORY: Anniv
7883   :END:
7884 %%(org-bbdb-anniversaries)
7885 @end example
7887 You can then go ahead and define anniversaries for a BBDB record.  Basically,
7888 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7889 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7890 followed by a space and the class of the anniversary (@samp{birthday} or
7891 @samp{wedding}, or a format string).  If you omit the class, it will default to
7892 @samp{birthday}.  Here are a few examples, the header for the file
7893 @file{org-bbdb.el} contains more detailed information.
7895 @example
7896 1973-06-22
7897 06-22
7898 1955-08-02 wedding
7899 2008-04-14 %s released version 6.01 of org mode, %d years ago
7900 @end example
7902 After a change to BBDB, or for the first agenda display during an Emacs
7903 session, the agenda display will suffer a short delay as Org updates its
7904 hash with anniversaries.  However, from then on things will be very fast---much
7905 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7906 in an Org or Diary file.
7908 @subsubheading Appointment reminders
7909 @cindex @file{appt.el}
7910 @cindex appointment reminders
7911 @cindex appointment
7912 @cindex reminders
7914 Org can interact with Emacs appointments notification facility.  To add the
7915 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7916 This command lets you filter through the list of your appointments and add
7917 only those belonging to a specific category or matching a regular expression.
7918 It also reads a @code{APPT_WARNTIME} property which will then override the
7919 value of @code{appt-message-warning-time} for this appointment.  See the
7920 docstring for details.
7922 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7923 @subsection The global TODO list
7924 @cindex global TODO list
7925 @cindex TODO list, global
7927 The global TODO list contains all unfinished TODO items formatted and
7928 collected into a single place.
7930 @table @kbd
7931 @orgcmd{C-c a t,org-todo-list}
7932 Show the global TODO list.  This collects the TODO items from all agenda
7933 files (@pxref{Agenda Views}) into a single buffer.  By default, this lists
7934 items with a state the is not a DONE state.  The buffer is in
7935 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7936 entries directly from that buffer (@pxref{Agenda commands}).
7937 @orgcmd{C-c a T,org-todo-list}
7938 @cindex TODO keyword matching
7939 @vindex org-todo-keywords
7940 Like the above, but allows selection of a specific TODO keyword.  You can
7941 also do this by specifying a prefix argument to @kbd{C-c a t}.  You are
7942 prompted for a keyword, and you may also specify several keywords by
7943 separating them with @samp{|} as the boolean OR operator.  With a numeric
7944 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7945 @kindex r
7946 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7947 a prefix argument to this command to change the selected TODO keyword,
7948 for example @kbd{3 r}.  If you often need a search for a specific
7949 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7950 Matching specific TODO keywords can also be done as part of a tags
7951 search (@pxref{Tag searches}).
7952 @end table
7954 Remote editing of TODO items means that you can change the state of a
7955 TODO entry with a single key press.  The commands available in the
7956 TODO list are described in @ref{Agenda commands}.
7958 @cindex sublevels, inclusion into TODO list
7959 Normally the global TODO list simply shows all headlines with TODO
7960 keywords.  This list can become very long.  There are two ways to keep
7961 it more compact:
7962 @itemize @minus
7963 @item
7964 @vindex org-agenda-todo-ignore-scheduled
7965 @vindex org-agenda-todo-ignore-deadlines
7966 @vindex org-agenda-todo-ignore-timestamp
7967 @vindex org-agenda-todo-ignore-with-date
7968 Some people view a TODO item that has been @emph{scheduled} for execution or
7969 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7970 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7971 @code{org-agenda-todo-ignore-deadlines},
7972 @code{org-agenda-todo-ignore-timestamp} and/or
7973 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7974 TODO list.
7975 @item
7976 @vindex org-agenda-todo-list-sublevels
7977 TODO items may have sublevels to break up the task into subtasks.  In
7978 such cases it may be enough to list only the highest level TODO headline
7979 and omit the sublevels from the global list.  Configure the variable
7980 @code{org-agenda-todo-list-sublevels} to get this behavior.
7981 @end itemize
7983 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7984 @subsection Matching tags and properties
7985 @cindex matching, of tags
7986 @cindex matching, of properties
7987 @cindex tags view
7988 @cindex match view
7990 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7991 or have properties (@pxref{Properties and Columns}), you can select headlines
7992 based on this metadata and collect them into an agenda buffer.  The match
7993 syntax described here also applies when creating sparse trees with @kbd{C-c /
7996 @table @kbd
7997 @orgcmd{C-c a m,org-tags-view}
7998 Produce a list of all headlines that match a given set of tags.  The
7999 command prompts for a selection criterion, which is a boolean logic
8000 expression with tags, like @samp{+work+urgent-withboss} or
8001 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
8002 define a custom command for it (@pxref{Agenda dispatcher}).
8003 @orgcmd{C-c a M,org-tags-view}
8004 @vindex org-tags-match-list-sublevels
8005 @vindex org-agenda-tags-todo-honor-ignore-options
8006 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
8007 not-DONE state and force checking subitems (see variable
8008 @code{org-tags-match-list-sublevels}).  To exclude scheduled/deadline items,
8009 see the variable @code{org-agenda-tags-todo-honor-ignore-options}.  Matching
8010 specific TODO keywords together with a tags match is also possible, see
8011 @ref{Tag searches}.
8012 @end table
8014 The commands available in the tags list are described in @ref{Agenda
8015 commands}.
8017 @subsubheading Match syntax
8019 @cindex Boolean logic, for tag/property searches
8020 A search string can use Boolean operators @samp{&} for @code{AND} and
8021 @samp{|} for @code{OR}@.  @samp{&} binds more strongly than @samp{|}.
8022 Parentheses are not implemented.  Each element in the search is either a
8023 tag, a regular expression matching tags, or an expression like
8024 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8025 property value.  Each element may be preceded by @samp{-}, to select
8026 against it, and @samp{+} is syntactic sugar for positive selection.  The
8027 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8028 present.  Here are some examples, using only tags.
8030 @table @samp
8031 @item work
8032 Select headlines tagged @samp{:work:}.
8033 @item work&boss
8034 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8035 @item +work-boss
8036 Select headlines tagged @samp{:work:}, but discard those also tagged
8037 @samp{:boss:}.
8038 @item work|laptop
8039 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8040 @item work|laptop+night
8041 Like before, but require the @samp{:laptop:} lines to be tagged also
8042 @samp{:night:}.
8043 @end table
8045 @cindex regular expressions, with tags search
8046 Instead of a tag, you may also specify a regular expression enclosed in curly
8047 braces.  For example,
8048 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8049 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8051 @cindex group tags, as regular expressions
8052 Group tags (@pxref{Tag groups}) are expanded as regular expressions.  E.g.,
8053 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8054 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8055 and searching for @samp{-work} will search for all headlines but those with
8056 one of the tag in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8058 @cindex TODO keyword matching, with tags search
8059 @cindex level, require for tags/property match
8060 @cindex category, require for tags/property match
8061 @vindex org-odd-levels-only
8062 You may also test for properties (@pxref{Properties and Columns}) at the same
8063 time as matching tags.  The properties may be real properties, or special
8064 properties that represent other metadata (@pxref{Special properties}).  For
8065 example, the ``property'' @code{TODO} represents the TODO keyword of the
8066 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8067 the entry.  The ITEM special property cannot currently be used in tags/property
8068 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
8069 ,skipping entries based on regexp}.}.
8071 Except the @pxref{Special properties}, one other ``property'' can also be
8072 used. @code{LEVEL} represents the level of an entry.  So a search
8073 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8074 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8075 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8076 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8078 Here are more examples:
8080 @table @samp
8081 @item work+TODO="WAITING"
8082 Select @samp{:work:}-tagged TODO lines with the specific TODO
8083 keyword @samp{WAITING}.
8084 @item work+TODO="WAITING"|home+TODO="WAITING"
8085 Waiting tasks both at work and at home.
8086 @end table
8088 When matching properties, a number of different operators can be used to test
8089 the value of a property.  Here is a complex example:
8091 @example
8092 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
8093          +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8094 @end example
8096 @noindent
8097 The type of comparison will depend on how the comparison value is written:
8098 @itemize @minus
8099 @item
8100 If the comparison value is a plain number, a numerical comparison is done,
8101 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8102 @samp{>=}, and @samp{<>}.
8103 @item
8104 If the comparison value is enclosed in double-quotes,
8105 a string comparison is done, and the same operators are allowed.
8106 @item
8107 If the comparison value is enclosed in double-quotes @emph{and} angular
8108 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8109 assumed to be date/time specifications in the standard Org way, and the
8110 comparison will be done accordingly.  Special values that will be recognized
8111 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8112 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8113 specification.  Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8114 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8115 respectively, can be used.
8116 @item
8117 If the comparison value is enclosed
8118 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8119 regexp matches the property value, and @samp{<>} meaning that it does not
8120 match.
8121 @end itemize
8123 So the search string in the example finds entries tagged @samp{:work:} but
8124 not @samp{:boss:}, which also have a priority value @samp{A}, a
8125 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8126 property that is numerically smaller than 2, a @samp{:With:} property that is
8127 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8128 on or after October 11, 2008.
8130 Accessing TODO, LEVEL, and CATEGORY during a search is fast.  Accessing any
8131 other properties will slow down the search.  However, once you have paid the
8132 price by accessing one property, testing additional properties is cheap
8133 again.
8135 You can configure Org mode to use property inheritance during a search, but
8136 beware that this can slow down searches considerably.  See @ref{Property
8137 inheritance}, for details.
8139 For backward compatibility, and also for typing speed, there is also a
8140 different way to test TODO states in a search.  For this, terminate the
8141 tags/property part of the search string (which may include several terms
8142 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8143 expression just for TODO keywords.  The syntax is then similar to that for
8144 tags, but should be applied with care: for example, a positive selection on
8145 several TODO keywords cannot meaningfully be combined with boolean AND@.
8146 However, @emph{negative selection} combined with AND can be meaningful.  To
8147 make sure that only lines are checked that actually have any TODO keyword
8148 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8149 part after the slash with @samp{!}.  Using @kbd{C-c a M} or @samp{/!} will
8150 not match TODO keywords in a DONE state.  Examples:
8152 @table @samp
8153 @item work/WAITING
8154 Same as @samp{work+TODO="WAITING"}
8155 @item work/!-WAITING-NEXT
8156 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8157 nor @samp{NEXT}
8158 @item work/!+WAITING|+NEXT
8159 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8160 @samp{NEXT}.
8161 @end table
8163 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
8164 @subsection Timeline for a single file
8165 @cindex timeline, single file
8166 @cindex time-sorted view
8168 The timeline summarizes all time-stamped items from a single Org mode
8169 file in a @emph{time-sorted view}.  The main purpose of this command is
8170 to give an overview over events in a project.
8172 @table @kbd
8173 @orgcmd{C-c a L,org-timeline}
8174 Show a time-sorted view of the Org file, with all time-stamped items.
8175 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8176 (scheduled or not) are also listed under the current date.
8177 @end table
8179 @noindent
8180 The commands available in the timeline buffer are listed in
8181 @ref{Agenda commands}.
8183 @node Search view, Stuck projects, Timeline, Built-in agenda views
8184 @subsection Search view
8185 @cindex search view
8186 @cindex text search
8187 @cindex searching, for text
8189 This agenda view is a general text search facility for Org mode entries.
8190 It is particularly useful to find notes.
8192 @table @kbd
8193 @orgcmd{C-c a s,org-search-view}
8194 This is a special search that lets you select entries by matching a substring
8195 or specific words using a boolean logic.
8196 @end table
8197 For example, the search string @samp{computer equipment} will find entries
8198 that contain @samp{computer equipment} as a substring.  If the two words are
8199 separated by more space or a line break, the search will still match.
8200 Search view can also search for specific keywords in the entry, using Boolean
8201 logic.  The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8202 will search for note entries that contain the keywords @code{computer}
8203 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8204 not matched by the regular expression @code{8\.11[bg]}, meaning to
8205 exclude both 8.11b and 8.11g.  The first @samp{+} is necessary to turn on
8206 word search, other @samp{+} characters are optional.  For more details, see
8207 the docstring of the command @code{org-search-view}.
8209 @vindex org-agenda-text-search-extra-files
8210 Note that in addition to the agenda files, this command will also search
8211 the files listed in @code{org-agenda-text-search-extra-files}.
8213 @node Stuck projects,  , Search view, Built-in agenda views
8214 @subsection Stuck projects
8215 @pindex GTD, Getting Things Done
8217 If you are following a system like David Allen's GTD to organize your
8218 work, one of the ``duties'' you have is a regular review to make sure
8219 that all projects move along.  A @emph{stuck} project is a project that
8220 has no defined next actions, so it will never show up in the TODO lists
8221 Org mode produces.  During the review, you need to identify such
8222 projects and define next actions for them.
8224 @table @kbd
8225 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8226 List projects that are stuck.
8227 @kindex C-c a !
8228 @item C-c a !
8229 @vindex org-stuck-projects
8230 Customize the variable @code{org-stuck-projects} to define what a stuck
8231 project is and how to find it.
8232 @end table
8234 You almost certainly will have to configure this view before it will
8235 work for you.  The built-in default assumes that all your projects are
8236 level-2 headlines, and that a project is not stuck if it has at least
8237 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8239 Let's assume that you, in your own way of using Org mode, identify
8240 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8241 indicate a project that should not be considered yet.  Let's further
8242 assume that the TODO keyword DONE marks finished projects, and that NEXT
8243 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
8244 is a next action even without the NEXT tag.  Finally, if the project
8245 contains the special word IGNORE anywhere, it should not be listed
8246 either.  In this case you would start by identifying eligible projects
8247 with a tags/todo match@footnote{@xref{Tag searches}.}
8248 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8249 IGNORE in the subtree to identify projects that are not stuck.  The
8250 correct customization for this is
8252 @lisp
8253 (setq org-stuck-projects
8254       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8255                                "\\<IGNORE\\>"))
8256 @end lisp
8258 Note that if a project is identified as non-stuck, the subtree of this entry
8259 will still be searched for stuck projects.
8261 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
8262 @section Presentation and sorting
8263 @cindex presentation, of agenda items
8265 @vindex org-agenda-prefix-format
8266 @vindex org-agenda-tags-column
8267 Before displaying items in an agenda view, Org mode visually prepares the
8268 items and sorts them.  Each item occupies a single line.  The line starts
8269 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8270 of the item and other important information.  You can customize in which
8271 column tags will be displayed through @code{org-agenda-tags-column}.  You can
8272 also customize the prefix using the option @code{org-agenda-prefix-format}.
8273 This prefix is followed by a cleaned-up version of the outline headline
8274 associated with the item.
8276 @menu
8277 * Categories::                  Not all tasks are equal
8278 * Time-of-day specifications::  How the agenda knows the time
8279 * Sorting agenda items::        The order of things
8280 * Filtering/limiting agenda items::  Dynamically narrow the agenda
8281 @end menu
8283 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
8284 @subsection Categories
8286 @cindex category
8287 @cindex #+CATEGORY
8288 The category is a broad label assigned to each agenda item.  By default,
8289 the category is simply derived from the file name, but you can also
8290 specify it with a special line in the buffer, like this@footnote{For
8291 backward compatibility, the following also works: if there are several
8292 such lines in a file, each specifies the category for the text below it.
8293 The first category also applies to any text before the first CATEGORY
8294 line.  However, using this method is @emph{strongly} deprecated as it is
8295 incompatible with the outline structure of the document.  The correct
8296 method for setting multiple categories in a buffer is using a
8297 property.}:
8299 @example
8300 #+CATEGORY: Thesis
8301 @end example
8303 @noindent
8304 @cindex property, CATEGORY
8305 If you would like to have a special CATEGORY for a single entry or a
8306 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8307 special category you want to apply as the value.
8309 @noindent
8310 The display in the agenda buffer looks best if the category is not
8311 longer than 10 characters.
8313 @noindent
8314 You can set up icons for category by customizing the
8315 @code{org-agenda-category-icon-alist} variable.
8317 @node Time-of-day specifications, Sorting agenda items, Categories, Presentation and sorting
8318 @subsection Time-of-day specifications
8319 @cindex time-of-day specification
8321 Org mode checks each agenda item for a time-of-day specification.  The
8322 time can be part of the timestamp that triggered inclusion into the
8323 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
8324 ranges can be specified with two timestamps, like
8326 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8328 In the headline of the entry itself, a time(range) may also appear as
8329 plain text (like @samp{12:45} or a @samp{8:30-1pm}).  If the agenda
8330 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8331 specifications in diary entries are recognized as well.
8333 For agenda display, Org mode extracts the time and displays it in a
8334 standard 24 hour format as part of the prefix.  The example times in
8335 the previous paragraphs would end up in the agenda like this:
8337 @example
8338     8:30-13:00 Arthur Dent lies in front of the bulldozer
8339    12:45...... Ford Prefect arrives and takes Arthur to the pub
8340    19:00...... The Vogon reads his poem
8341    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8342 @end example
8344 @cindex time grid
8345 If the agenda is in single-day mode, or for the display of today, the
8346 timed entries are embedded in a time grid, like
8348 @example
8349     8:00...... ------------------
8350     8:30-13:00 Arthur Dent lies in front of the bulldozer
8351    10:00...... ------------------
8352    12:00...... ------------------
8353    12:45...... Ford Prefect arrives and takes Arthur to the pub
8354    14:00...... ------------------
8355    16:00...... ------------------
8356    18:00...... ------------------
8357    19:00...... The Vogon reads his poem
8358    20:00...... ------------------
8359    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8360 @end example
8362 @vindex org-agenda-use-time-grid
8363 @vindex org-agenda-time-grid
8364 The time grid can be turned on and off with the variable
8365 @code{org-agenda-use-time-grid}, and can be configured with
8366 @code{org-agenda-time-grid}.
8368 @node Sorting agenda items, Filtering/limiting agenda items, Time-of-day specifications, Presentation and sorting
8369 @subsection Sorting agenda items
8370 @cindex sorting, of agenda items
8371 @cindex priorities, of agenda items
8372 Before being inserted into a view, the items are sorted.  How this is
8373 done depends on the type of view.
8374 @itemize @bullet
8375 @item
8376 @vindex org-agenda-files
8377 For the daily/weekly agenda, the items for each day are sorted.  The
8378 default order is to first collect all items containing an explicit
8379 time-of-day specification.  These entries will be shown at the beginning
8380 of the list, as a @emph{schedule} for the day.  After that, items remain
8381 grouped in categories, in the sequence given by @code{org-agenda-files}.
8382 Within each category, items are sorted by priority (@pxref{Priorities}),
8383 which is composed of the base priority (2000 for priority @samp{A}, 1000
8384 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8385 overdue scheduled or deadline items.
8386 @item
8387 For the TODO list, items remain in the order of categories, but within
8388 each category, sorting takes place according to priority
8389 (@pxref{Priorities}).  The priority used for sorting derives from the
8390 priority cookie, with additions depending on how close an item is to its due
8391 or scheduled date.
8392 @item
8393 For tags matches, items are not sorted at all, but just appear in the
8394 sequence in which they are found in the agenda files.
8395 @end itemize
8397 @vindex org-agenda-sorting-strategy
8398 Sorting can be customized using the variable
8399 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8400 the estimated effort of an entry (@pxref{Effort estimates}).
8402 @node Filtering/limiting agenda items,  , Sorting agenda items, Presentation and sorting
8403 @subsection Filtering/limiting agenda items
8405 Agenda built-in or customized commands are statically defined.  Agenda
8406 filters and limits provide two ways of dynamically narrowing down the list of
8407 agenda entries: @emph{fitlers} and @emph{limits}.  Filters only act on the
8408 display of the items, while limits take effect before the list of agenda
8409 entries is built.  Filter are more often used interactively, while limits are
8410 mostly useful when defined as local variables within custom agenda commands.
8412 @subsubheading Filtering in the agenda
8413 @cindex filtering, by tag, category, top headline and effort, in agenda
8414 @cindex tag filtering, in agenda
8415 @cindex category filtering, in agenda
8416 @cindex top headline filtering, in agenda
8417 @cindex effort filtering, in agenda
8418 @cindex query editing, in agenda
8420 @table @kbd
8421 @orgcmd{/,org-agenda-filter-by-tag}
8422 @vindex org-agenda-tag-filter-preset
8423 Filter the agenda view with respect to a tag and/or effort estimates.  The
8424 difference between this and a custom agenda command is that filtering is very
8425 fast, so that you can switch quickly between different filters without having
8426 to recreate the agenda.@footnote{Custom commands can preset a filter by
8427 binding the variable @code{org-agenda-tag-filter-preset} as an option.  This
8428 filter will then be applied to the view and persist as a basic filter through
8429 refreshes and more secondary filtering.  The filter is a global property of
8430 the entire agenda view---in a block agenda, you should only set this in the
8431 global options section, not in the section of an individual block.}
8433 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8434 all.  Pressing @key{TAB} at that prompt will offer use completion to select a
8435 tag (including any tags that do not have a selection character).  The command
8436 then hides all entries that do not contain or inherit this tag.  When called
8437 with prefix arg, remove the entries that @emph{do} have the tag.  A second
8438 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8439 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8440 will be narrowed by requiring or forbidding the selected additional tag.
8441 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8442 immediately use the @kbd{\} command.
8444 @vindex org-sort-agenda-noeffort-is-high
8445 In order to filter for effort estimates, you should set up allowed
8446 efforts globally, for example
8447 @lisp
8448 (setq org-global-properties
8449     '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8450 @end lisp
8451 You can then filter for an effort by first typing an operator, one of
8452 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8453 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8454 The filter will then restrict to entries with effort smaller-or-equal, equal,
8455 or larger-or-equal than the selected value.  If the digits 0--9 are not used
8456 as fast access keys to tags, you can also simply press the index digit
8457 directly without an operator.  In this case, @kbd{<} will be assumed.  For
8458 application of the operator, entries without a defined effort will be treated
8459 according to the value of @code{org-sort-agenda-noeffort-is-high}.  To filter
8460 for tasks without effort definition, press @kbd{?} as the operator.
8462 Org also supports automatic, context-aware tag filtering.  If the variable
8463 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8464 that function can decide which tags should be excluded from the agenda
8465 automatically.  Once this is set, the @kbd{/} command then accepts @kbd{RET}
8466 as a sub-option key and runs the auto exclusion logic.  For example, let's
8467 say you use a @code{Net} tag to identify tasks which need network access, an
8468 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8469 calls.  You could auto-exclude these tags based on the availability of the
8470 Internet, and outside of business hours, with something like this:
8472 @smalllisp
8473 @group
8474 (defun org-my-auto-exclude-function (tag)
8475   (and (cond
8476         ((string= tag "Net")
8477          (/= 0 (call-process "/sbin/ping" nil nil nil
8478                              "-c1" "-q" "-t1" "mail.gnu.org")))
8479         ((or (string= tag "Errand") (string= tag "Call"))
8480          (let ((hour (nth 2 (decode-time))))
8481            (or (< hour 8) (> hour 21)))))
8482        (concat "-" tag)))
8484 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8485 @end group
8486 @end smalllisp
8488 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8489 Narrow the current agenda filter by an additional condition.  When called with
8490 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8491 the effort criterion.  You can achieve the same effect by pressing @kbd{+} or
8492 @kbd{-} as the first key after the @kbd{/} command.
8495 @kindex [
8496 @kindex ]
8497 @kindex @{
8498 @kindex @}
8499 @item [ ] @{ @}
8500 @table @i
8501 @item @r{in} search view
8502 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8503 (@kbd{@{} and @kbd{@}}) to the query string.  The opening bracket/brace will
8504 add a positive search term prefixed by @samp{+}, indicating that this search
8505 term @i{must} occur/match in the entry.  The closing bracket/brace will add a
8506 negative search term which @i{must not} occur/match in the entry for it to be
8507 selected.
8508 @end table
8510 @orgcmd{<,org-agenda-filter-by-category}
8511 @vindex org-agenda-category-filter-preset
8513 Filter the current agenda view with respect to the category of the item at
8514 point.  Pressing @code{<} another time will remove this filter.  You can add
8515 a filter preset through the option @code{org-agenda-category-filter-preset}
8516 (see below.)
8518 @orgcmd{^,org-agenda-filter-by-top-headline}
8519 Filter the current agenda view and only display the siblings and the parent
8520 headline of the one at point.
8522 @orgcmd{=,org-agenda-filter-by-regexp}
8523 @vindex org-agenda-regexp-filter-preset
8525 Filter the agenda view by a regular expression: only show agenda entries
8526 matching the regular expression the user entered.  When called with a prefix
8527 argument, it will filter @emph{out} entries matching the regexp.  With two
8528 universal prefix arguments, it will remove all the regexp filters, which can
8529 be accumulated.  You can add a filter preset through the option
8530 @code{org-agenda-category-filter-preset} (see below.)
8532 @orgcmd{|,org-agenda-filter-remove-all}
8533 Remove all filters in the current agenda view.
8534 @end table
8536 @subsubheading Setting limits for the agenda
8537 @cindex limits, in agenda
8538 @vindex org-agenda-max-entries
8539 @vindex org-agenda-max-effort
8540 @vindex org-agenda-max-todos
8541 @vindex org-agenda-max-tags
8543 Here is a list of options that you can set, either globally, or locally in
8544 your custom agenda views@pxref{Custom agenda views}.
8546 @table @var
8547 @item org-agenda-max-entries
8548 Limit the number of entries.
8549 @item org-agenda-max-effort
8550 Limit the duration of accumulated efforts (as minutes).
8551 @item org-agenda-max-todos
8552 Limit the number of entries with TODO keywords.
8553 @item org-agenda-max-tags
8554 Limit the number of tagged entries.
8555 @end table
8557 When set to a positive integer, each option will exclude entries from other
8558 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8559 the agenda to 100 minutes of effort and exclude any entry that as no effort
8560 property.  If you want to include entries with no effort property, use a
8561 negative value for @code{org-agenda-max-effort}.
8563 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8564 command.  For example, this custom command will display the next five entries
8565 with a @code{NEXT} TODO keyword.
8567 @smalllisp
8568 (setq org-agenda-custom-commands
8569       '(("n" todo "NEXT"
8570          ((org-agenda-max-entries 5)))))
8571 @end smalllisp
8573 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8574 will again the next five entries again, including the first entry that was
8575 excluded so far.
8577 You can also dynamically set temporary limits@footnote{Those temporary limits
8578 are lost when rebuilding the agenda.}:
8580 @table @kbd
8581 @orgcmd{~,org-agenda-limit-interactively}
8582 This prompts for the type of limit to apply and its value.
8583 @end table
8585 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
8586 @section Commands in the agenda buffer
8587 @cindex commands, in agenda buffer
8589 Entries in the agenda buffer are linked back to the Org file or diary
8590 file where they originate.  You are not allowed to edit the agenda
8591 buffer itself, but commands are provided to show and jump to the
8592 original entry location, and to edit the Org files ``remotely'' from
8593 the agenda buffer.  In this way, all information is stored only once,
8594 removing the risk that your agenda and note files may diverge.
8596 Some commands can be executed with mouse clicks on agenda lines.  For
8597 the other commands, the cursor needs to be in the desired line.
8599 @table @kbd
8600 @tsubheading{Motion}
8601 @cindex motion commands in agenda
8602 @orgcmd{n,org-agenda-next-line}
8603 Next line (same as @key{down} and @kbd{C-n}).
8604 @orgcmd{p,org-agenda-previous-line}
8605 Previous line (same as @key{up} and @kbd{C-p}).
8606 @tsubheading{View/Go to Org file}
8607 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8608 Display the original location of the item in another window.
8609 With prefix arg, make sure that the entire entry is made visible in the
8610 outline, not only the heading.
8612 @orgcmd{L,org-agenda-recenter}
8613 Display original location and recenter that window.
8615 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8616 Go to the original location of the item in another window.
8618 @orgcmd{@key{RET},org-agenda-switch-to}
8619 Go to the original location of the item and delete other windows.
8621 @orgcmd{F,org-agenda-follow-mode}
8622 @vindex org-agenda-start-with-follow-mode
8623 Toggle Follow mode.  In Follow mode, as you move the cursor through
8624 the agenda buffer, the other window always shows the corresponding
8625 location in the Org file.  The initial setting for this mode in new
8626 agenda buffers can be set with the variable
8627 @code{org-agenda-start-with-follow-mode}.
8629 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8630 Display the entire subtree of the current item in an indirect buffer.  With a
8631 numeric prefix argument N, go up to level N and then take that tree.  If N is
8632 negative, go up that many levels.  With a @kbd{C-u} prefix, do not remove the
8633 previously used indirect buffer.
8635 @orgcmd{C-c C-o,org-agenda-open-link}
8636 Follow a link in the entry.  This will offer a selection of any links in the
8637 text belonging to the referenced Org node.  If there is only one link, it
8638 will be followed without a selection prompt.
8640 @tsubheading{Change display}
8641 @cindex display changing, in agenda
8642 @kindex A
8643 @item A
8644 Interactively select another agenda view and append it to the current view.
8646 @kindex o
8647 @item o
8648 Delete other windows.
8650 @orgcmdkskc{v d,d,org-agenda-day-view}
8651 @xorgcmdkskc{v w,w,org-agenda-week-view}
8652 @xorgcmd{v t,org-agenda-fortnight-view}
8653 @xorgcmd{v m,org-agenda-month-view}
8654 @xorgcmd{v y,org-agenda-year-view}
8655 @xorgcmd{v SPC,org-agenda-reset-view}
8656 @vindex org-agenda-span
8657 Switch to day/week/month/year view.  When switching to day or week view, this
8658 setting becomes the default for subsequent agenda refreshes.  Since month and
8659 year views are slow to create, they do not become the default.  A numeric
8660 prefix argument may be used to jump directly to a specific day of the year,
8661 ISO week, month, or year, respectively.  For example, @kbd{32 d} jumps to
8662 February 1st, @kbd{9 w} to ISO week number 9.  When setting day, week, or
8663 month view, a year may be encoded in the prefix argument as well.  For
8664 example, @kbd{200712 w} will jump to week 12 in 2007.  If such a year
8665 specification has only one or two digits, it will be mapped to the interval
8666 1938--2037.  @kbd{v @key{SPC}} will reset to what is set in
8667 @code{org-agenda-span}.
8669 @orgcmd{f,org-agenda-later}
8670 Go forward in time to display the following @code{org-agenda-current-span} days.
8671 For example, if the display covers a week, switch to the following week.
8672 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8674 @orgcmd{b,org-agenda-earlier}
8675 Go backward in time to display earlier dates.
8677 @orgcmd{.,org-agenda-goto-today}
8678 Go to today.
8680 @orgcmd{j,org-agenda-goto-date}
8681 Prompt for a date and go there.
8683 @orgcmd{J,org-agenda-clock-goto}
8684 Go to the currently clocked-in task @i{in the agenda buffer}.
8686 @orgcmd{D,org-agenda-toggle-diary}
8687 Toggle the inclusion of diary entries.  See @ref{Weekly/daily agenda}.
8689 @orgcmdkskc{v l,l,org-agenda-log-mode}
8690 @kindex v L
8691 @vindex org-log-done
8692 @vindex org-agenda-log-mode-items
8693 Toggle Logbook mode.  In Logbook mode, entries that were marked DONE while
8694 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8695 entries that have been clocked on that day.  You can configure the entry
8696 types that should be included in log mode using the variable
8697 @code{org-agenda-log-mode-items}.  When called with a @kbd{C-u} prefix, show
8698 all possible logbook entries, including state changes.  When called with two
8699 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8700 @kbd{v L} is equivalent to @kbd{C-u v l}.
8702 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8703 Include inactive timestamps into the current view.  Only for weekly/daily
8704 agenda and timeline views.
8706 @orgcmd{v a,org-agenda-archives-mode}
8707 @xorgcmd{v A,org-agenda-archives-mode 'files}
8708 Toggle Archives mode.  In Archives mode, trees that are marked
8709 @code{ARCHIVED} are also scanned when producing the agenda.  When you use the
8710 capital @kbd{A}, even all archive files are included.  To exit archives mode,
8711 press @kbd{v a} again.
8713 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8714 @vindex org-agenda-start-with-clockreport-mode
8715 @vindex org-clock-report-include-clocking-task
8716 Toggle Clockreport mode.  In Clockreport mode, the daily/weekly agenda will
8717 always show a table with the clocked times for the time span and file scope
8718 covered by the current agenda view.  The initial setting for this mode in new
8719 agenda buffers can be set with the variable
8720 @code{org-agenda-start-with-clockreport-mode}.  By using a prefix argument
8721 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8722 contributions from entries that are hidden by agenda filtering@footnote{Only
8723 tags filtering will be respected here, effort filtering is ignored.}.  See
8724 also the variable @code{org-clock-report-include-clocking-task}.
8726 @orgkey{v c}
8727 @vindex org-agenda-clock-consistency-checks
8728 Show overlapping clock entries, clocking gaps, and other clocking problems in
8729 the current agenda range.  You can then visit clocking lines and fix them
8730 manually.  See the variable @code{org-agenda-clock-consistency-checks} for
8731 information on how to customize the definition of what constituted a clocking
8732 problem.  To return to normal agenda display, press @kbd{l} to exit Logbook
8733 mode.
8735 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8736 @vindex org-agenda-start-with-entry-text-mode
8737 @vindex org-agenda-entry-text-maxlines
8738 Toggle entry text mode.  In entry text mode, a number of lines from the Org
8739 outline node referenced by an agenda line will be displayed below the line.
8740 The maximum number of lines is given by the variable
8741 @code{org-agenda-entry-text-maxlines}.  Calling this command with a numeric
8742 prefix argument will temporarily modify that number to the prefix value.
8744 @orgcmd{G,org-agenda-toggle-time-grid}
8745 @vindex org-agenda-use-time-grid
8746 @vindex org-agenda-time-grid
8747 Toggle the time grid on and off.  See also the variables
8748 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8750 @orgcmd{r,org-agenda-redo}
8751 Recreate the agenda buffer, for example to reflect the changes after
8752 modification of the timestamps of items with @kbd{S-@key{left}} and
8753 @kbd{S-@key{right}}.  When the buffer is the global TODO list, a prefix
8754 argument is interpreted to create a selective list for a specific TODO
8755 keyword.
8756 @orgcmd{g,org-agenda-redo}
8757 Same as @kbd{r}.
8759 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8760 Save all Org buffers in the current Emacs session, and also the locations of
8761 IDs.
8763 @orgcmd{C-c C-x C-c,org-agenda-columns}
8764 @vindex org-columns-default-format
8765 Invoke column view (@pxref{Column view}) in the agenda buffer.  The column
8766 view format is taken from the entry at point, or (if there is no entry at
8767 point), from the first entry in the agenda view.  So whatever the format for
8768 that entry would be in the original buffer (taken from a property, from a
8769 @code{#+COLUMNS} line, or from the default variable
8770 @code{org-columns-default-format}), will be used in the agenda.
8772 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8773 Remove the restriction lock on the agenda, if it is currently restricted to a
8774 file or subtree (@pxref{Agenda files}).
8776 @tsubheading{Secondary filtering and query editing}
8778 For a detailed description of these commands, see @pxref{Filtering/limiting
8779 agenda items}.
8781 @orgcmd{/,org-agenda-filter-by-tag}
8782 @vindex org-agenda-tag-filter-preset
8783 Filter the agenda view with respect to a tag and/or effort estimates.
8785 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8786 Narrow the current agenda filter by an additional condition.
8788 @orgcmd{<,org-agenda-filter-by-category}
8789 @vindex org-agenda-category-filter-preset
8791 Filter the current agenda view with respect to the category of the item at
8792 point.  Pressing @code{<} another time will remove this filter.
8794 @orgcmd{^,org-agenda-filter-by-top-headline}
8795 Filter the current agenda view and only display the siblings and the parent
8796 headline of the one at point.
8798 @orgcmd{=,org-agenda-filter-by-regexp}
8799 @vindex org-agenda-regexp-filter-preset
8801 Filter the agenda view by a regular expression: only show agenda entries
8802 matching the regular expression the user entered.  When called with a prefix
8803 argument, it will filter @emph{out} entries matching the regexp.  With two
8804 universal prefix arguments, it will remove all the regexp filters, which can
8805 be accumulated.  You can add a filter preset through the option
8806 @code{org-agenda-category-filter-preset} (see below.)
8808 @orgcmd{|,org-agenda-filter-remove-all}
8809 Remove all filters in the current agenda view.
8811 @tsubheading{Remote editing}
8812 @cindex remote editing, from agenda
8814 @item 0--9
8815 Digit argument.
8817 @cindex undoing remote-editing events
8818 @cindex remote editing, undo
8819 @orgcmd{C-_,org-agenda-undo}
8820 Undo a change due to a remote editing command.  The change is undone
8821 both in the agenda buffer and in the remote buffer.
8823 @orgcmd{t,org-agenda-todo}
8824 Change the TODO state of the item, both in the agenda and in the
8825 original org file.
8827 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8828 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8829 Switch to the next/previous set of TODO keywords.
8831 @orgcmd{C-k,org-agenda-kill}
8832 @vindex org-agenda-confirm-kill
8833 Delete the current agenda item along with the entire subtree belonging
8834 to it in the original Org file.  If the text to be deleted remotely
8835 is longer than one line, the kill needs to be confirmed by the user.  See
8836 variable @code{org-agenda-confirm-kill}.
8838 @orgcmd{C-c C-w,org-agenda-refile}
8839 Refile the entry at point.
8841 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8842 @vindex org-archive-default-command
8843 Archive the subtree corresponding to the entry at point using the default
8844 archiving command set in @code{org-archive-default-command}.  When using the
8845 @code{a} key, confirmation will be required.
8847 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8848 Toggle the ARCHIVE tag for the current headline.
8850 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8851 Move the subtree corresponding to the current entry to its @emph{archive
8852 sibling}.
8854 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8855 Archive the subtree corresponding to the current headline.  This means the
8856 entry will be moved to the configured archive location, most likely a
8857 different file.
8859 @orgcmd{T,org-agenda-show-tags}
8860 @vindex org-agenda-show-inherited-tags
8861 Show all tags associated with the current item.  This is useful if you have
8862 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8863 tags of a headline occasionally.
8865 @orgcmd{:,org-agenda-set-tags}
8866 Set tags for the current headline.  If there is an active region in the
8867 agenda, change a tag for all headings in the region.
8869 @kindex ,
8870 @item ,
8871 Set the priority for the current item (@command{org-agenda-priority}).
8872 Org mode prompts for the priority character.  If you reply with @key{SPC},
8873 the priority cookie is removed from the entry.
8875 @orgcmd{P,org-agenda-show-priority}
8876 Display weighted priority of current item.
8878 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8879 Increase the priority of the current item.  The priority is changed in
8880 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
8881 key for this.
8883 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8884 Decrease the priority of the current item.
8886 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8887 @vindex org-log-into-drawer
8888 Add a note to the entry.  This note will be recorded, and then filed to the
8889 same location where state change notes are put.  Depending on
8890 @code{org-log-into-drawer}, this may be inside a drawer.
8892 @orgcmd{C-c C-a,org-attach}
8893 Dispatcher for all command related to attachments.
8895 @orgcmd{C-c C-s,org-agenda-schedule}
8896 Schedule this item.  With prefix arg remove the scheduling timestamp
8898 @orgcmd{C-c C-d,org-agenda-deadline}
8899 Set a deadline for this item.  With prefix arg remove the deadline.
8901 @orgcmd{S-@key{right},org-agenda-do-date-later}
8902 Change the timestamp associated with the current line by one day into the
8903 future.  If the date is in the past, the first call to this command will move
8904 it to today.@*
8905 With a numeric prefix argument, change it by that many days.  For example,
8906 @kbd{3 6 5 S-@key{right}} will change it by a year.  With a @kbd{C-u} prefix,
8907 change the time by one hour.  If you immediately repeat the command, it will
8908 continue to change hours even without the prefix arg.  With a double @kbd{C-u
8909 C-u} prefix, do the same for changing minutes.@*
8910 The stamp is changed in the original Org file, but the change is not directly
8911 reflected in the agenda buffer.  Use @kbd{r} or @kbd{g} to update the buffer.
8913 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8914 Change the timestamp associated with the current line by one day
8915 into the past.
8917 @orgcmd{>,org-agenda-date-prompt}
8918 Change the timestamp associated with the current line.  The key @kbd{>} has
8919 been chosen, because it is the same as @kbd{S-.}  on my keyboard.
8921 @orgcmd{I,org-agenda-clock-in}
8922 Start the clock on the current item.  If a clock is running already, it
8923 is stopped first.
8925 @orgcmd{O,org-agenda-clock-out}
8926 Stop the previously started clock.
8928 @orgcmd{X,org-agenda-clock-cancel}
8929 Cancel the currently running clock.
8931 @orgcmd{J,org-agenda-clock-goto}
8932 Jump to the running clock in another window.
8934 @orgcmd{k,org-agenda-capture}
8935 Like @code{org-capture}, but use the date at point as the default date for
8936 the capture template.  See @code{org-capture-use-agenda-date} to make this
8937 the default behavior of @code{org-capture}.
8938 @cindex capturing, from agenda
8939 @vindex org-capture-use-agenda-date
8941 @tsubheading{Dragging agenda lines forward/backward}
8942 @cindex dragging, agenda lines
8944 @orgcmd{M-<up>,org-agenda-drag-line-backward}
8945 Drag the line at point backward one line@footnote{Moving agenda lines does
8946 not persist after an agenda refresh and does not modify the contributing
8947 @file{.org} files}.  With a numeric prefix argument, drag backward by that
8948 many lines.
8950 @orgcmd{M-<down>,org-agenda-drag-line-forward}
8951 Drag the line at point forward one line.  With a numeric prefix argument,
8952 drag forward by that many lines.
8954 @tsubheading{Bulk remote editing selected entries}
8955 @cindex remote editing, bulk, from agenda
8956 @vindex org-agenda-bulk-custom-functions
8958 @orgcmd{m,org-agenda-bulk-mark}
8959 Mark the entry at point for bulk action.  With numeric prefix argument, mark
8960 that many successive entries.
8962 @orgcmd{*,org-agenda-bulk-mark-all}
8963 Mark all visible agenda entries for bulk action.
8965 @orgcmd{u,org-agenda-bulk-unmark}
8966 Unmark entry at point for bulk action.
8968 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8969 Unmark all marked entries for bulk action.
8971 @orgcmd{M-m,org-agenda-bulk-toggle}
8972 Toggle mark of the entry at point for bulk action.
8974 @orgcmd{M-*,org-agenda-bulk-toggle-all}
8975 Toggle marks of all visible entries for bulk action.
8977 @orgcmd{%,org-agenda-bulk-mark-regexp}
8978 Mark entries matching a regular expression for bulk action.
8980 @orgcmd{B,org-agenda-bulk-action}
8981 Bulk action: act on all marked entries in the agenda.  This will prompt for
8982 another key to select the action to be applied.  The prefix arg to @kbd{B}
8983 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8984 these special timestamps.  By default, marks are removed after the bulk.  If
8985 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
8986 @code{t} or hit @kbd{p} at the prompt.
8988 @table @kbd
8989 @item *
8990 Toggle persistent marks.
8991 @item $
8992 Archive all selected entries.
8993 @item A
8994 Archive entries by moving them to their respective archive siblings.
8995 @item t
8996 Change TODO state.  This prompts for a single TODO keyword and changes the
8997 state of all selected entries, bypassing blocking and suppressing logging
8998 notes (but not timestamps).
8999 @item +
9000 Add a tag to all selected entries.
9001 @item -
9002 Remove a tag from all selected entries.
9003 @item s
9004 Schedule all items to a new date.  To shift existing schedule dates by a
9005 fixed number of days, use something starting with double plus at the prompt,
9006 for example @samp{++8d} or @samp{++2w}.
9007 @item d
9008 Set deadline to a specific date.
9009 @item r
9010 Prompt for a single refile target and move all entries.  The entries will no
9011 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9012 @item S
9013 Reschedule randomly into the coming N days.  N will be prompted for.  With
9014 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9015 @item f
9016 Apply a function@footnote{You can also create persistent custom functions
9017 through @code{org-agenda-bulk-custom-functions}.} to marked entries.  For
9018 example, the function below sets the CATEGORY property of the entries to web.
9020 @lisp
9021 @group
9022 (defun set-category ()
9023   (interactive "P")
9024   (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9025                      (org-agenda-error)))
9026          (buffer (marker-buffer marker)))
9027     (with-current-buffer buffer
9028       (save-excursion
9029         (save-restriction
9030           (widen)
9031           (goto-char marker)
9032           (org-back-to-heading t)
9033           (org-set-property "CATEGORY" "web"))))))
9034 @end group
9035 @end lisp
9036 @end table
9038 @tsubheading{Calendar commands}
9039 @cindex calendar commands, from agenda
9041 @orgcmd{c,org-agenda-goto-calendar}
9042 Open the Emacs calendar and move to the date at the agenda cursor.
9044 @orgcmd{c,org-calendar-goto-agenda}
9045 When in the calendar, compute and show the Org mode agenda for the
9046 date at the cursor.
9048 @cindex diary entries, creating from agenda
9049 @orgcmd{i,org-agenda-diary-entry}
9050 @vindex org-agenda-diary-file
9051 Insert a new entry into the diary, using the date at the cursor and (for
9052 block entries) the date at the mark.  This will add to the Emacs diary
9053 file@footnote{This file is parsed for the agenda when
9054 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9055 command in the calendar.  The diary file will pop up in another window, where
9056 you can add the entry.
9058 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9059 Org will create entries (in Org mode syntax) in that file instead.  Most
9060 entries will be stored in a date-based outline tree that will later make it
9061 easy to archive appointments from previous months/years.  The tree will be
9062 built under an entry with a @code{DATE_TREE} property, or else with years as
9063 top-level entries.  Emacs will prompt you for the entry text---if you specify
9064 it, the entry will be created in @code{org-agenda-diary-file} without further
9065 interaction.  If you directly press @key{RET} at the prompt without typing
9066 text, the target file will be shown in another window for you to finish the
9067 entry there.  See also the @kbd{k r} command.
9069 @orgcmd{M,org-agenda-phases-of-moon}
9070 Show the phases of the moon for the three months around current date.
9072 @orgcmd{S,org-agenda-sunrise-sunset}
9073 Show sunrise and sunset times.  The geographical location must be set
9074 with calendar variables, see the documentation for the Emacs calendar.
9076 @orgcmd{C,org-agenda-convert-date}
9077 Convert the date at cursor into many other cultural and historic
9078 calendars.
9080 @orgcmd{H,org-agenda-holidays}
9081 Show holidays for three months around the cursor date.
9083 @item M-x org-icalendar-combine-agenda-files RET
9084 Export a single iCalendar file containing entries from all agenda files.
9085 This is a globally available command, and also available in the agenda menu.
9087 @tsubheading{Exporting to a file}
9088 @orgcmd{C-x C-w,org-agenda-write}
9089 @cindex exporting agenda views
9090 @cindex agenda views, exporting
9091 @vindex org-agenda-exporter-settings
9092 Write the agenda view to a file.  Depending on the extension of the selected
9093 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9094 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9095 (any other extension).  When exporting to Org, only the body of original
9096 headlines are exported, not subtrees or inherited tags.  When called with a
9097 @kbd{C-u} prefix argument, immediately open the newly created file.  Use the
9098 variable @code{org-agenda-exporter-settings} to set options for
9099 @file{ps-print} and for @file{htmlize} to be used during export.
9101 @tsubheading{Quit and Exit}
9102 @orgcmd{q,org-agenda-quit}
9103 Quit agenda, remove the agenda buffer.
9105 @cindex agenda files, removing buffers
9106 @orgcmd{x,org-agenda-exit}
9107 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9108 for the compilation of the agenda.  Buffers created by the user to
9109 visit Org files will not be removed.
9110 @end table
9113 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
9114 @section Custom agenda views
9115 @cindex custom agenda views
9116 @cindex agenda views, custom
9118 Custom agenda commands serve two purposes: to store and quickly access
9119 frequently used TODO and tags searches, and to create special composite
9120 agenda buffers.  Custom agenda commands will be accessible through the
9121 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9123 @menu
9124 * Storing searches::            Type once, use often
9125 * Block agenda::                All the stuff you need in a single buffer
9126 * Setting Options::             Changing the rules
9127 @end menu
9129 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
9130 @subsection Storing searches
9132 The first application of custom searches is the definition of keyboard
9133 shortcuts for frequently used searches, either creating an agenda
9134 buffer, or a sparse tree (the latter covering of course only the current
9135 buffer).
9136 @kindex C-c a C
9137 @vindex org-agenda-custom-commands
9138 @cindex agenda views, main example
9139 @cindex agenda, as an agenda views
9140 @cindex agenda*, as an agenda views
9141 @cindex tags, as an agenda view
9142 @cindex todo, as an agenda view
9143 @cindex tags-todo
9144 @cindex todo-tree
9145 @cindex occur-tree
9146 @cindex tags-tree
9148 Custom commands are configured in the variable
9149 @code{org-agenda-custom-commands}.  You can customize this variable, for
9150 example by pressing @kbd{C-c a C}.  You can also directly set it with Emacs
9151 Lisp in @file{.emacs}.  The following example contains all valid agenda
9152 views:
9154 @lisp
9155 @group
9156 (setq org-agenda-custom-commands
9157       '(("x" agenda)
9158         ("y" agenda*)
9159         ("w" todo "WAITING")
9160         ("W" todo-tree "WAITING")
9161         ("u" tags "+boss-urgent")
9162         ("v" tags-todo "+boss-urgent")
9163         ("U" tags-tree "+boss-urgent")
9164         ("f" occur-tree "\\<FIXME\\>")
9165         ("h" . "HOME+Name tags searches") ; description for "h" prefix
9166         ("hl" tags "+home+Lisa")
9167         ("hp" tags "+home+Peter")
9168         ("hk" tags "+home+Kim")))
9169 @end group
9170 @end lisp
9172 @noindent
9173 The initial string in each entry defines the keys you have to press
9174 after the dispatcher command @kbd{C-c a} in order to access the command.
9175 Usually this will be just a single character, but if you have many
9176 similar commands, you can also define two-letter combinations where the
9177 first character is the same in several combinations and serves as a
9178 prefix key@footnote{You can provide a description for a prefix key by
9179 inserting a cons cell with the prefix and the description.}.  The second
9180 parameter is the search type, followed by the string or regular
9181 expression to be used for the matching.  The example above will
9182 therefore define:
9184 @table @kbd
9185 @item C-c a x
9186 as a global search for agenda entries planned@footnote{@emph{Planned} means
9187 here that these entries have some planning information attached to them, like
9188 a time-stamp, a scheduled or a deadline string.  See
9189 @code{org-agenda-entry-types} on how to set what planning information will be
9190 taken into account.} this week/day.
9191 @item C-c a y
9192 as a global search for agenda entries planned this week/day, but only those
9193 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9194 @item C-c a w
9195 as a global search for TODO entries with @samp{WAITING} as the TODO
9196 keyword
9197 @item C-c a W
9198 as the same search, but only in the current buffer and displaying the
9199 results as a sparse tree
9200 @item C-c a u
9201 as a global tags search for headlines marked @samp{:boss:} but not
9202 @samp{:urgent:}
9203 @item C-c a v
9204 as the same search as @kbd{C-c a u}, but limiting the search to
9205 headlines that are also TODO items
9206 @item C-c a U
9207 as the same search as @kbd{C-c a u}, but only in the current buffer and
9208 displaying the result as a sparse tree
9209 @item C-c a f
9210 to create a sparse tree (again: current buffer only) with all entries
9211 containing the word @samp{FIXME}
9212 @item C-c a h
9213 as a prefix command for a HOME tags search where you have to press an
9214 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9215 Peter, or Kim) as additional tag to match.
9216 @end table
9218 Note that the @code{*-tree} agenda views need to be called from an
9219 Org buffer as they operate on the current buffer only.
9221 @node Block agenda, Setting Options, Storing searches, Custom agenda views
9222 @subsection Block agenda
9223 @cindex block agenda
9224 @cindex agenda, with block views
9226 Another possibility is the construction of agenda views that comprise
9227 the results of @emph{several} commands, each of which creates a block in
9228 the agenda buffer.  The available commands include @code{agenda} for the
9229 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9230 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9231 matching commands discussed above: @code{todo}, @code{tags}, and
9232 @code{tags-todo}.  Here are two examples:
9234 @lisp
9235 @group
9236 (setq org-agenda-custom-commands
9237       '(("h" "Agenda and Home-related tasks"
9238          ((agenda "")
9239           (tags-todo "home")
9240           (tags "garden")))
9241         ("o" "Agenda and Office-related tasks"
9242          ((agenda "")
9243           (tags-todo "work")
9244           (tags "office")))))
9245 @end group
9246 @end lisp
9248 @noindent
9249 This will define @kbd{C-c a h} to create a multi-block view for stuff
9250 you need to attend to at home.  The resulting agenda buffer will contain
9251 your agenda for the current week, all TODO items that carry the tag
9252 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
9253 command @kbd{C-c a o} provides a similar view for office tasks.
9255 @node Setting Options,  , Block agenda, Custom agenda views
9256 @subsection Setting options for custom commands
9257 @cindex options, for custom agenda views
9259 @vindex org-agenda-custom-commands
9260 Org mode contains a number of variables regulating agenda construction
9261 and display.  The global variables define the behavior for all agenda
9262 commands, including the custom commands.  However, if you want to change
9263 some settings just for a single custom view, you can do so.  Setting
9264 options requires inserting a list of variable names and values at the
9265 right spot in @code{org-agenda-custom-commands}.  For example:
9267 @lisp
9268 @group
9269 (setq org-agenda-custom-commands
9270       '(("w" todo "WAITING"
9271          ((org-agenda-sorting-strategy '(priority-down))
9272           (org-agenda-prefix-format "  Mixed: ")))
9273         ("U" tags-tree "+boss-urgent"
9274          ((org-show-following-heading nil)
9275           (org-show-hierarchy-above nil)))
9276         ("N" search ""
9277          ((org-agenda-files '("~org/notes.org"))
9278           (org-agenda-text-search-extra-files nil)))))
9279 @end group
9280 @end lisp
9282 @noindent
9283 Now the @kbd{C-c a w} command will sort the collected entries only by
9284 priority, and the prefix format is modified to just say @samp{  Mixed: }
9285 instead of giving the category of the entry.  The sparse tags tree of
9286 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9287 headline hierarchy above the match, nor the headline following the match
9288 will be shown.  The command @kbd{C-c a N} will do a text search limited
9289 to only a single file.
9291 @vindex org-agenda-custom-commands
9292 For command sets creating a block agenda,
9293 @code{org-agenda-custom-commands} has two separate spots for setting
9294 options.  You can add options that should be valid for just a single
9295 command in the set, and options that should be valid for all commands in
9296 the set.  The former are just added to the command entry; the latter
9297 must come after the list of command entries.  Going back to the block
9298 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9299 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9300 the results for GARDEN tags query in the opposite order,
9301 @code{priority-up}.  This would look like this:
9303 @lisp
9304 @group
9305 (setq org-agenda-custom-commands
9306       '(("h" "Agenda and Home-related tasks"
9307          ((agenda)
9308           (tags-todo "home")
9309           (tags "garden"
9310                 ((org-agenda-sorting-strategy '(priority-up)))))
9311          ((org-agenda-sorting-strategy '(priority-down))))
9312         ("o" "Agenda and Office-related tasks"
9313          ((agenda)
9314           (tags-todo "work")
9315           (tags "office")))))
9316 @end group
9317 @end lisp
9319 As you see, the values and parentheses setting is a little complex.
9320 When in doubt, use the customize interface to set this variable---it
9321 fully supports its structure.  Just one caveat: when setting options in
9322 this interface, the @emph{values} are just Lisp expressions.  So if the
9323 value is a string, you need to add the double-quotes around the value
9324 yourself.
9326 @vindex org-agenda-custom-commands-contexts
9327 To control whether an agenda command should be accessible from a specific
9328 context, you can customize @code{org-agenda-custom-commands-contexts}.  Let's
9329 say for example that you have an agenda commands @code{"o"} displaying a view
9330 that you only need when reading emails.  Then you would configure this option
9331 like this:
9333 @lisp
9334 (setq org-agenda-custom-commands-contexts
9335       '(("o" (in-mode . "message-mode"))))
9336 @end lisp
9338 You can also tell that the command key @code{"o"} should refer to another
9339 command key @code{"r"}.  In that case, add this command key like this:
9341 @lisp
9342 (setq org-agenda-custom-commands-contexts
9343       '(("o" "r" (in-mode . "message-mode"))))
9344 @end lisp
9346 See the docstring of the variable for more information.
9348 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
9349 @section Exporting Agenda Views
9350 @cindex agenda views, exporting
9352 If you are away from your computer, it can be very useful to have a printed
9353 version of some agenda views to carry around.  Org mode can export custom
9354 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9355 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9356 ghostscript @file{ps2pdf} utility must be installed on the system.  Selecting
9357 a PDF file will also create the postscript file.}, and iCalendar files.  If
9358 you want to do this only occasionally, use the command
9360 @table @kbd
9361 @orgcmd{C-x C-w,org-agenda-write}
9362 @cindex exporting agenda views
9363 @cindex agenda views, exporting
9364 @vindex org-agenda-exporter-settings
9365 Write the agenda view to a file.  Depending on the extension of the selected
9366 file name, the view will be exported as HTML (extension @file{.html} or
9367 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9368 @file{.ics}), or plain text (any other extension).  Use the variable
9369 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9370 for @file{htmlize} to be used during export, for example
9372 @vindex org-agenda-add-entry-text-maxlines
9373 @vindex htmlize-output-type
9374 @vindex ps-number-of-columns
9375 @vindex ps-landscape-mode
9376 @lisp
9377 (setq org-agenda-exporter-settings
9378       '((ps-number-of-columns 2)
9379         (ps-landscape-mode t)
9380         (org-agenda-add-entry-text-maxlines 5)
9381         (htmlize-output-type 'css)))
9382 @end lisp
9383 @end table
9385 If you need to export certain agenda views frequently, you can associate
9386 any custom agenda command with a list of output file names
9387 @footnote{If you want to store standard views like the weekly agenda
9388 or the global TODO list as well, you need to define custom commands for
9389 them in order to be able to specify file names.}.  Here is an example
9390 that first defines custom commands for the agenda and the global
9391 TODO list, together with a number of files to which to export them.
9392 Then we define two block agenda commands and specify file names for them
9393 as well.  File names can be relative to the current working directory,
9394 or absolute.
9396 @lisp
9397 @group
9398 (setq org-agenda-custom-commands
9399       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9400         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9401         ("h" "Agenda and Home-related tasks"
9402          ((agenda "")
9403           (tags-todo "home")
9404           (tags "garden"))
9405          nil
9406          ("~/views/home.html"))
9407         ("o" "Agenda and Office-related tasks"
9408          ((agenda)
9409           (tags-todo "work")
9410           (tags "office"))
9411          nil
9412          ("~/views/office.ps" "~/calendars/office.ics"))))
9413 @end group
9414 @end lisp
9416 The extension of the file name determines the type of export.  If it is
9417 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9418 the buffer to HTML and save it to this file name.  If the extension is
9419 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9420 Postscript output.  If the extension is @file{.ics}, iCalendar export is
9421 run export over all files that were used to construct the agenda, and
9422 limit the export to entries listed in the agenda.  Any other
9423 extension produces a plain ASCII file.
9425 The export files are @emph{not} created when you use one of those
9426 commands interactively because this might use too much overhead.
9427 Instead, there is a special command to produce @emph{all} specified
9428 files in one step:
9430 @table @kbd
9431 @orgcmd{C-c a e,org-store-agenda-views}
9432 Export all agenda views that have export file names associated with
9433 them.
9434 @end table
9436 You can use the options section of the custom agenda commands to also
9437 set options for the export commands.  For example:
9439 @lisp
9440 (setq org-agenda-custom-commands
9441       '(("X" agenda ""
9442          ((ps-number-of-columns 2)
9443           (ps-landscape-mode t)
9444           (org-agenda-prefix-format " [ ] ")
9445           (org-agenda-with-colors nil)
9446           (org-agenda-remove-tags t))
9447          ("theagenda.ps"))))
9448 @end lisp
9450 @noindent
9451 This command sets two options for the Postscript exporter, to make it
9452 print in two columns in landscape format---the resulting page can be cut
9453 in two and then used in a paper agenda.  The remaining settings modify
9454 the agenda prefix to omit category and scheduling information, and
9455 instead include a checkbox to check off items.  We also remove the tags
9456 to make the lines compact, and we don't want to use colors for the
9457 black-and-white printer.  Settings specified in
9458 @code{org-agenda-exporter-settings} will also apply, but the settings
9459 in @code{org-agenda-custom-commands} take precedence.
9461 @noindent
9462 From the command line you may also use
9463 @example
9464 emacs -eval (org-batch-store-agenda-views) -kill
9465 @end example
9466 @noindent
9467 or, if you need to modify some parameters@footnote{Quoting depends on the
9468 system you use, please check the FAQ for examples.}
9469 @example
9470 emacs -eval '(org-batch-store-agenda-views                      \
9471               org-agenda-span (quote month)                     \
9472               org-agenda-start-day "2007-11-01"                 \
9473               org-agenda-include-diary nil                      \
9474               org-agenda-files (quote ("~/org/project.org")))'  \
9475       -kill
9476 @end example
9477 @noindent
9478 which will create the agenda views restricted to the file
9479 @file{~/org/project.org}, without diary entries and with a 30-day
9480 extent.
9482 You can also extract agenda information in a way that allows further
9483 processing by other programs.  See @ref{Extracting agenda information}, for
9484 more information.
9487 @node Agenda column view,  , Exporting Agenda Views, Agenda Views
9488 @section Using column view in the agenda
9489 @cindex column view, in agenda
9490 @cindex agenda, column view
9492 Column view (@pxref{Column view}) is normally used to view and edit
9493 properties embedded in the hierarchical structure of an Org file.  It can be
9494 quite useful to use column view also from the agenda, where entries are
9495 collected by certain criteria.
9497 @table @kbd
9498 @orgcmd{C-c C-x C-c,org-agenda-columns}
9499 Turn on column view in the agenda.
9500 @end table
9502 To understand how to use this properly, it is important to realize that the
9503 entries in the agenda are no longer in their proper outline environment.
9504 This causes the following issues:
9506 @enumerate
9507 @item
9508 @vindex org-columns-default-format
9509 @vindex org-overriding-columns-format
9510 Org needs to make a decision which @code{COLUMNS} format to use.  Since the
9511 entries in the agenda are collected from different files, and different files
9512 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9513 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9514 currently set, and if so, takes the format from there.  Otherwise it takes
9515 the format associated with the first item in the agenda, or, if that item
9516 does not have a specific format (defined in a property, or in its file), it
9517 uses @code{org-columns-default-format}.
9518 @item
9519 @cindex property, special, CLOCKSUM
9520 If any of the columns has a summary type defined (@pxref{Column attributes}),
9521 turning on column view in the agenda will visit all relevant agenda files and
9522 make sure that the computations of this property are up to date.  This is
9523 also true for the special @code{CLOCKSUM} property.  Org will then sum the
9524 values displayed in the agenda.  In the daily/weekly agenda, the sums will
9525 cover a single day; in all other views they cover the entire block.  It is
9526 vital to realize that the agenda may show the same entry @emph{twice} (for
9527 example as scheduled and as a deadline), and it may show two entries from the
9528 same hierarchy (for example a @emph{parent} and its @emph{child}).  In these
9529 cases, the summation in the agenda will lead to incorrect results because
9530 some values will count double.
9531 @item
9532 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9533 the entire clocked time for this item.  So even in the daily/weekly agenda,
9534 the clocksum listed in column view may originate from times outside the
9535 current view.  This has the advantage that you can compare these values with
9536 a column listing the planned total effort for a task---one of the major
9537 applications for column view in the agenda.  If you want information about
9538 clocked time in the displayed period use clock table mode (press @kbd{R} in
9539 the agenda).
9541 @item
9542 @cindex property, special, CLOCKSUM_T
9543 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9544 always today's clocked time for this item.  So even in the weekly agenda,
9545 the clocksum listed in column view only originates from today.  This lets
9546 you compare the time you spent on a task for today, with the time already
9547 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9548 @end enumerate
9551 @node Markup, Exporting, Agenda Views, Top
9552 @chapter Markup for rich export
9554 When exporting Org mode documents, the exporter tries to reflect the
9555 structure of the document as accurately as possible in the back-end.  Since
9556 export targets like HTML, @LaTeX{} allow much richer formatting, Org mode has
9557 rules on how to prepare text for rich export.  This section summarizes the
9558 markup rules used in an Org mode buffer.
9560 @menu
9561 * Structural markup elements::  The basic structure as seen by the exporter
9562 * Images and tables::           Images, tables and caption mechanism
9563 * Literal examples::            Source code examples with special formatting
9564 * Include files::               Include additional files into a document
9565 * Index entries::               Making an index
9566 * Macro replacement::           Use macros to create templates
9567 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
9568 * Special blocks::              Containers targeted at export back-ends
9569 @end menu
9571 @node Structural markup elements, Images and tables, Markup, Markup
9572 @section Structural markup elements
9574 @menu
9575 * Document title::              Where the title is taken from
9576 * Headings and sections::       The document structure as seen by the exporter
9577 * Table of contents::           The if and where of the table of contents
9578 * Lists::                       Lists
9579 * Paragraphs::                  Paragraphs
9580 * Footnote markup::             Footnotes
9581 * Emphasis and monospace::      Bold, italic, etc.
9582 * Horizontal rules::            Make a line
9583 * Comment lines::               What will *not* be exported
9584 @end menu
9586 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
9587 @subheading Document title
9588 @cindex document title, markup rules
9590 @noindent
9591 The title of the exported document is taken from the special line
9593 @cindex #+TITLE
9594 @example
9595 #+TITLE: This is the title of the document
9596 @end example
9598 @noindent
9599 If this line does not exist, the title will be the name of the file
9600 associated to buffer, without extension, or the buffer name.
9602 @cindex property, EXPORT_TITLE
9603 If you are exporting only a subtree, its heading will become the title of the
9604 document.  If the subtree has a property @code{EXPORT_TITLE}, that will take
9605 precedence.
9607 @node Headings and sections, Table of contents, Document title, Structural markup elements
9608 @subheading Headings and sections
9609 @cindex headings and sections, markup rules
9611 @vindex org-export-headline-levels
9612 The outline structure of the document as described in @ref{Document
9613 Structure}, forms the basis for defining sections of the exported document.
9614 However, since the outline structure is also used for (for example) lists of
9615 tasks, only the first three outline levels will be used as headings.  Deeper
9616 levels will become itemized lists.  You can change the location of this
9617 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9618 per-file basis with a line
9620 @cindex #+OPTIONS
9621 @example
9622 #+OPTIONS: H:4
9623 @end example
9625 @node Table of contents, Lists, Headings and sections, Structural markup elements
9626 @subheading Table of contents
9627 @cindex table of contents, markup rules
9629 @cindex #+TOC
9630 @vindex org-export-with-toc
9631 The table of contents is normally inserted directly before the first headline
9632 of the file.  The depth of the table is by default the same as the number of
9633 headline levels, but you can choose a smaller number, or turn off the table
9634 of contents entirely, by configuring the variable @code{org-export-with-toc},
9635 or on a per-file basis with a line like
9637 @example
9638 #+OPTIONS: toc:2          (only to two levels in TOC)
9639 #+OPTIONS: toc:nil        (no default TOC at all)
9640 @end example
9642 If you would like to move the table of contents to a different location, you
9643 should turn off the default table using @code{org-export-with-toc} or
9644 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9645 location(s).
9647 @example
9648 #+OPTIONS: toc:nil        (no default TOC)
9650 #+TOC: headlines 2        (insert TOC here, with two headline levels)
9651 @end example
9653 Multiple @code{#+TOC: headline} lines are allowed.  The same @code{TOC}
9654 keyword can also generate a list of all tables (resp.@: all listings) with a
9655 caption in the buffer.
9657 @example
9658 #+TOC: listings           (build a list of listings)
9659 #+TOC: tables             (build a list of tables)
9660 @end example
9662 @cindex property, ALT_TITLE
9663 The headline's title usually determines its corresponding entry in a table of
9664 contents.  However, it is possible to specify an alternative title by
9665 setting @code{ALT_TITLE} property accordingly.  It will then be used when
9666 building the table.
9668 @node Lists, Paragraphs, Table of contents, Structural markup elements
9669 @subheading Lists
9670 @cindex lists, markup rules
9672 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9673 syntax for such lists.  Most back-ends support unordered, ordered, and
9674 description lists.
9676 @node Paragraphs, Footnote markup, Lists, Structural markup elements
9677 @subheading Paragraphs, line breaks, and quoting
9678 @cindex paragraphs, markup rules
9680 Paragraphs are separated by at least one empty line.  If you need to enforce
9681 a line break within a paragraph, use @samp{\\} at the end of a line.
9683 To keep the line breaks in a region, but otherwise use normal formatting, you
9684 can use this construct, which can also be used to format poetry.
9686 @cindex #+BEGIN_VERSE
9687 @example
9688 #+BEGIN_VERSE
9689  Great clouds overhead
9690  Tiny black birds rise and fall
9691  Snow covers Emacs
9693      -- AlexSchroeder
9694 #+END_VERSE
9695 @end example
9697 When quoting a passage from another document, it is customary to format this
9698 as a paragraph that is indented on both the left and the right margin.  You
9699 can include quotations in Org mode documents like this:
9701 @cindex #+BEGIN_QUOTE
9702 @example
9703 #+BEGIN_QUOTE
9704 Everything should be made as simple as possible,
9705 but not any simpler -- Albert Einstein
9706 #+END_QUOTE
9707 @end example
9709 If you would like to center some text, do it like this:
9710 @cindex #+BEGIN_CENTER
9711 @example
9712 #+BEGIN_CENTER
9713 Everything should be made as simple as possible, \\
9714 but not any simpler
9715 #+END_CENTER
9716 @end example
9719 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
9720 @subheading Footnote markup
9721 @cindex footnotes, markup rules
9722 @cindex @file{footnote.el}
9724 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9725 by all back-ends.  Org allows multiple references to the same note, and
9726 multiple footnotes side by side.
9728 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
9729 @subheading Emphasis and monospace
9731 @cindex underlined text, markup rules
9732 @cindex bold text, markup rules
9733 @cindex italic text, markup rules
9734 @cindex verbatim text, markup rules
9735 @cindex code text, markup rules
9736 @cindex strike-through text, markup rules
9737 @vindex org-fontify-emphasized-text
9738 @vindex org-emphasis-regexp-components
9739 @vindex org-emphasis-alist
9740 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9741 and @code{~code~}, and, if you must, @samp{+strike-through+}.  Text
9742 in the code and verbatim string is not processed for Org mode specific
9743 syntax, it is exported verbatim.
9745 To turn off fontification for marked up text, you can set
9746 @code{org-fontify-emphasized-text} to @code{nil}.  To narrow down the list of
9747 available markup syntax, you can customize @code{org-emphasis-alist}.  To fine
9748 tune what characters are allowed before and after the markup characters, you
9749 can tweak @code{org-emphasis-regexp-components}.  Beware that changing one of
9750 the above variables will no take effect until you reload Org, for which you
9751 may need to restart Emacs.
9753 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
9754 @subheading  Horizontal rules
9755 @cindex horizontal rules, markup rules
9756 A line consisting of only dashes, and at least 5 of them, will be exported as
9757 a horizontal line.
9759 @node Comment lines,  , Horizontal rules, Structural markup elements
9760 @subheading Comment lines
9761 @cindex comment lines
9762 @cindex exporting, not
9763 @cindex #+BEGIN_COMMENT
9765 Lines starting with zero or more whitespace characters followed by one
9766 @samp{#} and a whitespace are treated as comments and will never be exported.
9767 Also entire subtrees starting with the word @samp{COMMENT} will never be
9768 exported.  Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
9769 ... @samp{#+END_COMMENT} will not be exported.
9771 @table @kbd
9772 @kindex C-c ;
9773 @item C-c ;
9774 Toggle the COMMENT keyword at the beginning of an entry.
9775 @end table
9778 @node Images and tables, Literal examples, Structural markup elements, Markup
9779 @section Images and Tables
9781 @cindex tables, markup rules
9782 @cindex #+CAPTION
9783 @cindex #+NAME
9784 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9785 the @file{table.el} package will be exported properly.  For Org mode tables,
9786 the lines before the first horizontal separator line will become table header
9787 lines.  You can use the following lines somewhere before the table to assign
9788 a caption and a label for cross references, and in the text you can refer to
9789 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9791 @example
9792 #+CAPTION: This is the caption for the next table (or link)
9793 #+NAME:   tab:basic-data
9794    | ... | ...|
9795    |-----|----|
9796 @end example
9798 Optionally, the caption can take the form:
9799 @example
9800 #+CAPTION[Caption for list of tables]: Caption for table.
9801 @end example
9803 @cindex inlined images, markup rules
9804 Some back-ends allow you to directly include images into the exported
9805 document.  Org does this, if a link to an image files does not have
9806 a description part, for example @code{[[./img/a.jpg]]}.  If you wish to
9807 define a caption for the image and maybe a label for internal cross
9808 references, make sure that the link is on a line by itself and precede it
9809 with @code{#+CAPTION} and @code{#+NAME} as follows:
9811 @example
9812 #+CAPTION: This is the caption for the next figure link (or table)
9813 #+NAME:   fig:SED-HR4049
9814 [[./img/a.jpg]]
9815 @end example
9817 @noindent
9818 Such images can be displayed within the buffer.  @xref{Handling links,the
9819 discussion of image links}.
9821 Even though images and tables are prominent examples of captioned structures,
9822 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9823 equations, source code blocks).  Depending on the export back-end, those may
9824 or may not be handled.
9826 @node Literal examples, Include files, Images and tables, Markup
9827 @section Literal examples
9828 @cindex literal examples, markup rules
9829 @cindex code line references, markup rules
9831 You can include literal examples that should not be subjected to
9832 markup.  Such examples will be typeset in monospace, so this is well suited
9833 for source code and similar examples.
9834 @cindex #+BEGIN_EXAMPLE
9836 @example
9837 #+BEGIN_EXAMPLE
9838 Some example from a text file.
9839 #+END_EXAMPLE
9840 @end example
9842 Note that such blocks may be @i{indented} in order to align nicely with
9843 indented text and in particular with plain list structure (@pxref{Plain
9844 lists}).  For simplicity when using small examples, you can also start the
9845 example lines with a colon followed by a space.  There may also be additional
9846 whitespace before the colon:
9848 @example
9849 Here is an example
9850    : Some example from a text file.
9851 @end example
9853 @cindex formatting source code, markup rules
9854 If the example is source code from a programming language, or any other text
9855 that can be marked up by font-lock in Emacs, you can ask for the example to
9856 look like the fontified Emacs buffer@footnote{This works automatically for
9857 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9858 which is distributed with Org).  Fontified code chunks in @LaTeX{} can be
9859 achieved using either the listings or the
9860 @url{http://code.google.com/p/minted, minted,} package.  Refer to
9861 @code{org-latex-listings} documentation for details.}.  This is done
9862 with the @samp{src} block, where you also need to specify the name of the
9863 major mode that should be used to fontify the example@footnote{Code in
9864 @samp{src} blocks may also be evaluated either interactively or on export.
9865 See @pxref{Working With Source Code} for more information on evaluating code
9866 blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code
9867 blocks.
9868 @cindex #+BEGIN_SRC
9870 @example
9871 #+BEGIN_SRC emacs-lisp
9872   (defun org-xor (a b)
9873      "Exclusive or."
9874      (if a (not b) b))
9875 #+END_SRC
9876 @end example
9878 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9879 switch to the end of the @code{BEGIN} line, to get the lines of the example
9880 numbered.  If you use a @code{+n} switch, the numbering from the previous
9881 numbered snippet will be continued in the current one.  In literal examples,
9882 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9883 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9884 enclosed in single parenthesis).  In HTML, hovering the mouse over such a
9885 link will remote-highlight the corresponding code line, which is kind of
9886 cool.
9888 You can also add a @code{-r} switch which @i{removes} the labels from the
9889 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9890 labels in the source code while using line numbers for the links, which might
9891 be useful to explain those in an Org mode example code.}.  With the @code{-n}
9892 switch, links to these references will be labeled by the line numbers from
9893 the code listing, otherwise links will use the labels with no parentheses.
9894 Here is an example:
9896 @example
9897 #+BEGIN_SRC emacs-lisp -n -r
9898 (save-excursion                  (ref:sc)
9899    (goto-char (point-min)))      (ref:jump)
9900 #+END_SRC
9901 In line [[(sc)]] we remember the current position.  [[(jump)][Line (jump)]]
9902 jumps to point-min.
9903 @end example
9905 @vindex org-coderef-label-format
9906 If the syntax for the label format conflicts with the language syntax, use a
9907 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9908 -n -r -l "((%s))"}.  See also the variable @code{org-coderef-label-format}.
9910 HTML export also allows examples to be published as text areas (@pxref{Text
9911 areas in HTML export}).
9913 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9914 so often, shortcuts are provided using the Easy Templates facility
9915 (@pxref{Easy Templates}).
9917 @table @kbd
9918 @kindex C-c '
9919 @item C-c '
9920 Edit the source code example at point in its native mode.  This works by
9921 switching to a temporary buffer with the source code.  You need to exit by
9922 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9923 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9924 from being interpreted by Org as outline nodes or special syntax.  These
9925 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9926 The edited version will then replace the old version in the Org buffer.
9927 Fixed-width regions (where each line starts with a colon followed by a space)
9928 will be edited using @code{artist-mode}@footnote{You may select
9929 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9930 to allow creating ASCII drawings easily.  Using this command in an empty line
9931 will create a new fixed-width region.
9932 @kindex C-c l
9933 @item C-c l
9934 Calling @code{org-store-link} while editing a source code example in a
9935 temporary buffer created with @kbd{C-c '} will prompt for a label.  Make sure
9936 that it is unique in the current buffer, and insert it with the proper
9937 formatting like @samp{(ref:label)} at the end of the current line.  Then the
9938 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9939 @end table
9942 @node Include files, Index entries, Literal examples, Markup
9943 @section Include files
9944 @cindex include files, markup rules
9946 During export, you can include the content of another file.  For example, to
9947 include your @file{.emacs} file, you could use:
9948 @cindex #+INCLUDE
9950 @example
9951 #+INCLUDE: "~/.emacs" src emacs-lisp
9952 @end example
9954 @noindent
9955 The optional second and third parameter are the markup (e.g., @samp{quote},
9956 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9957 language for formatting the contents.  The markup is optional; if it is not
9958 given, the text will be assumed to be in Org mode format and will be
9959 processed normally.
9961 Contents of the included file will belong to the same structure (headline,
9962 item) containing the @code{INCLUDE} keyword.  In particular, headlines within
9963 the file will become children of the current section.  That behavior can be
9964 changed by providing an additional keyword parameter, @code{:minlevel}.  In
9965 that case, all headlines in the included file will be shifted so the one with
9966 the lowest level reaches that specified level.  For example, to make a file
9967 become a sibling of the current top-level headline, use
9969 @example
9970 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
9971 @end example
9973 You can also include a portion of a file by specifying a lines range using
9974 the @code{:lines} parameter.  The line at the upper end of the range will not
9975 be included.  The start and/or the end of the range may be omitted to use the
9976 obvious defaults.
9978 @example
9979 #+INCLUDE: "~/.emacs" :lines "5-10"   @r{Include lines 5 to 10, 10 excluded}
9980 #+INCLUDE: "~/.emacs" :lines "-10"    @r{Include lines 1 to 10, 10 excluded}
9981 #+INCLUDE: "~/.emacs" :lines "10-"    @r{Include lines from 10 to EOF}
9982 @end example
9984 @table @kbd
9985 @kindex C-c '
9986 @item C-c '
9987 Visit the include file at point.
9988 @end table
9990 @node Index entries, Macro replacement, Include files, Markup
9991 @section Index entries
9992 @cindex index entries, for publishing
9994 You can specify entries that will be used for generating an index during
9995 publishing.  This is done by lines starting with @code{#+INDEX}.  An entry
9996 the contains an exclamation mark will create a sub item.  See @ref{Generating
9997 an index} for more information.
9999 @example
10000 * Curriculum Vitae
10001 #+INDEX: CV
10002 #+INDEX: Application!CV
10003 @end example
10008 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
10009 @section Macro replacement
10010 @cindex macro replacement, during export
10011 @cindex #+MACRO
10013 You can define text snippets with
10015 @example
10016 #+MACRO: name   replacement text $1, $2 are arguments
10017 @end example
10019 @noindent which can be referenced in
10020 paragraphs, verse blocks, table cells and some keywords with
10021 @code{@{@{@{name(arg1,arg2)@}@}@}}@footnote{Since commas separate arguments,
10022 commas within arguments have to be escaped with a backslash character.
10023 Conversely, backslash characters before a comma, and only them, need to be
10024 escaped with another backslash character.}.  In addition to defined macros,
10025 @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will reference
10026 information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and similar lines.
10027 Also, @code{@{@{@{time(@var{FORMAT})@}@}@}} and
10028 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
10029 and to the modification time of the file being exported, respectively.
10030 @var{FORMAT} should be a format string understood by
10031 @code{format-time-string}.
10033 Macro expansion takes place during export.
10036 @node Embedded @LaTeX{}, Special blocks, Macro replacement, Markup
10037 @section Embedded @LaTeX{}
10038 @cindex @TeX{} interpretation
10039 @cindex @LaTeX{} interpretation
10041 Plain ASCII is normally sufficient for almost all note taking.  Exceptions
10042 include scientific notes, which often require mathematical symbols and the
10043 occasional formula.  @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10044 Donald E. Knuth's @TeX{} system.  Many of the features described here as
10045 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10046 distinction.}  is widely used to typeset scientific documents.  Org mode
10047 supports embedding @LaTeX{} code into its files, because many academics are
10048 used to writing and reading @LaTeX{} source code, and because it can be
10049 readily processed to produce pretty output for a number of export back-ends.
10051 @menu
10052 * Special symbols::             Greek letters and other symbols
10053 * Subscripts and superscripts::  Simple syntax for raising/lowering text
10054 * @LaTeX{} fragments::          Complex formulas made easy
10055 * Previewing @LaTeX{} fragments::  What will this snippet look like?
10056 * CDLaTeX mode::                Speed up entering of formulas
10057 @end menu
10059 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
10060 @subsection Special symbols
10061 @cindex math symbols
10062 @cindex special symbols
10063 @cindex @TeX{} macros
10064 @cindex @LaTeX{} fragments, markup rules
10065 @cindex HTML entities
10066 @cindex @LaTeX{} entities
10068 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10069 to indicate the Greek letter, or @samp{\to} to indicate an arrow.  Completion
10070 for these symbols is available, just type @samp{\} and maybe a few letters,
10071 and press @kbd{M-@key{TAB}} to see possible completions.  Unlike @LaTeX{}
10072 code, Org mode allows these symbols to be present without surrounding math
10073 delimiters, for example:
10075 @example
10076 Angles are written as Greek letters \alpha, \beta and \gamma.
10077 @end example
10079 @vindex org-entities
10080 During export, these symbols will be transformed into the native format of
10081 the exporter back-end.  Strings like @code{\alpha} will be exported as
10082 @code{&alpha;} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
10083 output.  Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
10084 @code{~} in @LaTeX{}.  If you need such a symbol inside a word, terminate it
10085 like this: @samp{\Aacute@{@}stor}.
10087 A large number of entities is provided, with names taken from both HTML and
10088 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10089 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10090 @samp{...} are all converted into special commands creating hyphens of
10091 different lengths or a compact set of dots.
10093 If you would like to see entities displayed as UTF-8 characters, use the
10094 following command@footnote{You can turn this on by default by setting the
10095 variable @code{org-pretty-entities}, or on a per-file base with the
10096 @code{#+STARTUP} option @code{entitiespretty}.}:
10098 @table @kbd
10099 @cindex @code{entitiespretty}, STARTUP keyword
10100 @kindex C-c C-x \
10101 @item C-c C-x \
10102 Toggle display of entities as UTF-8 characters.  This does not change the
10103 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10104 for display purposes only.
10105 @end table
10107 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
10108 @subsection Subscripts and superscripts
10109 @cindex subscript
10110 @cindex superscript
10112 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10113 subscripts.  Again, these can be used without embedding them in math-mode
10114 delimiters.  To increase the readability of ASCII text, it is not necessary
10115 (but OK) to surround multi-character sub- and superscripts with curly braces.
10116 For example
10118 @example
10119 The mass of the sun is M_sun = 1.989 x 10^30 kg.  The radius of
10120 the sun is R_@{sun@} = 6.96 x 10^8 m.
10121 @end example
10123 @vindex org-use-sub-superscripts
10124 If you write a text where the underscore is often used in a different
10125 context, Org's convention to always interpret these as subscripts can get in
10126 your way.  Configure the variable @code{org-use-sub-superscripts} to change
10127 this convention.  For example, when setting this variable to @code{@{@}},
10128 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10130 @table @kbd
10131 @kindex C-c C-x \
10132 @item C-c C-x \
10133 In addition to showing entities as UTF-8 characters, this command will also
10134 format sub- and superscripts in a WYSIWYM way.
10135 @end table
10137 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
10138 @subsection @LaTeX{} fragments
10139 @cindex @LaTeX{} fragments
10141 @vindex org-format-latex-header
10142 Going beyond symbols and sub- and superscripts, a full formula language is
10143 needed.  Org mode can contain @LaTeX{} math fragments, and it supports ways
10144 to process these for several export back-ends.  When exporting to @LaTeX{},
10145 the code is obviously left as it is.  When exporting to HTML, Org invokes the
10146 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
10147 HTML export}) to process and display the math@footnote{If you plan to use
10148 this regularly or on pages with significant page views, you should install
10149 @file{MathJax} on your own server in order to limit the load of our server.}.
10150 Finally, it can also process the mathematical expressions into
10151 images@footnote{For this to work you need to be on a system with a working
10152 @LaTeX{} installation.  You also need the @file{dvipng} program or the
10153 @file{convert}, respectively available at
10154 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10155 suite.  The @LaTeX{} header that will be used when processing a fragment can
10156 be configured with the variable @code{org-format-latex-header}.} that can be
10157 displayed in a browser.
10159 @LaTeX{} fragments don't need any special marking at all.  The following
10160 snippets will be identified as @LaTeX{} source code:
10161 @itemize @bullet
10162 @item
10163 Environments of any kind@footnote{When @file{MathJax} is used, only the
10164 environments recognized by @file{MathJax} will be processed.  When
10165 @file{dvipng} program or @file{imagemagick} suite is used to create images,
10166 any @LaTeX{} environment will be handled.}.  The only requirement is that the
10167 @code{\begin} and @code{\end} statements appear on a new line, at the
10168 beginning of the line or after whitespaces only.
10169 @item
10170 Text within the usual @LaTeX{} math delimiters.  To avoid conflicts with
10171 currency specifications, single @samp{$} characters are only recognized as
10172 math delimiters if the enclosed text contains at most two line breaks, is
10173 directly attached to the @samp{$} characters with no whitespace in between,
10174 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
10175 For the other delimiters, there is no such restriction, so when in doubt, use
10176 @samp{\(...\)} as inline math delimiters.
10177 @end itemize
10179 @noindent For example:
10181 @example
10182 \begin@{equation@}
10183 x=\sqrt@{b@}
10184 \end@{equation@}
10186 If $a^2=b$ and \( b=2 \), then the solution must be
10187 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10188 @end example
10190 @c FIXME
10191 @c @noindent
10192 @c @vindex org-format-latex-options
10193 @c If you need any of the delimiter ASCII sequences for other purposes, you
10194 @c can configure the option @code{org-format-latex-options} to deselect the
10195 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10197 @vindex org-export-with-latex
10198 @LaTeX{} processing can be configured with the variable
10199 @code{org-export-with-latex}.  The default setting is @code{t} which means
10200 @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10201 You can also set this variable on a per-file basis using one of these
10202 lines:
10204 @example
10205 #+OPTIONS: tex:t          @r{Do the right thing automatically (MathJax)}
10206 #+OPTIONS: tex:nil        @r{Do not process @LaTeX{} fragments at all}
10207 #+OPTIONS: tex:verbatim   @r{Verbatim export, for jsMath or so}
10208 @end example
10210 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
10211 @subsection Previewing @LaTeX{} fragments
10212 @cindex @LaTeX{} fragments, preview
10214 @vindex org-latex-create-formula-image-program
10215 If you have @file{dvipng} or @file{imagemagick} installed@footnote{Choose the
10216 converter by setting the variable
10217 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10218 fragments can be processed to produce preview images of the typeset
10219 expressions:
10221 @table @kbd
10222 @kindex C-c C-x C-l
10223 @item C-c C-x C-l
10224 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10225 over the source code.  If there is no fragment at point, process all
10226 fragments in the current entry (between two headlines).  When called
10227 with a prefix argument, process the entire subtree.  When called with
10228 two prefix arguments, or when the cursor is before the first headline,
10229 process the entire buffer.
10230 @kindex C-c C-c
10231 @item C-c C-c
10232 Remove the overlay preview images.
10233 @end table
10235 @vindex org-format-latex-options
10236 You can customize the variable @code{org-format-latex-options} to influence
10237 some aspects of the preview.  In particular, the @code{:scale} (and for HTML
10238 export, @code{:html-scale}) property can be used to adjust the size of the
10239 preview images.
10241 @vindex org-startup-with-latex-preview
10242 You can turn on the previewing of all @LaTeX{} fragments in a file with
10244 @example
10245 #+STARTUP: latexpreview
10246 @end example
10248 To disable it, simply use
10250 @example
10251 #+STARTUP: nolatexpreview
10252 @end example
10254 @node CDLaTeX mode,  , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
10255 @subsection Using CD@LaTeX{} to enter math
10256 @cindex CD@LaTeX{}
10258 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10259 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10260 environments and math templates.  Inside Org mode, you can make use of
10261 some of the features of CD@LaTeX{} mode.  You need to install
10262 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10263 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10264 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10265 version @code{org-cdlatex-mode} that comes as part of Org mode.  Turn it
10266 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10267 Org files with
10269 @lisp
10270 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10271 @end lisp
10273 When this mode is enabled, the following features are present (for more
10274 details see the documentation of CD@LaTeX{} mode):
10275 @itemize @bullet
10276 @kindex C-c @{
10277 @item
10278 Environment templates can be inserted with @kbd{C-c @{}.
10279 @item
10280 @kindex @key{TAB}
10281 The @key{TAB} key will do template expansion if the cursor is inside a
10282 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10283 inside such a fragment, see the documentation of the function
10284 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
10285 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10286 correctly inside the first brace.  Another @key{TAB} will get you into
10287 the second brace.  Even outside fragments, @key{TAB} will expand
10288 environment abbreviations at the beginning of a line.  For example, if
10289 you write @samp{equ} at the beginning of a line and press @key{TAB},
10290 this abbreviation will be expanded to an @code{equation} environment.
10291 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10292 @item
10293 @kindex _
10294 @kindex ^
10295 @vindex cdlatex-simplify-sub-super-scripts
10296 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10297 characters together with a pair of braces.  If you use @key{TAB} to move
10298 out of the braces, and if the braces surround only a single character or
10299 macro, they are removed again (depending on the variable
10300 @code{cdlatex-simplify-sub-super-scripts}).
10301 @item
10302 @kindex `
10303 Pressing the backquote @kbd{`} followed by a character inserts math
10304 macros, also outside @LaTeX{} fragments.  If you wait more than 1.5 seconds
10305 after the backquote, a help window will pop up.
10306 @item
10307 @kindex '
10308 Pressing the single-quote @kbd{'} followed by another character modifies
10309 the symbol before point with an accent or a font.  If you wait more than
10310 1.5 seconds after the single-quote, a help window will pop up.  Character
10311 modification will work only inside @LaTeX{} fragments; outside the quote
10312 is normal.
10313 @end itemize
10315 @node Special blocks,  , Embedded @LaTeX{}, Markup
10316 @section Special blocks
10317 @cindex Special blocks
10319 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10320 examples}).  It is also possible to create blocks containing raw code
10321 targeted at a specific back-ends (e.g., @samp{#+BEGIN_LATEX}).
10323 Any other block is a @emph{special block}.
10325 For example, @samp{#+BEGIN_ABSTRACT} and @samp{#+BEGIN_VIDEO} are special
10326 blocks.  The first one is useful when exporting to @LaTeX{}, the second one
10327 when exporting to HTML5.
10329 Each export back-end decides if they should be exported, and how.  When the
10330 block is ignored, its contents are still exported, as if the opening and
10331 closing block lines were not there.  For example, when exporting a
10332 @samp{#+BEGIN_TEST} block, HTML back-end wraps its contents within a
10333 @samp{<div name="test">} tag.
10335 Refer to back-end specific documentation for more information.
10337 @node Exporting, Publishing, Markup, Top
10338 @chapter Exporting
10339 @cindex exporting
10341 The Org mode export facilities can be used to export Org documents or parts
10342 of Org documents to a variety of other formats.  In addition, these
10343 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10344 in foreign buffers so you can author tables and lists in Org syntax and
10345 convert them in place to the target language.
10347 ASCII export produces a readable and simple version of an Org file for
10348 printing and sharing notes.  HTML export allows you to easily publish notes
10349 on the web, or to build full-fledged websites.  @LaTeX{} export lets you use
10350 Org mode and its structured editing functions to create arbitrarily complex
10351 @LaTeX{} files for any kind of document.  OpenDocument Text (ODT) export
10352 allows seamless collaboration across organizational boundaries.  Markdown
10353 export lets you seamlessly collaborate with other developers.  Finally, iCal
10354 export can extract entries with deadlines or appointments to produce a file
10355 in the iCalendar format.
10357 @menu
10358 * The Export Dispatcher::       The main exporter interface
10359 * Export back-ends::            Built-in export formats
10360 * Export settings::             Generic export settings
10361 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
10362 * Beamer export::               Exporting as a Beamer presentation
10363 * HTML export::                 Exporting to HTML
10364 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
10365 * Markdown export::             Exporting to Markdown
10366 * OpenDocument Text export::    Exporting to OpenDocument Text
10367 * Org export::                  Exporting to Org
10368 * iCalendar export::            Exporting to iCalendar
10369 * Other built-in back-ends::    Exporting to @code{Texinfo} or a man page
10370 * Export in foreign buffers::   Author tables and lists in Org syntax
10371 * Advanced configuration::      Fine-tuning the export output
10372 @end menu
10374 @node The Export Dispatcher, Export back-ends, Exporting, Exporting
10375 @section The Export Dispatcher
10376 @vindex org-export-dispatch-use-expert-ui
10377 @cindex Export, dispatcher
10379 The main entry point for export related tasks is the dispatcher, a
10380 hierarchical menu from which it is possible to select an export format and
10381 toggle export options@footnote{It is also possible to use a less intrusive
10382 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10383 non-@code{nil} value.  In that case, only a prompt is visible from the
10384 minibuffer.  From there one can still switch back to regular menu by pressing
10385 @key{?}.} from which it is possible to select an export format and to toggle
10386 export options.
10388 @c @quotation
10389 @table @asis
10390 @orgcmd{C-c C-e,org-export-dispatch}
10392 Dispatch for export and publishing commands.  When called with a @kbd{C-u}
10393 prefix argument, repeat the last export command on the current buffer while
10394 preserving toggled options.  If the current buffer hasn't changed and subtree
10395 export was activated, the command will affect that same subtree.
10396 @end table
10397 @c @end quotation
10399 Normally the entire buffer is exported, but if there is an active region
10400 only that part of the buffer will be exported.
10402 Several export options (@pxref{Export settings}) can be toggled from the
10403 export dispatcher with the following key combinations:
10405 @table @kbd
10406 @item C-a
10407 @vindex org-export-async-init-file
10408 Toggle asynchronous export.  Asynchronous export uses an external Emacs
10409 process that is configured with a specified initialization file.
10411 While exporting asynchronously, the output is not displayed, but stored in
10412 a place called ``the export stack''.  This stack can be displayed by calling
10413 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10414 from the dispatcher menu.
10416 @vindex org-export-in-background
10417 To make this behavior the default, customize the variable
10418 @code{org-export-in-background}.
10420 @item C-b
10421 Toggle body-only export.  Its effect depends on the back-end used.
10422 Typically, if the back-end has a header section (like @code{<head>...</head>}
10423 in the HTML back-end), a body-only export will not include this header.
10425 @item C-s
10426 @vindex org-export-initial-scope
10427 Toggle subtree export.  The top heading becomes the document title.
10429 You can change the default state of this option by setting
10430 @code{org-export-initial-scope}.
10432 @item C-v
10433 Toggle visible-only export.  Only export the text that is currently
10434 visible, i.e. not hidden by outline visibility in the buffer.
10436 @end table
10438 @vindex org-export-copy-to-kill-ring
10439 With the exception of asynchronous export, a successful export process writes
10440 its output to the kill-ring. You can configure this behavior by altering the
10441 option @code{org-export-copy-to-kill-ring}.
10443 @node Export back-ends, Export settings, The Export Dispatcher, Exporting
10444 @section Export back-ends
10445 @cindex Export, back-ends
10447 An export back-end is a library that translates Org syntax into a foreign
10448 format.  An export format is not available until the proper back-end has been
10449 loaded.
10451 @vindex org-export-backends
10452 By default, the following four back-ends are loaded: @code{ascii},
10453 @code{html}, @code{icalendar} and @code{latex}.  It is possible to add more
10454 (or remove some) by customizing @code{org-export-backends}.
10456 Built-in back-ends include:
10458 @itemize
10459 @item ascii (ASCII format)
10460 @item beamer (@LaTeX{} Beamer format)
10461 @item html (HTML format)
10462 @item icalendar (iCalendar format)
10463 @item latex (@LaTeX{} format)
10464 @item man (Man page format)
10465 @item md (Markdown format)
10466 @item odt (OpenDocument Text format)
10467 @item org (Org format)
10468 @item texinfo (Texinfo format)
10469 @end itemize
10471 Other back-ends might be found in the @code{contrib/} directory
10472 (@pxref{Installation}).
10474 @node Export settings, ASCII/Latin-1/UTF-8 export, Export back-ends, Exporting
10475 @section Export settings
10476 @cindex Export, settings
10478 Export options can be set: globally with variables; for an individual file by
10479 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10480 settings}), by setting individual keywords, or by specifying them in a
10481 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10482 properties (@pxref{Properties and Columns}).  Options set at a specific level
10483 override options set at a more general level.
10485 @cindex #+SETUPFILE
10486 In-buffer settings may appear anywhere in the file, either directly or
10487 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10488 Option keyword sets tailored to a particular back-end can be inserted from
10489 the export dispatcher (@pxref{The Export Dispatcher}) using the @code{Insert
10490 template} command by pressing @key{#}.  To insert keywords individually,
10491 a good way to make sure the keyword is correct is to type @code{#+} and then
10492 to use @kbd{M-<TAB>} for completion.
10494 The export keywords available for every back-end, and their equivalent global
10495 variables, include:
10497 @table @samp
10498 @item AUTHOR
10499 @vindex user-full-name
10500 The document author (@code{user-full-name}).
10502 @item CREATOR
10503 @vindex org-export-creator-string
10504 Entity responsible for output generation (@code{org-export-creator-string}).
10506 @item DATE
10507 @vindex org-export-date-timestamp-format
10508 A date or a time-stamp@footnote{The variable
10509 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10510 exported.}.
10512 @item DESCRIPTION
10513 The document description.  Back-ends handle it as they see fit (e.g., for the
10514 XHTML meta tag), if at all.  You can use several such keywords for long
10515 descriptions.
10517 @item EMAIL
10518 @vindex user-mail-address
10519 The email address (@code{user-mail-address}).
10521 @item KEYWORDS
10522 The keywords defining the contents of the document.  Back-ends handle it as
10523 they see fit (e.g., for the XHTML meta tag), if at all.  You can use several
10524 such keywords if the list is long.
10526 @item LANGUAGE
10527 @vindex org-export-default-language
10528 The language used for translating some strings
10529 (@code{org-export-default-language}).  E.g., @samp{#+LANGUAGE: fr} will tell
10530 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10531 clocktable.
10533 @item SELECT_TAGS
10534 @vindex org-export-select-tags
10535 The tags that select a tree for export (@code{org-export-select-tags}).  The
10536 default value is @code{:export:}.  Within a subtree tagged with
10537 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10538 below).  When headlines are selectively exported with @code{:export:}
10539 anywhere in a file, text before the first headline is ignored.
10541 @item EXCLUDE_TAGS
10542 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10543 The default value is @code{:noexport:}.  Entries with the @code{:noexport:}
10544 tag will be unconditionally excluded from the export, even if they have an
10545 @code{:export:} tag.
10547 @item TITLE
10548 The title to be shown (otherwise derived from buffer's name).  You can use
10549 several such keywords for long titles.
10550 @end table
10552 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10553 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10554 recognizes the following arguments:
10556 @table @code
10557 @item ':
10558 @vindex org-export-with-smart-quotes
10559 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10561 @item *:
10562 Toggle emphasized text (@code{org-export-with-emphasize}).
10564 @item -:
10565 @vindex org-export-with-special-strings
10566 Toggle conversion of special strings
10567 (@code{org-export-with-special-strings}).
10569 @item ::
10570 @vindex org-export-with-fixed-width
10571 Toggle fixed-width sections
10572 (@code{org-export-with-fixed-width}).
10574 @item <:
10575 @vindex org-export-with-timestamps
10576 Toggle inclusion of any time/date active/inactive stamps
10577 (@code{org-export-with-timestamps}).
10579 @item :
10580 @vindex org-export-preserve-breaks
10581 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10583 @item ^:
10584 @vindex org-export-with-sub-superscripts
10585 Toggle @TeX{}-like syntax for sub- and superscripts.  If you write "^:@{@}",
10586 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10587 it is (@code{org-export-with-sub-superscripts}).
10589 @item arch:
10590 @vindex org-export-with-archived-trees
10591 Configure export of archived trees.  Can be set to @code{headline} to only
10592 process the headline, skipping its contents
10593 (@code{org-export-with-archived-trees}).
10595 @item author:
10596 @vindex org-export-with-author
10597 Toggle inclusion of author name into exported file
10598 (@code{org-export-with-author}).
10600 @item c:
10601 @vindex org-export-with-clocks
10602 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10604 @item creator:
10605 @vindex org-export-with-creator
10606 Configure inclusion of creator info into exported file.  It may be set to
10607 @code{comment} (@code{org-export-with-creator}).
10609 @item d:
10610 @vindex org-export-with-drawers
10611 Toggle inclusion of drawers, or list drawers to include
10612 (@code{org-export-with-drawers}).
10614 @item e:
10615 @vindex org-export-with-entities
10616 Toggle inclusion of entities (@code{org-export-with-entities}).
10618 @item email:
10619 @vindex org-export-with-email
10620 Toggle inclusion of the author's e-mail into exported file
10621 (@code{org-export-with-email}).
10623 @item f:
10624 @vindex org-export-with-footnotes
10625 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10627 @item H:
10628 @vindex org-export-headline-levels
10629 Set the number of headline levels for export
10630 (@code{org-export-headline-levels}).  Below that level, headlines are treated
10631 differently.  In most back-ends, they become list items.
10633 @item inline:
10634 @vindex org-export-with-inlinetasks
10635 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10637 @item num:
10638 @vindex org-export-with-section-numbers
10639 Toggle section-numbers (@code{org-export-with-section-numbers}).  It can also
10640 be set to a number @samp{n}, so only headlines at that level or above will be
10641 numbered.
10643 @item p:
10644 @vindex org-export-with-planning
10645 Toggle export of planning information (@code{org-export-with-planning}).
10646 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10647 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10649 @item pri:
10650 @vindex org-export-with-priority
10651 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10653 @item stat:
10654 @vindex org-export-with-statistics-cookies
10655 Toggle inclusion of statistics cookies
10656 (@code{org-export-with-statistics-cookies}).
10658 @item tags:
10659 @vindex org-export-with-tags
10660 Toggle inclusion of tags, may also be @code{not-in-toc}
10661 (@code{org-export-with-tags}).
10663 @item tasks:
10664 @vindex org-export-with-tasks
10665 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10666 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10667 (@code{org-export-with-tasks}).
10669 @item tex:
10670 @vindex org-export-with-latex
10671 Configure export of @LaTeX{} fragments and environments.  It may be set to
10672 @code{verbatim} (@code{org-export-with-latex}).
10674 @item timestamp:
10675 @vindex org-export-time-stamp-file
10676 Toggle inclusion of the creation time into exported file
10677 (@code{org-export-time-stamp-file}).
10679 @item toc:
10680 @vindex org-export-with-toc
10681 Toggle inclusion of the table of contents, or set the level limit
10682 (@code{org-export-with-toc}).
10684 @item todo:
10685 @vindex org-export-with-todo-keywords
10686 Toggle inclusion of TODO keywords into exported text
10687 (@code{org-export-with-todo-keywords}).
10689 @item |:
10690 @vindex org-export-with-tables
10691 Toggle inclusion of tables (@code{org-export-with-tables}).
10692 @end table
10694 @cindex property, EXPORT_FILE_NAME
10695 When exporting only a subtree, each of the previous keywords@footnote{With
10696 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10697 properties.  These begin with @samp{EXPORT_}, followed by the name of the
10698 keyword they supplant.  For example, @samp{DATE} and @samp{OPTIONS} keywords
10699 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10700 properties.  Subtree export also supports the self-explicit
10701 @samp{EXPORT_FILE_NAME} property@footnote{There is no buffer-wide equivalent
10702 for this property.  The file name in this case is derived from the file
10703 associated to the buffer, if possible, or asked to the user otherwise.}.
10705 @cindex #+BIND
10706 @vindex org-export-allow-bind-keywords
10707 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10708 can become buffer-local during export by using the BIND keyword.  Its syntax
10709 is @samp{#+BIND: variable value}.  This is particularly useful for in-buffer
10710 settings that cannot be changed using specific keywords.
10712 @node ASCII/Latin-1/UTF-8 export, Beamer export, Export settings, Exporting
10713 @section ASCII/Latin-1/UTF-8 export
10714 @cindex ASCII export
10715 @cindex Latin-1 export
10716 @cindex UTF-8 export
10718 ASCII export produces a simple and very readable version of an Org mode
10719 file, containing only plain ASCII@.  Latin-1 and UTF-8 export augment the file
10720 with special characters and symbols available in these encodings.
10722 @vindex org-ascii-links-to-notes
10723 Links are exported in a footnote-like style, with the descriptive part in the
10724 text and the link in a note before the next heading.  See the variable
10725 @code{org-ascii-links-to-notes} for details and other options.
10727 @subheading ASCII export commands
10729 @table @kbd
10730 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10731 Export as an ASCII file.  For an Org file, @file{myfile.org}, the ASCII file
10732 will be @file{myfile.txt}.  The file will be overwritten without warning.
10733 When the original file is @file{myfile.txt}, the resulting file becomes
10734 @file{myfile.txt.txt} in order to prevent data loss.
10735 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10736 Export to a temporary buffer.  Do not create a file.
10737 @end table
10739 @subheading Header and sectioning structure
10741 In the exported version, the first three outline levels become headlines,
10742 defining a general document structure.  Additional levels are exported as
10743 lists.  The transition can also occur at a different level (@pxref{Export
10744 settings}).
10746 @subheading Quoting ASCII text
10748 You can insert text that will only appear when using @code{ASCII} back-end
10749 with the following constructs:
10751 @cindex #+ASCII
10752 @cindex #+BEGIN_ASCII
10753 @example
10754 Text @@@@ascii:and additional text@@@@ within a paragraph.
10756 #+ASCII: Some text
10758 #+BEGIN_ASCII
10759 All lines in this block will appear only when using this back-end.
10760 #+END_ASCII
10761 @end example
10763 @subheading ASCII specific attributes
10764 @cindex #+ATTR_ASCII
10765 @cindex horizontal rules, in ASCII export
10767 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10768 specifies the length, in characters, of a given horizontal rule.  It must be
10769 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
10771 @example
10772 #+ATTR_ASCII: :width 10
10773 -----
10774 @end example
10776 @node Beamer export, HTML export, ASCII/Latin-1/UTF-8 export, Exporting
10777 @section Beamer export
10778 @cindex Beamer export
10780 The @LaTeX{} class @emph{Beamer} allows production of high quality
10781 presentations using @LaTeX{} and pdf processing.  Org mode has special
10782 support for turning an Org mode file or tree into a Beamer presentation.
10784 @subheading Beamer export commands
10786 @table @kbd
10787 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
10788 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
10789 file will be @file{myfile.tex}.  The file will be overwritten without
10790 warning.
10791 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
10792 Export to a temporary buffer.  Do not create a file.
10793 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
10794 Export as @LaTeX{} and then process to PDF.
10795 @item C-c C-e l O
10796 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10797 @end table
10799 @subheading Sectioning, Frames and Blocks
10801 Any tree with not-too-deep level nesting should in principle be exportable as
10802 a Beamer presentation.  Headlines fall into three categories: sectioning
10803 elements, frames and blocks.
10805 @itemize @minus
10806 @item
10807 @vindex org-beamer-frame-level
10808 Headlines become frames when their level is equal to
10809 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
10810 (@pxref{Export settings}).
10812 @cindex property, BEAMER_ENV
10813 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
10814 set to either to @code{frame} or @code{fullframe}, its level overrides the
10815 variable.  A @code{fullframe} is a frame with an empty (ignored) title.
10817 @item
10818 @vindex org-beamer-environments-default
10819 @vindex org-beamer-environments-extra
10820 All frame's children become @code{block} environments.  Special block types
10821 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
10822 this property is set, the entry will also get a @code{:B_environment:} tag to
10823 make this visible.  This tag has no semantic meaning, it is only a visual
10824 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
10825 supported values and @code{org-beamer-environments-extra} for adding more).
10827 @item
10828 @cindex property, BEAMER_REF
10829 As a special case, if the @code{BEAMER_ENV} property is set to either
10830 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
10831 headline will become, respectively, an appendix, a note (within frame or
10832 between frame, depending on its level), a note with its title ignored or an
10833 @code{\againframe} command.  In the latter case, a @code{BEAMER_REF} property
10834 is mandatory in order to refer to the frame being resumed, and contents are
10835 ignored.
10837 Also, a headline with an @code{ignoreheading} environment will have its
10838 contents only inserted in the output.  This special value is useful to have
10839 data between frames, or to properly close a @code{column} environment.
10840 @end itemize
10842 @cindex property, BEAMER_ACT
10843 @cindex property, BEAMER_OPT
10844 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
10845 The former is translated as an overlay/action specification, or a default
10846 overlay specification when enclosed within square brackets.  The latter
10847 specifies options@footnote{The @code{fragile} option is added automatically
10848 if it contains code that requires a verbatim environment, though.} for the
10849 current frame or block.  The export back-end will automatically wrap
10850 properties within angular or square brackets when appropriate.
10852 @cindex property, BEAMER_COL
10853 Moreover, headlines handle the @code{BEAMER_COL} property.  Its value should
10854 be a decimal number representing the width of the column as a fraction of the
10855 total text width.  If the headline has no specific environment, its title
10856 will be ignored and its contents will fill the column created.  Otherwise,
10857 the block will fill the whole column and the title will be preserved.  Two
10858 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
10859 @code{columns} @LaTeX{} environment.  It will end before the next headline
10860 without such a property.  This environment is generated automatically.
10861 Although, it can also be explicitly created, with a special @code{columns}
10862 value for @code{BEAMER_ENV} property (if it needs to be set up with some
10863 specific options, for example).
10865 @subheading Beamer specific syntax
10867 Beamer back-end is an extension of @LaTeX{} back-end.  As such, all @LaTeX{}
10868 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
10869 recognized.  See @ref{@LaTeX{} and PDF export} for more information.
10871 @cindex #+BEAMER_THEME
10872 @cindex #+BEAMER_COLOR_THEME
10873 @cindex #+BEAMER_FONT_THEME
10874 @cindex #+BEAMER_INNER_THEME
10875 @cindex #+BEAMER_OUTER_THEME
10876 Beamer export introduces a number of keywords to insert code in the
10877 document's header.  Four control appearance of the presentation:
10878 @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
10879 @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
10880 @code{#+BEAMER_OUTER_THEME}.  All of them accept optional arguments
10881 within square brackets.  The last one, @code{#+BEAMER_HEADER}, is more
10882 generic and allows you to append any line of code in the header.
10884 @example
10885 #+BEAMER_THEME: Rochester [height=20pt]
10886 #+BEAMER_COLOR_THEME: spruce
10887 @end example
10889 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
10890 wrapped within a @code{frame} environment.  Those generated from a @code{TOC}
10891 keyword (@pxref{Table of contents}) are not.  In that case, it is also
10892 possible to specify options, enclosed within square brackets.
10894 @example
10895 #+TOC: headlines [currentsection]
10896 @end example
10898 Beamer specific code can be inserted with the following constructs:
10900 @cindex #+BEAMER
10901 @cindex #+BEGIN_BEAMER
10902 @example
10903 #+BEAMER: \pause
10905 #+BEGIN_BEAMER
10906 All lines in this block will appear only when using this back-end.
10907 #+END_BEAMER
10909 Text @@@@beamer:some code@@@@ within a paragraph.
10910 @end example
10912 In particular, this last example can be used to add overlay specifications to
10913 objects whose type is among @code{bold}, @code{item}, @code{link},
10914 @code{radio-target} and @code{target}, when the value is enclosed within
10915 angular brackets and put at the beginning the object.
10917 @example
10918 A *@@@@beamer:<2->@@@@useful* feature
10919 @end example
10921 @cindex #+ATTR_BEAMER
10922 Eventually, every plain list has support for @code{:environment},
10923 @code{:overlay} and @code{:options} attributes through
10924 @code{ATTR_BEAMER} affiliated keyword.  The first one allows the use
10925 of a different environment, the second sets overlay specifications and
10926 the last one inserts optional arguments in current list environment.
10928 @example
10929 #+ATTR_BEAMER: :overlay +-
10930 - item 1
10931 - item 2
10932 @end example
10934 @subheading Editing support
10936 You can turn on a special minor mode @code{org-beamer-mode} for faster
10937 editing with:
10939 @example
10940 #+STARTUP: beamer
10941 @end example
10943 @table @kbd
10944 @orgcmd{C-c C-b,org-beamer-select-environment}
10945 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
10946 environment or the @code{BEAMER_COL} property.
10947 @end table
10949 Also, a template for useful in-buffer settings or properties can be inserted
10950 into the buffer with @kbd{M-x org-beamer-insert-options-template}.  Among
10951 other things, this will install a column view format which is very handy for
10952 editing special properties used by Beamer.
10954 @subheading An example
10956 Here is a simple example Org document that is intended for Beamer export.
10958 @smallexample
10959 #+TITLE: Example Presentation
10960 #+AUTHOR: Carsten Dominik
10961 #+OPTIONS: H:2
10962 #+LATEX_CLASS: beamer
10963 #+LATEX_CLASS_OPTIONS: [presentation]
10964 #+BEAMER_THEME: Madrid
10965 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
10967 * This is the first structural section
10969 ** Frame 1
10970 *** Thanks to Eric Fraga                                           :B_block:BMCOL:
10971     :PROPERTIES:
10972     :BEAMER_COL: 0.48
10973     :BEAMER_ENV: block
10974     :END:
10975     for the first viable Beamer setup in Org
10976 *** Thanks to everyone else                                        :B_block:BMCOL:
10977     :PROPERTIES:
10978     :BEAMER_COL: 0.48
10979     :BEAMER_ACT: <2->
10980     :BEAMER_ENV: block
10981     :END:
10982     for contributing to the discussion
10983 **** This will be formatted as a beamer note                              :B_note:
10984      :PROPERTIES:
10985      :BEAMER_env: note
10986      :END:
10987 ** Frame 2 (where we will not use columns)
10988 *** Request
10989     Please test this stuff!
10990 @end smallexample
10992 @node HTML export, @LaTeX{} and PDF export, Beamer export, Exporting
10993 @section HTML export
10994 @cindex HTML export
10996 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
10997 HTML formatting, in ways similar to John Gruber's @emph{markdown}
10998 language, but with additional support for tables.
11000 @menu
11001 * HTML Export commands::        How to invoke HTML export
11002 * HTML doctypes::               Org can export to various (X)HTML flavors
11003 * HTML preamble and postamble::  How to insert a preamble and a postamble
11004 * Quoting HTML tags::           Using direct HTML in Org mode
11005 * Links in HTML export::        How links will be interpreted and formatted
11006 * Tables in HTML export::       How to modify the formatting of tables
11007 * Images in HTML export::       How to insert figures into HTML output
11008 * Math formatting in HTML export::  Beautiful math also on the web
11009 * Text areas in HTML export::   An alternative way to show an example
11010 * CSS support::                 Changing the appearance of the output
11011 * JavaScript support::          Info and Folding in a web browser
11012 @end menu
11014 @node HTML Export commands, HTML doctypes, HTML export, HTML export
11015 @subsection HTML export commands
11017 @table @kbd
11018 @orgcmd{C-c C-e h h,org-html-export-to-html}
11019 Export as an HTML file.  For an Org file @file{myfile.org},
11020 the HTML file will be @file{myfile.html}.  The file will be overwritten
11021 without warning.
11022 @kbd{C-c C-e h o}
11023 Export as an HTML file and immediately open it with a browser.
11024 @orgcmd{C-c C-e h H,org-html-export-as-html}
11025 Export to a temporary buffer.  Do not create a file.
11026 @end table
11028 @c FIXME Exporting sublevels
11029 @c @cindex headline levels, for exporting
11030 @c In the exported version, the first 3 outline levels will become headlines,
11031 @c defining a general document structure.  Additional levels will be exported as
11032 @c itemized lists.  If you want that transition to occur at a different level,
11033 @c specify it with a numeric prefix argument.  For example,
11035 @c @example
11036 @c @kbd{C-2 C-c C-e b}
11037 @c @end example
11039 @c @noindent
11040 @c creates two levels of headings and does the rest as items.
11042 @node HTML doctypes, HTML preamble and postamble, HTML Export commands, HTML export
11043 @subsection HTML doctypes
11044 @vindex org-html-doctype
11045 @vindex org-html-doctype-alist
11047 Org can export to various (X)HTML flavors.
11049 Setting the variable @code{org-html-doctype} allows you to export to different
11050 (X)HTML variants.  The exported HTML will be adjusted according to the syntax
11051 requirements of that variant.  You can either set this variable to a doctype
11052 string directly, in which case the exporter will try to adjust the syntax
11053 automatically, or you can use a ready-made doctype.  The ready-made options
11054 are:
11056 @itemize
11057 @item
11058 ``html4-strict''
11059 @item
11060 ``html4-transitional''
11061 @item
11062 ``html4-frameset''
11063 @item
11064 ``xhtml-strict''
11065 @item
11066 ``xhtml-transitional''
11067 @item
11068 ``xhtml-frameset''
11069 @item
11070 ``xhtml-11''
11071 @item
11072 ``html5''
11073 @item
11074 ``xhtml5''
11075 @end itemize
11077 See the variable @code{org-html-doctype-alist} for details.  The default is
11078 ``xhtml-strict''.
11080 @subsubheading Fancy HTML5 export
11081 @vindex org-html-html5-fancy
11082 @vindex org-html-html5-elements
11084 HTML5 introduces several new element types.  By default, Org will not make
11085 use of these element types, but you can set @code{org-html-html5-fancy} to
11086 @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11087 enable a few new block-level elements.  These are created using arbitrary
11088 #+BEGIN and #+END blocks. For instance:
11090 @example
11091 #+BEGIN_ASIDE
11092 Lorem ipsum
11093 #+END_ASIDE
11094 @end example
11096 Will export to:
11098 @example
11099 <aside>
11100   <p>Lorem ipsum</p>
11101 </aside>
11102 @end example
11104 While this:
11106 @example
11107 #+ATTR_HTML: :controls controls :width 350
11108 #+BEGIN_VIDEO
11109 #+HTML: <source src="movie.mp4" type="video/mp4">
11110 #+HTML: <source src="movie.ogg" type="video/ogg">
11111 Your browser does not support the video tag.
11112 #+END_VIDEO
11113 @end example
11115 Becomes:
11117 @example
11118 <video controls="controls" width="350">
11119   <source src="movie.mp4" type="video/mp4">
11120   <source src="movie.ogg" type="video/ogg">
11121   <p>Your browser does not support the video tag.</p>
11122 </video>
11123 @end example
11125 Special blocks that do not correspond to HTML5 elements (see
11126 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11127 @code{#+BEGIN_LEDERHOSEN} will still export to @samp{<div class="lederhosen">}.
11129 Headlines cannot appear within special blocks.  To wrap a headline and its
11130 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11131 @code{HTML_CONTAINER} property on the headline itself.
11133 @node HTML preamble and postamble, Quoting HTML tags, HTML doctypes, HTML export
11134 @subsection HTML preamble and postamble
11135 @vindex org-html-preamble
11136 @vindex org-html-postamble
11137 @vindex org-html-preamble-format
11138 @vindex org-html-postamble-format
11139 @vindex org-html-validation-link
11140 @vindex org-export-creator-string
11141 @vindex org-export-time-stamp-file
11143 The HTML exporter lets you define a preamble and a postamble.
11145 The default value for @code{org-html-preamble} is @code{t}, which means
11146 that the preamble is inserted depending on the relevant format string in
11147 @code{org-html-preamble-format}.
11149 Setting @code{org-html-preamble} to a string will override the default format
11150 string.  If you set it to a function, it will insert the output of the
11151 function, which must be a string.  Setting to @code{nil} will not insert any
11152 preamble.
11154 The default value for @code{org-html-postamble} is @code{'auto}, which means
11155 that the HTML exporter will look for information about the author, the email,
11156 the creator and the date, and build the postamble from these values.  Setting
11157 @code{org-html-postamble} to @code{t} will insert the postamble from the
11158 relevant format string found in @code{org-html-postamble-format}.  Setting it
11159 to @code{nil} will not insert any postamble.
11161 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
11162 @subsection Quoting HTML tags
11164 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
11165 @samp{&gt;} in HTML export.  If you want to include raw HTML code, which
11166 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11167 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}.  For more extensive HTML
11168 that should be copied verbatim to the exported file use either
11170 @cindex #+HTML
11171 @cindex #+BEGIN_HTML
11172 @example
11173 #+HTML: Literal HTML code for export
11174 @end example
11176 @noindent or
11177 @cindex #+BEGIN_HTML
11179 @example
11180 #+BEGIN_HTML
11181 All lines between these markers are exported literally
11182 #+END_HTML
11183 @end example
11186 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
11187 @subsection Links in HTML export
11189 @cindex links, in HTML export
11190 @cindex internal links, in HTML export
11191 @cindex external links, in HTML export
11192 Internal links (@pxref{Internal links}) will continue to work in HTML@.  This
11193 includes automatic links created by radio targets (@pxref{Radio
11194 targets}).  Links to external files will still work if the target file is on
11195 the same @i{relative} path as the published Org file.  Links to other
11196 @file{.org} files will be translated into HTML links under the assumption
11197 that an HTML version also exists of the linked file, at the same relative
11198 path.  @samp{id:} links can then be used to jump to specific entries across
11199 files.  For information related to linking files while publishing them to a
11200 publishing directory see @ref{Publishing links}.
11202 If you want to specify attributes for links, you can do so using a special
11203 @code{#+ATTR_HTML} line to define attributes that will be added to the
11204 @code{<a>} or @code{<img>} tags.  Here is an example that sets @code{title}
11205 and @code{style} attributes for a link:
11207 @cindex #+ATTR_HTML
11208 @example
11209 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11210 [[http://orgmode.org]]
11211 @end example
11213 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
11214 @subsection Tables
11215 @cindex tables, in HTML
11216 @vindex org-html-table-default-attributes
11218 Org mode tables are exported to HTML using the table attributes defined in
11219 @code{org-html-table-default-attributes}.  The default setting makes tables
11220 without cell borders and frame.  If you would like to change this for
11221 individual tables, place something like the following before the table:
11223 @cindex #+CAPTION
11224 @cindex #+ATTR_HTML
11225 @example
11226 #+CAPTION: This is a table with lines around and between cells
11227 #+ATTR_HTML: :border 2 :rules all :frame border
11228 @end example
11230 @vindex org-html-table-row-tags
11231 You can also modify the default tags used for each row by setting
11232 @code{org-html-table-row-tags}.  See the docstring for an example on
11233 how to use this option.
11235 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
11236 @subsection Images in HTML export
11238 @cindex images, inline in HTML
11239 @cindex inlining images in HTML
11240 @vindex org-html-inline-images
11241 HTML export can inline images given as links in the Org file, and
11242 it can make an image the clickable part of a link.  By
11243 default@footnote{But see the variable
11244 @code{org-html-inline-images}.}, images are inlined if a link does
11245 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
11246 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11247 @samp{the image} that points to the image.  If the description part
11248 itself is a @code{file:} link or a @code{http:} URL pointing to an
11249 image, this image will be inlined and activated so that clicking on the
11250 image will activate the link.  For example, to include a thumbnail that
11251 will link to a high resolution version of the image, you could use:
11253 @example
11254 [[file:highres.jpg][file:thumb.jpg]]
11255 @end example
11257 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11258 In the example below we specify the @code{alt} and @code{title} attributes to
11259 support text viewers and accessibility, and align it to the right.
11261 @cindex #+CAPTION
11262 @cindex #+ATTR_HTML
11263 @example
11264 #+CAPTION: A black cat stalking a spider
11265 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11266 [[./img/a.jpg]]
11267 @end example
11269 @noindent
11270 You could use @code{http} addresses just as well.
11272 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
11273 @subsection Math formatting in HTML export
11274 @cindex MathJax
11275 @cindex dvipng
11276 @cindex imagemagick
11278 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11279 different ways on HTML pages.  The default is to use the
11280 @uref{http://www.mathjax.org, MathJax system} which should work out of the
11281 box with Org mode installation because @uref{http://orgmode.org} serves
11282 @file{MathJax} for Org mode users for small applications and for testing
11283 purposes.  @b{If you plan to use this regularly or on pages with significant
11284 page views, you should install@footnote{Installation instructions can be
11285 found on the MathJax website, see
11286 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
11287 your own server in order to limit the load of our server.}  To configure
11288 @file{MathJax}, use the variable @code{org-html-mathjax-options} or
11289 insert something like the following into the buffer:
11291 @example
11292 #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
11293 @end example
11295 @noindent See the docstring of the variable
11296 @code{org-html-mathjax-options} for the meaning of the parameters in
11297 this line.
11299 If you prefer, you can also request that @LaTeX{} fragments are processed
11300 into small images that will be inserted into the browser page.  Before the
11301 availability of MathJax, this was the default method for Org files.  This
11302 method requires that the @file{dvipng} program or @file{imagemagick} suite is
11303 available on your system.  You can still get this processing with
11305 @example
11306 #+OPTIONS: tex:dvipng
11307 @end example
11311 @example
11312 #+OPTIONS: tex:imagemagick
11313 @end example
11315 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
11316 @subsection Text areas in HTML export
11318 @cindex text areas, in HTML
11319 An alternative way to publish literal code examples in HTML is to use text
11320 areas, where the example can even be edited before pasting it into an
11321 application.  It is triggered by @code{:textarea} attribute at an
11322 @code{example} or @code{src} block.
11324 You may also use @code{:height} and @code{:width} attributes to specify the
11325 height and width of the text area, which default to the number of lines in
11326 the example, and 80, respectively.  For example
11328 @example
11329 #+ATTR_HTML: :textarea t :width 40
11330 #+BEGIN_EXAMPLE
11331   (defun org-xor (a b)
11332      "Exclusive or."
11333      (if a (not b) b))
11334 #+END_EXAMPLE
11335 @end example
11338 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
11339 @subsection CSS support
11340 @cindex CSS, for HTML export
11341 @cindex HTML export, CSS
11343 @vindex org-html-todo-kwd-class-prefix
11344 @vindex org-html-tag-class-prefix
11345 You can modify the CSS style definitions for the exported file.  The HTML
11346 exporter assigns the following special CSS classes@footnote{If the classes on
11347 TODO keywords and tags lead to conflicts, use the variables
11348 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11349 make them unique.} to appropriate parts of the document---your style
11350 specifications may change these, in addition to any of the standard classes
11351 like for headlines, tables, etc.
11352 @example
11353 p.author            @r{author information, including email}
11354 p.date              @r{publishing date}
11355 p.creator           @r{creator info, about org mode version}
11356 .title              @r{document title}
11357 .todo               @r{TODO keywords, all not-done states}
11358 .done               @r{the DONE keywords, all states that count as done}
11359 .WAITING            @r{each TODO keyword also uses a class named after itself}
11360 .timestamp          @r{timestamp}
11361 .timestamp-kwd      @r{keyword associated with a timestamp, like SCHEDULED}
11362 .timestamp-wrapper  @r{span around keyword plus timestamp}
11363 .tag                @r{tag in a headline}
11364 ._HOME              @r{each tag uses itself as a class, "@@" replaced by "_"}
11365 .target             @r{target for links}
11366 .linenr             @r{the line number in a code example}
11367 .code-highlighted   @r{for highlighting referenced code lines}
11368 div.outline-N       @r{div for outline level N (headline plus text))}
11369 div.outline-text-N  @r{extra div for text at outline level N}
11370 .section-number-N   @r{section number in headlines, different for each level}
11371 .figure-number      @r{label like "Figure 1:"}
11372 .table-number       @r{label like "Table 1:"}
11373 .listing-number     @r{label like "Listing 1:"}
11374 div.figure          @r{how to format an inlined image}
11375 pre.src             @r{formatted source code}
11376 pre.example         @r{normal example}
11377 p.verse             @r{verse paragraph}
11378 div.footnotes       @r{footnote section headline}
11379 p.footnote          @r{footnote definition paragraph, containing a footnote}
11380 .footref            @r{a footnote reference number (always a <sup>)}
11381 .footnum            @r{footnote number in footnote definition (always <sup>)}
11382 @end example
11384 @vindex org-html-style-default
11385 @vindex org-html-head-include-default-style
11386 @vindex org-html-head
11387 @vindex org-html-head-extra
11388 @cindex #+HTML_INCLUDE_STYLE
11389 Each exported file contains a compact default style that defines these
11390 classes in a basic way@footnote{This style is defined in the constant
11391 @code{org-html-style-default}, which you should not modify.  To turn
11392 inclusion of these defaults off, customize
11393 @code{org-html-head-include-default-style} or set @code{html-style} to
11394 @code{nil} in an @code{OPTIONS} line.}.  You may overwrite these settings, or
11395 add to them by using the variables @code{org-html-head} and
11396 @code{org-html-head-extra}.  You can override the global values of these
11397 variables for each file by using these keywords:
11399 @cindex #+HTML_HEAD
11400 @cindex #+HTML_HEAD_EXTRA
11401 @example
11402 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11403 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11404 @end example
11406 @noindent
11407 For longer style definitions, you can use several such lines.  You could also
11408 directly write a @code{<style>} @code{</style>} section in this way, without
11409 referring to an external file.
11411 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11412 property to assign a class to the tree.  In order to specify CSS styles for a
11413 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11414 property.
11416 @c FIXME: More about header and footer styles
11417 @c FIXME: Talk about links and targets.
11419 @node JavaScript support,  , CSS support, HTML export
11420 @subsection JavaScript supported display of web pages
11422 @cindex Rose, Sebastian
11423 Sebastian Rose has written a JavaScript program especially designed to
11424 enhance the web viewing experience of HTML files created with Org.  This
11425 program allows you to view large files in two different ways.  The first one
11426 is an @emph{Info}-like mode where each section is displayed separately and
11427 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11428 as well, press @kbd{?} for an overview of the available keys).  The second
11429 view type is a @emph{folding} view much like Org provides inside Emacs.  The
11430 script is available at @url{http://orgmode.org/org-info.js} and you can find
11431 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11432 We host the script at our site, but if you use it a lot, you might not want
11433 to be dependent on @url{http://orgmode.org} and prefer to install a local
11434 copy on your own web server.
11436 All it then takes to use this program is adding a single line to the Org
11437 file:
11439 @cindex #+INFOJS_OPT
11440 @example
11441 #+INFOJS_OPT: view:info toc:nil
11442 @end example
11444 @noindent
11445 If this line is found, the HTML header will automatically contain the code
11446 needed to invoke the script.  Using the line above, you can set the following
11447 viewing options:
11449 @example
11450 path:    @r{The path to the script.  The default is to grab the script from}
11451          @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11452          @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11453 view:    @r{Initial view when the website is first shown.  Possible values are:}
11454          info      @r{Info-like interface with one section per page.}
11455          overview  @r{Folding interface, initially showing only top-level.}
11456          content   @r{Folding interface, starting with all headlines visible.}
11457          showall   @r{Folding interface, all headlines and text visible.}
11458 sdepth:  @r{Maximum headline level that will still become an independent}
11459          @r{section for info and folding modes.  The default is taken from}
11460          @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11461          @r{If this is smaller than in @code{org-export-headline-levels}, each}
11462          @r{info/folding section can still contain child headlines.}
11463 toc:     @r{Should the table of contents @emph{initially} be visible?}
11464          @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11465 tdepth:  @r{The depth of the table of contents.  The defaults are taken from}
11466          @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11467 ftoc:    @r{Does the CSS of the page specify a fixed position for the "toc"?}
11468          @r{If yes, the toc will never be displayed as a section.}
11469 ltoc:    @r{Should there be short contents (children) in each section?}
11470          @r{Make this @code{above} if the section should be above initial text.}
11471 mouse:   @r{Headings are highlighted when the mouse is over them.  Should be}
11472          @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11473 buttons: @r{Should view-toggle buttons be everywhere?  When @code{nil} (the}
11474          @r{default), only one such button will be present.}
11475 @end example
11476 @noindent
11477 @vindex org-html-infojs-options
11478 @vindex org-html-use-infojs
11479 You can choose default values for these options by customizing the variable
11480 @code{org-html-infojs-options}.  If you always want to apply the script to your
11481 pages, configure the variable @code{org-html-use-infojs}.
11483 @node @LaTeX{} and PDF export, Markdown export, HTML export, Exporting
11484 @section @LaTeX{} and PDF export
11485 @cindex @LaTeX{} export
11486 @cindex PDF export
11488 @LaTeX{} export can produce an arbitrarily complex LaTeX document of any
11489 standard or custom document class.  With further processing@footnote{The
11490 default @LaTeX{} output is designed for processing with @code{pdftex} or
11491 @LaTeX{}.  It includes packages that are not compatible with @code{xetex} and
11492 possibly @code{luatex}.  The @LaTeX{} exporter can be configured to support
11493 alternative TeX engines, see the options
11494 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}.},
11495 which the @LaTeX{} exporter is able to control, this back-end is able to
11496 produce PDF output.  Because the @LaTeX{} exporter can be configured to use
11497 the @code{hyperref} package, the default setup produces fully-linked PDF
11498 output.
11500 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11501 will not be started if two contiguous syntactical elements are not separated
11502 by an empty line.
11504 This back-end also offers enhanced support for footnotes.  Thus, it handles
11505 nested footnotes, footnotes in tables and footnotes in a list item's
11506 description.
11508 @menu
11509 * @LaTeX{} export commands::    How to export to LaTeX and PDF
11510 * Header and sectioning::       Setting up the export file structure
11511 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
11512 * @LaTeX{} specific attributes::  Controlling @LaTeX{} output
11513 @end menu
11515 @node @LaTeX{} export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
11516 @subsection @LaTeX{} export commands
11518 @table @kbd
11519 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11520 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
11521 file will be @file{myfile.tex}.  The file will be overwritten without
11522 warning.
11523 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11524 Export to a temporary buffer.  Do not create a file.
11525 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11526 Export as @LaTeX{} and then process to PDF.
11527 @item C-c C-e l o
11528 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11529 @end table
11531 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{} export commands, @LaTeX{} and PDF export
11532 @subsection Header and sectioning structure
11533 @cindex @LaTeX{} class
11534 @cindex @LaTeX{} sectioning structure
11535 @cindex @LaTeX{} header
11536 @cindex header, for @LaTeX{} files
11537 @cindex sectioning structure, for @LaTeX{} export
11539 By default, the first three outline levels become headlines, defining a
11540 general document structure.  Additional levels are exported as @code{itemize}
11541 or @code{enumerate} lists.  The transition can also occur at a different
11542 level (@pxref{Export settings}).
11544 By default, the @LaTeX{} output uses the class @code{article}.
11546 @vindex org-latex-default-class
11547 @vindex org-latex-classes
11548 @vindex org-latex-default-packages-alist
11549 @vindex org-latex-packages-alist
11550 You can change this globally by setting a different value for
11551 @code{org-latex-default-class} or locally by adding an option like
11552 @code{#+LATEX_CLASS: myclass} in your file, or with
11553 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11554 containing only this (sub)tree.  The class must be listed in
11555 @code{org-latex-classes}.  This variable defines a header template for each
11556 class@footnote{Into which the values of
11557 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
11558 are spliced.}, and allows you to define the sectioning structure for each
11559 class.  You can also define your own classes there.
11561 @cindex #+LATEX_CLASS
11562 @cindex #+LATEX_CLASS_OPTIONS
11563 @cindex property, EXPORT_LATEX_CLASS
11564 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
11565 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
11566 property can specify the options for the @code{\documentclass} macro.  These
11567 options have to be provided, as expected by @LaTeX{}, within square brackets.
11569 @cindex #+LATEX_HEADER
11570 @cindex #+LATEX_HEADER_EXTRA
11571 You can also use the @code{LATEX_HEADER} and
11572 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
11573 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
11574 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
11575 to add lines to the header.  See the docstring of @code{org-latex-classes} for
11576 more information.
11578 An example is shown below.
11580 @example
11581 #+LATEX_CLASS: article
11582 #+LATEX_CLASS_OPTIONS: [a4paper]
11583 #+LATEX_HEADER: \usepackage@{xyz@}
11585 * Headline 1
11586   some text
11587 @end example
11589 @node Quoting @LaTeX{} code, @LaTeX{} specific attributes, Header and sectioning, @LaTeX{} and PDF export
11590 @subsection Quoting @LaTeX{} code
11592 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11593 inserted into the @LaTeX{} file.  Furthermore, you can add special code that
11594 should only be present in @LaTeX{} export with the following constructs:
11596 @cindex #+LATEX
11597 @cindex #+BEGIN_LATEX
11598 @example
11599 Code within @@@@latex:some code@@@@ a paragraph.
11601 #+LATEX: Literal @LaTeX{} code for export
11603 #+BEGIN_LATEX
11604 All lines between these markers are exported literally
11605 #+END_LATEX
11606 @end example
11608 @node @LaTeX{} specific attributes,  , Quoting @LaTeX{} code, @LaTeX{} and PDF export
11609 @subsection @LaTeX{} specific attributes
11610 @cindex #+ATTR_LATEX
11612 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line.  They
11613 affect tables, images, plain lists, special blocks and source blocks.
11615 @subsubheading Tables in @LaTeX{} export
11616 @cindex tables, in @LaTeX{} export
11618 For @LaTeX{} export of a table, you can specify a label and a caption
11619 (@pxref{Images and tables}).  You can also use attributes to control table
11620 layout and contents.  Valid @LaTeX{} attributes include:
11622 @table @code
11623 @item :mode
11624 @vindex org-latex-default-table-mode
11625 Nature of table's contents.  It can be set to @code{table}, @code{math},
11626 @code{inline-math} or @code{verbatim}.  In particular, when in @code{math} or
11627 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11628 ignored and the table will be wrapped in a math environment.  Also,
11629 contiguous tables sharing the same math mode will be wrapped within the same
11630 environment.  Default mode is determined in
11631 @code{org-latex-default-table-mode}.
11632 @item :environment
11633 @vindex org-latex-default-table-environment
11634 Environment used for the table.  It can be set to any @LaTeX{} table
11635 environment, like @code{tabularx}@footnote{Requires adding the
11636 @code{tabularx} package to @code{org-latex-packages-alist}.},
11637 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
11638 @code{tabu} package to @code{org-latex-packages-alist}.},
11639 @code{bmatrix}@enddots{} It defaults to
11640 @code{org-latex-default-table-environment} value.
11641 @item :caption
11642 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
11643 (@pxref{Images and tables}).  If you need more advanced commands for that
11644 task, you can use @code{:caption} attribute instead.  Its value should be raw
11645 @LaTeX{} code.  It has precedence over @code{#+CAPTION}.
11646 @item :float
11647 @itemx :placement
11648 Float environment for the table.  Possible values are @code{sidewaystable},
11649 @code{multicolumn}, @code{t} and @code{nil}.  When unspecified, a table with
11650 a caption will have a @code{table} environment.  Moreover, @code{:placement}
11651 attribute can specify the positioning of the float.
11652 @item :align
11653 @itemx :font
11654 @itemx :width
11655 Set, respectively, the alignment string of the table, its font size and its
11656 width.  They only apply on regular tables.
11657 @item :spread
11658 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11659 only takes effect when used in conjunction with the @code{:width} attribute.
11660 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
11661 value of @code{:width}.
11662 @item :booktabs
11663 @itemx :center
11664 @itemx :rmlines
11665 @vindex org-latex-tables-booktabs
11666 @vindex org-latex-tables-centered
11667 They toggle, respectively, @code{booktabs} usage (assuming the package is
11668 properly loaded), table centering and removal of every horizontal rule but
11669 the first one (in a "table.el" table only).  In particular,
11670 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
11671 activates the first (respectively second) attribute globally.
11672 @item :math-prefix
11673 @itemx :math-suffix
11674 @itemx :math-arguments
11675 A string that will be inserted, respectively, before the table within the
11676 math environment, after the table within the math environment, and between
11677 the macro name and the contents of the table.  The @code{:math-arguments}
11678 attribute is used for matrix macros that require more than one argument
11679 (e.g., @code{qbordermatrix}).
11680 @end table
11682 Thus, attributes can be used in a wide array of situations, like writing
11683 a table that will span over multiple pages, or a matrix product:
11685 @example
11686 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11687 | ..... | ..... |
11688 | ..... | ..... |
11690 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11691 | a | b |
11692 | c | d |
11693 #+ATTR_LATEX: :mode math :environment bmatrix
11694 | 1 | 2 |
11695 | 3 | 4 |
11696 @end example
11698 In the example below, @LaTeX{} command
11699 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
11701 @example
11702 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11703 | ..... | ..... |
11704 | ..... | ..... |
11705 @end example
11708 @subsubheading Images in @LaTeX{} export
11709 @cindex images, inline in @LaTeX{}
11710 @cindex inlining images in @LaTeX{}
11712 Images that are linked to without a description part in the link, like
11713 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11714 output file resulting from @LaTeX{} processing.  Org will use an
11715 @code{\includegraphics} macro to insert the image@footnote{In the case of
11716 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11717 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
11719 You can specify specify image width or height with, respectively,
11720 @code{:width} and @code{:height} attributes.  It is also possible to add any
11721 other option with the @code{:options} attribute, as shown in the following
11722 example:
11724 @example
11725 #+ATTR_LATEX: :width 5cm :options angle=90
11726 [[./img/sed-hr4049.pdf]]
11727 @end example
11729 If you need a specific command for the caption, use @code{:caption}
11730 attribute.  It will override standard @code{#+CAPTION} value, if any.
11732 @example
11733 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11734 [[./img/sed-hr4049.pdf]]
11735 @end example
11737 If you have specified a caption as described in @ref{Images and tables}, the
11738 picture will be wrapped into a @code{figure} environment and thus become
11739 a floating element.  You can also ask Org to export an image as a float
11740 without specifying caption by setting the @code{:float} attribute.  You may
11741 also set it to:
11742 @itemize @minus
11743 @item
11744 @code{t}: if you want to use the standard @samp{figure} environment.  It is
11745 used by default if you provide a caption to the image.
11746 @item
11747 @code{multicolumn}: if you wish to include an image which spans multiple
11748 columns in a page.  This will export the image wrapped in a @code{figure*}
11749 environment.
11750 @item
11751 @code{wrap}: if you would like to let text flow around the image.  It will
11752 make the figure occupy the left half of the page.
11753 @item
11754 @code{nil}: if you need to avoid any floating environment, even when
11755 a caption is provided.
11756 @end itemize
11757 @noindent
11758 To modify the placement option of any floating environment, set the
11759 @code{placement} attribute.
11761 @example
11762 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
11763 [[./img/hst.png]]
11764 @end example
11766 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
11767 the @LaTeX{} @code{\includegraphics} macro will be commented out.
11769 @subsubheading Plain lists in @LaTeX{} export
11770 @cindex plain lists, in @LaTeX{} export
11772 Plain lists accept two optional attributes: @code{:environment} and
11773 @code{:options}.  The first one allows the use of a non-standard environment
11774 (e.g., @samp{inparaenum}).  The second one specifies additional arguments for
11775 that environment.
11777 @example
11778 #+ATTR_LATEX: :environment compactitem :options [$\circ$]
11779 - you need ``paralist'' package to reproduce this example.
11780 @end example
11782 @subsubheading Source blocks in @LaTeX{} export
11783 @cindex source blocks, in @LaTeX{} export
11785 In addition to syntax defined in @ref{Literal examples}, names and captions
11786 (@pxref{Images and tables}), source blocks also accept a @code{:float}
11787 attribute.  You may set it to:
11788 @itemize @minus
11789 @item
11790 @code{t}: if you want to make the source block a float.  It is the default
11791 value when a caption is provided.
11792 @item
11793 @code{multicolumn}: if you wish to include a source block which spans multiple
11794 columns in a page.
11795 @item
11796 @code{nil}: if you need to avoid any floating environment, even when a caption
11797 is provided.  It is useful for source code that may not fit in a single page.
11798 @end itemize
11800 @example
11801 #+ATTR_LATEX: :float nil
11802 #+BEGIN_SRC emacs-lisp
11803 Code that may not fit in a single page.
11804 #+END_SRC
11805 @end example
11807 @subsubheading Special blocks in @LaTeX{} export
11808 @cindex special blocks, in @LaTeX{} export
11809 @cindex abstract, in @LaTeX{} export
11810 @cindex proof, in @LaTeX{} export
11812 In @LaTeX{} back-end, special blocks become environments of the same name.
11813 Value of @code{:options} attribute will be appended as-is to that
11814 environment's opening string.  For example:
11816 @example
11817 #+BEGIN_ABSTRACT
11818 We demonstrate how to solve the Syracuse problem.
11819 #+END_ABSTRACT
11821 #+ATTR_LATEX: :options [Proof of important theorem]
11822 #+BEGIN_PROOF
11824 Therefore, any even number greater than 2 is the sum of two primes.
11825 #+END_PROOF
11826 @end example
11828 @noindent
11829 becomes
11831 @example
11832 \begin@{abstract@}
11833 We demonstrate how to solve the Syracuse problem.
11834 \end@{abstract@}
11836 \begin@{proof@}[Proof of important theorem]
11838 Therefore, any even number greater than 2 is the sum of two primes.
11839 \end@{proof@}
11840 @end example
11842 If you need to insert a specific caption command, use @code{:caption}
11843 attribute.  It will override standard @code{#+CAPTION} value, if any.  For
11844 example:
11846 @example
11847 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
11848 #+BEGIN_PROOF
11850 #+END_PROOF
11851 @end example
11853 @subsubheading Horizontal rules
11854 @cindex horizontal rules, in @LaTeX{} export
11856 Width and thickness of a given horizontal rule can be controlled with,
11857 respectively, @code{:width} and @code{:thickness} attributes:
11859 @example
11860 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
11861 -----
11862 @end example
11864 @node Markdown export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
11865 @section Markdown export
11866 @cindex Markdown export
11868 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
11869 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
11870 mode buffer.
11872 It is built over HTML back-end: any construct not supported by Markdown
11873 syntax (e.g., tables) will be controlled and translated by @code{html}
11874 back-end (@pxref{HTML export}).
11876 @subheading Markdown export commands
11878 @table @kbd
11879 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
11880 Export as a text file written in Markdown syntax.  For an Org file,
11881 @file{myfile.org}, the resulting file will be @file{myfile.md}.  The file
11882 will be overwritten without warning.
11883 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
11884 Export to a temporary buffer.  Do not create a file.
11885 @item C-c C-e m o
11886 Export as a text file with Markdown syntax, then open it.
11887 @end table
11889 @subheading Header and sectioning structure
11891 @vindex org-md-headline-style
11892 Markdown export can generate both @code{atx} and @code{setext} types for
11893 headlines, according to @code{org-md-headline-style}.  The former introduces
11894 a hard limit of two levels, whereas the latter pushes it to six.  Headlines
11895 below that limit are exported as lists.  You can also set a soft limit before
11896 that one (@pxref{Export settings}).
11898 @c begin opendocument
11900 @node OpenDocument Text export, Org export, Markdown export, Exporting
11901 @section OpenDocument Text export
11902 @cindex ODT
11903 @cindex OpenDocument
11904 @cindex export, OpenDocument
11905 @cindex LibreOffice
11907 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
11908 (ODT) format.  Documents created by this exporter use the
11909 @cite{OpenDocument-v1.2
11910 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11911 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
11912 are compatible with LibreOffice 3.4.
11914 @menu
11915 * Pre-requisites for ODT export::  What packages ODT exporter relies on
11916 * ODT export commands::         How to invoke ODT export
11917 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
11918 * Applying custom styles::      How to apply custom styles to the output
11919 * Links in ODT export::         How links will be interpreted and formatted
11920 * Tables in ODT export::        How Tables are exported
11921 * Images in ODT export::        How to insert images
11922 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
11923 * Labels and captions in ODT export::  How captions are rendered
11924 * Literal examples in ODT export::  How source and example blocks are formatted
11925 * Advanced topics in ODT export::  Read this if you are a power user
11926 @end menu
11928 @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
11929 @subsection Pre-requisites for ODT export
11930 @cindex zip
11931 The ODT exporter relies on the @file{zip} program to create the final
11932 output.  Check the availability of this program before proceeding further.
11934 @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
11935 @subsection ODT export commands
11937 @subsubheading Exporting to ODT
11938 @anchor{x-export-to-odt}
11940 @cindex region, active
11941 @cindex active region
11942 @cindex transient-mark-mode
11943 @table @kbd
11944 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
11945 @cindex property EXPORT_FILE_NAME
11947 Export as OpenDocument Text file.
11949 @vindex org-odt-preferred-output-format
11950 If @code{org-odt-preferred-output-format} is specified, automatically convert
11951 the exported file to that format.  @xref{x-export-to-other-formats, ,
11952 Automatically exporting to other formats}.
11954 For an Org file @file{myfile.org}, the ODT file will be
11955 @file{myfile.odt}.  The file will be overwritten without warning.  If there
11956 is an active region,@footnote{This requires @code{transient-mark-mode} to be
11957 turned on} only the region will be exported.  If the selected region is a
11958 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
11959 tree head will become the document title.  If the tree head entry has, or
11960 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
11961 export.
11963 @kbd{C-c C-e o O}
11964 Export as an OpenDocument Text file and open the resulting file.
11966 @vindex org-odt-preferred-output-format
11967 If @code{org-odt-preferred-output-format} is specified, open the converted
11968 file instead.  @xref{x-export-to-other-formats, , Automatically exporting to
11969 other formats}.
11970 @end table
11972 @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
11973 @subsection Extending ODT export
11975 The ODT exporter can interface with a variety of document
11976 converters and supports popular converters out of the box.  As a result, you
11977 can use it to export to formats like @samp{doc} or convert a document from
11978 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
11980 @cindex @file{unoconv}
11981 @cindex LibreOffice
11982 If you have a working installation of LibreOffice, a document converter is
11983 pre-configured for you and you can use it right away.  If you would like to
11984 use @file{unoconv} as your preferred converter, customize the variable
11985 @code{org-odt-convert-process} to point to @code{unoconv}.  You can
11986 also use your own favorite converter or tweak the default settings of the
11987 @file{LibreOffice} and @samp{unoconv} converters.  @xref{Configuring a
11988 document converter}.
11990 @subsubsection Automatically exporting to other formats
11991 @anchor{x-export-to-other-formats}
11993 @vindex org-odt-preferred-output-format
11994 Very often, you will find yourself exporting to ODT format, only to
11995 immediately save the exported document to other formats like @samp{doc},
11996 @samp{docx}, @samp{rtf}, @samp{pdf} etc.  In such cases, you can specify your
11997 preferred output format by customizing the variable
11998 @code{org-odt-preferred-output-format}.  This way, the export commands
11999 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12000 format that is of immediate interest to you.
12002 @subsubsection Converting between document formats
12003 @anchor{x-convert-to-other-formats}
12005 There are many document converters in the wild which support conversion to
12006 and from various file formats, including, but not limited to the
12007 ODT format.  LibreOffice converter, mentioned above, is one such
12008 converter.  Once a converter is configured, you can interact with it using
12009 the following command.
12011 @vindex org-odt-convert
12012 @table @kbd
12014 @item M-x org-odt-convert RET
12015 Convert an existing document from one format to another.  With a prefix
12016 argument, also open the newly produced file.
12017 @end table
12019 @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
12020 @subsection Applying custom styles
12021 @cindex styles, custom
12022 @cindex template, custom
12024 The ODT exporter ships with a set of OpenDocument styles
12025 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12026 output.  These factory styles, however, may not cater to your specific
12027 tastes.  To customize the output, you can either modify the above styles
12028 files directly, or generate the required styles using an application like
12029 LibreOffice.  The latter method is suitable for expert and non-expert
12030 users alike, and is described here.
12032 @subsubsection Applying custom styles: the easy way
12034 @enumerate
12035 @item
12036 Create a sample @file{example.org} file with the below settings and export it
12037 to ODT format.
12039 @example
12040 #+OPTIONS: H:10 num:t
12041 @end example
12043 @item
12044 Open the above @file{example.odt} using LibreOffice.  Use the @file{Stylist}
12045 to locate the target styles---these typically have the @samp{Org} prefix---and
12046 modify those to your taste.  Save the modified file either as an
12047 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12049 @item
12050 @cindex #+ODT_STYLES_FILE
12051 @vindex org-odt-styles-file
12052 Customize the variable @code{org-odt-styles-file} and point it to the
12053 newly created file.  For additional configuration options
12054 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12056 If you would like to choose a style on a per-file basis, you can use the
12057 @code{#+ODT_STYLES_FILE} option.  A typical setting will look like
12059 @example
12060 #+ODT_STYLES_FILE: "/path/to/example.ott"
12061 @end example
12065 @example
12066 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12067 @end example
12069 @end enumerate
12071 @subsubsection Using third-party styles and templates
12073 You can use third-party styles and templates for customizing your output.
12074 This will produce the desired output only if the template provides all
12075 style names that the @samp{ODT} exporter relies on.  Unless this condition is
12076 met, the output is going to be less than satisfactory.  So it is highly
12077 recommended that you only work with templates that are directly derived from
12078 the factory settings.
12080 @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
12081 @subsection Links in ODT export
12082 @cindex links, in ODT export
12084 ODT exporter creates native cross-references for internal links.  It creates
12085 Internet-style links for all other links.
12087 A link with no description and destined to a regular (un-itemized) outline
12088 heading is replaced with a cross-reference and section number of the heading.
12090 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
12091 with a cross-reference and sequence number of the labeled entity.
12092 @xref{Labels and captions in ODT export}.
12094 @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
12095 @subsection Tables in ODT export
12096 @cindex tables, in ODT export
12098 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12099 tables is supported.  However, export of complex @file{table.el} tables---tables
12100 that have column or row spans---is not supported.  Such tables are
12101 stripped from the exported document.
12103 By default, a table is exported with top and bottom frames and with rules
12104 separating row and column groups (@pxref{Column groups}).  Furthermore, all
12105 tables are typeset to occupy the same width.  If the table specifies
12106 alignment and relative width for its columns (@pxref{Column width and
12107 alignment}) then these are honored on export.@footnote{The column widths are
12108 interpreted as weighted ratios with the default weight being 1}
12110 @cindex #+ATTR_ODT
12111 You can control the width of the table by specifying @code{:rel-width}
12112 property using an @code{#+ATTR_ODT} line.
12114 For example, consider the following table which makes use of all the rules
12115 mentioned above.
12117 @example
12118 #+ATTR_ODT: :rel-width 50
12119 | Area/Month    |   Jan |   Feb |   Mar |   Sum |
12120 |---------------+-------+-------+-------+-------|
12121 | /             |     < |       |       |     < |
12122 | <l13>         |  <r5> |  <r5> |  <r5> |  <r6> |
12123 | North America |     1 |    21 |   926 |   948 |
12124 | Middle East   |     6 |    75 |   844 |   925 |
12125 | Asia Pacific  |     9 |    27 |   790 |   826 |
12126 |---------------+-------+-------+-------+-------|
12127 | Sum           |    16 |   123 |  2560 |  2699 |
12128 @end example
12130 On export, the table will occupy 50% of text area.  The columns will be sized
12131 (roughly) in the ratio of 13:5:5:5:6.  The first column will be left-aligned
12132 and rest of the columns will be right-aligned.  There will be vertical rules
12133 after separating the header and last columns from other columns.  There will
12134 be horizontal rules separating the header and last rows from other rows.
12136 If you are not satisfied with the above formatting options, you can create
12137 custom table styles and associate them with a table using the
12138 @code{#+ATTR_ODT} line.  @xref{Customizing tables in ODT export}.
12140 @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
12141 @subsection Images in ODT export
12142 @cindex images, embedding in ODT
12143 @cindex embedding images in ODT
12145 @subsubheading Embedding images
12146 You can embed images within the exported document by providing a link to the
12147 desired image file with no link description.  For example, to embed
12148 @samp{img.png} do either of the following:
12150 @example
12151 [[file:img.png]]
12152 @end example
12154 @example
12155 [[./img.png]]
12156 @end example
12158 @subsubheading Embedding clickable images
12159 You can create clickable images by providing a link whose description is a
12160 link to an image file.  For example, to embed a image
12161 @file{org-mode-unicorn.png} which when clicked jumps to
12162 @uref{http://Orgmode.org} website, do the following
12164 @example
12165 [[http://orgmode.org][./org-mode-unicorn.png]]
12166 @end example
12168 @subsubheading Sizing and scaling of embedded images
12170 @cindex #+ATTR_ODT
12171 You can control the size and scale of the embedded images using the
12172 @code{#+ATTR_ODT} attribute.
12174 @cindex identify, ImageMagick
12175 @vindex org-odt-pixels-per-inch
12176 The exporter specifies the desired size of the image in the final document in
12177 units of centimeters.  In order to scale the embedded images, the exporter
12178 queries for pixel dimensions of the images using one of a) ImageMagick's
12179 @file{identify} program or b) Emacs `create-image' and `image-size'
12180 APIs@footnote{Use of @file{ImageMagick} is only desirable.  However, if you
12181 routinely produce documents that have large images or you export your Org
12182 files that has images using a Emacs batch script, then the use of
12183 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12184 converted in to units of centimeters using
12185 @code{org-odt-pixels-per-inch}.  The default value of this variable is
12186 set to @code{display-pixels-per-inch}.  You can tweak this variable to
12187 achieve the best results.
12189 The examples below illustrate the various possibilities.
12191 @table @asis
12192 @item Explicitly size the image
12193 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12195 @example
12196 #+ATTR_ODT: :width 10 :height 10
12197 [[./img.png]]
12198 @end example
12200 @item Scale the image
12201 To embed @file{img.png} at half its size, do the following:
12203 @example
12204 #+ATTR_ODT: :scale 0.5
12205 [[./img.png]]
12206 @end example
12208 @item Scale the image to a specific width
12209 To embed @file{img.png} with a width of 10 cm while retaining the original
12210 height:width ratio, do the following:
12212 @example
12213 #+ATTR_ODT: :width 10
12214 [[./img.png]]
12215 @end example
12217 @item Scale the image to a specific height
12218 To embed @file{img.png} with a height of 10 cm while retaining the original
12219 height:width ratio, do the following
12221 @example
12222 #+ATTR_ODT: :height 10
12223 [[./img.png]]
12224 @end example
12225 @end table
12227 @subsubheading Anchoring of images
12229 @cindex #+ATTR_ODT
12230 You can control the manner in which an image is anchored by setting the
12231 @code{:anchor} property of it's @code{#+ATTR_ODT} line.  You can specify one
12232 of the the following three values for the @code{:anchor} property:
12233 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12235 To create an image that is anchored to a page, do the following:
12236 @example
12237 #+ATTR_ODT: :anchor "page"
12238 [[./img.png]]
12239 @end example
12241 @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
12242 @subsection Math formatting in ODT export
12244 The ODT exporter has special support for handling math.
12246 @menu
12247 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
12248 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
12249 @end menu
12251 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
12252 @subsubsection Working with @LaTeX{} math snippets
12254 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12255 document in one of the following ways:
12257 @cindex MathML
12258 @enumerate
12259 @item MathML
12261 This option is activated on a per-file basis with
12263 @example
12264 #+OPTIONS: LaTeX:t
12265 @end example
12267 With this option, @LaTeX{} fragments are first converted into MathML
12268 fragments using an external @LaTeX{}-to-MathML converter program.  The
12269 resulting MathML fragments are then embedded as an OpenDocument Formula in
12270 the exported document.
12272 @vindex org-latex-to-mathml-convert-command
12273 @vindex org-latex-to-mathml-jar-file
12275 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12276 @code{org-latex-to-mathml-convert-command} and
12277 @code{org-latex-to-mathml-jar-file}.
12279 If you prefer to use @file{MathToWeb}@footnote{See
12280 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
12281 converter, you can configure the above variables as shown below.
12283 @lisp
12284 (setq org-latex-to-mathml-convert-command
12285       "java -jar %j -unicode -force -df %o %I"
12286       org-latex-to-mathml-jar-file
12287       "/path/to/mathtoweb.jar")
12288 @end lisp
12290 You can use the following commands to quickly verify the reliability of
12291 the @LaTeX{}-to-MathML converter.
12293 @table @kbd
12294 @item M-x org-odt-export-as-odf RET
12295 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12297 @item M-x org-odt-export-as-odf-and-open RET
12298 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12299 and open the formula file with the system-registered application.
12300 @end table
12302 @cindex dvipng
12303 @cindex imagemagick
12304 @item PNG images
12306 This option is activated on a per-file basis with
12308 @example
12309 #+OPTIONS: tex:dvipng
12310 @end example
12314 @example
12315 #+OPTIONS: tex:imagemagick
12316 @end example
12318 With this option, @LaTeX{} fragments are processed into PNG images and the
12319 resulting images are embedded in the exported document.  This method requires
12320 that the @file{dvipng} program or @file{imagemagick} suite be available on
12321 your system.
12322 @end enumerate
12324 @node Working with MathML or OpenDocument formula files,  , Working with @LaTeX{} math snippets, Math formatting in ODT export
12325 @subsubsection Working with MathML or OpenDocument formula files
12327 For various reasons, you may find embedding @LaTeX{} math snippets in an
12328 ODT document less than reliable.  In that case, you can embed a
12329 math equation by linking to its MathML (@file{.mml}) source or its
12330 OpenDocument formula (@file{.odf}) file as shown below:
12332 @example
12333 [[./equation.mml]]
12334 @end example
12338 @example
12339 [[./equation.odf]]
12340 @end example
12342 @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
12343 @subsection Labels and captions in ODT export
12345 You can label and caption various category of objects---an inline image, a
12346 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12347 @code{#+CAPTION} lines.  @xref{Images and tables}.  ODT exporter enumerates
12348 each labeled or captioned object of a given category separately.  As a
12349 result, each such object is assigned a sequence number based on order of it's
12350 appearance in the Org file.
12352 In the exported document, a user-provided caption is augmented with the
12353 category and sequence number.  Consider the following inline image in an Org
12354 file.
12356 @example
12357 #+CAPTION: Bell curve
12358 #+LABEL:   fig:SED-HR4049
12359 [[./img/a.png]]
12360 @end example
12362 It could be rendered as shown below in the exported document.
12364 @example
12365 Figure 2: Bell curve
12366 @end example
12368 @vindex org-odt-category-map-alist
12369 You can modify the category component of the caption by customizing the
12370 option @code{org-odt-category-map-alist}.  For example, to tag all embedded
12371 images with the string @samp{Illustration} (instead of the default
12372 @samp{Figure}) use the following setting:
12374 @lisp
12375 (setq org-odt-category-map-alist
12376       (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12377 @end lisp
12379 With this, previous image will be captioned as below in the exported
12380 document.
12382 @example
12383 Illustration 2: Bell curve
12384 @end example
12386 @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
12387 @subsection Literal examples in ODT export
12389 Export of literal examples (@pxref{Literal examples}) with full fontification
12390 is supported.  Internally, the exporter relies on @file{htmlfontify.el} to
12391 generate all style definitions needed for a fancy listing.@footnote{Your
12392 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
12393 fontification to be turned on.}  The auto-generated styles have @samp{OrgSrc}
12394 as prefix and inherit their color from the faces used by Emacs
12395 @code{font-lock} library for the source language.
12397 @vindex org-odt-fontify-srcblocks
12398 If you prefer to use your own custom styles for fontification, you can do
12399 so by customizing the option
12400 @code{org-odt-create-custom-styles-for-srcblocks}.
12402 @vindex org-odt-create-custom-styles-for-srcblocks
12403 You can turn off fontification of literal examples by customizing the
12404 option @code{org-odt-fontify-srcblocks}.
12406 @node Advanced topics in ODT export,  , Literal examples in ODT export, OpenDocument Text export
12407 @subsection Advanced topics in ODT export
12409 If you rely heavily on ODT export, you may want to exploit the full
12410 set of features that the exporter offers.  This section describes features
12411 that would be of interest to power users.
12413 @menu
12414 * Configuring a document converter::  How to register a document converter
12415 * Working with OpenDocument style files::  Explore the internals
12416 * Creating one-off styles::     How to produce custom highlighting etc
12417 * Customizing tables in ODT export::  How to define and use Table templates
12418 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
12419 @end menu
12421 @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
12422 @subsubsection Configuring a document converter
12423 @cindex convert
12424 @cindex doc, docx, rtf
12425 @cindex converter
12427 The ODT exporter can work with popular converters with little or no
12428 extra configuration from your side. @xref{Extending ODT export}.
12429 If you are using a converter that is not supported by default or if you would
12430 like to tweak the default converter settings, proceed as below.
12432 @enumerate
12433 @item Register the converter
12435 @vindex org-odt-convert-processes
12436 Name your converter and add it to the list of known converters by
12437 customizing the option @code{org-odt-convert-processes}.  Also specify how
12438 the converter can be invoked via command-line to effect the conversion.
12440 @item Configure its capabilities
12442 @vindex org-odt-convert-capabilities
12443 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12444 converter can handle by customizing the variable
12445 @code{org-odt-convert-capabilities}.  Use the default value for this
12446 variable as a guide for configuring your converter.  As suggested by the
12447 default setting, you can specify the full set of formats supported by the
12448 converter and not limit yourself to specifying formats that are related to
12449 just the OpenDocument Text format.
12451 @item Choose the converter
12453 @vindex org-odt-convert-process
12454 Select the newly added converter as the preferred one by customizing the
12455 option @code{org-odt-convert-process}.
12456 @end enumerate
12458 @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
12459 @subsubsection Working with OpenDocument style files
12460 @cindex styles, custom
12461 @cindex template, custom
12463 This section explores the internals of the ODT exporter and the
12464 means by which it produces styled documents.  Read this section if you are
12465 interested in exploring the automatic and custom OpenDocument styles used by
12466 the exporter.
12468 @anchor{x-factory-styles}
12469 @subsubheading Factory styles
12471 The ODT exporter relies on two files for generating its output.
12472 These files are bundled with the distribution under the directory pointed to
12473 by the variable @code{org-odt-styles-dir}.  The two files are:
12475 @itemize
12476 @anchor{x-orgodtstyles-xml}
12477 @item
12478 @file{OrgOdtStyles.xml}
12480 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12481 document.  This file gets modified for the following purposes:
12482 @enumerate
12484 @item
12485 To control outline numbering based on user settings.
12487 @item
12488 To add styles generated by @file{htmlfontify.el} for fontification of code
12489 blocks.
12490 @end enumerate
12492 @anchor{x-orgodtcontenttemplate-xml}
12493 @item
12494 @file{OrgOdtContentTemplate.xml}
12496 This file contributes to the @file{content.xml} file of the final @samp{ODT}
12497 document.  The contents of the Org outline are inserted between the
12498 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
12500 Apart from serving as a template file for the final @file{content.xml}, the
12501 file serves the following purposes:
12502 @enumerate
12504 @item
12505 It contains automatic styles for formatting of tables which are referenced by
12506 the exporter.
12508 @item
12509 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
12510 elements that control how various entities---tables, images, equations,
12511 etc.---are numbered.
12512 @end enumerate
12513 @end itemize
12515 @anchor{x-overriding-factory-styles}
12516 @subsubheading Overriding factory styles
12517 The following two variables control the location from which the ODT
12518 exporter picks up the custom styles and content template files.  You can
12519 customize these variables to override the factory styles used by the
12520 exporter.
12522 @itemize
12523 @anchor{x-org-odt-styles-file}
12524 @item
12525 @code{org-odt-styles-file}
12527 Use this variable to specify the @file{styles.xml} that will be used in the
12528 final output.  You can specify one of the following values:
12530 @enumerate
12531 @item A @file{styles.xml} file
12533 Use this file instead of the default @file{styles.xml}
12535 @item A @file{.odt} or @file{.ott} file
12537 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12538 Template file
12540 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
12542 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12543 Template file.  Additionally extract the specified member files and embed
12544 those within the final @samp{ODT} document.
12546 Use this option if the @file{styles.xml} file references additional files
12547 like header and footer images.
12549 @item @code{nil}
12551 Use the default @file{styles.xml}
12552 @end enumerate
12554 @anchor{x-org-odt-content-template-file}
12555 @item
12556 @code{org-odt-content-template-file}
12558 Use this variable to specify the blank @file{content.xml} that will be used
12559 in the final output.
12560 @end itemize
12562 @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
12563 @subsubsection Creating one-off styles
12565 There are times when you would want one-off formatting in the exported
12566 document.  You can achieve this by embedding raw OpenDocument XML in the Org
12567 file.  The use of this feature is better illustrated with couple of examples.
12569 @enumerate
12570 @item Embedding ODT tags as part of regular text
12572 You can inline OpenDocument syntax by enclosing it within
12573 @samp{@@@@odt:...@@@@} markup.  For example, to highlight a region of text do
12574 the following:
12576 @example
12577 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
12578 text</text:span>@@@@.  But this is a regular text.
12579 @end example
12581 @strong{Hint:} To see the above example in action, edit your
12582 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12583 custom @samp{Highlight} style as shown below.
12585 @example
12586 <style:style style:name="Highlight" style:family="text">
12587   <style:text-properties fo:background-color="#ff0000"/>
12588 </style:style>
12589 @end example
12591 @item Embedding a one-line OpenDocument XML
12593 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
12594 directive.  For example, to force a page break do the following:
12596 @example
12597 #+ODT: <text:p text:style-name="PageBreak"/>
12598 @end example
12600 @strong{Hint:} To see the above example in action, edit your
12601 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12602 custom @samp{PageBreak} style as shown below.
12604 @example
12605 <style:style style:name="PageBreak" style:family="paragraph"
12606              style:parent-style-name="Text_20_body">
12607   <style:paragraph-properties fo:break-before="page"/>
12608 </style:style>
12609 @end example
12611 @item Embedding a block of OpenDocument XML
12613 You can add a large block of OpenDocument XML using the
12614 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
12616 For example, to create a one-off paragraph that uses bold text, do the
12617 following:
12619 @example
12620 #+BEGIN_ODT
12621 <text:p text:style-name="Text_20_body_20_bold">
12622 This paragraph is specially formatted and uses bold text.
12623 </text:p>
12624 #+END_ODT
12625 @end example
12627 @end enumerate
12629 @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
12630 @subsubsection Customizing tables in ODT export
12631 @cindex tables, in ODT export
12633 @cindex #+ATTR_ODT
12634 You can override the default formatting of the table by specifying a custom
12635 table style with the @code{#+ATTR_ODT} line.  For a discussion on default
12636 formatting of tables @pxref{Tables in ODT export}.
12638 This feature closely mimics the way table templates are defined in the
12639 OpenDocument-v1.2
12640 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12641 OpenDocument-v1.2 Specification}}
12643 @subsubheading Custom table styles: an illustration
12645 @vindex org-odt-table-styles
12646 To have a quick preview of this feature, install the below setting and
12647 export the table that follows:
12649 @lisp
12650 (setq org-odt-table-styles
12651       (append org-odt-table-styles
12652             '(("TableWithHeaderRowAndColumn" "Custom"
12653                 ((use-first-row-styles . t)
12654                  (use-first-column-styles . t)))
12655                 ("TableWithFirstRowandLastRow" "Custom"
12656                  ((use-first-row-styles . t)
12657                  (use-last-row-styles . t))))))
12658 @end lisp
12660 @example
12661 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12662 | Name  | Phone | Age |
12663 | Peter |  1234 |  17 |
12664 | Anna  |  4321 |  25 |
12665 @end example
12667 In the above example, you used a template named @samp{Custom} and installed
12668 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12669 @samp{TableWithFirstRowandLastRow}.  (@strong{Important:} The OpenDocument
12670 styles needed for producing the above template have been pre-defined for
12671 you.  These styles are available under the section marked @samp{Custom
12672 Table Template} in @file{OrgOdtContentTemplate.xml}
12673 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}).  If you need
12674 additional templates you have to define these styles yourselves.
12676 @subsubheading Custom table styles: the nitty-gritty
12677 To use this feature proceed as follows:
12679 @enumerate
12680 @item
12681 Create a table template@footnote{See the @code{<table:table-template>}
12682 element of the OpenDocument-v1.2 specification}
12684 A table template is nothing but a set of @samp{table-cell} and
12685 @samp{paragraph} styles for each of the following table cell categories:
12687 @itemize @minus
12688 @item Body
12689 @item First column
12690 @item Last column
12691 @item First row
12692 @item Last row
12693 @item Even row
12694 @item Odd row
12695 @item Even column
12696 @item Odd Column
12697 @end itemize
12699 The names for the above styles must be chosen based on the name of the table
12700 template using a well-defined convention.
12702 The naming convention is better illustrated with an example.  For a table
12703 template with the name @samp{Custom}, the needed style names are listed in
12704 the following table.
12706 @multitable  {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12707 @headitem Table cell type
12708 @tab @code{table-cell} style
12709 @tab @code{paragraph} style
12710 @item
12711 @tab
12712 @tab
12713 @item Body
12714 @tab @samp{CustomTableCell}
12715 @tab @samp{CustomTableParagraph}
12716 @item First column
12717 @tab @samp{CustomFirstColumnTableCell}
12718 @tab @samp{CustomFirstColumnTableParagraph}
12719 @item Last column
12720 @tab @samp{CustomLastColumnTableCell}
12721 @tab @samp{CustomLastColumnTableParagraph}
12722 @item First row
12723 @tab @samp{CustomFirstRowTableCell}
12724 @tab @samp{CustomFirstRowTableParagraph}
12725 @item Last row
12726 @tab @samp{CustomLastRowTableCell}
12727 @tab @samp{CustomLastRowTableParagraph}
12728 @item Even row
12729 @tab @samp{CustomEvenRowTableCell}
12730 @tab @samp{CustomEvenRowTableParagraph}
12731 @item Odd row
12732 @tab @samp{CustomOddRowTableCell}
12733 @tab @samp{CustomOddRowTableParagraph}
12734 @item Even column
12735 @tab @samp{CustomEvenColumnTableCell}
12736 @tab @samp{CustomEvenColumnTableParagraph}
12737 @item Odd column
12738 @tab @samp{CustomOddColumnTableCell}
12739 @tab @samp{CustomOddColumnTableParagraph}
12740 @end multitable
12742 To create a table template with the name @samp{Custom}, define the above
12743 styles in the
12744 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
12745 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
12746 styles}).
12748 @item
12749 Define a table style@footnote{See the attributes @code{table:template-name},
12750 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
12751 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
12752 @code{table:use-banding-rows-styles}, and
12753 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
12754 the OpenDocument-v1.2 specification}
12756 @vindex org-odt-table-styles
12757 To define a table style, create an entry for the style in the variable
12758 @code{org-odt-table-styles} and specify the following:
12760 @itemize @minus
12761 @item the name of the table template created in step (1)
12762 @item the set of cell styles in that template that are to be activated
12763 @end itemize
12765 For example, the entry below defines two different table styles
12766 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
12767 based on the same template @samp{Custom}.  The styles achieve their intended
12768 effect by selectively activating the individual cell styles in that template.
12770 @lisp
12771 (setq org-odt-table-styles
12772       (append org-odt-table-styles
12773               '(("TableWithHeaderRowAndColumn" "Custom"
12774                  ((use-first-row-styles . t)
12775                   (use-first-column-styles . t)))
12776                 ("TableWithFirstRowandLastRow" "Custom"
12777                  ((use-first-row-styles . t)
12778                   (use-last-row-styles . t))))))
12779 @end lisp
12781 @item
12782 Associate a table with the table style
12784 To do this, specify the table style created in step (2) as part of
12785 the @code{ATTR_ODT} line as shown below.
12787 @example
12788 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12789 | Name  | Phone | Age |
12790 | Peter |  1234 |  17 |
12791 | Anna  |  4321 |  25 |
12792 @end example
12793 @end enumerate
12795 @node Validating OpenDocument XML,  , Customizing tables in ODT export, Advanced topics in ODT export
12796 @subsubsection Validating OpenDocument XML
12798 Occasionally, you will discover that the document created by the
12799 ODT exporter cannot be opened by your favorite application.  One of
12800 the common reasons for this is that the @file{.odt} file is corrupt.  In such
12801 cases, you may want to validate the document against the OpenDocument RELAX
12802 NG Compact Syntax (RNC) schema.
12804 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
12805 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}.  For
12806 general help with validation (and schema-sensitive editing) of XML files:
12807 @inforef{Introduction,,nxml-mode}.
12809 @vindex org-odt-schema-dir
12810 If you have ready access to OpenDocument @file{.rnc} files and the needed
12811 schema-locating rules in a single folder, you can customize the variable
12812 @code{org-odt-schema-dir} to point to that directory.  The ODT exporter
12813 will take care of updating the @code{rng-schema-locating-files} for you.
12815 @c end opendocument
12817 @node Org export
12818 @section Org export
12819 @cindex Org export
12821 @code{org} export back-end creates a normalized version of the Org document
12822 in current buffer.  In particular, it evaluates Babel code (@pxref{Evaluating
12823 code blocks}) and removes other back-ends specific contents.
12825 @subheading Org export commands
12827 @table @kbd
12828 @orgcmd{C-c C-e O o,org-org-export-to-org}
12829 Export as an Org document.  For an Org file, @file{myfile.org}, the resulting
12830 file will be @file{myfile.org.org}.  The file will be overwritten without
12831 warning.
12832 @orgcmd{C-c C-e O O,org-org-export-as-org}
12833 Export to a temporary buffer.  Do not create a file.
12834 @item C-c C-e O v
12835 Export to an Org file, then open it.
12836 @end table
12838 @node iCalendar export, Other built-in back-ends, Org export, Exporting
12839 @section iCalendar export
12840 @cindex iCalendar export
12842 @vindex org-icalendar-include-todo
12843 @vindex org-icalendar-use-deadline
12844 @vindex org-icalendar-use-scheduled
12845 @vindex org-icalendar-categories
12846 @vindex org-icalendar-alarm-time
12847 Some people use Org mode for keeping track of projects, but still prefer a
12848 standard calendar application for anniversaries and appointments.  In this
12849 case it can be useful to show deadlines and other time-stamped items in Org
12850 files in the calendar application.  Org mode can export calendar information
12851 in the standard iCalendar format.  If you also want to have TODO entries
12852 included in the export, configure the variable
12853 @code{org-icalendar-include-todo}.  Plain timestamps are exported as VEVENT,
12854 and TODO items as VTODO@.  It will also create events from deadlines that are
12855 in non-TODO items.  Deadlines and scheduling dates in TODO items will be used
12856 to set the start and due dates for the TODO entry@footnote{See the variables
12857 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
12858 As categories, it will use the tags locally defined in the heading, and the
12859 file/tree category@footnote{To add inherited tags or the TODO state,
12860 configure the variable @code{org-icalendar-categories}.}.  See the variable
12861 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
12862 time.
12864 @vindex org-icalendar-store-UID
12865 @cindex property, ID
12866 The iCalendar standard requires each entry to have a globally unique
12867 identifier (UID).  Org creates these identifiers during export.  If you set
12868 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
12869 @code{:ID:} property of the entry and re-used next time you report this
12870 entry.  Since a single entry can give rise to multiple iCalendar entries (as
12871 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
12872 prefixes to the UID, depending on what triggered the inclusion of the entry.
12873 In this way the UID remains unique, but a synchronization program can still
12874 figure out from which entry all the different instances originate.
12876 @table @kbd
12877 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
12878 Create iCalendar entries for the current buffer and store them in the same
12879 directory, using a file extension @file{.ics}.
12880 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
12881 @vindex org-agenda-files
12882 Like @kbd{C-c C-e c f}, but do this for all files in
12883 @code{org-agenda-files}.  For each of these files, a separate iCalendar
12884 file will be written.
12885 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
12886 @vindex org-icalendar-combined-agenda-file
12887 Create a single large iCalendar file from all files in
12888 @code{org-agenda-files} and write it to the file given by
12889 @code{org-icalendar-combined-agenda-file}.
12890 @end table
12892 @vindex org-use-property-inheritance
12893 @vindex org-icalendar-include-body
12894 @cindex property, SUMMARY
12895 @cindex property, DESCRIPTION
12896 @cindex property, LOCATION
12897 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
12898 property can be inherited from higher in the hierarchy if you configure
12899 @code{org-use-property-inheritance} accordingly.} properties if the selected
12900 entries have them.  If not, the summary will be derived from the headline,
12901 and the description from the body (limited to
12902 @code{org-icalendar-include-body} characters).
12904 How this calendar is best read and updated, depends on the application
12905 you are using.  The FAQ covers this issue.
12907 @node Other built-in back-ends, Export in foreign buffers, iCalendar export, Exporting
12908 @section Other built-in back-ends
12909 @cindex export back-ends, built-in
12910 @vindex org-export-backends
12912 On top of the aforementioned back-ends, Org comes with other built-in ones:
12914 @itemize
12915 @item @file{ox-man.el}: export to a man page.
12916 @item @file{ox-texinfo.el}: export to @code{Texinfo} format.
12917 @end itemize
12919 To activate these export back-end, customize @code{org-export-backends} or
12920 load them directly with e.g., @code{(require 'ox-texinfo)}.  This will add
12921 new keys in the export dispatcher (@pxref{The Export Dispatcher}).
12923 See the comment section of these files for more information on how to use
12924 them.
12926 @node Export in foreign buffers, Advanced configuration, Other built-in back-ends, Exporting
12927 @section Export in foreign buffers
12929 Most built-in back-ends come with a command to convert the selected region
12930 into a selected format and replace this region by the exported output.  Here
12931 is a list of such conversion commands:
12933 @table @code
12934 @item org-html-convert-region-to-html
12935 Convert the selected region into HTML.
12936 @item org-latex-convert-region-to-latex
12937 Convert the selected region into @LaTeX{}.
12938 @item org-texinfo-convert-region-to-texinfo
12939 Convert the selected region into @code{Texinfo}.
12940 @item org-md-convert-region-to-md
12941 Convert the selected region into @code{MarkDown}.
12942 @end table
12944 This is particularly useful for converting tables and lists in foreign
12945 buffers.  E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
12946 use Org commands for editing a list, and finally select and convert the list
12947 with @code{M-x org-html-convert-region-to-html RET}.
12949 @node Advanced configuration,  , Export in foreign buffers, Exporting
12950 @section Advanced configuration
12952 @subheading Hooks
12954 @vindex org-export-before-processing-hook
12955 @vindex org-export-before-parsing-hook
12956 Two hooks are run during the first steps of the export process.  The first
12957 one, @code{org-export-before-processing-hook} is called before expanding
12958 macros, Babel code and include keywords in the buffer.  The second one,
12959 @code{org-export-before-parsing-hook}, as its name suggests, happens just
12960 before parsing the buffer.  Their main use is for heavy duties, that is
12961 duties involving structural modifications of the document.  For example, one
12962 may want to remove every headline in the buffer during export.  The following
12963 code can achieve this:
12965 @lisp
12966 @group
12967 (defun my-headline-removal (backend)
12968   "Remove all headlines in the current buffer.
12969 BACKEND is the export back-end being used, as a symbol."
12970   (org-map-entries
12971    (lambda () (delete-region (point) (progn (forward-line) (point))))))
12973 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
12974 @end group
12975 @end lisp
12977 Note that functions used in these hooks require a mandatory argument,
12978 a symbol representing the back-end used.
12980 @subheading Filters
12982 @cindex Filters, exporting
12983 Filters are lists of functions applied on a specific part of the output from
12984 a given back-end.  More explicitly, each time a back-end transforms an Org
12985 object or element into another language, all functions within a given filter
12986 type are called in turn on the string produced.  The string returned by the
12987 last function will be the one used in the final output.
12989 There are filters sets for each type of element or object, for plain text,
12990 for the parse tree, for the export options and for the final output.  They
12991 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
12992 where @code{TYPE} is the type targeted by the filter.  Valid types are:
12994 @multitable @columnfractions .33 .33 .33
12995 @item bold
12996 @tab babel-call
12997 @tab center-block
12998 @item clock
12999 @tab code
13000 @tab comment
13001 @item comment-block
13002 @tab diary-sexp
13003 @tab drawer
13004 @item dynamic-block
13005 @tab entity
13006 @tab example-block
13007 @item export-block
13008 @tab export-snippet
13009 @tab final-output
13010 @item fixed-width
13011 @tab footnote-definition
13012 @tab footnote-reference
13013 @item headline
13014 @tab horizontal-rule
13015 @tab inline-babel-call
13016 @item inline-src-block
13017 @tab inlinetask
13018 @tab italic
13019 @item item
13020 @tab keyword
13021 @tab latex-environment
13022 @item latex-fragment
13023 @tab line-break
13024 @tab link
13025 @item node-property
13026 @tab options
13027 @tab paragraph
13028 @item parse-tree
13029 @tab plain-list
13030 @tab plain-text
13031 @item planning
13032 @tab property-drawer
13033 @tab quote-block
13034 @item quote-section
13035 @tab radio-target
13036 @tab section
13037 @item special-block
13038 @tab src-block
13039 @tab statistics-cookie
13040 @item strike-through
13041 @tab subscript
13042 @tab superscript
13043 @item table
13044 @tab table-cell
13045 @tab table-row
13046 @item target
13047 @tab timestamp
13048 @tab underline
13049 @item verbatim
13050 @tab verse-block
13051 @tab
13052 @end multitable
13054 For example, the following snippet allows me to use non-breaking spaces in
13055 the Org buffer and get them translated into @LaTeX{} without using the
13056 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
13058 @lisp
13059 @group
13060 (defun my-latex-filter-nobreaks (text backend info)
13061   "Ensure \" \" are properly handled in LaTeX export."
13062   (when (org-export-derived-backend-p backend 'latex)
13063         (replace-regexp-in-string " " "~" text)))
13065 (add-to-list 'org-export-filter-plain-text-functions
13066              'my-latex-filter-nobreaks)
13067 @end group
13068 @end lisp
13070 Three arguments must be provided to a filter: the code being changed, the
13071 back-end used, and some information about the export process.  You can safely
13072 ignore the third argument for most purposes.  Note the use of
13073 @code{org-export-derived-backend-p}, which ensures that the filter will only
13074 be applied when using @code{latex} back-end or any other back-end derived
13075 from it (e.g., @code{beamer}).
13077 @subheading Extending an existing back-end
13079 This is obviously the most powerful customization, since the changes happen
13080 at the parser level.  Indeed, some export back-ends are built as extensions
13081 of other ones (e.g. Markdown back-end an extension of HTML back-end).
13083 Extending a back-end means that if an element type is not transcoded by the
13084 new back-end, it will be handled by the original one.  Hence you can extend
13085 specific parts of a back-end without too much work.
13087 As an example, imagine we want the @code{ascii} back-end to display the
13088 language used in a source block, when it is available, but only when some
13089 attribute is non-@code{nil}, like the following:
13091 @example
13092 #+ATTR_ASCII: :language t
13093 @end example
13095 Because that back-end is lacking in that area, we are going to create a new
13096 back-end, @code{my-ascii} that will do the job.
13098 @lisp
13099 @group
13100 (defun my-ascii-src-block (src-block contents info)
13101   "Transcode a SRC-BLOCK element from Org to ASCII.
13102 CONTENTS is nil.  INFO is a plist used as a communication
13103 channel."
13104   (if (not (org-export-read-attribute :attr_ascii src-block :language))
13105     (org-export-with-backend 'ascii src-block contents info)
13106   (concat
13107    (format ",--[ %s ]--\n%s`----"
13108            (org-element-property :language src-block)
13109            (replace-regexp-in-string
13110             "^" "| "
13111             (org-element-normalize-string
13112              (org-export-format-code-default src-block info)))))))
13114 (org-export-define-derived-backend 'my-ascii 'ascii
13115   :translate-alist '((src-block . my-ascii-src-block)))
13116 @end group
13117 @end lisp
13119 The @code{my-ascii-src-block} function looks at the attribute above the
13120 element.  If it isn't true, it gives hand to the @code{ascii} back-end.
13121 Otherwise, it creates a box around the code, leaving room for the language.
13122 A new back-end is then created.  It only changes its behavior when
13123 translating @code{src-block} type element.  Now, all it takes to use the new
13124 back-end is calling the following from an Org buffer:
13126 @smalllisp
13127 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
13128 @end smalllisp
13130 It is obviously possible to write an interactive function for this, install
13131 it in the export dispatcher menu, and so on.
13133 @node Publishing, Working With Source Code, Exporting, Top
13134 @chapter Publishing
13135 @cindex publishing
13137 Org includes a publishing management system that allows you to configure
13138 automatic HTML conversion of @emph{projects} composed of interlinked org
13139 files.  You can also configure Org to automatically upload your exported HTML
13140 pages and related attachments, such as images and source code files, to a web
13141 server.
13143 You can also use Org to convert files into PDF, or even combine HTML and PDF
13144 conversion so that files are available in both formats on the server.
13146 Publishing has been contributed to Org by David O'Toole.
13148 @menu
13149 * Configuration::               Defining projects
13150 * Uploading files::             How to get files up on the server
13151 * Sample configuration::        Example projects
13152 * Triggering publication::      Publication commands
13153 @end menu
13155 @node Configuration, Uploading files, Publishing, Publishing
13156 @section Configuration
13158 Publishing needs significant configuration to specify files, destination
13159 and many other properties of a project.
13161 @menu
13162 * Project alist::               The central configuration variable
13163 * Sources and destinations::    From here to there
13164 * Selecting files::             What files are part of the project?
13165 * Publishing action::           Setting the function doing the publishing
13166 * Publishing options::          Tweaking HTML/@LaTeX{} export
13167 * Publishing links::            Which links keep working after publishing?
13168 * Sitemap::                     Generating a list of all pages
13169 * Generating an index::         An index that reaches across pages
13170 @end menu
13172 @node Project alist, Sources and destinations, Configuration, Configuration
13173 @subsection The variable @code{org-publish-project-alist}
13174 @cindex org-publish-project-alist
13175 @cindex projects, for publishing
13177 @vindex org-publish-project-alist
13178 Publishing is configured almost entirely through setting the value of one
13179 variable, called @code{org-publish-project-alist}.  Each element of the list
13180 configures one project, and may be in one of the two following forms:
13182 @lisp
13183    ("project-name" :property value :property value ...)
13184      @r{i.e., a well-formed property list with alternating keys and values}
13185 @r{or}
13186    ("project-name" :components ("project-name" "project-name" ...))
13188 @end lisp
13190 In both cases, projects are configured by specifying property values.  A
13191 project defines the set of files that will be published, as well as the
13192 publishing configuration to use when publishing those files.  When a project
13193 takes the second form listed above, the individual members of the
13194 @code{:components} property are taken to be sub-projects, which group
13195 together files requiring different publishing options.  When you publish such
13196 a ``meta-project'', all the components will also be published, in the
13197 sequence given.
13199 @node Sources and destinations, Selecting files, Project alist, Configuration
13200 @subsection Sources and destinations for files
13201 @cindex directories, for publishing
13203 Most properties are optional, but some should always be set.  In
13204 particular, Org needs to know where to look for source files,
13205 and where to put published files.
13207 @multitable @columnfractions 0.3 0.7
13208 @item @code{:base-directory}
13209 @tab Directory containing publishing source files
13210 @item @code{:publishing-directory}
13211 @tab Directory where output files will be published.  You can directly
13212 publish to a web server using a file name syntax appropriate for
13213 the Emacs @file{tramp} package.  Or you can publish to a local directory and
13214 use external tools to upload your website (@pxref{Uploading files}).
13215 @item @code{:preparation-function}
13216 @tab Function or list of functions to be called before starting the
13217 publishing process, for example, to run @code{make} for updating files to be
13218 published.  The project property list is scoped into this call as the
13219 variable @code{project-plist}.
13220 @item @code{:completion-function}
13221 @tab Function or list of functions called after finishing the publishing
13222 process, for example, to change permissions of the resulting files.  The
13223 project property list is scoped into this call as the variable
13224 @code{project-plist}.
13225 @end multitable
13226 @noindent
13228 @node Selecting files, Publishing action, Sources and destinations, Configuration
13229 @subsection Selecting files
13230 @cindex files, selecting for publishing
13232 By default, all files with extension @file{.org} in the base directory
13233 are considered part of the project.  This can be modified by setting the
13234 properties
13235 @multitable @columnfractions 0.25 0.75
13236 @item @code{:base-extension}
13237 @tab Extension (without the dot!) of source files.  This actually is a
13238 regular expression.  Set this to the symbol @code{any} if you want to get all
13239 files in @code{:base-directory}, even without extension.
13241 @item @code{:exclude}
13242 @tab Regular expression to match file names that should not be
13243 published, even though they have been selected on the basis of their
13244 extension.
13246 @item @code{:include}
13247 @tab List of files to be included regardless of @code{:base-extension}
13248 and @code{:exclude}.
13250 @item @code{:recursive}
13251 @tab non-@code{nil} means, check base-directory recursively for files to publish.
13252 @end multitable
13254 @node Publishing action, Publishing options, Selecting files, Configuration
13255 @subsection Publishing action
13256 @cindex action, for publishing
13258 Publishing means that a file is copied to the destination directory and
13259 possibly transformed in the process.  The default transformation is to export
13260 Org files as HTML files, and this is done by the function
13261 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
13262 export}).  But you also can publish your content as PDF files using
13263 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
13264 using the corresponding functions.
13266 If you want to publish the Org file as an @code{.org} file but with the
13267 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
13268 function @code{org-org-publish-to-org}.  This will produce @file{file.org}
13269 and put it in the publishing directory.  If you want a htmlized version of
13270 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
13271 produce @file{file.org.html} in the publishing directory@footnote{If the
13272 publishing directory is the same than the source directory, @file{file.org}
13273 will be exported as @file{file.org.org}, so probably don't want to do this.}.
13275 Other files like images only need to be copied to the publishing destination.
13276 For this you can use @code{org-publish-attachment}.  For non-org files, you
13277 always need to specify the publishing function:
13279 @multitable @columnfractions 0.3 0.7
13280 @item @code{:publishing-function}
13281 @tab Function executing the publication of a file.  This may also be a
13282 list of functions, which will all be called in turn.
13283 @item @code{:htmlized-source}
13284 @tab non-@code{nil} means, publish htmlized source.
13285 @end multitable
13287 The function must accept three arguments: a property list containing at least
13288 a @code{:publishing-directory} property, the name of the file to be published
13289 and the path to the publishing directory of the output file.  It should take
13290 the specified file, make the necessary transformation (if any) and place the
13291 result into the destination folder.
13293 @node Publishing options, Publishing links, Publishing action, Configuration
13294 @subsection Options for the exporters
13295 @cindex options, for publishing
13297 The property list can be used to set many export options for the exporters.
13298 In most cases, these properties correspond to user variables in Org.  The
13299 first table below lists these properties along with the variable they belong
13300 to.  The second table list HTML specific properties.  See the documentation
13301 string of these options for details.
13303 @vindex org-display-custom-times
13304 @vindex org-export-default-language
13305 @vindex org-export-exclude-tags
13306 @vindex org-export-headline-levels
13307 @vindex org-export-preserve-breaks
13308 @vindex org-export-publishing-directory
13309 @vindex org-export-select-tags
13310 @vindex org-export-with-archived-trees
13311 @vindex org-export-with-author
13312 @vindex org-export-with-creator
13313 @vindex org-export-with-drawers
13314 @vindex org-export-with-email
13315 @vindex org-export-with-emphasize
13316 @vindex org-export-with-fixed-width
13317 @vindex org-export-with-footnotes
13318 @vindex org-export-with-latex
13319 @vindex org-export-with-planning
13320 @vindex org-export-with-priority
13321 @vindex org-export-with-section-numbers
13322 @vindex org-export-with-special-strings
13323 @vindex org-export-with-sub-superscripts
13324 @vindex org-export-with-tables
13325 @vindex org-export-with-tags
13326 @vindex org-export-with-tasks
13327 @vindex org-export-with-timestamps
13328 @vindex org-export-with-toc
13329 @vindex org-export-with-todo-keywords
13330 @vindex user-mail-address
13332 @multitable @columnfractions 0.32 0.68
13333 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
13334 @item @code{:exclude-tags}          @tab @code{org-export-exclude-tags}
13335 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
13336 @item @code{:language}              @tab @code{org-export-default-language}
13337 @item @code{:preserve-breaks}       @tab @code{org-export-preserve-breaks}
13338 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
13339 @item @code{:select-tags}           @tab @code{org-export-select-tags}
13340 @item @code{:with-author}           @tab @code{org-export-with-author}
13341 @item @code{:with-creator}          @tab @code{org-export-with-creator}
13342 @item @code{:with-drawers}          @tab @code{org-export-with-drawers}
13343 @item @code{:with-email}            @tab @code{org-export-with-email}
13344 @item @code{:with-emphasize}        @tab @code{org-export-with-emphasize}
13345 @item @code{:with-fixed-width}      @tab @code{org-export-with-fixed-width}
13346 @item @code{:with-footnotes}        @tab @code{org-export-with-footnotes}
13347 @item @code{:with-latex}            @tab @code{org-export-with-latex}
13348 @item @code{:with-planning}         @tab @code{org-export-with-planning}
13349 @item @code{:with-priority}         @tab @code{org-export-with-priority}
13350 @item @code{:with-special-strings}  @tab @code{org-export-with-special-strings}
13351 @item @code{:with-sub-superscript}  @tab @code{org-export-with-sub-superscripts}
13352 @item @code{:with-tables}           @tab @code{org-export-with-tables}
13353 @item @code{:with-tags}             @tab @code{org-export-with-tags}
13354 @item @code{:with-tasks}            @tab @code{org-export-with-tasks}
13355 @item @code{:with-timestamps}       @tab @code{org-export-with-timestamps}
13356 @item @code{:with-toc}              @tab @code{org-export-with-toc}
13357 @item @code{:with-todo-keywords}    @tab @code{org-export-with-todo-keywords}
13358 @end multitable
13360 @vindex org-html-doctype
13361 @vindex org-html-container-element
13362 @vindex org-html-html5-fancy
13363 @vindex org-html-xml-declaration
13364 @vindex org-html-link-up
13365 @vindex org-html-link-home
13366 @vindex org-html-link-org-files-as-html
13367 @vindex org-html-link-use-abs-url
13368 @vindex org-html-head
13369 @vindex org-html-head-extra
13370 @vindex org-html-inline-images
13371 @vindex org-html-extension
13372 @vindex org-html-preamble
13373 @vindex org-html-postamble
13374 @vindex org-html-table-default-attributes
13375 @vindex org-html-table-row-tags
13376 @vindex org-html-head-include-default-style
13377 @vindex org-html-head-include-scripts
13378 @multitable @columnfractions 0.32 0.68
13379 @item @code{:html-doctype}          @tab @code{org-html-doctype}
13380 @item @code{:html-container}        @tab @code{org-html-container-element}
13381 @item @code{:html-html5-fancy}      @tab @code{org-html-html5-fancy}
13382 @item @code{:html-xml-declaration}  @tab @code{org-html-xml-declaration}
13383 @item @code{:html-link-up}          @tab @code{org-html-link-up}
13384 @item @code{:html-link-home}        @tab @code{org-html-link-home}
13385 @item @code{:html-link-org-as-html} @tab @code{org-html-link-org-files-as-html}
13386 @item @code{:html-link-use-abs-url} @tab @code{org-html-link-use-abs-url}
13387 @item @code{:html-head}             @tab @code{org-html-head}
13388 @item @code{:html-head-extra}       @tab @code{org-html-head-extra}
13389 @item @code{:html-inline-images}    @tab @code{org-html-inline-images}
13390 @item @code{:html-extension}        @tab @code{org-html-extension}
13391 @item @code{:html-preamble}         @tab @code{org-html-preamble}
13392 @item @code{:html-postamble}        @tab @code{org-html-postamble}
13393 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
13394 @item @code{:html-table-row-tags}   @tab @code{org-html-table-row-tags}
13395 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
13396 @item @code{:html-head-include-scripts} @tab @code{org-html-head-include-scripts}
13397 @end multitable
13399 Most of the @code{org-export-with-*} variables have the same effect in each
13400 exporter.
13402 @vindex org-publish-project-alist
13403 When a property is given a value in @code{org-publish-project-alist}, its
13404 setting overrides the value of the corresponding user variable (if any)
13405 during publishing.  Options set within a file (@pxref{Export settings}),
13406 however, override everything.
13408 @node Publishing links, Sitemap, Publishing options, Configuration
13409 @subsection Links between published files
13410 @cindex links, publishing
13412 To create a link from one Org file to another, you would use something like
13413 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
13414 (@pxref{Hyperlinks}).  When published, this link becomes a link to
13415 @file{foo.html}.  You can thus interlink the pages of your "org web" project
13416 and the links will work as expected when you publish them to HTML@.  If you
13417 also publish the Org source file and want to link to it, use an @code{http:}
13418 link instead of a @code{file:} link, because @code{file:} links are converted
13419 to link to the corresponding @file{html} file.
13421 You may also link to related files, such as images.  Provided you are careful
13422 with relative file names, and provided you have also configured Org to upload
13423 the related files, these links will work too.  See @ref{Complex example}, for
13424 an example of this usage.
13426 @node Sitemap, Generating an index, Publishing links, Configuration
13427 @subsection Generating a sitemap
13428 @cindex sitemap, of published pages
13430 The following properties may be used to control publishing of
13431 a map of files for a given project.
13433 @multitable @columnfractions 0.35 0.65
13434 @item @code{:auto-sitemap}
13435 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
13436 or @code{org-publish-all}.
13438 @item @code{:sitemap-filename}
13439 @tab Filename for output of sitemap.  Defaults to @file{sitemap.org} (which
13440 becomes @file{sitemap.html}).
13442 @item @code{:sitemap-title}
13443 @tab Title of sitemap page.  Defaults to name of file.
13445 @item @code{:sitemap-function}
13446 @tab Plug-in function to use for generation of the sitemap.
13447 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
13448 of links to all files in the project.
13450 @item @code{:sitemap-sort-folders}
13451 @tab Where folders should appear in the sitemap.  Set this to @code{first}
13452 (default) or @code{last} to display folders first or last,
13453 respectively.  Any other value will mix files and folders.
13455 @item @code{:sitemap-sort-files}
13456 @tab How the files are sorted in the site map.  Set this to
13457 @code{alphabetically} (default), @code{chronologically} or
13458 @code{anti-chronologically}.  @code{chronologically} sorts the files with
13459 older date first while @code{anti-chronologically} sorts the files with newer
13460 date first.  @code{alphabetically} sorts the files alphabetically.  The date of
13461 a file is retrieved with @code{org-publish-find-date}.
13463 @item @code{:sitemap-ignore-case}
13464 @tab Should sorting be case-sensitive?  Default @code{nil}.
13466 @item @code{:sitemap-file-entry-format}
13467 @tab With this option one can tell how a sitemap's entry is formatted in the
13468 sitemap.  This is a format string with some escape sequences: @code{%t} stands
13469 for the title of the file, @code{%a} stands for the author of the file and
13470 @code{%d} stands for the date of the file.  The date is retrieved with the
13471 @code{org-publish-find-date} function and formatted with
13472 @code{org-publish-sitemap-date-format}.  Default @code{%t}.
13474 @item @code{:sitemap-date-format}
13475 @tab Format string for the @code{format-time-string} function that tells how
13476 a sitemap entry's date is to be formatted.  This property bypasses
13477 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
13479 @item @code{:sitemap-sans-extension}
13480 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
13481 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
13482 Defaults to @code{nil}.
13484 @end multitable
13486 @node Generating an index,  , Sitemap, Configuration
13487 @subsection Generating an index
13488 @cindex index, in a publishing project
13490 Org mode can generate an index across the files of a publishing project.
13492 @multitable @columnfractions 0.25 0.75
13493 @item @code{:makeindex}
13494 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
13495 publish it as @file{theindex.html}.
13496 @end multitable
13498 The file will be created when first publishing a project with the
13499 @code{:makeindex} set.  The file only contains a statement @code{#+INCLUDE:
13500 "theindex.inc"}.  You can then build around this include statement by adding
13501 a title, style information, etc.
13503 @node Uploading files, Sample configuration, Configuration, Publishing
13504 @section Uploading files
13505 @cindex rsync
13506 @cindex unison
13508 For those people already utilizing third party sync tools such as
13509 @command{rsync} or @command{unison}, it might be preferable not to use the built in
13510 @i{remote} publishing facilities of Org mode which rely heavily on
13511 Tramp.  Tramp, while very useful and powerful, tends not to be
13512 so efficient for multiple file transfer and has been known to cause problems
13513 under heavy usage.
13515 Specialized synchronization utilities offer several advantages.  In addition
13516 to timestamp comparison, they also do content and permissions/attribute
13517 checks.  For this reason you might prefer to publish your web to a local
13518 directory (possibly even @i{in place} with your Org files) and then use
13519 @file{unison} or @file{rsync} to do the synchronization with the remote host.
13521 Since Unison (for example) can be configured as to which files to transfer to
13522 a certain remote destination, it can greatly simplify the project publishing
13523 definition.  Simply keep all files in the correct location, process your Org
13524 files with @code{org-publish} and let the synchronization tool do the rest.
13525 You do not need, in this scenario, to include attachments such as @file{jpg},
13526 @file{css} or @file{gif} files in the project definition since the 3rd party
13527 tool syncs them.
13529 Publishing to a local directory is also much faster than to a remote one, so
13530 that you can afford more easily to republish entire projects.  If you set
13531 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
13532 benefit of re-including any changed external files such as source example
13533 files you might include with @code{#+INCLUDE:}.  The timestamp mechanism in
13534 Org is not smart enough to detect if included files have been modified.
13536 @node Sample configuration, Triggering publication, Uploading files, Publishing
13537 @section Sample configuration
13539 Below we provide two example configurations.  The first one is a simple
13540 project publishing only a set of Org files.  The second example is
13541 more complex, with a multi-component project.
13543 @menu
13544 * Simple example::              One-component publishing
13545 * Complex example::             A multi-component publishing example
13546 @end menu
13548 @node Simple example, Complex example, Sample configuration, Sample configuration
13549 @subsection Example: simple publishing configuration
13551 This example publishes a set of Org files to the @file{public_html}
13552 directory on the local machine.
13554 @lisp
13555 (setq org-publish-project-alist
13556       '(("org"
13557          :base-directory "~/org/"
13558          :publishing-directory "~/public_html"
13559          :section-numbers nil
13560          :with-toc nil
13561          :html-head "<link rel=\"stylesheet\"
13562                     href=\"../other/mystyle.css\"
13563                     type=\"text/css\"/>")))
13564 @end lisp
13566 @node Complex example,  , Simple example, Sample configuration
13567 @subsection Example: complex publishing configuration
13569 This more complicated example publishes an entire website, including
13570 Org files converted to HTML, image files, Emacs Lisp source code, and
13571 style sheets.  The publishing directory is remote and private files are
13572 excluded.
13574 To ensure that links are preserved, care should be taken to replicate
13575 your directory structure on the web server, and to use relative file
13576 paths.  For example, if your Org files are kept in @file{~/org} and your
13577 publishable images in @file{~/images}, you would link to an image with
13579 @example
13580 file:../images/myimage.png
13581 @end example
13583 On the web server, the relative path to the image should be the
13584 same.  You can accomplish this by setting up an "images" folder in the
13585 right place on the web server, and publishing images to it.
13587 @lisp
13588 (setq org-publish-project-alist
13589       '(("orgfiles"
13590           :base-directory "~/org/"
13591           :base-extension "org"
13592           :publishing-directory "/ssh:user@@host:~/html/notebook/"
13593           :publishing-function org-html-publish-to-html
13594           :exclude "PrivatePage.org"   ;; regexp
13595           :headline-levels 3
13596           :section-numbers nil
13597           :with-toc nil
13598           :html-head "<link rel=\"stylesheet\"
13599                   href=\"../other/mystyle.css\" type=\"text/css\"/>"
13600           :html-preamble t)
13602          ("images"
13603           :base-directory "~/images/"
13604           :base-extension "jpg\\|gif\\|png"
13605           :publishing-directory "/ssh:user@@host:~/html/images/"
13606           :publishing-function org-publish-attachment)
13608          ("other"
13609           :base-directory "~/other/"
13610           :base-extension "css\\|el"
13611           :publishing-directory "/ssh:user@@host:~/html/other/"
13612           :publishing-function org-publish-attachment)
13613          ("website" :components ("orgfiles" "images" "other"))))
13614 @end lisp
13616 @node Triggering publication,  , Sample configuration, Publishing
13617 @section Triggering publication
13619 Once properly configured, Org can publish with the following commands:
13621 @table @kbd
13622 @orgcmd{C-c C-e P x,org-publish}
13623 Prompt for a specific project and publish all files that belong to it.
13624 @orgcmd{C-c C-e P p,org-publish-current-project}
13625 Publish the project containing the current file.
13626 @orgcmd{C-c C-e P f,org-publish-current-file}
13627 Publish only the current file.
13628 @orgcmd{C-c C-e P a,org-publish-all}
13629 Publish every project.
13630 @end table
13632 @vindex org-publish-use-timestamps-flag
13633 Org uses timestamps to track when a file has changed.  The above functions
13634 normally only publish changed files.  You can override this and force
13635 publishing of all files by giving a prefix argument to any of the commands
13636 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
13637 This may be necessary in particular if files include other files via
13638 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
13640 @comment  node-name,  next,  previous,  up
13641 @comment Working With Source Code, Miscellaneous, Publishing, Top
13643 @node Working With Source Code, Miscellaneous, Publishing, Top
13644 @chapter Working with source code
13645 @cindex Schulte, Eric
13646 @cindex Davison, Dan
13647 @cindex source code, working with
13649 Source code can be included in Org mode documents using a @samp{src} block,
13650 e.g.:
13652 @example
13653 #+BEGIN_SRC emacs-lisp
13654   (defun org-xor (a b)
13655      "Exclusive or."
13656      (if a (not b) b))
13657 #+END_SRC
13658 @end example
13660 Org mode provides a number of features for working with live source code,
13661 including editing of code blocks in their native major-mode, evaluation of
13662 code blocks, converting code blocks into source files (known as @dfn{tangling}
13663 in literate programming), and exporting code blocks and their
13664 results in several formats.  This functionality was contributed by Eric
13665 Schulte and Dan Davison, and was originally named Org-babel.
13667 The following sections describe Org mode's code block handling facilities.
13669 @menu
13670 * Structure of code blocks::    Code block syntax described
13671 * Editing source code::         Language major-mode editing
13672 * Exporting code blocks::       Export contents and/or results
13673 * Extracting source code::      Create pure source code files
13674 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
13675 * Library of Babel::            Use and contribute to a library of useful code blocks
13676 * Languages::                   List of supported code block languages
13677 * Header arguments::            Configure code block functionality
13678 * Results of evaluation::       How evaluation results are handled
13679 * Noweb reference syntax::      Literate programming in Org mode
13680 * Key bindings and useful functions::  Work quickly with code blocks
13681 * Batch execution::             Call functions from the command line
13682 @end menu
13684 @comment  node-name,  next,  previous,  up
13685 @comment  Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
13687 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
13688 @section Structure of code blocks
13689 @cindex code block, structure
13690 @cindex source code, block structure
13691 @cindex #+NAME
13692 @cindex #+BEGIN_SRC
13694 Live code blocks can be specified with a @samp{src} block or
13695 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
13696 @ref{Easy Templates} system}  The structure of a @samp{src} block is
13698 @example
13699 #+NAME: <name>
13700 #+BEGIN_SRC <language> <switches> <header arguments>
13701   <body>
13702 #+END_SRC
13703 @end example
13705 The @code{#+NAME:} line is optional, and can be used to name the code
13706 block.  Live code blocks require that a language be specified on the
13707 @code{#+BEGIN_SRC} line.  Switches and header arguments are optional.
13708 @cindex source code, inline
13710 Live code blocks can also be specified inline using
13712 @example
13713 src_<language>@{<body>@}
13714 @end example
13718 @example
13719 src_<language>[<header arguments>]@{<body>@}
13720 @end example
13722 @table @code
13723 @item <#+NAME: name>
13724 This line associates a name with the code block.  This is similar to the
13725 @code{#+NAME: Name} lines that can be used to name tables in Org mode
13726 files.  Referencing the name of a code block makes it possible to evaluate
13727 the block from other places in the file, from other files, or from Org mode
13728 table formulas (see @ref{The spreadsheet}).  Names are assumed to be unique
13729 and the behavior of Org mode when two or more blocks share the same name is
13730 undefined.
13731 @cindex #+NAME
13732 @item <language>
13733 The language of the code in the block (see @ref{Languages}).
13734 @cindex source code, language
13735 @item <switches>
13736 Optional switches control code block export (see the discussion of switches in
13737 @ref{Literal examples})
13738 @cindex source code, switches
13739 @item <header arguments>
13740 Optional header arguments control many aspects of evaluation, export and
13741 tangling of code blocks (see @ref{Header arguments}).
13742 Header arguments can also be set on a per-buffer or per-subtree
13743 basis using properties.
13744 @item source code, header arguments
13745 @item <body>
13746 Source code in the specified language.
13747 @end table
13749 @comment  node-name,  next,  previous,  up
13750 @comment  Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
13752 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
13753 @section Editing source code
13754 @cindex code block, editing
13755 @cindex source code, editing
13757 @vindex org-edit-src-auto-save-idle-delay
13758 @vindex org-edit-src-turn-on-auto-save
13759 @kindex C-c '
13760 Use @kbd{C-c '} to edit the current code block.  This brings up a language
13761 major-mode edit buffer containing the body of the code block.  Manually
13762 saving this buffer with @key{C-x C-s} will write the contents back to the Org
13763 buffer.  You can also set @code{org-edit-src-auto-save-idle-delay} to save the
13764 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
13765 to auto-save this buffer into a separate file using @code{auto-save-mode}.
13766 Use @kbd{C-c '} again to exit.
13768 The @code{org-src-mode} minor mode will be active in the edit buffer.  The
13769 following variables can be used to configure the behavior of the edit
13770 buffer.  See also the customization group @code{org-edit-structure} for
13771 further configuration options.
13773 @table @code
13774 @item org-src-lang-modes
13775 If an Emacs major-mode named @code{<lang>-mode} exists, where
13776 @code{<lang>} is the language named in the header line of the code block,
13777 then the edit buffer will be placed in that major-mode.  This variable
13778 can be used to map arbitrary language names to existing major modes.
13779 @item org-src-window-setup
13780 Controls the way Emacs windows are rearranged when the edit buffer is created.
13781 @item org-src-preserve-indentation
13782 By default, the value is @code{nil}, which means that when code blocks are
13783 evaluated during export or tangled, they are re-inserted into the code block,
13784 which may replace sequences of spaces with tab characters.  When non-nil,
13785 whitespace in code blocks will be preserved during export or tangling,
13786 exactly as it appears.  This variable is especially useful for tangling
13787 languages such as Python, in which whitespace indentation in the output is
13788 critical.
13789 @item org-src-ask-before-returning-to-edit-buffer
13790 By default, Org will ask before returning to an open edit buffer.  Set this
13791 variable to @code{nil} to switch without asking.
13792 @end table
13794 To turn on native code fontification in the @emph{Org} buffer, configure the
13795 variable @code{org-src-fontify-natively}.
13797 @comment  node-name,  next,  previous,  up
13798 @comment  Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
13800 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
13801 @section Exporting code blocks
13802 @cindex code block, exporting
13803 @cindex source code, exporting
13805 It is possible to export the @emph{code} of code blocks, the @emph{results}
13806 of code block evaluation, @emph{both} the code and the results of code block
13807 evaluation, or @emph{none}.  For most languages, the default exports code.
13808 However, for some languages (e.g., @code{ditaa}) the default exports the
13809 results of code block evaluation.  For information on exporting code block
13810 bodies, see @ref{Literal examples}.
13812 The @code{:exports} header argument can be used to specify export
13813 behavior:
13815 @subsubheading Header arguments:
13817 @table @code
13818 @item :exports code
13819 The default in most languages.  The body of the code block is exported, as
13820 described in @ref{Literal examples}.
13821 @item :exports results
13822 The code block will be evaluated and the results will be placed in the
13823 Org mode buffer for export, either updating previous results of the code
13824 block located anywhere in the buffer or, if no previous results exist,
13825 placing the results immediately after the code block.  The body of the code
13826 block will not be exported.
13827 @item :exports both
13828 Both the code block and its results will be exported.
13829 @item :exports none
13830 Neither the code block nor its results will be exported.
13831 @end table
13833 It is possible to inhibit the evaluation of code blocks during export.
13834 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
13835 ensure that no code blocks are evaluated as part of the export process.  This
13836 can be useful in situations where potentially untrusted Org mode files are
13837 exported in an automated fashion, for example when Org mode is used as the
13838 markup language for a wiki.  It is also possible to set this variable to
13839 @code{'inline-only}.  In that case, only inline code blocks will be
13840 evaluated, in order to insert their results.  Non-inline code blocks are
13841 assumed to have their results already inserted in the buffer by manual
13842 evaluation.  This setting is useful to avoid expensive recalculations during
13843 export, not to provide security.
13845 @comment  node-name,  next,  previous,  up
13846 @comment  Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
13847 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
13848 @section Extracting source code
13849 @cindex tangling
13850 @cindex source code, extracting
13851 @cindex code block, extracting source code
13853 Creating pure source code files by extracting code from source blocks is
13854 referred to as ``tangling''---a term adopted from the literate programming
13855 community.  During ``tangling'' of code blocks their bodies are expanded
13856 using @code{org-babel-expand-src-block} which can expand both variable and
13857 ``noweb'' style references  (see @ref{Noweb reference syntax}).
13859 @subsubheading Header arguments
13861 @table @code
13862 @item :tangle no
13863 The default.  The code block is not included in the tangled output.
13864 @item :tangle yes
13865 Include the code block in the tangled output.  The output file name is the
13866 name of the org file with the extension @samp{.org} replaced by the extension
13867 for the block language.
13868 @item :tangle filename
13869 Include the code block in the tangled output to file @samp{filename}.
13870 @end table
13872 @kindex  C-c C-v t
13873 @subsubheading Functions
13875 @table @code
13876 @item org-babel-tangle
13877 Tangle the current file.  Bound to @kbd{C-c C-v t}.
13879 With prefix argument only tangle the current code block.
13880 @item org-babel-tangle-file
13881 Choose a file to tangle.  Bound to @kbd{C-c C-v f}.
13882 @end table
13884 @subsubheading Hooks
13886 @table @code
13887 @item org-babel-post-tangle-hook
13888 This hook is run from within code files tangled by @code{org-babel-tangle}.
13889 Example applications could include post-processing, compilation or evaluation
13890 of tangled code files.
13891 @end table
13893 @subsubheading Jumping between code and Org
13895 When tangling code from an Org-mode buffer to a source code file, you'll
13896 frequently find yourself viewing the file of tangled source code (e.g., many
13897 debuggers point to lines of the source code file).  It is useful to be able
13898 to navigate from the tangled source to the Org-mode buffer from which the
13899 code originated.
13901 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
13902 code to Org-mode functionality.  Two header arguments are required for
13903 jumping to work, first the @code{padline} (@ref{padline}) option must be set
13904 to true (the default setting), second the @code{comments} (@ref{comments})
13905 header argument must be set to @code{links}, which will insert comments into
13906 the source code buffer which point back to the original Org-mode file.
13908 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
13909 @section Evaluating code blocks
13910 @cindex code block, evaluating
13911 @cindex source code, evaluating
13912 @cindex #+RESULTS
13914 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
13915 potential for that code to do harm.  Org mode provides safeguards to ensure
13916 that code is only evaluated after explicit confirmation from the user.  For
13917 information on these safeguards (and on how to disable them) see @ref{Code
13918 evaluation security}.} and the results of evaluation optionally placed in the
13919 Org mode buffer.  The results of evaluation are placed following a line that
13920 begins by default with @code{#+RESULTS} and optionally a cache identifier
13921 and/or the name of the evaluated code block.  The default value of
13922 @code{#+RESULTS} can be changed with the customizable variable
13923 @code{org-babel-results-keyword}.
13925 By default, the evaluation facility is only enabled for Lisp code blocks
13926 specified as @code{emacs-lisp}.  However, source code blocks in many languages
13927 can be evaluated within Org mode (see @ref{Languages} for a list of supported
13928 languages and @ref{Structure of code blocks} for information on the syntax
13929 used to define a code block).
13931 @kindex C-c C-c
13932 There are a number of ways to evaluate code blocks.  The simplest is to press
13933 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
13934 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
13935 evaluation from the @kbd{C-c C-c} key binding.}.  This will call the
13936 @code{org-babel-execute-src-block} function to evaluate the block and insert
13937 its results into the Org mode buffer.
13938 @cindex #+CALL
13940 It is also possible to evaluate named code blocks from anywhere in an Org
13941 mode buffer or an Org mode table.  Live code blocks located in the current
13942 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
13943 can be executed.  Named code blocks can be executed with a separate
13944 @code{#+CALL:} line or inline within a block of text.
13946 The syntax of the @code{#+CALL:} line is
13948 @example
13949 #+CALL: <name>(<arguments>)
13950 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
13951 @end example
13953 The syntax for inline evaluation of named code blocks is
13955 @example
13956 ... call_<name>(<arguments>) ...
13957 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
13958 @end example
13960 @table @code
13961 @item <name>
13962 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
13963 @item <arguments>
13964 Arguments specified in this section will be passed to the code block.  These
13965 arguments use standard function call syntax, rather than
13966 header argument syntax.  For example, a @code{#+CALL:} line that passes the
13967 number four to a code block named @code{double}, which declares the header
13968 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
13969 @item <inside header arguments>
13970 Inside header arguments are passed through and applied to the named code
13971 block.  These arguments use header argument syntax rather than standard
13972 function call syntax.  Inside header arguments affect how the code block is
13973 evaluated.  For example, @code{[:results output]} will collect the results of
13974 everything printed to @code{STDOUT} during execution of the code block.
13975 @item <end header arguments>
13976 End header arguments are applied to the calling instance and do not affect
13977 evaluation of the named code block.  They affect how the results are
13978 incorporated into the Org mode buffer and how the call line is exported.  For
13979 example, @code{:results html} will insert the results of the call line
13980 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
13982 For more examples of passing header arguments to @code{#+CALL:} lines see
13983 @ref{Header arguments in function calls}.
13984 @end table
13986 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
13987 @section Library of Babel
13988 @cindex babel, library of
13989 @cindex source code, library
13990 @cindex code block, library
13992 The ``Library of Babel'' consists of code blocks that can be called from any
13993 Org mode file.  Code blocks defined in the ``Library of Babel'' can be called
13994 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
13995 code blocks} for information on the syntax of remote code block evaluation).
13998 The central repository of code blocks in the ``Library of Babel'' is housed
13999 in an Org mode file located in the @samp{contrib} directory of Org mode.
14001 Users can add code blocks they believe to be generally useful to their
14002 ``Library of Babel.''  The code blocks can be stored in any Org mode file and
14003 then loaded into the library with @code{org-babel-lob-ingest}.
14006 @kindex C-c C-v i
14007 Code blocks located in any Org mode file can be loaded into the ``Library of
14008 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
14011 @node Languages, Header arguments, Library of Babel, Working With Source Code
14012 @section Languages
14013 @cindex babel, languages
14014 @cindex source code, languages
14015 @cindex code block, languages
14017 Code blocks in the following languages are supported.
14019 @multitable @columnfractions 0.28 0.3 0.22 0.2
14020 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
14021 @item Asymptote @tab asymptote @tab Awk @tab awk
14022 @item Emacs Calc @tab calc @tab C @tab C
14023 @item C++ @tab C++ @tab Clojure @tab clojure
14024 @item CSS @tab css @tab ditaa @tab ditaa
14025 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
14026 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
14027 @item Java @tab java @tab @tab
14028 @item Javascript @tab js @tab LaTeX @tab latex
14029 @item Ledger @tab ledger @tab Lisp @tab lisp
14030 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
14031 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
14032 @item Octave @tab octave @tab Org mode @tab org
14033 @item Oz @tab oz @tab Perl @tab perl
14034 @item Plantuml @tab plantuml @tab Python @tab python
14035 @item R @tab R @tab Ruby @tab ruby
14036 @item Sass @tab sass @tab Scheme @tab scheme
14037 @item GNU Screen @tab screen @tab shell @tab sh
14038 @item SQL @tab sql @tab SQLite @tab sqlite
14039 @end multitable
14041 Language-specific documentation is available for some languages.  If
14042 available, it can be found at
14043 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
14045 The option @code{org-babel-load-languages} controls which languages are
14046 enabled for evaluation (by default only @code{emacs-lisp} is enabled).  This
14047 variable can be set using the customization interface or by adding code like
14048 the following to your emacs configuration.
14050 @quotation
14051 The following disables @code{emacs-lisp} evaluation and enables evaluation of
14052 @code{R} code blocks.
14053 @end quotation
14055 @lisp
14056 (org-babel-do-load-languages
14057  'org-babel-load-languages
14058  '((emacs-lisp . nil)
14059    (R . t)))
14060 @end lisp
14062 It is also possible to enable support for a language by loading the related
14063 elisp file with @code{require}.
14065 @quotation
14066 The following adds support for evaluating @code{clojure} code blocks.
14067 @end quotation
14069 @lisp
14070 (require 'ob-clojure)
14071 @end lisp
14073 @node Header arguments, Results of evaluation, Languages, Working With Source Code
14074 @section Header arguments
14075 @cindex code block, header arguments
14076 @cindex source code, block header arguments
14078 Code block functionality can be configured with header arguments.  This
14079 section provides an overview of the use of header arguments, and then
14080 describes each header argument in detail.
14082 @menu
14083 * Using header arguments::      Different ways to set header arguments
14084 * Specific header arguments::   List of header arguments
14085 @end menu
14087 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
14088 @subsection Using header arguments
14090 The values of header arguments can be set in several way.  When the header
14091 arguments in each layer have been determined, they are combined in order from
14092 the first, least specific (having the lowest priority) up to the last, most
14093 specific (having the highest priority).  A header argument with a higher
14094 priority replaces the same header argument specified at lower priority.
14095 @menu
14096 * System-wide header arguments::  Set global default values
14097 * Language-specific header arguments::  Set default values by language
14098 * Header arguments in Org mode properties::  Set default values for a buffer or heading
14099 * Language-specific header arguments in Org mode properties::  Set language-specific default values for a buffer or heading
14100 * Code block specific header arguments::  The most common way to set values
14101 * Header arguments in function calls::  The most specific level
14102 @end menu
14105 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
14106 @subsubheading System-wide header arguments
14107 @vindex org-babel-default-header-args
14108 System-wide values of header arguments can be specified by adapting the
14109 @code{org-babel-default-header-args} variable:
14111 @example
14112 :session    => "none"
14113 :results    => "replace"
14114 :exports    => "code"
14115 :cache      => "no"
14116 :noweb      => "no"
14117 @end example
14119 For example, the following example could be used to set the default value of
14120 @code{:noweb} header arguments to @code{yes}.  This would have the effect of
14121 expanding @code{:noweb} references by default when evaluating source code
14122 blocks.
14124 @lisp
14125 (setq org-babel-default-header-args
14126       (cons '(:noweb . "yes")
14127             (assq-delete-all :noweb org-babel-default-header-args)))
14128 @end lisp
14130 @node Language-specific header arguments, Header arguments in Org mode properties, System-wide header arguments, Using header arguments
14131 @subsubheading Language-specific header arguments
14132 Each language can define its own set of default header arguments in variable
14133 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
14134 of the language.  See the language-specific documentation available online at
14135 @uref{http://orgmode.org/worg/org-contrib/babel}.
14137 @node Header arguments in Org mode properties, Language-specific header arguments in Org mode properties, Language-specific header arguments, Using header arguments
14138 @subsubheading Header arguments in Org mode properties
14140 Buffer-wide header arguments may be specified as properties through the use
14141 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
14142 @ref{Property syntax}).
14144 For example the following would set @code{session} to @code{*R*} (only for R
14145 code blocks), and @code{results} to @code{silent} for every code block in the
14146 buffer, ensuring that all execution took place in the same session, and no
14147 results would be inserted into the buffer.
14149 @example
14150 #+PROPERTY: header-args:R  :session *R*
14151 #+PROPERTY: header-args    :results silent
14152 @end example
14154 Header arguments read from Org mode properties can also be set on a
14155 per-subtree basis using property drawers (see @ref{Property syntax}).
14156 @vindex org-use-property-inheritance
14157 When properties are used to set default header arguments, they are always
14158 looked up with inheritance, regardless of the value of
14159 @code{org-use-property-inheritance}.  Properties are evaluated as seen by the
14160 outermost call or source block.@footnote{The deprecated syntax for default
14161 header argument properties, using the name of the header argument as a
14162 property name directly, evaluates the property as seen by the corresponding
14163 source block definition.  This behavior has been kept for backwards
14164 compatibility.}
14166 In the following example the value of
14167 the @code{:cache} header argument will default to @code{yes} in all code
14168 blocks in the subtree rooted at the following heading:
14170 @example
14171 * outline header
14172   :PROPERTIES:
14173   :header-args:    :cache yes
14174   :END:
14175 @end example
14177 @kindex C-c C-x p
14178 @vindex org-babel-default-header-args
14179 Properties defined in this way override the properties set in
14180 @code{org-babel-default-header-args} and are applied for all activated
14181 languages.  It is convenient to use the @code{org-set-property} function
14182 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
14184 @node Language-specific header arguments in Org mode properties, Code block specific header arguments, Header arguments in Org mode properties, Using header arguments
14185 @subsubheading Language-specific header arguments in Org mode properties
14187 Language-specific header arguments are also read from properties
14188 @code{header-args:<lang>} where @code{<lang>} is the name of the language
14189 targeted.  As an example
14191 @example
14192 * Heading
14193   :PROPERTIES:
14194   :header-args:clojure:    :session *clojure-1*
14195   :header-args:R:          :session *R*
14196   :END:
14197 ** Subheading
14198   :PROPERTIES:
14199   :header-args:clojure:    :session *clojure-2*
14200   :END:
14201 @end example
14203 would independently set a default session header argument for R and clojure
14204 for calls and source blocks under subtree ``Heading'' and change to a
14205 different clojure setting for evaluations under subtree ``Subheading'', while
14206 the R session is inherited from ``Heading'' and therefore unchanged.
14208 @node Code block specific header arguments, Header arguments in function calls, Language-specific header arguments in Org mode properties, Using header arguments
14209 @subsubheading Code block specific header arguments
14211 The most common way to assign values to header arguments is at the
14212 code block level.  This can be done by listing a sequence of header
14213 arguments and their values as part of the @code{#+BEGIN_SRC} line.
14214 Properties set in this way override both the values of
14215 @code{org-babel-default-header-args} and header arguments specified as
14216 properties.  In the following example, the @code{:results} header argument
14217 is set to @code{silent}, meaning the results of execution will not be
14218 inserted in the buffer, and the @code{:exports} header argument is set to
14219 @code{code}, meaning only the body of the code block will be
14220 preserved on export to HTML or @LaTeX{}.
14222 @example
14223 #+NAME: factorial
14224 #+BEGIN_SRC haskell :results silent :exports code :var n=0
14225 fac 0 = 1
14226 fac n = n * fac (n-1)
14227 #+END_SRC
14228 @end example
14229 Similarly, it is possible to set header arguments for inline code blocks
14231 @example
14232 src_haskell[:exports both]@{fac 5@}
14233 @end example
14235 Code block header arguments can span multiple lines using @code{#+HEADER:} or
14236 @code{#+HEADERS:} lines preceding a code block or nested between the
14237 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
14238 @cindex #+HEADER:
14239 @cindex #+HEADERS:
14241 Multi-line header arguments on an un-named code block:
14243 @example
14244  #+HEADERS: :var data1=1
14245  #+BEGIN_SRC emacs-lisp :var data2=2
14246    (message "data1:%S, data2:%S" data1 data2)
14247  #+END_SRC
14249  #+RESULTS:
14250  : data1:1, data2:2
14251 @end example
14253 Multi-line header arguments on a named code block:
14255 @example
14256    #+NAME: named-block
14257    #+HEADER: :var data=2
14258    #+BEGIN_SRC emacs-lisp
14259      (message "data:%S" data)
14260    #+END_SRC
14262    #+RESULTS: named-block
14263    : data:2
14264 @end example
14266 @node Header arguments in function calls,  , Code block specific header arguments, Using header arguments
14267 @comment  node-name,  next,  previous,  up
14268 @subsubheading Header arguments in function calls
14270 At the most specific level, header arguments for ``Library of Babel'' or
14271 @code{#+CALL:} lines can be set as shown in the two examples below.  For more
14272 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
14273 blocks}.
14275 The following will apply the @code{:exports results} header argument to the
14276 evaluation of the @code{#+CALL:} line.
14278 @example
14279 #+CALL: factorial(n=5) :exports results
14280 @end example
14282 The following will apply the @code{:session special} header argument to the
14283 evaluation of the @code{factorial} code block.
14285 @example
14286 #+CALL: factorial[:session special](n=5)
14287 @end example
14289 @node Specific header arguments,  , Using header arguments, Header arguments
14290 @subsection Specific header arguments
14291 Header arguments consist of an initial colon followed by the name of the
14292 argument in lowercase letters.  The following header arguments are defined:
14294 @menu
14295 * var::                         Pass arguments to code blocks
14296 * results::                     Specify the type of results and how they will
14297                                 be collected and handled
14298 * file::                        Specify a path for file output
14299 * file-desc::                   Specify a description for file results
14300 * dir::                         Specify the default (possibly remote)
14301                                 directory for code block execution
14302 * exports::                     Export code and/or results
14303 * tangle::                      Toggle tangling and specify file name
14304 * mkdirp::                      Toggle creation of parent directories of target
14305                                 files during tangling
14306 * comments::                    Toggle insertion of comments in tangled
14307                                 code files
14308 * padline::                     Control insertion of padding lines in tangled
14309                                 code files
14310 * no-expand::                   Turn off variable assignment and noweb
14311                                 expansion during tangling
14312 * session::                     Preserve the state of code evaluation
14313 * noweb::                       Toggle expansion of noweb references
14314 * noweb-ref::                   Specify block's noweb reference resolution target
14315 * noweb-sep::                   String used to separate noweb references
14316 * cache::                       Avoid re-evaluating unchanged code blocks
14317 * sep::                         Delimiter for writing tabular results outside Org
14318 * hlines::                      Handle horizontal lines in tables
14319 * colnames::                    Handle column names in tables
14320 * rownames::                    Handle row names in tables
14321 * shebang::                     Make tangled files executable
14322 * tangle-mode::                 Set permission of tangled files
14323 * eval::                        Limit evaluation of specific code blocks
14324 * wrap::                        Mark source block evaluation results
14325 * post::                        Post processing of code block results
14326 * prologue::                    Text to prepend to code block body
14327 * epilogue::                    Text to append to code block body
14328 @end menu
14330 Additional header arguments are defined on a language-specific basis, see
14331 @ref{Languages}.
14333 @node var, results, Specific header arguments, Specific header arguments
14334 @subsubsection @code{:var}
14335 The @code{:var} header argument is used to pass arguments to code blocks.
14336 The specifics of how arguments are included in a code block vary by language;
14337 these are addressed in the language-specific documentation.  However, the
14338 syntax used to specify arguments is the same across all languages.  In every
14339 case, variables require a default value when they are declared.
14341 The values passed to arguments can either be literal values, references, or
14342 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
14343 References include anything in the Org mode file that takes a @code{#+NAME:}
14344 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
14345 other code blocks and the results of other code blocks.
14347 Note: When a reference is made to another code block, the referenced block
14348 will be evaluated unless it has current cached results (see @ref{cache}).
14350 Argument values can be indexed in a manner similar to arrays (see @ref{var,
14351 Indexable variable values}).
14353 The following syntax is used to pass arguments to code blocks using the
14354 @code{:var} header argument.
14356 @example
14357 :var name=assign
14358 @end example
14360 The argument, @code{assign}, can either be a literal value, such as a string
14361 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
14362 literal example, another code block (with or without arguments), or the
14363 results of evaluating another code block.
14365 Here are examples of passing values by reference:
14367 @table @dfn
14369 @item table
14370 an Org mode table named with either a @code{#+NAME:} line
14372 @example
14373 #+NAME: example-table
14374 | 1 |
14375 | 2 |
14376 | 3 |
14377 | 4 |
14379 #+NAME: table-length
14380 #+BEGIN_SRC emacs-lisp :var table=example-table
14381 (length table)
14382 #+END_SRC
14384 #+RESULTS: table-length
14385 : 4
14386 @end example
14388 @item list
14389 a simple list named with a @code{#+NAME:} line (note that nesting is not
14390 carried through to the source code block)
14392 @example
14393 #+NAME: example-list
14394   - simple
14395     - not
14396     - nested
14397   - list
14399 #+BEGIN_SRC emacs-lisp :var x=example-list
14400   (print x)
14401 #+END_SRC
14403 #+RESULTS:
14404 | simple | list |
14405 @end example
14407 @item code block without arguments
14408 a code block name (from the example above), as assigned by @code{#+NAME:},
14409 optionally followed by parentheses
14411 @example
14412 #+BEGIN_SRC emacs-lisp :var length=table-length()
14413 (* 2 length)
14414 #+END_SRC
14416 #+RESULTS:
14417 : 8
14418 @end example
14420 @item code block with arguments
14421 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
14422 optional arguments passed within the parentheses following the
14423 code block name using standard function call syntax
14425 @example
14426 #+NAME: double
14427 #+BEGIN_SRC emacs-lisp :var input=8
14428 (* 2 input)
14429 #+END_SRC
14431 #+RESULTS: double
14432 : 16
14434 #+NAME: squared
14435 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
14436 (* input input)
14437 #+END_SRC
14439 #+RESULTS: squared
14440 : 4
14441 @end example
14443 @item literal example
14444 a literal example block named with a @code{#+NAME:} line
14446 @example
14447 #+NAME: literal-example
14448 #+BEGIN_EXAMPLE
14449 A literal example
14450 on two lines
14451 #+END_EXAMPLE
14453 #+NAME: read-literal-example
14454 #+BEGIN_SRC emacs-lisp :var x=literal-example
14455   (concatenate 'string x " for you.")
14456 #+END_SRC
14458 #+RESULTS: read-literal-example
14459 : A literal example
14460 : on two lines for you.
14462 @end example
14464 @end table
14466 @subsubheading Indexable variable values
14467 It is possible to reference portions of variable values by ``indexing'' into
14468 the variables.  Indexes are 0 based with negative values counting back from
14469 the end.  If an index is separated by @code{,}s then each subsequent section
14470 will index into the next deepest nesting or dimension of the value.  Note
14471 that this indexing occurs @emph{before} other table related header arguments
14472 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied.  The
14473 following example assigns the last cell of the first row the table
14474 @code{example-table} to the variable @code{data}:
14476 @example
14477 #+NAME: example-table
14478 | 1 | a |
14479 | 2 | b |
14480 | 3 | c |
14481 | 4 | d |
14483 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
14484   data
14485 #+END_SRC
14487 #+RESULTS:
14488 : a
14489 @end example
14491 Ranges of variable values can be referenced using two integers separated by a
14492 @code{:}, in which case the entire inclusive range is referenced.  For
14493 example the following assigns the middle three rows of @code{example-table}
14494 to @code{data}.
14496 @example
14497 #+NAME: example-table
14498 | 1 | a |
14499 | 2 | b |
14500 | 3 | c |
14501 | 4 | d |
14502 | 5 | 3 |
14504 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
14505   data
14506 #+END_SRC
14508 #+RESULTS:
14509 | 2 | b |
14510 | 3 | c |
14511 | 4 | d |
14512 @end example
14514 Additionally, an empty index, or the single character @code{*}, are both
14515 interpreted to mean the entire range and as such are equivalent to
14516 @code{0:-1}, as shown in the following example in which the entire first
14517 column is referenced.
14519 @example
14520 #+NAME: example-table
14521 | 1 | a |
14522 | 2 | b |
14523 | 3 | c |
14524 | 4 | d |
14526 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
14527   data
14528 #+END_SRC
14530 #+RESULTS:
14531 | 1 | 2 | 3 | 4 |
14532 @end example
14534 It is possible to index into the results of code blocks as well as tables.
14535 Any number of dimensions can be indexed.  Dimensions are separated from one
14536 another by commas, as shown in the following example.
14538 @example
14539 #+NAME: 3D
14540 #+BEGIN_SRC emacs-lisp
14541   '(((1  2  3)  (4  5  6)  (7  8  9))
14542     ((10 11 12) (13 14 15) (16 17 18))
14543     ((19 20 21) (22 23 24) (25 26 27)))
14544 #+END_SRC
14546 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
14547   data
14548 #+END_SRC
14550 #+RESULTS:
14551 | 11 | 14 | 17 |
14552 @end example
14554 @subsubheading Emacs Lisp evaluation of variables
14556 Emacs lisp code can be used to initialize variable values.  When a variable
14557 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
14558 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
14559 the variable value.  The following example demonstrates use of this
14560 evaluation to reliably pass the file-name of the Org mode buffer to a code
14561 block---note that evaluation of header arguments is guaranteed to take place
14562 in the original Org mode file, while there is no such guarantee for
14563 evaluation of the code block body.
14565 @example
14566 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
14567   wc -w $filename
14568 #+END_SRC
14569 @end example
14571 Note that values read from tables and lists will not be evaluated as
14572 Emacs Lisp, as shown in the following example.
14574 @example
14575 #+NAME: table
14576 | (a b c) |
14578 #+HEADERS: :var data=table[0,0]
14579 #+BEGIN_SRC perl
14580   $data
14581 #+END_SRC
14583 #+RESULTS:
14584 : (a b c)
14585 @end example
14587 @node results, file, var, Specific header arguments
14588 @subsubsection @code{:results}
14590 There are four classes of @code{:results} header argument.  Only one option
14591 per class may be supplied per code block.
14593 @itemize @bullet
14594 @item
14595 @b{collection} header arguments specify how the results should be collected
14596 from the code block
14597 @item
14598 @b{type} header arguments specify what type of result the code block will
14599 return---which has implications for how they will be processed before
14600 insertion into the Org mode buffer
14601 @item
14602 @b{format} header arguments specify what type of result the code block will
14603 return---which has implications for how they will be inserted into the
14604 Org mode buffer
14605 @item
14606 @b{handling} header arguments specify how the results of evaluating the code
14607 block should be handled.
14608 @end itemize
14610 @subsubheading Collection
14611 The following options are mutually exclusive, and specify how the results
14612 should be collected from the code block.
14614 @itemize @bullet
14615 @item @code{value}
14616 This is the default.  The result is the value of the last statement in the
14617 code block.  This header argument places the evaluation in functional
14618 mode.  Note that in some languages, e.g., Python, use of this result type
14619 requires that a @code{return} statement be included in the body of the source
14620 code block.  E.g., @code{:results value}.
14621 @item @code{output}
14622 The result is the collection of everything printed to STDOUT during the
14623 execution of the code block.  This header argument places the
14624 evaluation in scripting mode.  E.g., @code{:results output}.
14625 @end itemize
14627 @subsubheading Type
14629 The following options are mutually exclusive and specify what type of results
14630 the code block will return.  By default, results are inserted as either a
14631 table or scalar depending on their value.
14633 @itemize @bullet
14634 @item @code{table}, @code{vector}
14635 The results should be interpreted as an Org mode table.  If a single value is
14636 returned, it will be converted into a table with one row and one column.
14637 E.g., @code{:results value table}.
14638 @item @code{list}
14639 The results should be interpreted as an Org mode list.  If a single scalar
14640 value is returned it will be converted into a list with only one element.
14641 @item @code{scalar}, @code{verbatim}
14642 The results should be interpreted literally---they will not be
14643 converted into a table.  The results will be inserted into the Org mode
14644 buffer as quoted text.  E.g., @code{:results value verbatim}.
14645 @item @code{file}
14646 The results will be interpreted as the path to a file, and will be inserted
14647 into the Org mode buffer as a file link.  E.g., @code{:results value file}.
14648 @end itemize
14650 @subsubheading Format
14652 The following options are mutually exclusive and specify what type of results
14653 the code block will return.  By default, results are inserted according to the
14654 type as specified above.
14656 @itemize @bullet
14657 @item @code{raw}
14658 The results are interpreted as raw Org mode code and are inserted directly
14659 into the buffer.  If the results look like a table they will be aligned as
14660 such by Org mode.  E.g., @code{:results value raw}.
14661 @item @code{org}
14662 The results are will be enclosed in a @code{BEGIN_SRC org} block.
14663 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
14664 in the block and/or if you export the file.  E.g., @code{:results value org}.
14665 @item @code{html}
14666 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
14667 block.  E.g., @code{:results value html}.
14668 @item @code{latex}
14669 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
14670 E.g., @code{:results value latex}.
14671 @item @code{code}
14672 Result are assumed to be parsable code and are enclosed in a code block.
14673 E.g., @code{:results value code}.
14674 @item @code{pp}
14675 The result is converted to pretty-printed code and is enclosed in a code
14676 block.  This option currently supports Emacs Lisp, Python, and Ruby.  E.g.,
14677 @code{:results value pp}.
14678 @item @code{drawer}
14679 The result is wrapped in a RESULTS drawer.  This can be useful for
14680 inserting @code{raw} or @code{org} syntax results in such a way that their
14681 extent is known and they can be automatically removed or replaced.
14682 @end itemize
14684 @subsubheading Handling
14685 The following results options indicate what happens with the
14686 results once they are collected.
14688 @itemize @bullet
14689 @item @code{silent}
14690 The results will be echoed in the minibuffer but will not be inserted into
14691 the Org mode buffer.  E.g., @code{:results output silent}.
14692 @item @code{replace}
14693 The default value.  Any existing results will be removed, and the new results
14694 will be inserted into the Org mode buffer in their place.  E.g.,
14695 @code{:results output replace}.
14696 @item @code{append}
14697 If there are pre-existing results of the code block then the new results will
14698 be appended to the existing results.  Otherwise the new results will be
14699 inserted as with @code{replace}.
14700 @item @code{prepend}
14701 If there are pre-existing results of the code block then the new results will
14702 be prepended to the existing results.  Otherwise the new results will be
14703 inserted as with @code{replace}.
14704 @end itemize
14706 @node file, file-desc, results, Specific header arguments
14707 @subsubsection @code{:file}
14709 The header argument @code{:file} is used to specify an external file in which
14710 to save code block results.  After code block evaluation an Org mode style
14711 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
14712 into the Org mode buffer.  Some languages including R, gnuplot, dot, and
14713 ditaa provide special handling of the @code{:file} header argument
14714 automatically wrapping the code block body in the boilerplate code required
14715 to save output to the specified file.  This is often useful for saving
14716 graphical output of a code block to the specified file.
14718 The argument to @code{:file} should be either a string specifying the path to
14719 a file, or a list of two strings in which case the first element of the list
14720 should be the path to a file and the second a description for the link.
14722 @node file-desc, dir, file, Specific header arguments
14723 @subsubsection @code{:file-desc}
14725 The value of the @code{:file-desc} header argument is used to provide a
14726 description for file code block results which are inserted as Org mode links
14727 (see @ref{Link format}).  If the @code{:file-desc} header argument is given
14728 with no value the link path will be placed in both the ``link'' and the
14729 ``description'' portion of the Org mode link.
14731 @node dir, exports, file-desc, Specific header arguments
14732 @subsubsection @code{:dir} and remote execution
14734 While the @code{:file} header argument can be used to specify the path to the
14735 output file, @code{:dir} specifies the default directory during code block
14736 execution.  If it is absent, then the directory associated with the current
14737 buffer is used.  In other words, supplying @code{:dir path} temporarily has
14738 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
14739 then not supplying @code{:dir}.  Under the surface, @code{:dir} simply sets
14740 the value of the Emacs variable @code{default-directory}.
14742 When using @code{:dir}, you should supply a relative path for file output
14743 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
14744 case that path will be interpreted relative to the default directory.
14746 In other words, if you want your plot to go into a folder called @file{Work}
14747 in your home directory, you could use
14749 @example
14750 #+BEGIN_SRC R :file myplot.png :dir ~/Work
14751 matplot(matrix(rnorm(100), 10), type="l")
14752 #+END_SRC
14753 @end example
14755 @subsubheading Remote execution
14756 A directory on a remote machine can be specified using tramp file syntax, in
14757 which case the code will be evaluated on the remote machine.  An example is
14759 @example
14760 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
14761 plot(1:10, main=system("hostname", intern=TRUE))
14762 #+END_SRC
14763 @end example
14765 Text results will be returned to the local Org mode buffer as usual, and file
14766 output will be created on the remote machine with relative paths interpreted
14767 relative to the remote directory.  An Org mode link to the remote file will be
14768 created.
14770 So, in the above example a plot will be created on the remote machine,
14771 and a link of the following form will be inserted in the org buffer:
14773 @example
14774 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
14775 @end example
14777 Most of this functionality follows immediately from the fact that @code{:dir}
14778 sets the value of the Emacs variable @code{default-directory}, thanks to
14779 tramp.  Those using XEmacs, or GNU Emacs prior to version 23 may need to
14780 install tramp separately in order for these features to work correctly.
14782 @subsubheading Further points
14784 @itemize @bullet
14785 @item
14786 If @code{:dir} is used in conjunction with @code{:session}, although it will
14787 determine the starting directory for a new session as expected, no attempt is
14788 currently made to alter the directory associated with an existing session.
14789 @item
14790 @code{:dir} should typically not be used to create files during export with
14791 @code{:exports results} or @code{:exports both}.  The reason is that, in order
14792 to retain portability of exported material between machines, during export
14793 links inserted into the buffer will @emph{not} be expanded against @code{default
14794 directory}.  Therefore, if @code{default-directory} is altered using
14795 @code{:dir}, it is probable that the file will be created in a location to
14796 which the link does not point.
14797 @end itemize
14799 @node exports, tangle, dir, Specific header arguments
14800 @subsubsection @code{:exports}
14802 The @code{:exports} header argument specifies what should be included in HTML
14803 or @LaTeX{} exports of the Org mode file.
14805 @itemize @bullet
14806 @item @code{code}
14807 The default.  The body of code is included into the exported file.  E.g.,
14808 @code{:exports code}.
14809 @item @code{results}
14810 The result of evaluating the code is included in the exported file.  E.g.,
14811 @code{:exports results}.
14812 @item @code{both}
14813 Both the code and results are included in the exported file.  E.g.,
14814 @code{:exports both}.
14815 @item @code{none}
14816 Nothing is included in the exported file.  E.g., @code{:exports none}.
14817 @end itemize
14819 @node tangle, mkdirp, exports, Specific header arguments
14820 @subsubsection @code{:tangle}
14822 The @code{:tangle} header argument specifies whether or not the code
14823 block should be included in tangled extraction of source code files.
14825 @itemize @bullet
14826 @item @code{tangle}
14827 The code block is exported to a source code file named after the full path
14828 (including the directory) and file name (w/o extension) of the Org mode file.
14829 E.g., @code{:tangle yes}.
14830 @item @code{no}
14831 The default.  The code block is not exported to a source code file.
14832 E.g., @code{:tangle no}.
14833 @item other
14834 Any other string passed to the @code{:tangle} header argument is interpreted
14835 as a path (directory and file name relative to the directory of the Org mode
14836 file) to which the block will be exported.  E.g., @code{:tangle path}.
14837 @end itemize
14839 @node mkdirp, comments, tangle, Specific header arguments
14840 @subsubsection @code{:mkdirp}
14842 The @code{:mkdirp} header argument can be used to create parent directories
14843 of tangled files when missing.  This can be set to @code{yes} to enable
14844 directory creation or to @code{no} to inhibit directory creation.
14846 @node comments, padline, mkdirp, Specific header arguments
14847 @subsubsection @code{:comments}
14848 By default code blocks are tangled to source-code files without any insertion
14849 of comments beyond those which may already exist in the body of the code
14850 block.  The @code{:comments} header argument can be set as follows to control
14851 the insertion of extra comments into the tangled code file.
14853 @itemize @bullet
14854 @item @code{no}
14855 The default.  No extra comments are inserted during tangling.
14856 @item @code{link}
14857 The code block is wrapped in comments which contain pointers back to the
14858 original Org file from which the code was tangled.
14859 @item @code{yes}
14860 A synonym for ``link'' to maintain backwards compatibility.
14861 @item @code{org}
14862 Include text from the Org mode file as a comment.
14863 The text is picked from the leading context of the tangled code and is
14864 limited by the nearest headline or source block as the case may be.
14865 @item @code{both}
14866 Turns on both the ``link'' and ``org'' comment options.
14867 @item @code{noweb}
14868 Turns on the ``link'' comment option, and additionally wraps expanded noweb
14869 references in the code block body in link comments.
14870 @end itemize
14872 @node padline, no-expand, comments, Specific header arguments
14873 @subsubsection @code{:padline}
14874 Control in insertion of padding lines around code block bodies in tangled
14875 code files.  The default value is @code{yes} which results in insertion of
14876 newlines before and after each tangled code block.  The following arguments
14877 are accepted.
14879 @itemize @bullet
14880 @item @code{yes}
14881 Insert newlines before and after each code block body in tangled code files.
14882 @item @code{no}
14883 Do not insert any newline padding in tangled output.
14884 @end itemize
14886 @node no-expand, session, padline, Specific header arguments
14887 @subsubsection @code{:no-expand}
14889 By default, code blocks are expanded with @code{org-babel-expand-src-block}
14890 during tangling.  This has the effect of assigning values to variables
14891 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
14892 references (see @ref{Noweb reference syntax}) with their targets.  The
14893 @code{:no-expand} header argument can be used to turn off this behavior.
14895 @node session, noweb, no-expand, Specific header arguments
14896 @subsubsection @code{:session}
14898 The @code{:session} header argument starts a session for an interpreted
14899 language where state is preserved.
14901 By default, a session is not started.
14903 A string passed to the @code{:session} header argument will give the session
14904 a name.  This makes it possible to run concurrent sessions for each
14905 interpreted language.
14907 @node noweb, noweb-ref, session, Specific header arguments
14908 @subsubsection @code{:noweb}
14910 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
14911 references (see @ref{Noweb reference syntax}) when the code block is
14912 evaluated, tangled, or exported.  The @code{:noweb} header argument can have
14913 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
14914 @code{no-export} @code{strip-export}.
14916 @itemize @bullet
14917 @item @code{no}
14918 The default.  ``Noweb'' syntax references in the body of the code block will
14919 not be expanded before the code block is evaluated, tangled or exported.
14920 @item @code{yes}
14921 ``Noweb'' syntax references in the body of the code block will be
14922 expanded before the code block is evaluated, tangled or exported.
14923 @item @code{tangle}
14924 ``Noweb'' syntax references in the body of the code block will be expanded
14925 before the code block is tangled.  However, ``noweb'' syntax references will
14926 not be expanded when the code block is evaluated or exported.
14927 @item @code{no-export}
14928 ``Noweb'' syntax references in the body of the code block will be expanded
14929 before the block is evaluated or tangled.  However, ``noweb'' syntax
14930 references will not be expanded when the code block is exported.
14931 @item @code{strip-export}
14932 ``Noweb'' syntax references in the body of the code block will be expanded
14933 before the block is evaluated or tangled.  However, ``noweb'' syntax
14934 references will be removed when the code block is exported.
14935 @item @code{eval}
14936 ``Noweb'' syntax references in the body of the code block will only be
14937 expanded before the block is evaluated.
14938 @end itemize
14940 @subsubheading Noweb prefix lines
14941 Noweb insertions are now placed behind the line prefix of the
14942 @code{<<reference>>}.
14943 This behavior is illustrated in the following example.  Because the
14944 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
14945 each line of the expanded noweb reference will be commented.
14947 This code block:
14949 @example
14950 -- <<example>>
14951 @end example
14953 expands to:
14955 @example
14956 -- this is the
14957 -- multi-line body of example
14958 @end example
14960 Note that noweb replacement text that does not contain any newlines will not
14961 be affected by this change, so it is still possible to use inline noweb
14962 references.
14964 @node noweb-ref, noweb-sep, noweb, Specific header arguments
14965 @subsubsection @code{:noweb-ref}
14966 When expanding ``noweb'' style references the bodies of all code block with
14967 @emph{either} a block name matching the reference name @emph{or} a
14968 @code{:noweb-ref} header argument matching the reference name will be
14969 concatenated together to form the replacement text.
14971 By setting this header argument at the sub-tree or file level, simple code
14972 block concatenation may be achieved.  For example, when tangling the
14973 following Org mode file, the bodies of code blocks will be concatenated into
14974 the resulting pure code file@footnote{(The example needs property inheritance
14975 to be turned on for the @code{noweb-ref} property, see @ref{Property
14976 inheritance}).}.
14978 @example
14979  #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
14980    <<fullest-disk>>
14981  #+END_SRC
14982  * the mount point of the fullest disk
14983    :PROPERTIES:
14984    :noweb-ref: fullest-disk
14985    :END:
14987  ** query all mounted disks
14988  #+BEGIN_SRC sh
14989    df \
14990  #+END_SRC
14992  ** strip the header row
14993  #+BEGIN_SRC sh
14994    |sed '1d' \
14995  #+END_SRC
14997  ** sort by the percent full
14998  #+BEGIN_SRC sh
14999    |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
15000  #+END_SRC
15002  ** extract the mount point
15003  #+BEGIN_SRC sh
15004    |awk '@{print $2@}'
15005  #+END_SRC
15006 @end example
15008 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
15009 used to separate accumulate noweb references like those above.  By default a
15010 newline is used.
15012 @node noweb-sep, cache, noweb-ref, Specific header arguments
15013 @subsubsection @code{:noweb-sep}
15015 The @code{:noweb-sep} header argument holds the string used to separate
15016 accumulate noweb references (see @ref{noweb-ref}).  By default a newline is
15017 used.
15019 @node cache, sep, noweb-sep, Specific header arguments
15020 @subsubsection @code{:cache}
15022 The @code{:cache} header argument controls the use of in-buffer caching of
15023 the results of evaluating code blocks.  It can be used to avoid re-evaluating
15024 unchanged code blocks.  Note that the @code{:cache} header argument will not
15025 attempt to cache results when the @code{:session} header argument is used,
15026 because the results of the code block execution may be stored in the session
15027 outside of the Org mode buffer.  The @code{:cache} header argument can have
15028 one of two values: @code{yes} or @code{no}.
15030 @itemize @bullet
15031 @item @code{no}
15032 The default.  No caching takes place, and the code block will be evaluated
15033 every time it is called.
15034 @item @code{yes}
15035 Every time the code block is run a SHA1 hash of the code and arguments
15036 passed to the block will be generated.  This hash is packed into the
15037 @code{#+RESULTS:} line and will be checked on subsequent
15038 executions of the code block.  If the code block has not
15039 changed since the last time it was evaluated, it will not be re-evaluated.
15040 @end itemize
15042 Code block caches notice if the value of a variable argument
15043 to the code block has changed.  If this is the case, the cache is
15044 invalidated and the code block is re-run.  In the following example,
15045 @code{caller} will not be re-run unless the results of @code{random} have
15046 changed since it was last run.
15048 @example
15049  #+NAME: random
15050  #+BEGIN_SRC R :cache yes
15051  runif(1)
15052  #+END_SRC
15054  #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
15055  0.4659510825295
15057  #+NAME: caller
15058  #+BEGIN_SRC emacs-lisp :var x=random :cache yes
15060  #+END_SRC
15062  #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
15063  0.254227238707244
15064 @end example
15066 @node sep, hlines, cache, Specific header arguments
15067 @subsubsection @code{:sep}
15069 The @code{:sep} header argument can be used to control the delimiter used
15070 when writing tabular results out to files external to Org mode.  This is used
15071 either when opening tabular results of a code block by calling the
15072 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
15073 or when writing code block results to an external file (see @ref{file})
15074 header argument.
15076 By default, when @code{:sep} is not specified output tables are tab
15077 delimited.
15079 @node hlines, colnames, sep, Specific header arguments
15080 @subsubsection @code{:hlines}
15082 Tables are frequently represented with one or more horizontal lines, or
15083 hlines.  The @code{:hlines} argument to a code block accepts the
15084 values @code{yes} or @code{no}, with a default value of @code{no}.
15086 @itemize @bullet
15087 @item @code{no}
15088 Strips horizontal lines from the input table.  In most languages this is the
15089 desired effect because an @code{hline} symbol is interpreted as an unbound
15090 variable and raises an error.  Setting @code{:hlines no} or relying on the
15091 default value yields the following results.
15093 @example
15094 #+NAME: many-cols
15095 | a | b | c |
15096 |---+---+---|
15097 | d | e | f |
15098 |---+---+---|
15099 | g | h | i |
15101 #+NAME: echo-table
15102 #+BEGIN_SRC python :var tab=many-cols
15103   return tab
15104 #+END_SRC
15106 #+RESULTS: echo-table
15107 | a | b | c |
15108 | d | e | f |
15109 | g | h | i |
15110 @end example
15112 @item @code{yes}
15113 Leaves hlines in the table.  Setting @code{:hlines yes} has this effect.
15115 @example
15116 #+NAME: many-cols
15117 | a | b | c |
15118 |---+---+---|
15119 | d | e | f |
15120 |---+---+---|
15121 | g | h | i |
15123 #+NAME: echo-table
15124 #+BEGIN_SRC python :var tab=many-cols :hlines yes
15125   return tab
15126 #+END_SRC
15128 #+RESULTS: echo-table
15129 | a | b | c |
15130 |---+---+---|
15131 | d | e | f |
15132 |---+---+---|
15133 | g | h | i |
15134 @end example
15135 @end itemize
15137 @node colnames, rownames, hlines, Specific header arguments
15138 @subsubsection @code{:colnames}
15140 The @code{:colnames} header argument accepts the values @code{yes},
15141 @code{no}, or @code{nil} for unassigned.  The default value is @code{nil}.
15142 Note that the behavior of the @code{:colnames} header argument may differ
15143 across languages.
15145 @itemize @bullet
15146 @item @code{nil}
15147 If an input table looks like it has column names
15148 (because its second row is an hline), then the column
15149 names will be removed from the table before
15150 processing, then reapplied to the results.
15152 @example
15153 #+NAME: less-cols
15154 | a |
15155 |---|
15156 | b |
15157 | c |
15159 #+NAME: echo-table-again
15160 #+BEGIN_SRC python :var tab=less-cols
15161   return [[val + '*' for val in row] for row in tab]
15162 #+END_SRC
15164 #+RESULTS: echo-table-again
15165 | a  |
15166 |----|
15167 | b* |
15168 | c* |
15169 @end example
15171 Please note that column names are not removed before the table is indexed
15172 using variable indexing @xref{var, Indexable variable values}.
15174 @item @code{no}
15175 No column name pre-processing takes place
15177 @item @code{yes}
15178 Column names are removed and reapplied as with @code{nil} even if the table
15179 does not ``look like'' it has column names (i.e., the second row is not an
15180 hline)
15181 @end itemize
15183 @node rownames, shebang, colnames, Specific header arguments
15184 @subsubsection @code{:rownames}
15186 The @code{:rownames} header argument can take on the values @code{yes} or
15187 @code{no}, with a default value of @code{no}.  Note that Emacs Lisp code
15188 blocks ignore the @code{:rownames} header argument entirely given the ease
15189 with which tables with row names may be handled directly in Emacs Lisp.
15191 @itemize @bullet
15192 @item @code{no}
15193 No row name pre-processing will take place.
15195 @item @code{yes}
15196 The first column of the table is removed from the table before processing,
15197 and is then reapplied to the results.
15199 @example
15200 #+NAME: with-rownames
15201 | one | 1 | 2 | 3 | 4 |  5 |
15202 | two | 6 | 7 | 8 | 9 | 10 |
15204 #+NAME: echo-table-once-again
15205 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
15206   return [[val + 10 for val in row] for row in tab]
15207 #+END_SRC
15209 #+RESULTS: echo-table-once-again
15210 | one | 11 | 12 | 13 | 14 | 15 |
15211 | two | 16 | 17 | 18 | 19 | 20 |
15212 @end example
15214 Please note that row names are not removed before the table is indexed using
15215 variable indexing @xref{var, Indexable variable values}.
15217 @end itemize
15219 @node shebang, tangle-mode, rownames, Specific header arguments
15220 @subsubsection @code{:shebang}
15222 Setting the @code{:shebang} header argument to a string value
15223 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
15224 first line of any tangled file holding the code block, and the file
15225 permissions of the tangled file are set to make it executable.
15228 @node tangle-mode, eval, shebang, Specific header arguments
15229 @subsubsection @code{:tangle-mode}
15231 The @code{tangle-mode} header argument controls the permission set on tangled
15232 files.  The value of this header argument will be passed to
15233 @code{set-file-modes}.  For example, to set a tangled file as read only use
15234 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
15235 use @code{:tangle-mode (identity #o755)}.  Blocks with @code{shebang}
15236 (@ref{shebang}) header arguments will automatically be made executable unless
15237 the @code{tangle-mode} header argument is also used.  The behavior is
15238 undefined if multiple code blocks with different values for the
15239 @code{tangle-mode} header argument are tangled to the same file.
15241 @node eval, wrap, tangle-mode, Specific header arguments
15242 @subsubsection @code{:eval}
15243 The @code{:eval} header argument can be used to limit the evaluation of
15244 specific code blocks.  The @code{:eval} header argument can be useful for
15245 protecting against the evaluation of dangerous code blocks or to ensure that
15246 evaluation will require a query regardless of the value of the
15247 @code{org-confirm-babel-evaluate} variable.  The possible values of
15248 @code{:eval} and their effects are shown below.
15250 @table @code
15251 @item never or no
15252 The code block will not be evaluated under any circumstances.
15253 @item query
15254 Evaluation of the code block will require a query.
15255 @item never-export or no-export
15256 The code block will not be evaluated during export but may still be called
15257 interactively.
15258 @item query-export
15259 Evaluation of the code block during export will require a query.
15260 @end table
15262 If this header argument is not set then evaluation is determined by the value
15263 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
15264 security}.
15266 @node wrap, post, eval, Specific header arguments
15267 @subsubsection @code{:wrap}
15268 The @code{:wrap} header argument is used to mark the results of source block
15269 evaluation.  The header argument can be passed a string that will be appended
15270 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
15271 results.  If not string is specified then the results will be wrapped in a
15272 @code{#+BEGIN/END_RESULTS} block.
15274 @node post, prologue, wrap, Specific header arguments
15275 @subsubsection @code{:post}
15276 The @code{:post} header argument is used to post-process the results of a
15277 code block execution.  When a post argument is given, the results of the code
15278 block will temporarily be bound to the @code{*this*} variable.  This variable
15279 may then be included in header argument forms such as those used in @ref{var}
15280 header argument specifications allowing passing of results to other code
15281 blocks, or direct execution via Emacs Lisp.
15283 The following example illustrates the usage of the @code{:post} header
15284 argument.
15286 @example
15287 #+name: attr_wrap
15288 #+begin_src sh :var data="" :var width="\\textwidth" :results output
15289   echo "#+ATTR_LATEX :width $width"
15290   echo "$data"
15291 #+end_src
15293 #+header: :file /tmp/it.png
15294 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
15295   digraph@{
15296           a -> b;
15297           b -> c;
15298           c -> a;
15299   @}
15300 #+end_src
15302 #+RESULTS:
15303 :RESULTS:
15304 #+ATTR_LATEX :width 5cm
15305 [[file:/tmp/it.png]]
15306 :END:
15307 @end example
15309 @node prologue, epilogue, post, Specific header arguments
15310 @subsubsection @code{:prologue}
15311 The value of the @code{prologue} header argument will be prepended to the
15312 code block body before execution.  For example, @code{:prologue "reset"} may
15313 be used to reset a gnuplot session before execution of a particular code
15314 block, or the following configuration may be used to do this for all gnuplot
15315 code blocks.  Also see @ref{epilogue}.
15317 @lisp
15318 (add-to-list 'org-babel-default-header-args:gnuplot
15319              '((:prologue . "reset")))
15320 @end lisp
15322 @node epilogue, , prologue, Specific header arguments
15323 @subsubsection @code{:epilogue}
15324 The value of the @code{epilogue} header argument will be appended to the code
15325 block body before execution.  Also see @ref{prologue}.
15327 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
15328 @section Results of evaluation
15329 @cindex code block, results of evaluation
15330 @cindex source code, results of evaluation
15332 The way in which results are handled depends on whether a session is invoked,
15333 as well as on whether @code{:results value} or @code{:results output} is
15334 used.  The following table shows the table possibilities.  For a full listing
15335 of the possible results header arguments see @ref{results}.
15337 @multitable @columnfractions 0.26 0.33 0.41
15338 @item @tab @b{Non-session} @tab @b{Session}
15339 @item @code{:results value} @tab value of last expression @tab value of last expression
15340 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
15341 @end multitable
15343 Note: With @code{:results value}, the result in both @code{:session} and
15344 non-session is returned to Org mode as a table (a one- or two-dimensional
15345 vector of strings or numbers) when appropriate.
15347 @subsection Non-session
15348 @subsubsection @code{:results value}
15349 This is the default.  Internally, the value is obtained by wrapping the code
15350 in a function definition in the external language, and evaluating that
15351 function.  Therefore, code should be written as if it were the body of such a
15352 function.  In particular, note that Python does not automatically return a
15353 value from a function unless a @code{return} statement is present, and so a
15354 @samp{return} statement will usually be required in Python.
15356 This is the only one of the four evaluation contexts in which the code is
15357 automatically wrapped in a function definition.
15359 @subsubsection @code{:results output}
15360 The code is passed to the interpreter as an external process, and the
15361 contents of the standard output stream are returned as text.  (In certain
15362 languages this also contains the error output stream; this is an area for
15363 future work.)
15365 @subsection Session
15366 @subsubsection @code{:results value}
15367 The code is passed to an interpreter running as an interactive Emacs inferior
15368 process.  Only languages which provide tools for interactive evaluation of
15369 code have session support, so some language (e.g., C and ditaa) do not
15370 support the @code{:session} header argument, and in other languages (e.g.,
15371 Python and Haskell) which have limitations on the code which may be entered
15372 into interactive sessions, those limitations apply to the code in code blocks
15373 using the @code{:session} header argument as well.
15375 Unless the @code{:results output} option is supplied (see below) the result
15376 returned is the result of the last evaluation performed by the
15377 interpreter.  (This is obtained in a language-specific manner: the value of
15378 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
15379 in R).
15381 @subsubsection @code{:results output}
15382 The code is passed to the interpreter running as an interactive Emacs
15383 inferior process.  The result returned is the concatenation of the sequence of
15384 (text) output from the interactive interpreter.  Notice that this is not
15385 necessarily the same as what would be sent to @code{STDOUT} if the same code
15386 were passed to a non-interactive interpreter running as an external
15387 process.  For example, compare the following two blocks:
15389 @example
15390 #+BEGIN_SRC python :results output
15391  print "hello"
15393  print "bye"
15394 #+END_SRC
15396 #+RESULTS:
15397 : hello
15398 : bye
15399 @end example
15401 In non-session mode, the `2' is not printed and does not appear.
15403 @example
15404 #+BEGIN_SRC python :results output :session
15405  print "hello"
15407  print "bye"
15408 #+END_SRC
15410 #+RESULTS:
15411 : hello
15412 : 2
15413 : bye
15414 @end example
15416 But in @code{:session} mode, the interactive interpreter receives input `2'
15417 and prints out its value, `2'.  (Indeed, the other print statements are
15418 unnecessary here).
15420 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
15421 @section Noweb reference syntax
15422 @cindex code block, noweb reference
15423 @cindex syntax, noweb
15424 @cindex source code, noweb reference
15426 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
15427 Programming system allows named blocks of code to be referenced by using the
15428 familiar Noweb syntax:
15430 @example
15431 <<code-block-name>>
15432 @end example
15434 When a code block is tangled or evaluated, whether or not ``noweb''
15435 references are expanded depends upon the value of the @code{:noweb} header
15436 argument.  If @code{:noweb yes}, then a Noweb reference is expanded before
15437 evaluation.  If @code{:noweb no}, the default, then the reference is not
15438 expanded before evaluation.  See the @ref{noweb-ref} header argument for
15439 a more flexible way to resolve noweb references.
15441 It is possible to include the @emph{results} of a code block rather than the
15442 body.  This is done by appending parenthesis to the code block name which may
15443 optionally contain arguments to the code block as shown below.
15445 @example
15446 <<code-block-name(optional arguments)>>
15447 @end example
15449 Note: the default value, @code{:noweb no}, was chosen to ensure that
15450 correct code is not broken in a language, such as Ruby, where
15451 @code{<<arg>>} is a syntactically valid construct.  If @code{<<arg>>} is not
15452 syntactically valid in languages that you use, then please consider setting
15453 the default value.
15455 Note: if noweb tangling is slow in large Org mode files consider setting the
15456 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
15457 This will result in faster noweb reference resolution at the expense of not
15458 correctly resolving inherited values of the @code{:noweb-ref} header
15459 argument.
15461 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
15462 @section Key bindings and useful functions
15463 @cindex code block, key bindings
15465 Many common Org mode key sequences are re-bound depending on
15466 the context.
15468 Within a code block, the following key bindings
15469 are active:
15471 @multitable @columnfractions 0.25 0.75
15472 @kindex C-c C-c
15473 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
15474 @kindex C-c C-o
15475 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
15476 @kindex C-up
15477 @item @kbd{C-@key{up}}    @tab @code{org-babel-load-in-session}
15478 @kindex M-down
15479 @item @kbd{M-@key{down}}  @tab @code{org-babel-pop-to-session}
15480 @end multitable
15482 In an Org mode buffer, the following key bindings are active:
15484 @multitable @columnfractions 0.45 0.55
15485 @kindex C-c C-v p
15486 @kindex C-c C-v C-p
15487 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
15488 @kindex C-c C-v n
15489 @kindex C-c C-v C-n
15490 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
15491 @kindex C-c C-v e
15492 @kindex C-c C-v C-e
15493 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
15494 @kindex C-c C-v o
15495 @kindex C-c C-v C-o
15496 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
15497 @kindex C-c C-v v
15498 @kindex C-c C-v C-v
15499 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
15500 @kindex C-c C-v u
15501 @kindex C-c C-v C-u
15502 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
15503 @kindex C-c C-v g
15504 @kindex C-c C-v C-g
15505 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
15506 @kindex C-c C-v r
15507 @kindex C-c C-v C-r
15508 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
15509 @kindex C-c C-v b
15510 @kindex C-c C-v C-b
15511 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
15512 @kindex C-c C-v s
15513 @kindex C-c C-v C-s
15514 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
15515 @kindex C-c C-v d
15516 @kindex C-c C-v C-d
15517 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
15518 @kindex C-c C-v t
15519 @kindex C-c C-v C-t
15520 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
15521 @kindex C-c C-v f
15522 @kindex C-c C-v C-f
15523 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
15524 @kindex C-c C-v c
15525 @kindex C-c C-v C-c
15526 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
15527 @kindex C-c C-v j
15528 @kindex C-c C-v C-j
15529 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
15530 @kindex C-c C-v l
15531 @kindex C-c C-v C-l
15532 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
15533 @kindex C-c C-v i
15534 @kindex C-c C-v C-i
15535 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
15536 @kindex C-c C-v I
15537 @kindex C-c C-v C-I
15538 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
15539 @kindex C-c C-v z
15540 @kindex C-c C-v C-z
15541 @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}
15542 @kindex C-c C-v a
15543 @kindex C-c C-v C-a
15544 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
15545 @kindex C-c C-v h
15546 @kindex C-c C-v C-h
15547 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
15548 @kindex C-c C-v x
15549 @kindex C-c C-v C-x
15550 @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}
15551 @end multitable
15553 @c When possible these keybindings were extended to work when the control key is
15554 @c kept pressed, resulting in the following additional keybindings.
15556 @c @multitable @columnfractions 0.25 0.75
15557 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
15558 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
15559 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
15560 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
15561 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
15562 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
15563 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
15564 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
15565 @c @end multitable
15567 @node Batch execution,  , Key bindings and useful functions, Working With Source Code
15568 @section Batch execution
15569 @cindex code block, batch execution
15570 @cindex source code, batch execution
15572 It is possible to call functions from the command line.  This shell
15573 script calls @code{org-babel-tangle} on every one of its arguments.
15575 Be sure to adjust the paths to fit your system.
15577 @example
15578 #!/bin/sh
15579 # -*- mode: shell-script -*-
15581 # tangle files with org-mode
15583 DIR=`pwd`
15584 FILES=""
15586 # wrap each argument in the code required to call tangle on it
15587 for i in $@@; do
15588     FILES="$FILES \"$i\""
15589 done
15591 emacs -Q --batch \
15592 --eval "(progn
15593 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
15594 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
15595 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
15596 (mapc (lambda (file)
15597        (find-file (expand-file-name file \"$DIR\"))
15598        (org-babel-tangle)
15599        (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
15600 @end example
15602 @node Miscellaneous, Hacking, Working With Source Code, Top
15603 @chapter Miscellaneous
15605 @menu
15606 * Completion::                  M-TAB knows what you need
15607 * Easy Templates::              Quick insertion of structural elements
15608 * Speed keys::                  Electric commands at the beginning of a headline
15609 * Code evaluation security::    Org mode files evaluate inline code
15610 * Customization::               Adapting Org to your taste
15611 * In-buffer settings::          Overview of the #+KEYWORDS
15612 * The very busy C-c C-c key::   When in doubt, press C-c C-c
15613 * Clean view::                  Getting rid of leading stars in the outline
15614 * TTY keys::                    Using Org on a tty
15615 * Interaction::                 Other Emacs packages
15616 * org-crypt::                   Encrypting Org files
15617 @end menu
15620 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
15621 @section Completion
15622 @cindex completion, of @TeX{} symbols
15623 @cindex completion, of TODO keywords
15624 @cindex completion, of dictionary words
15625 @cindex completion, of option keywords
15626 @cindex completion, of tags
15627 @cindex completion, of property keys
15628 @cindex completion, of link abbreviations
15629 @cindex @TeX{} symbol completion
15630 @cindex TODO keywords completion
15631 @cindex dictionary word completion
15632 @cindex option keyword completion
15633 @cindex tag completion
15634 @cindex link abbreviations, completion of
15636 Emacs would not be Emacs without completion, and Org mode uses it whenever it
15637 makes sense.  If you prefer an @i{iswitchb}- or @i{ido}-like interface for
15638 some of the completion prompts, you can specify your preference by setting at
15639 most one of the variables @code{org-completion-use-iswitchb}
15640 @code{org-completion-use-ido}.
15642 Org supports in-buffer completion.  This type of completion does
15643 not make use of the minibuffer.  You simply type a few letters into
15644 the buffer and use the key to complete text right there.
15646 @table @kbd
15647 @kindex M-@key{TAB}
15648 @item M-@key{TAB}
15649 Complete word at point
15650 @itemize @bullet
15651 @item
15652 At the beginning of a headline, complete TODO keywords.
15653 @item
15654 After @samp{\}, complete @TeX{} symbols supported by the exporter.
15655 @item
15656 After @samp{*}, complete headlines in the current buffer so that they
15657 can be used in search links like @samp{[[*find this headline]]}.
15658 @item
15659 After @samp{:} in a headline, complete tags.  The list of tags is taken
15660 from the variable @code{org-tag-alist} (possibly set through the
15661 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
15662 dynamically from all tags used in the current buffer.
15663 @item
15664 After @samp{:} and not in a headline, complete property keys.  The list
15665 of keys is constructed dynamically from all keys used in the current
15666 buffer.
15667 @item
15668 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
15669 @item
15670 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
15671 @samp{OPTIONS} which set file-specific options for Org mode.  When the
15672 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
15673 will insert example settings for this keyword.
15674 @item
15675 In the line after @samp{#+STARTUP: }, complete startup keywords,
15676 i.e., valid keys for this line.
15677 @item
15678 Elsewhere, complete dictionary words using Ispell.
15679 @end itemize
15680 @end table
15682 @node Easy Templates, Speed keys, Completion, Miscellaneous
15683 @section Easy Templates
15684 @cindex template insertion
15685 @cindex insertion, of templates
15687 Org mode supports insertion of empty structural elements (like
15688 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
15689 strokes.  This is achieved through a native template expansion mechanism.
15690 Note that Emacs has several other template mechanisms which could be used in
15691 a similar way, for example @file{yasnippet}.
15693 To insert a structural element, type a @samp{<}, followed by a template
15694 selector and @kbd{@key{TAB}}.  Completion takes effect only when the above
15695 keystrokes are typed on a line by itself.
15697 The following template selectors are currently supported.
15699 @multitable @columnfractions 0.1 0.9
15700 @item @kbd{s} @tab @code{#+BEGIN_SRC     ... #+END_SRC}
15701 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
15702 @item @kbd{q} @tab @code{#+BEGIN_QUOTE   ... #+END_QUOTE}
15703 @item @kbd{v} @tab @code{#+BEGIN_VERSE   ... #+END_VERSE}
15704 @item @kbd{c} @tab @code{#+BEGIN_CENTER  ... #+END_CENTER}
15705 @item @kbd{l} @tab @code{#+BEGIN_LaTeX   ... #+END_LaTeX}
15706 @item @kbd{L} @tab @code{#+LaTeX:}
15707 @item @kbd{h} @tab @code{#+BEGIN_HTML    ... #+END_HTML}
15708 @item @kbd{H} @tab @code{#+HTML:}
15709 @item @kbd{a} @tab @code{#+BEGIN_ASCII   ... #+END_ASCII}
15710 @item @kbd{A} @tab @code{#+ASCII:}
15711 @item @kbd{i} @tab @code{#+INDEX:} line
15712 @item @kbd{I} @tab @code{#+INCLUDE:} line
15713 @end multitable
15715 For example, on an empty line, typing "<e" and then pressing TAB, will expand
15716 into a complete EXAMPLE template.
15718 You can install additional templates by customizing the variable
15719 @code{org-structure-template-alist}.  See the docstring of the variable for
15720 additional details.
15722 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
15723 @section Speed keys
15724 @cindex speed keys
15725 @vindex org-use-speed-commands
15726 @vindex org-speed-commands-user
15728 Single keys can be made to execute commands when the cursor is at the
15729 beginning of a headline, i.e., before the first star.  Configure the variable
15730 @code{org-use-speed-commands} to activate this feature.  There is a
15731 pre-defined list of commands, and you can add more such commands using the
15732 variable @code{org-speed-commands-user}.  Speed keys do not only speed up
15733 navigation and other commands, but they also provide an alternative way to
15734 execute commands bound to keys that are not or not easily available on a TTY,
15735 or on a small mobile device with a limited keyboard.
15737 To see which commands are available, activate the feature and press @kbd{?}
15738 with the cursor at the beginning of a headline.
15740 @node Code evaluation security, Customization, Speed keys, Miscellaneous
15741 @section Code evaluation and security issues
15743 Org provides tools to work with the code snippets, including evaluating them.
15745 Running code on your machine always comes with a security risk.  Badly
15746 written or malicious code can be executed on purpose or by accident.  Org has
15747 default settings which will only evaluate such code if you give explicit
15748 permission to do so, and as a casual user of these features you should leave
15749 these precautions intact.
15751 For people who regularly work with such code, the confirmation prompts can
15752 become annoying, and you might want to turn them off.  This can be done, but
15753 you must be aware of the risks that are involved.
15755 Code evaluation can happen under the following circumstances:
15757 @table @i
15758 @item Source code blocks
15759 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
15760 C-c} in the block.  The most important thing to realize here is that Org mode
15761 files which contain code snippets are, in a certain sense, like executable
15762 files.  So you should accept them and load them into Emacs only from trusted
15763 sources---just like you would do with a program you install on your computer.
15765 Make sure you know what you are doing before customizing the variables
15766 which take off the default security brakes.
15768 @defopt org-confirm-babel-evaluate
15769 When t (the default), the user is asked before every code block evaluation.
15770 When @code{nil}, the user is not asked.  When set to a function, it is called with
15771 two arguments (language and body of the code block) and should return t to
15772 ask and @code{nil} not to ask.
15773 @end defopt
15775 For example, here is how to execute "ditaa" code (which is considered safe)
15776 without asking:
15778 @lisp
15779 (defun my-org-confirm-babel-evaluate (lang body)
15780   (not (string= lang "ditaa")))  ; don't ask for ditaa
15781 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
15782 @end lisp
15784 @item Following @code{shell} and @code{elisp} links
15785 Org has two link types that can directly evaluate code (@pxref{External
15786 links}).  These links can be problematic because the code to be evaluated is
15787 not visible.
15789 @defopt org-confirm-shell-link-function
15790 Function to queries user about shell link execution.
15791 @end defopt
15792 @defopt org-confirm-elisp-link-function
15793 Functions to query user for Emacs Lisp link execution.
15794 @end defopt
15796 @item Formulas in tables
15797 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
15798 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
15799 @end table
15801 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
15802 @section Customization
15803 @cindex customization
15804 @cindex options, for customization
15805 @cindex variables, for customization
15807 There are more than 500 variables that can be used to customize
15808 Org.  For the sake of compactness of the manual, I am not
15809 describing the variables here.  A structured overview of customization
15810 variables is available with @kbd{M-x org-customize RET}.  Or select
15811 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
15812 settings can also be activated on a per-file basis, by putting special
15813 lines into the buffer (@pxref{In-buffer settings}).
15815 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
15816 @section Summary of in-buffer settings
15817 @cindex in-buffer settings
15818 @cindex special keywords
15820 Org mode uses special lines in the buffer to define settings on a
15821 per-file basis.  These lines start with a @samp{#+} followed by a
15822 keyword, a colon, and then individual words defining a setting.  Several
15823 setting words can be in the same line, but you can also have multiple
15824 lines for the keyword.  While these settings are described throughout
15825 the manual, here is a summary.  After changing any of those lines in the
15826 buffer, press @kbd{C-c C-c} with the cursor still in the line to
15827 activate the changes immediately.  Otherwise they become effective only
15828 when the file is visited again in a new Emacs session.
15830 @vindex org-archive-location
15831 @table @kbd
15832 @item #+ARCHIVE: %s_done::
15833 This line sets the archive location for the agenda file.  It applies for
15834 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
15835 of the file.  The first such line also applies to any entries before it.
15836 The corresponding variable is @code{org-archive-location}.
15837 @item #+CATEGORY:
15838 This line sets the category for the agenda file.  The category applies
15839 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
15840 end of the file.  The first such line also applies to any entries before it.
15841 @item #+COLUMNS: %25ITEM ...
15842 @cindex property, COLUMNS
15843 Set the default format for columns view.  This format applies when
15844 columns view is invoked in locations where no @code{COLUMNS} property
15845 applies.
15846 @item #+CONSTANTS: name1=value1 ...
15847 @vindex org-table-formula-constants
15848 @vindex org-table-formula
15849 Set file-local values for constants to be used in table formulas.  This
15850 line sets the local variable @code{org-table-formula-constants-local}.
15851 The global version of this variable is
15852 @code{org-table-formula-constants}.
15853 @item #+FILETAGS: :tag1:tag2:tag3:
15854 Set tags that can be inherited by any entry in the file, including the
15855 top-level entries.
15856 @item #+DRAWERS: NAME1 ...
15857 @vindex org-drawers
15858 Set the file-local set of additional drawers.  The corresponding global
15859 variable is @code{org-drawers}.
15860 @item #+LINK: linkword replace
15861 @vindex org-link-abbrev-alist
15862 These lines (several are allowed) specify link abbreviations.
15863 @xref{Link abbreviations}.  The corresponding variable is
15864 @code{org-link-abbrev-alist}.
15865 @item #+PRIORITIES: highest lowest default
15866 @vindex org-highest-priority
15867 @vindex org-lowest-priority
15868 @vindex org-default-priority
15869 This line sets the limits and the default for the priorities.  All three
15870 must be either letters A--Z or numbers 0--9.  The highest priority must
15871 have a lower ASCII number than the lowest priority.
15872 @item #+PROPERTY: Property_Name Value
15873 This line sets a default inheritance value for entries in the current
15874 buffer, most useful for specifying the allowed values of a property.
15875 @cindex #+SETUPFILE
15876 @item #+SETUPFILE: file
15877 This line defines a file that holds more in-buffer setup.  Normally this is
15878 entirely ignored.  Only when the buffer is parsed for option-setting lines
15879 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
15880 settings line, or when exporting), then the contents of this file are parsed
15881 as if they had been included in the buffer.  In particular, the file can be
15882 any other Org mode file with internal setup.  You can visit the file the
15883 cursor is in the line with @kbd{C-c '}.
15884 @item #+STARTUP:
15885 @cindex #+STARTUP
15886 This line sets options to be used at startup of Org mode, when an
15887 Org file is being visited.
15889 The first set of options deals with the initial visibility of the outline
15890 tree.  The corresponding variable for global default settings is
15891 @code{org-startup-folded}, with a default value @code{t}, which means
15892 @code{overview}.
15893 @vindex org-startup-folded
15894 @cindex @code{overview}, STARTUP keyword
15895 @cindex @code{content}, STARTUP keyword
15896 @cindex @code{showall}, STARTUP keyword
15897 @cindex @code{showeverything}, STARTUP keyword
15898 @example
15899 overview         @r{top-level headlines only}
15900 content          @r{all headlines}
15901 showall          @r{no folding of any entries}
15902 showeverything   @r{show even drawer contents}
15903 @end example
15905 @vindex org-startup-indented
15906 @cindex @code{indent}, STARTUP keyword
15907 @cindex @code{noindent}, STARTUP keyword
15908 Dynamic virtual indentation is controlled by the variable
15909 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
15910 @example
15911 indent     @r{start with @code{org-indent-mode} turned on}
15912 noindent   @r{start with @code{org-indent-mode} turned off}
15913 @end example
15915 @vindex org-startup-align-all-tables
15916 Then there are options for aligning tables upon visiting a file.  This
15917 is useful in files containing narrowed table columns.  The corresponding
15918 variable is @code{org-startup-align-all-tables}, with a default value
15919 @code{nil}.
15920 @cindex @code{align}, STARTUP keyword
15921 @cindex @code{noalign}, STARTUP keyword
15922 @example
15923 align      @r{align all tables}
15924 noalign    @r{don't align tables on startup}
15925 @end example
15927 @vindex org-startup-with-inline-images
15928 When visiting a file, inline images can be automatically displayed.  The
15929 corresponding variable is @code{org-startup-with-inline-images}, with a
15930 default value @code{nil} to avoid delays when visiting a file.
15931 @cindex @code{inlineimages}, STARTUP keyword
15932 @cindex @code{noinlineimages}, STARTUP keyword
15933 @example
15934 inlineimages   @r{show inline images}
15935 noinlineimages @r{don't show inline images on startup}
15936 @end example
15938 @vindex org-startup-with-latex-preview
15939 When visiting a file, @LaTeX{} fragments can be converted to images
15940 automatically.  The variable @code{org-startup-with-latex-preview} which
15941 controls this behavior, is set to @code{nil} by default to avoid delays on
15942 startup.
15943 @cindex @code{latexpreview}, STARTUP keyword
15944 @cindex @code{nolatexpreview}, STARTUP keyword
15945 @example
15946 latexpreview   @r{preview @LaTeX{} fragments}
15947 nolatexpreview @r{don't preview @LaTeX{} fragments}
15948 @end example
15950 @vindex org-log-done
15951 @vindex org-log-note-clock-out
15952 @vindex org-log-repeat
15953 Logging the closing and reopening of TODO items and clock intervals can be
15954 configured using these options (see variables @code{org-log-done},
15955 @code{org-log-note-clock-out} and @code{org-log-repeat})
15956 @cindex @code{logdone}, STARTUP keyword
15957 @cindex @code{lognotedone}, STARTUP keyword
15958 @cindex @code{nologdone}, STARTUP keyword
15959 @cindex @code{lognoteclock-out}, STARTUP keyword
15960 @cindex @code{nolognoteclock-out}, STARTUP keyword
15961 @cindex @code{logrepeat}, STARTUP keyword
15962 @cindex @code{lognoterepeat}, STARTUP keyword
15963 @cindex @code{nologrepeat}, STARTUP keyword
15964 @cindex @code{logreschedule}, STARTUP keyword
15965 @cindex @code{lognotereschedule}, STARTUP keyword
15966 @cindex @code{nologreschedule}, STARTUP keyword
15967 @cindex @code{logredeadline}, STARTUP keyword
15968 @cindex @code{lognoteredeadline}, STARTUP keyword
15969 @cindex @code{nologredeadline}, STARTUP keyword
15970 @cindex @code{logrefile}, STARTUP keyword
15971 @cindex @code{lognoterefile}, STARTUP keyword
15972 @cindex @code{nologrefile}, STARTUP keyword
15973 @cindex @code{logdrawer}, STARTUP keyword
15974 @cindex @code{nologdrawer}, STARTUP keyword
15975 @cindex @code{logstatesreversed}, STARTUP keyword
15976 @cindex @code{nologstatesreversed}, STARTUP keyword
15977 @example
15978 logdone             @r{record a timestamp when an item is marked DONE}
15979 lognotedone         @r{record timestamp and a note when DONE}
15980 nologdone           @r{don't record when items are marked DONE}
15981 logrepeat           @r{record a time when reinstating a repeating item}
15982 lognoterepeat       @r{record a note when reinstating a repeating item}
15983 nologrepeat         @r{do not record when reinstating repeating item}
15984 lognoteclock-out    @r{record a note when clocking out}
15985 nolognoteclock-out  @r{don't record a note when clocking out}
15986 logreschedule       @r{record a timestamp when scheduling time changes}
15987 lognotereschedule   @r{record a note when scheduling time changes}
15988 nologreschedule     @r{do not record when a scheduling date changes}
15989 logredeadline       @r{record a timestamp when deadline changes}
15990 lognoteredeadline   @r{record a note when deadline changes}
15991 nologredeadline     @r{do not record when a deadline date changes}
15992 logrefile           @r{record a timestamp when refiling}
15993 lognoterefile       @r{record a note when refiling}
15994 nologrefile         @r{do not record when refiling}
15995 logdrawer           @r{store log into drawer}
15996 nologdrawer         @r{store log outside of drawer}
15997 logstatesreversed   @r{reverse the order of states notes}
15998 nologstatesreversed @r{do not reverse the order of states notes}
15999 @end example
16001 @vindex org-hide-leading-stars
16002 @vindex org-odd-levels-only
16003 Here are the options for hiding leading stars in outline headings, and for
16004 indenting outlines.  The corresponding variables are
16005 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
16006 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
16007 @cindex @code{hidestars}, STARTUP keyword
16008 @cindex @code{showstars}, STARTUP keyword
16009 @cindex @code{odd}, STARTUP keyword
16010 @cindex @code{even}, STARTUP keyword
16011 @example
16012 hidestars  @r{make all but one of the stars starting a headline invisible.}
16013 showstars  @r{show all stars starting a headline}
16014 indent     @r{virtual indentation according to outline level}
16015 noindent   @r{no virtual indentation according to outline level}
16016 odd        @r{allow only odd outline levels (1,3,...)}
16017 oddeven    @r{allow all outline levels}
16018 @end example
16020 @vindex org-put-time-stamp-overlays
16021 @vindex org-time-stamp-overlay-formats
16022 To turn on custom format overlays over timestamps (variables
16023 @code{org-put-time-stamp-overlays} and
16024 @code{org-time-stamp-overlay-formats}), use
16025 @cindex @code{customtime}, STARTUP keyword
16026 @example
16027 customtime @r{overlay custom time format}
16028 @end example
16030 @vindex constants-unit-system
16031 The following options influence the table spreadsheet (variable
16032 @code{constants-unit-system}).
16033 @cindex @code{constcgs}, STARTUP keyword
16034 @cindex @code{constSI}, STARTUP keyword
16035 @example
16036 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
16037 constSI    @r{@file{constants.el} should use the SI unit system}
16038 @end example
16040 @vindex org-footnote-define-inline
16041 @vindex org-footnote-auto-label
16042 @vindex org-footnote-auto-adjust
16043 To influence footnote settings, use the following keywords.  The
16044 corresponding variables are @code{org-footnote-define-inline},
16045 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
16046 @cindex @code{fninline}, STARTUP keyword
16047 @cindex @code{nofninline}, STARTUP keyword
16048 @cindex @code{fnlocal}, STARTUP keyword
16049 @cindex @code{fnprompt}, STARTUP keyword
16050 @cindex @code{fnauto}, STARTUP keyword
16051 @cindex @code{fnconfirm}, STARTUP keyword
16052 @cindex @code{fnplain}, STARTUP keyword
16053 @cindex @code{fnadjust}, STARTUP keyword
16054 @cindex @code{nofnadjust}, STARTUP keyword
16055 @example
16056 fninline    @r{define footnotes inline}
16057 fnnoinline  @r{define footnotes in separate section}
16058 fnlocal     @r{define footnotes near first reference, but not inline}
16059 fnprompt    @r{prompt for footnote labels}
16060 fnauto      @r{create @code{[fn:1]}-like labels automatically (default)}
16061 fnconfirm   @r{offer automatic label for editing or confirmation}
16062 fnplain     @r{create @code{[1]}-like labels automatically}
16063 fnadjust    @r{automatically renumber and sort footnotes}
16064 nofnadjust  @r{do not renumber and sort automatically}
16065 @end example
16067 @cindex org-hide-block-startup
16068 To hide blocks on startup, use these keywords.  The corresponding variable is
16069 @code{org-hide-block-startup}.
16070 @cindex @code{hideblocks}, STARTUP keyword
16071 @cindex @code{nohideblocks}, STARTUP keyword
16072 @example
16073 hideblocks   @r{Hide all begin/end blocks on startup}
16074 nohideblocks @r{Do not hide blocks on startup}
16075 @end example
16077 @cindex org-pretty-entities
16078 The display of entities as UTF-8 characters is governed by the variable
16079 @code{org-pretty-entities} and the keywords
16080 @cindex @code{entitiespretty}, STARTUP keyword
16081 @cindex @code{entitiesplain}, STARTUP keyword
16082 @example
16083 entitiespretty  @r{Show entities as UTF-8 characters where possible}
16084 entitiesplain   @r{Leave entities plain}
16085 @end example
16087 @item #+TAGS:  TAG1(c1) TAG2(c2)
16088 @vindex org-tag-alist
16089 These lines (several such lines are allowed) specify the valid tags in
16090 this file, and (potentially) the corresponding @emph{fast tag selection}
16091 keys.  The corresponding variable is @code{org-tag-alist}.
16092 @cindex #+TBLFM
16093 @item #+TBLFM:
16094 This line contains the formulas for the table directly above the line.
16096 Table can have multiple lines containing @samp{#+TBLFM:}.  Note
16097 that only the first line of @samp{#+TBLFM:} will be applied when
16098 you recalculate the table.  For more details see @ref{Using
16099 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
16101 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
16102 @itemx #+OPTIONS:, #+BIND:,
16103 @itemx #+DESCRIPTION:, #+KEYWORDS:,
16104 @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
16105 @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
16106 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
16107 These lines provide settings for exporting files.  For more details see
16108 @ref{Export settings}.
16109 @item #+TODO:    #+SEQ_TODO:   #+TYP_TODO:
16110 @vindex org-todo-keywords
16111 These lines set the TODO keywords and their interpretation in the
16112 current file.  The corresponding variable is @code{org-todo-keywords}.
16113 @end table
16115 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
16116 @section The very busy C-c C-c key
16117 @kindex C-c C-c
16118 @cindex C-c C-c, overview
16120 The key @kbd{C-c C-c} has many purposes in Org, which are all
16121 mentioned scattered throughout this manual.  One specific function of
16122 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
16123 other circumstances it means something like @emph{``Hey Org, look
16124 here and update according to what you see here''}.  Here is a summary of
16125 what this means in different contexts.
16127 @itemize @minus
16128 @item
16129 If there are highlights in the buffer from the creation of a sparse
16130 tree, or from clock display, remove these highlights.
16131 @item
16132 If the cursor is in one of the special @code{#+KEYWORD} lines, this
16133 triggers scanning the buffer for these lines and updating the
16134 information.
16135 @item
16136 If the cursor is inside a table, realign the table.  This command
16137 works even if the automatic table editor has been turned off.
16138 @item
16139 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
16140 the entire table.
16141 @item
16142 If the current buffer is a capture buffer, close the note and file it.
16143 With a prefix argument, file it, without further interaction, to the
16144 default location.
16145 @item
16146 If the cursor is on a @code{<<<target>>>}, update radio targets and
16147 corresponding links in this buffer.
16148 @item
16149 If the cursor is in a property line or at the start or end of a property
16150 drawer, offer property commands.
16151 @item
16152 If the cursor is at a footnote reference, go to the corresponding
16153 definition, and @emph{vice versa}.
16154 @item
16155 If the cursor is on a statistics cookie, update it.
16156 @item
16157 If the cursor is in a plain list item with a checkbox, toggle the status
16158 of the checkbox.
16159 @item
16160 If the cursor is on a numbered item in a plain list, renumber the
16161 ordered list.
16162 @item
16163 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
16164 block is updated.
16165 @item
16166 If the cursor is at a timestamp, fix the day name in the timestamp.
16167 @end itemize
16169 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
16170 @section A cleaner outline view
16171 @cindex hiding leading stars
16172 @cindex dynamic indentation
16173 @cindex odd-levels-only outlines
16174 @cindex clean outline view
16176 Some people find it noisy and distracting that the Org headlines start with a
16177 potentially large number of stars, and that text below the headlines is not
16178 indented.  While this is no problem when writing a @emph{book-like} document
16179 where the outline headings are really section headings, in a more
16180 @emph{list-oriented} outline, indented structure is a lot cleaner:
16182 @example
16183 @group
16184 * Top level headline             |    * Top level headline
16185 ** Second level                  |      * Second level
16186 *** 3rd level                    |        * 3rd level
16187 some text                        |          some text
16188 *** 3rd level                    |        * 3rd level
16189 more text                        |          more text
16190 * Another top level headline     |    * Another top level headline
16191 @end group
16192 @end example
16194 @noindent
16196 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
16197 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
16198 be achieved dynamically at display time using @code{org-indent-mode}.  In
16199 this minor mode, all lines are prefixed for display with the necessary amount
16200 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
16201 property, such that @code{visual-line-mode} (or purely setting
16202 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
16203 }.  Also headlines are prefixed with additional stars, so that the amount of
16204 indentation shifts by two@footnote{See the variable
16205 @code{org-indent-indentation-per-level}.}  spaces per level.  All headline
16206 stars but the last one are made invisible using the @code{org-hide}
16207 face@footnote{Turning on @code{org-indent-mode} sets
16208 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
16209 @code{nil}.}; see below under @samp{2.} for more information on how this
16210 works.  You can turn on @code{org-indent-mode} for all files by customizing
16211 the variable @code{org-startup-indented}, or you can turn it on for
16212 individual files using
16214 @example
16215 #+STARTUP: indent
16216 @end example
16218 If you want a similar effect in an earlier version of Emacs and/or Org, or if
16219 you want the indentation to be hard space characters so that the plain text
16220 file looks as similar as possible to the Emacs display, Org supports you in
16221 the following way:
16223 @enumerate
16224 @item
16225 @emph{Indentation of text below headlines}@*
16226 You may indent text below each headline to make the left boundary line up
16227 with the headline, like
16229 @example
16230 *** 3rd level
16231     more text, now indented
16232 @end example
16234 @vindex org-adapt-indentation
16235 Org supports this with paragraph filling, line wrapping, and structure
16236 editing@footnote{See also the variable @code{org-adapt-indentation}.},
16237 preserving or adapting the indentation as appropriate.
16239 @item
16240 @vindex org-hide-leading-stars
16241 @emph{Hiding leading stars}@* You can modify the display in such a way that
16242 all leading stars become invisible.  To do this in a global way, configure
16243 the variable @code{org-hide-leading-stars} or change this on a per-file basis
16244 with
16246 @example
16247 #+STARTUP: hidestars
16248 #+STARTUP: showstars
16249 @end example
16251 With hidden stars, the tree becomes:
16253 @example
16254 @group
16255 * Top level headline
16256  * Second level
16257   * 3rd level
16258   ...
16259 @end group
16260 @end example
16262 @noindent
16263 @vindex org-hide @r{(face)}
16264 The leading stars are not truly replaced by whitespace, they are only
16265 fontified with the face @code{org-hide} that uses the background color as
16266 font color.  If you are not using either white or black background, you may
16267 have to customize this face to get the wanted effect.  Another possibility is
16268 to set this font such that the extra stars are @i{almost} invisible, for
16269 example using the color @code{grey90} on a white background.
16271 @item
16272 @vindex org-odd-levels-only
16273 Things become cleaner still if you skip all the even levels and use only odd
16274 levels 1, 3, 5..., effectively adding two stars to go from one outline level
16275 to the next@footnote{When you need to specify a level for a property search
16276 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}.  In this
16277 way we get the outline view shown at the beginning of this section.  In order
16278 to make the structure editing and export commands handle this convention
16279 correctly, configure the variable @code{org-odd-levels-only}, or set this on
16280 a per-file basis with one of the following lines:
16282 @example
16283 #+STARTUP: odd
16284 #+STARTUP: oddeven
16285 @end example
16287 You can convert an Org file from single-star-per-level to the
16288 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
16289 RET} in that file.  The reverse operation is @kbd{M-x
16290 org-convert-to-oddeven-levels}.
16291 @end enumerate
16293 @node TTY keys, Interaction, Clean view, Miscellaneous
16294 @section Using Org on a tty
16295 @cindex tty key bindings
16297 Because Org contains a large number of commands, by default many of
16298 Org's core commands are bound to keys that are generally not
16299 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
16300 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
16301 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
16302 these commands on a tty when special keys are unavailable, the following
16303 alternative bindings can be used.  The tty bindings below will likely be
16304 more cumbersome; you may find for some of the bindings below that a
16305 customized workaround suits you better.  For example, changing a timestamp
16306 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
16307 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
16309 @multitable @columnfractions 0.15 0.2 0.1 0.2
16310 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
16311 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab @kbd{C} @tab
16312 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
16313 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab @kbd{L} @tab
16314 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x r}           @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
16315 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab @kbd{R} @tab
16316 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
16317 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab @kbd{U} @tab
16318 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
16319 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab @kbd{D} @tab
16320 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab @kbd{ } @tab
16321 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
16322 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab @kbd{ } @tab
16323 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab @kbd{ } @tab
16324 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab @kbd{ } @tab
16325 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab @kbd{ } @tab
16326 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab @kbd{ } @tab
16327 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab @kbd{ } @tab
16328 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
16329 @end multitable
16332 @node Interaction, org-crypt, TTY keys, Miscellaneous
16333 @section Interaction with other packages
16334 @cindex packages, interaction with other
16335 Org lives in the world of GNU Emacs and interacts in various ways
16336 with other code out there.
16338 @menu
16339 * Cooperation::                 Packages Org cooperates with
16340 * Conflicts::                   Packages that lead to conflicts
16341 @end menu
16343 @node Cooperation, Conflicts, Interaction, Interaction
16344 @subsection Packages that Org cooperates with
16346 @table @asis
16347 @cindex @file{calc.el}
16348 @cindex Gillespie, Dave
16349 @item @file{calc.el} by Dave Gillespie
16350 Org uses the Calc package for implementing spreadsheet
16351 functionality in its tables (@pxref{The spreadsheet}).  Org
16352 checks for the availability of Calc by looking for the function
16353 @code{calc-eval} which will have been autoloaded during setup if Calc has
16354 been installed properly.  As of Emacs 22, Calc is part of the Emacs
16355 distribution.  Another possibility for interaction between the two
16356 packages is using Calc for embedded calculations.  @xref{Embedded Mode,
16357 , Embedded Mode, calc, GNU Emacs Calc Manual}.
16358 @item @file{constants.el} by Carsten Dominik
16359 @cindex @file{constants.el}
16360 @cindex Dominik, Carsten
16361 @vindex org-table-formula-constants
16362 In a table formula (@pxref{The spreadsheet}), it is possible to use
16363 names for natural constants or units.  Instead of defining your own
16364 constants in the variable @code{org-table-formula-constants}, install
16365 the @file{constants} package which defines a large number of constants
16366 and units, and lets you use unit prefixes like @samp{M} for
16367 @samp{Mega}, etc.  You will need version 2.0 of this package, available
16368 at @url{http://www.astro.uva.nl/~dominik/Tools}.  Org checks for
16369 the function @code{constants-get}, which has to be autoloaded in your
16370 setup.  See the installation instructions in the file
16371 @file{constants.el}.
16372 @item @file{cdlatex.el} by Carsten Dominik
16373 @cindex @file{cdlatex.el}
16374 @cindex Dominik, Carsten
16375 Org mode can make use of the CD@LaTeX{} package to efficiently enter
16376 @LaTeX{} fragments into Org files.  See @ref{CDLaTeX mode}.
16377 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
16378 @cindex @file{imenu.el}
16379 Imenu allows menu access to an index of items in a file.  Org mode
16380 supports Imenu---all you need to do to get the index is the following:
16381 @lisp
16382 (add-hook 'org-mode-hook
16383           (lambda () (imenu-add-to-menubar "Imenu")))
16384 @end lisp
16385 @vindex org-imenu-depth
16386 By default the index is two levels deep---you can modify the depth using
16387 the option @code{org-imenu-depth}.
16388 @item @file{remember.el} by John Wiegley
16389 @cindex @file{remember.el}
16390 @cindex Wiegley, John
16391 Org used to use this package for capture, but no longer does.
16392 @item @file{speedbar.el} by Eric M. Ludlam
16393 @cindex @file{speedbar.el}
16394 @cindex Ludlam, Eric M.
16395 Speedbar is a package that creates a special frame displaying files and
16396 index items in files.  Org mode supports Speedbar and allows you to
16397 drill into Org files directly from the Speedbar.  It also allows you to
16398 restrict the scope of agenda commands to a file or a subtree by using
16399 the command @kbd{<} in the Speedbar frame.
16400 @cindex @file{table.el}
16401 @item @file{table.el} by Takaaki Ota
16402 @kindex C-c C-c
16403 @cindex table editor, @file{table.el}
16404 @cindex @file{table.el}
16405 @cindex Ota, Takaaki
16407 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
16408 and alignment can be created using the Emacs table package by Takaaki Ota
16409 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
16410 Org mode will recognize these tables and export them properly.  Because of
16411 interference with other Org mode functionality, you unfortunately cannot edit
16412 these tables directly in the buffer.  Instead, you need to use the command
16413 @kbd{C-c '} to edit them, similar to source code snippets.
16415 @table @kbd
16416 @orgcmd{C-c ',org-edit-special}
16417 Edit a @file{table.el} table.  Works when the cursor is in a table.el table.
16419 @orgcmd{C-c ~,org-table-create-with-table.el}
16420 Insert a @file{table.el} table.  If there is already a table at point, this
16421 command converts it between the @file{table.el} format and the Org mode
16422 format.  See the documentation string of the command
16423 @code{org-convert-table} for the restrictions under which this is
16424 possible.
16425 @end table
16426 @file{table.el} is part of Emacs since Emacs 22.
16427 @item @file{footnote.el} by Steven L. Baur
16428 @cindex @file{footnote.el}
16429 @cindex Baur, Steven L.
16430 Org mode recognizes numerical footnotes as provided by this package.
16431 However, Org mode also has its own footnote support (@pxref{Footnotes}),
16432 which makes using @file{footnote.el} unnecessary.
16433 @end table
16435 @node Conflicts,  , Cooperation, Interaction
16436 @subsection Packages that lead to conflicts with Org mode
16438 @table @asis
16440 @cindex @code{shift-selection-mode}
16441 @vindex org-support-shift-select
16442 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
16443 cursor motions combined with the shift key should start or enlarge regions.
16444 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
16445 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
16446 at such a location.  By default, @kbd{S-@key{cursor}} commands outside
16447 special contexts don't do anything, but you can customize the variable
16448 @code{org-support-shift-select}.  Org mode then tries to accommodate shift
16449 selection by (i) using it outside of the special contexts where special
16450 commands apply, and by (ii) extending an existing active region even if the
16451 cursor moves across a special context.
16453 @item @file{CUA.el} by Kim. F. Storm
16454 @cindex @file{CUA.el}
16455 @cindex Storm, Kim. F.
16456 @vindex org-replace-disputed-keys
16457 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
16458 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
16459 region.  In fact, Emacs 23 has this built-in in the form of
16460 @code{shift-selection-mode}, see previous paragraph.  If you are using Emacs
16461 23, you probably don't want to use another package for this purpose.  However,
16462 if you prefer to leave these keys to a different package while working in
16463 Org mode, configure the variable @code{org-replace-disputed-keys}.  When set,
16464 Org will move the following key bindings in Org files, and in the agenda
16465 buffer (but not during date selection).
16467 @example
16468 S-UP      @result{}  M-p             S-DOWN     @result{}  M-n
16469 S-LEFT    @result{}  M--             S-RIGHT    @result{}  M-+
16470 C-S-LEFT  @result{}  M-S--           C-S-RIGHT  @result{}  M-S-+
16471 @end example
16473 @vindex org-disputed-keys
16474 Yes, these are unfortunately more difficult to remember.  If you want
16475 to have other replacement keys, look at the variable
16476 @code{org-disputed-keys}.
16478 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
16479 @cindex @file{ecomplete.el}
16481 Ecomplete provides ``electric'' address completion in address header
16482 lines in message buffers.  Sadly Orgtbl mode cuts ecompletes power
16483 supply: No completion happens when Orgtbl mode is enabled in message
16484 buffers while entering text in address header lines.  If one wants to
16485 use ecomplete one should @emph{not} follow the advice to automagically
16486 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
16487 instead---after filling in the message headers---turn on Orgtbl mode
16488 manually when needed in the messages body.
16490 @item @file{filladapt.el} by Kyle Jones
16491 @cindex @file{filladapt.el}
16493 Org mode tries to do the right thing when filling paragraphs, list items and
16494 other elements.  Many users reported they had problems using both
16495 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
16496 this:
16498 @lisp
16499 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
16500 @end lisp
16502 @item @file{yasnippet.el}
16503 @cindex @file{yasnippet.el}
16504 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
16505 @code{"\t"}) overrules YASnippet's access to this key.  The following code
16506 fixed this problem:
16508 @lisp
16509 (add-hook 'org-mode-hook
16510           (lambda ()
16511             (org-set-local 'yas/trigger-key [tab])
16512             (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
16513 @end lisp
16515 The latest version of yasnippet doesn't play well with Org mode.  If the
16516 above code does not fix the conflict, start by defining the following
16517 function:
16519 @lisp
16520 (defun yas/org-very-safe-expand ()
16521   (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
16522 @end lisp
16524 Then, tell Org mode what to do with the new function:
16526 @lisp
16527 (add-hook 'org-mode-hook
16528           (lambda ()
16529             (make-variable-buffer-local 'yas/trigger-key)
16530             (setq yas/trigger-key [tab])
16531             (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
16532             (define-key yas/keymap [tab] 'yas/next-field)))
16533 @end lisp
16535 @item @file{windmove.el} by Hovav Shacham
16536 @cindex @file{windmove.el}
16537 This package also uses the @kbd{S-<cursor>} keys, so everything written
16538 in the paragraph above about CUA mode also applies here.  If you want make
16539 the windmove function active in locations where Org mode does not have
16540 special functionality on @kbd{S-@key{cursor}}, add this to your
16541 configuration:
16543 @lisp
16544 ;; Make windmove work in org-mode:
16545 (add-hook 'org-shiftup-final-hook 'windmove-up)
16546 (add-hook 'org-shiftleft-final-hook 'windmove-left)
16547 (add-hook 'org-shiftdown-final-hook 'windmove-down)
16548 (add-hook 'org-shiftright-final-hook 'windmove-right)
16549 @end lisp
16551 @item @file{viper.el} by Michael Kifer
16552 @cindex @file{viper.el}
16553 @kindex C-c /
16554 Viper uses @kbd{C-c /} and therefore makes this key not access the
16555 corresponding Org mode command @code{org-sparse-tree}.  You need to find
16556 another key for this command, or override the key in
16557 @code{viper-vi-global-user-map} with
16559 @lisp
16560 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
16561 @end lisp
16565 @end table
16567 @node org-crypt,  , Interaction, Miscellaneous
16568 @section org-crypt.el
16569 @cindex @file{org-crypt.el}
16570 @cindex @code{org-decrypt-entry}
16572 Org-crypt will encrypt the text of an entry, but not the headline, or
16573 properties.  Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
16574 files.
16576 Any text below a headline that has a @samp{:crypt:} tag will be automatically
16577 be encrypted when the file is saved.  If you want to use a different tag just
16578 customize the @code{org-crypt-tag-matcher} setting.
16580 To use org-crypt it is suggested that you have the following in your
16581 @file{.emacs}:
16583 @lisp
16584 (require 'org-crypt)
16585 (org-crypt-use-before-save-magic)
16586 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
16588 (setq org-crypt-key nil)
16589   ;; GPG key to use for encryption
16590   ;; Either the Key ID or set to nil to use symmetric encryption.
16592 (setq auto-save-default nil)
16593   ;; Auto-saving does not cooperate with org-crypt.el: so you need
16594   ;; to turn it off if you plan to use org-crypt.el quite often.
16595   ;; Otherwise, you'll get an (annoying) message each time you
16596   ;; start Org.
16598   ;; To turn it off only locally, you can insert this:
16599   ;;
16600   ;; # -*- buffer-auto-save-file-name: nil; -*-
16601 @end lisp
16603 Excluding the crypt tag from inheritance prevents already encrypted text
16604 being encrypted again.
16606 @node Hacking, MobileOrg, Miscellaneous, Top
16607 @appendix Hacking
16608 @cindex hacking
16610 This appendix covers some aspects where users can extend the functionality of
16611 Org.
16613 @menu
16614 * Hooks::                       How to reach into Org's internals
16615 * Add-on packages::             Available extensions
16616 * Adding hyperlink types::      New custom link types
16617 * Adding export back-ends::     How to write new export back-ends
16618 * Context-sensitive commands::  How to add functionality to such commands
16619 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
16620 * Dynamic blocks::              Automatically filled blocks
16621 * Special agenda views::        Customized views
16622 * Speeding up your agendas::    Tips on how to speed up your agendas
16623 * Extracting agenda information::  Post-processing of agenda information
16624 * Using the property API::      Writing programs that use entry properties
16625 * Using the mapping API::       Mapping over all or selected entries
16626 @end menu
16628 @node Hooks, Add-on packages, Hacking, Hacking
16629 @section Hooks
16630 @cindex hooks
16632 Org has a large number of hook variables that can be used to add
16633 functionality.  This appendix about hacking is going to illustrate the
16634 use of some of them.  A complete list of all hooks with documentation is
16635 maintained by the Worg project and can be found at
16636 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
16638 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
16639 @section Add-on packages
16640 @cindex add-on packages
16642 A large number of add-on packages have been written by various authors.
16644 These packages are not part of Emacs, but they are distributed as contributed
16645 packages with the separate release available at @uref{http://orgmode.org}.
16646 See the @file{contrib/README} file in the source code directory for a list of
16647 contributed files.  You may also find some more information on the Worg page:
16648 @uref{http://orgmode.org/worg/org-contrib/}.
16650 @node Adding hyperlink types, Adding export back-ends, Add-on packages, Hacking
16651 @section Adding hyperlink types
16652 @cindex hyperlinks, adding new types
16654 Org has a large number of hyperlink types built-in
16655 (@pxref{Hyperlinks}).  If you would like to add new link types, Org
16656 provides an interface for doing so.  Let's look at an example file,
16657 @file{org-man.el}, that will add support for creating links like
16658 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
16659 Emacs:
16661 @lisp
16662 ;;; org-man.el - Support for links to manpages in Org
16664 (require 'org)
16666 (org-add-link-type "man" 'org-man-open)
16667 (add-hook 'org-store-link-functions 'org-man-store-link)
16669 (defcustom org-man-command 'man
16670   "The Emacs command to be used to display a man page."
16671   :group 'org-link
16672   :type '(choice (const man) (const woman)))
16674 (defun org-man-open (path)
16675   "Visit the manpage on PATH.
16676 PATH should be a topic that can be thrown at the man command."
16677   (funcall org-man-command path))
16679 (defun org-man-store-link ()
16680   "Store a link to a manpage."
16681   (when (memq major-mode '(Man-mode woman-mode))
16682     ;; This is a man page, we do make this link
16683     (let* ((page (org-man-get-page-name))
16684            (link (concat "man:" page))
16685            (description (format "Manpage for %s" page)))
16686       (org-store-link-props
16687        :type "man"
16688        :link link
16689        :description description))))
16691 (defun org-man-get-page-name ()
16692   "Extract the page name from the buffer name."
16693   ;; This works for both `Man-mode' and `woman-mode'.
16694   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
16695       (match-string 1 (buffer-name))
16696     (error "Cannot create link to this man page")))
16698 (provide 'org-man)
16700 ;;; org-man.el ends here
16701 @end lisp
16703 @noindent
16704 You would activate this new link type in @file{.emacs} with
16706 @lisp
16707 (require 'org-man)
16708 @end lisp
16710 @noindent
16711 Let's go through the file and see what it does.
16712 @enumerate
16713 @item
16714 It does @code{(require 'org)} to make sure that @file{org.el} has been
16715 loaded.
16716 @item
16717 The next line calls @code{org-add-link-type} to define a new link type
16718 with prefix @samp{man}.  The call also contains the name of a function
16719 that will be called to follow such a link.
16720 @item
16721 @vindex org-store-link-functions
16722 The next line adds a function to @code{org-store-link-functions}, in
16723 order to allow the command @kbd{C-c l} to record a useful link in a
16724 buffer displaying a man page.
16725 @end enumerate
16727 The rest of the file defines the necessary variables and functions.
16728 First there is a customization variable that determines which Emacs
16729 command should be used to display man pages.  There are two options,
16730 @code{man} and @code{woman}.  Then the function to follow a link is
16731 defined.  It gets the link path as an argument---in this case the link
16732 path is just a topic for the manual command.  The function calls the
16733 value of @code{org-man-command} to display the man page.
16735 Finally the function @code{org-man-store-link} is defined.  When you try
16736 to store a link with @kbd{C-c l}, this function will be called to
16737 try to make a link.  The function must first decide if it is supposed to
16738 create the link for this buffer type; we do this by checking the value
16739 of the variable @code{major-mode}.  If not, the function must exit and
16740 return the value @code{nil}.  If yes, the link is created by getting the
16741 manual topic from the buffer name and prefixing it with the string
16742 @samp{man:}.  Then it must call the command @code{org-store-link-props}
16743 and set the @code{:type} and @code{:link} properties.  Optionally you
16744 can also set the @code{:description} property to provide a default for
16745 the link description when the link is later inserted into an Org
16746 buffer with @kbd{C-c C-l}.
16748 When it makes sense for your new link type, you may also define a function
16749 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
16750 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
16751 not accept any arguments, and return the full link with prefix.
16753 @node Adding export back-ends, Context-sensitive commands, Adding hyperlink types, Hacking
16754 @section Adding export back-ends
16755 @cindex Export, writing back-ends
16757 Org 8.0 comes with a completely rewritten export engine which makes it easy
16758 to write new export back-ends, either from scratch, or from deriving them
16759 from existing ones.
16761 Your two entry points are respectively @code{org-export-define-backend} and
16762 @code{org-export-define-derived-backend}.  To grok these functions, you
16763 should first have a look at @file{ox-latex.el} (for how to define a new
16764 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
16765 back-end from an existing one.
16767 When creating a new back-end from scratch, the basic idea is to set the name
16768 of the back-end (as a symbol) and an an alist of elements and export
16769 functions.  On top of this, you will need to set additional keywords like
16770 @code{:menu-entry} (to display the back-end in the export dispatcher),
16771 @code{:export-block} (to specify what blocks should not be exported by this
16772 back-end), and @code{:options-alist} (to let the user set export options that
16773 are specific to this back-end.)
16775 Deriving a new back-end is similar, except that you need to set
16776 @code{:translate-alist} to an alist of export functions that should be used
16777 instead of the parent back-end functions.
16779 For a complete reference documentation, see
16780 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
16781 Reference on Worg}.
16783 @node Context-sensitive commands, Tables in arbitrary syntax, Adding export back-ends, Hacking
16784 @section Context-sensitive commands
16785 @cindex context-sensitive commands, hooks
16786 @cindex add-ons, context-sensitive commands
16787 @vindex org-ctrl-c-ctrl-c-hook
16789 Org has several commands that act differently depending on context.  The most
16790 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
16791 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
16793 Add-ons can tap into this functionality by providing a function that detects
16794 special context for that add-on and executes functionality appropriate for
16795 the context.  Here is an example from Dan Davison's @file{org-R.el} which
16796 allows you to evaluate commands based on the @file{R} programming language
16797 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
16798 described in @ref{Working With Source Code} and is now obsolete.}.  For this
16799 package, special contexts are lines that start with @code{#+R:} or
16800 @code{#+RR:}.
16802 @lisp
16803 (defun org-R-apply-maybe ()
16804   "Detect if this is context for org-R and execute R commands."
16805   (if (save-excursion
16806         (beginning-of-line 1)
16807         (looking-at "#\\+RR?:"))
16808       (progn (call-interactively 'org-R-apply)
16809              t) ;; to signal that we took action
16810     nil)) ;; to signal that we did not
16812 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
16813 @end lisp
16815 The function first checks if the cursor is in such a line.  If that is the
16816 case, @code{org-R-apply} is called and the function returns @code{t} to
16817 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
16818 contexts.  If the function finds it should do nothing locally, it returns
16819 @code{nil} so that other, similar functions can have a try.
16822 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
16823 @section Tables and lists in arbitrary syntax
16824 @cindex tables, in other modes
16825 @cindex lists, in other modes
16826 @cindex Orgtbl mode
16828 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
16829 frequent feature request has been to make it work with native tables in
16830 specific languages, for example @LaTeX{}.  However, this is extremely
16831 hard to do in a general way, would lead to a customization nightmare,
16832 and would take away much of the simplicity of the Orgtbl mode table
16833 editor.
16835 This appendix describes a different approach.  We keep the Orgtbl mode
16836 table in its native format (the @i{source table}), and use a custom
16837 function to @i{translate} the table to the correct syntax, and to
16838 @i{install} it in the right location (the @i{target table}).  This puts
16839 the burden of writing conversion functions on the user, but it allows
16840 for a very flexible system.
16842 Bastien added the ability to do the same with lists, in Orgstruct mode.  You
16843 can use Org's facilities to edit and structure lists by turning
16844 @code{orgstruct-mode} on, then locally exporting such lists in another format
16845 (HTML, @LaTeX{} or Texinfo.)
16848 @menu
16849 * Radio tables::                Sending and receiving radio tables
16850 * A @LaTeX{} example::          Step by step, almost a tutorial
16851 * Translator functions::        Copy and modify
16852 * Radio lists::                 Sending and receiving lists
16853 @end menu
16855 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
16856 @subsection Radio tables
16857 @cindex radio tables
16859 To define the location of the target table, you first need to create two
16860 lines that are comments in the current mode, but contain magic words
16861 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find.  Orgtbl mode will
16862 insert the translated table between these lines, replacing whatever was there
16863 before.  For example in C mode where comments are between @code{/* ... */}:
16865 @example
16866 /* BEGIN RECEIVE ORGTBL table_name */
16867 /* END RECEIVE ORGTBL table_name */
16868 @end example
16870 @noindent
16871 Just above the source table, we put a special line that tells
16872 Orgtbl mode how to translate this table and where to install it.  For
16873 example:
16874 @cindex #+ORGTBL
16875 @example
16876 #+ORGTBL: SEND table_name translation_function arguments...
16877 @end example
16879 @noindent
16880 @code{table_name} is the reference name for the table that is also used
16881 in the receiver lines.  @code{translation_function} is the Lisp function
16882 that does the translation.  Furthermore, the line can contain a list of
16883 arguments (alternating key and value) at the end.  The arguments will be
16884 passed as a property list to the translation function for
16885 interpretation.  A few standard parameters are already recognized and
16886 acted upon before the translation function is called:
16888 @table @code
16889 @item :skip N
16890 Skip the first N lines of the table.  Hlines do count as separate lines for
16891 this parameter!
16893 @item :skipcols (n1 n2 ...)
16894 List of columns that should be skipped.  If the table has a column with
16895 calculation marks, that column is automatically discarded as well.
16896 Please note that the translator function sees the table @emph{after} the
16897 removal of these columns, the function never knows that there have been
16898 additional columns.
16900 @item :no-escape t
16901 When non-@code{nil}, do not escape special characters @code{&%#_^} when exporting
16902 the table.  The default value is @code{nil}.
16903 @end table
16905 @noindent
16906 The one problem remaining is how to keep the source table in the buffer
16907 without disturbing the normal workings of the file, for example during
16908 compilation of a C file or processing of a @LaTeX{} file.  There are a
16909 number of different solutions:
16911 @itemize @bullet
16912 @item
16913 The table could be placed in a block comment if that is supported by the
16914 language.  For example, in C mode you could wrap the table between
16915 @samp{/*} and @samp{*/} lines.
16916 @item
16917 Sometimes it is possible to put the table after some kind of @i{END}
16918 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
16919 in @LaTeX{}.
16920 @item
16921 You can just comment the table line-by-line whenever you want to process
16922 the file, and uncomment it whenever you need to edit the table.  This
16923 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
16924 makes this comment-toggling very easy, in particular if you bind it to a
16925 key.
16926 @end itemize
16928 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
16929 @subsection A @LaTeX{} example of radio tables
16930 @cindex @LaTeX{}, and Orgtbl mode
16932 The best way to wrap the source table in @LaTeX{} is to use the
16933 @code{comment} environment provided by @file{comment.sty}.  It has to be
16934 activated by placing @code{\usepackage@{comment@}} into the document
16935 header.  Orgtbl mode can insert a radio table skeleton@footnote{By
16936 default this works only for @LaTeX{}, HTML, and Texinfo.  Configure the
16937 variable @code{orgtbl-radio-table-templates} to install templates for other
16938 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table RET}.  You will
16939 be prompted for a table name, let's say we use @samp{salesfigures}.  You
16940 will then get the following template:
16942 @cindex #+ORGTBL, SEND
16943 @example
16944 % BEGIN RECEIVE ORGTBL salesfigures
16945 % END RECEIVE ORGTBL salesfigures
16946 \begin@{comment@}
16947 #+ORGTBL: SEND salesfigures orgtbl-to-latex
16948 | | |
16949 \end@{comment@}
16950 @end example
16952 @noindent
16953 @vindex @LaTeX{}-verbatim-environments
16954 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
16955 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
16956 into the receiver location with name @code{salesfigures}.  You may now
16957 fill in the table---feel free to use the spreadsheet features@footnote{If
16958 the @samp{#+TBLFM} line contains an odd number of dollar characters,
16959 this may cause problems with font-lock in @LaTeX{} mode.  As shown in the
16960 example you can fix this by adding an extra line inside the
16961 @code{comment} environment that is used to balance the dollar
16962 expressions.  If you are using AUC@TeX{} with the font-latex library, a
16963 much better solution is to add the @code{comment} environment to the
16964 variable @code{LaTeX-verbatim-environments}.}:
16966 @example
16967 % BEGIN RECEIVE ORGTBL salesfigures
16968 % END RECEIVE ORGTBL salesfigures
16969 \begin@{comment@}
16970 #+ORGTBL: SEND salesfigures orgtbl-to-latex
16971 | Month | Days | Nr sold | per day |
16972 |-------+------+---------+---------|
16973 | Jan   |   23 |      55 |     2.4 |
16974 | Feb   |   21 |      16 |     0.8 |
16975 | March |   22 |     278 |    12.6 |
16976 #+TBLFM: $4=$3/$2;%.1f
16977 % $ (optional extra dollar to keep font-lock happy, see footnote)
16978 \end@{comment@}
16979 @end example
16981 @noindent
16982 When you are done, press @kbd{C-c C-c} in the table to get the converted
16983 table inserted between the two marker lines.
16985 Now let's assume you want to make the table header by hand, because you
16986 want to control how columns are aligned, etc.  In this case we make sure
16987 that the table translator skips the first 2 lines of the source
16988 table, and tell the command to work as a @i{splice}, i.e., to not produce
16989 header and footer commands of the target table:
16991 @example
16992 \begin@{tabular@}@{lrrr@}
16993 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
16994 % BEGIN RECEIVE ORGTBL salesfigures
16995 % END RECEIVE ORGTBL salesfigures
16996 \end@{tabular@}
16998 \begin@{comment@}
16999 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
17000 | Month | Days | Nr sold | per day |
17001 |-------+------+---------+---------|
17002 | Jan   |   23 |      55 |     2.4 |
17003 | Feb   |   21 |      16 |     0.8 |
17004 | March |   22 |     278 |    12.6 |
17005 #+TBLFM: $4=$3/$2;%.1f
17006 \end@{comment@}
17007 @end example
17009 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
17010 Orgtbl mode.  It uses a @code{tabular} environment to typeset the table
17011 and marks horizontal lines with @code{\hline}.  Furthermore, it
17012 interprets the following parameters (see also @pxref{Translator functions}):
17014 @table @code
17015 @item :splice nil/t
17016 When set to t, return only table body lines, don't wrap them into a
17017 tabular environment.  Default is @code{nil}.
17019 @item :fmt fmt
17020 A format to be used to wrap each field, it should contain @code{%s} for the
17021 original field value.  For example, to wrap each field value in dollars,
17022 you could use @code{:fmt "$%s$"}.  This may also be a property list with
17023 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
17024 A function of one argument can be used in place of the strings; the
17025 function must return a formatted string.
17027 @item :efmt efmt
17028 Use this format to print numbers with exponentials.  The format should
17029 have @code{%s} twice for inserting mantissa and exponent, for example
17030 @code{"%s\\times10^@{%s@}"}.  The default is @code{"%s\\,(%s)"}.  This
17031 may also be a property list with column numbers and formats, for example
17032 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}.  After
17033 @code{efmt} has been applied to a value, @code{fmt} will also be
17034 applied.  Similar to @code{fmt}, functions of two arguments can be
17035 supplied instead of strings.
17036 @end table
17038 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
17039 @subsection Translator functions
17040 @cindex HTML, and Orgtbl mode
17041 @cindex translator function
17043 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
17044 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
17045 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
17046 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
17047 code that produces tables during HTML export.}, these all use a generic
17048 translator, @code{orgtbl-to-generic}.  For example, @code{orgtbl-to-latex}
17049 itself is a very short function that computes the column definitions for the
17050 @code{tabular} environment, defines a few field and line separators and then
17051 hands processing over to the generic translator.  Here is the entire code:
17053 @lisp
17054 @group
17055 (defun orgtbl-to-latex (table params)
17056   "Convert the Orgtbl mode TABLE to LaTeX."
17057   (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
17058                                org-table-last-alignment ""))
17059          (params2
17060           (list
17061            :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
17062            :tend "\\end@{tabular@}"
17063            :lstart "" :lend " \\\\" :sep " & "
17064            :efmt "%s\\,(%s)" :hline "\\hline")))
17065     (orgtbl-to-generic table (org-combine-plists params2 params))))
17066 @end group
17067 @end lisp
17069 As you can see, the properties passed into the function (variable
17070 @var{PARAMS}) are combined with the ones newly defined in the function
17071 (variable @var{PARAMS2}).  The ones passed into the function (i.e., the
17072 ones set by the @samp{ORGTBL SEND} line) take precedence.  So if you
17073 would like to use the @LaTeX{} translator, but wanted the line endings to
17074 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
17075 overrule the default with
17077 @example
17078 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
17079 @end example
17081 For a new language, you can either write your own converter function in
17082 analogy with the @LaTeX{} translator, or you can use the generic function
17083 directly.  For example, if you have a language where a table is started
17084 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
17085 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
17086 separator is a TAB, you could call the generic translator like this (on
17087 a single line!):
17089 @example
17090 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
17091                               :lstart "!BL! " :lend " !EL!" :sep "\t"
17092 @end example
17094 @noindent
17095 Please check the documentation string of the function
17096 @code{orgtbl-to-generic} for a full list of parameters understood by
17097 that function, and remember that you can pass each of them into
17098 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
17099 using the generic function.
17101 Of course you can also write a completely new function doing complicated
17102 things the generic translator cannot do.  A translator function takes
17103 two arguments.  The first argument is the table, a list of lines, each
17104 line either the symbol @code{hline} or a list of fields.  The second
17105 argument is the property list containing all parameters specified in the
17106 @samp{#+ORGTBL: SEND} line.  The function must return a single string
17107 containing the formatted table.  If you write a generally useful
17108 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
17109 others can benefit from your work.
17111 @node Radio lists,  , Translator functions, Tables in arbitrary syntax
17112 @subsection Radio lists
17113 @cindex radio lists
17114 @cindex org-list-insert-radio-list
17116 Sending and receiving radio lists works exactly the same way as sending and
17117 receiving radio tables (@pxref{Radio tables}).  As for radio tables, you can
17118 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
17119 @code{org-list-insert-radio-list}.
17121 Here are the differences with radio tables:
17123 @itemize @minus
17124 @item
17125 Orgstruct mode must be active.
17126 @item
17127 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
17128 @item
17129 The available translation functions for radio lists don't take
17130 parameters.
17131 @item
17132 @kbd{C-c C-c} will work when pressed on the first item of the list.
17133 @end itemize
17135 Here is a @LaTeX{} example.  Let's say that you have this in your
17136 @LaTeX{} file:
17138 @cindex #+ORGLST
17139 @example
17140 % BEGIN RECEIVE ORGLST to-buy
17141 % END RECEIVE ORGLST to-buy
17142 \begin@{comment@}
17143 #+ORGLST: SEND to-buy org-list-to-latex
17144 - a new house
17145 - a new computer
17146   + a new keyboard
17147   + a new mouse
17148 - a new life
17149 \end@{comment@}
17150 @end example
17152 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
17153 @LaTeX{} list between the two marker lines.
17155 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
17156 @section Dynamic blocks
17157 @cindex dynamic blocks
17159 Org documents can contain @emph{dynamic blocks}.  These are
17160 specially marked regions that are updated by some user-written function.
17161 A good example for such a block is the clock table inserted by the
17162 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
17164 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
17165 to the block and can also specify parameters for the function producing
17166 the content of the block.
17168 @cindex #+BEGIN:dynamic block
17169 @example
17170 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
17172 #+END:
17173 @end example
17175 Dynamic blocks are updated with the following commands
17177 @table @kbd
17178 @orgcmd{C-c C-x C-u,org-dblock-update}
17179 Update dynamic block at point.
17180 @orgkey{C-u C-c C-x C-u}
17181 Update all dynamic blocks in the current file.
17182 @end table
17184 Updating a dynamic block means to remove all the text between BEGIN and
17185 END, parse the BEGIN line for parameters and then call the specific
17186 writer function for this block to insert the new content.  If you want
17187 to use the original content in the writer function, you can use the
17188 extra parameter @code{:content}.
17190 For a block with name @code{myblock}, the writer function is
17191 @code{org-dblock-write:myblock} with as only parameter a property list
17192 with the parameters given in the begin line.  Here is a trivial example
17193 of a block that keeps track of when the block update function was last
17194 run:
17196 @example
17197 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
17199 #+END:
17200 @end example
17202 @noindent
17203 The corresponding block writer function could look like this:
17205 @lisp
17206 (defun org-dblock-write:block-update-time (params)
17207   (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
17208     (insert "Last block update at: "
17209             (format-time-string fmt (current-time)))))
17210 @end lisp
17212 If you want to make sure that all dynamic blocks are always up-to-date,
17213 you could add the function @code{org-update-all-dblocks} to a hook, for
17214 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
17215 written in a way such that it does nothing in buffers that are not in
17216 @code{org-mode}.
17218 You can narrow the current buffer to the current dynamic block (like any
17219 other block) with @code{org-narrow-to-block}.
17221 @node Special agenda views, Speeding up your agendas, Dynamic blocks, Hacking
17222 @section Special agenda views
17223 @cindex agenda views, user-defined
17225 @vindex org-agenda-skip-function
17226 @vindex org-agenda-skip-function-global
17227 Org provides a special hook that can be used to narrow down the selection
17228 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
17229 @code{agenda*} view is the same than @code{agenda} except that it only
17230 considers @emph{appointments}, i.e., scheduled and deadline items that have a
17231 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
17232 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}.  You may
17233 specify a function that is used at each match to verify if the match should
17234 indeed be part of the agenda view, and if not, how much should be skipped.
17235 You can specify a global condition that will be applied to all agenda views,
17236 this condition would be stored in the variable
17237 @code{org-agenda-skip-function-global}.  More commonly, such a definition is
17238 applied only to specific custom searches, using
17239 @code{org-agenda-skip-function}.
17241 Let's say you want to produce a list of projects that contain a WAITING
17242 tag anywhere in the project tree.  Let's further assume that you have
17243 marked all tree headings that define a project with the TODO keyword
17244 PROJECT@.  In this case you would run a TODO search for the keyword
17245 PROJECT, but skip the match unless there is a WAITING tag anywhere in
17246 the subtree belonging to the project line.
17248 To achieve this, you must write a function that searches the subtree for
17249 the tag.  If the tag is found, the function must return @code{nil} to
17250 indicate that this match should not be skipped.  If there is no such
17251 tag, return the location of the end of the subtree, to indicate that
17252 search should continue from there.
17254 @lisp
17255 (defun my-skip-unless-waiting ()
17256   "Skip trees that are not waiting"
17257   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
17258     (if (re-search-forward ":waiting:" subtree-end t)
17259         nil          ; tag found, do not skip
17260       subtree-end))) ; tag not found, continue after end of subtree
17261 @end lisp
17263 Now you may use this function in an agenda custom command, for example
17264 like this:
17266 @lisp
17267 (org-add-agenda-custom-command
17268  '("b" todo "PROJECT"
17269    ((org-agenda-skip-function 'my-skip-unless-waiting)
17270     (org-agenda-overriding-header "Projects waiting for something: "))))
17271 @end lisp
17273 @vindex org-agenda-overriding-header
17274 Note that this also binds @code{org-agenda-overriding-header} to get a
17275 meaningful header in the agenda view.
17277 @vindex org-odd-levels-only
17278 @vindex org-agenda-skip-function
17279 A general way to create custom searches is to base them on a search for
17280 entries with a certain level limit.  If you want to study all entries with
17281 your custom search function, simply do a search for
17282 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
17283 level number corresponds to order in the hierarchy, not to the number of
17284 stars.}, and then use @code{org-agenda-skip-function} to select the entries
17285 you really want to have.
17287 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
17288 particular, you may use the functions @code{org-agenda-skip-entry-if}
17289 and @code{org-agenda-skip-subtree-if} in this form, for example:
17291 @table @code
17292 @item (org-agenda-skip-entry-if 'scheduled)
17293 Skip current entry if it has been scheduled.
17294 @item (org-agenda-skip-entry-if 'notscheduled)
17295 Skip current entry if it has not been scheduled.
17296 @item (org-agenda-skip-entry-if 'deadline)
17297 Skip current entry if it has a deadline.
17298 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
17299 Skip current entry if it has a deadline, or if it is scheduled.
17300 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
17301 Skip current entry if the TODO keyword is TODO or WAITING.
17302 @item (org-agenda-skip-entry-if 'todo 'done)
17303 Skip current entry if the TODO keyword marks a DONE state.
17304 @item (org-agenda-skip-entry-if 'timestamp)
17305 Skip current entry if it has any timestamp, may also be deadline or scheduled.
17306 @anchor{x-agenda-skip-entry-regexp}
17307 @item (org-agenda-skip-entry-if 'regexp "regular expression")
17308 Skip current entry if the regular expression matches in the entry.
17309 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
17310 Skip current entry unless the regular expression matches.
17311 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
17312 Same as above, but check and skip the entire subtree.
17313 @end table
17315 Therefore we could also have written the search for WAITING projects
17316 like this, even without defining a special function:
17318 @lisp
17319 (org-add-agenda-custom-command
17320  '("b" todo "PROJECT"
17321    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
17322                                 'regexp ":waiting:"))
17323     (org-agenda-overriding-header "Projects waiting for something: "))))
17324 @end lisp
17326 @node Speeding up your agendas, Extracting agenda information, Special agenda views, Hacking
17327 @section Speeding up your agendas
17328 @cindex agenda views, optimization
17330 When your Org files grow in both number and size, agenda commands may start
17331 to become slow.  Below are some tips on how to speed up the agenda commands.
17333 @enumerate
17334 @item
17335 Reduce the number of Org agenda files: this will reduce the slowness caused
17336 by accessing a hard drive.
17337 @item
17338 Reduce the number of DONE and archived headlines: this way the agenda does
17339 not need to skip them.
17340 @item
17341 @vindex org-agenda-dim-blocked-tasks
17342 Inhibit the dimming of blocked tasks:
17343 @lisp
17344 (setq org-agenda-dim-blocked-tasks nil)
17345 @end lisp
17346 @item
17347 @vindex org-startup-folded
17348 @vindex org-agenda-inhibit-startup
17349 Inhibit agenda files startup options:
17350 @lisp
17351 (setq org-agenda-inhibit-startup nil)
17352 @end lisp
17353 @item
17354 @vindex org-agenda-show-inherited-tags
17355 @vindex org-agenda-use-tag-inheritance
17356 Disable tag inheritance in agenda:
17357 @lisp
17358 (setq org-agenda-use-tag-inheritance nil)
17359 @end lisp
17360 @end enumerate
17362 You can set these options for specific agenda views only.  See the docstrings
17363 of these variables for details on why they affect the agenda generation, and
17364 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
17365 page} for further explanations.
17367 @node Extracting agenda information, Using the property API, Speeding up your agendas, Hacking
17368 @section Extracting agenda information
17369 @cindex agenda, pipe
17370 @cindex Scripts, for agenda processing
17372 @vindex org-agenda-custom-commands
17373 Org provides commands to access agenda information for the command
17374 line in Emacs batch mode.  This extracted information can be sent
17375 directly to a printer, or it can be read by a program that does further
17376 processing of the data.  The first of these commands is the function
17377 @code{org-batch-agenda}, that produces an agenda view and sends it as
17378 ASCII text to STDOUT@.  The command takes a single string as parameter.
17379 If the string has length 1, it is used as a key to one of the commands
17380 you have configured in @code{org-agenda-custom-commands}, basically any
17381 key you can use after @kbd{C-c a}.  For example, to directly print the
17382 current TODO list, you could use
17384 @example
17385 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
17386 @end example
17388 If the parameter is a string with 2 or more characters, it is used as a
17389 tags/TODO match string.  For example, to print your local shopping list
17390 (all items with the tag @samp{shop}, but excluding the tag
17391 @samp{NewYork}), you could use
17393 @example
17394 emacs -batch -l ~/.emacs                                      \
17395       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
17396 @end example
17398 @noindent
17399 You may also modify parameters on the fly like this:
17401 @example
17402 emacs -batch -l ~/.emacs                                      \
17403    -eval '(org-batch-agenda "a"                               \
17404             org-agenda-span (quote month)                     \
17405             org-agenda-include-diary nil                      \
17406             org-agenda-files (quote ("~/org/project.org")))'  \
17407    | lpr
17408 @end example
17410 @noindent
17411 which will produce a 30-day agenda, fully restricted to the Org file
17412 @file{~/org/projects.org}, not even including the diary.
17414 If you want to process the agenda data in more sophisticated ways, you
17415 can use the command @code{org-batch-agenda-csv} to get a comma-separated
17416 list of values for each agenda item.  Each line in the output will
17417 contain a number of fields separated by commas.  The fields in a line
17418 are:
17420 @example
17421 category     @r{The category of the item}
17422 head         @r{The headline, without TODO keyword, TAGS and PRIORITY}
17423 type         @r{The type of the agenda entry, can be}
17424                 todo               @r{selected in TODO match}
17425                 tagsmatch          @r{selected in tags match}
17426                 diary              @r{imported from diary}
17427                 deadline           @r{a deadline}
17428                 scheduled          @r{scheduled}
17429                 timestamp          @r{appointment, selected by timestamp}
17430                 closed             @r{entry was closed on date}
17431                 upcoming-deadline  @r{warning about nearing deadline}
17432                 past-scheduled     @r{forwarded scheduled item}
17433                 block              @r{entry has date block including date}
17434 todo         @r{The TODO keyword, if any}
17435 tags         @r{All tags including inherited ones, separated by colons}
17436 date         @r{The relevant date, like 2007-2-14}
17437 time         @r{The time, like 15:00-16:50}
17438 extra        @r{String with extra planning info}
17439 priority-l   @r{The priority letter if any was given}
17440 priority-n   @r{The computed numerical priority}
17441 @end example
17443 @noindent
17444 Time and date will only be given if a timestamp (or deadline/scheduled)
17445 led to the selection of the item.
17447 A CSV list like this is very easy to use in a post-processing script.
17448 For example, here is a Perl program that gets the TODO list from
17449 Emacs/Org and prints all the items, preceded by a checkbox:
17451 @example
17452 #!/usr/bin/perl
17454 # define the Emacs command to run
17455 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
17457 # run it and capture the output
17458 $agenda = qx@{$cmd 2>/dev/null@};
17460 # loop over all lines
17461 foreach $line (split(/\n/,$agenda)) @{
17462   # get the individual values
17463   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
17464    $priority_l,$priority_n) = split(/,/,$line);
17465   # process and print
17466   print "[ ] $head\n";
17468 @end example
17470 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
17471 @section Using the property API
17472 @cindex API, for properties
17473 @cindex properties, API
17475 Here is a description of the functions that can be used to work with
17476 properties.
17478 @defun org-entry-properties &optional pom which
17479 Get all properties of the entry at point-or-marker POM.@*
17480 This includes the TODO keyword, the tags, time strings for deadline,
17481 scheduled, and clocking, and any additional properties defined in the
17482 entry.  The return value is an alist.  Keys may occur multiple times
17483 if the property key was used several times.@*
17484 POM may also be @code{nil}, in which case the current entry is used.
17485 If WHICH is @code{nil} or `all', get all properties.  If WHICH is
17486 `special' or `standard', only get that subclass.
17487 @end defun
17488 @vindex org-use-property-inheritance
17489 @findex org-insert-property-drawer
17490 @defun org-entry-get pom property &optional inherit
17491 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@.  By default,
17492 this only looks at properties defined locally in the entry.  If @code{INHERIT}
17493 is non-@code{nil} and the entry does not have the property, then also check
17494 higher levels of the hierarchy.  If @code{INHERIT} is the symbol
17495 @code{selective}, use inheritance if and only if the setting of
17496 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
17497 @end defun
17499 @defun org-entry-delete pom property
17500 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
17501 @end defun
17503 @defun org-entry-put pom property value
17504 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
17505 @end defun
17507 @defun org-buffer-property-keys &optional include-specials
17508 Get all property keys in the current buffer.
17509 @end defun
17511 @defun org-insert-property-drawer
17512 Insert a property drawer for the current entry.  Also
17513 @end defun
17515 @defun org-entry-put-multivalued-property pom property &rest values
17516 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
17517 @code{VALUES} should be a list of strings.  They will be concatenated, with
17518 spaces as separators.
17519 @end defun
17521 @defun org-entry-get-multivalued-property pom property
17522 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17523 list of values and return the values as a list of strings.
17524 @end defun
17526 @defun org-entry-add-to-multivalued-property pom property value
17527 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17528 list of values and make sure that @code{VALUE} is in this list.
17529 @end defun
17531 @defun org-entry-remove-from-multivalued-property pom property value
17532 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17533 list of values and make sure that @code{VALUE} is @emph{not} in this list.
17534 @end defun
17536 @defun org-entry-member-in-multivalued-property pom property value
17537 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17538 list of values and check if @code{VALUE} is in this list.
17539 @end defun
17541 @defopt org-property-allowed-value-functions
17542 Hook for functions supplying allowed values for a specific property.
17543 The functions must take a single argument, the name of the property, and
17544 return a flat list of allowed values.  If @samp{:ETC} is one of
17545 the values, use the values as completion help, but allow also other values
17546 to be entered.  The functions must return @code{nil} if they are not
17547 responsible for this property.
17548 @end defopt
17550 @node Using the mapping API,  , Using the property API, Hacking
17551 @section Using the mapping API
17552 @cindex API, for mapping
17553 @cindex mapping entries, API
17555 Org has sophisticated mapping capabilities to find all entries satisfying
17556 certain criteria.  Internally, this functionality is used to produce agenda
17557 views, but there is also an API that can be used to execute arbitrary
17558 functions for each or selected entries.  The main entry point for this API
17561 @defun org-map-entries func &optional match scope &rest skip
17562 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
17564 @code{FUNC} is a function or a Lisp form.  The function will be called
17565 without arguments, with the cursor positioned at the beginning of the
17566 headline.  The return values of all calls to the function will be collected
17567 and returned as a list.
17569 The call to @code{FUNC} will be wrapped into a save-excursion form, so
17570 @code{FUNC} does not need to preserve point.  After evaluation, the cursor
17571 will be moved to the end of the line (presumably of the headline of the
17572 processed entry) and search continues from there.  Under some circumstances,
17573 this may not produce the wanted results.  For example, if you have removed
17574 (e.g., archived) the current (sub)tree it could mean that the next entry will
17575 be skipped entirely.  In such cases, you can specify the position from where
17576 search should continue by making @code{FUNC} set the variable
17577 @code{org-map-continue-from} to the desired buffer position.
17579 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
17580 view.  Only headlines that are matched by this query will be considered
17581 during the iteration.  When @code{MATCH} is @code{nil} or @code{t}, all
17582 headlines will be visited by the iteration.
17584 @code{SCOPE} determines the scope of this command.  It can be any of:
17586 @example
17587 nil     @r{the current buffer, respecting the restriction if any}
17588 tree    @r{the subtree started with the entry at point}
17589 region  @r{The entries within the active region, if any}
17590 file    @r{the current buffer, without restriction}
17591 file-with-archives
17592         @r{the current buffer, and any archives associated with it}
17593 agenda  @r{all agenda files}
17594 agenda-with-archives
17595         @r{all agenda files with any archive files associated with them}
17596 (file1 file2 ...)
17597         @r{if this is a list, all files in the list will be scanned}
17598 @end example
17599 @noindent
17600 The remaining args are treated as settings for the skipping facilities of
17601 the scanner.  The following items can be given here:
17603 @vindex org-agenda-skip-function
17604 @example
17605 archive   @r{skip trees with the archive tag}
17606 comment   @r{skip trees with the COMMENT keyword}
17607 function or Lisp form
17608           @r{will be used as value for @code{org-agenda-skip-function},}
17609           @r{so whenever the function returns t, FUNC}
17610           @r{will not be called for that entry and search will}
17611           @r{continue from the point where the function leaves it}
17612 @end example
17613 @end defun
17615 The function given to that mapping routine can really do anything you like.
17616 It can use the property API (@pxref{Using the property API}) to gather more
17617 information about the entry, or in order to change metadata in the entry.
17618 Here are a couple of functions that might be handy:
17620 @defun org-todo &optional arg
17621 Change the TODO state of the entry.  See the docstring of the functions for
17622 the many possible values for the argument @code{ARG}.
17623 @end defun
17625 @defun org-priority &optional action
17626 Change the priority of the entry.  See the docstring of this function for the
17627 possible values for @code{ACTION}.
17628 @end defun
17630 @defun org-toggle-tag tag &optional onoff
17631 Toggle the tag @code{TAG} in the current entry.  Setting @code{ONOFF} to
17632 either @code{on} or @code{off} will not toggle tag, but ensure that it is
17633 either on or off.
17634 @end defun
17636 @defun org-promote
17637 Promote the current entry.
17638 @end defun
17640 @defun org-demote
17641 Demote the current entry.
17642 @end defun
17644 Here is a simple example that will turn all entries in the current file with
17645 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
17646 Entries in comment trees and in archive trees will be ignored.
17648 @lisp
17649 (org-map-entries
17650  '(org-todo "UPCOMING")
17651  "+TOMORROW" 'file 'archive 'comment)
17652 @end lisp
17654 The following example counts the number of entries with TODO keyword
17655 @code{WAITING}, in all agenda files.
17657 @lisp
17658 (length (org-map-entries t "/+WAITING" 'agenda))
17659 @end lisp
17661 @node MobileOrg, History and Acknowledgments, Hacking, Top
17662 @appendix MobileOrg
17663 @cindex iPhone
17664 @cindex MobileOrg
17666 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
17667 available for iOS and for Android.  @i{MobileOrg} offers offline viewing and
17668 capture support for an Org mode system rooted on a ``real'' computer.  It
17669 does also allow you to record changes to existing entries.  The
17670 @uref{https://github.com/MobileOrg/, iOS implementation} for the
17671 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
17672 and is now in the hands Sean Escriva.  Android users should check out
17673 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
17674 by Matt Jones.  The two implementations are not identical but offer similar
17675 features.
17677 This appendix describes the support Org has for creating agenda views in a
17678 format that can be displayed by @i{MobileOrg}, and for integrating notes
17679 captured and changes made by @i{MobileOrg} into the main system.
17681 For changing tags and TODO states in MobileOrg, you should have set up the
17682 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
17683 cover all important tags and TODO keywords, even if individual files use only
17684 part of these.  MobileOrg will also offer you states and tags set up with
17685 in-buffer settings, but it will understand the logistics of TODO state
17686 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
17687 (@pxref{Setting tags}) only for those set in these variables.
17689 @menu
17690 * Setting up the staging area::  Where to interact with the mobile device
17691 * Pushing to MobileOrg::        Uploading Org files and agendas
17692 * Pulling from MobileOrg::      Integrating captured and flagged items
17693 @end menu
17695 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
17696 @section Setting up the staging area
17698 MobileOrg needs to interact with Emacs through a directory on a server.  If you
17699 are using a public server, you should consider to encrypt the files that are
17700 uploaded to the server.  This can be done with Org mode 7.02 and with
17701 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
17702 installation on your system.  To turn on encryption, set a password in
17703 @i{MobileOrg} and, on the Emacs side, configure the variable
17704 @code{org-mobile-use-encryption}@footnote{If you can safely store the
17705 password in your Emacs setup, you might also want to configure
17706 @code{org-mobile-encryption-password}.  Please read the docstring of that
17707 variable.  Note that encryption will apply only to the contents of the
17708 @file{.org} files.  The file names themselves will remain visible.}.
17710 The easiest way to create that directory is to use a free
17711 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
17712 Dropbox, or if your version of MobileOrg does not support it, you can use a
17713 webdav server.  For more information, check out the documentation of MobileOrg and also this
17714 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
17715 When MobileOrg first connects to your Dropbox, it will create a directory
17716 @i{MobileOrg} inside the Dropbox.  After the directory has been created, tell
17717 Emacs about it:
17719 @lisp
17720 (setq org-mobile-directory "~/Dropbox/MobileOrg")
17721 @end lisp
17723 Org mode has commands to put files for @i{MobileOrg} into that directory,
17724 and to read captured notes from there.
17726 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
17727 @section Pushing to MobileOrg
17729 This operation copies all files currently listed in @code{org-mobile-files}
17730 to the directory @code{org-mobile-directory}.  By default this list contains
17731 all agenda files (as listed in @code{org-agenda-files}), but additional files
17732 can be included by customizing @code{org-mobile-files}.  File names will be
17733 staged with paths relative to @code{org-directory}, so all files should be
17734 inside this directory@footnote{Symbolic links in @code{org-directory} need to
17735 have the same name than their targets.}.
17737 The push operation also creates a special Org file @file{agendas.org} with
17738 all custom agenda view defined by the user@footnote{While creating the
17739 agendas, Org mode will force ID properties on all referenced entries, so that
17740 these entries can be uniquely identified if @i{MobileOrg} flags them for
17741 further action.  If you do not want to get these properties in so many
17742 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
17743 to @code{nil}.  Org mode will then rely on outline paths, in the hope that
17744 these will be unique enough.}.
17746 Finally, Org writes the file @file{index.org}, containing links to all other
17747 files.  @i{MobileOrg} first reads this file from the server, and then
17748 downloads all agendas and Org files listed in it.  To speed up the download,
17749 MobileOrg will only read files whose checksums@footnote{Checksums are stored
17750 automatically in the file @file{checksums.dat}} have changed.
17752 @node Pulling from MobileOrg,  , Pushing to MobileOrg, MobileOrg
17753 @section Pulling from MobileOrg
17755 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
17756 files for viewing.  It also appends captured entries and pointers to flagged
17757 and changed entries to the file @file{mobileorg.org} on the server.  Org has
17758 a @emph{pull} operation that integrates this information into an inbox file
17759 and operates on the pointers to flagged entries.  Here is how it works:
17761 @enumerate
17762 @item
17763 Org moves all entries found in
17764 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
17765 operation.} and appends them to the file pointed to by the variable
17766 @code{org-mobile-inbox-for-pull}.  Each captured entry and each editing event
17767 will be a top-level entry in the inbox file.
17768 @item
17769 After moving the entries, Org will attempt to implement the changes made in
17770 @i{MobileOrg}.  Some changes are applied directly and without user
17771 interaction.  Examples are all changes to tags, TODO state, headline and body
17772 text that can be cleanly applied.  Entries that have been flagged for further
17773 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
17774 again.  When there is a problem finding an entry or applying the change, the
17775 pointer entry will remain in the inbox and will be marked with an error
17776 message.  You need to later resolve these issues by hand.
17777 @item
17778 Org will then generate an agenda view with all flagged entries.  The user
17779 should then go through these entries and do whatever actions are necessary.
17780 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
17781 will be displayed in the echo area when the cursor is on the corresponding
17782 agenda line.
17784 @table @kbd
17785 @kindex ?
17786 @item ?
17787 Pressing @kbd{?} in that special agenda will display the full flagging note in
17788 another window and also push it onto the kill ring.  So you could use @kbd{?
17789 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
17790 Pressing @kbd{?} twice in succession will offer to remove the
17791 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
17792 in a property).  In this way you indicate that the intended processing for
17793 this flagged entry is finished.
17794 @end table
17795 @end enumerate
17797 @kindex C-c a ?
17798 If you are not able to process all flagged entries directly, you can always
17799 return to this agenda view@footnote{Note, however, that there is a subtle
17800 difference.  The view created automatically by @kbd{M-x org-mobile-pull RET}
17801 is guaranteed to search all files that have been addressed by the last pull.
17802 This might include a file that is not currently in your list of agenda files.
17803 If you later use @kbd{C-c a ?} to regenerate the view, only the current
17804 agenda files will be searched.} using @kbd{C-c a ?}.
17806 @node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top
17807 @appendix History and acknowledgments
17808 @cindex acknowledgments
17809 @cindex history
17810 @cindex thanks
17812 @section From Carsten
17814 Org was born in 2003, out of frustration over the user interface of the Emacs
17815 Outline mode.  I was trying to organize my notes and projects, and using
17816 Emacs seemed to be the natural way to go.  However, having to remember eleven
17817 different commands with two or three keys per command, only to hide and show
17818 parts of the outline tree, that seemed entirely unacceptable to me.  Also,
17819 when using outlines to take notes, I constantly wanted to restructure the
17820 tree, organizing it parallel to my thoughts and plans.  @emph{Visibility
17821 cycling} and @emph{structure editing} were originally implemented in the
17822 package @file{outline-magic.el}, but quickly moved to the more general
17823 @file{org.el}.  As this environment became comfortable for project planning,
17824 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
17825 @emph{table support}.  These areas highlighted the two main goals that Org
17826 still has today: to be a new, outline-based, plain text mode with innovative
17827 and intuitive editing features, and to incorporate project planning
17828 functionality directly into a notes file.
17830 Since the first release, literally thousands of emails to me or to
17831 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
17832 reports, feedback, new ideas, and sometimes patches and add-on code.
17833 Many thanks to everyone who has helped to improve this package.  I am
17834 trying to keep here a list of the people who had significant influence
17835 in shaping one or more aspects of Org.  The list may not be
17836 complete, if I have forgotten someone, please accept my apologies and
17837 let me know.
17839 Before I get to this list, a few special mentions are in order:
17841 @table @i
17842 @item Bastien Guerry
17843 Bastien has written a large number of extensions to Org (most of them
17844 integrated into the core by now), including the @LaTeX{} exporter and the plain
17845 list parser.  His support during the early days, when he basically acted as
17846 co-maintainer, was central to the success of this project.  Bastien also
17847 invented Worg, helped establishing the Web presence of Org, and sponsored
17848 hosting costs for the orgmode.org website.
17849 @item Eric Schulte and Dan Davison
17850 Eric and Dan are jointly responsible for the Org-babel system, which turns
17851 Org into a multi-language environment for evaluating code and doing literate
17852 programming and reproducible research.
17853 @item John Wiegley
17854 John has contributed a number of great ideas and patches directly to Org,
17855 including the attachment system (@file{org-attach.el}), integration with
17856 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
17857 items, habit tracking (@file{org-habits.el}), and encryption
17858 (@file{org-crypt.el}).  Also, the capture system is really an extended copy
17859 of his great @file{remember.el}.
17860 @item Sebastian Rose
17861 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
17862 of an ignorant amateur.  Sebastian has pushed this part of Org onto a much
17863 higher level.  He also wrote @file{org-info.js}, a Java script for displaying
17864 web pages derived from Org using an Info-like or a folding interface with
17865 single-key navigation.
17866 @end table
17868 @noindent See below for the full list of contributions!  Again, please
17869 let me know what I am missing here!
17871 @section From Bastien
17873 I (Bastien) have been maintaining Org since January 2011.  This appendix
17874 would not be complete without adding a few more acknowledgements and thanks
17875 to Carsten's ones above.
17877 I am first grateful to Carsten for his trust while handing me over the
17878 maintainership of Org.  His unremitting support is what really helped me
17879 getting more confident over time, with both the community and the code.
17881 When I took over maintainership, I knew I would have to make Org more
17882 collaborative than ever, as I would have to rely on people that are more
17883 knowledgeable than I am on many parts of the code.  Here is a list of the
17884 persons I could rely on, they should really be considered co-maintainers,
17885 either of the code or the community:
17887 @table @i
17888 @item Eric Schulte
17889 Eric is maintaining the Babel parts of Org.  His reactivity here kept me away
17890 from worrying about possible bugs here and let me focus on other parts.
17892 @item Nicolas Goaziou
17893 Nicolas is maintaining the consistency of the deepest parts of Org.  His
17894 work on @file{org-element.el} and @file{ox.el} has been outstanding, and
17895 opened the doors for many new ideas and features.  He rewrote many of the
17896 old exporters to use the new export engine, and helped with documenting
17897 this major change.  More importantly (if that's possible), he has been more
17898 than reliable during all the work done for Org 8.0, and always very
17899 reactive on the mailing list.
17901 @item Achim Gratz
17902 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
17903 into a flexible and conceptually clean process.  He patiently coped with the
17904 many hiccups that such a change can create for users.
17906 @item Nick Dokos
17907 The Org mode mailing list would not be such a nice place without Nick, who
17908 patiently helped users so many times.  It is impossible to overestimate such
17909 a great help, and the list would not be so active without him.
17910 @end table
17912 I received support from so many users that it is clearly impossible to be
17913 fair when shortlisting a few of them, but Org's history would not be
17914 complete if the ones above were not mentioned in this manual.
17916 @section List of contributions
17918 @itemize @bullet
17920 @item
17921 @i{Russel Adams} came up with the idea for drawers.
17922 @item
17923 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
17924 feedback on many features and several patches.
17925 @item
17926 @i{Luis Anaya} wrote @file{ox-man.el}.
17927 @item
17928 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
17929 @item
17930 @i{Michael Brand} helped by reporting many bugs and testing many features.
17931 He also implemented the distinction between empty fields and 0-value fields
17932 in Org's spreadsheets.
17933 @item
17934 @i{Christophe Bataillon} created the great unicorn logo that we use on the
17935 Org mode website.
17936 @item
17937 @i{Alex Bochannek} provided a patch for rounding timestamps.
17938 @item
17939 @i{Jan Böcker} wrote @file{org-docview.el}.
17940 @item
17941 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
17942 @item
17943 @i{Tom Breton} wrote @file{org-choose.el}.
17944 @item
17945 @i{Charles Cave}'s suggestion sparked the implementation of templates
17946 for Remember, which are now templates for capture.
17947 @item
17948 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
17949 specified time.
17950 @item
17951 @i{Gregory Chernov} patched support for Lisp forms into table
17952 calculations and improved XEmacs compatibility, in particular by porting
17953 @file{nouline.el} to XEmacs.
17954 @item
17955 @i{Sacha Chua} suggested copying some linking code from Planner.
17956 @item
17957 @i{Toby S. Cubitt} contributed to the code for clock formats.
17958 @item
17959 @i{Baoqiu Cui} contributed the DocBook exporter.  It has been deleted from
17960 Org 8.0: you can now export to Texinfo and export the @file{.texi} file to
17961 DocBook using @code{makeinfo}.
17962 @item
17963 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
17964 came up with the idea of properties, and that there should be an API for
17965 them.
17966 @item
17967 @i{Nick Dokos} tracked down several nasty bugs.
17968 @item
17969 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
17970 inspired some of the early development, including HTML export.  He also
17971 asked for a way to narrow wide table columns.
17972 @item
17973 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
17974 several years now.  He also sponsored the hosting costs until Rackspace
17975 started to host us for free.
17976 @item
17977 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
17978 the Org-Babel documentation into the manual.
17979 @item
17980 @i{Christian Egli} converted the documentation into Texinfo format, inspired
17981 the agenda, patched CSS formatting into the HTML exporter, and wrote
17982 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
17983 @file{ox-taskjuggler.el} for Org 8.0.
17984 @item
17985 @i{David Emery} provided a patch for custom CSS support in exported
17986 HTML agendas.
17987 @item
17988 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
17989 @item
17990 @i{Nic Ferrier} contributed mailcap and XOXO support.
17991 @item
17992 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
17993 @item
17994 @i{John Foerch} figured out how to make incremental search show context
17995 around a match in a hidden outline tree.
17996 @item
17997 @i{Raimar Finken} wrote @file{org-git-line.el}.
17998 @item
17999 @i{Mikael Fornius} works as a mailing list moderator.
18000 @item
18001 @i{Austin Frank} works as a mailing list moderator.
18002 @item
18003 @i{Eric Fraga} drove the development of BEAMER export with ideas and
18004 testing.
18005 @item
18006 @i{Barry Gidden} did proofreading the manual in preparation for the book
18007 publication through Network Theory Ltd.
18008 @item
18009 @i{Niels Giesen} had the idea to automatically archive DONE trees.
18010 @item
18011 @i{Nicolas Goaziou} rewrote much of the plain list code.  He also wrote
18012 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
18013 in implementing a clean framework for Org exporters.
18014 @item
18015 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
18016 @item
18017 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
18018 book.
18019 @item
18020 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
18021 task state change logging, and the clocktable.  His clear explanations have
18022 been critical when we started to adopt the Git version control system.
18023 @item
18024 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
18025 patches.
18026 @item
18027 @i{Phil Jackson} wrote @file{org-irc.el}.
18028 @item
18029 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
18030 folded entries, and column view for properties.
18031 @item
18032 @i{Matt Jones} wrote @i{MobileOrg Android}.
18033 @item
18034 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
18035 @item
18036 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
18037 @item
18038 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it.  He also
18039 provided frequent feedback and some patches.
18040 @item
18041 @i{Matt Lundin} has proposed last-row references for table formulas and named
18042 invisible anchors.  He has also worked a lot on the FAQ.
18043 @item
18044 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
18045 and is a prolific contributor on the mailing list with competent replies,
18046 small fixes and patches.
18047 @item
18048 @i{Jason F. McBrayer} suggested agenda export to CSV format.
18049 @item
18050 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
18051 @item
18052 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
18053 basis.
18054 @item
18055 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
18056 happy.
18057 @item
18058 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
18059 @item
18060 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
18061 and being able to quickly restrict the agenda to a subtree.
18062 @item
18063 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
18064 @item
18065 @i{Greg Newman} refreshed the unicorn logo into its current form.
18066 @item
18067 @i{Tim O'Callaghan} suggested in-file links, search options for general
18068 file links, and TAGS.
18069 @item
18070 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
18071 version of the reference card.
18072 @item
18073 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
18074 into Japanese.
18075 @item
18076 @i{Oliver Oppitz} suggested multi-state TODO items.
18077 @item
18078 @i{Scott Otterson} sparked the introduction of descriptive text for
18079 links, among other things.
18080 @item
18081 @i{Pete Phillips} helped during the development of the TAGS feature, and
18082 provided frequent feedback.
18083 @item
18084 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
18085 generation.
18086 @item
18087 @i{Martin Pohlack} provided the code snippet to bundle character insertion
18088 into bundles of 20 for undo.
18089 @item
18090 @i{Rackspace.com} is hosting our website for free.  Thank you Rackspace!
18091 @item
18092 @i{T.V. Raman} reported bugs and suggested improvements.
18093 @item
18094 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
18095 control.
18096 @item
18097 @i{Paul Rivier} provided the basic implementation of named footnotes.  He
18098 also acted as mailing list moderator for some time.
18099 @item
18100 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
18101 @item
18102 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
18103 conflict with @file{allout.el}.
18104 @item
18105 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
18106 extensive patches.
18107 @item
18108 @i{Philip Rooke} created the Org reference card, provided lots
18109 of feedback, developed and applied standards to the Org documentation.
18110 @item
18111 @i{Christian Schlauer} proposed angular brackets around links, among
18112 other things.
18113 @item
18114 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
18115 enjoy folding in non-org buffers by using Org headlines in comments.
18116 @item
18117 @i{Paul Sexton} wrote @file{org-ctags.el}.
18118 @item
18119 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
18120 @file{organizer-mode.el}.
18121 @item
18122 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
18123 examples, and remote highlighting for referenced code lines.
18124 @item
18125 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
18126 now packaged into Org's @file{contrib} directory.
18127 @item
18128 @i{Daniel Sinder} came up with the idea of internal archiving by locking
18129 subtrees.
18130 @item
18131 @i{Dale Smith} proposed link abbreviations.
18132 @item
18133 @i{James TD Smith} has contributed a large number of patches for useful
18134 tweaks and features.
18135 @item
18136 @i{Adam Spiers} asked for global linking commands, inspired the link
18137 extension system, added support for mairix, and proposed the mapping API.
18138 @item
18139 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
18140 @LaTeX{}, UTF-8, Latin-1 and ASCII.
18141 @item
18142 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
18143 with links transformation to Org syntax.
18144 @item
18145 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
18146 chapter about publishing.
18147 @item
18148 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
18149 @item
18150 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
18151 enabled source code highlighting in Gnus.
18152 @item
18153 @i{Stefan Vollmar} organized a video-recorded talk at the
18154 Max-Planck-Institute for Neurology.  He also inspired the creation of a
18155 concept index for HTML export.
18156 @item
18157 @i{J@"urgen Vollmer} contributed code generating the table of contents
18158 in HTML output.
18159 @item
18160 @i{Samuel Wales} has provided important feedback and bug reports.
18161 @item
18162 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
18163 keyword.
18164 @item
18165 @i{David Wainberg} suggested archiving, and improvements to the linking
18166 system.
18167 @item
18168 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
18169 linking to Gnus.
18170 @item
18171 @i{Roland Winkler} requested additional key bindings to make Org
18172 work on a tty.
18173 @item
18174 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
18175 and contributed various ideas and code snippets.
18176 @end itemize
18179 @node GNU Free Documentation License, Main Index, History and Acknowledgments, Top
18180 @appendix GNU Free Documentation License
18181 @include doclicense.texi
18184 @node Main Index, Key Index, GNU Free Documentation License, Top
18185 @unnumbered Concept index
18187 @printindex cp
18189 @node Key Index, Command and Function Index, Main Index, Top
18190 @unnumbered Key index
18192 @printindex ky
18194 @node Command and Function Index, Variable Index, Key Index, Top
18195 @unnumbered Command and function index
18197 @printindex fn
18199 @node Variable Index,  , Command and Function Index, Top
18200 @unnumbered Variable index
18202 This is not a complete index of variables and faces, only the ones that are
18203 mentioned in the manual.  For a more complete list, use @kbd{M-x
18204 org-customize @key{RET}} and then click yourself through the tree.
18206 @printindex vr
18208 @bye
18210 @c Local variables:
18211 @c fill-column: 77
18212 @c indent-tabs-mode: nil
18213 @c paragraph-start:    "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[  ]*$"
18214 @c paragraph-separate: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[       \f]*$"
18215 @c End:
18218 @c  LocalWords:  webdavhost pre