ox-texinfo: Handle @image
[org-mode.git] / doc / org.texi
blobc8018f9b1828abbe8320681e95437e34c237c788
1 \input texinfo  @c -*- coding: utf-8 -*-
2 @c %**start of header
3 @setfilename ../../info/org.info
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--2015 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 Bastien Guerry, Nicolas Goaziou, Eric Schulte,
288 Jambunathan K, Dan Davison, Thomas Dye, David O'Toole, and Philip Rooke.
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 short table of contents at the beginning.
297 @shortcontents
299 @c Output the table of contents at the beginning.
300 @contents
302 @ifnottex
303 @c FIXME These hand-written next,prev,up node pointers make editing a lot
304 @c harder.  There should be no need for them, makeinfo can do it
305 @c automatically for any document with a normal structure.
306 @node Top, Introduction, (dir), (dir)
307 @top Org Mode Manual
309 @insertcopying
310 @end ifnottex
312 @menu
313 * Introduction::                Getting started
314 * Document structure::          A tree works like your brain
315 * Tables::                      Pure magic for quick formatting
316 * Hyperlinks::                  Notes in context
317 * TODO items::                  Every tree branch can be a TODO item
318 * Tags::                        Tagging headlines and matching sets of tags
319 * Properties and columns::      Storing information about an entry
320 * Dates and times::             Making items useful for planning
321 * Capture - Refile - Archive::  The ins and outs for projects
322 * Agenda views::                Collecting information into views
323 * Markup::                      Prepare text for rich export
324 * Exporting::                   Sharing and publishing notes
325 * Publishing::                  Create a web site of linked Org files
326 * Working with source code::    Export, evaluate, and tangle code blocks
327 * Miscellaneous::               All the rest which did not fit elsewhere
328 * Hacking::                     How to hack your way around
329 * MobileOrg::                   Viewing and capture on a mobile device
330 * History and acknowledgments::  How Org came into being
331 * GNU Free Documentation License::  The license for this documentation.
332 * Main Index::                  An index of Org's concepts and features
333 * Key Index::                   Key bindings and where they are described
334 * Command and Function Index::  Command names and some internal functions
335 * Variable Index::              Variables mentioned in the manual
337 @detailmenu
338  --- The Detailed Node Listing ---
340 Introduction
342 * Summary::                     Brief summary of what Org does
343 * Installation::                Installing Org
344 * Activation::                  How to activate Org for certain buffers
345 * Feedback::                    Bug reports, ideas, patches etc.
346 * Conventions::                 Typesetting conventions in the manual
348 Document structure
350 * Outlines::                    Org is based on Outline mode
351 * Headlines::                   How to typeset Org tree headlines
352 * Visibility cycling::          Show and hide, much simplified
353 * Motion::                      Jumping to other headlines
354 * Structure editing::           Changing sequence and level of headlines
355 * Sparse trees::                Matches embedded in context
356 * Plain lists::                 Additional structure within an entry
357 * Drawers::                     Tucking stuff away
358 * Blocks::                      Folding blocks
359 * Footnotes::                   How footnotes are defined in Org's syntax
360 * Orgstruct mode::              Structure editing outside Org
361 * Org syntax::                  Formal description of Org's syntax
363 Visibility cycling
365 * Global and local cycling::    Cycling through various visibility states
366 * Initial visibility::          Setting the initial visibility state
367 * Catching invisible edits::    Preventing mistakes when editing invisible parts
369 Tables
371 * Built-in table editor::       Simple tables
372 * Column width and alignment::  Overrule the automatic settings
373 * Column groups::               Grouping to trigger vertical lines
374 * Orgtbl mode::                 The table editor as minor mode
375 * The spreadsheet::             The table editor has spreadsheet capabilities
376 * Org-Plot::                    Plotting from org tables
378 The spreadsheet
380 * References::                  How to refer to another field or range
381 * Formula syntax for Calc::     Using Calc to compute stuff
382 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
383 * Durations and time values::   How to compute durations and time values
384 * Field and range formulas::    Formula for specific (ranges of) fields
385 * Column formulas::             Formulas valid for an entire column
386 * Lookup functions::            Lookup functions for searching tables
387 * Editing and debugging formulas::  Fixing formulas
388 * Updating the table::          Recomputing all dependent fields
389 * Advanced features::           Field and column names, parameters and automatic recalc
391 Hyperlinks
393 * Link format::                 How links in Org are formatted
394 * Internal links::              Links to other places in the current file
395 * External links::              URL-like links to the world
396 * Handling links::              Creating, inserting and following
397 * Using links outside Org::     Linking from my C source code?
398 * Link abbreviations::          Shortcuts for writing complex links
399 * Search options::              Linking to a specific location
400 * Custom searches::             When the default search is not enough
402 Internal links
404 * Radio targets::               Make targets trigger links in plain text
406 TODO items
408 * TODO basics::                 Marking and displaying TODO entries
409 * TODO extensions::             Workflow and assignments
410 * Progress logging::            Dates and notes for progress
411 * Priorities::                  Some things are more important than others
412 * Breaking down tasks::         Splitting a task into manageable pieces
413 * Checkboxes::                  Tick-off lists
415 Extended use of TODO keywords
417 * Workflow states::             From TODO to DONE in steps
418 * TODO types::                  I do this, Fred does the rest
419 * Multiple sets in one file::   Mixing it all, and still finding your way
420 * Fast access to TODO states::  Single letter selection of a state
421 * Per-file keywords::           Different files, different requirements
422 * Faces for TODO keywords::     Highlighting states
423 * TODO dependencies::           When one task needs to wait for others
425 Progress logging
427 * Closing items::               When was this entry marked DONE?
428 * Tracking TODO state changes::  When did the status change?
429 * Tracking your habits::        How consistent have you been?
431 Tags
433 * Tag inheritance::             Tags use the tree structure of the outline
434 * Setting tags::                How to assign tags to a headline
435 * Tag hierarchy::               Create a hierarchy of tags
436 * Tag searches::                Searching for combinations of tags
438 Properties and columns
440 * Property syntax::             How properties are spelled out
441 * Special properties::          Access to other Org mode features
442 * Property searches::           Matching property values
443 * Property inheritance::        Passing values down the tree
444 * Column view::                 Tabular viewing and editing
445 * Property API::                Properties for Lisp programmers
447 Column view
449 * Defining columns::            The COLUMNS format property
450 * Using column view::           How to create and use column view
451 * Capturing column view::       A dynamic block for column view
453 Defining columns
455 * Scope of column definitions::  Where defined, where valid?
456 * Column attributes::           Appearance and content of a column
458 Dates and times
460 * Timestamps::                  Assigning a time to a tree entry
461 * Creating timestamps::         Commands which insert timestamps
462 * Deadlines and scheduling::    Planning your work
463 * Clocking work time::          Tracking how long you spend on a task
464 * Effort estimates::            Planning work effort in advance
465 * Timers::                      Notes with a running timer
467 Creating timestamps
469 * The date/time prompt::        How Org mode helps you entering date and time
470 * Custom time format::          Making dates look different
472 Deadlines and scheduling
474 * Inserting deadline/schedule::  Planning items
475 * Repeated tasks::              Items that show up again and again
477 Clocking work time
479 * Clocking commands::           Starting and stopping a clock
480 * The clock table::             Detailed reports
481 * Resolving idle time::         Resolving time when you've been idle
483 Capture - Refile - Archive
485 * Capture::                     Capturing new stuff
486 * Attachments::                 Add files to tasks
487 * RSS feeds::                   Getting input from RSS feeds
488 * Protocols::                   External (e.g., Browser) access to Emacs and Org
489 * Refile and copy::             Moving/copying a tree from one place to another
490 * Archiving::                   What to do with finished projects
492 Capture
494 * Setting up capture::          Where notes will be stored
495 * Using capture::               Commands to invoke and terminate capture
496 * Capture templates::           Define the outline of different note types
498 Capture templates
500 * Template elements::           What is needed for a complete template entry
501 * Template expansion::          Filling in information about time and context
502 * Templates in contexts::       Only show a template in a specific context
504 Archiving
506 * Moving subtrees::             Moving a tree to an archive file
507 * Internal archiving::          Switch off a tree but keep it in the file
509 Agenda views
511 * Agenda files::                Files being searched for agenda information
512 * Agenda dispatcher::           Keyboard access to agenda views
513 * Built-in agenda views::       What is available out of the box?
514 * Presentation and sorting::    How agenda items are prepared for display
515 * Agenda commands::             Remote editing of Org trees
516 * Custom agenda views::         Defining special searches and views
517 * Exporting agenda views::      Writing a view to a file
518 * Agenda column view::          Using column view for collected entries
520 The built-in agenda views
522 * Weekly/daily agenda::         The calendar page with current tasks
523 * Global TODO list::            All unfinished action items
524 * Matching tags and properties::  Structured information with fine-tuned search
525 * Timeline::                    Time-sorted view for single file
526 * Search view::                 Find entries by searching for text
527 * Stuck projects::              Find projects you need to review
529 Presentation and sorting
531 * Categories::                  Not all tasks are equal
532 * Time-of-day specifications::  How the agenda knows the time
533 * Sorting agenda items::        The order of things
534 * Filtering/limiting agenda items::  Dynamically narrow the agenda
536 Custom agenda views
538 * Storing searches::            Type once, use often
539 * Block agenda::                All the stuff you need in a single buffer
540 * Setting options::             Changing the rules
542 Markup for rich export
544 * Structural markup elements::  The basic structure as seen by the exporter
545 * Images and tables::           Images, tables and caption mechanism
546 * Literal examples::            Source code examples with special formatting
547 * Include files::               Include additional files into a document
548 * Index entries::               Making an index
549 * Macro replacement::           Use macros to create templates
550 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
551 * Special blocks::              Containers targeted at export back-ends
553 Structural markup elements
555 * Document title::              Where the title is taken from
556 * Headings and sections::       The document structure as seen by the exporter
557 * Table of contents::           The if and where of the table of contents
558 * Lists::                       Lists
559 * Paragraphs::                  Paragraphs
560 * Footnote markup::             Footnotes
561 * Emphasis and monospace::      Bold, italic, etc.
562 * Horizontal rules::            Make a line
563 * Comment lines::               What will *not* be exported
565 Embedded @LaTeX{}
567 * Special symbols::             Greek letters and other symbols
568 * Subscripts and superscripts::  Simple syntax for raising/lowering text
569 * @LaTeX{} fragments::          Complex formulas made easy
570 * Previewing @LaTeX{} fragments::  What will this snippet look like?
571 * CDLaTeX mode::                Speed up entering of formulas
573 Exporting
575 * The export dispatcher::       The main exporter interface
576 * Export back-ends::            Built-in export formats
577 * Export settings::             Generic export settings
578 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
579 * Beamer export::               Exporting as a Beamer presentation
580 * HTML export::                 Exporting to HTML
581 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
582 * Markdown export::             Exporting to Markdown
583 * OpenDocument Text export::    Exporting to OpenDocument Text
584 * Org export::                  Exporting to Org
585 * Texinfo export::              Exporting to Texinfo
586 * iCalendar export::            Exporting to iCalendar
587 * Other built-in back-ends::    Exporting to a man page
588 * Export in foreign buffers::   Author tables and lists in Org syntax
589 * Advanced configuration::      Fine-tuning the export output
591 HTML export
593 * HTML Export commands::        How to invoke HTML export
594 * HTML doctypes::               Org can export to various (X)HTML flavors
595 * HTML preamble and postamble::  How to insert a preamble and a postamble
596 * Quoting HTML tags::           Using direct HTML in Org mode
597 * Links in HTML export::        How links will be interpreted and formatted
598 * Tables in HTML export::       How to modify the formatting of tables
599 * Images in HTML export::       How to insert figures into HTML output
600 * Math formatting in HTML export::  Beautiful math also on the web
601 * Text areas in HTML export::   An alternative way to show an example
602 * CSS support::                 Changing the appearance of the output
603 * JavaScript support::          Info and Folding in a web browser
605 @LaTeX{} and PDF export
607 * @LaTeX{} export commands::    How to export to LaTeX and PDF
608 * Header and sectioning::       Setting up the export file structure
609 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
610 * @LaTeX{} specific attributes::  Controlling @LaTeX{} output
612 OpenDocument text export
614 * Pre-requisites for ODT export::  What packages ODT exporter relies on
615 * ODT export commands::         How to invoke ODT export
616 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
617 * Applying custom styles::      How to apply custom styles to the output
618 * Links in ODT export::         How links will be interpreted and formatted
619 * Tables in ODT export::        How Tables are exported
620 * Images in ODT export::        How to insert images
621 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
622 * Labels and captions in ODT export::  How captions are rendered
623 * Literal examples in ODT export::  How source and example blocks are formatted
624 * Advanced topics in ODT export::  Read this if you are a power user
626 Math formatting in ODT export
628 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
629 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
631 Advanced topics in ODT export
633 * Configuring a document converter::  How to register a document converter
634 * Working with OpenDocument style files::  Explore the internals
635 * Creating one-off styles::     How to produce custom highlighting etc
636 * Customizing tables in ODT export::  How to define and use Table templates
637 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
639 Texinfo export
641 * Texinfo export commands::     How to invoke Texinfo export
642 * Document preamble::           File header, title and copyright page
643 * Headings and sectioning structure:: Building document structure
644 * Indices::                     Creating indices
645 * Quoting Texinfo code::        Incorporating literal Texinfo code
646 * Texinfo specific attributes:: Controlling Texinfo output
647 * An example::
649 Publishing
651 * Configuration::               Defining projects
652 * Uploading files::             How to get files up on the server
653 * Sample configuration::        Example projects
654 * Triggering publication::      Publication commands
656 Configuration
658 * Project alist::               The central configuration variable
659 * Sources and destinations::    From here to there
660 * Selecting files::             What files are part of the project?
661 * Publishing action::           Setting the function doing the publishing
662 * Publishing options::          Tweaking HTML/@LaTeX{} export
663 * Publishing links::            Which links keep working after publishing?
664 * Sitemap::                     Generating a list of all pages
665 * Generating an index::         An index that reaches across pages
667 Sample configuration
669 * Simple example::              One-component publishing
670 * Complex example::             A multi-component publishing example
672 Working with source code
674 * Structure of code blocks::    Code block syntax described
675 * Editing source code::         Language major-mode editing
676 * Exporting code blocks::       Export contents and/or results
677 * Extracting source code::      Create pure source code files
678 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
679 * Library of Babel::            Use and contribute to a library of useful code blocks
680 * Languages::                   List of supported code block languages
681 * Header arguments::            Configure code block functionality
682 * Results of evaluation::       How evaluation results are handled
683 * Noweb reference syntax::      Literate programming in Org mode
684 * Key bindings and useful functions::  Work quickly with code blocks
685 * Batch execution::             Call functions from the command line
687 Header arguments
689 * Using header arguments::      Different ways to set header arguments
690 * Specific header arguments::   List of header arguments
692 Using header arguments
694 * System-wide header arguments::  Set global default values
695 * Language-specific header arguments::  Set default values by language
696 * Header arguments in Org mode properties::  Set default values for a buffer or heading
697 * Language-specific header arguments in Org mode properties::  Set language-specific default values for a buffer or heading
698 * Code block specific header arguments::  The most common way to set values
699 * Header arguments in function calls::  The most specific level
701 Specific header arguments
703 * var::                         Pass arguments to code blocks
704 * Results::                     Specify the type of results and how they will
705                                 be collected and handled
706 * file::                        Specify a path for file output
707 * file-desc::                   Specify a description for file results
708 * dir::                         Specify the default (possibly remote)
709                                 directory for code block execution
710 * exports::                     Export code and/or results
711 * tangle::                      Toggle tangling and specify file name
712 * mkdirp::                      Toggle creation of parent directories of target
713                                 files during tangling
714 * comments::                    Toggle insertion of comments in tangled
715                                 code files
716 * padline::                     Control insertion of padding lines in tangled
717                                 code files
718 * no-expand::                   Turn off variable assignment and noweb
719                                 expansion during tangling
720 * session::                     Preserve the state of code evaluation
721 * noweb::                       Toggle expansion of noweb references
722 * noweb-ref::                   Specify block's noweb reference resolution target
723 * noweb-sep::                   String used to separate noweb references
724 * cache::                       Avoid re-evaluating unchanged code blocks
725 * sep::                         Delimiter for writing tabular results outside Org
726 * hlines::                      Handle horizontal lines in tables
727 * colnames::                    Handle column names in tables
728 * rownames::                    Handle row names in tables
729 * shebang::                     Make tangled files executable
730 * tangle-mode::                 Set permission of tangled files
731 * eval::                        Limit evaluation of specific code blocks
732 * wrap::                        Mark source block evaluation results
733 * post::                        Post processing of code block results
734 * prologue::                    Text to prepend to code block body
735 * epilogue::                    Text to append to code block body
737 Miscellaneous
739 * Completion::                  M-TAB knows what you need
740 * Easy templates::              Quick insertion of structural elements
741 * Speed keys::                  Electric commands at the beginning of a headline
742 * Code evaluation security::    Org mode files evaluate inline code
743 * Customization::               Adapting Org to your taste
744 * In-buffer settings::          Overview of the #+KEYWORDS
745 * The very busy C-c C-c key::   When in doubt, press C-c C-c
746 * Clean view::                  Getting rid of leading stars in the outline
747 * TTY keys::                    Using Org on a tty
748 * Interaction::                 Other Emacs packages
749 * org-crypt::                   Encrypting Org files
751 Interaction with other packages
753 * Cooperation::                 Packages Org cooperates with
754 * Conflicts::                   Packages that lead to conflicts
756 Hacking
758 * Hooks::                       How to reach into Org's internals
759 * Add-on packages::             Available extensions
760 * Adding hyperlink types::      New custom link types
761 * Adding export back-ends::     How to write new export back-ends
762 * Context-sensitive commands::  How to add functionality to such commands
763 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
764 * Dynamic blocks::              Automatically filled blocks
765 * Special agenda views::        Customized views
766 * Speeding up your agendas::    Tips on how to speed up your agendas
767 * Extracting agenda information::  Post-processing of agenda information
768 * Using the property API::      Writing programs that use entry properties
769 * Using the mapping API::       Mapping over all or selected entries
771 Tables and lists in arbitrary syntax
773 * Radio tables::                Sending and receiving radio tables
774 * A @LaTeX{} example::          Step by step, almost a tutorial
775 * Translator functions::        Copy and modify
776 * Radio lists::                 Sending and receiving lists
778 MobileOrg
780 * Setting up the staging area::  Where to interact with the mobile device
781 * Pushing to MobileOrg::        Uploading Org files and agendas
782 * Pulling from MobileOrg::      Integrating captured and flagged items
784 @end detailmenu
785 @end menu
787 @node Introduction
788 @chapter Introduction
789 @cindex introduction
791 @menu
792 * Summary::                     Brief summary of what Org does
793 * Installation::                Installing Org
794 * Activation::                  How to activate Org for certain buffers
795 * Feedback::                    Bug reports, ideas, patches etc.
796 * Conventions::                 Typesetting conventions in the manual
797 @end menu
799 @node Summary
800 @section Summary
801 @cindex summary
803 Org is a mode for keeping notes, maintaining TODO lists, and project planning
804 with a fast and effective plain-text system.  It also is an authoring system
805 with unique support for literate programming and reproducible research.
807 Org is implemented on top of Outline mode, which makes it possible to keep
808 the content of large files well structured.  Visibility cycling and structure
809 editing help to work with the tree.  Tables are easily created with a
810 built-in table editor.  Plain text URL-like links connect to websites,
811 emails, Usenet messages, BBDB entries, and any files related to the projects.
813 Org develops organizational tasks around notes files that contain lists or
814 information about projects as plain text.  Project planning and task
815 management makes use of metadata which is part of an outline node.  Based on
816 this data, specific entries can be extracted in queries and create dynamic
817 @i{agenda views} that also integrate the Emacs calendar and diary.  Org can
818 be used to implement many different project planning schemes, such as David
819 Allen's GTD system.
821 Org files can serve as a single source authoring system with export to many
822 different formats such as HTML, @LaTeX{}, Open Document, and Markdown.  New
823 export backends can be derived from existing ones, or defined from scratch.
825 Org files can include source code blocks, which makes Org uniquely suited for
826 authoring technical documents with code examples. Org source code blocks are
827 fully functional; they can be evaluated in place and their results can be
828 captured in the file.  This makes it possible to create a single file
829 reproducible research compendium.
831 Org keeps simple things simple.  When first fired up, it should feel like a
832 straightforward, easy to use outliner.  Complexity is not imposed, but a
833 large amount of functionality is available when needed.  Org is a toolbox.
834 Many users actually run only a (very personal) fraction of Org's capabilities, and
835 know that there is more whenever they need it.
837 All of this is achieved with strictly plain text files, the most portable and
838 future-proof file format.  Org runs in Emacs.  Emacs is one of the most
839 widely ported programs, so that Org mode is available on every major
840 platform.
842 @cindex FAQ
843 There is a website for Org which provides links to the newest
844 version of Org, as well as additional information, frequently asked
845 questions (FAQ), links to tutorials, etc.  This page is located at
846 @uref{http://orgmode.org}.
847 @cindex print edition
849 An earlier version (7.3) of this manual is available as a
850 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from
851 Network Theory Ltd.}
853 @page
855 @node Installation
856 @section Installation
857 @cindex installation
858 @cindex XEmacs
860 Org is part of recent distributions of GNU Emacs, so you normally don't need
861 to install it.  If, for one reason or another, you want to install Org on top
862 of this pre-packaged version, there are three ways to do it:
864 @itemize @bullet
865 @item By using Emacs package system.
866 @item By downloading Org as an archive.
867 @item By using Org's git repository.
868 @end itemize
870 We @b{strongly recommend} to stick to a single installation method.
872 @subsubheading Using Emacs packaging system
874 Recent Emacs distributions include a packaging system which lets you install
875 Elisp libraries.  You can install Org with @kbd{M-x package-install RET org}.
877 @noindent @b{Important}: you need to do this in a session where no @code{.org} file has
878 been visited, i.e. where no Org built-in function have been loaded.
879 Otherwise autoload Org functions will mess up the installation.
881 Then, to make sure your Org configuration is taken into account, initialize
882 the package system with @code{(package-initialize)} in your @file{.emacs}
883 before setting any Org option.  If you want to use Org's package repository,
884 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
886 @subsubheading Downloading Org as an archive
888 You can download Org latest release from @uref{http://orgmode.org/, Org's
889 website}.  In this case, make sure you set the load-path correctly in your
890 @file{.emacs}:
892 @lisp
893 (add-to-list 'load-path "~/path/to/orgdir/lisp")
894 @end lisp
896 The downloaded archive contains contributed libraries that are not included
897 in Emacs.  If you want to use them, add the @file{contrib} directory to your
898 load-path:
900 @lisp
901 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
902 @end lisp
904 Optionally, you can compile the files and/or install them in your system.
905 Run @code{make help} to list compilation and installation options.
907 @subsubheading Using Org's git repository
909 You can clone Org's repository and install Org like this:
911 @example
912 $ cd ~/src/
913 $ git clone git://orgmode.org/org-mode.git
914 $ make autoloads
915 @end example
917 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
918 version in @file{org-version.el} and Org's autoloads in
919 @file{org-loaddefs.el}.
921 Remember to add the correct load-path as described in the method above.
923 You can also compile with @code{make}, generate the documentation with
924 @code{make doc}, create a local configuration with @code{make config} and
925 install Org with @code{make install}.  Please run @code{make help} to get
926 the list of compilation/installation options.
928 For more detailed explanations on Org's build system, please check the Org
929 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
930 Worg}.
932 @node Activation
933 @section Activation
934 @cindex activation
935 @cindex autoload
936 @cindex ELPA
937 @cindex global key bindings
938 @cindex key bindings, global
939 @findex org-agenda
940 @findex org-capture
941 @findex org-store-link
942 @findex org-iswitchb
944 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
945 default.  If you are using an earlier version of Emacs, add this line to your
946 @file{.emacs} file:
948 @lisp
949 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
950 @end lisp
952 Org mode buffers need font-lock to be turned on: this is the default in
953 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
954 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
956 There are compatibility issues between Org mode and some other Elisp
957 packages, please take the time to check the list (@pxref{Conflicts}).
959 The four Org commands @command{org-store-link}, @command{org-capture},
960 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
961 global keys (i.e., anywhere in Emacs, not just in Org buffers).  Here are
962 suggested bindings for these keys, please modify the keys to your own
963 liking.
964 @lisp
965 (global-set-key "\C-cl" 'org-store-link)
966 (global-set-key "\C-ca" 'org-agenda)
967 (global-set-key "\C-cc" 'org-capture)
968 (global-set-key "\C-cb" 'org-iswitchb)
969 @end lisp
971 @cindex Org mode, turning on
972 To turn on Org mode in a file that does not have the extension @file{.org},
973 make the first line of a file look like this:
975 @example
976 MY PROJECTS    -*- mode: org; -*-
977 @end example
979 @vindex org-insert-mode-line-in-empty-file
980 @noindent which will select Org mode for this buffer no matter what
981 the file's name is.  See also the variable
982 @code{org-insert-mode-line-in-empty-file}.
984 Many commands in Org work on the region if the region is @i{active}.  To make
985 use of this, you need to have @code{transient-mark-mode}
986 (@code{zmacs-regions} in XEmacs) turned on.  In Emacs 23 this is the default,
987 in Emacs 22 you need to do this yourself with
988 @lisp
989 (transient-mark-mode 1)
990 @end lisp
991 @noindent If you do not like @code{transient-mark-mode}, you can create an
992 active region by using the mouse to select a region, or pressing
993 @kbd{C-@key{SPC}} twice before moving the cursor.
995 @node Feedback
996 @section Feedback
997 @cindex feedback
998 @cindex bug reports
999 @cindex maintainer
1000 @cindex author
1002 If you find problems with Org, or if you have questions, remarks, or ideas
1003 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1004 You can subscribe to the list
1005 @uref{https://lists.gnu.org/mailman/listinfo/emacs-orgmode, on this web page}.
1006 If you are not a member of the mailing list, your mail will be passed to the
1007 list after a moderator has approved it@footnote{Please consider subscribing
1008 to the mailing list, in order to minimize the work the mailing list
1009 moderators have to do.}.
1011 For bug reports, please first try to reproduce the bug with the latest
1012 version of Org available---if you are running an outdated version, it is
1013 quite possible that the bug has been fixed already.  If the bug persists,
1014 prepare a report and provide as much information as possible, including the
1015 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1016 (@kbd{M-x org-version RET}), as well as the Org related setup in
1017 @file{.emacs}.  The easiest way to do this is to use the command
1018 @example
1019 @kbd{M-x org-submit-bug-report RET}
1020 @end example
1021 @noindent which will put all this information into an Emacs mail buffer so
1022 that you only need to add your description.  If you are not sending the Email
1023 from within Emacs, please copy and paste the content into your Email program.
1025 Sometimes you might face a problem due to an error in your Emacs or Org mode
1026 setup.  Before reporting a bug, it is very helpful to start Emacs with minimal
1027 customizations and reproduce the problem.  Doing so often helps you determine
1028 if the problem is with your customization or with Org mode itself.  You can
1029 start a typical minimal session with a command like the example below.
1031 @example
1032 $ emacs -Q -l /path/to/minimal-org.el
1033 @end example
1035 However if you are using Org mode as distributed with Emacs, a minimal setup
1036 is not necessary.  In that case it is sufficient to start Emacs as
1037 @code{emacs -Q}.  The @code{minimal-org.el} setup file can have contents as
1038 shown below.
1040 @lisp
1041 ;;; Minimal setup to load latest `org-mode'
1043 ;; activate debugging
1044 (setq debug-on-error t
1045       debug-on-signal nil
1046       debug-on-quit nil)
1048 ;; add latest org-mode to load path
1049 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1050 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1051 @end lisp
1053 If an error occurs, a backtrace can be very useful (see below on how to
1054 create one).  Often a small example file helps, along with clear information
1055 about:
1057 @enumerate
1058 @item What exactly did you do?
1059 @item What did you expect to happen?
1060 @item What happened instead?
1061 @end enumerate
1062 @noindent Thank you for helping to improve this program.
1064 @subsubheading How to create a useful backtrace
1066 @cindex backtrace of an error
1067 If working with Org produces an error with a message you don't
1068 understand, you may have hit a bug.  The best way to report this is by
1069 providing, in addition to what was mentioned above, a @emph{backtrace}.
1070 This is information from the built-in debugger about where and how the
1071 error occurred.  Here is how to produce a useful backtrace:
1073 @enumerate
1074 @item
1075 Reload uncompiled versions of all Org mode Lisp files.  The backtrace
1076 contains much more information if it is produced with uncompiled code.
1077 To do this, use
1078 @example
1079 @kbd{C-u M-x org-reload RET}
1080 @end example
1081 @noindent
1082 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1083 menu.
1084 @item
1085 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1086 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1087 @item
1088 Do whatever you have to do to hit the error.  Don't forget to
1089 document the steps you take.
1090 @item
1091 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1092 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
1093 attach it to your bug report.
1094 @end enumerate
1096 @node Conventions
1097 @section Typesetting conventions used in this manual
1099 @subsubheading TODO keywords, tags, properties, etc.
1101 Org mainly uses three types of keywords: TODO keywords, tags and property
1102 names.  In this manual we use the following conventions:
1104 @table @code
1105 @item TODO
1106 @itemx WAITING
1107 TODO keywords are written with all capitals, even if they are
1108 user-defined.
1109 @item boss
1110 @itemx ARCHIVE
1111 User-defined tags are written in lowercase; built-in tags with special
1112 meaning are written with all capitals.
1113 @item Release
1114 @itemx PRIORITY
1115 User-defined properties are capitalized; built-in properties with
1116 special meaning are written with all capitals.
1117 @end table
1119 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1120 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1121 environment).  They are written in uppercase in the manual to enhance its
1122 readability, but you can use lowercase in your Org files@footnote{Easy
1123 templates insert lowercase keywords and Babel dynamically inserts
1124 @code{#+results}.}.
1126 @subsubheading Keybindings and commands
1127 @kindex C-c a
1128 @findex org-agenda
1129 @kindex C-c c
1130 @findex org-capture
1132 The manual suggests a few global keybindings, in particular @kbd{C-c a} for
1133 @code{org-agenda} and @kbd{C-c c} for @code{org-capture}.  These are only
1134 suggestions, but the rest of the manual assumes that these keybindings are in
1135 place in order to list commands by key access.
1137 Also, the manual lists both the keys and the corresponding commands for
1138 accessing a functionality.  Org mode often uses the same key for different
1139 functions, depending on context.  The command that is bound to such keys has
1140 a generic name, like @code{org-metaright}.  In the manual we will, wherever
1141 possible, give the function that is internally called by the generic command.
1142 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1143 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1144 will be listed to call @code{org-table-move-column-right}.  If you prefer,
1145 you can compile the manual without the command names by unsetting the flag
1146 @code{cmdnames} in @file{org.texi}.
1148 @node Document structure
1149 @chapter Document structure
1150 @cindex document structure
1151 @cindex structure of document
1153 Org is based on Outline mode and provides flexible commands to
1154 edit the structure of the document.
1156 @menu
1157 * Outlines::                    Org is based on Outline mode
1158 * Headlines::                   How to typeset Org tree headlines
1159 * Visibility cycling::          Show and hide, much simplified
1160 * Motion::                      Jumping to other headlines
1161 * Structure editing::           Changing sequence and level of headlines
1162 * Sparse trees::                Matches embedded in context
1163 * Plain lists::                 Additional structure within an entry
1164 * Drawers::                     Tucking stuff away
1165 * Blocks::                      Folding blocks
1166 * Footnotes::                   How footnotes are defined in Org's syntax
1167 * Orgstruct mode::              Structure editing outside Org
1168 * Org syntax::                  Formal description of Org's syntax
1169 @end menu
1171 @node Outlines
1172 @section Outlines
1173 @cindex outlines
1174 @cindex Outline mode
1176 Org is implemented on top of Outline mode.  Outlines allow a
1177 document to be organized in a hierarchical structure, which (at least
1178 for me) is the best representation of notes and thoughts.  An overview
1179 of this structure is achieved by folding (hiding) large parts of the
1180 document to show only the general document structure and the parts
1181 currently being worked on.  Org greatly simplifies the use of
1182 outlines by compressing the entire show/hide functionality into a single
1183 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1185 @node Headlines
1186 @section Headlines
1187 @cindex headlines
1188 @cindex outline tree
1189 @vindex org-special-ctrl-a/e
1190 @vindex org-special-ctrl-k
1191 @vindex org-ctrl-k-protect-subtree
1193 Headlines define the structure of an outline tree.  The headlines in Org
1194 start with one or more stars, on the left margin@footnote{See the variables
1195 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1196 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1197 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1198 headings indented less than 30 stars.}.  For example:
1200 @example
1201 * Top level headline
1202 ** Second level
1203 *** 3rd level
1204     some text
1205 *** 3rd level
1206     more text
1208 * Another top level headline
1209 @end example
1211 @vindex org-footnote-section
1212 @noindent Note that a headline named after @code{org-footnote-section},
1213 which defaults to @samp{Footnotes}, is considered as special.  A subtree with
1214 this headline will be silently ignored by exporting functions.
1216 Some people find the many stars too noisy and would prefer an
1217 outline that has whitespace followed by a single star as headline
1218 starters.  @ref{Clean view}, describes a setup to realize this.
1220 @vindex org-cycle-separator-lines
1221 An empty line after the end of a subtree is considered part of it and
1222 will be hidden when the subtree is folded.  However, if you leave at
1223 least two empty lines, one empty line will remain visible after folding
1224 the subtree, in order to structure the collapsed view.  See the
1225 variable @code{org-cycle-separator-lines} to modify this behavior.
1227 @node Visibility cycling
1228 @section Visibility cycling
1229 @cindex cycling, visibility
1230 @cindex visibility cycling
1231 @cindex trees, visibility
1232 @cindex show hidden text
1233 @cindex hide text
1235 @menu
1236 * Global and local cycling::    Cycling through various visibility states
1237 * Initial visibility::          Setting the initial visibility state
1238 * Catching invisible edits::    Preventing mistakes when editing invisible parts
1239 @end menu
1241 @node Global and local cycling
1242 @subsection Global and local cycling
1244 Outlines make it possible to hide parts of the text in the buffer.
1245 Org uses just two commands, bound to @key{TAB} and
1246 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1248 @cindex subtree visibility states
1249 @cindex subtree cycling
1250 @cindex folded, subtree visibility state
1251 @cindex children, subtree visibility state
1252 @cindex subtree, subtree visibility state
1253 @table @asis
1254 @orgcmd{@key{TAB},org-cycle}
1255 @emph{Subtree cycling}: Rotate current subtree among the states
1257 @example
1258 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1259 '-----------------------------------'
1260 @end example
1262 @vindex org-cycle-emulate-tab
1263 @vindex org-cycle-global-at-bob
1264 The cursor must be on a headline for this to work@footnote{see, however,
1265 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
1266 beginning of the buffer and the first line is not a headline, then
1267 @key{TAB} actually runs global cycling (see below)@footnote{see the
1268 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
1269 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1271 @cindex global visibility states
1272 @cindex global cycling
1273 @cindex overview, global visibility state
1274 @cindex contents, global visibility state
1275 @cindex show all, global visibility state
1276 @orgcmd{S-@key{TAB},org-global-cycle}
1277 @itemx C-u @key{TAB}
1278 @emph{Global cycling}: Rotate the entire buffer among the states
1280 @example
1281 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1282 '--------------------------------------'
1283 @end example
1285 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1286 CONTENTS view up to headlines of level N will be shown.  Note that inside
1287 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1289 @cindex set startup visibility, command
1290 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1291 Switch back to the startup visibility of the buffer (@pxref{Initial visibility}).
1292 @cindex show all, command
1293 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1294 Show all, including drawers.
1295 @cindex revealing context
1296 @orgcmd{C-c C-r,org-reveal}
1297 Reveal context around point, showing the current entry, the following heading
1298 and the hierarchy above.  Useful for working near a location that has been
1299 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1300 (@pxref{Agenda commands}).  With a prefix argument show, on each
1301 level, all sibling headings.  With a double prefix argument, also show the
1302 entire subtree of the parent.
1303 @cindex show branches, command
1304 @orgcmd{C-c C-k,show-branches}
1305 Expose all the headings of the subtree, CONTENT view for just one subtree.
1306 @cindex show children, command
1307 @orgcmd{C-c @key{TAB},show-children}
1308 Expose all direct children of the subtree.  With a numeric prefix argument N,
1309 expose all children down to level N@.
1310 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1311 Show the current subtree in an indirect buffer@footnote{The indirect buffer
1312 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) will contain the entire
1313 buffer, but will be narrowed to the current tree.  Editing the indirect
1314 buffer will also change the original buffer, but without affecting visibility
1315 in that buffer.}.  With a numeric prefix argument N, go up to level N and
1316 then take that tree.  If N is negative then go up that many levels.  With a
1317 @kbd{C-u} prefix, do not remove the previously used indirect buffer.
1318 @orgcmd{C-c C-x v,org-copy-visible}
1319 Copy the @i{visible} text in the region into the kill ring.
1320 @end table
1322 @node Initial visibility
1323 @subsection Initial visibility
1325 @cindex visibility, initialize
1326 @vindex org-startup-folded
1327 @vindex org-agenda-inhibit-startup
1328 @cindex @code{overview}, STARTUP keyword
1329 @cindex @code{content}, STARTUP keyword
1330 @cindex @code{showall}, STARTUP keyword
1331 @cindex @code{showeverything}, STARTUP keyword
1333 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1334 i.e., only the top level headlines are visible@footnote{When
1335 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1336 visibility state when first opening a file for the agenda (@pxref{Speeding up
1337 your agendas}).}.  This can be configured through the variable
1338 @code{org-startup-folded}, or on a per-file basis by adding one of the
1339 following lines anywhere in the buffer:
1341 @example
1342 #+STARTUP: overview
1343 #+STARTUP: content
1344 #+STARTUP: showall
1345 #+STARTUP: showeverything
1346 @end example
1348 The startup visibility options are ignored when the file is open for the
1349 first time during the agenda generation: if you want the agenda to honor
1350 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1352 @cindex property, VISIBILITY
1353 @noindent
1354 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1355 and columns}) will get their visibility adapted accordingly.  Allowed values
1356 for this property are @code{folded}, @code{children}, @code{content}, and
1357 @code{all}.
1359 @table @asis
1360 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1361 Switch back to the startup visibility of the buffer, i.e., whatever is
1362 requested by startup options and @samp{VISIBILITY} properties in individual
1363 entries.
1364 @end table
1366 @node Catching invisible edits
1367 @subsection Catching invisible edits
1369 @vindex org-catch-invisible-edits
1370 @cindex edits, catching invisible
1371 Sometimes you may inadvertently edit an invisible part of the buffer and be
1372 confused on what has been edited and how to undo the mistake.  Setting
1373 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this.  See the
1374 docstring of this option on how Org should catch invisible edits and process
1375 them.
1377 @node Motion
1378 @section Motion
1379 @cindex motion, between headlines
1380 @cindex jumping, to headlines
1381 @cindex headline navigation
1382 The following commands jump to other headlines in the buffer.
1384 @table @asis
1385 @orgcmd{C-c C-n,outline-next-visible-heading}
1386 Next heading.
1387 @orgcmd{C-c C-p,outline-previous-visible-heading}
1388 Previous heading.
1389 @orgcmd{C-c C-f,org-forward-same-level}
1390 Next heading same level.
1391 @orgcmd{C-c C-b,org-backward-same-level}
1392 Previous heading same level.
1393 @orgcmd{C-c C-u,outline-up-heading}
1394 Backward to higher level heading.
1395 @orgcmd{C-c C-j,org-goto}
1396 Jump to a different place without changing the current outline
1397 visibility.  Shows the document structure in a temporary buffer, where
1398 you can use the following keys to find your destination:
1399 @vindex org-goto-auto-isearch
1400 @example
1401 @key{TAB}         @r{Cycle visibility.}
1402 @key{down} / @key{up}   @r{Next/previous visible headline.}
1403 @key{RET}         @r{Select this location.}
1404 @kbd{/}           @r{Do a Sparse-tree search}
1405 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1406 n / p        @r{Next/previous visible headline.}
1407 f / b        @r{Next/previous headline same level.}
1408 u            @r{One level up.}
1409 0-9          @r{Digit argument.}
1410 q            @r{Quit}
1411 @end example
1412 @vindex org-goto-interface
1413 @noindent
1414 See also the option @code{org-goto-interface}.
1415 @end table
1417 @node Structure editing
1418 @section Structure editing
1419 @cindex structure editing
1420 @cindex headline, promotion and demotion
1421 @cindex promotion, of subtrees
1422 @cindex demotion, of subtrees
1423 @cindex subtree, cut and paste
1424 @cindex pasting, of subtrees
1425 @cindex cutting, of subtrees
1426 @cindex copying, of subtrees
1427 @cindex sorting, of subtrees
1428 @cindex subtrees, cut and paste
1430 @table @asis
1431 @orgcmd{M-@key{RET},org-insert-heading}
1432 @vindex org-M-RET-may-split-line
1433 Insert a new heading/item with the same level as the one at point.
1435 If the cursor is in a plain list item, a new item is created (@pxref{Plain
1436 lists}).  To prevent this behavior in lists, call the command with one prefix
1437 argument.  When this command is used in the middle of a line, the line is
1438 split and the rest of the line becomes the new item or headline.  If you do
1439 not want the line to be split, customize @code{org-M-RET-may-split-line}.
1441 If the command is used at the @emph{beginning} of a line, and if there is a
1442 heading or an item at point, the new heading/item is created @emph{before}
1443 the current line.  If the command is used at the @emph{end} of a folded
1444 subtree (i.e., behind the ellipses at the end of a headline), then a headline
1445 will be inserted after the end of the subtree.
1447 Calling this command with @kbd{C-u C-u} will unconditionally respect the
1448 headline's content and create a new item at the end of the parent subtree.
1450 If point is at the beginning of a normal line, turn this line into a heading.
1451 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1452 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1453 current heading, the new heading is placed after the body instead of before
1454 it.  This command works from anywhere in the entry.
1455 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1456 @vindex org-treat-insert-todo-heading-as-state-change
1457 Insert new TODO entry with same level as current heading.  See also the
1458 variable @code{org-treat-insert-todo-heading-as-state-change}.
1459 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1460 Insert new TODO entry with same level as current heading.  Like
1461 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1462 subtree.
1463 @orgcmd{@key{TAB},org-cycle}
1464 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1465 become a child of the previous one.  The next @key{TAB} makes it a parent,
1466 and so on, all the way to top level.  Yet another @key{TAB}, and you are back
1467 to the initial level.
1468 @orgcmd{M-@key{left},org-do-promote}
1469 Promote current heading by one level.
1470 @orgcmd{M-@key{right},org-do-demote}
1471 Demote current heading by one level.
1472 @orgcmd{M-S-@key{left},org-promote-subtree}
1473 Promote the current subtree by one level.
1474 @orgcmd{M-S-@key{right},org-demote-subtree}
1475 Demote the current subtree by one level.
1476 @orgcmd{M-S-@key{up},org-move-subtree-up}
1477 Move subtree up (swap with previous subtree of same
1478 level).
1479 @orgcmd{M-S-@key{down},org-move-subtree-down}
1480 Move subtree down (swap with next subtree of same level).
1481 @orgcmd{M-h,org-mark-element}
1482 Mark the element at point.  Hitting repeatedly will mark subsequent elements
1483 of the one just marked.  E.g., hitting @key{M-h} on a paragraph will mark it,
1484 hitting @key{M-h} immediately again will mark the next one.
1485 @orgcmd{C-c @@,org-mark-subtree}
1486 Mark the subtree at point.  Hitting repeatedly will mark subsequent subtrees
1487 of the same level than the marked subtree.
1488 @orgcmd{C-c C-x C-w,org-cut-subtree}
1489 Kill subtree, i.e., remove it from buffer but save in kill ring.
1490 With a numeric prefix argument N, kill N sequential subtrees.
1491 @orgcmd{C-c C-x M-w,org-copy-subtree}
1492 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
1493 sequential subtrees.
1494 @orgcmd{C-c C-x C-y,org-paste-subtree}
1495 Yank subtree from kill ring.  This does modify the level of the subtree to
1496 make sure the tree fits in nicely at the yank position.  The yank level can
1497 also be specified with a numeric prefix argument, or by yanking after a
1498 headline marker like @samp{****}.
1499 @orgcmd{C-y,org-yank}
1500 @vindex org-yank-adjusted-subtrees
1501 @vindex org-yank-folded-subtrees
1502 Depending on the options @code{org-yank-adjusted-subtrees} and
1503 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1504 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1505 C-x C-y}.  With the default settings, no level adjustment will take place,
1506 but the yanked tree will be folded unless doing so would swallow text
1507 previously visible.  Any prefix argument to this command will force a normal
1508 @code{yank} to be executed, with the prefix passed along.  A good way to
1509 force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
1510 yank, it will yank previous kill items plainly, without adjustment and
1511 folding.
1512 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1513 Clone a subtree by making a number of sibling copies of it.  You will be
1514 prompted for the number of copies to make, and you can also specify if any
1515 timestamps in the entry should be shifted.  This can be useful, for example,
1516 to create a number of tasks related to a series of lectures to prepare.  For
1517 more details, see the docstring of the command
1518 @code{org-clone-subtree-with-time-shift}.
1519 @orgcmd{C-c C-w,org-refile}
1520 Refile entry or region to a different location.  @xref{Refile and copy}.
1521 @orgcmd{C-c ^,org-sort}
1522 Sort same-level entries.  When there is an active region, all entries in the
1523 region will be sorted.  Otherwise the children of the current headline are
1524 sorted.  The command prompts for the sorting method, which can be
1525 alphabetically, numerically, by time (first timestamp with active preferred,
1526 creation time, scheduled time, deadline time), by priority, by TODO keyword
1527 (in the sequence the keywords have been defined in the setup) or by the value
1528 of a property.  Reverse sorting is possible as well.  You can also supply
1529 your own function to extract the sorting key.  With a @kbd{C-u} prefix,
1530 sorting will be case-sensitive.
1531 @orgcmd{C-x n s,org-narrow-to-subtree}
1532 Narrow buffer to current subtree.
1533 @orgcmd{C-x n b,org-narrow-to-block}
1534 Narrow buffer to current block.
1535 @orgcmd{C-x n w,widen}
1536 Widen buffer to remove narrowing.
1537 @orgcmd{C-c *,org-toggle-heading}
1538 Turn a normal line or plain list item into a headline (so that it becomes a
1539 subheading at its location).  Also turn a headline into a normal line by
1540 removing the stars.  If there is an active region, turn all lines in the
1541 region into headlines.  If the first line in the region was an item, turn
1542 only the item lines into headlines.  Finally, if the first line is a
1543 headline, remove the stars from all headlines in the region.
1544 @end table
1546 @cindex region, active
1547 @cindex active region
1548 @cindex transient mark mode
1549 When there is an active region (Transient Mark mode), promotion and
1550 demotion work on all headlines in the region.  To select a region of
1551 headlines, it is best to place both point and mark at the beginning of a
1552 line, mark at the beginning of the first headline, and point at the line
1553 just after the last headline to change.  Note that when the cursor is
1554 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1555 functionality.
1558 @node Sparse trees
1559 @section Sparse trees
1560 @cindex sparse trees
1561 @cindex trees, sparse
1562 @cindex folding, sparse trees
1563 @cindex occur, command
1565 @vindex org-show-context-detail
1566 An important feature of Org mode is the ability to construct @emph{sparse
1567 trees} for selected information in an outline tree, so that the entire
1568 document is folded as much as possible, but the selected information is made
1569 visible along with the headline structure above it@footnote{See also the
1570 variable @code{org-show-context-detail} to decide how much context is shown
1571 around each match.}.  Just try it out and you will see immediately how it
1572 works.
1574 Org mode contains several commands for creating such trees, all these
1575 commands can be accessed through a dispatcher:
1577 @table @asis
1578 @orgcmd{C-c /,org-sparse-tree}
1579 This prompts for an extra key to select a sparse-tree creating command.
1580 @orgcmd{C-c / r,org-occur}
1581 @vindex org-remove-highlights-with-change
1582 Prompts for a regexp and shows a sparse tree with all matches.  If
1583 the match is in a headline, the headline is made visible.  If the match is in
1584 the body of an entry, headline and body are made visible.  In order to
1585 provide minimal context, also the full hierarchy of headlines above the match
1586 is shown, as well as the headline following the match.  Each match is also
1587 highlighted; the highlights disappear when the buffer is changed by an
1588 editing command@footnote{This depends on the option
1589 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1590 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1591 so several calls to this command can be stacked.
1592 @orgcmdkkc{M-g n,M-g M-n,next-error}
1593 Jump to the next sparse tree match in this buffer.
1594 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1595 Jump to the previous sparse tree match in this buffer.
1596 @end table
1598 @noindent
1599 @vindex org-agenda-custom-commands
1600 For frequently used sparse trees of specific search strings, you can
1601 use the option @code{org-agenda-custom-commands} to define fast
1602 keyboard access to specific sparse trees.  These commands will then be
1603 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1604 For example:
1606 @lisp
1607 (setq org-agenda-custom-commands
1608       '(("f" occur-tree "FIXME")))
1609 @end lisp
1611 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1612 a sparse tree matching the string @samp{FIXME}.
1614 The other sparse tree commands select headings based on TODO keywords,
1615 tags, or properties and will be discussed later in this manual.
1617 @kindex C-c C-e C-v
1618 @cindex printing sparse trees
1619 @cindex visible text, printing
1620 To print a sparse tree, you can use the Emacs command
1621 @code{ps-print-buffer-with-faces} which does not print invisible parts
1622 of the document @footnote{This does not work under XEmacs, because
1623 XEmacs uses selective display for outlining, not text properties.}.
1624 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1625 the document and print the resulting file.
1627 @node Plain lists
1628 @section Plain lists
1629 @cindex plain lists
1630 @cindex lists, plain
1631 @cindex lists, ordered
1632 @cindex ordered lists
1634 Within an entry of the outline tree, hand-formatted lists can provide
1635 additional structure.  They also provide a way to create lists of checkboxes
1636 (@pxref{Checkboxes}).  Org supports editing such lists, and every exporter
1637 (@pxref{Exporting}) can parse and format them.
1639 Org knows ordered lists, unordered lists, and description lists.
1640 @itemize @bullet
1641 @item
1642 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1643 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1644 they will be seen as top-level headlines.  Also, when you are hiding leading
1645 stars to get a clean outline view, plain list items starting with a star may
1646 be hard to distinguish from true headlines.  In short: even though @samp{*}
1647 is supported, it may be better to not use it for plain list items.}  as
1648 bullets.
1649 @item
1650 @vindex org-plain-list-ordered-item-terminator
1651 @vindex org-list-allow-alphabetical
1652 @emph{Ordered} list items start with a numeral followed by either a period or
1653 a right parenthesis@footnote{You can filter out any of them by configuring
1654 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1655 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1656 @samp{A)} by configuring @code{org-list-allow-alphabetical}.  To minimize
1657 confusion with normal text, those are limited to one character only.  Beyond
1658 that limit, bullets will automatically fallback to numbers.}.  If you want a
1659 list to start with a different value (e.g., 20), start the text of the item
1660 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1661 must be put @emph{before} the checkbox.  If you have activated alphabetical
1662 lists, you can also use counters like @code{[@@b]}.}.  Those constructs can
1663 be used in any item of the list in order to enforce a particular numbering.
1664 @item
1665 @emph{Description} list items are unordered list items, and contain the
1666 separator @samp{ :: } to distinguish the description @emph{term} from the
1667 description.
1668 @end itemize
1670 Items belonging to the same list must have the same indentation on the first
1671 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1672 2--digit numbers must be written left-aligned with the other numbers in the
1673 list.  An item ends before the next line that is less or equally indented
1674 than its bullet/number.
1676 @vindex org-list-empty-line-terminates-plain-lists
1677 A list ends whenever every item has ended, which means before any line less
1678 or equally indented than items at top level.  It also ends before two blank
1679 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1680 In that case, all items are closed.  Here is an example:
1682 @example
1683 @group
1684 ** Lord of the Rings
1685    My favorite scenes are (in this order)
1686    1. The attack of the Rohirrim
1687    2. Eowyn's fight with the witch king
1688       + this was already my favorite scene in the book
1689       + I really like Miranda Otto.
1690    3. Peter Jackson being shot by Legolas
1691       - on DVD only
1692       He makes a really funny face when it happens.
1693    But in the end, no individual scenes matter but the film as a whole.
1694    Important actors in this film are:
1695    - @b{Elijah Wood} :: He plays Frodo
1696    - @b{Sean Austin} :: He plays Sam, Frodo's friend.  I still remember
1697      him very well from his role as Mikey Walsh in @i{The Goonies}.
1698 @end group
1699 @end example
1701 Org supports these lists by tuning filling and wrapping commands to deal with
1702 them correctly@footnote{Org only changes the filling settings for Emacs.  For
1703 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}.  To turn this on,
1704 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1705 properly (@pxref{Exporting}).  Since indentation is what governs the
1706 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1707 blocks can be indented to signal that they belong to a particular item.
1709 @vindex org-list-demote-modify-bullet
1710 @vindex org-list-indent-offset
1711 If you find that using a different bullet for a sub-list (than that used for
1712 the current list-level) improves readability, customize the variable
1713 @code{org-list-demote-modify-bullet}.  To get a greater difference of
1714 indentation between items and their sub-items, customize
1715 @code{org-list-indent-offset}.
1717 @vindex org-list-automatic-rules
1718 The following commands act on items when the cursor is in the first line of
1719 an item (the line with the bullet or number).  Some of them imply the
1720 application of automatic rules to keep list structure intact.  If some of
1721 these actions get in your way, configure @code{org-list-automatic-rules}
1722 to disable them individually.
1724 @table @asis
1725 @orgcmd{@key{TAB},org-cycle}
1726 @cindex cycling, in plain lists
1727 @vindex org-cycle-include-plain-lists
1728 Items can be folded just like headline levels.  Normally this works only if
1729 the cursor is on a plain list item.  For more details, see the variable
1730 @code{org-cycle-include-plain-lists}.  If this variable is set to
1731 @code{integrate}, plain list items will be treated like low-level
1732 headlines.  The level of an item is then given by the indentation of the
1733 bullet/number.  Items are always subordinate to real headlines, however; the
1734 hierarchies remain completely separated.  In a new item with no text yet, the
1735 first @key{TAB} demotes the item to become a child of the previous
1736 one.  Subsequent @key{TAB}s move the item to meaningful levels in the list
1737 and eventually get it back to its initial position.
1738 @orgcmd{M-@key{RET},org-insert-heading}
1739 @vindex org-M-RET-may-split-line
1740 @vindex org-list-automatic-rules
1741 Insert new item at current level.  With a prefix argument, force a new
1742 heading (@pxref{Structure editing}).  If this command is used in the middle
1743 of an item, that item is @emph{split} in two, and the second part becomes the
1744 new item@footnote{If you do not want the item to be split, customize the
1745 variable @code{org-M-RET-may-split-line}.}.  If this command is executed
1746 @emph{before item's body}, the new item is created @emph{before} the current
1747 one.
1748 @end table
1750 @table @kbd
1751 @kindex M-S-@key{RET}
1752 @item M-S-@key{RET}
1753 Insert a new item with a checkbox (@pxref{Checkboxes}).
1754 @kindex S-@key{down}
1755 @item S-up
1756 @itemx S-down
1757 @cindex shift-selection-mode
1758 @vindex org-support-shift-select
1759 @vindex org-list-use-circular-motion
1760 Jump to the previous/next item in the current list@footnote{If you want to
1761 cycle around items that way, you may customize
1762 @code{org-list-use-circular-motion}.}, but only if
1763 @code{org-support-shift-select} is off.  If not, you can still use paragraph
1764 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1765 similar effect.
1766 @kindex M-@key{up}
1767 @kindex M-@key{down}
1768 @item M-up
1769 @itemx M-down
1770 Move the item including subitems up/down@footnote{See
1771 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1772 previous/next item of same indentation).  If the list is ordered, renumbering
1773 is automatic.
1774 @kindex M-@key{left}
1775 @kindex M-@key{right}
1776 @item M-left
1777 @itemx M-right
1778 Decrease/increase the indentation of an item, leaving children alone.
1779 @kindex M-S-@key{left}
1780 @kindex M-S-@key{right}
1781 @item M-S-@key{left}
1782 @itemx M-S-@key{right}
1783 Decrease/increase the indentation of the item, including subitems.
1784 Initially, the item tree is selected based on current indentation.  When
1785 these commands are executed several times in direct succession, the initially
1786 selected region is used, even if the new indentation would imply a different
1787 hierarchy.  To use the new hierarchy, break the command chain with a cursor
1788 motion or so.
1790 As a special case, using this command on the very first item of a list will
1791 move the whole list.  This behavior can be disabled by configuring
1792 @code{org-list-automatic-rules}.  The global indentation of a list has no
1793 influence on the text @emph{after} the list.
1794 @kindex C-c C-c
1795 @item C-c C-c
1796 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1797 state of the checkbox.  In any case, verify bullets and indentation
1798 consistency in the whole list.
1799 @kindex C-c -
1800 @vindex org-plain-list-ordered-item-terminator
1801 @item C-c -
1802 Cycle the entire list level through the different itemize/enumerate bullets
1803 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1804 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1805 and its indentation.  With a numeric prefix argument N, select the Nth bullet
1806 from this list.  If there is an active region when calling this, selected
1807 text will be changed into an item.  With a prefix argument, all lines will be
1808 converted to list items.  If the first line already was a list item, any item
1809 marker will be removed from the list.  Finally, even without an active
1810 region, a normal line will be converted into a list item.
1811 @kindex C-c *
1812 @item C-c *
1813 Turn a plain list item into a headline (so that it becomes a subheading at
1814 its location).  @xref{Structure editing}, for a detailed explanation.
1815 @kindex C-c C-*
1816 @item C-c C-*
1817 Turn the whole plain list into a subtree of the current heading.  Checkboxes
1818 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1819 (resp. checked).
1820 @kindex S-@key{left}
1821 @kindex S-@key{right}
1822 @item S-left/right
1823 @vindex org-support-shift-select
1824 This command also cycles bullet styles when the cursor in on the bullet or
1825 anywhere in an item line, details depending on
1826 @code{org-support-shift-select}.
1827 @kindex C-c ^
1828 @cindex sorting, of plain list
1829 @item C-c ^
1830 Sort the plain list.  You will be prompted for the sorting method:
1831 numerically, alphabetically, by time, by checked status for check lists,
1832 or by a custom function.
1833 @end table
1835 @node Drawers
1836 @section Drawers
1837 @cindex drawers
1838 @cindex visibility cycling, drawers
1840 @cindex org-insert-drawer
1841 @kindex C-c C-x d
1842 Sometimes you want to keep information associated with an entry, but you
1843 normally don't want to see it.  For this, Org mode has @emph{drawers}.  They
1844 can contain anything but a headline and another drawer.  Drawers look like
1845 this:
1847 @example
1848 ** This is a headline
1849    Still outside the drawer
1850    :DRAWERNAME:
1851    This is inside the drawer.
1852    :END:
1853    After the drawer.
1854 @end example
1856 You can interactively insert drawers at point by calling
1857 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}.  With an active
1858 region, this command will put the region inside the drawer.  With a prefix
1859 argument, this command calls @code{org-insert-property-drawer} and add a
1860 property drawer right below the current headline.  Completion over drawer
1861 keywords is also possible using @key{M-TAB}.
1863 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1864 show the entry, but keep the drawer collapsed to a single line.  In order to
1865 look inside the drawer, you need to move the cursor to the drawer line and
1866 press @key{TAB} there.  Org mode uses the @code{PROPERTIES} drawer for
1867 storing properties (@pxref{Properties and columns}), and you can also arrange
1868 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1869 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.  If you
1870 want to store a quick note in the LOGBOOK drawer, in a similar way to state
1871 changes, use
1873 @table @kbd
1874 @kindex C-c C-z
1875 @item C-c C-z
1876 Add a time-stamped note to the LOGBOOK drawer.
1877 @end table
1879 @vindex org-export-with-drawers
1880 @vindex org-export-with-properties
1881 You can select the name of the drawers which should be exported with
1882 @code{org-export-with-drawers}.  In that case, drawer contents will appear in
1883 export output.  Property drawers are not affected by this variable: configure
1884 @code{org-export-with-properties} instead.
1886 @node Blocks
1887 @section Blocks
1889 @vindex org-hide-block-startup
1890 @cindex blocks, folding
1891 Org mode uses begin...end blocks for various purposes from including source
1892 code examples (@pxref{Literal examples}) to capturing time logging
1893 information (@pxref{Clocking work time}).  These blocks can be folded and
1894 unfolded by pressing TAB in the begin line.  You can also get all blocks
1895 folded at startup by configuring the option @code{org-hide-block-startup}
1896 or on a per-file basis by using
1898 @cindex @code{hideblocks}, STARTUP keyword
1899 @cindex @code{nohideblocks}, STARTUP keyword
1900 @example
1901 #+STARTUP: hideblocks
1902 #+STARTUP: nohideblocks
1903 @end example
1905 @node Footnotes
1906 @section Footnotes
1907 @cindex footnotes
1909 Org mode supports the creation of footnotes.  In contrast to the
1910 @file{footnote.el} package, Org mode's footnotes are designed for work on
1911 a larger document, not only for one-off documents like emails.
1913 A footnote is started by a footnote marker in square brackets in column 0, no
1914 indentation allowed.  It ends at the next footnote definition, headline, or
1915 after two consecutive empty lines.  The footnote reference is simply the
1916 marker in square brackets, inside text.  For example:
1918 @example
1919 The Org homepage[fn:1] now looks a lot better than it used to.
1921 [fn:1] The link is: http://orgmode.org
1922 @end example
1924 Org mode extends the number-based syntax to @emph{named} footnotes and
1925 optional inline definition.  Using plain numbers as markers (as
1926 @file{footnote.el} does) is supported for backward compatibility, but not
1927 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1928 @LaTeX{}}).  Here are the valid references:
1930 @table @code
1931 @item [1]
1932 A plain numeric footnote marker.  Compatible with @file{footnote.el}, but not
1933 recommended because something like @samp{[1]} could easily be part of a code
1934 snippet.
1935 @item [fn:name]
1936 A named footnote reference, where @code{name} is a unique label word, or, for
1937 simplicity of automatic creation, a number.
1938 @item [fn:: This is the inline definition of this footnote]
1939 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1940 reference point.
1941 @item [fn:name: a definition]
1942 An inline definition of a footnote, which also specifies a name for the note.
1943 Since Org allows multiple references to the same note, you can then use
1944 @code{[fn:name]} to create additional references.
1945 @end table
1947 @vindex org-footnote-auto-label
1948 Footnote labels can be created automatically, or you can create names yourself.
1949 This is handled by the variable @code{org-footnote-auto-label} and its
1950 corresponding @code{#+STARTUP} keywords.  See the docstring of that variable
1951 for details.
1953 @noindent The following command handles footnotes:
1955 @table @kbd
1956 @kindex C-c C-x f
1957 @item C-c C-x f
1958 The footnote action command.
1960 When the cursor is on a footnote reference, jump to the definition.  When it
1961 is at a definition, jump to the (first) reference.
1963 @vindex org-footnote-define-inline
1964 @vindex org-footnote-section
1965 @vindex org-footnote-auto-adjust
1966 Otherwise, create a new footnote.  Depending on the option
1967 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1968 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1969 definition will be placed right into the text as part of the reference, or
1970 separately into the location determined by the option
1971 @code{org-footnote-section}.
1973 When this command is called with a prefix argument, a menu of additional
1974 options is offered:
1975 @example
1976 s   @r{Sort the footnote definitions by reference sequence.  During editing,}
1977     @r{Org makes no effort to sort footnote definitions into a particular}
1978     @r{sequence.  If you want them sorted, use this command, which will}
1979     @r{also move entries according to @code{org-footnote-section}.  Automatic}
1980     @r{sorting after each insertion/deletion can be configured using the}
1981     @r{option @code{org-footnote-auto-adjust}.}
1982 r   @r{Renumber the simple @code{fn:N} footnotes.  Automatic renumbering}
1983     @r{after each insertion/deletion can be configured using the option}
1984     @r{@code{org-footnote-auto-adjust}.}
1985 S   @r{Short for first @code{r}, then @code{s} action.}
1986 n   @r{Normalize the footnotes by collecting all definitions (including}
1987     @r{inline definitions) into a special section, and then numbering them}
1988     @r{in sequence.  The references will then also be numbers.  This is}
1989     @r{meant to be the final step before finishing a document (e.g., sending}
1990     @r{off an email).}
1991 d   @r{Delete the footnote at point, and all definitions of and references}
1992     @r{to it.}
1993 @end example
1994 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1995 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1996 renumbering and sorting footnotes can be automatic after each insertion or
1997 deletion.
1999 @kindex C-c C-c
2000 @item C-c C-c
2001 If the cursor is on a footnote reference, jump to the definition.  If it is a
2002 the definition, jump back to the reference.  When called at a footnote
2003 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
2004 @kindex C-c C-o
2005 @kindex mouse-1
2006 @kindex mouse-2
2007 @item C-c C-o  @r{or} mouse-1/2
2008 Footnote labels are also links to the corresponding definition/reference, and
2009 you can use the usual commands to follow these links.
2011 @vindex org-edit-footnote-reference
2012 @kindex C-c '
2013 @item C-c '
2014 @item C-c '
2015 Edit the footnote definition corresponding to the reference at point in a
2016 seperate window.  This may be useful if editing footnotes in a narrowed
2017 buffer.  The window can be closed by pressing @kbd{C-c '}.
2019 @end table
2021 @node Orgstruct mode
2022 @section The Orgstruct minor mode
2023 @cindex Orgstruct mode
2024 @cindex minor mode for structure editing
2026 If you like the intuitive way the Org mode structure editing and list
2027 formatting works, you might want to use these commands in other modes like
2028 Text mode or Mail mode as well.  The minor mode @code{orgstruct-mode} makes
2029 this possible.   Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2030 turn it on by default, for example in Message mode, with one of:
2032 @lisp
2033 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2034 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2035 @end lisp
2037 When this mode is active and the cursor is on a line that looks to Org like a
2038 headline or the first line of a list item, most structure editing commands
2039 will work, even if the same keys normally have different functionality in the
2040 major mode you are using.  If the cursor is not in one of those special
2041 lines, Orgstruct mode lurks silently in the shadows.
2043 When you use @code{orgstruct++-mode}, Org will also export indentation and
2044 autofill settings into that mode, and detect item context after the first
2045 line of an item.
2047 @vindex orgstruct-heading-prefix-regexp
2048 You can also use Org structure editing to fold and unfold headlines in
2049 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2050 the regular expression must match the local prefix to use before Org's
2051 headlines.  For example, if you set this variable to @code{";; "} in Emacs
2052 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2053 commented lines.  Some commands like @code{org-demote} are disabled when the
2054 prefix is set, but folding/unfolding will work correctly.
2056 @node Org syntax
2057 @section Org syntax
2058 @cindex Org syntax
2060 A reference document providing a formal description of Org's syntax is
2061 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2062 Worg}, written and maintained by Nicolas Goaziou.  It defines Org's core
2063 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2064 keywords}, @code{(greater) elements} and @code{objects}.  Each part of an Org
2065 file falls into one of the categories above.
2067 To explore the abstract structure of an Org buffer, run this in a buffer:
2069 @lisp
2070 M-: (org-element-parse-buffer) RET
2071 @end lisp
2073 It will output a list containing the buffer's content represented as an
2074 abstract structure.  The export engine relies on the information stored in
2075 this list.  Most interactive commands (e.g., for structure editing) also
2076 rely on the syntactic meaning of the surrounding context.
2078 @node Tables
2079 @chapter Tables
2080 @cindex tables
2081 @cindex editing tables
2083 Org comes with a fast and intuitive table editor.  Spreadsheet-like
2084 calculations are supported using the Emacs @file{calc} package
2085 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2087 @menu
2088 * Built-in table editor::       Simple tables
2089 * Column width and alignment::  Overrule the automatic settings
2090 * Column groups::               Grouping to trigger vertical lines
2091 * Orgtbl mode::                 The table editor as minor mode
2092 * The spreadsheet::             The table editor has spreadsheet capabilities
2093 * Org-Plot::                    Plotting from org tables
2094 @end menu
2096 @node Built-in table editor
2097 @section The built-in table editor
2098 @cindex table editor, built-in
2100 Org makes it easy to format tables in plain ASCII@.  Any line with @samp{|} as
2101 the first non-whitespace character is considered part of a table.  @samp{|}
2102 is also the column separator@footnote{To insert a vertical bar into a table
2103 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}.  A table
2104 might look like this:
2106 @example
2107 | Name  | Phone | Age |
2108 |-------+-------+-----|
2109 | Peter |  1234 |  17 |
2110 | Anna  |  4321 |  25 |
2111 @end example
2113 A table is re-aligned automatically each time you press @key{TAB} or
2114 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
2115 the next field (@key{RET} to the next row) and creates new table rows
2116 at the end of the table or before horizontal lines.  The indentation
2117 of the table is set by the first line.  Any line starting with
2118 @samp{|-} is considered as a horizontal separator line and will be
2119 expanded on the next re-align to span the whole table width.  So, to
2120 create the above table, you would only type
2122 @example
2123 |Name|Phone|Age|
2125 @end example
2127 @noindent and then press @key{TAB} to align the table and start filling in
2128 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
2129 @kbd{C-c @key{RET}}.
2131 @vindex org-enable-table-editor
2132 @vindex org-table-auto-blank-field
2133 When typing text into a field, Org treats @key{DEL},
2134 @key{Backspace}, and all character keys in a special way, so that
2135 inserting and deleting avoids shifting other fields.  Also, when
2136 typing @emph{immediately after the cursor was moved into a new field
2137 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2138 field is automatically made blank.  If this behavior is too
2139 unpredictable for you, configure the options
2140 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2142 @table @kbd
2143 @tsubheading{Creation and conversion}
2144 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2145 Convert the active region to a table.  If every line contains at least one
2146 TAB character, the function assumes that the material is tab separated.
2147 If every line contains a comma, comma-separated values (CSV) are assumed.
2148 If not, lines are split at whitespace into fields.  You can use a prefix
2149 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2150 C-u} forces TAB, @kbd{C-u C-u C-u} will prompt for a regular expression to
2151 match the separator, and a numeric argument N indicates that at least N
2152 consecutive spaces, or alternatively a TAB will be the separator.
2154 If there is no active region, this command creates an empty Org
2155 table.  But it is easier just to start typing, like
2156 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2158 @tsubheading{Re-aligning and field motion}
2159 @orgcmd{C-c C-c,org-table-align}
2160 Re-align the table and don't move to another field.
2162 @orgcmd{C-c SPC,org-table-blank-field}
2163 Blank the field at point.
2165 @orgcmd{<TAB>,org-table-next-field}
2166 Re-align the table, move to the next field.  Creates a new row if
2167 necessary.
2169 @orgcmd{S-@key{TAB},org-table-previous-field}
2170 Re-align, move to previous field.
2172 @orgcmd{@key{RET},org-table-next-row}
2173 Re-align the table and move down to next row.  Creates a new row if
2174 necessary.  At the beginning or end of a line, @key{RET} still does
2175 NEWLINE, so it can be used to split a table.
2177 @orgcmd{M-a,org-table-beginning-of-field}
2178 Move to beginning of the current table field, or on to the previous field.
2179 @orgcmd{M-e,org-table-end-of-field}
2180 Move to end of the current table field, or on to the next field.
2182 @tsubheading{Column and row editing}
2183 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2184 Move the current column left/right.
2186 @orgcmd{M-S-@key{left},org-table-delete-column}
2187 Kill the current column.
2189 @orgcmd{M-S-@key{right},org-table-insert-column}
2190 Insert a new column to the left of the cursor position.
2192 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2193 Move the current row up/down.
2195 @orgcmd{M-S-@key{up},org-table-kill-row}
2196 Kill the current row or horizontal line.
2198 @orgcmd{M-S-@key{down},org-table-insert-row}
2199 Insert a new row above the current row.  With a prefix argument, the line is
2200 created below the current one.
2202 @orgcmd{C-c -,org-table-insert-hline}
2203 Insert a horizontal line below current row.  With a prefix argument, the line
2204 is created above the current line.
2206 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2207 Insert a horizontal line below current row, and move the cursor into the row
2208 below that line.
2210 @orgcmd{C-c ^,org-table-sort-lines}
2211 Sort the table lines in the region.  The position of point indicates the
2212 column to be used for sorting, and the range of lines is the range
2213 between the nearest horizontal separator lines, or the entire table.  If
2214 point is before the first column, you will be prompted for the sorting
2215 column.  If there is an active region, the mark specifies the first line
2216 and the sorting column, while point should be in the last line to be
2217 included into the sorting.  The command prompts for the sorting type
2218 (alphabetically, numerically, or by time).  You can sort in normal or
2219 reverse order.  You can also supply your own key extraction and comparison
2220 functions.  When called with a prefix argument, alphabetic sorting will be
2221 case-sensitive.
2223 @tsubheading{Regions}
2224 @orgcmd{C-c C-x M-w,org-table-copy-region}
2225 Copy a rectangular region from a table to a special clipboard.  Point and
2226 mark determine edge fields of the rectangle.  If there is no active region,
2227 copy just the current field.  The process ignores horizontal separator lines.
2229 @orgcmd{C-c C-x C-w,org-table-cut-region}
2230 Copy a rectangular region from a table to a special clipboard, and
2231 blank all fields in the rectangle.  So this is the ``cut'' operation.
2233 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2234 Paste a rectangular region into a table.
2235 The upper left corner ends up in the current field.  All involved fields
2236 will be overwritten.  If the rectangle does not fit into the present table,
2237 the table is enlarged as needed.  The process ignores horizontal separator
2238 lines.
2240 @orgcmd{M-@key{RET},org-table-wrap-region}
2241 Split the current field at the cursor position and move the rest to the line
2242 below.  If there is an active region, and both point and mark are in the same
2243 column, the text in the column is wrapped to minimum width for the given
2244 number of lines.  A numeric prefix argument may be used to change the number
2245 of desired lines.  If there is no region, but you specify a prefix argument,
2246 the current field is made blank, and the content is appended to the field
2247 above.
2249 @tsubheading{Calculations}
2250 @cindex formula, in tables
2251 @cindex calculations, in tables
2252 @cindex region, active
2253 @cindex active region
2254 @cindex transient mark mode
2255 @orgcmd{C-c +,org-table-sum}
2256 Sum the numbers in the current column, or in the rectangle defined by
2257 the active region.  The result is shown in the echo area and can
2258 be inserted with @kbd{C-y}.
2260 @orgcmd{S-@key{RET},org-table-copy-down}
2261 @vindex org-table-copy-increment
2262 When current field is empty, copy from first non-empty field above.  When not
2263 empty, copy current field down to next row and move cursor along with it.
2264 Depending on the option @code{org-table-copy-increment}, integer field
2265 values will be incremented during copy.  Integers that are too large will not
2266 be incremented.  Also, a @code{0} prefix argument temporarily disables the
2267 increment.  This key is also used by shift-selection and related modes
2268 (@pxref{Conflicts}).
2270 @tsubheading{Miscellaneous}
2271 @orgcmd{C-c `,org-table-edit-field}
2272 Edit the current field in a separate window.  This is useful for fields that
2273 are not fully visible (@pxref{Column width and alignment}).  When called with
2274 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2275 edited in place.  When called with two @kbd{C-u} prefixes, make the editor
2276 window follow the cursor through the table and always show the current
2277 field.  The follow mode exits automatically when the cursor leaves the table,
2278 or when you repeat this command with @kbd{C-u C-u C-c `}.
2280 @item M-x org-table-import RET
2281 Import a file as a table.  The table should be TAB or whitespace
2282 separated.  Use, for example, to import a spreadsheet table or data
2283 from a database, because these programs generally can write
2284 TAB-separated text files.  This command works by inserting the file into
2285 the buffer and then converting the region to a table.  Any prefix
2286 argument is passed on to the converter, which uses it to determine the
2287 separator.
2288 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2289 Tables can also be imported by pasting tabular text into the Org
2290 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2291 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2293 @item M-x org-table-export RET
2294 @findex org-table-export
2295 @vindex org-table-export-default-format
2296 Export the table, by default as a TAB-separated file.  Use for data
2297 exchange with, for example, spreadsheet or database programs.  The format
2298 used to export the file can be configured in the option
2299 @code{org-table-export-default-format}.  You may also use properties
2300 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2301 name and the format for table export in a subtree.  Org supports quite
2302 general formats for exported tables.  The exporter format is the same as the
2303 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2304 detailed description.
2305 @end table
2307 If you don't like the automatic table editor because it gets in your
2308 way on lines which you would like to start with @samp{|}, you can turn
2309 it off with
2311 @lisp
2312 (setq org-enable-table-editor nil)
2313 @end lisp
2315 @noindent Then the only table command that still works is
2316 @kbd{C-c C-c} to do a manual re-align.
2318 @node Column width and alignment
2319 @section Column width and alignment
2320 @cindex narrow columns in tables
2321 @cindex alignment in tables
2323 The width of columns is automatically determined by the table editor.  And
2324 also the alignment of a column is determined automatically from the fraction
2325 of number-like versus non-number fields in the column.
2327 Sometimes a single field or a few fields need to carry more text, leading to
2328 inconveniently wide columns.  Or maybe you want to make a table with several
2329 columns having a fixed width, regardless of content.  To set@footnote{This
2330 feature does not work on XEmacs.} the width of a column, one field anywhere
2331 in the column may contain just the string @samp{<N>} where @samp{N} is an
2332 integer specifying the width of the column in characters.  The next re-align
2333 will then set the width of this column to this value.
2335 @example
2336 @group
2337 |---+------------------------------|               |---+--------|
2338 |   |                              |               |   | <6>    |
2339 | 1 | one                          |               | 1 | one    |
2340 | 2 | two                          |     ----\     | 2 | two    |
2341 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
2342 | 4 | four                         |               | 4 | four   |
2343 |---+------------------------------|               |---+--------|
2344 @end group
2345 @end example
2347 @noindent
2348 Fields that are wider become clipped and end in the string @samp{=>}.
2349 Note that the full text is still in the buffer but is hidden.
2350 To see the full text, hold the mouse over the field---a tool-tip window
2351 will show the full content.  To edit such a field, use the command
2352 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
2353 open a new window with the full field.  Edit it and finish with @kbd{C-c
2354 C-c}.
2356 @vindex org-startup-align-all-tables
2357 When visiting a file containing a table with narrowed columns, the
2358 necessary character hiding has not yet happened, and the table needs to
2359 be aligned before it looks nice.  Setting the option
2360 @code{org-startup-align-all-tables} will realign all tables in a file
2361 upon visiting, but also slow down startup.  You can also set this option
2362 on a per-file basis with:
2364 @example
2365 #+STARTUP: align
2366 #+STARTUP: noalign
2367 @end example
2369 If you would like to overrule the automatic alignment of number-rich columns
2370 to the right and of string-rich column to the left, you can use @samp{<r>},
2371 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2372 effect when exporting to HTML.} or @samp{<l>} in a similar fashion.  You may
2373 also combine alignment and field width like this: @samp{<r10>}.
2375 Lines which only contain these formatting cookies will be removed
2376 automatically when exporting the document.
2378 @node Column groups
2379 @section Column groups
2380 @cindex grouping columns in tables
2382 When Org exports tables, it does so by default without vertical
2383 lines because that is visually more satisfying in general.  Occasionally
2384 however, vertical lines can be useful to structure a table into groups
2385 of columns, much like horizontal lines can do for groups of rows.  In
2386 order to specify column groups, you can use a special row where the
2387 first field contains only @samp{/}.  The further fields can either
2388 contain @samp{<} to indicate that this column should start a group,
2389 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2390 and @samp{>}) to make a column
2391 a group of its own.  Boundaries between column groups will upon export be
2392 marked with vertical lines.  Here is an example:
2394 @example
2395 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2396 |---+-----+-----+-----+---------+------------|
2397 | / |   < |     |   > |       < |          > |
2398 | 1 |   1 |   1 |   1 |       1 |          1 |
2399 | 2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
2400 | 3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
2401 |---+-----+-----+-----+---------+------------|
2402 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2403 @end example
2405 It is also sufficient to just insert the column group starters after
2406 every vertical line you would like to have:
2408 @example
2409 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2410 |----+-----+-----+-----+---------+------------|
2411 | /  | <   |     |     | <       |            |
2412 @end example
2414 @node Orgtbl mode
2415 @section The Orgtbl minor mode
2416 @cindex Orgtbl mode
2417 @cindex minor mode for tables
2419 If you like the intuitive way the Org table editor works, you
2420 might also want to use it in other modes like Text mode or Mail mode.
2421 The minor mode Orgtbl mode makes this possible.  You can always toggle
2422 the mode with @kbd{M-x orgtbl-mode RET}.  To turn it on by default, for
2423 example in Message mode, use
2425 @lisp
2426 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2427 @end lisp
2429 Furthermore, with some special setup, it is possible to maintain tables
2430 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
2431 construct @LaTeX{} tables with the underlying ease and power of
2432 Orgtbl mode, including spreadsheet capabilities.  For details, see
2433 @ref{Tables in arbitrary syntax}.
2435 @node The spreadsheet
2436 @section The spreadsheet
2437 @cindex calculations, in tables
2438 @cindex spreadsheet capabilities
2439 @cindex @file{calc} package
2441 The table editor makes use of the Emacs @file{calc} package to implement
2442 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
2443 derive fields from other fields.  While fully featured, Org's implementation
2444 is not identical to other spreadsheets.  For example, Org knows the concept
2445 of a @emph{column formula} that will be applied to all non-header fields in a
2446 column without having to copy the formula to each relevant field.  There is
2447 also a formula debugger, and a formula editor with features for highlighting
2448 fields in the table corresponding to the references at the point in the
2449 formula, moving these references by arrow keys
2451 @menu
2452 * References::                  How to refer to another field or range
2453 * Formula syntax for Calc::     Using Calc to compute stuff
2454 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
2455 * Durations and time values::   How to compute durations and time values
2456 * Field and range formulas::    Formula for specific (ranges of) fields
2457 * Column formulas::             Formulas valid for an entire column
2458 * Lookup functions::            Lookup functions for searching tables
2459 * Editing and debugging formulas::  Fixing formulas
2460 * Updating the table::          Recomputing all dependent fields
2461 * Advanced features::           Field and column names, parameters and automatic recalc
2462 @end menu
2464 @node References
2465 @subsection References
2466 @cindex references
2468 To compute fields in the table from other fields, formulas must
2469 reference other fields or ranges.  In Org, fields can be referenced
2470 by name, by absolute coordinates, and by relative coordinates.  To find
2471 out what the coordinates of a field are, press @kbd{C-c ?} in that
2472 field, or press @kbd{C-c @}} to toggle the display of a grid.
2474 @subsubheading Field references
2475 @cindex field references
2476 @cindex references, to fields
2478 Formulas can reference the value of another field in two ways.  Like in
2479 any other spreadsheet, you may reference fields with a letter/number
2480 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2481 @vindex org-table-use-standard-references
2482 However, Org prefers@footnote{Org will understand references typed by the
2483 user as @samp{B4}, but it will not use this syntax when offering a formula
2484 for editing.  You can customize this behavior using the option
2485 @code{org-table-use-standard-references}.} to use another, more general
2486 representation that looks like this:
2487 @example
2488 @@@var{row}$@var{column}
2489 @end example
2491 Column specifications can be absolute like @code{$1},
2492 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2493 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2494 @code{$<} and @code{$>} are immutable references to the first and last
2495 column, respectively, and you can use @code{$>>>} to indicate the third
2496 column from the right.
2498 The row specification only counts data lines and ignores horizontal separator
2499 lines (hlines).  Like with columns, you can use absolute row numbers
2500 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2501 current row like @code{@@+3} or @code{@@-1}.  @code{@@<} and @code{@@>} are
2502 immutable references the first and last@footnote{For backward compatibility
2503 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2504 a stable way to the 5th and 12th field in the last row of the table.
2505 However, this syntax is deprecated, it should not be used for new documents.
2506 Use @code{@@>$} instead.} row in the table, respectively.  You may also
2507 specify the row relative to one of the hlines: @code{@@I} refers to the first
2508 hline, @code{@@II} to the second, etc.  @code{@@-I} refers to the first such
2509 line above the current line, @code{@@+I} to the first such line below the
2510 current line.  You can also write @code{@@III+2} which is the second data line
2511 after the third hline in the table.
2513 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2514 i.e., to the row/column for the field being computed.  Also, if you omit
2515 either the column or the row part of the reference, the current row/column is
2516 implied.
2518 Org's references with @emph{unsigned} numbers are fixed references
2519 in the sense that if you use the same reference in the formula for two
2520 different fields, the same field will be referenced each time.
2521 Org's references with @emph{signed} numbers are floating
2522 references because the same reference operator can reference different
2523 fields depending on the field being calculated by the formula.
2525 Here are a few examples:
2527 @example
2528 @@2$3      @r{2nd row, 3rd column (same as @code{C2})}
2529 $5        @r{column 5 in the current row (same as @code{E&})}
2530 @@2        @r{current column, row 2}
2531 @@-1$-3    @r{the field one row up, three columns to the left}
2532 @@-I$2     @r{field just under hline above current row, column 2}
2533 @@>$5      @r{field in the last row, in column 5}
2534 @end example
2536 @subsubheading Range references
2537 @cindex range references
2538 @cindex references, to ranges
2540 You may reference a rectangular range of fields by specifying two field
2541 references connected by two dots @samp{..}.  If both fields are in the
2542 current row, you may simply use @samp{$2..$7}, but if at least one field
2543 is in a different row, you need to use the general @code{@@row$column}
2544 format at least for the first field (i.e the reference must start with
2545 @samp{@@} in order to be interpreted correctly).  Examples:
2547 @example
2548 $1..$3        @r{first three fields in the current row}
2549 $P..$Q        @r{range, using column names (see under Advanced)}
2550 $<<<..$>>     @r{start in third column, continue to the last but one}
2551 @@2$1..@@4$3    @r{6 fields between these two fields (same as @code{A2..C4})}
2552 @@-1$-2..@@-1   @r{3 fields in the row above, starting from 2 columns on the left}
2553 @@I..II        @r{between first and second hline, short for @code{@@I..@@II}}
2554 @end example
2556 @noindent Range references return a vector of values that can be fed
2557 into Calc vector functions.  Empty fields in ranges are normally suppressed,
2558 so that the vector contains only the non-empty fields.  For other options
2559 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2560 for Calc}.
2562 @subsubheading Field coordinates in formulas
2563 @cindex field coordinates
2564 @cindex coordinates, of field
2565 @cindex row, of field coordinates
2566 @cindex column, of field coordinates
2568 One of the very first actions during evaluation of Calc formulas and Lisp
2569 formulas is to substitute @code{@@#} and @code{$#} in the formula with the
2570 row or column number of the field where the current result will go to.  The
2571 traditional Lisp formula equivalents are @code{org-table-current-dline} and
2572 @code{org-table-current-column}.  Examples:
2574 @table @code
2575 @item if(@@# % 2, $#, string(""))
2576 Insert column number on odd rows, set field to empty on even rows.
2577 @item $2 = '(identity remote(FOO, @@@@#$1))
2578 Copy text or values of each row of column 1 of the table named @code{FOO}
2579 into column 2 of the current table.
2580 @item @@3 = 2 * remote(FOO, @@1$$#)
2581 Insert the doubled value of each column of row 1 of the table named
2582 @code{FOO} into row 3 of the current table.
2583 @end table
2585 @noindent For the second/third example, the table named @code{FOO} must have
2586 at least as many rows/columns as the current table.  Note that this is
2587 inefficient@footnote{The computation time scales as O(N^2) because the table
2588 named @code{FOO} is parsed for each field to be read.} for large number of
2589 rows/columns.
2591 @subsubheading Named references
2592 @cindex named references
2593 @cindex references, named
2594 @cindex name, of column or field
2595 @cindex constants, in calculations
2596 @cindex #+CONSTANTS
2598 @vindex org-table-formula-constants
2599 @samp{$name} is interpreted as the name of a column, parameter or
2600 constant.  Constants are defined globally through the option
2601 @code{org-table-formula-constants}, and locally (for the file) through a
2602 line like
2604 @example
2605 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2606 @end example
2608 @noindent
2609 @vindex constants-unit-system
2610 @pindex constants.el
2611 Also properties (@pxref{Properties and columns}) can be used as
2612 constants in table formulas: for a property @samp{:Xyz:} use the name
2613 @samp{$PROP_Xyz}, and the property will be searched in the current
2614 outline entry and in the hierarchy above it.  If you have the
2615 @file{constants.el} package, it will also be used to resolve constants,
2616 including natural constants like @samp{$h} for Planck's constant, and
2617 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2618 supply the values of constants in two different unit systems, @code{SI}
2619 and @code{cgs}.  Which one is used depends on the value of the variable
2620 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
2621 @code{constSI} and @code{constcgs} to set this value for the current
2622 buffer.}.  Column names and parameters can be specified in special table
2623 lines.  These are described below, see @ref{Advanced features}.  All
2624 names must start with a letter, and further consist of letters and
2625 numbers.
2627 @subsubheading Remote references
2628 @cindex remote references
2629 @cindex references, remote
2630 @cindex references, to a different table
2631 @cindex name, of column or field
2632 @cindex constants, in calculations
2633 @cindex #+NAME, for table
2635 You may also reference constants, fields and ranges from a different table,
2636 either in the current file or even in a different file.  The syntax is
2638 @example
2639 remote(NAME-OR-ID,REF)
2640 @end example
2642 @noindent
2643 where NAME can be the name of a table in the current file as set by a
2644 @code{#+NAME: Name} line before the table.  It can also be the ID of an
2645 entry, even in a different file, and the reference then refers to the first
2646 table in that entry.  REF is an absolute field or range reference as
2647 described above for example @code{@@3$3} or @code{$somename}, valid in the
2648 referenced table.
2650 Indirection of NAME-OR-ID: When NAME-OR-ID has the format @code{@@ROW$COLUMN}
2651 it will be substituted with the name or ID found in this field of the current
2652 table.  For example @code{remote($1, @@>$2)} => @code{remote(year_2013,
2653 @@>$1)}.  The format @code{B3} is not supported because it can not be
2654 distinguished from a plain table name or ID.
2656 @node Formula syntax for Calc
2657 @subsection Formula syntax for Calc
2658 @cindex formula syntax, Calc
2659 @cindex syntax, of formulas
2661 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2662 package.  Note that @file{calc} has the non-standard convention that @samp{/}
2663 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2664 @samp{a/(b*c)}.  Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2665 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2666 GNU Emacs Calc Manual}), variable substitution takes place according to the
2667 rules described above.
2668 @cindex vectors, in table calculations
2669 The range vectors can be directly fed into the Calc vector functions
2670 like @samp{vmean} and @samp{vsum}.
2672 @cindex format specifier
2673 @cindex mode, for @file{calc}
2674 @vindex org-calc-default-modes
2675 A formula can contain an optional mode string after a semicolon.  This
2676 string consists of flags to influence Calc and other modes during
2677 execution.  By default, Org uses the standard Calc modes (precision
2678 12, angular units degrees, fraction and symbolic modes off).  The display
2679 format, however, has been changed to @code{(float 8)} to keep tables
2680 compact.  The default settings can be configured using the option
2681 @code{org-calc-default-modes}.
2683 @noindent List of modes:
2685 @table @asis
2686 @item @code{p20}
2687 Set the internal Calc calculation precision to 20 digits.
2688 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2689 Normal, scientific, engineering or fixed format of the result of Calc passed
2690 back to Org.  Calc formatting is unlimited in precision as long as the Calc
2691 calculation precision is greater.
2692 @item @code{D}, @code{R}
2693 Degree and radian angle modes of Calc.
2694 @item @code{F}, @code{S}
2695 Fraction and symbolic modes of Calc.
2696 @item @code{T}, @code{t}
2697 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2698 @item @code{E}
2699 If and how to consider empty fields.  Without @samp{E} empty fields in range
2700 references are suppressed so that the Calc vector or Lisp list contains only
2701 the non-empty fields.  With @samp{E} the empty fields are kept.  For empty
2702 fields in ranges or empty field references the value @samp{nan} (not a
2703 number) is used in Calc formulas and the empty string is used for Lisp
2704 formulas.  Add @samp{N} to use 0 instead for both formula types.  For the
2705 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2706 @item @code{N}
2707 Interpret all fields as numbers, use 0 for non-numbers.  See the next section
2708 to see how this is essential for computations with Lisp formulas.  In Calc
2709 formulas it is used only occasionally because there number strings are
2710 already interpreted as numbers without @samp{N}.
2711 @item @code{L}
2712 Literal, for Lisp formulas only.  See the next section.
2713 @end table
2715 @noindent
2716 Unless you use large integer numbers or high-precision-calculation and
2717 -display for floating point numbers you may alternatively provide a
2718 @samp{printf} format specifier to reformat the Calc result after it has been
2719 passed back to Org instead of letting Calc already do the
2720 formatting@footnote{The @samp{printf} reformatting is limited in precision
2721 because the value passed to it is converted into an @samp{integer} or
2722 @samp{double}.  The @samp{integer} is limited in size by truncating the
2723 signed value to 32 bits.  The @samp{double} is limited in precision to 64
2724 bits overall which leaves approximately 16 significant decimal digits.}.  A
2725 few examples:
2727 @example
2728 $1+$2                @r{Sum of first and second field}
2729 $1+$2;%.2f           @r{Same, format result to two decimals}
2730 exp($2)+exp($1)      @r{Math functions can be used}
2731 $0;%.1f              @r{Reformat current cell to 1 decimal}
2732 ($3-32)*5/9          @r{Degrees F -> C conversion}
2733 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
2734 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
2735 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
2736 taylor($3,x=7,2)     @r{Taylor series of $3, at x=7, second degree}
2737 @end example
2739 Calc also contains a complete set of logical operations, (@pxref{Logical
2740 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}).  For example
2742 @table @code
2743 @item if($1 < 20, teen, string(""))
2744 "teen" if age $1 is less than 20, else the Org table result field is set to
2745 empty with the empty string.
2746 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1
2747 Sum of the first two columns.  When at least one of the input fields is empty
2748 the Org table result field is set to empty.  @samp{E} is required to not
2749 convert empty fields to 0.  @samp{f-1} is an optional Calc format string
2750 similar to @samp{%.1f} but leaves empty results empty.
2751 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2752 Mean value of a range unless there is any empty field.  Every field in the
2753 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2754 in @samp{nan}.  Then @samp{typeof == 12} detects the @samp{nan} from
2755 @samp{vmean} and the Org table result field is set to empty.  Use this when
2756 the sample set is expected to never have missing values.
2757 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2758 Mean value of a range with empty fields skipped.  Every field in the range
2759 that is empty is skipped.  When all fields in the range are empty the mean
2760 value is not defined and the Org table result field is set to empty.  Use
2761 this when the sample set can have a variable size.
2762 @item vmean($1..$7); EN
2763 To complete the example before: Mean value of a range with empty fields
2764 counting as samples with value 0.  Use this only when incomplete sample sets
2765 should be padded with 0 to the full size.
2766 @end table
2768 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2769 and use them in formula syntax for Calc.
2771 @node Formula syntax for Lisp
2772 @subsection Emacs Lisp forms as formulas
2773 @cindex Lisp forms, as table formulas
2775 It is also possible to write a formula in Emacs Lisp.  This can be useful
2776 for string manipulation and control structures, if Calc's functionality is
2777 not enough.
2779 If a formula starts with a single-quote followed by an opening parenthesis,
2780 then it is evaluated as a Lisp form.  The evaluation should return either a
2781 string or a number.  Just as with @file{calc} formulas, you can specify modes
2782 and a printf format after a semicolon.
2784 With Emacs Lisp forms, you need to be conscious about the way field
2785 references are interpolated into the form.  By default, a reference will be
2786 interpolated as a Lisp string (in double-quotes) containing the field.  If
2787 you provide the @samp{N} mode switch, all referenced elements will be numbers
2788 (non-number fields will be zero) and interpolated as Lisp numbers, without
2789 quotes.  If you provide the @samp{L} flag, all fields will be interpolated
2790 literally, without quotes.  I.e., if you want a reference to be interpreted
2791 as a string by the Lisp form, enclose the reference operator itself in
2792 double-quotes, like @code{"$3"}.  Ranges are inserted as space-separated
2793 fields, so you can embed them in list or vector syntax.
2795 Here are a few examples---note how the @samp{N} mode is used when we do
2796 computations in Lisp:
2798 @table @code
2799 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2800 Swap the first two characters of the content of column 1.
2801 @item '(+ $1 $2);N
2802 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2803 @item '(apply '+ '($1..$4));N
2804 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2805 @end table
2807 @node Durations and time values
2808 @subsection Durations and time values
2809 @cindex Duration, computing
2810 @cindex Time, computing
2811 @vindex org-table-duration-custom-format
2813 If you want to compute time values use the @code{T} flag, either in Calc
2814 formulas or Elisp formulas:
2816 @example
2817 @group
2818   |  Task 1 |   Task 2 |    Total |
2819   |---------+----------+----------|
2820   |    2:12 |     1:47 | 03:59:00 |
2821   | 3:02:20 | -2:07:00 |     0.92 |
2822   #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2823 @end group
2824 @end example
2826 Input duration values must be of the form @code{HH:MM[:SS]}, where seconds
2827 are optional.  With the @code{T} flag, computed durations will be displayed
2828 as @code{HH:MM:SS} (see the first formula above).  With the @code{t} flag,
2829 computed durations will be displayed according to the value of the option
2830 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2831 will display the result as a fraction of hours (see the second formula in the
2832 example above).
2834 Negative duration values can be manipulated as well, and integers will be
2835 considered as seconds in addition and subtraction.
2837 @node Field and range formulas
2838 @subsection Field and range formulas
2839 @cindex field formula
2840 @cindex range formula
2841 @cindex formula, for individual table field
2842 @cindex formula, for range of fields
2844 To assign a formula to a particular field, type it directly into the field,
2845 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}.  When you press
2846 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2847 the formula will be stored as the formula for this field, evaluated, and the
2848 current field will be replaced with the result.
2850 @cindex #+TBLFM
2851 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2852 below the table.  If you type the equation in the 4th field of the 3rd data
2853 line in the table, the formula will look like @samp{@@3$4=$1+$2}.  When
2854 inserting/deleting/swapping columns and rows with the appropriate commands,
2855 @i{absolute references} (but not relative ones) in stored formulas are
2856 modified in order to still reference the same field.  To avoid this, in
2857 particular in range references, anchor ranges at the table borders (using
2858 @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines using the
2859 @code{@@I} notation.  Automatic adaptation of field references does of course
2860 not happen if you edit the table structure with normal editing
2861 commands---then you must fix the equations yourself.
2863 Instead of typing an equation into the field, you may also use the following
2864 command
2866 @table @kbd
2867 @orgcmd{C-u C-c =,org-table-eval-formula}
2868 Install a new formula for the current field.  The command prompts for a
2869 formula with default taken from the @samp{#+TBLFM:} line, applies
2870 it to the current field, and stores it.
2871 @end table
2873 The left-hand side of a formula can also be a special expression in order to
2874 assign the formula to a number of different fields.  There is no keyboard
2875 shortcut to enter such range formulas.  To add them, use the formula editor
2876 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2877 directly.
2879 @table @code
2880 @item $2=
2881 Column formula, valid for the entire column.  This is so common that Org
2882 treats these formulas in a special way, see @ref{Column formulas}.
2883 @item @@3=
2884 Row formula, applies to all fields in the specified row.  @code{@@>=} means
2885 the last row.
2886 @item @@1$2..@@4$3=
2887 Range formula, applies to all fields in the given rectangular range.  This
2888 can also be used to assign a formula to some but not all fields in a row.
2889 @item $name=
2890 Named field, see @ref{Advanced features}.
2891 @end table
2893 @node Column formulas
2894 @subsection Column formulas
2895 @cindex column formula
2896 @cindex formula, for table column
2898 When you assign a formula to a simple column reference like @code{$3=}, the
2899 same formula will be used in all fields of that column, with the following
2900 very convenient exceptions: (i) If the table contains horizontal separator
2901 hlines with rows above and below, everything before the first such hline is
2902 considered part of the table @emph{header} and will not be modified by column
2903 formulas.  Therefore a header is mandatory when you use column formulas and
2904 want to add hlines to group rows, like for example to separate a total row at
2905 the bottom from the summand rows above.  (ii) Fields that already get a value
2906 from a field/range formula will be left alone by column formulas.  These
2907 conditions make column formulas very easy to use.
2909 To assign a formula to a column, type it directly into any field in the
2910 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2911 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2912 the formula will be stored as the formula for the current column, evaluated
2913 and the current field replaced with the result.  If the field contains only
2914 @samp{=}, the previously stored formula for this column is used.  For each
2915 column, Org will only remember the most recently used formula.  In the
2916 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}.  The
2917 left-hand side of a column formula cannot be the name of column, it must be
2918 the numeric column reference or @code{$>}.
2920 Instead of typing an equation into the field, you may also use the
2921 following command:
2923 @table @kbd
2924 @orgcmd{C-c =,org-table-eval-formula}
2925 Install a new formula for the current column and replace current field with
2926 the result of the formula.  The command prompts for a formula, with default
2927 taken from the @samp{#+TBLFM} line, applies it to the current field and
2928 stores it.  With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2929 will apply it to that many consecutive fields in the current column.
2930 @end table
2932 @node Lookup functions
2933 @subsection Lookup functions
2934 @cindex lookup functions in tables
2935 @cindex table lookup functions
2937 Org has three predefined Emacs Lisp functions for lookups in tables.
2938 @table @code
2939 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2940 @findex org-lookup-first
2941 Searches for the first element @code{S} in list @code{S-LIST} for which
2942 @lisp
2943 (PREDICATE VAL S)
2944 @end lisp
2945 is @code{t}; returns the value from the corresponding position in list
2946 @code{R-LIST}.  The default @code{PREDICATE} is @code{equal}.  Note that the
2947 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2948 order as the corresponding parameters are in the call to
2949 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}.  If
2950 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2951 is returned.
2952 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2953 @findex org-lookup-last
2954 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2955 element for which @code{PREDICATE} is @code{t}.
2956 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2957 @findex org-lookup-all
2958 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2959 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2960 values.  This function can not be used by itself in a formula, because it
2961 returns a list of values.  However, powerful lookups can be built when this
2962 function is combined with other Emacs Lisp functions.
2963 @end table
2965 If the ranges used in these functions contain empty fields, the @code{E} mode
2966 for the formula should usually be specified: otherwise empty fields will not be
2967 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2968 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2969 element of @code{R-LIST}.
2971 These three functions can be used to implement associative arrays, count
2972 matching cells, rank results, group data etc.  For practical examples
2973 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2974 tutorial on Worg}.
2976 @node Editing and debugging formulas
2977 @subsection Editing and debugging formulas
2978 @cindex formula editing
2979 @cindex editing, of table formulas
2981 @vindex org-table-use-standard-references
2982 You can edit individual formulas in the minibuffer or directly in the field.
2983 Org can also prepare a special buffer with all active formulas of a table.
2984 When offering a formula for editing, Org converts references to the standard
2985 format (like @code{B3} or @code{D&}) if possible.  If you prefer to only work
2986 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2987 option @code{org-table-use-standard-references}.
2989 @table @kbd
2990 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2991 Edit the formula associated with the current column/field in the
2992 minibuffer.  See @ref{Column formulas}, and @ref{Field and range formulas}.
2993 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2994 Re-insert the active formula (either a
2995 field formula, or a column formula) into the current field, so that you
2996 can edit it directly in the field.  The advantage over editing in the
2997 minibuffer is that you can use the command @kbd{C-c ?}.
2998 @orgcmd{C-c ?,org-table-field-info}
2999 While editing a formula in a table field, highlight the field(s)
3000 referenced by the reference at the cursor position in the formula.
3001 @kindex C-c @}
3002 @findex org-table-toggle-coordinate-overlays
3003 @item C-c @}
3004 Toggle the display of row and column numbers for a table, using overlays
3005 (@command{org-table-toggle-coordinate-overlays}).  These are updated each
3006 time the table is aligned; you can force it with @kbd{C-c C-c}.
3007 @kindex C-c @{
3008 @findex org-table-toggle-formula-debugger
3009 @item C-c @{
3010 Toggle the formula debugger on and off
3011 (@command{org-table-toggle-formula-debugger}).  See below.
3012 @orgcmd{C-c ',org-table-edit-formulas}
3013 Edit all formulas for the current table in a special buffer, where the
3014 formulas will be displayed one per line.  If the current field has an
3015 active formula, the cursor in the formula editor will mark it.
3016 While inside the special buffer, Org will automatically highlight
3017 any field or range reference at the cursor position.  You may edit,
3018 remove and add formulas, and use the following commands:
3020 @table @kbd
3021 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
3022 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
3023 prefix, also apply the new formulas to the entire table.
3024 @orgcmd{C-c C-q,org-table-fedit-abort}
3025 Exit the formula editor without installing changes.
3026 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3027 Toggle all references in the formula editor between standard (like
3028 @code{B3}) and internal (like @code{@@3$2}).
3029 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3030 Pretty-print or indent Lisp formula at point.  When in a line containing
3031 a Lisp formula, format the formula according to Emacs Lisp rules.
3032 Another @key{TAB} collapses the formula back again.  In the open
3033 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3034 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3035 Complete Lisp symbols, just like in Emacs Lisp mode.
3036 @kindex S-@key{up}
3037 @kindex S-@key{down}
3038 @kindex S-@key{left}
3039 @kindex S-@key{right}
3040 @findex org-table-fedit-ref-up
3041 @findex org-table-fedit-ref-down
3042 @findex org-table-fedit-ref-left
3043 @findex org-table-fedit-ref-right
3044 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3045 Shift the reference at point.  For example, if the reference is
3046 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3047 This also works for relative references and for hline references.
3048 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3049 Move the test line for column formulas in the Org buffer up and
3050 down.
3051 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3052 Scroll the window displaying the table.
3053 @kindex C-c @}
3054 @findex org-table-toggle-coordinate-overlays
3055 @item C-c @}
3056 Turn the coordinate grid in the table on and off.
3057 @end table
3058 @end table
3060 Making a table field blank does not remove the formula associated with
3061 the field, because that is stored in a different line (the @samp{#+TBLFM}
3062 line)---during the next recalculation the field will be filled again.
3063 To remove a formula from a field, you have to give an empty reply when
3064 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3066 @kindex C-c C-c
3067 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3068 equations with @kbd{C-c C-c} in that line or with the normal
3069 recalculation commands in the table.
3071 @anchor{Using multiple #+TBLFM lines}
3072 @subsubheading Using multiple #+TBLFM lines
3073 @cindex #+TBLFM line, multiple
3074 @cindex #+TBLFM
3075 @cindex #+TBLFM, switching
3076 @kindex C-c C-c
3078 You may apply the formula temporarily.  This is useful when you
3079 switch the formula.  Place multiple @samp{#+TBLFM} lines right
3080 after the table, and then press @kbd{C-c C-c} on the formula to
3081 apply.  Here is an example:
3083 @example
3084 | x | y |
3085 |---+---|
3086 | 1 |   |
3087 | 2 |   |
3088 #+TBLFM: $2=$1*1
3089 #+TBLFM: $2=$1*2
3090 @end example
3092 @noindent
3093 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3095 @example
3096 | x | y |
3097 |---+---|
3098 | 1 | 2 |
3099 | 2 | 4 |
3100 #+TBLFM: $2=$1*1
3101 #+TBLFM: $2=$1*2
3102 @end example
3104 @noindent
3105 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3106 will get the following result of applying only the first @samp{#+TBLFM} line.
3108 @example
3109 | x | y |
3110 |---+---|
3111 | 1 | 1 |
3112 | 2 | 2 |
3113 #+TBLFM: $2=$1*1
3114 #+TBLFM: $2=$1*2
3115 @end example
3117 @subsubheading Debugging formulas
3118 @cindex formula debugging
3119 @cindex debugging, of table formulas
3120 When the evaluation of a formula leads to an error, the field content
3121 becomes the string @samp{#ERROR}.  If you would like see what is going
3122 on during variable substitution and calculation in order to find a bug,
3123 turn on formula debugging in the @code{Tbl} menu and repeat the
3124 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3125 field.  Detailed information will be displayed.
3127 @node Updating the table
3128 @subsection Updating the table
3129 @cindex recomputing table fields
3130 @cindex updating, table
3132 Recalculation of a table is normally not automatic, but needs to be
3133 triggered by a command.  See @ref{Advanced features}, for a way to make
3134 recalculation at least semi-automatic.
3136 In order to recalculate a line of a table or the entire table, use the
3137 following commands:
3139 @table @kbd
3140 @orgcmd{C-c *,org-table-recalculate}
3141 Recalculate the current row by first applying the stored column formulas
3142 from left to right, and all field/range formulas in the current row.
3144 @kindex C-u C-c *
3145 @item C-u C-c *
3146 @kindex C-u C-c C-c
3147 @itemx C-u C-c C-c
3148 Recompute the entire table, line by line.  Any lines before the first
3149 hline are left alone, assuming that these are part of the table header.
3151 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3152 Iterate the table by recomputing it until no further changes occur.
3153 This may be necessary if some computed fields use the value of other
3154 fields that are computed @i{later} in the calculation sequence.
3155 @item M-x org-table-recalculate-buffer-tables RET
3156 @findex org-table-recalculate-buffer-tables
3157 Recompute all tables in the current buffer.
3158 @item M-x org-table-iterate-buffer-tables RET
3159 @findex org-table-iterate-buffer-tables
3160 Iterate all tables in the current buffer, in order to converge table-to-table
3161 dependencies.
3162 @end table
3164 @node Advanced features
3165 @subsection Advanced features
3167 If you want the recalculation of fields to happen automatically, or if you
3168 want to be able to assign @i{names}@footnote{Such names must start by an
3169 alphabetic character and use only alphanumeric/underscore characters.} to
3170 fields and columns, you need to reserve the first column of the table for
3171 special marking characters.
3173 @table @kbd
3174 @orgcmd{C-#,org-table-rotate-recalc-marks}
3175 Rotate the calculation mark in first column through the states @samp{ },
3176 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
3177 change all marks in the region.
3178 @end table
3180 Here is an example of a table that collects exam results of students and
3181 makes use of these features:
3183 @example
3184 @group
3185 |---+---------+--------+--------+--------+-------+------|
3186 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3187 |---+---------+--------+--------+--------+-------+------|
3188 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
3189 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
3190 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
3191 |---+---------+--------+--------+--------+-------+------|
3192 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
3193 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
3194 |---+---------+--------+--------+--------+-------+------|
3195 |   | Average |        |        |        |  25.0 |      |
3196 | ^ |         |        |        |        |    at |      |
3197 | $ | max=50  |        |        |        |       |      |
3198 |---+---------+--------+--------+--------+-------+------|
3199 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3200 @end group
3201 @end example
3203 @noindent @b{Important}: please note that for these special tables,
3204 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3205 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3206 to the field itself.  The column formulas are not applied in rows with
3207 empty first field.
3209 @cindex marking characters, tables
3210 The marking characters have the following meaning:
3212 @table @samp
3213 @item !
3214 The fields in this line define names for the columns, so that you may
3215 refer to a column as @samp{$Tot} instead of @samp{$6}.
3216 @item ^
3217 This row defines names for the fields @emph{above} the row.  With such
3218 a definition, any formula in the table may use @samp{$m1} to refer to
3219 the value @samp{10}.  Also, if you assign a formula to a names field, it
3220 will be stored as @samp{$name=...}.
3221 @item _
3222 Similar to @samp{^}, but defines names for the fields in the row
3223 @emph{below}.
3224 @item $
3225 Fields in this row can define @emph{parameters} for formulas.  For
3226 example, if a field in a @samp{$} row contains @samp{max=50}, then
3227 formulas in this table can refer to the value 50 using @samp{$max}.
3228 Parameters work exactly like constants, only that they can be defined on
3229 a per-table basis.
3230 @item #
3231 Fields in this row are automatically recalculated when pressing
3232 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
3233 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
3234 lines will be left alone by this command.
3235 @item *
3236 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3237 not for automatic recalculation.  Use this when automatic
3238 recalculation slows down editing too much.
3239 @item @w{ }
3240 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3241 All lines that should be recalculated should be marked with @samp{#}
3242 or @samp{*}.
3243 @item /
3244 Do not export this line.  Useful for lines that contain the narrowing
3245 @samp{<N>} markers or column group markers.
3246 @end table
3248 Finally, just to whet your appetite for what can be done with the
3249 fantastic @file{calc.el} package, here is a table that computes the Taylor
3250 series of degree @code{n} at location @code{x} for a couple of
3251 functions.
3253 @example
3254 @group
3255 |---+-------------+---+-----+--------------------------------------|
3256 |   | Func        | n | x   | Result                               |
3257 |---+-------------+---+-----+--------------------------------------|
3258 | # | exp(x)      | 1 | x   | 1 + x                                |
3259 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
3260 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
3261 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3262 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
3263 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
3264 |---+-------------+---+-----+--------------------------------------|
3265 #+TBLFM: $5=taylor($2,$4,$3);n3
3266 @end group
3267 @end example
3269 @node Org-Plot
3270 @section Org-Plot
3271 @cindex graph, in tables
3272 @cindex plot tables using Gnuplot
3273 @cindex #+PLOT
3275 Org-Plot can produce graphs of information stored in org tables, either
3276 graphically or in ASCII-art.
3278 @subheading Graphical plots using @file{Gnuplot}
3280 Org-Plot produces 2D and 3D graphs using @file{Gnuplot}
3281 @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3282 @uref{http://xafs.org/BruceRavel/GnuplotMode}.  To see this in action, ensure
3283 that you have both Gnuplot and Gnuplot mode installed on your system, then
3284 call @kbd{C-c " g} or @kbd{M-x org-plot/gnuplot @key{RET}} on the following
3285 table.
3287 @example
3288 @group
3289 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3290 | Sede      | Max cites | H-index |
3291 |-----------+-----------+---------|
3292 | Chile     |    257.72 |   21.39 |
3293 | Leeds     |    165.77 |   19.68 |
3294 | Sao Paolo |     71.00 |   11.50 |
3295 | Stockholm |    134.19 |   14.33 |
3296 | Morelia   |    257.56 |   17.67 |
3297 @end group
3298 @end example
3300 Notice that Org Plot is smart enough to apply the table's headers as labels.
3301 Further control over the labels, type, content, and appearance of plots can
3302 be exercised through the @code{#+PLOT:} lines preceding a table.  See below
3303 for a complete list of Org-plot options.  The @code{#+PLOT:} lines are
3304 optional.  For more information and examples see the Org-plot tutorial at
3305 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3307 @subsubheading Plot Options
3309 @table @code
3310 @item set
3311 Specify any @command{gnuplot} option to be set when graphing.
3313 @item title
3314 Specify the title of the plot.
3316 @item ind
3317 Specify which column of the table to use as the @code{x} axis.
3319 @item deps
3320 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3321 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3322 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3323 column).
3325 @item type
3326 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3328 @item with
3329 Specify a @code{with} option to be inserted for every col being plotted
3330 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3331 Defaults to @code{lines}.
3333 @item file
3334 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3336 @item labels
3337 List of labels to be used for the @code{deps} (defaults to the column headers
3338 if they exist).
3340 @item line
3341 Specify an entire line to be inserted in the Gnuplot script.
3343 @item map
3344 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3345 flat mapping rather than a @code{3d} slope.
3347 @item timefmt
3348 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3349 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3351 @item script
3352 If you want total control, you can specify a script file (place the file name
3353 between double-quotes) which will be used to plot.  Before plotting, every
3354 instance of @code{$datafile} in the specified script will be replaced with
3355 the path to the generated data file.  Note: even if you set this option, you
3356 may still want to specify the plot type, as that can impact the content of
3357 the data file.
3358 @end table
3360 @subheading ASCII bar plots
3362 While the cursor is on a column, typing @kbd{C-c " a} or
3363 @kbd{M-x orgtbl-ascii-plot @key{RET}} create a new column containing an
3364 ASCII-art bars plot.  The plot is implemented through a regular column
3365 formula.  When the source column changes, the bar plot may be updated by
3366 refreshing the table, for example typing @kbd{C-u C-c *}.
3368 @example
3369 @group
3370 | Sede          | Max cites |              |
3371 |---------------+-----------+--------------|
3372 | Chile         |    257.72 | WWWWWWWWWWWW |
3373 | Leeds         |    165.77 | WWWWWWWh     |
3374 | Sao Paolo     |     71.00 | WWW;         |
3375 | Stockholm     |    134.19 | WWWWWW:      |
3376 | Morelia       |    257.56 | WWWWWWWWWWWH |
3377 | Rochefourchat |      0.00 |              |
3378 #+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)
3379 @end group
3380 @end example
3382 The formula is an elisp call:
3383 @lisp
3384 (orgtbl-ascii-draw COLUMN MIN MAX WIDTH)
3385 @end lisp
3387 @table @code
3388 @item COLUMN
3389   is a reference to the source column.
3391 @item MIN MAX
3392   are the minimal and maximal values displayed.  Sources values
3393   outside this range are displayed as @samp{too small}
3394   or @samp{too large}.
3396 @item WIDTH
3397   is the width in characters of the bar-plot.  It defaults to @samp{12}.
3399 @end table
3401 @node Hyperlinks
3402 @chapter Hyperlinks
3403 @cindex hyperlinks
3405 Like HTML, Org provides links inside a file, external links to
3406 other files, Usenet articles, emails, and much more.
3408 @menu
3409 * Link format::                 How links in Org are formatted
3410 * Internal links::              Links to other places in the current file
3411 * External links::              URL-like links to the world
3412 * Handling links::              Creating, inserting and following
3413 * Using links outside Org::     Linking from my C source code?
3414 * Link abbreviations::          Shortcuts for writing complex links
3415 * Search options::              Linking to a specific location
3416 * Custom searches::             When the default search is not enough
3417 @end menu
3419 @node Link format
3420 @section Link format
3421 @cindex link format
3422 @cindex format, of links
3424 Org will recognize plain URL-like links and activate them as
3425 clickable links.  The general link format, however, looks like this:
3427 @example
3428 [[link][description]]       @r{or alternatively}           [[link]]
3429 @end example
3431 @noindent
3432 Once a link in the buffer is complete (all brackets present), Org
3433 will change the display so that @samp{description} is displayed instead
3434 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3435 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
3436 which by default is an underlined face.  You can directly edit the
3437 visible part of a link.  Note that this can be either the @samp{link}
3438 part (if there is no description) or the @samp{description} part.  To
3439 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3440 cursor on the link.
3442 If you place the cursor at the beginning or just behind the end of the
3443 displayed text and press @key{BACKSPACE}, you will remove the
3444 (invisible) bracket at that location.  This makes the link incomplete
3445 and the internals are again displayed as plain text.  Inserting the
3446 missing bracket hides the link internals again.  To show the
3447 internal structure of all links, use the menu entry
3448 @code{Org->Hyperlinks->Literal links}.
3450 @node Internal links
3451 @section Internal links
3452 @cindex internal links
3453 @cindex links, internal
3454 @cindex targets, for links
3456 @cindex property, CUSTOM_ID
3457 If the link does not look like a URL, it is considered to be internal in the
3458 current file.  The most important case is a link like
3459 @samp{[[#my-custom-id]]} which will link to the entry with the
3460 @code{CUSTOM_ID} property @samp{my-custom-id}.  You are responsible yourself
3461 to make sure these custom IDs are unique in a file.
3463 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3464 lead to a text search in the current file.
3466 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3467 or with a mouse click (@pxref{Handling links}).  Links to custom IDs will
3468 point to the corresponding headline.  The preferred match for a text link is
3469 a @i{dedicated target}: the same string in double angular brackets, like
3470 @samp{<<My Target>>}.
3472 @cindex #+NAME
3473 If no dedicated target exists, the link will then try to match the exact name
3474 of an element within the buffer.  Naming is done with the @code{#+NAME}
3475 keyword, which has to be put in the line before the element it refers to, as
3476 in the following example
3478 @example
3479 #+NAME: My Target
3480 | a  | table      |
3481 |----+------------|
3482 | of | four cells |
3483 @end example
3485 If none of the above succeeds, Org will search for a headline that is exactly
3486 the link text but may also include a TODO keyword and tags@footnote{To insert
3487 a link targeting a headline, in-buffer completion can be used.  Just type
3488 a star followed by a few optional letters into the buffer and press
3489 @kbd{M-@key{TAB}}.  All headlines in the current buffer will be offered as
3490 completions.}.
3492 During export, internal links will be used to mark objects and assign them
3493 a number.  Marked objects will then be referenced by links pointing to them.
3494 In particular, links without a description will appear as the number assigned
3495 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3496 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3497 (@pxref{Images and tables}).}.  In the following excerpt from an Org buffer
3499 @example
3500 - one item
3501 - <<target>>another item
3502 Here we refer to item [[target]].
3503 @end example
3505 @noindent
3506 The last sentence will appear as @samp{Here we refer to item 2} when
3507 exported.
3509 In non-Org files, the search will look for the words in the link text.  In
3510 the above example the search would be for @samp{my target}.
3512 Following a link pushes a mark onto Org's own mark ring.  You can
3513 return to the previous position with @kbd{C-c &}.  Using this command
3514 several times in direct succession goes back to positions recorded
3515 earlier.
3517 @menu
3518 * Radio targets::               Make targets trigger links in plain text
3519 @end menu
3521 @node Radio targets
3522 @subsection Radio targets
3523 @cindex radio targets
3524 @cindex targets, radio
3525 @cindex links, radio targets
3527 Org can automatically turn any occurrences of certain target names
3528 in normal text into a link.  So without explicitly creating a link, the
3529 text connects to the target radioing its position.  Radio targets are
3530 enclosed by triple angular brackets.  For example, a target @samp{<<<My
3531 Target>>>} causes each occurrence of @samp{my target} in normal text to
3532 become activated as a link.  The Org file is scanned automatically
3533 for radio targets only when the file is first loaded into Emacs.  To
3534 update the target list during editing, press @kbd{C-c C-c} with the
3535 cursor on or at a target.
3537 @node External links
3538 @section External links
3539 @cindex links, external
3540 @cindex external links
3541 @cindex Gnus links
3542 @cindex BBDB links
3543 @cindex IRC links
3544 @cindex URL links
3545 @cindex file links
3546 @cindex RMAIL links
3547 @cindex MH-E links
3548 @cindex USENET links
3549 @cindex SHELL links
3550 @cindex Info links
3551 @cindex Elisp links
3553 Org supports links to files, websites, Usenet and email messages, BBDB
3554 database entries and links to both IRC conversations and their logs.
3555 External links are URL-like locators.  They start with a short identifying
3556 string followed by a colon.  There can be no space after the colon.  The
3557 following list shows examples for each link type.
3559 @example
3560 http://www.astro.uva.nl/~dominik          @r{on the web}
3561 doi:10.1000/182                           @r{DOI for an electronic resource}
3562 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
3563 /home/dominik/images/jupiter.jpg          @r{same as above}
3564 file:papers/last.pdf                      @r{file, relative path}
3565 ./papers/last.pdf                         @r{same as above}
3566 file:/myself@@some.where:papers/last.pdf   @r{file, path on remote machine}
3567 /myself@@some.where:papers/last.pdf        @r{same as above}
3568 file:sometextfile::NNN                    @r{file, jump to line number}
3569 file:projects.org                         @r{another Org file}
3570 file:projects.org::some words             @r{text search in Org file}@footnote{
3571 The actual behavior of the search will depend on the value of
3572 the option @code{org-link-search-must-match-exact-headline}.  If its value
3573 is @code{nil}, then a fuzzy text search will be done.  If it is t, then only the
3574 exact headline will be matched, ignoring spaces and cookies.  If the value is
3575 @code{query-to-create}, then an exact headline will be searched; if it is not
3576 found, then the user will be queried to create it.}
3577 file:projects.org::*task title @r{heading search in Org
3578 file}@footnote{ Headline searches always match the exact headline, ignoring
3579 spaces and cookies.  If the headline is not found and the value of the option
3580 @code{org-link-search-must-match-exact-headline} is @code{query-to-create},
3581 then the user will be queried to create it.}
3582 file+sys:/path/to/file                    @r{open via OS, like double-click}
3583 file+emacs:/path/to/file                  @r{force opening by Emacs}
3584 docview:papers/last.pdf::NNN              @r{open in doc-view mode at page}
3585 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
3586 news:comp.emacs                           @r{Usenet link}
3587 mailto:adent@@galaxy.net                   @r{Mail link}
3588 mhe:folder                                @r{MH-E folder link}
3589 mhe:folder#id                             @r{MH-E message link}
3590 rmail:folder                              @r{RMAIL folder link}
3591 rmail:folder#id                           @r{RMAIL message link}
3592 gnus:group                                @r{Gnus group link}
3593 gnus:group#id                             @r{Gnus article link}
3594 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
3595 irc:/irc.com/#emacs/bob                   @r{IRC link}
3596 info:org#External links                   @r{Info node or index link}
3597 shell:ls *.org                            @r{A shell command}
3598 elisp:org-agenda                          @r{Interactive Elisp command}
3599 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3600 @end example
3602 @cindex VM links
3603 @cindex WANDERLUST links
3604 On top of these built-in link types, some are available through the
3605 @code{contrib/} directory (@pxref{Installation}).  For example, these links
3606 to VM or Wanderlust messages are available when you load the corresponding
3607 libraries from the @code{contrib/} directory:
3609 @example
3610 vm:folder                                 @r{VM folder link}
3611 vm:folder#id                              @r{VM message link}
3612 vm://myself@@some.where.org/folder#id      @r{VM on remote machine}
3613 vm-imap:account:folder                    @r{VM IMAP folder link}
3614 vm-imap:account:folder#id                 @r{VM IMAP message link}
3615 wl:folder                                 @r{WANDERLUST folder link}
3616 wl:folder#id                              @r{WANDERLUST message link}
3617 @end example
3619 For customizing Org to add new link types @ref{Adding hyperlink types}.
3621 A link should be enclosed in double brackets and may contain a descriptive
3622 text to be displayed instead of the URL (@pxref{Link format}), for example:
3624 @example
3625 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3626 @end example
3628 @noindent
3629 If the description is a file name or URL that points to an image, HTML
3630 export (@pxref{HTML export}) will inline the image as a clickable
3631 button.  If there is no description at all and the link points to an
3632 image,
3633 that image will be inlined into the exported HTML file.
3635 @cindex square brackets, around links
3636 @cindex plain text external links
3637 Org also finds external links in the normal text and activates them
3638 as links.  If spaces must be part of the link (for example in
3639 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3640 about the end of the link, enclose them in square brackets.
3642 @node Handling links
3643 @section Handling links
3644 @cindex links, handling
3646 Org provides methods to create a link in the correct syntax, to
3647 insert it into an Org file, and to follow the link.
3649 @table @kbd
3650 @orgcmd{C-c l,org-store-link}
3651 @cindex storing links
3652 Store a link to the current location.  This is a @emph{global} command (you
3653 must create the key binding yourself) which can be used in any buffer to
3654 create a link.  The link will be stored for later insertion into an Org
3655 buffer (see below).  What kind of link will be created depends on the current
3656 buffer:
3658 @b{Org mode buffers}@*
3659 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3660 to the target.  Otherwise it points to the current headline, which will also
3661 be the description@footnote{If the headline contains a timestamp, it will be
3662 removed from the link and result in a wrong link---you should avoid putting
3663 timestamp in the headline.}.
3665 @vindex org-id-link-to-org-use-id
3666 @cindex property, CUSTOM_ID
3667 @cindex property, ID
3668 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3669 will be stored.  In addition or alternatively (depending on the value of
3670 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3671 be created and/or used to construct a link@footnote{The library
3672 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3673 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3674 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3675 potentially create two links: a human-readable from the custom ID, and one
3676 that is globally unique and works even if the entry is moved from file to
3677 file.  Later, when inserting the link, you need to decide which one to use.
3679 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3680 Pretty much all Emacs mail clients are supported.  The link will point to the
3681 current article, or, in some GNUS buffers, to the group.  The description is
3682 constructed from the author and the subject.
3684 @b{Web browsers: W3 and W3M}@*
3685 Here the link will be the current URL, with the page title as description.
3687 @b{Contacts: BBDB}@*
3688 Links created in a BBDB buffer will point to the current entry.
3690 @b{Chat: IRC}@*
3691 @vindex org-irc-link-to-logs
3692 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3693 a @samp{file:/} style link to the relevant point in the logs for the current
3694 conversation is created.  Otherwise an @samp{irc:/} style link to the
3695 user/channel/server under the point will be stored.
3697 @b{Other files}@*
3698 For any other files, the link will point to the file, with a search string
3699 (@pxref{Search options}) pointing to the contents of the current line.  If
3700 there is an active region, the selected words will form the basis of the
3701 search string.  If the automatically created link is not working correctly or
3702 accurately enough, you can write custom functions to select the search string
3703 and to do the search for particular file types---see @ref{Custom searches}.
3704 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3706 @b{Agenda view}@*
3707 When the cursor is in an agenda view, the created link points to the
3708 entry referenced by the current line.
3711 @orgcmd{C-c C-l,org-insert-link}
3712 @cindex link completion
3713 @cindex completion, of links
3714 @cindex inserting links
3715 @vindex org-keep-stored-link-after-insertion
3716 Insert a link@footnote{Note that you don't have to use this command to
3717 insert a link.  Links in Org are plain text, and you can type or paste them
3718 straight into the buffer.  By using this command, the links are automatically
3719 enclosed in double brackets, and you will be asked for the optional
3720 descriptive text.}.  This prompts for a link to be inserted into the buffer.
3721 You can just type a link, using text for an internal link, or one of the link
3722 type prefixes mentioned in the examples above.  The link will be inserted
3723 into the buffer@footnote{After insertion of a stored link, the link will be
3724 removed from the list of stored links.  To keep it in the list later use, use
3725 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3726 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3727 If some text was selected when this command is called, the selected text
3728 becomes the default description.
3730 @b{Inserting stored links}@*
3731 All links stored during the
3732 current session are part of the history for this prompt, so you can access
3733 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3735 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3736 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3737 defined through link abbreviations (@pxref{Link abbreviations}).  If you
3738 press @key{RET} after inserting only the @var{prefix}, Org will offer
3739 specific completion support for some link types@footnote{This works by
3740 calling a special function @code{org-PREFIX-complete-link}.}  For
3741 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3742 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3743 @key{RET}} you can complete contact names.
3744 @orgkey C-u C-c C-l
3745 @cindex file name completion
3746 @cindex completion, of file names
3747 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3748 a file will be inserted and you may use file name completion to select
3749 the name of the file.  The path to the file is inserted relative to the
3750 directory of the current Org file, if the linked file is in the current
3751 directory or in a sub-directory of it, or if the path is written relative
3752 to the current directory using @samp{../}.  Otherwise an absolute path
3753 is used, if possible with @samp{~/} for your home directory.  You can
3754 force an absolute path with two @kbd{C-u} prefixes.
3756 @item C-c C-l @ @r{(with cursor on existing link)}
3757 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3758 link and description parts of the link.
3760 @cindex following links
3761 @orgcmd{C-c C-o,org-open-at-point}
3762 @vindex org-file-apps
3763 @vindex org-link-frame-setup
3764 Open link at point.  This will launch a web browser for URLs (using
3765 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3766 the corresponding links, and execute the command in a shell link.  When the
3767 cursor is on an internal link, this command runs the corresponding search.
3768 When the cursor is on a TAG list in a headline, it creates the corresponding
3769 TAGS view.  If the cursor is on a timestamp, it compiles the agenda for that
3770 date.  Furthermore, it will visit text and remote files in @samp{file:} links
3771 with Emacs and select a suitable application for local non-text files.
3772 Classification of files is based on file extension only.  See option
3773 @code{org-file-apps}.  If you want to override the default application and
3774 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
3775 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3776 If the cursor is on a headline, but not on a link, offer all links in the
3777 headline and entry text.  If you want to setup the frame configuration for
3778 following links, customize @code{org-link-frame-setup}.
3780 @orgkey @key{RET}
3781 @vindex org-return-follows-link
3782 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3783 the link at point.
3785 @kindex mouse-2
3786 @kindex mouse-1
3787 @item mouse-2
3788 @itemx mouse-1
3789 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3790 would.  Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3792 @kindex mouse-3
3793 @item mouse-3
3794 @vindex org-display-internal-link-with-indirect-buffer
3795 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3796 internal links to be displayed in another window@footnote{See the
3797 option @code{org-display-internal-link-with-indirect-buffer}}.
3799 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3800 @cindex inlining images
3801 @cindex images, inlining
3802 @vindex org-startup-with-inline-images
3803 @cindex @code{inlineimages}, STARTUP keyword
3804 @cindex @code{noinlineimages}, STARTUP keyword
3805 Toggle the inline display of linked images.  Normally this will only inline
3806 images that have no description part in the link, i.e., images that will also
3807 be inlined during export.  When called with a prefix argument, also display
3808 images that do have a link description.  You can ask for inline images to be
3809 displayed at startup by configuring the variable
3810 @code{org-startup-with-inline-images}@footnote{with corresponding
3811 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3812 @orgcmd{C-c %,org-mark-ring-push}
3813 @cindex mark ring
3814 Push the current position onto the mark ring, to be able to return
3815 easily.  Commands following an internal link do this automatically.
3817 @orgcmd{C-c &,org-mark-ring-goto}
3818 @cindex links, returning to
3819 Jump back to a recorded position.  A position is recorded by the
3820 commands following internal links, and by @kbd{C-c %}.  Using this
3821 command several times in direct succession moves through a ring of
3822 previously recorded positions.
3824 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3825 @cindex links, finding next/previous
3826 Move forward/backward to the next link in the buffer.  At the limit of
3827 the buffer, the search fails once, and then wraps around.  The key
3828 bindings for this are really too long; you might want to bind this also
3829 to @kbd{C-n} and @kbd{C-p}
3830 @lisp
3831 (add-hook 'org-load-hook
3832   (lambda ()
3833     (define-key org-mode-map "\C-n" 'org-next-link)
3834     (define-key org-mode-map "\C-p" 'org-previous-link)))
3835 @end lisp
3836 @end table
3838 @node Using links outside Org
3839 @section Using links outside Org
3841 You can insert and follow links that have Org syntax not only in
3842 Org, but in any Emacs buffer.  For this, you should create two
3843 global commands, like this (please select suitable global keys
3844 yourself):
3846 @lisp
3847 (global-set-key "\C-c L" 'org-insert-link-global)
3848 (global-set-key "\C-c o" 'org-open-at-point-global)
3849 @end lisp
3851 @node Link abbreviations
3852 @section Link abbreviations
3853 @cindex link abbreviations
3854 @cindex abbreviation, links
3856 Long URLs can be cumbersome to type, and often many similar links are
3857 needed in a document.  For this you can use link abbreviations.  An
3858 abbreviated link looks like this
3860 @example
3861 [[linkword:tag][description]]
3862 @end example
3864 @noindent
3865 @vindex org-link-abbrev-alist
3866 where the tag is optional.
3867 The @i{linkword} must be a word, starting with a letter, followed by
3868 letters, numbers, @samp{-}, and @samp{_}.  Abbreviations are resolved
3869 according to the information in the variable @code{org-link-abbrev-alist}
3870 that relates the linkwords to replacement text.  Here is an example:
3872 @smalllisp
3873 @group
3874 (setq org-link-abbrev-alist
3875   '(("bugzilla"  . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3876     ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3877     ("google"    . "http://www.google.com/search?q=")
3878     ("gmap"      . "http://maps.google.com/maps?q=%s")
3879     ("omap"      . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3880     ("ads"       . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3881 @end group
3882 @end smalllisp
3884 If the replacement text contains the string @samp{%s}, it will be
3885 replaced with the tag.  Using @samp{%h} instead of @samp{%s} will
3886 url-encode the tag (see the example above, where we need to encode
3887 the URL parameter.)  Using @samp{%(my-function)} will pass the tag
3888 to a custom function, and replace it by the resulting string.
3890 If the replacement text doesn't contain any specifier, it will simply
3891 be appended to the string in order to create the link.
3893 Instead of a string, you may also specify a function that will be
3894 called with the tag as the only argument to create the link.
3896 With the above setting, you could link to a specific bug with
3897 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3898 @code{[[google:OrgMode]]}, show the map location of the Free Software
3899 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3900 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3901 what the Org author is doing besides Emacs hacking with
3902 @code{[[ads:Dominik,C]]}.
3904 If you need special abbreviations just for a single Org buffer, you
3905 can define them in the file with
3907 @cindex #+LINK
3908 @example
3909 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
3910 #+LINK: google    http://www.google.com/search?q=%s
3911 @end example
3913 @noindent
3914 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3915 complete link abbreviations.  You may also define a function
3916 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3917 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
3918 not accept any arguments, and return the full link with prefix.
3920 @node Search options
3921 @section Search options in file links
3922 @cindex search option in file links
3923 @cindex file links, searching
3925 File links can contain additional information to make Emacs jump to a
3926 particular location in the file when following a link.  This can be a
3927 line number or a search option after a double@footnote{For backward
3928 compatibility, line numbers can also follow a single colon.} colon.  For
3929 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3930 links}) to a file, it encodes the words in the current line as a search
3931 string that can be used to find this line back later when following the
3932 link with @kbd{C-c C-o}.
3934 Here is the syntax of the different ways to attach a search to a file
3935 link, together with an explanation:
3937 @example
3938 [[file:~/code/main.c::255]]
3939 [[file:~/xx.org::My Target]]
3940 [[file:~/xx.org::*My Target]]
3941 [[file:~/xx.org::#my-custom-id]]
3942 [[file:~/xx.org::/regexp/]]
3943 @end example
3945 @table @code
3946 @item 255
3947 Jump to line 255.
3948 @item My Target
3949 Search for a link target @samp{<<My Target>>}, or do a text search for
3950 @samp{my target}, similar to the search in internal links, see
3951 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
3952 link will become an HTML reference to the corresponding named anchor in
3953 the linked file.
3954 @item *My Target
3955 In an Org file, restrict search to headlines.
3956 @item #my-custom-id
3957 Link to a heading with a @code{CUSTOM_ID} property
3958 @item /regexp/
3959 Do a regular expression search for @code{regexp}.  This uses the Emacs
3960 command @code{occur} to list all matches in a separate window.  If the
3961 target file is in Org mode, @code{org-occur} is used to create a
3962 sparse tree with the matches.
3963 @c If the target file is a directory,
3964 @c @code{grep} will be used to search all files in the directory.
3965 @end table
3967 As a degenerate case, a file link with an empty file name can be used
3968 to search the current file.  For example, @code{[[file:::find me]]} does
3969 a search for @samp{find me} in the current file, just as
3970 @samp{[[find me]]} would.
3972 @node Custom searches
3973 @section Custom Searches
3974 @cindex custom search strings
3975 @cindex search strings, custom
3977 The default mechanism for creating search strings and for doing the
3978 actual search related to a file link may not work correctly in all
3979 cases.  For example, Bib@TeX{} database files have many entries like
3980 @samp{year="1993"} which would not result in good search strings,
3981 because the only unique identification for a Bib@TeX{} entry is the
3982 citation key.
3984 @vindex org-create-file-search-functions
3985 @vindex org-execute-file-search-functions
3986 If you come across such a problem, you can write custom functions to set
3987 the right search string for a particular file type, and to do the search
3988 for the string in the file.  Using @code{add-hook}, these functions need
3989 to be added to the hook variables
3990 @code{org-create-file-search-functions} and
3991 @code{org-execute-file-search-functions}.  See the docstring for these
3992 variables for more information.  Org actually uses this mechanism
3993 for Bib@TeX{} database files, and you can use the corresponding code as
3994 an implementation example.  See the file @file{org-bibtex.el}.
3996 @node TODO items
3997 @chapter TODO items
3998 @cindex TODO items
4000 Org mode does not maintain TODO lists as separate documents@footnote{Of
4001 course, you can make a document that contains only long lists of TODO items,
4002 but this is not required.}.  Instead, TODO items are an integral part of the
4003 notes file, because TODO items usually come up while taking notes!  With Org
4004 mode, simply mark any entry in a tree as being a TODO item.  In this way,
4005 information is not duplicated, and the entire context from which the TODO
4006 item emerged is always present.
4008 Of course, this technique for managing TODO items scatters them
4009 throughout your notes file.  Org mode compensates for this by providing
4010 methods to give you an overview of all the things that you have to do.
4012 @menu
4013 * TODO basics::                 Marking and displaying TODO entries
4014 * TODO extensions::             Workflow and assignments
4015 * Progress logging::            Dates and notes for progress
4016 * Priorities::                  Some things are more important than others
4017 * Breaking down tasks::         Splitting a task into manageable pieces
4018 * Checkboxes::                  Tick-off lists
4019 @end menu
4021 @node TODO basics
4022 @section Basic TODO functionality
4024 Any headline becomes a TODO item when it starts with the word
4025 @samp{TODO}, for example:
4027 @example
4028 *** TODO Write letter to Sam Fortune
4029 @end example
4031 @noindent
4032 The most important commands to work with TODO entries are:
4034 @table @kbd
4035 @orgcmd{C-c C-t,org-todo}
4036 @cindex cycling, of TODO states
4037 @vindex org-use-fast-todo-selection
4039 Rotate the TODO state of the current item among
4041 @example
4042 ,-> (unmarked) -> TODO -> DONE --.
4043 '--------------------------------'
4044 @end example
4046 If TODO keywords have fast access keys (see @ref{Fast access to TODO
4047 states}), you will be prompted for a TODO keyword through the fast selection
4048 interface; this is the default behavior when
4049 @code{org-use-fast-todo-selection} is non-@code{nil}.
4051 The same rotation can also be done ``remotely'' from the timeline and agenda
4052 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
4054 @orgkey{C-u C-c C-t}
4055 When TODO keywords have no selection keys, select a specific keyword using
4056 completion; otherwise force cycling through TODO states with no prompt.  When
4057 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
4058 selection interface.
4060 @kindex S-@key{right}
4061 @kindex S-@key{left}
4062 @item S-@key{right} @ @r{/} @ S-@key{left}
4063 @vindex org-treat-S-cursor-todo-selection-as-state-change
4064 Select the following/preceding TODO state, similar to cycling.  Useful
4065 mostly if more than two TODO states are possible (@pxref{TODO
4066 extensions}).  See also @ref{Conflicts}, for a discussion of the interaction
4067 with @code{shift-selection-mode}.  See also the variable
4068 @code{org-treat-S-cursor-todo-selection-as-state-change}.
4069 @orgcmd{C-c / t,org-show-todo-tree}
4070 @cindex sparse tree, for TODO
4071 @vindex org-todo-keywords
4072 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
4073 entire buffer, but shows all TODO items (with not-DONE state) and the
4074 headings hierarchy above them.  With a prefix argument (or by using @kbd{C-c
4075 / T}), search for a specific TODO@.  You will be prompted for the keyword,
4076 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
4077 entries that match any one of these keywords.  With a numeric prefix argument
4078 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
4079 With two prefix arguments, find all TODO states, both un-done and done.
4080 @orgcmd{C-c a t,org-todo-list}
4081 Show the global TODO list.  Collects the TODO items (with not-DONE states)
4082 from all agenda files (@pxref{Agenda views}) into a single buffer.  The new
4083 buffer will be in @code{agenda-mode}, which provides commands to examine and
4084 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4085 @xref{Global TODO list}, for more information.
4086 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4087 Insert a new TODO entry below the current one.
4088 @end table
4090 @noindent
4091 @vindex org-todo-state-tags-triggers
4092 Changing a TODO state can also trigger tag changes.  See the docstring of the
4093 option @code{org-todo-state-tags-triggers} for details.
4095 @node TODO extensions
4096 @section Extended use of TODO keywords
4097 @cindex extended TODO keywords
4099 @vindex org-todo-keywords
4100 By default, marked TODO entries have one of only two states: TODO and
4101 DONE@.  Org mode allows you to classify TODO items in more complex ways
4102 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
4103 special setup, the TODO keyword system can work differently in different
4104 files.
4106 Note that @i{tags} are another way to classify headlines in general and
4107 TODO items in particular (@pxref{Tags}).
4109 @menu
4110 * Workflow states::             From TODO to DONE in steps
4111 * TODO types::                  I do this, Fred does the rest
4112 * Multiple sets in one file::   Mixing it all, and still finding your way
4113 * Fast access to TODO states::  Single letter selection of a state
4114 * Per-file keywords::           Different files, different requirements
4115 * Faces for TODO keywords::     Highlighting states
4116 * TODO dependencies::           When one task needs to wait for others
4117 @end menu
4119 @node Workflow states
4120 @subsection TODO keywords as workflow states
4121 @cindex TODO workflow
4122 @cindex workflow states as TODO keywords
4124 You can use TODO keywords to indicate different @emph{sequential} states
4125 in the process of working on an item, for example@footnote{Changing
4126 this variable only becomes effective after restarting Org mode in a
4127 buffer.}:
4129 @lisp
4130 (setq org-todo-keywords
4131   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4132 @end lisp
4134 The vertical bar separates the TODO keywords (states that @emph{need
4135 action}) from the DONE states (which need @emph{no further action}).  If
4136 you don't provide the separator bar, the last state is used as the DONE
4137 state.
4138 @cindex completion, of TODO keywords
4139 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4140 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@.  You may
4141 also use a numeric prefix argument to quickly select a specific state.  For
4142 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4143 Or you can use @kbd{S-@key{left}} to go backward through the sequence.  If you
4144 define many keywords, you can use in-buffer completion
4145 (@pxref{Completion}) or even a special one-key selection scheme
4146 (@pxref{Fast access to TODO states}) to insert these words into the
4147 buffer.  Changing a TODO state can be logged with a timestamp, see
4148 @ref{Tracking TODO state changes}, for more information.
4150 @node TODO types
4151 @subsection TODO keywords as types
4152 @cindex TODO types
4153 @cindex names as TODO keywords
4154 @cindex types as TODO keywords
4156 The second possibility is to use TODO keywords to indicate different
4157 @emph{types} of action items.  For example, you might want to indicate
4158 that items are for ``work'' or ``home''.  Or, when you work with several
4159 people on a single project, you might want to assign action items
4160 directly to persons, by using their names as TODO keywords.  This would
4161 be set up like this:
4163 @lisp
4164 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4165 @end lisp
4167 In this case, different keywords do not indicate a sequence, but rather
4168 different types.  So the normal work flow would be to assign a task to a
4169 person, and later to mark it DONE@.  Org mode supports this style by adapting
4170 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4171 @kbd{t} command in the timeline and agenda buffers.}.  When used several
4172 times in succession, it will still cycle through all names, in order to first
4173 select the right type for a task.  But when you return to the item after some
4174 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4175 to DONE@.  Use prefix arguments or completion to quickly select a specific
4176 name.  You can also review the items of a specific TODO type in a sparse tree
4177 by using a numeric prefix to @kbd{C-c / t}.  For example, to see all things
4178 Lucy has to do, you would use @kbd{C-3 C-c / t}.  To collect Lucy's items
4179 from all agenda files into a single buffer, you would use the numeric prefix
4180 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4182 @node Multiple sets in one file
4183 @subsection Multiple keyword sets in one file
4184 @cindex TODO keyword sets
4186 Sometimes you may want to use different sets of TODO keywords in
4187 parallel.  For example, you may want to have the basic
4188 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4189 separate state indicating that an item has been canceled (so it is not
4190 DONE, but also does not require action).  Your setup would then look
4191 like this:
4193 @lisp
4194 (setq org-todo-keywords
4195       '((sequence "TODO" "|" "DONE")
4196         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4197         (sequence "|" "CANCELED")))
4198 @end lisp
4200 The keywords should all be different, this helps Org mode to keep track
4201 of which subsequence should be used for a given entry.  In this setup,
4202 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4203 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4204 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
4205 select the correct sequence.  Besides the obvious ways like typing a
4206 keyword or using completion, you may also apply the following commands:
4208 @table @kbd
4209 @kindex C-S-@key{right}
4210 @kindex C-S-@key{left}
4211 @kindex C-u C-u C-c C-t
4212 @item C-u C-u C-c C-t
4213 @itemx C-S-@key{right}
4214 @itemx C-S-@key{left}
4215 These keys jump from one TODO subset to the next.  In the above example,
4216 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4217 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4218 @code{CANCELED}.  Note that the @kbd{C-S-} key binding conflict with
4219 @code{shift-selection-mode} (@pxref{Conflicts}).
4220 @kindex S-@key{right}
4221 @kindex S-@key{left}
4222 @item S-@key{right}
4223 @itemx S-@key{left}
4224 @kbd{S-@key{left}} and @kbd{S-@key{right}} and walk through @emph{all}
4225 keywords from all sets, so for example @kbd{S-@key{right}} would switch
4226 from @code{DONE} to @code{REPORT} in the example above.  See also
4227 @ref{Conflicts}, for a discussion of the interaction with
4228 @code{shift-selection-mode}.
4229 @end table
4231 @node Fast access to TODO states
4232 @subsection Fast access to TODO states
4234 If you would like to quickly change an entry to an arbitrary TODO state
4235 instead of cycling through the states, you can set up keys for single-letter
4236 access to the states.  This is done by adding the selection character after
4237 each keyword, in parentheses@footnote{All characters are allowed except
4238 @code{@@^!}, which have a special meaning here.}.  For example:
4240 @lisp
4241 (setq org-todo-keywords
4242       '((sequence "TODO(t)" "|" "DONE(d)")
4243         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4244         (sequence "|" "CANCELED(c)")))
4245 @end lisp
4247 @vindex org-fast-tag-selection-include-todo
4248 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4249 will be switched to this state.  @kbd{SPC} can be used to remove any TODO
4250 keyword from an entry.@footnote{Check also the option
4251 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4252 state through the tags interface (@pxref{Setting tags}), in case you like to
4253 mingle the two concepts.  Note that this means you need to come up with
4254 unique keys across both sets of keywords.}
4256 @node Per-file keywords
4257 @subsection Setting up keywords for individual files
4258 @cindex keyword options
4259 @cindex per-file keywords
4260 @cindex #+TODO
4261 @cindex #+TYP_TODO
4262 @cindex #+SEQ_TODO
4264 It can be very useful to use different aspects of the TODO mechanism in
4265 different files.  For file-local settings, you need to add special lines to
4266 the file which set the keywords and interpretation for that file only.  For
4267 example, to set one of the two examples discussed above, you need one of the
4268 following lines anywhere in the file:
4270 @example
4271 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4272 @end example
4273 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4274 interpretation, but it means the same as @code{#+TODO}), or
4275 @example
4276 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4277 @end example
4279 A setup for using several sets in parallel would be:
4281 @example
4282 #+TODO: TODO | DONE
4283 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4284 #+TODO: | CANCELED
4285 @end example
4287 @cindex completion, of option keywords
4288 @kindex M-@key{TAB}
4289 @noindent To make sure you are using the correct keyword, type
4290 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4292 @cindex DONE, final TODO keyword
4293 Remember that the keywords after the vertical bar (or the last keyword
4294 if no bar is there) must always mean that the item is DONE (although you
4295 may use a different word).  After changing one of these lines, use
4296 @kbd{C-c C-c} with the cursor still in the line to make the changes
4297 known to Org mode@footnote{Org mode parses these lines only when
4298 Org mode is activated after visiting a file.  @kbd{C-c C-c} with the
4299 cursor in a line starting with @samp{#+} is simply restarting Org mode
4300 for the current buffer.}.
4302 @node Faces for TODO keywords
4303 @subsection Faces for TODO keywords
4304 @cindex faces, for TODO keywords
4306 @vindex org-todo @r{(face)}
4307 @vindex org-done @r{(face)}
4308 @vindex org-todo-keyword-faces
4309 Org mode highlights TODO keywords with special faces: @code{org-todo}
4310 for keywords indicating that an item still has to be acted upon, and
4311 @code{org-done} for keywords indicating that an item is finished.  If
4312 you are using more than 2 different states, you might want to use
4313 special faces for some of them.  This can be done using the option
4314 @code{org-todo-keyword-faces}.  For example:
4316 @lisp
4317 @group
4318 (setq org-todo-keyword-faces
4319       '(("TODO" . org-warning) ("STARTED" . "yellow")
4320         ("CANCELED" . (:foreground "blue" :weight bold))))
4321 @end group
4322 @end lisp
4324 While using a list with face properties as shown for CANCELED @emph{should}
4325 work, this does not always seem to be the case.  If necessary, define a
4326 special face and use that.  A string is interpreted as a color.  The option
4327 @code{org-faces-easy-properties} determines if that color is interpreted as a
4328 foreground or a background color.
4330 @node TODO dependencies
4331 @subsection TODO dependencies
4332 @cindex TODO dependencies
4333 @cindex dependencies, of TODO states
4334 @cindex TODO dependencies, NOBLOCKING
4336 @vindex org-enforce-todo-dependencies
4337 @cindex property, ORDERED
4338 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4339 dependencies.  Usually, a parent TODO task should not be marked DONE until
4340 all subtasks (defined as children tasks) are marked as DONE@.  And sometimes
4341 there is a logical sequence to a number of (sub)tasks, so that one task
4342 cannot be acted upon before all siblings above it are done.  If you customize
4343 the option @code{org-enforce-todo-dependencies}, Org will block entries
4344 from changing state to DONE while they have children that are not DONE@.
4345 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4346 will be blocked until all earlier siblings are marked DONE@.  Here is an
4347 example:
4349 @example
4350 * TODO Blocked until (two) is done
4351 ** DONE one
4352 ** TODO two
4354 * Parent
4355   :PROPERTIES:
4356   :ORDERED: t
4357   :END:
4358 ** TODO a
4359 ** TODO b, needs to wait for (a)
4360 ** TODO c, needs to wait for (a) and (b)
4361 @end example
4363 You can ensure an entry is never blocked by using the @code{NOBLOCKING}
4364 property:
4366 @example
4367 * This entry is never blocked
4368   :PROPERTIES:
4369   :NOBLOCKING: t
4370   :END:
4371 @end example
4373 @table @kbd
4374 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4375 @vindex org-track-ordered-property-with-tag
4376 @cindex property, ORDERED
4377 Toggle the @code{ORDERED} property of the current entry.  A property is used
4378 for this behavior because this should be local to the current entry, not
4379 inherited like a tag.  However, if you would like to @i{track} the value of
4380 this property with a tag for better visibility, customize the option
4381 @code{org-track-ordered-property-with-tag}.
4382 @orgkey{C-u C-u C-u C-c C-t}
4383 Change TODO state, circumventing any state blocking.
4384 @end table
4386 @vindex org-agenda-dim-blocked-tasks
4387 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4388 that cannot be closed because of such dependencies will be shown in a dimmed
4389 font or even made invisible in agenda views (@pxref{Agenda views}).
4391 @cindex checkboxes and TODO dependencies
4392 @vindex org-enforce-todo-dependencies
4393 You can also block changes of TODO states by looking at checkboxes
4394 (@pxref{Checkboxes}).  If you set the option
4395 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4396 checkboxes will be blocked from switching to DONE.
4398 If you need more complex dependency structures, for example dependencies
4399 between entries in different trees or files, check out the contributed
4400 module @file{org-depend.el}.
4402 @page
4403 @node Progress logging
4404 @section Progress logging
4405 @cindex progress logging
4406 @cindex logging, of progress
4408 Org mode can automatically record a timestamp and possibly a note when
4409 you mark a TODO item as DONE, or even each time you change the state of
4410 a TODO item.  This system is highly configurable; settings can be on a
4411 per-keyword basis and can be localized to a file or even a subtree.  For
4412 information on how to clock working time for a task, see @ref{Clocking
4413 work time}.
4415 @menu
4416 * Closing items::               When was this entry marked DONE?
4417 * Tracking TODO state changes::  When did the status change?
4418 * Tracking your habits::        How consistent have you been?
4419 @end menu
4421 @node Closing items
4422 @subsection Closing items
4424 The most basic logging is to keep track of @emph{when} a certain TODO
4425 item was finished.  This is achieved with@footnote{The corresponding
4426 in-buffer setting is: @code{#+STARTUP: logdone}}
4428 @lisp
4429 (setq org-log-done 'time)
4430 @end lisp
4432 @vindex org-closed-keep-when-no-todo
4433 @noindent
4434 Then each time you turn an entry from a TODO (not-done) state into any of the
4435 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4436 the headline.  If you turn the entry back into a TODO item through further
4437 state cycling, that line will be removed again.  If you turn the entry back
4438 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4439 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4440 non-@code{nil}.  If you want to record a note along with the timestamp,
4441 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4442 lognotedone}.}
4444 @lisp
4445 (setq org-log-done 'note)
4446 @end lisp
4448 @noindent
4449 You will then be prompted for a note, and that note will be stored below
4450 the entry with a @samp{Closing Note} heading.
4452 In the timeline (@pxref{Timeline}) and in the agenda
4453 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4454 display the TODO items with a @samp{CLOSED} timestamp on each day,
4455 giving you an overview of what has been done.
4457 @node Tracking TODO state changes
4458 @subsection Tracking TODO state changes
4459 @cindex drawer, for state change recording
4461 @vindex org-log-states-order-reversed
4462 @vindex org-log-into-drawer
4463 @cindex property, LOG_INTO_DRAWER
4464 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4465 might want to keep track of when a state change occurred and maybe take a
4466 note about this change.  You can either record just a timestamp, or a
4467 time-stamped note for a change.  These records will be inserted after the
4468 headline as an itemized list, newest first@footnote{See the option
4469 @code{org-log-states-order-reversed}}.  When taking a lot of notes, you might
4470 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4471 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4472 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4473 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4474 show an entry---use @key{C-u SPC} to keep it folded here}.  You can also
4475 overrule the setting of this variable for a subtree by setting a
4476 @code{LOG_INTO_DRAWER} property.
4478 Since it is normally too much to record a note for every state, Org mode
4479 expects configuration on a per-keyword basis for this.  This is achieved by
4480 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4481 with timestamp) in parentheses after each keyword.  For example, with the
4482 setting
4484 @lisp
4485 (setq org-todo-keywords
4486   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4487 @end lisp
4489 To record a timestamp without a note for TODO keywords configured with
4490 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4492 @noindent
4493 @vindex org-log-done
4494 You not only define global TODO keywords and fast access keys, but also
4495 request that a time is recorded when the entry is set to
4496 DONE@footnote{It is possible that Org mode will record two timestamps
4497 when you are using both @code{org-log-done} and state change logging.
4498 However, it will never prompt for two notes---if you have configured
4499 both, the state change recording note will take precedence and cancel
4500 the @samp{Closing Note}.}, and that a note is recorded when switching to
4501 WAIT or CANCELED@.  The setting for WAIT is even more special: the
4502 @samp{!} after the slash means that in addition to the note taken when
4503 entering the state, a timestamp should be recorded when @i{leaving} the
4504 WAIT state, if and only if the @i{target} state does not configure
4505 logging for entering it.  So it has no effect when switching from WAIT
4506 to DONE, because DONE is configured to record a timestamp only.  But
4507 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4508 setting now triggers a timestamp even though TODO has no logging
4509 configured.
4511 You can use the exact same syntax for setting logging preferences local
4512 to a buffer:
4513 @example
4514 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4515 @end example
4517 @cindex property, LOGGING
4518 In order to define logging settings that are local to a subtree or a
4519 single item, define a LOGGING property in this entry.  Any non-empty
4520 LOGGING property resets all logging settings to @code{nil}.  You may then turn
4521 on logging for this specific tree using STARTUP keywords like
4522 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4523 settings like @code{TODO(!)}.  For example
4525 @example
4526 * TODO Log each state with only a time
4527   :PROPERTIES:
4528   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4529   :END:
4530 * TODO Only log when switching to WAIT, and when repeating
4531   :PROPERTIES:
4532   :LOGGING: WAIT(@@) logrepeat
4533   :END:
4534 * TODO No logging at all
4535   :PROPERTIES:
4536   :LOGGING: nil
4537   :END:
4538 @end example
4540 @node Tracking your habits
4541 @subsection Tracking your habits
4542 @cindex habits
4544 Org has the ability to track the consistency of a special category of TODOs,
4545 called ``habits''.  A habit has the following properties:
4547 @enumerate
4548 @item
4549 You have enabled the @code{habits} module by customizing @code{org-modules}.
4550 @item
4551 The habit is a TODO item, with a TODO keyword representing an open state.
4552 @item
4553 The property @code{STYLE} is set to the value @code{habit}.
4554 @item
4555 The TODO has a scheduled date, usually with a @code{.+} style repeat
4556 interval.  A @code{++} style may be appropriate for habits with time
4557 constraints, e.g., must be done on weekends, or a @code{+} style for an
4558 unusual habit that can have a backlog, e.g., weekly reports.
4559 @item
4560 The TODO may also have minimum and maximum ranges specified by using the
4561 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4562 three days, but at most every two days.
4563 @item
4564 You must also have state logging for the @code{DONE} state enabled
4565 (@pxref{Tracking TODO state changes}), in order for historical data to be
4566 represented in the consistency graph.  If it is not enabled it is not an
4567 error, but the consistency graphs will be largely meaningless.
4568 @end enumerate
4570 To give you an idea of what the above rules look like in action, here's an
4571 actual habit with some history:
4573 @example
4574 ** TODO Shave
4575    SCHEDULED: <2009-10-17 Sat .+2d/4d>
4576    :PROPERTIES:
4577    :STYLE:    habit
4578    :LAST_REPEAT: [2009-10-19 Mon 00:36]
4579    :END:
4580    - State "DONE"       from "TODO"       [2009-10-15 Thu]
4581    - State "DONE"       from "TODO"       [2009-10-12 Mon]
4582    - State "DONE"       from "TODO"       [2009-10-10 Sat]
4583    - State "DONE"       from "TODO"       [2009-10-04 Sun]
4584    - State "DONE"       from "TODO"       [2009-10-02 Fri]
4585    - State "DONE"       from "TODO"       [2009-09-29 Tue]
4586    - State "DONE"       from "TODO"       [2009-09-25 Fri]
4587    - State "DONE"       from "TODO"       [2009-09-19 Sat]
4588    - State "DONE"       from "TODO"       [2009-09-16 Wed]
4589    - State "DONE"       from "TODO"       [2009-09-12 Sat]
4590 @end example
4592 What this habit says is: I want to shave at most every 2 days (given by the
4593 @code{SCHEDULED} date and repeat interval) and at least every 4 days.  If
4594 today is the 15th, then the habit first appears in the agenda on Oct 17,
4595 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4596 after four days have elapsed.
4598 What's really useful about habits is that they are displayed along with a
4599 consistency graph, to show how consistent you've been at getting that task
4600 done in the past.  This graph shows every day that the task was done over the
4601 past three weeks, with colors for each day.  The colors used are:
4603 @table @code
4604 @item Blue
4605 If the task wasn't to be done yet on that day.
4606 @item Green
4607 If the task could have been done on that day.
4608 @item Yellow
4609 If the task was going to be overdue the next day.
4610 @item Red
4611 If the task was overdue on that day.
4612 @end table
4614 In addition to coloring each day, the day is also marked with an asterisk if
4615 the task was actually done that day, and an exclamation mark to show where
4616 the current day falls in the graph.
4618 There are several configuration variables that can be used to change the way
4619 habits are displayed in the agenda.
4621 @table @code
4622 @item org-habit-graph-column
4623 The buffer column at which the consistency graph should be drawn.  This will
4624 overwrite any text in that column, so it is a good idea to keep your habits'
4625 titles brief and to the point.
4626 @item org-habit-preceding-days
4627 The amount of history, in days before today, to appear in consistency graphs.
4628 @item org-habit-following-days
4629 The number of days after today that will appear in consistency graphs.
4630 @item org-habit-show-habits-only-for-today
4631 If non-@code{nil}, only show habits in today's agenda view.  This is set to true by
4632 default.
4633 @end table
4635 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4636 temporarily be disabled and they won't appear at all.  Press @kbd{K} again to
4637 bring them back.  They are also subject to tag filtering, if you have habits
4638 which should only be done in certain contexts, for example.
4640 @node Priorities
4641 @section Priorities
4642 @cindex priorities
4644 If you use Org mode extensively, you may end up with enough TODO items that
4645 it starts to make sense to prioritize them.  Prioritizing can be done by
4646 placing a @emph{priority cookie} into the headline of a TODO item, like this
4648 @example
4649 *** TODO [#A] Write letter to Sam Fortune
4650 @end example
4652 @noindent
4653 @vindex org-priority-faces
4654 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4655 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie is
4656 treated just like priority @samp{B}.  Priorities make a difference only for
4657 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4658 have no inherent meaning to Org mode.  The cookies can be highlighted with
4659 special faces by customizing @code{org-priority-faces}.
4661 Priorities can be attached to any outline node; they do not need to be TODO
4662 items.
4664 @table @kbd
4665 @item @kbd{C-c ,}
4666 @kindex @kbd{C-c ,}
4667 @findex org-priority
4668 Set the priority of the current headline (@command{org-priority}).  The
4669 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4670 When you press @key{SPC} instead, the priority cookie is removed from the
4671 headline.  The priorities can also be changed ``remotely'' from the timeline
4672 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4674 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4675 @vindex org-priority-start-cycle-with-default
4676 Increase/decrease priority of current headline@footnote{See also the option
4677 @code{org-priority-start-cycle-with-default}.}.  Note that these keys are
4678 also used to modify timestamps (@pxref{Creating timestamps}).  See also
4679 @ref{Conflicts}, for a discussion of the interaction with
4680 @code{shift-selection-mode}.
4681 @end table
4683 @vindex org-highest-priority
4684 @vindex org-lowest-priority
4685 @vindex org-default-priority
4686 You can change the range of allowed priorities by setting the options
4687 @code{org-highest-priority}, @code{org-lowest-priority}, and
4688 @code{org-default-priority}.  For an individual buffer, you may set
4689 these values (highest, lowest, default) like this (please make sure that
4690 the highest priority is earlier in the alphabet than the lowest
4691 priority):
4693 @cindex #+PRIORITIES
4694 @example
4695 #+PRIORITIES: A C B
4696 @end example
4698 @node Breaking down tasks
4699 @section Breaking tasks down into subtasks
4700 @cindex tasks, breaking down
4701 @cindex statistics, for TODO items
4703 @vindex org-agenda-todo-list-sublevels
4704 It is often advisable to break down large tasks into smaller, manageable
4705 subtasks.  You can do this by creating an outline tree below a TODO item,
4706 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4707 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.  To keep
4708 the overview over the fraction of subtasks that are already completed, insert
4709 either @samp{[/]} or @samp{[%]} anywhere in the headline.  These cookies will
4710 be updated each time the TODO status of a child changes, or when pressing
4711 @kbd{C-c C-c} on the cookie.  For example:
4713 @example
4714 * Organize Party [33%]
4715 ** TODO Call people [1/2]
4716 *** TODO Peter
4717 *** DONE Sarah
4718 ** TODO Buy food
4719 ** DONE Talk to neighbor
4720 @end example
4722 @cindex property, COOKIE_DATA
4723 If a heading has both checkboxes and TODO children below it, the meaning of
4724 the statistics cookie become ambiguous.  Set the property
4725 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4726 this issue.
4728 @vindex org-hierarchical-todo-statistics
4729 If you would like to have the statistics cookie count any TODO entries in the
4730 subtree (not just direct children), configure
4731 @code{org-hierarchical-todo-statistics}.  To do this for a single subtree,
4732 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4733 property.
4735 @example
4736 * Parent capturing statistics [2/20]
4737   :PROPERTIES:
4738   :COOKIE_DATA: todo recursive
4739   :END:
4740 @end example
4742 If you would like a TODO entry to automatically change to DONE
4743 when all children are done, you can use the following setup:
4745 @example
4746 (defun org-summary-todo (n-done n-not-done)
4747   "Switch entry to DONE when all subentries are done, to TODO otherwise."
4748   (let (org-log-done org-log-states)   ; turn off logging
4749     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4751 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4752 @end example
4755 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4756 large number of subtasks (@pxref{Checkboxes}).
4759 @node Checkboxes
4760 @section Checkboxes
4761 @cindex checkboxes
4763 @vindex org-list-automatic-rules
4764 Every item in a plain list@footnote{With the exception of description
4765 lists.  But you can allow it by modifying @code{org-list-automatic-rules}
4766 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4767 it with the string @samp{[ ]}.  This feature is similar to TODO items
4768 (@pxref{TODO items}), but is more lightweight.  Checkboxes are not included
4769 in the global TODO list, so they are often great to split a task into a
4770 number of simple steps.  Or you can use them in a shopping list.  To toggle a
4771 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4772 @file{org-mouse.el}).
4774 Here is an example of a checkbox list.
4776 @example
4777 * TODO Organize party [2/4]
4778   - [-] call people [1/3]
4779     - [ ] Peter
4780     - [X] Sarah
4781     - [ ] Sam
4782   - [X] order food
4783   - [ ] think about what music to play
4784   - [X] talk to the neighbors
4785 @end example
4787 Checkboxes work hierarchically, so if a checkbox item has children that
4788 are checkboxes, toggling one of the children checkboxes will make the
4789 parent checkbox reflect if none, some, or all of the children are
4790 checked.
4792 @cindex statistics, for checkboxes
4793 @cindex checkbox statistics
4794 @cindex property, COOKIE_DATA
4795 @vindex org-checkbox-hierarchical-statistics
4796 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4797 indicating how many checkboxes present in this entry have been checked off,
4798 and the total number of checkboxes present.  This can give you an idea on how
4799 many checkboxes remain, even without opening a folded entry.  The cookies can
4800 be placed into a headline or into (the first line of) a plain list item.
4801 Each cookie covers checkboxes of direct children structurally below the
4802 headline/item on which the cookie appears@footnote{Set the option
4803 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4804 count all checkboxes below the cookie, not just those belonging to direct
4805 children.}.  You have to insert the cookie yourself by typing either
4806 @samp{[/]} or @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m}
4807 result, as in the examples above.  With @samp{[%]} you get information about
4808 the percentage of checkboxes checked (in the above example, this would be
4809 @samp{[50%]} and @samp{[33%]}, respectively).  In a headline, a cookie can
4810 count either checkboxes below the heading or TODO states of children, and it
4811 will display whatever was changed last.  Set the property @code{COOKIE_DATA}
4812 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4814 @cindex blocking, of checkboxes
4815 @cindex checkbox blocking
4816 @cindex property, ORDERED
4817 If the current outline node has an @code{ORDERED} property, checkboxes must
4818 be checked off in sequence, and an error will be thrown if you try to check
4819 off a box while there are unchecked boxes above it.
4821 @noindent The following commands work with checkboxes:
4823 @table @kbd
4824 @orgcmd{C-c C-c,org-toggle-checkbox}
4825 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4826 With a single prefix argument, add an empty checkbox or remove the current
4827 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4828 will add checkboxes to the rest of the list.}.  With a double prefix argument, set it to @samp{[-]}, which is
4829 considered to be an intermediate state.
4830 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4831 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
4832 double prefix argument, set it to @samp{[-]}, which is considered to be an
4833 intermediate state.
4834 @itemize @minus
4835 @item
4836 If there is an active region, toggle the first checkbox in the region
4837 and set all remaining boxes to the same status as the first.  With a prefix
4838 arg, add or remove the checkbox for all items in the region.
4839 @item
4840 If the cursor is in a headline, toggle checkboxes in the region between
4841 this headline and the next (so @emph{not} the entire subtree).
4842 @item
4843 If there is no active region, just toggle the checkbox at point.
4844 @end itemize
4845 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4846 Insert a new item with a checkbox.  This works only if the cursor is already
4847 in a plain list item (@pxref{Plain lists}).
4848 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4849 @vindex org-track-ordered-property-with-tag
4850 @cindex property, ORDERED
4851 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4852 be checked off in sequence.  A property is used for this behavior because
4853 this should be local to the current entry, not inherited like a tag.
4854 However, if you would like to @i{track} the value of this property with a tag
4855 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4856 @orgcmd{C-c #,org-update-statistics-cookies}
4857 Update the statistics cookie in the current outline entry.  When called with
4858 a @kbd{C-u} prefix, update the entire file.  Checkbox statistic cookies are
4859 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4860 new ones with @kbd{M-S-@key{RET}}.  TODO statistics cookies update when
4861 changing TODO states.  If you delete boxes/entries or add/change them by
4862 hand, use this command to get things back into sync.
4863 @end table
4865 @node Tags
4866 @chapter Tags
4867 @cindex tags
4868 @cindex headline tagging
4869 @cindex matching, tags
4870 @cindex sparse tree, tag based
4872 An excellent way to implement labels and contexts for cross-correlating
4873 information is to assign @i{tags} to headlines.  Org mode has extensive
4874 support for tags.
4876 @vindex org-tag-faces
4877 Every headline can contain a list of tags; they occur at the end of the
4878 headline.  Tags are normal words containing letters, numbers, @samp{_}, and
4879 @samp{@@}.  Tags must be preceded and followed by a single colon, e.g.,
4880 @samp{:work:}.  Several tags can be specified, as in @samp{:work:urgent:}.
4881 Tags will by default be in bold face with the same color as the headline.
4882 You may specify special faces for specific tags using the option
4883 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4884 (@pxref{Faces for TODO keywords}).
4886 @menu
4887 * Tag inheritance::             Tags use the tree structure of the outline
4888 * Setting tags::                How to assign tags to a headline
4889 * Tag hierarchy::               Create a hierarchy of tags
4890 * Tag searches::                Searching for combinations of tags
4891 @end menu
4893 @node Tag inheritance
4894 @section Tag inheritance
4895 @cindex tag inheritance
4896 @cindex inheritance, of tags
4897 @cindex sublevels, inclusion into tags match
4899 @i{Tags} make use of the hierarchical structure of outline trees.  If a
4900 heading has a certain tag, all subheadings will inherit the tag as
4901 well.  For example, in the list
4903 @example
4904 * Meeting with the French group      :work:
4905 ** Summary by Frank                  :boss:notes:
4906 *** TODO Prepare slides for him      :action:
4907 @end example
4909 @noindent
4910 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4911 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4912 explicitly marked with those tags.  You can also set tags that all entries in
4913 a file should inherit just as if these tags were defined in a hypothetical
4914 level zero that surrounds the entire file.  Use a line like this@footnote{As
4915 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4916 changes in the line.}:
4918 @cindex #+FILETAGS
4919 @example
4920 #+FILETAGS: :Peter:Boss:Secret:
4921 @end example
4923 @noindent
4924 @vindex org-use-tag-inheritance
4925 @vindex org-tags-exclude-from-inheritance
4926 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4927 To turn it off entirely, use @code{org-use-tag-inheritance}.
4929 @vindex org-tags-match-list-sublevels
4930 When a headline matches during a tags search while tag inheritance is turned
4931 on, all the sublevels in the same tree will (for a simple match form) match
4932 as well@footnote{This is only true if the search does not involve more
4933 complex tests including properties (@pxref{Property searches}).}.  The list
4934 of matches may then become very long.  If you only want to see the first tags
4935 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4936 recommended).
4938 @vindex org-agenda-use-tag-inheritance
4939 Tag inheritance is relevant when the agenda search tries to match a tag,
4940 either in the @code{tags} or @code{tags-todo} agenda types.  In other agenda
4941 types, @code{org-use-tag-inheritance} has no effect.  Still, you may want to
4942 have your tags correctly set in the agenda, so that tag filtering works fine,
4943 with inherited tags.  Set @code{org-agenda-use-tag-inheritance} to control
4944 this: the default value includes all agenda types, but setting this to @code{nil}
4945 can really speed up agenda generation.
4947 @node Setting tags
4948 @section Setting tags
4949 @cindex setting tags
4950 @cindex tags, setting
4952 @kindex M-@key{TAB}
4953 Tags can simply be typed into the buffer at the end of a headline.
4954 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
4955 also a special command for inserting tags:
4957 @table @kbd
4958 @orgcmd{C-c C-q,org-set-tags-command}
4959 @cindex completion, of tags
4960 @vindex org-tags-column
4961 Enter new tags for the current headline.  Org mode will either offer
4962 completion or a special single-key interface for setting tags, see
4963 below.  After pressing @key{RET}, the tags will be inserted and aligned
4964 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
4965 tags in the current buffer will be aligned to that column, just to make
4966 things look nice.  TAGS are automatically realigned after promotion,
4967 demotion, and TODO state changes (@pxref{TODO basics}).
4969 @orgcmd{C-c C-c,org-set-tags-command}
4970 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4971 @end table
4973 @vindex org-tag-alist
4974 Org supports tag insertion based on a @emph{list of tags}.  By
4975 default this list is constructed dynamically, containing all tags
4976 currently used in the buffer.  You may also globally specify a hard list
4977 of tags with the variable @code{org-tag-alist}.  Finally you can set
4978 the default tags for a given file with lines like
4980 @cindex #+TAGS
4981 @example
4982 #+TAGS: @@work @@home @@tennisclub
4983 #+TAGS: laptop car pc sailboat
4984 @end example
4986 If you have globally defined your preferred set of tags using the
4987 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4988 in a specific file, add an empty TAGS option line to that file:
4990 @example
4991 #+TAGS:
4992 @end example
4994 @vindex org-tag-persistent-alist
4995 If you have a preferred set of tags that you would like to use in every file,
4996 in addition to those defined on a per-file basis by TAGS option lines, then
4997 you may specify a list of tags with the variable
4998 @code{org-tag-persistent-alist}.  You may turn this off on a per-file basis
4999 by adding a STARTUP option line to that file:
5001 @example
5002 #+STARTUP: noptag
5003 @end example
5005 By default Org mode uses the standard minibuffer completion facilities for
5006 entering tags.  However, it also implements another, quicker, tag selection
5007 method called @emph{fast tag selection}.  This allows you to select and
5008 deselect tags with just a single key press.  For this to work well you should
5009 assign unique letters to most of your commonly used tags.  You can do this
5010 globally by configuring the variable @code{org-tag-alist} in your
5011 @file{.emacs} file.  For example, you may find the need to tag many items in
5012 different files with @samp{:@@home:}.  In this case you can set something
5013 like:
5015 @lisp
5016 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
5017 @end lisp
5019 @noindent If the tag is only relevant to the file you are working on, then you
5020 can instead set the TAGS option line as:
5022 @example
5023 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
5024 @end example
5026 @noindent The tags interface will show the available tags in a splash
5027 window.  If you want to start a new line after a specific tag, insert
5028 @samp{\n} into the tag list
5030 @example
5031 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t) \n laptop(l)  pc(p)
5032 @end example
5034 @noindent or write them in two lines:
5036 @example
5037 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)
5038 #+TAGS: laptop(l)  pc(p)
5039 @end example
5041 @noindent
5042 You can also group together tags that are mutually exclusive by using
5043 braces, as in:
5045 @example
5046 #+TAGS: @{ @@work(w)  @@home(h)  @@tennisclub(t) @}  laptop(l)  pc(p)
5047 @end example
5049 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
5050 and @samp{@@tennisclub} should be selected.  Multiple such groups are allowed.
5052 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
5053 these lines to activate any changes.
5055 @noindent
5056 To set these mutually exclusive groups in the variable @code{org-tag-alist},
5057 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
5058 of the braces.  Similarly, you can use @code{:newline} to indicate a line
5059 break.  The previous example would be set globally by the following
5060 configuration:
5062 @lisp
5063 (setq org-tag-alist '((:startgroup . nil)
5064                       ("@@work" . ?w) ("@@home" . ?h)
5065                       ("@@tennisclub" . ?t)
5066                       (:endgroup . nil)
5067                       ("laptop" . ?l) ("pc" . ?p)))
5068 @end lisp
5070 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
5071 automatically present you with a special interface, listing inherited tags,
5072 the tags of the current headline, and a list of all valid tags with
5073 corresponding keys@footnote{Keys will automatically be assigned to tags which
5074 have no configured keys.}.  In this interface, you can use the following
5075 keys:
5077 @table @kbd
5078 @item a-z...
5079 Pressing keys assigned to tags will add or remove them from the list of
5080 tags in the current line.  Selecting a tag in a group of mutually
5081 exclusive tags will turn off any other tags from that group.
5082 @kindex @key{TAB}
5083 @item @key{TAB}
5084 Enter a tag in the minibuffer, even if the tag is not in the predefined
5085 list.  You will be able to complete on all tags present in the buffer.
5086 You can also add several tags: just separate them with a comma.
5088 @kindex @key{SPC}
5089 @item @key{SPC}
5090 Clear all tags for this line.
5091 @kindex @key{RET}
5092 @item @key{RET}
5093 Accept the modified set.
5094 @item C-g
5095 Abort without installing changes.
5096 @item q
5097 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5098 @item !
5099 Turn off groups of mutually exclusive tags.  Use this to (as an
5100 exception) assign several tags from such a group.
5101 @item C-c
5102 Toggle auto-exit after the next change (see below).
5103 If you are using expert mode, the first @kbd{C-c} will display the
5104 selection window.
5105 @end table
5107 @noindent
5108 This method lets you assign tags to a headline with very few keys.  With
5109 the above setup, you could clear the current tags and set @samp{@@home},
5110 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5111 C-c @key{SPC} h l p @key{RET}}.  Switching from @samp{@@home} to
5112 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5113 alternatively with @kbd{C-c C-c C-c w}.  Adding the non-predefined tag
5114 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5115 @key{RET} @key{RET}}.
5117 @vindex org-fast-tag-selection-single-key
5118 If you find that most of the time you need only a single key press to
5119 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5120 Then you no longer have to press @key{RET} to exit fast tag selection---it
5121 will immediately exit after the first change.  If you then occasionally
5122 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5123 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5124 instead of @kbd{C-c C-c}).  If you set the variable to the value
5125 @code{expert}, the special window is not even shown for single-key tag
5126 selection, it comes up only when you press an extra @kbd{C-c}.
5128 @node Tag hierarchy
5129 @section Tag hierarchy
5131 @cindex group tags
5132 @cindex tags, groups
5133 @cindex tag hierarchy
5134 Tags can be defined in hierarchies.  A tag can be defined as a @emph{group
5135 tag} for a set of other tags.  The group tag can be seen as the ``broader
5136 term'' for its set of tags.  Defining multiple @emph{group tags} and nesting
5137 them creates a tag hierarchy.
5139 One use-case is to create a taxonomy of terms (tags) that can be used to
5140 classify nodes in a document or set of documents.
5142 When you search for a group tag, it will return matches for all members in
5143 the group and its subgroup.  In an agenda view, filtering by a group tag will
5144 display or hide headlines tagged with at least one of the members of the
5145 group or any of its subgroups.  This makes tag searches and filters even more
5146 flexible.
5148 You can set group tags by using brackets and inserting a colon between the
5149 group tag and its related tags---beware that all whitespaces are mandatory so
5150 that Org can parse this line correctly:
5152 @example
5153 #+TAGS: [ GTD : Control Persp ]
5154 @end example
5156 In this example, @samp{GTD} is the @emph{group tag} and it is related to two
5157 other tags: @samp{Control}, @samp{Persp}.  Defining @samp{Control} and
5158 @samp{Persp} as group tags creates an hierarchy of tags:
5160 @example
5161 #+TAGS: [ Control : Context Task ]
5162 #+TAGS: [ Persp : Vision Goal AOF Project ]
5163 @end example
5165 That can conceptually be seen as a hierarchy of tags:
5167 @example
5168 - GTD
5169   - Persp
5170     - Vision
5171     - Goal
5172     - AOF
5173     - Project
5174   - Control
5175     - Context
5176     - Task
5177 @end example
5179 You can use the @code{:startgrouptag}, @code{:grouptags} and
5180 @code{:endgrouptag} keyword directly when setting @code{org-tag-alist}
5181 directly:
5183 @lisp
5184 (setq org-tag-alist '((:startgrouptag)
5185                       ("GTD")
5186                       (:grouptags)
5187                       ("Control")
5188                       ("Persp")
5189                       (:endgrouptag)
5190                       (:startgrouptag)
5191                       ("Control")
5192                       (:grouptags)
5193                       ("Context")
5194                       ("Task")
5195                       (:endgrouptag)))
5196 @end lisp
5198 The tags in a group can be mutually exclusive if using the same group syntax
5199 as is used for grouping mutually exclusive tags together; using curly
5200 brackets.
5202 @example
5203 #+TAGS: @{ Context : @@Home @@Work @@Call @}
5204 @end example
5206 When setting @code{org-tag-alist} you can use @code{:startgroup} &
5207 @code{:endgroup} instead of @code{:startgrouptag} & @code{:endgrouptag} to
5208 make the tags mutually exclusive.
5210 Furthermore; The members of a @emph{group tag} can also be regular
5211 expression, creating the possibility of more dynamic and rule-based
5212 tag-structure.  The regular expressions in the group must be marked up within
5213 @{ @}.  Example use, to expand on the example given above:
5215 @example
5216 #+TAGS: [ Vision : @{V@.+@} ]
5217 #+TAGS: [ Goal : @{G@.+@} ]
5218 #+TAGS: [ AOF : @{AOF@.+@} ]
5219 #+TAGS: [ Project : @{P@.+@} ]
5220 @end example
5222 Searching for the tag @samp{Project} will now list all tags also including
5223 regular expression matches for @samp{P@@.+}.  Similar for tag-searches on
5224 @samp{Vision}, @samp{Goal} and @samp{AOF}.  This can be good for example if
5225 tags for a certain project is tagged with a common project-identifier,
5226 i.e. @samp{P@@2014_OrgTags}.
5228 @kindex C-c C-x q
5229 @vindex org-group-tags
5230 If you want to ignore group tags temporarily, toggle group tags support
5231 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}.  If you
5232 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5234 @node Tag searches
5235 @section Tag searches
5236 @cindex tag searches
5237 @cindex searching for tags
5239 Once a system of tags has been set up, it can be used to collect related
5240 information into special lists.
5242 @table @kbd
5243 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5244 Create a sparse tree with all headlines matching a tags/property/TODO search.
5245 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5246 @xref{Matching tags and properties}.
5247 @orgcmd{C-c a m,org-tags-view}
5248 Create a global list of tag matches from all agenda files.  @xref{Matching
5249 tags and properties}.
5250 @orgcmd{C-c a M,org-tags-view}
5251 @vindex org-tags-match-list-sublevels
5252 Create a global list of tag matches from all agenda files, but check
5253 only TODO items and force checking subitems (see the option
5254 @code{org-tags-match-list-sublevels}).
5255 @end table
5257 These commands all prompt for a match string which allows basic Boolean logic
5258 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5259 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5260 which are tagged, like @samp{Kathy} or @samp{Sally}.  The full syntax of the search
5261 string is rich and allows also matching against TODO keywords, entry levels
5262 and properties.  For a complete description with many examples, see
5263 @ref{Matching tags and properties}.
5266 @node Properties and columns
5267 @chapter Properties and columns
5268 @cindex properties
5270 A property is a key-value pair associated with an entry.  Properties can be
5271 set so they are associated with a single entry, with every entry in a tree,
5272 or with every entry in an Org mode file.
5274 There are two main applications for properties in Org mode.  First,
5275 properties are like tags, but with a value.  Imagine maintaining a file where
5276 you document bugs and plan releases for a piece of software.  Instead of
5277 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5278 property, say @code{:Release:}, that in different subtrees has different
5279 values, such as @code{1.0} or @code{2.0}.  Second, you can use properties to
5280 implement (very basic) database capabilities in an Org buffer.  Imagine
5281 keeping track of your music CDs, where properties could be things such as the
5282 album, artist, date of release, number of tracks, and so on.
5284 Properties can be conveniently edited and viewed in column view
5285 (@pxref{Column view}).
5287 @menu
5288 * Property syntax::             How properties are spelled out
5289 * Special properties::          Access to other Org mode features
5290 * Property searches::           Matching property values
5291 * Property inheritance::        Passing values down the tree
5292 * Column view::                 Tabular viewing and editing
5293 * Property API::                Properties for Lisp programmers
5294 @end menu
5296 @node Property syntax
5297 @section Property syntax
5298 @cindex property syntax
5299 @cindex drawer, for properties
5301 Properties are key-value pairs.  When they are associated with a single entry
5302 or with a tree they need to be inserted into a special drawer
5303 (@pxref{Drawers}) with the name @code{PROPERTIES}, which has to be located
5304 right below a headline, and its planning line (@pxref{Deadlines and
5305 scheduling}) when applicable.  Each property is specified on a single line,
5306 with the key (surrounded by colons) first, and the value after it.  Keys are
5307 case-insensitives.  Here is an example:
5309 @example
5310 * CD collection
5311 ** Classic
5312 *** Goldberg Variations
5313     :PROPERTIES:
5314     :Title:     Goldberg Variations
5315     :Composer:  J.S. Bach
5316     :Artist:    Glen Gould
5317     :Publisher: Deutsche Grammophon
5318     :NDisks:    1
5319     :END:
5320 @end example
5322 Depending on the value of @code{org-use-property-inheritance}, a property set
5323 this way will either be associated with a single entry, or the subtree
5324 defined by the entry, see @ref{Property inheritance}.
5326 You may define the allowed values for a particular property @samp{:Xyz:}
5327 by setting a property @samp{:Xyz_ALL:}.  This special property is
5328 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5329 the entire tree.  When allowed values are defined, setting the
5330 corresponding property becomes easier and is less prone to typing
5331 errors.  For the example with the CD collection, we can predefine
5332 publishers and the number of disks in a box like this:
5334 @example
5335 * CD collection
5336   :PROPERTIES:
5337   :NDisks_ALL:  1 2 3 4
5338   :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5339   :END:
5340 @end example
5342 If you want to set properties that can be inherited by any entry in a
5343 file, use a line like
5344 @cindex property, _ALL
5345 @cindex #+PROPERTY
5346 @example
5347 #+PROPERTY: NDisks_ALL 1 2 3 4
5348 @end example
5350 Contrary to properties set from a special drawer, you have to refresh the
5351 buffer with @kbd{C-c C-c} to activate this change.
5353 If you want to add to the value of an existing property, append a @code{+} to
5354 the property name.  The following results in the property @code{var} having
5355 the value ``foo=1 bar=2''.
5356 @cindex property, +
5357 @example
5358 #+PROPERTY: var  foo=1
5359 #+PROPERTY: var+ bar=2
5360 @end example
5362 It is also possible to add to the values of inherited properties.  The
5363 following results in the @code{genres} property having the value ``Classic
5364 Baroque'' under the @code{Goldberg Variations} subtree.
5365 @cindex property, +
5366 @example
5367 * CD collection
5368 ** Classic
5369     :PROPERTIES:
5370     :GENRES: Classic
5371     :END:
5372 *** Goldberg Variations
5373     :PROPERTIES:
5374     :Title:     Goldberg Variations
5375     :Composer:  J.S. Bach
5376     :Artist:    Glen Gould
5377     :Publisher: Deutsche Grammophon
5378     :NDisks:    1
5379     :GENRES+:   Baroque
5380     :END:
5381 @end example
5382 Note that a property can only have one entry per Drawer.
5384 @vindex org-global-properties
5385 Property values set with the global variable
5386 @code{org-global-properties} can be inherited by all entries in all
5387 Org files.
5389 @noindent
5390 The following commands help to work with properties:
5392 @table @kbd
5393 @orgcmd{M-@key{TAB},pcomplete}
5394 After an initial colon in a line, complete property keys.  All keys used
5395 in the current file will be offered as possible completions.
5396 @orgcmd{C-c C-x p,org-set-property}
5397 Set a property.  This prompts for a property name and a value.  If
5398 necessary, the property drawer is created as well.
5399 @item C-u M-x org-insert-drawer RET
5400 @cindex org-insert-drawer
5401 Insert a property drawer into the current entry.  The drawer will be
5402 inserted early in the entry, but after the lines with planning
5403 information like deadlines.
5404 @orgcmd{C-c C-c,org-property-action}
5405 With the cursor in a property drawer, this executes property commands.
5406 @orgcmd{C-c C-c s,org-set-property}
5407 Set a property in the current entry.  Both the property and the value
5408 can be inserted using completion.
5409 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5410 Switch property at point to the next/previous allowed value.
5411 @orgcmd{C-c C-c d,org-delete-property}
5412 Remove a property from the current entry.
5413 @orgcmd{C-c C-c D,org-delete-property-globally}
5414 Globally remove a property, from all entries in the current file.
5415 @orgcmd{C-c C-c c,org-compute-property-at-point}
5416 Compute the property at point, using the operator and scope from the
5417 nearest column format definition.
5418 @end table
5420 @node Special properties
5421 @section Special properties
5422 @cindex properties, special
5424 Special properties provide an alternative access method to Org mode features,
5425 like the TODO state or the priority of an entry, discussed in the previous
5426 chapters.  This interface exists so that you can include these states in
5427 a column view (@pxref{Column view}), or to use them in queries.  The
5428 following property names are special and should not be used as keys in the
5429 properties drawer:
5431 @cindex property, special, ALLTAGS
5432 @cindex property, special, BLOCKED
5433 @cindex property, special, CLOCKSUM
5434 @cindex property, special, CLOCKSUM_T
5435 @cindex property, special, CLOSED
5436 @cindex property, special, DEADLINE
5437 @cindex property, special, FILE
5438 @cindex property, special, ITEM
5439 @cindex property, special, PRIORITY
5440 @cindex property, special, SCHEDULED
5441 @cindex property, special, TAGS
5442 @cindex property, special, TIMESTAMP
5443 @cindex property, special, TIMESTAMP_IA
5444 @cindex property, special, TODO
5445 @example
5446 ALLTAGS      @r{All tags, including inherited ones.}
5447 BLOCKED      @r{"t" if task is currently blocked by children or siblings.}
5448 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
5449              @r{must be run first to compute the values in the current buffer.}
5450 CLOCKSUM_T   @r{The sum of CLOCK intervals in the subtree for today.}
5451              @r{@code{org-clock-sum-today} must be run first to compute the}
5452              @r{values in the current buffer.}
5453 CLOSED       @r{When was this entry closed?}
5454 DEADLINE     @r{The deadline time string, without the angular brackets.}
5455 FILE         @r{The filename the entry is located in.}
5456 ITEM         @r{The headline of the entry, with stars.}
5457 PRIORITY     @r{The priority of the entry, a string with a single letter.}
5458 SCHEDULED    @r{The scheduling timestamp, without the angular brackets.}
5459 TAGS         @r{The tags defined directly in the headline.}
5460 TIMESTAMP    @r{The first keyword-less timestamp in the entry.}
5461 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5462 TODO         @r{The TODO keyword of the entry.}
5463 @end example
5465 @node Property searches
5466 @section Property searches
5467 @cindex properties, searching
5468 @cindex searching, of properties
5470 To create sparse trees and special lists with selection based on properties,
5471 the same commands are used as for tag searches (@pxref{Tag searches}).
5473 @table @kbd
5474 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5475 Create a sparse tree with all matching entries.  With a
5476 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5477 @orgcmd{C-c a m,org-tags-view}
5478 Create a global list of tag/property  matches from all agenda files.
5479 @xref{Matching tags and properties}.
5480 @orgcmd{C-c a M,org-tags-view}
5481 @vindex org-tags-match-list-sublevels
5482 Create a global list of tag matches from all agenda files, but check
5483 only TODO items and force checking of subitems (see the option
5484 @code{org-tags-match-list-sublevels}).
5485 @end table
5487 The syntax for the search string is described in @ref{Matching tags and
5488 properties}.
5490 There is also a special command for creating sparse trees based on a
5491 single property:
5493 @table @kbd
5494 @orgkey{C-c / p}
5495 Create a sparse tree based on the value of a property.  This first
5496 prompts for the name of a property, and then for a value.  A sparse tree
5497 is created with all entries that define this property with the given
5498 value.  If you enclose the value in curly braces, it is interpreted as
5499 a regular expression and matched against the property values.
5500 @end table
5502 @node Property inheritance
5503 @section Property Inheritance
5504 @cindex properties, inheritance
5505 @cindex inheritance, of properties
5507 @vindex org-use-property-inheritance
5508 The outline structure of Org mode documents lends itself to an
5509 inheritance model of properties: if the parent in a tree has a certain
5510 property, the children can inherit this property.  Org mode does not
5511 turn this on by default, because it can slow down property searches
5512 significantly and is often not needed.  However, if you find inheritance
5513 useful, you can turn it on by setting the variable
5514 @code{org-use-property-inheritance}.  It may be set to @code{t} to make
5515 all properties inherited from the parent, to a list of properties
5516 that should be inherited, or to a regular expression that matches
5517 inherited properties.  If a property has the value @code{nil}, this is
5518 interpreted as an explicit undefine of the property, so that inheritance
5519 search will stop at this value and return @code{nil}.
5521 Org mode has a few properties for which inheritance is hard-coded, at
5522 least for the special applications for which they are used:
5524 @cindex property, COLUMNS
5525 @table @code
5526 @item COLUMNS
5527 The @code{:COLUMNS:} property defines the format of column view
5528 (@pxref{Column view}).  It is inherited in the sense that the level
5529 where a @code{:COLUMNS:} property is defined is used as the starting
5530 point for a column view table, independently of the location in the
5531 subtree from where columns view is turned on.
5532 @item CATEGORY
5533 @cindex property, CATEGORY
5534 For agenda view, a category set through a @code{:CATEGORY:} property
5535 applies to the entire subtree.
5536 @item ARCHIVE
5537 @cindex property, ARCHIVE
5538 For archiving, the @code{:ARCHIVE:} property may define the archive
5539 location for the entire subtree (@pxref{Moving subtrees}).
5540 @item LOGGING
5541 @cindex property, LOGGING
5542 The LOGGING property may define logging settings for an entry or a
5543 subtree (@pxref{Tracking TODO state changes}).
5544 @end table
5546 @node Column view
5547 @section Column view
5549 A great way to view and edit properties in an outline tree is
5550 @emph{column view}.  In column view, each outline node is turned into a
5551 table row.  Columns in this table provide access to properties of the
5552 entries.  Org mode implements columns by overlaying a tabular structure
5553 over the headline of each item.  While the headlines have been turned
5554 into a table row, you can still change the visibility of the outline
5555 tree.  For example, you get a compact table by switching to CONTENTS
5556 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5557 is active), but you can still open, read, and edit the entry below each
5558 headline.  Or, you can switch to column view after executing a sparse
5559 tree command and in this way get a table only for the selected items.
5560 Column view also works in agenda buffers (@pxref{Agenda views}) where
5561 queries have collected selected items, possibly from a number of files.
5563 @menu
5564 * Defining columns::            The COLUMNS format property
5565 * Using column view::           How to create and use column view
5566 * Capturing column view::       A dynamic block for column view
5567 @end menu
5569 @node Defining columns
5570 @subsection Defining columns
5571 @cindex column view, for properties
5572 @cindex properties, column view
5574 Setting up a column view first requires defining the columns.  This is
5575 done by defining a column format line.
5577 @menu
5578 * Scope of column definitions::  Where defined, where valid?
5579 * Column attributes::           Appearance and content of a column
5580 @end menu
5582 @node Scope of column definitions
5583 @subsubsection Scope of column definitions
5585 To define a column format for an entire file, use a line like
5587 @cindex #+COLUMNS
5588 @example
5589 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5590 @end example
5592 To specify a format that only applies to a specific tree, add a
5593 @code{:COLUMNS:} property to the top node of that tree, for example:
5595 @example
5596 ** Top node for columns view
5597    :PROPERTIES:
5598    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5599    :END:
5600 @end example
5602 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5603 for the entry itself, and for the entire subtree below it.  Since the
5604 column definition is part of the hierarchical structure of the document,
5605 you can define columns on level 1 that are general enough for all
5606 sublevels, and more specific columns further down, when you edit a
5607 deeper part of the tree.
5609 @node Column attributes
5610 @subsubsection Column attributes
5611 A column definition sets the attributes of a column.  The general
5612 definition looks like this:
5614 @example
5615  %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5616 @end example
5618 @noindent
5619 Except for the percent sign and the property name, all items are
5620 optional.  The individual parts have the following meaning:
5622 @example
5623 @var{width}           @r{An integer specifying the width of the column in characters.}
5624                 @r{If omitted, the width will be determined automatically.}
5625 @var{property}        @r{The property that should be edited in this column.}
5626                 @r{Special properties representing meta data are allowed here}
5627                 @r{as well (@pxref{Special properties})}
5628 @var{title}           @r{The header text for the column.  If omitted, the property}
5629                 @r{name is used.}
5630 @{@var{summary-type}@}  @r{The summary type.  If specified, the column values for}
5631                 @r{parent nodes are computed from the children.}
5632                 @r{Supported summary types are:}
5633                 @{+@}       @r{Sum numbers in this column.}
5634                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
5635                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
5636                 @{:@}       @r{Sum times, HH:MM, plain numbers are hours.}
5637                 @{X@}       @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5638                 @{X/@}      @r{Checkbox status, @samp{[n/m]}.}
5639                 @{X%@}      @r{Checkbox status, @samp{[n%]}.}
5640                 @{min@}     @r{Smallest number in column.}
5641                 @{max@}     @r{Largest number.}
5642                 @{mean@}    @r{Arithmetic mean of numbers.}
5643                 @{:min@}    @r{Smallest time value in column.}
5644                 @{:max@}    @r{Largest time value.}
5645                 @{:mean@}   @r{Arithmetic mean of time values.}
5646                 @{@@min@}    @r{Minimum age (in days/hours/mins/seconds).}
5647                 @{@@max@}    @r{Maximum age (in days/hours/mins/seconds).}
5648                 @{@@mean@}   @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5649                 @{est+@}    @r{Add @samp{low-high} estimates.}
5650 @end example
5652 @noindent
5653 Be aware that you can only have one summary type for any property you
5654 include.  Subsequent columns referencing the same property will all display the
5655 same summary information.
5657 The @code{est+} summary type requires further explanation.  It is used for
5658 combining estimates, expressed as @samp{low-high} ranges or plain numbers.
5659 For example, instead of estimating a particular task will take 5 days, you
5660 might estimate it as 5--6 days if you're fairly confident you know how much
5661 work is required, or 1--10 days if you don't really know what needs to be
5662 done.  Both ranges average at 5.5 days, but the first represents a more
5663 predictable delivery.
5665 When combining a set of such estimates, simply adding the lows and highs
5666 produces an unrealistically wide result.  Instead, @code{est+} adds the
5667 statistical mean and variance of the sub-tasks, generating a final estimate
5668 from the sum.  For example, suppose you had ten tasks, each of which was
5669 estimated at 0.5 to 2 days of work.  Straight addition produces an estimate
5670 of 5 to 20 days, representing what to expect if everything goes either
5671 extremely well or extremely poorly.  In contrast, @code{est+} estimates the
5672 full job more realistically, at 10--15 days.
5674 Numbers are right-aligned when a format specifier with an explicit width like
5675 @code{%5d} or @code{%5.1f} is used.
5677 Here is an example for a complete columns definition, along with allowed
5678 values.
5680 @example
5681 :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.}
5682                    %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5683 :Owner_ALL:    Tammy Mark Karl Lisa Don
5684 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
5685 :Approved_ALL: "[ ]" "[X]"
5686 @end example
5688 @noindent
5689 The first column, @samp{%25ITEM}, means the first 25 characters of the
5690 item itself, i.e., of the headline.  You probably always should start the
5691 column definition with the @samp{ITEM} specifier.  The other specifiers
5692 create columns @samp{Owner} with a list of names as allowed values, for
5693 @samp{Status} with four different possible values, and for a checkbox
5694 field @samp{Approved}.  When no width is given after the @samp{%}
5695 character, the column will be exactly as wide as it needs to be in order
5696 to fully display all values.  The @samp{Approved} column does have a
5697 modified title (@samp{Approved?}, with a question mark).  Summaries will
5698 be created for the @samp{Time_Estimate} column by adding time duration
5699 expressions like HH:MM, and for the @samp{Approved} column, by providing
5700 an @samp{[X]} status if all children have been checked.  The
5701 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5702 sums of CLOCK intervals in the subtree, either for all clocks or just for
5703 today.
5705 @node Using column view
5706 @subsection Using column view
5708 @table @kbd
5709 @tsubheading{Turning column view on and off}
5710 @orgcmd{C-c C-x C-c,org-columns}
5711 @vindex org-columns-default-format
5712 Turn on column view.  If the cursor is before the first headline in the file,
5713 column view is turned on for the entire file, using the @code{#+COLUMNS}
5714 definition.  If the cursor is somewhere inside the outline, this command
5715 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5716 defines a format.  When one is found, the column view table is established
5717 for the tree starting at the entry that contains the @code{:COLUMNS:}
5718 property.  If no such property is found, the format is taken from the
5719 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5720 and column view is established for the current entry and its subtree.
5721 @orgcmd{r,org-columns-redo}
5722 Recreate the column view, to include recent changes made in the buffer.
5723 @orgcmd{g,org-columns-redo}
5724 Same as @kbd{r}.
5725 @orgcmd{q,org-columns-quit}
5726 Exit column view.
5727 @tsubheading{Editing values}
5728 @item @key{left} @key{right} @key{up} @key{down}
5729 Move through the column view from field to field.
5730 @kindex S-@key{left}
5731 @kindex S-@key{right}
5732 @item  S-@key{left}/@key{right}
5733 Switch to the next/previous allowed value of the field.  For this, you
5734 have to have specified allowed values for a property.
5735 @item 1..9,0
5736 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5737 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5738 Same as @kbd{S-@key{left}/@key{right}}
5739 @orgcmd{e,org-columns-edit-value}
5740 Edit the property at point.  For the special properties, this will
5741 invoke the same interface that you normally use to change that
5742 property.  For example, when editing a TAGS property, the tag completion
5743 or fast selection interface will pop up.
5744 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5745 When there is a checkbox at point, toggle it.
5746 @orgcmd{v,org-columns-show-value}
5747 View the full value of this property.  This is useful if the width of
5748 the column is smaller than that of the value.
5749 @orgcmd{a,org-columns-edit-allowed}
5750 Edit the list of allowed values for this property.  If the list is found
5751 in the hierarchy, the modified value is stored there.  If no list is
5752 found, the new value is stored in the first entry that is part of the
5753 current column view.
5754 @tsubheading{Modifying the table structure}
5755 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5756 Make the column narrower/wider by one character.
5757 @orgcmd{S-M-@key{right},org-columns-new}
5758 Insert a new column, to the left of the current column.
5759 @orgcmd{S-M-@key{left},org-columns-delete}
5760 Delete the current column.
5761 @end table
5763 @node Capturing column view
5764 @subsection Capturing column view
5766 Since column view is just an overlay over a buffer, it cannot be
5767 exported or printed directly.  If you want to capture a column view, use
5768 a @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
5769 of this block looks like this:
5771 @cindex #+BEGIN, columnview
5772 @example
5773 * The column view
5774 #+BEGIN: columnview :hlines 1 :id "label"
5776 #+END:
5777 @end example
5779 @noindent This dynamic block has the following parameters:
5781 @table @code
5782 @item :id
5783 This is the most important parameter.  Column view is a feature that is
5784 often localized to a certain (sub)tree, and the capture block might be
5785 at a different location in the file.  To identify the tree whose view to
5786 capture, you can use 4 values:
5787 @cindex property, ID
5788 @example
5789 local     @r{use the tree in which the capture block is located}
5790 global    @r{make a global view, including all headings in the file}
5791 "file:@var{path-to-file}"
5792           @r{run column view at the top of this file}
5793 "@var{ID}"      @r{call column view in the tree that has an @code{:ID:}}
5794           @r{property with the value @i{label}.  You can use}
5795           @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5796           @r{the current entry and copy it to the kill-ring.}
5797 @end example
5798 @item :hlines
5799 When @code{t}, insert an hline after every line.  When a number @var{N}, insert
5800 an hline before each headline with level @code{<= @var{N}}.
5801 @item :vlines
5802 When set to @code{t}, force column groups to get vertical lines.
5803 @item :maxlevel
5804 When set to a number, don't capture entries below this level.
5805 @item :skip-empty-rows
5806 When set to @code{t}, skip rows where the only non-empty specifier of the
5807 column view is @code{ITEM}.
5809 @end table
5811 @noindent
5812 The following commands insert or update the dynamic block:
5814 @table @kbd
5815 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5816 Insert a dynamic block capturing a column view.  You will be prompted
5817 for the scope or ID of the view.
5818 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5819 Update dynamic block at point.  The cursor needs to be in the
5820 @code{#+BEGIN} line of the dynamic block.
5821 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5822 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
5823 you have several clock table blocks, column-capturing blocks or other dynamic
5824 blocks in a buffer.
5825 @end table
5827 You can add formulas to the column view table and you may add plotting
5828 instructions in front of the table---these will survive an update of the
5829 block.  If there is a @code{#+TBLFM:} after the table, the table will
5830 actually be recalculated automatically after an update.
5832 An alternative way to capture and process property values into a table is
5833 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5834 package@footnote{Contributed packages are not part of Emacs, but are
5835 distributed with the main distribution of Org (visit
5836 @uref{http://orgmode.org}).}.  It provides a general API to collect
5837 properties from entries in a certain scope, and arbitrary Lisp expressions to
5838 process these values before inserting them into a table or a dynamic block.
5840 @node Property API
5841 @section The Property API
5842 @cindex properties, API
5843 @cindex API, for properties
5845 There is a full API for accessing and changing properties.  This API can
5846 be used by Emacs Lisp programs to work with properties and to implement
5847 features based on them.  For more information see @ref{Using the
5848 property API}.
5850 @node Dates and times
5851 @chapter Dates and times
5852 @cindex dates
5853 @cindex times
5854 @cindex timestamp
5855 @cindex date stamp
5857 To assist project planning, TODO items can be labeled with a date and/or
5858 a time.  The specially formatted string carrying the date and time
5859 information is called a @emph{timestamp} in Org mode.  This may be a
5860 little confusing because timestamp is often used to indicate when
5861 something was created or last changed.  However, in Org mode this term
5862 is used in a much wider sense.
5864 @menu
5865 * Timestamps::                  Assigning a time to a tree entry
5866 * Creating timestamps::         Commands which insert timestamps
5867 * Deadlines and scheduling::    Planning your work
5868 * Clocking work time::          Tracking how long you spend on a task
5869 * Effort estimates::            Planning work effort in advance
5870 * Timers::                      Notes with a running timer
5871 @end menu
5874 @node Timestamps
5875 @section Timestamps, deadlines, and scheduling
5876 @cindex timestamps
5877 @cindex ranges, time
5878 @cindex date stamps
5879 @cindex deadlines
5880 @cindex scheduling
5882 A timestamp is a specification of a date (possibly with a time or a range of
5883 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5884 simplest form, the day name is optional when you type the date yourself.
5885 However, any dates inserted or modified by Org will add that day name, for
5886 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5887 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5888 date/time format.  To use an alternative format, see @ref{Custom time
5889 format}.}.  A timestamp can appear anywhere in the headline or body of an Org
5890 tree entry.  Its presence causes entries to be shown on specific dates in the
5891 agenda (@pxref{Weekly/daily agenda}).  We distinguish:
5893 @table @var
5894 @item Plain timestamp; Event; Appointment
5895 @cindex timestamp
5896 @cindex appointment
5897 A simple timestamp just assigns a date/time to an item.  This is just
5898 like writing down an appointment or event in a paper agenda.  In the
5899 timeline and agenda displays, the headline of an entry associated with a
5900 plain timestamp will be shown exactly on that date.
5902 @example
5903 * Meet Peter at the movies
5904   <2006-11-01 Wed 19:15>
5905 * Discussion on climate change
5906   <2006-11-02 Thu 20:00-22:00>
5907 @end example
5909 @item Timestamp with repeater interval
5910 @cindex timestamp, with repeater interval
5911 A timestamp may contain a @emph{repeater interval}, indicating that it
5912 applies not only on the given date, but again and again after a certain
5913 interval of N days (d), weeks (w), months (m), or years (y).  The
5914 following will show up in the agenda every Wednesday:
5916 @example
5917 * Pick up Sam at school
5918   <2007-05-16 Wed 12:30 +1w>
5919 @end example
5921 @item Diary-style sexp entries
5922 For more complex date specifications, Org mode supports using the special
5923 sexp diary entries implemented in the Emacs calendar/diary
5924 package@footnote{When working with the standard diary sexp functions, you
5925 need to be very careful with the order of the arguments.  That order depends
5926 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5927 versions, @code{european-calendar-style}).  For example, to specify a date
5928 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5929 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5930 the settings.  This has been the source of much confusion.  Org mode users
5931 can resort to special versions of these functions like @code{org-date} or
5932 @code{org-anniversary}.  These work just like the corresponding @code{diary-}
5933 functions, but with stable ISO order of arguments (year, month, day) wherever
5934 applicable, independent of the value of @code{calendar-date-style}.}.  For
5935 example with optional time
5937 @example
5938 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5939   <%%(diary-float t 4 2)>
5940 @end example
5942 @item Time/Date range
5943 @cindex timerange
5944 @cindex date range
5945 Two timestamps connected by @samp{--} denote a range.  The headline
5946 will be shown on the first and last day of the range, and on any dates
5947 that are displayed and fall in the range.  Here is an example:
5949 @example
5950 ** Meeting in Amsterdam
5951    <2004-08-23 Mon>--<2004-08-26 Thu>
5952 @end example
5954 @item Inactive timestamp
5955 @cindex timestamp, inactive
5956 @cindex inactive timestamp
5957 Just like a plain timestamp, but with square brackets instead of
5958 angular ones.  These timestamps are inactive in the sense that they do
5959 @emph{not} trigger an entry to show up in the agenda.
5961 @example
5962 * Gillian comes late for the fifth time
5963   [2006-11-01 Wed]
5964 @end example
5966 @end table
5968 @node Creating timestamps
5969 @section Creating timestamps
5970 @cindex creating timestamps
5971 @cindex timestamps, creating
5973 For Org mode to recognize timestamps, they need to be in the specific
5974 format.  All commands listed below produce timestamps in the correct
5975 format.
5977 @table @kbd
5978 @orgcmd{C-c .,org-time-stamp}
5979 Prompt for a date and insert a corresponding timestamp.  When the cursor is
5980 at an existing timestamp in the buffer, the command is used to modify this
5981 timestamp instead of inserting a new one.  When this command is used twice in
5982 succession, a time range is inserted.
5984 @orgcmd{C-c !,org-time-stamp-inactive}
5985 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5986 an agenda entry.
5988 @kindex C-u C-c .
5989 @kindex C-u C-c !
5990 @item C-u C-c .
5991 @itemx C-u C-c !
5992 @vindex org-time-stamp-rounding-minutes
5993 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5994 contains date and time.  The default time can be rounded to multiples of 5
5995 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5997 @orgkey{C-c C-c}
5998 Normalize timestamp, insert/fix day name if missing or wrong.
6000 @orgcmd{C-c <,org-date-from-calendar}
6001 Insert a timestamp corresponding to the cursor date in the Calendar.
6003 @orgcmd{C-c >,org-goto-calendar}
6004 Access the Emacs calendar for the current date.  If there is a
6005 timestamp in the current line, go to the corresponding date
6006 instead.
6008 @orgcmd{C-c C-o,org-open-at-point}
6009 Access the agenda for the date given by the timestamp or -range at
6010 point (@pxref{Weekly/daily agenda}).
6012 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
6013 Change date at cursor by one day.  These key bindings conflict with
6014 shift-selection and related modes (@pxref{Conflicts}).
6016 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
6017 Change the item under the cursor in a timestamp.  The cursor can be on a
6018 year, month, day, hour or minute.  When the timestamp contains a time range
6019 like @samp{15:30-16:30}, modifying the first time will also shift the second,
6020 shifting the time block with constant length.  To change the length, modify
6021 the second time.  Note that if the cursor is in a headline and not at a
6022 timestamp, these same keys modify the priority of an item.
6023 (@pxref{Priorities}).  The key bindings also conflict with shift-selection and
6024 related modes (@pxref{Conflicts}).
6026 @orgcmd{C-c C-y,org-evaluate-time-range}
6027 @cindex evaluate time range
6028 Evaluate a time range by computing the difference between start and end.
6029 With a prefix argument, insert result after the time range (in a table: into
6030 the following column).
6031 @end table
6034 @menu
6035 * The date/time prompt::        How Org mode helps you entering date and time
6036 * Custom time format::          Making dates look different
6037 @end menu
6039 @node The date/time prompt
6040 @subsection The date/time prompt
6041 @cindex date, reading in minibuffer
6042 @cindex time, reading in minibuffer
6044 @vindex org-read-date-prefer-future
6045 When Org mode prompts for a date/time, the default is shown in default
6046 date/time format, and the prompt therefore seems to ask for a specific
6047 format.  But it will in fact accept date/time information in a variety of
6048 formats.  Generally, the information should start at the beginning of the
6049 string.  Org mode will find whatever information is in
6050 there and derive anything you have not specified from the @emph{default date
6051 and time}.  The default is usually the current date and time, but when
6052 modifying an existing timestamp, or when entering the second stamp of a
6053 range, it is taken from the stamp in the buffer.  When filling in
6054 information, Org mode assumes that most of the time you will want to enter a
6055 date in the future: if you omit the month/year and the given day/month is
6056 @i{before} today, it will assume that you mean a future date@footnote{See the
6057 variable @code{org-read-date-prefer-future}.  You may set that variable to
6058 the symbol @code{time} to even make a time before now shift the date to
6059 tomorrow.}.  If the date has been automatically shifted into the future, the
6060 time prompt will show this with @samp{(=>F).}
6062 For example, let's assume that today is @b{June 13, 2006}.  Here is how
6063 various inputs will be interpreted, the items filled in by Org mode are
6064 in @b{bold}.
6066 @example
6067 3-2-5         @result{} 2003-02-05
6068 2/5/3         @result{} 2003-02-05
6069 14            @result{} @b{2006}-@b{06}-14
6070 12            @result{} @b{2006}-@b{07}-12
6071 2/5           @result{} @b{2007}-02-05
6072 Fri           @result{} nearest Friday after the default date
6073 sep 15        @result{} @b{2006}-09-15
6074 feb 15        @result{} @b{2007}-02-15
6075 sep 12 9      @result{} 2009-09-12
6076 12:45         @result{} @b{2006}-@b{06}-@b{13} 12:45
6077 22 sept 0:34  @result{} @b{2006}-09-22 0:34
6078 w4            @result{} ISO week for of the current year @b{2006}
6079 2012 w4 fri   @result{} Friday of ISO week 4 in 2012
6080 2012-w04-5    @result{} Same as above
6081 @end example
6083 Furthermore you can specify a relative date by giving, as the @emph{first}
6084 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
6085 indicate change in hours, days, weeks, months, or years.  With a single plus
6086 or minus, the date is always relative to today.  With a double plus or minus,
6087 it is relative to the default date.  If instead of a single letter, you use
6088 the abbreviation of day name, the date will be the Nth such day, e.g.:
6090 @example
6091 +0            @result{} today
6092 .             @result{} today
6093 +4d           @result{} four days from today
6094 +4            @result{} same as above
6095 +2w           @result{} two weeks from today
6096 ++5           @result{} five days from default date
6097 +2tue         @result{} second Tuesday from now
6098 -wed          @result{} last Wednesday
6099 @end example
6101 @vindex parse-time-months
6102 @vindex parse-time-weekdays
6103 The function understands English month and weekday abbreviations.  If
6104 you want to use unabbreviated names and/or other languages, configure
6105 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
6107 @vindex org-read-date-force-compatible-dates
6108 Not all dates can be represented in a given Emacs implementation.  By default
6109 Org mode forces dates into the compatibility range 1970--2037 which works on
6110 all Emacs implementations.  If you want to use dates outside of this range,
6111 read the docstring of the variable
6112 @code{org-read-date-force-compatible-dates}.
6114 You can specify a time range by giving start and end times or by giving a
6115 start time and a duration (in HH:MM format).  Use one or two dash(es) as the
6116 separator in the former case and use '+' as the separator in the latter
6117 case, e.g.:
6119 @example
6120 11am-1:15pm    @result{} 11:00-13:15
6121 11am--1:15pm   @result{} same as above
6122 11am+2:15      @result{} same as above
6123 @end example
6125 @cindex calendar, for selecting date
6126 @vindex org-popup-calendar-for-date-prompt
6127 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
6128 you don't need/want the calendar, configure the variable
6129 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
6130 prompt, either by clicking on a date in the calendar, or by pressing
6131 @key{RET}, the date selected in the calendar will be combined with the
6132 information entered at the prompt.  You can control the calendar fully
6133 from the minibuffer:
6135 @kindex <
6136 @kindex >
6137 @kindex M-v
6138 @kindex C-v
6139 @kindex mouse-1
6140 @kindex S-@key{right}
6141 @kindex S-@key{left}
6142 @kindex S-@key{down}
6143 @kindex S-@key{up}
6144 @kindex M-S-@key{right}
6145 @kindex M-S-@key{left}
6146 @kindex @key{RET}
6147 @kindex M-S-@key{down}
6148 @kindex M-S-@key{up}
6150 @example
6151 @key{RET}              @r{Choose date at cursor in calendar.}
6152 mouse-1            @r{Select date by clicking on it.}
6153 S-@key{right}/@key{left}   @r{One day forward/backward.}
6154 S-@key{down}/@key{up}      @r{One week forward/backward.}
6155 M-S-@key{right}/@key{left} @r{One month forward/backward.}
6156 > / <              @r{Scroll calendar forward/backward by one month.}
6157 M-v / C-v          @r{Scroll calendar forward/backward by 3 months.}
6158 M-S-@key{down}/@key{up}    @r{Scroll calendar forward/backward by one year.}
6159 @end example
6161 @vindex org-read-date-display-live
6162 The actions of the date/time prompt may seem complex, but I assure you they
6163 will grow on you, and you will start getting annoyed by pretty much any other
6164 way of entering a date/time out there.  To help you understand what is going
6165 on, the current interpretation of your input will be displayed live in the
6166 minibuffer@footnote{If you find this distracting, turn the display off with
6167 @code{org-read-date-display-live}.}.
6169 @node Custom time format
6170 @subsection Custom time format
6171 @cindex custom date/time format
6172 @cindex time format, custom
6173 @cindex date format, custom
6175 @vindex org-display-custom-times
6176 @vindex org-time-stamp-custom-formats
6177 Org mode uses the standard ISO notation for dates and times as it is
6178 defined in ISO 8601.  If you cannot get used to this and require another
6179 representation of date and time to keep you happy, you can get it by
6180 customizing the options @code{org-display-custom-times} and
6181 @code{org-time-stamp-custom-formats}.
6183 @table @kbd
6184 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6185 Toggle the display of custom formats for dates and times.
6186 @end table
6188 @noindent
6189 Org mode needs the default format for scanning, so the custom date/time
6190 format does not @emph{replace} the default format---instead it is put
6191 @emph{over} the default format using text properties.  This has the
6192 following consequences:
6193 @itemize @bullet
6194 @item
6195 You cannot place the cursor onto a timestamp anymore, only before or
6196 after.
6197 @item
6198 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6199 each component of a timestamp.  If the cursor is at the beginning of
6200 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6201 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
6202 time will be changed by one minute.
6203 @item
6204 If the timestamp contains a range of clock times or a repeater, these
6205 will not be overlaid, but remain in the buffer as they were.
6206 @item
6207 When you delete a timestamp character-by-character, it will only
6208 disappear from the buffer after @emph{all} (invisible) characters
6209 belonging to the ISO timestamp have been removed.
6210 @item
6211 If the custom timestamp format is longer than the default and you are
6212 using dates in tables, table alignment will be messed up.  If the custom
6213 format is shorter, things do work as expected.
6214 @end itemize
6217 @node Deadlines and scheduling
6218 @section Deadlines and scheduling
6220 A timestamp may be preceded by special keywords to facilitate planning:
6222 @table @var
6223 @item DEADLINE
6224 @cindex DEADLINE keyword
6226 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6227 to be finished on that date.
6229 @vindex org-deadline-warning-days
6230 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6231 On the deadline date, the task will be listed in the agenda.  In
6232 addition, the agenda for @emph{today} will carry a warning about the
6233 approaching or missed deadline, starting
6234 @code{org-deadline-warning-days} before the due date, and continuing
6235 until the entry is marked DONE@.  An example:
6237 @example
6238 *** TODO write article about the Earth for the Guide
6239     DEADLINE: <2004-02-29 Sun>
6240     The editor in charge is [[bbdb:Ford Prefect]]
6241 @end example
6243 You can specify a different lead time for warnings for a specific
6244 deadline using the following syntax.  Here is an example with a warning
6245 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.  This warning is
6246 deactivated if the task gets scheduled and you set
6247 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6249 @item SCHEDULED
6250 @cindex SCHEDULED keyword
6252 Meaning: you are planning to start working on that task on the given
6253 date.
6255 @vindex org-agenda-skip-scheduled-if-done
6256 The headline will be listed under the given date@footnote{It will still
6257 be listed on that date after it has been marked DONE@.  If you don't like
6258 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
6259 addition, a reminder that the scheduled date has passed will be present
6260 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6261 the task will automatically be forwarded until completed.
6263 @example
6264 *** TODO Call Trillian for a date on New Years Eve.
6265     SCHEDULED: <2004-12-25 Sat>
6266 @end example
6268 @vindex org-scheduled-delay-days
6269 @vindex org-agenda-skip-scheduled-delay-if-deadline
6270 If you want to @emph{delay} the display of this task in the agenda, use
6271 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6272 25th but will appear two days later.  In case the task contains a repeater,
6273 the delay is considered to affect all occurrences; if you want the delay to
6274 only affect the first scheduled occurrence of the task, use @code{--2d}
6275 instead.  See @code{org-scheduled-delay-days} and
6276 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6277 control this globally or per agenda.
6279 @noindent
6280 @b{Important:} Scheduling an item in Org mode should @i{not} be
6281 understood in the same way that we understand @i{scheduling a meeting}.
6282 Setting a date for a meeting is just a simple appointment, you should
6283 mark this entry with a simple plain timestamp, to get this item shown
6284 on the date where it applies.  This is a frequent misunderstanding by
6285 Org users.  In Org mode, @i{scheduling} means setting a date when you
6286 want to start working on an action item.
6287 @end table
6289 You may use timestamps with repeaters in scheduling and deadline
6290 entries.  Org mode will issue early and late warnings based on the
6291 assumption that the timestamp represents the @i{nearest instance} of
6292 the repeater.  However, the use of diary sexp entries like
6294 @code{<%%(diary-float t 42)>}
6296 in scheduling and deadline timestamps is limited.  Org mode does not
6297 know enough about the internals of each sexp function to issue early and
6298 late warnings.  However, it will show the item on each day where the
6299 sexp entry matches.
6301 @menu
6302 * Inserting deadline/schedule::  Planning items
6303 * Repeated tasks::              Items that show up again and again
6304 @end menu
6306 @node Inserting deadline/schedule
6307 @subsection Inserting deadlines or schedules
6309 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6310 @samp{DEADLINE} dates are inserted on the line right below the headline.  Don't put
6311 any text between this line and the headline.} a deadline or to schedule
6312 an item:
6314 @table @kbd
6316 @orgcmd{C-c C-d,org-deadline}
6317 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will happen
6318 in the line directly following the headline.  Any CLOSED timestamp will be
6319 removed.  When called with a prefix arg, an existing deadline will be removed
6320 from the entry.  Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6321 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6322 and @code{nologredeadline}}, a note will be taken when changing an existing
6323 deadline.
6325 @orgcmd{C-c C-s,org-schedule}
6326 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
6327 happen in the line directly following the headline.  Any CLOSED timestamp
6328 will be removed.  When called with a prefix argument, remove the scheduling
6329 date from the entry.  Depending on the variable
6330 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6331 keywords @code{logreschedule}, @code{lognotereschedule}, and
6332 @code{nologreschedule}}, a note will be taken when changing an existing
6333 scheduling time.
6335 @orgcmd{C-c / d,org-check-deadlines}
6336 @cindex sparse tree, for deadlines
6337 @vindex org-deadline-warning-days
6338 Create a sparse tree with all deadlines that are either past-due, or
6339 which will become due within @code{org-deadline-warning-days}.
6340 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
6341 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
6342 all deadlines due tomorrow.
6344 @orgcmd{C-c / b,org-check-before-date}
6345 Sparse tree for deadlines and scheduled items before a given date.
6347 @orgcmd{C-c / a,org-check-after-date}
6348 Sparse tree for deadlines and scheduled items after a given date.
6349 @end table
6351 Note that @code{org-schedule} and @code{org-deadline} supports
6352 setting the date by indicating a relative time: e.g., +1d will set
6353 the date to the next day after today, and --1w will set the date
6354 to the previous week before any current timestamp.
6356 @node Repeated tasks
6357 @subsection Repeated tasks
6358 @cindex tasks, repeated
6359 @cindex repeated tasks
6361 Some tasks need to be repeated again and again.  Org mode helps to
6362 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6363 or plain timestamp.  In the following example
6364 @example
6365 ** TODO Pay the rent
6366    DEADLINE: <2005-10-01 Sat +1m>
6367 @end example
6368 @noindent
6369 the @code{+1m} is a repeater; the intended interpretation is that the task
6370 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6371 from that time.  You can use yearly, monthly, weekly, daily and hourly repeat
6372 cookies by using the @code{y/w/m/d/h} letters.  If you need both a repeater
6373 and a special warning period in a deadline entry, the repeater should come
6374 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6376 @vindex org-todo-repeat-to-state
6377 Deadlines and scheduled items produce entries in the agenda when they are
6378 over-due, so it is important to be able to mark such an entry as completed
6379 once you have done so.  When you mark a DEADLINE or a SCHEDULE with the TODO
6380 keyword DONE, it will no longer produce entries in the agenda.  The problem
6381 with this is, however, that then also the @emph{next} instance of the
6382 repeated entry will not be active.  Org mode deals with this in the following
6383 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6384 shift the base date of the repeating timestamp by the repeater interval, and
6385 immediately set the entry state back to TODO@footnote{In fact, the target
6386 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6387 the variable @code{org-todo-repeat-to-state}.  If neither of these is
6388 specified, the target state defaults to the first state of the TODO state
6389 sequence.}.  In the example above, setting the state to DONE would actually
6390 switch the date like this:
6392 @example
6393 ** TODO Pay the rent
6394    DEADLINE: <2005-11-01 Tue +1m>
6395 @end example
6397 To mark a task with a repeater as @code{DONE}, use @kbd{C-- 1 C-c C-t}
6398 (i.e., @code{org-todo} with a numeric prefix argument of -1.)
6400 @vindex org-log-repeat
6401 A timestamp@footnote{You can change this using the option
6402 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6403 @code{lognoterepeat}, and @code{nologrepeat}.  With @code{lognoterepeat}, you
6404 will also be prompted for a note.} will be added under the deadline, to keep
6405 a record that you actually acted on the previous instance of this deadline.
6407 As a consequence of shifting the base date, this entry will no longer be
6408 visible in the agenda when checking past dates, but all future instances
6409 will be visible.
6411 With the @samp{+1m} cookie, the date shift will always be exactly one
6412 month.  So if you have not paid the rent for three months, marking this
6413 entry DONE will still keep it as an overdue deadline.  Depending on the
6414 task, this may not be the best way to handle it.  For example, if you
6415 forgot to call your father for 3 weeks, it does not make sense to call
6416 him 3 times in a single day to make up for it.  Finally, there are tasks
6417 like changing batteries which should always repeat a certain time
6418 @i{after} the last time you did it.  For these tasks, Org mode has
6419 special repeaters  @samp{++} and @samp{.+}.  For example:
6421 @example
6422 ** TODO Call Father
6423    DEADLINE: <2008-02-10 Sun ++1w>
6424    Marking this DONE will shift the date by at least one week,
6425    but also by as many weeks as it takes to get this date into
6426    the future.  However, it stays on a Sunday, even if you called
6427    and marked it done on Saturday.
6428 ** TODO Check the batteries in the smoke detectors
6429    DEADLINE: <2005-11-01 Tue .+1m>
6430    Marking this DONE will shift the date to one month after
6431    today.
6432 @end example
6434 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6435 You may have both scheduling and deadline information for a specific task.
6436 If the repeater is set for the scheduling information only, you probably want
6437 the repeater to be ignored after the deadline.  If so, set the variable
6438 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6439 @code{repeated-after-deadline}.  If you want both scheduling and deadline
6440 information to repeat after the same interval, set the same repeater for both
6441 timestamps.
6443 An alternative to using a repeater is to create a number of copies of a task
6444 subtree, with dates shifted in each copy.  The command @kbd{C-c C-x c} was
6445 created for this purpose, it is described in @ref{Structure editing}.
6448 @node Clocking work time
6449 @section Clocking work time
6450 @cindex clocking time
6451 @cindex time clocking
6453 Org mode allows you to clock the time you spend on specific tasks in a
6454 project.  When you start working on an item, you can start the clock.  When
6455 you stop working on that task, or when you mark the task done, the clock is
6456 stopped and the corresponding time interval is recorded.  It also computes
6457 the total time spent on each subtree@footnote{Clocking only works if all
6458 headings are indented with less than 30 stars.  This is a hardcoded
6459 limitation of `lmax' in `org-clock-sum'.} of a project.  And it remembers a
6460 history or tasks recently clocked, so that you can jump quickly between a
6461 number of tasks absorbing your time.
6463 To save the clock history across Emacs sessions, use
6464 @lisp
6465 (setq org-clock-persist 'history)
6466 (org-clock-persistence-insinuate)
6467 @end lisp
6468 When you clock into a new task after resuming Emacs, the incomplete
6469 clock@footnote{To resume the clock under the assumption that you have worked
6470 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6471 will be found (@pxref{Resolving idle time}) and you will be prompted about
6472 what to do with it.
6474 @menu
6475 * Clocking commands::           Starting and stopping a clock
6476 * The clock table::             Detailed reports
6477 * Resolving idle time::         Resolving time when you've been idle
6478 @end menu
6480 @node Clocking commands
6481 @subsection Clocking commands
6483 @table @kbd
6484 @orgcmd{C-c C-x C-i,org-clock-in}
6485 @vindex org-clock-into-drawer
6486 @vindex org-clock-continuously
6487 @cindex property, LOG_INTO_DRAWER
6488 Start the clock on the current item (clock-in).  This inserts the CLOCK
6489 keyword together with a timestamp.  If this is not the first clocking of
6490 this item, the multiple CLOCK lines will be wrapped into a
6491 @code{:LOGBOOK:} drawer (see also the variable
6492 @code{org-clock-into-drawer}).  You can also overrule
6493 the setting of this variable for a subtree by setting a
6494 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6495 When called with a @kbd{C-u} prefix argument,
6496 select the task from a list of recently clocked tasks.  With two @kbd{C-u
6497 C-u} prefixes, clock into the task at point and mark it as the default task;
6498 the default task will then always be available with letter @kbd{d} when
6499 selecting a clocking task.  With three @kbd{C-u C-u C-u} prefixes, force
6500 continuous clocking by starting the clock when the last clock stopped.@*
6501 @cindex property: CLOCK_MODELINE_TOTAL
6502 @cindex property: LAST_REPEAT
6503 @vindex org-clock-modeline-total
6504 While the clock is running, the current clocking time is shown in the mode
6505 line, along with the title of the task.  The clock time shown will be all
6506 time ever clocked for this task and its children.  If the task has an effort
6507 estimate (@pxref{Effort estimates}), the mode line displays the current
6508 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6509 hook a function doing this to @code{org-clock-in-prepare-hook}.}  If the task
6510 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6511 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6512 will be shown.  More control over what time is shown can be exercised with
6513 the @code{CLOCK_MODELINE_TOTAL} property.  It may have the values
6514 @code{current} to show only the current clocking instance, @code{today} to
6515 show all time clocked on this tasks today (see also the variable
6516 @code{org-extend-today-until}), @code{all} to include all time, or
6517 @code{auto} which is the default@footnote{See also the variable
6518 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6519 mode line entry will pop up a menu with clocking options.
6521 @orgcmd{C-c C-x C-o,org-clock-out}
6522 @vindex org-log-note-clock-out
6523 Stop the clock (clock-out).  This inserts another timestamp at the same
6524 location where the clock was last started.  It also directly computes
6525 the resulting time and inserts it after the time range as @samp{=>
6526 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
6527 possibility to record an additional note together with the clock-out
6528 timestamp@footnote{The corresponding in-buffer setting is:
6529 @code{#+STARTUP: lognoteclock-out}}.
6530 @orgcmd{C-c C-x C-x,org-clock-in-last}
6531 @vindex org-clock-continuously
6532 Reclock the last clocked task.  With one @kbd{C-u} prefix argument,
6533 select the task from the clock history.  With two @kbd{C-u} prefixes,
6534 force continuous clocking by starting the clock when the last clock
6535 stopped.
6536 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6537 Update the effort estimate for the current clock task.
6538 @kindex C-c C-y
6539 @kindex C-c C-c
6540 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6541 Recompute the time interval after changing one of the timestamps.  This
6542 is only necessary if you edit the timestamps directly.  If you change
6543 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6544 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6545 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6546 clock duration keeps the same.
6547 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6548 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6549 the one of the previous (or the next clock) timestamp by the same duration.
6550 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6551 by five minutes, then the clocked-in timestamp of the next clock will be
6552 increased by five minutes.
6553 @orgcmd{C-c C-t,org-todo}
6554 Changing the TODO state of an item to DONE automatically stops the clock
6555 if it is running in this same item.
6556 @orgcmd{C-c C-x C-q,org-clock-cancel}
6557 Cancel the current clock.  This is useful if a clock was started by
6558 mistake, or if you ended up working on something else.
6559 @orgcmd{C-c C-x C-j,org-clock-goto}
6560 Jump to the headline of the currently clocked in task.  With a @kbd{C-u}
6561 prefix arg, select the target task from a list of recently clocked tasks.
6562 @orgcmd{C-c C-x C-d,org-clock-display}
6563 @vindex org-remove-highlights-with-change
6564 Display time summaries for each subtree in the current buffer.  This puts
6565 overlays at the end of each headline, showing the total time recorded under
6566 that heading, including the time of any subheadings.  You can use visibility
6567 cycling to study the tree, but the overlays disappear when you change the
6568 buffer (see variable @code{org-remove-highlights-with-change}) or press
6569 @kbd{C-c C-c}.
6570 @end table
6572 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6573 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6574 worked on or closed during a day.
6576 @strong{Important:} note that both @code{org-clock-out} and
6577 @code{org-clock-in-last} can have a global keybinding and will not
6578 modify the window disposition.
6580 @node The clock table
6581 @subsection The clock table
6582 @cindex clocktable, dynamic block
6583 @cindex report, of clocked time
6585 Org mode can produce quite complex reports based on the time clocking
6586 information.  Such a report is called a @emph{clock table}, because it is
6587 formatted as one or several Org tables.
6589 @table @kbd
6590 @orgcmd{C-c C-x C-r,org-clock-report}
6591 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6592 report as an Org mode table into the current file.  When the cursor is
6593 at an existing clock table, just update it.  When called with a prefix
6594 argument, jump to the first clock report in the current document and
6595 update it.  The clock table always includes also trees with
6596 @code{:ARCHIVE:} tag.
6597 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6598 Update dynamic block at point.  The cursor needs to be in the
6599 @code{#+BEGIN} line of the dynamic block.
6600 @orgkey{C-u C-c C-x C-u}
6601 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
6602 you have several clock table blocks in a buffer.
6603 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6604 Shift the current @code{:block} interval and update the table.  The cursor
6605 needs to be in the @code{#+BEGIN: clocktable} line for this command.  If
6606 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6607 @end table
6610 Here is an example of the frame for a clock table as it is inserted into the
6611 buffer with the @kbd{C-c C-x C-r} command:
6613 @cindex #+BEGIN, clocktable
6614 @example
6615 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6616 #+END: clocktable
6617 @end example
6618 @noindent
6619 @vindex org-clocktable-defaults
6620 The @samp{BEGIN} line specifies a number of options to define the scope,
6621 structure, and formatting of the report.  Defaults for all these options can
6622 be configured in the variable @code{org-clocktable-defaults}.
6624 @noindent First there are options that determine which clock entries are to
6625 be selected:
6626 @example
6627 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
6628              @r{Clocks at deeper levels will be summed into the upper level.}
6629 :scope       @r{The scope to consider.  This can be any of the following:}
6630              nil        @r{the current buffer or narrowed region}
6631              file       @r{the full current buffer}
6632              subtree    @r{the subtree where the clocktable is located}
6633              tree@var{N}      @r{the surrounding level @var{N} tree, for example @code{tree3}}
6634              tree       @r{the surrounding level 1 tree}
6635              agenda     @r{all agenda files}
6636              ("file"..) @r{scan these files}
6637              file-with-archives    @r{current file and its archives}
6638              agenda-with-archives  @r{all agenda files, including archives}
6639 :block       @r{The time block to consider.  This block is specified either}
6640              @r{absolutely, or relative to the current time and may be any of}
6641              @r{these formats:}
6642              2007-12-31    @r{New year eve 2007}
6643              2007-12       @r{December 2007}
6644              2007-W50      @r{ISO-week 50 in 2007}
6645              2007-Q2       @r{2nd quarter in 2007}
6646              2007          @r{the year 2007}
6647              today, yesterday, today-@var{N}          @r{a relative day}
6648              thisweek, lastweek, thisweek-@var{N}     @r{a relative week}
6649              thismonth, lastmonth, thismonth-@var{N}  @r{a relative month}
6650              thisyear, lastyear, thisyear-@var{N}     @r{a relative year}
6651              @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6652 :tstart      @r{A time string specifying when to start considering times.}
6653              @r{Relative times like @code{"<-2w>"} can also be used.  See}
6654              @r{@ref{Matching tags and properties} for relative time syntax.}
6655 :tend        @r{A time string specifying when to stop considering times.}
6656              @r{Relative times like @code{"<now>"} can also be used.  See}
6657              @r{@ref{Matching tags and properties} for relative time syntax.}
6658 :wstart      @r{The starting day of the week.  The default is 1 for monday.}
6659 :mstart      @r{The starting day of the month.  The default 1 is for the first}
6660              @r{day of the month.}
6661 :step        @r{@code{week} or @code{day}, to split the table into chunks.}
6662              @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6663 :stepskip0   @r{Do not show steps that have zero time.}
6664 :fileskip0   @r{Do not show table sections from files which did not contribute.}
6665 :tags        @r{A tags match to select entries that should contribute.  See}
6666              @r{@ref{Matching tags and properties} for the match syntax.}
6667 @end example
6669 Then there are options which determine the formatting of the table.  These
6670 options are interpreted by the function @code{org-clocktable-write-default},
6671 but you can specify your own function using the @code{:formatter} parameter.
6672 @example
6673 :emphasize   @r{When @code{t}, emphasize level one and level two items.}
6674 :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".}
6675 :link        @r{Link the item headlines in the table to their origins.}
6676 :narrow      @r{An integer to limit the width of the headline column in}
6677              @r{the org table.  If you write it like @samp{50!}, then the}
6678              @r{headline will also be shortened in export.}
6679 :indent      @r{Indent each headline field according to its level.}
6680 :tcolumns    @r{Number of columns to be used for times.  If this is smaller}
6681              @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6682 :level       @r{Should a level number column be included?}
6683 :sort        @r{A cons cell like containing the column to sort and a sorting type.}
6684              @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.}
6685 :compact     @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6686              @r{All are overwritten except if there is an explicit @code{:narrow}}
6687 :timestamp   @r{A timestamp for the entry, when available.  Look for SCHEDULED,}
6688              @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6689 :properties  @r{List of properties that should be shown in the table.  Each}
6690              @r{property will get its own column.}
6691 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6692 :formula     @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6693              @r{As a special case, @samp{:formula %} adds a column with % time.}
6694              @r{If you do not specify a formula here, any existing formula}
6695              @r{below the clock table will survive updates and be evaluated.}
6696 :formatter   @r{A function to format clock data and insert it into the buffer.}
6697 @end example
6698 To get a clock summary of the current level 1 tree, for the current
6699 day, you could write
6700 @example
6701 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6702 #+END: clocktable
6703 @end example
6704 @noindent
6705 and to use a specific time range you could write@footnote{Note that all
6706 parameters must be specified in a single line---the line is broken here
6707 only to fit it into the manual.}
6708 @example
6709 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6710                     :tend "<2006-08-10 Thu 12:00>"
6711 #+END: clocktable
6712 @end example
6713 A range starting a week ago and ending right now could be written as
6714 @example
6715 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6716 #+END: clocktable
6717 @end example
6718 A summary of the current subtree with % times would be
6719 @example
6720 #+BEGIN: clocktable :scope subtree :link t :formula %
6721 #+END: clocktable
6722 @end example
6723 A horizontally compact representation of everything clocked during last week
6724 would be
6725 @example
6726 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6727 #+END: clocktable
6728 @end example
6730 @node Resolving idle time
6731 @subsection Resolving idle time and continuous clocking
6733 @subsubheading Resolving idle time
6734 @cindex resolve idle time
6735 @vindex org-clock-x11idle-program-name
6737 @cindex idle, resolve, dangling
6738 If you clock in on a work item, and then walk away from your
6739 computer---perhaps to take a phone call---you often need to ``resolve'' the
6740 time you were away by either subtracting it from the current clock, or
6741 applying it to another one.
6743 @vindex org-clock-idle-time
6744 By customizing the variable @code{org-clock-idle-time} to some integer, such
6745 as 10 or 15, Emacs can alert you when you get back to your computer after
6746 being idle for that many minutes@footnote{On computers using Mac OS X,
6747 idleness is based on actual user idleness, not just Emacs' idle time.  For
6748 X11, you can install a utility program @file{x11idle.c}, available in the
6749 @code{contrib/scripts} directory of the Org git distribution, or install the
6750 @file{xprintidle} package and set it to the variable
6751 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6752 same general treatment of idleness.  On other systems, idle time refers to
6753 Emacs idle time only.}, and ask what you want to do with the idle time.
6754 There will be a question waiting for you when you get back, indicating how
6755 much idle time has passed (constantly updated with the current amount), as
6756 well as a set of choices to correct the discrepancy:
6758 @table @kbd
6759 @item k
6760 To keep some or all of the minutes and stay clocked in, press @kbd{k}.  Org
6761 will ask how many of the minutes to keep.  Press @key{RET} to keep them all,
6762 effectively changing nothing, or enter a number to keep that many minutes.
6763 @item K
6764 If you use the shift key and press @kbd{K}, it will keep however many minutes
6765 you request and then immediately clock out of that task.  If you keep all of
6766 the minutes, this is the same as just clocking out of the current task.
6767 @item s
6768 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6769 the clock, and then check back in from the moment you returned.
6770 @item S
6771 To keep none of the minutes and just clock out at the start of the away time,
6772 use the shift key and press @kbd{S}.  Remember that using shift will always
6773 leave you clocked out, no matter which option you choose.
6774 @item C
6775 To cancel the clock altogether, use @kbd{C}.  Note that if instead of
6776 canceling you subtract the away time, and the resulting clock amount is less
6777 than a minute, the clock will still be canceled rather than clutter up the
6778 log with an empty entry.
6779 @end table
6781 What if you subtracted those away minutes from the current clock, and now
6782 want to apply them to a new clock?  Simply clock in to any task immediately
6783 after the subtraction.  Org will notice that you have subtracted time ``on
6784 the books'', so to speak, and will ask if you want to apply those minutes to
6785 the next task you clock in on.
6787 There is one other instance when this clock resolution magic occurs.  Say you
6788 were clocked in and hacking away, and suddenly your cat chased a mouse who
6789 scared a hamster that crashed into your UPS's power button!  You suddenly
6790 lose all your buffers, but thanks to auto-save you still have your recent Org
6791 mode changes, including your last clock in.
6793 If you restart Emacs and clock into any task, Org will notice that you have a
6794 dangling clock which was never clocked out from your last session.  Using
6795 that clock's starting time as the beginning of the unaccounted-for period,
6796 Org will ask how you want to resolve that time.  The logic and behavior is
6797 identical to dealing with away time due to idleness; it is just happening due
6798 to a recovery event rather than a set amount of idle time.
6800 You can also check all the files visited by your Org agenda for dangling
6801 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6803 @subsubheading Continuous clocking
6804 @cindex continuous clocking
6805 @vindex org-clock-continuously
6807 You may want to start clocking from the time when you clocked out the
6808 previous task.  To enable this systematically, set @code{org-clock-continuously}
6809 to @code{t}.  Each time you clock in, Org retrieves the clock-out time of the
6810 last clocked entry for this session, and start the new clock from there.
6812 If you only want this from time to time, use three universal prefix arguments
6813 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6815 @node Effort estimates
6816 @section Effort estimates
6817 @cindex effort estimates
6819 @cindex property, Effort
6820 If you want to plan your work in a very detailed way, or if you need to
6821 produce offers with quotations of the estimated work effort, you may want to
6822 assign effort estimates to entries.  If you are also clocking your work, you
6823 may later want to compare the planned effort with the actual working time,
6824 a great way to improve planning estimates.  Effort estimates are stored in
6825 a special property @code{EFFORT}.  You can set the effort for an entry with
6826 the following commands:
6828 @table @kbd
6829 @orgcmd{C-c C-x e,org-set-effort}
6830 Set the effort estimate for the current entry.  With a numeric prefix
6831 argument, set it to the Nth allowed value (see below).  This command is also
6832 accessible from the agenda with the @kbd{e} key.
6833 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6834 Modify the effort estimate of the item currently being clocked.
6835 @end table
6837 Clearly the best way to work with effort estimates is through column view
6838 (@pxref{Column view}).  You should start by setting up discrete values for
6839 effort estimates, and a @code{COLUMNS} format that displays these values
6840 together with clock sums (if you want to clock your time).  For a specific
6841 buffer you can use
6843 @example
6844 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6845 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6846 @end example
6848 @noindent
6849 @vindex org-global-properties
6850 @vindex org-columns-default-format
6851 or, even better, you can set up these values globally by customizing the
6852 variables @code{org-global-properties} and @code{org-columns-default-format}.
6853 In particular if you want to use this setup also in the agenda, a global
6854 setup may be advised.
6856 The way to assign estimates to individual items is then to switch to column
6857 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6858 value.  The values you enter will immediately be summed up in the hierarchy.
6859 In the column next to it, any clocked time will be displayed.
6861 @vindex org-agenda-columns-add-appointments-to-effort-sum
6862 If you switch to column view in the daily/weekly agenda, the effort column
6863 will summarize the estimated work effort for each day@footnote{Please note
6864 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6865 column view}).}, and you can use this to find space in your schedule.  To get
6866 an overview of the entire part of the day that is committed, you can set the
6867 option @code{org-agenda-columns-add-appointments-to-effort-sum}.  The
6868 appointments on a day that take place over a specified time interval will
6869 then also be added to the load estimate of the day.
6871 Effort estimates can be used in secondary agenda filtering that is triggered
6872 with the @kbd{/} key in the agenda (@pxref{Agenda commands}).  If you have
6873 these estimates defined consistently, two or three key presses will narrow
6874 down the list to stuff that fits into an available time slot.
6876 @node Timers
6877 @section Taking notes with a timer
6878 @cindex relative timer
6879 @cindex countdown timer
6880 @kindex ;
6882 Org provides provides two types of timers.  There is a relative timer that
6883 counts up, which can be useful when taking notes during, for example, a
6884 meeting or a video viewing.  There is also a countdown timer.
6886 The relative and countdown are started with separate commands.
6888 @table @kbd
6889 @orgcmd{C-c C-x 0,org-timer-start}
6890 Start or reset the relative timer.  By default, the timer is set to 0.  When
6891 called with a @kbd{C-u} prefix, prompt the user for a starting offset.  If
6892 there is a timer string at point, this is taken as the default, providing a
6893 convenient way to restart taking notes after a break in the process.  When
6894 called with a double prefix argument @kbd{C-u C-u}, change all timer strings
6895 in the active region by a certain amount.  This can be used to fix timer
6896 strings if the timer was not started at exactly the right moment.
6897 @orgcmd{C-c C-x ;,org-timer-set-timer}
6898 Start a countdown timer.  The user is prompted for a duration.
6899 @code{org-timer-default-timer} sets the default countdown value.  Giving a
6900 prefix numeric argument overrides this default value.  This command is
6901 available as @kbd{;} in agenda buffers.
6902 @end table
6904 Once started, relative and countdown timers are controlled with the same
6905 commands.
6907 @table @kbd
6908 @orgcmd{C-c C-x .,org-timer}
6909 Insert the value of the current relative or countdown timer into the buffer.
6910 If no timer is running, the relative timer will be started.  When called with
6911 a prefix argument, the relative timer is restarted.
6912 @orgcmd{C-c C-x -,org-timer-item}
6913 Insert a description list item with the value of the current relative or
6914 countdown timer.  With a prefix argument, first reset the relative timer to
6916 @orgcmd{M-@key{RET},org-insert-heading}
6917 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6918 new timer items.
6919 @orgcmd{C-c C-x \\,org-timer-pause-or-continue}
6920 Pause the timer, or continue it if it is already paused.
6921 @orgcmd{C-c C-x _,org-timer-stop}
6922 Stop the timer.  After this, you can only start a new timer, not continue the
6923 old one.  This command also removes the timer from the mode line.
6924 @end table
6926 @node Capture - Refile - Archive
6927 @chapter Capture - Refile - Archive
6928 @cindex capture
6930 An important part of any organization system is the ability to quickly
6931 capture new ideas and tasks, and to associate reference material with them.
6932 Org does this using a process called @i{capture}.  It also can store files
6933 related to a task (@i{attachments}) in a special directory.  Once in the
6934 system, tasks and projects need to be moved around.  Moving completed project
6935 trees to an archive file keeps the system compact and fast.
6937 @menu
6938 * Capture::                     Capturing new stuff
6939 * Attachments::                 Add files to tasks
6940 * RSS feeds::                   Getting input from RSS feeds
6941 * Protocols::                   External (e.g., Browser) access to Emacs and Org
6942 * Refile and copy::             Moving/copying a tree from one place to another
6943 * Archiving::                   What to do with finished projects
6944 @end menu
6946 @node Capture
6947 @section Capture
6948 @cindex capture
6950 Capture lets you quickly store notes with little interruption of your work
6951 flow.  Org's method for capturing new items is heavily inspired by John
6952 Wiegley excellent @file{remember.el} package.  Up to version 6.36, Org
6953 used a special setup for @file{remember.el}, then replaced it with
6954 @file{org-remember.el}.  As of version 8.0, @file{org-remember.el} has
6955 been completely replaced by @file{org-capture.el}.
6957 If your configuration depends on @file{org-remember.el}, you need to update
6958 it and use the setup described below.  To convert your
6959 @code{org-remember-templates}, run the command
6960 @example
6961 @kbd{M-x org-capture-import-remember-templates RET}
6962 @end example
6963 @noindent and then customize the new variable with @kbd{M-x
6964 customize-variable org-capture-templates}, check the result, and save the
6965 customization.
6967 @menu
6968 * Setting up capture::          Where notes will be stored
6969 * Using capture::               Commands to invoke and terminate capture
6970 * Capture templates::           Define the outline of different note types
6971 @end menu
6973 @node Setting up capture
6974 @subsection Setting up capture
6976 The following customization sets a default target file for notes, and defines
6977 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6978 suggestion.}  for capturing new material.
6980 @vindex org-default-notes-file
6981 @smalllisp
6982 @group
6983 (setq org-default-notes-file (concat org-directory "/notes.org"))
6984 (define-key global-map "\C-cc" 'org-capture)
6985 @end group
6986 @end smalllisp
6988 @node Using capture
6989 @subsection Using capture
6991 @table @kbd
6992 @orgcmd{C-c c,org-capture}
6993 Call the command @code{org-capture}.  Note that this keybinding is global and
6994 not active by default: you need to install it.  If you have templates
6995 @cindex date tree
6996 defined @pxref{Capture templates}, it will offer these templates for
6997 selection or use a new Org outline node as the default template.  It will
6998 insert the template into the target file and switch to an indirect buffer
6999 narrowed to this new node.  You may then insert the information you want.
7001 @orgcmd{C-c C-c,org-capture-finalize}
7002 Once you have finished entering information into the capture buffer, @kbd{C-c
7003 C-c} will return you to the window configuration before the capture process,
7004 so that you can resume your work without further distraction.  When called
7005 with a prefix arg, finalize and then jump to the captured item.
7007 @orgcmd{C-c C-w,org-capture-refile}
7008 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
7009 a different place.  Please realize that this is a normal refiling command
7010 that will be executed---so the cursor position at the moment you run this
7011 command is important.  If you have inserted a tree with a parent and
7012 children, first move the cursor back to the parent.  Any prefix argument
7013 given to this command will be passed on to the @code{org-refile} command.
7015 @orgcmd{C-c C-k,org-capture-kill}
7016 Abort the capture process and return to the previous state.
7018 @end table
7020 You can also call @code{org-capture} in a special way from the agenda, using
7021 the @kbd{k c} key combination.  With this access, any timestamps inserted by
7022 the selected capture template will default to the cursor date in the agenda,
7023 rather than to the current date.
7025 To find the locations of the last stored capture, use @code{org-capture} with
7026 prefix commands:
7028 @table @kbd
7029 @orgkey{C-u C-c c}
7030 Visit the target location of a capture template.  You get to select the
7031 template in the usual way.
7032 @orgkey{C-u C-u C-c c}
7033 Visit the last stored capture item in its buffer.
7034 @end table
7036 @vindex org-capture-bookmark
7037 @cindex org-capture-last-stored
7038 You can also jump to the bookmark @code{org-capture-last-stored}, which will
7039 automatically be created unless you set @code{org-capture-bookmark} to
7040 @code{nil}.
7042 To insert the capture at point in an Org buffer, call @code{org-capture} with
7043 a @code{C-0} prefix argument.
7045 @node Capture templates
7046 @subsection Capture templates
7047 @cindex templates, for Capture
7049 You can use templates for different types of capture items, and
7050 for different target locations.  The easiest way to create such templates is
7051 through the customize interface.
7053 @table @kbd
7054 @orgkey{C-c c C}
7055 Customize the variable @code{org-capture-templates}.
7056 @end table
7058 Before we give the formal description of template definitions, let's look at
7059 an example.  Say you would like to use one template to create general TODO
7060 entries, and you want to put these entries under the heading @samp{Tasks} in
7061 your file @file{~/org/gtd.org}.  Also, a date tree in the file
7062 @file{journal.org} should capture journal entries.  A possible configuration
7063 would look like:
7065 @smalllisp
7066 @group
7067 (setq org-capture-templates
7068  '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
7069         "* TODO %?\n  %i\n  %a")
7070    ("j" "Journal" entry (file+datetree "~/org/journal.org")
7071         "* %?\nEntered on %U\n  %i\n  %a")))
7072 @end group
7073 @end smalllisp
7075 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
7076 for you like this:
7077 @example
7078 * TODO
7079   [[file:@var{link to where you initiated capture}]]
7080 @end example
7082 @noindent
7083 During expansion of the template, @code{%a} has been replaced by a link to
7084 the location from where you called the capture command.  This can be
7085 extremely useful for deriving tasks from emails, for example.  You fill in
7086 the task definition, press @kbd{C-c C-c} and Org returns you to the same
7087 place where you started the capture process.
7089 To define special keys to capture to a particular template without going
7090 through the interactive template selection, you can create your key binding
7091 like this:
7093 @lisp
7094 (define-key global-map "\C-cx"
7095    (lambda () (interactive) (org-capture nil "x")))
7096 @end lisp
7098 @menu
7099 * Template elements::           What is needed for a complete template entry
7100 * Template expansion::          Filling in information about time and context
7101 * Templates in contexts::       Only show a template in a specific context
7102 @end menu
7104 @node Template elements
7105 @subsubsection Template elements
7107 Now lets look at the elements of a template definition.  Each entry in
7108 @code{org-capture-templates} is a list with the following items:
7110 @table @var
7111 @item keys
7112 The keys that will select the template, as a string, characters
7113 only, for example @code{"a"} for a template to be selected with a
7114 single key, or @code{"bt"} for selection with two keys.  When using
7115 several keys, keys using the same prefix key must be sequential
7116 in the list and preceded by a 2-element entry explaining the
7117 prefix key, for example
7118 @smalllisp
7119          ("b" "Templates for marking stuff to buy")
7120 @end smalllisp
7121 @noindent If you do not define a template for the @kbd{C} key, this key will
7122 be used to open the customize buffer for this complex variable.
7124 @item description
7125 A short string describing the template, which will be shown during
7126 selection.
7128 @item type
7129 The type of entry, a symbol.  Valid values are:
7131 @table @code
7132 @item entry
7133 An Org mode node, with a headline.  Will be filed as the child of the target
7134 entry or as a top-level entry.  The target file should be an Org mode file.
7135 @item item
7136 A plain list item, placed in the first plain  list at the target
7137 location.  Again the target file should be an Org file.
7138 @item checkitem
7139 A checkbox item.  This only differs from the plain list item by the
7140 default template.
7141 @item table-line
7142 a new line in the first table at the target location.  Where exactly the
7143 line will be inserted depends on the properties @code{:prepend} and
7144 @code{:table-line-pos} (see below).
7145 @item plain
7146 Text to be inserted as it is.
7147 @end table
7149 @item target
7150 @vindex org-default-notes-file
7151 Specification of where the captured item should be placed.  In Org mode
7152 files, targets usually define a node.  Entries will become children of this
7153 node.  Other types will be added to the table or list in the body of this
7154 node.  Most target specifications contain a file name.  If that file name is
7155 the empty string, it defaults to @code{org-default-notes-file}.  A file can
7156 also be given as a variable, function, or Emacs Lisp form.
7158 Valid values are:
7160 @table @code
7161 @item (file "path/to/file")
7162 Text will be placed at the beginning or end of that file.
7164 @item (id "id of existing org entry")
7165 Filing as child of this entry, or in the body of the entry.
7167 @item (file+headline "path/to/file" "node headline")
7168 Fast configuration if the target heading is unique in the file.
7170 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7171 For non-unique headings, the full path is safer.
7173 @item (file+regexp  "path/to/file" "regexp to find location")
7174 Use a regular expression to position the cursor.
7176 @item (file+datetree "path/to/file")
7177 Will create a heading in a date tree for today's date@footnote{Datetree
7178 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7179 and @code{* 2013} in your file, the capture will refile the note to the first
7180 one matched.}.
7182 @item (file+datetree+prompt "path/to/file")
7183 Will create a heading in a date tree, but will prompt for the date.
7185 @item (file+function "path/to/file" function-finding-location)
7186 A function to find the right location in the file.
7188 @item (clock)
7189 File to the entry that is currently being clocked.
7191 @item (function function-finding-location)
7192 Most general way, write your own function to find both
7193 file and location.
7194 @end table
7196 @item template
7197 The template for creating the capture item.  If you leave this empty, an
7198 appropriate default template will be used.  Otherwise this is a string with
7199 escape codes, which will be replaced depending on time and context of the
7200 capture call.  The string with escapes may be loaded from a template file,
7201 using the special syntax @code{(file "path/to/template")}.  See below for
7202 more details.
7204 @item properties
7205 The rest of the entry is a property list of additional options.
7206 Recognized properties are:
7208 @table @code
7209 @item :prepend
7210 Normally new captured information will be appended at
7211 the target location (last child, last table line, last list item...).
7212 Setting this property will change that.
7214 @item :immediate-finish
7215 When set, do not offer to edit the information, just
7216 file it away immediately.  This makes sense if the template only needs
7217 information that can be added automatically.
7219 @item :empty-lines
7220 Set this to the number of lines to insert
7221 before and after the new item.  Default 0, only common other value is 1.
7223 @item :clock-in
7224 Start the clock in this item.
7226 @item :clock-keep
7227 Keep the clock running when filing the captured entry.
7229 @item :clock-resume
7230 If starting the capture interrupted a clock, restart that clock when finished
7231 with the capture.  Note that @code{:clock-keep} has precedence over
7232 @code{:clock-resume}.  When setting both to @code{t}, the current clock will
7233 run and the previous one will not be resumed.
7235 @item :unnarrowed
7236 Do not narrow the target buffer, simply show the full buffer.  Default is to
7237 narrow it so that you only see the new material.
7239 @item :table-line-pos
7240 Specification of the location in the table where the new line should be
7241 inserted. It can be a string, a variable holding a string or a function
7242 returning a string. The string should look like @code{"II-3"} meaning that
7243 the new line should become the third line before the second horizontal
7244 separator line.
7246 @item :kill-buffer
7247 If the target file was not yet visited when capture was invoked, kill the
7248 buffer again after capture is completed.
7249 @end table
7250 @end table
7252 @node Template expansion
7253 @subsubsection Template expansion
7255 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7256 these sequences literally, escape the @kbd{%} with a backslash.} allow
7257 dynamic insertion of content.  The templates are expanded in the order given here:
7259 @smallexample
7260 %[@var{file}]     @r{Insert the contents of the file given by @var{file}.}
7261 %(@var{sexp})     @r{Evaluate Elisp @var{sexp} and replace with the result.}
7262                   @r{For convenience, %:keyword (see below) placeholders}
7263                   @r{within the expression will be expanded prior to this.}
7264                   @r{The sexp must return a string.}
7265 %<...>      @r{The result of format-time-string on the ... format specification.}
7266 %t          @r{Timestamp, date only.}
7267 %T          @r{Timestamp, with date and time.}
7268 %u, %U      @r{Like the above, but inactive timestamps.}
7269 %i          @r{Initial content, the region when capture is called while the}
7270             @r{region is active.}
7271             @r{The entire text will be indented like @code{%i} itself.}
7272 %a          @r{Annotation, normally the link created with @code{org-store-link}.}
7273 %A          @r{Like @code{%a}, but prompt for the description part.}
7274 %l          @r{Like %a, but only insert the literal link.}
7275 %c          @r{Current kill ring head.}
7276 %x          @r{Content of the X clipboard.}
7277 %k          @r{Title of the currently clocked task.}
7278 %K          @r{Link to the currently clocked task.}
7279 %n          @r{User name (taken from @code{user-full-name}).}
7280 %f          @r{File visited by current buffer when org-capture was called.}
7281 %F          @r{Full path of the file or directory visited by current buffer.}
7282 %:keyword   @r{Specific information for certain link types, see below.}
7283 %^g         @r{Prompt for tags, with completion on tags in target file.}
7284 %^G         @r{Prompt for tags, with completion all tags in all agenda files.}
7285 %^t         @r{Like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7286             @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7287 %^C         @r{Interactive selection of which kill or clip to use.}
7288 %^L         @r{Like @code{%^C}, but insert as link.}
7289 %^@{@var{prop}@}p   @r{Prompt the user for a value for property @var{prop}.}
7290 %^@{@var{prompt}@}  @r{prompt the user for a string and replace this sequence with it.}
7291             @r{You may specify a default value and a completion table with}
7292             @r{%^@{prompt|default|completion2|completion3...@}.}
7293             @r{The arrow keys access a prompt-specific history.}
7294 %\\n        @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7295             @r{a number, starting from 1.}
7296 %?          @r{After completing the template, position cursor here.}
7297 @end smallexample
7299 @noindent
7300 For specific link types, the following keywords will be
7301 defined@footnote{If you define your own link types (@pxref{Adding
7302 hyperlink types}), any property you store with
7303 @code{org-store-link-props} can be accessed in capture templates in a
7304 similar way.}:
7306 @vindex org-from-is-user-regexp
7307 @smallexample
7308 Link type                        |  Available keywords
7309 ---------------------------------+----------------------------------------------
7310 bbdb                             |  %:name %:company
7311 irc                              |  %:server %:port %:nick
7312 vm, vm-imap, wl, mh, mew, rmail  |  %:type %:subject %:message-id
7313                                  |  %:from %:fromname %:fromaddress
7314                                  |  %:to   %:toname   %:toaddress
7315                                  |  %:date @r{(message date header field)}
7316                                  |  %:date-timestamp @r{(date as active timestamp)}
7317                                  |  %:date-timestamp-inactive @r{(date as inactive timestamp)}
7318                                  |  %: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}.}}
7319 gnus                             |  %:group, @r{for messages also all email fields}
7320 w3, w3m                          |  %:url
7321 info                             |  %:file %:node
7322 calendar                         |  %:date
7323 @end smallexample
7325 @noindent
7326 To place the cursor after template expansion use:
7328 @smallexample
7329 %?          @r{After completing the template, position cursor here.}
7330 @end smallexample
7332 @node Templates in contexts
7333 @subsubsection Templates in contexts
7335 @vindex org-capture-templates-contexts
7336 To control whether a capture template should be accessible from a specific
7337 context, you can customize @code{org-capture-templates-contexts}.  Let's say
7338 for example that you have a capture template @code{"p"} for storing Gnus
7339 emails containing patches.  Then you would configure this option like this:
7341 @smalllisp
7342 (setq org-capture-templates-contexts
7343       '(("p" (in-mode . "message-mode"))))
7344 @end smalllisp
7346 You can also tell that the command key @code{"p"} should refer to another
7347 template.  In that case, add this command key like this:
7349 @smalllisp
7350 (setq org-capture-templates-contexts
7351       '(("p" "q" (in-mode . "message-mode"))))
7352 @end smalllisp
7354 See the docstring of the variable for more information.
7356 @node Attachments
7357 @section Attachments
7358 @cindex attachments
7360 @vindex org-attach-directory
7361 It is often useful to associate reference material with an outline node/task.
7362 Small chunks of plain text can simply be stored in the subtree of a project.
7363 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7364 files that live elsewhere on your computer or in the cloud, like emails or
7365 source code files belonging to a project.  Another method is @i{attachments},
7366 which are files located in a directory belonging to an outline node.  Org
7367 uses directories named by the unique ID of each entry.  These directories are
7368 located in the @file{data} directory which lives in the same directory where
7369 your Org file lives@footnote{If you move entries or Org files from one
7370 directory to another, you may want to configure @code{org-attach-directory}
7371 to contain an absolute path.}.  If you initialize this directory with
7372 @code{git init}, Org will automatically commit changes when it sees them.
7373 The attachment system has been contributed to Org by John Wiegley.
7375 In cases where it seems better to do so, you can also attach a directory of your
7376 choice to an entry.  You can also make children inherit the attachment
7377 directory from a parent, so that an entire subtree uses the same attached
7378 directory.
7380 @noindent The following commands deal with attachments:
7382 @table @kbd
7383 @orgcmd{C-c C-a,org-attach}
7384 The dispatcher for commands related to the attachment system.  After these
7385 keys, a list of commands is displayed and you must press an additional key
7386 to select a command:
7388 @table @kbd
7389 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7390 @vindex org-attach-method
7391 Select a file and move it into the task's attachment directory.  The file
7392 will be copied, moved, or linked, depending on @code{org-attach-method}.
7393 Note that hard links are not supported on all systems.
7395 @kindex C-c C-a c
7396 @kindex C-c C-a m
7397 @kindex C-c C-a l
7398 @item c/m/l
7399 Attach a file using the copy/move/link method.
7400 Note that hard links are not supported on all systems.
7402 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7403 Create a new attachment as an Emacs buffer.
7405 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7406 Synchronize the current task with its attachment directory, in case you added
7407 attachments yourself.
7409 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7410 @vindex org-file-apps
7411 Open current task's attachment.  If there is more than one, prompt for a
7412 file name first.  Opening will follow the rules set by @code{org-file-apps}.
7413 For more details, see the information on following hyperlinks
7414 (@pxref{Handling links}).
7416 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7417 Also open the attachment, but force opening the file in Emacs.
7419 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7420 Open the current task's attachment directory.
7422 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7423 Also open the directory, but force using @command{dired} in Emacs.
7425 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7426 Select and delete a single attachment.
7428 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7429 Delete all of a task's attachments.  A safer way is to open the directory in
7430 @command{dired} and delete from there.
7432 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7433 @cindex property, ATTACH_DIR
7434 Set a specific directory as the entry's attachment directory.  This works by
7435 putting the directory path into the @code{ATTACH_DIR} property.
7437 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7438 @cindex property, ATTACH_DIR_INHERIT
7439 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7440 same directory for attachments as the parent does.
7441 @end table
7442 @end table
7444 @node RSS feeds
7445 @section RSS feeds
7446 @cindex RSS feeds
7447 @cindex Atom feeds
7449 Org can add and change entries based on information found in RSS feeds and
7450 Atom feeds.  You could use this to make a task out of each new podcast in a
7451 podcast feed.  Or you could use a phone-based note-creating service on the
7452 web to import tasks into Org.  To access feeds, configure the variable
7453 @code{org-feed-alist}.  The docstring of this variable has detailed
7454 information.  Here is just an example:
7456 @smalllisp
7457 @group
7458 (setq org-feed-alist
7459      '(("Slashdot"
7460          "http://rss.slashdot.org/Slashdot/slashdot"
7461          "~/txt/org/feeds.org" "Slashdot Entries")))
7462 @end group
7463 @end smalllisp
7465 @noindent
7466 will configure that new items from the feed provided by
7467 @code{rss.slashdot.org} will result in new entries in the file
7468 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7469 the following command is used:
7471 @table @kbd
7472 @orgcmd{C-c C-x g,org-feed-update-all}
7473 @item C-c C-x g
7474 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7475 them.
7476 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7477 Prompt for a feed name and go to the inbox configured for this feed.
7478 @end table
7480 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7481 it will store information about the status of items in the feed, to avoid
7482 adding the same item several times.
7484 For more information, including how to read atom feeds, see
7485 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7487 @node Protocols
7488 @section Protocols for external access
7489 @cindex protocols, for external access
7490 @cindex emacsserver
7492 You can set up Org for handling protocol calls from outside applications that
7493 are passed to Emacs through the @file{emacsserver}.  For example, you can
7494 configure bookmarks in your web browser to send a link to the current page to
7495 Org and create a note from it using capture (@pxref{Capture}).  Or you
7496 could create a bookmark that will tell Emacs to open the local source file of
7497 a remote website you are looking at with the browser.  See
7498 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7499 documentation and setup instructions.
7501 @node Refile and copy
7502 @section Refile and copy
7503 @cindex refiling notes
7504 @cindex copying notes
7506 When reviewing the captured data, you may want to refile or to copy some of
7507 the entries into a different list, for example into a project.  Cutting,
7508 finding the right location, and then pasting the note is cumbersome.  To
7509 simplify this process, you can use the following special command:
7511 @table @kbd
7512 @orgcmd{C-c M-w,org-copy}
7513 @findex org-copy
7514 Copying works like refiling, except that the original note is not deleted.
7515 @orgcmd{C-c C-w,org-refile}
7516 @findex org-refile
7517 @vindex org-reverse-note-order
7518 @vindex org-refile-targets
7519 @vindex org-refile-use-outline-path
7520 @vindex org-outline-path-complete-in-steps
7521 @vindex org-refile-allow-creating-parent-nodes
7522 @vindex org-log-refile
7523 @vindex org-refile-use-cache
7524 @vindex org-refile-keep
7525 Refile the entry or region at point.  This command offers possible locations
7526 for refiling the entry and lets you select one with completion.  The item (or
7527 all items in the region) is filed below the target heading as a subitem.
7528 Depending on @code{org-reverse-note-order}, it will be either the first or
7529 last subitem.@*
7530 By default, all level 1 headlines in the current buffer are considered to be
7531 targets, but you can have more complex definitions across a number of files.
7532 See the variable @code{org-refile-targets} for details.  If you would like to
7533 select a location via a file-path-like completion along the outline path, see
7534 the variables @code{org-refile-use-outline-path} and
7535 @code{org-outline-path-complete-in-steps}.  If you would like to be able to
7536 create new nodes as new parents for refiling on the fly, check the
7537 variable @code{org-refile-allow-creating-parent-nodes}.
7538 When the variable @code{org-log-refile}@footnote{with corresponding
7539 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7540 and @code{nologrefile}} is set, a timestamp or a note will be
7541 recorded when an entry has been refiled.
7542 @orgkey{C-u C-c C-w}
7543 Use the refile interface to jump to a heading.
7544 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7545 Jump to the location where @code{org-refile} last moved a tree to.
7546 @item C-2 C-c C-w
7547 Refile as the child of the item currently being clocked.
7548 @item C-3 C-c C-w
7549 Refile and keep the entry in place.  Also see @code{org-refile-keep} to make
7550 this the default behavior, and beware that this may result in duplicated
7551 @code{ID} properties.
7552 @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}
7553 Clear the target cache.  Caching of refile targets can be turned on by
7554 setting @code{org-refile-use-cache}.  To make the command see new possible
7555 targets, you have to clear the cache with this command.
7556 @end table
7558 @node Archiving
7559 @section Archiving
7560 @cindex archiving
7562 When a project represented by a (sub)tree is finished, you may want
7563 to move the tree out of the way and to stop it from contributing to the
7564 agenda.  Archiving is important to keep your working files compact and global
7565 searches like the construction of agenda views fast.
7567 @table @kbd
7568 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7569 @vindex org-archive-default-command
7570 Archive the current entry using the command specified in the variable
7571 @code{org-archive-default-command}.
7572 @end table
7574 @menu
7575 * Moving subtrees::             Moving a tree to an archive file
7576 * Internal archiving::          Switch off a tree but keep it in the file
7577 @end menu
7579 @node Moving subtrees
7580 @subsection Moving a tree to the archive file
7581 @cindex external archiving
7583 The most common archiving action is to move a project tree to another file,
7584 the archive file.
7586 @table @kbd
7587 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7588 @vindex org-archive-location
7589 Archive the subtree starting at the cursor position to the location
7590 given by @code{org-archive-location}.
7591 @orgkey{C-u C-c C-x C-s}
7592 Check if any direct children of the current headline could be moved to
7593 the archive.  To do this, each subtree is checked for open TODO entries.
7594 If none are found, the command offers to move it to the archive
7595 location.  If the cursor is @emph{not} on a headline when this command
7596 is invoked, the level 1 trees will be checked.
7597 @orgkey{C-u C-u C-c C-x C-s}
7598 As above, but check subtree for timestamps instead of TODO entries.  The
7599 command will offer to archive the subtree if it @emph{does} contain a
7600 timestamp, and that timestamp is in the past.
7601 @end table
7603 @cindex archive locations
7604 The default archive location is a file in the same directory as the
7605 current file, with the name derived by appending @file{_archive} to the
7606 current file name.  You can also choose what heading to file archived
7607 items under, with the possibility to add them to a datetree in a file.
7608 For information and examples on how to specify the file and the heading,
7609 see the documentation string of the variable
7610 @code{org-archive-location}.
7612 There is also an in-buffer option for setting this variable, for example:
7614 @cindex #+ARCHIVE
7615 @example
7616 #+ARCHIVE: %s_done::
7617 @end example
7619 @cindex property, ARCHIVE
7620 @noindent
7621 If you would like to have a special ARCHIVE location for a single entry
7622 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7623 location as the value (@pxref{Properties and columns}).
7625 @vindex org-archive-save-context-info
7626 When a subtree is moved, it receives a number of special properties that
7627 record context information like the file from where the entry came, its
7628 outline path the archiving time etc.  Configure the variable
7629 @code{org-archive-save-context-info} to adjust the amount of information
7630 added.
7633 @node Internal archiving
7634 @subsection Internal archiving
7636 If you want to just switch off (for agenda views) certain subtrees without
7637 moving them to a different file, you can use the @code{ARCHIVE tag}.
7639 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7640 its location in the outline tree, but behaves in the following way:
7641 @itemize @minus
7642 @item
7643 @vindex org-cycle-open-archived-trees
7644 It does not open when you attempt to do so with a visibility cycling
7645 command (@pxref{Visibility cycling}).  You can force cycling archived
7646 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7647 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
7648 @code{show-all} will open archived subtrees.
7649 @item
7650 @vindex org-sparse-tree-open-archived-trees
7651 During sparse tree construction (@pxref{Sparse trees}), matches in
7652 archived subtrees are not exposed, unless you configure the option
7653 @code{org-sparse-tree-open-archived-trees}.
7654 @item
7655 @vindex org-agenda-skip-archived-trees
7656 During agenda view construction (@pxref{Agenda views}), the content of
7657 archived trees is ignored unless you configure the option
7658 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7659 be included.  In the agenda you can press @kbd{v a} to get archives
7660 temporarily included.
7661 @item
7662 @vindex org-export-with-archived-trees
7663 Archived trees are not exported (@pxref{Exporting}), only the headline
7664 is.  Configure the details using the variable
7665 @code{org-export-with-archived-trees}.
7666 @item
7667 @vindex org-columns-skip-archived-trees
7668 Archived trees are excluded from column view unless the variable
7669 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7670 @end itemize
7672 The following commands help manage the ARCHIVE tag:
7674 @table @kbd
7675 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7676 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
7677 the headline changes to a shadowed face, and the subtree below it is
7678 hidden.
7679 @orgkey{C-u C-c C-x a}
7680 Check if any direct children of the current headline should be archived.
7681 To do this, each subtree is checked for open TODO entries.  If none are
7682 found, the command offers to set the ARCHIVE tag for the child.  If the
7683 cursor is @emph{not} on a headline when this command is invoked, the
7684 level 1 trees will be checked.
7685 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7686 Cycle a tree even if it is tagged with ARCHIVE.
7687 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7688 Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
7689 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}.  The
7690 entry becomes a child of that sibling and in this way retains a lot of its
7691 original context, including inherited tags and approximate position in the
7692 outline.
7693 @end table
7696 @node Agenda views
7697 @chapter Agenda views
7698 @cindex agenda views
7700 Due to the way Org works, TODO items, time-stamped items, and
7701 tagged headlines can be scattered throughout a file or even a number of
7702 files.  To get an overview of open action items, or of events that are
7703 important for a particular date, this information must be collected,
7704 sorted and displayed in an organized way.
7706 Org can select items based on various criteria and display them
7707 in a separate buffer.  Seven different view types are provided:
7709 @itemize @bullet
7710 @item
7711 an @emph{agenda} that is like a calendar and shows information
7712 for specific dates,
7713 @item
7714 a @emph{TODO list} that covers all unfinished
7715 action items,
7716 @item
7717 a @emph{match view}, showings headlines based on the tags, properties, and
7718 TODO state associated with them,
7719 @item
7720 a @emph{timeline view} that shows all events in a single Org file,
7721 in time-sorted view,
7722 @item
7723 a @emph{text search view} that shows all entries from multiple files
7724 that contain specified keywords,
7725 @item
7726 a @emph{stuck projects view} showing projects that currently don't move
7727 along, and
7728 @item
7729 @emph{custom views} that are special searches and combinations of different
7730 views.
7731 @end itemize
7733 @noindent
7734 The extracted information is displayed in a special @emph{agenda
7735 buffer}.  This buffer is read-only, but provides commands to visit the
7736 corresponding locations in the original Org files, and even to
7737 edit these files remotely.
7739 @vindex org-agenda-window-setup
7740 @vindex org-agenda-restore-windows-after-quit
7741 Two variables control how the agenda buffer is displayed and whether the
7742 window configuration is restored when the agenda exits:
7743 @code{org-agenda-window-setup} and
7744 @code{org-agenda-restore-windows-after-quit}.
7746 @menu
7747 * Agenda files::                Files being searched for agenda information
7748 * Agenda dispatcher::           Keyboard access to agenda views
7749 * Built-in agenda views::       What is available out of the box?
7750 * Presentation and sorting::    How agenda items are prepared for display
7751 * Agenda commands::             Remote editing of Org trees
7752 * Custom agenda views::         Defining special searches and views
7753 * Exporting agenda views::      Writing a view to a file
7754 * Agenda column view::          Using column view for collected entries
7755 @end menu
7757 @node Agenda files
7758 @section Agenda files
7759 @cindex agenda files
7760 @cindex files for agenda
7762 @vindex org-agenda-files
7763 The information to be shown is normally collected from all @emph{agenda
7764 files}, the files listed in the variable
7765 @code{org-agenda-files}@footnote{If the value of that variable is not a
7766 list, but a single file name, then the list of agenda files will be
7767 maintained in that external file.}.  If a directory is part of this list,
7768 all files with the extension @file{.org} in this directory will be part
7769 of the list.
7771 Thus, even if you only work with a single Org file, that file should
7772 be put into the list@footnote{When using the dispatcher, pressing
7773 @kbd{<} before selecting a command will actually limit the command to
7774 the current file, and ignore @code{org-agenda-files} until the next
7775 dispatcher command.}.  You can customize @code{org-agenda-files}, but
7776 the easiest way to maintain it is through the following commands
7778 @cindex files, adding to agenda list
7779 @table @kbd
7780 @orgcmd{C-c [,org-agenda-file-to-front}
7781 Add current file to the list of agenda files.  The file is added to
7782 the front of the list.  If it was already in the list, it is moved to
7783 the front.  With a prefix argument, file is added/moved to the end.
7784 @orgcmd{C-c ],org-remove-file}
7785 Remove current file from the list of agenda files.
7786 @kindex C-,
7787 @cindex cycling, of agenda files
7788 @orgcmd{C-',org-cycle-agenda-files}
7789 @itemx C-,
7790 Cycle through agenda file list, visiting one file after the other.
7791 @kindex M-x org-iswitchb
7792 @item M-x org-iswitchb RET
7793 Command to use an @code{iswitchb}-like interface to switch to and between Org
7794 buffers.
7795 @end table
7797 @noindent
7798 The Org menu contains the current list of files and can be used
7799 to visit any of them.
7801 If you would like to focus the agenda temporarily on a file not in
7802 this list, or on just one file in the list, or even on only a subtree in a
7803 file, then this can be done in different ways.  For a single agenda command,
7804 you may press @kbd{<} once or several times in the dispatcher
7805 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
7806 extended period, use the following commands:
7808 @table @kbd
7809 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7810 Permanently restrict the agenda to the current subtree.  When with a
7811 prefix argument, or with the cursor before the first headline in a file,
7812 the agenda scope is set to the entire file.  This restriction remains in
7813 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7814 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
7815 agenda view, the new restriction takes effect immediately.
7816 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7817 Remove the permanent restriction created by @kbd{C-c C-x <}.
7818 @end table
7820 @noindent
7821 When working with @file{speedbar.el}, you can use the following commands in
7822 the Speedbar frame:
7824 @table @kbd
7825 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7826 Permanently restrict the agenda to the item---either an Org file or a subtree
7827 in such a file---at the cursor in the Speedbar frame.
7828 If there is a window displaying an agenda view, the new restriction takes
7829 effect immediately.
7830 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7831 Lift the restriction.
7832 @end table
7834 @node Agenda dispatcher
7835 @section The agenda dispatcher
7836 @cindex agenda dispatcher
7837 @cindex dispatching agenda commands
7838 The views are created through a dispatcher, which should be bound to a
7839 global key---for example @kbd{C-c a} (@pxref{Activation}).  In the
7840 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7841 is accessed and list keyboard access to commands accordingly.  After
7842 pressing @kbd{C-c a}, an additional letter is required to execute a
7843 command.  The dispatcher offers the following default commands:
7845 @table @kbd
7846 @item a
7847 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7848 @item t @r{/} T
7849 Create a list of all TODO items (@pxref{Global TODO list}).
7850 @item m @r{/} M
7851 Create a list of headlines matching a TAGS expression (@pxref{Matching
7852 tags and properties}).
7853 @item L
7854 Create the timeline view for the current buffer (@pxref{Timeline}).
7855 @item s
7856 Create a list of entries selected by a boolean expression of keywords
7857 and/or regular expressions that must or must not occur in the entry.
7858 @item /
7859 @vindex org-agenda-text-search-extra-files
7860 Search for a regular expression in all agenda files and additionally in
7861 the files listed in @code{org-agenda-text-search-extra-files}.  This
7862 uses the Emacs command @code{multi-occur}.  A prefix argument can be
7863 used to specify the number of context lines for each match, default is
7865 @item # @r{/} !
7866 Create a list of stuck projects (@pxref{Stuck projects}).
7867 @item <
7868 Restrict an agenda command to the current buffer@footnote{For backward
7869 compatibility, you can also press @kbd{1} to restrict to the current
7870 buffer.}.  After pressing @kbd{<}, you still need to press the character
7871 selecting the command.
7872 @item < <
7873 If there is an active region, restrict the following agenda command to
7874 the region.  Otherwise, restrict it to the current subtree@footnote{For
7875 backward compatibility, you can also press @kbd{0} to restrict to the
7876 current region/subtree.}.  After pressing @kbd{< <}, you still need to press the
7877 character selecting the command.
7879 @item *
7880 @cindex agenda, sticky
7881 @vindex org-agenda-sticky
7882 Toggle sticky agenda views.  By default, Org maintains only a single agenda
7883 buffer and rebuilds it each time you change the view, to make sure everything
7884 is always up to date.  If you often switch between agenda views and the build
7885 time bothers you, you can turn on sticky agenda buffers or make this the
7886 default by customizing the variable @code{org-agenda-sticky}.  With sticky
7887 agendas, the agenda dispatcher will not recreate agenda views from scratch,
7888 it will only switch to the selected one, and you need to update the agenda by
7889 hand with @kbd{r} or @kbd{g} when needed.  You can toggle sticky agenda view
7890 any time with @code{org-toggle-sticky-agenda}.
7891 @end table
7893 You can also define custom commands that will be accessible through the
7894 dispatcher, just like the default commands.  This includes the
7895 possibility to create extended agenda buffers that contain several
7896 blocks together, for example the weekly agenda, the global TODO list and
7897 a number of special tags matches.  @xref{Custom agenda views}.
7899 @node Built-in agenda views
7900 @section The built-in agenda views
7902 In this section we describe the built-in views.
7904 @menu
7905 * Weekly/daily agenda::         The calendar page with current tasks
7906 * Global TODO list::            All unfinished action items
7907 * Matching tags and properties::  Structured information with fine-tuned search
7908 * Timeline::                    Time-sorted view for single file
7909 * Search view::                 Find entries by searching for text
7910 * Stuck projects::              Find projects you need to review
7911 @end menu
7913 @node Weekly/daily agenda
7914 @subsection The weekly/daily agenda
7915 @cindex agenda
7916 @cindex weekly agenda
7917 @cindex daily agenda
7919 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7920 paper agenda, showing all the tasks for the current week or day.
7922 @table @kbd
7923 @cindex org-agenda, command
7924 @orgcmd{C-c a a,org-agenda-list}
7925 Compile an agenda for the current week from a list of Org files.  The agenda
7926 shows the entries for each day.  With a numeric prefix@footnote{For backward
7927 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7928 listed before the agenda.  This feature is deprecated, use the dedicated TODO
7929 list, or a block agenda instead (@pxref{Block agenda}).}  (like @kbd{C-u 2 1
7930 C-c a a}) you may set the number of days to be displayed.
7931 @end table
7933 @vindex org-agenda-span
7934 @vindex org-agenda-ndays
7935 @vindex org-agenda-start-day
7936 @vindex org-agenda-start-on-weekday
7937 The default number of days displayed in the agenda is set by the variable
7938 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}).  This
7939 variable can be set to any number of days you want to see by default in the
7940 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7941 @code{year}.  For weekly agendas, the default is to start on the previous
7942 monday (see @code{org-agenda-start-on-weekday}).  You can also set the start
7943 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7944 start the agenda ten days from today in the future.
7946 Remote editing from the agenda buffer means, for example, that you can
7947 change the dates of deadlines and appointments from the agenda buffer.
7948 The commands available in the Agenda buffer are listed in @ref{Agenda
7949 commands}.
7951 @subsubheading Calendar/Diary integration
7952 @cindex calendar integration
7953 @cindex diary integration
7955 Emacs contains the calendar and diary by Edward M. Reingold.  The
7956 calendar displays a three-month calendar with holidays from different
7957 countries and cultures.  The diary allows you to keep track of
7958 anniversaries, lunar phases, sunrise/set, recurrent appointments
7959 (weekly, monthly) and more.  In this way, it is quite complementary to
7960 Org.  It can be very useful to combine output from Org with
7961 the diary.
7963 In order to include entries from the Emacs diary into Org mode's
7964 agenda, you only need to customize the variable
7966 @lisp
7967 (setq org-agenda-include-diary t)
7968 @end lisp
7970 @noindent After that, everything will happen automatically.  All diary
7971 entries including holidays, anniversaries, etc., will be included in the
7972 agenda buffer created by Org mode.  @key{SPC}, @key{TAB}, and
7973 @key{RET} can be used from the agenda buffer to jump to the diary
7974 file in order to edit existing diary entries.  The @kbd{i} command to
7975 insert new entries for the current date works in the agenda buffer, as
7976 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7977 Sunrise/Sunset times, show lunar phases and to convert to other
7978 calendars, respectively.  @kbd{c} can be used to switch back and forth
7979 between calendar and agenda.
7981 If you are using the diary only for sexp entries and holidays, it is
7982 faster to not use the above setting, but instead to copy or even move
7983 the entries into an Org file.  Org mode evaluates diary-style sexp
7984 entries, and does it faster because there is no overhead for first
7985 creating the diary display.  Note that the sexp entries must start at
7986 the left margin, no whitespace is allowed before them.  For example,
7987 the following segment of an Org file will be processed and entries
7988 will be made in the agenda:
7990 @example
7991 * Holidays
7992   :PROPERTIES:
7993   :CATEGORY: Holiday
7994   :END:
7995 %%(org-calendar-holiday)   ; special function for holiday names
7997 * Birthdays
7998   :PROPERTIES:
7999   :CATEGORY: Ann
8000   :END:
8001 %%(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
8002 %%(org-anniversary 1869 10  2) Mahatma Gandhi would be %d years old
8003 @end example
8005 @subsubheading Anniversaries from BBDB
8006 @cindex BBDB, anniversaries
8007 @cindex anniversaries, from BBDB
8009 If you are using the Big Brothers Database to store your contacts, you will
8010 very likely prefer to store anniversaries in BBDB rather than in a
8011 separate Org or diary file.  Org supports this and will show BBDB
8012 anniversaries as part of the agenda.  All you need to do is to add the
8013 following to one of your agenda files:
8015 @example
8016 * Anniversaries
8017   :PROPERTIES:
8018   :CATEGORY: Anniv
8019   :END:
8020 %%(org-bbdb-anniversaries)
8021 @end example
8023 You can then go ahead and define anniversaries for a BBDB record.  Basically,
8024 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
8025 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
8026 followed by a space and the class of the anniversary (@samp{birthday} or
8027 @samp{wedding}, or a format string).  If you omit the class, it will default to
8028 @samp{birthday}.  Here are a few examples, the header for the file
8029 @file{org-bbdb.el} contains more detailed information.
8031 @example
8032 1973-06-22
8033 06-22
8034 1955-08-02 wedding
8035 2008-04-14 %s released version 6.01 of org mode, %d years ago
8036 @end example
8038 After a change to BBDB, or for the first agenda display during an Emacs
8039 session, the agenda display will suffer a short delay as Org updates its
8040 hash with anniversaries.  However, from then on things will be very fast---much
8041 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
8042 in an Org or Diary file.
8044 @subsubheading Appointment reminders
8045 @cindex @file{appt.el}
8046 @cindex appointment reminders
8047 @cindex appointment
8048 @cindex reminders
8050 Org can interact with Emacs appointments notification facility.  To add the
8051 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
8052 This command lets you filter through the list of your appointments and add
8053 only those belonging to a specific category or matching a regular expression.
8054 It also reads a @code{APPT_WARNTIME} property which will then override the
8055 value of @code{appt-message-warning-time} for this appointment.  See the
8056 docstring for details.
8058 @node Global TODO list
8059 @subsection The global TODO list
8060 @cindex global TODO list
8061 @cindex TODO list, global
8063 The global TODO list contains all unfinished TODO items formatted and
8064 collected into a single place.
8066 @table @kbd
8067 @orgcmd{C-c a t,org-todo-list}
8068 Show the global TODO list.  This collects the TODO items from all agenda
8069 files (@pxref{Agenda views}) into a single buffer.  By default, this lists
8070 items with a state the is not a DONE state.  The buffer is in
8071 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
8072 entries directly from that buffer (@pxref{Agenda commands}).
8073 @orgcmd{C-c a T,org-todo-list}
8074 @cindex TODO keyword matching
8075 @vindex org-todo-keywords
8076 Like the above, but allows selection of a specific TODO keyword.  You can
8077 also do this by specifying a prefix argument to @kbd{C-c a t}.  You are
8078 prompted for a keyword, and you may also specify several keywords by
8079 separating them with @samp{|} as the boolean OR operator.  With a numeric
8080 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
8081 @kindex r
8082 The @kbd{r} key in the agenda buffer regenerates it, and you can give
8083 a prefix argument to this command to change the selected TODO keyword,
8084 for example @kbd{3 r}.  If you often need a search for a specific
8085 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
8086 Matching specific TODO keywords can also be done as part of a tags
8087 search (@pxref{Tag searches}).
8088 @end table
8090 Remote editing of TODO items means that you can change the state of a
8091 TODO entry with a single key press.  The commands available in the
8092 TODO list are described in @ref{Agenda commands}.
8094 @cindex sublevels, inclusion into TODO list
8095 Normally the global TODO list simply shows all headlines with TODO
8096 keywords.  This list can become very long.  There are two ways to keep
8097 it more compact:
8098 @itemize @minus
8099 @item
8100 @vindex org-agenda-todo-ignore-scheduled
8101 @vindex org-agenda-todo-ignore-deadlines
8102 @vindex org-agenda-todo-ignore-timestamp
8103 @vindex org-agenda-todo-ignore-with-date
8104 Some people view a TODO item that has been @emph{scheduled} for execution or
8105 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
8106 Configure the variables @code{org-agenda-todo-ignore-scheduled},
8107 @code{org-agenda-todo-ignore-deadlines},
8108 @code{org-agenda-todo-ignore-timestamp} and/or
8109 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
8110 TODO list.
8111 @item
8112 @vindex org-agenda-todo-list-sublevels
8113 TODO items may have sublevels to break up the task into subtasks.  In
8114 such cases it may be enough to list only the highest level TODO headline
8115 and omit the sublevels from the global list.  Configure the variable
8116 @code{org-agenda-todo-list-sublevels} to get this behavior.
8117 @end itemize
8119 @node Matching tags and properties
8120 @subsection Matching tags and properties
8121 @cindex matching, of tags
8122 @cindex matching, of properties
8123 @cindex tags view
8124 @cindex match view
8126 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
8127 or have properties (@pxref{Properties and columns}), you can select headlines
8128 based on this metadata and collect them into an agenda buffer.  The match
8129 syntax described here also applies when creating sparse trees with @kbd{C-c /
8132 @table @kbd
8133 @orgcmd{C-c a m,org-tags-view}
8134 Produce a list of all headlines that match a given set of tags.  The
8135 command prompts for a selection criterion, which is a boolean logic
8136 expression with tags, like @samp{+work+urgent-withboss} or
8137 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
8138 define a custom command for it (@pxref{Agenda dispatcher}).
8139 @orgcmd{C-c a M,org-tags-view}
8140 @vindex org-tags-match-list-sublevels
8141 @vindex org-agenda-tags-todo-honor-ignore-options
8142 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
8143 not-DONE state and force checking subitems (see variable
8144 @code{org-tags-match-list-sublevels}).  To exclude scheduled/deadline items,
8145 see the variable @code{org-agenda-tags-todo-honor-ignore-options}.  Matching
8146 specific TODO keywords together with a tags match is also possible, see
8147 @ref{Tag searches}.
8148 @end table
8150 The commands available in the tags list are described in @ref{Agenda
8151 commands}.
8153 @subsubheading Match syntax
8155 @cindex Boolean logic, for tag/property searches
8156 A search string can use Boolean operators @samp{&} for @code{AND} and
8157 @samp{|} for @code{OR}@.  @samp{&} binds more strongly than @samp{|}.
8158 Parentheses are not implemented.  Each element in the search is either a
8159 tag, a regular expression matching tags, or an expression like
8160 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8161 property value.  Each element may be preceded by @samp{-}, to select
8162 against it, and @samp{+} is syntactic sugar for positive selection.  The
8163 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8164 present.  Here are some examples, using only tags.
8166 @table @samp
8167 @item work
8168 Select headlines tagged @samp{:work:}.
8169 @item work&boss
8170 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8171 @item +work-boss
8172 Select headlines tagged @samp{:work:}, but discard those also tagged
8173 @samp{:boss:}.
8174 @item work|laptop
8175 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8176 @item work|laptop+night
8177 Like before, but require the @samp{:laptop:} lines to be tagged also
8178 @samp{:night:}.
8179 @end table
8181 @cindex regular expressions, with tags search
8182 Instead of a tag, you may also specify a regular expression enclosed in curly
8183 braces.  For example,
8184 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8185 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8187 @cindex group tags, as regular expressions
8188 Group tags (@pxref{Tag hierarchy}) are expanded as regular expressions.  E.g.,
8189 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8190 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8191 and searching for @samp{-work} will search for all headlines but those with
8192 one of the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8194 @cindex TODO keyword matching, with tags search
8195 @cindex level, require for tags/property match
8196 @cindex category, require for tags/property match
8197 @vindex org-odd-levels-only
8198 You may also test for properties (@pxref{Properties and columns}) at the same
8199 time as matching tags.  The properties may be real properties, or special
8200 properties that represent other metadata (@pxref{Special properties}).  For
8201 example, the ``property'' @code{TODO} represents the TODO keyword of the
8202 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8203 the entry.
8205 In addition to the @ref{Special properties}, one other ``property'' can also
8206 be used. @code{LEVEL} represents the level of an entry.  So a search
8207 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8208 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8209 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8210 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8212 Here are more examples:
8214 @table @samp
8215 @item work+TODO="WAITING"
8216 Select @samp{:work:}-tagged TODO lines with the specific TODO
8217 keyword @samp{WAITING}.
8218 @item work+TODO="WAITING"|home+TODO="WAITING"
8219 Waiting tasks both at work and at home.
8220 @end table
8222 When matching properties, a number of different operators can be used to test
8223 the value of a property.  Here is a complex example:
8225 @example
8226 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
8227          +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8228 @end example
8230 @noindent
8231 The type of comparison will depend on how the comparison value is written:
8232 @itemize @minus
8233 @item
8234 If the comparison value is a plain number, a numerical comparison is done,
8235 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8236 @samp{>=}, and @samp{<>}.
8237 @item
8238 If the comparison value is enclosed in double-quotes,
8239 a string comparison is done, and the same operators are allowed.
8240 @item
8241 If the comparison value is enclosed in double-quotes @emph{and} angular
8242 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8243 assumed to be date/time specifications in the standard Org way, and the
8244 comparison will be done accordingly.  Special values that will be recognized
8245 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8246 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8247 specification.  Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8248 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8249 respectively, can be used.
8250 @item
8251 If the comparison value is enclosed
8252 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8253 regexp matches the property value, and @samp{<>} meaning that it does not
8254 match.
8255 @end itemize
8257 So the search string in the example finds entries tagged @samp{:work:} but
8258 not @samp{:boss:}, which also have a priority value @samp{A}, a
8259 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8260 property that is numerically smaller than 2, a @samp{:With:} property that is
8261 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8262 on or after October 11, 2008.
8264 You can configure Org mode to use property inheritance during a search, but
8265 beware that this can slow down searches considerably.  See @ref{Property
8266 inheritance}, for details.
8268 For backward compatibility, and also for typing speed, there is also a
8269 different way to test TODO states in a search.  For this, terminate the
8270 tags/property part of the search string (which may include several terms
8271 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8272 expression just for TODO keywords.  The syntax is then similar to that for
8273 tags, but should be applied with care: for example, a positive selection on
8274 several TODO keywords cannot meaningfully be combined with boolean AND@.
8275 However, @emph{negative selection} combined with AND can be meaningful.  To
8276 make sure that only lines are checked that actually have any TODO keyword
8277 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8278 part after the slash with @samp{!}.  Using @kbd{C-c a M} or @samp{/!} will
8279 not match TODO keywords in a DONE state.  Examples:
8281 @table @samp
8282 @item work/WAITING
8283 Same as @samp{work+TODO="WAITING"}
8284 @item work/!-WAITING-NEXT
8285 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8286 nor @samp{NEXT}
8287 @item work/!+WAITING|+NEXT
8288 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8289 @samp{NEXT}.
8290 @end table
8292 @node Timeline
8293 @subsection Timeline for a single file
8294 @cindex timeline, single file
8295 @cindex time-sorted view
8297 The timeline summarizes all time-stamped items from a single Org mode
8298 file in a @emph{time-sorted view}.  The main purpose of this command is
8299 to give an overview over events in a project.
8301 @table @kbd
8302 @orgcmd{C-c a L,org-timeline}
8303 Show a time-sorted view of the Org file, with all time-stamped items.
8304 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8305 (scheduled or not) are also listed under the current date.
8306 @end table
8308 @noindent
8309 The commands available in the timeline buffer are listed in
8310 @ref{Agenda commands}.
8312 @node Search view
8313 @subsection Search view
8314 @cindex search view
8315 @cindex text search
8316 @cindex searching, for text
8318 This agenda view is a general text search facility for Org mode entries.
8319 It is particularly useful to find notes.
8321 @table @kbd
8322 @orgcmd{C-c a s,org-search-view}
8323 This is a special search that lets you select entries by matching a substring
8324 or specific words using a boolean logic.
8325 @end table
8326 For example, the search string @samp{computer equipment} will find entries
8327 that contain @samp{computer equipment} as a substring.  If the two words are
8328 separated by more space or a line break, the search will still match.
8329 Search view can also search for specific keywords in the entry, using Boolean
8330 logic.  The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8331 will search for note entries that contain the keywords @code{computer}
8332 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8333 not matched by the regular expression @code{8\.11[bg]}, meaning to
8334 exclude both 8.11b and 8.11g.  The first @samp{+} is necessary to turn on
8335 word search, other @samp{+} characters are optional.  For more details, see
8336 the docstring of the command @code{org-search-view}.
8338 @vindex org-agenda-text-search-extra-files
8339 Note that in addition to the agenda files, this command will also search
8340 the files listed in @code{org-agenda-text-search-extra-files}.
8342 @node Stuck projects
8343 @subsection Stuck projects
8344 @pindex GTD, Getting Things Done
8346 If you are following a system like David Allen's GTD to organize your
8347 work, one of the ``duties'' you have is a regular review to make sure
8348 that all projects move along.  A @emph{stuck} project is a project that
8349 has no defined next actions, so it will never show up in the TODO lists
8350 Org mode produces.  During the review, you need to identify such
8351 projects and define next actions for them.
8353 @table @kbd
8354 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8355 List projects that are stuck.
8356 @kindex C-c a !
8357 @item C-c a !
8358 @vindex org-stuck-projects
8359 Customize the variable @code{org-stuck-projects} to define what a stuck
8360 project is and how to find it.
8361 @end table
8363 You almost certainly will have to configure this view before it will
8364 work for you.  The built-in default assumes that all your projects are
8365 level-2 headlines, and that a project is not stuck if it has at least
8366 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8368 Let's assume that you, in your own way of using Org mode, identify
8369 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8370 indicate a project that should not be considered yet.  Let's further
8371 assume that the TODO keyword DONE marks finished projects, and that NEXT
8372 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
8373 is a next action even without the NEXT tag.  Finally, if the project
8374 contains the special word IGNORE anywhere, it should not be listed
8375 either.  In this case you would start by identifying eligible projects
8376 with a tags/todo match@footnote{@xref{Tag searches}.}
8377 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8378 IGNORE in the subtree to identify projects that are not stuck.  The
8379 correct customization for this is
8381 @lisp
8382 (setq org-stuck-projects
8383       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8384                                "\\<IGNORE\\>"))
8385 @end lisp
8387 Note that if a project is identified as non-stuck, the subtree of this entry
8388 will still be searched for stuck projects.
8390 @node Presentation and sorting
8391 @section Presentation and sorting
8392 @cindex presentation, of agenda items
8394 @vindex org-agenda-prefix-format
8395 @vindex org-agenda-tags-column
8396 Before displaying items in an agenda view, Org mode visually prepares the
8397 items and sorts them.  Each item occupies a single line.  The line starts
8398 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8399 of the item and other important information.  You can customize in which
8400 column tags will be displayed through @code{org-agenda-tags-column}.  You can
8401 also customize the prefix using the option @code{org-agenda-prefix-format}.
8402 This prefix is followed by a cleaned-up version of the outline headline
8403 associated with the item.
8405 @menu
8406 * Categories::                  Not all tasks are equal
8407 * Time-of-day specifications::  How the agenda knows the time
8408 * Sorting agenda items::        The order of things
8409 * Filtering/limiting agenda items::  Dynamically narrow the agenda
8410 @end menu
8412 @node Categories
8413 @subsection Categories
8415 @cindex category
8416 @cindex #+CATEGORY
8417 The category is a broad label assigned to each agenda item.  By default, the
8418 category is simply derived from the file name, but you can also specify it
8419 with a special line in the buffer, like this:
8421 @example
8422 #+CATEGORY: Thesis
8423 @end example
8425 @noindent
8426 @cindex property, CATEGORY
8427 If you would like to have a special CATEGORY for a single entry or a
8428 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8429 special category you want to apply as the value.
8431 @noindent
8432 The display in the agenda buffer looks best if the category is not
8433 longer than 10 characters.
8435 @noindent
8436 You can set up icons for category by customizing the
8437 @code{org-agenda-category-icon-alist} variable.
8439 @node Time-of-day specifications
8440 @subsection Time-of-day specifications
8441 @cindex time-of-day specification
8443 Org mode checks each agenda item for a time-of-day specification.  The
8444 time can be part of the timestamp that triggered inclusion into the
8445 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
8446 ranges can be specified with two timestamps, like
8448 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8450 In the headline of the entry itself, a time(range) may also appear as
8451 plain text (like @samp{12:45} or a @samp{8:30-1pm}).  If the agenda
8452 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8453 specifications in diary entries are recognized as well.
8455 For agenda display, Org mode extracts the time and displays it in a
8456 standard 24 hour format as part of the prefix.  The example times in
8457 the previous paragraphs would end up in the agenda like this:
8459 @example
8460     8:30-13:00 Arthur Dent lies in front of the bulldozer
8461    12:45...... Ford Prefect arrives and takes Arthur to the pub
8462    19:00...... The Vogon reads his poem
8463    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8464 @end example
8466 @cindex time grid
8467 If the agenda is in single-day mode, or for the display of today, the
8468 timed entries are embedded in a time grid, like
8470 @example
8471     8:00...... ------------------
8472     8:30-13:00 Arthur Dent lies in front of the bulldozer
8473    10:00...... ------------------
8474    12:00...... ------------------
8475    12:45...... Ford Prefect arrives and takes Arthur to the pub
8476    14:00...... ------------------
8477    16:00...... ------------------
8478    18:00...... ------------------
8479    19:00...... The Vogon reads his poem
8480    20:00...... ------------------
8481    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8482 @end example
8484 @vindex org-agenda-use-time-grid
8485 @vindex org-agenda-time-grid
8486 The time grid can be turned on and off with the variable
8487 @code{org-agenda-use-time-grid}, and can be configured with
8488 @code{org-agenda-time-grid}.
8490 @node Sorting agenda items
8491 @subsection Sorting agenda items
8492 @cindex sorting, of agenda items
8493 @cindex priorities, of agenda items
8494 Before being inserted into a view, the items are sorted.  How this is
8495 done depends on the type of view.
8496 @itemize @bullet
8497 @item
8498 @vindex org-agenda-files
8499 For the daily/weekly agenda, the items for each day are sorted.  The
8500 default order is to first collect all items containing an explicit
8501 time-of-day specification.  These entries will be shown at the beginning
8502 of the list, as a @emph{schedule} for the day.  After that, items remain
8503 grouped in categories, in the sequence given by @code{org-agenda-files}.
8504 Within each category, items are sorted by priority (@pxref{Priorities}),
8505 which is composed of the base priority (2000 for priority @samp{A}, 1000
8506 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8507 overdue scheduled or deadline items.
8508 @item
8509 For the TODO list, items remain in the order of categories, but within
8510 each category, sorting takes place according to priority
8511 (@pxref{Priorities}).  The priority used for sorting derives from the
8512 priority cookie, with additions depending on how close an item is to its due
8513 or scheduled date.
8514 @item
8515 For tags matches, items are not sorted at all, but just appear in the
8516 sequence in which they are found in the agenda files.
8517 @end itemize
8519 @vindex org-agenda-sorting-strategy
8520 Sorting can be customized using the variable
8521 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8522 the estimated effort of an entry (@pxref{Effort estimates}).
8524 @node Filtering/limiting agenda items
8525 @subsection Filtering/limiting agenda items
8527 Agenda built-in or customized commands are statically defined.  Agenda
8528 filters and limits provide two ways of dynamically narrowing down the list of
8529 agenda entries: @emph{filters} and @emph{limits}.  Filters only act on the
8530 display of the items, while limits take effect before the list of agenda
8531 entries is built.  Filters are more often used interactively, while limits are
8532 mostly useful when defined as local variables within custom agenda commands.
8534 @subsubheading Filtering in the agenda
8535 @cindex filtering, by tag, category, top headline and effort, in agenda
8536 @cindex tag filtering, in agenda
8537 @cindex category filtering, in agenda
8538 @cindex top headline filtering, in agenda
8539 @cindex effort filtering, in agenda
8540 @cindex query editing, in agenda
8542 @table @kbd
8543 @orgcmd{/,org-agenda-filter-by-tag}
8544 @vindex org-agenda-tag-filter-preset
8545 Filter the agenda view with respect to a tag and/or effort estimates.  The
8546 difference between this and a custom agenda command is that filtering is very
8547 fast, so that you can switch quickly between different filters without having
8548 to recreate the agenda.@footnote{Custom commands can preset a filter by
8549 binding the variable @code{org-agenda-tag-filter-preset} as an option.  This
8550 filter will then be applied to the view and persist as a basic filter through
8551 refreshes and more secondary filtering.  The filter is a global property of
8552 the entire agenda view---in a block agenda, you should only set this in the
8553 global options section, not in the section of an individual block.}
8555 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8556 all.  Pressing @key{TAB} at that prompt will offer use completion to select a
8557 tag (including any tags that do not have a selection character).  The command
8558 then hides all entries that do not contain or inherit this tag.  When called
8559 with prefix arg, remove the entries that @emph{do} have the tag.  A second
8560 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8561 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8562 will be narrowed by requiring or forbidding the selected additional tag.
8563 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8564 immediately use the @kbd{\} command.
8566 Org also supports automatic, context-aware tag filtering.  If the variable
8567 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8568 that function can decide which tags should be excluded from the agenda
8569 automatically.  Once this is set, the @kbd{/} command then accepts @kbd{RET}
8570 as a sub-option key and runs the auto exclusion logic.  For example, let's
8571 say you use a @code{Net} tag to identify tasks which need network access, an
8572 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8573 calls.  You could auto-exclude these tags based on the availability of the
8574 Internet, and outside of business hours, with something like this:
8576 @smalllisp
8577 @group
8578 (defun org-my-auto-exclude-function (tag)
8579   (and (cond
8580         ((string= tag "Net")
8581          (/= 0 (call-process "/sbin/ping" nil nil nil
8582                              "-c1" "-q" "-t1" "mail.gnu.org")))
8583         ((or (string= tag "Errand") (string= tag "Call"))
8584          (let ((hour (nth 2 (decode-time))))
8585            (or (< hour 8) (> hour 21)))))
8586        (concat "-" tag)))
8588 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8589 @end group
8590 @end smalllisp
8592 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8593 Narrow the current agenda filter by an additional condition.  When called with
8594 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8595 the effort criterion.  You can achieve the same effect by pressing @kbd{+} or
8596 @kbd{-} as the first key after the @kbd{/} command.
8599 @kindex [
8600 @kindex ]
8601 @kindex @{
8602 @kindex @}
8603 @item [ ] @{ @}
8604 @table @i
8605 @item @r{in} search view
8606 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8607 (@kbd{@{} and @kbd{@}}) to the query string.  The opening bracket/brace will
8608 add a positive search term prefixed by @samp{+}, indicating that this search
8609 term @i{must} occur/match in the entry.  The closing bracket/brace will add a
8610 negative search term which @i{must not} occur/match in the entry for it to be
8611 selected.
8612 @end table
8614 @orgcmd{<,org-agenda-filter-by-category}
8615 @vindex org-agenda-category-filter-preset
8617 Filter the current agenda view with respect to the category of the item at
8618 point.  Pressing @code{<} another time will remove this filter.  You can add
8619 a filter preset through the option @code{org-agenda-category-filter-preset}
8620 (see below.)
8622 @orgcmd{^,org-agenda-filter-by-top-headline}
8623 Filter the current agenda view and only display the siblings and the parent
8624 headline of the one at point.
8626 @orgcmd{=,org-agenda-filter-by-regexp}
8627 @vindex org-agenda-regexp-filter-preset
8629 Filter the agenda view by a regular expression: only show agenda entries
8630 matching the regular expression the user entered.  When called with a prefix
8631 argument, it will filter @emph{out} entries matching the regexp.  With two
8632 universal prefix arguments, it will remove all the regexp filters, which can
8633 be accumulated.  You can add a filter preset through the option
8634 @code{org-agenda-category-filter-preset} (see below.)
8636 @orgcmd{_,org-agenda-filter-by-effort}
8637 @vindex org-agenda-effort-filter-preset
8638 @vindex org-sort-agenda-noeffort-is-high
8639 Filter the agenda view with respect to effort estimates.  
8640 You first need to set up allowed efforts globally, for example
8641 @lisp
8642 (setq org-global-properties
8643     '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8644 @end lisp
8645 You can then filter for an effort by first typing an operator, one of
8646 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8647 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8648 The filter will then restrict to entries with effort smaller-or-equal, equal,
8649 or larger-or-equal than the selected value.  For application of the operator,
8650 entries without a defined effort will be treated according to the value of
8651 @code{org-sort-agenda-noeffort-is-high}.
8653 @orgcmd{|,org-agenda-filter-remove-all}
8654 Remove all filters in the current agenda view.
8655 @end table
8657 @subsubheading Setting limits for the agenda
8658 @cindex limits, in agenda
8659 @vindex org-agenda-max-entries
8660 @vindex org-agenda-max-effort
8661 @vindex org-agenda-max-todos
8662 @vindex org-agenda-max-tags
8664 Here is a list of options that you can set, either globally, or locally in
8665 your custom agenda views (@pxref{Custom agenda views}).
8667 @table @code
8668 @item org-agenda-max-entries
8669 Limit the number of entries.
8670 @item org-agenda-max-effort
8671 Limit the duration of accumulated efforts (as minutes).
8672 @item org-agenda-max-todos
8673 Limit the number of entries with TODO keywords.
8674 @item org-agenda-max-tags
8675 Limit the number of tagged entries.
8676 @end table
8678 When set to a positive integer, each option will exclude entries from other
8679 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8680 the agenda to 100 minutes of effort and exclude any entry that has no effort
8681 property.  If you want to include entries with no effort property, use a
8682 negative value for @code{org-agenda-max-effort}.
8684 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8685 command.  For example, this custom command will display the next five entries
8686 with a @code{NEXT} TODO keyword.
8688 @smalllisp
8689 (setq org-agenda-custom-commands
8690       '(("n" todo "NEXT"
8691          ((org-agenda-max-entries 5)))))
8692 @end smalllisp
8694 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8695 will again the next five entries again, including the first entry that was
8696 excluded so far.
8698 You can also dynamically set temporary limits, which will be lost when
8699 rebuilding the agenda:
8701 @table @kbd
8702 @orgcmd{~,org-agenda-limit-interactively}
8703 This prompts for the type of limit to apply and its value.
8704 @end table
8706 @node Agenda commands
8707 @section Commands in the agenda buffer
8708 @cindex commands, in agenda buffer
8710 Entries in the agenda buffer are linked back to the Org file or diary
8711 file where they originate.  You are not allowed to edit the agenda
8712 buffer itself, but commands are provided to show and jump to the
8713 original entry location, and to edit the Org files ``remotely'' from
8714 the agenda buffer.  In this way, all information is stored only once,
8715 removing the risk that your agenda and note files may diverge.
8717 Some commands can be executed with mouse clicks on agenda lines.  For
8718 the other commands, the cursor needs to be in the desired line.
8720 @table @kbd
8721 @tsubheading{Motion}
8722 @cindex motion commands in agenda
8723 @orgcmd{n,org-agenda-next-line}
8724 Next line (same as @key{down} and @kbd{C-n}).
8725 @orgcmd{p,org-agenda-previous-line}
8726 Previous line (same as @key{up} and @kbd{C-p}).
8727 @orgcmd{N,org-agenda-next-item}
8728 Next item: same as next line, but only consider items.
8729 @orgcmd{P,org-agenda-previous-item}
8730 Previous item: same as previous line, but only consider items.
8731 @tsubheading{View/Go to Org file}
8732 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8733 Display the original location of the item in another window.
8734 With prefix arg, make sure that the entire entry is made visible in the
8735 outline, not only the heading.
8737 @orgcmd{L,org-agenda-recenter}
8738 Display original location and recenter that window.
8740 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8741 Go to the original location of the item in another window.
8743 @orgcmd{@key{RET},org-agenda-switch-to}
8744 Go to the original location of the item and delete other windows.
8746 @orgcmd{F,org-agenda-follow-mode}
8747 @vindex org-agenda-start-with-follow-mode
8748 Toggle Follow mode.  In Follow mode, as you move the cursor through
8749 the agenda buffer, the other window always shows the corresponding
8750 location in the Org file.  The initial setting for this mode in new
8751 agenda buffers can be set with the variable
8752 @code{org-agenda-start-with-follow-mode}.
8754 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8755 Display the entire subtree of the current item in an indirect buffer.  With a
8756 numeric prefix argument N, go up to level N and then take that tree.  If N is
8757 negative, go up that many levels.  With a @kbd{C-u} prefix, do not remove the
8758 previously used indirect buffer.
8760 @orgcmd{C-c C-o,org-agenda-open-link}
8761 Follow a link in the entry.  This will offer a selection of any links in the
8762 text belonging to the referenced Org node.  If there is only one link, it
8763 will be followed without a selection prompt.
8765 @tsubheading{Change display}
8766 @cindex display changing, in agenda
8767 @kindex A
8768 @item A
8769 Interactively select another agenda view and append it to the current view.
8771 @kindex o
8772 @item o
8773 Delete other windows.
8775 @orgcmdkskc{v d,d,org-agenda-day-view}
8776 @xorgcmdkskc{v w,w,org-agenda-week-view}
8777 @xorgcmd{v t,org-agenda-fortnight-view}
8778 @xorgcmd{v m,org-agenda-month-view}
8779 @xorgcmd{v y,org-agenda-year-view}
8780 @xorgcmd{v SPC,org-agenda-reset-view}
8781 @vindex org-agenda-span
8782 Switch to day/week/month/year view.  When switching to day or week view, this
8783 setting becomes the default for subsequent agenda refreshes.  Since month and
8784 year views are slow to create, they do not become the default.  A numeric
8785 prefix argument may be used to jump directly to a specific day of the year,
8786 ISO week, month, or year, respectively.  For example, @kbd{32 d} jumps to
8787 February 1st, @kbd{9 w} to ISO week number 9.  When setting day, week, or
8788 month view, a year may be encoded in the prefix argument as well.  For
8789 example, @kbd{200712 w} will jump to week 12 in 2007.  If such a year
8790 specification has only one or two digits, it will be mapped to the interval
8791 1938--2037.  @kbd{v @key{SPC}} will reset to what is set in
8792 @code{org-agenda-span}.
8794 @orgcmd{f,org-agenda-later}
8795 Go forward in time to display the following @code{org-agenda-current-span} days.
8796 For example, if the display covers a week, switch to the following week.
8797 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8799 @orgcmd{b,org-agenda-earlier}
8800 Go backward in time to display earlier dates.
8802 @orgcmd{.,org-agenda-goto-today}
8803 Go to today.
8805 @orgcmd{j,org-agenda-goto-date}
8806 Prompt for a date and go there.
8808 @orgcmd{J,org-agenda-clock-goto}
8809 Go to the currently clocked-in task @i{in the agenda buffer}.
8811 @orgcmd{D,org-agenda-toggle-diary}
8812 Toggle the inclusion of diary entries.  See @ref{Weekly/daily agenda}.
8814 @orgcmdkskc{v l,l,org-agenda-log-mode}
8815 @kindex v L
8816 @vindex org-log-done
8817 @vindex org-agenda-log-mode-items
8818 Toggle Logbook mode.  In Logbook mode, entries that were marked DONE while
8819 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8820 entries that have been clocked on that day.  You can configure the entry
8821 types that should be included in log mode using the variable
8822 @code{org-agenda-log-mode-items}.  When called with a @kbd{C-u} prefix, show
8823 all possible logbook entries, including state changes.  When called with two
8824 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8825 @kbd{v L} is equivalent to @kbd{C-u v l}.
8827 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8828 Include inactive timestamps into the current view.  Only for weekly/daily
8829 agenda and timeline views.
8831 @orgcmd{v a,org-agenda-archives-mode}
8832 @xorgcmd{v A,org-agenda-archives-mode 'files}
8833 Toggle Archives mode.  In Archives mode, trees that are marked
8834 @code{ARCHIVED} are also scanned when producing the agenda.  When you use the
8835 capital @kbd{A}, even all archive files are included.  To exit archives mode,
8836 press @kbd{v a} again.
8838 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8839 @vindex org-agenda-start-with-clockreport-mode
8840 @vindex org-clock-report-include-clocking-task
8841 Toggle Clockreport mode.  In Clockreport mode, the daily/weekly agenda will
8842 always show a table with the clocked times for the time span and file scope
8843 covered by the current agenda view.  The initial setting for this mode in new
8844 agenda buffers can be set with the variable
8845 @code{org-agenda-start-with-clockreport-mode}.  By using a prefix argument
8846 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8847 contributions from entries that are hidden by agenda filtering@footnote{Only
8848 tags filtering will be respected here, effort filtering is ignored.}.  See
8849 also the variable @code{org-clock-report-include-clocking-task}.
8851 @orgkey{v c}
8852 @vindex org-agenda-clock-consistency-checks
8853 Show overlapping clock entries, clocking gaps, and other clocking problems in
8854 the current agenda range.  You can then visit clocking lines and fix them
8855 manually.  See the variable @code{org-agenda-clock-consistency-checks} for
8856 information on how to customize the definition of what constituted a clocking
8857 problem.  To return to normal agenda display, press @kbd{l} to exit Logbook
8858 mode.
8860 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8861 @vindex org-agenda-start-with-entry-text-mode
8862 @vindex org-agenda-entry-text-maxlines
8863 Toggle entry text mode.  In entry text mode, a number of lines from the Org
8864 outline node referenced by an agenda line will be displayed below the line.
8865 The maximum number of lines is given by the variable
8866 @code{org-agenda-entry-text-maxlines}.  Calling this command with a numeric
8867 prefix argument will temporarily modify that number to the prefix value.
8869 @orgcmd{G,org-agenda-toggle-time-grid}
8870 @vindex org-agenda-use-time-grid
8871 @vindex org-agenda-time-grid
8872 Toggle the time grid on and off.  See also the variables
8873 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8875 @orgcmd{r,org-agenda-redo}
8876 Recreate the agenda buffer, for example to reflect the changes after
8877 modification of the timestamps of items with @kbd{S-@key{left}} and
8878 @kbd{S-@key{right}}.  When the buffer is the global TODO list, a prefix
8879 argument is interpreted to create a selective list for a specific TODO
8880 keyword.
8881 @orgcmd{g,org-agenda-redo}
8882 Same as @kbd{r}.
8884 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8885 Save all Org buffers in the current Emacs session, and also the locations of
8886 IDs.
8888 @orgcmd{C-c C-x C-c,org-agenda-columns}
8889 @vindex org-columns-default-format
8890 Invoke column view (@pxref{Column view}) in the agenda buffer.  The column
8891 view format is taken from the entry at point, or (if there is no entry at
8892 point), from the first entry in the agenda view.  So whatever the format for
8893 that entry would be in the original buffer (taken from a property, from a
8894 @code{#+COLUMNS} line, or from the default variable
8895 @code{org-columns-default-format}), will be used in the agenda.
8897 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8898 Remove the restriction lock on the agenda, if it is currently restricted to a
8899 file or subtree (@pxref{Agenda files}).
8901 @tsubheading{Secondary filtering and query editing}
8903 For a detailed description of these commands, see @pxref{Filtering/limiting
8904 agenda items}.
8906 @orgcmd{/,org-agenda-filter-by-tag}
8907 @vindex org-agenda-tag-filter-preset
8908 Filter the agenda view with respect to a tag and/or effort estimates.
8910 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8911 Narrow the current agenda filter by an additional condition.
8913 @orgcmd{<,org-agenda-filter-by-category}
8914 @vindex org-agenda-category-filter-preset
8916 Filter the current agenda view with respect to the category of the item at
8917 point.  Pressing @code{<} another time will remove this filter.
8919 @orgcmd{^,org-agenda-filter-by-top-headline}
8920 Filter the current agenda view and only display the siblings and the parent
8921 headline of the one at point.
8923 @orgcmd{=,org-agenda-filter-by-regexp}
8924 @vindex org-agenda-regexp-filter-preset
8926 Filter the agenda view by a regular expression: only show agenda entries
8927 matching the regular expression the user entered.  When called with a prefix
8928 argument, it will filter @emph{out} entries matching the regexp.  With two
8929 universal prefix arguments, it will remove all the regexp filters, which can
8930 be accumulated.  You can add a filter preset through the option
8931 @code{org-agenda-category-filter-preset} (see below.)
8933 @orgcmd{|,org-agenda-filter-remove-all}
8934 Remove all filters in the current agenda view.
8936 @tsubheading{Remote editing}
8937 @cindex remote editing, from agenda
8939 @item 0--9
8940 Digit argument.
8942 @cindex undoing remote-editing events
8943 @cindex remote editing, undo
8944 @orgcmd{C-_,org-agenda-undo}
8945 Undo a change due to a remote editing command.  The change is undone
8946 both in the agenda buffer and in the remote buffer.
8948 @orgcmd{t,org-agenda-todo}
8949 Change the TODO state of the item, both in the agenda and in the
8950 original org file.
8952 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8953 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8954 Switch to the next/previous set of TODO keywords.
8956 @orgcmd{C-k,org-agenda-kill}
8957 @vindex org-agenda-confirm-kill
8958 Delete the current agenda item along with the entire subtree belonging
8959 to it in the original Org file.  If the text to be deleted remotely
8960 is longer than one line, the kill needs to be confirmed by the user.  See
8961 variable @code{org-agenda-confirm-kill}.
8963 @orgcmd{C-c C-w,org-agenda-refile}
8964 Refile the entry at point.
8966 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8967 @vindex org-archive-default-command
8968 Archive the subtree corresponding to the entry at point using the default
8969 archiving command set in @code{org-archive-default-command}.  When using the
8970 @code{a} key, confirmation will be required.
8972 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8973 Toggle the ARCHIVE tag for the current headline.
8975 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8976 Move the subtree corresponding to the current entry to its @emph{archive
8977 sibling}.
8979 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8980 Archive the subtree corresponding to the current headline.  This means the
8981 entry will be moved to the configured archive location, most likely a
8982 different file.
8984 @orgcmd{T,org-agenda-show-tags}
8985 @vindex org-agenda-show-inherited-tags
8986 Show all tags associated with the current item.  This is useful if you have
8987 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8988 tags of a headline occasionally.
8990 @orgcmd{:,org-agenda-set-tags}
8991 Set tags for the current headline.  If there is an active region in the
8992 agenda, change a tag for all headings in the region.
8994 @kindex ,
8995 @item ,
8996 Set the priority for the current item (@command{org-agenda-priority}).
8997 Org mode prompts for the priority character.  If you reply with @key{SPC},
8998 the priority cookie is removed from the entry.
9000 @orgcmd{P,org-agenda-show-priority}
9001 Display weighted priority of current item.
9003 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
9004 Increase the priority of the current item.  The priority is changed in
9005 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
9006 key for this.
9008 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
9009 Decrease the priority of the current item.
9011 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
9012 @vindex org-log-into-drawer
9013 Add a note to the entry.  This note will be recorded, and then filed to the
9014 same location where state change notes are put.  Depending on
9015 @code{org-log-into-drawer}, this may be inside a drawer.
9017 @orgcmd{C-c C-a,org-attach}
9018 Dispatcher for all command related to attachments.
9020 @orgcmd{C-c C-s,org-agenda-schedule}
9021 Schedule this item.  With prefix arg remove the scheduling timestamp
9023 @orgcmd{C-c C-d,org-agenda-deadline}
9024 Set a deadline for this item.  With prefix arg remove the deadline.
9026 @orgcmd{S-@key{right},org-agenda-do-date-later}
9027 Change the timestamp associated with the current line by one day into the
9028 future.  If the date is in the past, the first call to this command will move
9029 it to today.@*
9030 With a numeric prefix argument, change it by that many days.  For example,
9031 @kbd{3 6 5 S-@key{right}} will change it by a year.  With a @kbd{C-u} prefix,
9032 change the time by one hour.  If you immediately repeat the command, it will
9033 continue to change hours even without the prefix arg.  With a double @kbd{C-u
9034 C-u} prefix, do the same for changing minutes.@*
9035 The stamp is changed in the original Org file, but the change is not directly
9036 reflected in the agenda buffer.  Use @kbd{r} or @kbd{g} to update the buffer.
9038 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
9039 Change the timestamp associated with the current line by one day
9040 into the past.
9042 @orgcmd{>,org-agenda-date-prompt}
9043 Change the timestamp associated with the current line.  The key @kbd{>} has
9044 been chosen, because it is the same as @kbd{S-.}  on my keyboard.
9046 @orgcmd{I,org-agenda-clock-in}
9047 Start the clock on the current item.  If a clock is running already, it
9048 is stopped first.
9050 @orgcmd{O,org-agenda-clock-out}
9051 Stop the previously started clock.
9053 @orgcmd{X,org-agenda-clock-cancel}
9054 Cancel the currently running clock.
9056 @orgcmd{J,org-agenda-clock-goto}
9057 Jump to the running clock in another window.
9059 @orgcmd{k,org-agenda-capture}
9060 Like @code{org-capture}, but use the date at point as the default date for
9061 the capture template.  See @code{org-capture-use-agenda-date} to make this
9062 the default behavior of @code{org-capture}.
9063 @cindex capturing, from agenda
9064 @vindex org-capture-use-agenda-date
9066 @tsubheading{Dragging agenda lines forward/backward}
9067 @cindex dragging, agenda lines
9069 @orgcmd{M-<up>,org-agenda-drag-line-backward}
9070 Drag the line at point backward one line@footnote{Moving agenda lines does
9071 not persist after an agenda refresh and does not modify the contributing
9072 @file{.org} files}.  With a numeric prefix argument, drag backward by that
9073 many lines.
9075 @orgcmd{M-<down>,org-agenda-drag-line-forward}
9076 Drag the line at point forward one line.  With a numeric prefix argument,
9077 drag forward by that many lines.
9079 @tsubheading{Bulk remote editing selected entries}
9080 @cindex remote editing, bulk, from agenda
9081 @vindex org-agenda-bulk-custom-functions
9083 @orgcmd{m,org-agenda-bulk-mark}
9084 Mark the entry at point for bulk action.  With numeric prefix argument, mark
9085 that many successive entries.
9087 @orgcmd{*,org-agenda-bulk-mark-all}
9088 Mark all visible agenda entries for bulk action.
9090 @orgcmd{u,org-agenda-bulk-unmark}
9091 Unmark entry at point for bulk action.
9093 @orgcmd{U,org-agenda-bulk-remove-all-marks}
9094 Unmark all marked entries for bulk action.
9096 @orgcmd{M-m,org-agenda-bulk-toggle}
9097 Toggle mark of the entry at point for bulk action.
9099 @orgcmd{M-*,org-agenda-bulk-toggle-all}
9100 Toggle marks of all visible entries for bulk action.
9102 @orgcmd{%,org-agenda-bulk-mark-regexp}
9103 Mark entries matching a regular expression for bulk action.
9105 @orgcmd{B,org-agenda-bulk-action}
9106 Bulk action: act on all marked entries in the agenda.  This will prompt for
9107 another key to select the action to be applied.  The prefix arg to @kbd{B}
9108 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
9109 these special timestamps.  By default, marks are removed after the bulk.  If
9110 you want them to persist, set @code{org-agenda-persistent-marks} to @code{t}
9111 or hit @kbd{p} at the prompt.
9113 @table @kbd
9114 @item *
9115 Toggle persistent marks.
9116 @item $
9117 Archive all selected entries.
9118 @item A
9119 Archive entries by moving them to their respective archive siblings.
9120 @item t
9121 Change TODO state.  This prompts for a single TODO keyword and changes the
9122 state of all selected entries, bypassing blocking and suppressing logging
9123 notes (but not timestamps).
9124 @item +
9125 Add a tag to all selected entries.
9126 @item -
9127 Remove a tag from all selected entries.
9128 @item s
9129 Schedule all items to a new date.  To shift existing schedule dates by a
9130 fixed number of days, use something starting with double plus at the prompt,
9131 for example @samp{++8d} or @samp{++2w}.
9132 @item d
9133 Set deadline to a specific date.
9134 @item r
9135 Prompt for a single refile target and move all entries.  The entries will no
9136 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9137 @item S
9138 Reschedule randomly into the coming N days.  N will be prompted for.  With
9139 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9140 @item f
9141 Apply a function@footnote{You can also create persistent custom functions
9142 through @code{org-agenda-bulk-custom-functions}.} to marked entries.  For
9143 example, the function below sets the CATEGORY property of the entries to web.
9145 @lisp
9146 @group
9147 (defun set-category ()
9148   (interactive "P")
9149   (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9150                      (org-agenda-error)))
9151          (buffer (marker-buffer marker)))
9152     (with-current-buffer buffer
9153       (save-excursion
9154         (save-restriction
9155           (widen)
9156           (goto-char marker)
9157           (org-back-to-heading t)
9158           (org-set-property "CATEGORY" "web"))))))
9159 @end group
9160 @end lisp
9161 @end table
9163 @tsubheading{Calendar commands}
9164 @cindex calendar commands, from agenda
9166 @orgcmd{c,org-agenda-goto-calendar}
9167 Open the Emacs calendar and move to the date at the agenda cursor.
9169 @orgcmd{c,org-calendar-goto-agenda}
9170 When in the calendar, compute and show the Org mode agenda for the
9171 date at the cursor.
9173 @cindex diary entries, creating from agenda
9174 @orgcmd{i,org-agenda-diary-entry}
9175 @vindex org-agenda-diary-file
9176 Insert a new entry into the diary, using the date at the cursor and (for
9177 block entries) the date at the mark.  This will add to the Emacs diary
9178 file@footnote{This file is parsed for the agenda when
9179 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9180 command in the calendar.  The diary file will pop up in another window, where
9181 you can add the entry.
9183 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9184 Org will create entries (in Org mode syntax) in that file instead.  Most
9185 entries will be stored in a date-based outline tree that will later make it
9186 easy to archive appointments from previous months/years.  The tree will be
9187 built under an entry with a @code{DATE_TREE} property, or else with years as
9188 top-level entries.  Emacs will prompt you for the entry text---if you specify
9189 it, the entry will be created in @code{org-agenda-diary-file} without further
9190 interaction.  If you directly press @key{RET} at the prompt without typing
9191 text, the target file will be shown in another window for you to finish the
9192 entry there.  See also the @kbd{k r} command.
9194 @orgcmd{M,org-agenda-phases-of-moon}
9195 Show the phases of the moon for the three months around current date.
9197 @orgcmd{S,org-agenda-sunrise-sunset}
9198 Show sunrise and sunset times.  The geographical location must be set
9199 with calendar variables, see the documentation for the Emacs calendar.
9201 @orgcmd{C,org-agenda-convert-date}
9202 Convert the date at cursor into many other cultural and historic
9203 calendars.
9205 @orgcmd{H,org-agenda-holidays}
9206 Show holidays for three months around the cursor date.
9208 @item M-x org-icalendar-combine-agenda-files RET
9209 Export a single iCalendar file containing entries from all agenda files.
9210 This is a globally available command, and also available in the agenda menu.
9212 @tsubheading{Exporting to a file}
9213 @orgcmd{C-x C-w,org-agenda-write}
9214 @cindex exporting agenda views
9215 @cindex agenda views, exporting
9216 @vindex org-agenda-exporter-settings
9217 Write the agenda view to a file.  Depending on the extension of the selected
9218 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9219 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9220 (any other extension).  When exporting to Org, only the body of original
9221 headlines are exported, not subtrees or inherited tags.  When called with a
9222 @kbd{C-u} prefix argument, immediately open the newly created file.  Use the
9223 variable @code{org-agenda-exporter-settings} to set options for
9224 @file{ps-print} and for @file{htmlize} to be used during export.
9226 @tsubheading{Quit and Exit}
9227 @orgcmd{q,org-agenda-quit}
9228 Quit agenda, remove the agenda buffer.
9230 @cindex agenda files, removing buffers
9231 @orgcmd{x,org-agenda-exit}
9232 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9233 for the compilation of the agenda.  Buffers created by the user to
9234 visit Org files will not be removed.
9235 @end table
9238 @node Custom agenda views
9239 @section Custom agenda views
9240 @cindex custom agenda views
9241 @cindex agenda views, custom
9243 Custom agenda commands serve two purposes: to store and quickly access
9244 frequently used TODO and tags searches, and to create special composite
9245 agenda buffers.  Custom agenda commands will be accessible through the
9246 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9248 @menu
9249 * Storing searches::            Type once, use often
9250 * Block agenda::                All the stuff you need in a single buffer
9251 * Setting options::             Changing the rules
9252 @end menu
9254 @node Storing searches
9255 @subsection Storing searches
9257 The first application of custom searches is the definition of keyboard
9258 shortcuts for frequently used searches, either creating an agenda
9259 buffer, or a sparse tree (the latter covering of course only the current
9260 buffer).
9261 @kindex C-c a C
9262 @vindex org-agenda-custom-commands
9263 @cindex agenda views, main example
9264 @cindex agenda, as an agenda views
9265 @cindex agenda*, as an agenda views
9266 @cindex tags, as an agenda view
9267 @cindex todo, as an agenda view
9268 @cindex tags-todo
9269 @cindex todo-tree
9270 @cindex occur-tree
9271 @cindex tags-tree
9273 Custom commands are configured in the variable
9274 @code{org-agenda-custom-commands}.  You can customize this variable, for
9275 example by pressing @kbd{C-c a C}.  You can also directly set it with Emacs
9276 Lisp in @file{.emacs}.  The following example contains all valid agenda
9277 views:
9279 @lisp
9280 @group
9281 (setq org-agenda-custom-commands
9282       '(("x" agenda)
9283         ("y" agenda*)
9284         ("w" todo "WAITING")
9285         ("W" todo-tree "WAITING")
9286         ("u" tags "+boss-urgent")
9287         ("v" tags-todo "+boss-urgent")
9288         ("U" tags-tree "+boss-urgent")
9289         ("f" occur-tree "\\<FIXME\\>")
9290         ("h" . "HOME+Name tags searches") ; description for "h" prefix
9291         ("hl" tags "+home+Lisa")
9292         ("hp" tags "+home+Peter")
9293         ("hk" tags "+home+Kim")))
9294 @end group
9295 @end lisp
9297 @noindent
9298 The initial string in each entry defines the keys you have to press
9299 after the dispatcher command @kbd{C-c a} in order to access the command.
9300 Usually this will be just a single character, but if you have many
9301 similar commands, you can also define two-letter combinations where the
9302 first character is the same in several combinations and serves as a
9303 prefix key@footnote{You can provide a description for a prefix key by
9304 inserting a cons cell with the prefix and the description.}.  The second
9305 parameter is the search type, followed by the string or regular
9306 expression to be used for the matching.  The example above will
9307 therefore define:
9309 @table @kbd
9310 @item C-c a x
9311 as a global search for agenda entries planned@footnote{@emph{Planned} means
9312 here that these entries have some planning information attached to them, like
9313 a time-stamp, a scheduled or a deadline string.  See
9314 @code{org-agenda-entry-types} on how to set what planning information will be
9315 taken into account.} this week/day.
9316 @item C-c a y
9317 as a global search for agenda entries planned this week/day, but only those
9318 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9319 @item C-c a w
9320 as a global search for TODO entries with @samp{WAITING} as the TODO
9321 keyword
9322 @item C-c a W
9323 as the same search, but only in the current buffer and displaying the
9324 results as a sparse tree
9325 @item C-c a u
9326 as a global tags search for headlines marked @samp{:boss:} but not
9327 @samp{:urgent:}
9328 @item C-c a v
9329 as the same search as @kbd{C-c a u}, but limiting the search to
9330 headlines that are also TODO items
9331 @item C-c a U
9332 as the same search as @kbd{C-c a u}, but only in the current buffer and
9333 displaying the result as a sparse tree
9334 @item C-c a f
9335 to create a sparse tree (again: current buffer only) with all entries
9336 containing the word @samp{FIXME}
9337 @item C-c a h
9338 as a prefix command for a HOME tags search where you have to press an
9339 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9340 Peter, or Kim) as additional tag to match.
9341 @end table
9343 Note that the @code{*-tree} agenda views need to be called from an
9344 Org buffer as they operate on the current buffer only.
9346 @node Block agenda
9347 @subsection Block agenda
9348 @cindex block agenda
9349 @cindex agenda, with block views
9351 Another possibility is the construction of agenda views that comprise
9352 the results of @emph{several} commands, each of which creates a block in
9353 the agenda buffer.  The available commands include @code{agenda} for the
9354 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9355 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9356 matching commands discussed above: @code{todo}, @code{tags}, and
9357 @code{tags-todo}.  Here are two examples:
9359 @lisp
9360 @group
9361 (setq org-agenda-custom-commands
9362       '(("h" "Agenda and Home-related tasks"
9363          ((agenda "")
9364           (tags-todo "home")
9365           (tags "garden")))
9366         ("o" "Agenda and Office-related tasks"
9367          ((agenda "")
9368           (tags-todo "work")
9369           (tags "office")))))
9370 @end group
9371 @end lisp
9373 @noindent
9374 This will define @kbd{C-c a h} to create a multi-block view for stuff
9375 you need to attend to at home.  The resulting agenda buffer will contain
9376 your agenda for the current week, all TODO items that carry the tag
9377 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
9378 command @kbd{C-c a o} provides a similar view for office tasks.
9380 @node Setting options
9381 @subsection Setting options for custom commands
9382 @cindex options, for custom agenda views
9384 @vindex org-agenda-custom-commands
9385 Org mode contains a number of variables regulating agenda construction
9386 and display.  The global variables define the behavior for all agenda
9387 commands, including the custom commands.  However, if you want to change
9388 some settings just for a single custom view, you can do so.  Setting
9389 options requires inserting a list of variable names and values at the
9390 right spot in @code{org-agenda-custom-commands}.  For example:
9392 @lisp
9393 @group
9394 (setq org-agenda-custom-commands
9395       '(("w" todo "WAITING"
9396          ((org-agenda-sorting-strategy '(priority-down))
9397           (org-agenda-prefix-format "  Mixed: ")))
9398         ("U" tags-tree "+boss-urgent"
9399          ((org-show-context-detail 'minimal)))
9400         ("N" search ""
9401          ((org-agenda-files '("~org/notes.org"))
9402           (org-agenda-text-search-extra-files nil)))))
9403 @end group
9404 @end lisp
9406 @noindent
9407 Now the @kbd{C-c a w} command will sort the collected entries only by
9408 priority, and the prefix format is modified to just say @samp{  Mixed: }
9409 instead of giving the category of the entry.  The sparse tags tree of
9410 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9411 headline hierarchy above the match, nor the headline following the match
9412 will be shown.  The command @kbd{C-c a N} will do a text search limited
9413 to only a single file.
9415 @vindex org-agenda-custom-commands
9416 For command sets creating a block agenda,
9417 @code{org-agenda-custom-commands} has two separate spots for setting
9418 options.  You can add options that should be valid for just a single
9419 command in the set, and options that should be valid for all commands in
9420 the set.  The former are just added to the command entry; the latter
9421 must come after the list of command entries.  Going back to the block
9422 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9423 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9424 the results for GARDEN tags query in the opposite order,
9425 @code{priority-up}.  This would look like this:
9427 @lisp
9428 @group
9429 (setq org-agenda-custom-commands
9430       '(("h" "Agenda and Home-related tasks"
9431          ((agenda)
9432           (tags-todo "home")
9433           (tags "garden"
9434                 ((org-agenda-sorting-strategy '(priority-up)))))
9435          ((org-agenda-sorting-strategy '(priority-down))))
9436         ("o" "Agenda and Office-related tasks"
9437          ((agenda)
9438           (tags-todo "work")
9439           (tags "office")))))
9440 @end group
9441 @end lisp
9443 As you see, the values and parentheses setting is a little complex.
9444 When in doubt, use the customize interface to set this variable---it
9445 fully supports its structure.  Just one caveat: when setting options in
9446 this interface, the @emph{values} are just Lisp expressions.  So if the
9447 value is a string, you need to add the double-quotes around the value
9448 yourself.
9450 @vindex org-agenda-custom-commands-contexts
9451 To control whether an agenda command should be accessible from a specific
9452 context, you can customize @code{org-agenda-custom-commands-contexts}.  Let's
9453 say for example that you have an agenda command @code{"o"} displaying a view
9454 that you only need when reading emails.  Then you would configure this option
9455 like this:
9457 @lisp
9458 (setq org-agenda-custom-commands-contexts
9459       '(("o" (in-mode . "message-mode"))))
9460 @end lisp
9462 You can also tell that the command key @code{"o"} should refer to another
9463 command key @code{"r"}.  In that case, add this command key like this:
9465 @lisp
9466 (setq org-agenda-custom-commands-contexts
9467       '(("o" "r" (in-mode . "message-mode"))))
9468 @end lisp
9470 See the docstring of the variable for more information.
9472 @node Exporting agenda views
9473 @section Exporting agenda views
9474 @cindex agenda views, exporting
9476 If you are away from your computer, it can be very useful to have a printed
9477 version of some agenda views to carry around.  Org mode can export custom
9478 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9479 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9480 ghostscript @file{ps2pdf} utility must be installed on the system.  Selecting
9481 a PDF file will also create the postscript file.}, and iCalendar files.  If
9482 you want to do this only occasionally, use the command
9484 @table @kbd
9485 @orgcmd{C-x C-w,org-agenda-write}
9486 @cindex exporting agenda views
9487 @cindex agenda views, exporting
9488 @vindex org-agenda-exporter-settings
9489 Write the agenda view to a file.  Depending on the extension of the selected
9490 file name, the view will be exported as HTML (extension @file{.html} or
9491 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9492 @file{.ics}), or plain text (any other extension).  Use the variable
9493 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9494 for @file{htmlize} to be used during export, for example
9496 @vindex org-agenda-add-entry-text-maxlines
9497 @vindex htmlize-output-type
9498 @vindex ps-number-of-columns
9499 @vindex ps-landscape-mode
9500 @lisp
9501 (setq org-agenda-exporter-settings
9502       '((ps-number-of-columns 2)
9503         (ps-landscape-mode t)
9504         (org-agenda-add-entry-text-maxlines 5)
9505         (htmlize-output-type 'css)))
9506 @end lisp
9507 @end table
9509 If you need to export certain agenda views frequently, you can associate
9510 any custom agenda command with a list of output file names
9511 @footnote{If you want to store standard views like the weekly agenda
9512 or the global TODO list as well, you need to define custom commands for
9513 them in order to be able to specify file names.}.  Here is an example
9514 that first defines custom commands for the agenda and the global
9515 TODO list, together with a number of files to which to export them.
9516 Then we define two block agenda commands and specify file names for them
9517 as well.  File names can be relative to the current working directory,
9518 or absolute.
9520 @lisp
9521 @group
9522 (setq org-agenda-custom-commands
9523       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9524         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9525         ("h" "Agenda and Home-related tasks"
9526          ((agenda "")
9527           (tags-todo "home")
9528           (tags "garden"))
9529          nil
9530          ("~/views/home.html"))
9531         ("o" "Agenda and Office-related tasks"
9532          ((agenda)
9533           (tags-todo "work")
9534           (tags "office"))
9535          nil
9536          ("~/views/office.ps" "~/calendars/office.ics"))))
9537 @end group
9538 @end lisp
9540 The extension of the file name determines the type of export.  If it is
9541 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9542 the buffer to HTML and save it to this file name.  If the extension is
9543 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9544 Postscript output.  If the extension is @file{.ics}, iCalendar export is
9545 run export over all files that were used to construct the agenda, and
9546 limit the export to entries listed in the agenda.  Any other
9547 extension produces a plain ASCII file.
9549 The export files are @emph{not} created when you use one of those
9550 commands interactively because this might use too much overhead.
9551 Instead, there is a special command to produce @emph{all} specified
9552 files in one step:
9554 @table @kbd
9555 @orgcmd{C-c a e,org-store-agenda-views}
9556 Export all agenda views that have export file names associated with
9557 them.
9558 @end table
9560 You can use the options section of the custom agenda commands to also
9561 set options for the export commands.  For example:
9563 @lisp
9564 (setq org-agenda-custom-commands
9565       '(("X" agenda ""
9566          ((ps-number-of-columns 2)
9567           (ps-landscape-mode t)
9568           (org-agenda-prefix-format " [ ] ")
9569           (org-agenda-with-colors nil)
9570           (org-agenda-remove-tags t))
9571          ("theagenda.ps"))))
9572 @end lisp
9574 @noindent
9575 This command sets two options for the Postscript exporter, to make it
9576 print in two columns in landscape format---the resulting page can be cut
9577 in two and then used in a paper agenda.  The remaining settings modify
9578 the agenda prefix to omit category and scheduling information, and
9579 instead include a checkbox to check off items.  We also remove the tags
9580 to make the lines compact, and we don't want to use colors for the
9581 black-and-white printer.  Settings specified in
9582 @code{org-agenda-exporter-settings} will also apply, but the settings
9583 in @code{org-agenda-custom-commands} take precedence.
9585 @noindent
9586 From the command line you may also use
9587 @example
9588 emacs -eval (org-batch-store-agenda-views) -kill
9589 @end example
9590 @noindent
9591 or, if you need to modify some parameters@footnote{Quoting depends on the
9592 system you use, please check the FAQ for examples.}
9593 @example
9594 emacs -eval '(org-batch-store-agenda-views                      \
9595               org-agenda-span (quote month)                     \
9596               org-agenda-start-day "2007-11-01"                 \
9597               org-agenda-include-diary nil                      \
9598               org-agenda-files (quote ("~/org/project.org")))'  \
9599       -kill
9600 @end example
9601 @noindent
9602 which will create the agenda views restricted to the file
9603 @file{~/org/project.org}, without diary entries and with a 30-day
9604 extent.
9606 You can also extract agenda information in a way that allows further
9607 processing by other programs.  See @ref{Extracting agenda information}, for
9608 more information.
9611 @node Agenda column view
9612 @section Using column view in the agenda
9613 @cindex column view, in agenda
9614 @cindex agenda, column view
9616 Column view (@pxref{Column view}) is normally used to view and edit
9617 properties embedded in the hierarchical structure of an Org file.  It can be
9618 quite useful to use column view also from the agenda, where entries are
9619 collected by certain criteria.
9621 @table @kbd
9622 @orgcmd{C-c C-x C-c,org-agenda-columns}
9623 Turn on column view in the agenda.
9624 @end table
9626 To understand how to use this properly, it is important to realize that the
9627 entries in the agenda are no longer in their proper outline environment.
9628 This causes the following issues:
9630 @enumerate
9631 @item
9632 @vindex org-columns-default-format
9633 @vindex org-overriding-columns-format
9634 Org needs to make a decision which @code{COLUMNS} format to use.  Since the
9635 entries in the agenda are collected from different files, and different files
9636 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9637 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9638 currently set, and if so, takes the format from there.  Otherwise it takes
9639 the format associated with the first item in the agenda, or, if that item
9640 does not have a specific format (defined in a property, or in its file), it
9641 uses @code{org-columns-default-format}.
9642 @item
9643 @cindex property, special, CLOCKSUM
9644 If any of the columns has a summary type defined (@pxref{Column attributes}),
9645 turning on column view in the agenda will visit all relevant agenda files and
9646 make sure that the computations of this property are up to date.  This is
9647 also true for the special @code{CLOCKSUM} property.  Org will then sum the
9648 values displayed in the agenda.  In the daily/weekly agenda, the sums will
9649 cover a single day; in all other views they cover the entire block.  It is
9650 vital to realize that the agenda may show the same entry @emph{twice} (for
9651 example as scheduled and as a deadline), and it may show two entries from the
9652 same hierarchy (for example a @emph{parent} and its @emph{child}).  In these
9653 cases, the summation in the agenda will lead to incorrect results because
9654 some values will count double.
9655 @item
9656 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9657 the entire clocked time for this item.  So even in the daily/weekly agenda,
9658 the clocksum listed in column view may originate from times outside the
9659 current view.  This has the advantage that you can compare these values with
9660 a column listing the planned total effort for a task---one of the major
9661 applications for column view in the agenda.  If you want information about
9662 clocked time in the displayed period use clock table mode (press @kbd{R} in
9663 the agenda).
9665 @item
9666 @cindex property, special, CLOCKSUM_T
9667 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9668 always today's clocked time for this item.  So even in the weekly agenda,
9669 the clocksum listed in column view only originates from today.  This lets
9670 you compare the time you spent on a task for today, with the time already
9671 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9672 @end enumerate
9675 @node Markup
9676 @chapter Markup for rich export
9678 When exporting Org mode documents, the exporter tries to reflect the
9679 structure of the document as accurately as possible in the back-end.  Since
9680 export targets like HTML and @LaTeX{} allow much richer formatting, Org mode has
9681 rules on how to prepare text for rich export.  This section summarizes the
9682 markup rules used in an Org mode buffer.
9684 @menu
9685 * Structural markup elements::  The basic structure as seen by the exporter
9686 * Images and tables::           Images, tables and caption mechanism
9687 * Literal examples::            Source code examples with special formatting
9688 * Include files::               Include additional files into a document
9689 * Index entries::               Making an index
9690 * Macro replacement::           Use macros to create templates
9691 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
9692 * Special blocks::              Containers targeted at export back-ends
9693 @end menu
9695 @node Structural markup elements
9696 @section Structural markup elements
9698 @menu
9699 * Document title::              Where the title is taken from
9700 * Headings and sections::       The document structure as seen by the exporter
9701 * Table of contents::           The if and where of the table of contents
9702 * Lists::                       Lists
9703 * Paragraphs::                  Paragraphs
9704 * Footnote markup::             Footnotes
9705 * Emphasis and monospace::      Bold, italic, etc.
9706 * Horizontal rules::            Make a line
9707 * Comment lines::               What will *not* be exported
9708 @end menu
9710 @node Document title
9711 @subheading Document title
9712 @cindex document title, markup rules
9714 @noindent
9715 The title of the exported document is taken from the special line
9717 @cindex #+TITLE
9718 @example
9719 #+TITLE: This is the title of the document
9720 @end example
9722 @cindex property, EXPORT_TITLE
9723 If you are exporting only a subtree, its heading will become the title of the
9724 document.  If the subtree has a property @code{EXPORT_TITLE}, that will take
9725 precedence.
9727 @node Headings and sections
9728 @subheading Headings and sections
9729 @cindex headings and sections, markup rules
9731 @vindex org-export-headline-levels
9732 The outline structure of the document as described in @ref{Document
9733 structure}, forms the basis for defining sections of the exported document.
9734 However, since the outline structure is also used for (for example) lists of
9735 tasks, only the first three outline levels will be used as headings.  Deeper
9736 levels will become itemized lists.  You can change the location of this
9737 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9738 per-file basis with a line
9740 @cindex #+OPTIONS
9741 @example
9742 #+OPTIONS: H:4
9743 @end example
9745 @node Table of contents
9746 @subheading Table of contents
9747 @cindex table of contents, markup rules
9749 @cindex #+TOC
9750 @vindex org-export-with-toc
9751 The table of contents is normally inserted directly before the first headline
9752 of the file.  The depth of the table is by default the same as the number of
9753 headline levels, but you can choose a smaller number, or turn off the table
9754 of contents entirely, by configuring the variable @code{org-export-with-toc},
9755 or on a per-file basis with a line like
9757 @example
9758 #+OPTIONS: toc:2          @r{only inlcude two levels in TOC}
9759 #+OPTIONS: toc:nil        @r{no default TOC at all}
9760 @end example
9762 If you would like to move the table of contents to a different location, you
9763 should turn off the default table using @code{org-export-with-toc} or
9764 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9765 location(s).
9767 @example
9768 #+OPTIONS: toc:nil        @r{no default TOC}
9770 #+TOC: headlines 2        @r{insert TOC here, with two headline levels}
9771 @end example
9773 Moreover, if you append @samp{local} parameter, the table contains only
9774 entries for the children of the current section@footnote{For @LaTeX{} export,
9775 this feature requires the @code{titletoc} package.  Note that @code{titletoc}
9776 must be loaded @emph{before} @code{hyperref}.  Thus, you may have to
9777 customize @code{org-latex-default-packages-alist}.}.  In this case, any depth
9778 parameter becomes relative to the current level.
9780 @example
9781 * Section
9782 #+TOC: headlines 1 local  @r{insert local TOC, with direct children only}
9783 @end example
9785 The same @code{TOC} keyword can also generate a list of all tables (resp.@:
9786 all listings) with a caption in the document.
9788 @example
9789 #+TOC: listings           @r{build a list of listings}
9790 #+TOC: tables             @r{build a list of tables}
9791 @end example
9793 @cindex property, ALT_TITLE
9794 The headline's title usually determines its corresponding entry in a table of
9795 contents.  However, it is possible to specify an alternative title by
9796 setting @code{ALT_TITLE} property accordingly.  It will then be used when
9797 building the table.
9799 @node Lists
9800 @subheading Lists
9801 @cindex lists, markup rules
9803 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9804 syntax for such lists.  Most back-ends support unordered, ordered, and
9805 description lists.
9807 @node Paragraphs
9808 @subheading Paragraphs, line breaks, and quoting
9809 @cindex paragraphs, markup rules
9811 Paragraphs are separated by at least one empty line.  If you need to enforce
9812 a line break within a paragraph, use @samp{\\} at the end of a line.
9814 To keep the line breaks in a region, but otherwise use normal formatting, you
9815 can use this construct, which can also be used to format poetry.
9817 @cindex #+BEGIN_VERSE
9818 @example
9819 #+BEGIN_VERSE
9820  Great clouds overhead
9821  Tiny black birds rise and fall
9822  Snow covers Emacs
9824      -- AlexSchroeder
9825 #+END_VERSE
9826 @end example
9828 When quoting a passage from another document, it is customary to format this
9829 as a paragraph that is indented on both the left and the right margin.  You
9830 can include quotations in Org mode documents like this:
9832 @cindex #+BEGIN_QUOTE
9833 @example
9834 #+BEGIN_QUOTE
9835 Everything should be made as simple as possible,
9836 but not any simpler -- Albert Einstein
9837 #+END_QUOTE
9838 @end example
9840 If you would like to center some text, do it like this:
9841 @cindex #+BEGIN_CENTER
9842 @example
9843 #+BEGIN_CENTER
9844 Everything should be made as simple as possible, \\
9845 but not any simpler
9846 #+END_CENTER
9847 @end example
9850 @node Footnote markup
9851 @subheading Footnote markup
9852 @cindex footnotes, markup rules
9853 @cindex @file{footnote.el}
9855 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9856 by all back-ends.  Org allows multiple references to the same note, and
9857 multiple footnotes side by side.
9859 @node Emphasis and monospace
9860 @subheading Emphasis and monospace
9862 @cindex underlined text, markup rules
9863 @cindex bold text, markup rules
9864 @cindex italic text, markup rules
9865 @cindex verbatim text, markup rules
9866 @cindex code text, markup rules
9867 @cindex strike-through text, markup rules
9868 @vindex org-fontify-emphasized-text
9869 @vindex org-emphasis-regexp-components
9870 @vindex org-emphasis-alist
9871 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9872 and @code{~code~}, and, if you must, @samp{+strike-through+}.  Text
9873 in the code and verbatim string is not processed for Org mode specific
9874 syntax, it is exported verbatim.
9876 To turn off fontification for marked up text, you can set
9877 @code{org-fontify-emphasized-text} to @code{nil}.  To narrow down the list of
9878 available markup syntax, you can customize @code{org-emphasis-alist}.  To fine
9879 tune what characters are allowed before and after the markup characters, you
9880 can tweak @code{org-emphasis-regexp-components}.  Beware that changing one of
9881 the above variables will no take effect until you reload Org, for which you
9882 may need to restart Emacs.
9884 @node Horizontal rules
9885 @subheading  Horizontal rules
9886 @cindex horizontal rules, markup rules
9887 A line consisting of only dashes, and at least 5 of them, will be exported as
9888 a horizontal line.
9890 @node Comment lines
9891 @subheading Comment lines
9892 @cindex comment lines
9893 @cindex exporting, not
9894 @cindex #+BEGIN_COMMENT
9896 Lines starting with zero or more whitespace characters followed by one
9897 @samp{#} and a whitespace are treated as comments and, as such, are not
9898 exported.
9900 Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
9901 ... @samp{#+END_COMMENT} are not exported.
9903 Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
9904 other keyword or priority cookie, comments out the entire subtree.  In this
9905 case, the subtree is not exported and no code block within it is executed
9906 either@footnote{For a less drastic behavior, consider using a select tag
9907 (@pxref{Export settings}) instead.}.  The command below helps changing the
9908 comment status of a headline.
9910 @table @kbd
9911 @kindex C-c ;
9912 @item C-c ;
9913 Toggle the @samp{COMMENT} keyword at the beginning of an entry.
9914 @end table
9917 @node Images and tables
9918 @section Images and Tables
9920 @cindex tables, markup rules
9921 @cindex #+CAPTION
9922 @cindex #+NAME
9923 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9924 the @file{table.el} package will be exported properly.  For Org mode tables,
9925 the lines before the first horizontal separator line will become table header
9926 lines.  You can use the following lines somewhere before the table to assign
9927 a caption and a label for cross references, and in the text you can refer to
9928 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9930 @example
9931 #+CAPTION: This is the caption for the next table (or link)
9932 #+NAME:   tab:basic-data
9933    | ... | ...|
9934    |-----|----|
9935 @end example
9937 Optionally, the caption can take the form:
9938 @example
9939 #+CAPTION[Caption for list of tables]: Caption for table.
9940 @end example
9942 @cindex inlined images, markup rules
9943 Some back-ends allow you to directly include images into the exported
9944 document.  Org does this, if a link to an image files does not have
9945 a description part, for example @code{[[./img/a.jpg]]}.  If you wish to
9946 define a caption for the image and maybe a label for internal cross
9947 references, make sure that the link is on a line by itself and precede it
9948 with @code{#+CAPTION} and @code{#+NAME} as follows:
9950 @example
9951 #+CAPTION: This is the caption for the next figure link (or table)
9952 #+NAME:   fig:SED-HR4049
9953 [[./img/a.jpg]]
9954 @end example
9956 @noindent
9957 Such images can be displayed within the buffer.  @xref{Handling links,the
9958 discussion of image links}.
9960 Even though images and tables are prominent examples of captioned structures,
9961 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9962 equations, source code blocks).  Depending on the export back-end, those may
9963 or may not be handled.
9965 @node Literal examples
9966 @section Literal examples
9967 @cindex literal examples, markup rules
9968 @cindex code line references, markup rules
9970 You can include literal examples that should not be subjected to
9971 markup.  Such examples will be typeset in monospace, so this is well suited
9972 for source code and similar examples.
9973 @cindex #+BEGIN_EXAMPLE
9975 @example
9976 #+BEGIN_EXAMPLE
9977 Some example from a text file.
9978 #+END_EXAMPLE
9979 @end example
9981 Note that such blocks may be @i{indented} in order to align nicely with
9982 indented text and in particular with plain list structure (@pxref{Plain
9983 lists}).  For simplicity when using small examples, you can also start the
9984 example lines with a colon followed by a space.  There may also be additional
9985 whitespace before the colon:
9987 @example
9988 Here is an example
9989    : Some example from a text file.
9990 @end example
9992 @cindex formatting source code, markup rules
9993 @vindex org-latex-listings
9994 If the example is source code from a programming language, or any other text
9995 that can be marked up by font-lock in Emacs, you can ask for the example to
9996 look like the fontified Emacs buffer@footnote{This works automatically for
9997 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9998 which is distributed with Org).  Fontified code chunks in @LaTeX{} can be
9999 achieved using either the listings or the
10000 @url{http://code.google.com/p/minted, minted,} package.  Refer to
10001 @code{org-latex-listings} documentation for details.}.  This is done
10002 with the @samp{src} block, where you also need to specify the name of the
10003 major mode that should be used to fontify the example@footnote{Code in
10004 @samp{src} blocks may also be evaluated either interactively or on export.
10005 See @pxref{Working with source code} for more information on evaluating code
10006 blocks.}, see @ref{Easy templates} for shortcuts to easily insert code
10007 blocks.
10008 @cindex #+BEGIN_SRC
10010 @example
10011 #+BEGIN_SRC emacs-lisp
10012   (defun org-xor (a b)
10013      "Exclusive or."
10014      (if a (not b) b))
10015 #+END_SRC
10016 @end example
10018 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
10019 switch to the end of the @code{BEGIN} line, to get the lines of the example
10020 numbered.  If you use a @code{+n} switch, the numbering from the previous
10021 numbered snippet will be continued in the current one.  In literal examples,
10022 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
10023 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
10024 enclosed in single parenthesis).  In HTML, hovering the mouse over such a
10025 link will remote-highlight the corresponding code line, which is kind of
10026 cool.
10028 You can also add a @code{-r} switch which @i{removes} the labels from the
10029 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
10030 labels in the source code while using line numbers for the links, which might
10031 be useful to explain those in an Org mode example code.}.  With the @code{-n}
10032 switch, links to these references will be labeled by the line numbers from
10033 the code listing, otherwise links will use the labels with no parentheses.
10034 Here is an example:
10036 @example
10037 #+BEGIN_SRC emacs-lisp -n -r
10038 (save-excursion                  (ref:sc)
10039    (goto-char (point-min)))      (ref:jump)
10040 #+END_SRC
10041 In line [[(sc)]] we remember the current position.  [[(jump)][Line (jump)]]
10042 jumps to point-min.
10043 @end example
10045 @cindex indentation, in source blocks
10046 Finally, you can use @code{-i} to preserve the indentation of a specific code
10047 block (@pxref{Editing source code}).
10049 @vindex org-coderef-label-format
10050 If the syntax for the label format conflicts with the language syntax, use a
10051 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
10052 -n -r -l "((%s))"}.  See also the variable @code{org-coderef-label-format}.
10054 HTML export also allows examples to be published as text areas (@pxref{Text
10055 areas in HTML export}).
10057 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
10058 so often, shortcuts are provided using the Easy templates facility
10059 (@pxref{Easy templates}).
10061 @table @kbd
10062 @kindex C-c '
10063 @item C-c '
10064 Edit the source code example at point in its native mode.  This works by
10065 switching to a temporary buffer with the source code.  You need to exit by
10066 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
10067 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
10068 from being interpreted by Org as outline nodes or special syntax.  These
10069 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
10070 The edited version will then replace the old version in the Org buffer.
10071 Fixed-width regions (where each line starts with a colon followed by a space)
10072 will be edited using @code{artist-mode}@footnote{You may select
10073 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
10074 to allow creating ASCII drawings easily.  Using this command in an empty line
10075 will create a new fixed-width region.
10076 @kindex C-c l
10077 @item C-c l
10078 Calling @code{org-store-link} while editing a source code example in a
10079 temporary buffer created with @kbd{C-c '} will prompt for a label.  Make sure
10080 that it is unique in the current buffer, and insert it with the proper
10081 formatting like @samp{(ref:label)} at the end of the current line.  Then the
10082 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
10083 @end table
10086 @node Include files
10087 @section Include files
10088 @cindex include files, markup rules
10090 During export, you can include the content of another file.  For example, to
10091 include your @file{.emacs} file, you could use:
10092 @cindex #+INCLUDE
10094 @example
10095 #+INCLUDE: "~/.emacs" src emacs-lisp
10096 @end example
10098 @noindent
10099 The first parameter names the the file to include.  The optional second and
10100 third parameter specify the markup (i.e., @samp{example} or @samp{src}), and,
10101 if the markup is @samp{src}, the language for formatting the contents.
10103 If markup is requested, the included content will be placed within an
10104 appropriate block@footnote{While you can request paragraphs (@samp{verse},
10105 @samp{quote}, @samp{center}), but this places severe restrictions on the type
10106 of content that is permissible}.  No changes to the included content are made
10107 and it is the responsibility of the user to ensure that the result is valid
10108 Org syntax.  For markup @samp{example} and @samp{src}, which is requesting a
10109 literal example, the content will be code-escaped before inclusion.
10111 If no markup is requested, the text will be assumed to be in Org mode format
10112 and will be processed normally.  However, footnote labels (@pxref{Footnotes})
10113 in the file will be made local to that file.  Contents of the included file
10114 will belong to the same structure (headline, item) containing the
10115 @code{INCLUDE} keyword.  In particular, headlines within the file will become
10116 children of the current section.  That behavior can be changed by providing
10117 an additional keyword parameter, @code{:minlevel}.  In that case, all
10118 headlines in the included file will be shifted so the one with the lowest
10119 level reaches that specified level.  For example, to make a file become a
10120 sibling of the current top-level headline, use
10122 @example
10123 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
10124 @end example
10126 You can also include a portion of a file by specifying a lines range using
10127 the @code{:lines} keyword parameter.  The line at the upper end of the range
10128 will not be included.  The start and/or the end of the range may be omitted
10129 to use the obvious defaults.
10131 @example
10132 #+INCLUDE: "~/.emacs" :lines "5-10"   @r{Include lines 5 to 10, 10 excluded}
10133 #+INCLUDE: "~/.emacs" :lines "-10"    @r{Include lines 1 to 10, 10 excluded}
10134 #+INCLUDE: "~/.emacs" :lines "10-"    @r{Include lines from 10 to EOF}
10135 @end example
10137 Finally, you may use a file-link to extract an object as matched by
10138 @code{org-link-search}@footnote{Note that
10139 @code{org-link-search-must-match-exact-headline} is locally bound to non-@code{nil}.
10140 Therefore, @code{org-link-search} only matches headlines and named elements.}
10141 (@pxref{Search options}).  If the @code{:only-contents} property is non-@code{nil},
10142 only the contents of the requested element will be included, omitting
10143 properties drawer and planning-line if present.  The @code{:lines} keyword
10144 operates locally with respect to the requested element.  Some examples:
10146 @example
10147 #+INCLUDE: "./paper.org::#theory" :only-contents t
10148    @r{Include the body of the heading with the custom id @code{theory}}
10149 #+INCLUDE: "./paper.org::mytable"  @r{Include named element.}
10150 #+INCLUDE: "./paper.org::*conclusion" :lines 1-20
10151    @r{Include the first 20 lines of the headline named conclusion.}
10152 @end example
10154 @table @kbd
10155 @kindex C-c '
10156 @item C-c '
10157 Visit the include file at point.
10158 @end table
10160 @node Index entries
10161 @section Index entries
10162 @cindex index entries, for publishing
10164 You can specify entries that will be used for generating an index during
10165 publishing.  This is done by lines starting with @code{#+INDEX}.  An entry
10166 the contains an exclamation mark will create a sub item.  See @ref{Generating
10167 an index} for more information.
10169 @example
10170 * Curriculum Vitae
10171 #+INDEX: CV
10172 #+INDEX: Application!CV
10173 @end example
10177 @node Macro replacement
10178 @section Macro replacement
10179 @cindex macro replacement, during export
10180 @cindex #+MACRO
10182 You can define text snippets with
10184 @example
10185 #+MACRO: name   replacement text $1, $2 are arguments
10186 @end example
10188 @noindent which can be referenced
10189 @code{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate arguments,
10190 commas within arguments have to be escaped with a backslash character.
10191 Conversely, backslash characters before a comma, and only them, need to be
10192 escaped with another backslash character.}.
10194 These references, called macros, can be inserted anywhere Org markup is
10195 recognized: paragraphs, headlines, verse blocks, tables cells and lists.
10196 They can also be used in keywords accepting Org syntax, e.g.,
10197 @code{#+CAPTION}, @code{#+TITLE}, @code{#+AUTHOR}, @code{#+DATE} and some
10198 others, export back-end specific, ones.
10200 In addition to user-defined macros, a set of predefined macros can be used:
10202 @table @code
10203 @item @{@{@{title@}@}@}
10204 @itemx @{@{@{author@}@}@}
10205 @itemx @{@{@{email@}@}@}
10206 @cindex title, macro
10207 @cindex author, macro
10208 @cindex email, macro
10209 These macros are replaced with the information available at the time of
10210 export.
10212 @item @{@{@{date@}@}@}
10213 @itemx @{@{@{date(@var{FORMAT})@}@}@}
10214 @itemx @{@{@{time(@var{FORMAT})@}@}@}
10215 @itemx @{@{@{modification-time(@var{FORMAT})@}@}@}
10216 @cindex date, macro
10217 @cindex time, macro
10218 @cindex modification time, macro
10219 These macros refer to the @code{#+DATE} keyword, the current date, and the
10220 modification time of the file being exported, respectively.  @var{FORMAT}
10221 should be a format string understood by @code{format-time-string}.  Note that
10222 @var{FORMAT} is an optional argument to the @code{@{@{@{date@}@}@}} macro,
10223 and that it will only be used if @code{#+DATE} is a single timestamp.
10225 @item @{@{@{input-file@}@}@}
10226 @cindex input file, macro
10227 This macro refers to the filename of the exported file, if any.
10229 @item @{@{@{property(@var{PROPERTY-NAME})@}@}@}
10230 @itemx @{@{@{property(@var{PROPERTY-NAME},@var{SEARCH-OPTION})@}@}@}
10231 @cindex property, macro
10232 This macro returns the value of property @var{PROPERTY-NAME} in current
10233 entry.  If @var{SEARCH-OPTION} (@pxref{Search options}) refers to a remote
10234 entry, it will be used instead.
10235 @end table
10237 The surrounding brackets can be made invisible by setting
10238 @code{org-hide-macro-markers} non-@code{nil}.
10240 Macro expansion takes place during the very beginning of the export process.
10243 @node Embedded @LaTeX{}
10244 @section Embedded @LaTeX{}
10245 @cindex @TeX{} interpretation
10246 @cindex @LaTeX{} interpretation
10248 Plain ASCII is normally sufficient for almost all note taking.  Exceptions
10249 include scientific notes, which often require mathematical symbols and the
10250 occasional formula.  @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10251 Donald E. Knuth's @TeX{} system.  Many of the features described here as
10252 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10253 distinction.}  is widely used to typeset scientific documents.  Org mode
10254 supports embedding @LaTeX{} code into its files, because many academics are
10255 used to writing and reading @LaTeX{} source code, and because it can be
10256 readily processed to produce pretty output for a number of export back-ends.
10258 @menu
10259 * Special symbols::             Greek letters and other symbols
10260 * Subscripts and superscripts::  Simple syntax for raising/lowering text
10261 * @LaTeX{} fragments::          Complex formulas made easy
10262 * Previewing @LaTeX{} fragments::  What will this snippet look like?
10263 * CDLaTeX mode::                Speed up entering of formulas
10264 @end menu
10266 @node Special symbols
10267 @subsection Special symbols
10268 @cindex math symbols
10269 @cindex special symbols
10270 @cindex @TeX{} macros
10271 @cindex @LaTeX{} fragments, markup rules
10272 @cindex HTML entities
10273 @cindex @LaTeX{} entities
10275 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10276 to indicate the Greek letter, or @samp{\to} to indicate an arrow.  Completion
10277 for these symbols is available, just type @samp{\} and maybe a few letters,
10278 and press @kbd{M-@key{TAB}} to see possible completions.  Unlike @LaTeX{}
10279 code, Org mode allows these symbols to be present without surrounding math
10280 delimiters, for example:
10282 @example
10283 Angles are written as Greek letters \alpha, \beta and \gamma.
10284 @end example
10286 @vindex org-entities
10287 During export, these symbols will be transformed into the native format of
10288 the exporter back-end.  Strings like @code{\alpha} will be exported as
10289 @code{&alpha;} in the HTML output, and as @code{\(\alpha\)} in the @LaTeX{}
10290 output.  Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
10291 @code{~} in @LaTeX{}.  If you need such a symbol inside a word, terminate it
10292 like this: @samp{\Aacute@{@}stor}.
10294 A large number of entities is provided, with names taken from both HTML and
10295 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10296 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10297 @samp{...} are all converted into special commands creating hyphens of
10298 different lengths or a compact set of dots.
10300 If you would like to see entities displayed as UTF-8 characters, use the
10301 following command@footnote{You can turn this on by default by setting the
10302 variable @code{org-pretty-entities}, or on a per-file base with the
10303 @code{#+STARTUP} option @code{entitiespretty}.}:
10305 @table @kbd
10306 @cindex @code{entitiespretty}, STARTUP keyword
10307 @kindex C-c C-x \
10308 @item C-c C-x \
10309 Toggle display of entities as UTF-8 characters.  This does not change the
10310 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10311 for display purposes only.
10312 @end table
10314 @node Subscripts and superscripts
10315 @subsection Subscripts and superscripts
10316 @cindex subscript
10317 @cindex superscript
10319 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10320 subscripts.  Again, these can be used without embedding them in math-mode
10321 delimiters.  To increase the readability of ASCII text, it is not necessary
10322 (but OK) to surround multi-character sub- and superscripts with curly braces.
10323 For example
10325 @example
10326 The mass of the sun is M_sun = 1.989 x 10^30 kg.  The radius of
10327 the sun is R_@{sun@} = 6.96 x 10^8 m.
10328 @end example
10330 @vindex org-use-sub-superscripts
10331 If you write a text where the underscore is often used in a different
10332 context, Org's convention to always interpret these as subscripts can get in
10333 your way.  Configure the variable @code{org-use-sub-superscripts} to change
10334 this convention.  For example, when setting this variable to @code{@{@}},
10335 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10337 @table @kbd
10338 @kindex C-c C-x \
10339 @item C-c C-x \
10340 In addition to showing entities as UTF-8 characters, this command will also
10341 format sub- and superscripts in a WYSIWYM way.
10342 @end table
10344 @node @LaTeX{} fragments
10345 @subsection @LaTeX{} fragments
10346 @cindex @LaTeX{} fragments
10348 @vindex org-format-latex-header
10349 Going beyond symbols and sub- and superscripts, a full formula language is
10350 needed.  Org mode can contain @LaTeX{} math fragments, and it supports ways
10351 to process these for several export back-ends.  When exporting to @LaTeX{},
10352 the code is left as it is.  When exporting to HTML, Org can use either
10353 @uref{http://www.mathjax.org, MathJax} (@pxref{Math formatting in HTML
10354 export}) or transcode the math into images (see @pxref{Previewing @LaTeX{}
10355 fragments}).
10357 @LaTeX{} fragments don't need any special marking at all.  The following
10358 snippets will be identified as @LaTeX{} source code:
10359 @itemize @bullet
10360 @item
10361 Environments of any kind@footnote{When MathJax is used, only the
10362 environments recognized by MathJax will be processed.  When
10363 @file{dvipng} program or @file{imagemagick} suite is used to create images,
10364 any @LaTeX{} environment will be handled.}.  The only requirement is that the
10365 @code{\begin} statement appears on a new line, at the beginning of the line
10366 or after whitespaces only.
10367 @item
10368 Text within the usual @LaTeX{} math delimiters.  To avoid conflicts with
10369 currency specifications, single @samp{$} characters are only recognized as
10370 math delimiters if the enclosed text contains at most two line breaks, is
10371 directly attached to the @samp{$} characters with no whitespace in between,
10372 and if the closing @samp{$} is followed by whitespace or punctuation
10373 (parentheses and quotes are considered to be punctuation in this
10374 context).  For the other delimiters, there is no such restriction, so when in
10375 doubt, use @samp{\(...\)} as inline math delimiters.
10376 @end itemize
10378 @noindent For example:
10380 @example
10381 \begin@{equation@}
10382 x=\sqrt@{b@}
10383 \end@{equation@}
10385 If $a^2=b$ and \( b=2 \), then the solution must be
10386 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10387 @end example
10389 @c FIXME
10390 @c @noindent
10391 @c @vindex org-format-latex-options
10392 @c If you need any of the delimiter ASCII sequences for other purposes, you
10393 @c can configure the option @code{org-format-latex-options} to deselect the
10394 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10396 @vindex org-export-with-latex
10397 @LaTeX{} processing can be configured with the variable
10398 @code{org-export-with-latex}.  The default setting is @code{t} which means
10399 MathJax for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10400 You can also set this variable on a per-file basis using one of these
10401 lines:
10403 @example
10404 #+OPTIONS: tex:t          @r{Do the right thing automatically (MathJax)}
10405 #+OPTIONS: tex:nil        @r{Do not process @LaTeX{} fragments at all}
10406 #+OPTIONS: tex:verbatim   @r{Verbatim export, for jsMath or so}
10407 @end example
10409 @node Previewing @LaTeX{} fragments
10410 @subsection Previewing @LaTeX{} fragments
10411 @cindex @LaTeX{} fragments, preview
10413 @vindex org-latex-create-formula-image-program
10414 If you have a working @LaTeX{} installation and either @file{dvipng} or
10415 @file{convert} installed@footnote{These are respectively available at
10416 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10417 suite. Choose the converter by setting the variable
10418 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10419 fragments can be processed to produce images of the typeset expressions to be
10420 used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
10421 or for inline previewing within Org mode.
10423 @vindex org-format-latex-options
10424 @vindex org-format-latex-header
10425 You can customize the variables @code{org-format-latex-options} and
10426 @code{org-format-latex-header} to influence some aspects of the preview.  In
10427 particular, the @code{:scale} (and for HTML export, @code{:html-scale})
10428 property of the former can be used to adjust the size of the preview images.
10430 @table @kbd
10431 @kindex C-c C-x C-l
10432 @item C-c C-x C-l
10433 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10434 over the source code.  If there is no fragment at point, process all
10435 fragments in the current entry (between two headlines).  When called
10436 with a prefix argument, process the entire subtree.  When called with
10437 two prefix arguments, or when the cursor is before the first headline,
10438 process the entire buffer.
10439 @kindex C-c C-c
10440 @item C-c C-c
10441 Remove the overlay preview images.
10442 @end table
10444 @vindex org-startup-with-latex-preview
10445 You can turn on the previewing of all @LaTeX{} fragments in a file with
10447 @example
10448 #+STARTUP: latexpreview
10449 @end example
10451 To disable it, simply use
10453 @example
10454 #+STARTUP: nolatexpreview
10455 @end example
10457 @node CDLaTeX mode
10458 @subsection Using CD@LaTeX{} to enter math
10459 @cindex CD@LaTeX{}
10461 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10462 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10463 environments and math templates.  Inside Org mode, you can make use of
10464 some of the features of CD@LaTeX{} mode.  You need to install
10465 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10466 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10467 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10468 version @code{org-cdlatex-mode} that comes as part of Org mode.  Turn it
10469 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10470 Org files with
10472 @lisp
10473 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10474 @end lisp
10476 When this mode is enabled, the following features are present (for more
10477 details see the documentation of CD@LaTeX{} mode):
10478 @itemize @bullet
10479 @kindex C-c @{
10480 @item
10481 Environment templates can be inserted with @kbd{C-c @{}.
10482 @item
10483 @kindex @key{TAB}
10484 The @key{TAB} key will do template expansion if the cursor is inside a
10485 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10486 inside such a fragment, see the documentation of the function
10487 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
10488 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10489 correctly inside the first brace.  Another @key{TAB} will get you into
10490 the second brace.  Even outside fragments, @key{TAB} will expand
10491 environment abbreviations at the beginning of a line.  For example, if
10492 you write @samp{equ} at the beginning of a line and press @key{TAB},
10493 this abbreviation will be expanded to an @code{equation} environment.
10494 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10495 @item
10496 @kindex _
10497 @kindex ^
10498 @vindex cdlatex-simplify-sub-super-scripts
10499 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10500 characters together with a pair of braces.  If you use @key{TAB} to move
10501 out of the braces, and if the braces surround only a single character or
10502 macro, they are removed again (depending on the variable
10503 @code{cdlatex-simplify-sub-super-scripts}).
10504 @item
10505 @kindex `
10506 Pressing the backquote @kbd{`} followed by a character inserts math
10507 macros, also outside @LaTeX{} fragments.  If you wait more than 1.5 seconds
10508 after the backquote, a help window will pop up.
10509 @item
10510 @kindex '
10511 Pressing the single-quote @kbd{'} followed by another character modifies
10512 the symbol before point with an accent or a font.  If you wait more than
10513 1.5 seconds after the single-quote, a help window will pop up.  Character
10514 modification will work only inside @LaTeX{} fragments; outside the quote
10515 is normal.
10516 @end itemize
10518 @node Special blocks
10519 @section Special blocks
10520 @cindex Special blocks
10522 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10523 examples}).  It is also possible to create blocks containing raw code
10524 targeted at a specific back-end (e.g., @samp{#+BEGIN_LATEX}).
10526 Any other block is a @emph{special block}.  Its name is case-sensitive.
10528 For example, @samp{#+BEGIN_abstract} and @samp{#+BEGIN_video} are special
10529 blocks.  The first one is useful when exporting to @LaTeX{}, the second one
10530 when exporting to HTML5.
10532 Each export back-end decides if they should be exported, and how.  When the
10533 block is ignored, its contents are still exported, as if the opening and
10534 closing block lines were not there.  For example, when exporting a
10535 @samp{#+BEGIN_test} block, HTML back-end wraps its contents within a
10536 @samp{<div name="test">} tag.
10538 Refer to back-end specific documentation for more information.
10540 @node Exporting
10541 @chapter Exporting
10542 @cindex exporting
10544 The Org mode export facilities can be used to export Org documents or parts
10545 of Org documents to a variety of other formats.  In addition, these
10546 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10547 in foreign buffers so you can author tables and lists in Org syntax and
10548 convert them in place to the target language.
10550 ASCII export produces a readable and simple version of an Org file for
10551 printing and sharing notes.  HTML export allows you to easily publish notes
10552 on the web, or to build full-fledged websites.  @LaTeX{} export lets you use
10553 Org mode and its structured editing functions to create arbitrarily complex
10554 @LaTeX{} files for any kind of document.  OpenDocument Text (ODT) export
10555 allows seamless collaboration across organizational boundaries.  Markdown
10556 export lets you seamlessly collaborate with other developers.  Finally, iCal
10557 export can extract entries with deadlines or appointments to produce a file
10558 in the iCalendar format.
10560 @menu
10561 * The export dispatcher::       The main exporter interface
10562 * Export back-ends::            Built-in export formats
10563 * Export settings::             Generic export settings
10564 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
10565 * Beamer export::               Exporting as a Beamer presentation
10566 * HTML export::                 Exporting to HTML
10567 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
10568 * Markdown export::             Exporting to Markdown
10569 * OpenDocument Text export::    Exporting to OpenDocument Text
10570 * Org export::                  Exporting to Org
10571 * Texinfo export::              Exporting to Texinfo
10572 * iCalendar export::            Exporting to iCalendar
10573 * Other built-in back-ends::    Exporting to a man page
10574 * Export in foreign buffers::   Author tables and lists in Org syntax
10575 * Advanced configuration::      Fine-tuning the export output
10576 @end menu
10578 @node The export dispatcher
10579 @section The export dispatcher
10580 @vindex org-export-dispatch-use-expert-ui
10581 @cindex Export, dispatcher
10583 The main entry point for export related tasks is the dispatcher, a
10584 hierarchical menu from which it is possible to select an export format and
10585 toggle export options@footnote{It is also possible to use a less intrusive
10586 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10587 non-@code{nil} value.  In that case, only a prompt is visible from the
10588 minibuffer.  From there one can still switch back to regular menu by pressing
10589 @key{?}.} from which it is possible to select an export format and to toggle
10590 export options.
10592 @table @asis
10593 @orgcmd{C-c C-e,org-export-dispatch}
10595 Dispatch for export and publishing commands.  When called with a @kbd{C-u}
10596 prefix argument, repeat the last export command on the current buffer while
10597 preserving toggled options.  If the current buffer hasn't changed and subtree
10598 export was activated, the command will affect that same subtree.
10599 @end table
10601 Normally the entire buffer is exported, but if there is an active region
10602 only that part of the buffer will be exported.
10604 Several export options (@pxref{Export settings}) can be toggled from the
10605 export dispatcher with the following key combinations:
10607 @table @kbd
10608 @item C-a
10609 @vindex org-export-async-init-file
10610 Toggle asynchronous export.  Asynchronous export uses an external Emacs
10611 process that is configured with a specified initialization file.
10613 While exporting asynchronously, the output is not displayed, but stored in
10614 a place called ``the export stack''.  This stack can be displayed by calling
10615 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10616 from the dispatcher menu.
10618 @vindex org-export-in-background
10619 To make this behavior the default, customize the variable
10620 @code{org-export-in-background}.
10622 @item C-b
10623 Toggle body-only export.  Its effect depends on the back-end used.
10624 Typically, if the back-end has a header section (like @code{<head>...</head>}
10625 in the HTML back-end), a body-only export will not include this header.
10627 @item C-s
10628 @vindex org-export-initial-scope
10629 Toggle subtree export.  The top heading becomes the document title.
10631 You can change the default state of this option by setting
10632 @code{org-export-initial-scope}.
10634 @item C-v
10635 Toggle visible-only export.  Only export the text that is currently
10636 visible, i.e. not hidden by outline visibility in the buffer.
10637 @end table
10639 @node Export back-ends
10640 @section Export back-ends
10641 @cindex Export, back-ends
10643 An export back-end is a library that translates Org syntax into a foreign
10644 format.  An export format is not available until the proper back-end has been
10645 loaded.
10647 @vindex org-export-backends
10648 By default, the following four back-ends are loaded: @code{ascii},
10649 @code{html}, @code{icalendar} and @code{latex}.  It is possible to add more
10650 (or remove some) by customizing @code{org-export-backends}.
10652 Built-in back-ends include:
10654 @itemize
10655 @item ascii (ASCII format)
10656 @item beamer (@LaTeX{} Beamer format)
10657 @item html (HTML format)
10658 @item icalendar (iCalendar format)
10659 @item latex (@LaTeX{} format)
10660 @item man (Man page format)
10661 @item md (Markdown format)
10662 @item odt (OpenDocument Text format)
10663 @item org (Org format)
10664 @item texinfo (Texinfo format)
10665 @end itemize
10667 Other back-ends might be found in the @code{contrib/} directory
10668 (@pxref{Installation}).
10670 @node Export settings
10671 @section Export settings
10672 @cindex Export, settings
10674 @cindex #+OPTIONS
10675 Export options can be set: globally with variables; for an individual file by
10676 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10677 settings}), by setting individual keywords, or by specifying them in a
10678 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10679 properties (@pxref{Properties and columns}).  Options set at a specific level
10680 override options set at a more general level.
10682 @cindex #+SETUPFILE
10683 In-buffer settings may appear anywhere in the file, either directly or
10684 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10685 Option keyword sets tailored to a particular back-end can be inserted from
10686 the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert
10687 template} command by pressing @key{#}.  To insert keywords individually,
10688 a good way to make sure the keyword is correct is to type @code{#+} and then
10689 to use @kbd{M-<TAB>} for completion.
10691 The export keywords available for every back-end, and their equivalent global
10692 variables, include:
10694 @table @samp
10695 @item AUTHOR
10696 @cindex #+AUTHOR
10697 @vindex user-full-name
10698 The document author (@code{user-full-name}).
10700 @item CREATOR
10701 @cindex #+CREATOR
10702 @vindex org-export-creator-string
10703 Entity responsible for output generation (@code{org-export-creator-string}).
10705 @item DATE
10706 @cindex #+DATE
10707 @vindex org-export-date-timestamp-format
10708 A date or a time-stamp@footnote{The variable
10709 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10710 exported.}.
10712 @item EMAIL
10713 @cindex #+EMAIL
10714 @vindex user-mail-address
10715 The email address (@code{user-mail-address}).
10717 @item LANGUAGE
10718 @cindex #+LANGUAGE
10719 @vindex org-export-default-language
10720 The language used for translating some strings
10721 (@code{org-export-default-language}).  E.g., @samp{#+LANGUAGE: fr} will tell
10722 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10723 clocktable.
10725 @item SELECT_TAGS
10726 @cindex #+SELECT_TAGS
10727 @vindex org-export-select-tags
10728 The tags that select a tree for export (@code{org-export-select-tags}).  The
10729 default value is @code{:export:}.  Within a subtree tagged with
10730 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10731 below).  When headlines are selectively exported with @code{:export:}
10732 anywhere in a file, text before the first headline is ignored.
10734 @item EXCLUDE_TAGS
10735 @cindex #+EXCLUDE_TAGS
10736 @vindex org-export-exclude-tags
10737 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10738 The default value is @code{:noexport:}.  Entries with the @code{:noexport:}
10739 tag will be unconditionally excluded from the export, even if they have an
10740 @code{:export:} tag.  Code blocks contained in excluded subtrees will still
10741 be executed during export even though the subtree is not exported.
10743 @item TITLE
10744 @cindex #+TITLE
10745 The title to be shown.  You can use several such keywords for long titles.
10746 @end table
10748 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10749 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10750 recognizes the following arguments:
10752 @table @code
10753 @item ':
10754 @vindex org-export-with-smart-quotes
10755 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10757 @item *:
10758 Toggle emphasized text (@code{org-export-with-emphasize}).
10760 @item -:
10761 @vindex org-export-with-special-strings
10762 Toggle conversion of special strings
10763 (@code{org-export-with-special-strings}).
10765 @item ::
10766 @vindex org-export-with-fixed-width
10767 Toggle fixed-width sections
10768 (@code{org-export-with-fixed-width}).
10770 @item <:
10771 @vindex org-export-with-timestamps
10772 Toggle inclusion of any time/date active/inactive stamps
10773 (@code{org-export-with-timestamps}).
10775 @item \n:
10776 @vindex org-export-preserve-breaks
10777 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10779 @item ^:
10780 @vindex org-export-with-sub-superscripts
10781 Toggle @TeX{}-like syntax for sub- and superscripts.  If you write "^:@{@}",
10782 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10783 it is (@code{org-export-with-sub-superscripts}).
10785 @item arch:
10786 @vindex org-export-with-archived-trees
10787 Configure export of archived trees.  Can be set to @code{headline} to only
10788 process the headline, skipping its contents
10789 (@code{org-export-with-archived-trees}).
10791 @item author:
10792 @vindex org-export-with-author
10793 Toggle inclusion of author name into exported file
10794 (@code{org-export-with-author}).
10796 @item c:
10797 @vindex org-export-with-clocks
10798 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10800 @item creator:
10801 @vindex org-export-with-creator
10802 Toggle inclusion of creator info into exported file
10803 (@code{org-export-with-creator}).
10805 @item d:
10806 @vindex org-export-with-drawers
10807 Toggle inclusion of drawers, or list drawers to include
10808 (@code{org-export-with-drawers}).
10810 @item date:
10811 @vindex org-export-with-date
10812 Toggle inclusion of a date into exported file (@code{org-export-with-date}).
10814 @item e:
10815 @vindex org-export-with-entities
10816 Toggle inclusion of entities (@code{org-export-with-entities}).
10818 @item email:
10819 @vindex org-export-with-email
10820 Toggle inclusion of the author's e-mail into exported file
10821 (@code{org-export-with-email}).
10823 @item f:
10824 @vindex org-export-with-footnotes
10825 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10827 @item H:
10828 @vindex org-export-headline-levels
10829 Set the number of headline levels for export
10830 (@code{org-export-headline-levels}).  Below that level, headlines are treated
10831 differently.  In most back-ends, they become list items.
10833 @item inline:
10834 @vindex org-export-with-inlinetasks
10835 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10837 @item num:
10838 @vindex org-export-with-section-numbers
10839 @cindex property, UNNUMBERED
10840 Toggle section-numbers (@code{org-export-with-section-numbers}).  It can also
10841 be set to a number @samp{n}, so only headlines at that level or above will be
10842 numbered.  Finally, irrespective of the level of a specific headline, the
10843 numbering of it can be disabled by setting the @code{UNNUMBERED} property to
10844 non-@code{nil}.  This also affects subheadings.
10846 @item p:
10847 @vindex org-export-with-planning
10848 Toggle export of planning information (@code{org-export-with-planning}).
10849 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10850 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10852 @item pri:
10853 @vindex org-export-with-priority
10854 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10856 @item prop:
10857 @vindex org-export-with-properties
10858 Toggle inclusion of property drawers, or list properties to include
10859 (@code{org-export-with-properties}).
10861 @item stat:
10862 @vindex org-export-with-statistics-cookies
10863 Toggle inclusion of statistics cookies
10864 (@code{org-export-with-statistics-cookies}).
10866 @item tags:
10867 @vindex org-export-with-tags
10868 Toggle inclusion of tags, may also be @code{not-in-toc}
10869 (@code{org-export-with-tags}).
10871 @item tasks:
10872 @vindex org-export-with-tasks
10873 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10874 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10875 (@code{org-export-with-tasks}).
10877 @item tex:
10878 @vindex org-export-with-latex
10879 Configure export of @LaTeX{} fragments and environments.  It may be set to
10880 @code{verbatim} (@code{org-export-with-latex}).
10882 @item timestamp:
10883 @vindex org-export-time-stamp-file
10884 Toggle inclusion of the creation time into exported file
10885 (@code{org-export-time-stamp-file}).
10887 @item title:
10888 @vindex org-export-with-title
10889 Toggle inclusion of title (@code{org-export-with-title}).
10891 @item toc:
10892 @vindex org-export-with-toc
10893 Toggle inclusion of the table of contents, or set the level limit
10894 (@code{org-export-with-toc}).
10896 @item todo:
10897 @vindex org-export-with-todo-keywords
10898 Toggle inclusion of TODO keywords into exported text
10899 (@code{org-export-with-todo-keywords}).
10901 @item |:
10902 @vindex org-export-with-tables
10903 Toggle inclusion of tables (@code{org-export-with-tables}).
10905 @end table
10907 When exporting only a subtree, each of the previous keywords@footnote{With
10908 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10909 properties.  These begin with @samp{EXPORT_}, followed by the name of the
10910 keyword they supplant.  For example, @samp{DATE} and @samp{OPTIONS} keywords
10911 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10912 properties.
10914 @cindex #+BIND
10915 @vindex org-export-allow-bind-keywords
10916 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10917 can become buffer-local during export by using the BIND keyword.  Its syntax
10918 is @samp{#+BIND: variable value}.  This is particularly useful for in-buffer
10919 settings that cannot be changed using specific keywords.
10921 @cindex property, EXPORT_FILE_NAME
10922 The name of the output file to be generated is taken from the file associated
10923 to the buffer, when possible, or asked to you otherwise.  For subtree export,
10924 you can also set @code{EXPORT_FILE_NAME} property.  In all cases, only the
10925 base name of the file is retained, and a back-end specific extension is
10926 added.
10928 @node ASCII/Latin-1/UTF-8 export
10929 @section ASCII/Latin-1/UTF-8 export
10930 @cindex ASCII export
10931 @cindex Latin-1 export
10932 @cindex UTF-8 export
10934 ASCII export produces a simple and very readable version of an Org mode
10935 file, containing only plain ASCII@.  Latin-1 and UTF-8 export augment the file
10936 with special characters and symbols available in these encodings.
10938 @vindex org-ascii-text-width
10939 Upon exporting, text is filled and justified, when appropriate, according the
10940 text width set in @code{org-ascii-text-width}.
10942 @vindex org-ascii-links-to-notes
10943 Links are exported in a footnote-like style, with the descriptive part in the
10944 text and the link in a note before the next heading.  See the variable
10945 @code{org-ascii-links-to-notes} for details and other options.
10947 @subheading ASCII export commands
10949 @table @kbd
10950 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10951 Export as an ASCII file.  For an Org file, @file{myfile.org}, the ASCII file
10952 will be @file{myfile.txt}.  The file will be overwritten without warning.
10953 When the original file is @file{myfile.txt}, the resulting file becomes
10954 @file{myfile.txt.txt} in order to prevent data loss.
10955 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10956 Export to a temporary buffer.  Do not create a file.
10957 @end table
10959 @subheading ASCII specific export settings
10961 ASCII export introduces a single of keywords, similar to the general options
10962 settings described in @ref{Export settings}.
10964 @table @samp
10965 @item SUBTITLE
10966 @cindex #+SUBTITLE (ASCII)
10967 The document subtitle.
10968 @end table
10970 @subheading Header and sectioning structure
10972 In the exported version, the first three outline levels become headlines,
10973 defining a general document structure.  Additional levels are exported as
10974 lists.  The transition can also occur at a different level (@pxref{Export
10975 settings}).
10977 @subheading Quoting ASCII text
10979 You can insert text that will only appear when using @code{ASCII} back-end
10980 with the following constructs:
10982 @cindex #+ASCII
10983 @cindex #+BEGIN_ASCII
10984 @example
10985 Text @@@@ascii:and additional text@@@@ within a paragraph.
10987 #+ASCII: Some text
10989 #+BEGIN_ASCII
10990 All lines in this block will appear only when using this back-end.
10991 #+END_ASCII
10992 @end example
10994 @subheading ASCII specific attributes
10995 @cindex #+ATTR_ASCII
10996 @cindex horizontal rules, in ASCII export
10998 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10999 specifies the length, in characters, of a given horizontal rule.  It must be
11000 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
11002 @example
11003 #+ATTR_ASCII: :width 10
11004 -----
11005 @end example
11007 @subheading ASCII special blocks
11008 @cindex special blocks, in ASCII export
11009 @cindex #+BEGIN_JUSTIFYLEFT
11010 @cindex #+BEGIN_JUSTIFYRIGHT
11012 In addition to @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), it is
11013 possible to justify contents to the left or the right of the page with the
11014 following dedicated blocks.
11016 @example
11017 #+BEGIN_JUSTIFYLEFT
11018 It's just a jump to the left...
11019 #+END_JUSTIFYLEFT
11021 #+BEGIN_JUSTIFYRIGHT
11022 ...and then a step to the right.
11023 #+END_JUSTIFYRIGHT
11024 @end example
11026 @node Beamer export
11027 @section Beamer export
11028 @cindex Beamer export
11030 The @LaTeX{} class @emph{Beamer} allows production of high quality
11031 presentations using @LaTeX{} and pdf processing.  Org mode has special
11032 support for turning an Org mode file or tree into a Beamer presentation.
11034 @menu
11035 * Beamer export commands:: How to export Beamer documents.
11036 * Beamer specific export settings:: Export settings for Beamer export.
11037 * Sectioning Frames and Blocks in Beamer:: Blocks and sections in Beamer.
11038 * Beamer specific syntax:: Syntax specific to Beamer.
11039 * Editing support:: Helper functions for Org Beamer export.
11040 * A Beamer Example:: An complete Beamer example.
11041 @end menu
11043 @node Beamer export commands
11044 @subsection Beamer export commands
11046 @table @kbd
11047 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
11048 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
11049 file will be @file{myfile.tex}.  The file will be overwritten without
11050 warning.
11051 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
11052 Export to a temporary buffer.  Do not create a file.
11053 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
11054 Export as @LaTeX{} and then process to PDF.
11055 @item C-c C-e l O
11056 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11057 @end table
11059 @node Beamer specific export settings
11060 @subsection Beamer specific export settings
11062 Beamer export introduces a number of keywords, similar to the general options
11063 settings described in @ref{Export settings}.
11065 @table @samp
11066 @item BEAMER_THEME
11067 @cindex #+BEAMER_THEME
11068 @vindex org-beamer-theme
11069 The Beamer theme (@code{org-beamer-theme}).  Options can be specified via
11070 brackets, for example:
11071 @smallexample
11072 #+BEAMER_THEME: Rochester [height=20pt]
11073 @end smallexample
11075 @item BEAMER_FONT_THEME
11076 @cindex #+BEAMER_FONT_THEME
11077 The Beamer font theme.
11079 @item BEAMER_INNER_THEME
11080 @cindex #+BEAMER_INNER_THEME
11081 The Beamer inner theme.
11083 @item BEAMER_OUTER_THEME
11084 @cindex #+BEAMER_OUTER_THEME
11085 The Beamer outer theme.
11087 @item BEAMER_HEADER
11088 @cindex #+BEAMER_HEADER
11089 Arbitrary lines inserted into the preamble, just before the @samp{hyperref}
11090 settings.
11092 @item DESCRIPTION
11093 @cindex #+DESCRIPTION (Beamer)
11094 The document description.  By default these are inserted as metadata using
11095 @samp{hyperref}.  Document metadata can be configured via
11096 @code{org-latex-hyperref-template}.  Description can also be typeset as part
11097 of the front matter via @code{org-latex-title-command}.  You can use several
11098 @code{#+DESCRIPTION} keywords if the description is is long.
11100 @item KEYWORDS
11101 @cindex #+KEYWORDS (Beamer)
11102 The keywords defining the contents of the document.  By default these are
11103 inserted as metadata using @samp{hyperref}.  Document metadata can be
11104 configured via @code{org-latex-hyperref-template}.  Description can also be
11105 typeset as part of the front matter via @code{org-latex-title-command}.  You
11106 can use several @code{#+KEYWORDS} if the description is is long.
11108 @item SUBTITLE
11109 @cindex #+SUBTITLE (Beamer)
11110 @vindex org-beamer-subtitle-format
11111 The document subtitle.  This is typeset using the format string
11112 @code{org-beamer-subtitle-format}.  It can also access via
11113 @code{org-latex-hyperref-template} or typeset as part of the front
11114 matter via @code{org-latex-title-command}.
11115 @end table
11117 @node Sectioning Frames and Blocks in Beamer
11118 @subsection Sectioning, Frames and Blocks in Beamer
11120 Any tree with not-too-deep level nesting should in principle be exportable as
11121 a Beamer presentation.  Headlines fall into three categories: sectioning
11122 elements, frames and blocks.
11124 @itemize @minus
11125 @item
11126 @vindex org-beamer-frame-level
11127 Headlines become frames when their level is equal to
11128 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
11129 (@pxref{Export settings}).
11131 @cindex property, BEAMER_ENV
11132 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
11133 set to either to @code{frame} or @code{fullframe}, its level overrides the
11134 variable.  A @code{fullframe} is a frame with an empty (ignored) title.
11136 @item
11137 @vindex org-beamer-environments-default
11138 @vindex org-beamer-environments-extra
11139 All frame's children become @code{block} environments.  Special block types
11140 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
11141 this property is set, the entry will also get a @code{:B_environment:} tag to
11142 make this visible.  This tag has no semantic meaning, it is only a visual
11143 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
11144 supported values and @code{org-beamer-environments-extra} for adding more).
11146 @item
11147 @cindex property, BEAMER_REF
11148 As a special case, if the @code{BEAMER_ENV} property is set to either
11149 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
11150 headline will become, respectively, an appendix, a note (within frame or
11151 between frame, depending on its level), a note with its title ignored or an
11152 @code{\againframe} command.  In the latter case, a @code{BEAMER_REF} property
11153 is mandatory in order to refer to the frame being resumed, and contents are
11154 ignored.
11156 Also, a headline with an @code{ignoreheading} environment will have its
11157 contents only inserted in the output.  This special value is useful to have
11158 data between frames, or to properly close a @code{column} environment.
11159 @end itemize
11161 @cindex property, BEAMER_ACT
11162 @cindex property, BEAMER_OPT
11163 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
11164 The former is translated as an overlay/action specification, or a default
11165 overlay specification when enclosed within square brackets.  The latter
11166 specifies options@footnote{The @code{fragile} option is added automatically
11167 if it contains code that requires a verbatim environment, though.} for the
11168 current frame or block.  The export back-end will automatically wrap
11169 properties within angular or square brackets when appropriate.
11171 @cindex property, BEAMER_COL
11172 Moreover, headlines handle the @code{BEAMER_COL} property.  Its value should
11173 be a decimal number representing the width of the column as a fraction of the
11174 total text width.  If the headline has no specific environment, its title
11175 will be ignored and its contents will fill the column created.  Otherwise,
11176 the block will fill the whole column and the title will be preserved.  Two
11177 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
11178 @code{columns} @LaTeX{} environment.  It will end before the next headline
11179 without such a property.  This environment is generated automatically.
11180 Although, it can also be explicitly created, with a special @code{columns}
11181 value for @code{BEAMER_ENV} property (if it needs to be set up with some
11182 specific options, for example).
11184 @node Beamer specific syntax
11185 @subsection Beamer specific syntax
11187 The Beamer back-end is an extension of the @LaTeX{} back-end.  As such, all @LaTeX{}
11188 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
11189 recognized.  See @ref{@LaTeX{} and PDF export} for more information.
11191 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
11192 wrapped within a @code{frame} environment.  Those generated from a @code{TOC}
11193 keyword (@pxref{Table of contents}) are not.  In that case, it is also
11194 possible to specify options, enclosed within square brackets.
11196 @example
11197 #+TOC: headlines [currentsection]
11198 @end example
11200 Beamer specific code can be inserted with the following constructs:
11202 @cindex #+BEAMER
11203 @cindex #+BEGIN_BEAMER
11204 @example
11205 #+BEAMER: \pause
11207 #+BEGIN_BEAMER
11208 All lines in this block will appear only when using this back-end.
11209 #+END_BEAMER
11211 Text @@@@beamer:some code@@@@ within a paragraph.
11212 @end example
11214 In particular, this last example can be used to add overlay specifications to
11215 objects whose type is among @code{bold}, @code{item}, @code{link},
11216 @code{radio-target} and @code{target}, when the value is enclosed within
11217 angular brackets and put at the beginning the object.
11219 @example
11220 A *@@@@beamer:<2->@@@@useful* feature
11221 @end example
11223 @cindex #+ATTR_BEAMER
11224 Eventually, every plain list has support for @code{:environment},
11225 @code{:overlay} and @code{:options} attributes through
11226 @code{ATTR_BEAMER} affiliated keyword.  The first one allows the use
11227 of a different environment, the second sets overlay specifications and
11228 the last one inserts optional arguments in current list environment.
11230 @example
11231 #+ATTR_BEAMER: :overlay +-
11232 - item 1
11233 - item 2
11234 @end example
11236 @node Editing support
11237 @subsection Editing support
11239 You can turn on a special minor mode @code{org-beamer-mode} for faster
11240 editing with:
11242 @example
11243 #+STARTUP: beamer
11244 @end example
11246 @table @kbd
11247 @orgcmd{C-c C-b,org-beamer-select-environment}
11248 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
11249 environment or the @code{BEAMER_COL} property.
11250 @end table
11252 @node A Beamer Example
11253 @subsection A Beamer example
11255 Here is a simple example Org document that is intended for Beamer export.
11257 @example
11258 #+TITLE: Example Presentation
11259 #+AUTHOR: Carsten Dominik
11260 #+OPTIONS: H:2 toc:t num:t
11261 #+LATEX_CLASS: beamer
11262 #+LATEX_CLASS_OPTIONS: [presentation]
11263 #+BEAMER_THEME: Madrid
11264 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
11266 * This is the first structural section
11268 ** Frame 1
11269 *** Thanks to Eric Fraga                                           :B_block:
11270     :PROPERTIES:
11271     :BEAMER_COL: 0.48
11272     :BEAMER_ENV: block
11273     :END:
11274     for the first viable Beamer setup in Org
11275 *** Thanks to everyone else                                        :B_block:
11276     :PROPERTIES:
11277     :BEAMER_COL: 0.48
11278     :BEAMER_ACT: <2->
11279     :BEAMER_ENV: block
11280     :END:
11281     for contributing to the discussion
11282 **** This will be formatted as a beamer note                       :B_note:
11283      :PROPERTIES:
11284      :BEAMER_env: note
11285      :END:
11286 ** Frame 2 (where we will not use columns)
11287 *** Request
11288     Please test this stuff!
11289 @end example
11291 @node HTML export
11292 @section HTML export
11293 @cindex HTML export
11295 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
11296 HTML formatting, in ways similar to John Gruber's @emph{markdown}
11297 language, but with additional support for tables.
11299 @menu
11300 * HTML Export commands::        How to invoke HTML export
11301 * HTML Specific export settings:: Export settings for HTML export.
11302 * HTML doctypes::               Org can export to various (X)HTML flavors
11303 * HTML preamble and postamble::  How to insert a preamble and a postamble
11304 * Quoting HTML tags::           Using direct HTML in Org mode
11305 * Links in HTML export::        How links will be interpreted and formatted
11306 * Tables in HTML export::       How to modify the formatting of tables
11307 * Images in HTML export::       How to insert figures into HTML output
11308 * Math formatting in HTML export::  Beautiful math also on the web
11309 * Text areas in HTML export::   An alternative way to show an example
11310 * CSS support::                 Changing the appearance of the output
11311 * JavaScript support::          Info and Folding in a web browser
11312 @end menu
11315 @node HTML Export commands
11316 @subsection HTML export commands
11318 @table @kbd
11319 @orgcmd{C-c C-e h h,org-html-export-to-html}
11320 Export as an HTML file.  For an Org file @file{myfile.org},
11321 the HTML file will be @file{myfile.html}.  The file will be overwritten
11322 without warning.
11323 @kbd{C-c C-e h o}
11324 Export as an HTML file and immediately open it with a browser.
11325 @orgcmd{C-c C-e h H,org-html-export-as-html}
11326 Export to a temporary buffer.  Do not create a file.
11327 @end table
11329 @c FIXME Exporting sublevels
11330 @c @cindex headline levels, for exporting
11331 @c In the exported version, the first 3 outline levels will become headlines,
11332 @c defining a general document structure.  Additional levels will be exported as
11333 @c itemized lists.  If you want that transition to occur at a different level,
11334 @c specify it with a numeric prefix argument.  For example,
11336 @c @example
11337 @c @kbd{C-2 C-c C-e b}
11338 @c @end example
11340 @c @noindent
11341 @c creates two levels of headings and does the rest as items.
11343 @node HTML Specific export settings
11344 @subsection HTML Specific export settings
11345 HTML export introduces a number of keywords, similar to the general options
11346 settings described in @ref{Export settings}.
11348 @table @samp
11349 @item DESCRIPTION
11350 @cindex #+DESCRIPTION (HTML)
11351 The document description.  This description is inserted as a HTML meta tag.
11352 You can use several such keywords if the list is long.
11354 @item HTML_DOCTYPE
11355 @cindex #+HTML_DOCTYPE
11356 @vindex org-html-doctype
11357 The document type, e.g. HTML5, (@code{org-html-doctype}).
11359 @item HTML_CONTAINER
11360 @cindex #+HTML_CONTAINER
11361 @vindex org-html-container-element
11362 The container, e.g. @samp{div}, used to wrap sections and elements
11363 (@code{org-html-container-element}).
11365 @item HTML_LINK_HOME
11366 @cindex #+HTML_LINK_HOME
11367 @vindex org-html-link-home
11368 The home link URL (@code{org-html-link-home}).
11370 @item HTML_LINK_UP
11371 @cindex #+HTML_LINK_UP
11372 @vindex org-html-link-up
11373 The up link URL (@code{org-html-link-up}).
11375 @item HTML_MATHJAX
11376 @cindex #+HTML_MATHJAX
11377 @vindex org-html-mathjax-options
11378 Options for the MathJax (@code{org-html-mathjax-options}).  MathJax is used
11379 to typeset @LaTeX{} math in HTML documents.  @ref{Math formatting in HTML
11380 export} contains an example.
11382 @item HTML_HEAD
11383 @cindex #+HTML_HEAD
11384 @vindex org-html-head
11385 Arbitrary lines appended to the end of the head of the document
11386 (@code{org-html-head}).
11388 @item HTML_HEAD_EXTRA
11389 @cindex #+HTML_HEAD_EXTRA
11390 @vindex org-html-head-extra
11391 Arbitrary lines appended to the end of the header of the document
11392 (@code{org-html-head-extra}).
11394 @item KEYWORDS
11395 @cindex #+KEYWORDS (HTML)
11396 The keywords defining the contents of the document.  This description is
11397 inserted as a HTML meta tag.  You can use several such keywords if the list
11398 is long.
11400 @item LATEX_HEADER
11401 @cindex #+LATEX_HEADER (HTML)
11402 Arbitrary lines appended to the preamble used when transcoding @LaTeX{}
11403 fragments to images.  See @ref{Math formatting in HTML export} for details.
11405 @item SUBTITLE
11406 @cindex #+SUBTILE (HTML)
11407 The document subtitle.  The formatting depends on whether HTML5 in used
11408 and on the @samp{subtitle} CSS class.
11409 @end table
11411 These keywords are treated in details in the following sections.
11413 @node HTML doctypes
11414 @subsection HTML doctypes
11415 @vindex org-html-doctype
11416 @vindex org-html-doctype-alist
11418 Org can export to various (X)HTML flavors.
11420 Setting the variable @code{org-html-doctype} allows you to export to different
11421 (X)HTML variants.  The exported HTML will be adjusted according to the syntax
11422 requirements of that variant.  You can either set this variable to a doctype
11423 string directly, in which case the exporter will try to adjust the syntax
11424 automatically, or you can use a ready-made doctype.  The ready-made options
11425 are:
11427 @itemize
11428 @item
11429 ``html4-strict''
11430 @item
11431 ``html4-transitional''
11432 @item
11433 ``html4-frameset''
11434 @item
11435 ``xhtml-strict''
11436 @item
11437 ``xhtml-transitional''
11438 @item
11439 ``xhtml-frameset''
11440 @item
11441 ``xhtml-11''
11442 @item
11443 ``html5''
11444 @item
11445 ``xhtml5''
11446 @end itemize
11448 See the variable @code{org-html-doctype-alist} for details.  The default is
11449 ``xhtml-strict''.
11451 @subsubheading Fancy HTML5 export
11452 @vindex org-html-html5-fancy
11453 @vindex org-html-html5-elements
11455 HTML5 introduces several new element types.  By default, Org will not make
11456 use of these element types, but you can set @code{org-html-html5-fancy} to
11457 @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11458 enable a few new block-level elements.  These are created using arbitrary
11459 #+BEGIN and #+END blocks. For instance:
11461 @example
11462 #+BEGIN_ASIDE
11463 Lorem ipsum
11464 #+END_ASIDE
11465 @end example
11467 Will export to:
11469 @example
11470 <aside>
11471   <p>Lorem ipsum</p>
11472 </aside>
11473 @end example
11475 While this:
11477 @example
11478 #+ATTR_HTML: :controls controls :width 350
11479 #+BEGIN_VIDEO
11480 #+HTML: <source src="movie.mp4" type="video/mp4">
11481 #+HTML: <source src="movie.ogg" type="video/ogg">
11482 Your browser does not support the video tag.
11483 #+END_VIDEO
11484 @end example
11486 Becomes:
11488 @example
11489 <video controls="controls" width="350">
11490   <source src="movie.mp4" type="video/mp4">
11491   <source src="movie.ogg" type="video/ogg">
11492   <p>Your browser does not support the video tag.</p>
11493 </video>
11494 @end example
11496 Special blocks that do not correspond to HTML5 elements (see
11497 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11498 @code{#+BEGIN_lederhosen} will still export to @samp{<div class="lederhosen">}.
11500 Headlines cannot appear within special blocks.  To wrap a headline and its
11501 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11502 @code{HTML_CONTAINER} property on the headline itself.
11504 @node HTML preamble and postamble
11505 @subsection HTML preamble and postamble
11506 @vindex org-html-preamble
11507 @vindex org-html-postamble
11508 @vindex org-html-preamble-format
11509 @vindex org-html-postamble-format
11510 @vindex org-html-validation-link
11511 @vindex org-export-creator-string
11512 @vindex org-export-time-stamp-file
11514 The HTML exporter lets you define a preamble and a postamble.
11516 The default value for @code{org-html-preamble} is @code{t}, which means
11517 that the preamble is inserted depending on the relevant format string in
11518 @code{org-html-preamble-format}.
11520 Setting @code{org-html-preamble} to a string will override the default format
11521 string.  If you set it to a function, it will insert the output of the
11522 function, which must be a string.  Setting to @code{nil} will not insert any
11523 preamble.
11525 The default value for @code{org-html-postamble} is @code{'auto}, which means
11526 that the HTML exporter will look for information about the author, the email,
11527 the creator and the date, and build the postamble from these values.  Setting
11528 @code{org-html-postamble} to @code{t} will insert the postamble from the
11529 relevant format string found in @code{org-html-postamble-format}.  Setting it
11530 to @code{nil} will not insert any postamble.
11532 @node Quoting HTML tags
11533 @subsection Quoting HTML tags
11535 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
11536 @samp{&gt;} in HTML export.  If you want to include raw HTML code, which
11537 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11538 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}.  For more extensive HTML
11539 that should be copied verbatim to the exported file use either
11541 @cindex #+HTML
11542 @cindex #+BEGIN_HTML
11543 @example
11544 #+HTML: Literal HTML code for export
11545 @end example
11547 @noindent or
11548 @cindex #+BEGIN_HTML
11550 @example
11551 #+BEGIN_HTML
11552 All lines between these markers are exported literally
11553 #+END_HTML
11554 @end example
11557 @node Links in HTML export
11558 @subsection Links in HTML export
11560 @cindex links, in HTML export
11561 @cindex internal links, in HTML export
11562 @cindex external links, in HTML export
11563 @vindex org-html-link-org-files-as-html
11564 Internal links (@pxref{Internal links}) will continue to work in HTML@.  This
11565 includes automatic links created by radio targets (@pxref{Radio
11566 targets}).  Links to external files will still work if the target file is on
11567 the same @i{relative} path as the published Org file.  Links to other
11568 @file{.org} files will be translated into HTML links under the assumption
11569 that an HTML version also exists of the linked file, at the same relative
11570 path; setting @code{org-html-link-org-files-as-html} to @code{nil} disables
11571 this translation.  @samp{id:} links can then be used to jump to specific
11572 entries across files.  For information related to linking files while
11573 publishing them to a publishing directory see @ref{Publishing links}.
11575 If you want to specify attributes for links, you can do so using a special
11576 @code{#+ATTR_HTML} line to define attributes that will be added to the
11577 @code{<a>} or @code{<img>} tags.  Here is an example that sets @code{title}
11578 and @code{style} attributes for a link:
11580 @cindex #+ATTR_HTML
11581 @example
11582 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11583 [[http://orgmode.org]]
11584 @end example
11586 @node Tables in HTML export
11587 @subsection Tables in HTML export
11588 @cindex tables, in HTML
11589 @vindex org-html-table-default-attributes
11591 Org mode tables are exported to HTML using the table attributes defined in
11592 @code{org-html-table-default-attributes}.  The default setting makes tables
11593 without cell borders and frame.  If you would like to change this for
11594 individual tables, place something like the following before the table:
11596 @cindex #+CAPTION
11597 @cindex #+ATTR_HTML
11598 @example
11599 #+CAPTION: This is a table with lines around and between cells
11600 #+ATTR_HTML: :border 2 :rules all :frame border
11601 @end example
11603 You can also group columns in the HTML output (@pxref{Column groups}).
11605 Below is a list of options for customizing tables HTML export.
11607 @table @code
11608 @vindex org-html-table-align-individual-fields
11609 @item org-html-table-align-individual-fields
11610 Non-@code{nil} means attach style attributes for alignment to each table field.
11612 @vindex org-html-table-caption-above
11613 @item org-html-table-caption-above
11614 When non-@code{nil}, place caption string at the beginning of the table.
11616 @vindex org-html-table-data-tags
11617 @item org-html-table-data-tags
11618 The opening and ending tags for table data fields.
11620 @vindex org-html-table-default-attributes
11621 @item org-html-table-default-attributes
11622 Default attributes and values which will be used in table tags.
11624 @vindex org-html-table-header-tags
11625 @item org-html-table-header-tags
11626 The opening and ending tags for table header fields.
11628 @vindex org-html-table-row-tags
11629 @item org-html-table-row-tags
11630 The opening and ending tags for table rows.
11632 @vindex org-html-table-use-header-tags-for-first-column
11633 @item org-html-table-use-header-tags-for-first-column
11634 Non-@code{nil} means format column one in tables with header tags.
11635 @end table
11637 @node Images in HTML export
11638 @subsection Images in HTML export
11640 @cindex images, inline in HTML
11641 @cindex inlining images in HTML
11642 @vindex org-html-inline-images
11643 HTML export can inline images given as links in the Org file, and
11644 it can make an image the clickable part of a link.  By
11645 default@footnote{But see the variable
11646 @code{org-html-inline-images}.}, images are inlined if a link does
11647 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
11648 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11649 @samp{the image} that points to the image.  If the description part
11650 itself is a @code{file:} link or a @code{http:} URL pointing to an
11651 image, this image will be inlined and activated so that clicking on the
11652 image will activate the link.  For example, to include a thumbnail that
11653 will link to a high resolution version of the image, you could use:
11655 @example
11656 [[file:highres.jpg][file:thumb.jpg]]
11657 @end example
11659 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11660 In the example below we specify the @code{alt} and @code{title} attributes to
11661 support text viewers and accessibility, and align it to the right.
11663 @cindex #+CAPTION
11664 @cindex #+ATTR_HTML
11665 @example
11666 #+CAPTION: A black cat stalking a spider
11667 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11668 [[./img/a.jpg]]
11669 @end example
11671 @noindent
11672 You could use @code{http} addresses just as well.
11674 @node Math formatting in HTML export
11675 @subsection Math formatting in HTML export
11676 @cindex MathJax
11677 @cindex dvipng
11678 @cindex imagemagick
11680 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11681 different ways on HTML pages.  The default is to use
11682 @uref{http://www.mathjax.org, MathJax} which should work out of the box with
11683 Org@footnote{By default Org loads MathJax from
11684 @uref{http://docs.mathjax.org/en/latest/start.html#using-the-mathjax-content-delivery-network-cdn,
11685 MathJax.org}.  A link to the terms of service of the MathJax CDN can be found
11686 in the docstring of @code{org-html-mathjax-options}.}.  Some MathJax display
11687 options can be configured via @code{org-html-mathjax-options}, or in the
11688 buffer.  For example, with the following settings,
11689 @smallexample
11690 #+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
11691 @end smallexample
11692 equation labels will be displayed on the left marign and equations will be
11693 five ems from the left margin.
11695 @noindent See the docstring of
11696 @code{org-html-mathjax-options} for all supported variables.  The MathJax
11697 template can be configure via @code{org-html-mathjax-template}.
11699 If you prefer, you can also request that @LaTeX{} fragments are processed
11700 into small images that will be inserted into the browser page.  Before the
11701 availability of MathJax, this was the default method for Org files.  This
11702 method requires that the @file{dvipng} program or @file{imagemagick} suite is
11703 available on your system.  You can still get this processing with
11705 @example
11706 #+OPTIONS: tex:dvipng
11707 @end example
11711 @example
11712 #+OPTIONS: tex:imagemagick
11713 @end example
11715 @node Text areas in HTML export
11716 @subsection Text areas in HTML export
11718 @cindex text areas, in HTML
11719 An alternative way to publish literal code examples in HTML is to use text
11720 areas, where the example can even be edited before pasting it into an
11721 application.  It is triggered by @code{:textarea} attribute at an
11722 @code{example} or @code{src} block.
11724 You may also use @code{:height} and @code{:width} attributes to specify the
11725 height and width of the text area, which default to the number of lines in
11726 the example, and 80, respectively.  For example
11728 @example
11729 #+ATTR_HTML: :textarea t :width 40
11730 #+BEGIN_EXAMPLE
11731   (defun org-xor (a b)
11732      "Exclusive or."
11733      (if a (not b) b))
11734 #+END_EXAMPLE
11735 @end example
11738 @node CSS support
11739 @subsection CSS support
11740 @cindex CSS, for HTML export
11741 @cindex HTML export, CSS
11743 @vindex org-html-todo-kwd-class-prefix
11744 @vindex org-html-tag-class-prefix
11745 You can modify the CSS style definitions for the exported file.  The HTML
11746 exporter assigns the following special CSS classes@footnote{If the classes on
11747 TODO keywords and tags lead to conflicts, use the variables
11748 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11749 make them unique.} to appropriate parts of the document---your style
11750 specifications may change these, in addition to any of the standard classes
11751 like for headlines, tables, etc.
11752 @example
11753 p.author            @r{author information, including email}
11754 p.date              @r{publishing date}
11755 p.creator           @r{creator info, about org mode version}
11756 .title              @r{document title}
11757 .subtitle           @r{document subtitle}
11758 .todo               @r{TODO keywords, all not-done states}
11759 .done               @r{the DONE keywords, all states that count as done}
11760 .WAITING            @r{each TODO keyword also uses a class named after itself}
11761 .timestamp          @r{timestamp}
11762 .timestamp-kwd      @r{keyword associated with a timestamp, like SCHEDULED}
11763 .timestamp-wrapper  @r{span around keyword plus timestamp}
11764 .tag                @r{tag in a headline}
11765 ._HOME              @r{each tag uses itself as a class, "@@" replaced by "_"}
11766 .target             @r{target for links}
11767 .linenr             @r{the line number in a code example}
11768 .code-highlighted   @r{for highlighting referenced code lines}
11769 div.outline-N       @r{div for outline level N (headline plus text))}
11770 div.outline-text-N  @r{extra div for text at outline level N}
11771 .section-number-N   @r{section number in headlines, different for each level}
11772 .figure-number      @r{label like "Figure 1:"}
11773 .table-number       @r{label like "Table 1:"}
11774 .listing-number     @r{label like "Listing 1:"}
11775 div.figure          @r{how to format an inlined image}
11776 pre.src             @r{formatted source code}
11777 pre.example         @r{normal example}
11778 p.verse             @r{verse paragraph}
11779 div.footnotes       @r{footnote section headline}
11780 p.footnote          @r{footnote definition paragraph, containing a footnote}
11781 .footref            @r{a footnote reference number (always a <sup>)}
11782 .footnum            @r{footnote number in footnote definition (always <sup>)}
11783 @end example
11785 @vindex org-html-style-default
11786 @vindex org-html-head-include-default-style
11787 @vindex org-html-head
11788 @vindex org-html-head-extra
11789 @cindex #+HTML_INCLUDE_STYLE
11790 Each exported file contains a compact default style that defines these
11791 classes in a basic way@footnote{This style is defined in the constant
11792 @code{org-html-style-default}, which you should not modify.  To turn
11793 inclusion of these defaults off, customize
11794 @code{org-html-head-include-default-style} or set @code{html-style} to
11795 @code{nil} in an @code{OPTIONS} line.}.  You may overwrite these settings, or
11796 add to them by using the variables @code{org-html-head} and
11797 @code{org-html-head-extra}.  You can override the global values of these
11798 variables for each file by using these keywords:
11800 @cindex #+HTML_HEAD
11801 @cindex #+HTML_HEAD_EXTRA
11802 @example
11803 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11804 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11805 @end example
11807 @noindent
11808 For longer style definitions, you can use several such lines.  You could also
11809 directly write a @code{<style>} @code{</style>} section in this way, without
11810 referring to an external file.
11812 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11813 property to assign a class to the tree.  In order to specify CSS styles for a
11814 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11815 property.
11817 @c FIXME: More about header and footer styles
11818 @c FIXME: Talk about links and targets.
11820 @node JavaScript support
11821 @subsection JavaScript supported display of web pages
11823 @cindex Rose, Sebastian
11824 Sebastian Rose has written a JavaScript program especially designed to
11825 enhance the web viewing experience of HTML files created with Org.  This
11826 program allows you to view large files in two different ways.  The first one
11827 is an @emph{Info}-like mode where each section is displayed separately and
11828 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11829 as well, press @kbd{?} for an overview of the available keys).  The second
11830 view type is a @emph{folding} view much like Org provides inside Emacs.  The
11831 script is available at @url{http://orgmode.org/org-info.js} and you can find
11832 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11833 We host the script at our site, but if you use it a lot, you might not want
11834 to be dependent on @url{http://orgmode.org} and prefer to install a local
11835 copy on your own web server.
11837 All it then takes to use this program is adding a single line to the Org
11838 file:
11840 @cindex #+INFOJS_OPT
11841 @example
11842 #+INFOJS_OPT: view:info toc:nil
11843 @end example
11845 @noindent
11846 If this line is found, the HTML header will automatically contain the code
11847 needed to invoke the script.  Using the line above, you can set the following
11848 viewing options:
11850 @example
11851 path:    @r{The path to the script.  The default is to grab the script from}
11852          @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11853          @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11854 view:    @r{Initial view when the website is first shown.  Possible values are:}
11855          info      @r{Info-like interface with one section per page.}
11856          overview  @r{Folding interface, initially showing only top-level.}
11857          content   @r{Folding interface, starting with all headlines visible.}
11858          showall   @r{Folding interface, all headlines and text visible.}
11859 sdepth:  @r{Maximum headline level that will still become an independent}
11860          @r{section for info and folding modes.  The default is taken from}
11861          @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11862          @r{If this is smaller than in @code{org-export-headline-levels}, each}
11863          @r{info/folding section can still contain child headlines.}
11864 toc:     @r{Should the table of contents @emph{initially} be visible?}
11865          @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11866 tdepth:  @r{The depth of the table of contents.  The defaults are taken from}
11867          @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11868 ftoc:    @r{Does the CSS of the page specify a fixed position for the "toc"?}
11869          @r{If yes, the toc will never be displayed as a section.}
11870 ltoc:    @r{Should there be short contents (children) in each section?}
11871          @r{Make this @code{above} if the section should be above initial text.}
11872 mouse:   @r{Headings are highlighted when the mouse is over them.  Should be}
11873          @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11874 buttons: @r{Should view-toggle buttons be everywhere?  When @code{nil} (the}
11875          @r{default), only one such button will be present.}
11876 @end example
11877 @noindent
11878 @vindex org-html-infojs-options
11879 @vindex org-html-use-infojs
11880 You can choose default values for these options by customizing the variable
11881 @code{org-html-infojs-options}.  If you always want to apply the script to your
11882 pages, configure the variable @code{org-html-use-infojs}.
11884 @node @LaTeX{} and PDF export
11885 @section @LaTeX{} and PDF export
11886 @cindex @LaTeX{} export
11887 @cindex PDF export
11889 @LaTeX{} export can produce an arbitrarily complex LaTeX document of any
11890 standard or custom document class.  With further processing@footnote{The
11891 default @LaTeX{} output is designed for processing with @code{pdftex} or
11892 @code{latex}.  The @LaTeX{} exporter can be configured to support alternative
11893 TeX engines, see see @code{org-latex-pdf-process}, and alternative packages,
11894 see @code{org-latex-default-packages-alist} and
11895 @code{org-latex-packages-alist}.}, which the @LaTeX{} exporter is able to
11896 control, this back-end is able to produce PDF output.  Because the @LaTeX{}
11897 exporter can be configured to use the @code{hyperref} package, the default
11898 setup produces fully-linked PDF output.
11900 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11901 will not be started if two contiguous syntactical elements are not separated
11902 by an empty line.
11904 This back-end also offers enhanced support for footnotes.  Thus, it handles
11905 nested footnotes, footnotes in tables and footnotes in a list item's
11906 description.
11908 @menu
11909 * @LaTeX{} export commands::    How to export to LaTeX and PDF
11910 * @LaTeX{} specific export settings::  Export settings for @LaTeX{}
11911 * Header and sectioning::       Setting up the export file structure
11912 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
11913 * @LaTeX{} specific attributes::  Controlling @LaTeX{} output
11914 @end menu
11916 @node @LaTeX{} export commands
11917 @subsection @LaTeX{} export commands
11919 @table @kbd
11920 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11921 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
11922 file will be @file{myfile.tex}.  The file will be overwritten without
11923 warning.
11924 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11925 Export to a temporary buffer.  Do not create a file.
11926 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11927 Export as @LaTeX{} and then process to PDF.
11928 @item C-c C-e l o
11929 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11930 @end table
11932 @node @LaTeX{} specific export settings
11933 @subsection @LaTeX{} specific export settings
11934 The @LaTeX{} exporter introduces a number of keywords, similar to the general
11935 options settings described in @ref{Export settings}.
11937 @table @samp
11938 @item DESCRIPTION
11939 @cindex #+DESCRIPTION (@LaTeX{})
11940 The document description.  By default these are inserted as metadata using
11941 @samp{hyperref}.  Document metadata can be configured via
11942 @code{org-latex-hyperref-template}.  Description can also be typeset as part
11943 of the front matter via @code{org-latex-title-command}.  You can use several
11944 @code{#+DESCRIPTION} keywords if the description is is long.
11946 @item LATEX_CLASS
11947 @cindex #+LATEX_CLASS
11948 @vindex org-latex-default-class
11949 @vindex org-latex-classes
11950 The predefined preamble and headline level mapping to use
11951 (@code{org-latex-default-class}).  Must be an element in
11952 @code{org-latex-classes}.
11954 @item LATEX_CLASS_OPTIONS
11955 @cindex #+LATEX_CLASS_OPTIONS
11956 Options given to the @LaTeX{} document class.
11958 @item LATEX_HEADER
11959 @cindex #+LATEX_HEADER
11960 @vindex org-latex-classes
11961 Arbitrary lines added to the preamble of the document, before the
11962 @samp{hyperref} settings.  The location can be controlled via
11963 @code{org-latex-classes}.
11965 @item LATEX_HEADER_EXTRA
11966 @cindex #+LATEX_HEADER_EXTRA
11967 @vindex org-latex-classes
11968 Arbitrary lines added to the preamble of the document, before the
11969 @samp{hyperref} settings.  The location can be controlled via
11970 @code{org-latex-classes}.
11972 @item KEYWORDS
11973 @cindex #+KEYWORDS (@LaTeX{})
11974 The keywords defining the contents of the document.  By default these are
11975 inserted as metadata using @samp{hyperref}.  Document metadata can be
11976 configured via @code{org-latex-hyperref-template}.  Description can also be
11977 typeset as part of the front matter via @code{org-latex-title-command}.  You
11978 can use several @code{#+KEYWORDS} if the description is is long.
11980 @item SUBTITLE
11981 @cindex #+SUBTITLE (@LaTeX{})
11982 @vindex org-latex-subtitle-separate
11983 @vindex org-latex-subtitle-format
11984 The document subtitle.  This is typeset according to
11985 @code{org-latex-subtitle-format}.  If @code{org-latex-subtitle-separate}
11986 is non-@code{nil} it is typed as part of the @samp{\title}-macro.  It
11987 can also access via @code{org-latex-hyperref-template} or typeset as
11988 part of the front matter via @code{org-latex-title-command}.
11989 @end table
11991 These keywords are treated in details in the following sections.
11993 @node Header and sectioning
11994 @subsection Header and sectioning structure
11995 @cindex @LaTeX{} class
11996 @cindex @LaTeX{} sectioning structure
11997 @cindex @LaTeX{} header
11998 @cindex header, for @LaTeX{} files
11999 @cindex sectioning structure, for @LaTeX{} export
12001 By default, the first three outline levels become headlines, defining a
12002 general document structure.  Additional levels are exported as @code{itemize}
12003 or @code{enumerate} lists.  The transition can also occur at a different
12004 level (@pxref{Export settings}).
12006 By default, the @LaTeX{} output uses the class @code{article}.
12008 @vindex org-latex-default-class
12009 @vindex org-latex-classes
12010 @vindex org-latex-default-packages-alist
12011 @vindex org-latex-packages-alist
12012 You can change this globally by setting a different value for
12013 @code{org-latex-default-class} or locally by adding an option like
12014 @code{#+LATEX_CLASS: myclass} in your file, or with
12015 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
12016 containing only this (sub)tree.  The class must be listed in
12017 @code{org-latex-classes}.  This variable defines a header template for each
12018 class@footnote{Into which the values of
12019 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
12020 are spliced.}, and allows you to define the sectioning structure for each
12021 class.  You can also define your own classes there.
12023 @cindex #+LATEX_CLASS
12024 @cindex #+LATEX_CLASS_OPTIONS
12025 @cindex property, EXPORT_LATEX_CLASS
12026 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
12027 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
12028 property can specify the options for the @code{\documentclass} macro.  These
12029 options have to be provided, as expected by @LaTeX{}, within square brackets.
12031 @cindex #+LATEX_HEADER
12032 @cindex #+LATEX_HEADER_EXTRA
12033 You can also use the @code{LATEX_HEADER} and
12034 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
12035 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
12036 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
12037 to add lines to the header.  See the docstring of @code{org-latex-classes} for
12038 more information.
12040 An example is shown below.
12042 @example
12043 #+LATEX_CLASS: article
12044 #+LATEX_CLASS_OPTIONS: [a4paper]
12045 #+LATEX_HEADER: \usepackage@{xyz@}
12047 * Headline 1
12048   some text
12049 @end example
12051 @node Quoting @LaTeX{} code
12052 @subsection Quoting @LaTeX{} code
12054 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
12055 inserted into the @LaTeX{} file.  Furthermore, you can add special code that
12056 should only be present in @LaTeX{} export with the following constructs:
12058 @cindex #+LATEX
12059 @cindex #+BEGIN_LATEX
12060 @example
12061 Code within @@@@latex:some code@@@@ a paragraph.
12063 #+LATEX: Literal @LaTeX{} code for export
12065 #+BEGIN_LATEX
12066 All lines between these markers are exported literally
12067 #+END_LATEX
12068 @end example
12070 @node @LaTeX{} specific attributes
12071 @subsection @LaTeX{} specific attributes
12072 @cindex #+ATTR_LATEX
12074 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line.  They
12075 affect tables, images, plain lists, special blocks and source blocks.
12077 @subsubheading Tables in @LaTeX{} export
12078 @cindex tables, in @LaTeX{} export
12080 For @LaTeX{} export of a table, you can specify a label and a caption
12081 (@pxref{Images and tables}).  You can also use attributes to control table
12082 layout and contents.  Valid @LaTeX{} attributes include:
12084 @table @code
12085 @item :mode
12086 @vindex org-latex-default-table-mode
12087 Nature of table's contents.  It can be set to @code{table}, @code{math},
12088 @code{inline-math} or @code{verbatim}.  In particular, when in @code{math} or
12089 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
12090 ignored and the table will be wrapped in a math environment.  Also,
12091 contiguous tables sharing the same math mode will be wrapped within the same
12092 environment.  Default mode is determined in
12093 @code{org-latex-default-table-mode}.
12094 @item :environment
12095 @vindex org-latex-default-table-environment
12096 Environment used for the table.  It can be set to any @LaTeX{} table
12097 environment, like @code{tabularx}@footnote{Requires adding the
12098 @code{tabularx} package to @code{org-latex-packages-alist}.},
12099 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
12100 @code{tabu} package to @code{org-latex-packages-alist}.},
12101 @code{bmatrix}@enddots{} It defaults to
12102 @code{org-latex-default-table-environment} value.
12103 @item :caption
12104 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
12105 (@pxref{Images and tables}).  If you need more advanced commands for that
12106 task, you can use @code{:caption} attribute instead.  Its value should be raw
12107 @LaTeX{} code.  It has precedence over @code{#+CAPTION}.
12108 @item :float
12109 @itemx :placement
12110 The @code{:float} specifies the float environment for the table.  Possible
12111 values are @code{sideways}@footnote{Formerly, the value was
12112 @code{sidewaystable}.  This is deprecated since Org 8.3.},
12113 @code{multicolumn}, @code{t} and @code{nil}.  When unspecified, a table with
12114 a caption will have a @code{table} environment.  Moreover, the
12115 @code{:placement} attribute can specify the positioning of the float.  Note:
12116 @code{:placement} is ignored for @code{:float sideways} tables.
12117 @item :align
12118 @itemx :font
12119 @itemx :width
12120 Set, respectively, the alignment string of the table, its font size and its
12121 width.  They only apply on regular tables.
12122 @item :spread
12123 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
12124 only takes effect when used in conjunction with the @code{:width} attribute.
12125 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
12126 value of @code{:width}.
12127 @item :booktabs
12128 @itemx :center
12129 @itemx :rmlines
12130 @vindex org-latex-tables-booktabs
12131 @vindex org-latex-tables-centered
12132 They toggle, respectively, @code{booktabs} usage (assuming the package is
12133 properly loaded), table centering and removal of every horizontal rule but
12134 the first one (in a "table.el" table only).  In particular,
12135 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
12136 activates the first (respectively second) attribute globally.
12137 @item :math-prefix
12138 @itemx :math-suffix
12139 @itemx :math-arguments
12140 A string that will be inserted, respectively, before the table within the
12141 math environment, after the table within the math environment, and between
12142 the macro name and the contents of the table.  The @code{:math-arguments}
12143 attribute is used for matrix macros that require more than one argument
12144 (e.g., @code{qbordermatrix}).
12145 @end table
12147 Thus, attributes can be used in a wide array of situations, like writing
12148 a table that will span over multiple pages, or a matrix product:
12150 @example
12151 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
12152 | ..... | ..... |
12153 | ..... | ..... |
12155 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
12156 | a | b |
12157 | c | d |
12158 #+ATTR_LATEX: :mode math :environment bmatrix
12159 | 1 | 2 |
12160 | 3 | 4 |
12161 @end example
12163 In the example below, @LaTeX{} command
12164 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
12166 @example
12167 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
12168 | ..... | ..... |
12169 | ..... | ..... |
12170 @end example
12173 @subsubheading Images in @LaTeX{} export
12174 @cindex images, inline in @LaTeX{}
12175 @cindex inlining images in @LaTeX{}
12177 Images that are linked to without a description part in the link, like
12178 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
12179 output file resulting from @LaTeX{} processing.  Org will use an
12180 @code{\includegraphics} macro to insert the image@footnote{In the case of
12181 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
12182 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
12184 You can specify specify image width or height with, respectively,
12185 @code{:width} and @code{:height} attributes.  It is also possible to add any
12186 other option with the @code{:options} attribute, as shown in the following
12187 example:
12189 @example
12190 #+ATTR_LATEX: :width 5cm :options angle=90
12191 [[./img/sed-hr4049.pdf]]
12192 @end example
12194 If you need a specific command for the caption, use @code{:caption}
12195 attribute.  It will override standard @code{#+CAPTION} value, if any.
12197 @example
12198 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
12199 [[./img/sed-hr4049.pdf]]
12200 @end example
12202 If you have specified a caption as described in @ref{Images and tables}, the
12203 picture will be wrapped into a @code{figure} environment and thus become
12204 a floating element.  You can also ask Org to export an image as a float
12205 without specifying caption by setting the @code{:float} attribute.  You may
12206 also set it to:
12207 @itemize @minus
12208 @item
12209 @code{t}: if you want to use the standard @samp{figure} environment.  It is
12210 used by default if you provide a caption to the image.
12211 @item
12212 @code{multicolumn}: if you wish to include an image which spans multiple
12213 columns in a page.  This will export the image wrapped in a @code{figure*}
12214 environment.
12215 @item
12216 @code{wrap}: if you would like to let text flow around the image.  It will
12217 make the figure occupy the left half of the page.
12218 @item
12219 @code{sideways}: if you would like the image to appear alone on a separate
12220 page rotated ninety degrees using the @code{sidewaysfigure}
12221 environment.  Setting this @code{:float} option will ignore the
12222 @code{:placement} setting.
12223 @item
12224 @code{nil}: if you need to avoid any floating environment, even when
12225 a caption is provided.
12226 @end itemize
12227 @noindent
12228 To modify the placement option of any floating environment, set the
12229 @code{placement} attribute.
12231 @example
12232 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
12233 [[./img/hst.png]]
12234 @end example
12236 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
12237 the @LaTeX{} @code{\includegraphics} macro will be commented out.
12239 @subsubheading Plain lists in @LaTeX{} export
12240 @cindex plain lists, in @LaTeX{} export
12242 Plain lists accept two optional attributes: @code{:environment} and
12243 @code{:options}.  The first one allows the use of a non-standard environment
12244 (e.g., @samp{inparaenum}).  The second one specifies additional arguments for
12245 that environment.
12247 @example
12248 #+ATTR_LATEX: :environment compactitem :options [$\circ$]
12249 - you need ``paralist'' package to reproduce this example.
12250 @end example
12252 @subsubheading Source blocks in @LaTeX{} export
12253 @cindex source blocks, in @LaTeX{} export
12255 In addition to syntax defined in @ref{Literal examples}, names and captions
12256 (@pxref{Images and tables}), source blocks also accept two additional
12257 attributes: @code{:float} and @code{:options}.
12259 You may set the former to
12260 @itemize @minus
12261 @item
12262 @code{t}: if you want to make the source block a float.  It is the default
12263 value when a caption is provided.
12264 @item
12265 @code{multicolumn}: if you wish to include a source block which spans multiple
12266 columns in a page.
12267 @item
12268 @code{nil}: if you need to avoid any floating environment, even when a caption
12269 is provided.  It is useful for source code that may not fit in a single page.
12270 @end itemize
12272 @example
12273 #+ATTR_LATEX: :float nil
12274 #+BEGIN_SRC emacs-lisp
12275 Code that may not fit in a single page.
12276 #+END_SRC
12277 @end example
12279 @vindex org-latex-listings-options
12280 @vindex org-latex-minted-options
12281 The latter allows to specify options relative to the package used to
12282 highlight code in the output (e.g., @code{listings}).  This is the local
12283 counterpart to @code{org-latex-listings-options} and
12284 @code{org-latex-minted-options} variables, which see.
12286 @example
12287 #+ATTR_LATEX: :options commentstyle=\bfseries
12288 #+BEGIN_SRC emacs-lisp
12289   (defun Fib (n)                          ; Count rabbits.
12290     (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
12291 #+END_SRC
12292 @end example
12294 @subsubheading Special blocks in @LaTeX{} export
12295 @cindex special blocks, in @LaTeX{} export
12296 @cindex abstract, in @LaTeX{} export
12297 @cindex proof, in @LaTeX{} export
12299 In @LaTeX{} back-end, special blocks become environments of the same name.
12300 Value of @code{:options} attribute will be appended as-is to that
12301 environment's opening string.  For example:
12303 @example
12304 #+BEGIN_abstract
12305 We demonstrate how to solve the Syracuse problem.
12306 #+END_abstract
12308 #+ATTR_LATEX: :options [Proof of important theorem]
12309 #+BEGIN_proof
12311 Therefore, any even number greater than 2 is the sum of two primes.
12312 #+END_proof
12313 @end example
12315 @noindent
12316 becomes
12318 @example
12319 \begin@{abstract@}
12320 We demonstrate how to solve the Syracuse problem.
12321 \end@{abstract@}
12323 \begin@{proof@}[Proof of important theorem]
12325 Therefore, any even number greater than 2 is the sum of two primes.
12326 \end@{proof@}
12327 @end example
12329 If you need to insert a specific caption command, use @code{:caption}
12330 attribute.  It will override standard @code{#+CAPTION} value, if any.  For
12331 example:
12333 @example
12334 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
12335 #+BEGIN_proof
12337 #+END_proof
12338 @end example
12340 @subsubheading Horizontal rules
12341 @cindex horizontal rules, in @LaTeX{} export
12343 Width and thickness of a given horizontal rule can be controlled with,
12344 respectively, @code{:width} and @code{:thickness} attributes:
12346 @example
12347 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
12348 -----
12349 @end example
12351 @node Markdown export
12352 @section Markdown export
12353 @cindex Markdown export
12355 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
12356 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
12357 mode buffer.
12359 It is built over HTML back-end: any construct not supported by Markdown
12360 syntax (e.g., tables) will be controlled and translated by @code{html}
12361 back-end (@pxref{HTML export}).
12363 @subheading Markdown export commands
12365 @table @kbd
12366 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
12367 Export as a text file written in Markdown syntax.  For an Org file,
12368 @file{myfile.org}, the resulting file will be @file{myfile.md}.  The file
12369 will be overwritten without warning.
12370 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
12371 Export to a temporary buffer.  Do not create a file.
12372 @item C-c C-e m o
12373 Export as a text file with Markdown syntax, then open it.
12374 @end table
12376 @subheading Header and sectioning structure
12378 @vindex org-md-headline-style
12379 Markdown export can generate both @code{atx} and @code{setext} types for
12380 headlines, according to @code{org-md-headline-style}.  The former introduces
12381 a hard limit of two levels, whereas the latter pushes it to six.  Headlines
12382 below that limit are exported as lists.  You can also set a soft limit before
12383 that one (@pxref{Export settings}).
12385 @c begin opendocument
12387 @node OpenDocument Text export
12388 @section OpenDocument Text export
12389 @cindex ODT
12390 @cindex OpenDocument
12391 @cindex export, OpenDocument
12392 @cindex LibreOffice
12394 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
12395 (ODT) format.  Documents created by this exporter use the
12396 @cite{OpenDocument-v1.2
12397 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12398 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
12399 are compatible with LibreOffice 3.4.
12401 @menu
12402 * Pre-requisites for ODT export::  What packages ODT exporter relies on
12403 * ODT export commands::         How to invoke ODT export
12404 * ODT specific export settings:: Export settings for ODT
12405 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
12406 * Applying custom styles::      How to apply custom styles to the output
12407 * Links in ODT export::         How links will be interpreted and formatted
12408 * Tables in ODT export::        How Tables are exported
12409 * Images in ODT export::        How to insert images
12410 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
12411 * Labels and captions in ODT export::  How captions are rendered
12412 * Literal examples in ODT export::  How source and example blocks are formatted
12413 * Advanced topics in ODT export::  Read this if you are a power user
12414 @end menu
12416 @node Pre-requisites for ODT export
12417 @subsection Pre-requisites for ODT export
12418 @cindex zip
12419 The ODT exporter relies on the @file{zip} program to create the final
12420 output.  Check the availability of this program before proceeding further.
12422 @node ODT export commands
12423 @subsection ODT export commands
12424 @anchor{x-export-to-odt}
12425 @cindex region, active
12426 @cindex active region
12427 @cindex transient-mark-mode
12428 @table @kbd
12429 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
12430 @cindex property EXPORT_FILE_NAME
12432 Export as OpenDocument Text file.
12434 @vindex org-odt-preferred-output-format
12435 If @code{org-odt-preferred-output-format} is specified, automatically convert
12436 the exported file to that format.  @xref{x-export-to-other-formats, ,
12437 Automatically exporting to other formats}.
12439 For an Org file @file{myfile.org}, the ODT file will be
12440 @file{myfile.odt}.  The file will be overwritten without warning.  If there
12441 is an active region,@footnote{This requires @code{transient-mark-mode} to be
12442 turned on} only the region will be exported.  If the selected region is a
12443 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
12444 tree head will become the document title.  If the tree head entry has, or
12445 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
12446 export.
12448 @kbd{C-c C-e o O}
12449 Export as an OpenDocument Text file and open the resulting file.
12451 @vindex org-odt-preferred-output-format
12452 If @code{org-odt-preferred-output-format} is specified, open the converted
12453 file instead.  @xref{x-export-to-other-formats, , Automatically exporting to
12454 other formats}.
12455 @end table
12457 @node ODT specific export settings
12458 @subsection ODT specific export settings
12459 The ODT exporter introduces a number of keywords, similar to the general
12460 options settings described in @ref{Export settings}.
12462 @table @samp
12463 @item DESCRIPTION
12464 @cindex #+DESCRIPTION (ODT)
12465 The document description.  These are inserted as document metadata.  You can
12466 use several such keywords if the list is long.
12468 @item KEYWORDS
12469 @cindex #+KEYWORDS (ODT)
12470 The keywords defining the contents of the document.  These are inserted as
12471 document metadata.  You can use several such keywords if the list is long.
12473 @item ODT_STYLES_FILE
12474 @cindex ODT_STYLES_FILE
12475 @vindex org-odt-styles-file
12476 The style file of the document (@code{org-odt-styles-file}).  See
12477 @ref{Applying custom styles} for details.
12479 @item SUBTITLE
12480 @cindex SUBTITLE (ODT)
12481 The document subtitle.
12482 @end table
12484 @node Extending ODT export
12485 @subsection Extending ODT export
12487 The ODT exporter can interface with a variety of document
12488 converters and supports popular converters out of the box.  As a result, you
12489 can use it to export to formats like @samp{doc} or convert a document from
12490 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
12492 @cindex @file{unoconv}
12493 @cindex LibreOffice
12494 If you have a working installation of LibreOffice, a document converter is
12495 pre-configured for you and you can use it right away.  If you would like to
12496 use @file{unoconv} as your preferred converter, customize the variable
12497 @code{org-odt-convert-process} to point to @code{unoconv}.  You can
12498 also use your own favorite converter or tweak the default settings of the
12499 @file{LibreOffice} and @samp{unoconv} converters.  @xref{Configuring a
12500 document converter}.
12502 @subsubheading Automatically exporting to other formats
12503 @anchor{x-export-to-other-formats}
12505 @vindex org-odt-preferred-output-format
12506 Very often, you will find yourself exporting to ODT format, only to
12507 immediately save the exported document to other formats like @samp{doc},
12508 @samp{docx}, @samp{rtf}, @samp{pdf} etc.  In such cases, you can specify your
12509 preferred output format by customizing the variable
12510 @code{org-odt-preferred-output-format}.  This way, the export commands
12511 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12512 format that is of immediate interest to you.
12514 @subsubheading Converting between document formats
12515 @anchor{x-convert-to-other-formats}
12517 There are many document converters in the wild which support conversion to
12518 and from various file formats, including, but not limited to the
12519 ODT format.  LibreOffice converter, mentioned above, is one such
12520 converter.  Once a converter is configured, you can interact with it using
12521 the following command.
12523 @vindex org-odt-convert
12524 @table @kbd
12526 @item M-x org-odt-convert RET
12527 Convert an existing document from one format to another.  With a prefix
12528 argument, also open the newly produced file.
12529 @end table
12531 @node Applying custom styles
12532 @subsection Applying custom styles
12533 @cindex styles, custom
12534 @cindex template, custom
12536 The ODT exporter ships with a set of OpenDocument styles
12537 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12538 output.  These factory styles, however, may not cater to your specific
12539 tastes.  To customize the output, you can either modify the above styles
12540 files directly, or generate the required styles using an application like
12541 LibreOffice.  The latter method is suitable for expert and non-expert
12542 users alike, and is described here.
12544 @subsubheading Applying custom styles: the easy way
12546 @enumerate
12547 @item
12548 Create a sample @file{example.org} file with the below settings and export it
12549 to ODT format.
12551 @example
12552 #+OPTIONS: H:10 num:t
12553 @end example
12555 @item
12556 Open the above @file{example.odt} using LibreOffice.  Use the @file{Stylist}
12557 to locate the target styles---these typically have the @samp{Org} prefix---and
12558 modify those to your taste.  Save the modified file either as an
12559 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12561 @item
12562 @cindex #+ODT_STYLES_FILE
12563 @vindex org-odt-styles-file
12564 Customize the variable @code{org-odt-styles-file} and point it to the
12565 newly created file.  For additional configuration options
12566 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12568 If you would like to choose a style on a per-file basis, you can use the
12569 @code{#+ODT_STYLES_FILE} option.  A typical setting will look like
12571 @example
12572 #+ODT_STYLES_FILE: "/path/to/example.ott"
12573 @end example
12577 @example
12578 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12579 @end example
12581 @end enumerate
12583 @subsubheading Using third-party styles and templates
12585 You can use third-party styles and templates for customizing your output.
12586 This will produce the desired output only if the template provides all
12587 style names that the @samp{ODT} exporter relies on.  Unless this condition is
12588 met, the output is going to be less than satisfactory.  So it is highly
12589 recommended that you only work with templates that are directly derived from
12590 the factory settings.
12592 @node Links in ODT export
12593 @subsection Links in ODT export
12594 @cindex links, in ODT export
12596 ODT exporter creates native cross-references for internal links.  It creates
12597 Internet-style links for all other links.
12599 A link with no description and destined to a regular (un-itemized) outline
12600 heading is replaced with a cross-reference and section number of the heading.
12602 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
12603 with a cross-reference and sequence number of the labeled entity.
12604 @xref{Labels and captions in ODT export}.
12606 @node Tables in ODT export
12607 @subsection Tables in ODT export
12608 @cindex tables, in ODT export
12610 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12611 tables is supported.  However, export of complex @file{table.el} tables---tables
12612 that have column or row spans---is not supported.  Such tables are
12613 stripped from the exported document.
12615 By default, a table is exported with top and bottom frames and with rules
12616 separating row and column groups (@pxref{Column groups}).  Furthermore, all
12617 tables are typeset to occupy the same width.  If the table specifies
12618 alignment and relative width for its columns (@pxref{Column width and
12619 alignment}) then these are honored on export.@footnote{The column widths are
12620 interpreted as weighted ratios with the default weight being 1}
12622 @cindex #+ATTR_ODT
12623 You can control the width of the table by specifying @code{:rel-width}
12624 property using an @code{#+ATTR_ODT} line.
12626 For example, consider the following table which makes use of all the rules
12627 mentioned above.
12629 @example
12630 #+ATTR_ODT: :rel-width 50
12631 | Area/Month    |   Jan |   Feb |   Mar |   Sum |
12632 |---------------+-------+-------+-------+-------|
12633 | /             |     < |       |       |     < |
12634 | <l13>         |  <r5> |  <r5> |  <r5> |  <r6> |
12635 | North America |     1 |    21 |   926 |   948 |
12636 | Middle East   |     6 |    75 |   844 |   925 |
12637 | Asia Pacific  |     9 |    27 |   790 |   826 |
12638 |---------------+-------+-------+-------+-------|
12639 | Sum           |    16 |   123 |  2560 |  2699 |
12640 @end example
12642 On export, the table will occupy 50% of text area.  The columns will be sized
12643 (roughly) in the ratio of 13:5:5:5:6.  The first column will be left-aligned
12644 and rest of the columns will be right-aligned.  There will be vertical rules
12645 after separating the header and last columns from other columns.  There will
12646 be horizontal rules separating the header and last rows from other rows.
12648 If you are not satisfied with the above formatting options, you can create
12649 custom table styles and associate them with a table using the
12650 @code{#+ATTR_ODT} line.  @xref{Customizing tables in ODT export}.
12652 @node Images in ODT export
12653 @subsection Images in ODT export
12654 @cindex images, embedding in ODT
12655 @cindex embedding images in ODT
12657 @subsubheading Embedding images
12658 You can embed images within the exported document by providing a link to the
12659 desired image file with no link description.  For example, to embed
12660 @samp{img.png} do either of the following:
12662 @example
12663 [[file:img.png]]
12664 @end example
12666 @example
12667 [[./img.png]]
12668 @end example
12670 @subsubheading Embedding clickable images
12671 You can create clickable images by providing a link whose description is a
12672 link to an image file.  For example, to embed a image
12673 @file{org-mode-unicorn.png} which when clicked jumps to
12674 @uref{http://Orgmode.org} website, do the following
12676 @example
12677 [[http://orgmode.org][./org-mode-unicorn.png]]
12678 @end example
12680 @subsubheading Sizing and scaling of embedded images
12682 @cindex #+ATTR_ODT
12683 You can control the size and scale of the embedded images using the
12684 @code{#+ATTR_ODT} attribute.
12686 @cindex identify, ImageMagick
12687 @vindex org-odt-pixels-per-inch
12688 The exporter specifies the desired size of the image in the final document in
12689 units of centimeters.  In order to scale the embedded images, the exporter
12690 queries for pixel dimensions of the images using one of a) ImageMagick's
12691 @file{identify} program or b) Emacs `create-image' and `image-size'
12692 APIs@footnote{Use of @file{ImageMagick} is only desirable.  However, if you
12693 routinely produce documents that have large images or you export your Org
12694 files that has images using a Emacs batch script, then the use of
12695 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12696 converted in to units of centimeters using
12697 @code{org-odt-pixels-per-inch}.  The default value of this variable is
12698 set to @code{display-pixels-per-inch}.  You can tweak this variable to
12699 achieve the best results.
12701 The examples below illustrate the various possibilities.
12703 @table @asis
12704 @item Explicitly size the image
12705 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12707 @example
12708 #+ATTR_ODT: :width 10 :height 10
12709 [[./img.png]]
12710 @end example
12712 @item Scale the image
12713 To embed @file{img.png} at half its size, do the following:
12715 @example
12716 #+ATTR_ODT: :scale 0.5
12717 [[./img.png]]
12718 @end example
12720 @item Scale the image to a specific width
12721 To embed @file{img.png} with a width of 10 cm while retaining the original
12722 height:width ratio, do the following:
12724 @example
12725 #+ATTR_ODT: :width 10
12726 [[./img.png]]
12727 @end example
12729 @item Scale the image to a specific height
12730 To embed @file{img.png} with a height of 10 cm while retaining the original
12731 height:width ratio, do the following
12733 @example
12734 #+ATTR_ODT: :height 10
12735 [[./img.png]]
12736 @end example
12737 @end table
12739 @subsubheading Anchoring of images
12741 @cindex #+ATTR_ODT
12742 You can control the manner in which an image is anchored by setting the
12743 @code{:anchor} property of it's @code{#+ATTR_ODT} line.  You can specify one
12744 of the following three values for the @code{:anchor} property:
12745 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12747 To create an image that is anchored to a page, do the following:
12748 @example
12749 #+ATTR_ODT: :anchor "page"
12750 [[./img.png]]
12751 @end example
12753 @node Math formatting in ODT export
12754 @subsection Math formatting in ODT export
12756 The ODT exporter has special support for handling math.
12758 @menu
12759 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
12760 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
12761 @end menu
12763 @node Working with @LaTeX{} math snippets
12764 @subsubheading Working with @LaTeX{} math snippets
12766 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12767 document in one of the following ways:
12769 @cindex MathML
12770 @enumerate
12771 @item MathML
12773 This option is activated on a per-file basis with
12775 @example
12776 #+OPTIONS: LaTeX:t
12777 @end example
12779 With this option, @LaTeX{} fragments are first converted into MathML
12780 fragments using an external @LaTeX{}-to-MathML converter program.  The
12781 resulting MathML fragments are then embedded as an OpenDocument Formula in
12782 the exported document.
12784 @vindex org-latex-to-mathml-convert-command
12785 @vindex org-latex-to-mathml-jar-file
12787 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12788 @code{org-latex-to-mathml-convert-command} and
12789 @code{org-latex-to-mathml-jar-file}.
12791 To use MathToWeb@footnote{See
12792 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}.} as your
12793 converter, you can configure the above variables as
12795 @lisp
12796 (setq org-latex-to-mathml-convert-command
12797       "java -jar %j -unicode -force -df %o %I"
12798       org-latex-to-mathml-jar-file
12799       "/path/to/mathtoweb.jar")
12800 @end lisp
12801 To use @LaTeX{}ML@footnote{See @uref{http://dlmf.nist.gov/LaTeXML/}.} use
12802 @lisp
12803 (setq org-latex-to-mathml-convert-command
12804       "latexmlmath \"%i\" --presentationmathml=%o")
12805 @end lisp
12807 You can use the following commands to quickly verify the reliability of
12808 the @LaTeX{}-to-MathML converter.
12810 @table @kbd
12811 @item M-x org-odt-export-as-odf RET
12812 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12814 @item M-x org-odt-export-as-odf-and-open RET
12815 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12816 and open the formula file with the system-registered application.
12817 @end table
12819 @cindex dvipng
12820 @cindex imagemagick
12821 @item PNG images
12823 This option is activated on a per-file basis with
12825 @example
12826 #+OPTIONS: tex:dvipng
12827 @end example
12831 @example
12832 #+OPTIONS: tex:imagemagick
12833 @end example
12835 With this option, @LaTeX{} fragments are processed into PNG images and the
12836 resulting images are embedded in the exported document.  This method requires
12837 that the @file{dvipng} program or @file{imagemagick} suite be available on
12838 your system.
12839 @end enumerate
12841 @node Working with MathML or OpenDocument formula files
12842 @subsubheading Working with MathML or OpenDocument formula files
12844 For various reasons, you may find embedding @LaTeX{} math snippets in an
12845 ODT document less than reliable.  In that case, you can embed a
12846 math equation by linking to its MathML (@file{.mml}) source or its
12847 OpenDocument formula (@file{.odf}) file as shown below:
12849 @example
12850 [[./equation.mml]]
12851 @end example
12855 @example
12856 [[./equation.odf]]
12857 @end example
12859 @node Labels and captions in ODT export
12860 @subsection Labels and captions in ODT export
12862 You can label and caption various category of objects---an inline image, a
12863 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12864 @code{#+CAPTION} lines.  @xref{Images and tables}.  ODT exporter enumerates
12865 each labeled or captioned object of a given category separately.  As a
12866 result, each such object is assigned a sequence number based on order of it's
12867 appearance in the Org file.
12869 In the exported document, a user-provided caption is augmented with the
12870 category and sequence number.  Consider the following inline image in an Org
12871 file.
12873 @example
12874 #+CAPTION: Bell curve
12875 #+LABEL:   fig:SED-HR4049
12876 [[./img/a.png]]
12877 @end example
12879 It could be rendered as shown below in the exported document.
12881 @example
12882 Figure 2: Bell curve
12883 @end example
12885 @vindex org-odt-category-map-alist
12886 You can modify the category component of the caption by customizing the
12887 option @code{org-odt-category-map-alist}.  For example, to tag all embedded
12888 images with the string @samp{Illustration} (instead of the default
12889 @samp{Figure}) use the following setting:
12891 @lisp
12892 (setq org-odt-category-map-alist
12893       (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12894 @end lisp
12896 With this, previous image will be captioned as below in the exported
12897 document.
12899 @example
12900 Illustration 2: Bell curve
12901 @end example
12903 @node Literal examples in ODT export
12904 @subsection Literal examples in ODT export
12906 Export of literal examples (@pxref{Literal examples}) with full fontification
12907 is supported.  Internally, the exporter relies on @file{htmlfontify.el} to
12908 generate all style definitions needed for a fancy listing.@footnote{Your
12909 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
12910 fontification to be turned on.}  The auto-generated styles have @samp{OrgSrc}
12911 as prefix and inherit their color from the faces used by Emacs
12912 @code{font-lock} library for the source language.
12914 @vindex org-odt-fontify-srcblocks
12915 If you prefer to use your own custom styles for fontification, you can do
12916 so by customizing the option
12917 @code{org-odt-create-custom-styles-for-srcblocks}.
12919 @vindex org-odt-create-custom-styles-for-srcblocks
12920 You can turn off fontification of literal examples by customizing the
12921 option @code{org-odt-fontify-srcblocks}.
12923 @node Advanced topics in ODT export
12924 @subsection Advanced topics in ODT export
12926 If you rely heavily on ODT export, you may want to exploit the full
12927 set of features that the exporter offers.  This section describes features
12928 that would be of interest to power users.
12930 @menu
12931 * Configuring a document converter::  How to register a document converter
12932 * Working with OpenDocument style files::  Explore the internals
12933 * Creating one-off styles::     How to produce custom highlighting etc
12934 * Customizing tables in ODT export::  How to define and use Table templates
12935 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
12936 @end menu
12938 @node Configuring a document converter
12939 @subsubheading Configuring a document converter
12940 @cindex convert
12941 @cindex doc, docx, rtf
12942 @cindex converter
12944 The ODT exporter can work with popular converters with little or no
12945 extra configuration from your side. @xref{Extending ODT export}.
12946 If you are using a converter that is not supported by default or if you would
12947 like to tweak the default converter settings, proceed as below.
12949 @enumerate
12950 @item Register the converter
12952 @vindex org-odt-convert-processes
12953 Name your converter and add it to the list of known converters by
12954 customizing the option @code{org-odt-convert-processes}.  Also specify how
12955 the converter can be invoked via command-line to effect the conversion.
12957 @item Configure its capabilities
12959 @vindex org-odt-convert-capabilities
12960 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12961 converter can handle by customizing the variable
12962 @code{org-odt-convert-capabilities}.  Use the default value for this
12963 variable as a guide for configuring your converter.  As suggested by the
12964 default setting, you can specify the full set of formats supported by the
12965 converter and not limit yourself to specifying formats that are related to
12966 just the OpenDocument Text format.
12968 @item Choose the converter
12970 @vindex org-odt-convert-process
12971 Select the newly added converter as the preferred one by customizing the
12972 option @code{org-odt-convert-process}.
12973 @end enumerate
12975 @node Working with OpenDocument style files
12976 @subsubheading Working with OpenDocument style files
12977 @cindex styles, custom
12978 @cindex template, custom
12980 This section explores the internals of the ODT exporter and the
12981 means by which it produces styled documents.  Read this section if you are
12982 interested in exploring the automatic and custom OpenDocument styles used by
12983 the exporter.
12985 @anchor{x-factory-styles}
12986 @subsubheading a) Factory styles
12988 The ODT exporter relies on two files for generating its output.
12989 These files are bundled with the distribution under the directory pointed to
12990 by the variable @code{org-odt-styles-dir}.  The two files are:
12992 @itemize
12993 @anchor{x-orgodtstyles-xml}
12994 @item
12995 @file{OrgOdtStyles.xml}
12997 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12998 document.  This file gets modified for the following purposes:
12999 @enumerate
13001 @item
13002 To control outline numbering based on user settings.
13004 @item
13005 To add styles generated by @file{htmlfontify.el} for fontification of code
13006 blocks.
13007 @end enumerate
13009 @anchor{x-orgodtcontenttemplate-xml}
13010 @item
13011 @file{OrgOdtContentTemplate.xml}
13013 This file contributes to the @file{content.xml} file of the final @samp{ODT}
13014 document.  The contents of the Org outline are inserted between the
13015 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
13017 Apart from serving as a template file for the final @file{content.xml}, the
13018 file serves the following purposes:
13019 @enumerate
13021 @item
13022 It contains automatic styles for formatting of tables which are referenced by
13023 the exporter.
13025 @item
13026 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
13027 elements that control how various entities---tables, images, equations,
13028 etc.---are numbered.
13029 @end enumerate
13030 @end itemize
13032 @anchor{x-overriding-factory-styles}
13033 @subsubheading b) Overriding factory styles
13034 The following two variables control the location from which the ODT
13035 exporter picks up the custom styles and content template files.  You can
13036 customize these variables to override the factory styles used by the
13037 exporter.
13039 @itemize
13040 @anchor{x-org-odt-styles-file}
13041 @item
13042 @code{org-odt-styles-file}
13044 Use this variable to specify the @file{styles.xml} that will be used in the
13045 final output.  You can specify one of the following values:
13047 @enumerate
13048 @item A @file{styles.xml} file
13050 Use this file instead of the default @file{styles.xml}
13052 @item A @file{.odt} or @file{.ott} file
13054 Use the @file{styles.xml} contained in the specified OpenDocument Text or
13055 Template file
13057 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
13059 Use the @file{styles.xml} contained in the specified OpenDocument Text or
13060 Template file.  Additionally extract the specified member files and embed
13061 those within the final @samp{ODT} document.
13063 Use this option if the @file{styles.xml} file references additional files
13064 like header and footer images.
13066 @item @code{nil}
13068 Use the default @file{styles.xml}
13069 @end enumerate
13071 @anchor{x-org-odt-content-template-file}
13072 @item
13073 @code{org-odt-content-template-file}
13075 Use this variable to specify the blank @file{content.xml} that will be used
13076 in the final output.
13077 @end itemize
13079 @node Creating one-off styles
13080 @subsubheading Creating one-off styles
13082 There are times when you would want one-off formatting in the exported
13083 document.  You can achieve this by embedding raw OpenDocument XML in the Org
13084 file.  The use of this feature is better illustrated with couple of examples.
13086 @enumerate
13087 @item Embedding ODT tags as part of regular text
13089 You can inline OpenDocument syntax by enclosing it within
13090 @samp{@@@@odt:...@@@@} markup.  For example, to highlight a region of text do
13091 the following:
13093 @example
13094 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
13095 text</text:span>@@@@.  But this is a regular text.
13096 @end example
13098 @strong{Hint:} To see the above example in action, edit your
13099 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
13100 custom @samp{Highlight} style as shown below.
13102 @example
13103 <style:style style:name="Highlight" style:family="text">
13104   <style:text-properties fo:background-color="#ff0000"/>
13105 </style:style>
13106 @end example
13108 @item Embedding a one-line OpenDocument XML
13110 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
13111 directive.  For example, to force a page break do the following:
13113 @example
13114 #+ODT: <text:p text:style-name="PageBreak"/>
13115 @end example
13117 @strong{Hint:} To see the above example in action, edit your
13118 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
13119 custom @samp{PageBreak} style as shown below.
13121 @example
13122 <style:style style:name="PageBreak" style:family="paragraph"
13123              style:parent-style-name="Text_20_body">
13124   <style:paragraph-properties fo:break-before="page"/>
13125 </style:style>
13126 @end example
13128 @item Embedding a block of OpenDocument XML
13130 You can add a large block of OpenDocument XML using the
13131 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
13133 For example, to create a one-off paragraph that uses bold text, do the
13134 following:
13136 @example
13137 #+BEGIN_ODT
13138 <text:p text:style-name="Text_20_body_20_bold">
13139 This paragraph is specially formatted and uses bold text.
13140 </text:p>
13141 #+END_ODT
13142 @end example
13144 @end enumerate
13146 @node Customizing tables in ODT export
13147 @subsubheading Customizing tables in ODT export
13148 @cindex tables, in ODT export
13150 @cindex #+ATTR_ODT
13151 You can override the default formatting of the table by specifying a custom
13152 table style with the @code{#+ATTR_ODT} line.  For a discussion on default
13153 formatting of tables @pxref{Tables in ODT export}.
13155 This feature closely mimics the way table templates are defined in the
13156 OpenDocument-v1.2
13157 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
13158 OpenDocument-v1.2 Specification}}
13160 @vindex org-odt-table-styles
13161 To have a quick preview of this feature, install the below setting and
13162 export the table that follows:
13164 @lisp
13165 (setq org-odt-table-styles
13166       (append org-odt-table-styles
13167             '(("TableWithHeaderRowAndColumn" "Custom"
13168                 ((use-first-row-styles . t)
13169                  (use-first-column-styles . t)))
13170                 ("TableWithFirstRowandLastRow" "Custom"
13171                  ((use-first-row-styles . t)
13172                  (use-last-row-styles . t))))))
13173 @end lisp
13175 @example
13176 #+ATTR_ODT: :style TableWithHeaderRowAndColumn
13177 | Name  | Phone | Age |
13178 | Peter |  1234 |  17 |
13179 | Anna  |  4321 |  25 |
13180 @end example
13182 In the above example, you used a template named @samp{Custom} and installed
13183 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
13184 @samp{TableWithFirstRowandLastRow}.  (@strong{Important:} The OpenDocument
13185 styles needed for producing the above template have been pre-defined for
13186 you.  These styles are available under the section marked @samp{Custom
13187 Table Template} in @file{OrgOdtContentTemplate.xml}
13188 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}).  If you need
13189 additional templates you have to define these styles yourselves.
13191 To use this feature proceed as follows:
13193 @enumerate
13194 @item
13195 Create a table template@footnote{See the @code{<table:table-template>}
13196 element of the OpenDocument-v1.2 specification}
13198 A table template is nothing but a set of @samp{table-cell} and
13199 @samp{paragraph} styles for each of the following table cell categories:
13201 @itemize @minus
13202 @item Body
13203 @item First column
13204 @item Last column
13205 @item First row
13206 @item Last row
13207 @item Even row
13208 @item Odd row
13209 @item Even column
13210 @item Odd Column
13211 @end itemize
13213 The names for the above styles must be chosen based on the name of the table
13214 template using a well-defined convention.
13216 The naming convention is better illustrated with an example.  For a table
13217 template with the name @samp{Custom}, the needed style names are listed in
13218 the following table.
13220 @multitable  {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
13221 @headitem Table cell type
13222 @tab @code{table-cell} style
13223 @tab @code{paragraph} style
13224 @item
13225 @tab
13226 @tab
13227 @item Body
13228 @tab @samp{CustomTableCell}
13229 @tab @samp{CustomTableParagraph}
13230 @item First column
13231 @tab @samp{CustomFirstColumnTableCell}
13232 @tab @samp{CustomFirstColumnTableParagraph}
13233 @item Last column
13234 @tab @samp{CustomLastColumnTableCell}
13235 @tab @samp{CustomLastColumnTableParagraph}
13236 @item First row
13237 @tab @samp{CustomFirstRowTableCell}
13238 @tab @samp{CustomFirstRowTableParagraph}
13239 @item Last row
13240 @tab @samp{CustomLastRowTableCell}
13241 @tab @samp{CustomLastRowTableParagraph}
13242 @item Even row
13243 @tab @samp{CustomEvenRowTableCell}
13244 @tab @samp{CustomEvenRowTableParagraph}
13245 @item Odd row
13246 @tab @samp{CustomOddRowTableCell}
13247 @tab @samp{CustomOddRowTableParagraph}
13248 @item Even column
13249 @tab @samp{CustomEvenColumnTableCell}
13250 @tab @samp{CustomEvenColumnTableParagraph}
13251 @item Odd column
13252 @tab @samp{CustomOddColumnTableCell}
13253 @tab @samp{CustomOddColumnTableParagraph}
13254 @end multitable
13256 To create a table template with the name @samp{Custom}, define the above
13257 styles in the
13258 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
13259 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
13260 styles}).
13262 @item
13263 Define a table style@footnote{See the attributes @code{table:template-name},
13264 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
13265 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
13266 @code{table:use-banding-rows-styles}, and
13267 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
13268 the OpenDocument-v1.2 specification}
13270 @vindex org-odt-table-styles
13271 To define a table style, create an entry for the style in the variable
13272 @code{org-odt-table-styles} and specify the following:
13274 @itemize @minus
13275 @item the name of the table template created in step (1)
13276 @item the set of cell styles in that template that are to be activated
13277 @end itemize
13279 For example, the entry below defines two different table styles
13280 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
13281 based on the same template @samp{Custom}.  The styles achieve their intended
13282 effect by selectively activating the individual cell styles in that template.
13284 @lisp
13285 (setq org-odt-table-styles
13286       (append org-odt-table-styles
13287               '(("TableWithHeaderRowAndColumn" "Custom"
13288                  ((use-first-row-styles . t)
13289                   (use-first-column-styles . t)))
13290                 ("TableWithFirstRowandLastRow" "Custom"
13291                  ((use-first-row-styles . t)
13292                   (use-last-row-styles . t))))))
13293 @end lisp
13295 @item
13296 Associate a table with the table style
13298 To do this, specify the table style created in step (2) as part of
13299 the @code{ATTR_ODT} line as shown below.
13301 @example
13302 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
13303 | Name  | Phone | Age |
13304 | Peter |  1234 |  17 |
13305 | Anna  |  4321 |  25 |
13306 @end example
13307 @end enumerate
13309 @node Validating OpenDocument XML
13310 @subsubheading Validating OpenDocument XML
13312 Occasionally, you will discover that the document created by the
13313 ODT exporter cannot be opened by your favorite application.  One of
13314 the common reasons for this is that the @file{.odt} file is corrupt.  In such
13315 cases, you may want to validate the document against the OpenDocument RELAX
13316 NG Compact Syntax (RNC) schema.
13318 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
13319 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}.  For
13320 general help with validation (and schema-sensitive editing) of XML files:
13321 @inforef{Introduction,,nxml-mode}.
13323 @vindex org-odt-schema-dir
13324 If you have ready access to OpenDocument @file{.rnc} files and the needed
13325 schema-locating rules in a single folder, you can customize the variable
13326 @code{org-odt-schema-dir} to point to that directory.  The ODT exporter
13327 will take care of updating the @code{rng-schema-locating-files} for you.
13329 @c end opendocument
13331 @node Org export
13332 @section Org export
13333 @cindex Org export
13335 @code{org} export back-end creates a normalized version of the Org document
13336 in current buffer.  In particular, it evaluates Babel code (@pxref{Evaluating
13337 code blocks}) and removes other back-ends specific contents.
13339 @subheading Org export commands
13341 @table @kbd
13342 @orgcmd{C-c C-e O o,org-org-export-to-org}
13343 Export as an Org document.  For an Org file, @file{myfile.org}, the resulting
13344 file will be @file{myfile.org.org}.  The file will be overwritten without
13345 warning.
13346 @orgcmd{C-c C-e O O,org-org-export-as-org}
13347 Export to a temporary buffer.  Do not create a file.
13348 @item C-c C-e O v
13349 Export to an Org file, then open it.
13350 @end table
13352 @node Texinfo export
13353 @section Texinfo export
13354 @cindex Texinfo export
13356 @samp{texinfo} export back-end generates Texinfo code and can compile it into
13357 an Info file.
13359 @menu
13360 * Texinfo export commands::     How to invoke Texinfo export
13361 * Texinfo specific export settings:: Export settings for Texinfo
13362 * Document preamble::           File header, title and copyright page
13363 * Headings and sectioning structure:: Building document structure
13364 * Indices::                     Creating indices
13365 * Quoting Texinfo code::        Incorporating literal Texinfo code
13366 * Texinfo specific attributes:: Controlling Texinfo output
13367 * An example::
13368 @end menu
13370 @node Texinfo export commands
13371 @subsection Texinfo export commands
13373 @vindex org-texinfo-info-process
13374 @table @kbd
13375 @orgcmd{C-c C-e i t,org-texinfo-export-to-texinfo}
13376 Export as a Texinfo file.  For an Org file, @file{myfile.org}, the resulting
13377 file will be @file{myfile.texi}.  The file will be overwritten without
13378 warning.
13379 @orgcmd{C-c C-e i i,org-texinfo-export-to-info}
13380 Export to Texinfo and then process to an Info file@footnote{By setting
13381 @code{org-texinfo-info-process}, it is possible to generate other formats,
13382 including DocBook.}.
13383 @end table
13385 @node Texinfo specific export settings
13386 @subsection Texinfo specific export settings
13387 The Texinfo exporter introduces a number of keywords, similar to the general
13388 options settings described in @ref{Export settings}.
13390 @table @samp
13392 @item SUBTITLE
13393 @cindex #+SUBTITLE (Texinfo)
13394 The document subtitle.
13396 @item SUBAUTHOR
13397 @cindex #+SUBAUTHOR
13398 The document subauthor.
13400 @item TEXINFO_FILENAME
13401 @cindex #+TEXINFO_FILENAME
13402 The Texinfo filename.
13404 @item TEXINFO_CLASS
13405 @cindex #+TEXINFO_CLASS
13406 @vindex org-texinfo-default-class
13407 The class of the document (@code{org-texinfo-default-class}).  This must be a
13408 member of @code{org-texinfo-classes}.
13410 @item TEXINFO_HEADER
13411 @cindex #+TEXINFO_HEADER
13412 Arbitrary lines inserted at the end of the preamble.
13414 @item TEXINFO_POST_HEADER
13415 @cindex #+TEXINFO_POST_HEADER
13416 Arbitrary lines inserted at the end of the preamble.
13418 @item TEXINFO_DIR_CATEGORY
13419 @cindex #+TEXINFO_DIR_CATEGORY
13420 The directory category of the document.
13422 @item TEXINFO_DIR_TITLE
13423 @cindex #+TEXINFO_DIR_TITLE
13424 The directory title of the document.
13426 @item TEXINFO_DIR_DESC
13427 @cindex #+TEXINFO_DIR_DESC
13428 The directory description of the document.
13430 @item TEXINFO_PRINTED_TITLE
13431 @cindex #+TEXINFO_PRINTED_TITLE
13432 The printed title of the document.
13433 @end table
13435 These keywords are treated in details in the following sections.
13437 @node Document preamble
13438 @subsection Document preamble
13440 When processing a document, @samp{texinfo} back-end generates a minimal file
13441 header along with a title page, a copyright page, and a menu.  You control
13442 the latter through the structure of the document (@pxref{Headings and
13443 sectioning structure}).  Various keywords allow to tweak the other parts.  It
13444 is also possible to give directions to install the document in the @samp{Top}
13445 node.
13447 @subsubheading File header
13449 @cindex #+TEXINFO_FILENAME
13450 Upon creating the header of a Texinfo file, the back-end guesses a name for
13451 the Info file to be compiled.  This may not be a sensible choice, e.g., if
13452 you want to produce the final document in a different directory.  Specify an
13453 alternate path with @code{#+TEXINFO_FILENAME} keyword to override the default
13454 destination.
13456 @vindex org-texinfo-coding-system
13457 @vindex org-texinfo-classes
13458 @cindex #+TEXINFO_HEADER
13459 @cindex #+TEXINFO_CLASS
13460 Along with the output file name, the header contains information about the
13461 language (@pxref{Export settings}) and current encoding used@footnote{See
13462 @code{org-texinfo-coding-system} for more information.}.  Insert
13463 a @code{#+TEXINFO_HEADER} keyword for each additional command needed, e.g.,
13464 @@code@{@@synindex@}.
13466 If you happen to regularly install the same set of commands, it may be easier
13467 to define your own class in @code{org-texinfo-classes}, which see.  Set
13468 @code{#+TEXINFO_CLASS} keyword accordingly in your document to activate it.
13470 @subsubheading Title and copyright page
13472 @cindex #+TEXINFO_PRINTED_TITLE
13473 The default template includes a title page for hard copy output.  The title
13474 and author displayed on this page are extracted from, respectively,
13475 @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}).  It is
13476 also possible to print a different, more specific, title with
13477 @code{#+TEXINFO_PRINTED_TITLE} keyword, and add subtitles with
13478 @code{#+SUBTITLE} keyword.  Both expect raw Texinfo code in their value.
13480 @cindex #+SUBAUTHOR
13481 Likewise, information brought by @code{#+AUTHOR} may not be enough.  You can
13482 include other authors with several @code{#+SUBAUTHOR} keywords.  Values are
13483 also expected to be written in Texinfo code.
13485 @example
13486 #+AUTHOR: Jane Smith
13487 #+SUBAUTHOR: John Doe
13488 #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@}
13489 @end example
13491 @cindex property, COPYING
13492 Copying material is defined in a dedicated headline with a non-@code{nil}
13493 @code{:COPYING:} property.  The contents are inserted within
13494 a @code{@@copying} command at the beginning of the document whereas the
13495 heading itself does not appear in the structure of the document.
13497 Copyright information is printed on the back of the title page.
13499 @example
13500 * Copying
13501   :PROPERTIES:
13502   :COPYING: t
13503   :END:
13505   This is a short example of a complete Texinfo file, version 1.0.
13507   Copyright \copy 2014 Free Software Foundation, Inc.
13508 @end example
13510 @subsubheading The Top node
13512 @cindex #+TEXINFO_DIR_CATEGORY
13513 @cindex #+TEXINFO_DIR_TITLE
13514 @cindex #+TEXINFO_DIR_DESC
13515 You may ultimately want to install your new Info file in your system.  You
13516 can write an appropriate entry in the top level directory specifying its
13517 category and title with, respectively, @code{#+TEXINFO_DIR_CATEGORY} and
13518 @code{#+TEXINFO_DIR_TITLE}.  Optionally, you can add a short description
13519 using @code{#+TEXINFO_DIR_DESC}.  The following example would write an entry
13520 similar to Org's in the @samp{Top} node.
13522 @example
13523 #+TEXINFO_DIR_CATEGORY: Emacs
13524 #+TEXINFO_DIR_TITLE: Org Mode: (org)
13525 #+TEXINFO_DIR_DESC: Outline-based notes management and organizer
13526 @end example
13528 @node Headings and sectioning structure
13529 @subsection Headings and sectioning structure
13531 @vindex org-texinfo-classes
13532 @vindex org-texinfo-default-class
13533 @cindex #+TEXINFO_CLASS
13534 @samp{texinfo} uses a pre-defined scheme, or class, to convert headlines into
13535 Texinfo structuring commands.  For example, a top level headline appears as
13536 @code{@@chapter} if it should be numbered or as @code{@@unnumbered}
13537 otherwise.  If you need to use a different set of commands, e.g., to start
13538 with @code{@@part} instead of @code{@@chapter}, install a new class in
13539 @code{org-texinfo-classes}, then activate it with @code{#+TEXINFO_CLASS}
13540 keyword.  Export process defaults to @code{org-texinfo-default-class} when
13541 there is no such keyword in the document.
13543 If a headline's level has no associated structuring command, or is below
13544 a certain threshold (@pxref{Export settings}), that headline becomes a list
13545 in Texinfo output.
13547 @cindex property, APPENDIX
13548 As an exception, a headline with a non-@code{nil} @code{:APPENDIX:} property becomes
13549 an appendix, independently on its level and the class used.
13551 @cindex property, DESCRIPTION
13552 Each regular sectioning structure creates a menu entry, named after the
13553 heading.  You can provide a different, e.g., shorter, title in
13554 @code{:ALT_TITLE:} property (@pxref{Table of contents}).  Optionally, you can
13555 specify a description for the item in @code{:DESCRIPTION:} property.  E.g.,
13557 @example
13558 * Controlling Screen Display
13559   :PROPERTIES:
13560   :ALT_TITLE: Display
13561   :DESCRIPTION: Controlling Screen Display
13562   :END:
13563 @end example
13565 @node Indices
13566 @subsection Indices
13568 @cindex #+CINDEX
13569 @cindex #+FINDEX
13570 @cindex #+KINDEX
13571 @cindex #+PINDEX
13572 @cindex #+TINDEX
13573 @cindex #+VINDEX
13574 Index entries are created using dedicated keywords.  @samp{texinfo} back-end
13575 provides one for each predefined type: @code{#+CINDEX}, @code{#+FINDEX},
13576 @code{#+KINDEX}, @code{#+PINDEX}, @code{#+TINDEX} and @code{#+VINDEX}.  For
13577 custom indices, you can write raw Texinfo code (@pxref{Quoting Texinfo
13578 code}).
13580 @example
13581 #+CINDEX: Defining indexing entries
13582 @end example
13584 @cindex property, INDEX
13585 To generate an index, you need to set the @code{:INDEX:} property of
13586 a headline to an appropriate abbreviation (e.g., @samp{cp} or @samp{vr}).
13587 The headline is then exported as an unnumbered chapter or section command and
13588 the index is inserted after its contents.
13590 @example
13591 * Concept Index
13592   :PROPERTIES:
13593   :INDEX: cp
13594   :END:
13595 @end example
13597 @node Quoting Texinfo code
13598 @subsection Quoting Texinfo code
13600 It is possible to insert raw Texinfo code using any of the following
13601 constructs
13603 @cindex #+TEXINFO
13604 @cindex #+BEGIN_TEXINFO
13605 @example
13606 Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU.
13608 #+TEXINFO: @@need800
13609 This paragraph is preceded by...
13611 #+BEGIN_TEXINFO
13612 @@auindex Johnson, Mark
13613 @@auindex Lakoff, George
13614 #+END_TEXINFO
13615 @end example
13617 @node Texinfo specific attributes
13618 @subsection Texinfo specific attributes
13620 @cindex #+ATTR_TEXINFO
13621 @samp{texinfo} back-end understands several attributes in plain lists, tables
13622 and images.  They must be specified using an @code{#+ATTR_TEXINFO} keyword,
13623 written just above the list, table or table.
13625 @subsubheading Plain lists
13627 In Texinfo output, description lists appear as two-column tables, using the
13628 default command @code{@@table}.  You can use @code{@@ftable} or
13629 @code{@@vtable}@footnote{For more information, @inforef{Two-column
13630 Tables,,texinfo}.} instead with @code{:table-type} attribute.
13632 @vindex org-texinfo-def-table-markup
13633 In any case, these constructs require a highlighting command for entries in
13634 the list.  You can provide one with @code{:indic} attribute.  If you do not,
13635 it defaults to the value stored in @code{org-texinfo-def-table-markup}, which
13636 see.
13638 @example
13639 #+ATTR_TEXINFO: :indic @@asis
13640 - foo :: This is the text for /foo/, with no highlighting.
13641 @end example
13643 @subsubheading Tables
13645 When exporting a table, column widths are deduced from the longest cell in
13646 each column.  You can also define them explicitly as fractions of the line
13647 length, using @code{:columns} attribute.
13649 @example
13650 #+ATTR_TEXINFO: :columns .5 .5
13651 | a cell | another cell |
13652 @end example
13654 @subsubheading Images
13656 Images are links to files with a supported image extension and no
13657 description.  Image scaling is set with @code{:width} and @code{:height}
13658 attributes.  You can also use @code{:alt} to specify alternate text, as
13659 Texinfo code.
13661 @example
13662 #+ATTR_TEXINFO: :width 1in :alt Alternate @@i@{text@}
13663 [[ridt.pdf]]
13664 @end example
13666 @node An example
13667 @subsection An example
13669 Here is a thorough example.  @inforef{GNU Sample Texts,,texinfo} for an
13670 equivalent Texinfo code.
13672 @example
13673 #+MACRO: version 2.0
13674 #+MACRO: updated last updated 4 March 2014
13676 #+OPTIONS: ':t toc:t author:t email:t
13677 #+TITLE: GNU Sample @{@{@{version@}@}@}
13678 #+AUTHOR: A.U. Thor
13679 #+EMAIL: bug-sample@@gnu.org
13680 #+LANGUAGE: en
13682 #+TEXINFO_FILENAME: sample.info
13683 #+TEXINFO_HEADER: @@syncodeindex pg cp
13685 #+TEXINFO_DIR_CATEGORY: Texinfo documentation system
13686 #+TEXINFO_DIR_TITLE: sample: (sample)
13687 #+TEXINFO_DIR_DESC: Invoking sample
13689 #+TEXINFO_PRINTED_TITLE: GNU Sample
13690 #+SUBTITLE: for version @{@{@{version@}@}@}, @{@{@{updated@}@}@}
13692 * Copying 
13693   :PROPERTIES:
13694   :COPYING:  t
13695   :END:
13697   This manual is for GNU Sample (version @{@{@{version@}@}@},
13698   @{@{@{updated@}@}@}), which is an example in the Texinfo documentation.
13700   Copyright @@@@texinfo:@@copyright@{@}@@@@ 2013 Free Software Foundation,
13701   Inc.
13703   #+BEGIN_QUOTE
13704   Permission is granted to copy, distribute and/or modify this
13705   document under the terms of the GNU Free Documentation License,
13706   Version 1.3 or any later version published by the Free Software
13707   Foundation; with no Invariant Sections, with no Front-Cover Texts,
13708   and with no Back-Cover Texts.  A copy of the license is included in
13709   the section entitled "GNU Free Documentation License".
13710   #+END_QUOTE
13712 * Invoking sample
13714   #+PINDEX: sample
13715   #+CINDEX: invoking @@command@{sample@}
13717   This is a sample manual.  There is no sample program to invoke, but
13718   if there were, you could see its basic usage and command line
13719   options here.
13721 * GNU Free Documentation License
13722   :PROPERTIES:
13723   :APPENDIX: t
13724   :END:
13726   #+TEXINFO: @@include fdl.texi
13728 * Index
13729   :PROPERTIES:
13730   :INDEX:    cp
13731   :END:
13732 @end example
13734 @node iCalendar export
13735 @section iCalendar export
13736 @cindex iCalendar export
13738 @vindex org-icalendar-include-todo
13739 @vindex org-icalendar-use-deadline
13740 @vindex org-icalendar-use-scheduled
13741 @vindex org-icalendar-categories
13742 @vindex org-icalendar-alarm-time
13743 Some people use Org mode for keeping track of projects, but still prefer a
13744 standard calendar application for anniversaries and appointments.  In this
13745 case it can be useful to show deadlines and other time-stamped items in Org
13746 files in the calendar application.  Org mode can export calendar information
13747 in the standard iCalendar format.  If you also want to have TODO entries
13748 included in the export, configure the variable
13749 @code{org-icalendar-include-todo}.  Plain timestamps are exported as VEVENT,
13750 and TODO items as VTODO@.  It will also create events from deadlines that are
13751 in non-TODO items.  Deadlines and scheduling dates in TODO items will be used
13752 to set the start and due dates for the TODO entry@footnote{See the variables
13753 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
13754 As categories, it will use the tags locally defined in the heading, and the
13755 file/tree category@footnote{To add inherited tags or the TODO state,
13756 configure the variable @code{org-icalendar-categories}.}.  See the variable
13757 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
13758 time.
13760 @vindex org-icalendar-store-UID
13761 @cindex property, ID
13762 The iCalendar standard requires each entry to have a globally unique
13763 identifier (UID).  Org creates these identifiers during export.  If you set
13764 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
13765 @code{:ID:} property of the entry and re-used next time you report this
13766 entry.  Since a single entry can give rise to multiple iCalendar entries (as
13767 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
13768 prefixes to the UID, depending on what triggered the inclusion of the entry.
13769 In this way the UID remains unique, but a synchronization program can still
13770 figure out from which entry all the different instances originate.
13772 @table @kbd
13773 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
13774 Create iCalendar entries for the current buffer and store them in the same
13775 directory, using a file extension @file{.ics}.
13776 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
13777 @vindex org-agenda-files
13778 Like @kbd{C-c C-e c f}, but do this for all files in
13779 @code{org-agenda-files}.  For each of these files, a separate iCalendar
13780 file will be written.
13781 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
13782 @vindex org-icalendar-combined-agenda-file
13783 Create a single large iCalendar file from all files in
13784 @code{org-agenda-files} and write it to the file given by
13785 @code{org-icalendar-combined-agenda-file}.
13786 @end table
13788 @vindex org-use-property-inheritance
13789 @vindex org-icalendar-include-body
13790 @cindex property, SUMMARY
13791 @cindex property, DESCRIPTION
13792 @cindex property, LOCATION
13793 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
13794 property can be inherited from higher in the hierarchy if you configure
13795 @code{org-use-property-inheritance} accordingly.} properties if the selected
13796 entries have them.  If not, the summary will be derived from the headline,
13797 and the description from the body (limited to
13798 @code{org-icalendar-include-body} characters).
13800 How this calendar is best read and updated, depends on the application
13801 you are using.  The FAQ covers this issue.
13803 @node Other built-in back-ends
13804 @section Other built-in back-ends
13805 @cindex export back-ends, built-in
13806 @vindex org-export-backends
13808 On top of the aforementioned back-ends, Org comes with other built-in ones:
13810 @itemize
13811 @item @file{ox-man.el}: export to a man page.
13812 @end itemize
13814 To activate these export back-end, customize @code{org-export-backends} or
13815 load them directly with e.g., @code{(require 'ox-man)}.  This will add new
13816 keys in the export dispatcher (@pxref{The export dispatcher}).
13818 See the comment section of these files for more information on how to use
13819 them.
13821 @node Export in foreign buffers
13822 @section Export in foreign buffers
13824 Most built-in back-ends come with a command to convert the selected region
13825 into a selected format and replace this region by the exported output.  Here
13826 is a list of such conversion commands:
13828 @table @code
13829 @item org-html-convert-region-to-html
13830 Convert the selected region into HTML.
13831 @item org-latex-convert-region-to-latex
13832 Convert the selected region into @LaTeX{}.
13833 @item org-texinfo-convert-region-to-texinfo
13834 Convert the selected region into @code{Texinfo}.
13835 @item org-md-convert-region-to-md
13836 Convert the selected region into @code{MarkDown}.
13837 @end table
13839 This is particularly useful for converting tables and lists in foreign
13840 buffers.  E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
13841 use Org commands for editing a list, and finally select and convert the list
13842 with @code{M-x org-html-convert-region-to-html RET}.
13844 @node Advanced configuration
13845 @section Advanced configuration
13847 @subheading Hooks
13849 @vindex org-export-before-processing-hook
13850 @vindex org-export-before-parsing-hook
13851 Two hooks are run during the first steps of the export process.  The first
13852 one, @code{org-export-before-processing-hook} is called before expanding
13853 macros, Babel code and include keywords in the buffer.  The second one,
13854 @code{org-export-before-parsing-hook}, as its name suggests, happens just
13855 before parsing the buffer.  Their main use is for heavy duties, that is
13856 duties involving structural modifications of the document.  For example, one
13857 may want to remove every headline in the buffer during export.  The following
13858 code can achieve this:
13860 @lisp
13861 @group
13862 (defun my-headline-removal (backend)
13863   "Remove all headlines in the current buffer.
13864 BACKEND is the export back-end being used, as a symbol."
13865   (org-map-entries
13866    (lambda () (delete-region (point) (progn (forward-line) (point))))))
13868 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
13869 @end group
13870 @end lisp
13872 Note that functions used in these hooks require a mandatory argument,
13873 a symbol representing the back-end used.
13875 @subheading Filters
13877 @cindex Filters, exporting
13878 Filters are lists of functions applied on a specific part of the output from
13879 a given back-end.  More explicitly, each time a back-end transforms an Org
13880 object or element into another language, all functions within a given filter
13881 type are called in turn on the string produced.  The string returned by the
13882 last function will be the one used in the final output.
13884 There are filter sets for each type of element or object, for plain text,
13885 for the parse tree, for the export options and for the final output.  They
13886 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
13887 where @code{TYPE} is the type targeted by the filter.  Valid types are:
13889 @multitable @columnfractions .33 .33 .33
13890 @item body
13891 @tab bold
13892 @tab babel-call
13893 @item center-block
13894 @tab clock
13895 @tab code
13896 @item diary-sexp
13897 @tab drawer
13898 @tab dynamic-block
13899 @item entity
13900 @tab example-block
13901 @tab export-block
13902 @item export-snippet
13903 @tab final-output
13904 @tab fixed-width
13905 @item footnote-definition
13906 @tab footnote-reference
13907 @tab headline
13908 @item horizontal-rule
13909 @tab inline-babel-call
13910 @tab inline-src-block
13911 @item inlinetask
13912 @tab italic
13913 @tab item
13914 @item keyword
13915 @tab latex-environment
13916 @tab latex-fragment
13917 @item line-break
13918 @tab link
13919 @tab node-property
13920 @item options
13921 @tab paragraph
13922 @tab parse-tree
13923 @item plain-list
13924 @tab plain-text
13925 @tab planning
13926 @item property-drawer
13927 @tab quote-block
13928 @tab quote-section
13929 @item radio-target
13930 @tab section
13931 @tab special-block
13932 @item src-block
13933 @tab statistics-cookie
13934 @tab strike-through
13935 @item subscript
13936 @tab superscript
13937 @tab table
13938 @item table-cell
13939 @tab table-row
13940 @tab target
13941 @item timestamp
13942 @tab underline
13943 @tab verbatim
13944 @item verse-block
13945 @end multitable
13947 For example, the following snippet allows me to use non-breaking spaces in
13948 the Org buffer and get them translated into @LaTeX{} without using the
13949 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
13951 @lisp
13952 @group
13953 (defun my-latex-filter-nobreaks (text backend info)
13954   "Ensure \" \" are properly handled in LaTeX export."
13955   (when (org-export-derived-backend-p backend 'latex)
13956         (replace-regexp-in-string " " "~" text)))
13958 (add-to-list 'org-export-filter-plain-text-functions
13959              'my-latex-filter-nobreaks)
13960 @end group
13961 @end lisp
13963 Three arguments must be provided to a filter: the code being changed, the
13964 back-end used, and some information about the export process.  You can safely
13965 ignore the third argument for most purposes.  Note the use of
13966 @code{org-export-derived-backend-p}, which ensures that the filter will only
13967 be applied when using @code{latex} back-end or any other back-end derived
13968 from it (e.g., @code{beamer}).
13970 @subheading Defining filters for individual files
13972 You can customize the export for just a specific file by binding export
13973 filter variables using @code{#+BIND}.  Here is an example where we introduce
13974 two filters, one to remove brackets from time stamps, and one to entirely
13975 remove any strike-through text.  The functions doing the filtering are
13976 defined in an src block that allows the filter function definitions to exist
13977 in the file itself and ensures that the functions will be there when needed.
13979 @example
13980 #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
13981 #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
13982 #+begin_src emacs-lisp :exports results :results none
13983   (defun tmp-f-timestamp (s backend info)
13984     (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
13985   (defun tmp-f-strike-through (s backend info) "")
13986 #+end_src
13987 @end example
13989 @subheading Extending an existing back-end
13991 This is obviously the most powerful customization, since the changes happen
13992 at the parser level.  Indeed, some export back-ends are built as extensions
13993 of other ones (e.g. Markdown back-end an extension of HTML back-end).
13995 Extending a back-end means that if an element type is not transcoded by the
13996 new back-end, it will be handled by the original one.  Hence you can extend
13997 specific parts of a back-end without too much work.
13999 As an example, imagine we want the @code{ascii} back-end to display the
14000 language used in a source block, when it is available, but only when some
14001 attribute is non-@code{nil}, like the following:
14003 @example
14004 #+ATTR_ASCII: :language t
14005 @end example
14007 Because that back-end is lacking in that area, we are going to create a new
14008 back-end, @code{my-ascii} that will do the job.
14010 @lisp
14011 @group
14012 (defun my-ascii-src-block (src-block contents info)
14013   "Transcode a SRC-BLOCK element from Org to ASCII.
14014 CONTENTS is nil.  INFO is a plist used as a communication
14015 channel."
14016   (if (not (org-export-read-attribute :attr_ascii src-block :language))
14017     (org-export-with-backend 'ascii src-block contents info)
14018   (concat
14019    (format ",--[ %s ]--\n%s`----"
14020            (org-element-property :language src-block)
14021            (replace-regexp-in-string
14022             "^" "| "
14023             (org-element-normalize-string
14024              (org-export-format-code-default src-block info)))))))
14026 (org-export-define-derived-backend 'my-ascii 'ascii
14027   :translate-alist '((src-block . my-ascii-src-block)))
14028 @end group
14029 @end lisp
14031 The @code{my-ascii-src-block} function looks at the attribute above the
14032 element.  If it isn't true, it gives hand to the @code{ascii} back-end.
14033 Otherwise, it creates a box around the code, leaving room for the language.
14034 A new back-end is then created.  It only changes its behavior when
14035 translating @code{src-block} type element.  Now, all it takes to use the new
14036 back-end is calling the following from an Org buffer:
14038 @smalllisp
14039 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
14040 @end smalllisp
14042 It is obviously possible to write an interactive function for this, install
14043 it in the export dispatcher menu, and so on.
14046 @node Publishing
14047 @chapter Publishing
14048 @cindex publishing
14050 Org includes a publishing management system that allows you to configure
14051 automatic HTML conversion of @emph{projects} composed of interlinked org
14052 files.  You can also configure Org to automatically upload your exported HTML
14053 pages and related attachments, such as images and source code files, to a web
14054 server.
14056 You can also use Org to convert files into PDF, or even combine HTML and PDF
14057 conversion so that files are available in both formats on the server.
14059 Publishing has been contributed to Org by David O'Toole.
14061 @menu
14062 * Configuration::               Defining projects
14063 * Uploading files::             How to get files up on the server
14064 * Sample configuration::        Example projects
14065 * Triggering publication::      Publication commands
14066 @end menu
14068 @node Configuration
14069 @section Configuration
14071 Publishing needs significant configuration to specify files, destination
14072 and many other properties of a project.
14074 @menu
14075 * Project alist::               The central configuration variable
14076 * Sources and destinations::    From here to there
14077 * Selecting files::             What files are part of the project?
14078 * Publishing action::           Setting the function doing the publishing
14079 * Publishing options::          Tweaking HTML/@LaTeX{} export
14080 * Publishing links::            Which links keep working after publishing?
14081 * Sitemap::                     Generating a list of all pages
14082 * Generating an index::         An index that reaches across pages
14083 @end menu
14085 @node Project alist
14086 @subsection The variable @code{org-publish-project-alist}
14087 @cindex org-publish-project-alist
14088 @cindex projects, for publishing
14090 @vindex org-publish-project-alist
14091 Publishing is configured almost entirely through setting the value of one
14092 variable, called @code{org-publish-project-alist}.  Each element of the list
14093 configures one project, and may be in one of the two following forms:
14095 @lisp
14096    ("project-name" :property value :property value ...)
14097      @r{i.e., a well-formed property list with alternating keys and values}
14098 @r{or}
14099    ("project-name" :components ("project-name" "project-name" ...))
14101 @end lisp
14103 In both cases, projects are configured by specifying property values.  A
14104 project defines the set of files that will be published, as well as the
14105 publishing configuration to use when publishing those files.  When a project
14106 takes the second form listed above, the individual members of the
14107 @code{:components} property are taken to be sub-projects, which group
14108 together files requiring different publishing options.  When you publish such
14109 a ``meta-project'', all the components will also be published, in the
14110 sequence given.
14112 @node Sources and destinations
14113 @subsection Sources and destinations for files
14114 @cindex directories, for publishing
14116 Most properties are optional, but some should always be set.  In
14117 particular, Org needs to know where to look for source files,
14118 and where to put published files.
14120 @multitable @columnfractions 0.3 0.7
14121 @item @code{:base-directory}
14122 @tab Directory containing publishing source files
14123 @item @code{:publishing-directory}
14124 @tab Directory where output files will be published.  You can directly
14125 publish to a web server using a file name syntax appropriate for
14126 the Emacs @file{tramp} package.  Or you can publish to a local directory and
14127 use external tools to upload your website (@pxref{Uploading files}).
14128 @item @code{:preparation-function}
14129 @tab Function or list of functions to be called before starting the
14130 publishing process, for example, to run @code{make} for updating files to be
14131 published.  The project property list is scoped into this call as the
14132 variable @code{project-plist}.
14133 @item @code{:completion-function}
14134 @tab Function or list of functions called after finishing the publishing
14135 process, for example, to change permissions of the resulting files.  The
14136 project property list is scoped into this call as the variable
14137 @code{project-plist}.
14138 @end multitable
14139 @noindent
14141 @node Selecting files
14142 @subsection Selecting files
14143 @cindex files, selecting for publishing
14145 By default, all files with extension @file{.org} in the base directory
14146 are considered part of the project.  This can be modified by setting the
14147 properties
14148 @multitable @columnfractions 0.25 0.75
14149 @item @code{:base-extension}
14150 @tab Extension (without the dot!) of source files.  This actually is a
14151 regular expression.  Set this to the symbol @code{any} if you want to get all
14152 files in @code{:base-directory}, even without extension.
14154 @item @code{:exclude}
14155 @tab Regular expression to match file names that should not be
14156 published, even though they have been selected on the basis of their
14157 extension.
14159 @item @code{:include}
14160 @tab List of files to be included regardless of @code{:base-extension}
14161 and @code{:exclude}.
14163 @item @code{:recursive}
14164 @tab non-@code{nil} means, check base-directory recursively for files to publish.
14165 @end multitable
14167 @node Publishing action
14168 @subsection Publishing action
14169 @cindex action, for publishing
14171 Publishing means that a file is copied to the destination directory and
14172 possibly transformed in the process.  The default transformation is to export
14173 Org files as HTML files, and this is done by the function
14174 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
14175 export}).  But you also can publish your content as PDF files using
14176 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
14177 using the corresponding functions.
14179 If you want to publish the Org file as an @code{.org} file but with the
14180 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
14181 function @code{org-org-publish-to-org}.  This will produce @file{file.org}
14182 and put it in the publishing directory.  If you want a htmlized version of
14183 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
14184 produce @file{file.org.html} in the publishing directory@footnote{If the
14185 publishing directory is the same than the source directory, @file{file.org}
14186 will be exported as @file{file.org.org}, so probably don't want to do this.}.
14188 Other files like images only need to be copied to the publishing destination.
14189 For this you can use @code{org-publish-attachment}.  For non-org files, you
14190 always need to specify the publishing function:
14192 @multitable @columnfractions 0.3 0.7
14193 @item @code{:publishing-function}
14194 @tab Function executing the publication of a file.  This may also be a
14195 list of functions, which will all be called in turn.
14196 @item @code{:htmlized-source}
14197 @tab non-@code{nil} means, publish htmlized source.
14198 @end multitable
14200 The function must accept three arguments: a property list containing at least
14201 a @code{:publishing-directory} property, the name of the file to be published
14202 and the path to the publishing directory of the output file.  It should take
14203 the specified file, make the necessary transformation (if any) and place the
14204 result into the destination folder.
14206 @node Publishing options
14207 @subsection Options for the exporters
14208 @cindex options, for publishing
14210 The property list can be used to set export options during the publishing
14211 process.  In most cases, these properties correspond to user variables in
14212 Org.  While some properties are available for all export back-ends, most of
14213 them are back-end specific.  The following sections list properties along
14214 with the variable they belong to.  See the documentation string of these
14215 options for details.
14217 @vindex org-publish-project-alist
14218 When a property is given a value in @code{org-publish-project-alist}, its
14219 setting overrides the value of the corresponding user variable (if any)
14220 during publishing.  Options set within a file (@pxref{Export settings}),
14221 however, override everything.
14223 @subsubheading Generic properties
14225 @multitable {@code{:with-sub-superscript}}  {@code{org-export-with-sub-superscripts}}
14226 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
14227 @item @code{:exclude-tags}          @tab @code{org-export-exclude-tags}
14228 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
14229 @item @code{:language}              @tab @code{org-export-default-language}
14230 @item @code{:preserve-breaks}       @tab @code{org-export-preserve-breaks}
14231 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
14232 @item @code{:select-tags}           @tab @code{org-export-select-tags}
14233 @item @code{:with-author}           @tab @code{org-export-with-author}
14234 @item @code{:with-creator}          @tab @code{org-export-with-creator}
14235 @item @code{:with-date}             @tab @code{org-export-with-date}
14236 @item @code{:with-drawers}          @tab @code{org-export-with-drawers}
14237 @item @code{:with-email}            @tab @code{org-export-with-email}
14238 @item @code{:with-emphasize}        @tab @code{org-export-with-emphasize}
14239 @item @code{:with-fixed-width}      @tab @code{org-export-with-fixed-width}
14240 @item @code{:with-footnotes}        @tab @code{org-export-with-footnotes}
14241 @item @code{:with-latex}            @tab @code{org-export-with-latex}
14242 @item @code{:with-planning}         @tab @code{org-export-with-planning}
14243 @item @code{:with-priority}         @tab @code{org-export-with-priority}
14244 @item @code{:with-properties}       @tab @code{org-export-with-properties}
14245 @item @code{:with-special-strings}  @tab @code{org-export-with-special-strings}
14246 @item @code{:with-sub-superscript}  @tab @code{org-export-with-sub-superscripts}
14247 @item @code{:with-tables}           @tab @code{org-export-with-tables}
14248 @item @code{:with-tags}             @tab @code{org-export-with-tags}
14249 @item @code{:with-tasks}            @tab @code{org-export-with-tasks}
14250 @item @code{:with-timestamps}       @tab @code{org-export-with-timestamps}
14251 @item @code{:with-title}            @tab @code{org-export-with-title}
14252 @item @code{:with-toc}              @tab @code{org-export-with-toc}
14253 @item @code{:with-todo-keywords}    @tab @code{org-export-with-todo-keywords}
14254 @end multitable
14256 @subsubheading ASCII specific properties
14258 @multitable {@code{:ascii-table-keep-all-vertical-lines}} {@code{org-ascii-table-keep-all-vertical-lines}}
14259 @item @code{:ascii-bullets}                       @tab @code{org-ascii-bullets}
14260 @item @code{:ascii-caption-above}                 @tab @code{org-ascii-caption-above}
14261 @item @code{:ascii-charset}                       @tab @code{org-ascii-charset}
14262 @item @code{:ascii-global-margin}                 @tab @code{org-ascii-global-margin}
14263 @item @code{:ascii-format-drawer-function}        @tab @code{org-ascii-format-drawer-function}
14264 @item @code{:ascii-format-inlinetask-function}    @tab @code{org-ascii-format-inlinetask-function}
14265 @item @code{:ascii-headline-spacing}              @tab @code{org-ascii-headline-spacing}
14266 @item @code{:ascii-indented-line-width}           @tab @code{org-ascii-indented-line-width}
14267 @item @code{:ascii-inlinetask-width}              @tab @code{org-ascii-inlinetask-width}
14268 @item @code{:ascii-inner-margin}                  @tab @code{org-ascii-inner-margin}
14269 @item @code{:ascii-links-to-notes}                @tab @code{org-ascii-links-to-notes}
14270 @item @code{:ascii-list-margin}                   @tab @code{org-ascii-list-margin}
14271 @item @code{:ascii-paragraph-spacing}             @tab @code{org-ascii-paragraph-spacing}
14272 @item @code{:ascii-quote-margin}                  @tab @code{org-ascii-quote-margin}
14273 @item @code{:ascii-table-keep-all-vertical-lines} @tab @code{org-ascii-table-keep-all-vertical-lines}
14274 @item @code{:ascii-table-use-ascii-art}           @tab @code{org-ascii-table-use-ascii-art}
14275 @item @code{:ascii-table-widen-columns}           @tab @code{org-ascii-table-widen-columns}
14276 @item @code{:ascii-text-width}                    @tab @code{org-ascii-text-width}
14277 @item @code{:ascii-underline}                     @tab @code{org-ascii-underline}
14278 @item @code{:ascii-verbatim-format}               @tab @code{org-ascii-verbatim-format}
14279 @end multitable
14281 @subsubheading Beamer specific properties
14283 @multitable {@code{:beamer-frame-default-options}} {@code{org-beamer-frame-default-options}}
14284 @item @code{:beamer-theme}                 @tab @code{org-beamer-theme}
14285 @item @code{:beamer-column-view-format}    @tab @code{org-beamer-column-view-format}
14286 @item @code{:beamer-environments-extra}    @tab @code{org-beamer-environments-extra}
14287 @item @code{:beamer-frame-default-options} @tab @code{org-beamer-frame-default-options}
14288 @item @code{:beamer-outline-frame-options} @tab @code{org-beamer-outline-frame-options}
14289 @item @code{:beamer-outline-frame-title}   @tab @code{org-beamer-outline-frame-title}
14290 @item @code{:beamer-subtitle-format}       @tab @code{org-beamer-subtitle-format}
14291 @end multitable
14293 @subsubheading HTML specific properties
14295 @multitable {@code{:html-table-use-header-tags-for-first-column}} {@code{org-html-table-use-header-tags-for-first-column}}
14296 @item @code{:html-allow-name-attribute-in-anchors} @tab @code{org-html-allow-name-attribute-in-anchors}
14297 @item @code{:html-checkbox-type}              @tab @code{org-html-checkbox-type}
14298 @item @code{:html-container}                  @tab @code{org-html-container-element}
14299 @item @code{:html-divs}                       @tab @code{org-html-divs}
14300 @item @code{:html-doctype}                    @tab @code{org-html-doctype}
14301 @item @code{:html-extension}                  @tab @code{org-html-extension}
14302 @item @code{:html-footnote-format}            @tab @code{org-html-footnote-format}
14303 @item @code{:html-footnote-separator}         @tab @code{org-html-footnote-separator}
14304 @item @code{:html-footnotes-section}          @tab @code{org-html-footnotes-section}
14305 @item @code{:html-format-drawer-function}     @tab @code{org-html-format-drawer-function}
14306 @item @code{:html-format-headline-function}   @tab @code{org-html-format-headline-function}
14307 @item @code{:html-format-inlinetask-function} @tab @code{org-html-format-inlinetask-function}
14308 @item @code{:html-head-extra}                 @tab @code{org-html-head-extra}
14309 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
14310 @item @code{:html-head-include-scripts}       @tab @code{org-html-head-include-scripts}
14311 @item @code{:html-head}                       @tab @code{org-html-head}
14312 @item @code{:html-home/up-format}             @tab @code{org-html-home/up-format}
14313 @item @code{:html-html5-fancy}                @tab @code{org-html-html5-fancy}
14314 @item @code{:html-indent}                     @tab @code{org-html-indent}
14315 @item @code{:html-infojs-options}             @tab @code{org-html-infojs-options}
14316 @item @code{:html-infojs-template}            @tab @code{org-html-infojs-template}
14317 @item @code{:html-inline-image-rules}         @tab @code{org-html-inline-image-rules}
14318 @item @code{:html-inline-images}              @tab @code{org-html-inline-images}
14319 @item @code{:html-link-home}                  @tab @code{org-html-link-home}
14320 @item @code{:html-link-org-files-as-html}     @tab @code{org-html-link-org-files-as-html}
14321 @item @code{:html-link-up}                    @tab @code{org-html-link-up}
14322 @item @code{:html-link-use-abs-url}           @tab @code{org-html-link-use-abs-url}
14323 @item @code{:html-mathjax-options}            @tab @code{org-html-mathjax-options}
14324 @item @code{:html-mathjax-template}           @tab @code{org-html-mathjax-template}
14325 @item @code{:html-metadata-timestamp-format}  @tab @code{org-html-metadata-timestamp-format}
14326 @item @code{:html-postamble-format}           @tab @code{org-html-postamble-format}
14327 @item @code{:html-postamble}                  @tab @code{org-html-postamble}
14328 @item @code{:html-preamble-format}            @tab @code{org-html-preamble-format}
14329 @item @code{:html-preamble}                   @tab @code{org-html-preamble}
14330 @item @code{:html-table-align-individual-fields} @tab @code{org-html-table-align-individual-fields}
14331 @item @code{:html-table-attributes}           @tab @code{org-html-table-default-attributes}
14332 @item @code{:html-table-caption-above}        @tab @code{org-html-table-caption-above}
14333 @item @code{:html-table-data-tags}            @tab @code{org-html-table-data-tags}
14334 @item @code{:html-table-header-tags}          @tab @code{org-html-table-header-tags}
14335 @item @code{:html-table-row-tags}             @tab @code{org-html-table-row-tags}
14336 @item @code{:html-table-use-header-tags-for-first-column} @tab @code{org-html-table-use-header-tags-for-first-column}
14337 @item @code{:html-tag-class-prefix}           @tab @code{org-html-tag-class-prefix}
14338 @item @code{:html-text-markup-alist}          @tab @code{org-html-text-markup-alist}
14339 @item @code{:html-todo-kwd-class-prefix}      @tab @code{org-html-todo-kwd-class-prefix}
14340 @item @code{:html-toplevel-hlevel}            @tab @code{org-html-toplevel-hlevel}
14341 @item @code{:html-use-infojs}                 @tab @code{org-html-use-infojs}
14342 @item @code{:html-use-unicode-chars}          @tab @code{org-html-use-unicode-chars}
14343 @item @code{:html-validation-link}            @tab @code{org-html-validation-link}
14344 @item @code{:html-viewport}                   @tab @code{org-html-viewport}
14345 @item @code{:html-xml-declaration}            @tab @code{org-html-xml-declaration}
14346 @end multitable
14348 @subsubheading @LaTeX{} specific properties
14350 @multitable {@code{:latex-link-with-unknown-path-format}} {@code{org-latex-link-with-unknown-path-format}} 
14351 @item @code{:latex-active-timestamp-format}    @tab @code{org-latex-active-timestamp-format}
14352 @item @code{:latex-caption-above}              @tab @code{org-latex-caption-above}
14353 @item @code{:latex-classes}                    @tab @code{org-latex-classes}
14354 @item @code{:latex-class}                      @tab @code{org-latex-default-class}
14355 @item @code{:latex-default-figure-position}    @tab @code{org-latex-default-figure-position}
14356 @item @code{:latex-default-table-environment}  @tab @code{org-latex-default-table-environment}
14357 @item @code{:latex-default-table-mode}         @tab @code{org-latex-default-table-mode}
14358 @item @code{:latex-diary-timestamp-format}     @tab @code{org-latex-diary-timestamp-format}
14359 @item @code{:latex-footnote-separator}         @tab @code{org-latex-footnote-separator}
14360 @item @code{:latex-format-drawer-function}     @tab @code{org-latex-format-drawer-function}
14361 @item @code{:latex-format-headline-function}   @tab @code{org-latex-format-headline-function}
14362 @item @code{:latex-format-inlinetask-function} @tab @code{org-latex-format-inlinetask-function}
14363 @item @code{:latex-hyperref-template}          @tab @code{org-latex-hyperref-template}
14364 @item @code{:latex-image-default-height}       @tab @code{org-latex-image-default-height}
14365 @item @code{:latex-image-default-option}       @tab @code{org-latex-image-default-option}
14366 @item @code{:latex-image-default-width}        @tab @code{org-latex-image-default-width}
14367 @item @code{:latex-inactive-timestamp-format}  @tab @code{org-latex-inactive-timestamp-format}
14368 @item @code{:latex-inline-image-rules}         @tab @code{org-latex-inline-image-rules}
14369 @item @code{:latex-link-with-unknown-path-format} @tab @code{org-latex-link-with-unknown-path-format}
14370 @item @code{:latex-listings-langs}             @tab @code{org-latex-listings-langs}
14371 @item @code{:latex-listings-options}           @tab @code{org-latex-listings-options}
14372 @item @code{:latex-listings}                   @tab @code{org-latex-listings}
14373 @item @code{:latex-minted-langs}               @tab @code{org-latex-minted-langs}
14374 @item @code{:latex-minted-options}             @tab @code{org-latex-minted-options}
14375 @item @code{:latex-prefer-user-labels}         @tab @code{org-latex-prefer-user-labels}
14376 @item @code{:latex-subtitle-format}            @tab @code{org-latex-subtitle-format}
14377 @item @code{:latex-subtitle-separate}          @tab @code{org-latex-subtitle-separate}
14378 @item @code{:latex-table-scientific-notation}  @tab @code{org-latex-table-scientific-notation}
14379 @item @code{:latex-tables-booktabs}            @tab @code{org-latex-tables-booktabs}
14380 @item @code{:latex-tables-centered}            @tab @code{org-latex-tables-centered}
14381 @item @code{:latex-text-markup-alist}          @tab @code{org-latex-text-markup-alist}
14382 @item @code{:latex-title-command}              @tab @code{org-latex-title-command}
14383 @item @code{:latex-toc-command}                @tab @code{org-latex-toc-command}
14384 @end multitable
14386 @subsubheading Markdown specific properties
14388 @multitable {@code{:md-headline-style}} {@code{org-md-headline-style}}
14389 @item @code{:md-headline-style} @tab @code{org-md-headline-style}
14390 @end multitable
14392 @subsubheading ODT specific properties
14394 @multitable {@code{:odt-format-inlinetask-function}} {@code{org-odt-format-inlinetask-function}}
14395 @item @code{:odt-content-template-file}      @tab @code{org-odt-content-template-file}
14396 @item @code{:odt-display-outline-level}      @tab @code{org-odt-display-outline-level}
14397 @item @code{:odt-fontify-srcblocks}          @tab @code{org-odt-fontify-srcblocks}
14398 @item @code{:odt-format-drawer-function}     @tab @code{org-odt-format-drawer-function}
14399 @item @code{:odt-format-headline-function}   @tab @code{org-odt-format-headline-function}
14400 @item @code{:odt-format-inlinetask-function} @tab @code{org-odt-format-inlinetask-function}
14401 @item @code{:odt-inline-formula-rules}       @tab @code{org-odt-inline-formula-rules}
14402 @item @code{:odt-inline-image-rules}         @tab @code{org-odt-inline-image-rules}
14403 @item @code{:odt-pixels-per-inch}            @tab @code{org-odt-pixels-per-inch}
14404 @item @code{:odt-styles-file}                @tab @code{org-odt-styles-file}
14405 @item @code{:odt-table-styles}               @tab @code{org-odt-table-styles}
14406 @item @code{:odt-use-date-fields}            @tab @code{org-odt-use-date-fields}
14407 @end multitable
14409 @subsubheading Texinfo specific properties
14411 @multitable {@code{:texinfo-link-with-unknown-path-format}} {@code{org-texinfo-link-with-unknown-path-format}}
14412 @item @code{:texinfo-active-timestamp-format}    @tab @code{org-texinfo-active-timestamp-format}
14413 @item @code{:texinfo-classes}                    @tab @code{org-texinfo-classes}
14414 @item @code{:texinfo-class}                      @tab @code{org-texinfo-default-class}
14415 @item @code{:texinfo-def-table-markup}           @tab @code{org-texinfo-def-table-markup}
14416 @item @code{:texinfo-diary-timestamp-format}     @tab @code{org-texinfo-diary-timestamp-format}
14417 @item @code{:texinfo-filename}                   @tab @code{org-texinfo-filename}
14418 @item @code{:texinfo-format-drawer-function}     @tab @code{org-texinfo-format-drawer-function}
14419 @item @code{:texinfo-format-headline-function}   @tab @code{org-texinfo-format-headline-function}
14420 @item @code{:texinfo-format-inlinetask-function} @tab @code{org-texinfo-format-inlinetask-function}
14421 @item @code{:texinfo-inactive-timestamp-format}  @tab @code{org-texinfo-inactive-timestamp-format}
14422 @item @code{:texinfo-link-with-unknown-path-format} @tab @code{org-texinfo-link-with-unknown-path-format}
14423 @item @code{:texinfo-node-description-column}    @tab @code{org-texinfo-node-description-column}
14424 @item @code{:texinfo-table-scientific-notation}  @tab @code{org-texinfo-table-scientific-notation}
14425 @item @code{:texinfo-tables-verbatim}            @tab @code{org-texinfo-tables-verbatim}
14426 @item @code{:texinfo-text-markup-alist}          @tab @code{org-texinfo-text-markup-alist}
14427 @end multitable
14429 @node Publishing links
14430 @subsection Links between published files
14431 @cindex links, publishing
14433 To create a link from one Org file to another, you would use something like
14434 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
14435 (@pxref{Hyperlinks}).  When published, this link becomes a link to
14436 @file{foo.html}.  You can thus interlink the pages of your "org web" project
14437 and the links will work as expected when you publish them to HTML@.  If you
14438 also publish the Org source file and want to link to it, use an @code{http:}
14439 link instead of a @code{file:} link, because @code{file:} links are converted
14440 to link to the corresponding @file{html} file.
14442 You may also link to related files, such as images.  Provided you are careful
14443 with relative file names, and provided you have also configured Org to upload
14444 the related files, these links will work too.  See @ref{Complex example}, for
14445 an example of this usage.
14447 @node Sitemap
14448 @subsection Generating a sitemap
14449 @cindex sitemap, of published pages
14451 The following properties may be used to control publishing of
14452 a map of files for a given project.
14454 @multitable @columnfractions 0.35 0.65
14455 @item @code{:auto-sitemap}
14456 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
14457 or @code{org-publish-all}.
14459 @item @code{:sitemap-filename}
14460 @tab Filename for output of sitemap.  Defaults to @file{sitemap.org} (which
14461 becomes @file{sitemap.html}).
14463 @item @code{:sitemap-title}
14464 @tab Title of sitemap page.  Defaults to name of file.
14466 @item @code{:sitemap-function}
14467 @tab Plug-in function to use for generation of the sitemap.
14468 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
14469 of links to all files in the project.
14471 @item @code{:sitemap-sort-folders}
14472 @tab Where folders should appear in the sitemap.  Set this to @code{first}
14473 (default) or @code{last} to display folders first or last,
14474 respectively.  Any other value will mix files and folders.
14476 @item @code{:sitemap-sort-files}
14477 @tab How the files are sorted in the site map.  Set this to
14478 @code{alphabetically} (default), @code{chronologically} or
14479 @code{anti-chronologically}.  @code{chronologically} sorts the files with
14480 older date first while @code{anti-chronologically} sorts the files with newer
14481 date first.  @code{alphabetically} sorts the files alphabetically.  The date of
14482 a file is retrieved with @code{org-publish-find-date}.
14484 @item @code{:sitemap-ignore-case}
14485 @tab Should sorting be case-sensitive?  Default @code{nil}.
14487 @item @code{:sitemap-file-entry-format}
14488 @tab With this option one can tell how a sitemap's entry is formatted in the
14489 sitemap.  This is a format string with some escape sequences: @code{%t} stands
14490 for the title of the file, @code{%a} stands for the author of the file and
14491 @code{%d} stands for the date of the file.  The date is retrieved with the
14492 @code{org-publish-find-date} function and formatted with
14493 @code{org-publish-sitemap-date-format}.  Default @code{%t}.
14495 @item @code{:sitemap-date-format}
14496 @tab Format string for the @code{format-time-string} function that tells how
14497 a sitemap entry's date is to be formatted.  This property bypasses
14498 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
14500 @item @code{:sitemap-sans-extension}
14501 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
14502 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
14503 Defaults to @code{nil}.
14505 @end multitable
14507 @node Generating an index
14508 @subsection Generating an index
14509 @cindex index, in a publishing project
14511 Org mode can generate an index across the files of a publishing project.
14513 @multitable @columnfractions 0.25 0.75
14514 @item @code{:makeindex}
14515 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
14516 publish it as @file{theindex.html}.
14517 @end multitable
14519 The file will be created when first publishing a project with the
14520 @code{:makeindex} set.  The file only contains a statement @code{#+INCLUDE:
14521 "theindex.inc"}.  You can then build around this include statement by adding
14522 a title, style information, etc.
14524 @node Uploading files
14525 @section Uploading files
14526 @cindex rsync
14527 @cindex unison
14529 For those people already utilizing third party sync tools such as
14530 @command{rsync} or @command{unison}, it might be preferable not to use the built in
14531 @i{remote} publishing facilities of Org mode which rely heavily on
14532 Tramp.  Tramp, while very useful and powerful, tends not to be
14533 so efficient for multiple file transfer and has been known to cause problems
14534 under heavy usage.
14536 Specialized synchronization utilities offer several advantages.  In addition
14537 to timestamp comparison, they also do content and permissions/attribute
14538 checks.  For this reason you might prefer to publish your web to a local
14539 directory (possibly even @i{in place} with your Org files) and then use
14540 @file{unison} or @file{rsync} to do the synchronization with the remote host.
14542 Since Unison (for example) can be configured as to which files to transfer to
14543 a certain remote destination, it can greatly simplify the project publishing
14544 definition.  Simply keep all files in the correct location, process your Org
14545 files with @code{org-publish} and let the synchronization tool do the rest.
14546 You do not need, in this scenario, to include attachments such as @file{jpg},
14547 @file{css} or @file{gif} files in the project definition since the 3rd party
14548 tool syncs them.
14550 Publishing to a local directory is also much faster than to a remote one, so
14551 that you can afford more easily to republish entire projects.  If you set
14552 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
14553 benefit of re-including any changed external files such as source example
14554 files you might include with @code{#+INCLUDE:}.  The timestamp mechanism in
14555 Org is not smart enough to detect if included files have been modified.
14557 @node Sample configuration
14558 @section Sample configuration
14560 Below we provide two example configurations.  The first one is a simple
14561 project publishing only a set of Org files.  The second example is
14562 more complex, with a multi-component project.
14564 @menu
14565 * Simple example::              One-component publishing
14566 * Complex example::             A multi-component publishing example
14567 @end menu
14569 @node Simple example
14570 @subsection Example: simple publishing configuration
14572 This example publishes a set of Org files to the @file{public_html}
14573 directory on the local machine.
14575 @lisp
14576 (setq org-publish-project-alist
14577       '(("org"
14578          :base-directory "~/org/"
14579          :publishing-directory "~/public_html"
14580          :section-numbers nil
14581          :with-toc nil
14582          :html-head "<link rel=\"stylesheet\"
14583                     href=\"../other/mystyle.css\"
14584                     type=\"text/css\"/>")))
14585 @end lisp
14587 @node Complex example
14588 @subsection Example: complex publishing configuration
14590 This more complicated example publishes an entire website, including
14591 Org files converted to HTML, image files, Emacs Lisp source code, and
14592 style sheets.  The publishing directory is remote and private files are
14593 excluded.
14595 To ensure that links are preserved, care should be taken to replicate
14596 your directory structure on the web server, and to use relative file
14597 paths.  For example, if your Org files are kept in @file{~/org} and your
14598 publishable images in @file{~/images}, you would link to an image with
14600 @example
14601 file:../images/myimage.png
14602 @end example
14604 On the web server, the relative path to the image should be the
14605 same.  You can accomplish this by setting up an "images" folder in the
14606 right place on the web server, and publishing images to it.
14608 @lisp
14609 (setq org-publish-project-alist
14610       '(("orgfiles"
14611           :base-directory "~/org/"
14612           :base-extension "org"
14613           :publishing-directory "/ssh:user@@host:~/html/notebook/"
14614           :publishing-function org-html-publish-to-html
14615           :exclude "PrivatePage.org"   ;; regexp
14616           :headline-levels 3
14617           :section-numbers nil
14618           :with-toc nil
14619           :html-head "<link rel=\"stylesheet\"
14620                   href=\"../other/mystyle.css\" type=\"text/css\"/>"
14621           :html-preamble t)
14623          ("images"
14624           :base-directory "~/images/"
14625           :base-extension "jpg\\|gif\\|png"
14626           :publishing-directory "/ssh:user@@host:~/html/images/"
14627           :publishing-function org-publish-attachment)
14629          ("other"
14630           :base-directory "~/other/"
14631           :base-extension "css\\|el"
14632           :publishing-directory "/ssh:user@@host:~/html/other/"
14633           :publishing-function org-publish-attachment)
14634          ("website" :components ("orgfiles" "images" "other"))))
14635 @end lisp
14637 @node Triggering publication
14638 @section Triggering publication
14640 Once properly configured, Org can publish with the following commands:
14642 @table @kbd
14643 @orgcmd{C-c C-e P x,org-publish}
14644 Prompt for a specific project and publish all files that belong to it.
14645 @orgcmd{C-c C-e P p,org-publish-current-project}
14646 Publish the project containing the current file.
14647 @orgcmd{C-c C-e P f,org-publish-current-file}
14648 Publish only the current file.
14649 @orgcmd{C-c C-e P a,org-publish-all}
14650 Publish every project.
14651 @end table
14653 @vindex org-publish-use-timestamps-flag
14654 Org uses timestamps to track when a file has changed.  The above functions
14655 normally only publish changed files.  You can override this and force
14656 publishing of all files by giving a prefix argument to any of the commands
14657 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
14658 This may be necessary in particular if files include other files via
14659 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
14662 @node Working with source code
14663 @chapter Working with source code
14664 @cindex Schulte, Eric
14665 @cindex Davison, Dan
14666 @cindex source code, working with
14668 Source code can be included in Org mode documents using a @samp{src} block,
14669 e.g.:
14671 @example
14672 #+BEGIN_SRC emacs-lisp
14673   (defun org-xor (a b)
14674      "Exclusive or."
14675      (if a (not b) b))
14676 #+END_SRC
14677 @end example
14679 Org mode provides a number of features for working with live source code,
14680 including editing of code blocks in their native major-mode, evaluation of
14681 code blocks, converting code blocks into source files (known as @dfn{tangling}
14682 in literate programming), and exporting code blocks and their
14683 results in several formats.  This functionality was contributed by Eric
14684 Schulte and Dan Davison, and was originally named Org-babel.
14686 The following sections describe Org mode's code block handling facilities.
14688 @menu
14689 * Structure of code blocks::    Code block syntax described
14690 * Editing source code::         Language major-mode editing
14691 * Exporting code blocks::       Export contents and/or results
14692 * Extracting source code::      Create pure source code files
14693 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
14694 * Library of Babel::            Use and contribute to a library of useful code blocks
14695 * Languages::                   List of supported code block languages
14696 * Header arguments::            Configure code block functionality
14697 * Results of evaluation::       How evaluation results are handled
14698 * Noweb reference syntax::      Literate programming in Org mode
14699 * Key bindings and useful functions::  Work quickly with code blocks
14700 * Batch execution::             Call functions from the command line
14701 @end menu
14704 @node Structure of code blocks
14705 @section Structure of code blocks
14706 @cindex code block, structure
14707 @cindex source code, block structure
14708 @cindex #+NAME
14709 @cindex #+BEGIN_SRC
14711 Live code blocks can be specified with a @samp{src} block or
14712 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
14713 @ref{Easy templates} system}  The structure of a @samp{src} block is
14715 @example
14716 #+NAME: <name>
14717 #+BEGIN_SRC <language> <switches> <header arguments>
14718   <body>
14719 #+END_SRC
14720 @end example
14722 The @code{#+NAME:} line is optional, and can be used to name the code
14723 block.  Live code blocks require that a language be specified on the
14724 @code{#+BEGIN_SRC} line.  Switches and header arguments are optional.
14725 @cindex source code, inline
14727 Live code blocks can also be specified inline using
14729 @example
14730 src_<language>@{<body>@}
14731 @end example
14735 @example
14736 src_<language>[<header arguments>]@{<body>@}
14737 @end example
14739 @table @code
14740 @item <#+NAME: name>
14741 This line associates a name with the code block.  This is similar to the
14742 @code{#+NAME: Name} lines that can be used to name tables in Org mode
14743 files.  Referencing the name of a code block makes it possible to evaluate
14744 the block from other places in the file, from other files, or from Org mode
14745 table formulas (see @ref{The spreadsheet}).  Names are assumed to be unique
14746 and the behavior of Org mode when two or more blocks share the same name is
14747 undefined.
14748 @cindex #+NAME
14749 @item <language>
14750 The language of the code in the block (see @ref{Languages}).
14751 @cindex source code, language
14752 @item <switches>
14753 Optional switches control code block export (see the discussion of switches in
14754 @ref{Literal examples})
14755 @cindex source code, switches
14756 @item <header arguments>
14757 Optional header arguments control many aspects of evaluation, export and
14758 tangling of code blocks (see @ref{Header arguments}).
14759 Header arguments can also be set on a per-buffer or per-subtree
14760 basis using properties.
14761 @item source code, header arguments
14762 @item <body>
14763 Source code in the specified language.
14764 @end table
14767 @node Editing source code
14768 @section Editing source code
14769 @cindex code block, editing
14770 @cindex source code, editing
14772 @vindex org-edit-src-auto-save-idle-delay
14773 @vindex org-edit-src-turn-on-auto-save
14774 @kindex C-c '
14775 Use @kbd{C-c '} to edit the current code block.  This brings up a language
14776 major-mode edit buffer containing the body of the code block.  Manually
14777 saving this buffer with @key{C-x C-s} will write the contents back to the Org
14778 buffer.  You can also set @code{org-edit-src-auto-save-idle-delay} to save the
14779 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
14780 to auto-save this buffer into a separate file using @code{auto-save-mode}.
14781 Use @kbd{C-c '} again to exit.
14783 The @code{org-src-mode} minor mode will be active in the edit buffer.  The
14784 following variables can be used to configure the behavior of the edit
14785 buffer.  See also the customization group @code{org-edit-structure} for
14786 further configuration options.
14788 @table @code
14789 @item org-src-lang-modes
14790 If an Emacs major-mode named @code{<lang>-mode} exists, where
14791 @code{<lang>} is the language named in the header line of the code block,
14792 then the edit buffer will be placed in that major-mode.  This variable
14793 can be used to map arbitrary language names to existing major modes.
14794 @item org-src-window-setup
14795 Controls the way Emacs windows are rearranged when the edit buffer is created.
14796 @item org-src-preserve-indentation
14797 @cindex indentation, in source blocks
14798 By default, the value is @code{nil}, which means that when code blocks are
14799 evaluated during export or tangled, they are re-inserted into the code block,
14800 which may replace sequences of spaces with tab characters.  When non-@code{nil},
14801 whitespace in code blocks will be preserved during export or tangling,
14802 exactly as it appears.  This variable is especially useful for tangling
14803 languages such as Python, in which whitespace indentation in the output is
14804 critical.
14805 @item org-src-ask-before-returning-to-edit-buffer
14806 By default, Org will ask before returning to an open edit buffer.  Set this
14807 variable to @code{nil} to switch without asking.
14808 @end table
14810 To turn on native code fontification in the @emph{Org} buffer, configure the
14811 variable @code{org-src-fontify-natively}.
14814 @node Exporting code blocks
14815 @section Exporting code blocks
14816 @cindex code block, exporting
14817 @cindex source code, exporting
14819 It is possible to export the @emph{code} of code blocks, the @emph{results}
14820 of code block evaluation, @emph{both} the code and the results of code block
14821 evaluation, or @emph{none}.  For most languages, the default exports code.
14822 However, for some languages (e.g., @code{ditaa}) the default exports the
14823 results of code block evaluation.  For information on exporting code block
14824 bodies, see @ref{Literal examples}.
14826 The @code{:exports} header argument can be used to specify export
14827 behavior (note that these arguments are only relevant for code blocks, not
14828 inline code):
14830 @subsubheading Header arguments:
14832 @table @code
14833 @cindex @code{:exports}, src header argument
14834 @item :exports code
14835 The default in most languages.  The body of the code block is exported, as
14836 described in @ref{Literal examples}.
14837 @item :exports results
14838 The code block will be evaluated each time to buffer is exported, and the
14839 results will be placed in the Org mode buffer for export, either updating
14840 previous results of the code block located anywhere in the buffer or, if no
14841 previous results exist, placing the results immediately after the code block.
14842 The body of the code block will not be exported.
14843 @item :exports both
14844 Both the code block and its results will be exported.
14845 @item :exports none
14846 Neither the code block nor its results will be exported.
14847 @end table
14849 It is possible to inhibit the evaluation of code blocks during export.
14850 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
14851 ensure that no code blocks are evaluated as part of the export process.  This
14852 can be useful in situations where potentially untrusted Org mode files are
14853 exported in an automated fashion, for example when Org mode is used as the
14854 markup language for a wiki.  It is also possible to set this variable to
14855 @code{inline-only}.  In that case, only inline code blocks will be
14856 evaluated, in order to insert their results.  Non-inline code blocks are
14857 assumed to have their results already inserted in the buffer by manual
14858 evaluation.  This setting is useful to avoid expensive recalculations during
14859 export, not to provide security.
14861 Code blocks in commented subtrees (@pxref{Comment lines}) are never evaluated
14862 on export.  However, code blocks in subtrees excluded from export
14863 (@pxref{Export settings}) may be evaluated on export.
14865 @node Extracting source code
14866 @section Extracting source code
14867 @cindex tangling
14868 @cindex source code, extracting
14869 @cindex code block, extracting source code
14871 Creating pure source code files by extracting code from source blocks is
14872 referred to as ``tangling''---a term adopted from the literate programming
14873 community.  During ``tangling'' of code blocks their bodies are expanded
14874 using @code{org-babel-expand-src-block} which can expand both variable and
14875 ``noweb'' style references  (see @ref{Noweb reference syntax}).
14877 @subsubheading Header arguments
14879 @table @code
14880 @cindex @code{:tangle}, src header argument
14881 @item :tangle no
14882 The default.  The code block is not included in the tangled output.
14883 @item :tangle yes
14884 Include the code block in the tangled output.  The output file name is the
14885 name of the org file with the extension @samp{.org} replaced by the extension
14886 for the block language.
14887 @item :tangle filename
14888 Include the code block in the tangled output to file @samp{filename}.
14889 @end table
14891 @kindex  C-c C-v t
14892 @subsubheading Functions
14894 @table @code
14895 @item org-babel-tangle
14896 Tangle the current file.  Bound to @kbd{C-c C-v t}.
14898 With prefix argument only tangle the current code block.
14899 @item org-babel-tangle-file
14900 Choose a file to tangle.  Bound to @kbd{C-c C-v f}.
14901 @end table
14903 @subsubheading Hooks
14905 @table @code
14906 @item org-babel-post-tangle-hook
14907 This hook is run from within code files tangled by @code{org-babel-tangle}.
14908 Example applications could include post-processing, compilation or evaluation
14909 of tangled code files.
14910 @end table
14912 @subsubheading Jumping between code and Org
14914 When tangling code from an Org-mode buffer to a source code file, you'll
14915 frequently find yourself viewing the file of tangled source code (e.g., many
14916 debuggers point to lines of the source code file).  It is useful to be able
14917 to navigate from the tangled source to the Org-mode buffer from which the
14918 code originated.
14920 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
14921 code to Org-mode functionality.  Two header arguments are required for
14922 jumping to work, first the @code{padline} (@ref{padline}) option must be set
14923 to true (the default setting), second the @code{comments} (@ref{comments})
14924 header argument must be set to @code{links}, which will insert comments into
14925 the source code buffer which point back to the original Org-mode file.
14927 @node Evaluating code blocks
14928 @section Evaluating code blocks
14929 @cindex code block, evaluating
14930 @cindex source code, evaluating
14931 @cindex #+RESULTS
14933 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
14934 potential for that code to do harm.  Org mode provides safeguards to ensure
14935 that code is only evaluated after explicit confirmation from the user.  For
14936 information on these safeguards (and on how to disable them) see @ref{Code
14937 evaluation security}.} and the results of evaluation optionally placed in the
14938 Org mode buffer.  The results of evaluation are placed following a line that
14939 begins by default with @code{#+RESULTS} and optionally a cache identifier
14940 and/or the name of the evaluated code block.  The default value of
14941 @code{#+RESULTS} can be changed with the customizable variable
14942 @code{org-babel-results-keyword}.
14944 By default, the evaluation facility is only enabled for Lisp code blocks
14945 specified as @code{emacs-lisp}.  However, source code blocks in many languages
14946 can be evaluated within Org mode (see @ref{Languages} for a list of supported
14947 languages and @ref{Structure of code blocks} for information on the syntax
14948 used to define a code block).
14950 @kindex C-c C-c
14951 There are a number of ways to evaluate code blocks.  The simplest is to press
14952 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
14953 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
14954 evaluation from the @kbd{C-c C-c} key binding.}.  This will call the
14955 @code{org-babel-execute-src-block} function to evaluate the block and insert
14956 its results into the Org mode buffer.
14958 @cindex #+CALL
14959 It is also possible to evaluate named code blocks from anywhere in an Org
14960 mode buffer or an Org mode table.  These named code blocks can be located in
14961 the current Org mode buffer or in the ``Library of Babel'' (@pxref{Library of
14962 Babel}).  Named code blocks can be evaluated with a separate @code{#+CALL:}
14963 line or inline within a block of text.  In both cases the result is wrapped
14964 according to the value of @code{org-babel-inline-result-wrap}, which by
14965 default is @code{"=%s="} for markup that produces verbatim text.
14967 The syntax of the @code{#+CALL:} line is
14969 @example
14970 #+CALL: <name>(<arguments>)
14971 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
14972 @end example
14974 The syntax for inline evaluation of named code blocks is
14976 @example
14977 ... call_<name>(<arguments>) ...
14978 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
14979 @end example
14981 @table @code
14982 @item <name>
14983 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
14984 @item <arguments>
14985 Arguments specified in this section will be passed to the code block.  These
14986 arguments use standard function call syntax, rather than
14987 header argument syntax.  For example, a @code{#+CALL:} line that passes the
14988 number four to a code block named @code{double}, which declares the header
14989 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
14990 @item <inside header arguments>
14991 Inside header arguments are passed through and applied to the named code
14992 block.  These arguments use header argument syntax rather than standard
14993 function call syntax.  Inside header arguments affect how the code block is
14994 evaluated.  For example, @code{[:results output]} will collect the results of
14995 everything printed to @code{STDOUT} during execution of the code block.
14996 @item <end header arguments>
14997 End header arguments are applied to the calling instance and do not affect
14998 evaluation of the named code block.  They affect how the results are
14999 incorporated into the Org mode buffer and how the call line is exported.  For
15000 example, @code{:results html} will insert the results of the call line
15001 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
15003 For more examples of passing header arguments to @code{#+CALL:} lines see
15004 @ref{Header arguments in function calls}.
15005 @end table
15007 @node Library of Babel
15008 @section Library of Babel
15009 @cindex babel, library of
15010 @cindex source code, library
15011 @cindex code block, library
15013 The ``Library of Babel'' consists of code blocks that can be called from any
15014 Org mode file.  Code blocks defined in the ``Library of Babel'' can be called
15015 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
15016 code blocks} for information on the syntax of remote code block evaluation).
15019 The central repository of code blocks in the ``Library of Babel'' is housed
15020 in an Org mode file located in the @samp{contrib} directory of Org mode.
15022 Users can add code blocks they believe to be generally useful to their
15023 ``Library of Babel.''  The code blocks can be stored in any Org mode file and
15024 then loaded into the library with @code{org-babel-lob-ingest}.
15027 @kindex C-c C-v i
15028 Code blocks located in any Org mode file can be loaded into the ``Library of
15029 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
15032 @node Languages
15033 @section Languages
15034 @cindex babel, languages
15035 @cindex source code, languages
15036 @cindex code block, languages
15038 Code blocks in the following languages are supported.
15040 @multitable @columnfractions 0.25 0.25 0.25 0.25
15041 @headitem @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
15042 @item Asymptote @tab asymptote @tab Awk @tab awk
15043 @item C @tab C @tab C++ @tab C++ 
15044 @item Clojure @tab clojure @tab CSS @tab css 
15045 @item D @tab d @tab ditaa @tab ditaa 
15046 @item Graphviz @tab dot @tab Emacs Calc @tab calc
15047 @item Emacs Lisp @tab emacs-lisp @tab Fortran @tab fortran
15048 @item gnuplot @tab gnuplot @tab Haskell @tab haskell 
15049 @item Java @tab java @tab Javascript @tab js 
15050 @item LaTeX @tab latex @tab Ledger @tab ledger 
15051 @item Lisp @tab lisp @tab Lilypond @tab lilypond 
15052 @item MATLAB @tab matlab @tab Mscgen @tab mscgen 
15053 @item Objective Caml @tab ocaml @tab Octave @tab octave 
15054 @item Org mode @tab org @tab Oz @tab oz 
15055 @item Perl @tab perl @tab Plantuml @tab plantuml 
15056 @item Processing.js @tab processing @tab Python @tab python 
15057 @item R @tab R @tab Ruby @tab ruby 
15058 @item Sass @tab sass @tab Scheme @tab scheme 
15059 @item GNU Screen @tab screen @tab shell @tab sh 
15060 @item SQL @tab sql @tab SQLite @tab sqlite
15061 @end multitable
15063 Language-specific documentation is available for some languages.  If
15064 available, it can be found at
15065 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
15067 The option @code{org-babel-load-languages} controls which languages are
15068 enabled for evaluation (by default only @code{emacs-lisp} is enabled).  This
15069 variable can be set using the customization interface or by adding code like
15070 the following to your emacs configuration.
15072 The following disables @code{emacs-lisp} evaluation and enables evaluation of
15073 @code{R} code blocks.
15075 @lisp
15076 (org-babel-do-load-languages
15077  'org-babel-load-languages
15078  '((emacs-lisp . nil)
15079    (R . t)))
15080 @end lisp
15082 It is also possible to enable support for a language by loading the related
15083 elisp file with @code{require}.
15085 The following adds support for evaluating @code{clojure} code blocks.
15087 @lisp
15088 (require 'ob-clojure)
15089 @end lisp
15091 @node Header arguments
15092 @section Header arguments
15093 @cindex code block, header arguments
15094 @cindex source code, block header arguments
15096 Code block functionality can be configured with header arguments.  This
15097 section provides an overview of the use of header arguments, and then
15098 describes each header argument in detail.
15100 @menu
15101 * Using header arguments::      Different ways to set header arguments
15102 * Specific header arguments::   List of header arguments
15103 @end menu
15105 @node Using header arguments
15106 @subsection Using header arguments
15108 The values of header arguments can be set in several way.  When the header
15109 arguments in each layer have been determined, they are combined in order from
15110 the first, least specific (having the lowest priority) up to the last, most
15111 specific (having the highest priority).  A header argument with a higher
15112 priority replaces the same header argument specified at lower priority.
15113 @menu
15114 * System-wide header arguments::  Set global default values
15115 * Language-specific header arguments::  Set default values by language
15116 * Header arguments in Org mode properties::  Set default values for a buffer or heading
15117 * Language-specific header arguments in Org mode properties::  Set language-specific default values for a buffer or heading
15118 * Code block specific header arguments::  The most common way to set values
15119 * Header arguments in function calls::  The most specific level
15120 @end menu
15123 @node System-wide header arguments
15124 @subsubheading System-wide header arguments
15125 @vindex org-babel-default-header-args
15126 System-wide values of header arguments can be specified by adapting the
15127 @code{org-babel-default-header-args} variable:
15129 @cindex @code{:session}, src header argument
15130 @cindex @code{:results}, src header argument
15131 @cindex @code{:exports}, src header argument
15132 @cindex @code{:cache}, src header argument
15133 @cindex @code{:noweb}, src header argument
15134 @example
15135 :session    => "none"
15136 :results    => "replace"
15137 :exports    => "code"
15138 :cache      => "no"
15139 :noweb      => "no"
15140 @end example
15142 For example, the following example could be used to set the default value of
15143 @code{:noweb} header arguments to @code{yes}.  This would have the effect of
15144 expanding @code{:noweb} references by default when evaluating source code
15145 blocks.
15147 @lisp
15148 (setq org-babel-default-header-args
15149       (cons '(:noweb . "yes")
15150             (assq-delete-all :noweb org-babel-default-header-args)))
15151 @end lisp
15153 @node Language-specific header arguments
15154 @subsubheading Language-specific header arguments
15155 Each language can define its own set of default header arguments in variable
15156 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
15157 of the language.  See the language-specific documentation available online at
15158 @uref{http://orgmode.org/worg/org-contrib/babel}.
15160 @node Header arguments in Org mode properties
15161 @subsubheading Header arguments in Org mode properties
15163 Buffer-wide header arguments may be specified as properties through the use
15164 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
15165 @ref{Property syntax}).
15167 For example the following would set @code{session} to @code{*R*} (only for R
15168 code blocks), and @code{results} to @code{silent} for every code block in the
15169 buffer, ensuring that all execution took place in the same session, and no
15170 results would be inserted into the buffer.
15172 @example
15173 #+PROPERTY: header-args:R  :session *R*
15174 #+PROPERTY: header-args    :results silent
15175 @end example
15177 Header arguments read from Org mode properties can also be set on a
15178 per-subtree basis using property drawers (see @ref{Property syntax}).
15179 @vindex org-use-property-inheritance
15180 When properties are used to set default header arguments, they are always
15181 looked up with inheritance, regardless of the value of
15182 @code{org-use-property-inheritance}.  Properties are evaluated as seen by the
15183 outermost call or source block.@footnote{The deprecated syntax for default
15184 header argument properties, using the name of the header argument as a
15185 property name directly, evaluates the property as seen by the corresponding
15186 source block definition.  This behavior has been kept for backwards
15187 compatibility.}
15189 In the following example the value of
15190 the @code{:cache} header argument will default to @code{yes} in all code
15191 blocks in the subtree rooted at the following heading:
15193 @example
15194 * outline header
15195   :PROPERTIES:
15196   :header-args:    :cache yes
15197   :END:
15198 @end example
15200 @kindex C-c C-x p
15201 @vindex org-babel-default-header-args
15202 Properties defined in this way override the properties set in
15203 @code{org-babel-default-header-args} and are applied for all activated
15204 languages.  It is convenient to use the @code{org-set-property} function
15205 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
15207 @node Language-specific header arguments in Org mode properties
15208 @subsubheading Language-specific header arguments in Org mode properties
15210 Language-specific header arguments are also read from properties
15211 @code{header-args:<lang>} where @code{<lang>} is the name of the language
15212 targeted.  As an example
15214 @example
15215 * Heading
15216   :PROPERTIES:
15217   :header-args:clojure:    :session *clojure-1*
15218   :header-args:R:          :session *R*
15219   :END:
15220 ** Subheading
15221   :PROPERTIES:
15222   :header-args:clojure:    :session *clojure-2*
15223   :END:
15224 @end example
15226 would independently set a default session header argument for R and clojure
15227 for calls and source blocks under subtree ``Heading'' and change to a
15228 different clojure setting for evaluations under subtree ``Subheading'', while
15229 the R session is inherited from ``Heading'' and therefore unchanged.
15231 @node Code block specific header arguments
15232 @subsubheading Code block specific header arguments
15234 The most common way to assign values to header arguments is at the
15235 code block level.  This can be done by listing a sequence of header
15236 arguments and their values as part of the @code{#+BEGIN_SRC} line.
15237 Properties set in this way override both the values of
15238 @code{org-babel-default-header-args} and header arguments specified as
15239 properties.  In the following example, the @code{:results} header argument
15240 is set to @code{silent}, meaning the results of execution will not be
15241 inserted in the buffer, and the @code{:exports} header argument is set to
15242 @code{code}, meaning only the body of the code block will be
15243 preserved on export to HTML or @LaTeX{}.
15245 @example
15246 #+NAME: factorial
15247 #+BEGIN_SRC haskell :results silent :exports code :var n=0
15248 fac 0 = 1
15249 fac n = n * fac (n-1)
15250 #+END_SRC
15251 @end example
15252 Similarly, it is possible to set header arguments for inline code blocks
15254 @example
15255 src_haskell[:exports both]@{fac 5@}
15256 @end example
15258 Code block header arguments can span multiple lines using @code{#+HEADER:} or
15259 @code{#+HEADERS:} lines preceding a code block or nested between the
15260 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
15261 @cindex #+HEADER:
15262 @cindex #+HEADERS:
15264 Multi-line header arguments on an un-named code block:
15266 @example
15267  #+HEADERS: :var data1=1
15268  #+BEGIN_SRC emacs-lisp :var data2=2
15269    (message "data1:%S, data2:%S" data1 data2)
15270  #+END_SRC
15272  #+RESULTS:
15273  : data1:1, data2:2
15274 @end example
15276 Multi-line header arguments on a named code block:
15278 @example
15279    #+NAME: named-block
15280    #+HEADER: :var data=2
15281    #+BEGIN_SRC emacs-lisp
15282      (message "data:%S" data)
15283    #+END_SRC
15285    #+RESULTS: named-block
15286    : data:2
15287 @end example
15289 @node Header arguments in function calls
15290 @subsubheading Header arguments in function calls
15292 At the most specific level, header arguments for ``Library of Babel'' or
15293 @code{#+CALL:} lines can be set as shown in the two examples below.  For more
15294 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
15295 blocks}.
15297 The following will apply the @code{:exports results} header argument to the
15298 evaluation of the @code{#+CALL:} line.
15300 @example
15301 #+CALL: factorial(n=5) :exports results
15302 @end example
15304 The following will apply the @code{:session special} header argument to the
15305 evaluation of the @code{factorial} code block.
15307 @example
15308 #+CALL: factorial[:session special](n=5)
15309 @end example
15311 @node Specific header arguments
15312 @subsection Specific header arguments
15313 Header arguments consist of an initial colon followed by the name of the
15314 argument in lowercase letters.  The following header arguments are defined:
15316 @menu
15317 * var::                         Pass arguments to code blocks
15318 * Results::                     Specify the type of results and how they will
15319                                 be collected and handled
15320 * file::                        Specify a path for file output
15321 * file-desc::                   Specify a description for file results
15322 * file-ext::                    Specify an extension for file output
15323 * output-dir::                  Specify a directory to write file output to
15324 * dir::                         Specify the default (possibly remote)
15325                                 directory for code block execution
15326 * exports::                     Export code and/or results
15327 * tangle::                      Toggle tangling and specify file name
15328 * mkdirp::                      Toggle creation of parent directories of target
15329                                 files during tangling
15330 * comments::                    Toggle insertion of comments in tangled
15331                                 code files
15332 * padline::                     Control insertion of padding lines in tangled
15333                                 code files
15334 * no-expand::                   Turn off variable assignment and noweb
15335                                 expansion during tangling
15336 * session::                     Preserve the state of code evaluation
15337 * noweb::                       Toggle expansion of noweb references
15338 * noweb-ref::                   Specify block's noweb reference resolution target
15339 * noweb-sep::                   String used to separate noweb references
15340 * cache::                       Avoid re-evaluating unchanged code blocks
15341 * sep::                         Delimiter for writing tabular results outside Org
15342 * hlines::                      Handle horizontal lines in tables
15343 * colnames::                    Handle column names in tables
15344 * rownames::                    Handle row names in tables
15345 * shebang::                     Make tangled files executable
15346 * tangle-mode::                 Set permission of tangled files
15347 * eval::                        Limit evaluation of specific code blocks
15348 * wrap::                        Mark source block evaluation results
15349 * post::                        Post processing of code block results
15350 * prologue::                    Text to prepend to code block body
15351 * epilogue::                    Text to append to code block body
15352 @end menu
15354 Additional header arguments are defined on a language-specific basis, see
15355 @ref{Languages}.
15357 @node var
15358 @subsubsection @code{:var}
15359 @cindex @code{:var}, src header argument
15360 The @code{:var} header argument is used to pass arguments to code blocks.
15361 The specifics of how arguments are included in a code block vary by language;
15362 these are addressed in the language-specific documentation.  However, the
15363 syntax used to specify arguments is the same across all languages.  In every
15364 case, variables require a default value when they are declared.
15366 The values passed to arguments can either be literal values, references, or
15367 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
15368 References include anything in the Org mode file that takes a @code{#+NAME:}
15369 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
15370 other code blocks and the results of other code blocks.
15372 Note: When a reference is made to another code block, the referenced block
15373 will be evaluated unless it has current cached results (see @ref{cache}).
15375 Argument values can be indexed in a manner similar to arrays (see @ref{var,
15376 Indexable variable values}).
15378 The following syntax is used to pass arguments to code blocks using the
15379 @code{:var} header argument.
15381 @example
15382 :var name=assign
15383 @end example
15385 The argument, @code{assign}, can either be a literal value, such as a string
15386 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
15387 literal example, another code block (with or without arguments), or the
15388 results of evaluating another code block.
15390 Here are examples of passing values by reference:
15392 @table @dfn
15394 @item table
15395 an Org mode table named with either a @code{#+NAME:} line
15397 @example
15398 #+NAME: example-table
15399 | 1 |
15400 | 2 |
15401 | 3 |
15402 | 4 |
15404 #+NAME: table-length
15405 #+BEGIN_SRC emacs-lisp :var table=example-table
15406 (length table)
15407 #+END_SRC
15409 #+RESULTS: table-length
15410 : 4
15411 @end example
15413 @item list
15414 a simple list named with a @code{#+NAME:} line (note that nesting is not
15415 carried through to the source code block)
15417 @example
15418 #+NAME: example-list
15419   - simple
15420     - not
15421     - nested
15422   - list
15424 #+BEGIN_SRC emacs-lisp :var x=example-list
15425   (print x)
15426 #+END_SRC
15428 #+RESULTS:
15429 | simple | list |
15430 @end example
15432 @item code block without arguments
15433 a code block name (from the example above), as assigned by @code{#+NAME:},
15434 optionally followed by parentheses
15436 @example
15437 #+BEGIN_SRC emacs-lisp :var length=table-length()
15438 (* 2 length)
15439 #+END_SRC
15441 #+RESULTS:
15442 : 8
15443 @end example
15445 @item code block with arguments
15446 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
15447 optional arguments passed within the parentheses following the
15448 code block name using standard function call syntax
15450 @example
15451 #+NAME: double
15452 #+BEGIN_SRC emacs-lisp :var input=8
15453 (* 2 input)
15454 #+END_SRC
15456 #+RESULTS: double
15457 : 16
15459 #+NAME: squared
15460 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
15461 (* input input)
15462 #+END_SRC
15464 #+RESULTS: squared
15465 : 4
15466 @end example
15468 @item literal example
15469 a literal example block named with a @code{#+NAME:} line
15471 @example
15472 #+NAME: literal-example
15473 #+BEGIN_EXAMPLE
15474 A literal example
15475 on two lines
15476 #+END_EXAMPLE
15478 #+NAME: read-literal-example
15479 #+BEGIN_SRC emacs-lisp :var x=literal-example
15480   (concatenate 'string x " for you.")
15481 #+END_SRC
15483 #+RESULTS: read-literal-example
15484 : A literal example
15485 : on two lines for you.
15487 @end example
15489 @end table
15491 @subsubheading Indexable variable values
15492 It is possible to reference portions of variable values by ``indexing'' into
15493 the variables.  Indexes are 0 based with negative values counting back from
15494 the end.  If an index is separated by @code{,}s then each subsequent section
15495 will index into the next deepest nesting or dimension of the value.  Note
15496 that this indexing occurs @emph{before} other table related header arguments
15497 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied.  The
15498 following example assigns the last cell of the first row the table
15499 @code{example-table} to the variable @code{data}:
15501 @example
15502 #+NAME: example-table
15503 | 1 | a |
15504 | 2 | b |
15505 | 3 | c |
15506 | 4 | d |
15508 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
15509   data
15510 #+END_SRC
15512 #+RESULTS:
15513 : a
15514 @end example
15516 Ranges of variable values can be referenced using two integers separated by a
15517 @code{:}, in which case the entire inclusive range is referenced.  For
15518 example the following assigns the middle three rows of @code{example-table}
15519 to @code{data}.
15521 @example
15522 #+NAME: example-table
15523 | 1 | a |
15524 | 2 | b |
15525 | 3 | c |
15526 | 4 | d |
15527 | 5 | 3 |
15529 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
15530   data
15531 #+END_SRC
15533 #+RESULTS:
15534 | 2 | b |
15535 | 3 | c |
15536 | 4 | d |
15537 @end example
15539 Additionally, an empty index, or the single character @code{*}, are both
15540 interpreted to mean the entire range and as such are equivalent to
15541 @code{0:-1}, as shown in the following example in which the entire first
15542 column is referenced.
15544 @example
15545 #+NAME: example-table
15546 | 1 | a |
15547 | 2 | b |
15548 | 3 | c |
15549 | 4 | d |
15551 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
15552   data
15553 #+END_SRC
15555 #+RESULTS:
15556 | 1 | 2 | 3 | 4 |
15557 @end example
15559 It is possible to index into the results of code blocks as well as tables.
15560 Any number of dimensions can be indexed.  Dimensions are separated from one
15561 another by commas, as shown in the following example.
15563 @example
15564 #+NAME: 3D
15565 #+BEGIN_SRC emacs-lisp
15566   '(((1  2  3)  (4  5  6)  (7  8  9))
15567     ((10 11 12) (13 14 15) (16 17 18))
15568     ((19 20 21) (22 23 24) (25 26 27)))
15569 #+END_SRC
15571 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
15572   data
15573 #+END_SRC
15575 #+RESULTS:
15576 | 11 | 14 | 17 |
15577 @end example
15579 @subsubheading Emacs Lisp evaluation of variables
15581 Emacs lisp code can be used to initialize variable values.  When a variable
15582 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
15583 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
15584 the variable value.  The following example demonstrates use of this
15585 evaluation to reliably pass the file-name of the Org mode buffer to a code
15586 block---note that evaluation of header arguments is guaranteed to take place
15587 in the original Org mode file, while there is no such guarantee for
15588 evaluation of the code block body.
15590 @example
15591 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
15592   wc -w $filename
15593 #+END_SRC
15594 @end example
15596 Note that values read from tables and lists will not be evaluated as
15597 Emacs Lisp, as shown in the following example.
15599 @example
15600 #+NAME: table
15601 | (a b c) |
15603 #+HEADERS: :var data=table[0,0]
15604 #+BEGIN_SRC perl
15605   $data
15606 #+END_SRC
15608 #+RESULTS:
15609 : (a b c)
15610 @end example
15612 @node Results
15613 @subsubsection @code{:results}
15614 @cindex @code{:results}, src header argument
15616 There are four classes of @code{:results} header argument.  Only one option
15617 per class may be supplied per code block.
15619 @itemize @bullet
15620 @item
15621 @b{collection} header arguments specify how the results should be collected
15622 from the code block
15623 @item
15624 @b{type} header arguments specify what type of result the code block will
15625 return---which has implications for how they will be processed before
15626 insertion into the Org mode buffer
15627 @item
15628 @b{format} header arguments specify what type of result the code block will
15629 return---which has implications for how they will be inserted into the
15630 Org mode buffer
15631 @item
15632 @b{handling} header arguments specify how the results of evaluating the code
15633 block should be handled.
15634 @end itemize
15636 @subsubheading Collection
15637 The following options are mutually exclusive, and specify how the results
15638 should be collected from the code block.
15640 @itemize @bullet
15641 @item @code{value}
15642 This is the default.  The result is the value of the last statement in the
15643 code block.  This header argument places the evaluation in functional
15644 mode.  Note that in some languages, e.g., Python, use of this result type
15645 requires that a @code{return} statement be included in the body of the source
15646 code block.  E.g., @code{:results value}.
15647 @item @code{output}
15648 The result is the collection of everything printed to STDOUT during the
15649 execution of the code block.  This header argument places the
15650 evaluation in scripting mode.  E.g., @code{:results output}.
15651 @end itemize
15653 @subsubheading Type
15655 The following options are mutually exclusive and specify what type of results
15656 the code block will return.  By default, results are inserted as either a
15657 table or scalar depending on their value.
15659 @itemize @bullet
15660 @item @code{table}, @code{vector}
15661 The results should be interpreted as an Org mode table.  If a single value is
15662 returned, it will be converted into a table with one row and one column.
15663 E.g., @code{:results value table}.
15664 @item @code{list}
15665 The results should be interpreted as an Org mode list.  If a single scalar
15666 value is returned it will be converted into a list with only one element.
15667 @item @code{scalar}, @code{verbatim}
15668 The results should be interpreted literally---they will not be
15669 converted into a table.  The results will be inserted into the Org mode
15670 buffer as quoted text.  E.g., @code{:results value verbatim}.
15671 @item @code{file}
15672 The results will be interpreted as the path to a file, and will be inserted
15673 into the Org mode buffer as a file link.  E.g., @code{:results value file}.
15674 @end itemize
15676 @subsubheading Format
15678 The following options are mutually exclusive and specify what type of results
15679 the code block will return.  By default, results are inserted according to the
15680 type as specified above.
15682 @itemize @bullet
15683 @item @code{raw}
15684 The results are interpreted as raw Org mode code and are inserted directly
15685 into the buffer.  If the results look like a table they will be aligned as
15686 such by Org mode.  E.g., @code{:results value raw}.
15687 @item @code{org}
15688 The results are will be enclosed in a @code{BEGIN_SRC org} block.
15689 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
15690 in the block and/or if you export the file.  E.g., @code{:results value org}.
15691 @item @code{html}
15692 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
15693 block.  E.g., @code{:results value html}.
15694 @item @code{latex}
15695 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
15696 E.g., @code{:results value latex}.
15697 @item @code{code}
15698 Result are assumed to be parsable code and are enclosed in a code block.
15699 E.g., @code{:results value code}.
15700 @item @code{pp}
15701 The result is converted to pretty-printed code and is enclosed in a code
15702 block.  This option currently supports Emacs Lisp, Python, and Ruby.  E.g.,
15703 @code{:results value pp}.
15704 @item @code{drawer}
15705 The result is wrapped in a RESULTS drawer.  This can be useful for
15706 inserting @code{raw} or @code{org} syntax results in such a way that their
15707 extent is known and they can be automatically removed or replaced.
15708 @end itemize
15710 @subsubheading Handling
15711 The following results options indicate what happens with the
15712 results once they are collected.
15714 @itemize @bullet
15715 @item @code{silent}
15716 The results will be echoed in the minibuffer but will not be inserted into
15717 the Org mode buffer.  E.g., @code{:results output silent}.
15718 @item @code{replace}
15719 The default value.  Any existing results will be removed, and the new results
15720 will be inserted into the Org mode buffer in their place.  E.g.,
15721 @code{:results output replace}.
15722 @item @code{append}
15723 If there are pre-existing results of the code block then the new results will
15724 be appended to the existing results.  Otherwise the new results will be
15725 inserted as with @code{replace}.
15726 @item @code{prepend}
15727 If there are pre-existing results of the code block then the new results will
15728 be prepended to the existing results.  Otherwise the new results will be
15729 inserted as with @code{replace}.
15730 @end itemize
15732 @node file
15733 @subsubsection @code{:file}
15734 @cindex @code{:file}, src header argument
15736 The header argument @code{:file} is used to specify an external file in which
15737 to save code block results.  After code block evaluation an Org mode style
15738 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
15739 into the Org mode buffer.  Some languages including R, gnuplot, dot, and
15740 ditaa provide special handling of the @code{:file} header argument
15741 automatically wrapping the code block body in the boilerplate code required
15742 to save output to the specified file.  This is often useful for saving
15743 graphical output of a code block to the specified file.
15745 The argument to @code{:file} should be either a string specifying the path to
15746 a file, or a list of two strings in which case the first element of the list
15747 should be the path to a file and the second a description for the link.
15749 @node file-desc
15750 @subsubsection @code{:file-desc}
15752 The value of the @code{:file-desc} header argument is used to provide a
15753 description for file code block results which are inserted as Org mode links
15754 (see @ref{Link format}).  If the @code{:file-desc} header argument is given
15755 with no value the link path will be placed in both the ``link'' and the
15756 ``description'' portion of the Org mode link.
15758 @node file-ext
15759 @subsubsection @code{:file-ext}
15760 @cindex @code{:file-ext}, src header argument
15762 The value of the @code{:file-ext} header argument is used to provide an
15763 extension to write the file output to.  It is combined with the
15764 @code{#+NAME:} of the source block and the value of the @ref{output-dir}
15765 header argument to generate a complete file name.
15767 This header arg will be overridden by @code{:file}, and thus has no effect
15768 when the latter is specified.
15770 @node output-dir
15771 @subsubsection @code{:output-dir}
15772 @cindex @code{:output-dir}, src header argument
15774 The value of the @code{:output-dir} header argument is used to provide a
15775 directory to write the file output to.  It may specify an absolute directory
15776 (beginning with @code{/}) or a relative directory (without @code{/}).  It can
15777 be combined with the @code{#+NAME:} of the source block and the value of the
15778 @ref{file-ext} header argument to generate a complete file name, or used
15779 along with a @ref{file} header arg.
15781 @node dir
15782 @subsubsection @code{:dir} and remote execution
15783 @cindex @code{:dir}, src header argument
15785 While the @code{:file} header argument can be used to specify the path to the
15786 output file, @code{:dir} specifies the default directory during code block
15787 execution.  If it is absent, then the directory associated with the current
15788 buffer is used.  In other words, supplying @code{:dir path} temporarily has
15789 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
15790 then not supplying @code{:dir}.  Under the surface, @code{:dir} simply sets
15791 the value of the Emacs variable @code{default-directory}.
15793 When using @code{:dir}, you should supply a relative path for file output
15794 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
15795 case that path will be interpreted relative to the default directory.
15797 In other words, if you want your plot to go into a folder called @file{Work}
15798 in your home directory, you could use
15800 @example
15801 #+BEGIN_SRC R :file myplot.png :dir ~/Work
15802 matplot(matrix(rnorm(100), 10), type="l")
15803 #+END_SRC
15804 @end example
15806 @subsubheading Remote execution
15807 A directory on a remote machine can be specified using tramp file syntax, in
15808 which case the code will be evaluated on the remote machine.  An example is
15810 @example
15811 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
15812 plot(1:10, main=system("hostname", intern=TRUE))
15813 #+END_SRC
15814 @end example
15816 Text results will be returned to the local Org mode buffer as usual, and file
15817 output will be created on the remote machine with relative paths interpreted
15818 relative to the remote directory.  An Org mode link to the remote file will be
15819 created.
15821 So, in the above example a plot will be created on the remote machine,
15822 and a link of the following form will be inserted in the org buffer:
15824 @example
15825 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
15826 @end example
15828 Most of this functionality follows immediately from the fact that @code{:dir}
15829 sets the value of the Emacs variable @code{default-directory}, thanks to
15830 tramp.  Those using XEmacs, or GNU Emacs prior to version 23 may need to
15831 install tramp separately in order for these features to work correctly.
15833 @subsubheading Further points
15835 @itemize @bullet
15836 @item
15837 If @code{:dir} is used in conjunction with @code{:session}, although it will
15838 determine the starting directory for a new session as expected, no attempt is
15839 currently made to alter the directory associated with an existing session.
15840 @item
15841 @code{:dir} should typically not be used to create files during export with
15842 @code{:exports results} or @code{:exports both}.  The reason is that, in order
15843 to retain portability of exported material between machines, during export
15844 links inserted into the buffer will @emph{not} be expanded against @code{default
15845 directory}.  Therefore, if @code{default-directory} is altered using
15846 @code{:dir}, it is probable that the file will be created in a location to
15847 which the link does not point.
15848 @end itemize
15850 @node exports
15851 @subsubsection @code{:exports}
15852 @cindex @code{:exports}, src header argument
15854 The @code{:exports} header argument specifies what should be included in HTML
15855 or @LaTeX{} exports of the Org mode file.  Note that the @code{:exports}
15856 option is only relevant for code blocks, not inline code.
15858 @itemize @bullet
15859 @item @code{code}
15860 The default.  The body of code is included into the exported file.  E.g.,
15861 @code{:exports code}.
15862 @item @code{results}
15863 The result of evaluating the code is included in the exported file.  E.g.,
15864 @code{:exports results}.
15865 @item @code{both}
15866 Both the code and results are included in the exported file.  E.g.,
15867 @code{:exports both}.
15868 @item @code{none}
15869 Nothing is included in the exported file.  E.g., @code{:exports none}.
15870 @end itemize
15872 @node tangle
15873 @subsubsection @code{:tangle}
15874 @cindex @code{:tangle}, src header argument
15876 The @code{:tangle} header argument specifies whether or not the code
15877 block should be included in tangled extraction of source code files.
15879 @itemize @bullet
15880 @item @code{tangle}
15881 The code block is exported to a source code file named after the full path
15882 (including the directory) and file name (w/o extension) of the Org mode file.
15883 E.g., @code{:tangle yes}.
15884 @item @code{no}
15885 The default.  The code block is not exported to a source code file.
15886 E.g., @code{:tangle no}.
15887 @item other
15888 Any other string passed to the @code{:tangle} header argument is interpreted
15889 as a path (directory and file name relative to the directory of the Org mode
15890 file) to which the block will be exported.  E.g., @code{:tangle path}.
15891 @end itemize
15893 @node mkdirp
15894 @subsubsection @code{:mkdirp}
15895 @cindex @code{:mkdirp}, src header argument
15897 The @code{:mkdirp} header argument can be used to create parent directories
15898 of tangled files when missing.  This can be set to @code{yes} to enable
15899 directory creation or to @code{no} to inhibit directory creation.
15901 @node comments
15902 @subsubsection @code{:comments}
15903 @cindex @code{:comments}, src header argument
15904 By default code blocks are tangled to source-code files without any insertion
15905 of comments beyond those which may already exist in the body of the code
15906 block.  The @code{:comments} header argument can be set as follows to control
15907 the insertion of extra comments into the tangled code file.
15909 @itemize @bullet
15910 @item @code{no}
15911 The default.  No extra comments are inserted during tangling.
15912 @item @code{link}
15913 The code block is wrapped in comments which contain pointers back to the
15914 original Org file from which the code was tangled.
15915 @item @code{yes}
15916 A synonym for ``link'' to maintain backwards compatibility.
15917 @item @code{org}
15918 Include text from the Org mode file as a comment.
15919 The text is picked from the leading context of the tangled code and is
15920 limited by the nearest headline or source block as the case may be.
15921 @item @code{both}
15922 Turns on both the ``link'' and ``org'' comment options.
15923 @item @code{noweb}
15924 Turns on the ``link'' comment option, and additionally wraps expanded noweb
15925 references in the code block body in link comments.
15926 @end itemize
15928 @node padline
15929 @subsubsection @code{:padline}
15930 @cindex @code{:padline}, src header argument
15931 Control in insertion of padding lines around code block bodies in tangled
15932 code files.  The default value is @code{yes} which results in insertion of
15933 newlines before and after each tangled code block.  The following arguments
15934 are accepted.
15936 @itemize @bullet
15937 @item @code{yes}
15938 Insert newlines before and after each code block body in tangled code files.
15939 @item @code{no}
15940 Do not insert any newline padding in tangled output.
15941 @end itemize
15943 @node no-expand
15944 @subsubsection @code{:no-expand}
15945 @cindex @code{:no-expand}, src header argument
15947 By default, code blocks are expanded with @code{org-babel-expand-src-block}
15948 during tangling.  This has the effect of assigning values to variables
15949 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
15950 references (see @ref{Noweb reference syntax}) with their targets.  The
15951 @code{:no-expand} header argument can be used to turn off this behavior.
15952 Note: The @code{:no-expand} header argument has no impact on export,
15953 i.e. code blocks will irrespective of this header argument expanded for
15954 execution.
15956 @node session
15957 @subsubsection @code{:session}
15958 @cindex @code{:session}, src header argument
15960 The @code{:session} header argument starts a (possibly named) session for an
15961 interpreted language where the interpreter’s state is preserved.  All code
15962 blocks sharing the same name are exectuted by the same interpreter process.
15963 By default, a session is not started.
15965 @itemize @bullet
15966 @item @code{none}
15967 The default.  Each block is evaluated in its own interpreter process, which
15968 is terminated after the evaluation.
15969 @item @code{other}
15970 Any other string passed to the @code{:session} header argument will give the
15971 session a name.  For example, @code{:session mysession}.  If @code{:session}
15972 is given but no name string is specified, the session is named according to
15973 the language used in the block.  All blocks with the same session name share
15974 the same session.  Using different session names enables concurrent sessions
15975 (even for the same interpreted language).
15977 @end itemize
15979 @node noweb
15980 @subsubsection @code{:noweb}
15981 @cindex @code{:noweb}, src header argument
15983 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
15984 references (see @ref{Noweb reference syntax}) when the code block is
15985 evaluated, tangled, or exported.  The @code{:noweb} header argument can have
15986 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
15987 @code{no-export} @code{strip-export}.
15989 @itemize @bullet
15990 @item @code{no}
15991 The default.  ``Noweb'' syntax references in the body of the code block will
15992 not be expanded before the code block is evaluated, tangled or exported.
15993 @item @code{yes}
15994 ``Noweb'' syntax references in the body of the code block will be
15995 expanded before the code block is evaluated, tangled or exported.
15996 @item @code{tangle}
15997 ``Noweb'' syntax references in the body of the code block will be expanded
15998 before the code block is tangled.  However, ``noweb'' syntax references will
15999 not be expanded when the code block is evaluated or exported.
16000 @item @code{no-export}
16001 ``Noweb'' syntax references in the body of the code block will be expanded
16002 before the block is evaluated or tangled.  However, ``noweb'' syntax
16003 references will not be expanded when the code block is exported.
16004 @item @code{strip-export}
16005 ``Noweb'' syntax references in the body of the code block will be expanded
16006 before the block is evaluated or tangled.  However, ``noweb'' syntax
16007 references will be removed when the code block is exported.
16008 @item @code{eval}
16009 ``Noweb'' syntax references in the body of the code block will only be
16010 expanded before the block is evaluated.
16011 @end itemize
16013 @subsubheading Noweb prefix lines
16014 Noweb insertions are now placed behind the line prefix of the
16015 @code{<<reference>>}.
16016 This behavior is illustrated in the following example.  Because the
16017 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
16018 each line of the expanded noweb reference will be commented.
16020 This code block:
16022 @example
16023 -- <<example>>
16024 @end example
16026 expands to:
16028 @example
16029 -- this is the
16030 -- multi-line body of example
16031 @end example
16033 Note that noweb replacement text that does not contain any newlines will not
16034 be affected by this change, so it is still possible to use inline noweb
16035 references.
16037 @node noweb-ref
16038 @subsubsection @code{:noweb-ref}
16039 @cindex @code{:noweb-ref}, src header argument
16040 When expanding ``noweb'' style references, the bodies of all code block with
16041 @emph{either} a block name matching the reference name @emph{or} a
16042 @code{:noweb-ref} header argument matching the reference name will be
16043 concatenated together to form the replacement text.
16045 By setting this header argument at the subtree or file level, simple code
16046 block concatenation may be achieved.  For example, when tangling the
16047 following Org mode file, the bodies of code blocks will be concatenated into
16048 the resulting pure code file@footnote{(The example needs property inheritance
16049 to be turned on for the @code{noweb-ref} property, see @ref{Property
16050 inheritance}).}.
16052 @example
16053  #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
16054    <<fullest-disk>>
16055  #+END_SRC
16056  * the mount point of the fullest disk
16057    :PROPERTIES:
16058    :noweb-ref: fullest-disk
16059    :END:
16061  ** query all mounted disks
16062  #+BEGIN_SRC sh
16063    df \
16064  #+END_SRC
16066  ** strip the header row
16067  #+BEGIN_SRC sh
16068    |sed '1d' \
16069  #+END_SRC
16071  ** sort by the percent full
16072  #+BEGIN_SRC sh
16073    |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
16074  #+END_SRC
16076  ** extract the mount point
16077  #+BEGIN_SRC sh
16078    |awk '@{print $2@}'
16079  #+END_SRC
16080 @end example
16082 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
16083 used to separate accumulate noweb references like those above.  By default a
16084 newline is used.
16086 @node noweb-sep
16087 @subsubsection @code{:noweb-sep}
16088 @cindex @code{:noweb-sep}, src header argument
16090 The @code{:noweb-sep} header argument holds the string used to separate
16091 accumulate noweb references (see @ref{noweb-ref}).  By default a newline is
16092 used.
16094 @node cache
16095 @subsubsection @code{:cache}
16096 @cindex @code{:cache}, src header argument
16098 The @code{:cache} header argument controls the use of in-buffer caching of
16099 the results of evaluating code blocks.  It can be used to avoid re-evaluating
16100 unchanged code blocks.  Note that the @code{:cache} header argument will not
16101 attempt to cache results when the @code{:session} header argument is used,
16102 because the results of the code block execution may be stored in the session
16103 outside of the Org mode buffer.  The @code{:cache} header argument can have
16104 one of two values: @code{yes} or @code{no}.
16106 @itemize @bullet
16107 @item @code{no}
16108 The default.  No caching takes place, and the code block will be evaluated
16109 every time it is called.
16110 @item @code{yes}
16111 Every time the code block is run a SHA1 hash of the code and arguments
16112 passed to the block will be generated.  This hash is packed into the
16113 @code{#+RESULTS:} line and will be checked on subsequent
16114 executions of the code block.  If the code block has not
16115 changed since the last time it was evaluated, it will not be re-evaluated.
16116 @end itemize
16118 Code block caches notice if the value of a variable argument
16119 to the code block has changed.  If this is the case, the cache is
16120 invalidated and the code block is re-run.  In the following example,
16121 @code{caller} will not be re-run unless the results of @code{random} have
16122 changed since it was last run.
16124 @example
16125  #+NAME: random
16126  #+BEGIN_SRC R :cache yes
16127  runif(1)
16128  #+END_SRC
16130  #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
16131  0.4659510825295
16133  #+NAME: caller
16134  #+BEGIN_SRC emacs-lisp :var x=random :cache yes
16136  #+END_SRC
16138  #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
16139  0.254227238707244
16140 @end example
16142 @node sep
16143 @subsubsection @code{:sep}
16144 @cindex @code{:sep}, src header argument
16146 The @code{:sep} header argument can be used to control the delimiter used
16147 when writing tabular results out to files external to Org mode.  This is used
16148 either when opening tabular results of a code block by calling the
16149 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
16150 or when writing code block results to an external file (see @ref{file})
16151 header argument.
16153 By default, when @code{:sep} is not specified output tables are tab
16154 delimited.
16156 @node hlines
16157 @subsubsection @code{:hlines}
16158 @cindex @code{:hlines}, src header argument
16160 Tables are frequently represented with one or more horizontal lines, or
16161 hlines.  The @code{:hlines} argument to a code block accepts the
16162 values @code{yes} or @code{no}, with a default value of @code{no}.
16164 @itemize @bullet
16165 @item @code{no}
16166 Strips horizontal lines from the input table.  In most languages this is the
16167 desired effect because an @code{hline} symbol is interpreted as an unbound
16168 variable and raises an error.  Setting @code{:hlines no} or relying on the
16169 default value yields the following results.
16171 @example
16172 #+NAME: many-cols
16173 | a | b | c |
16174 |---+---+---|
16175 | d | e | f |
16176 |---+---+---|
16177 | g | h | i |
16179 #+NAME: echo-table
16180 #+BEGIN_SRC python :var tab=many-cols
16181   return tab
16182 #+END_SRC
16184 #+RESULTS: echo-table
16185 | a | b | c |
16186 | d | e | f |
16187 | g | h | i |
16188 @end example
16190 @item @code{yes}
16191 Leaves hlines in the table.  Setting @code{:hlines yes} has this effect.
16193 @example
16194 #+NAME: many-cols
16195 | a | b | c |
16196 |---+---+---|
16197 | d | e | f |
16198 |---+---+---|
16199 | g | h | i |
16201 #+NAME: echo-table
16202 #+BEGIN_SRC python :var tab=many-cols :hlines yes
16203   return tab
16204 #+END_SRC
16206 #+RESULTS: echo-table
16207 | a | b | c |
16208 |---+---+---|
16209 | d | e | f |
16210 |---+---+---|
16211 | g | h | i |
16212 @end example
16213 @end itemize
16215 @node colnames
16216 @subsubsection @code{:colnames}
16217 @cindex @code{:colnames}, src header argument
16219 The @code{:colnames} header argument accepts the values @code{yes},
16220 @code{no}, or @code{nil} for unassigned.  The default value is @code{nil}.
16221 Note that the behavior of the @code{:colnames} header argument may differ
16222 across languages.
16224 @itemize @bullet
16225 @item @code{nil}
16226 If an input table looks like it has column names
16227 (because its second row is an hline), then the column
16228 names will be removed from the table before
16229 processing, then reapplied to the results.
16231 @example
16232 #+NAME: less-cols
16233 | a |
16234 |---|
16235 | b |
16236 | c |
16238 #+NAME: echo-table-again
16239 #+BEGIN_SRC python :var tab=less-cols
16240   return [[val + '*' for val in row] for row in tab]
16241 #+END_SRC
16243 #+RESULTS: echo-table-again
16244 | a  |
16245 |----|
16246 | b* |
16247 | c* |
16248 @end example
16250 Please note that column names are not removed before the table is indexed
16251 using variable indexing @xref{var, Indexable variable values}.
16253 @item @code{no}
16254 No column name pre-processing takes place
16256 @item @code{yes}
16257 Column names are removed and reapplied as with @code{nil} even if the table
16258 does not ``look like'' it has column names (i.e., the second row is not an
16259 hline)
16260 @end itemize
16262 @node rownames
16263 @subsubsection @code{:rownames}
16264 @cindex @code{:rownames}, src header argument
16266 The @code{:rownames} header argument can take on the values @code{yes} or
16267 @code{no}, with a default value of @code{no}.  Note that Emacs Lisp code
16268 blocks ignore the @code{:rownames} header argument entirely given the ease
16269 with which tables with row names may be handled directly in Emacs Lisp.
16271 @itemize @bullet
16272 @item @code{no}
16273 No row name pre-processing will take place.
16275 @item @code{yes}
16276 The first column of the table is removed from the table before processing,
16277 and is then reapplied to the results.
16279 @example
16280 #+NAME: with-rownames
16281 | one | 1 | 2 | 3 | 4 |  5 |
16282 | two | 6 | 7 | 8 | 9 | 10 |
16284 #+NAME: echo-table-once-again
16285 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
16286   return [[val + 10 for val in row] for row in tab]
16287 #+END_SRC
16289 #+RESULTS: echo-table-once-again
16290 | one | 11 | 12 | 13 | 14 | 15 |
16291 | two | 16 | 17 | 18 | 19 | 20 |
16292 @end example
16294 Please note that row names are not removed before the table is indexed using
16295 variable indexing @xref{var, Indexable variable values}.
16297 @end itemize
16299 @node shebang
16300 @subsubsection @code{:shebang}
16301 @cindex @code{:shebang}, src header argument
16303 Setting the @code{:shebang} header argument to a string value
16304 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
16305 first line of any tangled file holding the code block, and the file
16306 permissions of the tangled file are set to make it executable.
16309 @node tangle-mode
16310 @subsubsection @code{:tangle-mode}
16311 @cindex @code{:tangle-mode}, src header argument
16313 The @code{tangle-mode} header argument controls the permission set on tangled
16314 files.  The value of this header argument will be passed to
16315 @code{set-file-modes}.  For example, to set a tangled file as read only use
16316 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
16317 use @code{:tangle-mode (identity #o755)}.  Blocks with @code{shebang}
16318 (@ref{shebang}) header arguments will automatically be made executable unless
16319 the @code{tangle-mode} header argument is also used.  The behavior is
16320 undefined if multiple code blocks with different values for the
16321 @code{tangle-mode} header argument are tangled to the same file.
16323 @node eval
16324 @subsubsection @code{:eval}
16325 @cindex @code{:eval}, src header argument
16326 The @code{:eval} header argument can be used to limit the evaluation of
16327 specific code blocks.  The @code{:eval} header argument can be useful for
16328 protecting against the evaluation of dangerous code blocks or to ensure that
16329 evaluation will require a query regardless of the value of the
16330 @code{org-confirm-babel-evaluate} variable.  The possible values of
16331 @code{:eval} and their effects are shown below.
16333 @table @code
16334 @item never or no
16335 The code block will not be evaluated under any circumstances.
16336 @item query
16337 Evaluation of the code block will require a query.
16338 @item never-export or no-export
16339 The code block will not be evaluated during export but may still be called
16340 interactively.
16341 @item query-export
16342 Evaluation of the code block during export will require a query.
16343 @end table
16345 If this header argument is not set then evaluation is determined by the value
16346 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
16347 security}.
16349 @node wrap
16350 @subsubsection @code{:wrap}
16351 @cindex @code{:wrap}, src header argument
16352 The @code{:wrap} header argument is used to mark the results of source block
16353 evaluation.  The header argument can be passed a string that will be appended
16354 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
16355 results.  If not string is specified then the results will be wrapped in a
16356 @code{#+BEGIN/END_RESULTS} block.
16358 @node post
16359 @subsubsection @code{:post}
16360 @cindex @code{:post}, src header argument
16361 The @code{:post} header argument is used to post-process the results of a
16362 code block execution.  When a post argument is given, the results of the code
16363 block will temporarily be bound to the @code{*this*} variable.  This variable
16364 may then be included in header argument forms such as those used in @ref{var}
16365 header argument specifications allowing passing of results to other code
16366 blocks, or direct execution via Emacs Lisp.  Additional header arguments may
16367 be passed to the @code{:post}-function.
16369 The following two examples illustrate the usage of the @code{:post} header
16370 argument.  The first example shows how to attach a attribute-line via @code{:post}.
16372 @example
16373 #+name: attr_wrap
16374 #+begin_src sh :var data="" :var width="\\textwidth" :results output
16375   echo "#+ATTR_LATEX :width $width"
16376   echo "$data"
16377 #+end_src
16379 #+header: :file /tmp/it.png
16380 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
16381   digraph@{
16382           a -> b;
16383           b -> c;
16384           c -> a;
16385   @}
16386 #+end_src
16388 #+RESULTS:
16389 :RESULTS:
16390 #+ATTR_LATEX :width 5cm
16391 [[file:/tmp/it.png]]
16392 :END:
16393 @end example
16395 The second examples shows how to use @code{:post} together with the
16396 @code{:colnames} header argument.
16397 @example
16398 #+name: round-tbl
16399 #+begin_src emacs-lisp :var tbl="" fmt="%.3f"
16400   (mapcar (lambda (row)
16401             (mapcar (lambda (cell)
16402                       (if (numberp cell)
16403                           (format fmt cell)
16404                         cell))
16405                     row))
16406           tbl)
16407 #+end_src
16409 #+begin_src R :colnames yes :post round-tbl[:colnames yes](*this*)
16410 set.seed(42)
16411 data.frame(foo=rnorm(1))
16412 #+end_src
16414 #+RESULTS:
16415 |   foo |
16416 |-------|
16417 | 1.371 |
16418 @end example
16420 @node prologue
16421 @subsubsection @code{:prologue}
16422 @cindex @code{:prologue}, src header argument
16423 The value of the @code{prologue} header argument will be prepended to the
16424 code block body before execution.  For example, @code{:prologue "reset"} may
16425 be used to reset a gnuplot session before execution of a particular code
16426 block, or the following configuration may be used to do this for all gnuplot
16427 code blocks.  Also see @ref{epilogue}.
16429 @lisp
16430 (add-to-list 'org-babel-default-header-args:gnuplot
16431              '((:prologue . "reset")))
16432 @end lisp
16434 @node epilogue
16435 @subsubsection @code{:epilogue}
16436 @cindex @code{:epilogue}, src header argument
16437 The value of the @code{epilogue} header argument will be appended to the code
16438 block body before execution.  Also see @ref{prologue}.
16440 @node Results of evaluation
16441 @section Results of evaluation
16442 @cindex code block, results of evaluation
16443 @cindex source code, results of evaluation
16445 The way in which results are handled depends on whether a session is invoked,
16446 as well as on whether @code{:results value} or @code{:results output} is
16447 used.  The following table shows the table possibilities.  For a full listing
16448 of the possible results header arguments see @ref{Results}.
16450 @multitable @columnfractions 0.26 0.33 0.41
16451 @item @tab @b{Non-session} @tab @b{Session}
16452 @item @code{:results value} @tab value of last expression @tab value of last expression
16453 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
16454 @end multitable
16456 Note: With @code{:results value}, the result in both @code{:session} and
16457 non-session is returned to Org mode as a table (a one- or two-dimensional
16458 vector of strings or numbers) when appropriate.
16460 @subsection Non-session
16461 @subsubsection @code{:results value}
16462 @cindex @code{:results}, src header argument
16463 This is the default.  Internally, the value is obtained by wrapping the code
16464 in a function definition in the external language, and evaluating that
16465 function.  Therefore, code should be written as if it were the body of such a
16466 function.  In particular, note that Python does not automatically return a
16467 value from a function unless a @code{return} statement is present, and so a
16468 @samp{return} statement will usually be required in Python.
16470 This is the only one of the four evaluation contexts in which the code is
16471 automatically wrapped in a function definition.
16473 @subsubsection @code{:results output}
16474 @cindex @code{:results}, src header argument
16475 The code is passed to the interpreter as an external process, and the
16476 contents of the standard output stream are returned as text.  (In certain
16477 languages this also contains the error output stream; this is an area for
16478 future work.)
16480 @subsection Session
16481 @subsubsection @code{:results value}
16482 @cindex @code{:results}, src header argument
16483 The code is passed to an interpreter running as an interactive Emacs inferior
16484 process.  Only languages which provide tools for interactive evaluation of
16485 code have session support, so some language (e.g., C and ditaa) do not
16486 support the @code{:session} header argument, and in other languages (e.g.,
16487 Python and Haskell) which have limitations on the code which may be entered
16488 into interactive sessions, those limitations apply to the code in code blocks
16489 using the @code{:session} header argument as well.
16491 Unless the @code{:results output} option is supplied (see below) the result
16492 returned is the result of the last evaluation performed by the
16493 interpreter.  (This is obtained in a language-specific manner: the value of
16494 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
16495 in R).
16497 @subsubsection @code{:results output}
16498 @cindex @code{:results}, src header argument
16499 The code is passed to the interpreter running as an interactive Emacs
16500 inferior process.  The result returned is the concatenation of the sequence of
16501 (text) output from the interactive interpreter.  Notice that this is not
16502 necessarily the same as what would be sent to @code{STDOUT} if the same code
16503 were passed to a non-interactive interpreter running as an external
16504 process.  For example, compare the following two blocks:
16506 @example
16507 #+BEGIN_SRC python :results output
16508  print "hello"
16510  print "bye"
16511 #+END_SRC
16513 #+RESULTS:
16514 : hello
16515 : bye
16516 @end example
16518 In non-session mode, the `2' is not printed and does not appear.
16520 @example
16521 #+BEGIN_SRC python :results output :session
16522  print "hello"
16524  print "bye"
16525 #+END_SRC
16527 #+RESULTS:
16528 : hello
16529 : 2
16530 : bye
16531 @end example
16533 But in @code{:session} mode, the interactive interpreter receives input `2'
16534 and prints out its value, `2'.  (Indeed, the other print statements are
16535 unnecessary here).
16537 @node Noweb reference syntax
16538 @section Noweb reference syntax
16539 @cindex code block, noweb reference
16540 @cindex syntax, noweb
16541 @cindex source code, noweb reference
16543 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
16544 Programming system allows named blocks of code to be referenced by using the
16545 familiar Noweb syntax:
16547 @example
16548 <<code-block-name>>
16549 @end example
16551 When a code block is tangled or evaluated, whether or not ``noweb''
16552 references are expanded depends upon the value of the @code{:noweb} header
16553 argument.  If @code{:noweb yes}, then a Noweb reference is expanded before
16554 evaluation.  If @code{:noweb no}, the default, then the reference is not
16555 expanded before evaluation.  See the @ref{noweb-ref} header argument for
16556 a more flexible way to resolve noweb references.
16558 It is possible to include the @emph{results} of a code block rather than the
16559 body.  This is done by appending parenthesis to the code block name which may
16560 optionally contain arguments to the code block as shown below.
16562 @example
16563 <<code-block-name(optional arguments)>>
16564 @end example
16566 Note: the default value, @code{:noweb no}, was chosen to ensure that
16567 correct code is not broken in a language, such as Ruby, where
16568 @code{<<arg>>} is a syntactically valid construct.  If @code{<<arg>>} is not
16569 syntactically valid in languages that you use, then please consider setting
16570 the default value.
16572 Note: if noweb tangling is slow in large Org mode files consider setting the
16573 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
16574 This will result in faster noweb reference resolution at the expense of not
16575 correctly resolving inherited values of the @code{:noweb-ref} header
16576 argument.
16578 @node Key bindings and useful functions
16579 @section Key bindings and useful functions
16580 @cindex code block, key bindings
16582 Many common Org mode key sequences are re-bound depending on
16583 the context.
16585 Within a code block, the following key bindings
16586 are active:
16588 @multitable @columnfractions 0.25 0.75
16589 @kindex C-c C-c
16590 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
16591 @kindex C-c C-o
16592 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
16593 @kindex M-up
16594 @item @kbd{M-@key{up}}    @tab @code{org-babel-load-in-session}
16595 @kindex M-down
16596 @item @kbd{M-@key{down}}  @tab @code{org-babel-switch-to-session}
16597 @end multitable
16599 In an Org mode buffer, the following key bindings are active:
16601 @multitable @columnfractions 0.45 0.55
16602 @kindex C-c C-v p
16603 @kindex C-c C-v C-p
16604 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
16605 @kindex C-c C-v n
16606 @kindex C-c C-v C-n
16607 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
16608 @kindex C-c C-v e
16609 @kindex C-c C-v C-e
16610 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
16611 @kindex C-c C-v o
16612 @kindex C-c C-v C-o
16613 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
16614 @kindex C-c C-v v
16615 @kindex C-c C-v C-v
16616 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
16617 @kindex C-c C-v u
16618 @kindex C-c C-v C-u
16619 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
16620 @kindex C-c C-v g
16621 @kindex C-c C-v C-g
16622 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
16623 @kindex C-c C-v r
16624 @kindex C-c C-v C-r
16625 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
16626 @kindex C-c C-v b
16627 @kindex C-c C-v C-b
16628 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16629 @kindex C-c C-v s
16630 @kindex C-c C-v C-s
16631 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16632 @kindex C-c C-v d
16633 @kindex C-c C-v C-d
16634 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
16635 @kindex C-c C-v t
16636 @kindex C-c C-v C-t
16637 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16638 @kindex C-c C-v f
16639 @kindex C-c C-v C-f
16640 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16641 @kindex C-c C-v c
16642 @kindex C-c C-v C-c
16643 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
16644 @kindex C-c C-v j
16645 @kindex C-c C-v C-j
16646 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
16647 @kindex C-c C-v l
16648 @kindex C-c C-v C-l
16649 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
16650 @kindex C-c C-v i
16651 @kindex C-c C-v C-i
16652 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
16653 @kindex C-c C-v I
16654 @kindex C-c C-v C-I
16655 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
16656 @kindex C-c C-v z
16657 @kindex C-c C-v C-z
16658 @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}
16659 @kindex C-c C-v a
16660 @kindex C-c C-v C-a
16661 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16662 @kindex C-c C-v h
16663 @kindex C-c C-v C-h
16664 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
16665 @kindex C-c C-v x
16666 @kindex C-c C-v C-x
16667 @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}
16668 @end multitable
16670 @c When possible these keybindings were extended to work when the control key is
16671 @c kept pressed, resulting in the following additional keybindings.
16673 @c @multitable @columnfractions 0.25 0.75
16674 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16675 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16676 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16677 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
16678 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
16679 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16680 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16681 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
16682 @c @end multitable
16684 @node Batch execution
16685 @section Batch execution
16686 @cindex code block, batch execution
16687 @cindex source code, batch execution
16689 It is possible to call functions from the command line.  This shell
16690 script calls @code{org-babel-tangle} on every one of its arguments.
16692 Be sure to adjust the paths to fit your system.
16694 @example
16695 #!/bin/sh
16696 # -*- mode: shell-script -*-
16698 # tangle files with org-mode
16700 DIR=`pwd`
16701 FILES=""
16703 # wrap each argument in the code required to call tangle on it
16704 for i in $@@; do
16705     FILES="$FILES \"$i\""
16706 done
16708 emacs -Q --batch \
16709 --eval "(progn
16710 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
16711 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
16712 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
16713 (mapc (lambda (file)
16714        (find-file (expand-file-name file \"$DIR\"))
16715        (org-babel-tangle)
16716        (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
16717 @end example
16719 @node Miscellaneous
16720 @chapter Miscellaneous
16722 @menu
16723 * Completion::                  M-TAB knows what you need
16724 * Easy templates::              Quick insertion of structural elements
16725 * Speed keys::                  Electric commands at the beginning of a headline
16726 * Code evaluation security::    Org mode files evaluate inline code
16727 * Customization::               Adapting Org to your taste
16728 * In-buffer settings::          Overview of the #+KEYWORDS
16729 * The very busy C-c C-c key::   When in doubt, press C-c C-c
16730 * Clean view::                  Getting rid of leading stars in the outline
16731 * TTY keys::                    Using Org on a tty
16732 * Interaction::                 Other Emacs packages
16733 * org-crypt::                   Encrypting Org files
16734 @end menu
16737 @node Completion
16738 @section Completion
16739 @cindex completion, of @TeX{} symbols
16740 @cindex completion, of TODO keywords
16741 @cindex completion, of dictionary words
16742 @cindex completion, of option keywords
16743 @cindex completion, of tags
16744 @cindex completion, of property keys
16745 @cindex completion, of link abbreviations
16746 @cindex @TeX{} symbol completion
16747 @cindex TODO keywords completion
16748 @cindex dictionary word completion
16749 @cindex option keyword completion
16750 @cindex tag completion
16751 @cindex link abbreviations, completion of
16753 Emacs would not be Emacs without completion, and Org mode uses it whenever it
16754 makes sense.  If you prefer an @i{iswitchb}- or @i{ido}-like interface for
16755 some of the completion prompts, you can specify your preference by setting at
16756 most one of the variables @code{org-completion-use-iswitchb}
16757 @code{org-completion-use-ido}.
16759 Org supports in-buffer completion.  This type of completion does
16760 not make use of the minibuffer.  You simply type a few letters into
16761 the buffer and use the key to complete text right there.
16763 @table @kbd
16764 @kindex M-@key{TAB}
16765 @item M-@key{TAB}
16766 Complete word at point
16767 @itemize @bullet
16768 @item
16769 At the beginning of a headline, complete TODO keywords.
16770 @item
16771 After @samp{\}, complete @TeX{} symbols supported by the exporter.
16772 @item
16773 After @samp{*}, complete headlines in the current buffer so that they
16774 can be used in search links like @samp{[[*find this headline]]}.
16775 @item
16776 After @samp{:} in a headline, complete tags.  The list of tags is taken
16777 from the variable @code{org-tag-alist} (possibly set through the
16778 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
16779 dynamically from all tags used in the current buffer.
16780 @item
16781 After @samp{:} and not in a headline, complete property keys.  The list
16782 of keys is constructed dynamically from all keys used in the current
16783 buffer.
16784 @item
16785 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
16786 @item
16787 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
16788 @samp{OPTIONS} which set file-specific options for Org mode.  When the
16789 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
16790 will insert example settings for this keyword.
16791 @item
16792 In the line after @samp{#+STARTUP: }, complete startup keywords,
16793 i.e., valid keys for this line.
16794 @item
16795 Elsewhere, complete dictionary words using Ispell.
16796 @end itemize
16797 @end table
16799 @node Easy templates
16800 @section Easy templates
16801 @cindex template insertion
16802 @cindex insertion, of templates
16804 Org mode supports insertion of empty structural elements (like
16805 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
16806 strokes.  This is achieved through a native template expansion mechanism.
16807 Note that Emacs has several other template mechanisms which could be used in
16808 a similar way, for example @file{yasnippet}.
16810 To insert a structural element, type a @samp{<}, followed by a template
16811 selector and @kbd{@key{TAB}}.  Completion takes effect only when the above
16812 keystrokes are typed on a line by itself.
16814 The following template selectors are currently supported.
16816 @multitable @columnfractions 0.1 0.9
16817 @item @kbd{s} @tab @code{#+BEGIN_SRC     ... #+END_SRC}
16818 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
16819 @item @kbd{q} @tab @code{#+BEGIN_QUOTE   ... #+END_QUOTE}
16820 @item @kbd{v} @tab @code{#+BEGIN_VERSE   ... #+END_VERSE}
16821 @item @kbd{c} @tab @code{#+BEGIN_CENTER  ... #+END_CENTER}
16822 @item @kbd{l} @tab @code{#+BEGIN_LaTeX   ... #+END_LaTeX}
16823 @item @kbd{L} @tab @code{#+LaTeX:}
16824 @item @kbd{h} @tab @code{#+BEGIN_HTML    ... #+END_HTML}
16825 @item @kbd{H} @tab @code{#+HTML:}
16826 @item @kbd{a} @tab @code{#+BEGIN_ASCII   ... #+END_ASCII}
16827 @item @kbd{A} @tab @code{#+ASCII:}
16828 @item @kbd{i} @tab @code{#+INDEX:} line
16829 @item @kbd{I} @tab @code{#+INCLUDE:} line
16830 @end multitable
16832 For example, on an empty line, typing "<e" and then pressing TAB, will expand
16833 into a complete EXAMPLE template.
16835 You can install additional templates by customizing the variable
16836 @code{org-structure-template-alist}.  See the docstring of the variable for
16837 additional details.
16839 @node Speed keys
16840 @section Speed keys
16841 @cindex speed keys
16842 @vindex org-use-speed-commands
16843 @vindex org-speed-commands-user
16845 Single keys can be made to execute commands when the cursor is at the
16846 beginning of a headline, i.e., before the first star.  Configure the variable
16847 @code{org-use-speed-commands} to activate this feature.  There is a
16848 pre-defined list of commands, and you can add more such commands using the
16849 variable @code{org-speed-commands-user}.  Speed keys not only speed up
16850 navigation and other commands, but they also provide an alternative way to
16851 execute commands bound to keys that are not or not easily available on a TTY,
16852 or on a small mobile device with a limited keyboard.
16854 To see which commands are available, activate the feature and press @kbd{?}
16855 with the cursor at the beginning of a headline.
16857 @node Code evaluation security
16858 @section Code evaluation and security issues
16860 Org provides tools to work with code snippets, including evaluating them.
16862 Running code on your machine always comes with a security risk.  Badly
16863 written or malicious code can be executed on purpose or by accident.  Org has
16864 default settings which will only evaluate such code if you give explicit
16865 permission to do so, and as a casual user of these features you should leave
16866 these precautions intact.
16868 For people who regularly work with such code, the confirmation prompts can
16869 become annoying, and you might want to turn them off.  This can be done, but
16870 you must be aware of the risks that are involved.
16872 Code evaluation can happen under the following circumstances:
16874 @table @i
16875 @item Source code blocks
16876 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
16877 C-c} in the block.  The most important thing to realize here is that Org mode
16878 files which contain code snippets are, in a certain sense, like executable
16879 files.  So you should accept them and load them into Emacs only from trusted
16880 sources---just like you would do with a program you install on your computer.
16882 Make sure you know what you are doing before customizing the variables
16883 which take off the default security brakes.
16885 @defopt org-confirm-babel-evaluate
16886 When t (the default), the user is asked before every code block evaluation.
16887 When @code{nil}, the user is not asked.  When set to a function, it is called with
16888 two arguments (language and body of the code block) and should return t to
16889 ask and @code{nil} not to ask.
16890 @end defopt
16892 For example, here is how to execute "ditaa" code (which is considered safe)
16893 without asking:
16895 @lisp
16896 (defun my-org-confirm-babel-evaluate (lang body)
16897   (not (string= lang "ditaa")))  ; don't ask for ditaa
16898 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
16899 @end lisp
16901 @item Following @code{shell} and @code{elisp} links
16902 Org has two link types that can directly evaluate code (@pxref{External
16903 links}).  These links can be problematic because the code to be evaluated is
16904 not visible.
16906 @defopt org-confirm-shell-link-function
16907 Function to queries user about shell link execution.
16908 @end defopt
16909 @defopt org-confirm-elisp-link-function
16910 Functions to query user for Emacs Lisp link execution.
16911 @end defopt
16913 @item Formulas in tables
16914 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
16915 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
16916 @end table
16918 @node Customization
16919 @section Customization
16920 @cindex customization
16921 @cindex options, for customization
16922 @cindex variables, for customization
16924 There are more than 500 variables that can be used to customize
16925 Org.  For the sake of compactness of the manual, I am not
16926 describing the variables here.  A structured overview of customization
16927 variables is available with @kbd{M-x org-customize RET}.  Or select
16928 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
16929 settings can also be activated on a per-file basis, by putting special
16930 lines into the buffer (@pxref{In-buffer settings}).
16932 @node In-buffer settings
16933 @section Summary of in-buffer settings
16934 @cindex in-buffer settings
16935 @cindex special keywords
16937 Org mode uses special lines in the buffer to define settings on a
16938 per-file basis.  These lines start with a @samp{#+} followed by a
16939 keyword, a colon, and then individual words defining a setting.  Several
16940 setting words can be in the same line, but you can also have multiple
16941 lines for the keyword.  While these settings are described throughout
16942 the manual, here is a summary.  After changing any of these lines in the
16943 buffer, press @kbd{C-c C-c} with the cursor still in the line to
16944 activate the changes immediately.  Otherwise they become effective only
16945 when the file is visited again in a new Emacs session.
16947 @vindex org-archive-location
16948 @table @kbd
16949 @item #+ARCHIVE: %s_done::
16950 This line sets the archive location for the agenda file.  It applies for
16951 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
16952 of the file.  The first such line also applies to any entries before it.
16953 The corresponding variable is @code{org-archive-location}.
16954 @item #+CATEGORY:
16955 This line sets the category for the agenda file.  The category applies to the
16956 whole document.
16957 @item #+COLUMNS: %25ITEM ...
16958 @cindex property, COLUMNS
16959 Set the default format for columns view.  This format applies when
16960 columns view is invoked in locations where no @code{COLUMNS} property
16961 applies.
16962 @item #+CONSTANTS: name1=value1 ...
16963 @vindex org-table-formula-constants
16964 @vindex org-table-formula
16965 Set file-local values for constants to be used in table formulas.  This
16966 line sets the local variable @code{org-table-formula-constants-local}.
16967 The global version of this variable is
16968 @code{org-table-formula-constants}.
16969 @item #+FILETAGS: :tag1:tag2:tag3:
16970 Set tags that can be inherited by any entry in the file, including the
16971 top-level entries.
16972 @item #+LINK: linkword replace
16973 @vindex org-link-abbrev-alist
16974 These lines (several are allowed) specify link abbreviations.
16975 @xref{Link abbreviations}.  The corresponding variable is
16976 @code{org-link-abbrev-alist}.
16977 @item #+PRIORITIES: highest lowest default
16978 @vindex org-highest-priority
16979 @vindex org-lowest-priority
16980 @vindex org-default-priority
16981 This line sets the limits and the default for the priorities.  All three
16982 must be either letters A--Z or numbers 0--9.  The highest priority must
16983 have a lower ASCII number than the lowest priority.
16984 @item #+PROPERTY: Property_Name Value
16985 This line sets a default inheritance value for entries in the current
16986 buffer, most useful for specifying the allowed values of a property.
16987 @cindex #+SETUPFILE
16988 @item #+SETUPFILE: file
16989 This line defines a file that holds more in-buffer setup.  Normally this is
16990 entirely ignored.  Only when the buffer is parsed for option-setting lines
16991 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
16992 settings line, or when exporting), then the contents of this file are parsed
16993 as if they had been included in the buffer.  In particular, the file can be
16994 any other Org mode file with internal setup.  You can visit the file the
16995 cursor is in the line with @kbd{C-c '}.
16996 @item #+STARTUP:
16997 @cindex #+STARTUP
16998 This line sets options to be used at startup of Org mode, when an
16999 Org file is being visited.
17001 The first set of options deals with the initial visibility of the outline
17002 tree.  The corresponding variable for global default settings is
17003 @code{org-startup-folded}, with a default value @code{t}, which means
17004 @code{overview}.
17005 @vindex org-startup-folded
17006 @cindex @code{overview}, STARTUP keyword
17007 @cindex @code{content}, STARTUP keyword
17008 @cindex @code{showall}, STARTUP keyword
17009 @cindex @code{showeverything}, STARTUP keyword
17010 @example
17011 overview         @r{top-level headlines only}
17012 content          @r{all headlines}
17013 showall          @r{no folding of any entries}
17014 showeverything   @r{show even drawer contents}
17015 @end example
17017 @vindex org-startup-indented
17018 @cindex @code{indent}, STARTUP keyword
17019 @cindex @code{noindent}, STARTUP keyword
17020 Dynamic virtual indentation is controlled by the variable
17021 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
17022 @example
17023 indent     @r{start with @code{org-indent-mode} turned on}
17024 noindent   @r{start with @code{org-indent-mode} turned off}
17025 @end example
17027 @vindex org-startup-align-all-tables
17028 Then there are options for aligning tables upon visiting a file.  This
17029 is useful in files containing narrowed table columns.  The corresponding
17030 variable is @code{org-startup-align-all-tables}, with a default value
17031 @code{nil}.
17032 @cindex @code{align}, STARTUP keyword
17033 @cindex @code{noalign}, STARTUP keyword
17034 @example
17035 align      @r{align all tables}
17036 noalign    @r{don't align tables on startup}
17037 @end example
17039 @vindex org-startup-with-inline-images
17040 When visiting a file, inline images can be automatically displayed.  The
17041 corresponding variable is @code{org-startup-with-inline-images}, with a
17042 default value @code{nil} to avoid delays when visiting a file.
17043 @cindex @code{inlineimages}, STARTUP keyword
17044 @cindex @code{noinlineimages}, STARTUP keyword
17045 @example
17046 inlineimages   @r{show inline images}
17047 noinlineimages @r{don't show inline images on startup}
17048 @end example
17050 @vindex org-startup-with-latex-preview
17051 When visiting a file, @LaTeX{} fragments can be converted to images
17052 automatically.  The variable @code{org-startup-with-latex-preview} which
17053 controls this behavior, is set to @code{nil} by default to avoid delays on
17054 startup.
17055 @cindex @code{latexpreview}, STARTUP keyword
17056 @cindex @code{nolatexpreview}, STARTUP keyword
17057 @example
17058 latexpreview   @r{preview @LaTeX{} fragments}
17059 nolatexpreview @r{don't preview @LaTeX{} fragments}
17060 @end example
17062 @vindex org-log-done
17063 @vindex org-log-note-clock-out
17064 @vindex org-log-repeat
17065 Logging the closing and reopening of TODO items and clock intervals can be
17066 configured using these options (see variables @code{org-log-done},
17067 @code{org-log-note-clock-out} and @code{org-log-repeat})
17068 @cindex @code{logdone}, STARTUP keyword
17069 @cindex @code{lognotedone}, STARTUP keyword
17070 @cindex @code{nologdone}, STARTUP keyword
17071 @cindex @code{lognoteclock-out}, STARTUP keyword
17072 @cindex @code{nolognoteclock-out}, STARTUP keyword
17073 @cindex @code{logrepeat}, STARTUP keyword
17074 @cindex @code{lognoterepeat}, STARTUP keyword
17075 @cindex @code{nologrepeat}, STARTUP keyword
17076 @cindex @code{logreschedule}, STARTUP keyword
17077 @cindex @code{lognotereschedule}, STARTUP keyword
17078 @cindex @code{nologreschedule}, STARTUP keyword
17079 @cindex @code{logredeadline}, STARTUP keyword
17080 @cindex @code{lognoteredeadline}, STARTUP keyword
17081 @cindex @code{nologredeadline}, STARTUP keyword
17082 @cindex @code{logrefile}, STARTUP keyword
17083 @cindex @code{lognoterefile}, STARTUP keyword
17084 @cindex @code{nologrefile}, STARTUP keyword
17085 @cindex @code{logdrawer}, STARTUP keyword
17086 @cindex @code{nologdrawer}, STARTUP keyword
17087 @cindex @code{logstatesreversed}, STARTUP keyword
17088 @cindex @code{nologstatesreversed}, STARTUP keyword
17089 @example
17090 logdone             @r{record a timestamp when an item is marked DONE}
17091 lognotedone         @r{record timestamp and a note when DONE}
17092 nologdone           @r{don't record when items are marked DONE}
17093 logrepeat           @r{record a time when reinstating a repeating item}
17094 lognoterepeat       @r{record a note when reinstating a repeating item}
17095 nologrepeat         @r{do not record when reinstating repeating item}
17096 lognoteclock-out    @r{record a note when clocking out}
17097 nolognoteclock-out  @r{don't record a note when clocking out}
17098 logreschedule       @r{record a timestamp when scheduling time changes}
17099 lognotereschedule   @r{record a note when scheduling time changes}
17100 nologreschedule     @r{do not record when a scheduling date changes}
17101 logredeadline       @r{record a timestamp when deadline changes}
17102 lognoteredeadline   @r{record a note when deadline changes}
17103 nologredeadline     @r{do not record when a deadline date changes}
17104 logrefile           @r{record a timestamp when refiling}
17105 lognoterefile       @r{record a note when refiling}
17106 nologrefile         @r{do not record when refiling}
17107 logdrawer           @r{store log into drawer}
17108 nologdrawer         @r{store log outside of drawer}
17109 logstatesreversed   @r{reverse the order of states notes}
17110 nologstatesreversed @r{do not reverse the order of states notes}
17111 @end example
17113 @vindex org-hide-leading-stars
17114 @vindex org-odd-levels-only
17115 Here are the options for hiding leading stars in outline headings, and for
17116 indenting outlines.  The corresponding variables are
17117 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
17118 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
17119 @cindex @code{hidestars}, STARTUP keyword
17120 @cindex @code{showstars}, STARTUP keyword
17121 @cindex @code{odd}, STARTUP keyword
17122 @cindex @code{even}, STARTUP keyword
17123 @example
17124 hidestars  @r{make all but one of the stars starting a headline invisible.}
17125 showstars  @r{show all stars starting a headline}
17126 indent     @r{virtual indentation according to outline level}
17127 noindent   @r{no virtual indentation according to outline level}
17128 odd        @r{allow only odd outline levels (1,3,...)}
17129 oddeven    @r{allow all outline levels}
17130 @end example
17132 @vindex org-put-time-stamp-overlays
17133 @vindex org-time-stamp-overlay-formats
17134 To turn on custom format overlays over timestamps (variables
17135 @code{org-put-time-stamp-overlays} and
17136 @code{org-time-stamp-overlay-formats}), use
17137 @cindex @code{customtime}, STARTUP keyword
17138 @example
17139 customtime @r{overlay custom time format}
17140 @end example
17142 @vindex constants-unit-system
17143 The following options influence the table spreadsheet (variable
17144 @code{constants-unit-system}).
17145 @cindex @code{constcgs}, STARTUP keyword
17146 @cindex @code{constSI}, STARTUP keyword
17147 @example
17148 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
17149 constSI    @r{@file{constants.el} should use the SI unit system}
17150 @end example
17152 @vindex org-footnote-define-inline
17153 @vindex org-footnote-auto-label
17154 @vindex org-footnote-auto-adjust
17155 To influence footnote settings, use the following keywords.  The
17156 corresponding variables are @code{org-footnote-define-inline},
17157 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
17158 @cindex @code{fninline}, STARTUP keyword
17159 @cindex @code{nofninline}, STARTUP keyword
17160 @cindex @code{fnlocal}, STARTUP keyword
17161 @cindex @code{fnprompt}, STARTUP keyword
17162 @cindex @code{fnauto}, STARTUP keyword
17163 @cindex @code{fnconfirm}, STARTUP keyword
17164 @cindex @code{fnplain}, STARTUP keyword
17165 @cindex @code{fnadjust}, STARTUP keyword
17166 @cindex @code{nofnadjust}, STARTUP keyword
17167 @example
17168 fninline    @r{define footnotes inline}
17169 fnnoinline  @r{define footnotes in separate section}
17170 fnlocal     @r{define footnotes near first reference, but not inline}
17171 fnprompt    @r{prompt for footnote labels}
17172 fnauto      @r{create @code{[fn:1]}-like labels automatically (default)}
17173 fnconfirm   @r{offer automatic label for editing or confirmation}
17174 fnplain     @r{create @code{[1]}-like labels automatically}
17175 fnadjust    @r{automatically renumber and sort footnotes}
17176 nofnadjust  @r{do not renumber and sort automatically}
17177 @end example
17179 @cindex org-hide-block-startup
17180 To hide blocks on startup, use these keywords.  The corresponding variable is
17181 @code{org-hide-block-startup}.
17182 @cindex @code{hideblocks}, STARTUP keyword
17183 @cindex @code{nohideblocks}, STARTUP keyword
17184 @example
17185 hideblocks   @r{Hide all begin/end blocks on startup}
17186 nohideblocks @r{Do not hide blocks on startup}
17187 @end example
17189 @cindex org-pretty-entities
17190 The display of entities as UTF-8 characters is governed by the variable
17191 @code{org-pretty-entities} and the keywords
17192 @cindex @code{entitiespretty}, STARTUP keyword
17193 @cindex @code{entitiesplain}, STARTUP keyword
17194 @example
17195 entitiespretty  @r{Show entities as UTF-8 characters where possible}
17196 entitiesplain   @r{Leave entities plain}
17197 @end example
17199 @item #+TAGS:  TAG1(c1) TAG2(c2)
17200 @vindex org-tag-alist
17201 These lines (several such lines are allowed) specify the valid tags in
17202 this file, and (potentially) the corresponding @emph{fast tag selection}
17203 keys.  The corresponding variable is @code{org-tag-alist}.
17204 @cindex #+TBLFM
17205 @item #+TBLFM:
17206 This line contains the formulas for the table directly above the line.
17208 Table can have multiple lines containing @samp{#+TBLFM:}.  Note
17209 that only the first line of @samp{#+TBLFM:} will be applied when
17210 you recalculate the table.  For more details see @ref{Using
17211 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
17213 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
17214 @itemx #+OPTIONS:, #+BIND:,
17215 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
17216 These lines provide settings for exporting files.  For more details see
17217 @ref{Export settings}.
17218 @item #+TODO:    #+SEQ_TODO:   #+TYP_TODO:
17219 @vindex org-todo-keywords
17220 These lines set the TODO keywords and their interpretation in the
17221 current file.  The corresponding variable is @code{org-todo-keywords}.
17222 @end table
17224 @node The very busy C-c C-c key
17225 @section The very busy C-c C-c key
17226 @kindex C-c C-c
17227 @cindex C-c C-c, overview
17229 The key @kbd{C-c C-c} has many purposes in Org, which are all
17230 mentioned scattered throughout this manual.  One specific function of
17231 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
17232 other circumstances it means something like @emph{``Hey Org, look
17233 here and update according to what you see here''}.  Here is a summary of
17234 what this means in different contexts.
17236 @itemize @minus
17237 @item
17238 If there are highlights in the buffer from the creation of a sparse
17239 tree, or from clock display, remove these highlights.
17240 @item
17241 If the cursor is in one of the special @code{#+KEYWORD} lines, this
17242 triggers scanning the buffer for these lines and updating the
17243 information.
17244 @item
17245 If the cursor is inside a table, realign the table.  This command
17246 works even if the automatic table editor has been turned off.
17247 @item
17248 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
17249 the entire table.
17250 @item
17251 If the current buffer is a capture buffer, close the note and file it.
17252 With a prefix argument, file it, without further interaction, to the
17253 default location.
17254 @item
17255 If the cursor is on a @code{<<<target>>>}, update radio targets and
17256 corresponding links in this buffer.
17257 @item
17258 If the cursor is in a property line or at the start or end of a property
17259 drawer, offer property commands.
17260 @item
17261 If the cursor is at a footnote reference, go to the corresponding
17262 definition, and @emph{vice versa}.
17263 @item
17264 If the cursor is on a statistics cookie, update it.
17265 @item
17266 If the cursor is in a plain list item with a checkbox, toggle the status
17267 of the checkbox.
17268 @item
17269 If the cursor is on a numbered item in a plain list, renumber the
17270 ordered list.
17271 @item
17272 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
17273 block is updated.
17274 @item
17275 If the cursor is at a timestamp, fix the day name in the timestamp.
17276 @end itemize
17278 @node Clean view
17279 @section A cleaner outline view
17280 @cindex hiding leading stars
17281 @cindex dynamic indentation
17282 @cindex odd-levels-only outlines
17283 @cindex clean outline view
17285 Some people find it noisy and distracting that the Org headlines start with a
17286 potentially large number of stars, and that text below the headlines is not
17287 indented.  While this is no problem when writing a @emph{book-like} document
17288 where the outline headings are really section headings, in a more
17289 @emph{list-oriented} outline, indented structure is a lot cleaner:
17291 @example
17292 @group
17293 * Top level headline             |    * Top level headline
17294 ** Second level                  |      * Second level
17295 *** 3rd level                    |        * 3rd level
17296 some text                        |          some text
17297 *** 3rd level                    |        * 3rd level
17298 more text                        |          more text
17299 * Another top level headline     |    * Another top level headline
17300 @end group
17301 @end example
17303 @noindent
17305 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
17306 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
17307 be achieved dynamically at display time using @code{org-indent-mode}.  In
17308 this minor mode, all lines are prefixed for display with the necessary amount
17309 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
17310 property, such that @code{visual-line-mode} (or purely setting
17311 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
17312 }.  Also headlines are prefixed with additional stars, so that the amount of
17313 indentation shifts by two@footnote{See the variable
17314 @code{org-indent-indentation-per-level}.}  spaces per level.  All headline
17315 stars but the last one are made invisible using the @code{org-hide}
17316 face@footnote{Turning on @code{org-indent-mode} sets
17317 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
17318 @code{nil}.}; see below under @samp{2.} for more information on how this
17319 works.  You can turn on @code{org-indent-mode} for all files by customizing
17320 the variable @code{org-startup-indented}, or you can turn it on for
17321 individual files using
17323 @example
17324 #+STARTUP: indent
17325 @end example
17327 If you want a similar effect in an earlier version of Emacs and/or Org, or if
17328 you want the indentation to be hard space characters so that the plain text
17329 file looks as similar as possible to the Emacs display, Org supports you in
17330 the following way:
17332 @enumerate
17333 @item
17334 @emph{Indentation of text below headlines}@*
17335 You may indent text below each headline to make the left boundary line up
17336 with the headline, like
17338 @example
17339 *** 3rd level
17340     more text, now indented
17341 @end example
17343 @vindex org-adapt-indentation
17344 Org supports this with paragraph filling, line wrapping, and structure
17345 editing@footnote{See also the variable @code{org-adapt-indentation}.},
17346 preserving or adapting the indentation as appropriate.
17348 @item
17349 @vindex org-hide-leading-stars
17350 @emph{Hiding leading stars}@* You can modify the display in such a way that
17351 all leading stars become invisible.  To do this in a global way, configure
17352 the variable @code{org-hide-leading-stars} or change this on a per-file basis
17353 with
17355 @example
17356 #+STARTUP: hidestars
17357 #+STARTUP: showstars
17358 @end example
17360 With hidden stars, the tree becomes:
17362 @example
17363 @group
17364 * Top level headline
17365  * Second level
17366   * 3rd level
17367   ...
17368 @end group
17369 @end example
17371 @noindent
17372 @vindex org-hide @r{(face)}
17373 The leading stars are not truly replaced by whitespace, they are only
17374 fontified with the face @code{org-hide} that uses the background color as
17375 font color.  If you are not using either white or black background, you may
17376 have to customize this face to get the wanted effect.  Another possibility is
17377 to set this font such that the extra stars are @i{almost} invisible, for
17378 example using the color @code{grey90} on a white background.
17380 @item
17381 @vindex org-odd-levels-only
17382 Things become cleaner still if you skip all the even levels and use only odd
17383 levels 1, 3, 5..., effectively adding two stars to go from one outline level
17384 to the next@footnote{When you need to specify a level for a property search
17385 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}.  In this
17386 way we get the outline view shown at the beginning of this section.  In order
17387 to make the structure editing and export commands handle this convention
17388 correctly, configure the variable @code{org-odd-levels-only}, or set this on
17389 a per-file basis with one of the following lines:
17391 @example
17392 #+STARTUP: odd
17393 #+STARTUP: oddeven
17394 @end example
17396 You can convert an Org file from single-star-per-level to the
17397 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
17398 RET} in that file.  The reverse operation is @kbd{M-x
17399 org-convert-to-oddeven-levels}.
17400 @end enumerate
17402 @node TTY keys
17403 @section Using Org on a tty
17404 @cindex tty key bindings
17406 Because Org contains a large number of commands, by default many of
17407 Org's core commands are bound to keys that are generally not
17408 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
17409 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
17410 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
17411 these commands on a tty when special keys are unavailable, the following
17412 alternative bindings can be used.  The tty bindings below will likely be
17413 more cumbersome; you may find for some of the bindings below that a
17414 customized workaround suits you better.  For example, changing a timestamp
17415 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
17416 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
17418 @multitable @columnfractions 0.15 0.2 0.1 0.2
17419 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
17420 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab @kbd{C} @tab
17421 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
17422 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab @kbd{L} @tab
17423 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x r}           @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
17424 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab @kbd{R} @tab
17425 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
17426 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab @kbd{U} @tab
17427 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
17428 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab @kbd{D} @tab
17429 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab @kbd{ } @tab
17430 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
17431 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab @kbd{ } @tab
17432 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab @kbd{ } @tab
17433 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab @kbd{ } @tab
17434 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab @kbd{ } @tab
17435 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab @kbd{ } @tab
17436 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab @kbd{ } @tab
17437 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
17438 @end multitable
17441 @node Interaction
17442 @section Interaction with other packages
17443 @cindex packages, interaction with other
17444 Org lives in the world of GNU Emacs and interacts in various ways
17445 with other code out there.
17447 @menu
17448 * Cooperation::                 Packages Org cooperates with
17449 * Conflicts::                   Packages that lead to conflicts
17450 @end menu
17452 @node Cooperation
17453 @subsection Packages that Org cooperates with
17455 @table @asis
17456 @cindex @file{calc.el}
17457 @cindex Gillespie, Dave
17458 @item @file{calc.el} by Dave Gillespie
17459 Org uses the Calc package for implementing spreadsheet
17460 functionality in its tables (@pxref{The spreadsheet}).  Org
17461 checks for the availability of Calc by looking for the function
17462 @code{calc-eval} which will have been autoloaded during setup if Calc has
17463 been installed properly.  As of Emacs 22, Calc is part of the Emacs
17464 distribution.  Another possibility for interaction between the two
17465 packages is using Calc for embedded calculations.  @xref{Embedded Mode,
17466 , Embedded Mode, calc, GNU Emacs Calc Manual}.
17467 @item @file{constants.el} by Carsten Dominik
17468 @cindex @file{constants.el}
17469 @cindex Dominik, Carsten
17470 @vindex org-table-formula-constants
17471 In a table formula (@pxref{The spreadsheet}), it is possible to use
17472 names for natural constants or units.  Instead of defining your own
17473 constants in the variable @code{org-table-formula-constants}, install
17474 the @file{constants} package which defines a large number of constants
17475 and units, and lets you use unit prefixes like @samp{M} for
17476 @samp{Mega}, etc.  You will need version 2.0 of this package, available
17477 at @url{http://www.astro.uva.nl/~dominik/Tools}.  Org checks for
17478 the function @code{constants-get}, which has to be autoloaded in your
17479 setup.  See the installation instructions in the file
17480 @file{constants.el}.
17481 @item @file{cdlatex.el} by Carsten Dominik
17482 @cindex @file{cdlatex.el}
17483 @cindex Dominik, Carsten
17484 Org mode can make use of the CD@LaTeX{} package to efficiently enter
17485 @LaTeX{} fragments into Org files.  See @ref{CDLaTeX mode}.
17486 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
17487 @cindex @file{imenu.el}
17488 Imenu allows menu access to an index of items in a file.  Org mode
17489 supports Imenu---all you need to do to get the index is the following:
17490 @lisp
17491 (add-hook 'org-mode-hook
17492           (lambda () (imenu-add-to-menubar "Imenu")))
17493 @end lisp
17494 @vindex org-imenu-depth
17495 By default the index is two levels deep---you can modify the depth using
17496 the option @code{org-imenu-depth}.
17497 @item @file{remember.el} by John Wiegley
17498 @cindex @file{remember.el}
17499 @cindex Wiegley, John
17500 Org used to use this package for capture, but no longer does.
17501 @item @file{speedbar.el} by Eric M. Ludlam
17502 @cindex @file{speedbar.el}
17503 @cindex Ludlam, Eric M.
17504 Speedbar is a package that creates a special frame displaying files and
17505 index items in files.  Org mode supports Speedbar and allows you to
17506 drill into Org files directly from the Speedbar.  It also allows you to
17507 restrict the scope of agenda commands to a file or a subtree by using
17508 the command @kbd{<} in the Speedbar frame.
17509 @cindex @file{table.el}
17510 @item @file{table.el} by Takaaki Ota
17511 @kindex C-c C-c
17512 @cindex table editor, @file{table.el}
17513 @cindex @file{table.el}
17514 @cindex Ota, Takaaki
17516 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
17517 and alignment can be created using the Emacs table package by Takaaki Ota
17518 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
17519 Org mode will recognize these tables and export them properly.  Because of
17520 interference with other Org mode functionality, you unfortunately cannot edit
17521 these tables directly in the buffer.  Instead, you need to use the command
17522 @kbd{C-c '} to edit them, similar to source code snippets.
17524 @table @kbd
17525 @orgcmd{C-c ',org-edit-special}
17526 Edit a @file{table.el} table.  Works when the cursor is in a table.el table.
17528 @orgcmd{C-c ~,org-table-create-with-table.el}
17529 Insert a @file{table.el} table.  If there is already a table at point, this
17530 command converts it between the @file{table.el} format and the Org mode
17531 format.  See the documentation string of the command
17532 @code{org-convert-table} for the restrictions under which this is
17533 possible.
17534 @end table
17535 @file{table.el} is part of Emacs since Emacs 22.
17536 @item @file{footnote.el} by Steven L. Baur
17537 @cindex @file{footnote.el}
17538 @cindex Baur, Steven L.
17539 Org mode recognizes numerical footnotes as provided by this package.
17540 However, Org mode also has its own footnote support (@pxref{Footnotes}),
17541 which makes using @file{footnote.el} unnecessary.
17542 @end table
17544 @node Conflicts
17545 @subsection Packages that lead to conflicts with Org mode
17547 @table @asis
17549 @cindex @code{shift-selection-mode}
17550 @vindex org-support-shift-select
17551 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
17552 cursor motions combined with the shift key should start or enlarge regions.
17553 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
17554 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
17555 at such a location.  By default, @kbd{S-@key{cursor}} commands outside
17556 special contexts don't do anything, but you can customize the variable
17557 @code{org-support-shift-select}.  Org mode then tries to accommodate shift
17558 selection by (i) using it outside of the special contexts where special
17559 commands apply, and by (ii) extending an existing active region even if the
17560 cursor moves across a special context.
17562 @item @file{CUA.el} by Kim. F. Storm
17563 @cindex @file{CUA.el}
17564 @cindex Storm, Kim. F.
17565 @vindex org-replace-disputed-keys
17566 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
17567 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and
17568 extend the region.  In fact, Emacs 23 has this built-in in the form of
17569 @code{shift-selection-mode}, see previous paragraph.  If you are using Emacs
17570 23, you probably don't want to use another package for this purpose.
17571 However, if you prefer to leave these keys to a different package while
17572 working in Org mode, configure the variable @code{org-replace-disputed-keys}.
17573 When set, Org will move the following key bindings in Org files, and in the
17574 agenda buffer (but not during date selection).
17576 @example
17577 S-UP      @result{}  M-p             S-DOWN     @result{}  M-n
17578 S-LEFT    @result{}  M--             S-RIGHT    @result{}  M-+
17579 C-S-LEFT  @result{}  M-S--           C-S-RIGHT  @result{}  M-S-+
17580 @end example
17582 @vindex org-disputed-keys
17583 Yes, these are unfortunately more difficult to remember.  If you want
17584 to have other replacement keys, look at the variable
17585 @code{org-disputed-keys}.
17587 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
17588 @cindex @file{ecomplete.el}
17590 Ecomplete provides ``electric'' address completion in address header
17591 lines in message buffers.  Sadly Orgtbl mode cuts ecompletes power
17592 supply: No completion happens when Orgtbl mode is enabled in message
17593 buffers while entering text in address header lines.  If one wants to
17594 use ecomplete one should @emph{not} follow the advice to automagically
17595 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
17596 instead---after filling in the message headers---turn on Orgtbl mode
17597 manually when needed in the messages body.
17599 @item @file{filladapt.el} by Kyle Jones
17600 @cindex @file{filladapt.el}
17602 Org mode tries to do the right thing when filling paragraphs, list items and
17603 other elements.  Many users reported they had problems using both
17604 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
17605 this:
17607 @lisp
17608 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
17609 @end lisp
17611 @item @file{yasnippet.el}
17612 @cindex @file{yasnippet.el}
17613 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
17614 @code{"\t"}) overrules YASnippet's access to this key.  The following code
17615 fixed this problem:
17617 @lisp
17618 (add-hook 'org-mode-hook
17619           (lambda ()
17620             (org-set-local 'yas/trigger-key [tab])
17621             (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
17622 @end lisp
17624 The latest version of yasnippet doesn't play well with Org mode.  If the
17625 above code does not fix the conflict, start by defining the following
17626 function:
17628 @lisp
17629 (defun yas/org-very-safe-expand ()
17630   (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
17631 @end lisp
17633 Then, tell Org mode what to do with the new function:
17635 @lisp
17636 (add-hook 'org-mode-hook
17637           (lambda ()
17638             (make-variable-buffer-local 'yas/trigger-key)
17639             (setq yas/trigger-key [tab])
17640             (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
17641             (define-key yas/keymap [tab] 'yas/next-field)))
17642 @end lisp
17644 @item @file{windmove.el} by Hovav Shacham
17645 @cindex @file{windmove.el}
17646 This package also uses the @kbd{S-<cursor>} keys, so everything written
17647 in the paragraph above about CUA mode also applies here.  If you want make
17648 the windmove function active in locations where Org mode does not have
17649 special functionality on @kbd{S-@key{cursor}}, add this to your
17650 configuration:
17652 @lisp
17653 ;; Make windmove work in org-mode:
17654 (add-hook 'org-shiftup-final-hook 'windmove-up)
17655 (add-hook 'org-shiftleft-final-hook 'windmove-left)
17656 (add-hook 'org-shiftdown-final-hook 'windmove-down)
17657 (add-hook 'org-shiftright-final-hook 'windmove-right)
17658 @end lisp
17660 @item @file{viper.el} by Michael Kifer
17661 @cindex @file{viper.el}
17662 @kindex C-c /
17663 Viper uses @kbd{C-c /} and therefore makes this key not access the
17664 corresponding Org mode command @code{org-sparse-tree}.  You need to find
17665 another key for this command, or override the key in
17666 @code{viper-vi-global-user-map} with
17668 @lisp
17669 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
17670 @end lisp
17674 @end table
17676 @node org-crypt
17677 @section org-crypt.el
17678 @cindex @file{org-crypt.el}
17679 @cindex @code{org-decrypt-entry}
17681 Org-crypt will encrypt the text of an entry, but not the headline, or
17682 properties.  Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
17683 files.
17685 Any text below a headline that has a @samp{:crypt:} tag will be automatically
17686 be encrypted when the file is saved.  If you want to use a different tag just
17687 customize the @code{org-crypt-tag-matcher} setting.
17689 To use org-crypt it is suggested that you have the following in your
17690 @file{.emacs}:
17692 @lisp
17693 (require 'org-crypt)
17694 (org-crypt-use-before-save-magic)
17695 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
17697 (setq org-crypt-key nil)
17698   ;; GPG key to use for encryption
17699   ;; Either the Key ID or set to nil to use symmetric encryption.
17701 (setq auto-save-default nil)
17702   ;; Auto-saving does not cooperate with org-crypt.el: so you need
17703   ;; to turn it off if you plan to use org-crypt.el quite often.
17704   ;; Otherwise, you'll get an (annoying) message each time you
17705   ;; start Org.
17707   ;; To turn it off only locally, you can insert this:
17708   ;;
17709   ;; # -*- buffer-auto-save-file-name: nil; -*-
17710 @end lisp
17712 Excluding the crypt tag from inheritance prevents already encrypted text
17713 being encrypted again.
17715 @node Hacking
17716 @appendix Hacking
17717 @cindex hacking
17719 This appendix covers some areas where users can extend the functionality of
17720 Org.
17722 @menu
17723 * Hooks::                       How to reach into Org's internals
17724 * Add-on packages::             Available extensions
17725 * Adding hyperlink types::      New custom link types
17726 * Adding export back-ends::     How to write new export back-ends
17727 * Context-sensitive commands::  How to add functionality to such commands
17728 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
17729 * Dynamic blocks::              Automatically filled blocks
17730 * Special agenda views::        Customized views
17731 * Speeding up your agendas::    Tips on how to speed up your agendas
17732 * Extracting agenda information::  Post-processing of agenda information
17733 * Using the property API::      Writing programs that use entry properties
17734 * Using the mapping API::       Mapping over all or selected entries
17735 @end menu
17737 @node Hooks
17738 @section Hooks
17739 @cindex hooks
17741 Org has a large number of hook variables that can be used to add
17742 functionality.  This appendix about hacking is going to illustrate the
17743 use of some of them.  A complete list of all hooks with documentation is
17744 maintained by the Worg project and can be found at
17745 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
17747 @node Add-on packages
17748 @section Add-on packages
17749 @cindex add-on packages
17751 A large number of add-on packages have been written by various authors.
17753 These packages are not part of Emacs, but they are distributed as contributed
17754 packages with the separate release available at @uref{http://orgmode.org}.
17755 See the @file{contrib/README} file in the source code directory for a list of
17756 contributed files.  You may also find some more information on the Worg page:
17757 @uref{http://orgmode.org/worg/org-contrib/}.
17759 @node Adding hyperlink types
17760 @section Adding hyperlink types
17761 @cindex hyperlinks, adding new types
17763 Org has a large number of hyperlink types built-in
17764 (@pxref{Hyperlinks}).  If you would like to add new link types, Org
17765 provides an interface for doing so.  Let's look at an example file,
17766 @file{org-man.el}, that will add support for creating links like
17767 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
17768 Emacs:
17770 @lisp
17771 ;;; org-man.el - Support for links to manpages in Org
17773 (require 'org)
17775 (org-add-link-type "man" 'org-man-open)
17776 (add-hook 'org-store-link-functions 'org-man-store-link)
17778 (defcustom org-man-command 'man
17779   "The Emacs command to be used to display a man page."
17780   :group 'org-link
17781   :type '(choice (const man) (const woman)))
17783 (defun org-man-open (path)
17784   "Visit the manpage on PATH.
17785 PATH should be a topic that can be thrown at the man command."
17786   (funcall org-man-command path))
17788 (defun org-man-store-link ()
17789   "Store a link to a manpage."
17790   (when (memq major-mode '(Man-mode woman-mode))
17791     ;; This is a man page, we do make this link
17792     (let* ((page (org-man-get-page-name))
17793            (link (concat "man:" page))
17794            (description (format "Manpage for %s" page)))
17795       (org-store-link-props
17796        :type "man"
17797        :link link
17798        :description description))))
17800 (defun org-man-get-page-name ()
17801   "Extract the page name from the buffer name."
17802   ;; This works for both `Man-mode' and `woman-mode'.
17803   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
17804       (match-string 1 (buffer-name))
17805     (error "Cannot create link to this man page")))
17807 (provide 'org-man)
17809 ;;; org-man.el ends here
17810 @end lisp
17812 @noindent
17813 You would activate this new link type in @file{.emacs} with
17815 @lisp
17816 (require 'org-man)
17817 @end lisp
17819 @noindent
17820 Let's go through the file and see what it does.
17821 @enumerate
17822 @item
17823 It does @code{(require 'org)} to make sure that @file{org.el} has been
17824 loaded.
17825 @item
17826 The next line calls @code{org-add-link-type} to define a new link type
17827 with prefix @samp{man}.  The call also contains the name of a function
17828 that will be called to follow such a link.
17829 @item
17830 @vindex org-store-link-functions
17831 The next line adds a function to @code{org-store-link-functions}, in
17832 order to allow the command @kbd{C-c l} to record a useful link in a
17833 buffer displaying a man page.
17834 @end enumerate
17836 The rest of the file defines the necessary variables and functions.
17837 First there is a customization variable that determines which Emacs
17838 command should be used to display man pages.  There are two options,
17839 @code{man} and @code{woman}.  Then the function to follow a link is
17840 defined.  It gets the link path as an argument---in this case the link
17841 path is just a topic for the manual command.  The function calls the
17842 value of @code{org-man-command} to display the man page.
17844 Finally the function @code{org-man-store-link} is defined.  When you try
17845 to store a link with @kbd{C-c l}, this function will be called to
17846 try to make a link.  The function must first decide if it is supposed to
17847 create the link for this buffer type; we do this by checking the value
17848 of the variable @code{major-mode}.  If not, the function must exit and
17849 return the value @code{nil}.  If yes, the link is created by getting the
17850 manual topic from the buffer name and prefixing it with the string
17851 @samp{man:}.  Then it must call the command @code{org-store-link-props}
17852 and set the @code{:type} and @code{:link} properties.  Optionally you
17853 can also set the @code{:description} property to provide a default for
17854 the link description when the link is later inserted into an Org
17855 buffer with @kbd{C-c C-l}.
17857 When it makes sense for your new link type, you may also define a function
17858 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
17859 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
17860 not accept any arguments, and return the full link with prefix.
17862 @node Adding export back-ends
17863 @section Adding export back-ends
17864 @cindex Export, writing back-ends
17866 Org 8.0 comes with a completely rewritten export engine which makes it easy
17867 to write new export back-ends, either from scratch, or by deriving them
17868 from existing ones.
17870 Your two entry points are respectively @code{org-export-define-backend} and
17871 @code{org-export-define-derived-backend}.  To grok these functions, you
17872 should first have a look at @file{ox-latex.el} (for how to define a new
17873 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
17874 back-end from an existing one.
17876 When creating a new back-end from scratch, the basic idea is to set the name
17877 of the back-end (as a symbol) and an alist of elements and export functions.
17878 On top of this, you will need to set additional keywords like
17879 @code{:menu-entry} (to display the back-end in the export dispatcher),
17880 @code{:export-block} (to specify what blocks should not be exported by this
17881 back-end), and @code{:options-alist} (to let the user set export options that
17882 are specific to this back-end.)
17884 Deriving a new back-end is similar, except that you need to set
17885 @code{:translate-alist} to an alist of export functions that should be used
17886 instead of the parent back-end functions.
17888 For a complete reference documentation, see
17889 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
17890 Reference on Worg}.
17892 @node Context-sensitive commands
17893 @section Context-sensitive commands
17894 @cindex context-sensitive commands, hooks
17895 @cindex add-ons, context-sensitive commands
17896 @vindex org-ctrl-c-ctrl-c-hook
17898 Org has several commands that act differently depending on context.  The most
17899 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
17900 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
17902 Add-ons can tap into this functionality by providing a function that detects
17903 special context for that add-on and executes functionality appropriate for
17904 the context.  Here is an example from Dan Davison's @file{org-R.el} which
17905 allows you to evaluate commands based on the @file{R} programming language
17906 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
17907 described in @ref{Working with source code} and is now obsolete.}.  For this
17908 package, special contexts are lines that start with @code{#+R:} or
17909 @code{#+RR:}.
17911 @lisp
17912 (defun org-R-apply-maybe ()
17913   "Detect if this is context for org-R and execute R commands."
17914   (if (save-excursion
17915         (beginning-of-line 1)
17916         (looking-at "#\\+RR?:"))
17917       (progn (call-interactively 'org-R-apply)
17918              t) ;; to signal that we took action
17919     nil)) ;; to signal that we did not
17921 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
17922 @end lisp
17924 The function first checks if the cursor is in such a line.  If that is the
17925 case, @code{org-R-apply} is called and the function returns @code{t} to
17926 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
17927 contexts.  If the function finds it should do nothing locally, it returns
17928 @code{nil} so that other, similar functions can have a try.
17931 @node Tables in arbitrary syntax
17932 @section Tables and lists in arbitrary syntax
17933 @cindex tables, in other modes
17934 @cindex lists, in other modes
17935 @cindex Orgtbl mode
17937 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
17938 frequent feature request has been to make it work with native tables in
17939 specific languages, for example @LaTeX{}.  However, this is extremely
17940 hard to do in a general way, would lead to a customization nightmare,
17941 and would take away much of the simplicity of the Orgtbl mode table
17942 editor.
17944 This appendix describes a different approach.  We keep the Orgtbl mode
17945 table in its native format (the @i{source table}), and use a custom
17946 function to @i{translate} the table to the correct syntax, and to
17947 @i{install} it in the right location (the @i{target table}).  This puts
17948 the burden of writing conversion functions on the user, but it allows
17949 for a very flexible system.
17951 Bastien added the ability to do the same with lists, in Orgstruct mode.  You
17952 can use Org's facilities to edit and structure lists by turning
17953 @code{orgstruct-mode} on, then locally exporting such lists in another format
17954 (HTML, @LaTeX{} or Texinfo.)
17957 @menu
17958 * Radio tables::                Sending and receiving radio tables
17959 * A @LaTeX{} example::          Step by step, almost a tutorial
17960 * Translator functions::        Copy and modify
17961 * Radio lists::                 Sending and receiving lists
17962 @end menu
17964 @node Radio tables
17965 @subsection Radio tables
17966 @cindex radio tables
17968 To define the location of the target table, you first need to create two
17969 lines that are comments in the current mode, but contain magic words
17970 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find.  Orgtbl mode will
17971 insert the translated table between these lines, replacing whatever was there
17972 before.  For example in C mode where comments are between @code{/* ... */}:
17974 @example
17975 /* BEGIN RECEIVE ORGTBL table_name */
17976 /* END RECEIVE ORGTBL table_name */
17977 @end example
17979 @noindent
17980 Just above the source table, we put a special line that tells
17981 Orgtbl mode how to translate this table and where to install it.  For
17982 example:
17983 @cindex #+ORGTBL
17984 @example
17985 #+ORGTBL: SEND table_name translation_function arguments...
17986 @end example
17988 @noindent
17989 @code{table_name} is the reference name for the table that is also used
17990 in the receiver lines.  @code{translation_function} is the Lisp function
17991 that does the translation.  Furthermore, the line can contain a list of
17992 arguments (alternating key and value) at the end.  The arguments will be
17993 passed as a property list to the translation function for
17994 interpretation.  A few standard parameters are already recognized and
17995 acted upon before the translation function is called:
17997 @table @code
17998 @item :skip N
17999 Skip the first N lines of the table.  Hlines do count as separate lines for
18000 this parameter!
18002 @item :skipcols (n1 n2 ...)
18003 List of columns that should be skipped.  If the table has a column with
18004 calculation marks, that column is automatically discarded as well.
18005 Please note that the translator function sees the table @emph{after} the
18006 removal of these columns, the function never knows that there have been
18007 additional columns.
18008 @end table
18010 @noindent
18011 The one problem remaining is how to keep the source table in the buffer
18012 without disturbing the normal workings of the file, for example during
18013 compilation of a C file or processing of a @LaTeX{} file.  There are a
18014 number of different solutions:
18016 @itemize @bullet
18017 @item
18018 The table could be placed in a block comment if that is supported by the
18019 language.  For example, in C mode you could wrap the table between
18020 @samp{/*} and @samp{*/} lines.
18021 @item
18022 Sometimes it is possible to put the table after some kind of @i{END}
18023 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
18024 in @LaTeX{}.
18025 @item
18026 You can just comment the table line-by-line whenever you want to process
18027 the file, and uncomment it whenever you need to edit the table.  This
18028 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
18029 makes this comment-toggling very easy, in particular if you bind it to a
18030 key.
18031 @end itemize
18033 @node A @LaTeX{} example
18034 @subsection A @LaTeX{} example of radio tables
18035 @cindex @LaTeX{}, and Orgtbl mode
18037 The best way to wrap the source table in @LaTeX{} is to use the
18038 @code{comment} environment provided by @file{comment.sty}.  It has to be
18039 activated by placing @code{\usepackage@{comment@}} into the document
18040 header.  Orgtbl mode can insert a radio table skeleton@footnote{By
18041 default this works only for @LaTeX{}, HTML, and Texinfo.  Configure the
18042 variable @code{orgtbl-radio-table-templates} to install templates for other
18043 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table RET}.  You will
18044 be prompted for a table name, let's say we use @samp{salesfigures}.  You
18045 will then get the following template:
18047 @cindex #+ORGTBL, SEND
18048 @example
18049 % BEGIN RECEIVE ORGTBL salesfigures
18050 % END RECEIVE ORGTBL salesfigures
18051 \begin@{comment@}
18052 #+ORGTBL: SEND salesfigures orgtbl-to-latex
18053 | | |
18054 \end@{comment@}
18055 @end example
18057 @noindent
18058 @vindex @LaTeX{}-verbatim-environments
18059 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
18060 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
18061 into the receiver location with name @code{salesfigures}.  You may now
18062 fill in the table---feel free to use the spreadsheet features@footnote{If
18063 the @samp{#+TBLFM} line contains an odd number of dollar characters,
18064 this may cause problems with font-lock in @LaTeX{} mode.  As shown in the
18065 example you can fix this by adding an extra line inside the
18066 @code{comment} environment that is used to balance the dollar
18067 expressions.  If you are using AUC@TeX{} with the font-latex library, a
18068 much better solution is to add the @code{comment} environment to the
18069 variable @code{LaTeX-verbatim-environments}.}:
18071 @example
18072 % BEGIN RECEIVE ORGTBL salesfigures
18073 % END RECEIVE ORGTBL salesfigures
18074 \begin@{comment@}
18075 #+ORGTBL: SEND salesfigures orgtbl-to-latex
18076 | Month | Days | Nr sold | per day |
18077 |-------+------+---------+---------|
18078 | Jan   |   23 |      55 |     2.4 |
18079 | Feb   |   21 |      16 |     0.8 |
18080 | March |   22 |     278 |    12.6 |
18081 #+TBLFM: $4=$3/$2;%.1f
18082 % $ (optional extra dollar to keep font-lock happy, see footnote)
18083 \end@{comment@}
18084 @end example
18086 @noindent
18087 When you are done, press @kbd{C-c C-c} in the table to get the converted
18088 table inserted between the two marker lines.
18090 Now let's assume you want to make the table header by hand, because you
18091 want to control how columns are aligned, etc.  In this case we make sure
18092 that the table translator skips the first 2 lines of the source
18093 table, and tell the command to work as a @i{splice}, i.e., to not produce
18094 header and footer commands of the target table:
18096 @example
18097 \begin@{tabular@}@{lrrr@}
18098 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
18099 % BEGIN RECEIVE ORGTBL salesfigures
18100 % END RECEIVE ORGTBL salesfigures
18101 \end@{tabular@}
18103 \begin@{comment@}
18104 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
18105 | Month | Days | Nr sold | per day |
18106 |-------+------+---------+---------|
18107 | Jan   |   23 |      55 |     2.4 |
18108 | Feb   |   21 |      16 |     0.8 |
18109 | March |   22 |     278 |    12.6 |
18110 #+TBLFM: $4=$3/$2;%.1f
18111 \end@{comment@}
18112 @end example
18114 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
18115 Orgtbl mode.  By default, it uses a @code{tabular} environment to typeset the
18116 table and marks horizontal lines with @code{\hline}.  You can control the
18117 output through several parameters (see also @pxref{Translator functions}),
18118 including the following ones :
18120 @table @code
18121 @item :splice nil/t
18122 When non-@code{nil}, return only table body lines, don't wrap them into a tabular
18123 environment.  Default is @code{nil}.
18125 @item :fmt fmt
18126 A format to be used to wrap each field, it should contain @code{%s} for the
18127 original field value.  For example, to wrap each field value in dollars,
18128 you could use @code{:fmt "$%s$"}.  This may also be a property list with
18129 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
18130 A function of one argument can be used in place of the strings; the
18131 function must return a formatted string.
18133 @item :efmt efmt
18134 Use this format to print numbers with exponentials.  The format should have
18135 @code{%s} twice for inserting mantissa and exponent, for example
18136 @code{"%s\\times10^@{%s@}"}.  This may also be a property list with column
18137 numbers and formats, for example @code{:efmt (2 "$%s\\times10^@{%s@}$"
18138 4 "$%s\\cdot10^@{%s@}$")}.  After @code{efmt} has been applied to a value,
18139 @code{fmt} will also be applied.  Similar to @code{fmt}, functions of two
18140 arguments can be supplied instead of strings.  By default, no special
18141 formatting is applied.
18142 @end table
18144 @node Translator functions
18145 @subsection Translator functions
18146 @cindex HTML, and Orgtbl mode
18147 @cindex translator function
18149 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
18150 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
18151 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, @code{orgtbl-to-texinfo},
18152 @code{orgtbl-to-unicode} and @code{orgtbl-to-orgtbl}.  These all use
18153 a generic translator, @code{orgtbl-to-generic}, which, in turn, can delegate
18154 translations to various export back-ends (@pxref{Export back-ends}).
18156 In particular, properties passed into the function (i.e., the ones set by the
18157 @samp{ORGTBL SEND} line) take precedence over translations defined in the
18158 function.  So if you would like to use the @LaTeX{} translator, but wanted
18159 the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you
18160 could just overrule the default with
18162 @example
18163 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
18164 @end example
18166 For a new language, you can use the generic function to write your own
18167 converter function.  For example, if you have a language where a table is
18168 started with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines
18169 are started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
18170 separator is a TAB, you could define your generic translator like this:
18172 @lisp
18173 (defun orgtbl-to-language (table params)
18174   "Convert the orgtbl-mode TABLE to language."
18175   (orgtbl-to-generic
18176    table
18177    (org-combine-plists
18178     '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
18179     params)))
18180 @end lisp
18182 @noindent
18183 Please check the documentation string of the function
18184 @code{orgtbl-to-generic} for a full list of parameters understood by
18185 that function, and remember that you can pass each of them into
18186 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
18187 using the generic function.
18189 Of course you can also write a completely new function doing complicated
18190 things the generic translator cannot do.  A translator function takes
18191 two arguments.  The first argument is the table, a list of lines, each
18192 line either the symbol @code{hline} or a list of fields.  The second
18193 argument is the property list containing all parameters specified in the
18194 @samp{#+ORGTBL: SEND} line.  The function must return a single string
18195 containing the formatted table.  If you write a generally useful
18196 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
18197 others can benefit from your work.
18199 @node Radio lists
18200 @subsection Radio lists
18201 @cindex radio lists
18202 @cindex org-list-insert-radio-list
18204 Sending and receiving radio lists works exactly the same way as sending and
18205 receiving radio tables (@pxref{Radio tables}).  As for radio tables, you can
18206 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
18207 @code{org-list-insert-radio-list}.
18209 Here are the differences with radio tables:
18211 @itemize @minus
18212 @item
18213 Orgstruct mode must be active.
18214 @item
18215 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
18216 @item
18217 The available translation functions for radio lists don't take
18218 parameters.
18219 @item
18220 @kbd{C-c C-c} will work when pressed on the first item of the list.
18221 @end itemize
18223 Here is a @LaTeX{} example.  Let's say that you have this in your
18224 @LaTeX{} file:
18226 @cindex #+ORGLST
18227 @example
18228 % BEGIN RECEIVE ORGLST to-buy
18229 % END RECEIVE ORGLST to-buy
18230 \begin@{comment@}
18231 #+ORGLST: SEND to-buy org-list-to-latex
18232 - a new house
18233 - a new computer
18234   + a new keyboard
18235   + a new mouse
18236 - a new life
18237 \end@{comment@}
18238 @end example
18240 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
18241 @LaTeX{} list between the two marker lines.
18243 @node Dynamic blocks
18244 @section Dynamic blocks
18245 @cindex dynamic blocks
18247 Org documents can contain @emph{dynamic blocks}.  These are
18248 specially marked regions that are updated by some user-written function.
18249 A good example for such a block is the clock table inserted by the
18250 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
18252 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
18253 to the block and can also specify parameters for the function producing
18254 the content of the block.
18256 @cindex #+BEGIN:dynamic block
18257 @example
18258 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
18260 #+END:
18261 @end example
18263 Dynamic blocks are updated with the following commands
18265 @table @kbd
18266 @orgcmd{C-c C-x C-u,org-dblock-update}
18267 Update dynamic block at point.
18268 @orgkey{C-u C-c C-x C-u}
18269 Update all dynamic blocks in the current file.
18270 @end table
18272 Updating a dynamic block means to remove all the text between BEGIN and
18273 END, parse the BEGIN line for parameters and then call the specific
18274 writer function for this block to insert the new content.  If you want
18275 to use the original content in the writer function, you can use the
18276 extra parameter @code{:content}.
18278 For a block with name @code{myblock}, the writer function is
18279 @code{org-dblock-write:myblock} with as only parameter a property list
18280 with the parameters given in the begin line.  Here is a trivial example
18281 of a block that keeps track of when the block update function was last
18282 run:
18284 @example
18285 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
18287 #+END:
18288 @end example
18290 @noindent
18291 The corresponding block writer function could look like this:
18293 @lisp
18294 (defun org-dblock-write:block-update-time (params)
18295   (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
18296     (insert "Last block update at: "
18297             (format-time-string fmt (current-time)))))
18298 @end lisp
18300 If you want to make sure that all dynamic blocks are always up-to-date,
18301 you could add the function @code{org-update-all-dblocks} to a hook, for
18302 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
18303 written in a way such that it does nothing in buffers that are not in
18304 @code{org-mode}.
18306 You can narrow the current buffer to the current dynamic block (like any
18307 other block) with @code{org-narrow-to-block}.
18309 @node Special agenda views
18310 @section Special agenda views
18311 @cindex agenda views, user-defined
18313 @vindex org-agenda-skip-function
18314 @vindex org-agenda-skip-function-global
18315 Org provides a special hook that can be used to narrow down the selection
18316 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
18317 @code{agenda*} view is the same as @code{agenda} except that it only
18318 considers @emph{appointments}, i.e., scheduled and deadline items that have a
18319 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
18320 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}.  You may
18321 specify a function that is used at each match to verify if the match should
18322 indeed be part of the agenda view, and if not, how much should be skipped.
18323 You can specify a global condition that will be applied to all agenda views,
18324 this condition would be stored in the variable
18325 @code{org-agenda-skip-function-global}.  More commonly, such a definition is
18326 applied only to specific custom searches, using
18327 @code{org-agenda-skip-function}.
18329 Let's say you want to produce a list of projects that contain a WAITING
18330 tag anywhere in the project tree.  Let's further assume that you have
18331 marked all tree headings that define a project with the TODO keyword
18332 PROJECT@.  In this case you would run a TODO search for the keyword
18333 PROJECT, but skip the match unless there is a WAITING tag anywhere in
18334 the subtree belonging to the project line.
18336 To achieve this, you must write a function that searches the subtree for
18337 the tag.  If the tag is found, the function must return @code{nil} to
18338 indicate that this match should not be skipped.  If there is no such
18339 tag, return the location of the end of the subtree, to indicate that
18340 search should continue from there.
18342 @lisp
18343 (defun my-skip-unless-waiting ()
18344   "Skip trees that are not waiting"
18345   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
18346     (if (re-search-forward ":waiting:" subtree-end t)
18347         nil          ; tag found, do not skip
18348       subtree-end))) ; tag not found, continue after end of subtree
18349 @end lisp
18351 Now you may use this function in an agenda custom command, for example
18352 like this:
18354 @lisp
18355 (org-add-agenda-custom-command
18356  '("b" todo "PROJECT"
18357    ((org-agenda-skip-function 'my-skip-unless-waiting)
18358     (org-agenda-overriding-header "Projects waiting for something: "))))
18359 @end lisp
18361 @vindex org-agenda-overriding-header
18362 Note that this also binds @code{org-agenda-overriding-header} to get a
18363 meaningful header in the agenda view.
18365 @vindex org-odd-levels-only
18366 @vindex org-agenda-skip-function
18367 A general way to create custom searches is to base them on a search for
18368 entries with a certain level limit.  If you want to study all entries with
18369 your custom search function, simply do a search for
18370 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
18371 level number corresponds to order in the hierarchy, not to the number of
18372 stars.}, and then use @code{org-agenda-skip-function} to select the entries
18373 you really want to have.
18375 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
18376 particular, you may use the functions @code{org-agenda-skip-entry-if}
18377 and @code{org-agenda-skip-subtree-if} in this form, for example:
18379 @table @code
18380 @item (org-agenda-skip-entry-if 'scheduled)
18381 Skip current entry if it has been scheduled.
18382 @item (org-agenda-skip-entry-if 'notscheduled)
18383 Skip current entry if it has not been scheduled.
18384 @item (org-agenda-skip-entry-if 'deadline)
18385 Skip current entry if it has a deadline.
18386 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
18387 Skip current entry if it has a deadline, or if it is scheduled.
18388 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
18389 Skip current entry if the TODO keyword is TODO or WAITING.
18390 @item (org-agenda-skip-entry-if 'todo 'done)
18391 Skip current entry if the TODO keyword marks a DONE state.
18392 @item (org-agenda-skip-entry-if 'timestamp)
18393 Skip current entry if it has any timestamp, may also be deadline or scheduled.
18394 @anchor{x-agenda-skip-entry-regexp}
18395 @item (org-agenda-skip-entry-if 'regexp "regular expression")
18396 Skip current entry if the regular expression matches in the entry.
18397 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
18398 Skip current entry unless the regular expression matches.
18399 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
18400 Same as above, but check and skip the entire subtree.
18401 @end table
18403 Therefore we could also have written the search for WAITING projects
18404 like this, even without defining a special function:
18406 @lisp
18407 (org-add-agenda-custom-command
18408  '("b" todo "PROJECT"
18409    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
18410                                 'regexp ":waiting:"))
18411     (org-agenda-overriding-header "Projects waiting for something: "))))
18412 @end lisp
18414 @node Speeding up your agendas
18415 @section Speeding up your agendas
18416 @cindex agenda views, optimization
18418 When your Org files grow in both number and size, agenda commands may start
18419 to become slow.  Below are some tips on how to speed up the agenda commands.
18421 @enumerate
18422 @item
18423 Reduce the number of Org agenda files: this will reduce the slowdown caused
18424 by accessing a hard drive.
18425 @item
18426 Reduce the number of DONE and archived headlines: this way the agenda does
18427 not need to skip them.
18428 @item
18429 @vindex org-agenda-dim-blocked-tasks
18430 Inhibit the dimming of blocked tasks:
18431 @lisp
18432 (setq org-agenda-dim-blocked-tasks nil)
18433 @end lisp
18434 @item
18435 @vindex org-startup-folded
18436 @vindex org-agenda-inhibit-startup
18437 Inhibit agenda files startup options:
18438 @lisp
18439 (setq org-agenda-inhibit-startup nil)
18440 @end lisp
18441 @item
18442 @vindex org-agenda-show-inherited-tags
18443 @vindex org-agenda-use-tag-inheritance
18444 Disable tag inheritance in agenda:
18445 @lisp
18446 (setq org-agenda-use-tag-inheritance nil)
18447 @end lisp
18448 @end enumerate
18450 You can set these options for specific agenda views only.  See the docstrings
18451 of these variables for details on why they affect the agenda generation, and
18452 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
18453 page} for further explanations.
18455 @node Extracting agenda information
18456 @section Extracting agenda information
18457 @cindex agenda, pipe
18458 @cindex Scripts, for agenda processing
18460 @vindex org-agenda-custom-commands
18461 Org provides commands to access agenda information for the command
18462 line in Emacs batch mode.  This extracted information can be sent
18463 directly to a printer, or it can be read by a program that does further
18464 processing of the data.  The first of these commands is the function
18465 @code{org-batch-agenda}, that produces an agenda view and sends it as
18466 ASCII text to STDOUT@.  The command takes a single string as parameter.
18467 If the string has length 1, it is used as a key to one of the commands
18468 you have configured in @code{org-agenda-custom-commands}, basically any
18469 key you can use after @kbd{C-c a}.  For example, to directly print the
18470 current TODO list, you could use
18472 @example
18473 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
18474 @end example
18476 If the parameter is a string with 2 or more characters, it is used as a
18477 tags/TODO match string.  For example, to print your local shopping list
18478 (all items with the tag @samp{shop}, but excluding the tag
18479 @samp{NewYork}), you could use
18481 @example
18482 emacs -batch -l ~/.emacs                                      \
18483       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
18484 @end example
18486 @noindent
18487 You may also modify parameters on the fly like this:
18489 @example
18490 emacs -batch -l ~/.emacs                                      \
18491    -eval '(org-batch-agenda "a"                               \
18492             org-agenda-span (quote month)                     \
18493             org-agenda-include-diary nil                      \
18494             org-agenda-files (quote ("~/org/project.org")))'  \
18495    | lpr
18496 @end example
18498 @noindent
18499 which will produce a 30-day agenda, fully restricted to the Org file
18500 @file{~/org/projects.org}, not even including the diary.
18502 If you want to process the agenda data in more sophisticated ways, you
18503 can use the command @code{org-batch-agenda-csv} to get a comma-separated
18504 list of values for each agenda item.  Each line in the output will
18505 contain a number of fields separated by commas.  The fields in a line
18506 are:
18508 @example
18509 category     @r{The category of the item}
18510 head         @r{The headline, without TODO keyword, TAGS and PRIORITY}
18511 type         @r{The type of the agenda entry, can be}
18512                 todo               @r{selected in TODO match}
18513                 tagsmatch          @r{selected in tags match}
18514                 diary              @r{imported from diary}
18515                 deadline           @r{a deadline}
18516                 scheduled          @r{scheduled}
18517                 timestamp          @r{appointment, selected by timestamp}
18518                 closed             @r{entry was closed on date}
18519                 upcoming-deadline  @r{warning about nearing deadline}
18520                 past-scheduled     @r{forwarded scheduled item}
18521                 block              @r{entry has date block including date}
18522 todo         @r{The TODO keyword, if any}
18523 tags         @r{All tags including inherited ones, separated by colons}
18524 date         @r{The relevant date, like 2007-2-14}
18525 time         @r{The time, like 15:00-16:50}
18526 extra        @r{String with extra planning info}
18527 priority-l   @r{The priority letter if any was given}
18528 priority-n   @r{The computed numerical priority}
18529 @end example
18531 @noindent
18532 Time and date will only be given if a timestamp (or deadline/scheduled)
18533 led to the selection of the item.
18535 A CSV list like this is very easy to use in a post-processing script.
18536 For example, here is a Perl program that gets the TODO list from
18537 Emacs/Org and prints all the items, preceded by a checkbox:
18539 @example
18540 #!/usr/bin/perl
18542 # define the Emacs command to run
18543 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
18545 # run it and capture the output
18546 $agenda = qx@{$cmd 2>/dev/null@};
18548 # loop over all lines
18549 foreach $line (split(/\n/,$agenda)) @{
18550   # get the individual values
18551   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
18552    $priority_l,$priority_n) = split(/,/,$line);
18553   # process and print
18554   print "[ ] $head\n";
18556 @end example
18558 @node Using the property API
18559 @section Using the property API
18560 @cindex API, for properties
18561 @cindex properties, API
18563 Here is a description of the functions that can be used to work with
18564 properties.
18566 @defun org-entry-properties &optional pom which
18567 Get all properties of the entry at point-or-marker POM.@*
18568 This includes the TODO keyword, the tags, time strings for deadline,
18569 scheduled, and clocking, and any additional properties defined in the
18570 entry.  The return value is an alist.  Keys may occur multiple times
18571 if the property key was used several times.@*
18572 POM may also be @code{nil}, in which case the current entry is used.
18573 If WHICH is @code{nil} or `all', get all properties.  If WHICH is
18574 `special' or `standard', only get that subclass.
18575 @end defun
18576 @vindex org-use-property-inheritance
18577 @findex org-insert-property-drawer
18578 @defun org-entry-get pom property &optional inherit
18579 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@.  By default,
18580 this only looks at properties defined locally in the entry.  If @code{INHERIT}
18581 is non-@code{nil} and the entry does not have the property, then also check
18582 higher levels of the hierarchy.  If @code{INHERIT} is the symbol
18583 @code{selective}, use inheritance if and only if the setting of
18584 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
18585 @end defun
18587 @defun org-entry-delete pom property
18588 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
18589 @end defun
18591 @defun org-entry-put pom property value
18592 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
18593 @end defun
18595 @defun org-buffer-property-keys &optional include-specials
18596 Get all property keys in the current buffer.
18597 @end defun
18599 @defun org-insert-property-drawer
18600 Insert a property drawer for the current entry.
18601 @end defun
18603 @defun org-entry-put-multivalued-property pom property &rest values
18604 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
18605 @code{VALUES} should be a list of strings.  They will be concatenated, with
18606 spaces as separators.
18607 @end defun
18609 @defun org-entry-get-multivalued-property pom property
18610 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18611 list of values and return the values as a list of strings.
18612 @end defun
18614 @defun org-entry-add-to-multivalued-property pom property value
18615 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18616 list of values and make sure that @code{VALUE} is in this list.
18617 @end defun
18619 @defun org-entry-remove-from-multivalued-property pom property value
18620 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18621 list of values and make sure that @code{VALUE} is @emph{not} in this list.
18622 @end defun
18624 @defun org-entry-member-in-multivalued-property pom property value
18625 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18626 list of values and check if @code{VALUE} is in this list.
18627 @end defun
18629 @defopt org-property-allowed-value-functions
18630 Hook for functions supplying allowed values for a specific property.
18631 The functions must take a single argument, the name of the property, and
18632 return a flat list of allowed values.  If @samp{:ETC} is one of
18633 the values, use the values as completion help, but allow also other values
18634 to be entered.  The functions must return @code{nil} if they are not
18635 responsible for this property.
18636 @end defopt
18638 @node Using the mapping API
18639 @section Using the mapping API
18640 @cindex API, for mapping
18641 @cindex mapping entries, API
18643 Org has sophisticated mapping capabilities to find all entries satisfying
18644 certain criteria.  Internally, this functionality is used to produce agenda
18645 views, but there is also an API that can be used to execute arbitrary
18646 functions for each or selected entries.  The main entry point for this API
18649 @defun org-map-entries func &optional match scope &rest skip
18650 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
18652 @code{FUNC} is a function or a Lisp form.  The function will be called
18653 without arguments, with the cursor positioned at the beginning of the
18654 headline.  The return values of all calls to the function will be collected
18655 and returned as a list.
18657 The call to @code{FUNC} will be wrapped into a save-excursion form, so
18658 @code{FUNC} does not need to preserve point.  After evaluation, the cursor
18659 will be moved to the end of the line (presumably of the headline of the
18660 processed entry) and search continues from there.  Under some circumstances,
18661 this may not produce the wanted results.  For example, if you have removed
18662 (e.g., archived) the current (sub)tree it could mean that the next entry will
18663 be skipped entirely.  In such cases, you can specify the position from where
18664 search should continue by making @code{FUNC} set the variable
18665 @code{org-map-continue-from} to the desired buffer position.
18667 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
18668 view.  Only headlines that are matched by this query will be considered
18669 during the iteration.  When @code{MATCH} is @code{nil} or @code{t}, all
18670 headlines will be visited by the iteration.
18672 @code{SCOPE} determines the scope of this command.  It can be any of:
18674 @example
18675 nil     @r{the current buffer, respecting the restriction if any}
18676 tree    @r{the subtree started with the entry at point}
18677 region  @r{The entries within the active region, if any}
18678 file    @r{the current buffer, without restriction}
18679 file-with-archives
18680         @r{the current buffer, and any archives associated with it}
18681 agenda  @r{all agenda files}
18682 agenda-with-archives
18683         @r{all agenda files with any archive files associated with them}
18684 (file1 file2 ...)
18685         @r{if this is a list, all files in the list will be scanned}
18686 @end example
18687 @noindent
18688 The remaining args are treated as settings for the skipping facilities of
18689 the scanner.  The following items can be given here:
18691 @vindex org-agenda-skip-function
18692 @example
18693 archive   @r{skip trees with the archive tag}
18694 comment   @r{skip trees with the COMMENT keyword}
18695 function or Lisp form
18696           @r{will be used as value for @code{org-agenda-skip-function},}
18697           @r{so whenever the function returns t, FUNC}
18698           @r{will not be called for that entry and search will}
18699           @r{continue from the point where the function leaves it}
18700 @end example
18701 @end defun
18703 The function given to that mapping routine can really do anything you like.
18704 It can use the property API (@pxref{Using the property API}) to gather more
18705 information about the entry, or in order to change metadata in the entry.
18706 Here are a couple of functions that might be handy:
18708 @defun org-todo &optional arg
18709 Change the TODO state of the entry.  See the docstring of the functions for
18710 the many possible values for the argument @code{ARG}.
18711 @end defun
18713 @defun org-priority &optional action
18714 Change the priority of the entry.  See the docstring of this function for the
18715 possible values for @code{ACTION}.
18716 @end defun
18718 @defun org-toggle-tag tag &optional onoff
18719 Toggle the tag @code{TAG} in the current entry.  Setting @code{ONOFF} to
18720 either @code{on} or @code{off} will not toggle tag, but ensure that it is
18721 either on or off.
18722 @end defun
18724 @defun org-promote
18725 Promote the current entry.
18726 @end defun
18728 @defun org-demote
18729 Demote the current entry.
18730 @end defun
18732 Here is a simple example that will turn all entries in the current file with
18733 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
18734 Entries in comment trees and in archive trees will be ignored.
18736 @lisp
18737 (org-map-entries
18738  '(org-todo "UPCOMING")
18739  "+TOMORROW" 'file 'archive 'comment)
18740 @end lisp
18742 The following example counts the number of entries with TODO keyword
18743 @code{WAITING}, in all agenda files.
18745 @lisp
18746 (length (org-map-entries t "/+WAITING" 'agenda))
18747 @end lisp
18749 @node MobileOrg
18750 @appendix MobileOrg
18751 @cindex iPhone
18752 @cindex MobileOrg
18754 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
18755 available for iOS and for Android.  @i{MobileOrg} offers offline viewing and
18756 capture support for an Org mode system rooted on a ``real'' computer.  It
18757 also allows you to record changes to existing entries.  The
18758 @uref{https://github.com/MobileOrg/, iOS implementation} for the
18759 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
18760 and is now in the hands Sean Escriva.  Android users should check out
18761 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
18762 by Matt Jones.  The two implementations are not identical but offer similar
18763 features.
18765 This appendix describes the support Org has for creating agenda views in a
18766 format that can be displayed by @i{MobileOrg}, and for integrating notes
18767 captured and changes made by @i{MobileOrg} into the main system.
18769 For changing tags and TODO states in MobileOrg, you should have set up the
18770 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
18771 cover all important tags and TODO keywords, even if individual files use only
18772 part of these.  MobileOrg will also offer you states and tags set up with
18773 in-buffer settings, but it will understand the logistics of TODO state
18774 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
18775 (@pxref{Setting tags}) only for those set in these variables.
18777 @menu
18778 * Setting up the staging area::  Where to interact with the mobile device
18779 * Pushing to MobileOrg::        Uploading Org files and agendas
18780 * Pulling from MobileOrg::      Integrating captured and flagged items
18781 @end menu
18783 @node Setting up the staging area
18784 @section Setting up the staging area
18786 MobileOrg needs to interact with Emacs through a directory on a server.  If
18787 you are using a public server, you should consider encrypting the files that
18788 are uploaded to the server.  This can be done with Org mode 7.02 and with
18789 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
18790 installation on your system.  To turn on encryption, set a password in
18791 @i{MobileOrg} and, on the Emacs side, configure the variable
18792 @code{org-mobile-use-encryption}@footnote{If you can safely store the
18793 password in your Emacs setup, you might also want to configure
18794 @code{org-mobile-encryption-password}.  Please read the docstring of that
18795 variable.  Note that encryption will apply only to the contents of the
18796 @file{.org} files.  The file names themselves will remain visible.}.
18798 The easiest way to create that directory is to use a free
18799 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
18800 Dropbox, or if your version of MobileOrg does not support it, you can use a
18801 webdav server.  For more information, check out the documentation of MobileOrg and also this
18802 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
18803 When MobileOrg first connects to your Dropbox, it will create a directory
18804 @i{MobileOrg} inside the Dropbox.  After the directory has been created, tell
18805 Emacs about it:
18807 @lisp
18808 (setq org-mobile-directory "~/Dropbox/MobileOrg")
18809 @end lisp
18811 Org mode has commands to put files for @i{MobileOrg} into that directory,
18812 and to read captured notes from there.
18814 @node Pushing to MobileOrg
18815 @section Pushing to MobileOrg
18817 This operation copies all files currently listed in @code{org-mobile-files}
18818 to the directory @code{org-mobile-directory}.  By default this list contains
18819 all agenda files (as listed in @code{org-agenda-files}), but additional files
18820 can be included by customizing @code{org-mobile-files}.  File names will be
18821 staged with paths relative to @code{org-directory}, so all files should be
18822 inside this directory@footnote{Symbolic links in @code{org-directory} need to
18823 have the same name as their targets.}.
18825 The push operation also creates a special Org file @file{agendas.org} with
18826 all custom agenda view defined by the user@footnote{While creating the
18827 agendas, Org mode will force ID properties on all referenced entries, so that
18828 these entries can be uniquely identified if @i{MobileOrg} flags them for
18829 further action.  If you do not want to get these properties in so many
18830 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
18831 to @code{nil}.  Org mode will then rely on outline paths, in the hope that
18832 these will be unique enough.}.
18834 Finally, Org writes the file @file{index.org}, containing links to all other
18835 files.  @i{MobileOrg} first reads this file from the server, and then
18836 downloads all agendas and Org files listed in it.  To speed up the download,
18837 MobileOrg will only read files whose checksums@footnote{Checksums are stored
18838 automatically in the file @file{checksums.dat}} have changed.
18840 @node Pulling from MobileOrg
18841 @section Pulling from MobileOrg
18843 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
18844 files for viewing.  It also appends captured entries and pointers to flagged
18845 and changed entries to the file @file{mobileorg.org} on the server.  Org has
18846 a @emph{pull} operation that integrates this information into an inbox file
18847 and operates on the pointers to flagged entries.  Here is how it works:
18849 @enumerate
18850 @item
18851 Org moves all entries found in
18852 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
18853 operation.} and appends them to the file pointed to by the variable
18854 @code{org-mobile-inbox-for-pull}.  Each captured entry and each editing event
18855 will be a top-level entry in the inbox file.
18856 @item
18857 After moving the entries, Org will attempt to implement the changes made in
18858 @i{MobileOrg}.  Some changes are applied directly and without user
18859 interaction.  Examples are all changes to tags, TODO state, headline and body
18860 text that can be cleanly applied.  Entries that have been flagged for further
18861 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
18862 again.  When there is a problem finding an entry or applying the change, the
18863 pointer entry will remain in the inbox and will be marked with an error
18864 message.  You need to later resolve these issues by hand.
18865 @item
18866 Org will then generate an agenda view with all flagged entries.  The user
18867 should then go through these entries and do whatever actions are necessary.
18868 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
18869 will be displayed in the echo area when the cursor is on the corresponding
18870 agenda line.
18872 @table @kbd
18873 @kindex ?
18874 @item ?
18875 Pressing @kbd{?} in that special agenda will display the full flagging note in
18876 another window and also push it onto the kill ring.  So you could use @kbd{?
18877 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
18878 Pressing @kbd{?} twice in succession will offer to remove the
18879 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
18880 in a property).  In this way you indicate that the intended processing for
18881 this flagged entry is finished.
18882 @end table
18883 @end enumerate
18885 @kindex C-c a ?
18886 If you are not able to process all flagged entries directly, you can always
18887 return to this agenda view@footnote{Note, however, that there is a subtle
18888 difference.  The view created automatically by @kbd{M-x org-mobile-pull RET}
18889 is guaranteed to search all files that have been addressed by the last pull.
18890 This might include a file that is not currently in your list of agenda files.
18891 If you later use @kbd{C-c a ?} to regenerate the view, only the current
18892 agenda files will be searched.} using @kbd{C-c a ?}.
18894 @node History and acknowledgments
18895 @appendix History and acknowledgments
18896 @cindex acknowledgments
18897 @cindex history
18898 @cindex thanks
18900 @section From Carsten
18902 Org was born in 2003, out of frustration over the user interface of the Emacs
18903 Outline mode.  I was trying to organize my notes and projects, and using
18904 Emacs seemed to be the natural way to go.  However, having to remember eleven
18905 different commands with two or three keys per command, only to hide and show
18906 parts of the outline tree, that seemed entirely unacceptable to me.  Also,
18907 when using outlines to take notes, I constantly wanted to restructure the
18908 tree, organizing it parallel to my thoughts and plans.  @emph{Visibility
18909 cycling} and @emph{structure editing} were originally implemented in the
18910 package @file{outline-magic.el}, but quickly moved to the more general
18911 @file{org.el}.  As this environment became comfortable for project planning,
18912 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
18913 @emph{table support}.  These areas highlighted the two main goals that Org
18914 still has today: to be a new, outline-based, plain text mode with innovative
18915 and intuitive editing features, and to incorporate project planning
18916 functionality directly into a notes file.
18918 Since the first release, literally thousands of emails to me or to
18919 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
18920 reports, feedback, new ideas, and sometimes patches and add-on code.
18921 Many thanks to everyone who has helped to improve this package.  I am
18922 trying to keep here a list of the people who had significant influence
18923 in shaping one or more aspects of Org.  The list may not be
18924 complete, if I have forgotten someone, please accept my apologies and
18925 let me know.
18927 Before I get to this list, a few special mentions are in order:
18929 @table @i
18930 @item Bastien Guerry
18931 Bastien has written a large number of extensions to Org (most of them
18932 integrated into the core by now), including the @LaTeX{} exporter and the
18933 plain list parser.  His support during the early days was central to the
18934 success of this project.  Bastien also invented Worg, helped establishing the
18935 Web presence of Org, and sponsored hosting costs for the orgmode.org website.
18936 Bastien stepped in as maintainer of Org between 2011 and 2013, at a time when
18937 I desparately needed a break.
18938 @item Eric Schulte and Dan Davison
18939 Eric and Dan are jointly responsible for the Org-babel system, which turns
18940 Org into a multi-language environment for evaluating code and doing literate
18941 programming and reproducible research.  This has become one of Org's killer
18942 features that define what Org is today.
18943 @item John Wiegley
18944 John has contributed a number of great ideas and patches directly to Org,
18945 including the attachment system (@file{org-attach.el}), integration with
18946 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
18947 items, habit tracking (@file{org-habits.el}), and encryption
18948 (@file{org-crypt.el}).  Also, the capture system is really an extended copy
18949 of his great @file{remember.el}.
18950 @item Sebastian Rose
18951 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
18952 of an ignorant amateur.  Sebastian has pushed this part of Org onto a much
18953 higher level.  He also wrote @file{org-info.js}, a Java script for displaying
18954 web pages derived from Org using an Info-like or a folding interface with
18955 single-key navigation.
18956 @end table
18958 @noindent See below for the full list of contributions!  Again, please
18959 let me know what I am missing here!
18961 @section From Bastien
18963 I (Bastien) have been maintaining Org between 2011 and 2013.  This appendix
18964 would not be complete without adding a few more acknowledgements and thanks.
18966 I am first grateful to Carsten for his trust while handing me over the
18967 maintainership of Org.  His unremitting support is what really helped me
18968 getting more confident over time, with both the community and the code.
18970 When I took over maintainership, I knew I would have to make Org more
18971 collaborative than ever, as I would have to rely on people that are more
18972 knowledgeable than I am on many parts of the code.  Here is a list of the
18973 persons I could rely on, they should really be considered co-maintainers,
18974 either of the code or the community:
18976 @table @i
18977 @item Eric Schulte
18978 Eric is maintaining the Babel parts of Org.  His reactivity here kept me away
18979 from worrying about possible bugs here and let me focus on other parts.
18981 @item Nicolas Goaziou
18982 Nicolas is maintaining the consistency of the deepest parts of Org.  His work
18983 on @file{org-element.el} and @file{ox.el} has been outstanding, and it opened
18984 the doors for many new ideas and features.  He rewrote many of the old
18985 exporters to use the new export engine, and helped with documenting this
18986 major change.  More importantly (if that's possible), he has been more than
18987 reliable during all the work done for Org 8.0, and always very reactive on
18988 the mailing list.
18990 @item Achim Gratz
18991 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
18992 into a flexible and conceptually clean process.  He patiently coped with the
18993 many hiccups that such a change can create for users.
18995 @item Nick Dokos
18996 The Org mode mailing list would not be such a nice place without Nick, who
18997 patiently helped users so many times.  It is impossible to overestimate such
18998 a great help, and the list would not be so active without him.
18999 @end table
19001 I received support from so many users that it is clearly impossible to be
19002 fair when shortlisting a few of them, but Org's history would not be
19003 complete if the ones above were not mentioned in this manual.
19005 @section List of contributions
19007 @itemize @bullet
19009 @item
19010 @i{Russel Adams} came up with the idea for drawers.
19011 @item
19012 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
19013 feedback on many features and several patches.
19014 @item
19015 @i{Luis Anaya} wrote @file{ox-man.el}.
19016 @item
19017 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
19018 @item
19019 @i{Michael Brand} helped by reporting many bugs and testing many features.
19020 He also implemented the distinction between empty fields and 0-value fields
19021 in Org's spreadsheets.
19022 @item
19023 @i{Christophe Bataillon} created the great unicorn logo that we use on the
19024 Org mode website.
19025 @item
19026 @i{Alex Bochannek} provided a patch for rounding timestamps.
19027 @item
19028 @i{Jan Böcker} wrote @file{org-docview.el}.
19029 @item
19030 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
19031 @item
19032 @i{Tom Breton} wrote @file{org-choose.el}.
19033 @item
19034 @i{Charles Cave}'s suggestion sparked the implementation of templates
19035 for Remember, which are now templates for capture.
19036 @item
19037 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
19038 specified time.
19039 @item
19040 @i{Gregory Chernov} patched support for Lisp forms into table
19041 calculations and improved XEmacs compatibility, in particular by porting
19042 @file{nouline.el} to XEmacs.
19043 @item
19044 @i{Sacha Chua} suggested copying some linking code from Planner, and helped
19045 make Org pupular through her blog.
19046 @item
19047 @i{Toby S. Cubitt} contributed to the code for clock formats.
19048 @item
19049 @i{Baoqiu Cui} contributed the first DocBook exporter.  In Org 8.0, we go a
19050 different route: you can now export to Texinfo and export the @file{.texi}
19051 file to DocBook using @code{makeinfo}.
19052 @item
19053 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
19054 came up with the idea of properties, and that there should be an API for
19055 them.
19056 @item
19057 @i{Nick Dokos} tracked down several nasty bugs.
19058 @item
19059 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
19060 inspired some of the early development, including HTML export.  He also
19061 asked for a way to narrow wide table columns.
19062 @item
19063 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
19064 several years now.  He also sponsored the hosting costs until Rackspace
19065 started to host us for free.
19066 @item
19067 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
19068 the Org-Babel documentation into the manual.
19069 @item
19070 @i{Christian Egli} converted the documentation into Texinfo format, inspired
19071 the agenda, patched CSS formatting into the HTML exporter, and wrote
19072 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
19073 @file{ox-taskjuggler.el} for Org 8.0.
19074 @item
19075 @i{David Emery} provided a patch for custom CSS support in exported
19076 HTML agendas.
19077 @item
19078 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
19079 @item
19080 @i{Nic Ferrier} contributed mailcap and XOXO support.
19081 @item
19082 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
19083 @item
19084 @i{John Foerch} figured out how to make incremental search show context
19085 around a match in a hidden outline tree.
19086 @item
19087 @i{Raimar Finken} wrote @file{org-git-line.el}.
19088 @item
19089 @i{Mikael Fornius} works as a mailing list moderator.
19090 @item
19091 @i{Austin Frank} works as a mailing list moderator.
19092 @item
19093 @i{Eric Fraga} drove the development of BEAMER export with ideas and
19094 testing.
19095 @item
19096 @i{Barry Gidden} did proofreading the manual in preparation for the book
19097 publication through Network Theory Ltd.
19098 @item
19099 @i{Niels Giesen} had the idea to automatically archive DONE trees.
19100 @item
19101 @i{Nicolas Goaziou} rewrote much of the plain list code.  He also wrote
19102 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
19103 in implementing a clean framework for Org exporters.
19104 @item
19105 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
19106 @item
19107 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
19108 book.
19109 @item
19110 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
19111 task state change logging, and the clocktable.  His clear explanations have
19112 been critical when we started to adopt the Git version control system.
19113 @item
19114 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
19115 patches.
19116 @item
19117 @i{Phil Jackson} wrote @file{org-irc.el}.
19118 @item
19119 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
19120 folded entries, and column view for properties.
19121 @item
19122 @i{Matt Jones} wrote @i{MobileOrg Android}.
19123 @item
19124 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
19125 @item
19126 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
19127 @item
19128 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it.  He also
19129 provided frequent feedback and some patches.
19130 @item
19131 @i{Matt Lundin} has proposed last-row references for table formulas and named
19132 invisible anchors.  He has also worked a lot on the FAQ.
19133 @item
19134 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
19135 and is a prolific contributor on the mailing list with competent replies,
19136 small fixes and patches.
19137 @item
19138 @i{Jason F. McBrayer} suggested agenda export to CSV format.
19139 @item
19140 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
19141 @item
19142 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
19143 basis.
19144 @item
19145 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
19146 happy.
19147 @item
19148 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
19149 @item
19150 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
19151 and being able to quickly restrict the agenda to a subtree.
19152 @item
19153 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
19154 @item
19155 @i{Greg Newman} refreshed the unicorn logo into its current form.
19156 @item
19157 @i{Tim O'Callaghan} suggested in-file links, search options for general
19158 file links, and TAGS.
19159 @item
19160 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
19161 version of the reference card.
19162 @item
19163 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
19164 into Japanese.
19165 @item
19166 @i{Oliver Oppitz} suggested multi-state TODO items.
19167 @item
19168 @i{Scott Otterson} sparked the introduction of descriptive text for
19169 links, among other things.
19170 @item
19171 @i{Pete Phillips} helped during the development of the TAGS feature, and
19172 provided frequent feedback.
19173 @item
19174 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
19175 generation.
19176 @item
19177 @i{Martin Pohlack} provided the code snippet to bundle character insertion
19178 into bundles of 20 for undo.
19179 @item
19180 @i{Rackspace.com} is hosting our website for free.  Thank you Rackspace!
19181 @item
19182 @i{T.V. Raman} reported bugs and suggested improvements.
19183 @item
19184 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
19185 control.
19186 @item
19187 @i{Paul Rivier} provided the basic implementation of named footnotes.  He
19188 also acted as mailing list moderator for some time.
19189 @item
19190 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
19191 @item
19192 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
19193 conflict with @file{allout.el}.
19194 @item
19195 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
19196 extensive patches.
19197 @item
19198 @i{Philip Rooke} created the Org reference card, provided lots
19199 of feedback, developed and applied standards to the Org documentation.
19200 @item
19201 @i{Christian Schlauer} proposed angular brackets around links, among
19202 other things.
19203 @item
19204 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
19205 enjoy folding in non-org buffers by using Org headlines in comments.
19206 @item
19207 @i{Paul Sexton} wrote @file{org-ctags.el}.
19208 @item
19209 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
19210 @file{organizer-mode.el}.
19211 @item
19212 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
19213 examples, and remote highlighting for referenced code lines.
19214 @item
19215 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
19216 now packaged into Org's @file{contrib} directory.
19217 @item
19218 @i{Daniel Sinder} came up with the idea of internal archiving by locking
19219 subtrees.
19220 @item
19221 @i{Dale Smith} proposed link abbreviations.
19222 @item
19223 @i{James TD Smith} has contributed a large number of patches for useful
19224 tweaks and features.
19225 @item
19226 @i{Adam Spiers} asked for global linking commands, inspired the link
19227 extension system, added support for mairix, and proposed the mapping API.
19228 @item
19229 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
19230 @LaTeX{}, UTF-8, Latin-1 and ASCII.
19231 @item
19232 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
19233 with links transformation to Org syntax.
19234 @item
19235 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
19236 chapter about publishing.
19237 @item
19238 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
19239 @item
19240 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
19241 enabled source code highlighting in Gnus.
19242 @item
19243 @i{Stefan Vollmar} organized a video-recorded talk at the
19244 Max-Planck-Institute for Neurology.  He also inspired the creation of a
19245 concept index for HTML export.
19246 @item
19247 @i{J@"urgen Vollmer} contributed code generating the table of contents
19248 in HTML output.
19249 @item
19250 @i{Samuel Wales} has provided important feedback and bug reports.
19251 @item
19252 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
19253 keyword.
19254 @item
19255 @i{David Wainberg} suggested archiving, and improvements to the linking
19256 system.
19257 @item
19258 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
19259 linking to Gnus.
19260 @item
19261 @i{Roland Winkler} requested additional key bindings to make Org
19262 work on a tty.
19263 @item
19264 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
19265 and contributed various ideas and code snippets.
19266 @end itemize
19269 @node GNU Free Documentation License
19270 @appendix GNU Free Documentation License
19271 @include doclicense.texi
19274 @node Main Index
19275 @unnumbered Concept index
19277 @printindex cp
19279 @node Key Index
19280 @unnumbered Key index
19282 @printindex ky
19284 @node Command and Function Index
19285 @unnumbered Command and function index
19287 @printindex fn
19289 @node Variable Index
19290 @unnumbered Variable index
19292 This is not a complete index of variables and faces, only the ones that are
19293 mentioned in the manual.  For a more complete list, use @kbd{M-x
19294 org-customize @key{RET}} and then click yourself through the tree.
19296 @printindex vr
19298 @bye
19300 @c Local variables:
19301 @c fill-column: 77
19302 @c indent-tabs-mode: nil
19303 @c paragraph-start:    "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[  ]*$"
19304 @c paragraph-separate: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[       \f]*$"
19305 @c End:
19308 @c  LocalWords:  webdavhost pre