ox-html: Use upstream MathJax CDN
[org-mode.git] / doc / org.texi
blobc0ea6626e4509f150bccedef0b5eda51a353c948
1 \input texinfo
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--2014 Free Software Foundation, Inc.
264 @quotation
265 Permission is granted to copy, distribute and/or modify this document
266 under the terms of the GNU Free Documentation License, Version 1.3 or
267 any later version published by the Free Software Foundation; with no
268 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
269 and with the Back-Cover Texts as in (a) below.  A copy of the license
270 is included in the section entitled ``GNU Free Documentation License.''
272 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
273 modify this GNU manual.''
274 @end quotation
275 @end copying
277 @dircategory Emacs editing modes
278 @direntry
279 * Org Mode: (org).      Outline-based notes management and organizer
280 @end direntry
282 @titlepage
283 @title The Org Manual
285 @subtitle Release @value{VERSION}
286 @author by Carsten Dominik
287 with contributions by 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 groups::                  Use one tag to search for several 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.
2010 @end table
2012 @node Orgstruct mode
2013 @section The Orgstruct minor mode
2014 @cindex Orgstruct mode
2015 @cindex minor mode for structure editing
2017 If you like the intuitive way the Org mode structure editing and list
2018 formatting works, you might want to use these commands in other modes like
2019 Text mode or Mail mode as well.  The minor mode @code{orgstruct-mode} makes
2020 this possible.   Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2021 turn it on by default, for example in Message mode, with one of:
2023 @lisp
2024 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2025 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2026 @end lisp
2028 When this mode is active and the cursor is on a line that looks to Org like a
2029 headline or the first line of a list item, most structure editing commands
2030 will work, even if the same keys normally have different functionality in the
2031 major mode you are using.  If the cursor is not in one of those special
2032 lines, Orgstruct mode lurks silently in the shadows.
2034 When you use @code{orgstruct++-mode}, Org will also export indentation and
2035 autofill settings into that mode, and detect item context after the first
2036 line of an item.
2038 @vindex orgstruct-heading-prefix-regexp
2039 You can also use Org structure editing to fold and unfold headlines in
2040 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2041 the regular expression must match the local prefix to use before Org's
2042 headlines.  For example, if you set this variable to @code{";; "} in Emacs
2043 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2044 commented lines.  Some commands like @code{org-demote} are disabled when the
2045 prefix is set, but folding/unfolding will work correctly.
2047 @node Org syntax
2048 @section Org syntax
2049 @cindex Org syntax
2051 A reference document providing a formal description of Org's syntax is
2052 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2053 Worg}, written and maintained by Nicolas Goaziou.  It defines Org's core
2054 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2055 keywords}, @code{(greater) elements} and @code{objects}.  Each part of an Org
2056 file falls into one of the categories above.
2058 To explore the abstract structure of an Org buffer, run this in a buffer:
2060 @lisp
2061 M-: (org-element-parse-buffer) RET
2062 @end lisp
2064 It will output a list containing the buffer's content represented as an
2065 abstract structure.  The export engine relies on the information stored in
2066 this list.  Most interactive commands (e.g., for structure editing) also
2067 rely on the syntactic meaning of the surrounding context.
2069 @node Tables
2070 @chapter Tables
2071 @cindex tables
2072 @cindex editing tables
2074 Org comes with a fast and intuitive table editor.  Spreadsheet-like
2075 calculations are supported using the Emacs @file{calc} package
2076 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2078 @menu
2079 * Built-in table editor::       Simple tables
2080 * Column width and alignment::  Overrule the automatic settings
2081 * Column groups::               Grouping to trigger vertical lines
2082 * Orgtbl mode::                 The table editor as minor mode
2083 * The spreadsheet::             The table editor has spreadsheet capabilities
2084 * Org-Plot::                    Plotting from org tables
2085 @end menu
2087 @node Built-in table editor
2088 @section The built-in table editor
2089 @cindex table editor, built-in
2091 Org makes it easy to format tables in plain ASCII@.  Any line with @samp{|} as
2092 the first non-whitespace character is considered part of a table.  @samp{|}
2093 is also the column separator@footnote{To insert a vertical bar into a table
2094 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}.  A table
2095 might look like this:
2097 @example
2098 | Name  | Phone | Age |
2099 |-------+-------+-----|
2100 | Peter |  1234 |  17 |
2101 | Anna  |  4321 |  25 |
2102 @end example
2104 A table is re-aligned automatically each time you press @key{TAB} or
2105 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
2106 the next field (@key{RET} to the next row) and creates new table rows
2107 at the end of the table or before horizontal lines.  The indentation
2108 of the table is set by the first line.  Any line starting with
2109 @samp{|-} is considered as a horizontal separator line and will be
2110 expanded on the next re-align to span the whole table width.  So, to
2111 create the above table, you would only type
2113 @example
2114 |Name|Phone|Age|
2116 @end example
2118 @noindent and then press @key{TAB} to align the table and start filling in
2119 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
2120 @kbd{C-c @key{RET}}.
2122 @vindex org-enable-table-editor
2123 @vindex org-table-auto-blank-field
2124 When typing text into a field, Org treats @key{DEL},
2125 @key{Backspace}, and all character keys in a special way, so that
2126 inserting and deleting avoids shifting other fields.  Also, when
2127 typing @emph{immediately after the cursor was moved into a new field
2128 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2129 field is automatically made blank.  If this behavior is too
2130 unpredictable for you, configure the options
2131 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2133 @table @kbd
2134 @tsubheading{Creation and conversion}
2135 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2136 Convert the active region to a table.  If every line contains at least one
2137 TAB character, the function assumes that the material is tab separated.
2138 If every line contains a comma, comma-separated values (CSV) are assumed.
2139 If not, lines are split at whitespace into fields.  You can use a prefix
2140 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2141 C-u} forces TAB, @kbd{C-u C-u C-u} will prompt for a regular expression to
2142 match the separator, and a numeric argument N indicates that at least N
2143 consecutive spaces, or alternatively a TAB will be the separator.
2145 If there is no active region, this command creates an empty Org
2146 table.  But it is easier just to start typing, like
2147 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2149 @tsubheading{Re-aligning and field motion}
2150 @orgcmd{C-c C-c,org-table-align}
2151 Re-align the table and don't move to another field.
2153 @orgcmd{C-c SPC,org-table-blank-field}
2154 Blank the field at point.
2156 @orgcmd{<TAB>,org-table-next-field}
2157 Re-align the table, move to the next field.  Creates a new row if
2158 necessary.
2160 @orgcmd{S-@key{TAB},org-table-previous-field}
2161 Re-align, move to previous field.
2163 @orgcmd{@key{RET},org-table-next-row}
2164 Re-align the table and move down to next row.  Creates a new row if
2165 necessary.  At the beginning or end of a line, @key{RET} still does
2166 NEWLINE, so it can be used to split a table.
2168 @orgcmd{M-a,org-table-beginning-of-field}
2169 Move to beginning of the current table field, or on to the previous field.
2170 @orgcmd{M-e,org-table-end-of-field}
2171 Move to end of the current table field, or on to the next field.
2173 @tsubheading{Column and row editing}
2174 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2175 Move the current column left/right.
2177 @orgcmd{M-S-@key{left},org-table-delete-column}
2178 Kill the current column.
2180 @orgcmd{M-S-@key{right},org-table-insert-column}
2181 Insert a new column to the left of the cursor position.
2183 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2184 Move the current row up/down.
2186 @orgcmd{M-S-@key{up},org-table-kill-row}
2187 Kill the current row or horizontal line.
2189 @orgcmd{M-S-@key{down},org-table-insert-row}
2190 Insert a new row above the current row.  With a prefix argument, the line is
2191 created below the current one.
2193 @orgcmd{C-c -,org-table-insert-hline}
2194 Insert a horizontal line below current row.  With a prefix argument, the line
2195 is created above the current line.
2197 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2198 Insert a horizontal line below current row, and move the cursor into the row
2199 below that line.
2201 @orgcmd{C-c ^,org-table-sort-lines}
2202 Sort the table lines in the region.  The position of point indicates the
2203 column to be used for sorting, and the range of lines is the range
2204 between the nearest horizontal separator lines, or the entire table.  If
2205 point is before the first column, you will be prompted for the sorting
2206 column.  If there is an active region, the mark specifies the first line
2207 and the sorting column, while point should be in the last line to be
2208 included into the sorting.  The command prompts for the sorting type
2209 (alphabetically, numerically, or by time).  You can sort in normal or
2210 reverse order.  You can also supply your own key extraction and comparison
2211 functions.  When called with a prefix argument, alphabetic sorting will be
2212 case-sensitive.
2214 @tsubheading{Regions}
2215 @orgcmd{C-c C-x M-w,org-table-copy-region}
2216 Copy a rectangular region from a table to a special clipboard.  Point and
2217 mark determine edge fields of the rectangle.  If there is no active region,
2218 copy just the current field.  The process ignores horizontal separator lines.
2220 @orgcmd{C-c C-x C-w,org-table-cut-region}
2221 Copy a rectangular region from a table to a special clipboard, and
2222 blank all fields in the rectangle.  So this is the ``cut'' operation.
2224 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2225 Paste a rectangular region into a table.
2226 The upper left corner ends up in the current field.  All involved fields
2227 will be overwritten.  If the rectangle does not fit into the present table,
2228 the table is enlarged as needed.  The process ignores horizontal separator
2229 lines.
2231 @orgcmd{M-@key{RET},org-table-wrap-region}
2232 Split the current field at the cursor position and move the rest to the line
2233 below.  If there is an active region, and both point and mark are in the same
2234 column, the text in the column is wrapped to minimum width for the given
2235 number of lines.  A numeric prefix argument may be used to change the number
2236 of desired lines.  If there is no region, but you specify a prefix argument,
2237 the current field is made blank, and the content is appended to the field
2238 above.
2240 @tsubheading{Calculations}
2241 @cindex formula, in tables
2242 @cindex calculations, in tables
2243 @cindex region, active
2244 @cindex active region
2245 @cindex transient mark mode
2246 @orgcmd{C-c +,org-table-sum}
2247 Sum the numbers in the current column, or in the rectangle defined by
2248 the active region.  The result is shown in the echo area and can
2249 be inserted with @kbd{C-y}.
2251 @orgcmd{S-@key{RET},org-table-copy-down}
2252 @vindex org-table-copy-increment
2253 When current field is empty, copy from first non-empty field above.  When not
2254 empty, copy current field down to next row and move cursor along with it.
2255 Depending on the option @code{org-table-copy-increment}, integer field
2256 values will be incremented during copy.  Integers that are too large will not
2257 be incremented.  Also, a @code{0} prefix argument temporarily disables the
2258 increment.  This key is also used by shift-selection and related modes
2259 (@pxref{Conflicts}).
2261 @tsubheading{Miscellaneous}
2262 @orgcmd{C-c `,org-table-edit-field}
2263 Edit the current field in a separate window.  This is useful for fields that
2264 are not fully visible (@pxref{Column width and alignment}).  When called with
2265 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2266 edited in place.  When called with two @kbd{C-u} prefixes, make the editor
2267 window follow the cursor through the table and always show the current
2268 field.  The follow mode exits automatically when the cursor leaves the table,
2269 or when you repeat this command with @kbd{C-u C-u C-c `}.
2271 @item M-x org-table-import RET
2272 Import a file as a table.  The table should be TAB or whitespace
2273 separated.  Use, for example, to import a spreadsheet table or data
2274 from a database, because these programs generally can write
2275 TAB-separated text files.  This command works by inserting the file into
2276 the buffer and then converting the region to a table.  Any prefix
2277 argument is passed on to the converter, which uses it to determine the
2278 separator.
2279 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2280 Tables can also be imported by pasting tabular text into the Org
2281 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2282 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2284 @item M-x org-table-export RET
2285 @findex org-table-export
2286 @vindex org-table-export-default-format
2287 Export the table, by default as a TAB-separated file.  Use for data
2288 exchange with, for example, spreadsheet or database programs.  The format
2289 used to export the file can be configured in the option
2290 @code{org-table-export-default-format}.  You may also use properties
2291 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2292 name and the format for table export in a subtree.  Org supports quite
2293 general formats for exported tables.  The exporter format is the same as the
2294 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2295 detailed description.
2296 @end table
2298 If you don't like the automatic table editor because it gets in your
2299 way on lines which you would like to start with @samp{|}, you can turn
2300 it off with
2302 @lisp
2303 (setq org-enable-table-editor nil)
2304 @end lisp
2306 @noindent Then the only table command that still works is
2307 @kbd{C-c C-c} to do a manual re-align.
2309 @node Column width and alignment
2310 @section Column width and alignment
2311 @cindex narrow columns in tables
2312 @cindex alignment in tables
2314 The width of columns is automatically determined by the table editor.  And
2315 also the alignment of a column is determined automatically from the fraction
2316 of number-like versus non-number fields in the column.
2318 Sometimes a single field or a few fields need to carry more text, leading to
2319 inconveniently wide columns.  Or maybe you want to make a table with several
2320 columns having a fixed width, regardless of content.  To set@footnote{This
2321 feature does not work on XEmacs.} the width of a column, one field anywhere
2322 in the column may contain just the string @samp{<N>} where @samp{N} is an
2323 integer specifying the width of the column in characters.  The next re-align
2324 will then set the width of this column to this value.
2326 @example
2327 @group
2328 |---+------------------------------|               |---+--------|
2329 |   |                              |               |   | <6>    |
2330 | 1 | one                          |               | 1 | one    |
2331 | 2 | two                          |     ----\     | 2 | two    |
2332 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
2333 | 4 | four                         |               | 4 | four   |
2334 |---+------------------------------|               |---+--------|
2335 @end group
2336 @end example
2338 @noindent
2339 Fields that are wider become clipped and end in the string @samp{=>}.
2340 Note that the full text is still in the buffer but is hidden.
2341 To see the full text, hold the mouse over the field---a tool-tip window
2342 will show the full content.  To edit such a field, use the command
2343 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
2344 open a new window with the full field.  Edit it and finish with @kbd{C-c
2345 C-c}.
2347 @vindex org-startup-align-all-tables
2348 When visiting a file containing a table with narrowed columns, the
2349 necessary character hiding has not yet happened, and the table needs to
2350 be aligned before it looks nice.  Setting the option
2351 @code{org-startup-align-all-tables} will realign all tables in a file
2352 upon visiting, but also slow down startup.  You can also set this option
2353 on a per-file basis with:
2355 @example
2356 #+STARTUP: align
2357 #+STARTUP: noalign
2358 @end example
2360 If you would like to overrule the automatic alignment of number-rich columns
2361 to the right and of string-rich column to the left, you can use @samp{<r>},
2362 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2363 effect when exporting to HTML.} or @samp{<l>} in a similar fashion.  You may
2364 also combine alignment and field width like this: @samp{<r10>}.
2366 Lines which only contain these formatting cookies will be removed
2367 automatically when exporting the document.
2369 @node Column groups
2370 @section Column groups
2371 @cindex grouping columns in tables
2373 When Org exports tables, it does so by default without vertical
2374 lines because that is visually more satisfying in general.  Occasionally
2375 however, vertical lines can be useful to structure a table into groups
2376 of columns, much like horizontal lines can do for groups of rows.  In
2377 order to specify column groups, you can use a special row where the
2378 first field contains only @samp{/}.  The further fields can either
2379 contain @samp{<} to indicate that this column should start a group,
2380 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2381 and @samp{>}) to make a column
2382 a group of its own.  Boundaries between column groups will upon export be
2383 marked with vertical lines.  Here is an example:
2385 @example
2386 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2387 |---+-----+-----+-----+---------+------------|
2388 | / |   < |     |   > |       < |          > |
2389 | 1 |   1 |   1 |   1 |       1 |          1 |
2390 | 2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
2391 | 3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
2392 |---+-----+-----+-----+---------+------------|
2393 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2394 @end example
2396 It is also sufficient to just insert the column group starters after
2397 every vertical line you would like to have:
2399 @example
2400 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2401 |----+-----+-----+-----+---------+------------|
2402 | /  | <   |     |     | <       |            |
2403 @end example
2405 @node Orgtbl mode
2406 @section The Orgtbl minor mode
2407 @cindex Orgtbl mode
2408 @cindex minor mode for tables
2410 If you like the intuitive way the Org table editor works, you
2411 might also want to use it in other modes like Text mode or Mail mode.
2412 The minor mode Orgtbl mode makes this possible.  You can always toggle
2413 the mode with @kbd{M-x orgtbl-mode RET}.  To turn it on by default, for
2414 example in Message mode, use
2416 @lisp
2417 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2418 @end lisp
2420 Furthermore, with some special setup, it is possible to maintain tables
2421 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
2422 construct @LaTeX{} tables with the underlying ease and power of
2423 Orgtbl mode, including spreadsheet capabilities.  For details, see
2424 @ref{Tables in arbitrary syntax}.
2426 @node The spreadsheet
2427 @section The spreadsheet
2428 @cindex calculations, in tables
2429 @cindex spreadsheet capabilities
2430 @cindex @file{calc} package
2432 The table editor makes use of the Emacs @file{calc} package to implement
2433 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
2434 derive fields from other fields.  While fully featured, Org's implementation
2435 is not identical to other spreadsheets.  For example, Org knows the concept
2436 of a @emph{column formula} that will be applied to all non-header fields in a
2437 column without having to copy the formula to each relevant field.  There is
2438 also a formula debugger, and a formula editor with features for highlighting
2439 fields in the table corresponding to the references at the point in the
2440 formula, moving these references by arrow keys
2442 @menu
2443 * References::                  How to refer to another field or range
2444 * Formula syntax for Calc::     Using Calc to compute stuff
2445 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
2446 * Durations and time values::   How to compute durations and time values
2447 * Field and range formulas::    Formula for specific (ranges of) fields
2448 * Column formulas::             Formulas valid for an entire column
2449 * Lookup functions::            Lookup functions for searching tables
2450 * Editing and debugging formulas::  Fixing formulas
2451 * Updating the table::          Recomputing all dependent fields
2452 * Advanced features::           Field and column names, parameters and automatic recalc
2453 @end menu
2455 @node References
2456 @subsection References
2457 @cindex references
2459 To compute fields in the table from other fields, formulas must
2460 reference other fields or ranges.  In Org, fields can be referenced
2461 by name, by absolute coordinates, and by relative coordinates.  To find
2462 out what the coordinates of a field are, press @kbd{C-c ?} in that
2463 field, or press @kbd{C-c @}} to toggle the display of a grid.
2465 @subsubheading Field references
2466 @cindex field references
2467 @cindex references, to fields
2469 Formulas can reference the value of another field in two ways.  Like in
2470 any other spreadsheet, you may reference fields with a letter/number
2471 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2472 @vindex org-table-use-standard-references
2473 However, Org prefers@footnote{Org will understand references typed by the
2474 user as @samp{B4}, but it will not use this syntax when offering a formula
2475 for editing.  You can customize this behavior using the option
2476 @code{org-table-use-standard-references}.} to use another, more general
2477 representation that looks like this:
2478 @example
2479 @@@var{row}$@var{column}
2480 @end example
2482 Column specifications can be absolute like @code{$1},
2483 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2484 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2485 @code{$<} and @code{$>} are immutable references to the first and last
2486 column, respectively, and you can use @code{$>>>} to indicate the third
2487 column from the right.
2489 The row specification only counts data lines and ignores horizontal separator
2490 lines (hlines).  Like with columns, you can use absolute row numbers
2491 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2492 current row like @code{@@+3} or @code{@@-1}.  @code{@@<} and @code{@@>} are
2493 immutable references the first and last@footnote{For backward compatibility
2494 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2495 a stable way to the 5th and 12th field in the last row of the table.
2496 However, this syntax is deprecated, it should not be used for new documents.
2497 Use @code{@@>$} instead.} row in the table, respectively.  You may also
2498 specify the row relative to one of the hlines: @code{@@I} refers to the first
2499 hline, @code{@@II} to the second, etc.  @code{@@-I} refers to the first such
2500 line above the current line, @code{@@+I} to the first such line below the
2501 current line.  You can also write @code{@@III+2} which is the second data line
2502 after the third hline in the table.
2504 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2505 i.e., to the row/column for the field being computed.  Also, if you omit
2506 either the column or the row part of the reference, the current row/column is
2507 implied.
2509 Org's references with @emph{unsigned} numbers are fixed references
2510 in the sense that if you use the same reference in the formula for two
2511 different fields, the same field will be referenced each time.
2512 Org's references with @emph{signed} numbers are floating
2513 references because the same reference operator can reference different
2514 fields depending on the field being calculated by the formula.
2516 Here are a few examples:
2518 @example
2519 @@2$3      @r{2nd row, 3rd column (same as @code{C2})}
2520 $5        @r{column 5 in the current row (same as @code{E&})}
2521 @@2        @r{current column, row 2}
2522 @@-1$-3    @r{the field one row up, three columns to the left}
2523 @@-I$2     @r{field just under hline above current row, column 2}
2524 @@>$5      @r{field in the last row, in column 5}
2525 @end example
2527 @subsubheading Range references
2528 @cindex range references
2529 @cindex references, to ranges
2531 You may reference a rectangular range of fields by specifying two field
2532 references connected by two dots @samp{..}.  If both fields are in the
2533 current row, you may simply use @samp{$2..$7}, but if at least one field
2534 is in a different row, you need to use the general @code{@@row$column}
2535 format at least for the first field (i.e the reference must start with
2536 @samp{@@} in order to be interpreted correctly).  Examples:
2538 @example
2539 $1..$3        @r{first three fields in the current row}
2540 $P..$Q        @r{range, using column names (see under Advanced)}
2541 $<<<..$>>     @r{start in third column, continue to the last but one}
2542 @@2$1..@@4$3    @r{6 fields between these two fields (same as @code{A2..C4})}
2543 @@-1$-2..@@-1   @r{3 fields in the row above, starting from 2 columns on the left}
2544 @@I..II        @r{between first and second hline, short for @code{@@I..@@II}}
2545 @end example
2547 @noindent Range references return a vector of values that can be fed
2548 into Calc vector functions.  Empty fields in ranges are normally suppressed,
2549 so that the vector contains only the non-empty fields.  For other options
2550 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2551 for Calc}.
2553 @subsubheading Field coordinates in formulas
2554 @cindex field coordinates
2555 @cindex coordinates, of field
2556 @cindex row, of field coordinates
2557 @cindex column, of field coordinates
2559 One of the very first actions during evaluation of Calc formulas and Lisp
2560 formulas is to substitute @code{@@#} and @code{$#} in the formula with the
2561 row or column number of the field where the current result will go to.  The
2562 traditional Lisp formula equivalents are @code{org-table-current-dline} and
2563 @code{org-table-current-column}.  Examples:
2565 @table @code
2566 @item if(@@# % 2, $#, string(""))
2567 Insert column number on odd rows, set field to empty on even rows.
2568 @item $2 = '(identity remote(FOO, @@@@#$1))
2569 Copy text or values of each row of column 1 of the table named @code{FOO}
2570 into column 2 of the current table.
2571 @item @@3 = 2 * remote(FOO, @@1$$#)
2572 Insert the doubled value of each column of row 1 of the table named
2573 @code{FOO} into row 3 of the current table.
2574 @end table
2576 @noindent For the second/third example, the table named @code{FOO} must have
2577 at least as many rows/columns as the current table.  Note that this is
2578 inefficient@footnote{The computation time scales as O(N^2) because the table
2579 named @code{FOO} is parsed for each field to be read.} for large number of
2580 rows/columns.
2582 @subsubheading Named references
2583 @cindex named references
2584 @cindex references, named
2585 @cindex name, of column or field
2586 @cindex constants, in calculations
2587 @cindex #+CONSTANTS
2589 @vindex org-table-formula-constants
2590 @samp{$name} is interpreted as the name of a column, parameter or
2591 constant.  Constants are defined globally through the option
2592 @code{org-table-formula-constants}, and locally (for the file) through a
2593 line like
2595 @example
2596 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2597 @end example
2599 @noindent
2600 @vindex constants-unit-system
2601 @pindex constants.el
2602 Also properties (@pxref{Properties and columns}) can be used as
2603 constants in table formulas: for a property @samp{:Xyz:} use the name
2604 @samp{$PROP_Xyz}, and the property will be searched in the current
2605 outline entry and in the hierarchy above it.  If you have the
2606 @file{constants.el} package, it will also be used to resolve constants,
2607 including natural constants like @samp{$h} for Planck's constant, and
2608 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2609 supply the values of constants in two different unit systems, @code{SI}
2610 and @code{cgs}.  Which one is used depends on the value of the variable
2611 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
2612 @code{constSI} and @code{constcgs} to set this value for the current
2613 buffer.}.  Column names and parameters can be specified in special table
2614 lines.  These are described below, see @ref{Advanced features}.  All
2615 names must start with a letter, and further consist of letters and
2616 numbers.
2618 @subsubheading Remote references
2619 @cindex remote references
2620 @cindex references, remote
2621 @cindex references, to a different table
2622 @cindex name, of column or field
2623 @cindex constants, in calculations
2624 @cindex #+NAME, for table
2626 You may also reference constants, fields and ranges from a different table,
2627 either in the current file or even in a different file.  The syntax is
2629 @example
2630 remote(NAME-OR-ID,REF)
2631 @end example
2633 @noindent
2634 where NAME can be the name of a table in the current file as set by a
2635 @code{#+NAME: Name} line before the table.  It can also be the ID of an
2636 entry, even in a different file, and the reference then refers to the first
2637 table in that entry.  REF is an absolute field or range reference as
2638 described above for example @code{@@3$3} or @code{$somename}, valid in the
2639 referenced table.
2641 Indirection of NAME-OR-ID: When NAME-OR-ID has the format @code{@@ROW$COLUMN}
2642 it will be substituted with the name or ID found in this field of the current
2643 table.  For example @code{remote($1, @@>$2)} => @code{remote(year_2013,
2644 @@>$1)}.  The format @code{B3} is not supported because it can not be
2645 distinguished from a plain table name or ID.
2647 @node Formula syntax for Calc
2648 @subsection Formula syntax for Calc
2649 @cindex formula syntax, Calc
2650 @cindex syntax, of formulas
2652 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2653 package.  Note that @file{calc} has the non-standard convention that @samp{/}
2654 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2655 @samp{a/(b*c)}.  Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2656 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2657 GNU Emacs Calc Manual}), variable substitution takes place according to the
2658 rules described above.
2659 @cindex vectors, in table calculations
2660 The range vectors can be directly fed into the Calc vector functions
2661 like @samp{vmean} and @samp{vsum}.
2663 @cindex format specifier
2664 @cindex mode, for @file{calc}
2665 @vindex org-calc-default-modes
2666 A formula can contain an optional mode string after a semicolon.  This
2667 string consists of flags to influence Calc and other modes during
2668 execution.  By default, Org uses the standard Calc modes (precision
2669 12, angular units degrees, fraction and symbolic modes off).  The display
2670 format, however, has been changed to @code{(float 8)} to keep tables
2671 compact.  The default settings can be configured using the option
2672 @code{org-calc-default-modes}.
2674 @noindent List of modes:
2676 @table @asis
2677 @item @code{p20}
2678 Set the internal Calc calculation precision to 20 digits.
2679 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2680 Normal, scientific, engineering or fixed format of the result of Calc passed
2681 back to Org.  Calc formatting is unlimited in precision as long as the Calc
2682 calculation precision is greater.
2683 @item @code{D}, @code{R}
2684 Degree and radian angle modes of Calc.
2685 @item @code{F}, @code{S}
2686 Fraction and symbolic modes of Calc.
2687 @item @code{T}, @code{t}
2688 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2689 @item @code{E}
2690 If and how to consider empty fields.  Without @samp{E} empty fields in range
2691 references are suppressed so that the Calc vector or Lisp list contains only
2692 the non-empty fields.  With @samp{E} the empty fields are kept.  For empty
2693 fields in ranges or empty field references the value @samp{nan} (not a
2694 number) is used in Calc formulas and the empty string is used for Lisp
2695 formulas.  Add @samp{N} to use 0 instead for both formula types.  For the
2696 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2697 @item @code{N}
2698 Interpret all fields as numbers, use 0 for non-numbers.  See the next section
2699 to see how this is essential for computations with Lisp formulas.  In Calc
2700 formulas it is used only occasionally because there number strings are
2701 already interpreted as numbers without @samp{N}.
2702 @item @code{L}
2703 Literal, for Lisp formulas only.  See the next section.
2704 @end table
2706 @noindent
2707 Unless you use large integer numbers or high-precision-calculation and
2708 -display for floating point numbers you may alternatively provide a
2709 @samp{printf} format specifier to reformat the Calc result after it has been
2710 passed back to Org instead of letting Calc already do the
2711 formatting@footnote{The @samp{printf} reformatting is limited in precision
2712 because the value passed to it is converted into an @samp{integer} or
2713 @samp{double}.  The @samp{integer} is limited in size by truncating the
2714 signed value to 32 bits.  The @samp{double} is limited in precision to 64
2715 bits overall which leaves approximately 16 significant decimal digits.}.  A
2716 few examples:
2718 @example
2719 $1+$2                @r{Sum of first and second field}
2720 $1+$2;%.2f           @r{Same, format result to two decimals}
2721 exp($2)+exp($1)      @r{Math functions can be used}
2722 $0;%.1f              @r{Reformat current cell to 1 decimal}
2723 ($3-32)*5/9          @r{Degrees F -> C conversion}
2724 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
2725 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
2726 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
2727 taylor($3,x=7,2)     @r{Taylor series of $3, at x=7, second degree}
2728 @end example
2730 Calc also contains a complete set of logical operations, (@pxref{Logical
2731 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}).  For example
2733 @table @code
2734 @item if($1 < 20, teen, string(""))
2735 "teen" if age $1 is less than 20, else the Org table result field is set to
2736 empty with the empty string.
2737 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1
2738 Sum of the first two columns.  When at least one of the input fields is empty
2739 the Org table result field is set to empty.  @samp{E} is required to not
2740 convert empty fields to 0.  @samp{f-1} is an optional Calc format string
2741 similar to @samp{%.1f} but leaves empty results empty.
2742 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2743 Mean value of a range unless there is any empty field.  Every field in the
2744 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2745 in @samp{nan}.  Then @samp{typeof == 12} detects the @samp{nan} from
2746 @samp{vmean} and the Org table result field is set to empty.  Use this when
2747 the sample set is expected to never have missing values.
2748 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2749 Mean value of a range with empty fields skipped.  Every field in the range
2750 that is empty is skipped.  When all fields in the range are empty the mean
2751 value is not defined and the Org table result field is set to empty.  Use
2752 this when the sample set can have a variable size.
2753 @item vmean($1..$7); EN
2754 To complete the example before: Mean value of a range with empty fields
2755 counting as samples with value 0.  Use this only when incomplete sample sets
2756 should be padded with 0 to the full size.
2757 @end table
2759 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2760 and use them in formula syntax for Calc.
2762 @node Formula syntax for Lisp
2763 @subsection Emacs Lisp forms as formulas
2764 @cindex Lisp forms, as table formulas
2766 It is also possible to write a formula in Emacs Lisp.  This can be useful
2767 for string manipulation and control structures, if Calc's functionality is
2768 not enough.
2770 If a formula starts with a single-quote followed by an opening parenthesis,
2771 then it is evaluated as a Lisp form.  The evaluation should return either a
2772 string or a number.  Just as with @file{calc} formulas, you can specify modes
2773 and a printf format after a semicolon.
2775 With Emacs Lisp forms, you need to be conscious about the way field
2776 references are interpolated into the form.  By default, a reference will be
2777 interpolated as a Lisp string (in double-quotes) containing the field.  If
2778 you provide the @samp{N} mode switch, all referenced elements will be numbers
2779 (non-number fields will be zero) and interpolated as Lisp numbers, without
2780 quotes.  If you provide the @samp{L} flag, all fields will be interpolated
2781 literally, without quotes.  I.e., if you want a reference to be interpreted
2782 as a string by the Lisp form, enclose the reference operator itself in
2783 double-quotes, like @code{"$3"}.  Ranges are inserted as space-separated
2784 fields, so you can embed them in list or vector syntax.
2786 Here are a few examples---note how the @samp{N} mode is used when we do
2787 computations in Lisp:
2789 @table @code
2790 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2791 Swap the first two characters of the content of column 1.
2792 @item '(+ $1 $2);N
2793 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2794 @item '(apply '+ '($1..$4));N
2795 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2796 @end table
2798 @node Durations and time values
2799 @subsection Durations and time values
2800 @cindex Duration, computing
2801 @cindex Time, computing
2802 @vindex org-table-duration-custom-format
2804 If you want to compute time values use the @code{T} flag, either in Calc
2805 formulas or Elisp formulas:
2807 @example
2808 @group
2809   |  Task 1 |   Task 2 |    Total |
2810   |---------+----------+----------|
2811   |    2:12 |     1:47 | 03:59:00 |
2812   | 3:02:20 | -2:07:00 |     0.92 |
2813   #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2814 @end group
2815 @end example
2817 Input duration values must be of the form @code{HH:MM[:SS]}, where seconds
2818 are optional.  With the @code{T} flag, computed durations will be displayed
2819 as @code{HH:MM:SS} (see the first formula above).  With the @code{t} flag,
2820 computed durations will be displayed according to the value of the option
2821 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2822 will display the result as a fraction of hours (see the second formula in the
2823 example above).
2825 Negative duration values can be manipulated as well, and integers will be
2826 considered as seconds in addition and subtraction.
2828 @node Field and range formulas
2829 @subsection Field and range formulas
2830 @cindex field formula
2831 @cindex range formula
2832 @cindex formula, for individual table field
2833 @cindex formula, for range of fields
2835 To assign a formula to a particular field, type it directly into the field,
2836 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}.  When you press
2837 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2838 the formula will be stored as the formula for this field, evaluated, and the
2839 current field will be replaced with the result.
2841 @cindex #+TBLFM
2842 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2843 below the table.  If you type the equation in the 4th field of the 3rd data
2844 line in the table, the formula will look like @samp{@@3$4=$1+$2}.  When
2845 inserting/deleting/swapping columns and rows with the appropriate commands,
2846 @i{absolute references} (but not relative ones) in stored formulas are
2847 modified in order to still reference the same field.  To avoid this, in
2848 particular in range references, anchor ranges at the table borders (using
2849 @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines using the
2850 @code{@@I} notation.  Automatic adaptation of field references does of course
2851 not happen if you edit the table structure with normal editing
2852 commands---then you must fix the equations yourself.
2854 Instead of typing an equation into the field, you may also use the following
2855 command
2857 @table @kbd
2858 @orgcmd{C-u C-c =,org-table-eval-formula}
2859 Install a new formula for the current field.  The command prompts for a
2860 formula with default taken from the @samp{#+TBLFM:} line, applies
2861 it to the current field, and stores it.
2862 @end table
2864 The left-hand side of a formula can also be a special expression in order to
2865 assign the formula to a number of different fields.  There is no keyboard
2866 shortcut to enter such range formulas.  To add them, use the formula editor
2867 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2868 directly.
2870 @table @code
2871 @item $2=
2872 Column formula, valid for the entire column.  This is so common that Org
2873 treats these formulas in a special way, see @ref{Column formulas}.
2874 @item @@3=
2875 Row formula, applies to all fields in the specified row.  @code{@@>=} means
2876 the last row.
2877 @item @@1$2..@@4$3=
2878 Range formula, applies to all fields in the given rectangular range.  This
2879 can also be used to assign a formula to some but not all fields in a row.
2880 @item $name=
2881 Named field, see @ref{Advanced features}.
2882 @end table
2884 @node Column formulas
2885 @subsection Column formulas
2886 @cindex column formula
2887 @cindex formula, for table column
2889 When you assign a formula to a simple column reference like @code{$3=}, the
2890 same formula will be used in all fields of that column, with the following
2891 very convenient exceptions: (i) If the table contains horizontal separator
2892 hlines with rows above and below, everything before the first such hline is
2893 considered part of the table @emph{header} and will not be modified by column
2894 formulas.  Therefore a header is mandatory when you use column formulas and
2895 want to add hlines to group rows, like for example to separate a total row at
2896 the bottom from the summand rows above.  (ii) Fields that already get a value
2897 from a field/range formula will be left alone by column formulas.  These
2898 conditions make column formulas very easy to use.
2900 To assign a formula to a column, type it directly into any field in the
2901 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2902 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2903 the formula will be stored as the formula for the current column, evaluated
2904 and the current field replaced with the result.  If the field contains only
2905 @samp{=}, the previously stored formula for this column is used.  For each
2906 column, Org will only remember the most recently used formula.  In the
2907 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}.  The
2908 left-hand side of a column formula cannot be the name of column, it must be
2909 the numeric column reference or @code{$>}.
2911 Instead of typing an equation into the field, you may also use the
2912 following command:
2914 @table @kbd
2915 @orgcmd{C-c =,org-table-eval-formula}
2916 Install a new formula for the current column and replace current field with
2917 the result of the formula.  The command prompts for a formula, with default
2918 taken from the @samp{#+TBLFM} line, applies it to the current field and
2919 stores it.  With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2920 will apply it to that many consecutive fields in the current column.
2921 @end table
2923 @node Lookup functions
2924 @subsection Lookup functions
2925 @cindex lookup functions in tables
2926 @cindex table lookup functions
2928 Org has three predefined Emacs Lisp functions for lookups in tables.
2929 @table @code
2930 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2931 @findex org-lookup-first
2932 Searches for the first element @code{S} in list @code{S-LIST} for which
2933 @lisp
2934 (PREDICATE VAL S)
2935 @end lisp
2936 is @code{t}; returns the value from the corresponding position in list
2937 @code{R-LIST}.  The default @code{PREDICATE} is @code{equal}.  Note that the
2938 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2939 order as the corresponding parameters are in the call to
2940 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}.  If
2941 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2942 is returned.
2943 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2944 @findex org-lookup-last
2945 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2946 element for which @code{PREDICATE} is @code{t}.
2947 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2948 @findex org-lookup-all
2949 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2950 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2951 values.  This function can not be used by itself in a formula, because it
2952 returns a list of values.  However, powerful lookups can be built when this
2953 function is combined with other Emacs Lisp functions.
2954 @end table
2956 If the ranges used in these functions contain empty fields, the @code{E} mode
2957 for the formula should usually be specified: otherwise empty fields will not be
2958 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2959 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2960 element of @code{R-LIST}.
2962 These three functions can be used to implement associative arrays, count
2963 matching cells, rank results, group data etc.  For practical examples
2964 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2965 tutorial on Worg}.
2967 @node Editing and debugging formulas
2968 @subsection Editing and debugging formulas
2969 @cindex formula editing
2970 @cindex editing, of table formulas
2972 @vindex org-table-use-standard-references
2973 You can edit individual formulas in the minibuffer or directly in the field.
2974 Org can also prepare a special buffer with all active formulas of a table.
2975 When offering a formula for editing, Org converts references to the standard
2976 format (like @code{B3} or @code{D&}) if possible.  If you prefer to only work
2977 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2978 option @code{org-table-use-standard-references}.
2980 @table @kbd
2981 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2982 Edit the formula associated with the current column/field in the
2983 minibuffer.  See @ref{Column formulas}, and @ref{Field and range formulas}.
2984 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2985 Re-insert the active formula (either a
2986 field formula, or a column formula) into the current field, so that you
2987 can edit it directly in the field.  The advantage over editing in the
2988 minibuffer is that you can use the command @kbd{C-c ?}.
2989 @orgcmd{C-c ?,org-table-field-info}
2990 While editing a formula in a table field, highlight the field(s)
2991 referenced by the reference at the cursor position in the formula.
2992 @kindex C-c @}
2993 @findex org-table-toggle-coordinate-overlays
2994 @item C-c @}
2995 Toggle the display of row and column numbers for a table, using overlays
2996 (@command{org-table-toggle-coordinate-overlays}).  These are updated each
2997 time the table is aligned; you can force it with @kbd{C-c C-c}.
2998 @kindex C-c @{
2999 @findex org-table-toggle-formula-debugger
3000 @item C-c @{
3001 Toggle the formula debugger on and off
3002 (@command{org-table-toggle-formula-debugger}).  See below.
3003 @orgcmd{C-c ',org-table-edit-formulas}
3004 Edit all formulas for the current table in a special buffer, where the
3005 formulas will be displayed one per line.  If the current field has an
3006 active formula, the cursor in the formula editor will mark it.
3007 While inside the special buffer, Org will automatically highlight
3008 any field or range reference at the cursor position.  You may edit,
3009 remove and add formulas, and use the following commands:
3011 @table @kbd
3012 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
3013 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
3014 prefix, also apply the new formulas to the entire table.
3015 @orgcmd{C-c C-q,org-table-fedit-abort}
3016 Exit the formula editor without installing changes.
3017 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3018 Toggle all references in the formula editor between standard (like
3019 @code{B3}) and internal (like @code{@@3$2}).
3020 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3021 Pretty-print or indent Lisp formula at point.  When in a line containing
3022 a Lisp formula, format the formula according to Emacs Lisp rules.
3023 Another @key{TAB} collapses the formula back again.  In the open
3024 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3025 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3026 Complete Lisp symbols, just like in Emacs Lisp mode.
3027 @kindex S-@key{up}
3028 @kindex S-@key{down}
3029 @kindex S-@key{left}
3030 @kindex S-@key{right}
3031 @findex org-table-fedit-ref-up
3032 @findex org-table-fedit-ref-down
3033 @findex org-table-fedit-ref-left
3034 @findex org-table-fedit-ref-right
3035 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3036 Shift the reference at point.  For example, if the reference is
3037 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3038 This also works for relative references and for hline references.
3039 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3040 Move the test line for column formulas in the Org buffer up and
3041 down.
3042 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3043 Scroll the window displaying the table.
3044 @kindex C-c @}
3045 @findex org-table-toggle-coordinate-overlays
3046 @item C-c @}
3047 Turn the coordinate grid in the table on and off.
3048 @end table
3049 @end table
3051 Making a table field blank does not remove the formula associated with
3052 the field, because that is stored in a different line (the @samp{#+TBLFM}
3053 line)---during the next recalculation the field will be filled again.
3054 To remove a formula from a field, you have to give an empty reply when
3055 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3057 @kindex C-c C-c
3058 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3059 equations with @kbd{C-c C-c} in that line or with the normal
3060 recalculation commands in the table.
3062 @anchor{Using multiple #+TBLFM lines}
3063 @subsubheading Using multiple #+TBLFM lines
3064 @cindex #+TBLFM line, multiple
3065 @cindex #+TBLFM
3066 @cindex #+TBLFM, switching
3067 @kindex C-c C-c
3069 You may apply the formula temporarily.  This is useful when you
3070 switch the formula.  Place multiple @samp{#+TBLFM} lines right
3071 after the table, and then press @kbd{C-c C-c} on the formula to
3072 apply.  Here is an example:
3074 @example
3075 | x | y |
3076 |---+---|
3077 | 1 |   |
3078 | 2 |   |
3079 #+TBLFM: $2=$1*1
3080 #+TBLFM: $2=$1*2
3081 @end example
3083 @noindent
3084 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3086 @example
3087 | x | y |
3088 |---+---|
3089 | 1 | 2 |
3090 | 2 | 4 |
3091 #+TBLFM: $2=$1*1
3092 #+TBLFM: $2=$1*2
3093 @end example
3095 @noindent
3096 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3097 will get the following result of applying only the first @samp{#+TBLFM} line.
3099 @example
3100 | x | y |
3101 |---+---|
3102 | 1 | 1 |
3103 | 2 | 2 |
3104 #+TBLFM: $2=$1*1
3105 #+TBLFM: $2=$1*2
3106 @end example
3108 @subsubheading Debugging formulas
3109 @cindex formula debugging
3110 @cindex debugging, of table formulas
3111 When the evaluation of a formula leads to an error, the field content
3112 becomes the string @samp{#ERROR}.  If you would like see what is going
3113 on during variable substitution and calculation in order to find a bug,
3114 turn on formula debugging in the @code{Tbl} menu and repeat the
3115 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3116 field.  Detailed information will be displayed.
3118 @node Updating the table
3119 @subsection Updating the table
3120 @cindex recomputing table fields
3121 @cindex updating, table
3123 Recalculation of a table is normally not automatic, but needs to be
3124 triggered by a command.  See @ref{Advanced features}, for a way to make
3125 recalculation at least semi-automatic.
3127 In order to recalculate a line of a table or the entire table, use the
3128 following commands:
3130 @table @kbd
3131 @orgcmd{C-c *,org-table-recalculate}
3132 Recalculate the current row by first applying the stored column formulas
3133 from left to right, and all field/range formulas in the current row.
3135 @kindex C-u C-c *
3136 @item C-u C-c *
3137 @kindex C-u C-c C-c
3138 @itemx C-u C-c C-c
3139 Recompute the entire table, line by line.  Any lines before the first
3140 hline are left alone, assuming that these are part of the table header.
3142 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3143 Iterate the table by recomputing it until no further changes occur.
3144 This may be necessary if some computed fields use the value of other
3145 fields that are computed @i{later} in the calculation sequence.
3146 @item M-x org-table-recalculate-buffer-tables RET
3147 @findex org-table-recalculate-buffer-tables
3148 Recompute all tables in the current buffer.
3149 @item M-x org-table-iterate-buffer-tables RET
3150 @findex org-table-iterate-buffer-tables
3151 Iterate all tables in the current buffer, in order to converge table-to-table
3152 dependencies.
3153 @end table
3155 @node Advanced features
3156 @subsection Advanced features
3158 If you want the recalculation of fields to happen automatically, or if you
3159 want to be able to assign @i{names}@footnote{Such names must start by an
3160 alphabetic character and use only alphanumeric/underscore characters.} to
3161 fields and columns, you need to reserve the first column of the table for
3162 special marking characters.
3164 @table @kbd
3165 @orgcmd{C-#,org-table-rotate-recalc-marks}
3166 Rotate the calculation mark in first column through the states @samp{ },
3167 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
3168 change all marks in the region.
3169 @end table
3171 Here is an example of a table that collects exam results of students and
3172 makes use of these features:
3174 @example
3175 @group
3176 |---+---------+--------+--------+--------+-------+------|
3177 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3178 |---+---------+--------+--------+--------+-------+------|
3179 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
3180 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
3181 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
3182 |---+---------+--------+--------+--------+-------+------|
3183 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
3184 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
3185 |---+---------+--------+--------+--------+-------+------|
3186 |   | Average |        |        |        |  25.0 |      |
3187 | ^ |         |        |        |        |    at |      |
3188 | $ | max=50  |        |        |        |       |      |
3189 |---+---------+--------+--------+--------+-------+------|
3190 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3191 @end group
3192 @end example
3194 @noindent @b{Important}: please note that for these special tables,
3195 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3196 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3197 to the field itself.  The column formulas are not applied in rows with
3198 empty first field.
3200 @cindex marking characters, tables
3201 The marking characters have the following meaning:
3203 @table @samp
3204 @item !
3205 The fields in this line define names for the columns, so that you may
3206 refer to a column as @samp{$Tot} instead of @samp{$6}.
3207 @item ^
3208 This row defines names for the fields @emph{above} the row.  With such
3209 a definition, any formula in the table may use @samp{$m1} to refer to
3210 the value @samp{10}.  Also, if you assign a formula to a names field, it
3211 will be stored as @samp{$name=...}.
3212 @item _
3213 Similar to @samp{^}, but defines names for the fields in the row
3214 @emph{below}.
3215 @item $
3216 Fields in this row can define @emph{parameters} for formulas.  For
3217 example, if a field in a @samp{$} row contains @samp{max=50}, then
3218 formulas in this table can refer to the value 50 using @samp{$max}.
3219 Parameters work exactly like constants, only that they can be defined on
3220 a per-table basis.
3221 @item #
3222 Fields in this row are automatically recalculated when pressing
3223 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
3224 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
3225 lines will be left alone by this command.
3226 @item *
3227 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3228 not for automatic recalculation.  Use this when automatic
3229 recalculation slows down editing too much.
3230 @item @w{ }
3231 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3232 All lines that should be recalculated should be marked with @samp{#}
3233 or @samp{*}.
3234 @item /
3235 Do not export this line.  Useful for lines that contain the narrowing
3236 @samp{<N>} markers or column group markers.
3237 @end table
3239 Finally, just to whet your appetite for what can be done with the
3240 fantastic @file{calc.el} package, here is a table that computes the Taylor
3241 series of degree @code{n} at location @code{x} for a couple of
3242 functions.
3244 @example
3245 @group
3246 |---+-------------+---+-----+--------------------------------------|
3247 |   | Func        | n | x   | Result                               |
3248 |---+-------------+---+-----+--------------------------------------|
3249 | # | exp(x)      | 1 | x   | 1 + x                                |
3250 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
3251 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
3252 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3253 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
3254 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
3255 |---+-------------+---+-----+--------------------------------------|
3256 #+TBLFM: $5=taylor($2,$4,$3);n3
3257 @end group
3258 @end example
3260 @node Org-Plot
3261 @section Org-Plot
3262 @cindex graph, in tables
3263 @cindex plot tables using Gnuplot
3264 @cindex #+PLOT
3266 Org-Plot can produce graphs of information stored in org tables, either
3267 graphically or in ASCII-art.
3269 @subheading Graphical plots using @file{Gnuplot}
3271 Org-Plot produces 2D and 3D graphs using @file{Gnuplot}
3272 @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3273 @uref{http://xafs.org/BruceRavel/GnuplotMode}.  To see this in action, ensure
3274 that you have both Gnuplot and Gnuplot mode installed on your system, then
3275 call @kbd{C-c " g} or @kbd{M-x org-plot/gnuplot @key{RET}} on the following
3276 table.
3278 @example
3279 @group
3280 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3281 | Sede      | Max cites | H-index |
3282 |-----------+-----------+---------|
3283 | Chile     |    257.72 |   21.39 |
3284 | Leeds     |    165.77 |   19.68 |
3285 | Sao Paolo |     71.00 |   11.50 |
3286 | Stockholm |    134.19 |   14.33 |
3287 | Morelia   |    257.56 |   17.67 |
3288 @end group
3289 @end example
3291 Notice that Org Plot is smart enough to apply the table's headers as labels.
3292 Further control over the labels, type, content, and appearance of plots can
3293 be exercised through the @code{#+PLOT:} lines preceding a table.  See below
3294 for a complete list of Org-plot options.  The @code{#+PLOT:} lines are
3295 optional.  For more information and examples see the Org-plot tutorial at
3296 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3298 @subsubheading Plot Options
3300 @table @code
3301 @item set
3302 Specify any @command{gnuplot} option to be set when graphing.
3304 @item title
3305 Specify the title of the plot.
3307 @item ind
3308 Specify which column of the table to use as the @code{x} axis.
3310 @item deps
3311 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3312 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3313 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3314 column).
3316 @item type
3317 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3319 @item with
3320 Specify a @code{with} option to be inserted for every col being plotted
3321 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3322 Defaults to @code{lines}.
3324 @item file
3325 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3327 @item labels
3328 List of labels to be used for the @code{deps} (defaults to the column headers
3329 if they exist).
3331 @item line
3332 Specify an entire line to be inserted in the Gnuplot script.
3334 @item map
3335 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3336 flat mapping rather than a @code{3d} slope.
3338 @item timefmt
3339 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3340 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3342 @item script
3343 If you want total control, you can specify a script file (place the file name
3344 between double-quotes) which will be used to plot.  Before plotting, every
3345 instance of @code{$datafile} in the specified script will be replaced with
3346 the path to the generated data file.  Note: even if you set this option, you
3347 may still want to specify the plot type, as that can impact the content of
3348 the data file.
3349 @end table
3351 @subheading ASCII bar plots
3353 While the cursor is on a column, typing @kbd{C-c " a} or
3354 @kbd{M-x orgtbl-ascii-plot @key{RET}} create a new column containing an
3355 ASCII-art bars plot.  The plot is implemented through a regular column
3356 formula.  When the source column changes, the bar plot may be updated by
3357 refreshing the table, for example typing @kbd{C-u C-c *}.
3359 @example
3360 @group
3361 | Sede          | Max cites |              |
3362 |---------------+-----------+--------------|
3363 | Chile         |    257.72 | WWWWWWWWWWWW |
3364 | Leeds         |    165.77 | WWWWWWWh     |
3365 | Sao Paolo     |     71.00 | WWW;         |
3366 | Stockholm     |    134.19 | WWWWWW:      |
3367 | Morelia       |    257.56 | WWWWWWWWWWWH |
3368 | Rochefourchat |      0.00 |              |
3369 #+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)
3370 @end group
3371 @end example
3373 The formula is an elisp call:
3374 @lisp
3375 (orgtbl-ascii-draw COLUMN MIN MAX WIDTH)
3376 @end lisp
3378 @table @code
3379 @item COLUMN
3380   is a reference to the source column.
3382 @item MIN MAX
3383   are the minimal and maximal values displayed.  Sources values
3384   outside this range are displayed as @samp{too small}
3385   or @samp{too large}.
3387 @item WIDTH
3388   is the width in characters of the bar-plot.  It defaults to @samp{12}.
3390 @end table
3392 @node Hyperlinks
3393 @chapter Hyperlinks
3394 @cindex hyperlinks
3396 Like HTML, Org provides links inside a file, external links to
3397 other files, Usenet articles, emails, and much more.
3399 @menu
3400 * Link format::                 How links in Org are formatted
3401 * Internal links::              Links to other places in the current file
3402 * External links::              URL-like links to the world
3403 * Handling links::              Creating, inserting and following
3404 * Using links outside Org::     Linking from my C source code?
3405 * Link abbreviations::          Shortcuts for writing complex links
3406 * Search options::              Linking to a specific location
3407 * Custom searches::             When the default search is not enough
3408 @end menu
3410 @node Link format
3411 @section Link format
3412 @cindex link format
3413 @cindex format, of links
3415 Org will recognize plain URL-like links and activate them as
3416 clickable links.  The general link format, however, looks like this:
3418 @example
3419 [[link][description]]       @r{or alternatively}           [[link]]
3420 @end example
3422 @noindent
3423 Once a link in the buffer is complete (all brackets present), Org
3424 will change the display so that @samp{description} is displayed instead
3425 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3426 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
3427 which by default is an underlined face.  You can directly edit the
3428 visible part of a link.  Note that this can be either the @samp{link}
3429 part (if there is no description) or the @samp{description} part.  To
3430 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3431 cursor on the link.
3433 If you place the cursor at the beginning or just behind the end of the
3434 displayed text and press @key{BACKSPACE}, you will remove the
3435 (invisible) bracket at that location.  This makes the link incomplete
3436 and the internals are again displayed as plain text.  Inserting the
3437 missing bracket hides the link internals again.  To show the
3438 internal structure of all links, use the menu entry
3439 @code{Org->Hyperlinks->Literal links}.
3441 @node Internal links
3442 @section Internal links
3443 @cindex internal links
3444 @cindex links, internal
3445 @cindex targets, for links
3447 @cindex property, CUSTOM_ID
3448 If the link does not look like a URL, it is considered to be internal in the
3449 current file.  The most important case is a link like
3450 @samp{[[#my-custom-id]]} which will link to the entry with the
3451 @code{CUSTOM_ID} property @samp{my-custom-id}.  You are responsible yourself
3452 to make sure these custom IDs are unique in a file.
3454 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3455 lead to a text search in the current file.
3457 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3458 or with a mouse click (@pxref{Handling links}).  Links to custom IDs will
3459 point to the corresponding headline.  The preferred match for a text link is
3460 a @i{dedicated target}: the same string in double angular brackets, like
3461 @samp{<<My Target>>}.
3463 @cindex #+NAME
3464 If no dedicated target exists, the link will then try to match the exact name
3465 of an element within the buffer.  Naming is done with the @code{#+NAME}
3466 keyword, which has to be put in the line before the element it refers to, as
3467 in the following example
3469 @example
3470 #+NAME: My Target
3471 | a  | table      |
3472 |----+------------|
3473 | of | four cells |
3474 @end example
3476 If none of the above succeeds, Org will search for a headline that is exactly
3477 the link text but may also include a TODO keyword and tags@footnote{To insert
3478 a link targeting a headline, in-buffer completion can be used.  Just type
3479 a star followed by a few optional letters into the buffer and press
3480 @kbd{M-@key{TAB}}.  All headlines in the current buffer will be offered as
3481 completions.}.
3483 During export, internal links will be used to mark objects and assign them
3484 a number.  Marked objects will then be referenced by links pointing to them.
3485 In particular, links without a description will appear as the number assigned
3486 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3487 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3488 (@pxref{Images and tables}).}.  In the following excerpt from an Org buffer
3490 @example
3491 - one item
3492 - <<target>>another item
3493 Here we refer to item [[target]].
3494 @end example
3496 @noindent
3497 The last sentence will appear as @samp{Here we refer to item 2} when
3498 exported.
3500 In non-Org files, the search will look for the words in the link text.  In
3501 the above example the search would be for @samp{my target}.
3503 Following a link pushes a mark onto Org's own mark ring.  You can
3504 return to the previous position with @kbd{C-c &}.  Using this command
3505 several times in direct succession goes back to positions recorded
3506 earlier.
3508 @menu
3509 * Radio targets::               Make targets trigger links in plain text
3510 @end menu
3512 @node Radio targets
3513 @subsection Radio targets
3514 @cindex radio targets
3515 @cindex targets, radio
3516 @cindex links, radio targets
3518 Org can automatically turn any occurrences of certain target names
3519 in normal text into a link.  So without explicitly creating a link, the
3520 text connects to the target radioing its position.  Radio targets are
3521 enclosed by triple angular brackets.  For example, a target @samp{<<<My
3522 Target>>>} causes each occurrence of @samp{my target} in normal text to
3523 become activated as a link.  The Org file is scanned automatically
3524 for radio targets only when the file is first loaded into Emacs.  To
3525 update the target list during editing, press @kbd{C-c C-c} with the
3526 cursor on or at a target.
3528 @node External links
3529 @section External links
3530 @cindex links, external
3531 @cindex external links
3532 @cindex Gnus links
3533 @cindex BBDB links
3534 @cindex IRC links
3535 @cindex URL links
3536 @cindex file links
3537 @cindex RMAIL links
3538 @cindex MH-E links
3539 @cindex USENET links
3540 @cindex SHELL links
3541 @cindex Info links
3542 @cindex Elisp links
3544 Org supports links to files, websites, Usenet and email messages, BBDB
3545 database entries and links to both IRC conversations and their logs.
3546 External links are URL-like locators.  They start with a short identifying
3547 string followed by a colon.  There can be no space after the colon.  The
3548 following list shows examples for each link type.
3550 @example
3551 http://www.astro.uva.nl/~dominik          @r{on the web}
3552 doi:10.1000/182                           @r{DOI for an electronic resource}
3553 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
3554 /home/dominik/images/jupiter.jpg          @r{same as above}
3555 file:papers/last.pdf                      @r{file, relative path}
3556 ./papers/last.pdf                         @r{same as above}
3557 file:/myself@@some.where:papers/last.pdf   @r{file, path on remote machine}
3558 /myself@@some.where:papers/last.pdf        @r{same as above}
3559 file:sometextfile::NNN                    @r{file, jump to line number}
3560 file:projects.org                         @r{another Org file}
3561 file:projects.org::some words             @r{text search in Org file}@footnote{
3562 The actual behavior of the search will depend on the value of
3563 the option @code{org-link-search-must-match-exact-headline}.  If its value
3564 is @code{nil}, then a fuzzy text search will be done.  If it is t, then only the
3565 exact headline will be matched, ignoring spaces and cookies.  If the value is
3566 @code{query-to-create}, then an exact headline will be searched; if it is not
3567 found, then the user will be queried to create it.}
3568 file:projects.org::*task title @r{heading search in Org
3569 file}@footnote{ Headline searches always match the exact headline, ignoring
3570 spaces and cookies.  If the headline is not found and the value of the option
3571 @code{org-link-search-must-match-exact-headline} is @code{query-to-create},
3572 then the user will be queried to create it.}
3573 file+sys:/path/to/file                    @r{open via OS, like double-click}
3574 file+emacs:/path/to/file                  @r{force opening by Emacs}
3575 docview:papers/last.pdf::NNN              @r{open in doc-view mode at page}
3576 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
3577 news:comp.emacs                           @r{Usenet link}
3578 mailto:adent@@galaxy.net                   @r{Mail link}
3579 mhe:folder                                @r{MH-E folder link}
3580 mhe:folder#id                             @r{MH-E message link}
3581 rmail:folder                              @r{RMAIL folder link}
3582 rmail:folder#id                           @r{RMAIL message link}
3583 gnus:group                                @r{Gnus group link}
3584 gnus:group#id                             @r{Gnus article link}
3585 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
3586 irc:/irc.com/#emacs/bob                   @r{IRC link}
3587 info:org#External links                   @r{Info node or index link}
3588 shell:ls *.org                            @r{A shell command}
3589 elisp:org-agenda                          @r{Interactive Elisp command}
3590 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3591 @end example
3593 @cindex VM links
3594 @cindex WANDERLUST links
3595 On top of these built-in link types, some are available through the
3596 @code{contrib/} directory (@pxref{Installation}).  For example, these links
3597 to VM or Wanderlust messages are available when you load the corresponding
3598 libraries from the @code{contrib/} directory:
3600 @example
3601 vm:folder                                 @r{VM folder link}
3602 vm:folder#id                              @r{VM message link}
3603 vm://myself@@some.where.org/folder#id      @r{VM on remote machine}
3604 vm-imap:account:folder                    @r{VM IMAP folder link}
3605 vm-imap:account:folder#id                 @r{VM IMAP message link}
3606 wl:folder                                 @r{WANDERLUST folder link}
3607 wl:folder#id                              @r{WANDERLUST message link}
3608 @end example
3610 For customizing Org to add new link types @ref{Adding hyperlink types}.
3612 A link should be enclosed in double brackets and may contain a descriptive
3613 text to be displayed instead of the URL (@pxref{Link format}), for example:
3615 @example
3616 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3617 @end example
3619 @noindent
3620 If the description is a file name or URL that points to an image, HTML
3621 export (@pxref{HTML export}) will inline the image as a clickable
3622 button.  If there is no description at all and the link points to an
3623 image,
3624 that image will be inlined into the exported HTML file.
3626 @cindex square brackets, around links
3627 @cindex plain text external links
3628 Org also finds external links in the normal text and activates them
3629 as links.  If spaces must be part of the link (for example in
3630 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3631 about the end of the link, enclose them in square brackets.
3633 @node Handling links
3634 @section Handling links
3635 @cindex links, handling
3637 Org provides methods to create a link in the correct syntax, to
3638 insert it into an Org file, and to follow the link.
3640 @table @kbd
3641 @orgcmd{C-c l,org-store-link}
3642 @cindex storing links
3643 Store a link to the current location.  This is a @emph{global} command (you
3644 must create the key binding yourself) which can be used in any buffer to
3645 create a link.  The link will be stored for later insertion into an Org
3646 buffer (see below).  What kind of link will be created depends on the current
3647 buffer:
3649 @b{Org mode buffers}@*
3650 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3651 to the target.  Otherwise it points to the current headline, which will also
3652 be the description@footnote{If the headline contains a timestamp, it will be
3653 removed from the link and result in a wrong link---you should avoid putting
3654 timestamp in the headline.}.
3656 @vindex org-id-link-to-org-use-id
3657 @cindex property, CUSTOM_ID
3658 @cindex property, ID
3659 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3660 will be stored.  In addition or alternatively (depending on the value of
3661 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3662 be created and/or used to construct a link@footnote{The library
3663 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3664 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3665 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3666 potentially create two links: a human-readable from the custom ID, and one
3667 that is globally unique and works even if the entry is moved from file to
3668 file.  Later, when inserting the link, you need to decide which one to use.
3670 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3671 Pretty much all Emacs mail clients are supported.  The link will point to the
3672 current article, or, in some GNUS buffers, to the group.  The description is
3673 constructed from the author and the subject.
3675 @b{Web browsers: W3 and W3M}@*
3676 Here the link will be the current URL, with the page title as description.
3678 @b{Contacts: BBDB}@*
3679 Links created in a BBDB buffer will point to the current entry.
3681 @b{Chat: IRC}@*
3682 @vindex org-irc-link-to-logs
3683 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3684 a @samp{file:/} style link to the relevant point in the logs for the current
3685 conversation is created.  Otherwise an @samp{irc:/} style link to the
3686 user/channel/server under the point will be stored.
3688 @b{Other files}@*
3689 For any other files, the link will point to the file, with a search string
3690 (@pxref{Search options}) pointing to the contents of the current line.  If
3691 there is an active region, the selected words will form the basis of the
3692 search string.  If the automatically created link is not working correctly or
3693 accurately enough, you can write custom functions to select the search string
3694 and to do the search for particular file types---see @ref{Custom searches}.
3695 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3697 @b{Agenda view}@*
3698 When the cursor is in an agenda view, the created link points to the
3699 entry referenced by the current line.
3702 @orgcmd{C-c C-l,org-insert-link}
3703 @cindex link completion
3704 @cindex completion, of links
3705 @cindex inserting links
3706 @vindex org-keep-stored-link-after-insertion
3707 Insert a link@footnote{Note that you don't have to use this command to
3708 insert a link.  Links in Org are plain text, and you can type or paste them
3709 straight into the buffer.  By using this command, the links are automatically
3710 enclosed in double brackets, and you will be asked for the optional
3711 descriptive text.}.  This prompts for a link to be inserted into the buffer.
3712 You can just type a link, using text for an internal link, or one of the link
3713 type prefixes mentioned in the examples above.  The link will be inserted
3714 into the buffer@footnote{After insertion of a stored link, the link will be
3715 removed from the list of stored links.  To keep it in the list later use, use
3716 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3717 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3718 If some text was selected when this command is called, the selected text
3719 becomes the default description.
3721 @b{Inserting stored links}@*
3722 All links stored during the
3723 current session are part of the history for this prompt, so you can access
3724 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3726 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3727 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3728 defined through link abbreviations (@pxref{Link abbreviations}).  If you
3729 press @key{RET} after inserting only the @var{prefix}, Org will offer
3730 specific completion support for some link types@footnote{This works by
3731 calling a special function @code{org-PREFIX-complete-link}.}  For
3732 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3733 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3734 @key{RET}} you can complete contact names.
3735 @orgkey C-u C-c C-l
3736 @cindex file name completion
3737 @cindex completion, of file names
3738 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3739 a file will be inserted and you may use file name completion to select
3740 the name of the file.  The path to the file is inserted relative to the
3741 directory of the current Org file, if the linked file is in the current
3742 directory or in a sub-directory of it, or if the path is written relative
3743 to the current directory using @samp{../}.  Otherwise an absolute path
3744 is used, if possible with @samp{~/} for your home directory.  You can
3745 force an absolute path with two @kbd{C-u} prefixes.
3747 @item C-c C-l @ @r{(with cursor on existing link)}
3748 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3749 link and description parts of the link.
3751 @cindex following links
3752 @orgcmd{C-c C-o,org-open-at-point}
3753 @vindex org-file-apps
3754 @vindex org-link-frame-setup
3755 Open link at point.  This will launch a web browser for URLs (using
3756 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3757 the corresponding links, and execute the command in a shell link.  When the
3758 cursor is on an internal link, this command runs the corresponding search.
3759 When the cursor is on a TAG list in a headline, it creates the corresponding
3760 TAGS view.  If the cursor is on a timestamp, it compiles the agenda for that
3761 date.  Furthermore, it will visit text and remote files in @samp{file:} links
3762 with Emacs and select a suitable application for local non-text files.
3763 Classification of files is based on file extension only.  See option
3764 @code{org-file-apps}.  If you want to override the default application and
3765 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
3766 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3767 If the cursor is on a headline, but not on a link, offer all links in the
3768 headline and entry text.  If you want to setup the frame configuration for
3769 following links, customize @code{org-link-frame-setup}.
3771 @orgkey @key{RET}
3772 @vindex org-return-follows-link
3773 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3774 the link at point.
3776 @kindex mouse-2
3777 @kindex mouse-1
3778 @item mouse-2
3779 @itemx mouse-1
3780 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3781 would.  Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3783 @kindex mouse-3
3784 @item mouse-3
3785 @vindex org-display-internal-link-with-indirect-buffer
3786 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3787 internal links to be displayed in another window@footnote{See the
3788 option @code{org-display-internal-link-with-indirect-buffer}}.
3790 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3791 @cindex inlining images
3792 @cindex images, inlining
3793 @vindex org-startup-with-inline-images
3794 @cindex @code{inlineimages}, STARTUP keyword
3795 @cindex @code{noinlineimages}, STARTUP keyword
3796 Toggle the inline display of linked images.  Normally this will only inline
3797 images that have no description part in the link, i.e., images that will also
3798 be inlined during export.  When called with a prefix argument, also display
3799 images that do have a link description.  You can ask for inline images to be
3800 displayed at startup by configuring the variable
3801 @code{org-startup-with-inline-images}@footnote{with corresponding
3802 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3803 @orgcmd{C-c %,org-mark-ring-push}
3804 @cindex mark ring
3805 Push the current position onto the mark ring, to be able to return
3806 easily.  Commands following an internal link do this automatically.
3808 @orgcmd{C-c &,org-mark-ring-goto}
3809 @cindex links, returning to
3810 Jump back to a recorded position.  A position is recorded by the
3811 commands following internal links, and by @kbd{C-c %}.  Using this
3812 command several times in direct succession moves through a ring of
3813 previously recorded positions.
3815 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3816 @cindex links, finding next/previous
3817 Move forward/backward to the next link in the buffer.  At the limit of
3818 the buffer, the search fails once, and then wraps around.  The key
3819 bindings for this are really too long; you might want to bind this also
3820 to @kbd{C-n} and @kbd{C-p}
3821 @lisp
3822 (add-hook 'org-load-hook
3823   (lambda ()
3824     (define-key org-mode-map "\C-n" 'org-next-link)
3825     (define-key org-mode-map "\C-p" 'org-previous-link)))
3826 @end lisp
3827 @end table
3829 @node Using links outside Org
3830 @section Using links outside Org
3832 You can insert and follow links that have Org syntax not only in
3833 Org, but in any Emacs buffer.  For this, you should create two
3834 global commands, like this (please select suitable global keys
3835 yourself):
3837 @lisp
3838 (global-set-key "\C-c L" 'org-insert-link-global)
3839 (global-set-key "\C-c o" 'org-open-at-point-global)
3840 @end lisp
3842 @node Link abbreviations
3843 @section Link abbreviations
3844 @cindex link abbreviations
3845 @cindex abbreviation, links
3847 Long URLs can be cumbersome to type, and often many similar links are
3848 needed in a document.  For this you can use link abbreviations.  An
3849 abbreviated link looks like this
3851 @example
3852 [[linkword:tag][description]]
3853 @end example
3855 @noindent
3856 @vindex org-link-abbrev-alist
3857 where the tag is optional.
3858 The @i{linkword} must be a word, starting with a letter, followed by
3859 letters, numbers, @samp{-}, and @samp{_}.  Abbreviations are resolved
3860 according to the information in the variable @code{org-link-abbrev-alist}
3861 that relates the linkwords to replacement text.  Here is an example:
3863 @smalllisp
3864 @group
3865 (setq org-link-abbrev-alist
3866   '(("bugzilla"  . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3867     ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3868     ("google"    . "http://www.google.com/search?q=")
3869     ("gmap"      . "http://maps.google.com/maps?q=%s")
3870     ("omap"      . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3871     ("ads"       . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3872 @end group
3873 @end smalllisp
3875 If the replacement text contains the string @samp{%s}, it will be
3876 replaced with the tag.  Using @samp{%h} instead of @samp{%s} will
3877 url-encode the tag (see the example above, where we need to encode
3878 the URL parameter.)  Using @samp{%(my-function)} will pass the tag
3879 to a custom function, and replace it by the resulting string.
3881 If the replacement text doesn't contain any specifier, it will simply
3882 be appended to the string in order to create the link.
3884 Instead of a string, you may also specify a function that will be
3885 called with the tag as the only argument to create the link.
3887 With the above setting, you could link to a specific bug with
3888 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3889 @code{[[google:OrgMode]]}, show the map location of the Free Software
3890 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3891 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3892 what the Org author is doing besides Emacs hacking with
3893 @code{[[ads:Dominik,C]]}.
3895 If you need special abbreviations just for a single Org buffer, you
3896 can define them in the file with
3898 @cindex #+LINK
3899 @example
3900 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
3901 #+LINK: google    http://www.google.com/search?q=%s
3902 @end example
3904 @noindent
3905 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3906 complete link abbreviations.  You may also define a function
3907 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3908 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
3909 not accept any arguments, and return the full link with prefix.
3911 @node Search options
3912 @section Search options in file links
3913 @cindex search option in file links
3914 @cindex file links, searching
3916 File links can contain additional information to make Emacs jump to a
3917 particular location in the file when following a link.  This can be a
3918 line number or a search option after a double@footnote{For backward
3919 compatibility, line numbers can also follow a single colon.} colon.  For
3920 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3921 links}) to a file, it encodes the words in the current line as a search
3922 string that can be used to find this line back later when following the
3923 link with @kbd{C-c C-o}.
3925 Here is the syntax of the different ways to attach a search to a file
3926 link, together with an explanation:
3928 @example
3929 [[file:~/code/main.c::255]]
3930 [[file:~/xx.org::My Target]]
3931 [[file:~/xx.org::*My Target]]
3932 [[file:~/xx.org::#my-custom-id]]
3933 [[file:~/xx.org::/regexp/]]
3934 @end example
3936 @table @code
3937 @item 255
3938 Jump to line 255.
3939 @item My Target
3940 Search for a link target @samp{<<My Target>>}, or do a text search for
3941 @samp{my target}, similar to the search in internal links, see
3942 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
3943 link will become an HTML reference to the corresponding named anchor in
3944 the linked file.
3945 @item *My Target
3946 In an Org file, restrict search to headlines.
3947 @item #my-custom-id
3948 Link to a heading with a @code{CUSTOM_ID} property
3949 @item /regexp/
3950 Do a regular expression search for @code{regexp}.  This uses the Emacs
3951 command @code{occur} to list all matches in a separate window.  If the
3952 target file is in Org mode, @code{org-occur} is used to create a
3953 sparse tree with the matches.
3954 @c If the target file is a directory,
3955 @c @code{grep} will be used to search all files in the directory.
3956 @end table
3958 As a degenerate case, a file link with an empty file name can be used
3959 to search the current file.  For example, @code{[[file:::find me]]} does
3960 a search for @samp{find me} in the current file, just as
3961 @samp{[[find me]]} would.
3963 @node Custom searches
3964 @section Custom Searches
3965 @cindex custom search strings
3966 @cindex search strings, custom
3968 The default mechanism for creating search strings and for doing the
3969 actual search related to a file link may not work correctly in all
3970 cases.  For example, Bib@TeX{} database files have many entries like
3971 @samp{year="1993"} which would not result in good search strings,
3972 because the only unique identification for a Bib@TeX{} entry is the
3973 citation key.
3975 @vindex org-create-file-search-functions
3976 @vindex org-execute-file-search-functions
3977 If you come across such a problem, you can write custom functions to set
3978 the right search string for a particular file type, and to do the search
3979 for the string in the file.  Using @code{add-hook}, these functions need
3980 to be added to the hook variables
3981 @code{org-create-file-search-functions} and
3982 @code{org-execute-file-search-functions}.  See the docstring for these
3983 variables for more information.  Org actually uses this mechanism
3984 for Bib@TeX{} database files, and you can use the corresponding code as
3985 an implementation example.  See the file @file{org-bibtex.el}.
3987 @node TODO items
3988 @chapter TODO items
3989 @cindex TODO items
3991 Org mode does not maintain TODO lists as separate documents@footnote{Of
3992 course, you can make a document that contains only long lists of TODO items,
3993 but this is not required.}.  Instead, TODO items are an integral part of the
3994 notes file, because TODO items usually come up while taking notes!  With Org
3995 mode, simply mark any entry in a tree as being a TODO item.  In this way,
3996 information is not duplicated, and the entire context from which the TODO
3997 item emerged is always present.
3999 Of course, this technique for managing TODO items scatters them
4000 throughout your notes file.  Org mode compensates for this by providing
4001 methods to give you an overview of all the things that you have to do.
4003 @menu
4004 * TODO basics::                 Marking and displaying TODO entries
4005 * TODO extensions::             Workflow and assignments
4006 * Progress logging::            Dates and notes for progress
4007 * Priorities::                  Some things are more important than others
4008 * Breaking down tasks::         Splitting a task into manageable pieces
4009 * Checkboxes::                  Tick-off lists
4010 @end menu
4012 @node TODO basics
4013 @section Basic TODO functionality
4015 Any headline becomes a TODO item when it starts with the word
4016 @samp{TODO}, for example:
4018 @example
4019 *** TODO Write letter to Sam Fortune
4020 @end example
4022 @noindent
4023 The most important commands to work with TODO entries are:
4025 @table @kbd
4026 @orgcmd{C-c C-t,org-todo}
4027 @cindex cycling, of TODO states
4028 @vindex org-use-fast-todo-selection
4030 Rotate the TODO state of the current item among
4032 @example
4033 ,-> (unmarked) -> TODO -> DONE --.
4034 '--------------------------------'
4035 @end example
4037 If TODO keywords have fast access keys (see @ref{Fast access to TODO
4038 states}), you will be prompted for a TODO keyword through the fast selection
4039 interface; this is the default behavior when
4040 @code{org-use-fast-todo-selection} is non-@code{nil}.
4042 The same rotation can also be done ``remotely'' from the timeline and agenda
4043 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
4045 @orgkey{C-u C-c C-t}
4046 When TODO keywords have no selection keys, select a specific keyword using
4047 completion; otherwise force cycling through TODO states with no prompt.  When
4048 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
4049 selection interface.
4051 @kindex S-@key{right}
4052 @kindex S-@key{left}
4053 @item S-@key{right} @ @r{/} @ S-@key{left}
4054 @vindex org-treat-S-cursor-todo-selection-as-state-change
4055 Select the following/preceding TODO state, similar to cycling.  Useful
4056 mostly if more than two TODO states are possible (@pxref{TODO
4057 extensions}).  See also @ref{Conflicts}, for a discussion of the interaction
4058 with @code{shift-selection-mode}.  See also the variable
4059 @code{org-treat-S-cursor-todo-selection-as-state-change}.
4060 @orgcmd{C-c / t,org-show-todo-tree}
4061 @cindex sparse tree, for TODO
4062 @vindex org-todo-keywords
4063 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
4064 entire buffer, but shows all TODO items (with not-DONE state) and the
4065 headings hierarchy above them.  With a prefix argument (or by using @kbd{C-c
4066 / T}), search for a specific TODO@.  You will be prompted for the keyword,
4067 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
4068 entries that match any one of these keywords.  With a numeric prefix argument
4069 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
4070 With two prefix arguments, find all TODO states, both un-done and done.
4071 @orgcmd{C-c a t,org-todo-list}
4072 Show the global TODO list.  Collects the TODO items (with not-DONE states)
4073 from all agenda files (@pxref{Agenda views}) into a single buffer.  The new
4074 buffer will be in @code{agenda-mode}, which provides commands to examine and
4075 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4076 @xref{Global TODO list}, for more information.
4077 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4078 Insert a new TODO entry below the current one.
4079 @end table
4081 @noindent
4082 @vindex org-todo-state-tags-triggers
4083 Changing a TODO state can also trigger tag changes.  See the docstring of the
4084 option @code{org-todo-state-tags-triggers} for details.
4086 @node TODO extensions
4087 @section Extended use of TODO keywords
4088 @cindex extended TODO keywords
4090 @vindex org-todo-keywords
4091 By default, marked TODO entries have one of only two states: TODO and
4092 DONE@.  Org mode allows you to classify TODO items in more complex ways
4093 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
4094 special setup, the TODO keyword system can work differently in different
4095 files.
4097 Note that @i{tags} are another way to classify headlines in general and
4098 TODO items in particular (@pxref{Tags}).
4100 @menu
4101 * Workflow states::             From TODO to DONE in steps
4102 * TODO types::                  I do this, Fred does the rest
4103 * Multiple sets in one file::   Mixing it all, and still finding your way
4104 * Fast access to TODO states::  Single letter selection of a state
4105 * Per-file keywords::           Different files, different requirements
4106 * Faces for TODO keywords::     Highlighting states
4107 * TODO dependencies::           When one task needs to wait for others
4108 @end menu
4110 @node Workflow states
4111 @subsection TODO keywords as workflow states
4112 @cindex TODO workflow
4113 @cindex workflow states as TODO keywords
4115 You can use TODO keywords to indicate different @emph{sequential} states
4116 in the process of working on an item, for example@footnote{Changing
4117 this variable only becomes effective after restarting Org mode in a
4118 buffer.}:
4120 @lisp
4121 (setq org-todo-keywords
4122   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4123 @end lisp
4125 The vertical bar separates the TODO keywords (states that @emph{need
4126 action}) from the DONE states (which need @emph{no further action}).  If
4127 you don't provide the separator bar, the last state is used as the DONE
4128 state.
4129 @cindex completion, of TODO keywords
4130 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4131 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@.  You may
4132 also use a numeric prefix argument to quickly select a specific state.  For
4133 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4134 Or you can use @kbd{S-@key{left}} to go backward through the sequence.  If you
4135 define many keywords, you can use in-buffer completion
4136 (@pxref{Completion}) or even a special one-key selection scheme
4137 (@pxref{Fast access to TODO states}) to insert these words into the
4138 buffer.  Changing a TODO state can be logged with a timestamp, see
4139 @ref{Tracking TODO state changes}, for more information.
4141 @node TODO types
4142 @subsection TODO keywords as types
4143 @cindex TODO types
4144 @cindex names as TODO keywords
4145 @cindex types as TODO keywords
4147 The second possibility is to use TODO keywords to indicate different
4148 @emph{types} of action items.  For example, you might want to indicate
4149 that items are for ``work'' or ``home''.  Or, when you work with several
4150 people on a single project, you might want to assign action items
4151 directly to persons, by using their names as TODO keywords.  This would
4152 be set up like this:
4154 @lisp
4155 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4156 @end lisp
4158 In this case, different keywords do not indicate a sequence, but rather
4159 different types.  So the normal work flow would be to assign a task to a
4160 person, and later to mark it DONE@.  Org mode supports this style by adapting
4161 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4162 @kbd{t} command in the timeline and agenda buffers.}.  When used several
4163 times in succession, it will still cycle through all names, in order to first
4164 select the right type for a task.  But when you return to the item after some
4165 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4166 to DONE@.  Use prefix arguments or completion to quickly select a specific
4167 name.  You can also review the items of a specific TODO type in a sparse tree
4168 by using a numeric prefix to @kbd{C-c / t}.  For example, to see all things
4169 Lucy has to do, you would use @kbd{C-3 C-c / t}.  To collect Lucy's items
4170 from all agenda files into a single buffer, you would use the numeric prefix
4171 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4173 @node Multiple sets in one file
4174 @subsection Multiple keyword sets in one file
4175 @cindex TODO keyword sets
4177 Sometimes you may want to use different sets of TODO keywords in
4178 parallel.  For example, you may want to have the basic
4179 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4180 separate state indicating that an item has been canceled (so it is not
4181 DONE, but also does not require action).  Your setup would then look
4182 like this:
4184 @lisp
4185 (setq org-todo-keywords
4186       '((sequence "TODO" "|" "DONE")
4187         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4188         (sequence "|" "CANCELED")))
4189 @end lisp
4191 The keywords should all be different, this helps Org mode to keep track
4192 of which subsequence should be used for a given entry.  In this setup,
4193 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4194 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4195 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
4196 select the correct sequence.  Besides the obvious ways like typing a
4197 keyword or using completion, you may also apply the following commands:
4199 @table @kbd
4200 @kindex C-S-@key{right}
4201 @kindex C-S-@key{left}
4202 @kindex C-u C-u C-c C-t
4203 @item C-u C-u C-c C-t
4204 @itemx C-S-@key{right}
4205 @itemx C-S-@key{left}
4206 These keys jump from one TODO subset to the next.  In the above example,
4207 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4208 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4209 @code{CANCELED}.  Note that the @kbd{C-S-} key binding conflict with
4210 @code{shift-selection-mode} (@pxref{Conflicts}).
4211 @kindex S-@key{right}
4212 @kindex S-@key{left}
4213 @item S-@key{right}
4214 @itemx S-@key{left}
4215 @kbd{S-@key{left}} and @kbd{S-@key{right}} and walk through @emph{all}
4216 keywords from all sets, so for example @kbd{S-@key{right}} would switch
4217 from @code{DONE} to @code{REPORT} in the example above.  See also
4218 @ref{Conflicts}, for a discussion of the interaction with
4219 @code{shift-selection-mode}.
4220 @end table
4222 @node Fast access to TODO states
4223 @subsection Fast access to TODO states
4225 If you would like to quickly change an entry to an arbitrary TODO state
4226 instead of cycling through the states, you can set up keys for single-letter
4227 access to the states.  This is done by adding the selection character after
4228 each keyword, in parentheses@footnote{All characters are allowed except
4229 @code{@@^!}, which have a special meaning here.}.  For example:
4231 @lisp
4232 (setq org-todo-keywords
4233       '((sequence "TODO(t)" "|" "DONE(d)")
4234         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4235         (sequence "|" "CANCELED(c)")))
4236 @end lisp
4238 @vindex org-fast-tag-selection-include-todo
4239 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4240 will be switched to this state.  @kbd{SPC} can be used to remove any TODO
4241 keyword from an entry.@footnote{Check also the option
4242 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4243 state through the tags interface (@pxref{Setting tags}), in case you like to
4244 mingle the two concepts.  Note that this means you need to come up with
4245 unique keys across both sets of keywords.}
4247 @node Per-file keywords
4248 @subsection Setting up keywords for individual files
4249 @cindex keyword options
4250 @cindex per-file keywords
4251 @cindex #+TODO
4252 @cindex #+TYP_TODO
4253 @cindex #+SEQ_TODO
4255 It can be very useful to use different aspects of the TODO mechanism in
4256 different files.  For file-local settings, you need to add special lines to
4257 the file which set the keywords and interpretation for that file only.  For
4258 example, to set one of the two examples discussed above, you need one of the
4259 following lines anywhere in the file:
4261 @example
4262 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4263 @end example
4264 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4265 interpretation, but it means the same as @code{#+TODO}), or
4266 @example
4267 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4268 @end example
4270 A setup for using several sets in parallel would be:
4272 @example
4273 #+TODO: TODO | DONE
4274 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4275 #+TODO: | CANCELED
4276 @end example
4278 @cindex completion, of option keywords
4279 @kindex M-@key{TAB}
4280 @noindent To make sure you are using the correct keyword, type
4281 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4283 @cindex DONE, final TODO keyword
4284 Remember that the keywords after the vertical bar (or the last keyword
4285 if no bar is there) must always mean that the item is DONE (although you
4286 may use a different word).  After changing one of these lines, use
4287 @kbd{C-c C-c} with the cursor still in the line to make the changes
4288 known to Org mode@footnote{Org mode parses these lines only when
4289 Org mode is activated after visiting a file.  @kbd{C-c C-c} with the
4290 cursor in a line starting with @samp{#+} is simply restarting Org mode
4291 for the current buffer.}.
4293 @node Faces for TODO keywords
4294 @subsection Faces for TODO keywords
4295 @cindex faces, for TODO keywords
4297 @vindex org-todo @r{(face)}
4298 @vindex org-done @r{(face)}
4299 @vindex org-todo-keyword-faces
4300 Org mode highlights TODO keywords with special faces: @code{org-todo}
4301 for keywords indicating that an item still has to be acted upon, and
4302 @code{org-done} for keywords indicating that an item is finished.  If
4303 you are using more than 2 different states, you might want to use
4304 special faces for some of them.  This can be done using the option
4305 @code{org-todo-keyword-faces}.  For example:
4307 @lisp
4308 @group
4309 (setq org-todo-keyword-faces
4310       '(("TODO" . org-warning) ("STARTED" . "yellow")
4311         ("CANCELED" . (:foreground "blue" :weight bold))))
4312 @end group
4313 @end lisp
4315 While using a list with face properties as shown for CANCELED @emph{should}
4316 work, this does not always seem to be the case.  If necessary, define a
4317 special face and use that.  A string is interpreted as a color.  The option
4318 @code{org-faces-easy-properties} determines if that color is interpreted as a
4319 foreground or a background color.
4321 @node TODO dependencies
4322 @subsection TODO dependencies
4323 @cindex TODO dependencies
4324 @cindex dependencies, of TODO states
4325 @cindex TODO dependencies, NOBLOCKING
4327 @vindex org-enforce-todo-dependencies
4328 @cindex property, ORDERED
4329 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4330 dependencies.  Usually, a parent TODO task should not be marked DONE until
4331 all subtasks (defined as children tasks) are marked as DONE@.  And sometimes
4332 there is a logical sequence to a number of (sub)tasks, so that one task
4333 cannot be acted upon before all siblings above it are done.  If you customize
4334 the option @code{org-enforce-todo-dependencies}, Org will block entries
4335 from changing state to DONE while they have children that are not DONE@.
4336 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4337 will be blocked until all earlier siblings are marked DONE@.  Here is an
4338 example:
4340 @example
4341 * TODO Blocked until (two) is done
4342 ** DONE one
4343 ** TODO two
4345 * Parent
4346   :PROPERTIES:
4347   :ORDERED: t
4348   :END:
4349 ** TODO a
4350 ** TODO b, needs to wait for (a)
4351 ** TODO c, needs to wait for (a) and (b)
4352 @end example
4354 You can ensure an entry is never blocked by using the @code{NOBLOCKING}
4355 property:
4357 @example
4358 * This entry is never blocked
4359   :PROPERTIES:
4360   :NOBLOCKING: t
4361   :END:
4362 @end example
4364 @table @kbd
4365 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4366 @vindex org-track-ordered-property-with-tag
4367 @cindex property, ORDERED
4368 Toggle the @code{ORDERED} property of the current entry.  A property is used
4369 for this behavior because this should be local to the current entry, not
4370 inherited like a tag.  However, if you would like to @i{track} the value of
4371 this property with a tag for better visibility, customize the option
4372 @code{org-track-ordered-property-with-tag}.
4373 @orgkey{C-u C-u C-u C-c C-t}
4374 Change TODO state, circumventing any state blocking.
4375 @end table
4377 @vindex org-agenda-dim-blocked-tasks
4378 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4379 that cannot be closed because of such dependencies will be shown in a dimmed
4380 font or even made invisible in agenda views (@pxref{Agenda views}).
4382 @cindex checkboxes and TODO dependencies
4383 @vindex org-enforce-todo-dependencies
4384 You can also block changes of TODO states by looking at checkboxes
4385 (@pxref{Checkboxes}).  If you set the option
4386 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4387 checkboxes will be blocked from switching to DONE.
4389 If you need more complex dependency structures, for example dependencies
4390 between entries in different trees or files, check out the contributed
4391 module @file{org-depend.el}.
4393 @page
4394 @node Progress logging
4395 @section Progress logging
4396 @cindex progress logging
4397 @cindex logging, of progress
4399 Org mode can automatically record a timestamp and possibly a note when
4400 you mark a TODO item as DONE, or even each time you change the state of
4401 a TODO item.  This system is highly configurable; settings can be on a
4402 per-keyword basis and can be localized to a file or even a subtree.  For
4403 information on how to clock working time for a task, see @ref{Clocking
4404 work time}.
4406 @menu
4407 * Closing items::               When was this entry marked DONE?
4408 * Tracking TODO state changes::  When did the status change?
4409 * Tracking your habits::        How consistent have you been?
4410 @end menu
4412 @node Closing items
4413 @subsection Closing items
4415 The most basic logging is to keep track of @emph{when} a certain TODO
4416 item was finished.  This is achieved with@footnote{The corresponding
4417 in-buffer setting is: @code{#+STARTUP: logdone}}
4419 @lisp
4420 (setq org-log-done 'time)
4421 @end lisp
4423 @vindex org-closed-keep-when-no-todo
4424 @noindent
4425 Then each time you turn an entry from a TODO (not-done) state into any of the
4426 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4427 the headline.  If you turn the entry back into a TODO item through further
4428 state cycling, that line will be removed again.  If you turn the entry back
4429 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4430 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4431 non-@code{nil}.  If you want to record a note along with the timestamp,
4432 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4433 lognotedone}.}
4435 @lisp
4436 (setq org-log-done 'note)
4437 @end lisp
4439 @noindent
4440 You will then be prompted for a note, and that note will be stored below
4441 the entry with a @samp{Closing Note} heading.
4443 In the timeline (@pxref{Timeline}) and in the agenda
4444 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4445 display the TODO items with a @samp{CLOSED} timestamp on each day,
4446 giving you an overview of what has been done.
4448 @node Tracking TODO state changes
4449 @subsection Tracking TODO state changes
4450 @cindex drawer, for state change recording
4452 @vindex org-log-states-order-reversed
4453 @vindex org-log-into-drawer
4454 @cindex property, LOG_INTO_DRAWER
4455 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4456 might want to keep track of when a state change occurred and maybe take a
4457 note about this change.  You can either record just a timestamp, or a
4458 time-stamped note for a change.  These records will be inserted after the
4459 headline as an itemized list, newest first@footnote{See the option
4460 @code{org-log-states-order-reversed}}.  When taking a lot of notes, you might
4461 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4462 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4463 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4464 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4465 show an entry---use @key{C-u SPC} to keep it folded here}.  You can also
4466 overrule the setting of this variable for a subtree by setting a
4467 @code{LOG_INTO_DRAWER} property.
4469 Since it is normally too much to record a note for every state, Org mode
4470 expects configuration on a per-keyword basis for this.  This is achieved by
4471 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4472 with timestamp) in parentheses after each keyword.  For example, with the
4473 setting
4475 @lisp
4476 (setq org-todo-keywords
4477   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4478 @end lisp
4480 To record a timestamp without a note for TODO keywords configured with
4481 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4483 @noindent
4484 @vindex org-log-done
4485 You not only define global TODO keywords and fast access keys, but also
4486 request that a time is recorded when the entry is set to
4487 DONE@footnote{It is possible that Org mode will record two timestamps
4488 when you are using both @code{org-log-done} and state change logging.
4489 However, it will never prompt for two notes---if you have configured
4490 both, the state change recording note will take precedence and cancel
4491 the @samp{Closing Note}.}, and that a note is recorded when switching to
4492 WAIT or CANCELED@.  The setting for WAIT is even more special: the
4493 @samp{!} after the slash means that in addition to the note taken when
4494 entering the state, a timestamp should be recorded when @i{leaving} the
4495 WAIT state, if and only if the @i{target} state does not configure
4496 logging for entering it.  So it has no effect when switching from WAIT
4497 to DONE, because DONE is configured to record a timestamp only.  But
4498 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4499 setting now triggers a timestamp even though TODO has no logging
4500 configured.
4502 You can use the exact same syntax for setting logging preferences local
4503 to a buffer:
4504 @example
4505 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4506 @end example
4508 @cindex property, LOGGING
4509 In order to define logging settings that are local to a subtree or a
4510 single item, define a LOGGING property in this entry.  Any non-empty
4511 LOGGING property resets all logging settings to @code{nil}.  You may then turn
4512 on logging for this specific tree using STARTUP keywords like
4513 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4514 settings like @code{TODO(!)}.  For example
4516 @example
4517 * TODO Log each state with only a time
4518   :PROPERTIES:
4519   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4520   :END:
4521 * TODO Only log when switching to WAIT, and when repeating
4522   :PROPERTIES:
4523   :LOGGING: WAIT(@@) logrepeat
4524   :END:
4525 * TODO No logging at all
4526   :PROPERTIES:
4527   :LOGGING: nil
4528   :END:
4529 @end example
4531 @node Tracking your habits
4532 @subsection Tracking your habits
4533 @cindex habits
4535 Org has the ability to track the consistency of a special category of TODOs,
4536 called ``habits''.  A habit has the following properties:
4538 @enumerate
4539 @item
4540 You have enabled the @code{habits} module by customizing @code{org-modules}.
4541 @item
4542 The habit is a TODO item, with a TODO keyword representing an open state.
4543 @item
4544 The property @code{STYLE} is set to the value @code{habit}.
4545 @item
4546 The TODO has a scheduled date, usually with a @code{.+} style repeat
4547 interval.  A @code{++} style may be appropriate for habits with time
4548 constraints, e.g., must be done on weekends, or a @code{+} style for an
4549 unusual habit that can have a backlog, e.g., weekly reports.
4550 @item
4551 The TODO may also have minimum and maximum ranges specified by using the
4552 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4553 three days, but at most every two days.
4554 @item
4555 You must also have state logging for the @code{DONE} state enabled
4556 (@pxref{Tracking TODO state changes}), in order for historical data to be
4557 represented in the consistency graph.  If it is not enabled it is not an
4558 error, but the consistency graphs will be largely meaningless.
4559 @end enumerate
4561 To give you an idea of what the above rules look like in action, here's an
4562 actual habit with some history:
4564 @example
4565 ** TODO Shave
4566    SCHEDULED: <2009-10-17 Sat .+2d/4d>
4567    :PROPERTIES:
4568    :STYLE:    habit
4569    :LAST_REPEAT: [2009-10-19 Mon 00:36]
4570    :END:
4571    - State "DONE"       from "TODO"       [2009-10-15 Thu]
4572    - State "DONE"       from "TODO"       [2009-10-12 Mon]
4573    - State "DONE"       from "TODO"       [2009-10-10 Sat]
4574    - State "DONE"       from "TODO"       [2009-10-04 Sun]
4575    - State "DONE"       from "TODO"       [2009-10-02 Fri]
4576    - State "DONE"       from "TODO"       [2009-09-29 Tue]
4577    - State "DONE"       from "TODO"       [2009-09-25 Fri]
4578    - State "DONE"       from "TODO"       [2009-09-19 Sat]
4579    - State "DONE"       from "TODO"       [2009-09-16 Wed]
4580    - State "DONE"       from "TODO"       [2009-09-12 Sat]
4581 @end example
4583 What this habit says is: I want to shave at most every 2 days (given by the
4584 @code{SCHEDULED} date and repeat interval) and at least every 4 days.  If
4585 today is the 15th, then the habit first appears in the agenda on Oct 17,
4586 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4587 after four days have elapsed.
4589 What's really useful about habits is that they are displayed along with a
4590 consistency graph, to show how consistent you've been at getting that task
4591 done in the past.  This graph shows every day that the task was done over the
4592 past three weeks, with colors for each day.  The colors used are:
4594 @table @code
4595 @item Blue
4596 If the task wasn't to be done yet on that day.
4597 @item Green
4598 If the task could have been done on that day.
4599 @item Yellow
4600 If the task was going to be overdue the next day.
4601 @item Red
4602 If the task was overdue on that day.
4603 @end table
4605 In addition to coloring each day, the day is also marked with an asterisk if
4606 the task was actually done that day, and an exclamation mark to show where
4607 the current day falls in the graph.
4609 There are several configuration variables that can be used to change the way
4610 habits are displayed in the agenda.
4612 @table @code
4613 @item org-habit-graph-column
4614 The buffer column at which the consistency graph should be drawn.  This will
4615 overwrite any text in that column, so it is a good idea to keep your habits'
4616 titles brief and to the point.
4617 @item org-habit-preceding-days
4618 The amount of history, in days before today, to appear in consistency graphs.
4619 @item org-habit-following-days
4620 The number of days after today that will appear in consistency graphs.
4621 @item org-habit-show-habits-only-for-today
4622 If non-@code{nil}, only show habits in today's agenda view.  This is set to true by
4623 default.
4624 @end table
4626 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4627 temporarily be disabled and they won't appear at all.  Press @kbd{K} again to
4628 bring them back.  They are also subject to tag filtering, if you have habits
4629 which should only be done in certain contexts, for example.
4631 @node Priorities
4632 @section Priorities
4633 @cindex priorities
4635 If you use Org mode extensively, you may end up with enough TODO items that
4636 it starts to make sense to prioritize them.  Prioritizing can be done by
4637 placing a @emph{priority cookie} into the headline of a TODO item, like this
4639 @example
4640 *** TODO [#A] Write letter to Sam Fortune
4641 @end example
4643 @noindent
4644 @vindex org-priority-faces
4645 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4646 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie is
4647 treated just like priority @samp{B}.  Priorities make a difference only for
4648 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4649 have no inherent meaning to Org mode.  The cookies can be highlighted with
4650 special faces by customizing @code{org-priority-faces}.
4652 Priorities can be attached to any outline node; they do not need to be TODO
4653 items.
4655 @table @kbd
4656 @item @kbd{C-c ,}
4657 @kindex @kbd{C-c ,}
4658 @findex org-priority
4659 Set the priority of the current headline (@command{org-priority}).  The
4660 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4661 When you press @key{SPC} instead, the priority cookie is removed from the
4662 headline.  The priorities can also be changed ``remotely'' from the timeline
4663 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4665 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4666 @vindex org-priority-start-cycle-with-default
4667 Increase/decrease priority of current headline@footnote{See also the option
4668 @code{org-priority-start-cycle-with-default}.}.  Note that these keys are
4669 also used to modify timestamps (@pxref{Creating timestamps}).  See also
4670 @ref{Conflicts}, for a discussion of the interaction with
4671 @code{shift-selection-mode}.
4672 @end table
4674 @vindex org-highest-priority
4675 @vindex org-lowest-priority
4676 @vindex org-default-priority
4677 You can change the range of allowed priorities by setting the options
4678 @code{org-highest-priority}, @code{org-lowest-priority}, and
4679 @code{org-default-priority}.  For an individual buffer, you may set
4680 these values (highest, lowest, default) like this (please make sure that
4681 the highest priority is earlier in the alphabet than the lowest
4682 priority):
4684 @cindex #+PRIORITIES
4685 @example
4686 #+PRIORITIES: A C B
4687 @end example
4689 @node Breaking down tasks
4690 @section Breaking tasks down into subtasks
4691 @cindex tasks, breaking down
4692 @cindex statistics, for TODO items
4694 @vindex org-agenda-todo-list-sublevels
4695 It is often advisable to break down large tasks into smaller, manageable
4696 subtasks.  You can do this by creating an outline tree below a TODO item,
4697 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4698 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.  To keep
4699 the overview over the fraction of subtasks that are already completed, insert
4700 either @samp{[/]} or @samp{[%]} anywhere in the headline.  These cookies will
4701 be updated each time the TODO status of a child changes, or when pressing
4702 @kbd{C-c C-c} on the cookie.  For example:
4704 @example
4705 * Organize Party [33%]
4706 ** TODO Call people [1/2]
4707 *** TODO Peter
4708 *** DONE Sarah
4709 ** TODO Buy food
4710 ** DONE Talk to neighbor
4711 @end example
4713 @cindex property, COOKIE_DATA
4714 If a heading has both checkboxes and TODO children below it, the meaning of
4715 the statistics cookie become ambiguous.  Set the property
4716 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4717 this issue.
4719 @vindex org-hierarchical-todo-statistics
4720 If you would like to have the statistics cookie count any TODO entries in the
4721 subtree (not just direct children), configure
4722 @code{org-hierarchical-todo-statistics}.  To do this for a single subtree,
4723 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4724 property.
4726 @example
4727 * Parent capturing statistics [2/20]
4728   :PROPERTIES:
4729   :COOKIE_DATA: todo recursive
4730   :END:
4731 @end example
4733 If you would like a TODO entry to automatically change to DONE
4734 when all children are done, you can use the following setup:
4736 @example
4737 (defun org-summary-todo (n-done n-not-done)
4738   "Switch entry to DONE when all subentries are done, to TODO otherwise."
4739   (let (org-log-done org-log-states)   ; turn off logging
4740     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4742 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4743 @end example
4746 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4747 large number of subtasks (@pxref{Checkboxes}).
4750 @node Checkboxes
4751 @section Checkboxes
4752 @cindex checkboxes
4754 @vindex org-list-automatic-rules
4755 Every item in a plain list@footnote{With the exception of description
4756 lists.  But you can allow it by modifying @code{org-list-automatic-rules}
4757 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4758 it with the string @samp{[ ]}.  This feature is similar to TODO items
4759 (@pxref{TODO items}), but is more lightweight.  Checkboxes are not included
4760 in the global TODO list, so they are often great to split a task into a
4761 number of simple steps.  Or you can use them in a shopping list.  To toggle a
4762 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4763 @file{org-mouse.el}).
4765 Here is an example of a checkbox list.
4767 @example
4768 * TODO Organize party [2/4]
4769   - [-] call people [1/3]
4770     - [ ] Peter
4771     - [X] Sarah
4772     - [ ] Sam
4773   - [X] order food
4774   - [ ] think about what music to play
4775   - [X] talk to the neighbors
4776 @end example
4778 Checkboxes work hierarchically, so if a checkbox item has children that
4779 are checkboxes, toggling one of the children checkboxes will make the
4780 parent checkbox reflect if none, some, or all of the children are
4781 checked.
4783 @cindex statistics, for checkboxes
4784 @cindex checkbox statistics
4785 @cindex property, COOKIE_DATA
4786 @vindex org-checkbox-hierarchical-statistics
4787 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4788 indicating how many checkboxes present in this entry have been checked off,
4789 and the total number of checkboxes present.  This can give you an idea on how
4790 many checkboxes remain, even without opening a folded entry.  The cookies can
4791 be placed into a headline or into (the first line of) a plain list item.
4792 Each cookie covers checkboxes of direct children structurally below the
4793 headline/item on which the cookie appears@footnote{Set the option
4794 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4795 count all checkboxes below the cookie, not just those belonging to direct
4796 children.}.  You have to insert the cookie yourself by typing either
4797 @samp{[/]} or @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m}
4798 result, as in the examples above.  With @samp{[%]} you get information about
4799 the percentage of checkboxes checked (in the above example, this would be
4800 @samp{[50%]} and @samp{[33%]}, respectively).  In a headline, a cookie can
4801 count either checkboxes below the heading or TODO states of children, and it
4802 will display whatever was changed last.  Set the property @code{COOKIE_DATA}
4803 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4805 @cindex blocking, of checkboxes
4806 @cindex checkbox blocking
4807 @cindex property, ORDERED
4808 If the current outline node has an @code{ORDERED} property, checkboxes must
4809 be checked off in sequence, and an error will be thrown if you try to check
4810 off a box while there are unchecked boxes above it.
4812 @noindent The following commands work with checkboxes:
4814 @table @kbd
4815 @orgcmd{C-c C-c,org-toggle-checkbox}
4816 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4817 With a single prefix argument, add an empty checkbox or remove the current
4818 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4819 will add checkboxes to the rest of the list.}.  With a double prefix argument, set it to @samp{[-]}, which is
4820 considered to be an intermediate state.
4821 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4822 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
4823 double prefix argument, set it to @samp{[-]}, which is considered to be an
4824 intermediate state.
4825 @itemize @minus
4826 @item
4827 If there is an active region, toggle the first checkbox in the region
4828 and set all remaining boxes to the same status as the first.  With a prefix
4829 arg, add or remove the checkbox for all items in the region.
4830 @item
4831 If the cursor is in a headline, toggle checkboxes in the region between
4832 this headline and the next (so @emph{not} the entire subtree).
4833 @item
4834 If there is no active region, just toggle the checkbox at point.
4835 @end itemize
4836 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4837 Insert a new item with a checkbox.  This works only if the cursor is already
4838 in a plain list item (@pxref{Plain lists}).
4839 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4840 @vindex org-track-ordered-property-with-tag
4841 @cindex property, ORDERED
4842 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4843 be checked off in sequence.  A property is used for this behavior because
4844 this should be local to the current entry, not inherited like a tag.
4845 However, if you would like to @i{track} the value of this property with a tag
4846 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4847 @orgcmd{C-c #,org-update-statistics-cookies}
4848 Update the statistics cookie in the current outline entry.  When called with
4849 a @kbd{C-u} prefix, update the entire file.  Checkbox statistic cookies are
4850 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4851 new ones with @kbd{M-S-@key{RET}}.  TODO statistics cookies update when
4852 changing TODO states.  If you delete boxes/entries or add/change them by
4853 hand, use this command to get things back into sync.
4854 @end table
4856 @node Tags
4857 @chapter Tags
4858 @cindex tags
4859 @cindex headline tagging
4860 @cindex matching, tags
4861 @cindex sparse tree, tag based
4863 An excellent way to implement labels and contexts for cross-correlating
4864 information is to assign @i{tags} to headlines.  Org mode has extensive
4865 support for tags.
4867 @vindex org-tag-faces
4868 Every headline can contain a list of tags; they occur at the end of the
4869 headline.  Tags are normal words containing letters, numbers, @samp{_}, and
4870 @samp{@@}.  Tags must be preceded and followed by a single colon, e.g.,
4871 @samp{:work:}.  Several tags can be specified, as in @samp{:work:urgent:}.
4872 Tags will by default be in bold face with the same color as the headline.
4873 You may specify special faces for specific tags using the option
4874 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4875 (@pxref{Faces for TODO keywords}).
4877 @menu
4878 * Tag inheritance::             Tags use the tree structure of the outline
4879 * Setting tags::                How to assign tags to a headline
4880 * Tag groups::                  Use one tag to search for several tags
4881 * Tag searches::                Searching for combinations of tags
4882 @end menu
4884 @node Tag inheritance
4885 @section Tag inheritance
4886 @cindex tag inheritance
4887 @cindex inheritance, of tags
4888 @cindex sublevels, inclusion into tags match
4890 @i{Tags} make use of the hierarchical structure of outline trees.  If a
4891 heading has a certain tag, all subheadings will inherit the tag as
4892 well.  For example, in the list
4894 @example
4895 * Meeting with the French group      :work:
4896 ** Summary by Frank                  :boss:notes:
4897 *** TODO Prepare slides for him      :action:
4898 @end example
4900 @noindent
4901 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4902 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4903 explicitly marked with those tags.  You can also set tags that all entries in
4904 a file should inherit just as if these tags were defined in a hypothetical
4905 level zero that surrounds the entire file.  Use a line like this@footnote{As
4906 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4907 changes in the line.}:
4909 @cindex #+FILETAGS
4910 @example
4911 #+FILETAGS: :Peter:Boss:Secret:
4912 @end example
4914 @noindent
4915 @vindex org-use-tag-inheritance
4916 @vindex org-tags-exclude-from-inheritance
4917 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4918 To turn it off entirely, use @code{org-use-tag-inheritance}.
4920 @vindex org-tags-match-list-sublevels
4921 When a headline matches during a tags search while tag inheritance is turned
4922 on, all the sublevels in the same tree will (for a simple match form) match
4923 as well@footnote{This is only true if the search does not involve more
4924 complex tests including properties (@pxref{Property searches}).}.  The list
4925 of matches may then become very long.  If you only want to see the first tags
4926 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4927 recommended).
4929 @vindex org-agenda-use-tag-inheritance
4930 Tag inheritance is relevant when the agenda search tries to match a tag,
4931 either in the @code{tags} or @code{tags-todo} agenda types.  In other agenda
4932 types, @code{org-use-tag-inheritance} has no effect.  Still, you may want to
4933 have your tags correctly set in the agenda, so that tag filtering works fine,
4934 with inherited tags.  Set @code{org-agenda-use-tag-inheritance} to control
4935 this: the default value includes all agenda types, but setting this to @code{nil}
4936 can really speed up agenda generation.
4938 @node Setting tags
4939 @section Setting tags
4940 @cindex setting tags
4941 @cindex tags, setting
4943 @kindex M-@key{TAB}
4944 Tags can simply be typed into the buffer at the end of a headline.
4945 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
4946 also a special command for inserting tags:
4948 @table @kbd
4949 @orgcmd{C-c C-q,org-set-tags-command}
4950 @cindex completion, of tags
4951 @vindex org-tags-column
4952 Enter new tags for the current headline.  Org mode will either offer
4953 completion or a special single-key interface for setting tags, see
4954 below.  After pressing @key{RET}, the tags will be inserted and aligned
4955 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
4956 tags in the current buffer will be aligned to that column, just to make
4957 things look nice.  TAGS are automatically realigned after promotion,
4958 demotion, and TODO state changes (@pxref{TODO basics}).
4960 @orgcmd{C-c C-c,org-set-tags-command}
4961 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4962 @end table
4964 @vindex org-tag-alist
4965 Org supports tag insertion based on a @emph{list of tags}.  By
4966 default this list is constructed dynamically, containing all tags
4967 currently used in the buffer.  You may also globally specify a hard list
4968 of tags with the variable @code{org-tag-alist}.  Finally you can set
4969 the default tags for a given file with lines like
4971 @cindex #+TAGS
4972 @example
4973 #+TAGS: @@work @@home @@tennisclub
4974 #+TAGS: laptop car pc sailboat
4975 @end example
4977 If you have globally defined your preferred set of tags using the
4978 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4979 in a specific file, add an empty TAGS option line to that file:
4981 @example
4982 #+TAGS:
4983 @end example
4985 @vindex org-tag-persistent-alist
4986 If you have a preferred set of tags that you would like to use in every file,
4987 in addition to those defined on a per-file basis by TAGS option lines, then
4988 you may specify a list of tags with the variable
4989 @code{org-tag-persistent-alist}.  You may turn this off on a per-file basis
4990 by adding a STARTUP option line to that file:
4992 @example
4993 #+STARTUP: noptag
4994 @end example
4996 By default Org mode uses the standard minibuffer completion facilities for
4997 entering tags.  However, it also implements another, quicker, tag selection
4998 method called @emph{fast tag selection}.  This allows you to select and
4999 deselect tags with just a single key press.  For this to work well you should
5000 assign unique letters to most of your commonly used tags.  You can do this
5001 globally by configuring the variable @code{org-tag-alist} in your
5002 @file{.emacs} file.  For example, you may find the need to tag many items in
5003 different files with @samp{:@@home:}.  In this case you can set something
5004 like:
5006 @lisp
5007 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
5008 @end lisp
5010 @noindent If the tag is only relevant to the file you are working on, then you
5011 can instead set the TAGS option line as:
5013 @example
5014 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
5015 @end example
5017 @noindent The tags interface will show the available tags in a splash
5018 window.  If you want to start a new line after a specific tag, insert
5019 @samp{\n} into the tag list
5021 @example
5022 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t) \n laptop(l)  pc(p)
5023 @end example
5025 @noindent or write them in two lines:
5027 @example
5028 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)
5029 #+TAGS: laptop(l)  pc(p)
5030 @end example
5032 @noindent
5033 You can also group together tags that are mutually exclusive by using
5034 braces, as in:
5036 @example
5037 #+TAGS: @{ @@work(w)  @@home(h)  @@tennisclub(t) @}  laptop(l)  pc(p)
5038 @end example
5040 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
5041 and @samp{@@tennisclub} should be selected.  Multiple such groups are allowed.
5043 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
5044 these lines to activate any changes.
5046 @noindent
5047 To set these mutually exclusive groups in the variable @code{org-tag-alist},
5048 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
5049 of the braces.  Similarly, you can use @code{:newline} to indicate a line
5050 break.  The previous example would be set globally by the following
5051 configuration:
5053 @lisp
5054 (setq org-tag-alist '((:startgroup . nil)
5055                       ("@@work" . ?w) ("@@home" . ?h)
5056                       ("@@tennisclub" . ?t)
5057                       (:endgroup . nil)
5058                       ("laptop" . ?l) ("pc" . ?p)))
5059 @end lisp
5061 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
5062 automatically present you with a special interface, listing inherited tags,
5063 the tags of the current headline, and a list of all valid tags with
5064 corresponding keys@footnote{Keys will automatically be assigned to tags which
5065 have no configured keys.}.  In this interface, you can use the following
5066 keys:
5068 @table @kbd
5069 @item a-z...
5070 Pressing keys assigned to tags will add or remove them from the list of
5071 tags in the current line.  Selecting a tag in a group of mutually
5072 exclusive tags will turn off any other tags from that group.
5073 @kindex @key{TAB}
5074 @item @key{TAB}
5075 Enter a tag in the minibuffer, even if the tag is not in the predefined
5076 list.  You will be able to complete on all tags present in the buffer.
5077 You can also add several tags: just separate them with a comma.
5079 @kindex @key{SPC}
5080 @item @key{SPC}
5081 Clear all tags for this line.
5082 @kindex @key{RET}
5083 @item @key{RET}
5084 Accept the modified set.
5085 @item C-g
5086 Abort without installing changes.
5087 @item q
5088 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5089 @item !
5090 Turn off groups of mutually exclusive tags.  Use this to (as an
5091 exception) assign several tags from such a group.
5092 @item C-c
5093 Toggle auto-exit after the next change (see below).
5094 If you are using expert mode, the first @kbd{C-c} will display the
5095 selection window.
5096 @end table
5098 @noindent
5099 This method lets you assign tags to a headline with very few keys.  With
5100 the above setup, you could clear the current tags and set @samp{@@home},
5101 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5102 C-c @key{SPC} h l p @key{RET}}.  Switching from @samp{@@home} to
5103 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5104 alternatively with @kbd{C-c C-c C-c w}.  Adding the non-predefined tag
5105 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5106 @key{RET} @key{RET}}.
5108 @vindex org-fast-tag-selection-single-key
5109 If you find that most of the time you need only a single key press to
5110 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5111 Then you no longer have to press @key{RET} to exit fast tag selection---it
5112 will immediately exit after the first change.  If you then occasionally
5113 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5114 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5115 instead of @kbd{C-c C-c}).  If you set the variable to the value
5116 @code{expert}, the special window is not even shown for single-key tag
5117 selection, it comes up only when you press an extra @kbd{C-c}.
5119 @node Tag groups
5120 @section Tag groups
5122 @cindex group tags
5123 @cindex tags, groups
5124 In a set of mutually exclusive tags, the first tag can be defined as a
5125 @emph{group tag}.  When you search for a group tag, it will return matches
5126 for all members in the group.  In an agenda view, filtering by a group tag
5127 will display headlines tagged with at least one of the members of the
5128 group.  This makes tag searches and filters even more flexible.
5130 You can set group tags by inserting a colon between the group tag and other
5131 tags---beware that all whitespaces are mandatory so that Org can parse this
5132 line correctly:
5134 @example
5135 #+TAGS: @{ @@read : @@read_book @@read_ebook @}
5136 @end example
5138 In this example, @samp{@@read} is a @emph{group tag} for a set of three
5139 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
5141 You can also use the @code{:grouptags} keyword directly when setting
5142 @code{org-tag-alist}:
5144 @lisp
5145 (setq org-tag-alist '((:startgroup . nil)
5146                       ("@@read" . nil)
5147                       (:grouptags . nil)
5148                       ("@@read_book" . nil)
5149                       ("@@read_ebook" . nil)
5150                       (:endgroup . nil)))
5151 @end lisp
5153 You cannot nest group tags or use a group tag as a tag in another group.
5155 @kindex C-c C-x q
5156 @vindex org-group-tags
5157 If you want to ignore group tags temporarily, toggle group tags support
5158 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}.  If you
5159 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5161 @node Tag searches
5162 @section Tag searches
5163 @cindex tag searches
5164 @cindex searching for tags
5166 Once a system of tags has been set up, it can be used to collect related
5167 information into special lists.
5169 @table @kbd
5170 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5171 Create a sparse tree with all headlines matching a tags/property/TODO search.
5172 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5173 @xref{Matching tags and properties}.
5174 @orgcmd{C-c a m,org-tags-view}
5175 Create a global list of tag matches from all agenda files.  @xref{Matching
5176 tags and properties}.
5177 @orgcmd{C-c a M,org-tags-view}
5178 @vindex org-tags-match-list-sublevels
5179 Create a global list of tag matches from all agenda files, but check
5180 only TODO items and force checking subitems (see the option
5181 @code{org-tags-match-list-sublevels}).
5182 @end table
5184 These commands all prompt for a match string which allows basic Boolean logic
5185 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5186 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5187 which are tagged, like @samp{Kathy} or @samp{Sally}.  The full syntax of the search
5188 string is rich and allows also matching against TODO keywords, entry levels
5189 and properties.  For a complete description with many examples, see
5190 @ref{Matching tags and properties}.
5193 @node Properties and columns
5194 @chapter Properties and columns
5195 @cindex properties
5197 A property is a key-value pair associated with an entry.  Properties can be
5198 set so they are associated with a single entry, with every entry in a tree,
5199 or with every entry in an Org mode file.
5201 There are two main applications for properties in Org mode.  First,
5202 properties are like tags, but with a value.  Imagine maintaining a file where
5203 you document bugs and plan releases for a piece of software.  Instead of
5204 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5205 property, say @code{:Release:}, that in different subtrees has different
5206 values, such as @code{1.0} or @code{2.0}.  Second, you can use properties to
5207 implement (very basic) database capabilities in an Org buffer.  Imagine
5208 keeping track of your music CDs, where properties could be things such as the
5209 album, artist, date of release, number of tracks, and so on.
5211 Properties can be conveniently edited and viewed in column view
5212 (@pxref{Column view}).
5214 @menu
5215 * Property syntax::             How properties are spelled out
5216 * Special properties::          Access to other Org mode features
5217 * Property searches::           Matching property values
5218 * Property inheritance::        Passing values down the tree
5219 * Column view::                 Tabular viewing and editing
5220 * Property API::                Properties for Lisp programmers
5221 @end menu
5223 @node Property syntax
5224 @section Property syntax
5225 @cindex property syntax
5226 @cindex drawer, for properties
5228 Properties are key-value pairs.  When they are associated with a single entry
5229 or with a tree they need to be inserted into a special drawer
5230 (@pxref{Drawers}) with the name @code{PROPERTIES}, which has to be located
5231 right below a headline, and its planning line (@pxref{Deadlines and
5232 scheduling}) when applicable.  Each property is specified on a single line,
5233 with the key (surrounded by colons) first, and the value after it.  Keys are
5234 case-insensitives.  Here is an example:
5236 @example
5237 * CD collection
5238 ** Classic
5239 *** Goldberg Variations
5240     :PROPERTIES:
5241     :Title:     Goldberg Variations
5242     :Composer:  J.S. Bach
5243     :Artist:    Glen Gould
5244     :Publisher: Deutsche Grammophon
5245     :NDisks:    1
5246     :END:
5247 @end example
5249 Depending on the value of @code{org-use-property-inheritance}, a property set
5250 this way will either be associated with a single entry, or the subtree
5251 defined by the entry, see @ref{Property inheritance}.
5253 You may define the allowed values for a particular property @samp{:Xyz:}
5254 by setting a property @samp{:Xyz_ALL:}.  This special property is
5255 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5256 the entire tree.  When allowed values are defined, setting the
5257 corresponding property becomes easier and is less prone to typing
5258 errors.  For the example with the CD collection, we can predefine
5259 publishers and the number of disks in a box like this:
5261 @example
5262 * CD collection
5263   :PROPERTIES:
5264   :NDisks_ALL:  1 2 3 4
5265   :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5266   :END:
5267 @end example
5269 If you want to set properties that can be inherited by any entry in a
5270 file, use a line like
5271 @cindex property, _ALL
5272 @cindex #+PROPERTY
5273 @example
5274 #+PROPERTY: NDisks_ALL 1 2 3 4
5275 @end example
5277 Contrary to properties set from a special drawer, you have to refresh the
5278 buffer with @kbd{C-c C-c} to activate this change.
5280 If you want to add to the value of an existing property, append a @code{+} to
5281 the property name.  The following results in the property @code{var} having
5282 the value ``foo=1 bar=2''.
5283 @cindex property, +
5284 @example
5285 #+PROPERTY: var  foo=1
5286 #+PROPERTY: var+ bar=2
5287 @end example
5289 It is also possible to add to the values of inherited properties.  The
5290 following results in the @code{genres} property having the value ``Classic
5291 Baroque'' under the @code{Goldberg Variations} subtree.
5292 @cindex property, +
5293 @example
5294 * CD collection
5295 ** Classic
5296     :PROPERTIES:
5297     :GENRES: Classic
5298     :END:
5299 *** Goldberg Variations
5300     :PROPERTIES:
5301     :Title:     Goldberg Variations
5302     :Composer:  J.S. Bach
5303     :Artist:    Glen Gould
5304     :Publisher: Deutsche Grammophon
5305     :NDisks:    1
5306     :GENRES+:   Baroque
5307     :END:
5308 @end example
5309 Note that a property can only have one entry per Drawer.
5311 @vindex org-global-properties
5312 Property values set with the global variable
5313 @code{org-global-properties} can be inherited by all entries in all
5314 Org files.
5316 @noindent
5317 The following commands help to work with properties:
5319 @table @kbd
5320 @orgcmd{M-@key{TAB},pcomplete}
5321 After an initial colon in a line, complete property keys.  All keys used
5322 in the current file will be offered as possible completions.
5323 @orgcmd{C-c C-x p,org-set-property}
5324 Set a property.  This prompts for a property name and a value.  If
5325 necessary, the property drawer is created as well.
5326 @item C-u M-x org-insert-drawer RET
5327 @cindex org-insert-drawer
5328 Insert a property drawer into the current entry.  The drawer will be
5329 inserted early in the entry, but after the lines with planning
5330 information like deadlines.
5331 @orgcmd{C-c C-c,org-property-action}
5332 With the cursor in a property drawer, this executes property commands.
5333 @orgcmd{C-c C-c s,org-set-property}
5334 Set a property in the current entry.  Both the property and the value
5335 can be inserted using completion.
5336 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5337 Switch property at point to the next/previous allowed value.
5338 @orgcmd{C-c C-c d,org-delete-property}
5339 Remove a property from the current entry.
5340 @orgcmd{C-c C-c D,org-delete-property-globally}
5341 Globally remove a property, from all entries in the current file.
5342 @orgcmd{C-c C-c c,org-compute-property-at-point}
5343 Compute the property at point, using the operator and scope from the
5344 nearest column format definition.
5345 @end table
5347 @node Special properties
5348 @section Special properties
5349 @cindex properties, special
5351 Special properties provide an alternative access method to Org mode features,
5352 like the TODO state or the priority of an entry, discussed in the previous
5353 chapters.  This interface exists so that you can include these states in
5354 a column view (@pxref{Column view}), or to use them in queries.  The
5355 following property names are special and (except for @code{:CATEGORY:})
5356 should not be used as keys in the properties drawer:
5358 @cindex property, special, ALLTAGS
5359 @cindex property, special, BLOCKED
5360 @cindex property, special, CATEGORY
5361 @cindex property, special, CLOCKSUM
5362 @cindex property, special, CLOCKSUM_T
5363 @cindex property, special, CLOSED
5364 @cindex property, special, DEADLINE
5365 @cindex property, special, FILE
5366 @cindex property, special, ITEM
5367 @cindex property, special, PRIORITY
5368 @cindex property, special, SCHEDULED
5369 @cindex property, special, TAGS
5370 @cindex property, special, TIMESTAMP
5371 @cindex property, special, TIMESTAMP_IA
5372 @cindex property, special, TODO
5373 @example
5374 ALLTAGS      @r{All tags, including inherited ones.}
5375 BLOCKED      @r{"t" if task is currently blocked by children or siblings.}
5376 CATEGORY     @r{The category of an entry.}
5377 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
5378              @r{must be run first to compute the values in the current buffer.}
5379 CLOCKSUM_T   @r{The sum of CLOCK intervals in the subtree for today.}
5380              @r{@code{org-clock-sum-today} must be run first to compute the}
5381              @r{values in the current buffer.}
5382 CLOSED       @r{When was this entry closed?}
5383 DEADLINE     @r{The deadline time string, without the angular brackets.}
5384 FILE         @r{The filename the entry is located in.}
5385 ITEM         @r{The headline of the entry, with stars.}
5386 PRIORITY     @r{The priority of the entry, a string with a single letter.}
5387 SCHEDULED    @r{The scheduling timestamp, without the angular brackets.}
5388 TAGS         @r{The tags defined directly in the headline.}
5389 TIMESTAMP    @r{The first keyword-less timestamp in the entry.}
5390 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5391 TODO         @r{The TODO keyword of the entry.}
5392 @end example
5394 @node Property searches
5395 @section Property searches
5396 @cindex properties, searching
5397 @cindex searching, of properties
5399 To create sparse trees and special lists with selection based on properties,
5400 the same commands are used as for tag searches (@pxref{Tag searches}).
5402 @table @kbd
5403 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5404 Create a sparse tree with all matching entries.  With a
5405 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5406 @orgcmd{C-c a m,org-tags-view}
5407 Create a global list of tag/property  matches from all agenda files.
5408 @xref{Matching tags and properties}.
5409 @orgcmd{C-c a M,org-tags-view}
5410 @vindex org-tags-match-list-sublevels
5411 Create a global list of tag matches from all agenda files, but check
5412 only TODO items and force checking of subitems (see the option
5413 @code{org-tags-match-list-sublevels}).
5414 @end table
5416 The syntax for the search string is described in @ref{Matching tags and
5417 properties}.
5419 There is also a special command for creating sparse trees based on a
5420 single property:
5422 @table @kbd
5423 @orgkey{C-c / p}
5424 Create a sparse tree based on the value of a property.  This first
5425 prompts for the name of a property, and then for a value.  A sparse tree
5426 is created with all entries that define this property with the given
5427 value.  If you enclose the value in curly braces, it is interpreted as
5428 a regular expression and matched against the property values.
5429 @end table
5431 @node Property inheritance
5432 @section Property Inheritance
5433 @cindex properties, inheritance
5434 @cindex inheritance, of properties
5436 @vindex org-use-property-inheritance
5437 The outline structure of Org mode documents lends itself to an
5438 inheritance model of properties: if the parent in a tree has a certain
5439 property, the children can inherit this property.  Org mode does not
5440 turn this on by default, because it can slow down property searches
5441 significantly and is often not needed.  However, if you find inheritance
5442 useful, you can turn it on by setting the variable
5443 @code{org-use-property-inheritance}.  It may be set to @code{t} to make
5444 all properties inherited from the parent, to a list of properties
5445 that should be inherited, or to a regular expression that matches
5446 inherited properties.  If a property has the value @code{nil}, this is
5447 interpreted as an explicit undefine of the property, so that inheritance
5448 search will stop at this value and return @code{nil}.
5450 Org mode has a few properties for which inheritance is hard-coded, at
5451 least for the special applications for which they are used:
5453 @cindex property, COLUMNS
5454 @table @code
5455 @item COLUMNS
5456 The @code{:COLUMNS:} property defines the format of column view
5457 (@pxref{Column view}).  It is inherited in the sense that the level
5458 where a @code{:COLUMNS:} property is defined is used as the starting
5459 point for a column view table, independently of the location in the
5460 subtree from where columns view is turned on.
5461 @item CATEGORY
5462 @cindex property, CATEGORY
5463 For agenda view, a category set through a @code{:CATEGORY:} property
5464 applies to the entire subtree.
5465 @item ARCHIVE
5466 @cindex property, ARCHIVE
5467 For archiving, the @code{:ARCHIVE:} property may define the archive
5468 location for the entire subtree (@pxref{Moving subtrees}).
5469 @item LOGGING
5470 @cindex property, LOGGING
5471 The LOGGING property may define logging settings for an entry or a
5472 subtree (@pxref{Tracking TODO state changes}).
5473 @end table
5475 @node Column view
5476 @section Column view
5478 A great way to view and edit properties in an outline tree is
5479 @emph{column view}.  In column view, each outline node is turned into a
5480 table row.  Columns in this table provide access to properties of the
5481 entries.  Org mode implements columns by overlaying a tabular structure
5482 over the headline of each item.  While the headlines have been turned
5483 into a table row, you can still change the visibility of the outline
5484 tree.  For example, you get a compact table by switching to CONTENTS
5485 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5486 is active), but you can still open, read, and edit the entry below each
5487 headline.  Or, you can switch to column view after executing a sparse
5488 tree command and in this way get a table only for the selected items.
5489 Column view also works in agenda buffers (@pxref{Agenda views}) where
5490 queries have collected selected items, possibly from a number of files.
5492 @menu
5493 * Defining columns::            The COLUMNS format property
5494 * Using column view::           How to create and use column view
5495 * Capturing column view::       A dynamic block for column view
5496 @end menu
5498 @node Defining columns
5499 @subsection Defining columns
5500 @cindex column view, for properties
5501 @cindex properties, column view
5503 Setting up a column view first requires defining the columns.  This is
5504 done by defining a column format line.
5506 @menu
5507 * Scope of column definitions::  Where defined, where valid?
5508 * Column attributes::           Appearance and content of a column
5509 @end menu
5511 @node Scope of column definitions
5512 @subsubsection Scope of column definitions
5514 To define a column format for an entire file, use a line like
5516 @cindex #+COLUMNS
5517 @example
5518 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5519 @end example
5521 To specify a format that only applies to a specific tree, add a
5522 @code{:COLUMNS:} property to the top node of that tree, for example:
5524 @example
5525 ** Top node for columns view
5526    :PROPERTIES:
5527    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5528    :END:
5529 @end example
5531 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5532 for the entry itself, and for the entire subtree below it.  Since the
5533 column definition is part of the hierarchical structure of the document,
5534 you can define columns on level 1 that are general enough for all
5535 sublevels, and more specific columns further down, when you edit a
5536 deeper part of the tree.
5538 @node Column attributes
5539 @subsubsection Column attributes
5540 A column definition sets the attributes of a column.  The general
5541 definition looks like this:
5543 @example
5544  %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5545 @end example
5547 @noindent
5548 Except for the percent sign and the property name, all items are
5549 optional.  The individual parts have the following meaning:
5551 @example
5552 @var{width}           @r{An integer specifying the width of the column in characters.}
5553                 @r{If omitted, the width will be determined automatically.}
5554 @var{property}        @r{The property that should be edited in this column.}
5555                 @r{Special properties representing meta data are allowed here}
5556                 @r{as well (@pxref{Special properties})}
5557 @var{title}           @r{The header text for the column.  If omitted, the property}
5558                 @r{name is used.}
5559 @{@var{summary-type}@}  @r{The summary type.  If specified, the column values for}
5560                 @r{parent nodes are computed from the children.}
5561                 @r{Supported summary types are:}
5562                 @{+@}       @r{Sum numbers in this column.}
5563                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
5564                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
5565                 @{:@}       @r{Sum times, HH:MM, plain numbers are hours.}
5566                 @{X@}       @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5567                 @{X/@}      @r{Checkbox status, @samp{[n/m]}.}
5568                 @{X%@}      @r{Checkbox status, @samp{[n%]}.}
5569                 @{min@}     @r{Smallest number in column.}
5570                 @{max@}     @r{Largest number.}
5571                 @{mean@}    @r{Arithmetic mean of numbers.}
5572                 @{:min@}    @r{Smallest time value in column.}
5573                 @{:max@}    @r{Largest time value.}
5574                 @{:mean@}   @r{Arithmetic mean of time values.}
5575                 @{@@min@}    @r{Minimum age (in days/hours/mins/seconds).}
5576                 @{@@max@}    @r{Maximum age (in days/hours/mins/seconds).}
5577                 @{@@mean@}   @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5578                 @{est+@}    @r{Add @samp{low-high} estimates.}
5579 @end example
5581 @noindent
5582 Be aware that you can only have one summary type for any property you
5583 include.  Subsequent columns referencing the same property will all display the
5584 same summary information.
5586 The @code{est+} summary type requires further explanation.  It is used for
5587 combining estimates, expressed as @samp{low-high} ranges or plain numbers.
5588 For example, instead of estimating a particular task will take 5 days, you
5589 might estimate it as 5--6 days if you're fairly confident you know how much
5590 work is required, or 1--10 days if you don't really know what needs to be
5591 done.  Both ranges average at 5.5 days, but the first represents a more
5592 predictable delivery.
5594 When combining a set of such estimates, simply adding the lows and highs
5595 produces an unrealistically wide result.  Instead, @code{est+} adds the
5596 statistical mean and variance of the sub-tasks, generating a final estimate
5597 from the sum.  For example, suppose you had ten tasks, each of which was
5598 estimated at 0.5 to 2 days of work.  Straight addition produces an estimate
5599 of 5 to 20 days, representing what to expect if everything goes either
5600 extremely well or extremely poorly.  In contrast, @code{est+} estimates the
5601 full job more realistically, at 10--15 days.
5603 Numbers are right-aligned when a format specifier with an explicit width like
5604 @code{%5d} or @code{%5.1f} is used.
5606 Here is an example for a complete columns definition, along with allowed
5607 values.
5609 @example
5610 :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.}
5611                    %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5612 :Owner_ALL:    Tammy Mark Karl Lisa Don
5613 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
5614 :Approved_ALL: "[ ]" "[X]"
5615 @end example
5617 @noindent
5618 The first column, @samp{%25ITEM}, means the first 25 characters of the
5619 item itself, i.e., of the headline.  You probably always should start the
5620 column definition with the @samp{ITEM} specifier.  The other specifiers
5621 create columns @samp{Owner} with a list of names as allowed values, for
5622 @samp{Status} with four different possible values, and for a checkbox
5623 field @samp{Approved}.  When no width is given after the @samp{%}
5624 character, the column will be exactly as wide as it needs to be in order
5625 to fully display all values.  The @samp{Approved} column does have a
5626 modified title (@samp{Approved?}, with a question mark).  Summaries will
5627 be created for the @samp{Time_Estimate} column by adding time duration
5628 expressions like HH:MM, and for the @samp{Approved} column, by providing
5629 an @samp{[X]} status if all children have been checked.  The
5630 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5631 sums of CLOCK intervals in the subtree, either for all clocks or just for
5632 today.
5634 @node Using column view
5635 @subsection Using column view
5637 @table @kbd
5638 @tsubheading{Turning column view on and off}
5639 @orgcmd{C-c C-x C-c,org-columns}
5640 @vindex org-columns-default-format
5641 Turn on column view.  If the cursor is before the first headline in the file,
5642 column view is turned on for the entire file, using the @code{#+COLUMNS}
5643 definition.  If the cursor is somewhere inside the outline, this command
5644 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5645 defines a format.  When one is found, the column view table is established
5646 for the tree starting at the entry that contains the @code{:COLUMNS:}
5647 property.  If no such property is found, the format is taken from the
5648 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5649 and column view is established for the current entry and its subtree.
5650 @orgcmd{r,org-columns-redo}
5651 Recreate the column view, to include recent changes made in the buffer.
5652 @orgcmd{g,org-columns-redo}
5653 Same as @kbd{r}.
5654 @orgcmd{q,org-columns-quit}
5655 Exit column view.
5656 @tsubheading{Editing values}
5657 @item @key{left} @key{right} @key{up} @key{down}
5658 Move through the column view from field to field.
5659 @kindex S-@key{left}
5660 @kindex S-@key{right}
5661 @item  S-@key{left}/@key{right}
5662 Switch to the next/previous allowed value of the field.  For this, you
5663 have to have specified allowed values for a property.
5664 @item 1..9,0
5665 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5666 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5667 Same as @kbd{S-@key{left}/@key{right}}
5668 @orgcmd{e,org-columns-edit-value}
5669 Edit the property at point.  For the special properties, this will
5670 invoke the same interface that you normally use to change that
5671 property.  For example, when editing a TAGS property, the tag completion
5672 or fast selection interface will pop up.
5673 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5674 When there is a checkbox at point, toggle it.
5675 @orgcmd{v,org-columns-show-value}
5676 View the full value of this property.  This is useful if the width of
5677 the column is smaller than that of the value.
5678 @orgcmd{a,org-columns-edit-allowed}
5679 Edit the list of allowed values for this property.  If the list is found
5680 in the hierarchy, the modified value is stored there.  If no list is
5681 found, the new value is stored in the first entry that is part of the
5682 current column view.
5683 @tsubheading{Modifying the table structure}
5684 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5685 Make the column narrower/wider by one character.
5686 @orgcmd{S-M-@key{right},org-columns-new}
5687 Insert a new column, to the left of the current column.
5688 @orgcmd{S-M-@key{left},org-columns-delete}
5689 Delete the current column.
5690 @end table
5692 @node Capturing column view
5693 @subsection Capturing column view
5695 Since column view is just an overlay over a buffer, it cannot be
5696 exported or printed directly.  If you want to capture a column view, use
5697 a @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
5698 of this block looks like this:
5700 @cindex #+BEGIN, columnview
5701 @example
5702 * The column view
5703 #+BEGIN: columnview :hlines 1 :id "label"
5705 #+END:
5706 @end example
5708 @noindent This dynamic block has the following parameters:
5710 @table @code
5711 @item :id
5712 This is the most important parameter.  Column view is a feature that is
5713 often localized to a certain (sub)tree, and the capture block might be
5714 at a different location in the file.  To identify the tree whose view to
5715 capture, you can use 4 values:
5716 @cindex property, ID
5717 @example
5718 local     @r{use the tree in which the capture block is located}
5719 global    @r{make a global view, including all headings in the file}
5720 "file:@var{path-to-file}"
5721           @r{run column view at the top of this file}
5722 "@var{ID}"      @r{call column view in the tree that has an @code{:ID:}}
5723           @r{property with the value @i{label}.  You can use}
5724           @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5725           @r{the current entry and copy it to the kill-ring.}
5726 @end example
5727 @item :hlines
5728 When @code{t}, insert an hline after every line.  When a number @var{N}, insert
5729 an hline before each headline with level @code{<= @var{N}}.
5730 @item :vlines
5731 When set to @code{t}, force column groups to get vertical lines.
5732 @item :maxlevel
5733 When set to a number, don't capture entries below this level.
5734 @item :skip-empty-rows
5735 When set to @code{t}, skip rows where the only non-empty specifier of the
5736 column view is @code{ITEM}.
5738 @end table
5740 @noindent
5741 The following commands insert or update the dynamic block:
5743 @table @kbd
5744 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5745 Insert a dynamic block capturing a column view.  You will be prompted
5746 for the scope or ID of the view.
5747 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5748 Update dynamic block at point.  The cursor needs to be in the
5749 @code{#+BEGIN} line of the dynamic block.
5750 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5751 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
5752 you have several clock table blocks, column-capturing blocks or other dynamic
5753 blocks in a buffer.
5754 @end table
5756 You can add formulas to the column view table and you may add plotting
5757 instructions in front of the table---these will survive an update of the
5758 block.  If there is a @code{#+TBLFM:} after the table, the table will
5759 actually be recalculated automatically after an update.
5761 An alternative way to capture and process property values into a table is
5762 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5763 package@footnote{Contributed packages are not part of Emacs, but are
5764 distributed with the main distribution of Org (visit
5765 @uref{http://orgmode.org}).}.  It provides a general API to collect
5766 properties from entries in a certain scope, and arbitrary Lisp expressions to
5767 process these values before inserting them into a table or a dynamic block.
5769 @node Property API
5770 @section The Property API
5771 @cindex properties, API
5772 @cindex API, for properties
5774 There is a full API for accessing and changing properties.  This API can
5775 be used by Emacs Lisp programs to work with properties and to implement
5776 features based on them.  For more information see @ref{Using the
5777 property API}.
5779 @node Dates and times
5780 @chapter Dates and times
5781 @cindex dates
5782 @cindex times
5783 @cindex timestamp
5784 @cindex date stamp
5786 To assist project planning, TODO items can be labeled with a date and/or
5787 a time.  The specially formatted string carrying the date and time
5788 information is called a @emph{timestamp} in Org mode.  This may be a
5789 little confusing because timestamp is often used to indicate when
5790 something was created or last changed.  However, in Org mode this term
5791 is used in a much wider sense.
5793 @menu
5794 * Timestamps::                  Assigning a time to a tree entry
5795 * Creating timestamps::         Commands which insert timestamps
5796 * Deadlines and scheduling::    Planning your work
5797 * Clocking work time::          Tracking how long you spend on a task
5798 * Effort estimates::            Planning work effort in advance
5799 * Timers::                      Notes with a running timer
5800 @end menu
5803 @node Timestamps
5804 @section Timestamps, deadlines, and scheduling
5805 @cindex timestamps
5806 @cindex ranges, time
5807 @cindex date stamps
5808 @cindex deadlines
5809 @cindex scheduling
5811 A timestamp is a specification of a date (possibly with a time or a range of
5812 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5813 simplest form, the day name is optional when you type the date yourself.
5814 However, any dates inserted or modified by Org will add that day name, for
5815 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5816 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5817 date/time format.  To use an alternative format, see @ref{Custom time
5818 format}.}.  A timestamp can appear anywhere in the headline or body of an Org
5819 tree entry.  Its presence causes entries to be shown on specific dates in the
5820 agenda (@pxref{Weekly/daily agenda}).  We distinguish:
5822 @table @var
5823 @item Plain timestamp; Event; Appointment
5824 @cindex timestamp
5825 @cindex appointment
5826 A simple timestamp just assigns a date/time to an item.  This is just
5827 like writing down an appointment or event in a paper agenda.  In the
5828 timeline and agenda displays, the headline of an entry associated with a
5829 plain timestamp will be shown exactly on that date.
5831 @example
5832 * Meet Peter at the movies
5833   <2006-11-01 Wed 19:15>
5834 * Discussion on climate change
5835   <2006-11-02 Thu 20:00-22:00>
5836 @end example
5838 @item Timestamp with repeater interval
5839 @cindex timestamp, with repeater interval
5840 A timestamp may contain a @emph{repeater interval}, indicating that it
5841 applies not only on the given date, but again and again after a certain
5842 interval of N days (d), weeks (w), months (m), or years (y).  The
5843 following will show up in the agenda every Wednesday:
5845 @example
5846 * Pick up Sam at school
5847   <2007-05-16 Wed 12:30 +1w>
5848 @end example
5850 @item Diary-style sexp entries
5851 For more complex date specifications, Org mode supports using the special
5852 sexp diary entries implemented in the Emacs calendar/diary
5853 package@footnote{When working with the standard diary sexp functions, you
5854 need to be very careful with the order of the arguments.  That order depends
5855 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5856 versions, @code{european-calendar-style}).  For example, to specify a date
5857 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5858 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5859 the settings.  This has been the source of much confusion.  Org mode users
5860 can resort to special versions of these functions like @code{org-date} or
5861 @code{org-anniversary}.  These work just like the corresponding @code{diary-}
5862 functions, but with stable ISO order of arguments (year, month, day) wherever
5863 applicable, independent of the value of @code{calendar-date-style}.}.  For
5864 example with optional time
5866 @example
5867 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5868   <%%(diary-float t 4 2)>
5869 @end example
5871 @item Time/Date range
5872 @cindex timerange
5873 @cindex date range
5874 Two timestamps connected by @samp{--} denote a range.  The headline
5875 will be shown on the first and last day of the range, and on any dates
5876 that are displayed and fall in the range.  Here is an example:
5878 @example
5879 ** Meeting in Amsterdam
5880    <2004-08-23 Mon>--<2004-08-26 Thu>
5881 @end example
5883 @item Inactive timestamp
5884 @cindex timestamp, inactive
5885 @cindex inactive timestamp
5886 Just like a plain timestamp, but with square brackets instead of
5887 angular ones.  These timestamps are inactive in the sense that they do
5888 @emph{not} trigger an entry to show up in the agenda.
5890 @example
5891 * Gillian comes late for the fifth time
5892   [2006-11-01 Wed]
5893 @end example
5895 @end table
5897 @node Creating timestamps
5898 @section Creating timestamps
5899 @cindex creating timestamps
5900 @cindex timestamps, creating
5902 For Org mode to recognize timestamps, they need to be in the specific
5903 format.  All commands listed below produce timestamps in the correct
5904 format.
5906 @table @kbd
5907 @orgcmd{C-c .,org-time-stamp}
5908 Prompt for a date and insert a corresponding timestamp.  When the cursor is
5909 at an existing timestamp in the buffer, the command is used to modify this
5910 timestamp instead of inserting a new one.  When this command is used twice in
5911 succession, a time range is inserted.
5913 @orgcmd{C-c !,org-time-stamp-inactive}
5914 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5915 an agenda entry.
5917 @kindex C-u C-c .
5918 @kindex C-u C-c !
5919 @item C-u C-c .
5920 @itemx C-u C-c !
5921 @vindex org-time-stamp-rounding-minutes
5922 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5923 contains date and time.  The default time can be rounded to multiples of 5
5924 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5926 @orgkey{C-c C-c}
5927 Normalize timestamp, insert/fix day name if missing or wrong.
5929 @orgcmd{C-c <,org-date-from-calendar}
5930 Insert a timestamp corresponding to the cursor date in the Calendar.
5932 @orgcmd{C-c >,org-goto-calendar}
5933 Access the Emacs calendar for the current date.  If there is a
5934 timestamp in the current line, go to the corresponding date
5935 instead.
5937 @orgcmd{C-c C-o,org-open-at-point}
5938 Access the agenda for the date given by the timestamp or -range at
5939 point (@pxref{Weekly/daily agenda}).
5941 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5942 Change date at cursor by one day.  These key bindings conflict with
5943 shift-selection and related modes (@pxref{Conflicts}).
5945 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5946 Change the item under the cursor in a timestamp.  The cursor can be on a
5947 year, month, day, hour or minute.  When the timestamp contains a time range
5948 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5949 shifting the time block with constant length.  To change the length, modify
5950 the second time.  Note that if the cursor is in a headline and not at a
5951 timestamp, these same keys modify the priority of an item.
5952 (@pxref{Priorities}).  The key bindings also conflict with shift-selection and
5953 related modes (@pxref{Conflicts}).
5955 @orgcmd{C-c C-y,org-evaluate-time-range}
5956 @cindex evaluate time range
5957 Evaluate a time range by computing the difference between start and end.
5958 With a prefix argument, insert result after the time range (in a table: into
5959 the following column).
5960 @end table
5963 @menu
5964 * The date/time prompt::        How Org mode helps you entering date and time
5965 * Custom time format::          Making dates look different
5966 @end menu
5968 @node The date/time prompt
5969 @subsection The date/time prompt
5970 @cindex date, reading in minibuffer
5971 @cindex time, reading in minibuffer
5973 @vindex org-read-date-prefer-future
5974 When Org mode prompts for a date/time, the default is shown in default
5975 date/time format, and the prompt therefore seems to ask for a specific
5976 format.  But it will in fact accept date/time information in a variety of
5977 formats.  Generally, the information should start at the beginning of the
5978 string.  Org mode will find whatever information is in
5979 there and derive anything you have not specified from the @emph{default date
5980 and time}.  The default is usually the current date and time, but when
5981 modifying an existing timestamp, or when entering the second stamp of a
5982 range, it is taken from the stamp in the buffer.  When filling in
5983 information, Org mode assumes that most of the time you will want to enter a
5984 date in the future: if you omit the month/year and the given day/month is
5985 @i{before} today, it will assume that you mean a future date@footnote{See the
5986 variable @code{org-read-date-prefer-future}.  You may set that variable to
5987 the symbol @code{time} to even make a time before now shift the date to
5988 tomorrow.}.  If the date has been automatically shifted into the future, the
5989 time prompt will show this with @samp{(=>F).}
5991 For example, let's assume that today is @b{June 13, 2006}.  Here is how
5992 various inputs will be interpreted, the items filled in by Org mode are
5993 in @b{bold}.
5995 @example
5996 3-2-5         @result{} 2003-02-05
5997 2/5/3         @result{} 2003-02-05
5998 14            @result{} @b{2006}-@b{06}-14
5999 12            @result{} @b{2006}-@b{07}-12
6000 2/5           @result{} @b{2007}-02-05
6001 Fri           @result{} nearest Friday after the default date
6002 sep 15        @result{} @b{2006}-09-15
6003 feb 15        @result{} @b{2007}-02-15
6004 sep 12 9      @result{} 2009-09-12
6005 12:45         @result{} @b{2006}-@b{06}-@b{13} 12:45
6006 22 sept 0:34  @result{} @b{2006}-09-22 0:34
6007 w4            @result{} ISO week for of the current year @b{2006}
6008 2012 w4 fri   @result{} Friday of ISO week 4 in 2012
6009 2012-w04-5    @result{} Same as above
6010 @end example
6012 Furthermore you can specify a relative date by giving, as the @emph{first}
6013 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
6014 indicate change in hours, days, weeks, months, or years.  With a single plus
6015 or minus, the date is always relative to today.  With a double plus or minus,
6016 it is relative to the default date.  If instead of a single letter, you use
6017 the abbreviation of day name, the date will be the Nth such day, e.g.:
6019 @example
6020 +0            @result{} today
6021 .             @result{} today
6022 +4d           @result{} four days from today
6023 +4            @result{} same as above
6024 +2w           @result{} two weeks from today
6025 ++5           @result{} five days from default date
6026 +2tue         @result{} second Tuesday from now
6027 -wed          @result{} last Wednesday
6028 @end example
6030 @vindex parse-time-months
6031 @vindex parse-time-weekdays
6032 The function understands English month and weekday abbreviations.  If
6033 you want to use unabbreviated names and/or other languages, configure
6034 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
6036 @vindex org-read-date-force-compatible-dates
6037 Not all dates can be represented in a given Emacs implementation.  By default
6038 Org mode forces dates into the compatibility range 1970--2037 which works on
6039 all Emacs implementations.  If you want to use dates outside of this range,
6040 read the docstring of the variable
6041 @code{org-read-date-force-compatible-dates}.
6043 You can specify a time range by giving start and end times or by giving a
6044 start time and a duration (in HH:MM format).  Use one or two dash(es) as the
6045 separator in the former case and use '+' as the separator in the latter
6046 case, e.g.:
6048 @example
6049 11am-1:15pm    @result{} 11:00-13:15
6050 11am--1:15pm   @result{} same as above
6051 11am+2:15      @result{} same as above
6052 @end example
6054 @cindex calendar, for selecting date
6055 @vindex org-popup-calendar-for-date-prompt
6056 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
6057 you don't need/want the calendar, configure the variable
6058 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
6059 prompt, either by clicking on a date in the calendar, or by pressing
6060 @key{RET}, the date selected in the calendar will be combined with the
6061 information entered at the prompt.  You can control the calendar fully
6062 from the minibuffer:
6064 @kindex <
6065 @kindex >
6066 @kindex M-v
6067 @kindex C-v
6068 @kindex mouse-1
6069 @kindex S-@key{right}
6070 @kindex S-@key{left}
6071 @kindex S-@key{down}
6072 @kindex S-@key{up}
6073 @kindex M-S-@key{right}
6074 @kindex M-S-@key{left}
6075 @kindex @key{RET}
6076 @example
6077 @key{RET}           @r{Choose date at cursor in calendar.}
6078 mouse-1        @r{Select date by clicking on it.}
6079 S-@key{right}/@key{left}     @r{One day forward/backward.}
6080 S-@key{down}/@key{up}     @r{One week forward/backward.}
6081 M-S-@key{right}/@key{left}   @r{One month forward/backward.}
6082 > / <          @r{Scroll calendar forward/backward by one month.}
6083 M-v / C-v      @r{Scroll calendar forward/backward by 3 months.}
6084 @end example
6086 @vindex org-read-date-display-live
6087 The actions of the date/time prompt may seem complex, but I assure you they
6088 will grow on you, and you will start getting annoyed by pretty much any other
6089 way of entering a date/time out there.  To help you understand what is going
6090 on, the current interpretation of your input will be displayed live in the
6091 minibuffer@footnote{If you find this distracting, turn the display off with
6092 @code{org-read-date-display-live}.}.
6094 @node Custom time format
6095 @subsection Custom time format
6096 @cindex custom date/time format
6097 @cindex time format, custom
6098 @cindex date format, custom
6100 @vindex org-display-custom-times
6101 @vindex org-time-stamp-custom-formats
6102 Org mode uses the standard ISO notation for dates and times as it is
6103 defined in ISO 8601.  If you cannot get used to this and require another
6104 representation of date and time to keep you happy, you can get it by
6105 customizing the options @code{org-display-custom-times} and
6106 @code{org-time-stamp-custom-formats}.
6108 @table @kbd
6109 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6110 Toggle the display of custom formats for dates and times.
6111 @end table
6113 @noindent
6114 Org mode needs the default format for scanning, so the custom date/time
6115 format does not @emph{replace} the default format---instead it is put
6116 @emph{over} the default format using text properties.  This has the
6117 following consequences:
6118 @itemize @bullet
6119 @item
6120 You cannot place the cursor onto a timestamp anymore, only before or
6121 after.
6122 @item
6123 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6124 each component of a timestamp.  If the cursor is at the beginning of
6125 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6126 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
6127 time will be changed by one minute.
6128 @item
6129 If the timestamp contains a range of clock times or a repeater, these
6130 will not be overlaid, but remain in the buffer as they were.
6131 @item
6132 When you delete a timestamp character-by-character, it will only
6133 disappear from the buffer after @emph{all} (invisible) characters
6134 belonging to the ISO timestamp have been removed.
6135 @item
6136 If the custom timestamp format is longer than the default and you are
6137 using dates in tables, table alignment will be messed up.  If the custom
6138 format is shorter, things do work as expected.
6139 @end itemize
6142 @node Deadlines and scheduling
6143 @section Deadlines and scheduling
6145 A timestamp may be preceded by special keywords to facilitate planning:
6147 @table @var
6148 @item DEADLINE
6149 @cindex DEADLINE keyword
6151 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6152 to be finished on that date.
6154 @vindex org-deadline-warning-days
6155 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6156 On the deadline date, the task will be listed in the agenda.  In
6157 addition, the agenda for @emph{today} will carry a warning about the
6158 approaching or missed deadline, starting
6159 @code{org-deadline-warning-days} before the due date, and continuing
6160 until the entry is marked DONE@.  An example:
6162 @example
6163 *** TODO write article about the Earth for the Guide
6164     DEADLINE: <2004-02-29 Sun>
6165     The editor in charge is [[bbdb:Ford Prefect]]
6166 @end example
6168 You can specify a different lead time for warnings for a specific
6169 deadline using the following syntax.  Here is an example with a warning
6170 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.  This warning is
6171 deactivated if the task gets scheduled and you set
6172 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6174 @item SCHEDULED
6175 @cindex SCHEDULED keyword
6177 Meaning: you are planning to start working on that task on the given
6178 date.
6180 @vindex org-agenda-skip-scheduled-if-done
6181 The headline will be listed under the given date@footnote{It will still
6182 be listed on that date after it has been marked DONE@.  If you don't like
6183 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
6184 addition, a reminder that the scheduled date has passed will be present
6185 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6186 the task will automatically be forwarded until completed.
6188 @example
6189 *** TODO Call Trillian for a date on New Years Eve.
6190     SCHEDULED: <2004-12-25 Sat>
6191 @end example
6193 @vindex org-scheduled-delay-days
6194 @vindex org-agenda-skip-scheduled-delay-if-deadline
6195 If you want to @emph{delay} the display of this task in the agenda, use
6196 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6197 25th but will appear two days later.  In case the task contains a repeater,
6198 the delay is considered to affect all occurrences; if you want the delay to
6199 only affect the first scheduled occurrence of the task, use @code{--2d}
6200 instead.  See @code{org-scheduled-delay-days} and
6201 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6202 control this globally or per agenda.
6204 @noindent
6205 @b{Important:} Scheduling an item in Org mode should @i{not} be
6206 understood in the same way that we understand @i{scheduling a meeting}.
6207 Setting a date for a meeting is just a simple appointment, you should
6208 mark this entry with a simple plain timestamp, to get this item shown
6209 on the date where it applies.  This is a frequent misunderstanding by
6210 Org users.  In Org mode, @i{scheduling} means setting a date when you
6211 want to start working on an action item.
6212 @end table
6214 You may use timestamps with repeaters in scheduling and deadline
6215 entries.  Org mode will issue early and late warnings based on the
6216 assumption that the timestamp represents the @i{nearest instance} of
6217 the repeater.  However, the use of diary sexp entries like
6219 @code{<%%(diary-float t 42)>}
6221 in scheduling and deadline timestamps is limited.  Org mode does not
6222 know enough about the internals of each sexp function to issue early and
6223 late warnings.  However, it will show the item on each day where the
6224 sexp entry matches.
6226 @menu
6227 * Inserting deadline/schedule::  Planning items
6228 * Repeated tasks::              Items that show up again and again
6229 @end menu
6231 @node Inserting deadline/schedule
6232 @subsection Inserting deadlines or schedules
6234 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6235 @samp{DEADLINE} dates are inserted on the line right below the headline.  Don't put
6236 any text between this line and the headline.} a deadline or to schedule
6237 an item:
6239 @table @kbd
6241 @orgcmd{C-c C-d,org-deadline}
6242 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will happen
6243 in the line directly following the headline.  Any CLOSED timestamp will be
6244 removed.  When called with a prefix arg, an existing deadline will be removed
6245 from the entry.  Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6246 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6247 and @code{nologredeadline}}, a note will be taken when changing an existing
6248 deadline.
6250 @orgcmd{C-c C-s,org-schedule}
6251 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
6252 happen in the line directly following the headline.  Any CLOSED timestamp
6253 will be removed.  When called with a prefix argument, remove the scheduling
6254 date from the entry.  Depending on the variable
6255 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6256 keywords @code{logreschedule}, @code{lognotereschedule}, and
6257 @code{nologreschedule}}, a note will be taken when changing an existing
6258 scheduling time.
6260 @orgcmd{C-c / d,org-check-deadlines}
6261 @cindex sparse tree, for deadlines
6262 @vindex org-deadline-warning-days
6263 Create a sparse tree with all deadlines that are either past-due, or
6264 which will become due within @code{org-deadline-warning-days}.
6265 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
6266 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
6267 all deadlines due tomorrow.
6269 @orgcmd{C-c / b,org-check-before-date}
6270 Sparse tree for deadlines and scheduled items before a given date.
6272 @orgcmd{C-c / a,org-check-after-date}
6273 Sparse tree for deadlines and scheduled items after a given date.
6274 @end table
6276 Note that @code{org-schedule} and @code{org-deadline} supports
6277 setting the date by indicating a relative time: e.g., +1d will set
6278 the date to the next day after today, and --1w will set the date
6279 to the previous week before any current timestamp.
6281 @node Repeated tasks
6282 @subsection Repeated tasks
6283 @cindex tasks, repeated
6284 @cindex repeated tasks
6286 Some tasks need to be repeated again and again.  Org mode helps to
6287 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6288 or plain timestamp.  In the following example
6289 @example
6290 ** TODO Pay the rent
6291    DEADLINE: <2005-10-01 Sat +1m>
6292 @end example
6293 @noindent
6294 the @code{+1m} is a repeater; the intended interpretation is that the task
6295 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6296 from that time.  You can use yearly, monthly, weekly, daily and hourly repeat
6297 cookies by using the @code{y/w/m/d/h} letters.  If you need both a repeater
6298 and a special warning period in a deadline entry, the repeater should come
6299 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6301 @vindex org-todo-repeat-to-state
6302 Deadlines and scheduled items produce entries in the agenda when they are
6303 over-due, so it is important to be able to mark such an entry as completed
6304 once you have done so.  When you mark a DEADLINE or a SCHEDULE with the TODO
6305 keyword DONE, it will no longer produce entries in the agenda.  The problem
6306 with this is, however, that then also the @emph{next} instance of the
6307 repeated entry will not be active.  Org mode deals with this in the following
6308 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6309 shift the base date of the repeating timestamp by the repeater interval, and
6310 immediately set the entry state back to TODO@footnote{In fact, the target
6311 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6312 the variable @code{org-todo-repeat-to-state}.  If neither of these is
6313 specified, the target state defaults to the first state of the TODO state
6314 sequence.}.  In the example above, setting the state to DONE would actually
6315 switch the date like this:
6317 @example
6318 ** TODO Pay the rent
6319    DEADLINE: <2005-11-01 Tue +1m>
6320 @end example
6322 To mark a task with a repeater as @code{DONE}, use @kbd{C-- 1 C-c C-t}
6323 (i.e., @code{org-todo} with a numeric prefix argument of -1.)
6325 @vindex org-log-repeat
6326 A timestamp@footnote{You can change this using the option
6327 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6328 @code{lognoterepeat}, and @code{nologrepeat}.  With @code{lognoterepeat}, you
6329 will also be prompted for a note.} will be added under the deadline, to keep
6330 a record that you actually acted on the previous instance of this deadline.
6332 As a consequence of shifting the base date, this entry will no longer be
6333 visible in the agenda when checking past dates, but all future instances
6334 will be visible.
6336 With the @samp{+1m} cookie, the date shift will always be exactly one
6337 month.  So if you have not paid the rent for three months, marking this
6338 entry DONE will still keep it as an overdue deadline.  Depending on the
6339 task, this may not be the best way to handle it.  For example, if you
6340 forgot to call your father for 3 weeks, it does not make sense to call
6341 him 3 times in a single day to make up for it.  Finally, there are tasks
6342 like changing batteries which should always repeat a certain time
6343 @i{after} the last time you did it.  For these tasks, Org mode has
6344 special repeaters  @samp{++} and @samp{.+}.  For example:
6346 @example
6347 ** TODO Call Father
6348    DEADLINE: <2008-02-10 Sun ++1w>
6349    Marking this DONE will shift the date by at least one week,
6350    but also by as many weeks as it takes to get this date into
6351    the future.  However, it stays on a Sunday, even if you called
6352    and marked it done on Saturday.
6353 ** TODO Check the batteries in the smoke detectors
6354    DEADLINE: <2005-11-01 Tue .+1m>
6355    Marking this DONE will shift the date to one month after
6356    today.
6357 @end example
6359 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6360 You may have both scheduling and deadline information for a specific task.
6361 If the repeater is set for the scheduling information only, you probably want
6362 the repeater to be ignored after the deadline.  If so, set the variable
6363 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6364 @code{repeated-after-deadline}.  If you want both scheduling and deadline
6365 information to repeat after the same interval, set the same repeater for both
6366 timestamps.
6368 An alternative to using a repeater is to create a number of copies of a task
6369 subtree, with dates shifted in each copy.  The command @kbd{C-c C-x c} was
6370 created for this purpose, it is described in @ref{Structure editing}.
6373 @node Clocking work time
6374 @section Clocking work time
6375 @cindex clocking time
6376 @cindex time clocking
6378 Org mode allows you to clock the time you spend on specific tasks in a
6379 project.  When you start working on an item, you can start the clock.  When
6380 you stop working on that task, or when you mark the task done, the clock is
6381 stopped and the corresponding time interval is recorded.  It also computes
6382 the total time spent on each subtree@footnote{Clocking only works if all
6383 headings are indented with less than 30 stars.  This is a hardcoded
6384 limitation of `lmax' in `org-clock-sum'.} of a project.  And it remembers a
6385 history or tasks recently clocked, so that you can jump quickly between a
6386 number of tasks absorbing your time.
6388 To save the clock history across Emacs sessions, use
6389 @lisp
6390 (setq org-clock-persist 'history)
6391 (org-clock-persistence-insinuate)
6392 @end lisp
6393 When you clock into a new task after resuming Emacs, the incomplete
6394 clock@footnote{To resume the clock under the assumption that you have worked
6395 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6396 will be found (@pxref{Resolving idle time}) and you will be prompted about
6397 what to do with it.
6399 @menu
6400 * Clocking commands::           Starting and stopping a clock
6401 * The clock table::             Detailed reports
6402 * Resolving idle time::         Resolving time when you've been idle
6403 @end menu
6405 @node Clocking commands
6406 @subsection Clocking commands
6408 @table @kbd
6409 @orgcmd{C-c C-x C-i,org-clock-in}
6410 @vindex org-clock-into-drawer
6411 @vindex org-clock-continuously
6412 @cindex property, LOG_INTO_DRAWER
6413 Start the clock on the current item (clock-in).  This inserts the CLOCK
6414 keyword together with a timestamp.  If this is not the first clocking of
6415 this item, the multiple CLOCK lines will be wrapped into a
6416 @code{:LOGBOOK:} drawer (see also the variable
6417 @code{org-clock-into-drawer}).  You can also overrule
6418 the setting of this variable for a subtree by setting a
6419 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6420 When called with a @kbd{C-u} prefix argument,
6421 select the task from a list of recently clocked tasks.  With two @kbd{C-u
6422 C-u} prefixes, clock into the task at point and mark it as the default task;
6423 the default task will then always be available with letter @kbd{d} when
6424 selecting a clocking task.  With three @kbd{C-u C-u C-u} prefixes, force
6425 continuous clocking by starting the clock when the last clock stopped.@*
6426 @cindex property: CLOCK_MODELINE_TOTAL
6427 @cindex property: LAST_REPEAT
6428 @vindex org-clock-modeline-total
6429 While the clock is running, the current clocking time is shown in the mode
6430 line, along with the title of the task.  The clock time shown will be all
6431 time ever clocked for this task and its children.  If the task has an effort
6432 estimate (@pxref{Effort estimates}), the mode line displays the current
6433 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6434 hook a function doing this to @code{org-clock-in-prepare-hook}.}  If the task
6435 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6436 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6437 will be shown.  More control over what time is shown can be exercised with
6438 the @code{CLOCK_MODELINE_TOTAL} property.  It may have the values
6439 @code{current} to show only the current clocking instance, @code{today} to
6440 show all time clocked on this tasks today (see also the variable
6441 @code{org-extend-today-until}), @code{all} to include all time, or
6442 @code{auto} which is the default@footnote{See also the variable
6443 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6444 mode line entry will pop up a menu with clocking options.
6446 @orgcmd{C-c C-x C-o,org-clock-out}
6447 @vindex org-log-note-clock-out
6448 Stop the clock (clock-out).  This inserts another timestamp at the same
6449 location where the clock was last started.  It also directly computes
6450 the resulting time and inserts it after the time range as @samp{=>
6451 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
6452 possibility to record an additional note together with the clock-out
6453 timestamp@footnote{The corresponding in-buffer setting is:
6454 @code{#+STARTUP: lognoteclock-out}}.
6455 @orgcmd{C-c C-x C-x,org-clock-in-last}
6456 @vindex org-clock-continuously
6457 Reclock the last clocked task.  With one @kbd{C-u} prefix argument,
6458 select the task from the clock history.  With two @kbd{C-u} prefixes,
6459 force continuous clocking by starting the clock when the last clock
6460 stopped.
6461 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6462 Update the effort estimate for the current clock task.
6463 @kindex C-c C-y
6464 @kindex C-c C-c
6465 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6466 Recompute the time interval after changing one of the timestamps.  This
6467 is only necessary if you edit the timestamps directly.  If you change
6468 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6469 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6470 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6471 clock duration keeps the same.
6472 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6473 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6474 the one of the previous (or the next clock) timestamp by the same duration.
6475 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6476 by five minutes, then the clocked-in timestamp of the next clock will be
6477 increased by five minutes.
6478 @orgcmd{C-c C-t,org-todo}
6479 Changing the TODO state of an item to DONE automatically stops the clock
6480 if it is running in this same item.
6481 @orgcmd{C-c C-x C-q,org-clock-cancel}
6482 Cancel the current clock.  This is useful if a clock was started by
6483 mistake, or if you ended up working on something else.
6484 @orgcmd{C-c C-x C-j,org-clock-goto}
6485 Jump to the headline of the currently clocked in task.  With a @kbd{C-u}
6486 prefix arg, select the target task from a list of recently clocked tasks.
6487 @orgcmd{C-c C-x C-d,org-clock-display}
6488 @vindex org-remove-highlights-with-change
6489 Display time summaries for each subtree in the current buffer.  This puts
6490 overlays at the end of each headline, showing the total time recorded under
6491 that heading, including the time of any subheadings.  You can use visibility
6492 cycling to study the tree, but the overlays disappear when you change the
6493 buffer (see variable @code{org-remove-highlights-with-change}) or press
6494 @kbd{C-c C-c}.
6495 @end table
6497 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6498 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6499 worked on or closed during a day.
6501 @strong{Important:} note that both @code{org-clock-out} and
6502 @code{org-clock-in-last} can have a global keybinding and will not
6503 modify the window disposition.
6505 @node The clock table
6506 @subsection The clock table
6507 @cindex clocktable, dynamic block
6508 @cindex report, of clocked time
6510 Org mode can produce quite complex reports based on the time clocking
6511 information.  Such a report is called a @emph{clock table}, because it is
6512 formatted as one or several Org tables.
6514 @table @kbd
6515 @orgcmd{C-c C-x C-r,org-clock-report}
6516 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6517 report as an Org mode table into the current file.  When the cursor is
6518 at an existing clock table, just update it.  When called with a prefix
6519 argument, jump to the first clock report in the current document and
6520 update it.  The clock table always includes also trees with
6521 @code{:ARCHIVE:} tag.
6522 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6523 Update dynamic block at point.  The cursor needs to be in the
6524 @code{#+BEGIN} line of the dynamic block.
6525 @orgkey{C-u C-c C-x C-u}
6526 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
6527 you have several clock table blocks in a buffer.
6528 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6529 Shift the current @code{:block} interval and update the table.  The cursor
6530 needs to be in the @code{#+BEGIN: clocktable} line for this command.  If
6531 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6532 @end table
6535 Here is an example of the frame for a clock table as it is inserted into the
6536 buffer with the @kbd{C-c C-x C-r} command:
6538 @cindex #+BEGIN, clocktable
6539 @example
6540 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6541 #+END: clocktable
6542 @end example
6543 @noindent
6544 @vindex org-clocktable-defaults
6545 The @samp{BEGIN} line specifies a number of options to define the scope,
6546 structure, and formatting of the report.  Defaults for all these options can
6547 be configured in the variable @code{org-clocktable-defaults}.
6549 @noindent First there are options that determine which clock entries are to
6550 be selected:
6551 @example
6552 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
6553              @r{Clocks at deeper levels will be summed into the upper level.}
6554 :scope       @r{The scope to consider.  This can be any of the following:}
6555              nil        @r{the current buffer or narrowed region}
6556              file       @r{the full current buffer}
6557              subtree    @r{the subtree where the clocktable is located}
6558              tree@var{N}      @r{the surrounding level @var{N} tree, for example @code{tree3}}
6559              tree       @r{the surrounding level 1 tree}
6560              agenda     @r{all agenda files}
6561              ("file"..) @r{scan these files}
6562              file-with-archives    @r{current file and its archives}
6563              agenda-with-archives  @r{all agenda files, including archives}
6564 :block       @r{The time block to consider.  This block is specified either}
6565              @r{absolutely, or relative to the current time and may be any of}
6566              @r{these formats:}
6567              2007-12-31    @r{New year eve 2007}
6568              2007-12       @r{December 2007}
6569              2007-W50      @r{ISO-week 50 in 2007}
6570              2007-Q2       @r{2nd quarter in 2007}
6571              2007          @r{the year 2007}
6572              today, yesterday, today-@var{N}          @r{a relative day}
6573              thisweek, lastweek, thisweek-@var{N}     @r{a relative week}
6574              thismonth, lastmonth, thismonth-@var{N}  @r{a relative month}
6575              thisyear, lastyear, thisyear-@var{N}     @r{a relative year}
6576              @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6577 :tstart      @r{A time string specifying when to start considering times.}
6578              @r{Relative times like @code{"<-2w>"} can also be used.  See}
6579              @r{@ref{Matching tags and properties} for relative time syntax.}
6580 :tend        @r{A time string specifying when to stop considering times.}
6581              @r{Relative times like @code{"<now>"} can also be used.  See}
6582              @r{@ref{Matching tags and properties} for relative time syntax.}
6583 :wstart      @r{The starting day of the week.  The default is 1 for monday.}
6584 :mstart      @r{The starting day of the month.  The default 1 is for the first}
6585              @r{day of the month.}
6586 :step        @r{@code{week} or @code{day}, to split the table into chunks.}
6587              @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6588 :stepskip0   @r{Do not show steps that have zero time.}
6589 :fileskip0   @r{Do not show table sections from files which did not contribute.}
6590 :tags        @r{A tags match to select entries that should contribute.  See}
6591              @r{@ref{Matching tags and properties} for the match syntax.}
6592 @end example
6594 Then there are options which determine the formatting of the table.  These
6595 options are interpreted by the function @code{org-clocktable-write-default},
6596 but you can specify your own function using the @code{:formatter} parameter.
6597 @example
6598 :emphasize   @r{When @code{t}, emphasize level one and level two items.}
6599 :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".}
6600 :link        @r{Link the item headlines in the table to their origins.}
6601 :narrow      @r{An integer to limit the width of the headline column in}
6602              @r{the org table.  If you write it like @samp{50!}, then the}
6603              @r{headline will also be shortened in export.}
6604 :indent      @r{Indent each headline field according to its level.}
6605 :tcolumns    @r{Number of columns to be used for times.  If this is smaller}
6606              @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6607 :level       @r{Should a level number column be included?}
6608 :sort        @r{A cons cell like containing the column to sort and a sorting type.}
6609              @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.}
6610 :compact     @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6611              @r{All are overwritten except if there is an explicit @code{:narrow}}
6612 :timestamp   @r{A timestamp for the entry, when available.  Look for SCHEDULED,}
6613              @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6614 :properties  @r{List of properties that should be shown in the table.  Each}
6615              @r{property will get its own column.}
6616 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6617 :formula     @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6618              @r{As a special case, @samp{:formula %} adds a column with % time.}
6619              @r{If you do not specify a formula here, any existing formula}
6620              @r{below the clock table will survive updates and be evaluated.}
6621 :formatter   @r{A function to format clock data and insert it into the buffer.}
6622 @end example
6623 To get a clock summary of the current level 1 tree, for the current
6624 day, you could write
6625 @example
6626 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6627 #+END: clocktable
6628 @end example
6629 @noindent
6630 and to use a specific time range you could write@footnote{Note that all
6631 parameters must be specified in a single line---the line is broken here
6632 only to fit it into the manual.}
6633 @example
6634 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6635                     :tend "<2006-08-10 Thu 12:00>"
6636 #+END: clocktable
6637 @end example
6638 A range starting a week ago and ending right now could be written as
6639 @example
6640 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6641 #+END: clocktable
6642 @end example
6643 A summary of the current subtree with % times would be
6644 @example
6645 #+BEGIN: clocktable :scope subtree :link t :formula %
6646 #+END: clocktable
6647 @end example
6648 A horizontally compact representation of everything clocked during last week
6649 would be
6650 @example
6651 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6652 #+END: clocktable
6653 @end example
6655 @node Resolving idle time
6656 @subsection Resolving idle time and continuous clocking
6658 @subsubheading Resolving idle time
6659 @cindex resolve idle time
6660 @vindex org-clock-x11idle-program-name
6662 @cindex idle, resolve, dangling
6663 If you clock in on a work item, and then walk away from your
6664 computer---perhaps to take a phone call---you often need to ``resolve'' the
6665 time you were away by either subtracting it from the current clock, or
6666 applying it to another one.
6668 @vindex org-clock-idle-time
6669 By customizing the variable @code{org-clock-idle-time} to some integer, such
6670 as 10 or 15, Emacs can alert you when you get back to your computer after
6671 being idle for that many minutes@footnote{On computers using Mac OS X,
6672 idleness is based on actual user idleness, not just Emacs' idle time.  For
6673 X11, you can install a utility program @file{x11idle.c}, available in the
6674 @code{contrib/scripts} directory of the Org git distribution, or install the
6675 @file{xprintidle} package and set it to the variable
6676 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6677 same general treatment of idleness.  On other systems, idle time refers to
6678 Emacs idle time only.}, and ask what you want to do with the idle time.
6679 There will be a question waiting for you when you get back, indicating how
6680 much idle time has passed (constantly updated with the current amount), as
6681 well as a set of choices to correct the discrepancy:
6683 @table @kbd
6684 @item k
6685 To keep some or all of the minutes and stay clocked in, press @kbd{k}.  Org
6686 will ask how many of the minutes to keep.  Press @key{RET} to keep them all,
6687 effectively changing nothing, or enter a number to keep that many minutes.
6688 @item K
6689 If you use the shift key and press @kbd{K}, it will keep however many minutes
6690 you request and then immediately clock out of that task.  If you keep all of
6691 the minutes, this is the same as just clocking out of the current task.
6692 @item s
6693 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6694 the clock, and then check back in from the moment you returned.
6695 @item S
6696 To keep none of the minutes and just clock out at the start of the away time,
6697 use the shift key and press @kbd{S}.  Remember that using shift will always
6698 leave you clocked out, no matter which option you choose.
6699 @item C
6700 To cancel the clock altogether, use @kbd{C}.  Note that if instead of
6701 canceling you subtract the away time, and the resulting clock amount is less
6702 than a minute, the clock will still be canceled rather than clutter up the
6703 log with an empty entry.
6704 @end table
6706 What if you subtracted those away minutes from the current clock, and now
6707 want to apply them to a new clock?  Simply clock in to any task immediately
6708 after the subtraction.  Org will notice that you have subtracted time ``on
6709 the books'', so to speak, and will ask if you want to apply those minutes to
6710 the next task you clock in on.
6712 There is one other instance when this clock resolution magic occurs.  Say you
6713 were clocked in and hacking away, and suddenly your cat chased a mouse who
6714 scared a hamster that crashed into your UPS's power button!  You suddenly
6715 lose all your buffers, but thanks to auto-save you still have your recent Org
6716 mode changes, including your last clock in.
6718 If you restart Emacs and clock into any task, Org will notice that you have a
6719 dangling clock which was never clocked out from your last session.  Using
6720 that clock's starting time as the beginning of the unaccounted-for period,
6721 Org will ask how you want to resolve that time.  The logic and behavior is
6722 identical to dealing with away time due to idleness; it is just happening due
6723 to a recovery event rather than a set amount of idle time.
6725 You can also check all the files visited by your Org agenda for dangling
6726 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6728 @subsubheading Continuous clocking
6729 @cindex continuous clocking
6730 @vindex org-clock-continuously
6732 You may want to start clocking from the time when you clocked out the
6733 previous task.  To enable this systematically, set @code{org-clock-continuously}
6734 to @code{t}.  Each time you clock in, Org retrieves the clock-out time of the
6735 last clocked entry for this session, and start the new clock from there.
6737 If you only want this from time to time, use three universal prefix arguments
6738 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6740 @node Effort estimates
6741 @section Effort estimates
6742 @cindex effort estimates
6744 @cindex property, Effort
6745 If you want to plan your work in a very detailed way, or if you need to
6746 produce offers with quotations of the estimated work effort, you may want to
6747 assign effort estimates to entries.  If you are also clocking your work, you
6748 may later want to compare the planned effort with the actual working time,
6749 a great way to improve planning estimates.  Effort estimates are stored in
6750 a special property @code{EFFORT}.  You can set the effort for an entry with
6751 the following commands:
6753 @table @kbd
6754 @orgcmd{C-c C-x e,org-set-effort}
6755 Set the effort estimate for the current entry.  With a numeric prefix
6756 argument, set it to the Nth allowed value (see below).  This command is also
6757 accessible from the agenda with the @kbd{e} key.
6758 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6759 Modify the effort estimate of the item currently being clocked.
6760 @end table
6762 Clearly the best way to work with effort estimates is through column view
6763 (@pxref{Column view}).  You should start by setting up discrete values for
6764 effort estimates, and a @code{COLUMNS} format that displays these values
6765 together with clock sums (if you want to clock your time).  For a specific
6766 buffer you can use
6768 @example
6769 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6770 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6771 @end example
6773 @noindent
6774 @vindex org-global-properties
6775 @vindex org-columns-default-format
6776 or, even better, you can set up these values globally by customizing the
6777 variables @code{org-global-properties} and @code{org-columns-default-format}.
6778 In particular if you want to use this setup also in the agenda, a global
6779 setup may be advised.
6781 The way to assign estimates to individual items is then to switch to column
6782 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6783 value.  The values you enter will immediately be summed up in the hierarchy.
6784 In the column next to it, any clocked time will be displayed.
6786 @vindex org-agenda-columns-add-appointments-to-effort-sum
6787 If you switch to column view in the daily/weekly agenda, the effort column
6788 will summarize the estimated work effort for each day@footnote{Please note
6789 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6790 column view}).}, and you can use this to find space in your schedule.  To get
6791 an overview of the entire part of the day that is committed, you can set the
6792 option @code{org-agenda-columns-add-appointments-to-effort-sum}.  The
6793 appointments on a day that take place over a specified time interval will
6794 then also be added to the load estimate of the day.
6796 Effort estimates can be used in secondary agenda filtering that is triggered
6797 with the @kbd{/} key in the agenda (@pxref{Agenda commands}).  If you have
6798 these estimates defined consistently, two or three key presses will narrow
6799 down the list to stuff that fits into an available time slot.
6801 @node Timers
6802 @section Taking notes with a timer
6803 @cindex relative timer
6804 @cindex countdown timer
6805 @kindex ;
6807 Org provides provides two types of timers.  There is a relative timer that
6808 counts up, which can be useful when taking notes during, for example, a
6809 meeting or a video viewing.  There is also a countdown timer.
6811 The relative and countdown are started with separate commands.
6813 @table @kbd
6814 @orgcmd{C-c C-x 0,org-timer-start}
6815 Start or reset the relative timer.  By default, the timer is set to 0.  When
6816 called with a @kbd{C-u} prefix, prompt the user for a starting offset.  If
6817 there is a timer string at point, this is taken as the default, providing a
6818 convenient way to restart taking notes after a break in the process.  When
6819 called with a double prefix argument @kbd{C-u C-u}, change all timer strings
6820 in the active region by a certain amount.  This can be used to fix timer
6821 strings if the timer was not started at exactly the right moment.
6822 @orgcmd{C-c C-x ;,org-timer-set-timer}
6823 Start a countdown timer.  The user is prompted for a duration.
6824 @code{org-timer-default-timer} sets the default countdown value.  Giving a
6825 prefix numeric argument overrides this default value.  This command is
6826 available as @kbd{;} in agenda buffers.
6827 @end table
6829 Once started, relative and countdown timers are controlled with the same
6830 commands.
6832 @table @kbd
6833 @orgcmd{C-c C-x .,org-timer}
6834 Insert the value of the current relative or countdown timer into the buffer.
6835 If no timer is running, the relative timer will be started.  When called with
6836 a prefix argument, the relative timer is restarted.
6837 @orgcmd{C-c C-x -,org-timer-item}
6838 Insert a description list item with the value of the current relative or
6839 countdown timer.  With a prefix argument, first reset the relative timer to
6841 @orgcmd{M-@key{RET},org-insert-heading}
6842 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6843 new timer items.
6844 @orgcmd{C-c C-x \\,org-timer-pause-or-continue}
6845 Pause the timer, or continue it if it is already paused.
6846 @orgcmd{C-c C-x _,org-timer-stop}
6847 Stop the timer.  After this, you can only start a new timer, not continue the
6848 old one.  This command also removes the timer from the mode line.
6849 @end table
6851 @node Capture - Refile - Archive
6852 @chapter Capture - Refile - Archive
6853 @cindex capture
6855 An important part of any organization system is the ability to quickly
6856 capture new ideas and tasks, and to associate reference material with them.
6857 Org does this using a process called @i{capture}.  It also can store files
6858 related to a task (@i{attachments}) in a special directory.  Once in the
6859 system, tasks and projects need to be moved around.  Moving completed project
6860 trees to an archive file keeps the system compact and fast.
6862 @menu
6863 * Capture::                     Capturing new stuff
6864 * Attachments::                 Add files to tasks
6865 * RSS feeds::                   Getting input from RSS feeds
6866 * Protocols::                   External (e.g., Browser) access to Emacs and Org
6867 * Refile and copy::             Moving/copying a tree from one place to another
6868 * Archiving::                   What to do with finished projects
6869 @end menu
6871 @node Capture
6872 @section Capture
6873 @cindex capture
6875 Capture lets you quickly store notes with little interruption of your work
6876 flow.  Org's method for capturing new items is heavily inspired by John
6877 Wiegley excellent @file{remember.el} package.  Up to version 6.36, Org
6878 used a special setup for @file{remember.el}, then replaced it with
6879 @file{org-remember.el}.  As of version 8.0, @file{org-remember.el} has
6880 been completely replaced by @file{org-capture.el}.
6882 If your configuration depends on @file{org-remember.el}, you need to update
6883 it and use the setup described below.  To convert your
6884 @code{org-remember-templates}, run the command
6885 @example
6886 @kbd{M-x org-capture-import-remember-templates RET}
6887 @end example
6888 @noindent and then customize the new variable with @kbd{M-x
6889 customize-variable org-capture-templates}, check the result, and save the
6890 customization.
6892 @menu
6893 * Setting up capture::          Where notes will be stored
6894 * Using capture::               Commands to invoke and terminate capture
6895 * Capture templates::           Define the outline of different note types
6896 @end menu
6898 @node Setting up capture
6899 @subsection Setting up capture
6901 The following customization sets a default target file for notes, and defines
6902 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6903 suggestion.}  for capturing new material.
6905 @vindex org-default-notes-file
6906 @smalllisp
6907 @group
6908 (setq org-default-notes-file (concat org-directory "/notes.org"))
6909 (define-key global-map "\C-cc" 'org-capture)
6910 @end group
6911 @end smalllisp
6913 @node Using capture
6914 @subsection Using capture
6916 @table @kbd
6917 @orgcmd{C-c c,org-capture}
6918 Call the command @code{org-capture}.  Note that this keybinding is global and
6919 not active by default: you need to install it.  If you have templates
6920 @cindex date tree
6921 defined @pxref{Capture templates}, it will offer these templates for
6922 selection or use a new Org outline node as the default template.  It will
6923 insert the template into the target file and switch to an indirect buffer
6924 narrowed to this new node.  You may then insert the information you want.
6926 @orgcmd{C-c C-c,org-capture-finalize}
6927 Once you have finished entering information into the capture buffer, @kbd{C-c
6928 C-c} will return you to the window configuration before the capture process,
6929 so that you can resume your work without further distraction.  When called
6930 with a prefix arg, finalize and then jump to the captured item.
6932 @orgcmd{C-c C-w,org-capture-refile}
6933 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6934 a different place.  Please realize that this is a normal refiling command
6935 that will be executed---so the cursor position at the moment you run this
6936 command is important.  If you have inserted a tree with a parent and
6937 children, first move the cursor back to the parent.  Any prefix argument
6938 given to this command will be passed on to the @code{org-refile} command.
6940 @orgcmd{C-c C-k,org-capture-kill}
6941 Abort the capture process and return to the previous state.
6943 @end table
6945 You can also call @code{org-capture} in a special way from the agenda, using
6946 the @kbd{k c} key combination.  With this access, any timestamps inserted by
6947 the selected capture template will default to the cursor date in the agenda,
6948 rather than to the current date.
6950 To find the locations of the last stored capture, use @code{org-capture} with
6951 prefix commands:
6953 @table @kbd
6954 @orgkey{C-u C-c c}
6955 Visit the target location of a capture template.  You get to select the
6956 template in the usual way.
6957 @orgkey{C-u C-u C-c c}
6958 Visit the last stored capture item in its buffer.
6959 @end table
6961 @vindex org-capture-bookmark
6962 @cindex org-capture-last-stored
6963 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6964 automatically be created unless you set @code{org-capture-bookmark} to
6965 @code{nil}.
6967 To insert the capture at point in an Org buffer, call @code{org-capture} with
6968 a @code{C-0} prefix argument.
6970 @node Capture templates
6971 @subsection Capture templates
6972 @cindex templates, for Capture
6974 You can use templates for different types of capture items, and
6975 for different target locations.  The easiest way to create such templates is
6976 through the customize interface.
6978 @table @kbd
6979 @orgkey{C-c c C}
6980 Customize the variable @code{org-capture-templates}.
6981 @end table
6983 Before we give the formal description of template definitions, let's look at
6984 an example.  Say you would like to use one template to create general TODO
6985 entries, and you want to put these entries under the heading @samp{Tasks} in
6986 your file @file{~/org/gtd.org}.  Also, a date tree in the file
6987 @file{journal.org} should capture journal entries.  A possible configuration
6988 would look like:
6990 @smalllisp
6991 @group
6992 (setq org-capture-templates
6993  '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6994         "* TODO %?\n  %i\n  %a")
6995    ("j" "Journal" entry (file+datetree "~/org/journal.org")
6996         "* %?\nEntered on %U\n  %i\n  %a")))
6997 @end group
6998 @end smalllisp
7000 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
7001 for you like this:
7002 @example
7003 * TODO
7004   [[file:@var{link to where you initiated capture}]]
7005 @end example
7007 @noindent
7008 During expansion of the template, @code{%a} has been replaced by a link to
7009 the location from where you called the capture command.  This can be
7010 extremely useful for deriving tasks from emails, for example.  You fill in
7011 the task definition, press @kbd{C-c C-c} and Org returns you to the same
7012 place where you started the capture process.
7014 To define special keys to capture to a particular template without going
7015 through the interactive template selection, you can create your key binding
7016 like this:
7018 @lisp
7019 (define-key global-map "\C-cx"
7020    (lambda () (interactive) (org-capture nil "x")))
7021 @end lisp
7023 @menu
7024 * Template elements::           What is needed for a complete template entry
7025 * Template expansion::          Filling in information about time and context
7026 * Templates in contexts::       Only show a template in a specific context
7027 @end menu
7029 @node Template elements
7030 @subsubsection Template elements
7032 Now lets look at the elements of a template definition.  Each entry in
7033 @code{org-capture-templates} is a list with the following items:
7035 @table @var
7036 @item keys
7037 The keys that will select the template, as a string, characters
7038 only, for example @code{"a"} for a template to be selected with a
7039 single key, or @code{"bt"} for selection with two keys.  When using
7040 several keys, keys using the same prefix key must be sequential
7041 in the list and preceded by a 2-element entry explaining the
7042 prefix key, for example
7043 @smalllisp
7044          ("b" "Templates for marking stuff to buy")
7045 @end smalllisp
7046 @noindent If you do not define a template for the @kbd{C} key, this key will
7047 be used to open the customize buffer for this complex variable.
7049 @item description
7050 A short string describing the template, which will be shown during
7051 selection.
7053 @item type
7054 The type of entry, a symbol.  Valid values are:
7056 @table @code
7057 @item entry
7058 An Org mode node, with a headline.  Will be filed as the child of the target
7059 entry or as a top-level entry.  The target file should be an Org mode file.
7060 @item item
7061 A plain list item, placed in the first plain  list at the target
7062 location.  Again the target file should be an Org file.
7063 @item checkitem
7064 A checkbox item.  This only differs from the plain list item by the
7065 default template.
7066 @item table-line
7067 a new line in the first table at the target location.  Where exactly the
7068 line will be inserted depends on the properties @code{:prepend} and
7069 @code{:table-line-pos} (see below).
7070 @item plain
7071 Text to be inserted as it is.
7072 @end table
7074 @item target
7075 @vindex org-default-notes-file
7076 Specification of where the captured item should be placed.  In Org mode
7077 files, targets usually define a node.  Entries will become children of this
7078 node.  Other types will be added to the table or list in the body of this
7079 node.  Most target specifications contain a file name.  If that file name is
7080 the empty string, it defaults to @code{org-default-notes-file}.  A file can
7081 also be given as a variable, function, or Emacs Lisp form.
7083 Valid values are:
7085 @table @code
7086 @item (file "path/to/file")
7087 Text will be placed at the beginning or end of that file.
7089 @item (id "id of existing org entry")
7090 Filing as child of this entry, or in the body of the entry.
7092 @item (file+headline "path/to/file" "node headline")
7093 Fast configuration if the target heading is unique in the file.
7095 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7096 For non-unique headings, the full path is safer.
7098 @item (file+regexp  "path/to/file" "regexp to find location")
7099 Use a regular expression to position the cursor.
7101 @item (file+datetree "path/to/file")
7102 Will create a heading in a date tree for today's date@footnote{Datetree
7103 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7104 and @code{* 2013} in your file, the capture will refile the note to the first
7105 one matched.}.
7107 @item (file+datetree+prompt "path/to/file")
7108 Will create a heading in a date tree, but will prompt for the date.
7110 @item (file+function "path/to/file" function-finding-location)
7111 A function to find the right location in the file.
7113 @item (clock)
7114 File to the entry that is currently being clocked.
7116 @item (function function-finding-location)
7117 Most general way, write your own function to find both
7118 file and location.
7119 @end table
7121 @item template
7122 The template for creating the capture item.  If you leave this empty, an
7123 appropriate default template will be used.  Otherwise this is a string with
7124 escape codes, which will be replaced depending on time and context of the
7125 capture call.  The string with escapes may be loaded from a template file,
7126 using the special syntax @code{(file "path/to/template")}.  See below for
7127 more details.
7129 @item properties
7130 The rest of the entry is a property list of additional options.
7131 Recognized properties are:
7133 @table @code
7134 @item :prepend
7135 Normally new captured information will be appended at
7136 the target location (last child, last table line, last list item...).
7137 Setting this property will change that.
7139 @item :immediate-finish
7140 When set, do not offer to edit the information, just
7141 file it away immediately.  This makes sense if the template only needs
7142 information that can be added automatically.
7144 @item :empty-lines
7145 Set this to the number of lines to insert
7146 before and after the new item.  Default 0, only common other value is 1.
7148 @item :clock-in
7149 Start the clock in this item.
7151 @item :clock-keep
7152 Keep the clock running when filing the captured entry.
7154 @item :clock-resume
7155 If starting the capture interrupted a clock, restart that clock when finished
7156 with the capture.  Note that @code{:clock-keep} has precedence over
7157 @code{:clock-resume}.  When setting both to @code{t}, the current clock will
7158 run and the previous one will not be resumed.
7160 @item :unnarrowed
7161 Do not narrow the target buffer, simply show the full buffer.  Default is to
7162 narrow it so that you only see the new material.
7164 @item :table-line-pos
7165 Specification of the location in the table where the new line should be
7166 inserted. It can be a string, a variable holding a string or a function
7167 returning a string. The string should look like @code{"II-3"} meaning that
7168 the new line should become the third line before the second horizontal
7169 separator line.
7171 @item :kill-buffer
7172 If the target file was not yet visited when capture was invoked, kill the
7173 buffer again after capture is completed.
7174 @end table
7175 @end table
7177 @node Template expansion
7178 @subsubsection Template expansion
7180 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7181 these sequences literally, escape the @kbd{%} with a backslash.} allow
7182 dynamic insertion of content.  The templates are expanded in the order given here:
7184 @smallexample
7185 %[@var{file}]     @r{Insert the contents of the file given by @var{file}.}
7186 %(@var{sexp})     @r{Evaluate Elisp @var{sexp} and replace with the result.}
7187                   @r{For convenience, %:keyword (see below) placeholders}
7188                   @r{within the expression will be expanded prior to this.}
7189                   @r{The sexp must return a string.}
7190 %<...>      @r{The result of format-time-string on the ... format specification.}
7191 %t          @r{Timestamp, date only.}
7192 %T          @r{Timestamp, with date and time.}
7193 %u, %U      @r{Like the above, but inactive timestamps.}
7194 %i          @r{Initial content, the region when capture is called while the}
7195             @r{region is active.}
7196             @r{The entire text will be indented like @code{%i} itself.}
7197 %a          @r{Annotation, normally the link created with @code{org-store-link}.}
7198 %A          @r{Like @code{%a}, but prompt for the description part.}
7199 %l          @r{Like %a, but only insert the literal link.}
7200 %c          @r{Current kill ring head.}
7201 %x          @r{Content of the X clipboard.}
7202 %k          @r{Title of the currently clocked task.}
7203 %K          @r{Link to the currently clocked task.}
7204 %n          @r{User name (taken from @code{user-full-name}).}
7205 %f          @r{File visited by current buffer when org-capture was called.}
7206 %F          @r{Full path of the file or directory visited by current buffer.}
7207 %:keyword   @r{Specific information for certain link types, see below.}
7208 %^g         @r{Prompt for tags, with completion on tags in target file.}
7209 %^G         @r{Prompt for tags, with completion all tags in all agenda files.}
7210 %^t         @r{Like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7211             @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7212 %^C         @r{Interactive selection of which kill or clip to use.}
7213 %^L         @r{Like @code{%^C}, but insert as link.}
7214 %^@{@var{prop}@}p   @r{Prompt the user for a value for property @var{prop}.}
7215 %^@{@var{prompt}@}  @r{prompt the user for a string and replace this sequence with it.}
7216             @r{You may specify a default value and a completion table with}
7217             @r{%^@{prompt|default|completion2|completion3...@}.}
7218             @r{The arrow keys access a prompt-specific history.}
7219 %\n         @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7220             @r{a number, starting from 1.}
7221 %?          @r{After completing the template, position cursor here.}
7222 @end smallexample
7224 @noindent
7225 For specific link types, the following keywords will be
7226 defined@footnote{If you define your own link types (@pxref{Adding
7227 hyperlink types}), any property you store with
7228 @code{org-store-link-props} can be accessed in capture templates in a
7229 similar way.}:
7231 @vindex org-from-is-user-regexp
7232 @smallexample
7233 Link type                        |  Available keywords
7234 ---------------------------------+----------------------------------------------
7235 bbdb                             |  %:name %:company
7236 irc                              |  %:server %:port %:nick
7237 vm, vm-imap, wl, mh, mew, rmail  |  %:type %:subject %:message-id
7238                                  |  %:from %:fromname %:fromaddress
7239                                  |  %:to   %:toname   %:toaddress
7240                                  |  %:date @r{(message date header field)}
7241                                  |  %:date-timestamp @r{(date as active timestamp)}
7242                                  |  %:date-timestamp-inactive @r{(date as inactive timestamp)}
7243                                  |  %: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}.}}
7244 gnus                             |  %:group, @r{for messages also all email fields}
7245 w3, w3m                          |  %:url
7246 info                             |  %:file %:node
7247 calendar                         |  %:date
7248 @end smallexample
7250 @noindent
7251 To place the cursor after template expansion use:
7253 @smallexample
7254 %?          @r{After completing the template, position cursor here.}
7255 @end smallexample
7257 @node Templates in contexts
7258 @subsubsection Templates in contexts
7260 @vindex org-capture-templates-contexts
7261 To control whether a capture template should be accessible from a specific
7262 context, you can customize @code{org-capture-templates-contexts}.  Let's say
7263 for example that you have a capture template @code{"p"} for storing Gnus
7264 emails containing patches.  Then you would configure this option like this:
7266 @smalllisp
7267 (setq org-capture-templates-contexts
7268       '(("p" (in-mode . "message-mode"))))
7269 @end smalllisp
7271 You can also tell that the command key @code{"p"} should refer to another
7272 template.  In that case, add this command key like this:
7274 @smalllisp
7275 (setq org-capture-templates-contexts
7276       '(("p" "q" (in-mode . "message-mode"))))
7277 @end smalllisp
7279 See the docstring of the variable for more information.
7281 @node Attachments
7282 @section Attachments
7283 @cindex attachments
7285 @vindex org-attach-directory
7286 It is often useful to associate reference material with an outline node/task.
7287 Small chunks of plain text can simply be stored in the subtree of a project.
7288 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7289 files that live elsewhere on your computer or in the cloud, like emails or
7290 source code files belonging to a project.  Another method is @i{attachments},
7291 which are files located in a directory belonging to an outline node.  Org
7292 uses directories named by the unique ID of each entry.  These directories are
7293 located in the @file{data} directory which lives in the same directory where
7294 your Org file lives@footnote{If you move entries or Org files from one
7295 directory to another, you may want to configure @code{org-attach-directory}
7296 to contain an absolute path.}.  If you initialize this directory with
7297 @code{git init}, Org will automatically commit changes when it sees them.
7298 The attachment system has been contributed to Org by John Wiegley.
7300 In cases where it seems better to do so, you can also attach a directory of your
7301 choice to an entry.  You can also make children inherit the attachment
7302 directory from a parent, so that an entire subtree uses the same attached
7303 directory.
7305 @noindent The following commands deal with attachments:
7307 @table @kbd
7308 @orgcmd{C-c C-a,org-attach}
7309 The dispatcher for commands related to the attachment system.  After these
7310 keys, a list of commands is displayed and you must press an additional key
7311 to select a command:
7313 @table @kbd
7314 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7315 @vindex org-attach-method
7316 Select a file and move it into the task's attachment directory.  The file
7317 will be copied, moved, or linked, depending on @code{org-attach-method}.
7318 Note that hard links are not supported on all systems.
7320 @kindex C-c C-a c
7321 @kindex C-c C-a m
7322 @kindex C-c C-a l
7323 @item c/m/l
7324 Attach a file using the copy/move/link method.
7325 Note that hard links are not supported on all systems.
7327 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7328 Create a new attachment as an Emacs buffer.
7330 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7331 Synchronize the current task with its attachment directory, in case you added
7332 attachments yourself.
7334 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7335 @vindex org-file-apps
7336 Open current task's attachment.  If there is more than one, prompt for a
7337 file name first.  Opening will follow the rules set by @code{org-file-apps}.
7338 For more details, see the information on following hyperlinks
7339 (@pxref{Handling links}).
7341 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7342 Also open the attachment, but force opening the file in Emacs.
7344 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7345 Open the current task's attachment directory.
7347 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7348 Also open the directory, but force using @command{dired} in Emacs.
7350 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7351 Select and delete a single attachment.
7353 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7354 Delete all of a task's attachments.  A safer way is to open the directory in
7355 @command{dired} and delete from there.
7357 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7358 @cindex property, ATTACH_DIR
7359 Set a specific directory as the entry's attachment directory.  This works by
7360 putting the directory path into the @code{ATTACH_DIR} property.
7362 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7363 @cindex property, ATTACH_DIR_INHERIT
7364 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7365 same directory for attachments as the parent does.
7366 @end table
7367 @end table
7369 @node RSS feeds
7370 @section RSS feeds
7371 @cindex RSS feeds
7372 @cindex Atom feeds
7374 Org can add and change entries based on information found in RSS feeds and
7375 Atom feeds.  You could use this to make a task out of each new podcast in a
7376 podcast feed.  Or you could use a phone-based note-creating service on the
7377 web to import tasks into Org.  To access feeds, configure the variable
7378 @code{org-feed-alist}.  The docstring of this variable has detailed
7379 information.  Here is just an example:
7381 @smalllisp
7382 @group
7383 (setq org-feed-alist
7384      '(("Slashdot"
7385          "http://rss.slashdot.org/Slashdot/slashdot"
7386          "~/txt/org/feeds.org" "Slashdot Entries")))
7387 @end group
7388 @end smalllisp
7390 @noindent
7391 will configure that new items from the feed provided by
7392 @code{rss.slashdot.org} will result in new entries in the file
7393 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7394 the following command is used:
7396 @table @kbd
7397 @orgcmd{C-c C-x g,org-feed-update-all}
7398 @item C-c C-x g
7399 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7400 them.
7401 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7402 Prompt for a feed name and go to the inbox configured for this feed.
7403 @end table
7405 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7406 it will store information about the status of items in the feed, to avoid
7407 adding the same item several times.
7409 For more information, including how to read atom feeds, see
7410 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7412 @node Protocols
7413 @section Protocols for external access
7414 @cindex protocols, for external access
7415 @cindex emacsserver
7417 You can set up Org for handling protocol calls from outside applications that
7418 are passed to Emacs through the @file{emacsserver}.  For example, you can
7419 configure bookmarks in your web browser to send a link to the current page to
7420 Org and create a note from it using capture (@pxref{Capture}).  Or you
7421 could create a bookmark that will tell Emacs to open the local source file of
7422 a remote website you are looking at with the browser.  See
7423 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7424 documentation and setup instructions.
7426 @node Refile and copy
7427 @section Refile and copy
7428 @cindex refiling notes
7429 @cindex copying notes
7431 When reviewing the captured data, you may want to refile or to copy some of
7432 the entries into a different list, for example into a project.  Cutting,
7433 finding the right location, and then pasting the note is cumbersome.  To
7434 simplify this process, you can use the following special command:
7436 @table @kbd
7437 @orgcmd{C-c M-w,org-copy}
7438 @findex org-copy
7439 Copying works like refiling, except that the original note is not deleted.
7440 @orgcmd{C-c C-w,org-refile}
7441 @findex org-refile
7442 @vindex org-reverse-note-order
7443 @vindex org-refile-targets
7444 @vindex org-refile-use-outline-path
7445 @vindex org-outline-path-complete-in-steps
7446 @vindex org-refile-allow-creating-parent-nodes
7447 @vindex org-log-refile
7448 @vindex org-refile-use-cache
7449 @vindex org-refile-keep
7450 Refile the entry or region at point.  This command offers possible locations
7451 for refiling the entry and lets you select one with completion.  The item (or
7452 all items in the region) is filed below the target heading as a subitem.
7453 Depending on @code{org-reverse-note-order}, it will be either the first or
7454 last subitem.@*
7455 By default, all level 1 headlines in the current buffer are considered to be
7456 targets, but you can have more complex definitions across a number of files.
7457 See the variable @code{org-refile-targets} for details.  If you would like to
7458 select a location via a file-path-like completion along the outline path, see
7459 the variables @code{org-refile-use-outline-path} and
7460 @code{org-outline-path-complete-in-steps}.  If you would like to be able to
7461 create new nodes as new parents for refiling on the fly, check the
7462 variable @code{org-refile-allow-creating-parent-nodes}.
7463 When the variable @code{org-log-refile}@footnote{with corresponding
7464 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7465 and @code{nologrefile}} is set, a timestamp or a note will be
7466 recorded when an entry has been refiled.
7467 @orgkey{C-u C-c C-w}
7468 Use the refile interface to jump to a heading.
7469 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7470 Jump to the location where @code{org-refile} last moved a tree to.
7471 @item C-2 C-c C-w
7472 Refile as the child of the item currently being clocked.
7473 @item C-3 C-c C-w
7474 Refile and keep the entry in place.  Also see @code{org-refile-keep} to make
7475 this the default behavior, and beware that this may result in duplicated
7476 @code{ID} properties.
7477 @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}
7478 Clear the target cache.  Caching of refile targets can be turned on by
7479 setting @code{org-refile-use-cache}.  To make the command see new possible
7480 targets, you have to clear the cache with this command.
7481 @end table
7483 @node Archiving
7484 @section Archiving
7485 @cindex archiving
7487 When a project represented by a (sub)tree is finished, you may want
7488 to move the tree out of the way and to stop it from contributing to the
7489 agenda.  Archiving is important to keep your working files compact and global
7490 searches like the construction of agenda views fast.
7492 @table @kbd
7493 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7494 @vindex org-archive-default-command
7495 Archive the current entry using the command specified in the variable
7496 @code{org-archive-default-command}.
7497 @end table
7499 @menu
7500 * Moving subtrees::             Moving a tree to an archive file
7501 * Internal archiving::          Switch off a tree but keep it in the file
7502 @end menu
7504 @node Moving subtrees
7505 @subsection Moving a tree to the archive file
7506 @cindex external archiving
7508 The most common archiving action is to move a project tree to another file,
7509 the archive file.
7511 @table @kbd
7512 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7513 @vindex org-archive-location
7514 Archive the subtree starting at the cursor position to the location
7515 given by @code{org-archive-location}.
7516 @orgkey{C-u C-c C-x C-s}
7517 Check if any direct children of the current headline could be moved to
7518 the archive.  To do this, each subtree is checked for open TODO entries.
7519 If none are found, the command offers to move it to the archive
7520 location.  If the cursor is @emph{not} on a headline when this command
7521 is invoked, the level 1 trees will be checked.
7522 @orgkey{C-u C-u C-c C-x C-s}
7523 As above, but check subtree for timestamps instead of TODO entries.  The
7524 command will offer to archive the subtree if it @emph{does} contain a
7525 timestamp, and that timestamp is in the past.
7526 @end table
7528 @cindex archive locations
7529 The default archive location is a file in the same directory as the
7530 current file, with the name derived by appending @file{_archive} to the
7531 current file name.  You can also choose what heading to file archived
7532 items under, with the possibility to add them to a datetree in a file.
7533 For information and examples on how to specify the file and the heading,
7534 see the documentation string of the variable
7535 @code{org-archive-location}.
7537 There is also an in-buffer option for setting this variable, for
7538 example@footnote{For backward compatibility, the following also works:
7539 If there are several such lines in a file, each specifies the archive
7540 location for the text below it.  The first such line also applies to any
7541 text before its definition.  However, using this method is
7542 @emph{strongly} deprecated as it is incompatible with the outline
7543 structure of the document.  The correct method for setting multiple
7544 archive locations in a buffer is using properties.}:
7546 @cindex #+ARCHIVE
7547 @example
7548 #+ARCHIVE: %s_done::
7549 @end example
7551 @cindex property, ARCHIVE
7552 @noindent
7553 If you would like to have a special ARCHIVE location for a single entry
7554 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7555 location as the value (@pxref{Properties and columns}).
7557 @vindex org-archive-save-context-info
7558 When a subtree is moved, it receives a number of special properties that
7559 record context information like the file from where the entry came, its
7560 outline path the archiving time etc.  Configure the variable
7561 @code{org-archive-save-context-info} to adjust the amount of information
7562 added.
7565 @node Internal archiving
7566 @subsection Internal archiving
7568 If you want to just switch off (for agenda views) certain subtrees without
7569 moving them to a different file, you can use the @code{ARCHIVE tag}.
7571 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7572 its location in the outline tree, but behaves in the following way:
7573 @itemize @minus
7574 @item
7575 @vindex org-cycle-open-archived-trees
7576 It does not open when you attempt to do so with a visibility cycling
7577 command (@pxref{Visibility cycling}).  You can force cycling archived
7578 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7579 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
7580 @code{show-all} will open archived subtrees.
7581 @item
7582 @vindex org-sparse-tree-open-archived-trees
7583 During sparse tree construction (@pxref{Sparse trees}), matches in
7584 archived subtrees are not exposed, unless you configure the option
7585 @code{org-sparse-tree-open-archived-trees}.
7586 @item
7587 @vindex org-agenda-skip-archived-trees
7588 During agenda view construction (@pxref{Agenda views}), the content of
7589 archived trees is ignored unless you configure the option
7590 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7591 be included.  In the agenda you can press @kbd{v a} to get archives
7592 temporarily included.
7593 @item
7594 @vindex org-export-with-archived-trees
7595 Archived trees are not exported (@pxref{Exporting}), only the headline
7596 is.  Configure the details using the variable
7597 @code{org-export-with-archived-trees}.
7598 @item
7599 @vindex org-columns-skip-archived-trees
7600 Archived trees are excluded from column view unless the variable
7601 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7602 @end itemize
7604 The following commands help manage the ARCHIVE tag:
7606 @table @kbd
7607 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7608 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
7609 the headline changes to a shadowed face, and the subtree below it is
7610 hidden.
7611 @orgkey{C-u C-c C-x a}
7612 Check if any direct children of the current headline should be archived.
7613 To do this, each subtree is checked for open TODO entries.  If none are
7614 found, the command offers to set the ARCHIVE tag for the child.  If the
7615 cursor is @emph{not} on a headline when this command is invoked, the
7616 level 1 trees will be checked.
7617 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7618 Cycle a tree even if it is tagged with ARCHIVE.
7619 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7620 Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
7621 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}.  The
7622 entry becomes a child of that sibling and in this way retains a lot of its
7623 original context, including inherited tags and approximate position in the
7624 outline.
7625 @end table
7628 @node Agenda views
7629 @chapter Agenda views
7630 @cindex agenda views
7632 Due to the way Org works, TODO items, time-stamped items, and
7633 tagged headlines can be scattered throughout a file or even a number of
7634 files.  To get an overview of open action items, or of events that are
7635 important for a particular date, this information must be collected,
7636 sorted and displayed in an organized way.
7638 Org can select items based on various criteria and display them
7639 in a separate buffer.  Seven different view types are provided:
7641 @itemize @bullet
7642 @item
7643 an @emph{agenda} that is like a calendar and shows information
7644 for specific dates,
7645 @item
7646 a @emph{TODO list} that covers all unfinished
7647 action items,
7648 @item
7649 a @emph{match view}, showings headlines based on the tags, properties, and
7650 TODO state associated with them,
7651 @item
7652 a @emph{timeline view} that shows all events in a single Org file,
7653 in time-sorted view,
7654 @item
7655 a @emph{text search view} that shows all entries from multiple files
7656 that contain specified keywords,
7657 @item
7658 a @emph{stuck projects view} showing projects that currently don't move
7659 along, and
7660 @item
7661 @emph{custom views} that are special searches and combinations of different
7662 views.
7663 @end itemize
7665 @noindent
7666 The extracted information is displayed in a special @emph{agenda
7667 buffer}.  This buffer is read-only, but provides commands to visit the
7668 corresponding locations in the original Org files, and even to
7669 edit these files remotely.
7671 @vindex org-agenda-window-setup
7672 @vindex org-agenda-restore-windows-after-quit
7673 Two variables control how the agenda buffer is displayed and whether the
7674 window configuration is restored when the agenda exits:
7675 @code{org-agenda-window-setup} and
7676 @code{org-agenda-restore-windows-after-quit}.
7678 @menu
7679 * Agenda files::                Files being searched for agenda information
7680 * Agenda dispatcher::           Keyboard access to agenda views
7681 * Built-in agenda views::       What is available out of the box?
7682 * Presentation and sorting::    How agenda items are prepared for display
7683 * Agenda commands::             Remote editing of Org trees
7684 * Custom agenda views::         Defining special searches and views
7685 * Exporting agenda views::      Writing a view to a file
7686 * Agenda column view::          Using column view for collected entries
7687 @end menu
7689 @node Agenda files
7690 @section Agenda files
7691 @cindex agenda files
7692 @cindex files for agenda
7694 @vindex org-agenda-files
7695 The information to be shown is normally collected from all @emph{agenda
7696 files}, the files listed in the variable
7697 @code{org-agenda-files}@footnote{If the value of that variable is not a
7698 list, but a single file name, then the list of agenda files will be
7699 maintained in that external file.}.  If a directory is part of this list,
7700 all files with the extension @file{.org} in this directory will be part
7701 of the list.
7703 Thus, even if you only work with a single Org file, that file should
7704 be put into the list@footnote{When using the dispatcher, pressing
7705 @kbd{<} before selecting a command will actually limit the command to
7706 the current file, and ignore @code{org-agenda-files} until the next
7707 dispatcher command.}.  You can customize @code{org-agenda-files}, but
7708 the easiest way to maintain it is through the following commands
7710 @cindex files, adding to agenda list
7711 @table @kbd
7712 @orgcmd{C-c [,org-agenda-file-to-front}
7713 Add current file to the list of agenda files.  The file is added to
7714 the front of the list.  If it was already in the list, it is moved to
7715 the front.  With a prefix argument, file is added/moved to the end.
7716 @orgcmd{C-c ],org-remove-file}
7717 Remove current file from the list of agenda files.
7718 @kindex C-,
7719 @cindex cycling, of agenda files
7720 @orgcmd{C-',org-cycle-agenda-files}
7721 @itemx C-,
7722 Cycle through agenda file list, visiting one file after the other.
7723 @kindex M-x org-iswitchb
7724 @item M-x org-iswitchb RET
7725 Command to use an @code{iswitchb}-like interface to switch to and between Org
7726 buffers.
7727 @end table
7729 @noindent
7730 The Org menu contains the current list of files and can be used
7731 to visit any of them.
7733 If you would like to focus the agenda temporarily on a file not in
7734 this list, or on just one file in the list, or even on only a subtree in a
7735 file, then this can be done in different ways.  For a single agenda command,
7736 you may press @kbd{<} once or several times in the dispatcher
7737 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
7738 extended period, use the following commands:
7740 @table @kbd
7741 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7742 Permanently restrict the agenda to the current subtree.  When with a
7743 prefix argument, or with the cursor before the first headline in a file,
7744 the agenda scope is set to the entire file.  This restriction remains in
7745 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7746 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
7747 agenda view, the new restriction takes effect immediately.
7748 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7749 Remove the permanent restriction created by @kbd{C-c C-x <}.
7750 @end table
7752 @noindent
7753 When working with @file{speedbar.el}, you can use the following commands in
7754 the Speedbar frame:
7756 @table @kbd
7757 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7758 Permanently restrict the agenda to the item---either an Org file or a subtree
7759 in such a file---at the cursor in the Speedbar frame.
7760 If there is a window displaying an agenda view, the new restriction takes
7761 effect immediately.
7762 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7763 Lift the restriction.
7764 @end table
7766 @node Agenda dispatcher
7767 @section The agenda dispatcher
7768 @cindex agenda dispatcher
7769 @cindex dispatching agenda commands
7770 The views are created through a dispatcher, which should be bound to a
7771 global key---for example @kbd{C-c a} (@pxref{Activation}).  In the
7772 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7773 is accessed and list keyboard access to commands accordingly.  After
7774 pressing @kbd{C-c a}, an additional letter is required to execute a
7775 command.  The dispatcher offers the following default commands:
7777 @table @kbd
7778 @item a
7779 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7780 @item t @r{/} T
7781 Create a list of all TODO items (@pxref{Global TODO list}).
7782 @item m @r{/} M
7783 Create a list of headlines matching a TAGS expression (@pxref{Matching
7784 tags and properties}).
7785 @item L
7786 Create the timeline view for the current buffer (@pxref{Timeline}).
7787 @item s
7788 Create a list of entries selected by a boolean expression of keywords
7789 and/or regular expressions that must or must not occur in the entry.
7790 @item /
7791 @vindex org-agenda-text-search-extra-files
7792 Search for a regular expression in all agenda files and additionally in
7793 the files listed in @code{org-agenda-text-search-extra-files}.  This
7794 uses the Emacs command @code{multi-occur}.  A prefix argument can be
7795 used to specify the number of context lines for each match, default is
7797 @item # @r{/} !
7798 Create a list of stuck projects (@pxref{Stuck projects}).
7799 @item <
7800 Restrict an agenda command to the current buffer@footnote{For backward
7801 compatibility, you can also press @kbd{1} to restrict to the current
7802 buffer.}.  After pressing @kbd{<}, you still need to press the character
7803 selecting the command.
7804 @item < <
7805 If there is an active region, restrict the following agenda command to
7806 the region.  Otherwise, restrict it to the current subtree@footnote{For
7807 backward compatibility, you can also press @kbd{0} to restrict to the
7808 current region/subtree.}.  After pressing @kbd{< <}, you still need to press the
7809 character selecting the command.
7811 @item *
7812 @cindex agenda, sticky
7813 @vindex org-agenda-sticky
7814 Toggle sticky agenda views.  By default, Org maintains only a single agenda
7815 buffer and rebuilds it each time you change the view, to make sure everything
7816 is always up to date.  If you often switch between agenda views and the build
7817 time bothers you, you can turn on sticky agenda buffers or make this the
7818 default by customizing the variable @code{org-agenda-sticky}.  With sticky
7819 agendas, the agenda dispatcher will not recreate agenda views from scratch,
7820 it will only switch to the selected one, and you need to update the agenda by
7821 hand with @kbd{r} or @kbd{g} when needed.  You can toggle sticky agenda view
7822 any time with @code{org-toggle-sticky-agenda}.
7823 @end table
7825 You can also define custom commands that will be accessible through the
7826 dispatcher, just like the default commands.  This includes the
7827 possibility to create extended agenda buffers that contain several
7828 blocks together, for example the weekly agenda, the global TODO list and
7829 a number of special tags matches.  @xref{Custom agenda views}.
7831 @node Built-in agenda views
7832 @section The built-in agenda views
7834 In this section we describe the built-in views.
7836 @menu
7837 * Weekly/daily agenda::         The calendar page with current tasks
7838 * Global TODO list::            All unfinished action items
7839 * Matching tags and properties::  Structured information with fine-tuned search
7840 * Timeline::                    Time-sorted view for single file
7841 * Search view::                 Find entries by searching for text
7842 * Stuck projects::              Find projects you need to review
7843 @end menu
7845 @node Weekly/daily agenda
7846 @subsection The weekly/daily agenda
7847 @cindex agenda
7848 @cindex weekly agenda
7849 @cindex daily agenda
7851 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7852 paper agenda, showing all the tasks for the current week or day.
7854 @table @kbd
7855 @cindex org-agenda, command
7856 @orgcmd{C-c a a,org-agenda-list}
7857 Compile an agenda for the current week from a list of Org files.  The agenda
7858 shows the entries for each day.  With a numeric prefix@footnote{For backward
7859 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7860 listed before the agenda.  This feature is deprecated, use the dedicated TODO
7861 list, or a block agenda instead (@pxref{Block agenda}).}  (like @kbd{C-u 2 1
7862 C-c a a}) you may set the number of days to be displayed.
7863 @end table
7865 @vindex org-agenda-span
7866 @vindex org-agenda-ndays
7867 @vindex org-agenda-start-day
7868 @vindex org-agenda-start-on-weekday
7869 The default number of days displayed in the agenda is set by the variable
7870 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}).  This
7871 variable can be set to any number of days you want to see by default in the
7872 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7873 @code{year}.  For weekly agendas, the default is to start on the previous
7874 monday (see @code{org-agenda-start-on-weekday}).  You can also set the start
7875 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7876 start the agenda ten days from today in the future.
7878 Remote editing from the agenda buffer means, for example, that you can
7879 change the dates of deadlines and appointments from the agenda buffer.
7880 The commands available in the Agenda buffer are listed in @ref{Agenda
7881 commands}.
7883 @subsubheading Calendar/Diary integration
7884 @cindex calendar integration
7885 @cindex diary integration
7887 Emacs contains the calendar and diary by Edward M. Reingold.  The
7888 calendar displays a three-month calendar with holidays from different
7889 countries and cultures.  The diary allows you to keep track of
7890 anniversaries, lunar phases, sunrise/set, recurrent appointments
7891 (weekly, monthly) and more.  In this way, it is quite complementary to
7892 Org.  It can be very useful to combine output from Org with
7893 the diary.
7895 In order to include entries from the Emacs diary into Org mode's
7896 agenda, you only need to customize the variable
7898 @lisp
7899 (setq org-agenda-include-diary t)
7900 @end lisp
7902 @noindent After that, everything will happen automatically.  All diary
7903 entries including holidays, anniversaries, etc., will be included in the
7904 agenda buffer created by Org mode.  @key{SPC}, @key{TAB}, and
7905 @key{RET} can be used from the agenda buffer to jump to the diary
7906 file in order to edit existing diary entries.  The @kbd{i} command to
7907 insert new entries for the current date works in the agenda buffer, as
7908 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7909 Sunrise/Sunset times, show lunar phases and to convert to other
7910 calendars, respectively.  @kbd{c} can be used to switch back and forth
7911 between calendar and agenda.
7913 If you are using the diary only for sexp entries and holidays, it is
7914 faster to not use the above setting, but instead to copy or even move
7915 the entries into an Org file.  Org mode evaluates diary-style sexp
7916 entries, and does it faster because there is no overhead for first
7917 creating the diary display.  Note that the sexp entries must start at
7918 the left margin, no whitespace is allowed before them.  For example,
7919 the following segment of an Org file will be processed and entries
7920 will be made in the agenda:
7922 @example
7923 * Birthdays and similar stuff
7924 #+CATEGORY: Holiday
7925 %%(org-calendar-holiday)   ; special function for holiday names
7926 #+CATEGORY: Ann
7927 %%(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
7928 %%(org-anniversary 1869 10  2) Mahatma Gandhi would be %d years old
7929 @end example
7931 @subsubheading Anniversaries from BBDB
7932 @cindex BBDB, anniversaries
7933 @cindex anniversaries, from BBDB
7935 If you are using the Big Brothers Database to store your contacts, you will
7936 very likely prefer to store anniversaries in BBDB rather than in a
7937 separate Org or diary file.  Org supports this and will show BBDB
7938 anniversaries as part of the agenda.  All you need to do is to add the
7939 following to one of your agenda files:
7941 @example
7942 * Anniversaries
7943   :PROPERTIES:
7944   :CATEGORY: Anniv
7945   :END:
7946 %%(org-bbdb-anniversaries)
7947 @end example
7949 You can then go ahead and define anniversaries for a BBDB record.  Basically,
7950 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7951 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7952 followed by a space and the class of the anniversary (@samp{birthday} or
7953 @samp{wedding}, or a format string).  If you omit the class, it will default to
7954 @samp{birthday}.  Here are a few examples, the header for the file
7955 @file{org-bbdb.el} contains more detailed information.
7957 @example
7958 1973-06-22
7959 06-22
7960 1955-08-02 wedding
7961 2008-04-14 %s released version 6.01 of org mode, %d years ago
7962 @end example
7964 After a change to BBDB, or for the first agenda display during an Emacs
7965 session, the agenda display will suffer a short delay as Org updates its
7966 hash with anniversaries.  However, from then on things will be very fast---much
7967 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7968 in an Org or Diary file.
7970 @subsubheading Appointment reminders
7971 @cindex @file{appt.el}
7972 @cindex appointment reminders
7973 @cindex appointment
7974 @cindex reminders
7976 Org can interact with Emacs appointments notification facility.  To add the
7977 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7978 This command lets you filter through the list of your appointments and add
7979 only those belonging to a specific category or matching a regular expression.
7980 It also reads a @code{APPT_WARNTIME} property which will then override the
7981 value of @code{appt-message-warning-time} for this appointment.  See the
7982 docstring for details.
7984 @node Global TODO list
7985 @subsection The global TODO list
7986 @cindex global TODO list
7987 @cindex TODO list, global
7989 The global TODO list contains all unfinished TODO items formatted and
7990 collected into a single place.
7992 @table @kbd
7993 @orgcmd{C-c a t,org-todo-list}
7994 Show the global TODO list.  This collects the TODO items from all agenda
7995 files (@pxref{Agenda views}) into a single buffer.  By default, this lists
7996 items with a state the is not a DONE state.  The buffer is in
7997 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7998 entries directly from that buffer (@pxref{Agenda commands}).
7999 @orgcmd{C-c a T,org-todo-list}
8000 @cindex TODO keyword matching
8001 @vindex org-todo-keywords
8002 Like the above, but allows selection of a specific TODO keyword.  You can
8003 also do this by specifying a prefix argument to @kbd{C-c a t}.  You are
8004 prompted for a keyword, and you may also specify several keywords by
8005 separating them with @samp{|} as the boolean OR operator.  With a numeric
8006 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
8007 @kindex r
8008 The @kbd{r} key in the agenda buffer regenerates it, and you can give
8009 a prefix argument to this command to change the selected TODO keyword,
8010 for example @kbd{3 r}.  If you often need a search for a specific
8011 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
8012 Matching specific TODO keywords can also be done as part of a tags
8013 search (@pxref{Tag searches}).
8014 @end table
8016 Remote editing of TODO items means that you can change the state of a
8017 TODO entry with a single key press.  The commands available in the
8018 TODO list are described in @ref{Agenda commands}.
8020 @cindex sublevels, inclusion into TODO list
8021 Normally the global TODO list simply shows all headlines with TODO
8022 keywords.  This list can become very long.  There are two ways to keep
8023 it more compact:
8024 @itemize @minus
8025 @item
8026 @vindex org-agenda-todo-ignore-scheduled
8027 @vindex org-agenda-todo-ignore-deadlines
8028 @vindex org-agenda-todo-ignore-timestamp
8029 @vindex org-agenda-todo-ignore-with-date
8030 Some people view a TODO item that has been @emph{scheduled} for execution or
8031 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
8032 Configure the variables @code{org-agenda-todo-ignore-scheduled},
8033 @code{org-agenda-todo-ignore-deadlines},
8034 @code{org-agenda-todo-ignore-timestamp} and/or
8035 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
8036 TODO list.
8037 @item
8038 @vindex org-agenda-todo-list-sublevels
8039 TODO items may have sublevels to break up the task into subtasks.  In
8040 such cases it may be enough to list only the highest level TODO headline
8041 and omit the sublevels from the global list.  Configure the variable
8042 @code{org-agenda-todo-list-sublevels} to get this behavior.
8043 @end itemize
8045 @node Matching tags and properties
8046 @subsection Matching tags and properties
8047 @cindex matching, of tags
8048 @cindex matching, of properties
8049 @cindex tags view
8050 @cindex match view
8052 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
8053 or have properties (@pxref{Properties and columns}), you can select headlines
8054 based on this metadata and collect them into an agenda buffer.  The match
8055 syntax described here also applies when creating sparse trees with @kbd{C-c /
8058 @table @kbd
8059 @orgcmd{C-c a m,org-tags-view}
8060 Produce a list of all headlines that match a given set of tags.  The
8061 command prompts for a selection criterion, which is a boolean logic
8062 expression with tags, like @samp{+work+urgent-withboss} or
8063 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
8064 define a custom command for it (@pxref{Agenda dispatcher}).
8065 @orgcmd{C-c a M,org-tags-view}
8066 @vindex org-tags-match-list-sublevels
8067 @vindex org-agenda-tags-todo-honor-ignore-options
8068 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
8069 not-DONE state and force checking subitems (see variable
8070 @code{org-tags-match-list-sublevels}).  To exclude scheduled/deadline items,
8071 see the variable @code{org-agenda-tags-todo-honor-ignore-options}.  Matching
8072 specific TODO keywords together with a tags match is also possible, see
8073 @ref{Tag searches}.
8074 @end table
8076 The commands available in the tags list are described in @ref{Agenda
8077 commands}.
8079 @subsubheading Match syntax
8081 @cindex Boolean logic, for tag/property searches
8082 A search string can use Boolean operators @samp{&} for @code{AND} and
8083 @samp{|} for @code{OR}@.  @samp{&} binds more strongly than @samp{|}.
8084 Parentheses are not implemented.  Each element in the search is either a
8085 tag, a regular expression matching tags, or an expression like
8086 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8087 property value.  Each element may be preceded by @samp{-}, to select
8088 against it, and @samp{+} is syntactic sugar for positive selection.  The
8089 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8090 present.  Here are some examples, using only tags.
8092 @table @samp
8093 @item work
8094 Select headlines tagged @samp{:work:}.
8095 @item work&boss
8096 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8097 @item +work-boss
8098 Select headlines tagged @samp{:work:}, but discard those also tagged
8099 @samp{:boss:}.
8100 @item work|laptop
8101 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8102 @item work|laptop+night
8103 Like before, but require the @samp{:laptop:} lines to be tagged also
8104 @samp{:night:}.
8105 @end table
8107 @cindex regular expressions, with tags search
8108 Instead of a tag, you may also specify a regular expression enclosed in curly
8109 braces.  For example,
8110 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8111 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8113 @cindex group tags, as regular expressions
8114 Group tags (@pxref{Tag groups}) are expanded as regular expressions.  E.g.,
8115 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8116 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8117 and searching for @samp{-work} will search for all headlines but those with
8118 one of the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8120 @cindex TODO keyword matching, with tags search
8121 @cindex level, require for tags/property match
8122 @cindex category, require for tags/property match
8123 @vindex org-odd-levels-only
8124 You may also test for properties (@pxref{Properties and columns}) at the same
8125 time as matching tags.  The properties may be real properties, or special
8126 properties that represent other metadata (@pxref{Special properties}).  For
8127 example, the ``property'' @code{TODO} represents the TODO keyword of the
8128 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8129 the entry.
8131 In addition to the @ref{Special properties}, one other ``property'' can also
8132 be used. @code{LEVEL} represents the level of an entry.  So a search
8133 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8134 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8135 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8136 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8138 Here are more examples:
8140 @table @samp
8141 @item work+TODO="WAITING"
8142 Select @samp{:work:}-tagged TODO lines with the specific TODO
8143 keyword @samp{WAITING}.
8144 @item work+TODO="WAITING"|home+TODO="WAITING"
8145 Waiting tasks both at work and at home.
8146 @end table
8148 When matching properties, a number of different operators can be used to test
8149 the value of a property.  Here is a complex example:
8151 @example
8152 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
8153          +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8154 @end example
8156 @noindent
8157 The type of comparison will depend on how the comparison value is written:
8158 @itemize @minus
8159 @item
8160 If the comparison value is a plain number, a numerical comparison is done,
8161 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8162 @samp{>=}, and @samp{<>}.
8163 @item
8164 If the comparison value is enclosed in double-quotes,
8165 a string comparison is done, and the same operators are allowed.
8166 @item
8167 If the comparison value is enclosed in double-quotes @emph{and} angular
8168 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8169 assumed to be date/time specifications in the standard Org way, and the
8170 comparison will be done accordingly.  Special values that will be recognized
8171 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8172 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8173 specification.  Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8174 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8175 respectively, can be used.
8176 @item
8177 If the comparison value is enclosed
8178 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8179 regexp matches the property value, and @samp{<>} meaning that it does not
8180 match.
8181 @end itemize
8183 So the search string in the example finds entries tagged @samp{:work:} but
8184 not @samp{:boss:}, which also have a priority value @samp{A}, a
8185 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8186 property that is numerically smaller than 2, a @samp{:With:} property that is
8187 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8188 on or after October 11, 2008.
8190 You can configure Org mode to use property inheritance during a search, but
8191 beware that this can slow down searches considerably.  See @ref{Property
8192 inheritance}, for details.
8194 For backward compatibility, and also for typing speed, there is also a
8195 different way to test TODO states in a search.  For this, terminate the
8196 tags/property part of the search string (which may include several terms
8197 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8198 expression just for TODO keywords.  The syntax is then similar to that for
8199 tags, but should be applied with care: for example, a positive selection on
8200 several TODO keywords cannot meaningfully be combined with boolean AND@.
8201 However, @emph{negative selection} combined with AND can be meaningful.  To
8202 make sure that only lines are checked that actually have any TODO keyword
8203 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8204 part after the slash with @samp{!}.  Using @kbd{C-c a M} or @samp{/!} will
8205 not match TODO keywords in a DONE state.  Examples:
8207 @table @samp
8208 @item work/WAITING
8209 Same as @samp{work+TODO="WAITING"}
8210 @item work/!-WAITING-NEXT
8211 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8212 nor @samp{NEXT}
8213 @item work/!+WAITING|+NEXT
8214 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8215 @samp{NEXT}.
8216 @end table
8218 @node Timeline
8219 @subsection Timeline for a single file
8220 @cindex timeline, single file
8221 @cindex time-sorted view
8223 The timeline summarizes all time-stamped items from a single Org mode
8224 file in a @emph{time-sorted view}.  The main purpose of this command is
8225 to give an overview over events in a project.
8227 @table @kbd
8228 @orgcmd{C-c a L,org-timeline}
8229 Show a time-sorted view of the Org file, with all time-stamped items.
8230 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8231 (scheduled or not) are also listed under the current date.
8232 @end table
8234 @noindent
8235 The commands available in the timeline buffer are listed in
8236 @ref{Agenda commands}.
8238 @node Search view
8239 @subsection Search view
8240 @cindex search view
8241 @cindex text search
8242 @cindex searching, for text
8244 This agenda view is a general text search facility for Org mode entries.
8245 It is particularly useful to find notes.
8247 @table @kbd
8248 @orgcmd{C-c a s,org-search-view}
8249 This is a special search that lets you select entries by matching a substring
8250 or specific words using a boolean logic.
8251 @end table
8252 For example, the search string @samp{computer equipment} will find entries
8253 that contain @samp{computer equipment} as a substring.  If the two words are
8254 separated by more space or a line break, the search will still match.
8255 Search view can also search for specific keywords in the entry, using Boolean
8256 logic.  The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8257 will search for note entries that contain the keywords @code{computer}
8258 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8259 not matched by the regular expression @code{8\.11[bg]}, meaning to
8260 exclude both 8.11b and 8.11g.  The first @samp{+} is necessary to turn on
8261 word search, other @samp{+} characters are optional.  For more details, see
8262 the docstring of the command @code{org-search-view}.
8264 @vindex org-agenda-text-search-extra-files
8265 Note that in addition to the agenda files, this command will also search
8266 the files listed in @code{org-agenda-text-search-extra-files}.
8268 @node Stuck projects
8269 @subsection Stuck projects
8270 @pindex GTD, Getting Things Done
8272 If you are following a system like David Allen's GTD to organize your
8273 work, one of the ``duties'' you have is a regular review to make sure
8274 that all projects move along.  A @emph{stuck} project is a project that
8275 has no defined next actions, so it will never show up in the TODO lists
8276 Org mode produces.  During the review, you need to identify such
8277 projects and define next actions for them.
8279 @table @kbd
8280 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8281 List projects that are stuck.
8282 @kindex C-c a !
8283 @item C-c a !
8284 @vindex org-stuck-projects
8285 Customize the variable @code{org-stuck-projects} to define what a stuck
8286 project is and how to find it.
8287 @end table
8289 You almost certainly will have to configure this view before it will
8290 work for you.  The built-in default assumes that all your projects are
8291 level-2 headlines, and that a project is not stuck if it has at least
8292 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8294 Let's assume that you, in your own way of using Org mode, identify
8295 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8296 indicate a project that should not be considered yet.  Let's further
8297 assume that the TODO keyword DONE marks finished projects, and that NEXT
8298 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
8299 is a next action even without the NEXT tag.  Finally, if the project
8300 contains the special word IGNORE anywhere, it should not be listed
8301 either.  In this case you would start by identifying eligible projects
8302 with a tags/todo match@footnote{@xref{Tag searches}.}
8303 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8304 IGNORE in the subtree to identify projects that are not stuck.  The
8305 correct customization for this is
8307 @lisp
8308 (setq org-stuck-projects
8309       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8310                                "\\<IGNORE\\>"))
8311 @end lisp
8313 Note that if a project is identified as non-stuck, the subtree of this entry
8314 will still be searched for stuck projects.
8316 @node Presentation and sorting
8317 @section Presentation and sorting
8318 @cindex presentation, of agenda items
8320 @vindex org-agenda-prefix-format
8321 @vindex org-agenda-tags-column
8322 Before displaying items in an agenda view, Org mode visually prepares the
8323 items and sorts them.  Each item occupies a single line.  The line starts
8324 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8325 of the item and other important information.  You can customize in which
8326 column tags will be displayed through @code{org-agenda-tags-column}.  You can
8327 also customize the prefix using the option @code{org-agenda-prefix-format}.
8328 This prefix is followed by a cleaned-up version of the outline headline
8329 associated with the item.
8331 @menu
8332 * Categories::                  Not all tasks are equal
8333 * Time-of-day specifications::  How the agenda knows the time
8334 * Sorting agenda items::        The order of things
8335 * Filtering/limiting agenda items::  Dynamically narrow the agenda
8336 @end menu
8338 @node Categories
8339 @subsection Categories
8341 @cindex category
8342 @cindex #+CATEGORY
8343 The category is a broad label assigned to each agenda item.  By default,
8344 the category is simply derived from the file name, but you can also
8345 specify it with a special line in the buffer, like this@footnote{For
8346 backward compatibility, the following also works: if there are several
8347 such lines in a file, each specifies the category for the text below it.
8348 The first category also applies to any text before the first CATEGORY
8349 line.  However, using this method is @emph{strongly} deprecated as it is
8350 incompatible with the outline structure of the document.  The correct
8351 method for setting multiple categories in a buffer is using a
8352 property.}:
8354 @example
8355 #+CATEGORY: Thesis
8356 @end example
8358 @noindent
8359 @cindex property, CATEGORY
8360 If you would like to have a special CATEGORY for a single entry or a
8361 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8362 special category you want to apply as the value.
8364 @noindent
8365 The display in the agenda buffer looks best if the category is not
8366 longer than 10 characters.
8368 @noindent
8369 You can set up icons for category by customizing the
8370 @code{org-agenda-category-icon-alist} variable.
8372 @node Time-of-day specifications
8373 @subsection Time-of-day specifications
8374 @cindex time-of-day specification
8376 Org mode checks each agenda item for a time-of-day specification.  The
8377 time can be part of the timestamp that triggered inclusion into the
8378 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
8379 ranges can be specified with two timestamps, like
8381 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8383 In the headline of the entry itself, a time(range) may also appear as
8384 plain text (like @samp{12:45} or a @samp{8:30-1pm}).  If the agenda
8385 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8386 specifications in diary entries are recognized as well.
8388 For agenda display, Org mode extracts the time and displays it in a
8389 standard 24 hour format as part of the prefix.  The example times in
8390 the previous paragraphs would end up in the agenda like this:
8392 @example
8393     8:30-13:00 Arthur Dent lies in front of the bulldozer
8394    12:45...... Ford Prefect arrives and takes Arthur to the pub
8395    19:00...... The Vogon reads his poem
8396    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8397 @end example
8399 @cindex time grid
8400 If the agenda is in single-day mode, or for the display of today, the
8401 timed entries are embedded in a time grid, like
8403 @example
8404     8:00...... ------------------
8405     8:30-13:00 Arthur Dent lies in front of the bulldozer
8406    10:00...... ------------------
8407    12:00...... ------------------
8408    12:45...... Ford Prefect arrives and takes Arthur to the pub
8409    14:00...... ------------------
8410    16:00...... ------------------
8411    18:00...... ------------------
8412    19:00...... The Vogon reads his poem
8413    20:00...... ------------------
8414    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8415 @end example
8417 @vindex org-agenda-use-time-grid
8418 @vindex org-agenda-time-grid
8419 The time grid can be turned on and off with the variable
8420 @code{org-agenda-use-time-grid}, and can be configured with
8421 @code{org-agenda-time-grid}.
8423 @node Sorting agenda items
8424 @subsection Sorting agenda items
8425 @cindex sorting, of agenda items
8426 @cindex priorities, of agenda items
8427 Before being inserted into a view, the items are sorted.  How this is
8428 done depends on the type of view.
8429 @itemize @bullet
8430 @item
8431 @vindex org-agenda-files
8432 For the daily/weekly agenda, the items for each day are sorted.  The
8433 default order is to first collect all items containing an explicit
8434 time-of-day specification.  These entries will be shown at the beginning
8435 of the list, as a @emph{schedule} for the day.  After that, items remain
8436 grouped in categories, in the sequence given by @code{org-agenda-files}.
8437 Within each category, items are sorted by priority (@pxref{Priorities}),
8438 which is composed of the base priority (2000 for priority @samp{A}, 1000
8439 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8440 overdue scheduled or deadline items.
8441 @item
8442 For the TODO list, items remain in the order of categories, but within
8443 each category, sorting takes place according to priority
8444 (@pxref{Priorities}).  The priority used for sorting derives from the
8445 priority cookie, with additions depending on how close an item is to its due
8446 or scheduled date.
8447 @item
8448 For tags matches, items are not sorted at all, but just appear in the
8449 sequence in which they are found in the agenda files.
8450 @end itemize
8452 @vindex org-agenda-sorting-strategy
8453 Sorting can be customized using the variable
8454 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8455 the estimated effort of an entry (@pxref{Effort estimates}).
8457 @node Filtering/limiting agenda items
8458 @subsection Filtering/limiting agenda items
8460 Agenda built-in or customized commands are statically defined.  Agenda
8461 filters and limits provide two ways of dynamically narrowing down the list of
8462 agenda entries: @emph{filters} and @emph{limits}.  Filters only act on the
8463 display of the items, while limits take effect before the list of agenda
8464 entries is built.  Filters are more often used interactively, while limits are
8465 mostly useful when defined as local variables within custom agenda commands.
8467 @subsubheading Filtering in the agenda
8468 @cindex filtering, by tag, category, top headline and effort, in agenda
8469 @cindex tag filtering, in agenda
8470 @cindex category filtering, in agenda
8471 @cindex top headline filtering, in agenda
8472 @cindex effort filtering, in agenda
8473 @cindex query editing, in agenda
8475 @table @kbd
8476 @orgcmd{/,org-agenda-filter-by-tag}
8477 @vindex org-agenda-tag-filter-preset
8478 Filter the agenda view with respect to a tag and/or effort estimates.  The
8479 difference between this and a custom agenda command is that filtering is very
8480 fast, so that you can switch quickly between different filters without having
8481 to recreate the agenda.@footnote{Custom commands can preset a filter by
8482 binding the variable @code{org-agenda-tag-filter-preset} as an option.  This
8483 filter will then be applied to the view and persist as a basic filter through
8484 refreshes and more secondary filtering.  The filter is a global property of
8485 the entire agenda view---in a block agenda, you should only set this in the
8486 global options section, not in the section of an individual block.}
8488 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8489 all.  Pressing @key{TAB} at that prompt will offer use completion to select a
8490 tag (including any tags that do not have a selection character).  The command
8491 then hides all entries that do not contain or inherit this tag.  When called
8492 with prefix arg, remove the entries that @emph{do} have the tag.  A second
8493 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8494 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8495 will be narrowed by requiring or forbidding the selected additional tag.
8496 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8497 immediately use the @kbd{\} command.
8499 Org also supports automatic, context-aware tag filtering.  If the variable
8500 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8501 that function can decide which tags should be excluded from the agenda
8502 automatically.  Once this is set, the @kbd{/} command then accepts @kbd{RET}
8503 as a sub-option key and runs the auto exclusion logic.  For example, let's
8504 say you use a @code{Net} tag to identify tasks which need network access, an
8505 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8506 calls.  You could auto-exclude these tags based on the availability of the
8507 Internet, and outside of business hours, with something like this:
8509 @smalllisp
8510 @group
8511 (defun org-my-auto-exclude-function (tag)
8512   (and (cond
8513         ((string= tag "Net")
8514          (/= 0 (call-process "/sbin/ping" nil nil nil
8515                              "-c1" "-q" "-t1" "mail.gnu.org")))
8516         ((or (string= tag "Errand") (string= tag "Call"))
8517          (let ((hour (nth 2 (decode-time))))
8518            (or (< hour 8) (> hour 21)))))
8519        (concat "-" tag)))
8521 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8522 @end group
8523 @end smalllisp
8525 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8526 Narrow the current agenda filter by an additional condition.  When called with
8527 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8528 the effort criterion.  You can achieve the same effect by pressing @kbd{+} or
8529 @kbd{-} as the first key after the @kbd{/} command.
8532 @kindex [
8533 @kindex ]
8534 @kindex @{
8535 @kindex @}
8536 @item [ ] @{ @}
8537 @table @i
8538 @item @r{in} search view
8539 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8540 (@kbd{@{} and @kbd{@}}) to the query string.  The opening bracket/brace will
8541 add a positive search term prefixed by @samp{+}, indicating that this search
8542 term @i{must} occur/match in the entry.  The closing bracket/brace will add a
8543 negative search term which @i{must not} occur/match in the entry for it to be
8544 selected.
8545 @end table
8547 @orgcmd{<,org-agenda-filter-by-category}
8548 @vindex org-agenda-category-filter-preset
8550 Filter the current agenda view with respect to the category of the item at
8551 point.  Pressing @code{<} another time will remove this filter.  You can add
8552 a filter preset through the option @code{org-agenda-category-filter-preset}
8553 (see below.)
8555 @orgcmd{^,org-agenda-filter-by-top-headline}
8556 Filter the current agenda view and only display the siblings and the parent
8557 headline of the one at point.
8559 @orgcmd{=,org-agenda-filter-by-regexp}
8560 @vindex org-agenda-regexp-filter-preset
8562 Filter the agenda view by a regular expression: only show agenda entries
8563 matching the regular expression the user entered.  When called with a prefix
8564 argument, it will filter @emph{out} entries matching the regexp.  With two
8565 universal prefix arguments, it will remove all the regexp filters, which can
8566 be accumulated.  You can add a filter preset through the option
8567 @code{org-agenda-category-filter-preset} (see below.)
8569 @orgcmd{_,org-agenda-filter-by-effort}
8570 @vindex org-agenda-effort-filter-preset
8571 @vindex org-sort-agenda-noeffort-is-high
8572 Filter the agenda view with respect to effort estimates.  
8573 You first need to set up allowed efforts globally, for example
8574 @lisp
8575 (setq org-global-properties
8576     '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8577 @end lisp
8578 You can then filter for an effort by first typing an operator, one of
8579 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8580 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8581 The filter will then restrict to entries with effort smaller-or-equal, equal,
8582 or larger-or-equal than the selected value.  For application of the operator,
8583 entries without a defined effort will be treated according to the value of
8584 @code{org-sort-agenda-noeffort-is-high}.
8586 @orgcmd{|,org-agenda-filter-remove-all}
8587 Remove all filters in the current agenda view.
8588 @end table
8590 @subsubheading Setting limits for the agenda
8591 @cindex limits, in agenda
8592 @vindex org-agenda-max-entries
8593 @vindex org-agenda-max-effort
8594 @vindex org-agenda-max-todos
8595 @vindex org-agenda-max-tags
8597 Here is a list of options that you can set, either globally, or locally in
8598 your custom agenda views (@pxref{Custom agenda views}).
8600 @table @code
8601 @item org-agenda-max-entries
8602 Limit the number of entries.
8603 @item org-agenda-max-effort
8604 Limit the duration of accumulated efforts (as minutes).
8605 @item org-agenda-max-todos
8606 Limit the number of entries with TODO keywords.
8607 @item org-agenda-max-tags
8608 Limit the number of tagged entries.
8609 @end table
8611 When set to a positive integer, each option will exclude entries from other
8612 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8613 the agenda to 100 minutes of effort and exclude any entry that has no effort
8614 property.  If you want to include entries with no effort property, use a
8615 negative value for @code{org-agenda-max-effort}.
8617 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8618 command.  For example, this custom command will display the next five entries
8619 with a @code{NEXT} TODO keyword.
8621 @smalllisp
8622 (setq org-agenda-custom-commands
8623       '(("n" todo "NEXT"
8624          ((org-agenda-max-entries 5)))))
8625 @end smalllisp
8627 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8628 will again the next five entries again, including the first entry that was
8629 excluded so far.
8631 You can also dynamically set temporary limits, which will be lost when
8632 rebuilding the agenda:
8634 @table @kbd
8635 @orgcmd{~,org-agenda-limit-interactively}
8636 This prompts for the type of limit to apply and its value.
8637 @end table
8639 @node Agenda commands
8640 @section Commands in the agenda buffer
8641 @cindex commands, in agenda buffer
8643 Entries in the agenda buffer are linked back to the Org file or diary
8644 file where they originate.  You are not allowed to edit the agenda
8645 buffer itself, but commands are provided to show and jump to the
8646 original entry location, and to edit the Org files ``remotely'' from
8647 the agenda buffer.  In this way, all information is stored only once,
8648 removing the risk that your agenda and note files may diverge.
8650 Some commands can be executed with mouse clicks on agenda lines.  For
8651 the other commands, the cursor needs to be in the desired line.
8653 @table @kbd
8654 @tsubheading{Motion}
8655 @cindex motion commands in agenda
8656 @orgcmd{n,org-agenda-next-line}
8657 Next line (same as @key{down} and @kbd{C-n}).
8658 @orgcmd{p,org-agenda-previous-line}
8659 Previous line (same as @key{up} and @kbd{C-p}).
8660 @orgcmd{N,org-agenda-next-item}
8661 Next item: same as next line, but only consider items.
8662 @orgcmd{P,org-agenda-previous-item}
8663 Previous item: same as previous line, but only consider items.
8664 @tsubheading{View/Go to Org file}
8665 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8666 Display the original location of the item in another window.
8667 With prefix arg, make sure that the entire entry is made visible in the
8668 outline, not only the heading.
8670 @orgcmd{L,org-agenda-recenter}
8671 Display original location and recenter that window.
8673 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8674 Go to the original location of the item in another window.
8676 @orgcmd{@key{RET},org-agenda-switch-to}
8677 Go to the original location of the item and delete other windows.
8679 @orgcmd{F,org-agenda-follow-mode}
8680 @vindex org-agenda-start-with-follow-mode
8681 Toggle Follow mode.  In Follow mode, as you move the cursor through
8682 the agenda buffer, the other window always shows the corresponding
8683 location in the Org file.  The initial setting for this mode in new
8684 agenda buffers can be set with the variable
8685 @code{org-agenda-start-with-follow-mode}.
8687 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8688 Display the entire subtree of the current item in an indirect buffer.  With a
8689 numeric prefix argument N, go up to level N and then take that tree.  If N is
8690 negative, go up that many levels.  With a @kbd{C-u} prefix, do not remove the
8691 previously used indirect buffer.
8693 @orgcmd{C-c C-o,org-agenda-open-link}
8694 Follow a link in the entry.  This will offer a selection of any links in the
8695 text belonging to the referenced Org node.  If there is only one link, it
8696 will be followed without a selection prompt.
8698 @tsubheading{Change display}
8699 @cindex display changing, in agenda
8700 @kindex A
8701 @item A
8702 Interactively select another agenda view and append it to the current view.
8704 @kindex o
8705 @item o
8706 Delete other windows.
8708 @orgcmdkskc{v d,d,org-agenda-day-view}
8709 @xorgcmdkskc{v w,w,org-agenda-week-view}
8710 @xorgcmd{v t,org-agenda-fortnight-view}
8711 @xorgcmd{v m,org-agenda-month-view}
8712 @xorgcmd{v y,org-agenda-year-view}
8713 @xorgcmd{v SPC,org-agenda-reset-view}
8714 @vindex org-agenda-span
8715 Switch to day/week/month/year view.  When switching to day or week view, this
8716 setting becomes the default for subsequent agenda refreshes.  Since month and
8717 year views are slow to create, they do not become the default.  A numeric
8718 prefix argument may be used to jump directly to a specific day of the year,
8719 ISO week, month, or year, respectively.  For example, @kbd{32 d} jumps to
8720 February 1st, @kbd{9 w} to ISO week number 9.  When setting day, week, or
8721 month view, a year may be encoded in the prefix argument as well.  For
8722 example, @kbd{200712 w} will jump to week 12 in 2007.  If such a year
8723 specification has only one or two digits, it will be mapped to the interval
8724 1938--2037.  @kbd{v @key{SPC}} will reset to what is set in
8725 @code{org-agenda-span}.
8727 @orgcmd{f,org-agenda-later}
8728 Go forward in time to display the following @code{org-agenda-current-span} days.
8729 For example, if the display covers a week, switch to the following week.
8730 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8732 @orgcmd{b,org-agenda-earlier}
8733 Go backward in time to display earlier dates.
8735 @orgcmd{.,org-agenda-goto-today}
8736 Go to today.
8738 @orgcmd{j,org-agenda-goto-date}
8739 Prompt for a date and go there.
8741 @orgcmd{J,org-agenda-clock-goto}
8742 Go to the currently clocked-in task @i{in the agenda buffer}.
8744 @orgcmd{D,org-agenda-toggle-diary}
8745 Toggle the inclusion of diary entries.  See @ref{Weekly/daily agenda}.
8747 @orgcmdkskc{v l,l,org-agenda-log-mode}
8748 @kindex v L
8749 @vindex org-log-done
8750 @vindex org-agenda-log-mode-items
8751 Toggle Logbook mode.  In Logbook mode, entries that were marked DONE while
8752 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8753 entries that have been clocked on that day.  You can configure the entry
8754 types that should be included in log mode using the variable
8755 @code{org-agenda-log-mode-items}.  When called with a @kbd{C-u} prefix, show
8756 all possible logbook entries, including state changes.  When called with two
8757 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8758 @kbd{v L} is equivalent to @kbd{C-u v l}.
8760 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8761 Include inactive timestamps into the current view.  Only for weekly/daily
8762 agenda and timeline views.
8764 @orgcmd{v a,org-agenda-archives-mode}
8765 @xorgcmd{v A,org-agenda-archives-mode 'files}
8766 Toggle Archives mode.  In Archives mode, trees that are marked
8767 @code{ARCHIVED} are also scanned when producing the agenda.  When you use the
8768 capital @kbd{A}, even all archive files are included.  To exit archives mode,
8769 press @kbd{v a} again.
8771 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8772 @vindex org-agenda-start-with-clockreport-mode
8773 @vindex org-clock-report-include-clocking-task
8774 Toggle Clockreport mode.  In Clockreport mode, the daily/weekly agenda will
8775 always show a table with the clocked times for the time span and file scope
8776 covered by the current agenda view.  The initial setting for this mode in new
8777 agenda buffers can be set with the variable
8778 @code{org-agenda-start-with-clockreport-mode}.  By using a prefix argument
8779 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8780 contributions from entries that are hidden by agenda filtering@footnote{Only
8781 tags filtering will be respected here, effort filtering is ignored.}.  See
8782 also the variable @code{org-clock-report-include-clocking-task}.
8784 @orgkey{v c}
8785 @vindex org-agenda-clock-consistency-checks
8786 Show overlapping clock entries, clocking gaps, and other clocking problems in
8787 the current agenda range.  You can then visit clocking lines and fix them
8788 manually.  See the variable @code{org-agenda-clock-consistency-checks} for
8789 information on how to customize the definition of what constituted a clocking
8790 problem.  To return to normal agenda display, press @kbd{l} to exit Logbook
8791 mode.
8793 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8794 @vindex org-agenda-start-with-entry-text-mode
8795 @vindex org-agenda-entry-text-maxlines
8796 Toggle entry text mode.  In entry text mode, a number of lines from the Org
8797 outline node referenced by an agenda line will be displayed below the line.
8798 The maximum number of lines is given by the variable
8799 @code{org-agenda-entry-text-maxlines}.  Calling this command with a numeric
8800 prefix argument will temporarily modify that number to the prefix value.
8802 @orgcmd{G,org-agenda-toggle-time-grid}
8803 @vindex org-agenda-use-time-grid
8804 @vindex org-agenda-time-grid
8805 Toggle the time grid on and off.  See also the variables
8806 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8808 @orgcmd{r,org-agenda-redo}
8809 Recreate the agenda buffer, for example to reflect the changes after
8810 modification of the timestamps of items with @kbd{S-@key{left}} and
8811 @kbd{S-@key{right}}.  When the buffer is the global TODO list, a prefix
8812 argument is interpreted to create a selective list for a specific TODO
8813 keyword.
8814 @orgcmd{g,org-agenda-redo}
8815 Same as @kbd{r}.
8817 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8818 Save all Org buffers in the current Emacs session, and also the locations of
8819 IDs.
8821 @orgcmd{C-c C-x C-c,org-agenda-columns}
8822 @vindex org-columns-default-format
8823 Invoke column view (@pxref{Column view}) in the agenda buffer.  The column
8824 view format is taken from the entry at point, or (if there is no entry at
8825 point), from the first entry in the agenda view.  So whatever the format for
8826 that entry would be in the original buffer (taken from a property, from a
8827 @code{#+COLUMNS} line, or from the default variable
8828 @code{org-columns-default-format}), will be used in the agenda.
8830 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8831 Remove the restriction lock on the agenda, if it is currently restricted to a
8832 file or subtree (@pxref{Agenda files}).
8834 @tsubheading{Secondary filtering and query editing}
8836 For a detailed description of these commands, see @pxref{Filtering/limiting
8837 agenda items}.
8839 @orgcmd{/,org-agenda-filter-by-tag}
8840 @vindex org-agenda-tag-filter-preset
8841 Filter the agenda view with respect to a tag and/or effort estimates.
8843 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8844 Narrow the current agenda filter by an additional condition.
8846 @orgcmd{<,org-agenda-filter-by-category}
8847 @vindex org-agenda-category-filter-preset
8849 Filter the current agenda view with respect to the category of the item at
8850 point.  Pressing @code{<} another time will remove this filter.
8852 @orgcmd{^,org-agenda-filter-by-top-headline}
8853 Filter the current agenda view and only display the siblings and the parent
8854 headline of the one at point.
8856 @orgcmd{=,org-agenda-filter-by-regexp}
8857 @vindex org-agenda-regexp-filter-preset
8859 Filter the agenda view by a regular expression: only show agenda entries
8860 matching the regular expression the user entered.  When called with a prefix
8861 argument, it will filter @emph{out} entries matching the regexp.  With two
8862 universal prefix arguments, it will remove all the regexp filters, which can
8863 be accumulated.  You can add a filter preset through the option
8864 @code{org-agenda-category-filter-preset} (see below.)
8866 @orgcmd{|,org-agenda-filter-remove-all}
8867 Remove all filters in the current agenda view.
8869 @tsubheading{Remote editing}
8870 @cindex remote editing, from agenda
8872 @item 0--9
8873 Digit argument.
8875 @cindex undoing remote-editing events
8876 @cindex remote editing, undo
8877 @orgcmd{C-_,org-agenda-undo}
8878 Undo a change due to a remote editing command.  The change is undone
8879 both in the agenda buffer and in the remote buffer.
8881 @orgcmd{t,org-agenda-todo}
8882 Change the TODO state of the item, both in the agenda and in the
8883 original org file.
8885 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8886 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8887 Switch to the next/previous set of TODO keywords.
8889 @orgcmd{C-k,org-agenda-kill}
8890 @vindex org-agenda-confirm-kill
8891 Delete the current agenda item along with the entire subtree belonging
8892 to it in the original Org file.  If the text to be deleted remotely
8893 is longer than one line, the kill needs to be confirmed by the user.  See
8894 variable @code{org-agenda-confirm-kill}.
8896 @orgcmd{C-c C-w,org-agenda-refile}
8897 Refile the entry at point.
8899 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8900 @vindex org-archive-default-command
8901 Archive the subtree corresponding to the entry at point using the default
8902 archiving command set in @code{org-archive-default-command}.  When using the
8903 @code{a} key, confirmation will be required.
8905 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8906 Toggle the ARCHIVE tag for the current headline.
8908 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8909 Move the subtree corresponding to the current entry to its @emph{archive
8910 sibling}.
8912 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8913 Archive the subtree corresponding to the current headline.  This means the
8914 entry will be moved to the configured archive location, most likely a
8915 different file.
8917 @orgcmd{T,org-agenda-show-tags}
8918 @vindex org-agenda-show-inherited-tags
8919 Show all tags associated with the current item.  This is useful if you have
8920 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8921 tags of a headline occasionally.
8923 @orgcmd{:,org-agenda-set-tags}
8924 Set tags for the current headline.  If there is an active region in the
8925 agenda, change a tag for all headings in the region.
8927 @kindex ,
8928 @item ,
8929 Set the priority for the current item (@command{org-agenda-priority}).
8930 Org mode prompts for the priority character.  If you reply with @key{SPC},
8931 the priority cookie is removed from the entry.
8933 @orgcmd{P,org-agenda-show-priority}
8934 Display weighted priority of current item.
8936 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8937 Increase the priority of the current item.  The priority is changed in
8938 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
8939 key for this.
8941 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8942 Decrease the priority of the current item.
8944 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8945 @vindex org-log-into-drawer
8946 Add a note to the entry.  This note will be recorded, and then filed to the
8947 same location where state change notes are put.  Depending on
8948 @code{org-log-into-drawer}, this may be inside a drawer.
8950 @orgcmd{C-c C-a,org-attach}
8951 Dispatcher for all command related to attachments.
8953 @orgcmd{C-c C-s,org-agenda-schedule}
8954 Schedule this item.  With prefix arg remove the scheduling timestamp
8956 @orgcmd{C-c C-d,org-agenda-deadline}
8957 Set a deadline for this item.  With prefix arg remove the deadline.
8959 @orgcmd{S-@key{right},org-agenda-do-date-later}
8960 Change the timestamp associated with the current line by one day into the
8961 future.  If the date is in the past, the first call to this command will move
8962 it to today.@*
8963 With a numeric prefix argument, change it by that many days.  For example,
8964 @kbd{3 6 5 S-@key{right}} will change it by a year.  With a @kbd{C-u} prefix,
8965 change the time by one hour.  If you immediately repeat the command, it will
8966 continue to change hours even without the prefix arg.  With a double @kbd{C-u
8967 C-u} prefix, do the same for changing minutes.@*
8968 The stamp is changed in the original Org file, but the change is not directly
8969 reflected in the agenda buffer.  Use @kbd{r} or @kbd{g} to update the buffer.
8971 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8972 Change the timestamp associated with the current line by one day
8973 into the past.
8975 @orgcmd{>,org-agenda-date-prompt}
8976 Change the timestamp associated with the current line.  The key @kbd{>} has
8977 been chosen, because it is the same as @kbd{S-.}  on my keyboard.
8979 @orgcmd{I,org-agenda-clock-in}
8980 Start the clock on the current item.  If a clock is running already, it
8981 is stopped first.
8983 @orgcmd{O,org-agenda-clock-out}
8984 Stop the previously started clock.
8986 @orgcmd{X,org-agenda-clock-cancel}
8987 Cancel the currently running clock.
8989 @orgcmd{J,org-agenda-clock-goto}
8990 Jump to the running clock in another window.
8992 @orgcmd{k,org-agenda-capture}
8993 Like @code{org-capture}, but use the date at point as the default date for
8994 the capture template.  See @code{org-capture-use-agenda-date} to make this
8995 the default behavior of @code{org-capture}.
8996 @cindex capturing, from agenda
8997 @vindex org-capture-use-agenda-date
8999 @tsubheading{Dragging agenda lines forward/backward}
9000 @cindex dragging, agenda lines
9002 @orgcmd{M-<up>,org-agenda-drag-line-backward}
9003 Drag the line at point backward one line@footnote{Moving agenda lines does
9004 not persist after an agenda refresh and does not modify the contributing
9005 @file{.org} files}.  With a numeric prefix argument, drag backward by that
9006 many lines.
9008 @orgcmd{M-<down>,org-agenda-drag-line-forward}
9009 Drag the line at point forward one line.  With a numeric prefix argument,
9010 drag forward by that many lines.
9012 @tsubheading{Bulk remote editing selected entries}
9013 @cindex remote editing, bulk, from agenda
9014 @vindex org-agenda-bulk-custom-functions
9016 @orgcmd{m,org-agenda-bulk-mark}
9017 Mark the entry at point for bulk action.  With numeric prefix argument, mark
9018 that many successive entries.
9020 @orgcmd{*,org-agenda-bulk-mark-all}
9021 Mark all visible agenda entries for bulk action.
9023 @orgcmd{u,org-agenda-bulk-unmark}
9024 Unmark entry at point for bulk action.
9026 @orgcmd{U,org-agenda-bulk-remove-all-marks}
9027 Unmark all marked entries for bulk action.
9029 @orgcmd{M-m,org-agenda-bulk-toggle}
9030 Toggle mark of the entry at point for bulk action.
9032 @orgcmd{M-*,org-agenda-bulk-toggle-all}
9033 Toggle marks of all visible entries for bulk action.
9035 @orgcmd{%,org-agenda-bulk-mark-regexp}
9036 Mark entries matching a regular expression for bulk action.
9038 @orgcmd{B,org-agenda-bulk-action}
9039 Bulk action: act on all marked entries in the agenda.  This will prompt for
9040 another key to select the action to be applied.  The prefix arg to @kbd{B}
9041 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
9042 these special timestamps.  By default, marks are removed after the bulk.  If
9043 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
9044 @code{t} or hit @kbd{p} at the prompt.
9046 @table @kbd
9047 @item *
9048 Toggle persistent marks.
9049 @item $
9050 Archive all selected entries.
9051 @item A
9052 Archive entries by moving them to their respective archive siblings.
9053 @item t
9054 Change TODO state.  This prompts for a single TODO keyword and changes the
9055 state of all selected entries, bypassing blocking and suppressing logging
9056 notes (but not timestamps).
9057 @item +
9058 Add a tag to all selected entries.
9059 @item -
9060 Remove a tag from all selected entries.
9061 @item s
9062 Schedule all items to a new date.  To shift existing schedule dates by a
9063 fixed number of days, use something starting with double plus at the prompt,
9064 for example @samp{++8d} or @samp{++2w}.
9065 @item d
9066 Set deadline to a specific date.
9067 @item r
9068 Prompt for a single refile target and move all entries.  The entries will no
9069 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9070 @item S
9071 Reschedule randomly into the coming N days.  N will be prompted for.  With
9072 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9073 @item f
9074 Apply a function@footnote{You can also create persistent custom functions
9075 through @code{org-agenda-bulk-custom-functions}.} to marked entries.  For
9076 example, the function below sets the CATEGORY property of the entries to web.
9078 @lisp
9079 @group
9080 (defun set-category ()
9081   (interactive "P")
9082   (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9083                      (org-agenda-error)))
9084          (buffer (marker-buffer marker)))
9085     (with-current-buffer buffer
9086       (save-excursion
9087         (save-restriction
9088           (widen)
9089           (goto-char marker)
9090           (org-back-to-heading t)
9091           (org-set-property "CATEGORY" "web"))))))
9092 @end group
9093 @end lisp
9094 @end table
9096 @tsubheading{Calendar commands}
9097 @cindex calendar commands, from agenda
9099 @orgcmd{c,org-agenda-goto-calendar}
9100 Open the Emacs calendar and move to the date at the agenda cursor.
9102 @orgcmd{c,org-calendar-goto-agenda}
9103 When in the calendar, compute and show the Org mode agenda for the
9104 date at the cursor.
9106 @cindex diary entries, creating from agenda
9107 @orgcmd{i,org-agenda-diary-entry}
9108 @vindex org-agenda-diary-file
9109 Insert a new entry into the diary, using the date at the cursor and (for
9110 block entries) the date at the mark.  This will add to the Emacs diary
9111 file@footnote{This file is parsed for the agenda when
9112 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9113 command in the calendar.  The diary file will pop up in another window, where
9114 you can add the entry.
9116 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9117 Org will create entries (in Org mode syntax) in that file instead.  Most
9118 entries will be stored in a date-based outline tree that will later make it
9119 easy to archive appointments from previous months/years.  The tree will be
9120 built under an entry with a @code{DATE_TREE} property, or else with years as
9121 top-level entries.  Emacs will prompt you for the entry text---if you specify
9122 it, the entry will be created in @code{org-agenda-diary-file} without further
9123 interaction.  If you directly press @key{RET} at the prompt without typing
9124 text, the target file will be shown in another window for you to finish the
9125 entry there.  See also the @kbd{k r} command.
9127 @orgcmd{M,org-agenda-phases-of-moon}
9128 Show the phases of the moon for the three months around current date.
9130 @orgcmd{S,org-agenda-sunrise-sunset}
9131 Show sunrise and sunset times.  The geographical location must be set
9132 with calendar variables, see the documentation for the Emacs calendar.
9134 @orgcmd{C,org-agenda-convert-date}
9135 Convert the date at cursor into many other cultural and historic
9136 calendars.
9138 @orgcmd{H,org-agenda-holidays}
9139 Show holidays for three months around the cursor date.
9141 @item M-x org-icalendar-combine-agenda-files RET
9142 Export a single iCalendar file containing entries from all agenda files.
9143 This is a globally available command, and also available in the agenda menu.
9145 @tsubheading{Exporting to a file}
9146 @orgcmd{C-x C-w,org-agenda-write}
9147 @cindex exporting agenda views
9148 @cindex agenda views, exporting
9149 @vindex org-agenda-exporter-settings
9150 Write the agenda view to a file.  Depending on the extension of the selected
9151 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9152 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9153 (any other extension).  When exporting to Org, only the body of original
9154 headlines are exported, not subtrees or inherited tags.  When called with a
9155 @kbd{C-u} prefix argument, immediately open the newly created file.  Use the
9156 variable @code{org-agenda-exporter-settings} to set options for
9157 @file{ps-print} and for @file{htmlize} to be used during export.
9159 @tsubheading{Quit and Exit}
9160 @orgcmd{q,org-agenda-quit}
9161 Quit agenda, remove the agenda buffer.
9163 @cindex agenda files, removing buffers
9164 @orgcmd{x,org-agenda-exit}
9165 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9166 for the compilation of the agenda.  Buffers created by the user to
9167 visit Org files will not be removed.
9168 @end table
9171 @node Custom agenda views
9172 @section Custom agenda views
9173 @cindex custom agenda views
9174 @cindex agenda views, custom
9176 Custom agenda commands serve two purposes: to store and quickly access
9177 frequently used TODO and tags searches, and to create special composite
9178 agenda buffers.  Custom agenda commands will be accessible through the
9179 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9181 @menu
9182 * Storing searches::            Type once, use often
9183 * Block agenda::                All the stuff you need in a single buffer
9184 * Setting options::             Changing the rules
9185 @end menu
9187 @node Storing searches
9188 @subsection Storing searches
9190 The first application of custom searches is the definition of keyboard
9191 shortcuts for frequently used searches, either creating an agenda
9192 buffer, or a sparse tree (the latter covering of course only the current
9193 buffer).
9194 @kindex C-c a C
9195 @vindex org-agenda-custom-commands
9196 @cindex agenda views, main example
9197 @cindex agenda, as an agenda views
9198 @cindex agenda*, as an agenda views
9199 @cindex tags, as an agenda view
9200 @cindex todo, as an agenda view
9201 @cindex tags-todo
9202 @cindex todo-tree
9203 @cindex occur-tree
9204 @cindex tags-tree
9206 Custom commands are configured in the variable
9207 @code{org-agenda-custom-commands}.  You can customize this variable, for
9208 example by pressing @kbd{C-c a C}.  You can also directly set it with Emacs
9209 Lisp in @file{.emacs}.  The following example contains all valid agenda
9210 views:
9212 @lisp
9213 @group
9214 (setq org-agenda-custom-commands
9215       '(("x" agenda)
9216         ("y" agenda*)
9217         ("w" todo "WAITING")
9218         ("W" todo-tree "WAITING")
9219         ("u" tags "+boss-urgent")
9220         ("v" tags-todo "+boss-urgent")
9221         ("U" tags-tree "+boss-urgent")
9222         ("f" occur-tree "\\<FIXME\\>")
9223         ("h" . "HOME+Name tags searches") ; description for "h" prefix
9224         ("hl" tags "+home+Lisa")
9225         ("hp" tags "+home+Peter")
9226         ("hk" tags "+home+Kim")))
9227 @end group
9228 @end lisp
9230 @noindent
9231 The initial string in each entry defines the keys you have to press
9232 after the dispatcher command @kbd{C-c a} in order to access the command.
9233 Usually this will be just a single character, but if you have many
9234 similar commands, you can also define two-letter combinations where the
9235 first character is the same in several combinations and serves as a
9236 prefix key@footnote{You can provide a description for a prefix key by
9237 inserting a cons cell with the prefix and the description.}.  The second
9238 parameter is the search type, followed by the string or regular
9239 expression to be used for the matching.  The example above will
9240 therefore define:
9242 @table @kbd
9243 @item C-c a x
9244 as a global search for agenda entries planned@footnote{@emph{Planned} means
9245 here that these entries have some planning information attached to them, like
9246 a time-stamp, a scheduled or a deadline string.  See
9247 @code{org-agenda-entry-types} on how to set what planning information will be
9248 taken into account.} this week/day.
9249 @item C-c a y
9250 as a global search for agenda entries planned this week/day, but only those
9251 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9252 @item C-c a w
9253 as a global search for TODO entries with @samp{WAITING} as the TODO
9254 keyword
9255 @item C-c a W
9256 as the same search, but only in the current buffer and displaying the
9257 results as a sparse tree
9258 @item C-c a u
9259 as a global tags search for headlines marked @samp{:boss:} but not
9260 @samp{:urgent:}
9261 @item C-c a v
9262 as the same search as @kbd{C-c a u}, but limiting the search to
9263 headlines that are also TODO items
9264 @item C-c a U
9265 as the same search as @kbd{C-c a u}, but only in the current buffer and
9266 displaying the result as a sparse tree
9267 @item C-c a f
9268 to create a sparse tree (again: current buffer only) with all entries
9269 containing the word @samp{FIXME}
9270 @item C-c a h
9271 as a prefix command for a HOME tags search where you have to press an
9272 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9273 Peter, or Kim) as additional tag to match.
9274 @end table
9276 Note that the @code{*-tree} agenda views need to be called from an
9277 Org buffer as they operate on the current buffer only.
9279 @node Block agenda
9280 @subsection Block agenda
9281 @cindex block agenda
9282 @cindex agenda, with block views
9284 Another possibility is the construction of agenda views that comprise
9285 the results of @emph{several} commands, each of which creates a block in
9286 the agenda buffer.  The available commands include @code{agenda} for the
9287 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9288 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9289 matching commands discussed above: @code{todo}, @code{tags}, and
9290 @code{tags-todo}.  Here are two examples:
9292 @lisp
9293 @group
9294 (setq org-agenda-custom-commands
9295       '(("h" "Agenda and Home-related tasks"
9296          ((agenda "")
9297           (tags-todo "home")
9298           (tags "garden")))
9299         ("o" "Agenda and Office-related tasks"
9300          ((agenda "")
9301           (tags-todo "work")
9302           (tags "office")))))
9303 @end group
9304 @end lisp
9306 @noindent
9307 This will define @kbd{C-c a h} to create a multi-block view for stuff
9308 you need to attend to at home.  The resulting agenda buffer will contain
9309 your agenda for the current week, all TODO items that carry the tag
9310 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
9311 command @kbd{C-c a o} provides a similar view for office tasks.
9313 @node Setting options
9314 @subsection Setting options for custom commands
9315 @cindex options, for custom agenda views
9317 @vindex org-agenda-custom-commands
9318 Org mode contains a number of variables regulating agenda construction
9319 and display.  The global variables define the behavior for all agenda
9320 commands, including the custom commands.  However, if you want to change
9321 some settings just for a single custom view, you can do so.  Setting
9322 options requires inserting a list of variable names and values at the
9323 right spot in @code{org-agenda-custom-commands}.  For example:
9325 @lisp
9326 @group
9327 (setq org-agenda-custom-commands
9328       '(("w" todo "WAITING"
9329          ((org-agenda-sorting-strategy '(priority-down))
9330           (org-agenda-prefix-format "  Mixed: ")))
9331         ("U" tags-tree "+boss-urgent"
9332          ((org-show-context-detail 'minimal)))
9333         ("N" search ""
9334          ((org-agenda-files '("~org/notes.org"))
9335           (org-agenda-text-search-extra-files nil)))))
9336 @end group
9337 @end lisp
9339 @noindent
9340 Now the @kbd{C-c a w} command will sort the collected entries only by
9341 priority, and the prefix format is modified to just say @samp{  Mixed: }
9342 instead of giving the category of the entry.  The sparse tags tree of
9343 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9344 headline hierarchy above the match, nor the headline following the match
9345 will be shown.  The command @kbd{C-c a N} will do a text search limited
9346 to only a single file.
9348 @vindex org-agenda-custom-commands
9349 For command sets creating a block agenda,
9350 @code{org-agenda-custom-commands} has two separate spots for setting
9351 options.  You can add options that should be valid for just a single
9352 command in the set, and options that should be valid for all commands in
9353 the set.  The former are just added to the command entry; the latter
9354 must come after the list of command entries.  Going back to the block
9355 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9356 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9357 the results for GARDEN tags query in the opposite order,
9358 @code{priority-up}.  This would look like this:
9360 @lisp
9361 @group
9362 (setq org-agenda-custom-commands
9363       '(("h" "Agenda and Home-related tasks"
9364          ((agenda)
9365           (tags-todo "home")
9366           (tags "garden"
9367                 ((org-agenda-sorting-strategy '(priority-up)))))
9368          ((org-agenda-sorting-strategy '(priority-down))))
9369         ("o" "Agenda and Office-related tasks"
9370          ((agenda)
9371           (tags-todo "work")
9372           (tags "office")))))
9373 @end group
9374 @end lisp
9376 As you see, the values and parentheses setting is a little complex.
9377 When in doubt, use the customize interface to set this variable---it
9378 fully supports its structure.  Just one caveat: when setting options in
9379 this interface, the @emph{values} are just Lisp expressions.  So if the
9380 value is a string, you need to add the double-quotes around the value
9381 yourself.
9383 @vindex org-agenda-custom-commands-contexts
9384 To control whether an agenda command should be accessible from a specific
9385 context, you can customize @code{org-agenda-custom-commands-contexts}.  Let's
9386 say for example that you have an agenda command @code{"o"} displaying a view
9387 that you only need when reading emails.  Then you would configure this option
9388 like this:
9390 @lisp
9391 (setq org-agenda-custom-commands-contexts
9392       '(("o" (in-mode . "message-mode"))))
9393 @end lisp
9395 You can also tell that the command key @code{"o"} should refer to another
9396 command key @code{"r"}.  In that case, add this command key like this:
9398 @lisp
9399 (setq org-agenda-custom-commands-contexts
9400       '(("o" "r" (in-mode . "message-mode"))))
9401 @end lisp
9403 See the docstring of the variable for more information.
9405 @node Exporting agenda views
9406 @section Exporting agenda views
9407 @cindex agenda views, exporting
9409 If you are away from your computer, it can be very useful to have a printed
9410 version of some agenda views to carry around.  Org mode can export custom
9411 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9412 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9413 ghostscript @file{ps2pdf} utility must be installed on the system.  Selecting
9414 a PDF file will also create the postscript file.}, and iCalendar files.  If
9415 you want to do this only occasionally, use the command
9417 @table @kbd
9418 @orgcmd{C-x C-w,org-agenda-write}
9419 @cindex exporting agenda views
9420 @cindex agenda views, exporting
9421 @vindex org-agenda-exporter-settings
9422 Write the agenda view to a file.  Depending on the extension of the selected
9423 file name, the view will be exported as HTML (extension @file{.html} or
9424 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9425 @file{.ics}), or plain text (any other extension).  Use the variable
9426 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9427 for @file{htmlize} to be used during export, for example
9429 @vindex org-agenda-add-entry-text-maxlines
9430 @vindex htmlize-output-type
9431 @vindex ps-number-of-columns
9432 @vindex ps-landscape-mode
9433 @lisp
9434 (setq org-agenda-exporter-settings
9435       '((ps-number-of-columns 2)
9436         (ps-landscape-mode t)
9437         (org-agenda-add-entry-text-maxlines 5)
9438         (htmlize-output-type 'css)))
9439 @end lisp
9440 @end table
9442 If you need to export certain agenda views frequently, you can associate
9443 any custom agenda command with a list of output file names
9444 @footnote{If you want to store standard views like the weekly agenda
9445 or the global TODO list as well, you need to define custom commands for
9446 them in order to be able to specify file names.}.  Here is an example
9447 that first defines custom commands for the agenda and the global
9448 TODO list, together with a number of files to which to export them.
9449 Then we define two block agenda commands and specify file names for them
9450 as well.  File names can be relative to the current working directory,
9451 or absolute.
9453 @lisp
9454 @group
9455 (setq org-agenda-custom-commands
9456       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9457         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9458         ("h" "Agenda and Home-related tasks"
9459          ((agenda "")
9460           (tags-todo "home")
9461           (tags "garden"))
9462          nil
9463          ("~/views/home.html"))
9464         ("o" "Agenda and Office-related tasks"
9465          ((agenda)
9466           (tags-todo "work")
9467           (tags "office"))
9468          nil
9469          ("~/views/office.ps" "~/calendars/office.ics"))))
9470 @end group
9471 @end lisp
9473 The extension of the file name determines the type of export.  If it is
9474 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9475 the buffer to HTML and save it to this file name.  If the extension is
9476 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9477 Postscript output.  If the extension is @file{.ics}, iCalendar export is
9478 run export over all files that were used to construct the agenda, and
9479 limit the export to entries listed in the agenda.  Any other
9480 extension produces a plain ASCII file.
9482 The export files are @emph{not} created when you use one of those
9483 commands interactively because this might use too much overhead.
9484 Instead, there is a special command to produce @emph{all} specified
9485 files in one step:
9487 @table @kbd
9488 @orgcmd{C-c a e,org-store-agenda-views}
9489 Export all agenda views that have export file names associated with
9490 them.
9491 @end table
9493 You can use the options section of the custom agenda commands to also
9494 set options for the export commands.  For example:
9496 @lisp
9497 (setq org-agenda-custom-commands
9498       '(("X" agenda ""
9499          ((ps-number-of-columns 2)
9500           (ps-landscape-mode t)
9501           (org-agenda-prefix-format " [ ] ")
9502           (org-agenda-with-colors nil)
9503           (org-agenda-remove-tags t))
9504          ("theagenda.ps"))))
9505 @end lisp
9507 @noindent
9508 This command sets two options for the Postscript exporter, to make it
9509 print in two columns in landscape format---the resulting page can be cut
9510 in two and then used in a paper agenda.  The remaining settings modify
9511 the agenda prefix to omit category and scheduling information, and
9512 instead include a checkbox to check off items.  We also remove the tags
9513 to make the lines compact, and we don't want to use colors for the
9514 black-and-white printer.  Settings specified in
9515 @code{org-agenda-exporter-settings} will also apply, but the settings
9516 in @code{org-agenda-custom-commands} take precedence.
9518 @noindent
9519 From the command line you may also use
9520 @example
9521 emacs -eval (org-batch-store-agenda-views) -kill
9522 @end example
9523 @noindent
9524 or, if you need to modify some parameters@footnote{Quoting depends on the
9525 system you use, please check the FAQ for examples.}
9526 @example
9527 emacs -eval '(org-batch-store-agenda-views                      \
9528               org-agenda-span (quote month)                     \
9529               org-agenda-start-day "2007-11-01"                 \
9530               org-agenda-include-diary nil                      \
9531               org-agenda-files (quote ("~/org/project.org")))'  \
9532       -kill
9533 @end example
9534 @noindent
9535 which will create the agenda views restricted to the file
9536 @file{~/org/project.org}, without diary entries and with a 30-day
9537 extent.
9539 You can also extract agenda information in a way that allows further
9540 processing by other programs.  See @ref{Extracting agenda information}, for
9541 more information.
9544 @node Agenda column view
9545 @section Using column view in the agenda
9546 @cindex column view, in agenda
9547 @cindex agenda, column view
9549 Column view (@pxref{Column view}) is normally used to view and edit
9550 properties embedded in the hierarchical structure of an Org file.  It can be
9551 quite useful to use column view also from the agenda, where entries are
9552 collected by certain criteria.
9554 @table @kbd
9555 @orgcmd{C-c C-x C-c,org-agenda-columns}
9556 Turn on column view in the agenda.
9557 @end table
9559 To understand how to use this properly, it is important to realize that the
9560 entries in the agenda are no longer in their proper outline environment.
9561 This causes the following issues:
9563 @enumerate
9564 @item
9565 @vindex org-columns-default-format
9566 @vindex org-overriding-columns-format
9567 Org needs to make a decision which @code{COLUMNS} format to use.  Since the
9568 entries in the agenda are collected from different files, and different files
9569 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9570 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9571 currently set, and if so, takes the format from there.  Otherwise it takes
9572 the format associated with the first item in the agenda, or, if that item
9573 does not have a specific format (defined in a property, or in its file), it
9574 uses @code{org-columns-default-format}.
9575 @item
9576 @cindex property, special, CLOCKSUM
9577 If any of the columns has a summary type defined (@pxref{Column attributes}),
9578 turning on column view in the agenda will visit all relevant agenda files and
9579 make sure that the computations of this property are up to date.  This is
9580 also true for the special @code{CLOCKSUM} property.  Org will then sum the
9581 values displayed in the agenda.  In the daily/weekly agenda, the sums will
9582 cover a single day; in all other views they cover the entire block.  It is
9583 vital to realize that the agenda may show the same entry @emph{twice} (for
9584 example as scheduled and as a deadline), and it may show two entries from the
9585 same hierarchy (for example a @emph{parent} and its @emph{child}).  In these
9586 cases, the summation in the agenda will lead to incorrect results because
9587 some values will count double.
9588 @item
9589 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9590 the entire clocked time for this item.  So even in the daily/weekly agenda,
9591 the clocksum listed in column view may originate from times outside the
9592 current view.  This has the advantage that you can compare these values with
9593 a column listing the planned total effort for a task---one of the major
9594 applications for column view in the agenda.  If you want information about
9595 clocked time in the displayed period use clock table mode (press @kbd{R} in
9596 the agenda).
9598 @item
9599 @cindex property, special, CLOCKSUM_T
9600 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9601 always today's clocked time for this item.  So even in the weekly agenda,
9602 the clocksum listed in column view only originates from today.  This lets
9603 you compare the time you spent on a task for today, with the time already
9604 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9605 @end enumerate
9608 @node Markup
9609 @chapter Markup for rich export
9611 When exporting Org mode documents, the exporter tries to reflect the
9612 structure of the document as accurately as possible in the back-end.  Since
9613 export targets like HTML and @LaTeX{} allow much richer formatting, Org mode has
9614 rules on how to prepare text for rich export.  This section summarizes the
9615 markup rules used in an Org mode buffer.
9617 @menu
9618 * Structural markup elements::  The basic structure as seen by the exporter
9619 * Images and tables::           Images, tables and caption mechanism
9620 * Literal examples::            Source code examples with special formatting
9621 * Include files::               Include additional files into a document
9622 * Index entries::               Making an index
9623 * Macro replacement::           Use macros to create templates
9624 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
9625 * Special blocks::              Containers targeted at export back-ends
9626 @end menu
9628 @node Structural markup elements
9629 @section Structural markup elements
9631 @menu
9632 * Document title::              Where the title is taken from
9633 * Headings and sections::       The document structure as seen by the exporter
9634 * Table of contents::           The if and where of the table of contents
9635 * Lists::                       Lists
9636 * Paragraphs::                  Paragraphs
9637 * Footnote markup::             Footnotes
9638 * Emphasis and monospace::      Bold, italic, etc.
9639 * Horizontal rules::            Make a line
9640 * Comment lines::               What will *not* be exported
9641 @end menu
9643 @node Document title
9644 @subheading Document title
9645 @cindex document title, markup rules
9647 @noindent
9648 The title of the exported document is taken from the special line
9650 @cindex #+TITLE
9651 @example
9652 #+TITLE: This is the title of the document
9653 @end example
9655 @cindex property, EXPORT_TITLE
9656 If you are exporting only a subtree, its heading will become the title of the
9657 document.  If the subtree has a property @code{EXPORT_TITLE}, that will take
9658 precedence.
9660 @node Headings and sections
9661 @subheading Headings and sections
9662 @cindex headings and sections, markup rules
9664 @vindex org-export-headline-levels
9665 The outline structure of the document as described in @ref{Document
9666 structure}, forms the basis for defining sections of the exported document.
9667 However, since the outline structure is also used for (for example) lists of
9668 tasks, only the first three outline levels will be used as headings.  Deeper
9669 levels will become itemized lists.  You can change the location of this
9670 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9671 per-file basis with a line
9673 @cindex #+OPTIONS
9674 @example
9675 #+OPTIONS: H:4
9676 @end example
9678 @node Table of contents
9679 @subheading Table of contents
9680 @cindex table of contents, markup rules
9682 @cindex #+TOC
9683 @vindex org-export-with-toc
9684 The table of contents is normally inserted directly before the first headline
9685 of the file.  The depth of the table is by default the same as the number of
9686 headline levels, but you can choose a smaller number, or turn off the table
9687 of contents entirely, by configuring the variable @code{org-export-with-toc},
9688 or on a per-file basis with a line like
9690 @example
9691 #+OPTIONS: toc:2          @r{only inlcude two levels in TOC}
9692 #+OPTIONS: toc:nil        @r{no default TOC at all}
9693 @end example
9695 If you would like to move the table of contents to a different location, you
9696 should turn off the default table using @code{org-export-with-toc} or
9697 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9698 location(s).
9700 @example
9701 #+OPTIONS: toc:nil        @r{no default TOC}
9703 #+TOC: headlines 2        @r{insert TOC here, with two headline levels}
9704 @end example
9706 Moreover, if you append @samp{local} parameter, the table contains only
9707 entries for the children of the current section@footnote{For @LaTeX{} export,
9708 this feature requires the @code{titletoc} package.  Note that @code{titletoc}
9709 must be loaded @emph{before} @code{hyperref}.  Thus, you may have to
9710 customize @code{org-latex-default-packages-alist}.}.  In this case, any depth
9711 parameter becomes relative to the current level.
9713 @example
9714 * Section
9715 #+TOC: headlines 1 local  @r{insert local TOC, with direct children only}
9716 @end example
9718 The same @code{TOC} keyword can also generate a list of all tables (resp.@:
9719 all listings) with a caption in the document.
9721 @example
9722 #+TOC: listings           @r{build a list of listings}
9723 #+TOC: tables             @r{build a list of tables}
9724 @end example
9726 @cindex property, ALT_TITLE
9727 The headline's title usually determines its corresponding entry in a table of
9728 contents.  However, it is possible to specify an alternative title by
9729 setting @code{ALT_TITLE} property accordingly.  It will then be used when
9730 building the table.
9732 @node Lists
9733 @subheading Lists
9734 @cindex lists, markup rules
9736 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9737 syntax for such lists.  Most back-ends support unordered, ordered, and
9738 description lists.
9740 @node Paragraphs
9741 @subheading Paragraphs, line breaks, and quoting
9742 @cindex paragraphs, markup rules
9744 Paragraphs are separated by at least one empty line.  If you need to enforce
9745 a line break within a paragraph, use @samp{\\} at the end of a line.
9747 To keep the line breaks in a region, but otherwise use normal formatting, you
9748 can use this construct, which can also be used to format poetry.
9750 @cindex #+BEGIN_VERSE
9751 @example
9752 #+BEGIN_VERSE
9753  Great clouds overhead
9754  Tiny black birds rise and fall
9755  Snow covers Emacs
9757      -- AlexSchroeder
9758 #+END_VERSE
9759 @end example
9761 When quoting a passage from another document, it is customary to format this
9762 as a paragraph that is indented on both the left and the right margin.  You
9763 can include quotations in Org mode documents like this:
9765 @cindex #+BEGIN_QUOTE
9766 @example
9767 #+BEGIN_QUOTE
9768 Everything should be made as simple as possible,
9769 but not any simpler -- Albert Einstein
9770 #+END_QUOTE
9771 @end example
9773 If you would like to center some text, do it like this:
9774 @cindex #+BEGIN_CENTER
9775 @example
9776 #+BEGIN_CENTER
9777 Everything should be made as simple as possible, \\
9778 but not any simpler
9779 #+END_CENTER
9780 @end example
9783 @node Footnote markup
9784 @subheading Footnote markup
9785 @cindex footnotes, markup rules
9786 @cindex @file{footnote.el}
9788 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9789 by all back-ends.  Org allows multiple references to the same note, and
9790 multiple footnotes side by side.
9792 @node Emphasis and monospace
9793 @subheading Emphasis and monospace
9795 @cindex underlined text, markup rules
9796 @cindex bold text, markup rules
9797 @cindex italic text, markup rules
9798 @cindex verbatim text, markup rules
9799 @cindex code text, markup rules
9800 @cindex strike-through text, markup rules
9801 @vindex org-fontify-emphasized-text
9802 @vindex org-emphasis-regexp-components
9803 @vindex org-emphasis-alist
9804 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9805 and @code{~code~}, and, if you must, @samp{+strike-through+}.  Text
9806 in the code and verbatim string is not processed for Org mode specific
9807 syntax, it is exported verbatim.
9809 To turn off fontification for marked up text, you can set
9810 @code{org-fontify-emphasized-text} to @code{nil}.  To narrow down the list of
9811 available markup syntax, you can customize @code{org-emphasis-alist}.  To fine
9812 tune what characters are allowed before and after the markup characters, you
9813 can tweak @code{org-emphasis-regexp-components}.  Beware that changing one of
9814 the above variables will no take effect until you reload Org, for which you
9815 may need to restart Emacs.
9817 @node Horizontal rules
9818 @subheading  Horizontal rules
9819 @cindex horizontal rules, markup rules
9820 A line consisting of only dashes, and at least 5 of them, will be exported as
9821 a horizontal line.
9823 @node Comment lines
9824 @subheading Comment lines
9825 @cindex comment lines
9826 @cindex exporting, not
9827 @cindex #+BEGIN_COMMENT
9829 Lines starting with zero or more whitespace characters followed by one
9830 @samp{#} and a whitespace are treated as comments and, as such, are not
9831 exported.
9833 Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
9834 ... @samp{#+END_COMMENT} are not exported.
9836 Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
9837 other keyword or priority cookie, comments out the entire subtree.  In this
9838 case, the subtree is not exported and no code block within it is executed
9839 either.  The command below helps changing the comment status of a headline.
9841 @table @kbd
9842 @kindex C-c ;
9843 @item C-c ;
9844 Toggle the @samp{COMMENT} keyword at the beginning of an entry.
9845 @end table
9848 @node Images and tables
9849 @section Images and Tables
9851 @cindex tables, markup rules
9852 @cindex #+CAPTION
9853 @cindex #+NAME
9854 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9855 the @file{table.el} package will be exported properly.  For Org mode tables,
9856 the lines before the first horizontal separator line will become table header
9857 lines.  You can use the following lines somewhere before the table to assign
9858 a caption and a label for cross references, and in the text you can refer to
9859 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9861 @example
9862 #+CAPTION: This is the caption for the next table (or link)
9863 #+NAME:   tab:basic-data
9864    | ... | ...|
9865    |-----|----|
9866 @end example
9868 Optionally, the caption can take the form:
9869 @example
9870 #+CAPTION[Caption for list of tables]: Caption for table.
9871 @end example
9873 @cindex inlined images, markup rules
9874 Some back-ends allow you to directly include images into the exported
9875 document.  Org does this, if a link to an image files does not have
9876 a description part, for example @code{[[./img/a.jpg]]}.  If you wish to
9877 define a caption for the image and maybe a label for internal cross
9878 references, make sure that the link is on a line by itself and precede it
9879 with @code{#+CAPTION} and @code{#+NAME} as follows:
9881 @example
9882 #+CAPTION: This is the caption for the next figure link (or table)
9883 #+NAME:   fig:SED-HR4049
9884 [[./img/a.jpg]]
9885 @end example
9887 @noindent
9888 Such images can be displayed within the buffer.  @xref{Handling links,the
9889 discussion of image links}.
9891 Even though images and tables are prominent examples of captioned structures,
9892 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9893 equations, source code blocks).  Depending on the export back-end, those may
9894 or may not be handled.
9896 @node Literal examples
9897 @section Literal examples
9898 @cindex literal examples, markup rules
9899 @cindex code line references, markup rules
9901 You can include literal examples that should not be subjected to
9902 markup.  Such examples will be typeset in monospace, so this is well suited
9903 for source code and similar examples.
9904 @cindex #+BEGIN_EXAMPLE
9906 @example
9907 #+BEGIN_EXAMPLE
9908 Some example from a text file.
9909 #+END_EXAMPLE
9910 @end example
9912 Note that such blocks may be @i{indented} in order to align nicely with
9913 indented text and in particular with plain list structure (@pxref{Plain
9914 lists}).  For simplicity when using small examples, you can also start the
9915 example lines with a colon followed by a space.  There may also be additional
9916 whitespace before the colon:
9918 @example
9919 Here is an example
9920    : Some example from a text file.
9921 @end example
9923 @cindex formatting source code, markup rules
9924 @vindex org-latex-listings
9925 If the example is source code from a programming language, or any other text
9926 that can be marked up by font-lock in Emacs, you can ask for the example to
9927 look like the fontified Emacs buffer@footnote{This works automatically for
9928 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9929 which is distributed with Org).  Fontified code chunks in @LaTeX{} can be
9930 achieved using either the listings or the
9931 @url{http://code.google.com/p/minted, minted,} package.  Refer to
9932 @code{org-latex-listings} documentation for details.}.  This is done
9933 with the @samp{src} block, where you also need to specify the name of the
9934 major mode that should be used to fontify the example@footnote{Code in
9935 @samp{src} blocks may also be evaluated either interactively or on export.
9936 See @pxref{Working with source code} for more information on evaluating code
9937 blocks.}, see @ref{Easy templates} for shortcuts to easily insert code
9938 blocks.
9939 @cindex #+BEGIN_SRC
9941 @example
9942 #+BEGIN_SRC emacs-lisp
9943   (defun org-xor (a b)
9944      "Exclusive or."
9945      (if a (not b) b))
9946 #+END_SRC
9947 @end example
9949 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9950 switch to the end of the @code{BEGIN} line, to get the lines of the example
9951 numbered.  If you use a @code{+n} switch, the numbering from the previous
9952 numbered snippet will be continued in the current one.  In literal examples,
9953 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9954 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9955 enclosed in single parenthesis).  In HTML, hovering the mouse over such a
9956 link will remote-highlight the corresponding code line, which is kind of
9957 cool.
9959 You can also add a @code{-r} switch which @i{removes} the labels from the
9960 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9961 labels in the source code while using line numbers for the links, which might
9962 be useful to explain those in an Org mode example code.}.  With the @code{-n}
9963 switch, links to these references will be labeled by the line numbers from
9964 the code listing, otherwise links will use the labels with no parentheses.
9965 Here is an example:
9967 @example
9968 #+BEGIN_SRC emacs-lisp -n -r
9969 (save-excursion                  (ref:sc)
9970    (goto-char (point-min)))      (ref:jump)
9971 #+END_SRC
9972 In line [[(sc)]] we remember the current position.  [[(jump)][Line (jump)]]
9973 jumps to point-min.
9974 @end example
9976 @cindex indentation, in source blocks
9977 Finally, you can use @code{-i} to preserve the indentation of a specific code
9978 block (@pxref{Editing source code}).
9980 @vindex org-coderef-label-format
9981 If the syntax for the label format conflicts with the language syntax, use a
9982 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9983 -n -r -l "((%s))"}.  See also the variable @code{org-coderef-label-format}.
9985 HTML export also allows examples to be published as text areas (@pxref{Text
9986 areas in HTML export}).
9988 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9989 so often, shortcuts are provided using the Easy templates facility
9990 (@pxref{Easy templates}).
9992 @table @kbd
9993 @kindex C-c '
9994 @item C-c '
9995 Edit the source code example at point in its native mode.  This works by
9996 switching to a temporary buffer with the source code.  You need to exit by
9997 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9998 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9999 from being interpreted by Org as outline nodes or special syntax.  These
10000 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
10001 The edited version will then replace the old version in the Org buffer.
10002 Fixed-width regions (where each line starts with a colon followed by a space)
10003 will be edited using @code{artist-mode}@footnote{You may select
10004 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
10005 to allow creating ASCII drawings easily.  Using this command in an empty line
10006 will create a new fixed-width region.
10007 @kindex C-c l
10008 @item C-c l
10009 Calling @code{org-store-link} while editing a source code example in a
10010 temporary buffer created with @kbd{C-c '} will prompt for a label.  Make sure
10011 that it is unique in the current buffer, and insert it with the proper
10012 formatting like @samp{(ref:label)} at the end of the current line.  Then the
10013 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
10014 @end table
10017 @node Include files
10018 @section Include files
10019 @cindex include files, markup rules
10021 During export, you can include the content of another file.  For example, to
10022 include your @file{.emacs} file, you could use:
10023 @cindex #+INCLUDE
10025 @example
10026 #+INCLUDE: "~/.emacs" src emacs-lisp
10027 @end example
10029 @noindent
10030 The first parameter names the the file to include.  The optional second and
10031 third parameter specify the markup (i.e., @samp{example} or @samp{src}), and,
10032 if the markup is @samp{src}, the language for formatting the contents.
10034 If markup is requested, the included content will be placed within an
10035 appropriate block@footnote{While you can request paragraphs (@samp{verse},
10036 @samp{quote}, @samp{center}), but this places severe restrictions on the type
10037 of content that is permissible}.  No changes to the included content are made
10038 and it is the responsibility of the user to ensure that the result is valid
10039 Org syntax.  For markup @samp{example} and @samp{src}, which is requesting a
10040 literal example, the content will be code-escaped before inclusion.
10042 If no markup is requested, the text will be assumed to be in Org mode format
10043 and will be processed normally.  However, footnote labels (@pxref{Footnotes})
10044 in the file will be made local to that file.  Contents of the included file
10045 will belong to the same structure (headline, item) containing the
10046 @code{INCLUDE} keyword.  In particular, headlines within the file will become
10047 children of the current section.  That behavior can be changed by providing
10048 an additional keyword parameter, @code{:minlevel}.  In that case, all
10049 headlines in the included file will be shifted so the one with the lowest
10050 level reaches that specified level.  For example, to make a file become a
10051 sibling of the current top-level headline, use
10053 @example
10054 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
10055 @end example
10057 You can also include a portion of a file by specifying a lines range using
10058 the @code{:lines} keyword parameter.  The line at the upper end of the range
10059 will not be included.  The start and/or the end of the range may be omitted
10060 to use the obvious defaults.
10062 @example
10063 #+INCLUDE: "~/.emacs" :lines "5-10"   @r{Include lines 5 to 10, 10 excluded}
10064 #+INCLUDE: "~/.emacs" :lines "-10"    @r{Include lines 1 to 10, 10 excluded}
10065 #+INCLUDE: "~/.emacs" :lines "10-"    @r{Include lines from 10 to EOF}
10066 @end example
10068 Finally, you may use a file-link to extract an object as matched by
10069 @code{org-link-search}@footnote{Note that
10070 @code{org-link-search-must-match-exact-headline} is locally bound to non-@code{nil}.
10071 Therefore, @code{org-link-search} only matches headlines and named elements.}
10072 (@pxref{Search options}).  If the @code{:only-contents} property is non-@code{nil},
10073 only the contents of the requested element will be included, omitting
10074 properties drawer and planning-line if present.  The @code{:lines} keyword
10075 operates locally with respect to the requested element.  Some examples:
10077 @example
10078 #+INCLUDE: "./paper.org::#theory" :only-contents t
10079    @r{Include the body of the heading with the custom id @code{theory}}
10080 #+INCLUDE: "./paper.org::mytable"  @r{Include named element.}
10081 #+INCLUDE: "./paper.org::*conclusion" :lines 1-20
10082    @r{Include the first 20 lines of the headline named conclusion.}
10083 @end example
10085 @table @kbd
10086 @kindex C-c '
10087 @item C-c '
10088 Visit the include file at point.
10089 @end table
10091 @node Index entries
10092 @section Index entries
10093 @cindex index entries, for publishing
10095 You can specify entries that will be used for generating an index during
10096 publishing.  This is done by lines starting with @code{#+INDEX}.  An entry
10097 the contains an exclamation mark will create a sub item.  See @ref{Generating
10098 an index} for more information.
10100 @example
10101 * Curriculum Vitae
10102 #+INDEX: CV
10103 #+INDEX: Application!CV
10104 @end example
10109 @node Macro replacement
10110 @section Macro replacement
10111 @cindex macro replacement, during export
10112 @cindex #+MACRO
10114 You can define text snippets with
10116 @example
10117 #+MACRO: name   replacement text $1, $2 are arguments
10118 @end example
10120 @noindent which can be referenced
10121 @code{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate arguments,
10122 commas within arguments have to be escaped with a backslash character.
10123 Conversely, backslash characters before a comma, and only them, need to be
10124 escaped with another backslash character.}.
10126 These references, called macros, can be inserted anywhere Org markup is
10127 recognized: paragraphs, headlines, verse blocks, tables cells and lists.
10128 They cannot be used within ordinary keywords (starting with @code{#+}) but
10129 are allowed in @code{#+CAPTION}, @code{#+TITLE}, @code{#+AUTHOR} and
10130 @code{#+EMAIL}.
10132 In addition to user-defined macros, a set of predefined macros can be used:
10133 @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, and
10134 @code{@{@{@{email@}@}@}} are replaced with the information set by their
10135 respective keywords.  Further, @code{@{@{@{date(@var{FORMAT})@}@}@}},
10136 @code{@{@{@{time(@var{FORMAT})@}@}@}} and
10137 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to the @code{#+DATE}
10138 keyword, the current date, and the modification time of the file being
10139 exported, respectively.  @var{FORMAT} should be a format string understood by
10140 @code{format-time-string}.  Note that @var{FORMAT} is an optional argument to
10141 the @code{@{@{@{date@}@}@}} macro, and that it will only be used if
10142 @code{#+DATE} is a single timestamp.  Finally, the filename is available via
10143 @code{@{@{@{input-file@}@}@}} and properties can be accessed using
10144 @code{@{@{@{property(@var{PROPERTY-NAME})@}@}@}}.
10146 The surrounding brackets can be made invisible by setting
10147 @code{org-hide-macro-markers} non-@code{nil}.
10149 Macro expansion takes place during the very beginning of the export process.
10152 @node Embedded @LaTeX{}
10153 @section Embedded @LaTeX{}
10154 @cindex @TeX{} interpretation
10155 @cindex @LaTeX{} interpretation
10157 Plain ASCII is normally sufficient for almost all note taking.  Exceptions
10158 include scientific notes, which often require mathematical symbols and the
10159 occasional formula.  @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10160 Donald E. Knuth's @TeX{} system.  Many of the features described here as
10161 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10162 distinction.}  is widely used to typeset scientific documents.  Org mode
10163 supports embedding @LaTeX{} code into its files, because many academics are
10164 used to writing and reading @LaTeX{} source code, and because it can be
10165 readily processed to produce pretty output for a number of export back-ends.
10167 @menu
10168 * Special symbols::             Greek letters and other symbols
10169 * Subscripts and superscripts::  Simple syntax for raising/lowering text
10170 * @LaTeX{} fragments::          Complex formulas made easy
10171 * Previewing @LaTeX{} fragments::  What will this snippet look like?
10172 * CDLaTeX mode::                Speed up entering of formulas
10173 @end menu
10175 @node Special symbols
10176 @subsection Special symbols
10177 @cindex math symbols
10178 @cindex special symbols
10179 @cindex @TeX{} macros
10180 @cindex @LaTeX{} fragments, markup rules
10181 @cindex HTML entities
10182 @cindex @LaTeX{} entities
10184 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10185 to indicate the Greek letter, or @samp{\to} to indicate an arrow.  Completion
10186 for these symbols is available, just type @samp{\} and maybe a few letters,
10187 and press @kbd{M-@key{TAB}} to see possible completions.  Unlike @LaTeX{}
10188 code, Org mode allows these symbols to be present without surrounding math
10189 delimiters, for example:
10191 @example
10192 Angles are written as Greek letters \alpha, \beta and \gamma.
10193 @end example
10195 @vindex org-entities
10196 During export, these symbols will be transformed into the native format of
10197 the exporter back-end.  Strings like @code{\alpha} will be exported as
10198 @code{&alpha;} in the HTML output, and as @code{\(\alpha\)} in the @LaTeX{}
10199 output.  Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
10200 @code{~} in @LaTeX{}.  If you need such a symbol inside a word, terminate it
10201 like this: @samp{\Aacute@{@}stor}.
10203 A large number of entities is provided, with names taken from both HTML and
10204 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10205 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10206 @samp{...} are all converted into special commands creating hyphens of
10207 different lengths or a compact set of dots.
10209 If you would like to see entities displayed as UTF-8 characters, use the
10210 following command@footnote{You can turn this on by default by setting the
10211 variable @code{org-pretty-entities}, or on a per-file base with the
10212 @code{#+STARTUP} option @code{entitiespretty}.}:
10214 @table @kbd
10215 @cindex @code{entitiespretty}, STARTUP keyword
10216 @kindex C-c C-x \
10217 @item C-c C-x \
10218 Toggle display of entities as UTF-8 characters.  This does not change the
10219 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10220 for display purposes only.
10221 @end table
10223 @node Subscripts and superscripts
10224 @subsection Subscripts and superscripts
10225 @cindex subscript
10226 @cindex superscript
10228 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10229 subscripts.  Again, these can be used without embedding them in math-mode
10230 delimiters.  To increase the readability of ASCII text, it is not necessary
10231 (but OK) to surround multi-character sub- and superscripts with curly braces.
10232 For example
10234 @example
10235 The mass of the sun is M_sun = 1.989 x 10^30 kg.  The radius of
10236 the sun is R_@{sun@} = 6.96 x 10^8 m.
10237 @end example
10239 @vindex org-use-sub-superscripts
10240 If you write a text where the underscore is often used in a different
10241 context, Org's convention to always interpret these as subscripts can get in
10242 your way.  Configure the variable @code{org-use-sub-superscripts} to change
10243 this convention.  For example, when setting this variable to @code{@{@}},
10244 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10246 @table @kbd
10247 @kindex C-c C-x \
10248 @item C-c C-x \
10249 In addition to showing entities as UTF-8 characters, this command will also
10250 format sub- and superscripts in a WYSIWYM way.
10251 @end table
10253 @node @LaTeX{} fragments
10254 @subsection @LaTeX{} fragments
10255 @cindex @LaTeX{} fragments
10257 @vindex org-format-latex-header
10258 Going beyond symbols and sub- and superscripts, a full formula language is
10259 needed.  Org mode can contain @LaTeX{} math fragments, and it supports ways
10260 to process these for several export back-ends.  When exporting to @LaTeX{},
10261 the code is left as it is.  When exporting to HTML, Org can use either
10262 @uref{http://www.mathjax.org, MathJax} (@pxref{Math formatting in HTML
10263 export}) or transcode the math into images (see @pxref{Previewing @LaTeX{}
10264 fragments}).
10266 @LaTeX{} fragments don't need any special marking at all.  The following
10267 snippets will be identified as @LaTeX{} source code:
10268 @itemize @bullet
10269 @item
10270 Environments of any kind@footnote{When MathJax is used, only the
10271 environments recognized by MathJax will be processed.  When
10272 @file{dvipng} program or @file{imagemagick} suite is used to create images,
10273 any @LaTeX{} environment will be handled.}.  The only requirement is that the
10274 @code{\begin} statement appears on a new line, at the beginning of the line
10275 or after whitespaces only.
10276 @item
10277 Text within the usual @LaTeX{} math delimiters.  To avoid conflicts with
10278 currency specifications, single @samp{$} characters are only recognized as
10279 math delimiters if the enclosed text contains at most two line breaks, is
10280 directly attached to the @samp{$} characters with no whitespace in between,
10281 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
10282 For the other delimiters, there is no such restriction, so when in doubt, use
10283 @samp{\(...\)} as inline math delimiters.
10284 @end itemize
10286 @noindent For example:
10288 @example
10289 \begin@{equation@}
10290 x=\sqrt@{b@}
10291 \end@{equation@}
10293 If $a^2=b$ and \( b=2 \), then the solution must be
10294 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10295 @end example
10297 @c FIXME
10298 @c @noindent
10299 @c @vindex org-format-latex-options
10300 @c If you need any of the delimiter ASCII sequences for other purposes, you
10301 @c can configure the option @code{org-format-latex-options} to deselect the
10302 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10304 @vindex org-export-with-latex
10305 @LaTeX{} processing can be configured with the variable
10306 @code{org-export-with-latex}.  The default setting is @code{t} which means
10307 MathJax for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10308 You can also set this variable on a per-file basis using one of these
10309 lines:
10311 @example
10312 #+OPTIONS: tex:t          @r{Do the right thing automatically (MathJax)}
10313 #+OPTIONS: tex:nil        @r{Do not process @LaTeX{} fragments at all}
10314 #+OPTIONS: tex:verbatim   @r{Verbatim export, for jsMath or so}
10315 @end example
10317 @node Previewing @LaTeX{} fragments
10318 @subsection Previewing @LaTeX{} fragments
10319 @cindex @LaTeX{} fragments, preview
10321 @vindex org-latex-create-formula-image-program
10322 If you have a working @LaTeX{} installation and either @file{dvipng} or
10323 @file{convert} installed@footnote{These are respectively available at
10324 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10325 suite. Choose the converter by setting the variable
10326 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10327 fragments can be processed to produce images of the typeset expressions to be
10328 used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
10329 or for inline previewing within Org mode.
10331 @vindex org-format-latex-options
10332 @vindex org-format-latex-header
10333 You can customize the variables @code{org-format-latex-options} and
10334 @code{org-format-latex-header} to influence some aspects of the preview.  In
10335 particular, the @code{:scale} (and for HTML export, @code{:html-scale})
10336 property of the former can be used to adjust the size of the preview images.
10338 @table @kbd
10339 @kindex C-c C-x C-l
10340 @item C-c C-x C-l
10341 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10342 over the source code.  If there is no fragment at point, process all
10343 fragments in the current entry (between two headlines).  When called
10344 with a prefix argument, process the entire subtree.  When called with
10345 two prefix arguments, or when the cursor is before the first headline,
10346 process the entire buffer.
10347 @kindex C-c C-c
10348 @item C-c C-c
10349 Remove the overlay preview images.
10350 @end table
10352 @vindex org-startup-with-latex-preview
10353 You can turn on the previewing of all @LaTeX{} fragments in a file with
10355 @example
10356 #+STARTUP: latexpreview
10357 @end example
10359 To disable it, simply use
10361 @example
10362 #+STARTUP: nolatexpreview
10363 @end example
10365 @node CDLaTeX mode
10366 @subsection Using CD@LaTeX{} to enter math
10367 @cindex CD@LaTeX{}
10369 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10370 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10371 environments and math templates.  Inside Org mode, you can make use of
10372 some of the features of CD@LaTeX{} mode.  You need to install
10373 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10374 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10375 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10376 version @code{org-cdlatex-mode} that comes as part of Org mode.  Turn it
10377 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10378 Org files with
10380 @lisp
10381 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10382 @end lisp
10384 When this mode is enabled, the following features are present (for more
10385 details see the documentation of CD@LaTeX{} mode):
10386 @itemize @bullet
10387 @kindex C-c @{
10388 @item
10389 Environment templates can be inserted with @kbd{C-c @{}.
10390 @item
10391 @kindex @key{TAB}
10392 The @key{TAB} key will do template expansion if the cursor is inside a
10393 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10394 inside such a fragment, see the documentation of the function
10395 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
10396 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10397 correctly inside the first brace.  Another @key{TAB} will get you into
10398 the second brace.  Even outside fragments, @key{TAB} will expand
10399 environment abbreviations at the beginning of a line.  For example, if
10400 you write @samp{equ} at the beginning of a line and press @key{TAB},
10401 this abbreviation will be expanded to an @code{equation} environment.
10402 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10403 @item
10404 @kindex _
10405 @kindex ^
10406 @vindex cdlatex-simplify-sub-super-scripts
10407 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10408 characters together with a pair of braces.  If you use @key{TAB} to move
10409 out of the braces, and if the braces surround only a single character or
10410 macro, they are removed again (depending on the variable
10411 @code{cdlatex-simplify-sub-super-scripts}).
10412 @item
10413 @kindex `
10414 Pressing the backquote @kbd{`} followed by a character inserts math
10415 macros, also outside @LaTeX{} fragments.  If you wait more than 1.5 seconds
10416 after the backquote, a help window will pop up.
10417 @item
10418 @kindex '
10419 Pressing the single-quote @kbd{'} followed by another character modifies
10420 the symbol before point with an accent or a font.  If you wait more than
10421 1.5 seconds after the single-quote, a help window will pop up.  Character
10422 modification will work only inside @LaTeX{} fragments; outside the quote
10423 is normal.
10424 @end itemize
10426 @node Special blocks
10427 @section Special blocks
10428 @cindex Special blocks
10430 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10431 examples}).  It is also possible to create blocks containing raw code
10432 targeted at a specific back-end (e.g., @samp{#+BEGIN_LATEX}).
10434 Any other block is a @emph{special block}.  Its name is case-sensitive.
10436 For example, @samp{#+BEGIN_abstract} and @samp{#+BEGIN_video} are special
10437 blocks.  The first one is useful when exporting to @LaTeX{}, the second one
10438 when exporting to HTML5.
10440 Each export back-end decides if they should be exported, and how.  When the
10441 block is ignored, its contents are still exported, as if the opening and
10442 closing block lines were not there.  For example, when exporting a
10443 @samp{#+BEGIN_test} block, HTML back-end wraps its contents within a
10444 @samp{<div name="test">} tag.
10446 Refer to back-end specific documentation for more information.
10448 @node Exporting
10449 @chapter Exporting
10450 @cindex exporting
10452 The Org mode export facilities can be used to export Org documents or parts
10453 of Org documents to a variety of other formats.  In addition, these
10454 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10455 in foreign buffers so you can author tables and lists in Org syntax and
10456 convert them in place to the target language.
10458 ASCII export produces a readable and simple version of an Org file for
10459 printing and sharing notes.  HTML export allows you to easily publish notes
10460 on the web, or to build full-fledged websites.  @LaTeX{} export lets you use
10461 Org mode and its structured editing functions to create arbitrarily complex
10462 @LaTeX{} files for any kind of document.  OpenDocument Text (ODT) export
10463 allows seamless collaboration across organizational boundaries.  Markdown
10464 export lets you seamlessly collaborate with other developers.  Finally, iCal
10465 export can extract entries with deadlines or appointments to produce a file
10466 in the iCalendar format.
10468 @menu
10469 * The export dispatcher::       The main exporter interface
10470 * Export back-ends::            Built-in export formats
10471 * Export settings::             Generic export settings
10472 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
10473 * Beamer export::               Exporting as a Beamer presentation
10474 * HTML export::                 Exporting to HTML
10475 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
10476 * Markdown export::             Exporting to Markdown
10477 * OpenDocument Text export::    Exporting to OpenDocument Text
10478 * Org export::                  Exporting to Org
10479 * Texinfo export::              Exporting to Texinfo
10480 * iCalendar export::            Exporting to iCalendar
10481 * Other built-in back-ends::    Exporting to a man page
10482 * Export in foreign buffers::   Author tables and lists in Org syntax
10483 * Advanced configuration::      Fine-tuning the export output
10484 @end menu
10486 @node The export dispatcher
10487 @section The export dispatcher
10488 @vindex org-export-dispatch-use-expert-ui
10489 @cindex Export, dispatcher
10491 The main entry point for export related tasks is the dispatcher, a
10492 hierarchical menu from which it is possible to select an export format and
10493 toggle export options@footnote{It is also possible to use a less intrusive
10494 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10495 non-@code{nil} value.  In that case, only a prompt is visible from the
10496 minibuffer.  From there one can still switch back to regular menu by pressing
10497 @key{?}.} from which it is possible to select an export format and to toggle
10498 export options.
10500 @c @quotation
10501 @table @asis
10502 @orgcmd{C-c C-e,org-export-dispatch}
10504 Dispatch for export and publishing commands.  When called with a @kbd{C-u}
10505 prefix argument, repeat the last export command on the current buffer while
10506 preserving toggled options.  If the current buffer hasn't changed and subtree
10507 export was activated, the command will affect that same subtree.
10508 @end table
10509 @c @end quotation
10511 Normally the entire buffer is exported, but if there is an active region
10512 only that part of the buffer will be exported.
10514 Several export options (@pxref{Export settings}) can be toggled from the
10515 export dispatcher with the following key combinations:
10517 @table @kbd
10518 @item C-a
10519 @vindex org-export-async-init-file
10520 Toggle asynchronous export.  Asynchronous export uses an external Emacs
10521 process that is configured with a specified initialization file.
10523 While exporting asynchronously, the output is not displayed, but stored in
10524 a place called ``the export stack''.  This stack can be displayed by calling
10525 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10526 from the dispatcher menu.
10528 @vindex org-export-in-background
10529 To make this behavior the default, customize the variable
10530 @code{org-export-in-background}.
10532 @item C-b
10533 Toggle body-only export.  Its effect depends on the back-end used.
10534 Typically, if the back-end has a header section (like @code{<head>...</head>}
10535 in the HTML back-end), a body-only export will not include this header.
10537 @item C-s
10538 @vindex org-export-initial-scope
10539 Toggle subtree export.  The top heading becomes the document title.
10541 You can change the default state of this option by setting
10542 @code{org-export-initial-scope}.
10544 @item C-v
10545 Toggle visible-only export.  Only export the text that is currently
10546 visible, i.e. not hidden by outline visibility in the buffer.
10547 @end table
10549 @node Export back-ends
10550 @section Export back-ends
10551 @cindex Export, back-ends
10553 An export back-end is a library that translates Org syntax into a foreign
10554 format.  An export format is not available until the proper back-end has been
10555 loaded.
10557 @vindex org-export-backends
10558 By default, the following four back-ends are loaded: @code{ascii},
10559 @code{html}, @code{icalendar} and @code{latex}.  It is possible to add more
10560 (or remove some) by customizing @code{org-export-backends}.
10562 Built-in back-ends include:
10564 @itemize
10565 @item ascii (ASCII format)
10566 @item beamer (@LaTeX{} Beamer format)
10567 @item html (HTML format)
10568 @item icalendar (iCalendar format)
10569 @item latex (@LaTeX{} format)
10570 @item man (Man page format)
10571 @item md (Markdown format)
10572 @item odt (OpenDocument Text format)
10573 @item org (Org format)
10574 @item texinfo (Texinfo format)
10575 @end itemize
10577 Other back-ends might be found in the @code{contrib/} directory
10578 (@pxref{Installation}).
10580 @node Export settings
10581 @section Export settings
10582 @cindex Export, settings
10584 @cindex #+OPTIONS
10585 Export options can be set: globally with variables; for an individual file by
10586 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10587 settings}), by setting individual keywords, or by specifying them in a
10588 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10589 properties (@pxref{Properties and columns}).  Options set at a specific level
10590 override options set at a more general level.
10592 @cindex #+SETUPFILE
10593 In-buffer settings may appear anywhere in the file, either directly or
10594 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10595 Option keyword sets tailored to a particular back-end can be inserted from
10596 the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert
10597 template} command by pressing @key{#}.  To insert keywords individually,
10598 a good way to make sure the keyword is correct is to type @code{#+} and then
10599 to use @kbd{M-<TAB>} for completion.
10601 The export keywords available for every back-end, and their equivalent global
10602 variables, include:
10604 @table @samp
10605 @item AUTHOR
10606 @cindex #+AUTHOR
10607 @vindex user-full-name
10608 The document author (@code{user-full-name}).
10610 @item CREATOR
10611 @cindex #+CREATOR
10612 @vindex org-export-creator-string
10613 Entity responsible for output generation (@code{org-export-creator-string}).
10615 @item DATE
10616 @cindex #+DATE
10617 @vindex org-export-date-timestamp-format
10618 A date or a time-stamp@footnote{The variable
10619 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10620 exported.}.
10622 @item DESCRIPTION
10623 @cindex #+DESCRIPTION
10624 The document description.  Back-ends handle it as they see fit (e.g., for the
10625 XHTML meta tag), if at all.  You can use several such keywords for long
10626 descriptions.
10628 @item EMAIL
10629 @cindex #+EMAIL
10630 @vindex user-mail-address
10631 The email address (@code{user-mail-address}).
10633 @item KEYWORDS
10634 @cindex #+KEYWORDS
10635 The keywords defining the contents of the document.  Back-ends handle it as
10636 they see fit (e.g., for the XHTML meta tag), if at all.  You can use several
10637 such keywords if the list is long.
10639 @item LANGUAGE
10640 @cindex #+LANGUAGE
10641 @vindex org-export-default-language
10642 The language used for translating some strings
10643 (@code{org-export-default-language}).  E.g., @samp{#+LANGUAGE: fr} will tell
10644 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10645 clocktable.
10647 @item SELECT_TAGS
10648 @cindex #+SELECT_TAGS
10649 @vindex org-export-select-tags
10650 The tags that select a tree for export (@code{org-export-select-tags}).  The
10651 default value is @code{:export:}.  Within a subtree tagged with
10652 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10653 below).  When headlines are selectively exported with @code{:export:}
10654 anywhere in a file, text before the first headline is ignored.
10656 @item EXCLUDE_TAGS
10657 @cindex #+EXCLUDE_TAGS
10658 @vindex org-export-exclude-tags
10659 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10660 The default value is @code{:noexport:}.  Entries with the @code{:noexport:}
10661 tag will be unconditionally excluded from the export, even if they have an
10662 @code{:export:} tag.  Code blocks contained in excluded subtrees will still
10663 be executed during export even though the subtree is not exported.
10665 @item TITLE
10666 @cindex #+TITLE
10667 The title to be shown.  You can use several such keywords for long titles.
10668 @end table
10670 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10671 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10672 recognizes the following arguments:
10674 @table @code
10675 @item ':
10676 @vindex org-export-with-smart-quotes
10677 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10679 @item *:
10680 Toggle emphasized text (@code{org-export-with-emphasize}).
10682 @item -:
10683 @vindex org-export-with-special-strings
10684 Toggle conversion of special strings
10685 (@code{org-export-with-special-strings}).
10687 @item ::
10688 @vindex org-export-with-fixed-width
10689 Toggle fixed-width sections
10690 (@code{org-export-with-fixed-width}).
10692 @item <:
10693 @vindex org-export-with-timestamps
10694 Toggle inclusion of any time/date active/inactive stamps
10695 (@code{org-export-with-timestamps}).
10697 @item \n:
10698 @vindex org-export-preserve-breaks
10699 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10701 @item ^:
10702 @vindex org-export-with-sub-superscripts
10703 Toggle @TeX{}-like syntax for sub- and superscripts.  If you write "^:@{@}",
10704 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10705 it is (@code{org-export-with-sub-superscripts}).
10707 @item arch:
10708 @vindex org-export-with-archived-trees
10709 Configure export of archived trees.  Can be set to @code{headline} to only
10710 process the headline, skipping its contents
10711 (@code{org-export-with-archived-trees}).
10713 @item author:
10714 @vindex org-export-with-author
10715 Toggle inclusion of author name into exported file
10716 (@code{org-export-with-author}).
10718 @item c:
10719 @vindex org-export-with-clocks
10720 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10722 @item creator:
10723 @vindex org-export-with-creator
10724 Configure inclusion of creator info into exported file.  It may be set to
10725 @code{comment} (@code{org-export-with-creator}).
10727 @item d:
10728 @vindex org-export-with-drawers
10729 Toggle inclusion of drawers, or list drawers to include
10730 (@code{org-export-with-drawers}).
10732 @item date:
10733 @vindex org-export-with-date
10734 Toggle inclusion of a date into exported file (@code{org-export-with-date}).
10736 @item e:
10737 @vindex org-export-with-entities
10738 Toggle inclusion of entities (@code{org-export-with-entities}).
10740 @item email:
10741 @vindex org-export-with-email
10742 Toggle inclusion of the author's e-mail into exported file
10743 (@code{org-export-with-email}).
10745 @item f:
10746 @vindex org-export-with-footnotes
10747 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10749 @item H:
10750 @vindex org-export-headline-levels
10751 Set the number of headline levels for export
10752 (@code{org-export-headline-levels}).  Below that level, headlines are treated
10753 differently.  In most back-ends, they become list items.
10755 @item inline:
10756 @vindex org-export-with-inlinetasks
10757 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10759 @item num:
10760 @vindex org-export-with-section-numbers
10761 @cindex property, UNNUMBERED
10762 Toggle section-numbers (@code{org-export-with-section-numbers}).  It can also
10763 be set to a number @samp{n}, so only headlines at that level or above will be
10764 numbered.  Finally, irrespective of the level of a specific headline, the
10765 numbering of it can be disabled by setting the @code{UNNUMBERED} property to
10766 non-@code{nil}.  This also affects subheadings.
10768 @item p:
10769 @vindex org-export-with-planning
10770 Toggle export of planning information (@code{org-export-with-planning}).
10771 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10772 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10774 @item pri:
10775 @vindex org-export-with-priority
10776 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10778 @item prop:
10779 @vindex org-export-with-properties
10780 Toggle inclusion of property drawers, or list properties to include
10781 (@code{org-export-with-properties}).
10783 @item stat:
10784 @vindex org-export-with-statistics-cookies
10785 Toggle inclusion of statistics cookies
10786 (@code{org-export-with-statistics-cookies}).
10788 @item tags:
10789 @vindex org-export-with-tags
10790 Toggle inclusion of tags, may also be @code{not-in-toc}
10791 (@code{org-export-with-tags}).
10793 @item tasks:
10794 @vindex org-export-with-tasks
10795 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10796 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10797 (@code{org-export-with-tasks}).
10799 @item tex:
10800 @vindex org-export-with-latex
10801 Configure export of @LaTeX{} fragments and environments.  It may be set to
10802 @code{verbatim} (@code{org-export-with-latex}).
10804 @item timestamp:
10805 @vindex org-export-time-stamp-file
10806 Toggle inclusion of the creation time into exported file
10807 (@code{org-export-time-stamp-file}).
10809 @item title:
10810 @vindex org-export-with-title
10811 Toggle inclusion of title (@code{org-export-with-title}).
10813 @item toc:
10814 @vindex org-export-with-toc
10815 Toggle inclusion of the table of contents, or set the level limit
10816 (@code{org-export-with-toc}).
10818 @item todo:
10819 @vindex org-export-with-todo-keywords
10820 Toggle inclusion of TODO keywords into exported text
10821 (@code{org-export-with-todo-keywords}).
10823 @item |:
10824 @vindex org-export-with-tables
10825 Toggle inclusion of tables (@code{org-export-with-tables}).
10827 @end table
10829 When exporting only a subtree, each of the previous keywords@footnote{With
10830 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10831 properties.  These begin with @samp{EXPORT_}, followed by the name of the
10832 keyword they supplant.  For example, @samp{DATE} and @samp{OPTIONS} keywords
10833 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10834 properties.
10836 @cindex #+BIND
10837 @vindex org-export-allow-bind-keywords
10838 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10839 can become buffer-local during export by using the BIND keyword.  Its syntax
10840 is @samp{#+BIND: variable value}.  This is particularly useful for in-buffer
10841 settings that cannot be changed using specific keywords.
10843 @cindex property, EXPORT_FILE_NAME
10844 The name of the output file to be generated is taken from the file associated
10845 to the buffer, when possible, or asked to you otherwise.  For subtree export,
10846 you can also set @code{EXPORT_FILE_NAME} property.  In all cases, only the
10847 base name of the file is retained, and a back-end specific extension is
10848 added.
10850 @node ASCII/Latin-1/UTF-8 export
10851 @section ASCII/Latin-1/UTF-8 export
10852 @cindex ASCII export
10853 @cindex Latin-1 export
10854 @cindex UTF-8 export
10856 ASCII export produces a simple and very readable version of an Org mode
10857 file, containing only plain ASCII@.  Latin-1 and UTF-8 export augment the file
10858 with special characters and symbols available in these encodings.
10860 @vindex org-ascii-text-width
10861 Upon exporting, text is filled and justified, when appropriate, according the
10862 text width set in @code{org-ascii-text-width}.
10864 @vindex org-ascii-links-to-notes
10865 Links are exported in a footnote-like style, with the descriptive part in the
10866 text and the link in a note before the next heading.  See the variable
10867 @code{org-ascii-links-to-notes} for details and other options.
10869 @subheading ASCII export commands
10871 @table @kbd
10872 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10873 Export as an ASCII file.  For an Org file, @file{myfile.org}, the ASCII file
10874 will be @file{myfile.txt}.  The file will be overwritten without warning.
10875 When the original file is @file{myfile.txt}, the resulting file becomes
10876 @file{myfile.txt.txt} in order to prevent data loss.
10877 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10878 Export to a temporary buffer.  Do not create a file.
10879 @end table
10881 @subheading Header and sectioning structure
10883 In the exported version, the first three outline levels become headlines,
10884 defining a general document structure.  Additional levels are exported as
10885 lists.  The transition can also occur at a different level (@pxref{Export
10886 settings}).
10888 @subheading Quoting ASCII text
10890 You can insert text that will only appear when using @code{ASCII} back-end
10891 with the following constructs:
10893 @cindex #+ASCII
10894 @cindex #+BEGIN_ASCII
10895 @example
10896 Text @@@@ascii:and additional text@@@@ within a paragraph.
10898 #+ASCII: Some text
10900 #+BEGIN_ASCII
10901 All lines in this block will appear only when using this back-end.
10902 #+END_ASCII
10903 @end example
10905 @subheading ASCII specific attributes
10906 @cindex #+ATTR_ASCII
10907 @cindex horizontal rules, in ASCII export
10909 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10910 specifies the length, in characters, of a given horizontal rule.  It must be
10911 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
10913 @example
10914 #+ATTR_ASCII: :width 10
10915 -----
10916 @end example
10918 @subheading ASCII special blocks
10919 @cindex special blocks, in ASCII export
10920 @cindex #+BEGIN_JUSTIFYLEFT
10921 @cindex #+BEGIN_JUSTIFYRIGHT
10923 In addition to @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), it is
10924 possible to justify contents to the left or the right of the page with the
10925 following dedicated blocks.
10927 @example
10928 #+BEGIN_JUSTIFYLEFT
10929 It's just a jump to the left...
10930 #+END_JUSTIFYLEFT
10932 #+BEGIN_JUSTIFYRIGHT
10933 ...and then a step to the right.
10934 #+END_JUSTIFYRIGHT
10935 @end example
10937 @node Beamer export
10938 @section Beamer export
10939 @cindex Beamer export
10941 The @LaTeX{} class @emph{Beamer} allows production of high quality
10942 presentations using @LaTeX{} and pdf processing.  Org mode has special
10943 support for turning an Org mode file or tree into a Beamer presentation.
10945 @subheading Beamer export commands
10947 @table @kbd
10948 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
10949 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
10950 file will be @file{myfile.tex}.  The file will be overwritten without
10951 warning.
10952 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
10953 Export to a temporary buffer.  Do not create a file.
10954 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
10955 Export as @LaTeX{} and then process to PDF.
10956 @item C-c C-e l O
10957 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10958 @end table
10960 @subheading Sectioning, Frames and Blocks
10962 Any tree with not-too-deep level nesting should in principle be exportable as
10963 a Beamer presentation.  Headlines fall into three categories: sectioning
10964 elements, frames and blocks.
10966 @itemize @minus
10967 @item
10968 @vindex org-beamer-frame-level
10969 Headlines become frames when their level is equal to
10970 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
10971 (@pxref{Export settings}).
10973 @cindex property, BEAMER_ENV
10974 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
10975 set to either to @code{frame} or @code{fullframe}, its level overrides the
10976 variable.  A @code{fullframe} is a frame with an empty (ignored) title.
10978 @item
10979 @vindex org-beamer-environments-default
10980 @vindex org-beamer-environments-extra
10981 All frame's children become @code{block} environments.  Special block types
10982 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
10983 this property is set, the entry will also get a @code{:B_environment:} tag to
10984 make this visible.  This tag has no semantic meaning, it is only a visual
10985 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
10986 supported values and @code{org-beamer-environments-extra} for adding more).
10988 @item
10989 @cindex property, BEAMER_REF
10990 As a special case, if the @code{BEAMER_ENV} property is set to either
10991 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
10992 headline will become, respectively, an appendix, a note (within frame or
10993 between frame, depending on its level), a note with its title ignored or an
10994 @code{\againframe} command.  In the latter case, a @code{BEAMER_REF} property
10995 is mandatory in order to refer to the frame being resumed, and contents are
10996 ignored.
10998 Also, a headline with an @code{ignoreheading} environment will have its
10999 contents only inserted in the output.  This special value is useful to have
11000 data between frames, or to properly close a @code{column} environment.
11001 @end itemize
11003 @cindex property, BEAMER_ACT
11004 @cindex property, BEAMER_OPT
11005 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
11006 The former is translated as an overlay/action specification, or a default
11007 overlay specification when enclosed within square brackets.  The latter
11008 specifies options@footnote{The @code{fragile} option is added automatically
11009 if it contains code that requires a verbatim environment, though.} for the
11010 current frame or block.  The export back-end will automatically wrap
11011 properties within angular or square brackets when appropriate.
11013 @cindex property, BEAMER_COL
11014 Moreover, headlines handle the @code{BEAMER_COL} property.  Its value should
11015 be a decimal number representing the width of the column as a fraction of the
11016 total text width.  If the headline has no specific environment, its title
11017 will be ignored and its contents will fill the column created.  Otherwise,
11018 the block will fill the whole column and the title will be preserved.  Two
11019 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
11020 @code{columns} @LaTeX{} environment.  It will end before the next headline
11021 without such a property.  This environment is generated automatically.
11022 Although, it can also be explicitly created, with a special @code{columns}
11023 value for @code{BEAMER_ENV} property (if it needs to be set up with some
11024 specific options, for example).
11026 @subheading Beamer specific syntax
11028 Beamer back-end is an extension of @LaTeX{} back-end.  As such, all @LaTeX{}
11029 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
11030 recognized.  See @ref{@LaTeX{} and PDF export} for more information.
11032 @cindex #+BEAMER_THEME
11033 @cindex #+BEAMER_COLOR_THEME
11034 @cindex #+BEAMER_FONT_THEME
11035 @cindex #+BEAMER_INNER_THEME
11036 @cindex #+BEAMER_OUTER_THEME
11037 Beamer export introduces a number of keywords to insert code in the
11038 document's header.  Four control appearance of the presentation:
11039 @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
11040 @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
11041 @code{#+BEAMER_OUTER_THEME}.  All of them accept optional arguments
11042 within square brackets.  The last one, @code{#+BEAMER_HEADER}, is more
11043 generic and allows you to append any line of code in the header.
11045 @example
11046 #+BEAMER_THEME: Rochester [height=20pt]
11047 #+BEAMER_COLOR_THEME: spruce
11048 @end example
11050 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
11051 wrapped within a @code{frame} environment.  Those generated from a @code{TOC}
11052 keyword (@pxref{Table of contents}) are not.  In that case, it is also
11053 possible to specify options, enclosed within square brackets.
11055 @example
11056 #+TOC: headlines [currentsection]
11057 @end example
11059 Beamer specific code can be inserted with the following constructs:
11061 @cindex #+BEAMER
11062 @cindex #+BEGIN_BEAMER
11063 @example
11064 #+BEAMER: \pause
11066 #+BEGIN_BEAMER
11067 All lines in this block will appear only when using this back-end.
11068 #+END_BEAMER
11070 Text @@@@beamer:some code@@@@ within a paragraph.
11071 @end example
11073 In particular, this last example can be used to add overlay specifications to
11074 objects whose type is among @code{bold}, @code{item}, @code{link},
11075 @code{radio-target} and @code{target}, when the value is enclosed within
11076 angular brackets and put at the beginning the object.
11078 @example
11079 A *@@@@beamer:<2->@@@@useful* feature
11080 @end example
11082 @cindex #+ATTR_BEAMER
11083 Eventually, every plain list has support for @code{:environment},
11084 @code{:overlay} and @code{:options} attributes through
11085 @code{ATTR_BEAMER} affiliated keyword.  The first one allows the use
11086 of a different environment, the second sets overlay specifications and
11087 the last one inserts optional arguments in current list environment.
11089 @example
11090 #+ATTR_BEAMER: :overlay +-
11091 - item 1
11092 - item 2
11093 @end example
11095 @subheading Editing support
11097 You can turn on a special minor mode @code{org-beamer-mode} for faster
11098 editing with:
11100 @example
11101 #+STARTUP: beamer
11102 @end example
11104 @table @kbd
11105 @orgcmd{C-c C-b,org-beamer-select-environment}
11106 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
11107 environment or the @code{BEAMER_COL} property.
11108 @end table
11110 @subheading An example
11112 Here is a simple example Org document that is intended for Beamer export.
11114 @smallexample
11115 #+TITLE: Example Presentation
11116 #+AUTHOR: Carsten Dominik
11117 #+OPTIONS: H:2 toc:t num:t
11118 #+LATEX_CLASS: beamer
11119 #+LATEX_CLASS_OPTIONS: [presentation]
11120 #+BEAMER_THEME: Madrid
11121 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
11123 * This is the first structural section
11125 ** Frame 1
11126 *** Thanks to Eric Fraga                                           :B_block:
11127     :PROPERTIES:
11128     :BEAMER_COL: 0.48
11129     :BEAMER_ENV: block
11130     :END:
11131     for the first viable Beamer setup in Org
11132 *** Thanks to everyone else                                        :B_block:
11133     :PROPERTIES:
11134     :BEAMER_COL: 0.48
11135     :BEAMER_ACT: <2->
11136     :BEAMER_ENV: block
11137     :END:
11138     for contributing to the discussion
11139 **** This will be formatted as a beamer note                       :B_note:
11140      :PROPERTIES:
11141      :BEAMER_env: note
11142      :END:
11143 ** Frame 2 (where we will not use columns)
11144 *** Request
11145     Please test this stuff!
11146 @end smallexample
11148 @node HTML export
11149 @section HTML export
11150 @cindex HTML export
11152 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
11153 HTML formatting, in ways similar to John Gruber's @emph{markdown}
11154 language, but with additional support for tables.
11156 @menu
11157 * HTML Export commands::        How to invoke HTML export
11158 * HTML doctypes::               Org can export to various (X)HTML flavors
11159 * HTML preamble and postamble::  How to insert a preamble and a postamble
11160 * Quoting HTML tags::           Using direct HTML in Org mode
11161 * Links in HTML export::        How links will be interpreted and formatted
11162 * Tables in HTML export::       How to modify the formatting of tables
11163 * Images in HTML export::       How to insert figures into HTML output
11164 * Math formatting in HTML export::  Beautiful math also on the web
11165 * Text areas in HTML export::   An alternative way to show an example
11166 * CSS support::                 Changing the appearance of the output
11167 * JavaScript support::          Info and Folding in a web browser
11168 @end menu
11170 @node HTML Export commands
11171 @subsection HTML export commands
11173 @table @kbd
11174 @orgcmd{C-c C-e h h,org-html-export-to-html}
11175 Export as an HTML file.  For an Org file @file{myfile.org},
11176 the HTML file will be @file{myfile.html}.  The file will be overwritten
11177 without warning.
11178 @kbd{C-c C-e h o}
11179 Export as an HTML file and immediately open it with a browser.
11180 @orgcmd{C-c C-e h H,org-html-export-as-html}
11181 Export to a temporary buffer.  Do not create a file.
11182 @end table
11184 @c FIXME Exporting sublevels
11185 @c @cindex headline levels, for exporting
11186 @c In the exported version, the first 3 outline levels will become headlines,
11187 @c defining a general document structure.  Additional levels will be exported as
11188 @c itemized lists.  If you want that transition to occur at a different level,
11189 @c specify it with a numeric prefix argument.  For example,
11191 @c @example
11192 @c @kbd{C-2 C-c C-e b}
11193 @c @end example
11195 @c @noindent
11196 @c creates two levels of headings and does the rest as items.
11198 @node HTML doctypes
11199 @subsection HTML doctypes
11200 @vindex org-html-doctype
11201 @vindex org-html-doctype-alist
11203 Org can export to various (X)HTML flavors.
11205 Setting the variable @code{org-html-doctype} allows you to export to different
11206 (X)HTML variants.  The exported HTML will be adjusted according to the syntax
11207 requirements of that variant.  You can either set this variable to a doctype
11208 string directly, in which case the exporter will try to adjust the syntax
11209 automatically, or you can use a ready-made doctype.  The ready-made options
11210 are:
11212 @itemize
11213 @item
11214 ``html4-strict''
11215 @item
11216 ``html4-transitional''
11217 @item
11218 ``html4-frameset''
11219 @item
11220 ``xhtml-strict''
11221 @item
11222 ``xhtml-transitional''
11223 @item
11224 ``xhtml-frameset''
11225 @item
11226 ``xhtml-11''
11227 @item
11228 ``html5''
11229 @item
11230 ``xhtml5''
11231 @end itemize
11233 See the variable @code{org-html-doctype-alist} for details.  The default is
11234 ``xhtml-strict''.
11236 @subsubheading Fancy HTML5 export
11237 @vindex org-html-html5-fancy
11238 @vindex org-html-html5-elements
11240 HTML5 introduces several new element types.  By default, Org will not make
11241 use of these element types, but you can set @code{org-html-html5-fancy} to
11242 @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11243 enable a few new block-level elements.  These are created using arbitrary
11244 #+BEGIN and #+END blocks. For instance:
11246 @example
11247 #+BEGIN_ASIDE
11248 Lorem ipsum
11249 #+END_ASIDE
11250 @end example
11252 Will export to:
11254 @example
11255 <aside>
11256   <p>Lorem ipsum</p>
11257 </aside>
11258 @end example
11260 While this:
11262 @example
11263 #+ATTR_HTML: :controls controls :width 350
11264 #+BEGIN_VIDEO
11265 #+HTML: <source src="movie.mp4" type="video/mp4">
11266 #+HTML: <source src="movie.ogg" type="video/ogg">
11267 Your browser does not support the video tag.
11268 #+END_VIDEO
11269 @end example
11271 Becomes:
11273 @example
11274 <video controls="controls" width="350">
11275   <source src="movie.mp4" type="video/mp4">
11276   <source src="movie.ogg" type="video/ogg">
11277   <p>Your browser does not support the video tag.</p>
11278 </video>
11279 @end example
11281 Special blocks that do not correspond to HTML5 elements (see
11282 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11283 @code{#+BEGIN_lederhosen} will still export to @samp{<div class="lederhosen">}.
11285 Headlines cannot appear within special blocks.  To wrap a headline and its
11286 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11287 @code{HTML_CONTAINER} property on the headline itself.
11289 @node HTML preamble and postamble
11290 @subsection HTML preamble and postamble
11291 @vindex org-html-preamble
11292 @vindex org-html-postamble
11293 @vindex org-html-preamble-format
11294 @vindex org-html-postamble-format
11295 @vindex org-html-validation-link
11296 @vindex org-export-creator-string
11297 @vindex org-export-time-stamp-file
11299 The HTML exporter lets you define a preamble and a postamble.
11301 The default value for @code{org-html-preamble} is @code{t}, which means
11302 that the preamble is inserted depending on the relevant format string in
11303 @code{org-html-preamble-format}.
11305 Setting @code{org-html-preamble} to a string will override the default format
11306 string.  If you set it to a function, it will insert the output of the
11307 function, which must be a string.  Setting to @code{nil} will not insert any
11308 preamble.
11310 The default value for @code{org-html-postamble} is @code{'auto}, which means
11311 that the HTML exporter will look for information about the author, the email,
11312 the creator and the date, and build the postamble from these values.  Setting
11313 @code{org-html-postamble} to @code{t} will insert the postamble from the
11314 relevant format string found in @code{org-html-postamble-format}.  Setting it
11315 to @code{nil} will not insert any postamble.
11317 @node Quoting HTML tags
11318 @subsection Quoting HTML tags
11320 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
11321 @samp{&gt;} in HTML export.  If you want to include raw HTML code, which
11322 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11323 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}.  For more extensive HTML
11324 that should be copied verbatim to the exported file use either
11326 @cindex #+HTML
11327 @cindex #+BEGIN_HTML
11328 @example
11329 #+HTML: Literal HTML code for export
11330 @end example
11332 @noindent or
11333 @cindex #+BEGIN_HTML
11335 @example
11336 #+BEGIN_HTML
11337 All lines between these markers are exported literally
11338 #+END_HTML
11339 @end example
11342 @node Links in HTML export
11343 @subsection Links in HTML export
11345 @cindex links, in HTML export
11346 @cindex internal links, in HTML export
11347 @cindex external links, in HTML export
11348 @vindex org-html-link-org-files-as-html
11349 Internal links (@pxref{Internal links}) will continue to work in HTML@.  This
11350 includes automatic links created by radio targets (@pxref{Radio
11351 targets}).  Links to external files will still work if the target file is on
11352 the same @i{relative} path as the published Org file.  Links to other
11353 @file{.org} files will be translated into HTML links under the assumption
11354 that an HTML version also exists of the linked file, at the same relative
11355 path; setting @code{org-html-link-org-files-as-html} to @code{nil} disables
11356 this translation.  @samp{id:} links can then be used to jump to specific
11357 entries across files.  For information related to linking files while
11358 publishing them to a publishing directory see @ref{Publishing links}.
11360 If you want to specify attributes for links, you can do so using a special
11361 @code{#+ATTR_HTML} line to define attributes that will be added to the
11362 @code{<a>} or @code{<img>} tags.  Here is an example that sets @code{title}
11363 and @code{style} attributes for a link:
11365 @cindex #+ATTR_HTML
11366 @example
11367 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11368 [[http://orgmode.org]]
11369 @end example
11371 @node Tables in HTML export
11372 @subsection Tables in HTML export
11373 @cindex tables, in HTML
11374 @vindex org-html-table-default-attributes
11376 Org mode tables are exported to HTML using the table attributes defined in
11377 @code{org-html-table-default-attributes}.  The default setting makes tables
11378 without cell borders and frame.  If you would like to change this for
11379 individual tables, place something like the following before the table:
11381 @cindex #+CAPTION
11382 @cindex #+ATTR_HTML
11383 @example
11384 #+CAPTION: This is a table with lines around and between cells
11385 #+ATTR_HTML: :border 2 :rules all :frame border
11386 @end example
11388 You can also group columns in the HTML output (@pxref{Column groups}).
11390 Below is a list of options for customizing tables HTML export.
11392 @table @code
11393 @vindex org-html-table-align-individual-fields
11394 @item org-html-table-align-individual-fields
11395 Non-@code{nil} means attach style attributes for alignment to each table field.
11397 @vindex org-html-table-caption-above
11398 @item org-html-table-caption-above
11399 When non-@code{nil}, place caption string at the beginning of the table.
11401 @vindex org-html-table-data-tags
11402 @item org-html-table-data-tags
11403 The opening and ending tags for table data fields.
11405 @vindex org-html-table-default-attributes
11406 @item org-html-table-default-attributes
11407 Default attributes and values which will be used in table tags.
11409 @vindex org-html-table-header-tags
11410 @item org-html-table-header-tags
11411 The opening and ending tags for table header fields.
11413 @vindex org-html-table-row-tags
11414 @item org-html-table-row-tags
11415 The opening and ending tags for table rows.
11417 @vindex org-html-table-use-header-tags-for-first-column
11418 @item org-html-table-use-header-tags-for-first-column
11419 Non-@code{nil} means format column one in tables with header tags.
11420 @end table
11422 @node Images in HTML export
11423 @subsection Images in HTML export
11425 @cindex images, inline in HTML
11426 @cindex inlining images in HTML
11427 @vindex org-html-inline-images
11428 HTML export can inline images given as links in the Org file, and
11429 it can make an image the clickable part of a link.  By
11430 default@footnote{But see the variable
11431 @code{org-html-inline-images}.}, images are inlined if a link does
11432 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
11433 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11434 @samp{the image} that points to the image.  If the description part
11435 itself is a @code{file:} link or a @code{http:} URL pointing to an
11436 image, this image will be inlined and activated so that clicking on the
11437 image will activate the link.  For example, to include a thumbnail that
11438 will link to a high resolution version of the image, you could use:
11440 @example
11441 [[file:highres.jpg][file:thumb.jpg]]
11442 @end example
11444 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11445 In the example below we specify the @code{alt} and @code{title} attributes to
11446 support text viewers and accessibility, and align it to the right.
11448 @cindex #+CAPTION
11449 @cindex #+ATTR_HTML
11450 @example
11451 #+CAPTION: A black cat stalking a spider
11452 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11453 [[./img/a.jpg]]
11454 @end example
11456 @noindent
11457 You could use @code{http} addresses just as well.
11459 @node Math formatting in HTML export
11460 @subsection Math formatting in HTML export
11461 @cindex MathJax
11462 @cindex dvipng
11463 @cindex imagemagick
11465 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11466 different ways on HTML pages.  The default is to use
11467 @uref{http://www.mathjax.org, MathJax} which should work out of the box with
11468 Org@footnote{By default Org loads MathJax from
11469 @uref{http://docs.mathjax.org/en/latest/start.html#using-the-mathjax-content-delivery-network-cdn,
11470 MathJax.org}.  A link to the terms of service of the MathJax CDN can be found
11471 in the docstring of @code{org-html-mathjax-options}.}.  Some MathJax display
11472 options can be configured via @code{org-html-mathjax-options}, or in the
11473 buffer.  For example, with the following settings,
11474 @smallexample
11475 #+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
11476 @end smallexample
11477 equation labels will be displayed on the left marign and equations will be
11478 five ems from the left margin.
11480 @noindent See the docstring of
11481 @code{org-html-mathjax-options} for all supported variables.  The MathJax
11482 template can be configure via @code{org-html-mathjax-template}.
11484 If you prefer, you can also request that @LaTeX{} fragments are processed
11485 into small images that will be inserted into the browser page.  Before the
11486 availability of MathJax, this was the default method for Org files.  This
11487 method requires that the @file{dvipng} program or @file{imagemagick} suite is
11488 available on your system.  You can still get this processing with
11490 @example
11491 #+OPTIONS: tex:dvipng
11492 @end example
11496 @example
11497 #+OPTIONS: tex:imagemagick
11498 @end example
11500 @node Text areas in HTML export
11501 @subsection Text areas in HTML export
11503 @cindex text areas, in HTML
11504 An alternative way to publish literal code examples in HTML is to use text
11505 areas, where the example can even be edited before pasting it into an
11506 application.  It is triggered by @code{:textarea} attribute at an
11507 @code{example} or @code{src} block.
11509 You may also use @code{:height} and @code{:width} attributes to specify the
11510 height and width of the text area, which default to the number of lines in
11511 the example, and 80, respectively.  For example
11513 @example
11514 #+ATTR_HTML: :textarea t :width 40
11515 #+BEGIN_EXAMPLE
11516   (defun org-xor (a b)
11517      "Exclusive or."
11518      (if a (not b) b))
11519 #+END_EXAMPLE
11520 @end example
11523 @node CSS support
11524 @subsection CSS support
11525 @cindex CSS, for HTML export
11526 @cindex HTML export, CSS
11528 @vindex org-html-todo-kwd-class-prefix
11529 @vindex org-html-tag-class-prefix
11530 You can modify the CSS style definitions for the exported file.  The HTML
11531 exporter assigns the following special CSS classes@footnote{If the classes on
11532 TODO keywords and tags lead to conflicts, use the variables
11533 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11534 make them unique.} to appropriate parts of the document---your style
11535 specifications may change these, in addition to any of the standard classes
11536 like for headlines, tables, etc.
11537 @example
11538 p.author            @r{author information, including email}
11539 p.date              @r{publishing date}
11540 p.creator           @r{creator info, about org mode version}
11541 .title              @r{document title}
11542 .todo               @r{TODO keywords, all not-done states}
11543 .done               @r{the DONE keywords, all states that count as done}
11544 .WAITING            @r{each TODO keyword also uses a class named after itself}
11545 .timestamp          @r{timestamp}
11546 .timestamp-kwd      @r{keyword associated with a timestamp, like SCHEDULED}
11547 .timestamp-wrapper  @r{span around keyword plus timestamp}
11548 .tag                @r{tag in a headline}
11549 ._HOME              @r{each tag uses itself as a class, "@@" replaced by "_"}
11550 .target             @r{target for links}
11551 .linenr             @r{the line number in a code example}
11552 .code-highlighted   @r{for highlighting referenced code lines}
11553 div.outline-N       @r{div for outline level N (headline plus text))}
11554 div.outline-text-N  @r{extra div for text at outline level N}
11555 .section-number-N   @r{section number in headlines, different for each level}
11556 .figure-number      @r{label like "Figure 1:"}
11557 .table-number       @r{label like "Table 1:"}
11558 .listing-number     @r{label like "Listing 1:"}
11559 div.figure          @r{how to format an inlined image}
11560 pre.src             @r{formatted source code}
11561 pre.example         @r{normal example}
11562 p.verse             @r{verse paragraph}
11563 div.footnotes       @r{footnote section headline}
11564 p.footnote          @r{footnote definition paragraph, containing a footnote}
11565 .footref            @r{a footnote reference number (always a <sup>)}
11566 .footnum            @r{footnote number in footnote definition (always <sup>)}
11567 @end example
11569 @vindex org-html-style-default
11570 @vindex org-html-head-include-default-style
11571 @vindex org-html-head
11572 @vindex org-html-head-extra
11573 @cindex #+HTML_INCLUDE_STYLE
11574 Each exported file contains a compact default style that defines these
11575 classes in a basic way@footnote{This style is defined in the constant
11576 @code{org-html-style-default}, which you should not modify.  To turn
11577 inclusion of these defaults off, customize
11578 @code{org-html-head-include-default-style} or set @code{html-style} to
11579 @code{nil} in an @code{OPTIONS} line.}.  You may overwrite these settings, or
11580 add to them by using the variables @code{org-html-head} and
11581 @code{org-html-head-extra}.  You can override the global values of these
11582 variables for each file by using these keywords:
11584 @cindex #+HTML_HEAD
11585 @cindex #+HTML_HEAD_EXTRA
11586 @example
11587 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11588 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11589 @end example
11591 @noindent
11592 For longer style definitions, you can use several such lines.  You could also
11593 directly write a @code{<style>} @code{</style>} section in this way, without
11594 referring to an external file.
11596 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11597 property to assign a class to the tree.  In order to specify CSS styles for a
11598 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11599 property.
11601 @c FIXME: More about header and footer styles
11602 @c FIXME: Talk about links and targets.
11604 @node JavaScript support
11605 @subsection JavaScript supported display of web pages
11607 @cindex Rose, Sebastian
11608 Sebastian Rose has written a JavaScript program especially designed to
11609 enhance the web viewing experience of HTML files created with Org.  This
11610 program allows you to view large files in two different ways.  The first one
11611 is an @emph{Info}-like mode where each section is displayed separately and
11612 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11613 as well, press @kbd{?} for an overview of the available keys).  The second
11614 view type is a @emph{folding} view much like Org provides inside Emacs.  The
11615 script is available at @url{http://orgmode.org/org-info.js} and you can find
11616 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11617 We host the script at our site, but if you use it a lot, you might not want
11618 to be dependent on @url{http://orgmode.org} and prefer to install a local
11619 copy on your own web server.
11621 All it then takes to use this program is adding a single line to the Org
11622 file:
11624 @cindex #+INFOJS_OPT
11625 @example
11626 #+INFOJS_OPT: view:info toc:nil
11627 @end example
11629 @noindent
11630 If this line is found, the HTML header will automatically contain the code
11631 needed to invoke the script.  Using the line above, you can set the following
11632 viewing options:
11634 @example
11635 path:    @r{The path to the script.  The default is to grab the script from}
11636          @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11637          @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11638 view:    @r{Initial view when the website is first shown.  Possible values are:}
11639          info      @r{Info-like interface with one section per page.}
11640          overview  @r{Folding interface, initially showing only top-level.}
11641          content   @r{Folding interface, starting with all headlines visible.}
11642          showall   @r{Folding interface, all headlines and text visible.}
11643 sdepth:  @r{Maximum headline level that will still become an independent}
11644          @r{section for info and folding modes.  The default is taken from}
11645          @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11646          @r{If this is smaller than in @code{org-export-headline-levels}, each}
11647          @r{info/folding section can still contain child headlines.}
11648 toc:     @r{Should the table of contents @emph{initially} be visible?}
11649          @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11650 tdepth:  @r{The depth of the table of contents.  The defaults are taken from}
11651          @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11652 ftoc:    @r{Does the CSS of the page specify a fixed position for the "toc"?}
11653          @r{If yes, the toc will never be displayed as a section.}
11654 ltoc:    @r{Should there be short contents (children) in each section?}
11655          @r{Make this @code{above} if the section should be above initial text.}
11656 mouse:   @r{Headings are highlighted when the mouse is over them.  Should be}
11657          @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11658 buttons: @r{Should view-toggle buttons be everywhere?  When @code{nil} (the}
11659          @r{default), only one such button will be present.}
11660 @end example
11661 @noindent
11662 @vindex org-html-infojs-options
11663 @vindex org-html-use-infojs
11664 You can choose default values for these options by customizing the variable
11665 @code{org-html-infojs-options}.  If you always want to apply the script to your
11666 pages, configure the variable @code{org-html-use-infojs}.
11668 @node @LaTeX{} and PDF export
11669 @section @LaTeX{} and PDF export
11670 @cindex @LaTeX{} export
11671 @cindex PDF export
11673 @LaTeX{} export can produce an arbitrarily complex LaTeX document of any
11674 standard or custom document class.  With further processing@footnote{The
11675 default @LaTeX{} output is designed for processing with @code{pdftex} or
11676 @LaTeX{}.  It includes packages that are not compatible with @code{xetex} and
11677 possibly @code{luatex}.  The @LaTeX{} exporter can be configured to support
11678 alternative TeX engines, see the options
11679 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}.},
11680 which the @LaTeX{} exporter is able to control, this back-end is able to
11681 produce PDF output.  Because the @LaTeX{} exporter can be configured to use
11682 the @code{hyperref} package, the default setup produces fully-linked PDF
11683 output.
11685 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11686 will not be started if two contiguous syntactical elements are not separated
11687 by an empty line.
11689 This back-end also offers enhanced support for footnotes.  Thus, it handles
11690 nested footnotes, footnotes in tables and footnotes in a list item's
11691 description.
11693 @menu
11694 * @LaTeX{} export commands::    How to export to LaTeX and PDF
11695 * Header and sectioning::       Setting up the export file structure
11696 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
11697 * @LaTeX{} specific attributes::  Controlling @LaTeX{} output
11698 @end menu
11700 @node @LaTeX{} export commands
11701 @subsection @LaTeX{} export commands
11703 @table @kbd
11704 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11705 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
11706 file will be @file{myfile.tex}.  The file will be overwritten without
11707 warning.
11708 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11709 Export to a temporary buffer.  Do not create a file.
11710 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11711 Export as @LaTeX{} and then process to PDF.
11712 @item C-c C-e l o
11713 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11714 @end table
11716 @node Header and sectioning
11717 @subsection Header and sectioning structure
11718 @cindex @LaTeX{} class
11719 @cindex @LaTeX{} sectioning structure
11720 @cindex @LaTeX{} header
11721 @cindex header, for @LaTeX{} files
11722 @cindex sectioning structure, for @LaTeX{} export
11724 By default, the first three outline levels become headlines, defining a
11725 general document structure.  Additional levels are exported as @code{itemize}
11726 or @code{enumerate} lists.  The transition can also occur at a different
11727 level (@pxref{Export settings}).
11729 By default, the @LaTeX{} output uses the class @code{article}.
11731 @vindex org-latex-default-class
11732 @vindex org-latex-classes
11733 @vindex org-latex-default-packages-alist
11734 @vindex org-latex-packages-alist
11735 You can change this globally by setting a different value for
11736 @code{org-latex-default-class} or locally by adding an option like
11737 @code{#+LATEX_CLASS: myclass} in your file, or with
11738 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11739 containing only this (sub)tree.  The class must be listed in
11740 @code{org-latex-classes}.  This variable defines a header template for each
11741 class@footnote{Into which the values of
11742 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
11743 are spliced.}, and allows you to define the sectioning structure for each
11744 class.  You can also define your own classes there.
11746 @cindex #+LATEX_CLASS
11747 @cindex #+LATEX_CLASS_OPTIONS
11748 @cindex property, EXPORT_LATEX_CLASS
11749 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
11750 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
11751 property can specify the options for the @code{\documentclass} macro.  These
11752 options have to be provided, as expected by @LaTeX{}, within square brackets.
11754 @cindex #+LATEX_HEADER
11755 @cindex #+LATEX_HEADER_EXTRA
11756 You can also use the @code{LATEX_HEADER} and
11757 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
11758 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
11759 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
11760 to add lines to the header.  See the docstring of @code{org-latex-classes} for
11761 more information.
11763 An example is shown below.
11765 @example
11766 #+LATEX_CLASS: article
11767 #+LATEX_CLASS_OPTIONS: [a4paper]
11768 #+LATEX_HEADER: \usepackage@{xyz@}
11770 * Headline 1
11771   some text
11772 @end example
11774 @node Quoting @LaTeX{} code
11775 @subsection Quoting @LaTeX{} code
11777 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11778 inserted into the @LaTeX{} file.  Furthermore, you can add special code that
11779 should only be present in @LaTeX{} export with the following constructs:
11781 @cindex #+LATEX
11782 @cindex #+BEGIN_LATEX
11783 @example
11784 Code within @@@@latex:some code@@@@ a paragraph.
11786 #+LATEX: Literal @LaTeX{} code for export
11788 #+BEGIN_LATEX
11789 All lines between these markers are exported literally
11790 #+END_LATEX
11791 @end example
11793 @node @LaTeX{} specific attributes
11794 @subsection @LaTeX{} specific attributes
11795 @cindex #+ATTR_LATEX
11797 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line.  They
11798 affect tables, images, plain lists, special blocks and source blocks.
11800 @subsubheading Tables in @LaTeX{} export
11801 @cindex tables, in @LaTeX{} export
11803 For @LaTeX{} export of a table, you can specify a label and a caption
11804 (@pxref{Images and tables}).  You can also use attributes to control table
11805 layout and contents.  Valid @LaTeX{} attributes include:
11807 @table @code
11808 @item :mode
11809 @vindex org-latex-default-table-mode
11810 Nature of table's contents.  It can be set to @code{table}, @code{math},
11811 @code{inline-math} or @code{verbatim}.  In particular, when in @code{math} or
11812 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11813 ignored and the table will be wrapped in a math environment.  Also,
11814 contiguous tables sharing the same math mode will be wrapped within the same
11815 environment.  Default mode is determined in
11816 @code{org-latex-default-table-mode}.
11817 @item :environment
11818 @vindex org-latex-default-table-environment
11819 Environment used for the table.  It can be set to any @LaTeX{} table
11820 environment, like @code{tabularx}@footnote{Requires adding the
11821 @code{tabularx} package to @code{org-latex-packages-alist}.},
11822 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
11823 @code{tabu} package to @code{org-latex-packages-alist}.},
11824 @code{bmatrix}@enddots{} It defaults to
11825 @code{org-latex-default-table-environment} value.
11826 @item :caption
11827 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
11828 (@pxref{Images and tables}).  If you need more advanced commands for that
11829 task, you can use @code{:caption} attribute instead.  Its value should be raw
11830 @LaTeX{} code.  It has precedence over @code{#+CAPTION}.
11831 @item :float
11832 @itemx :placement
11833 The @code{:float} specifies the float environment for the table.  Possible
11834 values are @code{sideways}@footnote{Formerly, the value was
11835 @code{sidewaystable}.  This is deprecated since Org 8.3.},
11836 @code{multicolumn}, @code{t} and @code{nil}.  When unspecified, a table with
11837 a caption will have a @code{table} environment.  Moreover, the
11838 @code{:placement} attribute can specify the positioning of the float.  Note:
11839 @code{:placement} is ignored for @code{:float sideways} tables.
11840 @item :align
11841 @itemx :font
11842 @itemx :width
11843 Set, respectively, the alignment string of the table, its font size and its
11844 width.  They only apply on regular tables.
11845 @item :spread
11846 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11847 only takes effect when used in conjunction with the @code{:width} attribute.
11848 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
11849 value of @code{:width}.
11850 @item :booktabs
11851 @itemx :center
11852 @itemx :rmlines
11853 @vindex org-latex-tables-booktabs
11854 @vindex org-latex-tables-centered
11855 They toggle, respectively, @code{booktabs} usage (assuming the package is
11856 properly loaded), table centering and removal of every horizontal rule but
11857 the first one (in a "table.el" table only).  In particular,
11858 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
11859 activates the first (respectively second) attribute globally.
11860 @item :math-prefix
11861 @itemx :math-suffix
11862 @itemx :math-arguments
11863 A string that will be inserted, respectively, before the table within the
11864 math environment, after the table within the math environment, and between
11865 the macro name and the contents of the table.  The @code{:math-arguments}
11866 attribute is used for matrix macros that require more than one argument
11867 (e.g., @code{qbordermatrix}).
11868 @end table
11870 Thus, attributes can be used in a wide array of situations, like writing
11871 a table that will span over multiple pages, or a matrix product:
11873 @example
11874 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11875 | ..... | ..... |
11876 | ..... | ..... |
11878 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11879 | a | b |
11880 | c | d |
11881 #+ATTR_LATEX: :mode math :environment bmatrix
11882 | 1 | 2 |
11883 | 3 | 4 |
11884 @end example
11886 In the example below, @LaTeX{} command
11887 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
11889 @example
11890 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11891 | ..... | ..... |
11892 | ..... | ..... |
11893 @end example
11896 @subsubheading Images in @LaTeX{} export
11897 @cindex images, inline in @LaTeX{}
11898 @cindex inlining images in @LaTeX{}
11900 Images that are linked to without a description part in the link, like
11901 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11902 output file resulting from @LaTeX{} processing.  Org will use an
11903 @code{\includegraphics} macro to insert the image@footnote{In the case of
11904 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11905 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
11907 You can specify specify image width or height with, respectively,
11908 @code{:width} and @code{:height} attributes.  It is also possible to add any
11909 other option with the @code{:options} attribute, as shown in the following
11910 example:
11912 @example
11913 #+ATTR_LATEX: :width 5cm :options angle=90
11914 [[./img/sed-hr4049.pdf]]
11915 @end example
11917 If you need a specific command for the caption, use @code{:caption}
11918 attribute.  It will override standard @code{#+CAPTION} value, if any.
11920 @example
11921 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11922 [[./img/sed-hr4049.pdf]]
11923 @end example
11925 If you have specified a caption as described in @ref{Images and tables}, the
11926 picture will be wrapped into a @code{figure} environment and thus become
11927 a floating element.  You can also ask Org to export an image as a float
11928 without specifying caption by setting the @code{:float} attribute.  You may
11929 also set it to:
11930 @itemize @minus
11931 @item
11932 @code{t}: if you want to use the standard @samp{figure} environment.  It is
11933 used by default if you provide a caption to the image.
11934 @item
11935 @code{multicolumn}: if you wish to include an image which spans multiple
11936 columns in a page.  This will export the image wrapped in a @code{figure*}
11937 environment.
11938 @item
11939 @code{wrap}: if you would like to let text flow around the image.  It will
11940 make the figure occupy the left half of the page.
11941 @item
11942 @code{sideways}: if you would like the image to appear alone on a separate
11943 page rotated ninety degrees using the @code{sidewaysfigure}
11944 environment.  Setting this @code{:float} option will ignore the
11945 @code{:placement} setting.
11946 @item
11947 @code{nil}: if you need to avoid any floating environment, even when
11948 a caption is provided.
11949 @end itemize
11950 @noindent
11951 To modify the placement option of any floating environment, set the
11952 @code{placement} attribute.
11954 @example
11955 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
11956 [[./img/hst.png]]
11957 @end example
11959 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
11960 the @LaTeX{} @code{\includegraphics} macro will be commented out.
11962 @subsubheading Plain lists in @LaTeX{} export
11963 @cindex plain lists, in @LaTeX{} export
11965 Plain lists accept two optional attributes: @code{:environment} and
11966 @code{:options}.  The first one allows the use of a non-standard environment
11967 (e.g., @samp{inparaenum}).  The second one specifies additional arguments for
11968 that environment.
11970 @example
11971 #+ATTR_LATEX: :environment compactitem :options [$\circ$]
11972 - you need ``paralist'' package to reproduce this example.
11973 @end example
11975 @subsubheading Source blocks in @LaTeX{} export
11976 @cindex source blocks, in @LaTeX{} export
11978 In addition to syntax defined in @ref{Literal examples}, names and captions
11979 (@pxref{Images and tables}), source blocks also accept two additional
11980 attributes: @code{:float} and @code{:options}.
11982 You may set the former to
11983 @itemize @minus
11984 @item
11985 @code{t}: if you want to make the source block a float.  It is the default
11986 value when a caption is provided.
11987 @item
11988 @code{multicolumn}: if you wish to include a source block which spans multiple
11989 columns in a page.
11990 @item
11991 @code{nil}: if you need to avoid any floating environment, even when a caption
11992 is provided.  It is useful for source code that may not fit in a single page.
11993 @end itemize
11995 @example
11996 #+ATTR_LATEX: :float nil
11997 #+BEGIN_SRC emacs-lisp
11998 Code that may not fit in a single page.
11999 #+END_SRC
12000 @end example
12002 @vindex org-latex-listings-options
12003 @vindex org-latex-minted-options
12004 The latter allows to specify options relative to the package used to
12005 highlight code in the output (e.g., @code{listings}).  This is the local
12006 counterpart to @code{org-latex-listings-options} and
12007 @code{org-latex-minted-options} variables, which see.
12009 @example
12010 #+ATTR_LATEX: :options commentstyle=\bfseries
12011 #+BEGIN_SRC emacs-lisp
12012   (defun Fib (n)                          ; Count rabbits.
12013     (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
12014 #+END_SRC
12015 @end example
12017 @subsubheading Special blocks in @LaTeX{} export
12018 @cindex special blocks, in @LaTeX{} export
12019 @cindex abstract, in @LaTeX{} export
12020 @cindex proof, in @LaTeX{} export
12022 In @LaTeX{} back-end, special blocks become environments of the same name.
12023 Value of @code{:options} attribute will be appended as-is to that
12024 environment's opening string.  For example:
12026 @example
12027 #+BEGIN_abstract
12028 We demonstrate how to solve the Syracuse problem.
12029 #+END_abstract
12031 #+ATTR_LATEX: :options [Proof of important theorem]
12032 #+BEGIN_proof
12034 Therefore, any even number greater than 2 is the sum of two primes.
12035 #+END_proof
12036 @end example
12038 @noindent
12039 becomes
12041 @example
12042 \begin@{abstract@}
12043 We demonstrate how to solve the Syracuse problem.
12044 \end@{abstract@}
12046 \begin@{proof@}[Proof of important theorem]
12048 Therefore, any even number greater than 2 is the sum of two primes.
12049 \end@{proof@}
12050 @end example
12052 If you need to insert a specific caption command, use @code{:caption}
12053 attribute.  It will override standard @code{#+CAPTION} value, if any.  For
12054 example:
12056 @example
12057 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
12058 #+BEGIN_proof
12060 #+END_proof
12061 @end example
12063 @subsubheading Horizontal rules
12064 @cindex horizontal rules, in @LaTeX{} export
12066 Width and thickness of a given horizontal rule can be controlled with,
12067 respectively, @code{:width} and @code{:thickness} attributes:
12069 @example
12070 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
12071 -----
12072 @end example
12074 @node Markdown export
12075 @section Markdown export
12076 @cindex Markdown export
12078 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
12079 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
12080 mode buffer.
12082 It is built over HTML back-end: any construct not supported by Markdown
12083 syntax (e.g., tables) will be controlled and translated by @code{html}
12084 back-end (@pxref{HTML export}).
12086 @subheading Markdown export commands
12088 @table @kbd
12089 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
12090 Export as a text file written in Markdown syntax.  For an Org file,
12091 @file{myfile.org}, the resulting file will be @file{myfile.md}.  The file
12092 will be overwritten without warning.
12093 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
12094 Export to a temporary buffer.  Do not create a file.
12095 @item C-c C-e m o
12096 Export as a text file with Markdown syntax, then open it.
12097 @end table
12099 @subheading Header and sectioning structure
12101 @vindex org-md-headline-style
12102 Markdown export can generate both @code{atx} and @code{setext} types for
12103 headlines, according to @code{org-md-headline-style}.  The former introduces
12104 a hard limit of two levels, whereas the latter pushes it to six.  Headlines
12105 below that limit are exported as lists.  You can also set a soft limit before
12106 that one (@pxref{Export settings}).
12108 @c begin opendocument
12110 @node OpenDocument Text export
12111 @section OpenDocument Text export
12112 @cindex ODT
12113 @cindex OpenDocument
12114 @cindex export, OpenDocument
12115 @cindex LibreOffice
12117 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
12118 (ODT) format.  Documents created by this exporter use the
12119 @cite{OpenDocument-v1.2
12120 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12121 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
12122 are compatible with LibreOffice 3.4.
12124 @menu
12125 * Pre-requisites for ODT export::  What packages ODT exporter relies on
12126 * ODT export commands::         How to invoke ODT export
12127 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
12128 * Applying custom styles::      How to apply custom styles to the output
12129 * Links in ODT export::         How links will be interpreted and formatted
12130 * Tables in ODT export::        How Tables are exported
12131 * Images in ODT export::        How to insert images
12132 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
12133 * Labels and captions in ODT export::  How captions are rendered
12134 * Literal examples in ODT export::  How source and example blocks are formatted
12135 * Advanced topics in ODT export::  Read this if you are a power user
12136 @end menu
12138 @node Pre-requisites for ODT export
12139 @subsection Pre-requisites for ODT export
12140 @cindex zip
12141 The ODT exporter relies on the @file{zip} program to create the final
12142 output.  Check the availability of this program before proceeding further.
12144 @node ODT export commands
12145 @subsection ODT export commands
12147 @subsubheading Exporting to ODT
12148 @anchor{x-export-to-odt}
12150 @cindex region, active
12151 @cindex active region
12152 @cindex transient-mark-mode
12153 @table @kbd
12154 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
12155 @cindex property EXPORT_FILE_NAME
12157 Export as OpenDocument Text file.
12159 @vindex org-odt-preferred-output-format
12160 If @code{org-odt-preferred-output-format} is specified, automatically convert
12161 the exported file to that format.  @xref{x-export-to-other-formats, ,
12162 Automatically exporting to other formats}.
12164 For an Org file @file{myfile.org}, the ODT file will be
12165 @file{myfile.odt}.  The file will be overwritten without warning.  If there
12166 is an active region,@footnote{This requires @code{transient-mark-mode} to be
12167 turned on} only the region will be exported.  If the selected region is a
12168 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
12169 tree head will become the document title.  If the tree head entry has, or
12170 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
12171 export.
12173 @kbd{C-c C-e o O}
12174 Export as an OpenDocument Text file and open the resulting file.
12176 @vindex org-odt-preferred-output-format
12177 If @code{org-odt-preferred-output-format} is specified, open the converted
12178 file instead.  @xref{x-export-to-other-formats, , Automatically exporting to
12179 other formats}.
12180 @end table
12182 @node Extending ODT export
12183 @subsection Extending ODT export
12185 The ODT exporter can interface with a variety of document
12186 converters and supports popular converters out of the box.  As a result, you
12187 can use it to export to formats like @samp{doc} or convert a document from
12188 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
12190 @cindex @file{unoconv}
12191 @cindex LibreOffice
12192 If you have a working installation of LibreOffice, a document converter is
12193 pre-configured for you and you can use it right away.  If you would like to
12194 use @file{unoconv} as your preferred converter, customize the variable
12195 @code{org-odt-convert-process} to point to @code{unoconv}.  You can
12196 also use your own favorite converter or tweak the default settings of the
12197 @file{LibreOffice} and @samp{unoconv} converters.  @xref{Configuring a
12198 document converter}.
12200 @subsubheading Automatically exporting to other formats
12201 @anchor{x-export-to-other-formats}
12203 @vindex org-odt-preferred-output-format
12204 Very often, you will find yourself exporting to ODT format, only to
12205 immediately save the exported document to other formats like @samp{doc},
12206 @samp{docx}, @samp{rtf}, @samp{pdf} etc.  In such cases, you can specify your
12207 preferred output format by customizing the variable
12208 @code{org-odt-preferred-output-format}.  This way, the export commands
12209 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12210 format that is of immediate interest to you.
12212 @subsubheading Converting between document formats
12213 @anchor{x-convert-to-other-formats}
12215 There are many document converters in the wild which support conversion to
12216 and from various file formats, including, but not limited to the
12217 ODT format.  LibreOffice converter, mentioned above, is one such
12218 converter.  Once a converter is configured, you can interact with it using
12219 the following command.
12221 @vindex org-odt-convert
12222 @table @kbd
12224 @item M-x org-odt-convert RET
12225 Convert an existing document from one format to another.  With a prefix
12226 argument, also open the newly produced file.
12227 @end table
12229 @node Applying custom styles
12230 @subsection Applying custom styles
12231 @cindex styles, custom
12232 @cindex template, custom
12234 The ODT exporter ships with a set of OpenDocument styles
12235 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12236 output.  These factory styles, however, may not cater to your specific
12237 tastes.  To customize the output, you can either modify the above styles
12238 files directly, or generate the required styles using an application like
12239 LibreOffice.  The latter method is suitable for expert and non-expert
12240 users alike, and is described here.
12242 @subsubheading Applying custom styles: the easy way
12244 @enumerate
12245 @item
12246 Create a sample @file{example.org} file with the below settings and export it
12247 to ODT format.
12249 @example
12250 #+OPTIONS: H:10 num:t
12251 @end example
12253 @item
12254 Open the above @file{example.odt} using LibreOffice.  Use the @file{Stylist}
12255 to locate the target styles---these typically have the @samp{Org} prefix---and
12256 modify those to your taste.  Save the modified file either as an
12257 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12259 @item
12260 @cindex #+ODT_STYLES_FILE
12261 @vindex org-odt-styles-file
12262 Customize the variable @code{org-odt-styles-file} and point it to the
12263 newly created file.  For additional configuration options
12264 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12266 If you would like to choose a style on a per-file basis, you can use the
12267 @code{#+ODT_STYLES_FILE} option.  A typical setting will look like
12269 @example
12270 #+ODT_STYLES_FILE: "/path/to/example.ott"
12271 @end example
12275 @example
12276 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12277 @end example
12279 @end enumerate
12281 @subsubheading Using third-party styles and templates
12283 You can use third-party styles and templates for customizing your output.
12284 This will produce the desired output only if the template provides all
12285 style names that the @samp{ODT} exporter relies on.  Unless this condition is
12286 met, the output is going to be less than satisfactory.  So it is highly
12287 recommended that you only work with templates that are directly derived from
12288 the factory settings.
12290 @node Links in ODT export
12291 @subsection Links in ODT export
12292 @cindex links, in ODT export
12294 ODT exporter creates native cross-references for internal links.  It creates
12295 Internet-style links for all other links.
12297 A link with no description and destined to a regular (un-itemized) outline
12298 heading is replaced with a cross-reference and section number of the heading.
12300 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
12301 with a cross-reference and sequence number of the labeled entity.
12302 @xref{Labels and captions in ODT export}.
12304 @node Tables in ODT export
12305 @subsection Tables in ODT export
12306 @cindex tables, in ODT export
12308 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12309 tables is supported.  However, export of complex @file{table.el} tables---tables
12310 that have column or row spans---is not supported.  Such tables are
12311 stripped from the exported document.
12313 By default, a table is exported with top and bottom frames and with rules
12314 separating row and column groups (@pxref{Column groups}).  Furthermore, all
12315 tables are typeset to occupy the same width.  If the table specifies
12316 alignment and relative width for its columns (@pxref{Column width and
12317 alignment}) then these are honored on export.@footnote{The column widths are
12318 interpreted as weighted ratios with the default weight being 1}
12320 @cindex #+ATTR_ODT
12321 You can control the width of the table by specifying @code{:rel-width}
12322 property using an @code{#+ATTR_ODT} line.
12324 For example, consider the following table which makes use of all the rules
12325 mentioned above.
12327 @example
12328 #+ATTR_ODT: :rel-width 50
12329 | Area/Month    |   Jan |   Feb |   Mar |   Sum |
12330 |---------------+-------+-------+-------+-------|
12331 | /             |     < |       |       |     < |
12332 | <l13>         |  <r5> |  <r5> |  <r5> |  <r6> |
12333 | North America |     1 |    21 |   926 |   948 |
12334 | Middle East   |     6 |    75 |   844 |   925 |
12335 | Asia Pacific  |     9 |    27 |   790 |   826 |
12336 |---------------+-------+-------+-------+-------|
12337 | Sum           |    16 |   123 |  2560 |  2699 |
12338 @end example
12340 On export, the table will occupy 50% of text area.  The columns will be sized
12341 (roughly) in the ratio of 13:5:5:5:6.  The first column will be left-aligned
12342 and rest of the columns will be right-aligned.  There will be vertical rules
12343 after separating the header and last columns from other columns.  There will
12344 be horizontal rules separating the header and last rows from other rows.
12346 If you are not satisfied with the above formatting options, you can create
12347 custom table styles and associate them with a table using the
12348 @code{#+ATTR_ODT} line.  @xref{Customizing tables in ODT export}.
12350 @node Images in ODT export
12351 @subsection Images in ODT export
12352 @cindex images, embedding in ODT
12353 @cindex embedding images in ODT
12355 @subsubheading Embedding images
12356 You can embed images within the exported document by providing a link to the
12357 desired image file with no link description.  For example, to embed
12358 @samp{img.png} do either of the following:
12360 @example
12361 [[file:img.png]]
12362 @end example
12364 @example
12365 [[./img.png]]
12366 @end example
12368 @subsubheading Embedding clickable images
12369 You can create clickable images by providing a link whose description is a
12370 link to an image file.  For example, to embed a image
12371 @file{org-mode-unicorn.png} which when clicked jumps to
12372 @uref{http://Orgmode.org} website, do the following
12374 @example
12375 [[http://orgmode.org][./org-mode-unicorn.png]]
12376 @end example
12378 @subsubheading Sizing and scaling of embedded images
12380 @cindex #+ATTR_ODT
12381 You can control the size and scale of the embedded images using the
12382 @code{#+ATTR_ODT} attribute.
12384 @cindex identify, ImageMagick
12385 @vindex org-odt-pixels-per-inch
12386 The exporter specifies the desired size of the image in the final document in
12387 units of centimeters.  In order to scale the embedded images, the exporter
12388 queries for pixel dimensions of the images using one of a) ImageMagick's
12389 @file{identify} program or b) Emacs `create-image' and `image-size'
12390 APIs@footnote{Use of @file{ImageMagick} is only desirable.  However, if you
12391 routinely produce documents that have large images or you export your Org
12392 files that has images using a Emacs batch script, then the use of
12393 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12394 converted in to units of centimeters using
12395 @code{org-odt-pixels-per-inch}.  The default value of this variable is
12396 set to @code{display-pixels-per-inch}.  You can tweak this variable to
12397 achieve the best results.
12399 The examples below illustrate the various possibilities.
12401 @table @asis
12402 @item Explicitly size the image
12403 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12405 @example
12406 #+ATTR_ODT: :width 10 :height 10
12407 [[./img.png]]
12408 @end example
12410 @item Scale the image
12411 To embed @file{img.png} at half its size, do the following:
12413 @example
12414 #+ATTR_ODT: :scale 0.5
12415 [[./img.png]]
12416 @end example
12418 @item Scale the image to a specific width
12419 To embed @file{img.png} with a width of 10 cm while retaining the original
12420 height:width ratio, do the following:
12422 @example
12423 #+ATTR_ODT: :width 10
12424 [[./img.png]]
12425 @end example
12427 @item Scale the image to a specific height
12428 To embed @file{img.png} with a height of 10 cm while retaining the original
12429 height:width ratio, do the following
12431 @example
12432 #+ATTR_ODT: :height 10
12433 [[./img.png]]
12434 @end example
12435 @end table
12437 @subsubheading Anchoring of images
12439 @cindex #+ATTR_ODT
12440 You can control the manner in which an image is anchored by setting the
12441 @code{:anchor} property of it's @code{#+ATTR_ODT} line.  You can specify one
12442 of the following three values for the @code{:anchor} property:
12443 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12445 To create an image that is anchored to a page, do the following:
12446 @example
12447 #+ATTR_ODT: :anchor "page"
12448 [[./img.png]]
12449 @end example
12451 @node Math formatting in ODT export
12452 @subsection Math formatting in ODT export
12454 The ODT exporter has special support for handling math.
12456 @menu
12457 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
12458 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
12459 @end menu
12461 @node Working with @LaTeX{} math snippets
12462 @subsubheading Working with @LaTeX{} math snippets
12464 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12465 document in one of the following ways:
12467 @cindex MathML
12468 @enumerate
12469 @item MathML
12471 This option is activated on a per-file basis with
12473 @example
12474 #+OPTIONS: LaTeX:t
12475 @end example
12477 With this option, @LaTeX{} fragments are first converted into MathML
12478 fragments using an external @LaTeX{}-to-MathML converter program.  The
12479 resulting MathML fragments are then embedded as an OpenDocument Formula in
12480 the exported document.
12482 @vindex org-latex-to-mathml-convert-command
12483 @vindex org-latex-to-mathml-jar-file
12485 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12486 @code{org-latex-to-mathml-convert-command} and
12487 @code{org-latex-to-mathml-jar-file}.
12489 To use MathToWeb@footnote{See
12490 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}.} as your
12491 converter, you can configure the above variables as
12493 @lisp
12494 (setq org-latex-to-mathml-convert-command
12495       "java -jar %j -unicode -force -df %o %I"
12496       org-latex-to-mathml-jar-file
12497       "/path/to/mathtoweb.jar")
12498 @end lisp
12499 To use @LaTeX{}ML@footnote{See @uref{http://dlmf.nist.gov/LaTeXML/}.} use
12500 @lisp
12501 (setq org-latex-to-mathml-convert-command
12502       "latexmlmath \"%i\" --presentationmathml=%o")
12503 @end lisp
12505 You can use the following commands to quickly verify the reliability of
12506 the @LaTeX{}-to-MathML converter.
12508 @table @kbd
12509 @item M-x org-odt-export-as-odf RET
12510 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12512 @item M-x org-odt-export-as-odf-and-open RET
12513 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12514 and open the formula file with the system-registered application.
12515 @end table
12517 @cindex dvipng
12518 @cindex imagemagick
12519 @item PNG images
12521 This option is activated on a per-file basis with
12523 @example
12524 #+OPTIONS: tex:dvipng
12525 @end example
12529 @example
12530 #+OPTIONS: tex:imagemagick
12531 @end example
12533 With this option, @LaTeX{} fragments are processed into PNG images and the
12534 resulting images are embedded in the exported document.  This method requires
12535 that the @file{dvipng} program or @file{imagemagick} suite be available on
12536 your system.
12537 @end enumerate
12539 @node Working with MathML or OpenDocument formula files
12540 @subsubheading Working with MathML or OpenDocument formula files
12542 For various reasons, you may find embedding @LaTeX{} math snippets in an
12543 ODT document less than reliable.  In that case, you can embed a
12544 math equation by linking to its MathML (@file{.mml}) source or its
12545 OpenDocument formula (@file{.odf}) file as shown below:
12547 @example
12548 [[./equation.mml]]
12549 @end example
12553 @example
12554 [[./equation.odf]]
12555 @end example
12557 @node Labels and captions in ODT export
12558 @subsection Labels and captions in ODT export
12560 You can label and caption various category of objects---an inline image, a
12561 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12562 @code{#+CAPTION} lines.  @xref{Images and tables}.  ODT exporter enumerates
12563 each labeled or captioned object of a given category separately.  As a
12564 result, each such object is assigned a sequence number based on order of it's
12565 appearance in the Org file.
12567 In the exported document, a user-provided caption is augmented with the
12568 category and sequence number.  Consider the following inline image in an Org
12569 file.
12571 @example
12572 #+CAPTION: Bell curve
12573 #+LABEL:   fig:SED-HR4049
12574 [[./img/a.png]]
12575 @end example
12577 It could be rendered as shown below in the exported document.
12579 @example
12580 Figure 2: Bell curve
12581 @end example
12583 @vindex org-odt-category-map-alist
12584 You can modify the category component of the caption by customizing the
12585 option @code{org-odt-category-map-alist}.  For example, to tag all embedded
12586 images with the string @samp{Illustration} (instead of the default
12587 @samp{Figure}) use the following setting:
12589 @lisp
12590 (setq org-odt-category-map-alist
12591       (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12592 @end lisp
12594 With this, previous image will be captioned as below in the exported
12595 document.
12597 @example
12598 Illustration 2: Bell curve
12599 @end example
12601 @node Literal examples in ODT export
12602 @subsection Literal examples in ODT export
12604 Export of literal examples (@pxref{Literal examples}) with full fontification
12605 is supported.  Internally, the exporter relies on @file{htmlfontify.el} to
12606 generate all style definitions needed for a fancy listing.@footnote{Your
12607 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
12608 fontification to be turned on.}  The auto-generated styles have @samp{OrgSrc}
12609 as prefix and inherit their color from the faces used by Emacs
12610 @code{font-lock} library for the source language.
12612 @vindex org-odt-fontify-srcblocks
12613 If you prefer to use your own custom styles for fontification, you can do
12614 so by customizing the option
12615 @code{org-odt-create-custom-styles-for-srcblocks}.
12617 @vindex org-odt-create-custom-styles-for-srcblocks
12618 You can turn off fontification of literal examples by customizing the
12619 option @code{org-odt-fontify-srcblocks}.
12621 @node Advanced topics in ODT export
12622 @subsection Advanced topics in ODT export
12624 If you rely heavily on ODT export, you may want to exploit the full
12625 set of features that the exporter offers.  This section describes features
12626 that would be of interest to power users.
12628 @menu
12629 * Configuring a document converter::  How to register a document converter
12630 * Working with OpenDocument style files::  Explore the internals
12631 * Creating one-off styles::     How to produce custom highlighting etc
12632 * Customizing tables in ODT export::  How to define and use Table templates
12633 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
12634 @end menu
12636 @node Configuring a document converter
12637 @subsubheading Configuring a document converter
12638 @cindex convert
12639 @cindex doc, docx, rtf
12640 @cindex converter
12642 The ODT exporter can work with popular converters with little or no
12643 extra configuration from your side. @xref{Extending ODT export}.
12644 If you are using a converter that is not supported by default or if you would
12645 like to tweak the default converter settings, proceed as below.
12647 @enumerate
12648 @item Register the converter
12650 @vindex org-odt-convert-processes
12651 Name your converter and add it to the list of known converters by
12652 customizing the option @code{org-odt-convert-processes}.  Also specify how
12653 the converter can be invoked via command-line to effect the conversion.
12655 @item Configure its capabilities
12657 @vindex org-odt-convert-capabilities
12658 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12659 converter can handle by customizing the variable
12660 @code{org-odt-convert-capabilities}.  Use the default value for this
12661 variable as a guide for configuring your converter.  As suggested by the
12662 default setting, you can specify the full set of formats supported by the
12663 converter and not limit yourself to specifying formats that are related to
12664 just the OpenDocument Text format.
12666 @item Choose the converter
12668 @vindex org-odt-convert-process
12669 Select the newly added converter as the preferred one by customizing the
12670 option @code{org-odt-convert-process}.
12671 @end enumerate
12673 @node Working with OpenDocument style files
12674 @subsubheading Working with OpenDocument style files
12675 @cindex styles, custom
12676 @cindex template, custom
12678 This section explores the internals of the ODT exporter and the
12679 means by which it produces styled documents.  Read this section if you are
12680 interested in exploring the automatic and custom OpenDocument styles used by
12681 the exporter.
12683 @anchor{x-factory-styles}
12684 @subsubheading a) Factory styles
12686 The ODT exporter relies on two files for generating its output.
12687 These files are bundled with the distribution under the directory pointed to
12688 by the variable @code{org-odt-styles-dir}.  The two files are:
12690 @itemize
12691 @anchor{x-orgodtstyles-xml}
12692 @item
12693 @file{OrgOdtStyles.xml}
12695 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12696 document.  This file gets modified for the following purposes:
12697 @enumerate
12699 @item
12700 To control outline numbering based on user settings.
12702 @item
12703 To add styles generated by @file{htmlfontify.el} for fontification of code
12704 blocks.
12705 @end enumerate
12707 @anchor{x-orgodtcontenttemplate-xml}
12708 @item
12709 @file{OrgOdtContentTemplate.xml}
12711 This file contributes to the @file{content.xml} file of the final @samp{ODT}
12712 document.  The contents of the Org outline are inserted between the
12713 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
12715 Apart from serving as a template file for the final @file{content.xml}, the
12716 file serves the following purposes:
12717 @enumerate
12719 @item
12720 It contains automatic styles for formatting of tables which are referenced by
12721 the exporter.
12723 @item
12724 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
12725 elements that control how various entities---tables, images, equations,
12726 etc.---are numbered.
12727 @end enumerate
12728 @end itemize
12730 @anchor{x-overriding-factory-styles}
12731 @subsubheading b) Overriding factory styles
12732 The following two variables control the location from which the ODT
12733 exporter picks up the custom styles and content template files.  You can
12734 customize these variables to override the factory styles used by the
12735 exporter.
12737 @itemize
12738 @anchor{x-org-odt-styles-file}
12739 @item
12740 @code{org-odt-styles-file}
12742 Use this variable to specify the @file{styles.xml} that will be used in the
12743 final output.  You can specify one of the following values:
12745 @enumerate
12746 @item A @file{styles.xml} file
12748 Use this file instead of the default @file{styles.xml}
12750 @item A @file{.odt} or @file{.ott} file
12752 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12753 Template file
12755 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
12757 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12758 Template file.  Additionally extract the specified member files and embed
12759 those within the final @samp{ODT} document.
12761 Use this option if the @file{styles.xml} file references additional files
12762 like header and footer images.
12764 @item @code{nil}
12766 Use the default @file{styles.xml}
12767 @end enumerate
12769 @anchor{x-org-odt-content-template-file}
12770 @item
12771 @code{org-odt-content-template-file}
12773 Use this variable to specify the blank @file{content.xml} that will be used
12774 in the final output.
12775 @end itemize
12777 @node Creating one-off styles
12778 @subsubheading Creating one-off styles
12780 There are times when you would want one-off formatting in the exported
12781 document.  You can achieve this by embedding raw OpenDocument XML in the Org
12782 file.  The use of this feature is better illustrated with couple of examples.
12784 @enumerate
12785 @item Embedding ODT tags as part of regular text
12787 You can inline OpenDocument syntax by enclosing it within
12788 @samp{@@@@odt:...@@@@} markup.  For example, to highlight a region of text do
12789 the following:
12791 @example
12792 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
12793 text</text:span>@@@@.  But this is a regular text.
12794 @end example
12796 @strong{Hint:} To see the above example in action, edit your
12797 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12798 custom @samp{Highlight} style as shown below.
12800 @example
12801 <style:style style:name="Highlight" style:family="text">
12802   <style:text-properties fo:background-color="#ff0000"/>
12803 </style:style>
12804 @end example
12806 @item Embedding a one-line OpenDocument XML
12808 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
12809 directive.  For example, to force a page break do the following:
12811 @example
12812 #+ODT: <text:p text:style-name="PageBreak"/>
12813 @end example
12815 @strong{Hint:} To see the above example in action, edit your
12816 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12817 custom @samp{PageBreak} style as shown below.
12819 @example
12820 <style:style style:name="PageBreak" style:family="paragraph"
12821              style:parent-style-name="Text_20_body">
12822   <style:paragraph-properties fo:break-before="page"/>
12823 </style:style>
12824 @end example
12826 @item Embedding a block of OpenDocument XML
12828 You can add a large block of OpenDocument XML using the
12829 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
12831 For example, to create a one-off paragraph that uses bold text, do the
12832 following:
12834 @example
12835 #+BEGIN_ODT
12836 <text:p text:style-name="Text_20_body_20_bold">
12837 This paragraph is specially formatted and uses bold text.
12838 </text:p>
12839 #+END_ODT
12840 @end example
12842 @end enumerate
12844 @node Customizing tables in ODT export
12845 @subsubheading Customizing tables in ODT export
12846 @cindex tables, in ODT export
12848 @cindex #+ATTR_ODT
12849 You can override the default formatting of the table by specifying a custom
12850 table style with the @code{#+ATTR_ODT} line.  For a discussion on default
12851 formatting of tables @pxref{Tables in ODT export}.
12853 This feature closely mimics the way table templates are defined in the
12854 OpenDocument-v1.2
12855 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12856 OpenDocument-v1.2 Specification}}
12858 @vindex org-odt-table-styles
12859 To have a quick preview of this feature, install the below setting and
12860 export the table that follows:
12862 @lisp
12863 (setq org-odt-table-styles
12864       (append org-odt-table-styles
12865             '(("TableWithHeaderRowAndColumn" "Custom"
12866                 ((use-first-row-styles . t)
12867                  (use-first-column-styles . t)))
12868                 ("TableWithFirstRowandLastRow" "Custom"
12869                  ((use-first-row-styles . t)
12870                  (use-last-row-styles . t))))))
12871 @end lisp
12873 @example
12874 #+ATTR_ODT: :style TableWithHeaderRowAndColumn
12875 | Name  | Phone | Age |
12876 | Peter |  1234 |  17 |
12877 | Anna  |  4321 |  25 |
12878 @end example
12880 In the above example, you used a template named @samp{Custom} and installed
12881 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12882 @samp{TableWithFirstRowandLastRow}.  (@strong{Important:} The OpenDocument
12883 styles needed for producing the above template have been pre-defined for
12884 you.  These styles are available under the section marked @samp{Custom
12885 Table Template} in @file{OrgOdtContentTemplate.xml}
12886 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}).  If you need
12887 additional templates you have to define these styles yourselves.
12889 To use this feature proceed as follows:
12891 @enumerate
12892 @item
12893 Create a table template@footnote{See the @code{<table:table-template>}
12894 element of the OpenDocument-v1.2 specification}
12896 A table template is nothing but a set of @samp{table-cell} and
12897 @samp{paragraph} styles for each of the following table cell categories:
12899 @itemize @minus
12900 @item Body
12901 @item First column
12902 @item Last column
12903 @item First row
12904 @item Last row
12905 @item Even row
12906 @item Odd row
12907 @item Even column
12908 @item Odd Column
12909 @end itemize
12911 The names for the above styles must be chosen based on the name of the table
12912 template using a well-defined convention.
12914 The naming convention is better illustrated with an example.  For a table
12915 template with the name @samp{Custom}, the needed style names are listed in
12916 the following table.
12918 @multitable  {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12919 @headitem Table cell type
12920 @tab @code{table-cell} style
12921 @tab @code{paragraph} style
12922 @item
12923 @tab
12924 @tab
12925 @item Body
12926 @tab @samp{CustomTableCell}
12927 @tab @samp{CustomTableParagraph}
12928 @item First column
12929 @tab @samp{CustomFirstColumnTableCell}
12930 @tab @samp{CustomFirstColumnTableParagraph}
12931 @item Last column
12932 @tab @samp{CustomLastColumnTableCell}
12933 @tab @samp{CustomLastColumnTableParagraph}
12934 @item First row
12935 @tab @samp{CustomFirstRowTableCell}
12936 @tab @samp{CustomFirstRowTableParagraph}
12937 @item Last row
12938 @tab @samp{CustomLastRowTableCell}
12939 @tab @samp{CustomLastRowTableParagraph}
12940 @item Even row
12941 @tab @samp{CustomEvenRowTableCell}
12942 @tab @samp{CustomEvenRowTableParagraph}
12943 @item Odd row
12944 @tab @samp{CustomOddRowTableCell}
12945 @tab @samp{CustomOddRowTableParagraph}
12946 @item Even column
12947 @tab @samp{CustomEvenColumnTableCell}
12948 @tab @samp{CustomEvenColumnTableParagraph}
12949 @item Odd column
12950 @tab @samp{CustomOddColumnTableCell}
12951 @tab @samp{CustomOddColumnTableParagraph}
12952 @end multitable
12954 To create a table template with the name @samp{Custom}, define the above
12955 styles in the
12956 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
12957 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
12958 styles}).
12960 @item
12961 Define a table style@footnote{See the attributes @code{table:template-name},
12962 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
12963 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
12964 @code{table:use-banding-rows-styles}, and
12965 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
12966 the OpenDocument-v1.2 specification}
12968 @vindex org-odt-table-styles
12969 To define a table style, create an entry for the style in the variable
12970 @code{org-odt-table-styles} and specify the following:
12972 @itemize @minus
12973 @item the name of the table template created in step (1)
12974 @item the set of cell styles in that template that are to be activated
12975 @end itemize
12977 For example, the entry below defines two different table styles
12978 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
12979 based on the same template @samp{Custom}.  The styles achieve their intended
12980 effect by selectively activating the individual cell styles in that template.
12982 @lisp
12983 (setq org-odt-table-styles
12984       (append org-odt-table-styles
12985               '(("TableWithHeaderRowAndColumn" "Custom"
12986                  ((use-first-row-styles . t)
12987                   (use-first-column-styles . t)))
12988                 ("TableWithFirstRowandLastRow" "Custom"
12989                  ((use-first-row-styles . t)
12990                   (use-last-row-styles . t))))))
12991 @end lisp
12993 @item
12994 Associate a table with the table style
12996 To do this, specify the table style created in step (2) as part of
12997 the @code{ATTR_ODT} line as shown below.
12999 @example
13000 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
13001 | Name  | Phone | Age |
13002 | Peter |  1234 |  17 |
13003 | Anna  |  4321 |  25 |
13004 @end example
13005 @end enumerate
13007 @node Validating OpenDocument XML
13008 @subsubheading Validating OpenDocument XML
13010 Occasionally, you will discover that the document created by the
13011 ODT exporter cannot be opened by your favorite application.  One of
13012 the common reasons for this is that the @file{.odt} file is corrupt.  In such
13013 cases, you may want to validate the document against the OpenDocument RELAX
13014 NG Compact Syntax (RNC) schema.
13016 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
13017 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}.  For
13018 general help with validation (and schema-sensitive editing) of XML files:
13019 @inforef{Introduction,,nxml-mode}.
13021 @vindex org-odt-schema-dir
13022 If you have ready access to OpenDocument @file{.rnc} files and the needed
13023 schema-locating rules in a single folder, you can customize the variable
13024 @code{org-odt-schema-dir} to point to that directory.  The ODT exporter
13025 will take care of updating the @code{rng-schema-locating-files} for you.
13027 @c end opendocument
13029 @node Org export
13030 @section Org export
13031 @cindex Org export
13033 @code{org} export back-end creates a normalized version of the Org document
13034 in current buffer.  In particular, it evaluates Babel code (@pxref{Evaluating
13035 code blocks}) and removes other back-ends specific contents.
13037 @subheading Org export commands
13039 @table @kbd
13040 @orgcmd{C-c C-e O o,org-org-export-to-org}
13041 Export as an Org document.  For an Org file, @file{myfile.org}, the resulting
13042 file will be @file{myfile.org.org}.  The file will be overwritten without
13043 warning.
13044 @orgcmd{C-c C-e O O,org-org-export-as-org}
13045 Export to a temporary buffer.  Do not create a file.
13046 @item C-c C-e O v
13047 Export to an Org file, then open it.
13048 @end table
13050 @node Texinfo export
13051 @section Texinfo export
13052 @cindex Texinfo export
13054 @samp{texinfo} export back-end generates Texinfo code and can compile it into
13055 an Info file.
13057 @menu
13058 * Texinfo export commands::     How to invoke Texinfo export
13059 * Document preamble::           File header, title and copyright page
13060 * Headings and sectioning structure:: Building document structure
13061 * Indices::                     Creating indices
13062 * Quoting Texinfo code::        Incorporating literal Texinfo code
13063 * Texinfo specific attributes:: Controlling Texinfo output
13064 * An example::
13065 @end menu
13067 @node Texinfo export commands
13068 @subsection Texinfo export commands
13070 @vindex org-texinfo-info-process
13071 @table @kbd
13072 @orgcmd{C-c C-e i t,org-texinfo-export-to-texinfo}
13073 Export as a Texinfo file.  For an Org file, @file{myfile.org}, the resulting
13074 file will be @file{myfile.texi}.  The file will be overwritten without
13075 warning.
13076 @orgcmd{C-c C-e i i,org-texinfo-export-to-info}
13077 Export to Texinfo and then process to an Info file@footnote{By setting
13078 @code{org-texinfo-info-process}, it is possible to generate other formats,
13079 including DocBook.}.
13080 @end table
13082 @node Document preamble
13083 @subsection Document preamble
13085 When processing a document, @samp{texinfo} back-end generates a minimal file
13086 header along with a title page, a copyright page, and a menu.  You control
13087 the latter through the structure of the document (@pxref{Headings and
13088 sectioning structure}).  Various keywords allow to tweak the other parts.  It
13089 is also possible to give directions to install the document in the @samp{Top}
13090 node.
13092 @subsubheading File header
13094 @cindex #+TEXINFO_FILENAME
13095 Upon creating the header of a Texinfo file, the back-end guesses a name for
13096 the Info file to be compiled.  This may not be a sensible choice, e.g., if
13097 you want to produce the final document in a different directory.  Specify an
13098 alternate path with @code{#+TEXINFO_FILENAME} keyword to override the default
13099 destination.
13101 @vindex org-texinfo-coding-system
13102 @vindex org-texinfo-classes
13103 @cindex #+TEXINFO_HEADER
13104 @cindex #+TEXINFO_CLASS
13105 Along with the output file name, the header contains information about the
13106 language (@pxref{Export settings}) and current encoding used@footnote{See
13107 @code{org-texinfo-coding-system} for more information.}.  Insert
13108 a @code{#+TEXINFO_HEADER} keyword for each additional command needed, e.g.,
13109 @@code@{@@synindex@}.
13111 If you happen to regularly install the same set of commands, it may be easier
13112 to define your own class in @code{org-texinfo-classes}, which see.  Set
13113 @code{#+TEXINFO_CLASS} keyword accordingly in your document to activate it.
13115 @subsubheading Title and copyright page
13117 @cindex #+TEXINFO_PRINTED_TITLE
13118 @cindex #+SUBTITLE
13119 The default template includes a title page for hard copy output.  The title
13120 and author displayed on this page are extracted from, respectively,
13121 @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}).  It is
13122 also possible to print a different, more specific, title with
13123 @code{#+TEXINFO_PRINTED_TITLE} keyword, and add subtitles with
13124 @code{#+SUBTITLE} keyword.  Both expect raw Texinfo code in their value.
13126 @cindex #+SUBAUTHOR
13127 Likewise, information brought by @code{#+AUTHOR} may not be enough.  You can
13128 include other authors with several @code{#+SUBAUTHOR} keywords.  Values are
13129 also expected to be written in Texinfo code.
13131 @example
13132 #+AUTHOR: Jane Smith
13133 #+SUBAUTHOR: John Doe
13134 #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@}
13135 @end example
13137 @cindex property, COPYING
13138 Copying material is defined in a dedicated headline with a non-@code{nil}
13139 @code{:COPYING:} property.  The contents are inserted within
13140 a @code{@@copying} command at the beginning of the document whereas the
13141 heading itself does not appear in the structure of the document.
13143 Copyright information is printed on the back of the title page.
13145 @example
13146 * Copying
13147   :PROPERTIES:
13148   :COPYING: t
13149   :END:
13151   This is a short example of a complete Texinfo file, version 1.0.
13153   Copyright \copy 2014 Free Software Foundation, Inc.
13154 @end example
13156 @subsubheading The Top node
13158 @cindex #+TEXINFO_DIR_CATEGORY
13159 @cindex #+TEXINFO_DIR_TITLE
13160 @cindex #+TEXINFO_DIR_DESC
13161 You may ultimately want to install your new Info file in your system.  You
13162 can write an appropriate entry in the top level directory specifying its
13163 category and title with, respectively, @code{#+TEXINFO_DIR_CATEGORY} and
13164 @code{#+TEXINFO_DIR_TITLE}.  Optionally, you can add a short description
13165 using @code{#+TEXINFO_DIR_DESC}.  The following example would write an entry
13166 similar to Org's in the @samp{Top} node.
13168 @example
13169 #+TEXINFO_DIR_CATEGORY: Emacs
13170 #+TEXINFO_DIR_TITLE: Org Mode: (org)
13171 #+TEXINFO_DIR_DESC: Outline-based notes management and organizer
13172 @end example
13174 @node Headings and sectioning structure
13175 @subsection Headings and sectioning structure
13177 @vindex org-texinfo-classes
13178 @vindex org-texinfo-default-class
13179 @cindex #+TEXINFO_CLASS
13180 @samp{texinfo} uses a pre-defined scheme, or class, to convert headlines into
13181 Texinfo structuring commands.  For example, a top level headline appears as
13182 @code{@@chapter} if it should be numbered or as @code{@@unnumbered}
13183 otherwise.  If you need to use a different set of commands, e.g., to start
13184 with @code{@@part} instead of @code{@@chapter}, install a new class in
13185 @code{org-texinfo-classes}, then activate it with @code{#+TEXINFO_CLASS}
13186 keyword.  Export process defaults to @code{org-texinfo-default-class} when
13187 there is no such keyword in the document.
13189 If a headline's level has no associated structuring command, or is below
13190 a certain threshold (@pxref{Export settings}), that headline becomes a list
13191 in Texinfo output.
13193 @cindex property, APPENDIX
13194 As an exception, a headline with a non-@code{nil} @code{:APPENDIX:} property becomes
13195 an appendix, independently on its level and the class used.
13197 @cindex property, DESCRIPTION
13198 Each regular sectioning structure creates a menu entry, named after the
13199 heading.  You can provide a different, e.g., shorter, title in
13200 @code{:ALT_TITLE:} property (@pxref{Table of contents}).  Optionally, you can
13201 specify a description for the item in @code{:DESCRIPTION:} property.  E.g.,
13203 @example
13204 * Controlling Screen Display
13205   :PROPERTIES:
13206   :ALT_TITLE: Display
13207   :DESCRIPTION: Controlling Screen Display
13208   :END:
13209 @end example
13211 @node Indices
13212 @subsection Indices
13214 @cindex #+CINDEX
13215 @cindex #+FINDEX
13216 @cindex #+KINDEX
13217 @cindex #+PINDEX
13218 @cindex #+TINDEX
13219 @cindex #+VINDEX
13220 Index entries are created using dedicated keywords.  @samp{texinfo} back-end
13221 provides one for each predefined type: @code{#+CINDEX}, @code{#+FINDEX},
13222 @code{#+KINDEX}, @code{#+PINDEX}, @code{#+TINDEX} and @code{#+VINDEX}.  For
13223 custom indices, you can write raw Texinfo code (@pxref{Quoting Texinfo
13224 code}).
13226 @example
13227 #+CINDEX: Defining indexing entries
13228 @end example
13230 @cindex property, INDEX
13231 To generate an index, you need to set the @code{:INDEX:} property of
13232 a headline to an appropriate abbreviation (e.g., @samp{cp} or @samp{vr}).
13233 The headline is then exported as an unnumbered chapter or section command and
13234 the index is inserted after its contents.
13236 @example
13237 * Concept Index
13238   :PROPERTIES:
13239   :INDEX: cp
13240   :END:
13241 @end example
13243 @node Quoting Texinfo code
13244 @subsection Quoting Texinfo code
13246 It is possible to insert raw Texinfo code using any of the following
13247 constructs
13249 @cindex #+TEXINFO
13250 @cindex #+BEGIN_TEXINFO
13251 @example
13252 Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU.
13254 #+TEXINFO: @@need800
13255 This paragraph is preceded by...
13257 #+BEGIN_TEXINFO
13258 @@auindex Johnson, Mark
13259 @@auindex Lakoff, George
13260 #+END_TEXINFO
13261 @end example
13263 @node Texinfo specific attributes
13264 @subsection Texinfo specific attributes
13266 @cindex #+ATTR_TEXINFO
13267 @samp{texinfo} back-end understands several attributes in plain lists and
13268 tables.  They must be specified using an @code{#+ATTR_TEXINFO} keyword,
13269 written just above the list or table.
13271 @subsubheading Plain lists
13273 In Texinfo output, description lists appear as two-column tables, using the
13274 default command @code{@@table}.  You can use @code{@@ftable} or
13275 @code{@@vtable}@footnote{For more information, @inforef{Two-column
13276 Tables,,texinfo}.} instead with @code{:table-type} attribute.
13278 @vindex org-texinfo-def-table-markup
13279 In any case, these constructs require a highlighting command for entries in
13280 the list.  You can provide one with @code{:indic} attribute.  If you do not,
13281 it defaults to the value stored in @code{org-texinfo-def-table-markup}, which
13282 see.
13284 @example
13285 #+ATTR_TEXINFO: :indic @@asis
13286 - foo :: This is the text for /foo/, with no highlighting.
13287 @end example
13289 @subsubheading Tables
13291 When exporting a table, column widths are deduced from the longest cell in
13292 each column.  You can also define them explicitly as fractions of the line
13293 length, using @code{:columns} attribute.
13295 @example
13296 #+ATTR_TEXINFO: :columns .5 .5
13297 | a cell | another cell |
13298 @end example
13300 @node An example
13301 @subsection An example
13303 Here is a thorough example.  @inforef{GNU Sample Texts,,texinfo} for an
13304 equivalent Texinfo code.
13306 @smallexample
13307 #+MACRO: version 2.0
13308 #+MACRO: updated last updated 4 March 2014
13310 #+OPTIONS: ':t toc:t author:t email:t
13311 #+TITLE: GNU Sample @{@{@{version@}@}@}
13312 #+AUTHOR: A.U. Thor
13313 #+EMAIL: bug-sample@@gnu.org
13314 #+LANGUAGE: en
13316 #+TEXINFO_FILENAME: sample.info
13317 #+TEXINFO_HEADER: @@syncodeindex pg cp
13319 #+TEXINFO_DIR_CATEGORY: Texinfo documentation system
13320 #+TEXINFO_DIR_TITLE: sample: (sample)
13321 #+TEXINFO_DIR_DESC: Invoking sample
13323 #+TEXINFO_PRINTED_TITLE: GNU Sample
13324 #+SUBTITLE: for version 2.0, last updated 4 March 2014
13326 * Copying 
13327   :PROPERTIES:
13328   :COPYING:  t
13329   :END:
13331   This manual is for GNU Sample (version @{@{@{version@}@}@},
13332   @{@{@{updated@}@}@}), which is an example in the Texinfo documentation.
13334   Copyright @@@@texinfo:@@copyright@{@}@@@@ 2013 Free Software Foundation,
13335   Inc.
13337   #+BEGIN_QUOTE
13338   Permission is granted to copy, distribute and/or modify this
13339   document under the terms of the GNU Free Documentation License,
13340   Version 1.3 or any later version published by the Free Software
13341   Foundation; with no Invariant Sections, with no Front-Cover Texts,
13342   and with no Back-Cover Texts.  A copy of the license is included in
13343   the section entitled "GNU Free Documentation License".
13344   #+END_QUOTE
13346 * Invoking sample
13348   #+PINDEX: sample
13349   #+CINDEX: invoking @@command@{sample@}
13351   This is a sample manual.  There is no sample program to invoke, but
13352   if there were, you could see its basic usage and command line
13353   options here.
13355 * GNU Free Documentation License
13356   :PROPERTIES:
13357   :APPENDIX: t
13358   :END:
13360   #+TEXINFO: @@include fdl.texi
13362 * Index
13363   :PROPERTIES:
13364   :INDEX:    cp
13365   :END:
13366 @end smallexample
13368 @node iCalendar export
13369 @section iCalendar export
13370 @cindex iCalendar export
13372 @vindex org-icalendar-include-todo
13373 @vindex org-icalendar-use-deadline
13374 @vindex org-icalendar-use-scheduled
13375 @vindex org-icalendar-categories
13376 @vindex org-icalendar-alarm-time
13377 Some people use Org mode for keeping track of projects, but still prefer a
13378 standard calendar application for anniversaries and appointments.  In this
13379 case it can be useful to show deadlines and other time-stamped items in Org
13380 files in the calendar application.  Org mode can export calendar information
13381 in the standard iCalendar format.  If you also want to have TODO entries
13382 included in the export, configure the variable
13383 @code{org-icalendar-include-todo}.  Plain timestamps are exported as VEVENT,
13384 and TODO items as VTODO@.  It will also create events from deadlines that are
13385 in non-TODO items.  Deadlines and scheduling dates in TODO items will be used
13386 to set the start and due dates for the TODO entry@footnote{See the variables
13387 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
13388 As categories, it will use the tags locally defined in the heading, and the
13389 file/tree category@footnote{To add inherited tags or the TODO state,
13390 configure the variable @code{org-icalendar-categories}.}.  See the variable
13391 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
13392 time.
13394 @vindex org-icalendar-store-UID
13395 @cindex property, ID
13396 The iCalendar standard requires each entry to have a globally unique
13397 identifier (UID).  Org creates these identifiers during export.  If you set
13398 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
13399 @code{:ID:} property of the entry and re-used next time you report this
13400 entry.  Since a single entry can give rise to multiple iCalendar entries (as
13401 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
13402 prefixes to the UID, depending on what triggered the inclusion of the entry.
13403 In this way the UID remains unique, but a synchronization program can still
13404 figure out from which entry all the different instances originate.
13406 @table @kbd
13407 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
13408 Create iCalendar entries for the current buffer and store them in the same
13409 directory, using a file extension @file{.ics}.
13410 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
13411 @vindex org-agenda-files
13412 Like @kbd{C-c C-e c f}, but do this for all files in
13413 @code{org-agenda-files}.  For each of these files, a separate iCalendar
13414 file will be written.
13415 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
13416 @vindex org-icalendar-combined-agenda-file
13417 Create a single large iCalendar file from all files in
13418 @code{org-agenda-files} and write it to the file given by
13419 @code{org-icalendar-combined-agenda-file}.
13420 @end table
13422 @vindex org-use-property-inheritance
13423 @vindex org-icalendar-include-body
13424 @cindex property, SUMMARY
13425 @cindex property, DESCRIPTION
13426 @cindex property, LOCATION
13427 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
13428 property can be inherited from higher in the hierarchy if you configure
13429 @code{org-use-property-inheritance} accordingly.} properties if the selected
13430 entries have them.  If not, the summary will be derived from the headline,
13431 and the description from the body (limited to
13432 @code{org-icalendar-include-body} characters).
13434 How this calendar is best read and updated, depends on the application
13435 you are using.  The FAQ covers this issue.
13437 @node Other built-in back-ends
13438 @section Other built-in back-ends
13439 @cindex export back-ends, built-in
13440 @vindex org-export-backends
13442 On top of the aforementioned back-ends, Org comes with other built-in ones:
13444 @itemize
13445 @item @file{ox-man.el}: export to a man page.
13446 @end itemize
13448 To activate these export back-end, customize @code{org-export-backends} or
13449 load them directly with e.g., @code{(require 'ox-man)}.  This will add new
13450 keys in the export dispatcher (@pxref{The export dispatcher}).
13452 See the comment section of these files for more information on how to use
13453 them.
13455 @node Export in foreign buffers
13456 @section Export in foreign buffers
13458 Most built-in back-ends come with a command to convert the selected region
13459 into a selected format and replace this region by the exported output.  Here
13460 is a list of such conversion commands:
13462 @table @code
13463 @item org-html-convert-region-to-html
13464 Convert the selected region into HTML.
13465 @item org-latex-convert-region-to-latex
13466 Convert the selected region into @LaTeX{}.
13467 @item org-texinfo-convert-region-to-texinfo
13468 Convert the selected region into @code{Texinfo}.
13469 @item org-md-convert-region-to-md
13470 Convert the selected region into @code{MarkDown}.
13471 @end table
13473 This is particularly useful for converting tables and lists in foreign
13474 buffers.  E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
13475 use Org commands for editing a list, and finally select and convert the list
13476 with @code{M-x org-html-convert-region-to-html RET}.
13478 @node Advanced configuration
13479 @section Advanced configuration
13481 @subheading Hooks
13483 @vindex org-export-before-processing-hook
13484 @vindex org-export-before-parsing-hook
13485 Two hooks are run during the first steps of the export process.  The first
13486 one, @code{org-export-before-processing-hook} is called before expanding
13487 macros, Babel code and include keywords in the buffer.  The second one,
13488 @code{org-export-before-parsing-hook}, as its name suggests, happens just
13489 before parsing the buffer.  Their main use is for heavy duties, that is
13490 duties involving structural modifications of the document.  For example, one
13491 may want to remove every headline in the buffer during export.  The following
13492 code can achieve this:
13494 @lisp
13495 @group
13496 (defun my-headline-removal (backend)
13497   "Remove all headlines in the current buffer.
13498 BACKEND is the export back-end being used, as a symbol."
13499   (org-map-entries
13500    (lambda () (delete-region (point) (progn (forward-line) (point))))))
13502 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
13503 @end group
13504 @end lisp
13506 Note that functions used in these hooks require a mandatory argument,
13507 a symbol representing the back-end used.
13509 @subheading Filters
13511 @cindex Filters, exporting
13512 Filters are lists of functions applied on a specific part of the output from
13513 a given back-end.  More explicitly, each time a back-end transforms an Org
13514 object or element into another language, all functions within a given filter
13515 type are called in turn on the string produced.  The string returned by the
13516 last function will be the one used in the final output.
13518 There are filter sets for each type of element or object, for plain text,
13519 for the parse tree, for the export options and for the final output.  They
13520 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
13521 where @code{TYPE} is the type targeted by the filter.  Valid types are:
13523 @multitable @columnfractions .33 .33 .33
13524 @item body
13525 @tab bold
13526 @tab babel-call
13527 @item center-block
13528 @tab clock
13529 @tab code
13530 @item comment
13531 @tab comment-block
13532 @tab diary-sexp
13533 @item drawer
13534 @tab dynamic-block
13535 @tab entity
13536 @item example-block
13537 @tab export-block
13538 @tab export-snippet
13539 @item final-output
13540 @tab fixed-width
13541 @tab footnote-definition
13542 @item footnote-reference
13543 @tab headline
13544 @tab horizontal-rule
13545 @item inline-babel-call
13546 @tab inline-src-block
13547 @tab inlinetask
13548 @item italic
13549 @tab item
13550 @tab keyword
13551 @item latex-environment
13552 @tab latex-fragment
13553 @tab line-break
13554 @item link
13555 @tab node-property
13556 @tab options
13557 @item paragraph
13558 @tab parse-tree
13559 @tab plain-list
13560 @item plain-text
13561 @tab planning
13562 @tab property-drawer
13563 @item quote-block
13564 @tab quote-section
13565 @tab radio-target
13566 @item section
13567 @tab special-block
13568 @tab src-block
13569 @item statistics-cookie
13570 @tab strike-through
13571 @tab subscript
13572 @item superscript
13573 @tab table
13574 @tab table-cell
13575 @item table-row
13576 @tab target
13577 @tab timestamp
13578 @item underline
13579 @tab verbatim
13580 @tab verse-block
13581 @end multitable
13583 For example, the following snippet allows me to use non-breaking spaces in
13584 the Org buffer and get them translated into @LaTeX{} without using the
13585 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
13587 @lisp
13588 @group
13589 (defun my-latex-filter-nobreaks (text backend info)
13590   "Ensure \" \" are properly handled in LaTeX export."
13591   (when (org-export-derived-backend-p backend 'latex)
13592         (replace-regexp-in-string " " "~" text)))
13594 (add-to-list 'org-export-filter-plain-text-functions
13595              'my-latex-filter-nobreaks)
13596 @end group
13597 @end lisp
13599 Three arguments must be provided to a filter: the code being changed, the
13600 back-end used, and some information about the export process.  You can safely
13601 ignore the third argument for most purposes.  Note the use of
13602 @code{org-export-derived-backend-p}, which ensures that the filter will only
13603 be applied when using @code{latex} back-end or any other back-end derived
13604 from it (e.g., @code{beamer}).
13606 @subheading Defining filters for individual files
13608 You can customize the export for just a specific file by binding export
13609 filter variables using @code{#+BIND}.  Here is an example where we introduce
13610 two filters, one to remove brackets from time stamps, and one to entirely
13611 remove any strike-through text.  The functions doing the filtering are
13612 defined in an src block that allows the filter function definitions to exist
13613 in the file itself and ensures that the functions will be there when needed.
13615 @example
13616 #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
13617 #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
13618 #+begin_src emacs-lisp :exports results :results none
13619   (defun tmp-f-timestamp (s backend info)
13620     (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
13621   (defun tmp-f-strike-through (s backend info) "")
13622 #+end_src
13623 @end example
13625 @subheading Extending an existing back-end
13627 This is obviously the most powerful customization, since the changes happen
13628 at the parser level.  Indeed, some export back-ends are built as extensions
13629 of other ones (e.g. Markdown back-end an extension of HTML back-end).
13631 Extending a back-end means that if an element type is not transcoded by the
13632 new back-end, it will be handled by the original one.  Hence you can extend
13633 specific parts of a back-end without too much work.
13635 As an example, imagine we want the @code{ascii} back-end to display the
13636 language used in a source block, when it is available, but only when some
13637 attribute is non-@code{nil}, like the following:
13639 @example
13640 #+ATTR_ASCII: :language t
13641 @end example
13643 Because that back-end is lacking in that area, we are going to create a new
13644 back-end, @code{my-ascii} that will do the job.
13646 @lisp
13647 @group
13648 (defun my-ascii-src-block (src-block contents info)
13649   "Transcode a SRC-BLOCK element from Org to ASCII.
13650 CONTENTS is nil.  INFO is a plist used as a communication
13651 channel."
13652   (if (not (org-export-read-attribute :attr_ascii src-block :language))
13653     (org-export-with-backend 'ascii src-block contents info)
13654   (concat
13655    (format ",--[ %s ]--\n%s`----"
13656            (org-element-property :language src-block)
13657            (replace-regexp-in-string
13658             "^" "| "
13659             (org-element-normalize-string
13660              (org-export-format-code-default src-block info)))))))
13662 (org-export-define-derived-backend 'my-ascii 'ascii
13663   :translate-alist '((src-block . my-ascii-src-block)))
13664 @end group
13665 @end lisp
13667 The @code{my-ascii-src-block} function looks at the attribute above the
13668 element.  If it isn't true, it gives hand to the @code{ascii} back-end.
13669 Otherwise, it creates a box around the code, leaving room for the language.
13670 A new back-end is then created.  It only changes its behavior when
13671 translating @code{src-block} type element.  Now, all it takes to use the new
13672 back-end is calling the following from an Org buffer:
13674 @smalllisp
13675 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
13676 @end smalllisp
13678 It is obviously possible to write an interactive function for this, install
13679 it in the export dispatcher menu, and so on.
13682 @node Publishing
13683 @chapter Publishing
13684 @cindex publishing
13686 Org includes a publishing management system that allows you to configure
13687 automatic HTML conversion of @emph{projects} composed of interlinked org
13688 files.  You can also configure Org to automatically upload your exported HTML
13689 pages and related attachments, such as images and source code files, to a web
13690 server.
13692 You can also use Org to convert files into PDF, or even combine HTML and PDF
13693 conversion so that files are available in both formats on the server.
13695 Publishing has been contributed to Org by David O'Toole.
13697 @menu
13698 * Configuration::               Defining projects
13699 * Uploading files::             How to get files up on the server
13700 * Sample configuration::        Example projects
13701 * Triggering publication::      Publication commands
13702 @end menu
13704 @node Configuration
13705 @section Configuration
13707 Publishing needs significant configuration to specify files, destination
13708 and many other properties of a project.
13710 @menu
13711 * Project alist::               The central configuration variable
13712 * Sources and destinations::    From here to there
13713 * Selecting files::             What files are part of the project?
13714 * Publishing action::           Setting the function doing the publishing
13715 * Publishing options::          Tweaking HTML/@LaTeX{} export
13716 * Publishing links::            Which links keep working after publishing?
13717 * Sitemap::                     Generating a list of all pages
13718 * Generating an index::         An index that reaches across pages
13719 @end menu
13721 @node Project alist
13722 @subsection The variable @code{org-publish-project-alist}
13723 @cindex org-publish-project-alist
13724 @cindex projects, for publishing
13726 @vindex org-publish-project-alist
13727 Publishing is configured almost entirely through setting the value of one
13728 variable, called @code{org-publish-project-alist}.  Each element of the list
13729 configures one project, and may be in one of the two following forms:
13731 @lisp
13732    ("project-name" :property value :property value ...)
13733      @r{i.e., a well-formed property list with alternating keys and values}
13734 @r{or}
13735    ("project-name" :components ("project-name" "project-name" ...))
13737 @end lisp
13739 In both cases, projects are configured by specifying property values.  A
13740 project defines the set of files that will be published, as well as the
13741 publishing configuration to use when publishing those files.  When a project
13742 takes the second form listed above, the individual members of the
13743 @code{:components} property are taken to be sub-projects, which group
13744 together files requiring different publishing options.  When you publish such
13745 a ``meta-project'', all the components will also be published, in the
13746 sequence given.
13748 @node Sources and destinations
13749 @subsection Sources and destinations for files
13750 @cindex directories, for publishing
13752 Most properties are optional, but some should always be set.  In
13753 particular, Org needs to know where to look for source files,
13754 and where to put published files.
13756 @multitable @columnfractions 0.3 0.7
13757 @item @code{:base-directory}
13758 @tab Directory containing publishing source files
13759 @item @code{:publishing-directory}
13760 @tab Directory where output files will be published.  You can directly
13761 publish to a web server using a file name syntax appropriate for
13762 the Emacs @file{tramp} package.  Or you can publish to a local directory and
13763 use external tools to upload your website (@pxref{Uploading files}).
13764 @item @code{:preparation-function}
13765 @tab Function or list of functions to be called before starting the
13766 publishing process, for example, to run @code{make} for updating files to be
13767 published.  The project property list is scoped into this call as the
13768 variable @code{project-plist}.
13769 @item @code{:completion-function}
13770 @tab Function or list of functions called after finishing the publishing
13771 process, for example, to change permissions of the resulting files.  The
13772 project property list is scoped into this call as the variable
13773 @code{project-plist}.
13774 @end multitable
13775 @noindent
13777 @node Selecting files
13778 @subsection Selecting files
13779 @cindex files, selecting for publishing
13781 By default, all files with extension @file{.org} in the base directory
13782 are considered part of the project.  This can be modified by setting the
13783 properties
13784 @multitable @columnfractions 0.25 0.75
13785 @item @code{:base-extension}
13786 @tab Extension (without the dot!) of source files.  This actually is a
13787 regular expression.  Set this to the symbol @code{any} if you want to get all
13788 files in @code{:base-directory}, even without extension.
13790 @item @code{:exclude}
13791 @tab Regular expression to match file names that should not be
13792 published, even though they have been selected on the basis of their
13793 extension.
13795 @item @code{:include}
13796 @tab List of files to be included regardless of @code{:base-extension}
13797 and @code{:exclude}.
13799 @item @code{:recursive}
13800 @tab non-@code{nil} means, check base-directory recursively for files to publish.
13801 @end multitable
13803 @node Publishing action
13804 @subsection Publishing action
13805 @cindex action, for publishing
13807 Publishing means that a file is copied to the destination directory and
13808 possibly transformed in the process.  The default transformation is to export
13809 Org files as HTML files, and this is done by the function
13810 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
13811 export}).  But you also can publish your content as PDF files using
13812 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
13813 using the corresponding functions.
13815 If you want to publish the Org file as an @code{.org} file but with the
13816 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
13817 function @code{org-org-publish-to-org}.  This will produce @file{file.org}
13818 and put it in the publishing directory.  If you want a htmlized version of
13819 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
13820 produce @file{file.org.html} in the publishing directory@footnote{If the
13821 publishing directory is the same than the source directory, @file{file.org}
13822 will be exported as @file{file.org.org}, so probably don't want to do this.}.
13824 Other files like images only need to be copied to the publishing destination.
13825 For this you can use @code{org-publish-attachment}.  For non-org files, you
13826 always need to specify the publishing function:
13828 @multitable @columnfractions 0.3 0.7
13829 @item @code{:publishing-function}
13830 @tab Function executing the publication of a file.  This may also be a
13831 list of functions, which will all be called in turn.
13832 @item @code{:htmlized-source}
13833 @tab non-@code{nil} means, publish htmlized source.
13834 @end multitable
13836 The function must accept three arguments: a property list containing at least
13837 a @code{:publishing-directory} property, the name of the file to be published
13838 and the path to the publishing directory of the output file.  It should take
13839 the specified file, make the necessary transformation (if any) and place the
13840 result into the destination folder.
13842 @node Publishing options
13843 @subsection Options for the exporters
13844 @cindex options, for publishing
13846 The property list can be used to set export options during the publishing
13847 process.  In most cases, these properties correspond to user variables in
13848 Org.  While some properties are available for all export back-ends, most of
13849 them are back-end specific.  The following sections list properties along
13850 with the variable they belong to.  See the documentation string of these
13851 options for details.
13853 @vindex org-publish-project-alist
13854 When a property is given a value in @code{org-publish-project-alist}, its
13855 setting overrides the value of the corresponding user variable (if any)
13856 during publishing.  Options set within a file (@pxref{Export settings}),
13857 however, override everything.
13859 @subsubheading Generic properties
13861 @multitable {@code{:with-sub-superscript}}  {@code{org-export-with-sub-superscripts}}
13862 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
13863 @item @code{:exclude-tags}          @tab @code{org-export-exclude-tags}
13864 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
13865 @item @code{:language}              @tab @code{org-export-default-language}
13866 @item @code{:preserve-breaks}       @tab @code{org-export-preserve-breaks}
13867 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
13868 @item @code{:select-tags}           @tab @code{org-export-select-tags}
13869 @item @code{:with-author}           @tab @code{org-export-with-author}
13870 @item @code{:with-creator}          @tab @code{org-export-with-creator}
13871 @item @code{:with-date}             @tab @code{org-export-with-date}
13872 @item @code{:with-drawers}          @tab @code{org-export-with-drawers}
13873 @item @code{:with-email}            @tab @code{org-export-with-email}
13874 @item @code{:with-emphasize}        @tab @code{org-export-with-emphasize}
13875 @item @code{:with-fixed-width}      @tab @code{org-export-with-fixed-width}
13876 @item @code{:with-footnotes}        @tab @code{org-export-with-footnotes}
13877 @item @code{:with-latex}            @tab @code{org-export-with-latex}
13878 @item @code{:with-planning}         @tab @code{org-export-with-planning}
13879 @item @code{:with-priority}         @tab @code{org-export-with-priority}
13880 @item @code{:with-properties}       @tab @code{org-export-with-properties}
13881 @item @code{:with-special-strings}  @tab @code{org-export-with-special-strings}
13882 @item @code{:with-sub-superscript}  @tab @code{org-export-with-sub-superscripts}
13883 @item @code{:with-tables}           @tab @code{org-export-with-tables}
13884 @item @code{:with-tags}             @tab @code{org-export-with-tags}
13885 @item @code{:with-tasks}            @tab @code{org-export-with-tasks}
13886 @item @code{:with-timestamps}       @tab @code{org-export-with-timestamps}
13887 @item @code{:with-title}            @tab @code{org-export-with-title}
13888 @item @code{:with-toc}              @tab @code{org-export-with-toc}
13889 @item @code{:with-todo-keywords}    @tab @code{org-export-with-todo-keywords}
13890 @end multitable
13892 @subsubheading ASCII specific properties
13894 @multitable {@code{:ascii-table-keep-all-vertical-lines}} {@code{org-ascii-table-keep-all-vertical-lines}}
13895 @item @code{:ascii-bullets}                       @tab @code{org-ascii-bullets}
13896 @item @code{:ascii-caption-above}                 @tab @code{org-ascii-caption-above}
13897 @item @code{:ascii-charset}                       @tab @code{org-ascii-charset}
13898 @item @code{:ascii-global-margin}                 @tab @code{org-ascii-global-margin}
13899 @item @code{:ascii-format-drawer-function}        @tab @code{org-ascii-format-drawer-function}
13900 @item @code{:ascii-format-inlinetask-function}    @tab @code{org-ascii-format-inlinetask-function}
13901 @item @code{:ascii-headline-spacing}              @tab @code{org-ascii-headline-spacing}
13902 @item @code{:ascii-indented-line-width}           @tab @code{org-ascii-indented-line-width}
13903 @item @code{:ascii-inlinetask-width}              @tab @code{org-ascii-inlinetask-width}
13904 @item @code{:ascii-inner-margin}                  @tab @code{org-ascii-inner-margin}
13905 @item @code{:ascii-links-to-notes}                @tab @code{org-ascii-links-to-notes}
13906 @item @code{:ascii-list-margin}                   @tab @code{org-ascii-list-margin}
13907 @item @code{:ascii-paragraph-spacing}             @tab @code{org-ascii-paragraph-spacing}
13908 @item @code{:ascii-quote-margin}                  @tab @code{org-ascii-quote-margin}
13909 @item @code{:ascii-table-keep-all-vertical-lines} @tab @code{org-ascii-table-keep-all-vertical-lines}
13910 @item @code{:ascii-table-use-ascii-art}           @tab @code{org-ascii-table-use-ascii-art}
13911 @item @code{:ascii-table-widen-columns}           @tab @code{org-ascii-table-widen-columns}
13912 @item @code{:ascii-text-width}                    @tab @code{org-ascii-text-width}
13913 @item @code{:ascii-underline}                     @tab @code{org-ascii-underline}
13914 @item @code{:ascii-verbatim-format}               @tab @code{org-ascii-verbatim-format}
13915 @end multitable
13917 @subsubheading Beamer specific properties
13919 @multitable {@code{:beamer-frame-default-options}} {@code{org-beamer-frame-default-options}}
13920 @item @code{:beamer-theme}                 @tab @code{org-beamer-theme}
13921 @item @code{:beamer-column-view-format}    @tab @code{org-beamer-column-view-format}
13922 @item @code{:beamer-environments-extra}    @tab @code{org-beamer-environments-extra}
13923 @item @code{:beamer-frame-default-options} @tab @code{org-beamer-frame-default-options}
13924 @item @code{:beamer-outline-frame-options} @tab @code{org-beamer-outline-frame-options}
13925 @item @code{:beamer-outline-frame-title}   @tab @code{org-beamer-outline-frame-title}
13926 @end multitable
13928 @subsubheading HTML specific properties
13930 @multitable {@code{:html-table-use-header-tags-for-first-column}} {@code{org-html-table-use-header-tags-for-first-column}}
13931 @item @code{:html-allow-name-attribute-in-anchors} @tab @code{org-html-allow-name-attribute-in-anchors}
13932 @item @code{:html-checkbox-type}              @tab @code{org-html-checkbox-type}
13933 @item @code{:html-container}                  @tab @code{org-html-container-element}
13934 @item @code{:html-divs}                       @tab @code{org-html-divs}
13935 @item @code{:html-doctype}                    @tab @code{org-html-doctype}
13936 @item @code{:html-extension}                  @tab @code{org-html-extension}
13937 @item @code{:html-footnote-format}            @tab @code{org-html-footnote-format}
13938 @item @code{:html-footnote-separator}         @tab @code{org-html-footnote-separator}
13939 @item @code{:html-footnotes-section}          @tab @code{org-html-footnotes-section}
13940 @item @code{:html-format-drawer-function}     @tab @code{org-html-format-drawer-function}
13941 @item @code{:html-format-headline-function}   @tab @code{org-html-format-headline-function}
13942 @item @code{:html-format-inlinetask-function} @tab @code{org-html-format-inlinetask-function}
13943 @item @code{:html-head-extra}                 @tab @code{org-html-head-extra}
13944 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
13945 @item @code{:html-head-include-scripts}       @tab @code{org-html-head-include-scripts}
13946 @item @code{:html-head}                       @tab @code{org-html-head}
13947 @item @code{:html-home/up-format}             @tab @code{org-html-home/up-format}
13948 @item @code{:html-html5-fancy}                @tab @code{org-html-html5-fancy}
13949 @item @code{:html-indent}                     @tab @code{org-html-indent}
13950 @item @code{:html-infojs-options}             @tab @code{org-html-infojs-options}
13951 @item @code{:html-infojs-template}            @tab @code{org-html-infojs-template}
13952 @item @code{:html-inline-image-rules}         @tab @code{org-html-inline-image-rules}
13953 @item @code{:html-inline-images}              @tab @code{org-html-inline-images}
13954 @item @code{:html-link-home}                  @tab @code{org-html-link-home}
13955 @item @code{:html-link-org-files-as-html}     @tab @code{org-html-link-org-files-as-html}
13956 @item @code{:html-link-up}                    @tab @code{org-html-link-up}
13957 @item @code{:html-link-use-abs-url}           @tab @code{org-html-link-use-abs-url}
13958 @item @code{:html-mathjax-options}            @tab @code{org-html-mathjax-options}
13959 @item @code{:html-mathjax-template}           @tab @code{org-html-mathjax-template}
13960 @item @code{:html-metadata-timestamp-format}  @tab @code{org-html-metadata-timestamp-format}
13961 @item @code{:html-postamble-format}           @tab @code{org-html-postamble-format}
13962 @item @code{:html-postamble}                  @tab @code{org-html-postamble}
13963 @item @code{:html-preamble-format}            @tab @code{org-html-preamble-format}
13964 @item @code{:html-preamble}                   @tab @code{org-html-preamble}
13965 @item @code{:html-table-align-individual-fields} @tab @code{org-html-table-align-individual-fields}
13966 @item @code{:html-table-attributes}           @tab @code{org-html-table-default-attributes}
13967 @item @code{:html-table-caption-above}        @tab @code{org-html-table-caption-above}
13968 @item @code{:html-table-data-tags}            @tab @code{org-html-table-data-tags}
13969 @item @code{:html-table-header-tags}          @tab @code{org-html-table-header-tags}
13970 @item @code{:html-table-row-tags}             @tab @code{org-html-table-row-tags}
13971 @item @code{:html-table-use-header-tags-for-first-column} @tab @code{org-html-table-use-header-tags-for-first-column}
13972 @item @code{:html-tag-class-prefix}           @tab @code{org-html-tag-class-prefix}
13973 @item @code{:html-text-markup-alist}          @tab @code{org-html-text-markup-alist}
13974 @item @code{:html-todo-kwd-class-prefix}      @tab @code{org-html-todo-kwd-class-prefix}
13975 @item @code{:html-toplevel-hlevel}            @tab @code{org-html-toplevel-hlevel}
13976 @item @code{:html-use-infojs}                 @tab @code{org-html-use-infojs}
13977 @item @code{:html-use-unicode-chars}          @tab @code{org-html-use-unicode-chars}
13978 @item @code{:html-validation-link}            @tab @code{org-html-validation-link}
13979 @item @code{:html-xml-declaration}            @tab @code{org-html-xml-declaration}
13980 @end multitable
13982 @subsubheading @LaTeX{} specific properties
13984 @multitable {@code{:latex-link-with-unknown-path-format}} {@code{org-latex-link-with-unknown-path-format}} 
13985 @item @code{:latex-active-timestamp-format}    @tab @code{org-latex-active-timestamp-format}
13986 @item @code{:latex-caption-above}              @tab @code{org-latex-caption-above}
13987 @item @code{:latex-classes}                    @tab @code{org-latex-classes}
13988 @item @code{:latex-class}                      @tab @code{org-latex-default-class}
13989 @item @code{:latex-custom-id-labels}           @tab @code{org-latex-custom-id-as-label}
13990 @item @code{:latex-default-figure-position}    @tab @code{org-latex-default-figure-position}
13991 @item @code{:latex-default-table-environment}  @tab @code{org-latex-default-table-environment}
13992 @item @code{:latex-default-table-mode}         @tab @code{org-latex-default-table-mode}
13993 @item @code{:latex-diary-timestamp-format}     @tab @code{org-latex-diary-timestamp-format}
13994 @item @code{:latex-footnote-separator}         @tab @code{org-latex-footnote-separator}
13995 @item @code{:latex-format-drawer-function}     @tab @code{org-latex-format-drawer-function}
13996 @item @code{:latex-format-headline-function}   @tab @code{org-latex-format-headline-function}
13997 @item @code{:latex-format-inlinetask-function} @tab @code{org-latex-format-inlinetask-function}
13998 @item @code{:latex-hyperref-template}          @tab @code{org-latex-hyperref-template}
13999 @item @code{:latex-image-default-height}       @tab @code{org-latex-image-default-height}
14000 @item @code{:latex-image-default-option}       @tab @code{org-latex-image-default-option}
14001 @item @code{:latex-image-default-width}        @tab @code{org-latex-image-default-width}
14002 @item @code{:latex-inactive-timestamp-format}  @tab @code{org-latex-inactive-timestamp-format}
14003 @item @code{:latex-inline-image-rules}         @tab @code{org-latex-inline-image-rules}
14004 @item @code{:latex-link-with-unknown-path-format} @tab @code{org-latex-link-with-unknown-path-format}
14005 @item @code{:latex-listings-langs}             @tab @code{org-latex-listings-langs}
14006 @item @code{:latex-listings-options}           @tab @code{org-latex-listings-options}
14007 @item @code{:latex-listings}                   @tab @code{org-latex-listings}
14008 @item @code{:latex-minted-langs}               @tab @code{org-latex-minted-langs}
14009 @item @code{:latex-minted-options}             @tab @code{org-latex-minted-options}
14010 @item @code{:latex-table-scientific-notation}  @tab @code{org-latex-table-scientific-notation}
14011 @item @code{:latex-tables-booktabs}            @tab @code{org-latex-tables-booktabs}
14012 @item @code{:latex-tables-centered}            @tab @code{org-latex-tables-centered}
14013 @item @code{:latex-text-markup-alist}          @tab @code{org-latex-text-markup-alist}
14014 @item @code{:latex-title-command}              @tab @code{org-latex-title-command}
14015 @item @code{:latex-toc-command}                @tab @code{org-latex-toc-command}
14016 @end multitable
14018 @subsubheading Markdown specific properties
14020 @multitable {@code{:md-headline-style}} {@code{org-md-headline-style}}
14021 @item @code{:md-headline-style} @tab @code{org-md-headline-style}
14022 @end multitable
14024 @subsubheading ODT specific properties
14026 @multitable {@code{:odt-format-inlinetask-function}} {@code{org-odt-format-inlinetask-function}}
14027 @item @code{:odt-content-template-file}      @tab @code{org-odt-content-template-file}
14028 @item @code{:odt-display-outline-level}      @tab @code{org-odt-display-outline-level}
14029 @item @code{:odt-fontify-srcblocks}          @tab @code{org-odt-fontify-srcblocks}
14030 @item @code{:odt-format-drawer-function}     @tab @code{org-odt-format-drawer-function}
14031 @item @code{:odt-format-headline-function}   @tab @code{org-odt-format-headline-function}
14032 @item @code{:odt-format-inlinetask-function} @tab @code{org-odt-format-inlinetask-function}
14033 @item @code{:odt-inline-formula-rules}       @tab @code{org-odt-inline-formula-rules}
14034 @item @code{:odt-inline-image-rules}         @tab @code{org-odt-inline-image-rules}
14035 @item @code{:odt-pixels-per-inch}            @tab @code{org-odt-pixels-per-inch}
14036 @item @code{:odt-styles-file}                @tab @code{org-odt-styles-file}
14037 @item @code{:odt-table-styles}               @tab @code{org-odt-table-styles}
14038 @item @code{:odt-use-date-fields}            @tab @code{org-odt-use-date-fields}
14039 @end multitable
14041 @subsubheading Texinfo specific properties
14043 @multitable {@code{:texinfo-link-with-unknown-path-format}} {@code{org-texinfo-link-with-unknown-path-format}}
14044 @item @code{:texinfo-active-timestamp-format}    @tab @code{org-texinfo-active-timestamp-format}
14045 @item @code{:texinfo-classes}                    @tab @code{org-texinfo-classes}
14046 @item @code{:texinfo-class}                      @tab @code{org-texinfo-default-class}
14047 @item @code{:texinfo-def-table-markup}           @tab @code{org-texinfo-def-table-markup}
14048 @item @code{:texinfo-diary-timestamp-format}     @tab @code{org-texinfo-diary-timestamp-format}
14049 @item @code{:texinfo-filename}                   @tab @code{org-texinfo-filename}
14050 @item @code{:texinfo-format-drawer-function}     @tab @code{org-texinfo-format-drawer-function}
14051 @item @code{:texinfo-format-headline-function}   @tab @code{org-texinfo-format-headline-function}
14052 @item @code{:texinfo-format-inlinetask-function} @tab @code{org-texinfo-format-inlinetask-function}
14053 @item @code{:texinfo-inactive-timestamp-format}  @tab @code{org-texinfo-inactive-timestamp-format}
14054 @item @code{:texinfo-link-with-unknown-path-format} @tab @code{org-texinfo-link-with-unknown-path-format}
14055 @item @code{:texinfo-node-description-column}    @tab @code{org-texinfo-node-description-column}
14056 @item @code{:texinfo-table-scientific-notation}  @tab @code{org-texinfo-table-scientific-notation}
14057 @item @code{:texinfo-tables-verbatim}            @tab @code{org-texinfo-tables-verbatim}
14058 @item @code{:texinfo-text-markup-alist}          @tab @code{org-texinfo-text-markup-alist}
14059 @end multitable
14061 @node Publishing links
14062 @subsection Links between published files
14063 @cindex links, publishing
14065 To create a link from one Org file to another, you would use something like
14066 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
14067 (@pxref{Hyperlinks}).  When published, this link becomes a link to
14068 @file{foo.html}.  You can thus interlink the pages of your "org web" project
14069 and the links will work as expected when you publish them to HTML@.  If you
14070 also publish the Org source file and want to link to it, use an @code{http:}
14071 link instead of a @code{file:} link, because @code{file:} links are converted
14072 to link to the corresponding @file{html} file.
14074 You may also link to related files, such as images.  Provided you are careful
14075 with relative file names, and provided you have also configured Org to upload
14076 the related files, these links will work too.  See @ref{Complex example}, for
14077 an example of this usage.
14079 @node Sitemap
14080 @subsection Generating a sitemap
14081 @cindex sitemap, of published pages
14083 The following properties may be used to control publishing of
14084 a map of files for a given project.
14086 @multitable @columnfractions 0.35 0.65
14087 @item @code{:auto-sitemap}
14088 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
14089 or @code{org-publish-all}.
14091 @item @code{:sitemap-filename}
14092 @tab Filename for output of sitemap.  Defaults to @file{sitemap.org} (which
14093 becomes @file{sitemap.html}).
14095 @item @code{:sitemap-title}
14096 @tab Title of sitemap page.  Defaults to name of file.
14098 @item @code{:sitemap-function}
14099 @tab Plug-in function to use for generation of the sitemap.
14100 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
14101 of links to all files in the project.
14103 @item @code{:sitemap-sort-folders}
14104 @tab Where folders should appear in the sitemap.  Set this to @code{first}
14105 (default) or @code{last} to display folders first or last,
14106 respectively.  Any other value will mix files and folders.
14108 @item @code{:sitemap-sort-files}
14109 @tab How the files are sorted in the site map.  Set this to
14110 @code{alphabetically} (default), @code{chronologically} or
14111 @code{anti-chronologically}.  @code{chronologically} sorts the files with
14112 older date first while @code{anti-chronologically} sorts the files with newer
14113 date first.  @code{alphabetically} sorts the files alphabetically.  The date of
14114 a file is retrieved with @code{org-publish-find-date}.
14116 @item @code{:sitemap-ignore-case}
14117 @tab Should sorting be case-sensitive?  Default @code{nil}.
14119 @item @code{:sitemap-file-entry-format}
14120 @tab With this option one can tell how a sitemap's entry is formatted in the
14121 sitemap.  This is a format string with some escape sequences: @code{%t} stands
14122 for the title of the file, @code{%a} stands for the author of the file and
14123 @code{%d} stands for the date of the file.  The date is retrieved with the
14124 @code{org-publish-find-date} function and formatted with
14125 @code{org-publish-sitemap-date-format}.  Default @code{%t}.
14127 @item @code{:sitemap-date-format}
14128 @tab Format string for the @code{format-time-string} function that tells how
14129 a sitemap entry's date is to be formatted.  This property bypasses
14130 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
14132 @item @code{:sitemap-sans-extension}
14133 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
14134 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
14135 Defaults to @code{nil}.
14137 @end multitable
14139 @node Generating an index
14140 @subsection Generating an index
14141 @cindex index, in a publishing project
14143 Org mode can generate an index across the files of a publishing project.
14145 @multitable @columnfractions 0.25 0.75
14146 @item @code{:makeindex}
14147 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
14148 publish it as @file{theindex.html}.
14149 @end multitable
14151 The file will be created when first publishing a project with the
14152 @code{:makeindex} set.  The file only contains a statement @code{#+INCLUDE:
14153 "theindex.inc"}.  You can then build around this include statement by adding
14154 a title, style information, etc.
14156 @node Uploading files
14157 @section Uploading files
14158 @cindex rsync
14159 @cindex unison
14161 For those people already utilizing third party sync tools such as
14162 @command{rsync} or @command{unison}, it might be preferable not to use the built in
14163 @i{remote} publishing facilities of Org mode which rely heavily on
14164 Tramp.  Tramp, while very useful and powerful, tends not to be
14165 so efficient for multiple file transfer and has been known to cause problems
14166 under heavy usage.
14168 Specialized synchronization utilities offer several advantages.  In addition
14169 to timestamp comparison, they also do content and permissions/attribute
14170 checks.  For this reason you might prefer to publish your web to a local
14171 directory (possibly even @i{in place} with your Org files) and then use
14172 @file{unison} or @file{rsync} to do the synchronization with the remote host.
14174 Since Unison (for example) can be configured as to which files to transfer to
14175 a certain remote destination, it can greatly simplify the project publishing
14176 definition.  Simply keep all files in the correct location, process your Org
14177 files with @code{org-publish} and let the synchronization tool do the rest.
14178 You do not need, in this scenario, to include attachments such as @file{jpg},
14179 @file{css} or @file{gif} files in the project definition since the 3rd party
14180 tool syncs them.
14182 Publishing to a local directory is also much faster than to a remote one, so
14183 that you can afford more easily to republish entire projects.  If you set
14184 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
14185 benefit of re-including any changed external files such as source example
14186 files you might include with @code{#+INCLUDE:}.  The timestamp mechanism in
14187 Org is not smart enough to detect if included files have been modified.
14189 @node Sample configuration
14190 @section Sample configuration
14192 Below we provide two example configurations.  The first one is a simple
14193 project publishing only a set of Org files.  The second example is
14194 more complex, with a multi-component project.
14196 @menu
14197 * Simple example::              One-component publishing
14198 * Complex example::             A multi-component publishing example
14199 @end menu
14201 @node Simple example
14202 @subsection Example: simple publishing configuration
14204 This example publishes a set of Org files to the @file{public_html}
14205 directory on the local machine.
14207 @lisp
14208 (setq org-publish-project-alist
14209       '(("org"
14210          :base-directory "~/org/"
14211          :publishing-directory "~/public_html"
14212          :section-numbers nil
14213          :with-toc nil
14214          :html-head "<link rel=\"stylesheet\"
14215                     href=\"../other/mystyle.css\"
14216                     type=\"text/css\"/>")))
14217 @end lisp
14219 @node Complex example
14220 @subsection Example: complex publishing configuration
14222 This more complicated example publishes an entire website, including
14223 Org files converted to HTML, image files, Emacs Lisp source code, and
14224 style sheets.  The publishing directory is remote and private files are
14225 excluded.
14227 To ensure that links are preserved, care should be taken to replicate
14228 your directory structure on the web server, and to use relative file
14229 paths.  For example, if your Org files are kept in @file{~/org} and your
14230 publishable images in @file{~/images}, you would link to an image with
14232 @example
14233 file:../images/myimage.png
14234 @end example
14236 On the web server, the relative path to the image should be the
14237 same.  You can accomplish this by setting up an "images" folder in the
14238 right place on the web server, and publishing images to it.
14240 @lisp
14241 (setq org-publish-project-alist
14242       '(("orgfiles"
14243           :base-directory "~/org/"
14244           :base-extension "org"
14245           :publishing-directory "/ssh:user@@host:~/html/notebook/"
14246           :publishing-function org-html-publish-to-html
14247           :exclude "PrivatePage.org"   ;; regexp
14248           :headline-levels 3
14249           :section-numbers nil
14250           :with-toc nil
14251           :html-head "<link rel=\"stylesheet\"
14252                   href=\"../other/mystyle.css\" type=\"text/css\"/>"
14253           :html-preamble t)
14255          ("images"
14256           :base-directory "~/images/"
14257           :base-extension "jpg\\|gif\\|png"
14258           :publishing-directory "/ssh:user@@host:~/html/images/"
14259           :publishing-function org-publish-attachment)
14261          ("other"
14262           :base-directory "~/other/"
14263           :base-extension "css\\|el"
14264           :publishing-directory "/ssh:user@@host:~/html/other/"
14265           :publishing-function org-publish-attachment)
14266          ("website" :components ("orgfiles" "images" "other"))))
14267 @end lisp
14269 @node Triggering publication
14270 @section Triggering publication
14272 Once properly configured, Org can publish with the following commands:
14274 @table @kbd
14275 @orgcmd{C-c C-e P x,org-publish}
14276 Prompt for a specific project and publish all files that belong to it.
14277 @orgcmd{C-c C-e P p,org-publish-current-project}
14278 Publish the project containing the current file.
14279 @orgcmd{C-c C-e P f,org-publish-current-file}
14280 Publish only the current file.
14281 @orgcmd{C-c C-e P a,org-publish-all}
14282 Publish every project.
14283 @end table
14285 @vindex org-publish-use-timestamps-flag
14286 Org uses timestamps to track when a file has changed.  The above functions
14287 normally only publish changed files.  You can override this and force
14288 publishing of all files by giving a prefix argument to any of the commands
14289 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
14290 This may be necessary in particular if files include other files via
14291 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
14294 @node Working with source code
14295 @chapter Working with source code
14296 @cindex Schulte, Eric
14297 @cindex Davison, Dan
14298 @cindex source code, working with
14300 Source code can be included in Org mode documents using a @samp{src} block,
14301 e.g.:
14303 @example
14304 #+BEGIN_SRC emacs-lisp
14305   (defun org-xor (a b)
14306      "Exclusive or."
14307      (if a (not b) b))
14308 #+END_SRC
14309 @end example
14311 Org mode provides a number of features for working with live source code,
14312 including editing of code blocks in their native major-mode, evaluation of
14313 code blocks, converting code blocks into source files (known as @dfn{tangling}
14314 in literate programming), and exporting code blocks and their
14315 results in several formats.  This functionality was contributed by Eric
14316 Schulte and Dan Davison, and was originally named Org-babel.
14318 The following sections describe Org mode's code block handling facilities.
14320 @menu
14321 * Structure of code blocks::    Code block syntax described
14322 * Editing source code::         Language major-mode editing
14323 * Exporting code blocks::       Export contents and/or results
14324 * Extracting source code::      Create pure source code files
14325 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
14326 * Library of Babel::            Use and contribute to a library of useful code blocks
14327 * Languages::                   List of supported code block languages
14328 * Header arguments::            Configure code block functionality
14329 * Results of evaluation::       How evaluation results are handled
14330 * Noweb reference syntax::      Literate programming in Org mode
14331 * Key bindings and useful functions::  Work quickly with code blocks
14332 * Batch execution::             Call functions from the command line
14333 @end menu
14336 @node Structure of code blocks
14337 @section Structure of code blocks
14338 @cindex code block, structure
14339 @cindex source code, block structure
14340 @cindex #+NAME
14341 @cindex #+BEGIN_SRC
14343 Live code blocks can be specified with a @samp{src} block or
14344 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
14345 @ref{Easy templates} system}  The structure of a @samp{src} block is
14347 @example
14348 #+NAME: <name>
14349 #+BEGIN_SRC <language> <switches> <header arguments>
14350   <body>
14351 #+END_SRC
14352 @end example
14354 The @code{#+NAME:} line is optional, and can be used to name the code
14355 block.  Live code blocks require that a language be specified on the
14356 @code{#+BEGIN_SRC} line.  Switches and header arguments are optional.
14357 @cindex source code, inline
14359 Live code blocks can also be specified inline using
14361 @example
14362 src_<language>@{<body>@}
14363 @end example
14367 @example
14368 src_<language>[<header arguments>]@{<body>@}
14369 @end example
14371 @table @code
14372 @item <#+NAME: name>
14373 This line associates a name with the code block.  This is similar to the
14374 @code{#+NAME: Name} lines that can be used to name tables in Org mode
14375 files.  Referencing the name of a code block makes it possible to evaluate
14376 the block from other places in the file, from other files, or from Org mode
14377 table formulas (see @ref{The spreadsheet}).  Names are assumed to be unique
14378 and the behavior of Org mode when two or more blocks share the same name is
14379 undefined.
14380 @cindex #+NAME
14381 @item <language>
14382 The language of the code in the block (see @ref{Languages}).
14383 @cindex source code, language
14384 @item <switches>
14385 Optional switches control code block export (see the discussion of switches in
14386 @ref{Literal examples})
14387 @cindex source code, switches
14388 @item <header arguments>
14389 Optional header arguments control many aspects of evaluation, export and
14390 tangling of code blocks (see @ref{Header arguments}).
14391 Header arguments can also be set on a per-buffer or per-subtree
14392 basis using properties.
14393 @item source code, header arguments
14394 @item <body>
14395 Source code in the specified language.
14396 @end table
14399 @node Editing source code
14400 @section Editing source code
14401 @cindex code block, editing
14402 @cindex source code, editing
14404 @vindex org-edit-src-auto-save-idle-delay
14405 @vindex org-edit-src-turn-on-auto-save
14406 @kindex C-c '
14407 Use @kbd{C-c '} to edit the current code block.  This brings up a language
14408 major-mode edit buffer containing the body of the code block.  Manually
14409 saving this buffer with @key{C-x C-s} will write the contents back to the Org
14410 buffer.  You can also set @code{org-edit-src-auto-save-idle-delay} to save the
14411 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
14412 to auto-save this buffer into a separate file using @code{auto-save-mode}.
14413 Use @kbd{C-c '} again to exit.
14415 The @code{org-src-mode} minor mode will be active in the edit buffer.  The
14416 following variables can be used to configure the behavior of the edit
14417 buffer.  See also the customization group @code{org-edit-structure} for
14418 further configuration options.
14420 @table @code
14421 @item org-src-lang-modes
14422 If an Emacs major-mode named @code{<lang>-mode} exists, where
14423 @code{<lang>} is the language named in the header line of the code block,
14424 then the edit buffer will be placed in that major-mode.  This variable
14425 can be used to map arbitrary language names to existing major modes.
14426 @item org-src-window-setup
14427 Controls the way Emacs windows are rearranged when the edit buffer is created.
14428 @item org-src-preserve-indentation
14429 @cindex indentation, in source blocks
14430 By default, the value is @code{nil}, which means that when code blocks are
14431 evaluated during export or tangled, they are re-inserted into the code block,
14432 which may replace sequences of spaces with tab characters.  When non-@code{nil},
14433 whitespace in code blocks will be preserved during export or tangling,
14434 exactly as it appears.  This variable is especially useful for tangling
14435 languages such as Python, in which whitespace indentation in the output is
14436 critical.
14437 @item org-src-ask-before-returning-to-edit-buffer
14438 By default, Org will ask before returning to an open edit buffer.  Set this
14439 variable to @code{nil} to switch without asking.
14440 @end table
14442 To turn on native code fontification in the @emph{Org} buffer, configure the
14443 variable @code{org-src-fontify-natively}.
14446 @node Exporting code blocks
14447 @section Exporting code blocks
14448 @cindex code block, exporting
14449 @cindex source code, exporting
14451 It is possible to export the @emph{code} of code blocks, the @emph{results}
14452 of code block evaluation, @emph{both} the code and the results of code block
14453 evaluation, or @emph{none}.  For most languages, the default exports code.
14454 However, for some languages (e.g., @code{ditaa}) the default exports the
14455 results of code block evaluation.  For information on exporting code block
14456 bodies, see @ref{Literal examples}.
14458 The @code{:exports} header argument can be used to specify export
14459 behavior (note that these arguments are only relevant for code blocks, not
14460 inline code):
14462 @subsubheading Header arguments:
14464 @table @code
14465 @cindex @code{:exports}, src header argument
14466 @item :exports code
14467 The default in most languages.  The body of the code block is exported, as
14468 described in @ref{Literal examples}.
14469 @item :exports results
14470 The code block will be evaluated each time to buffer is exported, and the
14471 results will be placed in the Org mode buffer for export, either updating
14472 previous results of the code block located anywhere in the buffer or, if no
14473 previous results exist, placing the results immediately after the code block.
14474 The body of the code block will not be exported.
14475 @item :exports both
14476 Both the code block and its results will be exported.
14477 @item :exports none
14478 Neither the code block nor its results will be exported.
14479 @end table
14481 It is possible to inhibit the evaluation of code blocks during export.
14482 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
14483 ensure that no code blocks are evaluated as part of the export process.  This
14484 can be useful in situations where potentially untrusted Org mode files are
14485 exported in an automated fashion, for example when Org mode is used as the
14486 markup language for a wiki.  It is also possible to set this variable to
14487 @code{inline-only}.  In that case, only inline code blocks will be
14488 evaluated, in order to insert their results.  Non-inline code blocks are
14489 assumed to have their results already inserted in the buffer by manual
14490 evaluation.  This setting is useful to avoid expensive recalculations during
14491 export, not to provide security.
14493 Code blocks in commented subtrees (@pxref{Comment lines}) are never evaluated
14494 on export.  However, code blocks in subtrees excluded from export
14495 (@pxref{Export settings}) may be evaluated on export.
14497 @node Extracting source code
14498 @section Extracting source code
14499 @cindex tangling
14500 @cindex source code, extracting
14501 @cindex code block, extracting source code
14503 Creating pure source code files by extracting code from source blocks is
14504 referred to as ``tangling''---a term adopted from the literate programming
14505 community.  During ``tangling'' of code blocks their bodies are expanded
14506 using @code{org-babel-expand-src-block} which can expand both variable and
14507 ``noweb'' style references  (see @ref{Noweb reference syntax}).
14509 @subsubheading Header arguments
14511 @table @code
14512 @cindex @code{:tangle}, src header argument
14513 @item :tangle no
14514 The default.  The code block is not included in the tangled output.
14515 @item :tangle yes
14516 Include the code block in the tangled output.  The output file name is the
14517 name of the org file with the extension @samp{.org} replaced by the extension
14518 for the block language.
14519 @item :tangle filename
14520 Include the code block in the tangled output to file @samp{filename}.
14521 @end table
14523 @kindex  C-c C-v t
14524 @subsubheading Functions
14526 @table @code
14527 @item org-babel-tangle
14528 Tangle the current file.  Bound to @kbd{C-c C-v t}.
14530 With prefix argument only tangle the current code block.
14531 @item org-babel-tangle-file
14532 Choose a file to tangle.  Bound to @kbd{C-c C-v f}.
14533 @end table
14535 @subsubheading Hooks
14537 @table @code
14538 @item org-babel-post-tangle-hook
14539 This hook is run from within code files tangled by @code{org-babel-tangle}.
14540 Example applications could include post-processing, compilation or evaluation
14541 of tangled code files.
14542 @end table
14544 @subsubheading Jumping between code and Org
14546 When tangling code from an Org-mode buffer to a source code file, you'll
14547 frequently find yourself viewing the file of tangled source code (e.g., many
14548 debuggers point to lines of the source code file).  It is useful to be able
14549 to navigate from the tangled source to the Org-mode buffer from which the
14550 code originated.
14552 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
14553 code to Org-mode functionality.  Two header arguments are required for
14554 jumping to work, first the @code{padline} (@ref{padline}) option must be set
14555 to true (the default setting), second the @code{comments} (@ref{comments})
14556 header argument must be set to @code{links}, which will insert comments into
14557 the source code buffer which point back to the original Org-mode file.
14559 @node Evaluating code blocks
14560 @section Evaluating code blocks
14561 @cindex code block, evaluating
14562 @cindex source code, evaluating
14563 @cindex #+RESULTS
14565 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
14566 potential for that code to do harm.  Org mode provides safeguards to ensure
14567 that code is only evaluated after explicit confirmation from the user.  For
14568 information on these safeguards (and on how to disable them) see @ref{Code
14569 evaluation security}.} and the results of evaluation optionally placed in the
14570 Org mode buffer.  The results of evaluation are placed following a line that
14571 begins by default with @code{#+RESULTS} and optionally a cache identifier
14572 and/or the name of the evaluated code block.  The default value of
14573 @code{#+RESULTS} can be changed with the customizable variable
14574 @code{org-babel-results-keyword}.
14576 By default, the evaluation facility is only enabled for Lisp code blocks
14577 specified as @code{emacs-lisp}.  However, source code blocks in many languages
14578 can be evaluated within Org mode (see @ref{Languages} for a list of supported
14579 languages and @ref{Structure of code blocks} for information on the syntax
14580 used to define a code block).
14582 @kindex C-c C-c
14583 There are a number of ways to evaluate code blocks.  The simplest is to press
14584 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
14585 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
14586 evaluation from the @kbd{C-c C-c} key binding.}.  This will call the
14587 @code{org-babel-execute-src-block} function to evaluate the block and insert
14588 its results into the Org mode buffer.
14590 @cindex #+CALL
14591 It is also possible to evaluate named code blocks from anywhere in an Org
14592 mode buffer or an Org mode table.  These named code blocks can be located in
14593 the current Org mode buffer or in the ``Library of Babel'' (@pxref{Library of
14594 Babel}).  Named code blocks can be evaluated with a separate @code{#+CALL:}
14595 line or inline within a block of text.  In both cases the result is wrapped
14596 according to the value of @code{org-babel-inline-result-wrap}, which by
14597 default is @code{"=%s="} for markup that produces verbatim text.
14599 The syntax of the @code{#+CALL:} line is
14601 @example
14602 #+CALL: <name>(<arguments>)
14603 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
14604 @end example
14606 The syntax for inline evaluation of named code blocks is
14608 @example
14609 ... call_<name>(<arguments>) ...
14610 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
14611 @end example
14613 @table @code
14614 @item <name>
14615 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
14616 @item <arguments>
14617 Arguments specified in this section will be passed to the code block.  These
14618 arguments use standard function call syntax, rather than
14619 header argument syntax.  For example, a @code{#+CALL:} line that passes the
14620 number four to a code block named @code{double}, which declares the header
14621 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
14622 @item <inside header arguments>
14623 Inside header arguments are passed through and applied to the named code
14624 block.  These arguments use header argument syntax rather than standard
14625 function call syntax.  Inside header arguments affect how the code block is
14626 evaluated.  For example, @code{[:results output]} will collect the results of
14627 everything printed to @code{STDOUT} during execution of the code block.
14628 @item <end header arguments>
14629 End header arguments are applied to the calling instance and do not affect
14630 evaluation of the named code block.  They affect how the results are
14631 incorporated into the Org mode buffer and how the call line is exported.  For
14632 example, @code{:results html} will insert the results of the call line
14633 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
14635 For more examples of passing header arguments to @code{#+CALL:} lines see
14636 @ref{Header arguments in function calls}.
14637 @end table
14639 @node Library of Babel
14640 @section Library of Babel
14641 @cindex babel, library of
14642 @cindex source code, library
14643 @cindex code block, library
14645 The ``Library of Babel'' consists of code blocks that can be called from any
14646 Org mode file.  Code blocks defined in the ``Library of Babel'' can be called
14647 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
14648 code blocks} for information on the syntax of remote code block evaluation).
14651 The central repository of code blocks in the ``Library of Babel'' is housed
14652 in an Org mode file located in the @samp{contrib} directory of Org mode.
14654 Users can add code blocks they believe to be generally useful to their
14655 ``Library of Babel.''  The code blocks can be stored in any Org mode file and
14656 then loaded into the library with @code{org-babel-lob-ingest}.
14659 @kindex C-c C-v i
14660 Code blocks located in any Org mode file can be loaded into the ``Library of
14661 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
14664 @node Languages
14665 @section Languages
14666 @cindex babel, languages
14667 @cindex source code, languages
14668 @cindex code block, languages
14670 Code blocks in the following languages are supported.
14672 @multitable @columnfractions 0.28 0.3 0.22 0.2
14673 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
14674 @item Asymptote @tab asymptote @tab Awk @tab awk
14675 @item Emacs Calc @tab calc @tab C @tab C
14676 @item C++ @tab C++ @tab Clojure @tab clojure
14677 @item CSS @tab css @tab ditaa @tab ditaa
14678 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
14679 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
14680 @item Java @tab java @tab @tab
14681 @item Javascript @tab js @tab LaTeX @tab latex
14682 @item Ledger @tab ledger @tab Lisp @tab lisp
14683 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
14684 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
14685 @item Octave @tab octave @tab Org mode @tab org
14686 @item Oz @tab oz @tab Perl @tab perl
14687 @item Plantuml @tab plantuml @tab Python @tab python
14688 @item R @tab R @tab Ruby @tab ruby
14689 @item Sass @tab sass @tab Scheme @tab scheme
14690 @item GNU Screen @tab screen @tab shell @tab sh
14691 @item SQL @tab sql @tab SQLite @tab sqlite
14692 @end multitable
14694 Language-specific documentation is available for some languages.  If
14695 available, it can be found at
14696 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
14698 The option @code{org-babel-load-languages} controls which languages are
14699 enabled for evaluation (by default only @code{emacs-lisp} is enabled).  This
14700 variable can be set using the customization interface or by adding code like
14701 the following to your emacs configuration.
14703 @quotation
14704 The following disables @code{emacs-lisp} evaluation and enables evaluation of
14705 @code{R} code blocks.
14706 @end quotation
14708 @lisp
14709 (org-babel-do-load-languages
14710  'org-babel-load-languages
14711  '((emacs-lisp . nil)
14712    (R . t)))
14713 @end lisp
14715 It is also possible to enable support for a language by loading the related
14716 elisp file with @code{require}.
14718 @quotation
14719 The following adds support for evaluating @code{clojure} code blocks.
14720 @end quotation
14722 @lisp
14723 (require 'ob-clojure)
14724 @end lisp
14726 @node Header arguments
14727 @section Header arguments
14728 @cindex code block, header arguments
14729 @cindex source code, block header arguments
14731 Code block functionality can be configured with header arguments.  This
14732 section provides an overview of the use of header arguments, and then
14733 describes each header argument in detail.
14735 @menu
14736 * Using header arguments::      Different ways to set header arguments
14737 * Specific header arguments::   List of header arguments
14738 @end menu
14740 @node Using header arguments
14741 @subsection Using header arguments
14743 The values of header arguments can be set in several way.  When the header
14744 arguments in each layer have been determined, they are combined in order from
14745 the first, least specific (having the lowest priority) up to the last, most
14746 specific (having the highest priority).  A header argument with a higher
14747 priority replaces the same header argument specified at lower priority.
14748 @menu
14749 * System-wide header arguments::  Set global default values
14750 * Language-specific header arguments::  Set default values by language
14751 * Header arguments in Org mode properties::  Set default values for a buffer or heading
14752 * Language-specific header arguments in Org mode properties::  Set language-specific default values for a buffer or heading
14753 * Code block specific header arguments::  The most common way to set values
14754 * Header arguments in function calls::  The most specific level
14755 @end menu
14758 @node System-wide header arguments
14759 @subsubheading System-wide header arguments
14760 @vindex org-babel-default-header-args
14761 System-wide values of header arguments can be specified by adapting the
14762 @code{org-babel-default-header-args} variable:
14764 @cindex @code{:session}, src header argument
14765 @cindex @code{:results}, src header argument
14766 @cindex @code{:exports}, src header argument
14767 @cindex @code{:cache}, src header argument
14768 @cindex @code{:noweb}, src header argument
14769 @example
14770 :session    => "none"
14771 :results    => "replace"
14772 :exports    => "code"
14773 :cache      => "no"
14774 :noweb      => "no"
14775 @end example
14777 For example, the following example could be used to set the default value of
14778 @code{:noweb} header arguments to @code{yes}.  This would have the effect of
14779 expanding @code{:noweb} references by default when evaluating source code
14780 blocks.
14782 @lisp
14783 (setq org-babel-default-header-args
14784       (cons '(:noweb . "yes")
14785             (assq-delete-all :noweb org-babel-default-header-args)))
14786 @end lisp
14788 @node Language-specific header arguments
14789 @subsubheading Language-specific header arguments
14790 Each language can define its own set of default header arguments in variable
14791 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
14792 of the language.  See the language-specific documentation available online at
14793 @uref{http://orgmode.org/worg/org-contrib/babel}.
14795 @node Header arguments in Org mode properties
14796 @subsubheading Header arguments in Org mode properties
14798 Buffer-wide header arguments may be specified as properties through the use
14799 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
14800 @ref{Property syntax}).
14802 For example the following would set @code{session} to @code{*R*} (only for R
14803 code blocks), and @code{results} to @code{silent} for every code block in the
14804 buffer, ensuring that all execution took place in the same session, and no
14805 results would be inserted into the buffer.
14807 @example
14808 #+PROPERTY: header-args:R  :session *R*
14809 #+PROPERTY: header-args    :results silent
14810 @end example
14812 Header arguments read from Org mode properties can also be set on a
14813 per-subtree basis using property drawers (see @ref{Property syntax}).
14814 @vindex org-use-property-inheritance
14815 When properties are used to set default header arguments, they are always
14816 looked up with inheritance, regardless of the value of
14817 @code{org-use-property-inheritance}.  Properties are evaluated as seen by the
14818 outermost call or source block.@footnote{The deprecated syntax for default
14819 header argument properties, using the name of the header argument as a
14820 property name directly, evaluates the property as seen by the corresponding
14821 source block definition.  This behavior has been kept for backwards
14822 compatibility.}
14824 In the following example the value of
14825 the @code{:cache} header argument will default to @code{yes} in all code
14826 blocks in the subtree rooted at the following heading:
14828 @example
14829 * outline header
14830   :PROPERTIES:
14831   :header-args:    :cache yes
14832   :END:
14833 @end example
14835 @kindex C-c C-x p
14836 @vindex org-babel-default-header-args
14837 Properties defined in this way override the properties set in
14838 @code{org-babel-default-header-args} and are applied for all activated
14839 languages.  It is convenient to use the @code{org-set-property} function
14840 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
14842 @node Language-specific header arguments in Org mode properties
14843 @subsubheading Language-specific header arguments in Org mode properties
14845 Language-specific header arguments are also read from properties
14846 @code{header-args:<lang>} where @code{<lang>} is the name of the language
14847 targeted.  As an example
14849 @example
14850 * Heading
14851   :PROPERTIES:
14852   :header-args:clojure:    :session *clojure-1*
14853   :header-args:R:          :session *R*
14854   :END:
14855 ** Subheading
14856   :PROPERTIES:
14857   :header-args:clojure:    :session *clojure-2*
14858   :END:
14859 @end example
14861 would independently set a default session header argument for R and clojure
14862 for calls and source blocks under subtree ``Heading'' and change to a
14863 different clojure setting for evaluations under subtree ``Subheading'', while
14864 the R session is inherited from ``Heading'' and therefore unchanged.
14866 @node Code block specific header arguments
14867 @subsubheading Code block specific header arguments
14869 The most common way to assign values to header arguments is at the
14870 code block level.  This can be done by listing a sequence of header
14871 arguments and their values as part of the @code{#+BEGIN_SRC} line.
14872 Properties set in this way override both the values of
14873 @code{org-babel-default-header-args} and header arguments specified as
14874 properties.  In the following example, the @code{:results} header argument
14875 is set to @code{silent}, meaning the results of execution will not be
14876 inserted in the buffer, and the @code{:exports} header argument is set to
14877 @code{code}, meaning only the body of the code block will be
14878 preserved on export to HTML or @LaTeX{}.
14880 @example
14881 #+NAME: factorial
14882 #+BEGIN_SRC haskell :results silent :exports code :var n=0
14883 fac 0 = 1
14884 fac n = n * fac (n-1)
14885 #+END_SRC
14886 @end example
14887 Similarly, it is possible to set header arguments for inline code blocks
14889 @example
14890 src_haskell[:exports both]@{fac 5@}
14891 @end example
14893 Code block header arguments can span multiple lines using @code{#+HEADER:} or
14894 @code{#+HEADERS:} lines preceding a code block or nested between the
14895 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
14896 @cindex #+HEADER:
14897 @cindex #+HEADERS:
14899 Multi-line header arguments on an un-named code block:
14901 @example
14902  #+HEADERS: :var data1=1
14903  #+BEGIN_SRC emacs-lisp :var data2=2
14904    (message "data1:%S, data2:%S" data1 data2)
14905  #+END_SRC
14907  #+RESULTS:
14908  : data1:1, data2:2
14909 @end example
14911 Multi-line header arguments on a named code block:
14913 @example
14914    #+NAME: named-block
14915    #+HEADER: :var data=2
14916    #+BEGIN_SRC emacs-lisp
14917      (message "data:%S" data)
14918    #+END_SRC
14920    #+RESULTS: named-block
14921    : data:2
14922 @end example
14924 @node Header arguments in function calls
14925 @subsubheading Header arguments in function calls
14927 At the most specific level, header arguments for ``Library of Babel'' or
14928 @code{#+CALL:} lines can be set as shown in the two examples below.  For more
14929 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
14930 blocks}.
14932 The following will apply the @code{:exports results} header argument to the
14933 evaluation of the @code{#+CALL:} line.
14935 @example
14936 #+CALL: factorial(n=5) :exports results
14937 @end example
14939 The following will apply the @code{:session special} header argument to the
14940 evaluation of the @code{factorial} code block.
14942 @example
14943 #+CALL: factorial[:session special](n=5)
14944 @end example
14946 @node Specific header arguments
14947 @subsection Specific header arguments
14948 Header arguments consist of an initial colon followed by the name of the
14949 argument in lowercase letters.  The following header arguments are defined:
14951 @menu
14952 * var::                         Pass arguments to code blocks
14953 * Results::                     Specify the type of results and how they will
14954                                 be collected and handled
14955 * file::                        Specify a path for file output
14956 * file-desc::                   Specify a description for file results
14957 * file-ext::                    Specify an extension for file output
14958 * output-dir::                  Specify a directory to write file output to
14959 * dir::                         Specify the default (possibly remote)
14960                                 directory for code block execution
14961 * exports::                     Export code and/or results
14962 * tangle::                      Toggle tangling and specify file name
14963 * mkdirp::                      Toggle creation of parent directories of target
14964                                 files during tangling
14965 * comments::                    Toggle insertion of comments in tangled
14966                                 code files
14967 * padline::                     Control insertion of padding lines in tangled
14968                                 code files
14969 * no-expand::                   Turn off variable assignment and noweb
14970                                 expansion during tangling
14971 * session::                     Preserve the state of code evaluation
14972 * noweb::                       Toggle expansion of noweb references
14973 * noweb-ref::                   Specify block's noweb reference resolution target
14974 * noweb-sep::                   String used to separate noweb references
14975 * cache::                       Avoid re-evaluating unchanged code blocks
14976 * sep::                         Delimiter for writing tabular results outside Org
14977 * hlines::                      Handle horizontal lines in tables
14978 * colnames::                    Handle column names in tables
14979 * rownames::                    Handle row names in tables
14980 * shebang::                     Make tangled files executable
14981 * tangle-mode::                 Set permission of tangled files
14982 * eval::                        Limit evaluation of specific code blocks
14983 * wrap::                        Mark source block evaluation results
14984 * post::                        Post processing of code block results
14985 * prologue::                    Text to prepend to code block body
14986 * epilogue::                    Text to append to code block body
14987 @end menu
14989 Additional header arguments are defined on a language-specific basis, see
14990 @ref{Languages}.
14992 @node var
14993 @subsubsection @code{:var}
14994 @cindex @code{:var}, src header argument
14995 The @code{:var} header argument is used to pass arguments to code blocks.
14996 The specifics of how arguments are included in a code block vary by language;
14997 these are addressed in the language-specific documentation.  However, the
14998 syntax used to specify arguments is the same across all languages.  In every
14999 case, variables require a default value when they are declared.
15001 The values passed to arguments can either be literal values, references, or
15002 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
15003 References include anything in the Org mode file that takes a @code{#+NAME:}
15004 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
15005 other code blocks and the results of other code blocks.
15007 Note: When a reference is made to another code block, the referenced block
15008 will be evaluated unless it has current cached results (see @ref{cache}).
15010 Argument values can be indexed in a manner similar to arrays (see @ref{var,
15011 Indexable variable values}).
15013 The following syntax is used to pass arguments to code blocks using the
15014 @code{:var} header argument.
15016 @example
15017 :var name=assign
15018 @end example
15020 The argument, @code{assign}, can either be a literal value, such as a string
15021 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
15022 literal example, another code block (with or without arguments), or the
15023 results of evaluating another code block.
15025 Here are examples of passing values by reference:
15027 @table @dfn
15029 @item table
15030 an Org mode table named with either a @code{#+NAME:} line
15032 @example
15033 #+NAME: example-table
15034 | 1 |
15035 | 2 |
15036 | 3 |
15037 | 4 |
15039 #+NAME: table-length
15040 #+BEGIN_SRC emacs-lisp :var table=example-table
15041 (length table)
15042 #+END_SRC
15044 #+RESULTS: table-length
15045 : 4
15046 @end example
15048 @item list
15049 a simple list named with a @code{#+NAME:} line (note that nesting is not
15050 carried through to the source code block)
15052 @example
15053 #+NAME: example-list
15054   - simple
15055     - not
15056     - nested
15057   - list
15059 #+BEGIN_SRC emacs-lisp :var x=example-list
15060   (print x)
15061 #+END_SRC
15063 #+RESULTS:
15064 | simple | list |
15065 @end example
15067 @item code block without arguments
15068 a code block name (from the example above), as assigned by @code{#+NAME:},
15069 optionally followed by parentheses
15071 @example
15072 #+BEGIN_SRC emacs-lisp :var length=table-length()
15073 (* 2 length)
15074 #+END_SRC
15076 #+RESULTS:
15077 : 8
15078 @end example
15080 @item code block with arguments
15081 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
15082 optional arguments passed within the parentheses following the
15083 code block name using standard function call syntax
15085 @example
15086 #+NAME: double
15087 #+BEGIN_SRC emacs-lisp :var input=8
15088 (* 2 input)
15089 #+END_SRC
15091 #+RESULTS: double
15092 : 16
15094 #+NAME: squared
15095 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
15096 (* input input)
15097 #+END_SRC
15099 #+RESULTS: squared
15100 : 4
15101 @end example
15103 @item literal example
15104 a literal example block named with a @code{#+NAME:} line
15106 @example
15107 #+NAME: literal-example
15108 #+BEGIN_EXAMPLE
15109 A literal example
15110 on two lines
15111 #+END_EXAMPLE
15113 #+NAME: read-literal-example
15114 #+BEGIN_SRC emacs-lisp :var x=literal-example
15115   (concatenate 'string x " for you.")
15116 #+END_SRC
15118 #+RESULTS: read-literal-example
15119 : A literal example
15120 : on two lines for you.
15122 @end example
15124 @end table
15126 @subsubheading Indexable variable values
15127 It is possible to reference portions of variable values by ``indexing'' into
15128 the variables.  Indexes are 0 based with negative values counting back from
15129 the end.  If an index is separated by @code{,}s then each subsequent section
15130 will index into the next deepest nesting or dimension of the value.  Note
15131 that this indexing occurs @emph{before} other table related header arguments
15132 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied.  The
15133 following example assigns the last cell of the first row the table
15134 @code{example-table} to the variable @code{data}:
15136 @example
15137 #+NAME: example-table
15138 | 1 | a |
15139 | 2 | b |
15140 | 3 | c |
15141 | 4 | d |
15143 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
15144   data
15145 #+END_SRC
15147 #+RESULTS:
15148 : a
15149 @end example
15151 Ranges of variable values can be referenced using two integers separated by a
15152 @code{:}, in which case the entire inclusive range is referenced.  For
15153 example the following assigns the middle three rows of @code{example-table}
15154 to @code{data}.
15156 @example
15157 #+NAME: example-table
15158 | 1 | a |
15159 | 2 | b |
15160 | 3 | c |
15161 | 4 | d |
15162 | 5 | 3 |
15164 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
15165   data
15166 #+END_SRC
15168 #+RESULTS:
15169 | 2 | b |
15170 | 3 | c |
15171 | 4 | d |
15172 @end example
15174 Additionally, an empty index, or the single character @code{*}, are both
15175 interpreted to mean the entire range and as such are equivalent to
15176 @code{0:-1}, as shown in the following example in which the entire first
15177 column is referenced.
15179 @example
15180 #+NAME: example-table
15181 | 1 | a |
15182 | 2 | b |
15183 | 3 | c |
15184 | 4 | d |
15186 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
15187   data
15188 #+END_SRC
15190 #+RESULTS:
15191 | 1 | 2 | 3 | 4 |
15192 @end example
15194 It is possible to index into the results of code blocks as well as tables.
15195 Any number of dimensions can be indexed.  Dimensions are separated from one
15196 another by commas, as shown in the following example.
15198 @example
15199 #+NAME: 3D
15200 #+BEGIN_SRC emacs-lisp
15201   '(((1  2  3)  (4  5  6)  (7  8  9))
15202     ((10 11 12) (13 14 15) (16 17 18))
15203     ((19 20 21) (22 23 24) (25 26 27)))
15204 #+END_SRC
15206 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
15207   data
15208 #+END_SRC
15210 #+RESULTS:
15211 | 11 | 14 | 17 |
15212 @end example
15214 @subsubheading Emacs Lisp evaluation of variables
15216 Emacs lisp code can be used to initialize variable values.  When a variable
15217 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
15218 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
15219 the variable value.  The following example demonstrates use of this
15220 evaluation to reliably pass the file-name of the Org mode buffer to a code
15221 block---note that evaluation of header arguments is guaranteed to take place
15222 in the original Org mode file, while there is no such guarantee for
15223 evaluation of the code block body.
15225 @example
15226 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
15227   wc -w $filename
15228 #+END_SRC
15229 @end example
15231 Note that values read from tables and lists will not be evaluated as
15232 Emacs Lisp, as shown in the following example.
15234 @example
15235 #+NAME: table
15236 | (a b c) |
15238 #+HEADERS: :var data=table[0,0]
15239 #+BEGIN_SRC perl
15240   $data
15241 #+END_SRC
15243 #+RESULTS:
15244 : (a b c)
15245 @end example
15247 @node Results
15248 @subsubsection @code{:results}
15249 @cindex @code{:results}, src header argument
15251 There are four classes of @code{:results} header argument.  Only one option
15252 per class may be supplied per code block.
15254 @itemize @bullet
15255 @item
15256 @b{collection} header arguments specify how the results should be collected
15257 from the code block
15258 @item
15259 @b{type} header arguments specify what type of result the code block will
15260 return---which has implications for how they will be processed before
15261 insertion into the Org mode buffer
15262 @item
15263 @b{format} header arguments specify what type of result the code block will
15264 return---which has implications for how they will be inserted into the
15265 Org mode buffer
15266 @item
15267 @b{handling} header arguments specify how the results of evaluating the code
15268 block should be handled.
15269 @end itemize
15271 @subsubheading Collection
15272 The following options are mutually exclusive, and specify how the results
15273 should be collected from the code block.
15275 @itemize @bullet
15276 @item @code{value}
15277 This is the default.  The result is the value of the last statement in the
15278 code block.  This header argument places the evaluation in functional
15279 mode.  Note that in some languages, e.g., Python, use of this result type
15280 requires that a @code{return} statement be included in the body of the source
15281 code block.  E.g., @code{:results value}.
15282 @item @code{output}
15283 The result is the collection of everything printed to STDOUT during the
15284 execution of the code block.  This header argument places the
15285 evaluation in scripting mode.  E.g., @code{:results output}.
15286 @end itemize
15288 @subsubheading Type
15290 The following options are mutually exclusive and specify what type of results
15291 the code block will return.  By default, results are inserted as either a
15292 table or scalar depending on their value.
15294 @itemize @bullet
15295 @item @code{table}, @code{vector}
15296 The results should be interpreted as an Org mode table.  If a single value is
15297 returned, it will be converted into a table with one row and one column.
15298 E.g., @code{:results value table}.
15299 @item @code{list}
15300 The results should be interpreted as an Org mode list.  If a single scalar
15301 value is returned it will be converted into a list with only one element.
15302 @item @code{scalar}, @code{verbatim}
15303 The results should be interpreted literally---they will not be
15304 converted into a table.  The results will be inserted into the Org mode
15305 buffer as quoted text.  E.g., @code{:results value verbatim}.
15306 @item @code{file}
15307 The results will be interpreted as the path to a file, and will be inserted
15308 into the Org mode buffer as a file link.  E.g., @code{:results value file}.
15309 @end itemize
15311 @subsubheading Format
15313 The following options are mutually exclusive and specify what type of results
15314 the code block will return.  By default, results are inserted according to the
15315 type as specified above.
15317 @itemize @bullet
15318 @item @code{raw}
15319 The results are interpreted as raw Org mode code and are inserted directly
15320 into the buffer.  If the results look like a table they will be aligned as
15321 such by Org mode.  E.g., @code{:results value raw}.
15322 @item @code{org}
15323 The results are will be enclosed in a @code{BEGIN_SRC org} block.
15324 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
15325 in the block and/or if you export the file.  E.g., @code{:results value org}.
15326 @item @code{html}
15327 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
15328 block.  E.g., @code{:results value html}.
15329 @item @code{latex}
15330 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
15331 E.g., @code{:results value latex}.
15332 @item @code{code}
15333 Result are assumed to be parsable code and are enclosed in a code block.
15334 E.g., @code{:results value code}.
15335 @item @code{pp}
15336 The result is converted to pretty-printed code and is enclosed in a code
15337 block.  This option currently supports Emacs Lisp, Python, and Ruby.  E.g.,
15338 @code{:results value pp}.
15339 @item @code{drawer}
15340 The result is wrapped in a RESULTS drawer.  This can be useful for
15341 inserting @code{raw} or @code{org} syntax results in such a way that their
15342 extent is known and they can be automatically removed or replaced.
15343 @end itemize
15345 @subsubheading Handling
15346 The following results options indicate what happens with the
15347 results once they are collected.
15349 @itemize @bullet
15350 @item @code{silent}
15351 The results will be echoed in the minibuffer but will not be inserted into
15352 the Org mode buffer.  E.g., @code{:results output silent}.
15353 @item @code{replace}
15354 The default value.  Any existing results will be removed, and the new results
15355 will be inserted into the Org mode buffer in their place.  E.g.,
15356 @code{:results output replace}.
15357 @item @code{append}
15358 If there are pre-existing results of the code block then the new results will
15359 be appended to the existing results.  Otherwise the new results will be
15360 inserted as with @code{replace}.
15361 @item @code{prepend}
15362 If there are pre-existing results of the code block then the new results will
15363 be prepended to the existing results.  Otherwise the new results will be
15364 inserted as with @code{replace}.
15365 @end itemize
15367 @node file
15368 @subsubsection @code{:file}
15369 @cindex @code{:file}, src header argument
15371 The header argument @code{:file} is used to specify an external file in which
15372 to save code block results.  After code block evaluation an Org mode style
15373 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
15374 into the Org mode buffer.  Some languages including R, gnuplot, dot, and
15375 ditaa provide special handling of the @code{:file} header argument
15376 automatically wrapping the code block body in the boilerplate code required
15377 to save output to the specified file.  This is often useful for saving
15378 graphical output of a code block to the specified file.
15380 The argument to @code{:file} should be either a string specifying the path to
15381 a file, or a list of two strings in which case the first element of the list
15382 should be the path to a file and the second a description for the link.
15384 @node file-desc
15385 @subsubsection @code{:file-desc}
15387 The value of the @code{:file-desc} header argument is used to provide a
15388 description for file code block results which are inserted as Org mode links
15389 (see @ref{Link format}).  If the @code{:file-desc} header argument is given
15390 with no value the link path will be placed in both the ``link'' and the
15391 ``description'' portion of the Org mode link.
15393 @node file-ext
15394 @subsubsection @code{:file-ext}
15395 @cindex @code{:file-ext}, src header argument
15397 The value of the @code{:file-ext} header argument is used to provide an
15398 extension to write the file output to.  It is combined with the
15399 @code{#+NAME:} of the source block and the value of the @ref{output-dir}
15400 header argument to generate a complete file name.
15402 This header arg will be overridden by @code{:file}, and thus has no effect
15403 when the latter is specified.
15405 @node output-dir
15406 @subsubsection @code{:output-dir}
15407 @cindex @code{:output-dir}, src header argument
15409 The value of the @code{:output-dir} header argument is used to provide a
15410 directory to write the file output to.  It may specify an absolute directory
15411 (beginning with @code{/}) or a relative directory (without @code{/}).  It can
15412 be combined with the @code{#+NAME:} of the source block and the value of the
15413 @ref{file-ext} header argument to generate a complete file name, or used
15414 along with a @ref{file} header arg.
15416 @node dir
15417 @subsubsection @code{:dir} and remote execution
15418 @cindex @code{:dir}, src header argument
15420 While the @code{:file} header argument can be used to specify the path to the
15421 output file, @code{:dir} specifies the default directory during code block
15422 execution.  If it is absent, then the directory associated with the current
15423 buffer is used.  In other words, supplying @code{:dir path} temporarily has
15424 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
15425 then not supplying @code{:dir}.  Under the surface, @code{:dir} simply sets
15426 the value of the Emacs variable @code{default-directory}.
15428 When using @code{:dir}, you should supply a relative path for file output
15429 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
15430 case that path will be interpreted relative to the default directory.
15432 In other words, if you want your plot to go into a folder called @file{Work}
15433 in your home directory, you could use
15435 @example
15436 #+BEGIN_SRC R :file myplot.png :dir ~/Work
15437 matplot(matrix(rnorm(100), 10), type="l")
15438 #+END_SRC
15439 @end example
15441 @subsubheading Remote execution
15442 A directory on a remote machine can be specified using tramp file syntax, in
15443 which case the code will be evaluated on the remote machine.  An example is
15445 @example
15446 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
15447 plot(1:10, main=system("hostname", intern=TRUE))
15448 #+END_SRC
15449 @end example
15451 Text results will be returned to the local Org mode buffer as usual, and file
15452 output will be created on the remote machine with relative paths interpreted
15453 relative to the remote directory.  An Org mode link to the remote file will be
15454 created.
15456 So, in the above example a plot will be created on the remote machine,
15457 and a link of the following form will be inserted in the org buffer:
15459 @example
15460 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
15461 @end example
15463 Most of this functionality follows immediately from the fact that @code{:dir}
15464 sets the value of the Emacs variable @code{default-directory}, thanks to
15465 tramp.  Those using XEmacs, or GNU Emacs prior to version 23 may need to
15466 install tramp separately in order for these features to work correctly.
15468 @subsubheading Further points
15470 @itemize @bullet
15471 @item
15472 If @code{:dir} is used in conjunction with @code{:session}, although it will
15473 determine the starting directory for a new session as expected, no attempt is
15474 currently made to alter the directory associated with an existing session.
15475 @item
15476 @code{:dir} should typically not be used to create files during export with
15477 @code{:exports results} or @code{:exports both}.  The reason is that, in order
15478 to retain portability of exported material between machines, during export
15479 links inserted into the buffer will @emph{not} be expanded against @code{default
15480 directory}.  Therefore, if @code{default-directory} is altered using
15481 @code{:dir}, it is probable that the file will be created in a location to
15482 which the link does not point.
15483 @end itemize
15485 @node exports
15486 @subsubsection @code{:exports}
15487 @cindex @code{:exports}, src header argument
15489 The @code{:exports} header argument specifies what should be included in HTML
15490 or @LaTeX{} exports of the Org mode file.  Note that the @code{:exports}
15491 option is only relevant for code blocks, not inline code.
15493 @itemize @bullet
15494 @item @code{code}
15495 The default.  The body of code is included into the exported file.  E.g.,
15496 @code{:exports code}.
15497 @item @code{results}
15498 The result of evaluating the code is included in the exported file.  E.g.,
15499 @code{:exports results}.
15500 @item @code{both}
15501 Both the code and results are included in the exported file.  E.g.,
15502 @code{:exports both}.
15503 @item @code{none}
15504 Nothing is included in the exported file.  E.g., @code{:exports none}.
15505 @end itemize
15507 @node tangle
15508 @subsubsection @code{:tangle}
15509 @cindex @code{:tangle}, src header argument
15511 The @code{:tangle} header argument specifies whether or not the code
15512 block should be included in tangled extraction of source code files.
15514 @itemize @bullet
15515 @item @code{tangle}
15516 The code block is exported to a source code file named after the full path
15517 (including the directory) and file name (w/o extension) of the Org mode file.
15518 E.g., @code{:tangle yes}.
15519 @item @code{no}
15520 The default.  The code block is not exported to a source code file.
15521 E.g., @code{:tangle no}.
15522 @item other
15523 Any other string passed to the @code{:tangle} header argument is interpreted
15524 as a path (directory and file name relative to the directory of the Org mode
15525 file) to which the block will be exported.  E.g., @code{:tangle path}.
15526 @end itemize
15528 @node mkdirp
15529 @subsubsection @code{:mkdirp}
15530 @cindex @code{:mkdirp}, src header argument
15532 The @code{:mkdirp} header argument can be used to create parent directories
15533 of tangled files when missing.  This can be set to @code{yes} to enable
15534 directory creation or to @code{no} to inhibit directory creation.
15536 @node comments
15537 @subsubsection @code{:comments}
15538 @cindex @code{:comments}, src header argument
15539 By default code blocks are tangled to source-code files without any insertion
15540 of comments beyond those which may already exist in the body of the code
15541 block.  The @code{:comments} header argument can be set as follows to control
15542 the insertion of extra comments into the tangled code file.
15544 @itemize @bullet
15545 @item @code{no}
15546 The default.  No extra comments are inserted during tangling.
15547 @item @code{link}
15548 The code block is wrapped in comments which contain pointers back to the
15549 original Org file from which the code was tangled.
15550 @item @code{yes}
15551 A synonym for ``link'' to maintain backwards compatibility.
15552 @item @code{org}
15553 Include text from the Org mode file as a comment.
15554 The text is picked from the leading context of the tangled code and is
15555 limited by the nearest headline or source block as the case may be.
15556 @item @code{both}
15557 Turns on both the ``link'' and ``org'' comment options.
15558 @item @code{noweb}
15559 Turns on the ``link'' comment option, and additionally wraps expanded noweb
15560 references in the code block body in link comments.
15561 @end itemize
15563 @node padline
15564 @subsubsection @code{:padline}
15565 @cindex @code{:padline}, src header argument
15566 Control in insertion of padding lines around code block bodies in tangled
15567 code files.  The default value is @code{yes} which results in insertion of
15568 newlines before and after each tangled code block.  The following arguments
15569 are accepted.
15571 @itemize @bullet
15572 @item @code{yes}
15573 Insert newlines before and after each code block body in tangled code files.
15574 @item @code{no}
15575 Do not insert any newline padding in tangled output.
15576 @end itemize
15578 @node no-expand
15579 @subsubsection @code{:no-expand}
15580 @cindex @code{:no-expand}, src header argument
15582 By default, code blocks are expanded with @code{org-babel-expand-src-block}
15583 during tangling.  This has the effect of assigning values to variables
15584 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
15585 references (see @ref{Noweb reference syntax}) with their targets.  The
15586 @code{:no-expand} header argument can be used to turn off this behavior.
15587 Note: The @code{:no-expand} header argument has no impact on export,
15588 i.e. code blocks will irrespective of this header argument expanded for
15589 execution.
15591 @node session
15592 @subsubsection @code{:session}
15593 @cindex @code{:session}, src header argument
15595 The @code{:session} header argument starts a (possibly named) session for an
15596 interpreted language where the interpreter’s state is preserved.  All code
15597 blocks sharing the same name are exectuted by the same interpreter process.
15598 By default, a session is not started.
15600 @itemize @bullet
15601 @item @code{none}
15602 The default.  Each block is evaluated in its own interpreter process, which
15603 is terminated after the evaluation.
15604 @item @code{other}
15605 Any other string passed to the @code{:session} header argument will give the
15606 session a name.  For example, @code{:session mysession}.  If @code{:session}
15607 is given but no name string is specified, the session is named according to
15608 the language used in the block.  All blocks with the same session name share
15609 the same session.  Using different session names enables concurrent sessions
15610 (even for the same interpreted language).
15612 @end itemize
15614 @node noweb
15615 @subsubsection @code{:noweb}
15616 @cindex @code{:noweb}, src header argument
15618 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
15619 references (see @ref{Noweb reference syntax}) when the code block is
15620 evaluated, tangled, or exported.  The @code{:noweb} header argument can have
15621 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
15622 @code{no-export} @code{strip-export}.
15624 @itemize @bullet
15625 @item @code{no}
15626 The default.  ``Noweb'' syntax references in the body of the code block will
15627 not be expanded before the code block is evaluated, tangled or exported.
15628 @item @code{yes}
15629 ``Noweb'' syntax references in the body of the code block will be
15630 expanded before the code block is evaluated, tangled or exported.
15631 @item @code{tangle}
15632 ``Noweb'' syntax references in the body of the code block will be expanded
15633 before the code block is tangled.  However, ``noweb'' syntax references will
15634 not be expanded when the code block is evaluated or exported.
15635 @item @code{no-export}
15636 ``Noweb'' syntax references in the body of the code block will be expanded
15637 before the block is evaluated or tangled.  However, ``noweb'' syntax
15638 references will not be expanded when the code block is exported.
15639 @item @code{strip-export}
15640 ``Noweb'' syntax references in the body of the code block will be expanded
15641 before the block is evaluated or tangled.  However, ``noweb'' syntax
15642 references will be removed when the code block is exported.
15643 @item @code{eval}
15644 ``Noweb'' syntax references in the body of the code block will only be
15645 expanded before the block is evaluated.
15646 @end itemize
15648 @subsubheading Noweb prefix lines
15649 Noweb insertions are now placed behind the line prefix of the
15650 @code{<<reference>>}.
15651 This behavior is illustrated in the following example.  Because the
15652 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
15653 each line of the expanded noweb reference will be commented.
15655 This code block:
15657 @example
15658 -- <<example>>
15659 @end example
15661 expands to:
15663 @example
15664 -- this is the
15665 -- multi-line body of example
15666 @end example
15668 Note that noweb replacement text that does not contain any newlines will not
15669 be affected by this change, so it is still possible to use inline noweb
15670 references.
15672 @node noweb-ref
15673 @subsubsection @code{:noweb-ref}
15674 @cindex @code{:noweb-ref}, src header argument
15675 When expanding ``noweb'' style references, the bodies of all code block with
15676 @emph{either} a block name matching the reference name @emph{or} a
15677 @code{:noweb-ref} header argument matching the reference name will be
15678 concatenated together to form the replacement text.
15680 By setting this header argument at the subtree or file level, simple code
15681 block concatenation may be achieved.  For example, when tangling the
15682 following Org mode file, the bodies of code blocks will be concatenated into
15683 the resulting pure code file@footnote{(The example needs property inheritance
15684 to be turned on for the @code{noweb-ref} property, see @ref{Property
15685 inheritance}).}.
15687 @example
15688  #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
15689    <<fullest-disk>>
15690  #+END_SRC
15691  * the mount point of the fullest disk
15692    :PROPERTIES:
15693    :noweb-ref: fullest-disk
15694    :END:
15696  ** query all mounted disks
15697  #+BEGIN_SRC sh
15698    df \
15699  #+END_SRC
15701  ** strip the header row
15702  #+BEGIN_SRC sh
15703    |sed '1d' \
15704  #+END_SRC
15706  ** sort by the percent full
15707  #+BEGIN_SRC sh
15708    |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
15709  #+END_SRC
15711  ** extract the mount point
15712  #+BEGIN_SRC sh
15713    |awk '@{print $2@}'
15714  #+END_SRC
15715 @end example
15717 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
15718 used to separate accumulate noweb references like those above.  By default a
15719 newline is used.
15721 @node noweb-sep
15722 @subsubsection @code{:noweb-sep}
15723 @cindex @code{:noweb-sep}, src header argument
15725 The @code{:noweb-sep} header argument holds the string used to separate
15726 accumulate noweb references (see @ref{noweb-ref}).  By default a newline is
15727 used.
15729 @node cache
15730 @subsubsection @code{:cache}
15731 @cindex @code{:cache}, src header argument
15733 The @code{:cache} header argument controls the use of in-buffer caching of
15734 the results of evaluating code blocks.  It can be used to avoid re-evaluating
15735 unchanged code blocks.  Note that the @code{:cache} header argument will not
15736 attempt to cache results when the @code{:session} header argument is used,
15737 because the results of the code block execution may be stored in the session
15738 outside of the Org mode buffer.  The @code{:cache} header argument can have
15739 one of two values: @code{yes} or @code{no}.
15741 @itemize @bullet
15742 @item @code{no}
15743 The default.  No caching takes place, and the code block will be evaluated
15744 every time it is called.
15745 @item @code{yes}
15746 Every time the code block is run a SHA1 hash of the code and arguments
15747 passed to the block will be generated.  This hash is packed into the
15748 @code{#+RESULTS:} line and will be checked on subsequent
15749 executions of the code block.  If the code block has not
15750 changed since the last time it was evaluated, it will not be re-evaluated.
15751 @end itemize
15753 Code block caches notice if the value of a variable argument
15754 to the code block has changed.  If this is the case, the cache is
15755 invalidated and the code block is re-run.  In the following example,
15756 @code{caller} will not be re-run unless the results of @code{random} have
15757 changed since it was last run.
15759 @example
15760  #+NAME: random
15761  #+BEGIN_SRC R :cache yes
15762  runif(1)
15763  #+END_SRC
15765  #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
15766  0.4659510825295
15768  #+NAME: caller
15769  #+BEGIN_SRC emacs-lisp :var x=random :cache yes
15771  #+END_SRC
15773  #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
15774  0.254227238707244
15775 @end example
15777 @node sep
15778 @subsubsection @code{:sep}
15779 @cindex @code{:sep}, src header argument
15781 The @code{:sep} header argument can be used to control the delimiter used
15782 when writing tabular results out to files external to Org mode.  This is used
15783 either when opening tabular results of a code block by calling the
15784 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
15785 or when writing code block results to an external file (see @ref{file})
15786 header argument.
15788 By default, when @code{:sep} is not specified output tables are tab
15789 delimited.
15791 @node hlines
15792 @subsubsection @code{:hlines}
15793 @cindex @code{:hlines}, src header argument
15795 Tables are frequently represented with one or more horizontal lines, or
15796 hlines.  The @code{:hlines} argument to a code block accepts the
15797 values @code{yes} or @code{no}, with a default value of @code{no}.
15799 @itemize @bullet
15800 @item @code{no}
15801 Strips horizontal lines from the input table.  In most languages this is the
15802 desired effect because an @code{hline} symbol is interpreted as an unbound
15803 variable and raises an error.  Setting @code{:hlines no} or relying on the
15804 default value yields the following results.
15806 @example
15807 #+NAME: many-cols
15808 | a | b | c |
15809 |---+---+---|
15810 | d | e | f |
15811 |---+---+---|
15812 | g | h | i |
15814 #+NAME: echo-table
15815 #+BEGIN_SRC python :var tab=many-cols
15816   return tab
15817 #+END_SRC
15819 #+RESULTS: echo-table
15820 | a | b | c |
15821 | d | e | f |
15822 | g | h | i |
15823 @end example
15825 @item @code{yes}
15826 Leaves hlines in the table.  Setting @code{:hlines yes} has this effect.
15828 @example
15829 #+NAME: many-cols
15830 | a | b | c |
15831 |---+---+---|
15832 | d | e | f |
15833 |---+---+---|
15834 | g | h | i |
15836 #+NAME: echo-table
15837 #+BEGIN_SRC python :var tab=many-cols :hlines yes
15838   return tab
15839 #+END_SRC
15841 #+RESULTS: echo-table
15842 | a | b | c |
15843 |---+---+---|
15844 | d | e | f |
15845 |---+---+---|
15846 | g | h | i |
15847 @end example
15848 @end itemize
15850 @node colnames
15851 @subsubsection @code{:colnames}
15852 @cindex @code{:colnames}, src header argument
15854 The @code{:colnames} header argument accepts the values @code{yes},
15855 @code{no}, or @code{nil} for unassigned.  The default value is @code{nil}.
15856 Note that the behavior of the @code{:colnames} header argument may differ
15857 across languages.
15859 @itemize @bullet
15860 @item @code{nil}
15861 If an input table looks like it has column names
15862 (because its second row is an hline), then the column
15863 names will be removed from the table before
15864 processing, then reapplied to the results.
15866 @example
15867 #+NAME: less-cols
15868 | a |
15869 |---|
15870 | b |
15871 | c |
15873 #+NAME: echo-table-again
15874 #+BEGIN_SRC python :var tab=less-cols
15875   return [[val + '*' for val in row] for row in tab]
15876 #+END_SRC
15878 #+RESULTS: echo-table-again
15879 | a  |
15880 |----|
15881 | b* |
15882 | c* |
15883 @end example
15885 Please note that column names are not removed before the table is indexed
15886 using variable indexing @xref{var, Indexable variable values}.
15888 @item @code{no}
15889 No column name pre-processing takes place
15891 @item @code{yes}
15892 Column names are removed and reapplied as with @code{nil} even if the table
15893 does not ``look like'' it has column names (i.e., the second row is not an
15894 hline)
15895 @end itemize
15897 @node rownames
15898 @subsubsection @code{:rownames}
15899 @cindex @code{:rownames}, src header argument
15901 The @code{:rownames} header argument can take on the values @code{yes} or
15902 @code{no}, with a default value of @code{no}.  Note that Emacs Lisp code
15903 blocks ignore the @code{:rownames} header argument entirely given the ease
15904 with which tables with row names may be handled directly in Emacs Lisp.
15906 @itemize @bullet
15907 @item @code{no}
15908 No row name pre-processing will take place.
15910 @item @code{yes}
15911 The first column of the table is removed from the table before processing,
15912 and is then reapplied to the results.
15914 @example
15915 #+NAME: with-rownames
15916 | one | 1 | 2 | 3 | 4 |  5 |
15917 | two | 6 | 7 | 8 | 9 | 10 |
15919 #+NAME: echo-table-once-again
15920 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
15921   return [[val + 10 for val in row] for row in tab]
15922 #+END_SRC
15924 #+RESULTS: echo-table-once-again
15925 | one | 11 | 12 | 13 | 14 | 15 |
15926 | two | 16 | 17 | 18 | 19 | 20 |
15927 @end example
15929 Please note that row names are not removed before the table is indexed using
15930 variable indexing @xref{var, Indexable variable values}.
15932 @end itemize
15934 @node shebang
15935 @subsubsection @code{:shebang}
15936 @cindex @code{:shebang}, src header argument
15938 Setting the @code{:shebang} header argument to a string value
15939 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
15940 first line of any tangled file holding the code block, and the file
15941 permissions of the tangled file are set to make it executable.
15944 @node tangle-mode
15945 @subsubsection @code{:tangle-mode}
15946 @cindex @code{:tangle-mode}, src header argument
15948 The @code{tangle-mode} header argument controls the permission set on tangled
15949 files.  The value of this header argument will be passed to
15950 @code{set-file-modes}.  For example, to set a tangled file as read only use
15951 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
15952 use @code{:tangle-mode (identity #o755)}.  Blocks with @code{shebang}
15953 (@ref{shebang}) header arguments will automatically be made executable unless
15954 the @code{tangle-mode} header argument is also used.  The behavior is
15955 undefined if multiple code blocks with different values for the
15956 @code{tangle-mode} header argument are tangled to the same file.
15958 @node eval
15959 @subsubsection @code{:eval}
15960 @cindex @code{:eval}, src header argument
15961 The @code{:eval} header argument can be used to limit the evaluation of
15962 specific code blocks.  The @code{:eval} header argument can be useful for
15963 protecting against the evaluation of dangerous code blocks or to ensure that
15964 evaluation will require a query regardless of the value of the
15965 @code{org-confirm-babel-evaluate} variable.  The possible values of
15966 @code{:eval} and their effects are shown below.
15968 @table @code
15969 @item never or no
15970 The code block will not be evaluated under any circumstances.
15971 @item query
15972 Evaluation of the code block will require a query.
15973 @item never-export or no-export
15974 The code block will not be evaluated during export but may still be called
15975 interactively.
15976 @item query-export
15977 Evaluation of the code block during export will require a query.
15978 @end table
15980 If this header argument is not set then evaluation is determined by the value
15981 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
15982 security}.
15984 @node wrap
15985 @subsubsection @code{:wrap}
15986 @cindex @code{:wrap}, src header argument
15987 The @code{:wrap} header argument is used to mark the results of source block
15988 evaluation.  The header argument can be passed a string that will be appended
15989 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
15990 results.  If not string is specified then the results will be wrapped in a
15991 @code{#+BEGIN/END_RESULTS} block.
15993 @node post
15994 @subsubsection @code{:post}
15995 @cindex @code{:post}, src header argument
15996 The @code{:post} header argument is used to post-process the results of a
15997 code block execution.  When a post argument is given, the results of the code
15998 block will temporarily be bound to the @code{*this*} variable.  This variable
15999 may then be included in header argument forms such as those used in @ref{var}
16000 header argument specifications allowing passing of results to other code
16001 blocks, or direct execution via Emacs Lisp.  Additional header arguments may
16002 be passed to the @code{:post}-function.
16004 The following two examples illustrate the usage of the @code{:post} header
16005 argument.  The first example shows how to attach a attribute-line via @code{:post}.
16007 @example
16008 #+name: attr_wrap
16009 #+begin_src sh :var data="" :var width="\\textwidth" :results output
16010   echo "#+ATTR_LATEX :width $width"
16011   echo "$data"
16012 #+end_src
16014 #+header: :file /tmp/it.png
16015 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
16016   digraph@{
16017           a -> b;
16018           b -> c;
16019           c -> a;
16020   @}
16021 #+end_src
16023 #+RESULTS:
16024 :RESULTS:
16025 #+ATTR_LATEX :width 5cm
16026 [[file:/tmp/it.png]]
16027 :END:
16028 @end example
16030 The second examples shows how to use @code{:post} together with the
16031 @code{:colnames} header argument.
16032 @example
16033 #+name: round-tbl
16034 #+begin_src emacs-lisp :var tbl="" fmt="%.3f"
16035   (mapcar (lambda (row)
16036             (mapcar (lambda (cell)
16037                       (if (numberp cell)
16038                           (format fmt cell)
16039                         cell))
16040                     row))
16041           tbl)
16042 #+end_src
16044 #+begin_src R :colnames yes :post round-tbl[:colnames yes](*this*)
16045 set.seed(42)
16046 data.frame(foo=rnorm(1))
16047 #+end_src
16049 #+RESULTS:
16050 |   foo |
16051 |-------|
16052 | 1.371 |
16053 @end example
16055 @node prologue
16056 @subsubsection @code{:prologue}
16057 @cindex @code{:prologue}, src header argument
16058 The value of the @code{prologue} header argument will be prepended to the
16059 code block body before execution.  For example, @code{:prologue "reset"} may
16060 be used to reset a gnuplot session before execution of a particular code
16061 block, or the following configuration may be used to do this for all gnuplot
16062 code blocks.  Also see @ref{epilogue}.
16064 @lisp
16065 (add-to-list 'org-babel-default-header-args:gnuplot
16066              '((:prologue . "reset")))
16067 @end lisp
16069 @node epilogue
16070 @subsubsection @code{:epilogue}
16071 @cindex @code{:epilogue}, src header argument
16072 The value of the @code{epilogue} header argument will be appended to the code
16073 block body before execution.  Also see @ref{prologue}.
16075 @node Results of evaluation
16076 @section Results of evaluation
16077 @cindex code block, results of evaluation
16078 @cindex source code, results of evaluation
16080 The way in which results are handled depends on whether a session is invoked,
16081 as well as on whether @code{:results value} or @code{:results output} is
16082 used.  The following table shows the table possibilities.  For a full listing
16083 of the possible results header arguments see @ref{Results}.
16085 @multitable @columnfractions 0.26 0.33 0.41
16086 @item @tab @b{Non-session} @tab @b{Session}
16087 @item @code{:results value} @tab value of last expression @tab value of last expression
16088 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
16089 @end multitable
16091 Note: With @code{:results value}, the result in both @code{:session} and
16092 non-session is returned to Org mode as a table (a one- or two-dimensional
16093 vector of strings or numbers) when appropriate.
16095 @subsection Non-session
16096 @subsubsection @code{:results value}
16097 @cindex @code{:results}, src header argument
16098 This is the default.  Internally, the value is obtained by wrapping the code
16099 in a function definition in the external language, and evaluating that
16100 function.  Therefore, code should be written as if it were the body of such a
16101 function.  In particular, note that Python does not automatically return a
16102 value from a function unless a @code{return} statement is present, and so a
16103 @samp{return} statement will usually be required in Python.
16105 This is the only one of the four evaluation contexts in which the code is
16106 automatically wrapped in a function definition.
16108 @subsubsection @code{:results output}
16109 @cindex @code{:results}, src header argument
16110 The code is passed to the interpreter as an external process, and the
16111 contents of the standard output stream are returned as text.  (In certain
16112 languages this also contains the error output stream; this is an area for
16113 future work.)
16115 @subsection Session
16116 @subsubsection @code{:results value}
16117 @cindex @code{:results}, src header argument
16118 The code is passed to an interpreter running as an interactive Emacs inferior
16119 process.  Only languages which provide tools for interactive evaluation of
16120 code have session support, so some language (e.g., C and ditaa) do not
16121 support the @code{:session} header argument, and in other languages (e.g.,
16122 Python and Haskell) which have limitations on the code which may be entered
16123 into interactive sessions, those limitations apply to the code in code blocks
16124 using the @code{:session} header argument as well.
16126 Unless the @code{:results output} option is supplied (see below) the result
16127 returned is the result of the last evaluation performed by the
16128 interpreter.  (This is obtained in a language-specific manner: the value of
16129 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
16130 in R).
16132 @subsubsection @code{:results output}
16133 @cindex @code{:results}, src header argument
16134 The code is passed to the interpreter running as an interactive Emacs
16135 inferior process.  The result returned is the concatenation of the sequence of
16136 (text) output from the interactive interpreter.  Notice that this is not
16137 necessarily the same as what would be sent to @code{STDOUT} if the same code
16138 were passed to a non-interactive interpreter running as an external
16139 process.  For example, compare the following two blocks:
16141 @example
16142 #+BEGIN_SRC python :results output
16143  print "hello"
16145  print "bye"
16146 #+END_SRC
16148 #+RESULTS:
16149 : hello
16150 : bye
16151 @end example
16153 In non-session mode, the `2' is not printed and does not appear.
16155 @example
16156 #+BEGIN_SRC python :results output :session
16157  print "hello"
16159  print "bye"
16160 #+END_SRC
16162 #+RESULTS:
16163 : hello
16164 : 2
16165 : bye
16166 @end example
16168 But in @code{:session} mode, the interactive interpreter receives input `2'
16169 and prints out its value, `2'.  (Indeed, the other print statements are
16170 unnecessary here).
16172 @node Noweb reference syntax
16173 @section Noweb reference syntax
16174 @cindex code block, noweb reference
16175 @cindex syntax, noweb
16176 @cindex source code, noweb reference
16178 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
16179 Programming system allows named blocks of code to be referenced by using the
16180 familiar Noweb syntax:
16182 @example
16183 <<code-block-name>>
16184 @end example
16186 When a code block is tangled or evaluated, whether or not ``noweb''
16187 references are expanded depends upon the value of the @code{:noweb} header
16188 argument.  If @code{:noweb yes}, then a Noweb reference is expanded before
16189 evaluation.  If @code{:noweb no}, the default, then the reference is not
16190 expanded before evaluation.  See the @ref{noweb-ref} header argument for
16191 a more flexible way to resolve noweb references.
16193 It is possible to include the @emph{results} of a code block rather than the
16194 body.  This is done by appending parenthesis to the code block name which may
16195 optionally contain arguments to the code block as shown below.
16197 @example
16198 <<code-block-name(optional arguments)>>
16199 @end example
16201 Note: the default value, @code{:noweb no}, was chosen to ensure that
16202 correct code is not broken in a language, such as Ruby, where
16203 @code{<<arg>>} is a syntactically valid construct.  If @code{<<arg>>} is not
16204 syntactically valid in languages that you use, then please consider setting
16205 the default value.
16207 Note: if noweb tangling is slow in large Org mode files consider setting the
16208 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
16209 This will result in faster noweb reference resolution at the expense of not
16210 correctly resolving inherited values of the @code{:noweb-ref} header
16211 argument.
16213 @node Key bindings and useful functions
16214 @section Key bindings and useful functions
16215 @cindex code block, key bindings
16217 Many common Org mode key sequences are re-bound depending on
16218 the context.
16220 Within a code block, the following key bindings
16221 are active:
16223 @multitable @columnfractions 0.25 0.75
16224 @kindex C-c C-c
16225 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
16226 @kindex C-c C-o
16227 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
16228 @kindex M-up
16229 @item @kbd{M-@key{up}}    @tab @code{org-babel-load-in-session}
16230 @kindex M-down
16231 @item @kbd{M-@key{down}}  @tab @code{org-babel-switch-to-session}
16232 @end multitable
16234 In an Org mode buffer, the following key bindings are active:
16236 @multitable @columnfractions 0.45 0.55
16237 @kindex C-c C-v p
16238 @kindex C-c C-v C-p
16239 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
16240 @kindex C-c C-v n
16241 @kindex C-c C-v C-n
16242 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
16243 @kindex C-c C-v e
16244 @kindex C-c C-v C-e
16245 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
16246 @kindex C-c C-v o
16247 @kindex C-c C-v C-o
16248 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
16249 @kindex C-c C-v v
16250 @kindex C-c C-v C-v
16251 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
16252 @kindex C-c C-v u
16253 @kindex C-c C-v C-u
16254 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
16255 @kindex C-c C-v g
16256 @kindex C-c C-v C-g
16257 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
16258 @kindex C-c C-v r
16259 @kindex C-c C-v C-r
16260 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
16261 @kindex C-c C-v b
16262 @kindex C-c C-v C-b
16263 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16264 @kindex C-c C-v s
16265 @kindex C-c C-v C-s
16266 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16267 @kindex C-c C-v d
16268 @kindex C-c C-v C-d
16269 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
16270 @kindex C-c C-v t
16271 @kindex C-c C-v C-t
16272 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16273 @kindex C-c C-v f
16274 @kindex C-c C-v C-f
16275 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16276 @kindex C-c C-v c
16277 @kindex C-c C-v C-c
16278 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
16279 @kindex C-c C-v j
16280 @kindex C-c C-v C-j
16281 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
16282 @kindex C-c C-v l
16283 @kindex C-c C-v C-l
16284 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
16285 @kindex C-c C-v i
16286 @kindex C-c C-v C-i
16287 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
16288 @kindex C-c C-v I
16289 @kindex C-c C-v C-I
16290 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
16291 @kindex C-c C-v z
16292 @kindex C-c C-v C-z
16293 @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}
16294 @kindex C-c C-v a
16295 @kindex C-c C-v C-a
16296 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16297 @kindex C-c C-v h
16298 @kindex C-c C-v C-h
16299 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
16300 @kindex C-c C-v x
16301 @kindex C-c C-v C-x
16302 @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}
16303 @end multitable
16305 @c When possible these keybindings were extended to work when the control key is
16306 @c kept pressed, resulting in the following additional keybindings.
16308 @c @multitable @columnfractions 0.25 0.75
16309 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16310 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16311 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16312 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
16313 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
16314 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16315 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16316 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
16317 @c @end multitable
16319 @node Batch execution
16320 @section Batch execution
16321 @cindex code block, batch execution
16322 @cindex source code, batch execution
16324 It is possible to call functions from the command line.  This shell
16325 script calls @code{org-babel-tangle} on every one of its arguments.
16327 Be sure to adjust the paths to fit your system.
16329 @example
16330 #!/bin/sh
16331 # -*- mode: shell-script -*-
16333 # tangle files with org-mode
16335 DIR=`pwd`
16336 FILES=""
16338 # wrap each argument in the code required to call tangle on it
16339 for i in $@@; do
16340     FILES="$FILES \"$i\""
16341 done
16343 emacs -Q --batch \
16344 --eval "(progn
16345 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
16346 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
16347 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
16348 (mapc (lambda (file)
16349        (find-file (expand-file-name file \"$DIR\"))
16350        (org-babel-tangle)
16351        (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
16352 @end example
16354 @node Miscellaneous
16355 @chapter Miscellaneous
16357 @menu
16358 * Completion::                  M-TAB knows what you need
16359 * Easy templates::              Quick insertion of structural elements
16360 * Speed keys::                  Electric commands at the beginning of a headline
16361 * Code evaluation security::    Org mode files evaluate inline code
16362 * Customization::               Adapting Org to your taste
16363 * In-buffer settings::          Overview of the #+KEYWORDS
16364 * The very busy C-c C-c key::   When in doubt, press C-c C-c
16365 * Clean view::                  Getting rid of leading stars in the outline
16366 * TTY keys::                    Using Org on a tty
16367 * Interaction::                 Other Emacs packages
16368 * org-crypt::                   Encrypting Org files
16369 @end menu
16372 @node Completion
16373 @section Completion
16374 @cindex completion, of @TeX{} symbols
16375 @cindex completion, of TODO keywords
16376 @cindex completion, of dictionary words
16377 @cindex completion, of option keywords
16378 @cindex completion, of tags
16379 @cindex completion, of property keys
16380 @cindex completion, of link abbreviations
16381 @cindex @TeX{} symbol completion
16382 @cindex TODO keywords completion
16383 @cindex dictionary word completion
16384 @cindex option keyword completion
16385 @cindex tag completion
16386 @cindex link abbreviations, completion of
16388 Emacs would not be Emacs without completion, and Org mode uses it whenever it
16389 makes sense.  If you prefer an @i{iswitchb}- or @i{ido}-like interface for
16390 some of the completion prompts, you can specify your preference by setting at
16391 most one of the variables @code{org-completion-use-iswitchb}
16392 @code{org-completion-use-ido}.
16394 Org supports in-buffer completion.  This type of completion does
16395 not make use of the minibuffer.  You simply type a few letters into
16396 the buffer and use the key to complete text right there.
16398 @table @kbd
16399 @kindex M-@key{TAB}
16400 @item M-@key{TAB}
16401 Complete word at point
16402 @itemize @bullet
16403 @item
16404 At the beginning of a headline, complete TODO keywords.
16405 @item
16406 After @samp{\}, complete @TeX{} symbols supported by the exporter.
16407 @item
16408 After @samp{*}, complete headlines in the current buffer so that they
16409 can be used in search links like @samp{[[*find this headline]]}.
16410 @item
16411 After @samp{:} in a headline, complete tags.  The list of tags is taken
16412 from the variable @code{org-tag-alist} (possibly set through the
16413 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
16414 dynamically from all tags used in the current buffer.
16415 @item
16416 After @samp{:} and not in a headline, complete property keys.  The list
16417 of keys is constructed dynamically from all keys used in the current
16418 buffer.
16419 @item
16420 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
16421 @item
16422 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
16423 @samp{OPTIONS} which set file-specific options for Org mode.  When the
16424 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
16425 will insert example settings for this keyword.
16426 @item
16427 In the line after @samp{#+STARTUP: }, complete startup keywords,
16428 i.e., valid keys for this line.
16429 @item
16430 Elsewhere, complete dictionary words using Ispell.
16431 @end itemize
16432 @end table
16434 @node Easy templates
16435 @section Easy templates
16436 @cindex template insertion
16437 @cindex insertion, of templates
16439 Org mode supports insertion of empty structural elements (like
16440 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
16441 strokes.  This is achieved through a native template expansion mechanism.
16442 Note that Emacs has several other template mechanisms which could be used in
16443 a similar way, for example @file{yasnippet}.
16445 To insert a structural element, type a @samp{<}, followed by a template
16446 selector and @kbd{@key{TAB}}.  Completion takes effect only when the above
16447 keystrokes are typed on a line by itself.
16449 The following template selectors are currently supported.
16451 @multitable @columnfractions 0.1 0.9
16452 @item @kbd{s} @tab @code{#+BEGIN_SRC     ... #+END_SRC}
16453 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
16454 @item @kbd{q} @tab @code{#+BEGIN_QUOTE   ... #+END_QUOTE}
16455 @item @kbd{v} @tab @code{#+BEGIN_VERSE   ... #+END_VERSE}
16456 @item @kbd{c} @tab @code{#+BEGIN_CENTER  ... #+END_CENTER}
16457 @item @kbd{l} @tab @code{#+BEGIN_LaTeX   ... #+END_LaTeX}
16458 @item @kbd{L} @tab @code{#+LaTeX:}
16459 @item @kbd{h} @tab @code{#+BEGIN_HTML    ... #+END_HTML}
16460 @item @kbd{H} @tab @code{#+HTML:}
16461 @item @kbd{a} @tab @code{#+BEGIN_ASCII   ... #+END_ASCII}
16462 @item @kbd{A} @tab @code{#+ASCII:}
16463 @item @kbd{i} @tab @code{#+INDEX:} line
16464 @item @kbd{I} @tab @code{#+INCLUDE:} line
16465 @end multitable
16467 For example, on an empty line, typing "<e" and then pressing TAB, will expand
16468 into a complete EXAMPLE template.
16470 You can install additional templates by customizing the variable
16471 @code{org-structure-template-alist}.  See the docstring of the variable for
16472 additional details.
16474 @node Speed keys
16475 @section Speed keys
16476 @cindex speed keys
16477 @vindex org-use-speed-commands
16478 @vindex org-speed-commands-user
16480 Single keys can be made to execute commands when the cursor is at the
16481 beginning of a headline, i.e., before the first star.  Configure the variable
16482 @code{org-use-speed-commands} to activate this feature.  There is a
16483 pre-defined list of commands, and you can add more such commands using the
16484 variable @code{org-speed-commands-user}.  Speed keys not only speed up
16485 navigation and other commands, but they also provide an alternative way to
16486 execute commands bound to keys that are not or not easily available on a TTY,
16487 or on a small mobile device with a limited keyboard.
16489 To see which commands are available, activate the feature and press @kbd{?}
16490 with the cursor at the beginning of a headline.
16492 @node Code evaluation security
16493 @section Code evaluation and security issues
16495 Org provides tools to work with code snippets, including evaluating them.
16497 Running code on your machine always comes with a security risk.  Badly
16498 written or malicious code can be executed on purpose or by accident.  Org has
16499 default settings which will only evaluate such code if you give explicit
16500 permission to do so, and as a casual user of these features you should leave
16501 these precautions intact.
16503 For people who regularly work with such code, the confirmation prompts can
16504 become annoying, and you might want to turn them off.  This can be done, but
16505 you must be aware of the risks that are involved.
16507 Code evaluation can happen under the following circumstances:
16509 @table @i
16510 @item Source code blocks
16511 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
16512 C-c} in the block.  The most important thing to realize here is that Org mode
16513 files which contain code snippets are, in a certain sense, like executable
16514 files.  So you should accept them and load them into Emacs only from trusted
16515 sources---just like you would do with a program you install on your computer.
16517 Make sure you know what you are doing before customizing the variables
16518 which take off the default security brakes.
16520 @defopt org-confirm-babel-evaluate
16521 When t (the default), the user is asked before every code block evaluation.
16522 When @code{nil}, the user is not asked.  When set to a function, it is called with
16523 two arguments (language and body of the code block) and should return t to
16524 ask and @code{nil} not to ask.
16525 @end defopt
16527 For example, here is how to execute "ditaa" code (which is considered safe)
16528 without asking:
16530 @lisp
16531 (defun my-org-confirm-babel-evaluate (lang body)
16532   (not (string= lang "ditaa")))  ; don't ask for ditaa
16533 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
16534 @end lisp
16536 @item Following @code{shell} and @code{elisp} links
16537 Org has two link types that can directly evaluate code (@pxref{External
16538 links}).  These links can be problematic because the code to be evaluated is
16539 not visible.
16541 @defopt org-confirm-shell-link-function
16542 Function to queries user about shell link execution.
16543 @end defopt
16544 @defopt org-confirm-elisp-link-function
16545 Functions to query user for Emacs Lisp link execution.
16546 @end defopt
16548 @item Formulas in tables
16549 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
16550 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
16551 @end table
16553 @node Customization
16554 @section Customization
16555 @cindex customization
16556 @cindex options, for customization
16557 @cindex variables, for customization
16559 There are more than 500 variables that can be used to customize
16560 Org.  For the sake of compactness of the manual, I am not
16561 describing the variables here.  A structured overview of customization
16562 variables is available with @kbd{M-x org-customize RET}.  Or select
16563 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
16564 settings can also be activated on a per-file basis, by putting special
16565 lines into the buffer (@pxref{In-buffer settings}).
16567 @node In-buffer settings
16568 @section Summary of in-buffer settings
16569 @cindex in-buffer settings
16570 @cindex special keywords
16572 Org mode uses special lines in the buffer to define settings on a
16573 per-file basis.  These lines start with a @samp{#+} followed by a
16574 keyword, a colon, and then individual words defining a setting.  Several
16575 setting words can be in the same line, but you can also have multiple
16576 lines for the keyword.  While these settings are described throughout
16577 the manual, here is a summary.  After changing any of these lines in the
16578 buffer, press @kbd{C-c C-c} with the cursor still in the line to
16579 activate the changes immediately.  Otherwise they become effective only
16580 when the file is visited again in a new Emacs session.
16582 @vindex org-archive-location
16583 @table @kbd
16584 @item #+ARCHIVE: %s_done::
16585 This line sets the archive location for the agenda file.  It applies for
16586 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
16587 of the file.  The first such line also applies to any entries before it.
16588 The corresponding variable is @code{org-archive-location}.
16589 @item #+CATEGORY:
16590 This line sets the category for the agenda file.  The category applies
16591 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
16592 end of the file.  The first such line also applies to any entries before it.
16593 @item #+COLUMNS: %25ITEM ...
16594 @cindex property, COLUMNS
16595 Set the default format for columns view.  This format applies when
16596 columns view is invoked in locations where no @code{COLUMNS} property
16597 applies.
16598 @item #+CONSTANTS: name1=value1 ...
16599 @vindex org-table-formula-constants
16600 @vindex org-table-formula
16601 Set file-local values for constants to be used in table formulas.  This
16602 line sets the local variable @code{org-table-formula-constants-local}.
16603 The global version of this variable is
16604 @code{org-table-formula-constants}.
16605 @item #+FILETAGS: :tag1:tag2:tag3:
16606 Set tags that can be inherited by any entry in the file, including the
16607 top-level entries.
16608 @item #+LINK: linkword replace
16609 @vindex org-link-abbrev-alist
16610 These lines (several are allowed) specify link abbreviations.
16611 @xref{Link abbreviations}.  The corresponding variable is
16612 @code{org-link-abbrev-alist}.
16613 @item #+PRIORITIES: highest lowest default
16614 @vindex org-highest-priority
16615 @vindex org-lowest-priority
16616 @vindex org-default-priority
16617 This line sets the limits and the default for the priorities.  All three
16618 must be either letters A--Z or numbers 0--9.  The highest priority must
16619 have a lower ASCII number than the lowest priority.
16620 @item #+PROPERTY: Property_Name Value
16621 This line sets a default inheritance value for entries in the current
16622 buffer, most useful for specifying the allowed values of a property.
16623 @cindex #+SETUPFILE
16624 @item #+SETUPFILE: file
16625 This line defines a file that holds more in-buffer setup.  Normally this is
16626 entirely ignored.  Only when the buffer is parsed for option-setting lines
16627 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
16628 settings line, or when exporting), then the contents of this file are parsed
16629 as if they had been included in the buffer.  In particular, the file can be
16630 any other Org mode file with internal setup.  You can visit the file the
16631 cursor is in the line with @kbd{C-c '}.
16632 @item #+STARTUP:
16633 @cindex #+STARTUP
16634 This line sets options to be used at startup of Org mode, when an
16635 Org file is being visited.
16637 The first set of options deals with the initial visibility of the outline
16638 tree.  The corresponding variable for global default settings is
16639 @code{org-startup-folded}, with a default value @code{t}, which means
16640 @code{overview}.
16641 @vindex org-startup-folded
16642 @cindex @code{overview}, STARTUP keyword
16643 @cindex @code{content}, STARTUP keyword
16644 @cindex @code{showall}, STARTUP keyword
16645 @cindex @code{showeverything}, STARTUP keyword
16646 @example
16647 overview         @r{top-level headlines only}
16648 content          @r{all headlines}
16649 showall          @r{no folding of any entries}
16650 showeverything   @r{show even drawer contents}
16651 @end example
16653 @vindex org-startup-indented
16654 @cindex @code{indent}, STARTUP keyword
16655 @cindex @code{noindent}, STARTUP keyword
16656 Dynamic virtual indentation is controlled by the variable
16657 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
16658 @example
16659 indent     @r{start with @code{org-indent-mode} turned on}
16660 noindent   @r{start with @code{org-indent-mode} turned off}
16661 @end example
16663 @vindex org-startup-align-all-tables
16664 Then there are options for aligning tables upon visiting a file.  This
16665 is useful in files containing narrowed table columns.  The corresponding
16666 variable is @code{org-startup-align-all-tables}, with a default value
16667 @code{nil}.
16668 @cindex @code{align}, STARTUP keyword
16669 @cindex @code{noalign}, STARTUP keyword
16670 @example
16671 align      @r{align all tables}
16672 noalign    @r{don't align tables on startup}
16673 @end example
16675 @vindex org-startup-with-inline-images
16676 When visiting a file, inline images can be automatically displayed.  The
16677 corresponding variable is @code{org-startup-with-inline-images}, with a
16678 default value @code{nil} to avoid delays when visiting a file.
16679 @cindex @code{inlineimages}, STARTUP keyword
16680 @cindex @code{noinlineimages}, STARTUP keyword
16681 @example
16682 inlineimages   @r{show inline images}
16683 noinlineimages @r{don't show inline images on startup}
16684 @end example
16686 @vindex org-startup-with-latex-preview
16687 When visiting a file, @LaTeX{} fragments can be converted to images
16688 automatically.  The variable @code{org-startup-with-latex-preview} which
16689 controls this behavior, is set to @code{nil} by default to avoid delays on
16690 startup.
16691 @cindex @code{latexpreview}, STARTUP keyword
16692 @cindex @code{nolatexpreview}, STARTUP keyword
16693 @example
16694 latexpreview   @r{preview @LaTeX{} fragments}
16695 nolatexpreview @r{don't preview @LaTeX{} fragments}
16696 @end example
16698 @vindex org-log-done
16699 @vindex org-log-note-clock-out
16700 @vindex org-log-repeat
16701 Logging the closing and reopening of TODO items and clock intervals can be
16702 configured using these options (see variables @code{org-log-done},
16703 @code{org-log-note-clock-out} and @code{org-log-repeat})
16704 @cindex @code{logdone}, STARTUP keyword
16705 @cindex @code{lognotedone}, STARTUP keyword
16706 @cindex @code{nologdone}, STARTUP keyword
16707 @cindex @code{lognoteclock-out}, STARTUP keyword
16708 @cindex @code{nolognoteclock-out}, STARTUP keyword
16709 @cindex @code{logrepeat}, STARTUP keyword
16710 @cindex @code{lognoterepeat}, STARTUP keyword
16711 @cindex @code{nologrepeat}, STARTUP keyword
16712 @cindex @code{logreschedule}, STARTUP keyword
16713 @cindex @code{lognotereschedule}, STARTUP keyword
16714 @cindex @code{nologreschedule}, STARTUP keyword
16715 @cindex @code{logredeadline}, STARTUP keyword
16716 @cindex @code{lognoteredeadline}, STARTUP keyword
16717 @cindex @code{nologredeadline}, STARTUP keyword
16718 @cindex @code{logrefile}, STARTUP keyword
16719 @cindex @code{lognoterefile}, STARTUP keyword
16720 @cindex @code{nologrefile}, STARTUP keyword
16721 @cindex @code{logdrawer}, STARTUP keyword
16722 @cindex @code{nologdrawer}, STARTUP keyword
16723 @cindex @code{logstatesreversed}, STARTUP keyword
16724 @cindex @code{nologstatesreversed}, STARTUP keyword
16725 @example
16726 logdone             @r{record a timestamp when an item is marked DONE}
16727 lognotedone         @r{record timestamp and a note when DONE}
16728 nologdone           @r{don't record when items are marked DONE}
16729 logrepeat           @r{record a time when reinstating a repeating item}
16730 lognoterepeat       @r{record a note when reinstating a repeating item}
16731 nologrepeat         @r{do not record when reinstating repeating item}
16732 lognoteclock-out    @r{record a note when clocking out}
16733 nolognoteclock-out  @r{don't record a note when clocking out}
16734 logreschedule       @r{record a timestamp when scheduling time changes}
16735 lognotereschedule   @r{record a note when scheduling time changes}
16736 nologreschedule     @r{do not record when a scheduling date changes}
16737 logredeadline       @r{record a timestamp when deadline changes}
16738 lognoteredeadline   @r{record a note when deadline changes}
16739 nologredeadline     @r{do not record when a deadline date changes}
16740 logrefile           @r{record a timestamp when refiling}
16741 lognoterefile       @r{record a note when refiling}
16742 nologrefile         @r{do not record when refiling}
16743 logdrawer           @r{store log into drawer}
16744 nologdrawer         @r{store log outside of drawer}
16745 logstatesreversed   @r{reverse the order of states notes}
16746 nologstatesreversed @r{do not reverse the order of states notes}
16747 @end example
16749 @vindex org-hide-leading-stars
16750 @vindex org-odd-levels-only
16751 Here are the options for hiding leading stars in outline headings, and for
16752 indenting outlines.  The corresponding variables are
16753 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
16754 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
16755 @cindex @code{hidestars}, STARTUP keyword
16756 @cindex @code{showstars}, STARTUP keyword
16757 @cindex @code{odd}, STARTUP keyword
16758 @cindex @code{even}, STARTUP keyword
16759 @example
16760 hidestars  @r{make all but one of the stars starting a headline invisible.}
16761 showstars  @r{show all stars starting a headline}
16762 indent     @r{virtual indentation according to outline level}
16763 noindent   @r{no virtual indentation according to outline level}
16764 odd        @r{allow only odd outline levels (1,3,...)}
16765 oddeven    @r{allow all outline levels}
16766 @end example
16768 @vindex org-put-time-stamp-overlays
16769 @vindex org-time-stamp-overlay-formats
16770 To turn on custom format overlays over timestamps (variables
16771 @code{org-put-time-stamp-overlays} and
16772 @code{org-time-stamp-overlay-formats}), use
16773 @cindex @code{customtime}, STARTUP keyword
16774 @example
16775 customtime @r{overlay custom time format}
16776 @end example
16778 @vindex constants-unit-system
16779 The following options influence the table spreadsheet (variable
16780 @code{constants-unit-system}).
16781 @cindex @code{constcgs}, STARTUP keyword
16782 @cindex @code{constSI}, STARTUP keyword
16783 @example
16784 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
16785 constSI    @r{@file{constants.el} should use the SI unit system}
16786 @end example
16788 @vindex org-footnote-define-inline
16789 @vindex org-footnote-auto-label
16790 @vindex org-footnote-auto-adjust
16791 To influence footnote settings, use the following keywords.  The
16792 corresponding variables are @code{org-footnote-define-inline},
16793 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
16794 @cindex @code{fninline}, STARTUP keyword
16795 @cindex @code{nofninline}, STARTUP keyword
16796 @cindex @code{fnlocal}, STARTUP keyword
16797 @cindex @code{fnprompt}, STARTUP keyword
16798 @cindex @code{fnauto}, STARTUP keyword
16799 @cindex @code{fnconfirm}, STARTUP keyword
16800 @cindex @code{fnplain}, STARTUP keyword
16801 @cindex @code{fnadjust}, STARTUP keyword
16802 @cindex @code{nofnadjust}, STARTUP keyword
16803 @example
16804 fninline    @r{define footnotes inline}
16805 fnnoinline  @r{define footnotes in separate section}
16806 fnlocal     @r{define footnotes near first reference, but not inline}
16807 fnprompt    @r{prompt for footnote labels}
16808 fnauto      @r{create @code{[fn:1]}-like labels automatically (default)}
16809 fnconfirm   @r{offer automatic label for editing or confirmation}
16810 fnplain     @r{create @code{[1]}-like labels automatically}
16811 fnadjust    @r{automatically renumber and sort footnotes}
16812 nofnadjust  @r{do not renumber and sort automatically}
16813 @end example
16815 @cindex org-hide-block-startup
16816 To hide blocks on startup, use these keywords.  The corresponding variable is
16817 @code{org-hide-block-startup}.
16818 @cindex @code{hideblocks}, STARTUP keyword
16819 @cindex @code{nohideblocks}, STARTUP keyword
16820 @example
16821 hideblocks   @r{Hide all begin/end blocks on startup}
16822 nohideblocks @r{Do not hide blocks on startup}
16823 @end example
16825 @cindex org-pretty-entities
16826 The display of entities as UTF-8 characters is governed by the variable
16827 @code{org-pretty-entities} and the keywords
16828 @cindex @code{entitiespretty}, STARTUP keyword
16829 @cindex @code{entitiesplain}, STARTUP keyword
16830 @example
16831 entitiespretty  @r{Show entities as UTF-8 characters where possible}
16832 entitiesplain   @r{Leave entities plain}
16833 @end example
16835 @item #+TAGS:  TAG1(c1) TAG2(c2)
16836 @vindex org-tag-alist
16837 These lines (several such lines are allowed) specify the valid tags in
16838 this file, and (potentially) the corresponding @emph{fast tag selection}
16839 keys.  The corresponding variable is @code{org-tag-alist}.
16840 @cindex #+TBLFM
16841 @item #+TBLFM:
16842 This line contains the formulas for the table directly above the line.
16844 Table can have multiple lines containing @samp{#+TBLFM:}.  Note
16845 that only the first line of @samp{#+TBLFM:} will be applied when
16846 you recalculate the table.  For more details see @ref{Using
16847 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
16849 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
16850 @itemx #+OPTIONS:, #+BIND:,
16851 @itemx #+DESCRIPTION:, #+KEYWORDS:,
16852 @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
16853 @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
16854 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
16855 These lines provide settings for exporting files.  For more details see
16856 @ref{Export settings}.
16857 @item #+TODO:    #+SEQ_TODO:   #+TYP_TODO:
16858 @vindex org-todo-keywords
16859 These lines set the TODO keywords and their interpretation in the
16860 current file.  The corresponding variable is @code{org-todo-keywords}.
16861 @end table
16863 @node The very busy C-c C-c key
16864 @section The very busy C-c C-c key
16865 @kindex C-c C-c
16866 @cindex C-c C-c, overview
16868 The key @kbd{C-c C-c} has many purposes in Org, which are all
16869 mentioned scattered throughout this manual.  One specific function of
16870 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
16871 other circumstances it means something like @emph{``Hey Org, look
16872 here and update according to what you see here''}.  Here is a summary of
16873 what this means in different contexts.
16875 @itemize @minus
16876 @item
16877 If there are highlights in the buffer from the creation of a sparse
16878 tree, or from clock display, remove these highlights.
16879 @item
16880 If the cursor is in one of the special @code{#+KEYWORD} lines, this
16881 triggers scanning the buffer for these lines and updating the
16882 information.
16883 @item
16884 If the cursor is inside a table, realign the table.  This command
16885 works even if the automatic table editor has been turned off.
16886 @item
16887 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
16888 the entire table.
16889 @item
16890 If the current buffer is a capture buffer, close the note and file it.
16891 With a prefix argument, file it, without further interaction, to the
16892 default location.
16893 @item
16894 If the cursor is on a @code{<<<target>>>}, update radio targets and
16895 corresponding links in this buffer.
16896 @item
16897 If the cursor is in a property line or at the start or end of a property
16898 drawer, offer property commands.
16899 @item
16900 If the cursor is at a footnote reference, go to the corresponding
16901 definition, and @emph{vice versa}.
16902 @item
16903 If the cursor is on a statistics cookie, update it.
16904 @item
16905 If the cursor is in a plain list item with a checkbox, toggle the status
16906 of the checkbox.
16907 @item
16908 If the cursor is on a numbered item in a plain list, renumber the
16909 ordered list.
16910 @item
16911 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
16912 block is updated.
16913 @item
16914 If the cursor is at a timestamp, fix the day name in the timestamp.
16915 @end itemize
16917 @node Clean view
16918 @section A cleaner outline view
16919 @cindex hiding leading stars
16920 @cindex dynamic indentation
16921 @cindex odd-levels-only outlines
16922 @cindex clean outline view
16924 Some people find it noisy and distracting that the Org headlines start with a
16925 potentially large number of stars, and that text below the headlines is not
16926 indented.  While this is no problem when writing a @emph{book-like} document
16927 where the outline headings are really section headings, in a more
16928 @emph{list-oriented} outline, indented structure is a lot cleaner:
16930 @example
16931 @group
16932 * Top level headline             |    * Top level headline
16933 ** Second level                  |      * Second level
16934 *** 3rd level                    |        * 3rd level
16935 some text                        |          some text
16936 *** 3rd level                    |        * 3rd level
16937 more text                        |          more text
16938 * Another top level headline     |    * Another top level headline
16939 @end group
16940 @end example
16942 @noindent
16944 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
16945 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
16946 be achieved dynamically at display time using @code{org-indent-mode}.  In
16947 this minor mode, all lines are prefixed for display with the necessary amount
16948 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
16949 property, such that @code{visual-line-mode} (or purely setting
16950 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
16951 }.  Also headlines are prefixed with additional stars, so that the amount of
16952 indentation shifts by two@footnote{See the variable
16953 @code{org-indent-indentation-per-level}.}  spaces per level.  All headline
16954 stars but the last one are made invisible using the @code{org-hide}
16955 face@footnote{Turning on @code{org-indent-mode} sets
16956 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
16957 @code{nil}.}; see below under @samp{2.} for more information on how this
16958 works.  You can turn on @code{org-indent-mode} for all files by customizing
16959 the variable @code{org-startup-indented}, or you can turn it on for
16960 individual files using
16962 @example
16963 #+STARTUP: indent
16964 @end example
16966 If you want a similar effect in an earlier version of Emacs and/or Org, or if
16967 you want the indentation to be hard space characters so that the plain text
16968 file looks as similar as possible to the Emacs display, Org supports you in
16969 the following way:
16971 @enumerate
16972 @item
16973 @emph{Indentation of text below headlines}@*
16974 You may indent text below each headline to make the left boundary line up
16975 with the headline, like
16977 @example
16978 *** 3rd level
16979     more text, now indented
16980 @end example
16982 @vindex org-adapt-indentation
16983 Org supports this with paragraph filling, line wrapping, and structure
16984 editing@footnote{See also the variable @code{org-adapt-indentation}.},
16985 preserving or adapting the indentation as appropriate.
16987 @item
16988 @vindex org-hide-leading-stars
16989 @emph{Hiding leading stars}@* You can modify the display in such a way that
16990 all leading stars become invisible.  To do this in a global way, configure
16991 the variable @code{org-hide-leading-stars} or change this on a per-file basis
16992 with
16994 @example
16995 #+STARTUP: hidestars
16996 #+STARTUP: showstars
16997 @end example
16999 With hidden stars, the tree becomes:
17001 @example
17002 @group
17003 * Top level headline
17004  * Second level
17005   * 3rd level
17006   ...
17007 @end group
17008 @end example
17010 @noindent
17011 @vindex org-hide @r{(face)}
17012 The leading stars are not truly replaced by whitespace, they are only
17013 fontified with the face @code{org-hide} that uses the background color as
17014 font color.  If you are not using either white or black background, you may
17015 have to customize this face to get the wanted effect.  Another possibility is
17016 to set this font such that the extra stars are @i{almost} invisible, for
17017 example using the color @code{grey90} on a white background.
17019 @item
17020 @vindex org-odd-levels-only
17021 Things become cleaner still if you skip all the even levels and use only odd
17022 levels 1, 3, 5..., effectively adding two stars to go from one outline level
17023 to the next@footnote{When you need to specify a level for a property search
17024 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}.  In this
17025 way we get the outline view shown at the beginning of this section.  In order
17026 to make the structure editing and export commands handle this convention
17027 correctly, configure the variable @code{org-odd-levels-only}, or set this on
17028 a per-file basis with one of the following lines:
17030 @example
17031 #+STARTUP: odd
17032 #+STARTUP: oddeven
17033 @end example
17035 You can convert an Org file from single-star-per-level to the
17036 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
17037 RET} in that file.  The reverse operation is @kbd{M-x
17038 org-convert-to-oddeven-levels}.
17039 @end enumerate
17041 @node TTY keys
17042 @section Using Org on a tty
17043 @cindex tty key bindings
17045 Because Org contains a large number of commands, by default many of
17046 Org's core commands are bound to keys that are generally not
17047 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
17048 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
17049 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
17050 these commands on a tty when special keys are unavailable, the following
17051 alternative bindings can be used.  The tty bindings below will likely be
17052 more cumbersome; you may find for some of the bindings below that a
17053 customized workaround suits you better.  For example, changing a timestamp
17054 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
17055 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
17057 @multitable @columnfractions 0.15 0.2 0.1 0.2
17058 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
17059 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab @kbd{C} @tab
17060 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
17061 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab @kbd{L} @tab
17062 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x r}           @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
17063 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab @kbd{R} @tab
17064 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
17065 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab @kbd{U} @tab
17066 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
17067 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab @kbd{D} @tab
17068 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab @kbd{ } @tab
17069 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
17070 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab @kbd{ } @tab
17071 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab @kbd{ } @tab
17072 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab @kbd{ } @tab
17073 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab @kbd{ } @tab
17074 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab @kbd{ } @tab
17075 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab @kbd{ } @tab
17076 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
17077 @end multitable
17080 @node Interaction
17081 @section Interaction with other packages
17082 @cindex packages, interaction with other
17083 Org lives in the world of GNU Emacs and interacts in various ways
17084 with other code out there.
17086 @menu
17087 * Cooperation::                 Packages Org cooperates with
17088 * Conflicts::                   Packages that lead to conflicts
17089 @end menu
17091 @node Cooperation
17092 @subsection Packages that Org cooperates with
17094 @table @asis
17095 @cindex @file{calc.el}
17096 @cindex Gillespie, Dave
17097 @item @file{calc.el} by Dave Gillespie
17098 Org uses the Calc package for implementing spreadsheet
17099 functionality in its tables (@pxref{The spreadsheet}).  Org
17100 checks for the availability of Calc by looking for the function
17101 @code{calc-eval} which will have been autoloaded during setup if Calc has
17102 been installed properly.  As of Emacs 22, Calc is part of the Emacs
17103 distribution.  Another possibility for interaction between the two
17104 packages is using Calc for embedded calculations.  @xref{Embedded Mode,
17105 , Embedded Mode, calc, GNU Emacs Calc Manual}.
17106 @item @file{constants.el} by Carsten Dominik
17107 @cindex @file{constants.el}
17108 @cindex Dominik, Carsten
17109 @vindex org-table-formula-constants
17110 In a table formula (@pxref{The spreadsheet}), it is possible to use
17111 names for natural constants or units.  Instead of defining your own
17112 constants in the variable @code{org-table-formula-constants}, install
17113 the @file{constants} package which defines a large number of constants
17114 and units, and lets you use unit prefixes like @samp{M} for
17115 @samp{Mega}, etc.  You will need version 2.0 of this package, available
17116 at @url{http://www.astro.uva.nl/~dominik/Tools}.  Org checks for
17117 the function @code{constants-get}, which has to be autoloaded in your
17118 setup.  See the installation instructions in the file
17119 @file{constants.el}.
17120 @item @file{cdlatex.el} by Carsten Dominik
17121 @cindex @file{cdlatex.el}
17122 @cindex Dominik, Carsten
17123 Org mode can make use of the CD@LaTeX{} package to efficiently enter
17124 @LaTeX{} fragments into Org files.  See @ref{CDLaTeX mode}.
17125 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
17126 @cindex @file{imenu.el}
17127 Imenu allows menu access to an index of items in a file.  Org mode
17128 supports Imenu---all you need to do to get the index is the following:
17129 @lisp
17130 (add-hook 'org-mode-hook
17131           (lambda () (imenu-add-to-menubar "Imenu")))
17132 @end lisp
17133 @vindex org-imenu-depth
17134 By default the index is two levels deep---you can modify the depth using
17135 the option @code{org-imenu-depth}.
17136 @item @file{remember.el} by John Wiegley
17137 @cindex @file{remember.el}
17138 @cindex Wiegley, John
17139 Org used to use this package for capture, but no longer does.
17140 @item @file{speedbar.el} by Eric M. Ludlam
17141 @cindex @file{speedbar.el}
17142 @cindex Ludlam, Eric M.
17143 Speedbar is a package that creates a special frame displaying files and
17144 index items in files.  Org mode supports Speedbar and allows you to
17145 drill into Org files directly from the Speedbar.  It also allows you to
17146 restrict the scope of agenda commands to a file or a subtree by using
17147 the command @kbd{<} in the Speedbar frame.
17148 @cindex @file{table.el}
17149 @item @file{table.el} by Takaaki Ota
17150 @kindex C-c C-c
17151 @cindex table editor, @file{table.el}
17152 @cindex @file{table.el}
17153 @cindex Ota, Takaaki
17155 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
17156 and alignment can be created using the Emacs table package by Takaaki Ota
17157 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
17158 Org mode will recognize these tables and export them properly.  Because of
17159 interference with other Org mode functionality, you unfortunately cannot edit
17160 these tables directly in the buffer.  Instead, you need to use the command
17161 @kbd{C-c '} to edit them, similar to source code snippets.
17163 @table @kbd
17164 @orgcmd{C-c ',org-edit-special}
17165 Edit a @file{table.el} table.  Works when the cursor is in a table.el table.
17167 @orgcmd{C-c ~,org-table-create-with-table.el}
17168 Insert a @file{table.el} table.  If there is already a table at point, this
17169 command converts it between the @file{table.el} format and the Org mode
17170 format.  See the documentation string of the command
17171 @code{org-convert-table} for the restrictions under which this is
17172 possible.
17173 @end table
17174 @file{table.el} is part of Emacs since Emacs 22.
17175 @item @file{footnote.el} by Steven L. Baur
17176 @cindex @file{footnote.el}
17177 @cindex Baur, Steven L.
17178 Org mode recognizes numerical footnotes as provided by this package.
17179 However, Org mode also has its own footnote support (@pxref{Footnotes}),
17180 which makes using @file{footnote.el} unnecessary.
17181 @end table
17183 @node Conflicts
17184 @subsection Packages that lead to conflicts with Org mode
17186 @table @asis
17188 @cindex @code{shift-selection-mode}
17189 @vindex org-support-shift-select
17190 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
17191 cursor motions combined with the shift key should start or enlarge regions.
17192 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
17193 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
17194 at such a location.  By default, @kbd{S-@key{cursor}} commands outside
17195 special contexts don't do anything, but you can customize the variable
17196 @code{org-support-shift-select}.  Org mode then tries to accommodate shift
17197 selection by (i) using it outside of the special contexts where special
17198 commands apply, and by (ii) extending an existing active region even if the
17199 cursor moves across a special context.
17201 @item @file{CUA.el} by Kim. F. Storm
17202 @cindex @file{CUA.el}
17203 @cindex Storm, Kim. F.
17204 @vindex org-replace-disputed-keys
17205 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
17206 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and
17207 extend the region.  In fact, Emacs 23 has this built-in in the form of
17208 @code{shift-selection-mode}, see previous paragraph.  If you are using Emacs
17209 23, you probably don't want to use another package for this purpose.
17210 However, if you prefer to leave these keys to a different package while
17211 working in Org mode, configure the variable @code{org-replace-disputed-keys}.
17212 When set, Org will move the following key bindings in Org files, and in the
17213 agenda buffer (but not during date selection).
17215 @example
17216 S-UP      @result{}  M-p             S-DOWN     @result{}  M-n
17217 S-LEFT    @result{}  M--             S-RIGHT    @result{}  M-+
17218 C-S-LEFT  @result{}  M-S--           C-S-RIGHT  @result{}  M-S-+
17219 @end example
17221 @vindex org-disputed-keys
17222 Yes, these are unfortunately more difficult to remember.  If you want
17223 to have other replacement keys, look at the variable
17224 @code{org-disputed-keys}.
17226 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
17227 @cindex @file{ecomplete.el}
17229 Ecomplete provides ``electric'' address completion in address header
17230 lines in message buffers.  Sadly Orgtbl mode cuts ecompletes power
17231 supply: No completion happens when Orgtbl mode is enabled in message
17232 buffers while entering text in address header lines.  If one wants to
17233 use ecomplete one should @emph{not} follow the advice to automagically
17234 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
17235 instead---after filling in the message headers---turn on Orgtbl mode
17236 manually when needed in the messages body.
17238 @item @file{filladapt.el} by Kyle Jones
17239 @cindex @file{filladapt.el}
17241 Org mode tries to do the right thing when filling paragraphs, list items and
17242 other elements.  Many users reported they had problems using both
17243 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
17244 this:
17246 @lisp
17247 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
17248 @end lisp
17250 @item @file{yasnippet.el}
17251 @cindex @file{yasnippet.el}
17252 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
17253 @code{"\t"}) overrules YASnippet's access to this key.  The following code
17254 fixed this problem:
17256 @lisp
17257 (add-hook 'org-mode-hook
17258           (lambda ()
17259             (org-set-local 'yas/trigger-key [tab])
17260             (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
17261 @end lisp
17263 The latest version of yasnippet doesn't play well with Org mode.  If the
17264 above code does not fix the conflict, start by defining the following
17265 function:
17267 @lisp
17268 (defun yas/org-very-safe-expand ()
17269   (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
17270 @end lisp
17272 Then, tell Org mode what to do with the new function:
17274 @lisp
17275 (add-hook 'org-mode-hook
17276           (lambda ()
17277             (make-variable-buffer-local 'yas/trigger-key)
17278             (setq yas/trigger-key [tab])
17279             (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
17280             (define-key yas/keymap [tab] 'yas/next-field)))
17281 @end lisp
17283 @item @file{windmove.el} by Hovav Shacham
17284 @cindex @file{windmove.el}
17285 This package also uses the @kbd{S-<cursor>} keys, so everything written
17286 in the paragraph above about CUA mode also applies here.  If you want make
17287 the windmove function active in locations where Org mode does not have
17288 special functionality on @kbd{S-@key{cursor}}, add this to your
17289 configuration:
17291 @lisp
17292 ;; Make windmove work in org-mode:
17293 (add-hook 'org-shiftup-final-hook 'windmove-up)
17294 (add-hook 'org-shiftleft-final-hook 'windmove-left)
17295 (add-hook 'org-shiftdown-final-hook 'windmove-down)
17296 (add-hook 'org-shiftright-final-hook 'windmove-right)
17297 @end lisp
17299 @item @file{viper.el} by Michael Kifer
17300 @cindex @file{viper.el}
17301 @kindex C-c /
17302 Viper uses @kbd{C-c /} and therefore makes this key not access the
17303 corresponding Org mode command @code{org-sparse-tree}.  You need to find
17304 another key for this command, or override the key in
17305 @code{viper-vi-global-user-map} with
17307 @lisp
17308 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
17309 @end lisp
17313 @end table
17315 @node org-crypt
17316 @section org-crypt.el
17317 @cindex @file{org-crypt.el}
17318 @cindex @code{org-decrypt-entry}
17320 Org-crypt will encrypt the text of an entry, but not the headline, or
17321 properties.  Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
17322 files.
17324 Any text below a headline that has a @samp{:crypt:} tag will be automatically
17325 be encrypted when the file is saved.  If you want to use a different tag just
17326 customize the @code{org-crypt-tag-matcher} setting.
17328 To use org-crypt it is suggested that you have the following in your
17329 @file{.emacs}:
17331 @lisp
17332 (require 'org-crypt)
17333 (org-crypt-use-before-save-magic)
17334 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
17336 (setq org-crypt-key nil)
17337   ;; GPG key to use for encryption
17338   ;; Either the Key ID or set to nil to use symmetric encryption.
17340 (setq auto-save-default nil)
17341   ;; Auto-saving does not cooperate with org-crypt.el: so you need
17342   ;; to turn it off if you plan to use org-crypt.el quite often.
17343   ;; Otherwise, you'll get an (annoying) message each time you
17344   ;; start Org.
17346   ;; To turn it off only locally, you can insert this:
17347   ;;
17348   ;; # -*- buffer-auto-save-file-name: nil; -*-
17349 @end lisp
17351 Excluding the crypt tag from inheritance prevents already encrypted text
17352 being encrypted again.
17354 @node Hacking
17355 @appendix Hacking
17356 @cindex hacking
17358 This appendix covers some areas where users can extend the functionality of
17359 Org.
17361 @menu
17362 * Hooks::                       How to reach into Org's internals
17363 * Add-on packages::             Available extensions
17364 * Adding hyperlink types::      New custom link types
17365 * Adding export back-ends::     How to write new export back-ends
17366 * Context-sensitive commands::  How to add functionality to such commands
17367 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
17368 * Dynamic blocks::              Automatically filled blocks
17369 * Special agenda views::        Customized views
17370 * Speeding up your agendas::    Tips on how to speed up your agendas
17371 * Extracting agenda information::  Post-processing of agenda information
17372 * Using the property API::      Writing programs that use entry properties
17373 * Using the mapping API::       Mapping over all or selected entries
17374 @end menu
17376 @node Hooks
17377 @section Hooks
17378 @cindex hooks
17380 Org has a large number of hook variables that can be used to add
17381 functionality.  This appendix about hacking is going to illustrate the
17382 use of some of them.  A complete list of all hooks with documentation is
17383 maintained by the Worg project and can be found at
17384 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
17386 @node Add-on packages
17387 @section Add-on packages
17388 @cindex add-on packages
17390 A large number of add-on packages have been written by various authors.
17392 These packages are not part of Emacs, but they are distributed as contributed
17393 packages with the separate release available at @uref{http://orgmode.org}.
17394 See the @file{contrib/README} file in the source code directory for a list of
17395 contributed files.  You may also find some more information on the Worg page:
17396 @uref{http://orgmode.org/worg/org-contrib/}.
17398 @node Adding hyperlink types
17399 @section Adding hyperlink types
17400 @cindex hyperlinks, adding new types
17402 Org has a large number of hyperlink types built-in
17403 (@pxref{Hyperlinks}).  If you would like to add new link types, Org
17404 provides an interface for doing so.  Let's look at an example file,
17405 @file{org-man.el}, that will add support for creating links like
17406 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
17407 Emacs:
17409 @lisp
17410 ;;; org-man.el - Support for links to manpages in Org
17412 (require 'org)
17414 (org-add-link-type "man" 'org-man-open)
17415 (add-hook 'org-store-link-functions 'org-man-store-link)
17417 (defcustom org-man-command 'man
17418   "The Emacs command to be used to display a man page."
17419   :group 'org-link
17420   :type '(choice (const man) (const woman)))
17422 (defun org-man-open (path)
17423   "Visit the manpage on PATH.
17424 PATH should be a topic that can be thrown at the man command."
17425   (funcall org-man-command path))
17427 (defun org-man-store-link ()
17428   "Store a link to a manpage."
17429   (when (memq major-mode '(Man-mode woman-mode))
17430     ;; This is a man page, we do make this link
17431     (let* ((page (org-man-get-page-name))
17432            (link (concat "man:" page))
17433            (description (format "Manpage for %s" page)))
17434       (org-store-link-props
17435        :type "man"
17436        :link link
17437        :description description))))
17439 (defun org-man-get-page-name ()
17440   "Extract the page name from the buffer name."
17441   ;; This works for both `Man-mode' and `woman-mode'.
17442   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
17443       (match-string 1 (buffer-name))
17444     (error "Cannot create link to this man page")))
17446 (provide 'org-man)
17448 ;;; org-man.el ends here
17449 @end lisp
17451 @noindent
17452 You would activate this new link type in @file{.emacs} with
17454 @lisp
17455 (require 'org-man)
17456 @end lisp
17458 @noindent
17459 Let's go through the file and see what it does.
17460 @enumerate
17461 @item
17462 It does @code{(require 'org)} to make sure that @file{org.el} has been
17463 loaded.
17464 @item
17465 The next line calls @code{org-add-link-type} to define a new link type
17466 with prefix @samp{man}.  The call also contains the name of a function
17467 that will be called to follow such a link.
17468 @item
17469 @vindex org-store-link-functions
17470 The next line adds a function to @code{org-store-link-functions}, in
17471 order to allow the command @kbd{C-c l} to record a useful link in a
17472 buffer displaying a man page.
17473 @end enumerate
17475 The rest of the file defines the necessary variables and functions.
17476 First there is a customization variable that determines which Emacs
17477 command should be used to display man pages.  There are two options,
17478 @code{man} and @code{woman}.  Then the function to follow a link is
17479 defined.  It gets the link path as an argument---in this case the link
17480 path is just a topic for the manual command.  The function calls the
17481 value of @code{org-man-command} to display the man page.
17483 Finally the function @code{org-man-store-link} is defined.  When you try
17484 to store a link with @kbd{C-c l}, this function will be called to
17485 try to make a link.  The function must first decide if it is supposed to
17486 create the link for this buffer type; we do this by checking the value
17487 of the variable @code{major-mode}.  If not, the function must exit and
17488 return the value @code{nil}.  If yes, the link is created by getting the
17489 manual topic from the buffer name and prefixing it with the string
17490 @samp{man:}.  Then it must call the command @code{org-store-link-props}
17491 and set the @code{:type} and @code{:link} properties.  Optionally you
17492 can also set the @code{:description} property to provide a default for
17493 the link description when the link is later inserted into an Org
17494 buffer with @kbd{C-c C-l}.
17496 When it makes sense for your new link type, you may also define a function
17497 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
17498 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
17499 not accept any arguments, and return the full link with prefix.
17501 @node Adding export back-ends
17502 @section Adding export back-ends
17503 @cindex Export, writing back-ends
17505 Org 8.0 comes with a completely rewritten export engine which makes it easy
17506 to write new export back-ends, either from scratch, or by deriving them
17507 from existing ones.
17509 Your two entry points are respectively @code{org-export-define-backend} and
17510 @code{org-export-define-derived-backend}.  To grok these functions, you
17511 should first have a look at @file{ox-latex.el} (for how to define a new
17512 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
17513 back-end from an existing one.
17515 When creating a new back-end from scratch, the basic idea is to set the name
17516 of the back-end (as a symbol) and an alist of elements and export functions.
17517 On top of this, you will need to set additional keywords like
17518 @code{:menu-entry} (to display the back-end in the export dispatcher),
17519 @code{:export-block} (to specify what blocks should not be exported by this
17520 back-end), and @code{:options-alist} (to let the user set export options that
17521 are specific to this back-end.)
17523 Deriving a new back-end is similar, except that you need to set
17524 @code{:translate-alist} to an alist of export functions that should be used
17525 instead of the parent back-end functions.
17527 For a complete reference documentation, see
17528 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
17529 Reference on Worg}.
17531 @node Context-sensitive commands
17532 @section Context-sensitive commands
17533 @cindex context-sensitive commands, hooks
17534 @cindex add-ons, context-sensitive commands
17535 @vindex org-ctrl-c-ctrl-c-hook
17537 Org has several commands that act differently depending on context.  The most
17538 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
17539 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
17541 Add-ons can tap into this functionality by providing a function that detects
17542 special context for that add-on and executes functionality appropriate for
17543 the context.  Here is an example from Dan Davison's @file{org-R.el} which
17544 allows you to evaluate commands based on the @file{R} programming language
17545 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
17546 described in @ref{Working with source code} and is now obsolete.}.  For this
17547 package, special contexts are lines that start with @code{#+R:} or
17548 @code{#+RR:}.
17550 @lisp
17551 (defun org-R-apply-maybe ()
17552   "Detect if this is context for org-R and execute R commands."
17553   (if (save-excursion
17554         (beginning-of-line 1)
17555         (looking-at "#\\+RR?:"))
17556       (progn (call-interactively 'org-R-apply)
17557              t) ;; to signal that we took action
17558     nil)) ;; to signal that we did not
17560 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
17561 @end lisp
17563 The function first checks if the cursor is in such a line.  If that is the
17564 case, @code{org-R-apply} is called and the function returns @code{t} to
17565 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
17566 contexts.  If the function finds it should do nothing locally, it returns
17567 @code{nil} so that other, similar functions can have a try.
17570 @node Tables in arbitrary syntax
17571 @section Tables and lists in arbitrary syntax
17572 @cindex tables, in other modes
17573 @cindex lists, in other modes
17574 @cindex Orgtbl mode
17576 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
17577 frequent feature request has been to make it work with native tables in
17578 specific languages, for example @LaTeX{}.  However, this is extremely
17579 hard to do in a general way, would lead to a customization nightmare,
17580 and would take away much of the simplicity of the Orgtbl mode table
17581 editor.
17583 This appendix describes a different approach.  We keep the Orgtbl mode
17584 table in its native format (the @i{source table}), and use a custom
17585 function to @i{translate} the table to the correct syntax, and to
17586 @i{install} it in the right location (the @i{target table}).  This puts
17587 the burden of writing conversion functions on the user, but it allows
17588 for a very flexible system.
17590 Bastien added the ability to do the same with lists, in Orgstruct mode.  You
17591 can use Org's facilities to edit and structure lists by turning
17592 @code{orgstruct-mode} on, then locally exporting such lists in another format
17593 (HTML, @LaTeX{} or Texinfo.)
17596 @menu
17597 * Radio tables::                Sending and receiving radio tables
17598 * A @LaTeX{} example::          Step by step, almost a tutorial
17599 * Translator functions::        Copy and modify
17600 * Radio lists::                 Sending and receiving lists
17601 @end menu
17603 @node Radio tables
17604 @subsection Radio tables
17605 @cindex radio tables
17607 To define the location of the target table, you first need to create two
17608 lines that are comments in the current mode, but contain magic words
17609 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find.  Orgtbl mode will
17610 insert the translated table between these lines, replacing whatever was there
17611 before.  For example in C mode where comments are between @code{/* ... */}:
17613 @example
17614 /* BEGIN RECEIVE ORGTBL table_name */
17615 /* END RECEIVE ORGTBL table_name */
17616 @end example
17618 @noindent
17619 Just above the source table, we put a special line that tells
17620 Orgtbl mode how to translate this table and where to install it.  For
17621 example:
17622 @cindex #+ORGTBL
17623 @example
17624 #+ORGTBL: SEND table_name translation_function arguments...
17625 @end example
17627 @noindent
17628 @code{table_name} is the reference name for the table that is also used
17629 in the receiver lines.  @code{translation_function} is the Lisp function
17630 that does the translation.  Furthermore, the line can contain a list of
17631 arguments (alternating key and value) at the end.  The arguments will be
17632 passed as a property list to the translation function for
17633 interpretation.  A few standard parameters are already recognized and
17634 acted upon before the translation function is called:
17636 @table @code
17637 @item :skip N
17638 Skip the first N lines of the table.  Hlines do count as separate lines for
17639 this parameter!
17641 @item :skipcols (n1 n2 ...)
17642 List of columns that should be skipped.  If the table has a column with
17643 calculation marks, that column is automatically discarded as well.
17644 Please note that the translator function sees the table @emph{after} the
17645 removal of these columns, the function never knows that there have been
17646 additional columns.
17647 @end table
17649 @noindent
17650 The one problem remaining is how to keep the source table in the buffer
17651 without disturbing the normal workings of the file, for example during
17652 compilation of a C file or processing of a @LaTeX{} file.  There are a
17653 number of different solutions:
17655 @itemize @bullet
17656 @item
17657 The table could be placed in a block comment if that is supported by the
17658 language.  For example, in C mode you could wrap the table between
17659 @samp{/*} and @samp{*/} lines.
17660 @item
17661 Sometimes it is possible to put the table after some kind of @i{END}
17662 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
17663 in @LaTeX{}.
17664 @item
17665 You can just comment the table line-by-line whenever you want to process
17666 the file, and uncomment it whenever you need to edit the table.  This
17667 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
17668 makes this comment-toggling very easy, in particular if you bind it to a
17669 key.
17670 @end itemize
17672 @node A @LaTeX{} example
17673 @subsection A @LaTeX{} example of radio tables
17674 @cindex @LaTeX{}, and Orgtbl mode
17676 The best way to wrap the source table in @LaTeX{} is to use the
17677 @code{comment} environment provided by @file{comment.sty}.  It has to be
17678 activated by placing @code{\usepackage@{comment@}} into the document
17679 header.  Orgtbl mode can insert a radio table skeleton@footnote{By
17680 default this works only for @LaTeX{}, HTML, and Texinfo.  Configure the
17681 variable @code{orgtbl-radio-table-templates} to install templates for other
17682 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table RET}.  You will
17683 be prompted for a table name, let's say we use @samp{salesfigures}.  You
17684 will then get the following template:
17686 @cindex #+ORGTBL, SEND
17687 @example
17688 % BEGIN RECEIVE ORGTBL salesfigures
17689 % END RECEIVE ORGTBL salesfigures
17690 \begin@{comment@}
17691 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17692 | | |
17693 \end@{comment@}
17694 @end example
17696 @noindent
17697 @vindex @LaTeX{}-verbatim-environments
17698 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
17699 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
17700 into the receiver location with name @code{salesfigures}.  You may now
17701 fill in the table---feel free to use the spreadsheet features@footnote{If
17702 the @samp{#+TBLFM} line contains an odd number of dollar characters,
17703 this may cause problems with font-lock in @LaTeX{} mode.  As shown in the
17704 example you can fix this by adding an extra line inside the
17705 @code{comment} environment that is used to balance the dollar
17706 expressions.  If you are using AUC@TeX{} with the font-latex library, a
17707 much better solution is to add the @code{comment} environment to the
17708 variable @code{LaTeX-verbatim-environments}.}:
17710 @example
17711 % BEGIN RECEIVE ORGTBL salesfigures
17712 % END RECEIVE ORGTBL salesfigures
17713 \begin@{comment@}
17714 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17715 | Month | Days | Nr sold | per day |
17716 |-------+------+---------+---------|
17717 | Jan   |   23 |      55 |     2.4 |
17718 | Feb   |   21 |      16 |     0.8 |
17719 | March |   22 |     278 |    12.6 |
17720 #+TBLFM: $4=$3/$2;%.1f
17721 % $ (optional extra dollar to keep font-lock happy, see footnote)
17722 \end@{comment@}
17723 @end example
17725 @noindent
17726 When you are done, press @kbd{C-c C-c} in the table to get the converted
17727 table inserted between the two marker lines.
17729 Now let's assume you want to make the table header by hand, because you
17730 want to control how columns are aligned, etc.  In this case we make sure
17731 that the table translator skips the first 2 lines of the source
17732 table, and tell the command to work as a @i{splice}, i.e., to not produce
17733 header and footer commands of the target table:
17735 @example
17736 \begin@{tabular@}@{lrrr@}
17737 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
17738 % BEGIN RECEIVE ORGTBL salesfigures
17739 % END RECEIVE ORGTBL salesfigures
17740 \end@{tabular@}
17742 \begin@{comment@}
17743 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
17744 | Month | Days | Nr sold | per day |
17745 |-------+------+---------+---------|
17746 | Jan   |   23 |      55 |     2.4 |
17747 | Feb   |   21 |      16 |     0.8 |
17748 | March |   22 |     278 |    12.6 |
17749 #+TBLFM: $4=$3/$2;%.1f
17750 \end@{comment@}
17751 @end example
17753 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
17754 Orgtbl mode.  By default, it uses a @code{tabular} environment to typeset the
17755 table and marks horizontal lines with @code{\hline}.  You can control the
17756 output through several parameters (see also @pxref{Translator functions}),
17757 including the following ones :
17759 @table @code
17760 @item :splice nil/t
17761 When non-@code{nil}, return only table body lines, don't wrap them into a tabular
17762 environment.  Default is @code{nil}.
17764 @item :fmt fmt
17765 A format to be used to wrap each field, it should contain @code{%s} for the
17766 original field value.  For example, to wrap each field value in dollars,
17767 you could use @code{:fmt "$%s$"}.  This may also be a property list with
17768 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
17769 A function of one argument can be used in place of the strings; the
17770 function must return a formatted string.
17772 @item :efmt efmt
17773 Use this format to print numbers with exponentials.  The format should have
17774 @code{%s} twice for inserting mantissa and exponent, for example
17775 @code{"%s\\times10^@{%s@}"}.  This may also be a property list with column
17776 numbers and formats, for example @code{:efmt (2 "$%s\\times10^@{%s@}$"
17777 4 "$%s\\cdot10^@{%s@}$")}.  After @code{efmt} has been applied to a value,
17778 @code{fmt} will also be applied.  Similar to @code{fmt}, functions of two
17779 arguments can be supplied instead of strings.  By default, no special
17780 formatting is applied.
17781 @end table
17783 @node Translator functions
17784 @subsection Translator functions
17785 @cindex HTML, and Orgtbl mode
17786 @cindex translator function
17788 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
17789 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
17790 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, @code{orgtbl-to-texinfo},
17791 @code{orgtbl-to-unicode} and @code{orgtbl-to-orgtbl}.  These all use
17792 a generic translator, @code{orgtbl-to-generic}, which, in turn, can delegate
17793 translations to various export back-ends (@pxref{Export back-ends}).
17795 In particular, properties passed into the function (i.e., the ones set by the
17796 @samp{ORGTBL SEND} line) take precedence over translations defined in the
17797 function.  So if you would like to use the @LaTeX{} translator, but wanted
17798 the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you
17799 could just overrule the default with
17801 @example
17802 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
17803 @end example
17805 For a new language, you can use the generic function to write your own
17806 converter function.  For example, if you have a language where a table is
17807 started with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines
17808 are started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
17809 separator is a TAB, you could define your generic translator like this:
17811 @lisp
17812 (defun orgtbl-to-language (table params)
17813   "Convert the orgtbl-mode TABLE to language."
17814   (orgtbl-to-generic
17815    table
17816    (org-combine-plists
17817     '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
17818     params)))
17819 @end lisp
17821 @noindent
17822 Please check the documentation string of the function
17823 @code{orgtbl-to-generic} for a full list of parameters understood by
17824 that function, and remember that you can pass each of them into
17825 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
17826 using the generic function.
17828 Of course you can also write a completely new function doing complicated
17829 things the generic translator cannot do.  A translator function takes
17830 two arguments.  The first argument is the table, a list of lines, each
17831 line either the symbol @code{hline} or a list of fields.  The second
17832 argument is the property list containing all parameters specified in the
17833 @samp{#+ORGTBL: SEND} line.  The function must return a single string
17834 containing the formatted table.  If you write a generally useful
17835 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
17836 others can benefit from your work.
17838 @node Radio lists
17839 @subsection Radio lists
17840 @cindex radio lists
17841 @cindex org-list-insert-radio-list
17843 Sending and receiving radio lists works exactly the same way as sending and
17844 receiving radio tables (@pxref{Radio tables}).  As for radio tables, you can
17845 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
17846 @code{org-list-insert-radio-list}.
17848 Here are the differences with radio tables:
17850 @itemize @minus
17851 @item
17852 Orgstruct mode must be active.
17853 @item
17854 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
17855 @item
17856 The available translation functions for radio lists don't take
17857 parameters.
17858 @item
17859 @kbd{C-c C-c} will work when pressed on the first item of the list.
17860 @end itemize
17862 Here is a @LaTeX{} example.  Let's say that you have this in your
17863 @LaTeX{} file:
17865 @cindex #+ORGLST
17866 @example
17867 % BEGIN RECEIVE ORGLST to-buy
17868 % END RECEIVE ORGLST to-buy
17869 \begin@{comment@}
17870 #+ORGLST: SEND to-buy org-list-to-latex
17871 - a new house
17872 - a new computer
17873   + a new keyboard
17874   + a new mouse
17875 - a new life
17876 \end@{comment@}
17877 @end example
17879 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
17880 @LaTeX{} list between the two marker lines.
17882 @node Dynamic blocks
17883 @section Dynamic blocks
17884 @cindex dynamic blocks
17886 Org documents can contain @emph{dynamic blocks}.  These are
17887 specially marked regions that are updated by some user-written function.
17888 A good example for such a block is the clock table inserted by the
17889 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
17891 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
17892 to the block and can also specify parameters for the function producing
17893 the content of the block.
17895 @cindex #+BEGIN:dynamic block
17896 @example
17897 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
17899 #+END:
17900 @end example
17902 Dynamic blocks are updated with the following commands
17904 @table @kbd
17905 @orgcmd{C-c C-x C-u,org-dblock-update}
17906 Update dynamic block at point.
17907 @orgkey{C-u C-c C-x C-u}
17908 Update all dynamic blocks in the current file.
17909 @end table
17911 Updating a dynamic block means to remove all the text between BEGIN and
17912 END, parse the BEGIN line for parameters and then call the specific
17913 writer function for this block to insert the new content.  If you want
17914 to use the original content in the writer function, you can use the
17915 extra parameter @code{:content}.
17917 For a block with name @code{myblock}, the writer function is
17918 @code{org-dblock-write:myblock} with as only parameter a property list
17919 with the parameters given in the begin line.  Here is a trivial example
17920 of a block that keeps track of when the block update function was last
17921 run:
17923 @example
17924 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
17926 #+END:
17927 @end example
17929 @noindent
17930 The corresponding block writer function could look like this:
17932 @lisp
17933 (defun org-dblock-write:block-update-time (params)
17934   (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
17935     (insert "Last block update at: "
17936             (format-time-string fmt (current-time)))))
17937 @end lisp
17939 If you want to make sure that all dynamic blocks are always up-to-date,
17940 you could add the function @code{org-update-all-dblocks} to a hook, for
17941 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
17942 written in a way such that it does nothing in buffers that are not in
17943 @code{org-mode}.
17945 You can narrow the current buffer to the current dynamic block (like any
17946 other block) with @code{org-narrow-to-block}.
17948 @node Special agenda views
17949 @section Special agenda views
17950 @cindex agenda views, user-defined
17952 @vindex org-agenda-skip-function
17953 @vindex org-agenda-skip-function-global
17954 Org provides a special hook that can be used to narrow down the selection
17955 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
17956 @code{agenda*} view is the same as @code{agenda} except that it only
17957 considers @emph{appointments}, i.e., scheduled and deadline items that have a
17958 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
17959 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}.  You may
17960 specify a function that is used at each match to verify if the match should
17961 indeed be part of the agenda view, and if not, how much should be skipped.
17962 You can specify a global condition that will be applied to all agenda views,
17963 this condition would be stored in the variable
17964 @code{org-agenda-skip-function-global}.  More commonly, such a definition is
17965 applied only to specific custom searches, using
17966 @code{org-agenda-skip-function}.
17968 Let's say you want to produce a list of projects that contain a WAITING
17969 tag anywhere in the project tree.  Let's further assume that you have
17970 marked all tree headings that define a project with the TODO keyword
17971 PROJECT@.  In this case you would run a TODO search for the keyword
17972 PROJECT, but skip the match unless there is a WAITING tag anywhere in
17973 the subtree belonging to the project line.
17975 To achieve this, you must write a function that searches the subtree for
17976 the tag.  If the tag is found, the function must return @code{nil} to
17977 indicate that this match should not be skipped.  If there is no such
17978 tag, return the location of the end of the subtree, to indicate that
17979 search should continue from there.
17981 @lisp
17982 (defun my-skip-unless-waiting ()
17983   "Skip trees that are not waiting"
17984   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
17985     (if (re-search-forward ":waiting:" subtree-end t)
17986         nil          ; tag found, do not skip
17987       subtree-end))) ; tag not found, continue after end of subtree
17988 @end lisp
17990 Now you may use this function in an agenda custom command, for example
17991 like this:
17993 @lisp
17994 (org-add-agenda-custom-command
17995  '("b" todo "PROJECT"
17996    ((org-agenda-skip-function 'my-skip-unless-waiting)
17997     (org-agenda-overriding-header "Projects waiting for something: "))))
17998 @end lisp
18000 @vindex org-agenda-overriding-header
18001 Note that this also binds @code{org-agenda-overriding-header} to get a
18002 meaningful header in the agenda view.
18004 @vindex org-odd-levels-only
18005 @vindex org-agenda-skip-function
18006 A general way to create custom searches is to base them on a search for
18007 entries with a certain level limit.  If you want to study all entries with
18008 your custom search function, simply do a search for
18009 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
18010 level number corresponds to order in the hierarchy, not to the number of
18011 stars.}, and then use @code{org-agenda-skip-function} to select the entries
18012 you really want to have.
18014 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
18015 particular, you may use the functions @code{org-agenda-skip-entry-if}
18016 and @code{org-agenda-skip-subtree-if} in this form, for example:
18018 @table @code
18019 @item (org-agenda-skip-entry-if 'scheduled)
18020 Skip current entry if it has been scheduled.
18021 @item (org-agenda-skip-entry-if 'notscheduled)
18022 Skip current entry if it has not been scheduled.
18023 @item (org-agenda-skip-entry-if 'deadline)
18024 Skip current entry if it has a deadline.
18025 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
18026 Skip current entry if it has a deadline, or if it is scheduled.
18027 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
18028 Skip current entry if the TODO keyword is TODO or WAITING.
18029 @item (org-agenda-skip-entry-if 'todo 'done)
18030 Skip current entry if the TODO keyword marks a DONE state.
18031 @item (org-agenda-skip-entry-if 'timestamp)
18032 Skip current entry if it has any timestamp, may also be deadline or scheduled.
18033 @anchor{x-agenda-skip-entry-regexp}
18034 @item (org-agenda-skip-entry-if 'regexp "regular expression")
18035 Skip current entry if the regular expression matches in the entry.
18036 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
18037 Skip current entry unless the regular expression matches.
18038 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
18039 Same as above, but check and skip the entire subtree.
18040 @end table
18042 Therefore we could also have written the search for WAITING projects
18043 like this, even without defining a special function:
18045 @lisp
18046 (org-add-agenda-custom-command
18047  '("b" todo "PROJECT"
18048    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
18049                                 'regexp ":waiting:"))
18050     (org-agenda-overriding-header "Projects waiting for something: "))))
18051 @end lisp
18053 @node Speeding up your agendas
18054 @section Speeding up your agendas
18055 @cindex agenda views, optimization
18057 When your Org files grow in both number and size, agenda commands may start
18058 to become slow.  Below are some tips on how to speed up the agenda commands.
18060 @enumerate
18061 @item
18062 Reduce the number of Org agenda files: this will reduce the slowdown caused
18063 by accessing a hard drive.
18064 @item
18065 Reduce the number of DONE and archived headlines: this way the agenda does
18066 not need to skip them.
18067 @item
18068 @vindex org-agenda-dim-blocked-tasks
18069 Inhibit the dimming of blocked tasks:
18070 @lisp
18071 (setq org-agenda-dim-blocked-tasks nil)
18072 @end lisp
18073 @item
18074 @vindex org-startup-folded
18075 @vindex org-agenda-inhibit-startup
18076 Inhibit agenda files startup options:
18077 @lisp
18078 (setq org-agenda-inhibit-startup nil)
18079 @end lisp
18080 @item
18081 @vindex org-agenda-show-inherited-tags
18082 @vindex org-agenda-use-tag-inheritance
18083 Disable tag inheritance in agenda:
18084 @lisp
18085 (setq org-agenda-use-tag-inheritance nil)
18086 @end lisp
18087 @end enumerate
18089 You can set these options for specific agenda views only.  See the docstrings
18090 of these variables for details on why they affect the agenda generation, and
18091 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
18092 page} for further explanations.
18094 @node Extracting agenda information
18095 @section Extracting agenda information
18096 @cindex agenda, pipe
18097 @cindex Scripts, for agenda processing
18099 @vindex org-agenda-custom-commands
18100 Org provides commands to access agenda information for the command
18101 line in Emacs batch mode.  This extracted information can be sent
18102 directly to a printer, or it can be read by a program that does further
18103 processing of the data.  The first of these commands is the function
18104 @code{org-batch-agenda}, that produces an agenda view and sends it as
18105 ASCII text to STDOUT@.  The command takes a single string as parameter.
18106 If the string has length 1, it is used as a key to one of the commands
18107 you have configured in @code{org-agenda-custom-commands}, basically any
18108 key you can use after @kbd{C-c a}.  For example, to directly print the
18109 current TODO list, you could use
18111 @example
18112 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
18113 @end example
18115 If the parameter is a string with 2 or more characters, it is used as a
18116 tags/TODO match string.  For example, to print your local shopping list
18117 (all items with the tag @samp{shop}, but excluding the tag
18118 @samp{NewYork}), you could use
18120 @example
18121 emacs -batch -l ~/.emacs                                      \
18122       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
18123 @end example
18125 @noindent
18126 You may also modify parameters on the fly like this:
18128 @example
18129 emacs -batch -l ~/.emacs                                      \
18130    -eval '(org-batch-agenda "a"                               \
18131             org-agenda-span (quote month)                     \
18132             org-agenda-include-diary nil                      \
18133             org-agenda-files (quote ("~/org/project.org")))'  \
18134    | lpr
18135 @end example
18137 @noindent
18138 which will produce a 30-day agenda, fully restricted to the Org file
18139 @file{~/org/projects.org}, not even including the diary.
18141 If you want to process the agenda data in more sophisticated ways, you
18142 can use the command @code{org-batch-agenda-csv} to get a comma-separated
18143 list of values for each agenda item.  Each line in the output will
18144 contain a number of fields separated by commas.  The fields in a line
18145 are:
18147 @example
18148 category     @r{The category of the item}
18149 head         @r{The headline, without TODO keyword, TAGS and PRIORITY}
18150 type         @r{The type of the agenda entry, can be}
18151                 todo               @r{selected in TODO match}
18152                 tagsmatch          @r{selected in tags match}
18153                 diary              @r{imported from diary}
18154                 deadline           @r{a deadline}
18155                 scheduled          @r{scheduled}
18156                 timestamp          @r{appointment, selected by timestamp}
18157                 closed             @r{entry was closed on date}
18158                 upcoming-deadline  @r{warning about nearing deadline}
18159                 past-scheduled     @r{forwarded scheduled item}
18160                 block              @r{entry has date block including date}
18161 todo         @r{The TODO keyword, if any}
18162 tags         @r{All tags including inherited ones, separated by colons}
18163 date         @r{The relevant date, like 2007-2-14}
18164 time         @r{The time, like 15:00-16:50}
18165 extra        @r{String with extra planning info}
18166 priority-l   @r{The priority letter if any was given}
18167 priority-n   @r{The computed numerical priority}
18168 @end example
18170 @noindent
18171 Time and date will only be given if a timestamp (or deadline/scheduled)
18172 led to the selection of the item.
18174 A CSV list like this is very easy to use in a post-processing script.
18175 For example, here is a Perl program that gets the TODO list from
18176 Emacs/Org and prints all the items, preceded by a checkbox:
18178 @example
18179 #!/usr/bin/perl
18181 # define the Emacs command to run
18182 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
18184 # run it and capture the output
18185 $agenda = qx@{$cmd 2>/dev/null@};
18187 # loop over all lines
18188 foreach $line (split(/\n/,$agenda)) @{
18189   # get the individual values
18190   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
18191    $priority_l,$priority_n) = split(/,/,$line);
18192   # process and print
18193   print "[ ] $head\n";
18195 @end example
18197 @node Using the property API
18198 @section Using the property API
18199 @cindex API, for properties
18200 @cindex properties, API
18202 Here is a description of the functions that can be used to work with
18203 properties.
18205 @defun org-entry-properties &optional pom which
18206 Get all properties of the entry at point-or-marker POM.@*
18207 This includes the TODO keyword, the tags, time strings for deadline,
18208 scheduled, and clocking, and any additional properties defined in the
18209 entry.  The return value is an alist.  Keys may occur multiple times
18210 if the property key was used several times.@*
18211 POM may also be @code{nil}, in which case the current entry is used.
18212 If WHICH is @code{nil} or `all', get all properties.  If WHICH is
18213 `special' or `standard', only get that subclass.
18214 @end defun
18215 @vindex org-use-property-inheritance
18216 @findex org-insert-property-drawer
18217 @defun org-entry-get pom property &optional inherit
18218 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@.  By default,
18219 this only looks at properties defined locally in the entry.  If @code{INHERIT}
18220 is non-@code{nil} and the entry does not have the property, then also check
18221 higher levels of the hierarchy.  If @code{INHERIT} is the symbol
18222 @code{selective}, use inheritance if and only if the setting of
18223 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
18224 @end defun
18226 @defun org-entry-delete pom property
18227 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
18228 @end defun
18230 @defun org-entry-put pom property value
18231 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
18232 @end defun
18234 @defun org-buffer-property-keys &optional include-specials
18235 Get all property keys in the current buffer.
18236 @end defun
18238 @defun org-insert-property-drawer
18239 Insert a property drawer for the current entry.
18240 @end defun
18242 @defun org-entry-put-multivalued-property pom property &rest values
18243 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
18244 @code{VALUES} should be a list of strings.  They will be concatenated, with
18245 spaces as separators.
18246 @end defun
18248 @defun org-entry-get-multivalued-property pom property
18249 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18250 list of values and return the values as a list of strings.
18251 @end defun
18253 @defun org-entry-add-to-multivalued-property pom property value
18254 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18255 list of values and make sure that @code{VALUE} is in this list.
18256 @end defun
18258 @defun org-entry-remove-from-multivalued-property pom property value
18259 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18260 list of values and make sure that @code{VALUE} is @emph{not} in this list.
18261 @end defun
18263 @defun org-entry-member-in-multivalued-property pom property value
18264 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18265 list of values and check if @code{VALUE} is in this list.
18266 @end defun
18268 @defopt org-property-allowed-value-functions
18269 Hook for functions supplying allowed values for a specific property.
18270 The functions must take a single argument, the name of the property, and
18271 return a flat list of allowed values.  If @samp{:ETC} is one of
18272 the values, use the values as completion help, but allow also other values
18273 to be entered.  The functions must return @code{nil} if they are not
18274 responsible for this property.
18275 @end defopt
18277 @node Using the mapping API
18278 @section Using the mapping API
18279 @cindex API, for mapping
18280 @cindex mapping entries, API
18282 Org has sophisticated mapping capabilities to find all entries satisfying
18283 certain criteria.  Internally, this functionality is used to produce agenda
18284 views, but there is also an API that can be used to execute arbitrary
18285 functions for each or selected entries.  The main entry point for this API
18288 @defun org-map-entries func &optional match scope &rest skip
18289 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
18291 @code{FUNC} is a function or a Lisp form.  The function will be called
18292 without arguments, with the cursor positioned at the beginning of the
18293 headline.  The return values of all calls to the function will be collected
18294 and returned as a list.
18296 The call to @code{FUNC} will be wrapped into a save-excursion form, so
18297 @code{FUNC} does not need to preserve point.  After evaluation, the cursor
18298 will be moved to the end of the line (presumably of the headline of the
18299 processed entry) and search continues from there.  Under some circumstances,
18300 this may not produce the wanted results.  For example, if you have removed
18301 (e.g., archived) the current (sub)tree it could mean that the next entry will
18302 be skipped entirely.  In such cases, you can specify the position from where
18303 search should continue by making @code{FUNC} set the variable
18304 @code{org-map-continue-from} to the desired buffer position.
18306 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
18307 view.  Only headlines that are matched by this query will be considered
18308 during the iteration.  When @code{MATCH} is @code{nil} or @code{t}, all
18309 headlines will be visited by the iteration.
18311 @code{SCOPE} determines the scope of this command.  It can be any of:
18313 @example
18314 nil     @r{the current buffer, respecting the restriction if any}
18315 tree    @r{the subtree started with the entry at point}
18316 region  @r{The entries within the active region, if any}
18317 file    @r{the current buffer, without restriction}
18318 file-with-archives
18319         @r{the current buffer, and any archives associated with it}
18320 agenda  @r{all agenda files}
18321 agenda-with-archives
18322         @r{all agenda files with any archive files associated with them}
18323 (file1 file2 ...)
18324         @r{if this is a list, all files in the list will be scanned}
18325 @end example
18326 @noindent
18327 The remaining args are treated as settings for the skipping facilities of
18328 the scanner.  The following items can be given here:
18330 @vindex org-agenda-skip-function
18331 @example
18332 archive   @r{skip trees with the archive tag}
18333 comment   @r{skip trees with the COMMENT keyword}
18334 function or Lisp form
18335           @r{will be used as value for @code{org-agenda-skip-function},}
18336           @r{so whenever the function returns t, FUNC}
18337           @r{will not be called for that entry and search will}
18338           @r{continue from the point where the function leaves it}
18339 @end example
18340 @end defun
18342 The function given to that mapping routine can really do anything you like.
18343 It can use the property API (@pxref{Using the property API}) to gather more
18344 information about the entry, or in order to change metadata in the entry.
18345 Here are a couple of functions that might be handy:
18347 @defun org-todo &optional arg
18348 Change the TODO state of the entry.  See the docstring of the functions for
18349 the many possible values for the argument @code{ARG}.
18350 @end defun
18352 @defun org-priority &optional action
18353 Change the priority of the entry.  See the docstring of this function for the
18354 possible values for @code{ACTION}.
18355 @end defun
18357 @defun org-toggle-tag tag &optional onoff
18358 Toggle the tag @code{TAG} in the current entry.  Setting @code{ONOFF} to
18359 either @code{on} or @code{off} will not toggle tag, but ensure that it is
18360 either on or off.
18361 @end defun
18363 @defun org-promote
18364 Promote the current entry.
18365 @end defun
18367 @defun org-demote
18368 Demote the current entry.
18369 @end defun
18371 Here is a simple example that will turn all entries in the current file with
18372 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
18373 Entries in comment trees and in archive trees will be ignored.
18375 @lisp
18376 (org-map-entries
18377  '(org-todo "UPCOMING")
18378  "+TOMORROW" 'file 'archive 'comment)
18379 @end lisp
18381 The following example counts the number of entries with TODO keyword
18382 @code{WAITING}, in all agenda files.
18384 @lisp
18385 (length (org-map-entries t "/+WAITING" 'agenda))
18386 @end lisp
18388 @node MobileOrg
18389 @appendix MobileOrg
18390 @cindex iPhone
18391 @cindex MobileOrg
18393 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
18394 available for iOS and for Android.  @i{MobileOrg} offers offline viewing and
18395 capture support for an Org mode system rooted on a ``real'' computer.  It
18396 also allows you to record changes to existing entries.  The
18397 @uref{https://github.com/MobileOrg/, iOS implementation} for the
18398 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
18399 and is now in the hands Sean Escriva.  Android users should check out
18400 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
18401 by Matt Jones.  The two implementations are not identical but offer similar
18402 features.
18404 This appendix describes the support Org has for creating agenda views in a
18405 format that can be displayed by @i{MobileOrg}, and for integrating notes
18406 captured and changes made by @i{MobileOrg} into the main system.
18408 For changing tags and TODO states in MobileOrg, you should have set up the
18409 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
18410 cover all important tags and TODO keywords, even if individual files use only
18411 part of these.  MobileOrg will also offer you states and tags set up with
18412 in-buffer settings, but it will understand the logistics of TODO state
18413 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
18414 (@pxref{Setting tags}) only for those set in these variables.
18416 @menu
18417 * Setting up the staging area::  Where to interact with the mobile device
18418 * Pushing to MobileOrg::        Uploading Org files and agendas
18419 * Pulling from MobileOrg::      Integrating captured and flagged items
18420 @end menu
18422 @node Setting up the staging area
18423 @section Setting up the staging area
18425 MobileOrg needs to interact with Emacs through a directory on a server.  If
18426 you are using a public server, you should consider encrypting the files that
18427 are uploaded to the server.  This can be done with Org mode 7.02 and with
18428 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
18429 installation on your system.  To turn on encryption, set a password in
18430 @i{MobileOrg} and, on the Emacs side, configure the variable
18431 @code{org-mobile-use-encryption}@footnote{If you can safely store the
18432 password in your Emacs setup, you might also want to configure
18433 @code{org-mobile-encryption-password}.  Please read the docstring of that
18434 variable.  Note that encryption will apply only to the contents of the
18435 @file{.org} files.  The file names themselves will remain visible.}.
18437 The easiest way to create that directory is to use a free
18438 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
18439 Dropbox, or if your version of MobileOrg does not support it, you can use a
18440 webdav server.  For more information, check out the documentation of MobileOrg and also this
18441 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
18442 When MobileOrg first connects to your Dropbox, it will create a directory
18443 @i{MobileOrg} inside the Dropbox.  After the directory has been created, tell
18444 Emacs about it:
18446 @lisp
18447 (setq org-mobile-directory "~/Dropbox/MobileOrg")
18448 @end lisp
18450 Org mode has commands to put files for @i{MobileOrg} into that directory,
18451 and to read captured notes from there.
18453 @node Pushing to MobileOrg
18454 @section Pushing to MobileOrg
18456 This operation copies all files currently listed in @code{org-mobile-files}
18457 to the directory @code{org-mobile-directory}.  By default this list contains
18458 all agenda files (as listed in @code{org-agenda-files}), but additional files
18459 can be included by customizing @code{org-mobile-files}.  File names will be
18460 staged with paths relative to @code{org-directory}, so all files should be
18461 inside this directory@footnote{Symbolic links in @code{org-directory} need to
18462 have the same name as their targets.}.
18464 The push operation also creates a special Org file @file{agendas.org} with
18465 all custom agenda view defined by the user@footnote{While creating the
18466 agendas, Org mode will force ID properties on all referenced entries, so that
18467 these entries can be uniquely identified if @i{MobileOrg} flags them for
18468 further action.  If you do not want to get these properties in so many
18469 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
18470 to @code{nil}.  Org mode will then rely on outline paths, in the hope that
18471 these will be unique enough.}.
18473 Finally, Org writes the file @file{index.org}, containing links to all other
18474 files.  @i{MobileOrg} first reads this file from the server, and then
18475 downloads all agendas and Org files listed in it.  To speed up the download,
18476 MobileOrg will only read files whose checksums@footnote{Checksums are stored
18477 automatically in the file @file{checksums.dat}} have changed.
18479 @node Pulling from MobileOrg
18480 @section Pulling from MobileOrg
18482 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
18483 files for viewing.  It also appends captured entries and pointers to flagged
18484 and changed entries to the file @file{mobileorg.org} on the server.  Org has
18485 a @emph{pull} operation that integrates this information into an inbox file
18486 and operates on the pointers to flagged entries.  Here is how it works:
18488 @enumerate
18489 @item
18490 Org moves all entries found in
18491 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
18492 operation.} and appends them to the file pointed to by the variable
18493 @code{org-mobile-inbox-for-pull}.  Each captured entry and each editing event
18494 will be a top-level entry in the inbox file.
18495 @item
18496 After moving the entries, Org will attempt to implement the changes made in
18497 @i{MobileOrg}.  Some changes are applied directly and without user
18498 interaction.  Examples are all changes to tags, TODO state, headline and body
18499 text that can be cleanly applied.  Entries that have been flagged for further
18500 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
18501 again.  When there is a problem finding an entry or applying the change, the
18502 pointer entry will remain in the inbox and will be marked with an error
18503 message.  You need to later resolve these issues by hand.
18504 @item
18505 Org will then generate an agenda view with all flagged entries.  The user
18506 should then go through these entries and do whatever actions are necessary.
18507 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
18508 will be displayed in the echo area when the cursor is on the corresponding
18509 agenda line.
18511 @table @kbd
18512 @kindex ?
18513 @item ?
18514 Pressing @kbd{?} in that special agenda will display the full flagging note in
18515 another window and also push it onto the kill ring.  So you could use @kbd{?
18516 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
18517 Pressing @kbd{?} twice in succession will offer to remove the
18518 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
18519 in a property).  In this way you indicate that the intended processing for
18520 this flagged entry is finished.
18521 @end table
18522 @end enumerate
18524 @kindex C-c a ?
18525 If you are not able to process all flagged entries directly, you can always
18526 return to this agenda view@footnote{Note, however, that there is a subtle
18527 difference.  The view created automatically by @kbd{M-x org-mobile-pull RET}
18528 is guaranteed to search all files that have been addressed by the last pull.
18529 This might include a file that is not currently in your list of agenda files.
18530 If you later use @kbd{C-c a ?} to regenerate the view, only the current
18531 agenda files will be searched.} using @kbd{C-c a ?}.
18533 @node History and acknowledgments
18534 @appendix History and acknowledgments
18535 @cindex acknowledgments
18536 @cindex history
18537 @cindex thanks
18539 @section From Carsten
18541 Org was born in 2003, out of frustration over the user interface of the Emacs
18542 Outline mode.  I was trying to organize my notes and projects, and using
18543 Emacs seemed to be the natural way to go.  However, having to remember eleven
18544 different commands with two or three keys per command, only to hide and show
18545 parts of the outline tree, that seemed entirely unacceptable to me.  Also,
18546 when using outlines to take notes, I constantly wanted to restructure the
18547 tree, organizing it parallel to my thoughts and plans.  @emph{Visibility
18548 cycling} and @emph{structure editing} were originally implemented in the
18549 package @file{outline-magic.el}, but quickly moved to the more general
18550 @file{org.el}.  As this environment became comfortable for project planning,
18551 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
18552 @emph{table support}.  These areas highlighted the two main goals that Org
18553 still has today: to be a new, outline-based, plain text mode with innovative
18554 and intuitive editing features, and to incorporate project planning
18555 functionality directly into a notes file.
18557 Since the first release, literally thousands of emails to me or to
18558 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
18559 reports, feedback, new ideas, and sometimes patches and add-on code.
18560 Many thanks to everyone who has helped to improve this package.  I am
18561 trying to keep here a list of the people who had significant influence
18562 in shaping one or more aspects of Org.  The list may not be
18563 complete, if I have forgotten someone, please accept my apologies and
18564 let me know.
18566 Before I get to this list, a few special mentions are in order:
18568 @table @i
18569 @item Bastien Guerry
18570 Bastien has written a large number of extensions to Org (most of them
18571 integrated into the core by now), including the @LaTeX{} exporter and the
18572 plain list parser.  His support during the early days was central to the
18573 success of this project.  Bastien also invented Worg, helped establishing the
18574 Web presence of Org, and sponsored hosting costs for the orgmode.org website.
18575 Bastien stepped in as maintainer of Org between 2011 and 2013, at a time when
18576 I desparately needed a break.
18577 @item Eric Schulte and Dan Davison
18578 Eric and Dan are jointly responsible for the Org-babel system, which turns
18579 Org into a multi-language environment for evaluating code and doing literate
18580 programming and reproducible research.  This has become one of Org's killer
18581 features that define what Org is today.
18582 @item John Wiegley
18583 John has contributed a number of great ideas and patches directly to Org,
18584 including the attachment system (@file{org-attach.el}), integration with
18585 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
18586 items, habit tracking (@file{org-habits.el}), and encryption
18587 (@file{org-crypt.el}).  Also, the capture system is really an extended copy
18588 of his great @file{remember.el}.
18589 @item Sebastian Rose
18590 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
18591 of an ignorant amateur.  Sebastian has pushed this part of Org onto a much
18592 higher level.  He also wrote @file{org-info.js}, a Java script for displaying
18593 web pages derived from Org using an Info-like or a folding interface with
18594 single-key navigation.
18595 @end table
18597 @noindent See below for the full list of contributions!  Again, please
18598 let me know what I am missing here!
18600 @section From Bastien
18602 I (Bastien) have been maintaining Org between 2011 and 2013.  This appendix
18603 would not be complete without adding a few more acknowledgements and thanks.
18605 I am first grateful to Carsten for his trust while handing me over the
18606 maintainership of Org.  His unremitting support is what really helped me
18607 getting more confident over time, with both the community and the code.
18609 When I took over maintainership, I knew I would have to make Org more
18610 collaborative than ever, as I would have to rely on people that are more
18611 knowledgeable than I am on many parts of the code.  Here is a list of the
18612 persons I could rely on, they should really be considered co-maintainers,
18613 either of the code or the community:
18615 @table @i
18616 @item Eric Schulte
18617 Eric is maintaining the Babel parts of Org.  His reactivity here kept me away
18618 from worrying about possible bugs here and let me focus on other parts.
18620 @item Nicolas Goaziou
18621 Nicolas is maintaining the consistency of the deepest parts of Org.  His work
18622 on @file{org-element.el} and @file{ox.el} has been outstanding, and it opened
18623 the doors for many new ideas and features.  He rewrote many of the old
18624 exporters to use the new export engine, and helped with documenting this
18625 major change.  More importantly (if that's possible), he has been more than
18626 reliable during all the work done for Org 8.0, and always very reactive on
18627 the mailing list.
18629 @item Achim Gratz
18630 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
18631 into a flexible and conceptually clean process.  He patiently coped with the
18632 many hiccups that such a change can create for users.
18634 @item Nick Dokos
18635 The Org mode mailing list would not be such a nice place without Nick, who
18636 patiently helped users so many times.  It is impossible to overestimate such
18637 a great help, and the list would not be so active without him.
18638 @end table
18640 I received support from so many users that it is clearly impossible to be
18641 fair when shortlisting a few of them, but Org's history would not be
18642 complete if the ones above were not mentioned in this manual.
18644 @section List of contributions
18646 @itemize @bullet
18648 @item
18649 @i{Russel Adams} came up with the idea for drawers.
18650 @item
18651 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
18652 feedback on many features and several patches.
18653 @item
18654 @i{Luis Anaya} wrote @file{ox-man.el}.
18655 @item
18656 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
18657 @item
18658 @i{Michael Brand} helped by reporting many bugs and testing many features.
18659 He also implemented the distinction between empty fields and 0-value fields
18660 in Org's spreadsheets.
18661 @item
18662 @i{Christophe Bataillon} created the great unicorn logo that we use on the
18663 Org mode website.
18664 @item
18665 @i{Alex Bochannek} provided a patch for rounding timestamps.
18666 @item
18667 @i{Jan Böcker} wrote @file{org-docview.el}.
18668 @item
18669 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
18670 @item
18671 @i{Tom Breton} wrote @file{org-choose.el}.
18672 @item
18673 @i{Charles Cave}'s suggestion sparked the implementation of templates
18674 for Remember, which are now templates for capture.
18675 @item
18676 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
18677 specified time.
18678 @item
18679 @i{Gregory Chernov} patched support for Lisp forms into table
18680 calculations and improved XEmacs compatibility, in particular by porting
18681 @file{nouline.el} to XEmacs.
18682 @item
18683 @i{Sacha Chua} suggested copying some linking code from Planner, and helped
18684 make Org pupular through her blog.
18685 @item
18686 @i{Toby S. Cubitt} contributed to the code for clock formats.
18687 @item
18688 @i{Baoqiu Cui} contributed the first DocBook exporter.  In Org 8.0, we go a
18689 different route: you can now export to Texinfo and export the @file{.texi}
18690 file to DocBook using @code{makeinfo}.
18691 @item
18692 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
18693 came up with the idea of properties, and that there should be an API for
18694 them.
18695 @item
18696 @i{Nick Dokos} tracked down several nasty bugs.
18697 @item
18698 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
18699 inspired some of the early development, including HTML export.  He also
18700 asked for a way to narrow wide table columns.
18701 @item
18702 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
18703 several years now.  He also sponsored the hosting costs until Rackspace
18704 started to host us for free.
18705 @item
18706 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
18707 the Org-Babel documentation into the manual.
18708 @item
18709 @i{Christian Egli} converted the documentation into Texinfo format, inspired
18710 the agenda, patched CSS formatting into the HTML exporter, and wrote
18711 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
18712 @file{ox-taskjuggler.el} for Org 8.0.
18713 @item
18714 @i{David Emery} provided a patch for custom CSS support in exported
18715 HTML agendas.
18716 @item
18717 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
18718 @item
18719 @i{Nic Ferrier} contributed mailcap and XOXO support.
18720 @item
18721 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
18722 @item
18723 @i{John Foerch} figured out how to make incremental search show context
18724 around a match in a hidden outline tree.
18725 @item
18726 @i{Raimar Finken} wrote @file{org-git-line.el}.
18727 @item
18728 @i{Mikael Fornius} works as a mailing list moderator.
18729 @item
18730 @i{Austin Frank} works as a mailing list moderator.
18731 @item
18732 @i{Eric Fraga} drove the development of BEAMER export with ideas and
18733 testing.
18734 @item
18735 @i{Barry Gidden} did proofreading the manual in preparation for the book
18736 publication through Network Theory Ltd.
18737 @item
18738 @i{Niels Giesen} had the idea to automatically archive DONE trees.
18739 @item
18740 @i{Nicolas Goaziou} rewrote much of the plain list code.  He also wrote
18741 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
18742 in implementing a clean framework for Org exporters.
18743 @item
18744 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
18745 @item
18746 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
18747 book.
18748 @item
18749 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
18750 task state change logging, and the clocktable.  His clear explanations have
18751 been critical when we started to adopt the Git version control system.
18752 @item
18753 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
18754 patches.
18755 @item
18756 @i{Phil Jackson} wrote @file{org-irc.el}.
18757 @item
18758 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
18759 folded entries, and column view for properties.
18760 @item
18761 @i{Matt Jones} wrote @i{MobileOrg Android}.
18762 @item
18763 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
18764 @item
18765 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
18766 @item
18767 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it.  He also
18768 provided frequent feedback and some patches.
18769 @item
18770 @i{Matt Lundin} has proposed last-row references for table formulas and named
18771 invisible anchors.  He has also worked a lot on the FAQ.
18772 @item
18773 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
18774 and is a prolific contributor on the mailing list with competent replies,
18775 small fixes and patches.
18776 @item
18777 @i{Jason F. McBrayer} suggested agenda export to CSV format.
18778 @item
18779 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
18780 @item
18781 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
18782 basis.
18783 @item
18784 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
18785 happy.
18786 @item
18787 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
18788 @item
18789 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
18790 and being able to quickly restrict the agenda to a subtree.
18791 @item
18792 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
18793 @item
18794 @i{Greg Newman} refreshed the unicorn logo into its current form.
18795 @item
18796 @i{Tim O'Callaghan} suggested in-file links, search options for general
18797 file links, and TAGS.
18798 @item
18799 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
18800 version of the reference card.
18801 @item
18802 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
18803 into Japanese.
18804 @item
18805 @i{Oliver Oppitz} suggested multi-state TODO items.
18806 @item
18807 @i{Scott Otterson} sparked the introduction of descriptive text for
18808 links, among other things.
18809 @item
18810 @i{Pete Phillips} helped during the development of the TAGS feature, and
18811 provided frequent feedback.
18812 @item
18813 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
18814 generation.
18815 @item
18816 @i{Martin Pohlack} provided the code snippet to bundle character insertion
18817 into bundles of 20 for undo.
18818 @item
18819 @i{Rackspace.com} is hosting our website for free.  Thank you Rackspace!
18820 @item
18821 @i{T.V. Raman} reported bugs and suggested improvements.
18822 @item
18823 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
18824 control.
18825 @item
18826 @i{Paul Rivier} provided the basic implementation of named footnotes.  He
18827 also acted as mailing list moderator for some time.
18828 @item
18829 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
18830 @item
18831 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
18832 conflict with @file{allout.el}.
18833 @item
18834 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
18835 extensive patches.
18836 @item
18837 @i{Philip Rooke} created the Org reference card, provided lots
18838 of feedback, developed and applied standards to the Org documentation.
18839 @item
18840 @i{Christian Schlauer} proposed angular brackets around links, among
18841 other things.
18842 @item
18843 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
18844 enjoy folding in non-org buffers by using Org headlines in comments.
18845 @item
18846 @i{Paul Sexton} wrote @file{org-ctags.el}.
18847 @item
18848 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
18849 @file{organizer-mode.el}.
18850 @item
18851 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
18852 examples, and remote highlighting for referenced code lines.
18853 @item
18854 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
18855 now packaged into Org's @file{contrib} directory.
18856 @item
18857 @i{Daniel Sinder} came up with the idea of internal archiving by locking
18858 subtrees.
18859 @item
18860 @i{Dale Smith} proposed link abbreviations.
18861 @item
18862 @i{James TD Smith} has contributed a large number of patches for useful
18863 tweaks and features.
18864 @item
18865 @i{Adam Spiers} asked for global linking commands, inspired the link
18866 extension system, added support for mairix, and proposed the mapping API.
18867 @item
18868 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
18869 @LaTeX{}, UTF-8, Latin-1 and ASCII.
18870 @item
18871 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
18872 with links transformation to Org syntax.
18873 @item
18874 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
18875 chapter about publishing.
18876 @item
18877 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
18878 @item
18879 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
18880 enabled source code highlighting in Gnus.
18881 @item
18882 @i{Stefan Vollmar} organized a video-recorded talk at the
18883 Max-Planck-Institute for Neurology.  He also inspired the creation of a
18884 concept index for HTML export.
18885 @item
18886 @i{J@"urgen Vollmer} contributed code generating the table of contents
18887 in HTML output.
18888 @item
18889 @i{Samuel Wales} has provided important feedback and bug reports.
18890 @item
18891 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
18892 keyword.
18893 @item
18894 @i{David Wainberg} suggested archiving, and improvements to the linking
18895 system.
18896 @item
18897 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
18898 linking to Gnus.
18899 @item
18900 @i{Roland Winkler} requested additional key bindings to make Org
18901 work on a tty.
18902 @item
18903 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
18904 and contributed various ideas and code snippets.
18905 @end itemize
18908 @node GNU Free Documentation License
18909 @appendix GNU Free Documentation License
18910 @include doclicense.texi
18913 @node Main Index
18914 @unnumbered Concept index
18916 @printindex cp
18918 @node Key Index
18919 @unnumbered Key index
18921 @printindex ky
18923 @node Command and Function Index
18924 @unnumbered Command and function index
18926 @printindex fn
18928 @node Variable Index
18929 @unnumbered Variable index
18931 This is not a complete index of variables and faces, only the ones that are
18932 mentioned in the manual.  For a more complete list, use @kbd{M-x
18933 org-customize @key{RET}} and then click yourself through the tree.
18935 @printindex vr
18937 @bye
18939 @c Local variables:
18940 @c fill-column: 77
18941 @c indent-tabs-mode: nil
18942 @c paragraph-start:    "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[  ]*$"
18943 @c paragraph-separate: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[       \f]*$"
18944 @c End:
18947 @c  LocalWords:  webdavhost pre