org.texi: Fix #+CATEGORY description
[org-mode/org-tableheadings.git] / doc / org.texi
blob780bf6fa6e54a68559ccd65d2ee7877554e9089a
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 hierarchy::               Create a hierarchy of tags
436 * Tag searches::                Searching for combinations of tags
438 Properties and columns
440 * Property syntax::             How properties are spelled out
441 * Special properties::          Access to other Org mode features
442 * Property searches::           Matching property values
443 * Property inheritance::        Passing values down the tree
444 * Column view::                 Tabular viewing and editing
445 * Property API::                Properties for Lisp programmers
447 Column view
449 * Defining columns::            The COLUMNS format property
450 * Using column view::           How to create and use column view
451 * Capturing column view::       A dynamic block for column view
453 Defining columns
455 * Scope of column definitions::  Where defined, where valid?
456 * Column attributes::           Appearance and content of a column
458 Dates and times
460 * Timestamps::                  Assigning a time to a tree entry
461 * Creating timestamps::         Commands which insert timestamps
462 * Deadlines and scheduling::    Planning your work
463 * Clocking work time::          Tracking how long you spend on a task
464 * Effort estimates::            Planning work effort in advance
465 * Timers::                      Notes with a running timer
467 Creating timestamps
469 * The date/time prompt::        How Org mode helps you entering date and time
470 * Custom time format::          Making dates look different
472 Deadlines and scheduling
474 * Inserting deadline/schedule::  Planning items
475 * Repeated tasks::              Items that show up again and again
477 Clocking work time
479 * Clocking commands::           Starting and stopping a clock
480 * The clock table::             Detailed reports
481 * Resolving idle time::         Resolving time when you've been idle
483 Capture - Refile - Archive
485 * Capture::                     Capturing new stuff
486 * Attachments::                 Add files to tasks
487 * RSS feeds::                   Getting input from RSS feeds
488 * Protocols::                   External (e.g., Browser) access to Emacs and Org
489 * Refile and copy::             Moving/copying a tree from one place to another
490 * Archiving::                   What to do with finished projects
492 Capture
494 * Setting up capture::          Where notes will be stored
495 * Using capture::               Commands to invoke and terminate capture
496 * Capture templates::           Define the outline of different note types
498 Capture templates
500 * Template elements::           What is needed for a complete template entry
501 * Template expansion::          Filling in information about time and context
502 * Templates in contexts::       Only show a template in a specific context
504 Archiving
506 * Moving subtrees::             Moving a tree to an archive file
507 * Internal archiving::          Switch off a tree but keep it in the file
509 Agenda views
511 * Agenda files::                Files being searched for agenda information
512 * Agenda dispatcher::           Keyboard access to agenda views
513 * Built-in agenda views::       What is available out of the box?
514 * Presentation and sorting::    How agenda items are prepared for display
515 * Agenda commands::             Remote editing of Org trees
516 * Custom agenda views::         Defining special searches and views
517 * Exporting agenda views::      Writing a view to a file
518 * Agenda column view::          Using column view for collected entries
520 The built-in agenda views
522 * Weekly/daily agenda::         The calendar page with current tasks
523 * Global TODO list::            All unfinished action items
524 * Matching tags and properties::  Structured information with fine-tuned search
525 * Timeline::                    Time-sorted view for single file
526 * Search view::                 Find entries by searching for text
527 * Stuck projects::              Find projects you need to review
529 Presentation and sorting
531 * Categories::                  Not all tasks are equal
532 * Time-of-day specifications::  How the agenda knows the time
533 * Sorting agenda items::        The order of things
534 * Filtering/limiting agenda items::  Dynamically narrow the agenda
536 Custom agenda views
538 * Storing searches::            Type once, use often
539 * Block agenda::                All the stuff you need in a single buffer
540 * Setting options::             Changing the rules
542 Markup for rich export
544 * Structural markup elements::  The basic structure as seen by the exporter
545 * Images and tables::           Images, tables and caption mechanism
546 * Literal examples::            Source code examples with special formatting
547 * Include files::               Include additional files into a document
548 * Index entries::               Making an index
549 * Macro replacement::           Use macros to create templates
550 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
551 * Special blocks::              Containers targeted at export back-ends
553 Structural markup elements
555 * Document title::              Where the title is taken from
556 * Headings and sections::       The document structure as seen by the exporter
557 * Table of contents::           The if and where of the table of contents
558 * Lists::                       Lists
559 * Paragraphs::                  Paragraphs
560 * Footnote markup::             Footnotes
561 * Emphasis and monospace::      Bold, italic, etc.
562 * Horizontal rules::            Make a line
563 * Comment lines::               What will *not* be exported
565 Embedded @LaTeX{}
567 * Special symbols::             Greek letters and other symbols
568 * Subscripts and superscripts::  Simple syntax for raising/lowering text
569 * @LaTeX{} fragments::          Complex formulas made easy
570 * Previewing @LaTeX{} fragments::  What will this snippet look like?
571 * CDLaTeX mode::                Speed up entering of formulas
573 Exporting
575 * The export dispatcher::       The main exporter interface
576 * Export back-ends::            Built-in export formats
577 * Export settings::             Generic export settings
578 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
579 * Beamer export::               Exporting as a Beamer presentation
580 * HTML export::                 Exporting to HTML
581 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
582 * Markdown export::             Exporting to Markdown
583 * OpenDocument Text export::    Exporting to OpenDocument Text
584 * Org export::                  Exporting to Org
585 * Texinfo export::              Exporting to Texinfo
586 * iCalendar export::            Exporting to iCalendar
587 * Other built-in back-ends::    Exporting to a man page
588 * Export in foreign buffers::   Author tables and lists in Org syntax
589 * Advanced configuration::      Fine-tuning the export output
591 HTML export
593 * HTML Export commands::        How to invoke HTML export
594 * HTML doctypes::               Org can export to various (X)HTML flavors
595 * HTML preamble and postamble::  How to insert a preamble and a postamble
596 * Quoting HTML tags::           Using direct HTML in Org mode
597 * Links in HTML export::        How links will be interpreted and formatted
598 * Tables in HTML export::       How to modify the formatting of tables
599 * Images in HTML export::       How to insert figures into HTML output
600 * Math formatting in HTML export::  Beautiful math also on the web
601 * Text areas in HTML export::   An alternative way to show an example
602 * CSS support::                 Changing the appearance of the output
603 * JavaScript support::          Info and Folding in a web browser
605 @LaTeX{} and PDF export
607 * @LaTeX{} export commands::    How to export to LaTeX and PDF
608 * Header and sectioning::       Setting up the export file structure
609 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
610 * @LaTeX{} specific attributes::  Controlling @LaTeX{} output
612 OpenDocument text export
614 * Pre-requisites for ODT export::  What packages ODT exporter relies on
615 * ODT export commands::         How to invoke ODT export
616 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
617 * Applying custom styles::      How to apply custom styles to the output
618 * Links in ODT export::         How links will be interpreted and formatted
619 * Tables in ODT export::        How Tables are exported
620 * Images in ODT export::        How to insert images
621 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
622 * Labels and captions in ODT export::  How captions are rendered
623 * Literal examples in ODT export::  How source and example blocks are formatted
624 * Advanced topics in ODT export::  Read this if you are a power user
626 Math formatting in ODT export
628 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
629 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
631 Advanced topics in ODT export
633 * Configuring a document converter::  How to register a document converter
634 * Working with OpenDocument style files::  Explore the internals
635 * Creating one-off styles::     How to produce custom highlighting etc
636 * Customizing tables in ODT export::  How to define and use Table templates
637 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
639 Texinfo export
641 * Texinfo export commands::     How to invoke Texinfo export
642 * Document preamble::           File header, title and copyright page
643 * Headings and sectioning structure:: Building document structure
644 * Indices::                     Creating indices
645 * Quoting Texinfo code::        Incorporating literal Texinfo code
646 * Texinfo specific attributes:: Controlling Texinfo output
647 * An example::
649 Publishing
651 * Configuration::               Defining projects
652 * Uploading files::             How to get files up on the server
653 * Sample configuration::        Example projects
654 * Triggering publication::      Publication commands
656 Configuration
658 * Project alist::               The central configuration variable
659 * Sources and destinations::    From here to there
660 * Selecting files::             What files are part of the project?
661 * Publishing action::           Setting the function doing the publishing
662 * Publishing options::          Tweaking HTML/@LaTeX{} export
663 * Publishing links::            Which links keep working after publishing?
664 * Sitemap::                     Generating a list of all pages
665 * Generating an index::         An index that reaches across pages
667 Sample configuration
669 * Simple example::              One-component publishing
670 * Complex example::             A multi-component publishing example
672 Working with source code
674 * Structure of code blocks::    Code block syntax described
675 * Editing source code::         Language major-mode editing
676 * Exporting code blocks::       Export contents and/or results
677 * Extracting source code::      Create pure source code files
678 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
679 * Library of Babel::            Use and contribute to a library of useful code blocks
680 * Languages::                   List of supported code block languages
681 * Header arguments::            Configure code block functionality
682 * Results of evaluation::       How evaluation results are handled
683 * Noweb reference syntax::      Literate programming in Org mode
684 * Key bindings and useful functions::  Work quickly with code blocks
685 * Batch execution::             Call functions from the command line
687 Header arguments
689 * Using header arguments::      Different ways to set header arguments
690 * Specific header arguments::   List of header arguments
692 Using header arguments
694 * System-wide header arguments::  Set global default values
695 * Language-specific header arguments::  Set default values by language
696 * Header arguments in Org mode properties::  Set default values for a buffer or heading
697 * Language-specific header arguments in Org mode properties::  Set language-specific default values for a buffer or heading
698 * Code block specific header arguments::  The most common way to set values
699 * Header arguments in function calls::  The most specific level
701 Specific header arguments
703 * var::                         Pass arguments to code blocks
704 * Results::                     Specify the type of results and how they will
705                                 be collected and handled
706 * file::                        Specify a path for file output
707 * file-desc::                   Specify a description for file results
708 * dir::                         Specify the default (possibly remote)
709                                 directory for code block execution
710 * exports::                     Export code and/or results
711 * tangle::                      Toggle tangling and specify file name
712 * mkdirp::                      Toggle creation of parent directories of target
713                                 files during tangling
714 * comments::                    Toggle insertion of comments in tangled
715                                 code files
716 * padline::                     Control insertion of padding lines in tangled
717                                 code files
718 * no-expand::                   Turn off variable assignment and noweb
719                                 expansion during tangling
720 * session::                     Preserve the state of code evaluation
721 * noweb::                       Toggle expansion of noweb references
722 * noweb-ref::                   Specify block's noweb reference resolution target
723 * noweb-sep::                   String used to separate noweb references
724 * cache::                       Avoid re-evaluating unchanged code blocks
725 * sep::                         Delimiter for writing tabular results outside Org
726 * hlines::                      Handle horizontal lines in tables
727 * colnames::                    Handle column names in tables
728 * rownames::                    Handle row names in tables
729 * shebang::                     Make tangled files executable
730 * tangle-mode::                 Set permission of tangled files
731 * eval::                        Limit evaluation of specific code blocks
732 * wrap::                        Mark source block evaluation results
733 * post::                        Post processing of code block results
734 * prologue::                    Text to prepend to code block body
735 * epilogue::                    Text to append to code block body
737 Miscellaneous
739 * Completion::                  M-TAB knows what you need
740 * Easy templates::              Quick insertion of structural elements
741 * Speed keys::                  Electric commands at the beginning of a headline
742 * Code evaluation security::    Org mode files evaluate inline code
743 * Customization::               Adapting Org to your taste
744 * In-buffer settings::          Overview of the #+KEYWORDS
745 * The very busy C-c C-c key::   When in doubt, press C-c C-c
746 * Clean view::                  Getting rid of leading stars in the outline
747 * TTY keys::                    Using Org on a tty
748 * Interaction::                 Other Emacs packages
749 * org-crypt::                   Encrypting Org files
751 Interaction with other packages
753 * Cooperation::                 Packages Org cooperates with
754 * Conflicts::                   Packages that lead to conflicts
756 Hacking
758 * Hooks::                       How to reach into Org's internals
759 * Add-on packages::             Available extensions
760 * Adding hyperlink types::      New custom link types
761 * Adding export back-ends::     How to write new export back-ends
762 * Context-sensitive commands::  How to add functionality to such commands
763 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
764 * Dynamic blocks::              Automatically filled blocks
765 * Special agenda views::        Customized views
766 * Speeding up your agendas::    Tips on how to speed up your agendas
767 * Extracting agenda information::  Post-processing of agenda information
768 * Using the property API::      Writing programs that use entry properties
769 * Using the mapping API::       Mapping over all or selected entries
771 Tables and lists in arbitrary syntax
773 * Radio tables::                Sending and receiving radio tables
774 * A @LaTeX{} example::          Step by step, almost a tutorial
775 * Translator functions::        Copy and modify
776 * Radio lists::                 Sending and receiving lists
778 MobileOrg
780 * Setting up the staging area::  Where to interact with the mobile device
781 * Pushing to MobileOrg::        Uploading Org files and agendas
782 * Pulling from MobileOrg::      Integrating captured and flagged items
784 @end detailmenu
785 @end menu
787 @node Introduction
788 @chapter Introduction
789 @cindex introduction
791 @menu
792 * Summary::                     Brief summary of what Org does
793 * Installation::                Installing Org
794 * Activation::                  How to activate Org for certain buffers
795 * Feedback::                    Bug reports, ideas, patches etc.
796 * Conventions::                 Typesetting conventions in the manual
797 @end menu
799 @node Summary
800 @section Summary
801 @cindex summary
803 Org is a mode for keeping notes, maintaining TODO lists, and project planning
804 with a fast and effective plain-text system.  It also is an authoring system
805 with unique support for literate programming and reproducible research.
807 Org is implemented on top of Outline mode, which makes it possible to keep
808 the content of large files well structured.  Visibility cycling and structure
809 editing help to work with the tree.  Tables are easily created with a
810 built-in table editor.  Plain text URL-like links connect to websites,
811 emails, Usenet messages, BBDB entries, and any files related to the projects.
813 Org develops organizational tasks around notes files that contain lists or
814 information about projects as plain text.  Project planning and task
815 management makes use of metadata which is part of an outline node.  Based on
816 this data, specific entries can be extracted in queries and create dynamic
817 @i{agenda views} that also integrate the Emacs calendar and diary.  Org can
818 be used to implement many different project planning schemes, such as David
819 Allen's GTD system.
821 Org files can serve as a single source authoring system with export to many
822 different formats such as HTML, @LaTeX{}, Open Document, and Markdown.  New
823 export backends can be derived from existing ones, or defined from scratch.
825 Org files can include source code blocks, which makes Org uniquely suited for
826 authoring technical documents with code examples. Org source code blocks are
827 fully functional; they can be evaluated in place and their results can be
828 captured in the file.  This makes it possible to create a single file
829 reproducible research compendium.
831 Org keeps simple things simple.  When first fired up, it should feel like a
832 straightforward, easy to use outliner.  Complexity is not imposed, but a
833 large amount of functionality is available when needed.  Org is a toolbox.
834 Many users actually run only a (very personal) fraction of Org's capabilities, and
835 know that there is more whenever they need it.
837 All of this is achieved with strictly plain text files, the most portable and
838 future-proof file format.  Org runs in Emacs.  Emacs is one of the most
839 widely ported programs, so that Org mode is available on every major
840 platform.
842 @cindex FAQ
843 There is a website for Org which provides links to the newest
844 version of Org, as well as additional information, frequently asked
845 questions (FAQ), links to tutorials, etc.  This page is located at
846 @uref{http://orgmode.org}.
847 @cindex print edition
849 An earlier version (7.3) of this manual is available as a
850 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from
851 Network Theory Ltd.}
853 @page
855 @node Installation
856 @section Installation
857 @cindex installation
858 @cindex XEmacs
860 Org is part of recent distributions of GNU Emacs, so you normally don't need
861 to install it.  If, for one reason or another, you want to install Org on top
862 of this pre-packaged version, there are three ways to do it:
864 @itemize @bullet
865 @item By using Emacs package system.
866 @item By downloading Org as an archive.
867 @item By using Org's git repository.
868 @end itemize
870 We @b{strongly recommend} to stick to a single installation method.
872 @subsubheading Using Emacs packaging system
874 Recent Emacs distributions include a packaging system which lets you install
875 Elisp libraries.  You can install Org with @kbd{M-x package-install RET org}.
877 @noindent @b{Important}: you need to do this in a session where no @code{.org} file has
878 been visited, i.e. where no Org built-in function have been loaded.
879 Otherwise autoload Org functions will mess up the installation.
881 Then, to make sure your Org configuration is taken into account, initialize
882 the package system with @code{(package-initialize)} in your @file{.emacs}
883 before setting any Org option.  If you want to use Org's package repository,
884 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
886 @subsubheading Downloading Org as an archive
888 You can download Org latest release from @uref{http://orgmode.org/, Org's
889 website}.  In this case, make sure you set the load-path correctly in your
890 @file{.emacs}:
892 @lisp
893 (add-to-list 'load-path "~/path/to/orgdir/lisp")
894 @end lisp
896 The downloaded archive contains contributed libraries that are not included
897 in Emacs.  If you want to use them, add the @file{contrib} directory to your
898 load-path:
900 @lisp
901 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
902 @end lisp
904 Optionally, you can compile the files and/or install them in your system.
905 Run @code{make help} to list compilation and installation options.
907 @subsubheading Using Org's git repository
909 You can clone Org's repository and install Org like this:
911 @example
912 $ cd ~/src/
913 $ git clone git://orgmode.org/org-mode.git
914 $ make autoloads
915 @end example
917 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
918 version in @file{org-version.el} and Org's autoloads in
919 @file{org-loaddefs.el}.
921 Remember to add the correct load-path as described in the method above.
923 You can also compile with @code{make}, generate the documentation with
924 @code{make doc}, create a local configuration with @code{make config} and
925 install Org with @code{make install}.  Please run @code{make help} to get
926 the list of compilation/installation options.
928 For more detailed explanations on Org's build system, please check the Org
929 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
930 Worg}.
932 @node Activation
933 @section Activation
934 @cindex activation
935 @cindex autoload
936 @cindex ELPA
937 @cindex global key bindings
938 @cindex key bindings, global
939 @findex org-agenda
940 @findex org-capture
941 @findex org-store-link
942 @findex org-iswitchb
944 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
945 default.  If you are using an earlier version of Emacs, add this line to your
946 @file{.emacs} file:
948 @lisp
949 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
950 @end lisp
952 Org mode buffers need font-lock to be turned on: this is the default in
953 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
954 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
956 There are compatibility issues between Org mode and some other Elisp
957 packages, please take the time to check the list (@pxref{Conflicts}).
959 The four Org commands @command{org-store-link}, @command{org-capture},
960 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
961 global keys (i.e., anywhere in Emacs, not just in Org buffers).  Here are
962 suggested bindings for these keys, please modify the keys to your own
963 liking.
964 @lisp
965 (global-set-key "\C-cl" 'org-store-link)
966 (global-set-key "\C-ca" 'org-agenda)
967 (global-set-key "\C-cc" 'org-capture)
968 (global-set-key "\C-cb" 'org-iswitchb)
969 @end lisp
971 @cindex Org mode, turning on
972 To turn on Org mode in a file that does not have the extension @file{.org},
973 make the first line of a file look like this:
975 @example
976 MY PROJECTS    -*- mode: org; -*-
977 @end example
979 @vindex org-insert-mode-line-in-empty-file
980 @noindent which will select Org mode for this buffer no matter what
981 the file's name is.  See also the variable
982 @code{org-insert-mode-line-in-empty-file}.
984 Many commands in Org work on the region if the region is @i{active}.  To make
985 use of this, you need to have @code{transient-mark-mode}
986 (@code{zmacs-regions} in XEmacs) turned on.  In Emacs 23 this is the default,
987 in Emacs 22 you need to do this yourself with
988 @lisp
989 (transient-mark-mode 1)
990 @end lisp
991 @noindent If you do not like @code{transient-mark-mode}, you can create an
992 active region by using the mouse to select a region, or pressing
993 @kbd{C-@key{SPC}} twice before moving the cursor.
995 @node Feedback
996 @section Feedback
997 @cindex feedback
998 @cindex bug reports
999 @cindex maintainer
1000 @cindex author
1002 If you find problems with Org, or if you have questions, remarks, or ideas
1003 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1004 You can subscribe to the list
1005 @uref{https://lists.gnu.org/mailman/listinfo/emacs-orgmode, on this web page}.
1006 If you are not a member of the mailing list, your mail will be passed to the
1007 list after a moderator has approved it@footnote{Please consider subscribing
1008 to the mailing list, in order to minimize the work the mailing list
1009 moderators have to do.}.
1011 For bug reports, please first try to reproduce the bug with the latest
1012 version of Org available---if you are running an outdated version, it is
1013 quite possible that the bug has been fixed already.  If the bug persists,
1014 prepare a report and provide as much information as possible, including the
1015 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1016 (@kbd{M-x org-version RET}), as well as the Org related setup in
1017 @file{.emacs}.  The easiest way to do this is to use the command
1018 @example
1019 @kbd{M-x org-submit-bug-report RET}
1020 @end example
1021 @noindent which will put all this information into an Emacs mail buffer so
1022 that you only need to add your description.  If you are not sending the Email
1023 from within Emacs, please copy and paste the content into your Email program.
1025 Sometimes you might face a problem due to an error in your Emacs or Org mode
1026 setup.  Before reporting a bug, it is very helpful to start Emacs with minimal
1027 customizations and reproduce the problem.  Doing so often helps you determine
1028 if the problem is with your customization or with Org mode itself.  You can
1029 start a typical minimal session with a command like the example below.
1031 @example
1032 $ emacs -Q -l /path/to/minimal-org.el
1033 @end example
1035 However if you are using Org mode as distributed with Emacs, a minimal setup
1036 is not necessary.  In that case it is sufficient to start Emacs as
1037 @code{emacs -Q}.  The @code{minimal-org.el} setup file can have contents as
1038 shown below.
1040 @lisp
1041 ;;; Minimal setup to load latest `org-mode'
1043 ;; activate debugging
1044 (setq debug-on-error t
1045       debug-on-signal nil
1046       debug-on-quit nil)
1048 ;; add latest org-mode to load path
1049 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1050 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1051 @end lisp
1053 If an error occurs, a backtrace can be very useful (see below on how to
1054 create one).  Often a small example file helps, along with clear information
1055 about:
1057 @enumerate
1058 @item What exactly did you do?
1059 @item What did you expect to happen?
1060 @item What happened instead?
1061 @end enumerate
1062 @noindent Thank you for helping to improve this program.
1064 @subsubheading How to create a useful backtrace
1066 @cindex backtrace of an error
1067 If working with Org produces an error with a message you don't
1068 understand, you may have hit a bug.  The best way to report this is by
1069 providing, in addition to what was mentioned above, a @emph{backtrace}.
1070 This is information from the built-in debugger about where and how the
1071 error occurred.  Here is how to produce a useful backtrace:
1073 @enumerate
1074 @item
1075 Reload uncompiled versions of all Org mode Lisp files.  The backtrace
1076 contains much more information if it is produced with uncompiled code.
1077 To do this, use
1078 @example
1079 @kbd{C-u M-x org-reload RET}
1080 @end example
1081 @noindent
1082 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1083 menu.
1084 @item
1085 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1086 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1087 @item
1088 Do whatever you have to do to hit the error.  Don't forget to
1089 document the steps you take.
1090 @item
1091 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1092 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
1093 attach it to your bug report.
1094 @end enumerate
1096 @node Conventions
1097 @section Typesetting conventions used in this manual
1099 @subsubheading TODO keywords, tags, properties, etc.
1101 Org mainly uses three types of keywords: TODO keywords, tags and property
1102 names.  In this manual we use the following conventions:
1104 @table @code
1105 @item TODO
1106 @itemx WAITING
1107 TODO keywords are written with all capitals, even if they are
1108 user-defined.
1109 @item boss
1110 @itemx ARCHIVE
1111 User-defined tags are written in lowercase; built-in tags with special
1112 meaning are written with all capitals.
1113 @item Release
1114 @itemx PRIORITY
1115 User-defined properties are capitalized; built-in properties with
1116 special meaning are written with all capitals.
1117 @end table
1119 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1120 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1121 environment).  They are written in uppercase in the manual to enhance its
1122 readability, but you can use lowercase in your Org files@footnote{Easy
1123 templates insert lowercase keywords and Babel dynamically inserts
1124 @code{#+results}.}.
1126 @subsubheading Keybindings and commands
1127 @kindex C-c a
1128 @findex org-agenda
1129 @kindex C-c c
1130 @findex org-capture
1132 The manual suggests a few global keybindings, in particular @kbd{C-c a} for
1133 @code{org-agenda} and @kbd{C-c c} for @code{org-capture}.  These are only
1134 suggestions, but the rest of the manual assumes that these keybindings are in
1135 place in order to list commands by key access.
1137 Also, the manual lists both the keys and the corresponding commands for
1138 accessing a functionality.  Org mode often uses the same key for different
1139 functions, depending on context.  The command that is bound to such keys has
1140 a generic name, like @code{org-metaright}.  In the manual we will, wherever
1141 possible, give the function that is internally called by the generic command.
1142 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1143 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1144 will be listed to call @code{org-table-move-column-right}.  If you prefer,
1145 you can compile the manual without the command names by unsetting the flag
1146 @code{cmdnames} in @file{org.texi}.
1148 @node Document structure
1149 @chapter Document structure
1150 @cindex document structure
1151 @cindex structure of document
1153 Org is based on Outline mode and provides flexible commands to
1154 edit the structure of the document.
1156 @menu
1157 * Outlines::                    Org is based on Outline mode
1158 * Headlines::                   How to typeset Org tree headlines
1159 * Visibility cycling::          Show and hide, much simplified
1160 * Motion::                      Jumping to other headlines
1161 * Structure editing::           Changing sequence and level of headlines
1162 * Sparse trees::                Matches embedded in context
1163 * Plain lists::                 Additional structure within an entry
1164 * Drawers::                     Tucking stuff away
1165 * Blocks::                      Folding blocks
1166 * Footnotes::                   How footnotes are defined in Org's syntax
1167 * Orgstruct mode::              Structure editing outside Org
1168 * Org syntax::                  Formal description of Org's syntax
1169 @end menu
1171 @node Outlines
1172 @section Outlines
1173 @cindex outlines
1174 @cindex Outline mode
1176 Org is implemented on top of Outline mode.  Outlines allow a
1177 document to be organized in a hierarchical structure, which (at least
1178 for me) is the best representation of notes and thoughts.  An overview
1179 of this structure is achieved by folding (hiding) large parts of the
1180 document to show only the general document structure and the parts
1181 currently being worked on.  Org greatly simplifies the use of
1182 outlines by compressing the entire show/hide functionality into a single
1183 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1185 @node Headlines
1186 @section Headlines
1187 @cindex headlines
1188 @cindex outline tree
1189 @vindex org-special-ctrl-a/e
1190 @vindex org-special-ctrl-k
1191 @vindex org-ctrl-k-protect-subtree
1193 Headlines define the structure of an outline tree.  The headlines in Org
1194 start with one or more stars, on the left margin@footnote{See the variables
1195 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1196 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1197 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1198 headings indented less than 30 stars.}.  For example:
1200 @example
1201 * Top level headline
1202 ** Second level
1203 *** 3rd level
1204     some text
1205 *** 3rd level
1206     more text
1208 * Another top level headline
1209 @end example
1211 @vindex org-footnote-section
1212 @noindent Note that a headline named after @code{org-footnote-section},
1213 which defaults to @samp{Footnotes}, is considered as special.  A subtree with
1214 this headline will be silently ignored by exporting functions.
1216 Some people find the many stars too noisy and would prefer an
1217 outline that has whitespace followed by a single star as headline
1218 starters.  @ref{Clean view}, describes a setup to realize this.
1220 @vindex org-cycle-separator-lines
1221 An empty line after the end of a subtree is considered part of it and
1222 will be hidden when the subtree is folded.  However, if you leave at
1223 least two empty lines, one empty line will remain visible after folding
1224 the subtree, in order to structure the collapsed view.  See the
1225 variable @code{org-cycle-separator-lines} to modify this behavior.
1227 @node Visibility cycling
1228 @section Visibility cycling
1229 @cindex cycling, visibility
1230 @cindex visibility cycling
1231 @cindex trees, visibility
1232 @cindex show hidden text
1233 @cindex hide text
1235 @menu
1236 * Global and local cycling::    Cycling through various visibility states
1237 * Initial visibility::          Setting the initial visibility state
1238 * Catching invisible edits::    Preventing mistakes when editing invisible parts
1239 @end menu
1241 @node Global and local cycling
1242 @subsection Global and local cycling
1244 Outlines make it possible to hide parts of the text in the buffer.
1245 Org uses just two commands, bound to @key{TAB} and
1246 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1248 @cindex subtree visibility states
1249 @cindex subtree cycling
1250 @cindex folded, subtree visibility state
1251 @cindex children, subtree visibility state
1252 @cindex subtree, subtree visibility state
1253 @table @asis
1254 @orgcmd{@key{TAB},org-cycle}
1255 @emph{Subtree cycling}: Rotate current subtree among the states
1257 @example
1258 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1259 '-----------------------------------'
1260 @end example
1262 @vindex org-cycle-emulate-tab
1263 @vindex org-cycle-global-at-bob
1264 The cursor must be on a headline for this to work@footnote{see, however,
1265 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
1266 beginning of the buffer and the first line is not a headline, then
1267 @key{TAB} actually runs global cycling (see below)@footnote{see the
1268 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
1269 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1271 @cindex global visibility states
1272 @cindex global cycling
1273 @cindex overview, global visibility state
1274 @cindex contents, global visibility state
1275 @cindex show all, global visibility state
1276 @orgcmd{S-@key{TAB},org-global-cycle}
1277 @itemx C-u @key{TAB}
1278 @emph{Global cycling}: Rotate the entire buffer among the states
1280 @example
1281 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1282 '--------------------------------------'
1283 @end example
1285 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1286 CONTENTS view up to headlines of level N will be shown.  Note that inside
1287 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1289 @cindex set startup visibility, command
1290 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1291 Switch back to the startup visibility of the buffer (@pxref{Initial visibility}).
1292 @cindex show all, command
1293 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1294 Show all, including drawers.
1295 @cindex revealing context
1296 @orgcmd{C-c C-r,org-reveal}
1297 Reveal context around point, showing the current entry, the following heading
1298 and the hierarchy above.  Useful for working near a location that has been
1299 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1300 (@pxref{Agenda commands}).  With a prefix argument show, on each
1301 level, all sibling headings.  With a double prefix argument, also show the
1302 entire subtree of the parent.
1303 @cindex show branches, command
1304 @orgcmd{C-c C-k,show-branches}
1305 Expose all the headings of the subtree, CONTENT view for just one subtree.
1306 @cindex show children, command
1307 @orgcmd{C-c @key{TAB},show-children}
1308 Expose all direct children of the subtree.  With a numeric prefix argument N,
1309 expose all children down to level N@.
1310 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1311 Show the current subtree in an indirect buffer@footnote{The indirect buffer
1312 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) will contain the entire
1313 buffer, but will be narrowed to the current tree.  Editing the indirect
1314 buffer will also change the original buffer, but without affecting visibility
1315 in that buffer.}.  With a numeric prefix argument N, go up to level N and
1316 then take that tree.  If N is negative then go up that many levels.  With a
1317 @kbd{C-u} prefix, do not remove the previously used indirect buffer.
1318 @orgcmd{C-c C-x v,org-copy-visible}
1319 Copy the @i{visible} text in the region into the kill ring.
1320 @end table
1322 @node Initial visibility
1323 @subsection Initial visibility
1325 @cindex visibility, initialize
1326 @vindex org-startup-folded
1327 @vindex org-agenda-inhibit-startup
1328 @cindex @code{overview}, STARTUP keyword
1329 @cindex @code{content}, STARTUP keyword
1330 @cindex @code{showall}, STARTUP keyword
1331 @cindex @code{showeverything}, STARTUP keyword
1333 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1334 i.e., only the top level headlines are visible@footnote{When
1335 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1336 visibility state when first opening a file for the agenda (@pxref{Speeding up
1337 your agendas}).}.  This can be configured through the variable
1338 @code{org-startup-folded}, or on a per-file basis by adding one of the
1339 following lines anywhere in the buffer:
1341 @example
1342 #+STARTUP: overview
1343 #+STARTUP: content
1344 #+STARTUP: showall
1345 #+STARTUP: showeverything
1346 @end example
1348 The startup visibility options are ignored when the file is open for the
1349 first time during the agenda generation: if you want the agenda to honor
1350 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1352 @cindex property, VISIBILITY
1353 @noindent
1354 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1355 and columns}) will get their visibility adapted accordingly.  Allowed values
1356 for this property are @code{folded}, @code{children}, @code{content}, and
1357 @code{all}.
1359 @table @asis
1360 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1361 Switch back to the startup visibility of the buffer, i.e., whatever is
1362 requested by startup options and @samp{VISIBILITY} properties in individual
1363 entries.
1364 @end table
1366 @node Catching invisible edits
1367 @subsection Catching invisible edits
1369 @vindex org-catch-invisible-edits
1370 @cindex edits, catching invisible
1371 Sometimes you may inadvertently edit an invisible part of the buffer and be
1372 confused on what has been edited and how to undo the mistake.  Setting
1373 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this.  See the
1374 docstring of this option on how Org should catch invisible edits and process
1375 them.
1377 @node Motion
1378 @section Motion
1379 @cindex motion, between headlines
1380 @cindex jumping, to headlines
1381 @cindex headline navigation
1382 The following commands jump to other headlines in the buffer.
1384 @table @asis
1385 @orgcmd{C-c C-n,outline-next-visible-heading}
1386 Next heading.
1387 @orgcmd{C-c C-p,outline-previous-visible-heading}
1388 Previous heading.
1389 @orgcmd{C-c C-f,org-forward-same-level}
1390 Next heading same level.
1391 @orgcmd{C-c C-b,org-backward-same-level}
1392 Previous heading same level.
1393 @orgcmd{C-c C-u,outline-up-heading}
1394 Backward to higher level heading.
1395 @orgcmd{C-c C-j,org-goto}
1396 Jump to a different place without changing the current outline
1397 visibility.  Shows the document structure in a temporary buffer, where
1398 you can use the following keys to find your destination:
1399 @vindex org-goto-auto-isearch
1400 @example
1401 @key{TAB}         @r{Cycle visibility.}
1402 @key{down} / @key{up}   @r{Next/previous visible headline.}
1403 @key{RET}         @r{Select this location.}
1404 @kbd{/}           @r{Do a Sparse-tree search}
1405 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1406 n / p        @r{Next/previous visible headline.}
1407 f / b        @r{Next/previous headline same level.}
1408 u            @r{One level up.}
1409 0-9          @r{Digit argument.}
1410 q            @r{Quit}
1411 @end example
1412 @vindex org-goto-interface
1413 @noindent
1414 See also the option @code{org-goto-interface}.
1415 @end table
1417 @node Structure editing
1418 @section Structure editing
1419 @cindex structure editing
1420 @cindex headline, promotion and demotion
1421 @cindex promotion, of subtrees
1422 @cindex demotion, of subtrees
1423 @cindex subtree, cut and paste
1424 @cindex pasting, of subtrees
1425 @cindex cutting, of subtrees
1426 @cindex copying, of subtrees
1427 @cindex sorting, of subtrees
1428 @cindex subtrees, cut and paste
1430 @table @asis
1431 @orgcmd{M-@key{RET},org-insert-heading}
1432 @vindex org-M-RET-may-split-line
1433 Insert a new heading/item with the same level as the one at point.
1435 If the cursor is in a plain list item, a new item is created (@pxref{Plain
1436 lists}).  To prevent this behavior in lists, call the command with one prefix
1437 argument.  When this command is used in the middle of a line, the line is
1438 split and the rest of the line becomes the new item or headline.  If you do
1439 not want the line to be split, customize @code{org-M-RET-may-split-line}.
1441 If the command is used at the @emph{beginning} of a line, and if there is a
1442 heading or an item at point, the new heading/item is created @emph{before}
1443 the current line.  If the command is used at the @emph{end} of a folded
1444 subtree (i.e., behind the ellipses at the end of a headline), then a headline
1445 will be inserted after the end of the subtree.
1447 Calling this command with @kbd{C-u C-u} will unconditionally respect the
1448 headline's content and create a new item at the end of the parent subtree.
1450 If point is at the beginning of a normal line, turn this line into a heading.
1451 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1452 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1453 current heading, the new heading is placed after the body instead of before
1454 it.  This command works from anywhere in the entry.
1455 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1456 @vindex org-treat-insert-todo-heading-as-state-change
1457 Insert new TODO entry with same level as current heading.  See also the
1458 variable @code{org-treat-insert-todo-heading-as-state-change}.
1459 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1460 Insert new TODO entry with same level as current heading.  Like
1461 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1462 subtree.
1463 @orgcmd{@key{TAB},org-cycle}
1464 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1465 become a child of the previous one.  The next @key{TAB} makes it a parent,
1466 and so on, all the way to top level.  Yet another @key{TAB}, and you are back
1467 to the initial level.
1468 @orgcmd{M-@key{left},org-do-promote}
1469 Promote current heading by one level.
1470 @orgcmd{M-@key{right},org-do-demote}
1471 Demote current heading by one level.
1472 @orgcmd{M-S-@key{left},org-promote-subtree}
1473 Promote the current subtree by one level.
1474 @orgcmd{M-S-@key{right},org-demote-subtree}
1475 Demote the current subtree by one level.
1476 @orgcmd{M-S-@key{up},org-move-subtree-up}
1477 Move subtree up (swap with previous subtree of same
1478 level).
1479 @orgcmd{M-S-@key{down},org-move-subtree-down}
1480 Move subtree down (swap with next subtree of same level).
1481 @orgcmd{M-h,org-mark-element}
1482 Mark the element at point.  Hitting repeatedly will mark subsequent elements
1483 of the one just marked.  E.g., hitting @key{M-h} on a paragraph will mark it,
1484 hitting @key{M-h} immediately again will mark the next one.
1485 @orgcmd{C-c @@,org-mark-subtree}
1486 Mark the subtree at point.  Hitting repeatedly will mark subsequent subtrees
1487 of the same level than the marked subtree.
1488 @orgcmd{C-c C-x C-w,org-cut-subtree}
1489 Kill subtree, i.e., remove it from buffer but save in kill ring.
1490 With a numeric prefix argument N, kill N sequential subtrees.
1491 @orgcmd{C-c C-x M-w,org-copy-subtree}
1492 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
1493 sequential subtrees.
1494 @orgcmd{C-c C-x C-y,org-paste-subtree}
1495 Yank subtree from kill ring.  This does modify the level of the subtree to
1496 make sure the tree fits in nicely at the yank position.  The yank level can
1497 also be specified with a numeric prefix argument, or by yanking after a
1498 headline marker like @samp{****}.
1499 @orgcmd{C-y,org-yank}
1500 @vindex org-yank-adjusted-subtrees
1501 @vindex org-yank-folded-subtrees
1502 Depending on the options @code{org-yank-adjusted-subtrees} and
1503 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1504 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1505 C-x C-y}.  With the default settings, no level adjustment will take place,
1506 but the yanked tree will be folded unless doing so would swallow text
1507 previously visible.  Any prefix argument to this command will force a normal
1508 @code{yank} to be executed, with the prefix passed along.  A good way to
1509 force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
1510 yank, it will yank previous kill items plainly, without adjustment and
1511 folding.
1512 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1513 Clone a subtree by making a number of sibling copies of it.  You will be
1514 prompted for the number of copies to make, and you can also specify if any
1515 timestamps in the entry should be shifted.  This can be useful, for example,
1516 to create a number of tasks related to a series of lectures to prepare.  For
1517 more details, see the docstring of the command
1518 @code{org-clone-subtree-with-time-shift}.
1519 @orgcmd{C-c C-w,org-refile}
1520 Refile entry or region to a different location.  @xref{Refile and copy}.
1521 @orgcmd{C-c ^,org-sort}
1522 Sort same-level entries.  When there is an active region, all entries in the
1523 region will be sorted.  Otherwise the children of the current headline are
1524 sorted.  The command prompts for the sorting method, which can be
1525 alphabetically, numerically, by time (first timestamp with active preferred,
1526 creation time, scheduled time, deadline time), by priority, by TODO keyword
1527 (in the sequence the keywords have been defined in the setup) or by the value
1528 of a property.  Reverse sorting is possible as well.  You can also supply
1529 your own function to extract the sorting key.  With a @kbd{C-u} prefix,
1530 sorting will be case-sensitive.
1531 @orgcmd{C-x n s,org-narrow-to-subtree}
1532 Narrow buffer to current subtree.
1533 @orgcmd{C-x n b,org-narrow-to-block}
1534 Narrow buffer to current block.
1535 @orgcmd{C-x n w,widen}
1536 Widen buffer to remove narrowing.
1537 @orgcmd{C-c *,org-toggle-heading}
1538 Turn a normal line or plain list item into a headline (so that it becomes a
1539 subheading at its location).  Also turn a headline into a normal line by
1540 removing the stars.  If there is an active region, turn all lines in the
1541 region into headlines.  If the first line in the region was an item, turn
1542 only the item lines into headlines.  Finally, if the first line is a
1543 headline, remove the stars from all headlines in the region.
1544 @end table
1546 @cindex region, active
1547 @cindex active region
1548 @cindex transient mark mode
1549 When there is an active region (Transient Mark mode), promotion and
1550 demotion work on all headlines in the region.  To select a region of
1551 headlines, it is best to place both point and mark at the beginning of a
1552 line, mark at the beginning of the first headline, and point at the line
1553 just after the last headline to change.  Note that when the cursor is
1554 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1555 functionality.
1558 @node Sparse trees
1559 @section Sparse trees
1560 @cindex sparse trees
1561 @cindex trees, sparse
1562 @cindex folding, sparse trees
1563 @cindex occur, command
1565 @vindex org-show-context-detail
1566 An important feature of Org mode is the ability to construct @emph{sparse
1567 trees} for selected information in an outline tree, so that the entire
1568 document is folded as much as possible, but the selected information is made
1569 visible along with the headline structure above it@footnote{See also the
1570 variable @code{org-show-context-detail} to decide how much context is shown
1571 around each match.}.  Just try it out and you will see immediately how it
1572 works.
1574 Org mode contains several commands for creating such trees, all these
1575 commands can be accessed through a dispatcher:
1577 @table @asis
1578 @orgcmd{C-c /,org-sparse-tree}
1579 This prompts for an extra key to select a sparse-tree creating command.
1580 @orgcmd{C-c / r,org-occur}
1581 @vindex org-remove-highlights-with-change
1582 Prompts for a regexp and shows a sparse tree with all matches.  If
1583 the match is in a headline, the headline is made visible.  If the match is in
1584 the body of an entry, headline and body are made visible.  In order to
1585 provide minimal context, also the full hierarchy of headlines above the match
1586 is shown, as well as the headline following the match.  Each match is also
1587 highlighted; the highlights disappear when the buffer is changed by an
1588 editing command@footnote{This depends on the option
1589 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1590 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1591 so several calls to this command can be stacked.
1592 @orgcmdkkc{M-g n,M-g M-n,next-error}
1593 Jump to the next sparse tree match in this buffer.
1594 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1595 Jump to the previous sparse tree match in this buffer.
1596 @end table
1598 @noindent
1599 @vindex org-agenda-custom-commands
1600 For frequently used sparse trees of specific search strings, you can
1601 use the option @code{org-agenda-custom-commands} to define fast
1602 keyboard access to specific sparse trees.  These commands will then be
1603 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1604 For example:
1606 @lisp
1607 (setq org-agenda-custom-commands
1608       '(("f" occur-tree "FIXME")))
1609 @end lisp
1611 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1612 a sparse tree matching the string @samp{FIXME}.
1614 The other sparse tree commands select headings based on TODO keywords,
1615 tags, or properties and will be discussed later in this manual.
1617 @kindex C-c C-e C-v
1618 @cindex printing sparse trees
1619 @cindex visible text, printing
1620 To print a sparse tree, you can use the Emacs command
1621 @code{ps-print-buffer-with-faces} which does not print invisible parts
1622 of the document @footnote{This does not work under XEmacs, because
1623 XEmacs uses selective display for outlining, not text properties.}.
1624 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1625 the document and print the resulting file.
1627 @node Plain lists
1628 @section Plain lists
1629 @cindex plain lists
1630 @cindex lists, plain
1631 @cindex lists, ordered
1632 @cindex ordered lists
1634 Within an entry of the outline tree, hand-formatted lists can provide
1635 additional structure.  They also provide a way to create lists of checkboxes
1636 (@pxref{Checkboxes}).  Org supports editing such lists, and every exporter
1637 (@pxref{Exporting}) can parse and format them.
1639 Org knows ordered lists, unordered lists, and description lists.
1640 @itemize @bullet
1641 @item
1642 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1643 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1644 they will be seen as top-level headlines.  Also, when you are hiding leading
1645 stars to get a clean outline view, plain list items starting with a star may
1646 be hard to distinguish from true headlines.  In short: even though @samp{*}
1647 is supported, it may be better to not use it for plain list items.}  as
1648 bullets.
1649 @item
1650 @vindex org-plain-list-ordered-item-terminator
1651 @vindex org-list-allow-alphabetical
1652 @emph{Ordered} list items start with a numeral followed by either a period or
1653 a right parenthesis@footnote{You can filter out any of them by configuring
1654 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1655 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1656 @samp{A)} by configuring @code{org-list-allow-alphabetical}.  To minimize
1657 confusion with normal text, those are limited to one character only.  Beyond
1658 that limit, bullets will automatically fallback to numbers.}.  If you want a
1659 list to start with a different value (e.g., 20), start the text of the item
1660 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1661 must be put @emph{before} the checkbox.  If you have activated alphabetical
1662 lists, you can also use counters like @code{[@@b]}.}.  Those constructs can
1663 be used in any item of the list in order to enforce a particular numbering.
1664 @item
1665 @emph{Description} list items are unordered list items, and contain the
1666 separator @samp{ :: } to distinguish the description @emph{term} from the
1667 description.
1668 @end itemize
1670 Items belonging to the same list must have the same indentation on the first
1671 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1672 2--digit numbers must be written left-aligned with the other numbers in the
1673 list.  An item ends before the next line that is less or equally indented
1674 than its bullet/number.
1676 @vindex org-list-empty-line-terminates-plain-lists
1677 A list ends whenever every item has ended, which means before any line less
1678 or equally indented than items at top level.  It also ends before two blank
1679 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1680 In that case, all items are closed.  Here is an example:
1682 @example
1683 @group
1684 ** Lord of the Rings
1685    My favorite scenes are (in this order)
1686    1. The attack of the Rohirrim
1687    2. Eowyn's fight with the witch king
1688       + this was already my favorite scene in the book
1689       + I really like Miranda Otto.
1690    3. Peter Jackson being shot by Legolas
1691       - on DVD only
1692       He makes a really funny face when it happens.
1693    But in the end, no individual scenes matter but the film as a whole.
1694    Important actors in this film are:
1695    - @b{Elijah Wood} :: He plays Frodo
1696    - @b{Sean Austin} :: He plays Sam, Frodo's friend.  I still remember
1697      him very well from his role as Mikey Walsh in @i{The Goonies}.
1698 @end group
1699 @end example
1701 Org supports these lists by tuning filling and wrapping commands to deal with
1702 them correctly@footnote{Org only changes the filling settings for Emacs.  For
1703 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}.  To turn this on,
1704 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1705 properly (@pxref{Exporting}).  Since indentation is what governs the
1706 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1707 blocks can be indented to signal that they belong to a particular item.
1709 @vindex org-list-demote-modify-bullet
1710 @vindex org-list-indent-offset
1711 If you find that using a different bullet for a sub-list (than that used for
1712 the current list-level) improves readability, customize the variable
1713 @code{org-list-demote-modify-bullet}.  To get a greater difference of
1714 indentation between items and their sub-items, customize
1715 @code{org-list-indent-offset}.
1717 @vindex org-list-automatic-rules
1718 The following commands act on items when the cursor is in the first line of
1719 an item (the line with the bullet or number).  Some of them imply the
1720 application of automatic rules to keep list structure intact.  If some of
1721 these actions get in your way, configure @code{org-list-automatic-rules}
1722 to disable them individually.
1724 @table @asis
1725 @orgcmd{@key{TAB},org-cycle}
1726 @cindex cycling, in plain lists
1727 @vindex org-cycle-include-plain-lists
1728 Items can be folded just like headline levels.  Normally this works only if
1729 the cursor is on a plain list item.  For more details, see the variable
1730 @code{org-cycle-include-plain-lists}.  If this variable is set to
1731 @code{integrate}, plain list items will be treated like low-level
1732 headlines.  The level of an item is then given by the indentation of the
1733 bullet/number.  Items are always subordinate to real headlines, however; the
1734 hierarchies remain completely separated.  In a new item with no text yet, the
1735 first @key{TAB} demotes the item to become a child of the previous
1736 one.  Subsequent @key{TAB}s move the item to meaningful levels in the list
1737 and eventually get it back to its initial position.
1738 @orgcmd{M-@key{RET},org-insert-heading}
1739 @vindex org-M-RET-may-split-line
1740 @vindex org-list-automatic-rules
1741 Insert new item at current level.  With a prefix argument, force a new
1742 heading (@pxref{Structure editing}).  If this command is used in the middle
1743 of an item, that item is @emph{split} in two, and the second part becomes the
1744 new item@footnote{If you do not want the item to be split, customize the
1745 variable @code{org-M-RET-may-split-line}.}.  If this command is executed
1746 @emph{before item's body}, the new item is created @emph{before} the current
1747 one.
1748 @end table
1750 @table @kbd
1751 @kindex M-S-@key{RET}
1752 @item M-S-@key{RET}
1753 Insert a new item with a checkbox (@pxref{Checkboxes}).
1754 @kindex S-@key{down}
1755 @item S-up
1756 @itemx S-down
1757 @cindex shift-selection-mode
1758 @vindex org-support-shift-select
1759 @vindex org-list-use-circular-motion
1760 Jump to the previous/next item in the current list@footnote{If you want to
1761 cycle around items that way, you may customize
1762 @code{org-list-use-circular-motion}.}, but only if
1763 @code{org-support-shift-select} is off.  If not, you can still use paragraph
1764 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1765 similar effect.
1766 @kindex M-@key{up}
1767 @kindex M-@key{down}
1768 @item M-up
1769 @itemx M-down
1770 Move the item including subitems up/down@footnote{See
1771 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1772 previous/next item of same indentation).  If the list is ordered, renumbering
1773 is automatic.
1774 @kindex M-@key{left}
1775 @kindex M-@key{right}
1776 @item M-left
1777 @itemx M-right
1778 Decrease/increase the indentation of an item, leaving children alone.
1779 @kindex M-S-@key{left}
1780 @kindex M-S-@key{right}
1781 @item M-S-@key{left}
1782 @itemx M-S-@key{right}
1783 Decrease/increase the indentation of the item, including subitems.
1784 Initially, the item tree is selected based on current indentation.  When
1785 these commands are executed several times in direct succession, the initially
1786 selected region is used, even if the new indentation would imply a different
1787 hierarchy.  To use the new hierarchy, break the command chain with a cursor
1788 motion or so.
1790 As a special case, using this command on the very first item of a list will
1791 move the whole list.  This behavior can be disabled by configuring
1792 @code{org-list-automatic-rules}.  The global indentation of a list has no
1793 influence on the text @emph{after} the list.
1794 @kindex C-c C-c
1795 @item C-c C-c
1796 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1797 state of the checkbox.  In any case, verify bullets and indentation
1798 consistency in the whole list.
1799 @kindex C-c -
1800 @vindex org-plain-list-ordered-item-terminator
1801 @item C-c -
1802 Cycle the entire list level through the different itemize/enumerate bullets
1803 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1804 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1805 and its indentation.  With a numeric prefix argument N, select the Nth bullet
1806 from this list.  If there is an active region when calling this, selected
1807 text will be changed into an item.  With a prefix argument, all lines will be
1808 converted to list items.  If the first line already was a list item, any item
1809 marker will be removed from the list.  Finally, even without an active
1810 region, a normal line will be converted into a list item.
1811 @kindex C-c *
1812 @item C-c *
1813 Turn a plain list item into a headline (so that it becomes a subheading at
1814 its location).  @xref{Structure editing}, for a detailed explanation.
1815 @kindex C-c C-*
1816 @item C-c C-*
1817 Turn the whole plain list into a subtree of the current heading.  Checkboxes
1818 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1819 (resp. checked).
1820 @kindex S-@key{left}
1821 @kindex S-@key{right}
1822 @item S-left/right
1823 @vindex org-support-shift-select
1824 This command also cycles bullet styles when the cursor in on the bullet or
1825 anywhere in an item line, details depending on
1826 @code{org-support-shift-select}.
1827 @kindex C-c ^
1828 @cindex sorting, of plain list
1829 @item C-c ^
1830 Sort the plain list.  You will be prompted for the sorting method:
1831 numerically, alphabetically, by time, by checked status for check lists,
1832 or by a custom function.
1833 @end table
1835 @node Drawers
1836 @section Drawers
1837 @cindex drawers
1838 @cindex visibility cycling, drawers
1840 @cindex org-insert-drawer
1841 @kindex C-c C-x d
1842 Sometimes you want to keep information associated with an entry, but you
1843 normally don't want to see it.  For this, Org mode has @emph{drawers}.  They
1844 can contain anything but a headline and another drawer.  Drawers look like
1845 this:
1847 @example
1848 ** This is a headline
1849    Still outside the drawer
1850    :DRAWERNAME:
1851    This is inside the drawer.
1852    :END:
1853    After the drawer.
1854 @end example
1856 You can interactively insert drawers at point by calling
1857 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}.  With an active
1858 region, this command will put the region inside the drawer.  With a prefix
1859 argument, this command calls @code{org-insert-property-drawer} and add a
1860 property drawer right below the current headline.  Completion over drawer
1861 keywords is also possible using @key{M-TAB}.
1863 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1864 show the entry, but keep the drawer collapsed to a single line.  In order to
1865 look inside the drawer, you need to move the cursor to the drawer line and
1866 press @key{TAB} there.  Org mode uses the @code{PROPERTIES} drawer for
1867 storing properties (@pxref{Properties and columns}), and you can also arrange
1868 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1869 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.  If you
1870 want to store a quick note in the LOGBOOK drawer, in a similar way to state
1871 changes, use
1873 @table @kbd
1874 @kindex C-c C-z
1875 @item C-c C-z
1876 Add a time-stamped note to the LOGBOOK drawer.
1877 @end table
1879 @vindex org-export-with-drawers
1880 @vindex org-export-with-properties
1881 You can select the name of the drawers which should be exported with
1882 @code{org-export-with-drawers}.  In that case, drawer contents will appear in
1883 export output.  Property drawers are not affected by this variable: configure
1884 @code{org-export-with-properties} instead.
1886 @node Blocks
1887 @section Blocks
1889 @vindex org-hide-block-startup
1890 @cindex blocks, folding
1891 Org mode uses begin...end blocks for various purposes from including source
1892 code examples (@pxref{Literal examples}) to capturing time logging
1893 information (@pxref{Clocking work time}).  These blocks can be folded and
1894 unfolded by pressing TAB in the begin line.  You can also get all blocks
1895 folded at startup by configuring the option @code{org-hide-block-startup}
1896 or on a per-file basis by using
1898 @cindex @code{hideblocks}, STARTUP keyword
1899 @cindex @code{nohideblocks}, STARTUP keyword
1900 @example
1901 #+STARTUP: hideblocks
1902 #+STARTUP: nohideblocks
1903 @end example
1905 @node Footnotes
1906 @section Footnotes
1907 @cindex footnotes
1909 Org mode supports the creation of footnotes.  In contrast to the
1910 @file{footnote.el} package, Org mode's footnotes are designed for work on
1911 a larger document, not only for one-off documents like emails.
1913 A footnote is started by a footnote marker in square brackets in column 0, no
1914 indentation allowed.  It ends at the next footnote definition, headline, or
1915 after two consecutive empty lines.  The footnote reference is simply the
1916 marker in square brackets, inside text.  For example:
1918 @example
1919 The Org homepage[fn:1] now looks a lot better than it used to.
1921 [fn:1] The link is: http://orgmode.org
1922 @end example
1924 Org mode extends the number-based syntax to @emph{named} footnotes and
1925 optional inline definition.  Using plain numbers as markers (as
1926 @file{footnote.el} does) is supported for backward compatibility, but not
1927 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1928 @LaTeX{}}).  Here are the valid references:
1930 @table @code
1931 @item [1]
1932 A plain numeric footnote marker.  Compatible with @file{footnote.el}, but not
1933 recommended because something like @samp{[1]} could easily be part of a code
1934 snippet.
1935 @item [fn:name]
1936 A named footnote reference, where @code{name} is a unique label word, or, for
1937 simplicity of automatic creation, a number.
1938 @item [fn:: This is the inline definition of this footnote]
1939 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1940 reference point.
1941 @item [fn:name: a definition]
1942 An inline definition of a footnote, which also specifies a name for the note.
1943 Since Org allows multiple references to the same note, you can then use
1944 @code{[fn:name]} to create additional references.
1945 @end table
1947 @vindex org-footnote-auto-label
1948 Footnote labels can be created automatically, or you can create names yourself.
1949 This is handled by the variable @code{org-footnote-auto-label} and its
1950 corresponding @code{#+STARTUP} keywords.  See the docstring of that variable
1951 for details.
1953 @noindent The following command handles footnotes:
1955 @table @kbd
1956 @kindex C-c C-x f
1957 @item C-c C-x f
1958 The footnote action command.
1960 When the cursor is on a footnote reference, jump to the definition.  When it
1961 is at a definition, jump to the (first) reference.
1963 @vindex org-footnote-define-inline
1964 @vindex org-footnote-section
1965 @vindex org-footnote-auto-adjust
1966 Otherwise, create a new footnote.  Depending on the option
1967 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1968 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1969 definition will be placed right into the text as part of the reference, or
1970 separately into the location determined by the option
1971 @code{org-footnote-section}.
1973 When this command is called with a prefix argument, a menu of additional
1974 options is offered:
1975 @example
1976 s   @r{Sort the footnote definitions by reference sequence.  During editing,}
1977     @r{Org makes no effort to sort footnote definitions into a particular}
1978     @r{sequence.  If you want them sorted, use this command, which will}
1979     @r{also move entries according to @code{org-footnote-section}.  Automatic}
1980     @r{sorting after each insertion/deletion can be configured using the}
1981     @r{option @code{org-footnote-auto-adjust}.}
1982 r   @r{Renumber the simple @code{fn:N} footnotes.  Automatic renumbering}
1983     @r{after each insertion/deletion can be configured using the option}
1984     @r{@code{org-footnote-auto-adjust}.}
1985 S   @r{Short for first @code{r}, then @code{s} action.}
1986 n   @r{Normalize the footnotes by collecting all definitions (including}
1987     @r{inline definitions) into a special section, and then numbering them}
1988     @r{in sequence.  The references will then also be numbers.  This is}
1989     @r{meant to be the final step before finishing a document (e.g., sending}
1990     @r{off an email).}
1991 d   @r{Delete the footnote at point, and all definitions of and references}
1992     @r{to it.}
1993 @end example
1994 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1995 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1996 renumbering and sorting footnotes can be automatic after each insertion or
1997 deletion.
1999 @kindex C-c C-c
2000 @item C-c C-c
2001 If the cursor is on a footnote reference, jump to the definition.  If it is a
2002 the definition, jump back to the reference.  When called at a footnote
2003 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
2004 @kindex C-c C-o
2005 @kindex mouse-1
2006 @kindex mouse-2
2007 @item C-c C-o  @r{or} mouse-1/2
2008 Footnote labels are also links to the corresponding definition/reference, and
2009 you can use the usual commands to follow these links.
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 hierarchy::               Create a hierarchy of 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 hierarchy
5120 @section Tag hierarchy
5122 @cindex group tags
5123 @cindex tags, groups
5124 @cindex tag hierarchy
5125 Tags can be defined in hierarchies.  A tag can be defined as a @emph{group
5126 tag} for a set of other tags.  The group tag can be seen as the ``broader
5127 term'' for its set of tags.  Defining multiple @emph{group tags} and nesting
5128 them creates a tag hierarchy.
5130 One use-case is to create a taxonomy of terms (tags) that can be used to
5131 classify nodes in a document or set of documents.
5133 When you search for a group tag, it will return matches for all members in
5134 the group and its subgroup.  In an agenda view, filtering by a group tag will
5135 display or hide headlines tagged with at least one of the members of the
5136 group or any of its subgroups.  This makes tag searches and filters even more
5137 flexible.
5139 You can set group tags by using brackets and inserting a colon between the
5140 group tag and its related tags---beware that all whitespaces are mandatory so
5141 that Org can parse this line correctly:
5143 @example
5144 #+TAGS: [ GTD : Control Persp ]
5145 @end example
5147 In this example, @samp{GTD} is the @emph{group tag} and it is related to two
5148 other tags: @samp{Control}, @samp{Persp}.  Defining @samp{Control} and
5149 @samp{Persp} as group tags creates an hierarchy of tags:
5151 @example
5152 #+TAGS: [ Control : Context Task ]
5153 #+TAGS: [ Persp : Vision Goal AOF Project ]
5154 @end example
5156 That can conceptually be seen as a hierarchy of tags:
5158 @example
5159 - GTD
5160   - Persp
5161     - Vision
5162     - Goal
5163     - AOF
5164     - Project
5165   - Control
5166     - Context
5167     - Task
5168 @end example
5170 You can use the @code{:startgrouptag}, @code{:grouptags} and
5171 @code{:endgrouptag} keyword directly when setting @code{org-tag-alist}
5172 directly:
5174 @lisp
5175 (setq org-tag-alist '((:startgrouptag)
5176                       ("GTD")
5177                       (:grouptags)
5178                       ("Control")
5179                       ("Persp")
5180                       (:endgrouptag)
5181                       (:startgrouptag)
5182                       ("Control")
5183                       (:grouptags)
5184                       ("Context")
5185                       ("Task")
5186                       (:endgrouptag)))
5187 @end lisp
5189 The tags in a group can be mutually exclusive if using the same group syntax
5190 as is used for grouping mutually exclusive tags together; using curly
5191 brackets.
5193 @example
5194 #+TAGS: @{ Context : @@Home @@Work @@Call @}
5195 @end example
5197 When setting @code{org-tag-alist} you can use @code{:startgroup} &
5198 @code{:endgroup} instead of @code{:startgrouptag} & @code{:endgrouptag} to
5199 make the tags mutually exclusive.
5201 Furthermore; The members of a @emph{group tag} can also be regular
5202 expression, creating the possibility of more dynamic and rule-based
5203 tag-structure.  The regular expressions in the group must be marked up within
5204 @{ @}.  Example use, to expand on the example given above:
5206 @example
5207 #+TAGS: [ Vision : @{V@.+@} ]
5208 #+TAGS: [ Goal : @{G@.+@} ]
5209 #+TAGS: [ AOF : @{AOF@.+@} ]
5210 #+TAGS: [ Project : @{P@.+@} ]
5211 @end example
5213 Searching for the tag @samp{Project} will now list all tags also including
5214 regular expression matches for @samp{P@@.+}.  Similar for tag-searches on
5215 @samp{Vision}, @samp{Goal} and @samp{AOF}.  This can be good for example if
5216 tags for a certain project is tagged with a common project-identifier,
5217 i.e. @samp{P@@2014_OrgTags}.
5219 @kindex C-c C-x q
5220 @vindex org-group-tags
5221 If you want to ignore group tags temporarily, toggle group tags support
5222 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}.  If you
5223 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5225 @node Tag searches
5226 @section Tag searches
5227 @cindex tag searches
5228 @cindex searching for tags
5230 Once a system of tags has been set up, it can be used to collect related
5231 information into special lists.
5233 @table @kbd
5234 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5235 Create a sparse tree with all headlines matching a tags/property/TODO search.
5236 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5237 @xref{Matching tags and properties}.
5238 @orgcmd{C-c a m,org-tags-view}
5239 Create a global list of tag matches from all agenda files.  @xref{Matching
5240 tags and properties}.
5241 @orgcmd{C-c a M,org-tags-view}
5242 @vindex org-tags-match-list-sublevels
5243 Create a global list of tag matches from all agenda files, but check
5244 only TODO items and force checking subitems (see the option
5245 @code{org-tags-match-list-sublevels}).
5246 @end table
5248 These commands all prompt for a match string which allows basic Boolean logic
5249 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5250 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5251 which are tagged, like @samp{Kathy} or @samp{Sally}.  The full syntax of the search
5252 string is rich and allows also matching against TODO keywords, entry levels
5253 and properties.  For a complete description with many examples, see
5254 @ref{Matching tags and properties}.
5257 @node Properties and columns
5258 @chapter Properties and columns
5259 @cindex properties
5261 A property is a key-value pair associated with an entry.  Properties can be
5262 set so they are associated with a single entry, with every entry in a tree,
5263 or with every entry in an Org mode file.
5265 There are two main applications for properties in Org mode.  First,
5266 properties are like tags, but with a value.  Imagine maintaining a file where
5267 you document bugs and plan releases for a piece of software.  Instead of
5268 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5269 property, say @code{:Release:}, that in different subtrees has different
5270 values, such as @code{1.0} or @code{2.0}.  Second, you can use properties to
5271 implement (very basic) database capabilities in an Org buffer.  Imagine
5272 keeping track of your music CDs, where properties could be things such as the
5273 album, artist, date of release, number of tracks, and so on.
5275 Properties can be conveniently edited and viewed in column view
5276 (@pxref{Column view}).
5278 @menu
5279 * Property syntax::             How properties are spelled out
5280 * Special properties::          Access to other Org mode features
5281 * Property searches::           Matching property values
5282 * Property inheritance::        Passing values down the tree
5283 * Column view::                 Tabular viewing and editing
5284 * Property API::                Properties for Lisp programmers
5285 @end menu
5287 @node Property syntax
5288 @section Property syntax
5289 @cindex property syntax
5290 @cindex drawer, for properties
5292 Properties are key-value pairs.  When they are associated with a single entry
5293 or with a tree they need to be inserted into a special drawer
5294 (@pxref{Drawers}) with the name @code{PROPERTIES}, which has to be located
5295 right below a headline, and its planning line (@pxref{Deadlines and
5296 scheduling}) when applicable.  Each property is specified on a single line,
5297 with the key (surrounded by colons) first, and the value after it.  Keys are
5298 case-insensitives.  Here is an example:
5300 @example
5301 * CD collection
5302 ** Classic
5303 *** Goldberg Variations
5304     :PROPERTIES:
5305     :Title:     Goldberg Variations
5306     :Composer:  J.S. Bach
5307     :Artist:    Glen Gould
5308     :Publisher: Deutsche Grammophon
5309     :NDisks:    1
5310     :END:
5311 @end example
5313 Depending on the value of @code{org-use-property-inheritance}, a property set
5314 this way will either be associated with a single entry, or the subtree
5315 defined by the entry, see @ref{Property inheritance}.
5317 You may define the allowed values for a particular property @samp{:Xyz:}
5318 by setting a property @samp{:Xyz_ALL:}.  This special property is
5319 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5320 the entire tree.  When allowed values are defined, setting the
5321 corresponding property becomes easier and is less prone to typing
5322 errors.  For the example with the CD collection, we can predefine
5323 publishers and the number of disks in a box like this:
5325 @example
5326 * CD collection
5327   :PROPERTIES:
5328   :NDisks_ALL:  1 2 3 4
5329   :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5330   :END:
5331 @end example
5333 If you want to set properties that can be inherited by any entry in a
5334 file, use a line like
5335 @cindex property, _ALL
5336 @cindex #+PROPERTY
5337 @example
5338 #+PROPERTY: NDisks_ALL 1 2 3 4
5339 @end example
5341 Contrary to properties set from a special drawer, you have to refresh the
5342 buffer with @kbd{C-c C-c} to activate this change.
5344 If you want to add to the value of an existing property, append a @code{+} to
5345 the property name.  The following results in the property @code{var} having
5346 the value ``foo=1 bar=2''.
5347 @cindex property, +
5348 @example
5349 #+PROPERTY: var  foo=1
5350 #+PROPERTY: var+ bar=2
5351 @end example
5353 It is also possible to add to the values of inherited properties.  The
5354 following results in the @code{genres} property having the value ``Classic
5355 Baroque'' under the @code{Goldberg Variations} subtree.
5356 @cindex property, +
5357 @example
5358 * CD collection
5359 ** Classic
5360     :PROPERTIES:
5361     :GENRES: Classic
5362     :END:
5363 *** Goldberg Variations
5364     :PROPERTIES:
5365     :Title:     Goldberg Variations
5366     :Composer:  J.S. Bach
5367     :Artist:    Glen Gould
5368     :Publisher: Deutsche Grammophon
5369     :NDisks:    1
5370     :GENRES+:   Baroque
5371     :END:
5372 @end example
5373 Note that a property can only have one entry per Drawer.
5375 @vindex org-global-properties
5376 Property values set with the global variable
5377 @code{org-global-properties} can be inherited by all entries in all
5378 Org files.
5380 @noindent
5381 The following commands help to work with properties:
5383 @table @kbd
5384 @orgcmd{M-@key{TAB},pcomplete}
5385 After an initial colon in a line, complete property keys.  All keys used
5386 in the current file will be offered as possible completions.
5387 @orgcmd{C-c C-x p,org-set-property}
5388 Set a property.  This prompts for a property name and a value.  If
5389 necessary, the property drawer is created as well.
5390 @item C-u M-x org-insert-drawer RET
5391 @cindex org-insert-drawer
5392 Insert a property drawer into the current entry.  The drawer will be
5393 inserted early in the entry, but after the lines with planning
5394 information like deadlines.
5395 @orgcmd{C-c C-c,org-property-action}
5396 With the cursor in a property drawer, this executes property commands.
5397 @orgcmd{C-c C-c s,org-set-property}
5398 Set a property in the current entry.  Both the property and the value
5399 can be inserted using completion.
5400 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5401 Switch property at point to the next/previous allowed value.
5402 @orgcmd{C-c C-c d,org-delete-property}
5403 Remove a property from the current entry.
5404 @orgcmd{C-c C-c D,org-delete-property-globally}
5405 Globally remove a property, from all entries in the current file.
5406 @orgcmd{C-c C-c c,org-compute-property-at-point}
5407 Compute the property at point, using the operator and scope from the
5408 nearest column format definition.
5409 @end table
5411 @node Special properties
5412 @section Special properties
5413 @cindex properties, special
5415 Special properties provide an alternative access method to Org mode features,
5416 like the TODO state or the priority of an entry, discussed in the previous
5417 chapters.  This interface exists so that you can include these states in
5418 a column view (@pxref{Column view}), or to use them in queries.  The
5419 following property names are special and should not be used as keys in the
5420 properties drawer:
5422 @cindex property, special, ALLTAGS
5423 @cindex property, special, BLOCKED
5424 @cindex property, special, CLOCKSUM
5425 @cindex property, special, CLOCKSUM_T
5426 @cindex property, special, CLOSED
5427 @cindex property, special, DEADLINE
5428 @cindex property, special, FILE
5429 @cindex property, special, ITEM
5430 @cindex property, special, PRIORITY
5431 @cindex property, special, SCHEDULED
5432 @cindex property, special, TAGS
5433 @cindex property, special, TIMESTAMP
5434 @cindex property, special, TIMESTAMP_IA
5435 @cindex property, special, TODO
5436 @example
5437 ALLTAGS      @r{All tags, including inherited ones.}
5438 BLOCKED      @r{"t" if task is currently blocked by children or siblings.}
5439 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
5440              @r{must be run first to compute the values in the current buffer.}
5441 CLOCKSUM_T   @r{The sum of CLOCK intervals in the subtree for today.}
5442              @r{@code{org-clock-sum-today} must be run first to compute the}
5443              @r{values in the current buffer.}
5444 CLOSED       @r{When was this entry closed?}
5445 DEADLINE     @r{The deadline time string, without the angular brackets.}
5446 FILE         @r{The filename the entry is located in.}
5447 ITEM         @r{The headline of the entry, with stars.}
5448 PRIORITY     @r{The priority of the entry, a string with a single letter.}
5449 SCHEDULED    @r{The scheduling timestamp, without the angular brackets.}
5450 TAGS         @r{The tags defined directly in the headline.}
5451 TIMESTAMP    @r{The first keyword-less timestamp in the entry.}
5452 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5453 TODO         @r{The TODO keyword of the entry.}
5454 @end example
5456 @node Property searches
5457 @section Property searches
5458 @cindex properties, searching
5459 @cindex searching, of properties
5461 To create sparse trees and special lists with selection based on properties,
5462 the same commands are used as for tag searches (@pxref{Tag searches}).
5464 @table @kbd
5465 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5466 Create a sparse tree with all matching entries.  With a
5467 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5468 @orgcmd{C-c a m,org-tags-view}
5469 Create a global list of tag/property  matches from all agenda files.
5470 @xref{Matching tags and properties}.
5471 @orgcmd{C-c a M,org-tags-view}
5472 @vindex org-tags-match-list-sublevels
5473 Create a global list of tag matches from all agenda files, but check
5474 only TODO items and force checking of subitems (see the option
5475 @code{org-tags-match-list-sublevels}).
5476 @end table
5478 The syntax for the search string is described in @ref{Matching tags and
5479 properties}.
5481 There is also a special command for creating sparse trees based on a
5482 single property:
5484 @table @kbd
5485 @orgkey{C-c / p}
5486 Create a sparse tree based on the value of a property.  This first
5487 prompts for the name of a property, and then for a value.  A sparse tree
5488 is created with all entries that define this property with the given
5489 value.  If you enclose the value in curly braces, it is interpreted as
5490 a regular expression and matched against the property values.
5491 @end table
5493 @node Property inheritance
5494 @section Property Inheritance
5495 @cindex properties, inheritance
5496 @cindex inheritance, of properties
5498 @vindex org-use-property-inheritance
5499 The outline structure of Org mode documents lends itself to an
5500 inheritance model of properties: if the parent in a tree has a certain
5501 property, the children can inherit this property.  Org mode does not
5502 turn this on by default, because it can slow down property searches
5503 significantly and is often not needed.  However, if you find inheritance
5504 useful, you can turn it on by setting the variable
5505 @code{org-use-property-inheritance}.  It may be set to @code{t} to make
5506 all properties inherited from the parent, to a list of properties
5507 that should be inherited, or to a regular expression that matches
5508 inherited properties.  If a property has the value @code{nil}, this is
5509 interpreted as an explicit undefine of the property, so that inheritance
5510 search will stop at this value and return @code{nil}.
5512 Org mode has a few properties for which inheritance is hard-coded, at
5513 least for the special applications for which they are used:
5515 @cindex property, COLUMNS
5516 @table @code
5517 @item COLUMNS
5518 The @code{:COLUMNS:} property defines the format of column view
5519 (@pxref{Column view}).  It is inherited in the sense that the level
5520 where a @code{:COLUMNS:} property is defined is used as the starting
5521 point for a column view table, independently of the location in the
5522 subtree from where columns view is turned on.
5523 @item CATEGORY
5524 @cindex property, CATEGORY
5525 For agenda view, a category set through a @code{:CATEGORY:} property
5526 applies to the entire subtree.
5527 @item ARCHIVE
5528 @cindex property, ARCHIVE
5529 For archiving, the @code{:ARCHIVE:} property may define the archive
5530 location for the entire subtree (@pxref{Moving subtrees}).
5531 @item LOGGING
5532 @cindex property, LOGGING
5533 The LOGGING property may define logging settings for an entry or a
5534 subtree (@pxref{Tracking TODO state changes}).
5535 @end table
5537 @node Column view
5538 @section Column view
5540 A great way to view and edit properties in an outline tree is
5541 @emph{column view}.  In column view, each outline node is turned into a
5542 table row.  Columns in this table provide access to properties of the
5543 entries.  Org mode implements columns by overlaying a tabular structure
5544 over the headline of each item.  While the headlines have been turned
5545 into a table row, you can still change the visibility of the outline
5546 tree.  For example, you get a compact table by switching to CONTENTS
5547 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5548 is active), but you can still open, read, and edit the entry below each
5549 headline.  Or, you can switch to column view after executing a sparse
5550 tree command and in this way get a table only for the selected items.
5551 Column view also works in agenda buffers (@pxref{Agenda views}) where
5552 queries have collected selected items, possibly from a number of files.
5554 @menu
5555 * Defining columns::            The COLUMNS format property
5556 * Using column view::           How to create and use column view
5557 * Capturing column view::       A dynamic block for column view
5558 @end menu
5560 @node Defining columns
5561 @subsection Defining columns
5562 @cindex column view, for properties
5563 @cindex properties, column view
5565 Setting up a column view first requires defining the columns.  This is
5566 done by defining a column format line.
5568 @menu
5569 * Scope of column definitions::  Where defined, where valid?
5570 * Column attributes::           Appearance and content of a column
5571 @end menu
5573 @node Scope of column definitions
5574 @subsubsection Scope of column definitions
5576 To define a column format for an entire file, use a line like
5578 @cindex #+COLUMNS
5579 @example
5580 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5581 @end example
5583 To specify a format that only applies to a specific tree, add a
5584 @code{:COLUMNS:} property to the top node of that tree, for example:
5586 @example
5587 ** Top node for columns view
5588    :PROPERTIES:
5589    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5590    :END:
5591 @end example
5593 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5594 for the entry itself, and for the entire subtree below it.  Since the
5595 column definition is part of the hierarchical structure of the document,
5596 you can define columns on level 1 that are general enough for all
5597 sublevels, and more specific columns further down, when you edit a
5598 deeper part of the tree.
5600 @node Column attributes
5601 @subsubsection Column attributes
5602 A column definition sets the attributes of a column.  The general
5603 definition looks like this:
5605 @example
5606  %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5607 @end example
5609 @noindent
5610 Except for the percent sign and the property name, all items are
5611 optional.  The individual parts have the following meaning:
5613 @example
5614 @var{width}           @r{An integer specifying the width of the column in characters.}
5615                 @r{If omitted, the width will be determined automatically.}
5616 @var{property}        @r{The property that should be edited in this column.}
5617                 @r{Special properties representing meta data are allowed here}
5618                 @r{as well (@pxref{Special properties})}
5619 @var{title}           @r{The header text for the column.  If omitted, the property}
5620                 @r{name is used.}
5621 @{@var{summary-type}@}  @r{The summary type.  If specified, the column values for}
5622                 @r{parent nodes are computed from the children.}
5623                 @r{Supported summary types are:}
5624                 @{+@}       @r{Sum numbers in this column.}
5625                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
5626                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
5627                 @{:@}       @r{Sum times, HH:MM, plain numbers are hours.}
5628                 @{X@}       @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5629                 @{X/@}      @r{Checkbox status, @samp{[n/m]}.}
5630                 @{X%@}      @r{Checkbox status, @samp{[n%]}.}
5631                 @{min@}     @r{Smallest number in column.}
5632                 @{max@}     @r{Largest number.}
5633                 @{mean@}    @r{Arithmetic mean of numbers.}
5634                 @{:min@}    @r{Smallest time value in column.}
5635                 @{:max@}    @r{Largest time value.}
5636                 @{:mean@}   @r{Arithmetic mean of time values.}
5637                 @{@@min@}    @r{Minimum age (in days/hours/mins/seconds).}
5638                 @{@@max@}    @r{Maximum age (in days/hours/mins/seconds).}
5639                 @{@@mean@}   @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5640                 @{est+@}    @r{Add @samp{low-high} estimates.}
5641 @end example
5643 @noindent
5644 Be aware that you can only have one summary type for any property you
5645 include.  Subsequent columns referencing the same property will all display the
5646 same summary information.
5648 The @code{est+} summary type requires further explanation.  It is used for
5649 combining estimates, expressed as @samp{low-high} ranges or plain numbers.
5650 For example, instead of estimating a particular task will take 5 days, you
5651 might estimate it as 5--6 days if you're fairly confident you know how much
5652 work is required, or 1--10 days if you don't really know what needs to be
5653 done.  Both ranges average at 5.5 days, but the first represents a more
5654 predictable delivery.
5656 When combining a set of such estimates, simply adding the lows and highs
5657 produces an unrealistically wide result.  Instead, @code{est+} adds the
5658 statistical mean and variance of the sub-tasks, generating a final estimate
5659 from the sum.  For example, suppose you had ten tasks, each of which was
5660 estimated at 0.5 to 2 days of work.  Straight addition produces an estimate
5661 of 5 to 20 days, representing what to expect if everything goes either
5662 extremely well or extremely poorly.  In contrast, @code{est+} estimates the
5663 full job more realistically, at 10--15 days.
5665 Numbers are right-aligned when a format specifier with an explicit width like
5666 @code{%5d} or @code{%5.1f} is used.
5668 Here is an example for a complete columns definition, along with allowed
5669 values.
5671 @example
5672 :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.}
5673                    %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5674 :Owner_ALL:    Tammy Mark Karl Lisa Don
5675 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
5676 :Approved_ALL: "[ ]" "[X]"
5677 @end example
5679 @noindent
5680 The first column, @samp{%25ITEM}, means the first 25 characters of the
5681 item itself, i.e., of the headline.  You probably always should start the
5682 column definition with the @samp{ITEM} specifier.  The other specifiers
5683 create columns @samp{Owner} with a list of names as allowed values, for
5684 @samp{Status} with four different possible values, and for a checkbox
5685 field @samp{Approved}.  When no width is given after the @samp{%}
5686 character, the column will be exactly as wide as it needs to be in order
5687 to fully display all values.  The @samp{Approved} column does have a
5688 modified title (@samp{Approved?}, with a question mark).  Summaries will
5689 be created for the @samp{Time_Estimate} column by adding time duration
5690 expressions like HH:MM, and for the @samp{Approved} column, by providing
5691 an @samp{[X]} status if all children have been checked.  The
5692 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5693 sums of CLOCK intervals in the subtree, either for all clocks or just for
5694 today.
5696 @node Using column view
5697 @subsection Using column view
5699 @table @kbd
5700 @tsubheading{Turning column view on and off}
5701 @orgcmd{C-c C-x C-c,org-columns}
5702 @vindex org-columns-default-format
5703 Turn on column view.  If the cursor is before the first headline in the file,
5704 column view is turned on for the entire file, using the @code{#+COLUMNS}
5705 definition.  If the cursor is somewhere inside the outline, this command
5706 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5707 defines a format.  When one is found, the column view table is established
5708 for the tree starting at the entry that contains the @code{:COLUMNS:}
5709 property.  If no such property is found, the format is taken from the
5710 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5711 and column view is established for the current entry and its subtree.
5712 @orgcmd{r,org-columns-redo}
5713 Recreate the column view, to include recent changes made in the buffer.
5714 @orgcmd{g,org-columns-redo}
5715 Same as @kbd{r}.
5716 @orgcmd{q,org-columns-quit}
5717 Exit column view.
5718 @tsubheading{Editing values}
5719 @item @key{left} @key{right} @key{up} @key{down}
5720 Move through the column view from field to field.
5721 @kindex S-@key{left}
5722 @kindex S-@key{right}
5723 @item  S-@key{left}/@key{right}
5724 Switch to the next/previous allowed value of the field.  For this, you
5725 have to have specified allowed values for a property.
5726 @item 1..9,0
5727 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5728 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5729 Same as @kbd{S-@key{left}/@key{right}}
5730 @orgcmd{e,org-columns-edit-value}
5731 Edit the property at point.  For the special properties, this will
5732 invoke the same interface that you normally use to change that
5733 property.  For example, when editing a TAGS property, the tag completion
5734 or fast selection interface will pop up.
5735 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5736 When there is a checkbox at point, toggle it.
5737 @orgcmd{v,org-columns-show-value}
5738 View the full value of this property.  This is useful if the width of
5739 the column is smaller than that of the value.
5740 @orgcmd{a,org-columns-edit-allowed}
5741 Edit the list of allowed values for this property.  If the list is found
5742 in the hierarchy, the modified value is stored there.  If no list is
5743 found, the new value is stored in the first entry that is part of the
5744 current column view.
5745 @tsubheading{Modifying the table structure}
5746 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5747 Make the column narrower/wider by one character.
5748 @orgcmd{S-M-@key{right},org-columns-new}
5749 Insert a new column, to the left of the current column.
5750 @orgcmd{S-M-@key{left},org-columns-delete}
5751 Delete the current column.
5752 @end table
5754 @node Capturing column view
5755 @subsection Capturing column view
5757 Since column view is just an overlay over a buffer, it cannot be
5758 exported or printed directly.  If you want to capture a column view, use
5759 a @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
5760 of this block looks like this:
5762 @cindex #+BEGIN, columnview
5763 @example
5764 * The column view
5765 #+BEGIN: columnview :hlines 1 :id "label"
5767 #+END:
5768 @end example
5770 @noindent This dynamic block has the following parameters:
5772 @table @code
5773 @item :id
5774 This is the most important parameter.  Column view is a feature that is
5775 often localized to a certain (sub)tree, and the capture block might be
5776 at a different location in the file.  To identify the tree whose view to
5777 capture, you can use 4 values:
5778 @cindex property, ID
5779 @example
5780 local     @r{use the tree in which the capture block is located}
5781 global    @r{make a global view, including all headings in the file}
5782 "file:@var{path-to-file}"
5783           @r{run column view at the top of this file}
5784 "@var{ID}"      @r{call column view in the tree that has an @code{:ID:}}
5785           @r{property with the value @i{label}.  You can use}
5786           @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5787           @r{the current entry and copy it to the kill-ring.}
5788 @end example
5789 @item :hlines
5790 When @code{t}, insert an hline after every line.  When a number @var{N}, insert
5791 an hline before each headline with level @code{<= @var{N}}.
5792 @item :vlines
5793 When set to @code{t}, force column groups to get vertical lines.
5794 @item :maxlevel
5795 When set to a number, don't capture entries below this level.
5796 @item :skip-empty-rows
5797 When set to @code{t}, skip rows where the only non-empty specifier of the
5798 column view is @code{ITEM}.
5800 @end table
5802 @noindent
5803 The following commands insert or update the dynamic block:
5805 @table @kbd
5806 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5807 Insert a dynamic block capturing a column view.  You will be prompted
5808 for the scope or ID of the view.
5809 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5810 Update dynamic block at point.  The cursor needs to be in the
5811 @code{#+BEGIN} line of the dynamic block.
5812 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5813 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
5814 you have several clock table blocks, column-capturing blocks or other dynamic
5815 blocks in a buffer.
5816 @end table
5818 You can add formulas to the column view table and you may add plotting
5819 instructions in front of the table---these will survive an update of the
5820 block.  If there is a @code{#+TBLFM:} after the table, the table will
5821 actually be recalculated automatically after an update.
5823 An alternative way to capture and process property values into a table is
5824 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5825 package@footnote{Contributed packages are not part of Emacs, but are
5826 distributed with the main distribution of Org (visit
5827 @uref{http://orgmode.org}).}.  It provides a general API to collect
5828 properties from entries in a certain scope, and arbitrary Lisp expressions to
5829 process these values before inserting them into a table or a dynamic block.
5831 @node Property API
5832 @section The Property API
5833 @cindex properties, API
5834 @cindex API, for properties
5836 There is a full API for accessing and changing properties.  This API can
5837 be used by Emacs Lisp programs to work with properties and to implement
5838 features based on them.  For more information see @ref{Using the
5839 property API}.
5841 @node Dates and times
5842 @chapter Dates and times
5843 @cindex dates
5844 @cindex times
5845 @cindex timestamp
5846 @cindex date stamp
5848 To assist project planning, TODO items can be labeled with a date and/or
5849 a time.  The specially formatted string carrying the date and time
5850 information is called a @emph{timestamp} in Org mode.  This may be a
5851 little confusing because timestamp is often used to indicate when
5852 something was created or last changed.  However, in Org mode this term
5853 is used in a much wider sense.
5855 @menu
5856 * Timestamps::                  Assigning a time to a tree entry
5857 * Creating timestamps::         Commands which insert timestamps
5858 * Deadlines and scheduling::    Planning your work
5859 * Clocking work time::          Tracking how long you spend on a task
5860 * Effort estimates::            Planning work effort in advance
5861 * Timers::                      Notes with a running timer
5862 @end menu
5865 @node Timestamps
5866 @section Timestamps, deadlines, and scheduling
5867 @cindex timestamps
5868 @cindex ranges, time
5869 @cindex date stamps
5870 @cindex deadlines
5871 @cindex scheduling
5873 A timestamp is a specification of a date (possibly with a time or a range of
5874 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5875 simplest form, the day name is optional when you type the date yourself.
5876 However, any dates inserted or modified by Org will add that day name, for
5877 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5878 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5879 date/time format.  To use an alternative format, see @ref{Custom time
5880 format}.}.  A timestamp can appear anywhere in the headline or body of an Org
5881 tree entry.  Its presence causes entries to be shown on specific dates in the
5882 agenda (@pxref{Weekly/daily agenda}).  We distinguish:
5884 @table @var
5885 @item Plain timestamp; Event; Appointment
5886 @cindex timestamp
5887 @cindex appointment
5888 A simple timestamp just assigns a date/time to an item.  This is just
5889 like writing down an appointment or event in a paper agenda.  In the
5890 timeline and agenda displays, the headline of an entry associated with a
5891 plain timestamp will be shown exactly on that date.
5893 @example
5894 * Meet Peter at the movies
5895   <2006-11-01 Wed 19:15>
5896 * Discussion on climate change
5897   <2006-11-02 Thu 20:00-22:00>
5898 @end example
5900 @item Timestamp with repeater interval
5901 @cindex timestamp, with repeater interval
5902 A timestamp may contain a @emph{repeater interval}, indicating that it
5903 applies not only on the given date, but again and again after a certain
5904 interval of N days (d), weeks (w), months (m), or years (y).  The
5905 following will show up in the agenda every Wednesday:
5907 @example
5908 * Pick up Sam at school
5909   <2007-05-16 Wed 12:30 +1w>
5910 @end example
5912 @item Diary-style sexp entries
5913 For more complex date specifications, Org mode supports using the special
5914 sexp diary entries implemented in the Emacs calendar/diary
5915 package@footnote{When working with the standard diary sexp functions, you
5916 need to be very careful with the order of the arguments.  That order depends
5917 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5918 versions, @code{european-calendar-style}).  For example, to specify a date
5919 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5920 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5921 the settings.  This has been the source of much confusion.  Org mode users
5922 can resort to special versions of these functions like @code{org-date} or
5923 @code{org-anniversary}.  These work just like the corresponding @code{diary-}
5924 functions, but with stable ISO order of arguments (year, month, day) wherever
5925 applicable, independent of the value of @code{calendar-date-style}.}.  For
5926 example with optional time
5928 @example
5929 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5930   <%%(diary-float t 4 2)>
5931 @end example
5933 @item Time/Date range
5934 @cindex timerange
5935 @cindex date range
5936 Two timestamps connected by @samp{--} denote a range.  The headline
5937 will be shown on the first and last day of the range, and on any dates
5938 that are displayed and fall in the range.  Here is an example:
5940 @example
5941 ** Meeting in Amsterdam
5942    <2004-08-23 Mon>--<2004-08-26 Thu>
5943 @end example
5945 @item Inactive timestamp
5946 @cindex timestamp, inactive
5947 @cindex inactive timestamp
5948 Just like a plain timestamp, but with square brackets instead of
5949 angular ones.  These timestamps are inactive in the sense that they do
5950 @emph{not} trigger an entry to show up in the agenda.
5952 @example
5953 * Gillian comes late for the fifth time
5954   [2006-11-01 Wed]
5955 @end example
5957 @end table
5959 @node Creating timestamps
5960 @section Creating timestamps
5961 @cindex creating timestamps
5962 @cindex timestamps, creating
5964 For Org mode to recognize timestamps, they need to be in the specific
5965 format.  All commands listed below produce timestamps in the correct
5966 format.
5968 @table @kbd
5969 @orgcmd{C-c .,org-time-stamp}
5970 Prompt for a date and insert a corresponding timestamp.  When the cursor is
5971 at an existing timestamp in the buffer, the command is used to modify this
5972 timestamp instead of inserting a new one.  When this command is used twice in
5973 succession, a time range is inserted.
5975 @orgcmd{C-c !,org-time-stamp-inactive}
5976 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5977 an agenda entry.
5979 @kindex C-u C-c .
5980 @kindex C-u C-c !
5981 @item C-u C-c .
5982 @itemx C-u C-c !
5983 @vindex org-time-stamp-rounding-minutes
5984 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5985 contains date and time.  The default time can be rounded to multiples of 5
5986 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5988 @orgkey{C-c C-c}
5989 Normalize timestamp, insert/fix day name if missing or wrong.
5991 @orgcmd{C-c <,org-date-from-calendar}
5992 Insert a timestamp corresponding to the cursor date in the Calendar.
5994 @orgcmd{C-c >,org-goto-calendar}
5995 Access the Emacs calendar for the current date.  If there is a
5996 timestamp in the current line, go to the corresponding date
5997 instead.
5999 @orgcmd{C-c C-o,org-open-at-point}
6000 Access the agenda for the date given by the timestamp or -range at
6001 point (@pxref{Weekly/daily agenda}).
6003 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
6004 Change date at cursor by one day.  These key bindings conflict with
6005 shift-selection and related modes (@pxref{Conflicts}).
6007 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
6008 Change the item under the cursor in a timestamp.  The cursor can be on a
6009 year, month, day, hour or minute.  When the timestamp contains a time range
6010 like @samp{15:30-16:30}, modifying the first time will also shift the second,
6011 shifting the time block with constant length.  To change the length, modify
6012 the second time.  Note that if the cursor is in a headline and not at a
6013 timestamp, these same keys modify the priority of an item.
6014 (@pxref{Priorities}).  The key bindings also conflict with shift-selection and
6015 related modes (@pxref{Conflicts}).
6017 @orgcmd{C-c C-y,org-evaluate-time-range}
6018 @cindex evaluate time range
6019 Evaluate a time range by computing the difference between start and end.
6020 With a prefix argument, insert result after the time range (in a table: into
6021 the following column).
6022 @end table
6025 @menu
6026 * The date/time prompt::        How Org mode helps you entering date and time
6027 * Custom time format::          Making dates look different
6028 @end menu
6030 @node The date/time prompt
6031 @subsection The date/time prompt
6032 @cindex date, reading in minibuffer
6033 @cindex time, reading in minibuffer
6035 @vindex org-read-date-prefer-future
6036 When Org mode prompts for a date/time, the default is shown in default
6037 date/time format, and the prompt therefore seems to ask for a specific
6038 format.  But it will in fact accept date/time information in a variety of
6039 formats.  Generally, the information should start at the beginning of the
6040 string.  Org mode will find whatever information is in
6041 there and derive anything you have not specified from the @emph{default date
6042 and time}.  The default is usually the current date and time, but when
6043 modifying an existing timestamp, or when entering the second stamp of a
6044 range, it is taken from the stamp in the buffer.  When filling in
6045 information, Org mode assumes that most of the time you will want to enter a
6046 date in the future: if you omit the month/year and the given day/month is
6047 @i{before} today, it will assume that you mean a future date@footnote{See the
6048 variable @code{org-read-date-prefer-future}.  You may set that variable to
6049 the symbol @code{time} to even make a time before now shift the date to
6050 tomorrow.}.  If the date has been automatically shifted into the future, the
6051 time prompt will show this with @samp{(=>F).}
6053 For example, let's assume that today is @b{June 13, 2006}.  Here is how
6054 various inputs will be interpreted, the items filled in by Org mode are
6055 in @b{bold}.
6057 @example
6058 3-2-5         @result{} 2003-02-05
6059 2/5/3         @result{} 2003-02-05
6060 14            @result{} @b{2006}-@b{06}-14
6061 12            @result{} @b{2006}-@b{07}-12
6062 2/5           @result{} @b{2007}-02-05
6063 Fri           @result{} nearest Friday after the default date
6064 sep 15        @result{} @b{2006}-09-15
6065 feb 15        @result{} @b{2007}-02-15
6066 sep 12 9      @result{} 2009-09-12
6067 12:45         @result{} @b{2006}-@b{06}-@b{13} 12:45
6068 22 sept 0:34  @result{} @b{2006}-09-22 0:34
6069 w4            @result{} ISO week for of the current year @b{2006}
6070 2012 w4 fri   @result{} Friday of ISO week 4 in 2012
6071 2012-w04-5    @result{} Same as above
6072 @end example
6074 Furthermore you can specify a relative date by giving, as the @emph{first}
6075 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
6076 indicate change in hours, days, weeks, months, or years.  With a single plus
6077 or minus, the date is always relative to today.  With a double plus or minus,
6078 it is relative to the default date.  If instead of a single letter, you use
6079 the abbreviation of day name, the date will be the Nth such day, e.g.:
6081 @example
6082 +0            @result{} today
6083 .             @result{} today
6084 +4d           @result{} four days from today
6085 +4            @result{} same as above
6086 +2w           @result{} two weeks from today
6087 ++5           @result{} five days from default date
6088 +2tue         @result{} second Tuesday from now
6089 -wed          @result{} last Wednesday
6090 @end example
6092 @vindex parse-time-months
6093 @vindex parse-time-weekdays
6094 The function understands English month and weekday abbreviations.  If
6095 you want to use unabbreviated names and/or other languages, configure
6096 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
6098 @vindex org-read-date-force-compatible-dates
6099 Not all dates can be represented in a given Emacs implementation.  By default
6100 Org mode forces dates into the compatibility range 1970--2037 which works on
6101 all Emacs implementations.  If you want to use dates outside of this range,
6102 read the docstring of the variable
6103 @code{org-read-date-force-compatible-dates}.
6105 You can specify a time range by giving start and end times or by giving a
6106 start time and a duration (in HH:MM format).  Use one or two dash(es) as the
6107 separator in the former case and use '+' as the separator in the latter
6108 case, e.g.:
6110 @example
6111 11am-1:15pm    @result{} 11:00-13:15
6112 11am--1:15pm   @result{} same as above
6113 11am+2:15      @result{} same as above
6114 @end example
6116 @cindex calendar, for selecting date
6117 @vindex org-popup-calendar-for-date-prompt
6118 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
6119 you don't need/want the calendar, configure the variable
6120 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
6121 prompt, either by clicking on a date in the calendar, or by pressing
6122 @key{RET}, the date selected in the calendar will be combined with the
6123 information entered at the prompt.  You can control the calendar fully
6124 from the minibuffer:
6126 @kindex <
6127 @kindex >
6128 @kindex M-v
6129 @kindex C-v
6130 @kindex mouse-1
6131 @kindex S-@key{right}
6132 @kindex S-@key{left}
6133 @kindex S-@key{down}
6134 @kindex S-@key{up}
6135 @kindex M-S-@key{right}
6136 @kindex M-S-@key{left}
6137 @kindex @key{RET}
6138 @kindex M-S-@key{down}
6139 @kindex M-S-@key{up}
6141 @example
6142 @key{RET}              @r{Choose date at cursor in calendar.}
6143 mouse-1            @r{Select date by clicking on it.}
6144 S-@key{right}/@key{left}   @r{One day forward/backward.}
6145 S-@key{down}/@key{up}      @r{One week forward/backward.}
6146 M-S-@key{right}/@key{left} @r{One month forward/backward.}
6147 > / <              @r{Scroll calendar forward/backward by one month.}
6148 M-v / C-v          @r{Scroll calendar forward/backward by 3 months.}
6149 M-S-@key{down}/@key{up}    @r{Scroll calendar forward/backward by one year.}
6150 @end example
6152 @vindex org-read-date-display-live
6153 The actions of the date/time prompt may seem complex, but I assure you they
6154 will grow on you, and you will start getting annoyed by pretty much any other
6155 way of entering a date/time out there.  To help you understand what is going
6156 on, the current interpretation of your input will be displayed live in the
6157 minibuffer@footnote{If you find this distracting, turn the display off with
6158 @code{org-read-date-display-live}.}.
6160 @node Custom time format
6161 @subsection Custom time format
6162 @cindex custom date/time format
6163 @cindex time format, custom
6164 @cindex date format, custom
6166 @vindex org-display-custom-times
6167 @vindex org-time-stamp-custom-formats
6168 Org mode uses the standard ISO notation for dates and times as it is
6169 defined in ISO 8601.  If you cannot get used to this and require another
6170 representation of date and time to keep you happy, you can get it by
6171 customizing the options @code{org-display-custom-times} and
6172 @code{org-time-stamp-custom-formats}.
6174 @table @kbd
6175 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6176 Toggle the display of custom formats for dates and times.
6177 @end table
6179 @noindent
6180 Org mode needs the default format for scanning, so the custom date/time
6181 format does not @emph{replace} the default format---instead it is put
6182 @emph{over} the default format using text properties.  This has the
6183 following consequences:
6184 @itemize @bullet
6185 @item
6186 You cannot place the cursor onto a timestamp anymore, only before or
6187 after.
6188 @item
6189 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6190 each component of a timestamp.  If the cursor is at the beginning of
6191 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6192 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
6193 time will be changed by one minute.
6194 @item
6195 If the timestamp contains a range of clock times or a repeater, these
6196 will not be overlaid, but remain in the buffer as they were.
6197 @item
6198 When you delete a timestamp character-by-character, it will only
6199 disappear from the buffer after @emph{all} (invisible) characters
6200 belonging to the ISO timestamp have been removed.
6201 @item
6202 If the custom timestamp format is longer than the default and you are
6203 using dates in tables, table alignment will be messed up.  If the custom
6204 format is shorter, things do work as expected.
6205 @end itemize
6208 @node Deadlines and scheduling
6209 @section Deadlines and scheduling
6211 A timestamp may be preceded by special keywords to facilitate planning:
6213 @table @var
6214 @item DEADLINE
6215 @cindex DEADLINE keyword
6217 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6218 to be finished on that date.
6220 @vindex org-deadline-warning-days
6221 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6222 On the deadline date, the task will be listed in the agenda.  In
6223 addition, the agenda for @emph{today} will carry a warning about the
6224 approaching or missed deadline, starting
6225 @code{org-deadline-warning-days} before the due date, and continuing
6226 until the entry is marked DONE@.  An example:
6228 @example
6229 *** TODO write article about the Earth for the Guide
6230     DEADLINE: <2004-02-29 Sun>
6231     The editor in charge is [[bbdb:Ford Prefect]]
6232 @end example
6234 You can specify a different lead time for warnings for a specific
6235 deadline using the following syntax.  Here is an example with a warning
6236 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.  This warning is
6237 deactivated if the task gets scheduled and you set
6238 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6240 @item SCHEDULED
6241 @cindex SCHEDULED keyword
6243 Meaning: you are planning to start working on that task on the given
6244 date.
6246 @vindex org-agenda-skip-scheduled-if-done
6247 The headline will be listed under the given date@footnote{It will still
6248 be listed on that date after it has been marked DONE@.  If you don't like
6249 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
6250 addition, a reminder that the scheduled date has passed will be present
6251 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6252 the task will automatically be forwarded until completed.
6254 @example
6255 *** TODO Call Trillian for a date on New Years Eve.
6256     SCHEDULED: <2004-12-25 Sat>
6257 @end example
6259 @vindex org-scheduled-delay-days
6260 @vindex org-agenda-skip-scheduled-delay-if-deadline
6261 If you want to @emph{delay} the display of this task in the agenda, use
6262 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6263 25th but will appear two days later.  In case the task contains a repeater,
6264 the delay is considered to affect all occurrences; if you want the delay to
6265 only affect the first scheduled occurrence of the task, use @code{--2d}
6266 instead.  See @code{org-scheduled-delay-days} and
6267 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6268 control this globally or per agenda.
6270 @noindent
6271 @b{Important:} Scheduling an item in Org mode should @i{not} be
6272 understood in the same way that we understand @i{scheduling a meeting}.
6273 Setting a date for a meeting is just a simple appointment, you should
6274 mark this entry with a simple plain timestamp, to get this item shown
6275 on the date where it applies.  This is a frequent misunderstanding by
6276 Org users.  In Org mode, @i{scheduling} means setting a date when you
6277 want to start working on an action item.
6278 @end table
6280 You may use timestamps with repeaters in scheduling and deadline
6281 entries.  Org mode will issue early and late warnings based on the
6282 assumption that the timestamp represents the @i{nearest instance} of
6283 the repeater.  However, the use of diary sexp entries like
6285 @code{<%%(diary-float t 42)>}
6287 in scheduling and deadline timestamps is limited.  Org mode does not
6288 know enough about the internals of each sexp function to issue early and
6289 late warnings.  However, it will show the item on each day where the
6290 sexp entry matches.
6292 @menu
6293 * Inserting deadline/schedule::  Planning items
6294 * Repeated tasks::              Items that show up again and again
6295 @end menu
6297 @node Inserting deadline/schedule
6298 @subsection Inserting deadlines or schedules
6300 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6301 @samp{DEADLINE} dates are inserted on the line right below the headline.  Don't put
6302 any text between this line and the headline.} a deadline or to schedule
6303 an item:
6305 @table @kbd
6307 @orgcmd{C-c C-d,org-deadline}
6308 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will happen
6309 in the line directly following the headline.  Any CLOSED timestamp will be
6310 removed.  When called with a prefix arg, an existing deadline will be removed
6311 from the entry.  Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6312 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6313 and @code{nologredeadline}}, a note will be taken when changing an existing
6314 deadline.
6316 @orgcmd{C-c C-s,org-schedule}
6317 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
6318 happen in the line directly following the headline.  Any CLOSED timestamp
6319 will be removed.  When called with a prefix argument, remove the scheduling
6320 date from the entry.  Depending on the variable
6321 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6322 keywords @code{logreschedule}, @code{lognotereschedule}, and
6323 @code{nologreschedule}}, a note will be taken when changing an existing
6324 scheduling time.
6326 @orgcmd{C-c / d,org-check-deadlines}
6327 @cindex sparse tree, for deadlines
6328 @vindex org-deadline-warning-days
6329 Create a sparse tree with all deadlines that are either past-due, or
6330 which will become due within @code{org-deadline-warning-days}.
6331 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
6332 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
6333 all deadlines due tomorrow.
6335 @orgcmd{C-c / b,org-check-before-date}
6336 Sparse tree for deadlines and scheduled items before a given date.
6338 @orgcmd{C-c / a,org-check-after-date}
6339 Sparse tree for deadlines and scheduled items after a given date.
6340 @end table
6342 Note that @code{org-schedule} and @code{org-deadline} supports
6343 setting the date by indicating a relative time: e.g., +1d will set
6344 the date to the next day after today, and --1w will set the date
6345 to the previous week before any current timestamp.
6347 @node Repeated tasks
6348 @subsection Repeated tasks
6349 @cindex tasks, repeated
6350 @cindex repeated tasks
6352 Some tasks need to be repeated again and again.  Org mode helps to
6353 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6354 or plain timestamp.  In the following example
6355 @example
6356 ** TODO Pay the rent
6357    DEADLINE: <2005-10-01 Sat +1m>
6358 @end example
6359 @noindent
6360 the @code{+1m} is a repeater; the intended interpretation is that the task
6361 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6362 from that time.  You can use yearly, monthly, weekly, daily and hourly repeat
6363 cookies by using the @code{y/w/m/d/h} letters.  If you need both a repeater
6364 and a special warning period in a deadline entry, the repeater should come
6365 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6367 @vindex org-todo-repeat-to-state
6368 Deadlines and scheduled items produce entries in the agenda when they are
6369 over-due, so it is important to be able to mark such an entry as completed
6370 once you have done so.  When you mark a DEADLINE or a SCHEDULE with the TODO
6371 keyword DONE, it will no longer produce entries in the agenda.  The problem
6372 with this is, however, that then also the @emph{next} instance of the
6373 repeated entry will not be active.  Org mode deals with this in the following
6374 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6375 shift the base date of the repeating timestamp by the repeater interval, and
6376 immediately set the entry state back to TODO@footnote{In fact, the target
6377 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6378 the variable @code{org-todo-repeat-to-state}.  If neither of these is
6379 specified, the target state defaults to the first state of the TODO state
6380 sequence.}.  In the example above, setting the state to DONE would actually
6381 switch the date like this:
6383 @example
6384 ** TODO Pay the rent
6385    DEADLINE: <2005-11-01 Tue +1m>
6386 @end example
6388 To mark a task with a repeater as @code{DONE}, use @kbd{C-- 1 C-c C-t}
6389 (i.e., @code{org-todo} with a numeric prefix argument of -1.)
6391 @vindex org-log-repeat
6392 A timestamp@footnote{You can change this using the option
6393 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6394 @code{lognoterepeat}, and @code{nologrepeat}.  With @code{lognoterepeat}, you
6395 will also be prompted for a note.} will be added under the deadline, to keep
6396 a record that you actually acted on the previous instance of this deadline.
6398 As a consequence of shifting the base date, this entry will no longer be
6399 visible in the agenda when checking past dates, but all future instances
6400 will be visible.
6402 With the @samp{+1m} cookie, the date shift will always be exactly one
6403 month.  So if you have not paid the rent for three months, marking this
6404 entry DONE will still keep it as an overdue deadline.  Depending on the
6405 task, this may not be the best way to handle it.  For example, if you
6406 forgot to call your father for 3 weeks, it does not make sense to call
6407 him 3 times in a single day to make up for it.  Finally, there are tasks
6408 like changing batteries which should always repeat a certain time
6409 @i{after} the last time you did it.  For these tasks, Org mode has
6410 special repeaters  @samp{++} and @samp{.+}.  For example:
6412 @example
6413 ** TODO Call Father
6414    DEADLINE: <2008-02-10 Sun ++1w>
6415    Marking this DONE will shift the date by at least one week,
6416    but also by as many weeks as it takes to get this date into
6417    the future.  However, it stays on a Sunday, even if you called
6418    and marked it done on Saturday.
6419 ** TODO Check the batteries in the smoke detectors
6420    DEADLINE: <2005-11-01 Tue .+1m>
6421    Marking this DONE will shift the date to one month after
6422    today.
6423 @end example
6425 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6426 You may have both scheduling and deadline information for a specific task.
6427 If the repeater is set for the scheduling information only, you probably want
6428 the repeater to be ignored after the deadline.  If so, set the variable
6429 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6430 @code{repeated-after-deadline}.  If you want both scheduling and deadline
6431 information to repeat after the same interval, set the same repeater for both
6432 timestamps.
6434 An alternative to using a repeater is to create a number of copies of a task
6435 subtree, with dates shifted in each copy.  The command @kbd{C-c C-x c} was
6436 created for this purpose, it is described in @ref{Structure editing}.
6439 @node Clocking work time
6440 @section Clocking work time
6441 @cindex clocking time
6442 @cindex time clocking
6444 Org mode allows you to clock the time you spend on specific tasks in a
6445 project.  When you start working on an item, you can start the clock.  When
6446 you stop working on that task, or when you mark the task done, the clock is
6447 stopped and the corresponding time interval is recorded.  It also computes
6448 the total time spent on each subtree@footnote{Clocking only works if all
6449 headings are indented with less than 30 stars.  This is a hardcoded
6450 limitation of `lmax' in `org-clock-sum'.} of a project.  And it remembers a
6451 history or tasks recently clocked, so that you can jump quickly between a
6452 number of tasks absorbing your time.
6454 To save the clock history across Emacs sessions, use
6455 @lisp
6456 (setq org-clock-persist 'history)
6457 (org-clock-persistence-insinuate)
6458 @end lisp
6459 When you clock into a new task after resuming Emacs, the incomplete
6460 clock@footnote{To resume the clock under the assumption that you have worked
6461 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6462 will be found (@pxref{Resolving idle time}) and you will be prompted about
6463 what to do with it.
6465 @menu
6466 * Clocking commands::           Starting and stopping a clock
6467 * The clock table::             Detailed reports
6468 * Resolving idle time::         Resolving time when you've been idle
6469 @end menu
6471 @node Clocking commands
6472 @subsection Clocking commands
6474 @table @kbd
6475 @orgcmd{C-c C-x C-i,org-clock-in}
6476 @vindex org-clock-into-drawer
6477 @vindex org-clock-continuously
6478 @cindex property, LOG_INTO_DRAWER
6479 Start the clock on the current item (clock-in).  This inserts the CLOCK
6480 keyword together with a timestamp.  If this is not the first clocking of
6481 this item, the multiple CLOCK lines will be wrapped into a
6482 @code{:LOGBOOK:} drawer (see also the variable
6483 @code{org-clock-into-drawer}).  You can also overrule
6484 the setting of this variable for a subtree by setting a
6485 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6486 When called with a @kbd{C-u} prefix argument,
6487 select the task from a list of recently clocked tasks.  With two @kbd{C-u
6488 C-u} prefixes, clock into the task at point and mark it as the default task;
6489 the default task will then always be available with letter @kbd{d} when
6490 selecting a clocking task.  With three @kbd{C-u C-u C-u} prefixes, force
6491 continuous clocking by starting the clock when the last clock stopped.@*
6492 @cindex property: CLOCK_MODELINE_TOTAL
6493 @cindex property: LAST_REPEAT
6494 @vindex org-clock-modeline-total
6495 While the clock is running, the current clocking time is shown in the mode
6496 line, along with the title of the task.  The clock time shown will be all
6497 time ever clocked for this task and its children.  If the task has an effort
6498 estimate (@pxref{Effort estimates}), the mode line displays the current
6499 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6500 hook a function doing this to @code{org-clock-in-prepare-hook}.}  If the task
6501 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6502 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6503 will be shown.  More control over what time is shown can be exercised with
6504 the @code{CLOCK_MODELINE_TOTAL} property.  It may have the values
6505 @code{current} to show only the current clocking instance, @code{today} to
6506 show all time clocked on this tasks today (see also the variable
6507 @code{org-extend-today-until}), @code{all} to include all time, or
6508 @code{auto} which is the default@footnote{See also the variable
6509 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6510 mode line entry will pop up a menu with clocking options.
6512 @orgcmd{C-c C-x C-o,org-clock-out}
6513 @vindex org-log-note-clock-out
6514 Stop the clock (clock-out).  This inserts another timestamp at the same
6515 location where the clock was last started.  It also directly computes
6516 the resulting time and inserts it after the time range as @samp{=>
6517 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
6518 possibility to record an additional note together with the clock-out
6519 timestamp@footnote{The corresponding in-buffer setting is:
6520 @code{#+STARTUP: lognoteclock-out}}.
6521 @orgcmd{C-c C-x C-x,org-clock-in-last}
6522 @vindex org-clock-continuously
6523 Reclock the last clocked task.  With one @kbd{C-u} prefix argument,
6524 select the task from the clock history.  With two @kbd{C-u} prefixes,
6525 force continuous clocking by starting the clock when the last clock
6526 stopped.
6527 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6528 Update the effort estimate for the current clock task.
6529 @kindex C-c C-y
6530 @kindex C-c C-c
6531 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6532 Recompute the time interval after changing one of the timestamps.  This
6533 is only necessary if you edit the timestamps directly.  If you change
6534 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6535 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6536 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6537 clock duration keeps the same.
6538 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6539 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6540 the one of the previous (or the next clock) timestamp by the same duration.
6541 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6542 by five minutes, then the clocked-in timestamp of the next clock will be
6543 increased by five minutes.
6544 @orgcmd{C-c C-t,org-todo}
6545 Changing the TODO state of an item to DONE automatically stops the clock
6546 if it is running in this same item.
6547 @orgcmd{C-c C-x C-q,org-clock-cancel}
6548 Cancel the current clock.  This is useful if a clock was started by
6549 mistake, or if you ended up working on something else.
6550 @orgcmd{C-c C-x C-j,org-clock-goto}
6551 Jump to the headline of the currently clocked in task.  With a @kbd{C-u}
6552 prefix arg, select the target task from a list of recently clocked tasks.
6553 @orgcmd{C-c C-x C-d,org-clock-display}
6554 @vindex org-remove-highlights-with-change
6555 Display time summaries for each subtree in the current buffer.  This puts
6556 overlays at the end of each headline, showing the total time recorded under
6557 that heading, including the time of any subheadings.  You can use visibility
6558 cycling to study the tree, but the overlays disappear when you change the
6559 buffer (see variable @code{org-remove-highlights-with-change}) or press
6560 @kbd{C-c C-c}.
6561 @end table
6563 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6564 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6565 worked on or closed during a day.
6567 @strong{Important:} note that both @code{org-clock-out} and
6568 @code{org-clock-in-last} can have a global keybinding and will not
6569 modify the window disposition.
6571 @node The clock table
6572 @subsection The clock table
6573 @cindex clocktable, dynamic block
6574 @cindex report, of clocked time
6576 Org mode can produce quite complex reports based on the time clocking
6577 information.  Such a report is called a @emph{clock table}, because it is
6578 formatted as one or several Org tables.
6580 @table @kbd
6581 @orgcmd{C-c C-x C-r,org-clock-report}
6582 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6583 report as an Org mode table into the current file.  When the cursor is
6584 at an existing clock table, just update it.  When called with a prefix
6585 argument, jump to the first clock report in the current document and
6586 update it.  The clock table always includes also trees with
6587 @code{:ARCHIVE:} tag.
6588 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6589 Update dynamic block at point.  The cursor needs to be in the
6590 @code{#+BEGIN} line of the dynamic block.
6591 @orgkey{C-u C-c C-x C-u}
6592 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
6593 you have several clock table blocks in a buffer.
6594 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6595 Shift the current @code{:block} interval and update the table.  The cursor
6596 needs to be in the @code{#+BEGIN: clocktable} line for this command.  If
6597 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6598 @end table
6601 Here is an example of the frame for a clock table as it is inserted into the
6602 buffer with the @kbd{C-c C-x C-r} command:
6604 @cindex #+BEGIN, clocktable
6605 @example
6606 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6607 #+END: clocktable
6608 @end example
6609 @noindent
6610 @vindex org-clocktable-defaults
6611 The @samp{BEGIN} line specifies a number of options to define the scope,
6612 structure, and formatting of the report.  Defaults for all these options can
6613 be configured in the variable @code{org-clocktable-defaults}.
6615 @noindent First there are options that determine which clock entries are to
6616 be selected:
6617 @example
6618 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
6619              @r{Clocks at deeper levels will be summed into the upper level.}
6620 :scope       @r{The scope to consider.  This can be any of the following:}
6621              nil        @r{the current buffer or narrowed region}
6622              file       @r{the full current buffer}
6623              subtree    @r{the subtree where the clocktable is located}
6624              tree@var{N}      @r{the surrounding level @var{N} tree, for example @code{tree3}}
6625              tree       @r{the surrounding level 1 tree}
6626              agenda     @r{all agenda files}
6627              ("file"..) @r{scan these files}
6628              file-with-archives    @r{current file and its archives}
6629              agenda-with-archives  @r{all agenda files, including archives}
6630 :block       @r{The time block to consider.  This block is specified either}
6631              @r{absolutely, or relative to the current time and may be any of}
6632              @r{these formats:}
6633              2007-12-31    @r{New year eve 2007}
6634              2007-12       @r{December 2007}
6635              2007-W50      @r{ISO-week 50 in 2007}
6636              2007-Q2       @r{2nd quarter in 2007}
6637              2007          @r{the year 2007}
6638              today, yesterday, today-@var{N}          @r{a relative day}
6639              thisweek, lastweek, thisweek-@var{N}     @r{a relative week}
6640              thismonth, lastmonth, thismonth-@var{N}  @r{a relative month}
6641              thisyear, lastyear, thisyear-@var{N}     @r{a relative year}
6642              @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6643 :tstart      @r{A time string specifying when to start considering times.}
6644              @r{Relative times like @code{"<-2w>"} can also be used.  See}
6645              @r{@ref{Matching tags and properties} for relative time syntax.}
6646 :tend        @r{A time string specifying when to stop considering times.}
6647              @r{Relative times like @code{"<now>"} can also be used.  See}
6648              @r{@ref{Matching tags and properties} for relative time syntax.}
6649 :wstart      @r{The starting day of the week.  The default is 1 for monday.}
6650 :mstart      @r{The starting day of the month.  The default 1 is for the first}
6651              @r{day of the month.}
6652 :step        @r{@code{week} or @code{day}, to split the table into chunks.}
6653              @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6654 :stepskip0   @r{Do not show steps that have zero time.}
6655 :fileskip0   @r{Do not show table sections from files which did not contribute.}
6656 :tags        @r{A tags match to select entries that should contribute.  See}
6657              @r{@ref{Matching tags and properties} for the match syntax.}
6658 @end example
6660 Then there are options which determine the formatting of the table.  These
6661 options are interpreted by the function @code{org-clocktable-write-default},
6662 but you can specify your own function using the @code{:formatter} parameter.
6663 @example
6664 :emphasize   @r{When @code{t}, emphasize level one and level two items.}
6665 :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".}
6666 :link        @r{Link the item headlines in the table to their origins.}
6667 :narrow      @r{An integer to limit the width of the headline column in}
6668              @r{the org table.  If you write it like @samp{50!}, then the}
6669              @r{headline will also be shortened in export.}
6670 :indent      @r{Indent each headline field according to its level.}
6671 :tcolumns    @r{Number of columns to be used for times.  If this is smaller}
6672              @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6673 :level       @r{Should a level number column be included?}
6674 :sort        @r{A cons cell like containing the column to sort and a sorting type.}
6675              @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.}
6676 :compact     @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6677              @r{All are overwritten except if there is an explicit @code{:narrow}}
6678 :timestamp   @r{A timestamp for the entry, when available.  Look for SCHEDULED,}
6679              @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6680 :properties  @r{List of properties that should be shown in the table.  Each}
6681              @r{property will get its own column.}
6682 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6683 :formula     @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6684              @r{As a special case, @samp{:formula %} adds a column with % time.}
6685              @r{If you do not specify a formula here, any existing formula}
6686              @r{below the clock table will survive updates and be evaluated.}
6687 :formatter   @r{A function to format clock data and insert it into the buffer.}
6688 @end example
6689 To get a clock summary of the current level 1 tree, for the current
6690 day, you could write
6691 @example
6692 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6693 #+END: clocktable
6694 @end example
6695 @noindent
6696 and to use a specific time range you could write@footnote{Note that all
6697 parameters must be specified in a single line---the line is broken here
6698 only to fit it into the manual.}
6699 @example
6700 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6701                     :tend "<2006-08-10 Thu 12:00>"
6702 #+END: clocktable
6703 @end example
6704 A range starting a week ago and ending right now could be written as
6705 @example
6706 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6707 #+END: clocktable
6708 @end example
6709 A summary of the current subtree with % times would be
6710 @example
6711 #+BEGIN: clocktable :scope subtree :link t :formula %
6712 #+END: clocktable
6713 @end example
6714 A horizontally compact representation of everything clocked during last week
6715 would be
6716 @example
6717 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6718 #+END: clocktable
6719 @end example
6721 @node Resolving idle time
6722 @subsection Resolving idle time and continuous clocking
6724 @subsubheading Resolving idle time
6725 @cindex resolve idle time
6726 @vindex org-clock-x11idle-program-name
6728 @cindex idle, resolve, dangling
6729 If you clock in on a work item, and then walk away from your
6730 computer---perhaps to take a phone call---you often need to ``resolve'' the
6731 time you were away by either subtracting it from the current clock, or
6732 applying it to another one.
6734 @vindex org-clock-idle-time
6735 By customizing the variable @code{org-clock-idle-time} to some integer, such
6736 as 10 or 15, Emacs can alert you when you get back to your computer after
6737 being idle for that many minutes@footnote{On computers using Mac OS X,
6738 idleness is based on actual user idleness, not just Emacs' idle time.  For
6739 X11, you can install a utility program @file{x11idle.c}, available in the
6740 @code{contrib/scripts} directory of the Org git distribution, or install the
6741 @file{xprintidle} package and set it to the variable
6742 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6743 same general treatment of idleness.  On other systems, idle time refers to
6744 Emacs idle time only.}, and ask what you want to do with the idle time.
6745 There will be a question waiting for you when you get back, indicating how
6746 much idle time has passed (constantly updated with the current amount), as
6747 well as a set of choices to correct the discrepancy:
6749 @table @kbd
6750 @item k
6751 To keep some or all of the minutes and stay clocked in, press @kbd{k}.  Org
6752 will ask how many of the minutes to keep.  Press @key{RET} to keep them all,
6753 effectively changing nothing, or enter a number to keep that many minutes.
6754 @item K
6755 If you use the shift key and press @kbd{K}, it will keep however many minutes
6756 you request and then immediately clock out of that task.  If you keep all of
6757 the minutes, this is the same as just clocking out of the current task.
6758 @item s
6759 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6760 the clock, and then check back in from the moment you returned.
6761 @item S
6762 To keep none of the minutes and just clock out at the start of the away time,
6763 use the shift key and press @kbd{S}.  Remember that using shift will always
6764 leave you clocked out, no matter which option you choose.
6765 @item C
6766 To cancel the clock altogether, use @kbd{C}.  Note that if instead of
6767 canceling you subtract the away time, and the resulting clock amount is less
6768 than a minute, the clock will still be canceled rather than clutter up the
6769 log with an empty entry.
6770 @end table
6772 What if you subtracted those away minutes from the current clock, and now
6773 want to apply them to a new clock?  Simply clock in to any task immediately
6774 after the subtraction.  Org will notice that you have subtracted time ``on
6775 the books'', so to speak, and will ask if you want to apply those minutes to
6776 the next task you clock in on.
6778 There is one other instance when this clock resolution magic occurs.  Say you
6779 were clocked in and hacking away, and suddenly your cat chased a mouse who
6780 scared a hamster that crashed into your UPS's power button!  You suddenly
6781 lose all your buffers, but thanks to auto-save you still have your recent Org
6782 mode changes, including your last clock in.
6784 If you restart Emacs and clock into any task, Org will notice that you have a
6785 dangling clock which was never clocked out from your last session.  Using
6786 that clock's starting time as the beginning of the unaccounted-for period,
6787 Org will ask how you want to resolve that time.  The logic and behavior is
6788 identical to dealing with away time due to idleness; it is just happening due
6789 to a recovery event rather than a set amount of idle time.
6791 You can also check all the files visited by your Org agenda for dangling
6792 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6794 @subsubheading Continuous clocking
6795 @cindex continuous clocking
6796 @vindex org-clock-continuously
6798 You may want to start clocking from the time when you clocked out the
6799 previous task.  To enable this systematically, set @code{org-clock-continuously}
6800 to @code{t}.  Each time you clock in, Org retrieves the clock-out time of the
6801 last clocked entry for this session, and start the new clock from there.
6803 If you only want this from time to time, use three universal prefix arguments
6804 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6806 @node Effort estimates
6807 @section Effort estimates
6808 @cindex effort estimates
6810 @cindex property, Effort
6811 If you want to plan your work in a very detailed way, or if you need to
6812 produce offers with quotations of the estimated work effort, you may want to
6813 assign effort estimates to entries.  If you are also clocking your work, you
6814 may later want to compare the planned effort with the actual working time,
6815 a great way to improve planning estimates.  Effort estimates are stored in
6816 a special property @code{EFFORT}.  You can set the effort for an entry with
6817 the following commands:
6819 @table @kbd
6820 @orgcmd{C-c C-x e,org-set-effort}
6821 Set the effort estimate for the current entry.  With a numeric prefix
6822 argument, set it to the Nth allowed value (see below).  This command is also
6823 accessible from the agenda with the @kbd{e} key.
6824 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6825 Modify the effort estimate of the item currently being clocked.
6826 @end table
6828 Clearly the best way to work with effort estimates is through column view
6829 (@pxref{Column view}).  You should start by setting up discrete values for
6830 effort estimates, and a @code{COLUMNS} format that displays these values
6831 together with clock sums (if you want to clock your time).  For a specific
6832 buffer you can use
6834 @example
6835 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6836 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6837 @end example
6839 @noindent
6840 @vindex org-global-properties
6841 @vindex org-columns-default-format
6842 or, even better, you can set up these values globally by customizing the
6843 variables @code{org-global-properties} and @code{org-columns-default-format}.
6844 In particular if you want to use this setup also in the agenda, a global
6845 setup may be advised.
6847 The way to assign estimates to individual items is then to switch to column
6848 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6849 value.  The values you enter will immediately be summed up in the hierarchy.
6850 In the column next to it, any clocked time will be displayed.
6852 @vindex org-agenda-columns-add-appointments-to-effort-sum
6853 If you switch to column view in the daily/weekly agenda, the effort column
6854 will summarize the estimated work effort for each day@footnote{Please note
6855 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6856 column view}).}, and you can use this to find space in your schedule.  To get
6857 an overview of the entire part of the day that is committed, you can set the
6858 option @code{org-agenda-columns-add-appointments-to-effort-sum}.  The
6859 appointments on a day that take place over a specified time interval will
6860 then also be added to the load estimate of the day.
6862 Effort estimates can be used in secondary agenda filtering that is triggered
6863 with the @kbd{/} key in the agenda (@pxref{Agenda commands}).  If you have
6864 these estimates defined consistently, two or three key presses will narrow
6865 down the list to stuff that fits into an available time slot.
6867 @node Timers
6868 @section Taking notes with a timer
6869 @cindex relative timer
6870 @cindex countdown timer
6871 @kindex ;
6873 Org provides provides two types of timers.  There is a relative timer that
6874 counts up, which can be useful when taking notes during, for example, a
6875 meeting or a video viewing.  There is also a countdown timer.
6877 The relative and countdown are started with separate commands.
6879 @table @kbd
6880 @orgcmd{C-c C-x 0,org-timer-start}
6881 Start or reset the relative timer.  By default, the timer is set to 0.  When
6882 called with a @kbd{C-u} prefix, prompt the user for a starting offset.  If
6883 there is a timer string at point, this is taken as the default, providing a
6884 convenient way to restart taking notes after a break in the process.  When
6885 called with a double prefix argument @kbd{C-u C-u}, change all timer strings
6886 in the active region by a certain amount.  This can be used to fix timer
6887 strings if the timer was not started at exactly the right moment.
6888 @orgcmd{C-c C-x ;,org-timer-set-timer}
6889 Start a countdown timer.  The user is prompted for a duration.
6890 @code{org-timer-default-timer} sets the default countdown value.  Giving a
6891 prefix numeric argument overrides this default value.  This command is
6892 available as @kbd{;} in agenda buffers.
6893 @end table
6895 Once started, relative and countdown timers are controlled with the same
6896 commands.
6898 @table @kbd
6899 @orgcmd{C-c C-x .,org-timer}
6900 Insert the value of the current relative or countdown timer into the buffer.
6901 If no timer is running, the relative timer will be started.  When called with
6902 a prefix argument, the relative timer is restarted.
6903 @orgcmd{C-c C-x -,org-timer-item}
6904 Insert a description list item with the value of the current relative or
6905 countdown timer.  With a prefix argument, first reset the relative timer to
6907 @orgcmd{M-@key{RET},org-insert-heading}
6908 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6909 new timer items.
6910 @orgcmd{C-c C-x \\,org-timer-pause-or-continue}
6911 Pause the timer, or continue it if it is already paused.
6912 @orgcmd{C-c C-x _,org-timer-stop}
6913 Stop the timer.  After this, you can only start a new timer, not continue the
6914 old one.  This command also removes the timer from the mode line.
6915 @end table
6917 @node Capture - Refile - Archive
6918 @chapter Capture - Refile - Archive
6919 @cindex capture
6921 An important part of any organization system is the ability to quickly
6922 capture new ideas and tasks, and to associate reference material with them.
6923 Org does this using a process called @i{capture}.  It also can store files
6924 related to a task (@i{attachments}) in a special directory.  Once in the
6925 system, tasks and projects need to be moved around.  Moving completed project
6926 trees to an archive file keeps the system compact and fast.
6928 @menu
6929 * Capture::                     Capturing new stuff
6930 * Attachments::                 Add files to tasks
6931 * RSS feeds::                   Getting input from RSS feeds
6932 * Protocols::                   External (e.g., Browser) access to Emacs and Org
6933 * Refile and copy::             Moving/copying a tree from one place to another
6934 * Archiving::                   What to do with finished projects
6935 @end menu
6937 @node Capture
6938 @section Capture
6939 @cindex capture
6941 Capture lets you quickly store notes with little interruption of your work
6942 flow.  Org's method for capturing new items is heavily inspired by John
6943 Wiegley excellent @file{remember.el} package.  Up to version 6.36, Org
6944 used a special setup for @file{remember.el}, then replaced it with
6945 @file{org-remember.el}.  As of version 8.0, @file{org-remember.el} has
6946 been completely replaced by @file{org-capture.el}.
6948 If your configuration depends on @file{org-remember.el}, you need to update
6949 it and use the setup described below.  To convert your
6950 @code{org-remember-templates}, run the command
6951 @example
6952 @kbd{M-x org-capture-import-remember-templates RET}
6953 @end example
6954 @noindent and then customize the new variable with @kbd{M-x
6955 customize-variable org-capture-templates}, check the result, and save the
6956 customization.
6958 @menu
6959 * Setting up capture::          Where notes will be stored
6960 * Using capture::               Commands to invoke and terminate capture
6961 * Capture templates::           Define the outline of different note types
6962 @end menu
6964 @node Setting up capture
6965 @subsection Setting up capture
6967 The following customization sets a default target file for notes, and defines
6968 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6969 suggestion.}  for capturing new material.
6971 @vindex org-default-notes-file
6972 @smalllisp
6973 @group
6974 (setq org-default-notes-file (concat org-directory "/notes.org"))
6975 (define-key global-map "\C-cc" 'org-capture)
6976 @end group
6977 @end smalllisp
6979 @node Using capture
6980 @subsection Using capture
6982 @table @kbd
6983 @orgcmd{C-c c,org-capture}
6984 Call the command @code{org-capture}.  Note that this keybinding is global and
6985 not active by default: you need to install it.  If you have templates
6986 @cindex date tree
6987 defined @pxref{Capture templates}, it will offer these templates for
6988 selection or use a new Org outline node as the default template.  It will
6989 insert the template into the target file and switch to an indirect buffer
6990 narrowed to this new node.  You may then insert the information you want.
6992 @orgcmd{C-c C-c,org-capture-finalize}
6993 Once you have finished entering information into the capture buffer, @kbd{C-c
6994 C-c} will return you to the window configuration before the capture process,
6995 so that you can resume your work without further distraction.  When called
6996 with a prefix arg, finalize and then jump to the captured item.
6998 @orgcmd{C-c C-w,org-capture-refile}
6999 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
7000 a different place.  Please realize that this is a normal refiling command
7001 that will be executed---so the cursor position at the moment you run this
7002 command is important.  If you have inserted a tree with a parent and
7003 children, first move the cursor back to the parent.  Any prefix argument
7004 given to this command will be passed on to the @code{org-refile} command.
7006 @orgcmd{C-c C-k,org-capture-kill}
7007 Abort the capture process and return to the previous state.
7009 @end table
7011 You can also call @code{org-capture} in a special way from the agenda, using
7012 the @kbd{k c} key combination.  With this access, any timestamps inserted by
7013 the selected capture template will default to the cursor date in the agenda,
7014 rather than to the current date.
7016 To find the locations of the last stored capture, use @code{org-capture} with
7017 prefix commands:
7019 @table @kbd
7020 @orgkey{C-u C-c c}
7021 Visit the target location of a capture template.  You get to select the
7022 template in the usual way.
7023 @orgkey{C-u C-u C-c c}
7024 Visit the last stored capture item in its buffer.
7025 @end table
7027 @vindex org-capture-bookmark
7028 @cindex org-capture-last-stored
7029 You can also jump to the bookmark @code{org-capture-last-stored}, which will
7030 automatically be created unless you set @code{org-capture-bookmark} to
7031 @code{nil}.
7033 To insert the capture at point in an Org buffer, call @code{org-capture} with
7034 a @code{C-0} prefix argument.
7036 @node Capture templates
7037 @subsection Capture templates
7038 @cindex templates, for Capture
7040 You can use templates for different types of capture items, and
7041 for different target locations.  The easiest way to create such templates is
7042 through the customize interface.
7044 @table @kbd
7045 @orgkey{C-c c C}
7046 Customize the variable @code{org-capture-templates}.
7047 @end table
7049 Before we give the formal description of template definitions, let's look at
7050 an example.  Say you would like to use one template to create general TODO
7051 entries, and you want to put these entries under the heading @samp{Tasks} in
7052 your file @file{~/org/gtd.org}.  Also, a date tree in the file
7053 @file{journal.org} should capture journal entries.  A possible configuration
7054 would look like:
7056 @smalllisp
7057 @group
7058 (setq org-capture-templates
7059  '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
7060         "* TODO %?\n  %i\n  %a")
7061    ("j" "Journal" entry (file+datetree "~/org/journal.org")
7062         "* %?\nEntered on %U\n  %i\n  %a")))
7063 @end group
7064 @end smalllisp
7066 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
7067 for you like this:
7068 @example
7069 * TODO
7070   [[file:@var{link to where you initiated capture}]]
7071 @end example
7073 @noindent
7074 During expansion of the template, @code{%a} has been replaced by a link to
7075 the location from where you called the capture command.  This can be
7076 extremely useful for deriving tasks from emails, for example.  You fill in
7077 the task definition, press @kbd{C-c C-c} and Org returns you to the same
7078 place where you started the capture process.
7080 To define special keys to capture to a particular template without going
7081 through the interactive template selection, you can create your key binding
7082 like this:
7084 @lisp
7085 (define-key global-map "\C-cx"
7086    (lambda () (interactive) (org-capture nil "x")))
7087 @end lisp
7089 @menu
7090 * Template elements::           What is needed for a complete template entry
7091 * Template expansion::          Filling in information about time and context
7092 * Templates in contexts::       Only show a template in a specific context
7093 @end menu
7095 @node Template elements
7096 @subsubsection Template elements
7098 Now lets look at the elements of a template definition.  Each entry in
7099 @code{org-capture-templates} is a list with the following items:
7101 @table @var
7102 @item keys
7103 The keys that will select the template, as a string, characters
7104 only, for example @code{"a"} for a template to be selected with a
7105 single key, or @code{"bt"} for selection with two keys.  When using
7106 several keys, keys using the same prefix key must be sequential
7107 in the list and preceded by a 2-element entry explaining the
7108 prefix key, for example
7109 @smalllisp
7110          ("b" "Templates for marking stuff to buy")
7111 @end smalllisp
7112 @noindent If you do not define a template for the @kbd{C} key, this key will
7113 be used to open the customize buffer for this complex variable.
7115 @item description
7116 A short string describing the template, which will be shown during
7117 selection.
7119 @item type
7120 The type of entry, a symbol.  Valid values are:
7122 @table @code
7123 @item entry
7124 An Org mode node, with a headline.  Will be filed as the child of the target
7125 entry or as a top-level entry.  The target file should be an Org mode file.
7126 @item item
7127 A plain list item, placed in the first plain  list at the target
7128 location.  Again the target file should be an Org file.
7129 @item checkitem
7130 A checkbox item.  This only differs from the plain list item by the
7131 default template.
7132 @item table-line
7133 a new line in the first table at the target location.  Where exactly the
7134 line will be inserted depends on the properties @code{:prepend} and
7135 @code{:table-line-pos} (see below).
7136 @item plain
7137 Text to be inserted as it is.
7138 @end table
7140 @item target
7141 @vindex org-default-notes-file
7142 Specification of where the captured item should be placed.  In Org mode
7143 files, targets usually define a node.  Entries will become children of this
7144 node.  Other types will be added to the table or list in the body of this
7145 node.  Most target specifications contain a file name.  If that file name is
7146 the empty string, it defaults to @code{org-default-notes-file}.  A file can
7147 also be given as a variable, function, or Emacs Lisp form.
7149 Valid values are:
7151 @table @code
7152 @item (file "path/to/file")
7153 Text will be placed at the beginning or end of that file.
7155 @item (id "id of existing org entry")
7156 Filing as child of this entry, or in the body of the entry.
7158 @item (file+headline "path/to/file" "node headline")
7159 Fast configuration if the target heading is unique in the file.
7161 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7162 For non-unique headings, the full path is safer.
7164 @item (file+regexp  "path/to/file" "regexp to find location")
7165 Use a regular expression to position the cursor.
7167 @item (file+datetree "path/to/file")
7168 Will create a heading in a date tree for today's date@footnote{Datetree
7169 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7170 and @code{* 2013} in your file, the capture will refile the note to the first
7171 one matched.}.
7173 @item (file+datetree+prompt "path/to/file")
7174 Will create a heading in a date tree, but will prompt for the date.
7176 @item (file+function "path/to/file" function-finding-location)
7177 A function to find the right location in the file.
7179 @item (clock)
7180 File to the entry that is currently being clocked.
7182 @item (function function-finding-location)
7183 Most general way, write your own function to find both
7184 file and location.
7185 @end table
7187 @item template
7188 The template for creating the capture item.  If you leave this empty, an
7189 appropriate default template will be used.  Otherwise this is a string with
7190 escape codes, which will be replaced depending on time and context of the
7191 capture call.  The string with escapes may be loaded from a template file,
7192 using the special syntax @code{(file "path/to/template")}.  See below for
7193 more details.
7195 @item properties
7196 The rest of the entry is a property list of additional options.
7197 Recognized properties are:
7199 @table @code
7200 @item :prepend
7201 Normally new captured information will be appended at
7202 the target location (last child, last table line, last list item...).
7203 Setting this property will change that.
7205 @item :immediate-finish
7206 When set, do not offer to edit the information, just
7207 file it away immediately.  This makes sense if the template only needs
7208 information that can be added automatically.
7210 @item :empty-lines
7211 Set this to the number of lines to insert
7212 before and after the new item.  Default 0, only common other value is 1.
7214 @item :clock-in
7215 Start the clock in this item.
7217 @item :clock-keep
7218 Keep the clock running when filing the captured entry.
7220 @item :clock-resume
7221 If starting the capture interrupted a clock, restart that clock when finished
7222 with the capture.  Note that @code{:clock-keep} has precedence over
7223 @code{:clock-resume}.  When setting both to @code{t}, the current clock will
7224 run and the previous one will not be resumed.
7226 @item :unnarrowed
7227 Do not narrow the target buffer, simply show the full buffer.  Default is to
7228 narrow it so that you only see the new material.
7230 @item :table-line-pos
7231 Specification of the location in the table where the new line should be
7232 inserted. It can be a string, a variable holding a string or a function
7233 returning a string. The string should look like @code{"II-3"} meaning that
7234 the new line should become the third line before the second horizontal
7235 separator line.
7237 @item :kill-buffer
7238 If the target file was not yet visited when capture was invoked, kill the
7239 buffer again after capture is completed.
7240 @end table
7241 @end table
7243 @node Template expansion
7244 @subsubsection Template expansion
7246 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7247 these sequences literally, escape the @kbd{%} with a backslash.} allow
7248 dynamic insertion of content.  The templates are expanded in the order given here:
7250 @smallexample
7251 %[@var{file}]     @r{Insert the contents of the file given by @var{file}.}
7252 %(@var{sexp})     @r{Evaluate Elisp @var{sexp} and replace with the result.}
7253                   @r{For convenience, %:keyword (see below) placeholders}
7254                   @r{within the expression will be expanded prior to this.}
7255                   @r{The sexp must return a string.}
7256 %<...>      @r{The result of format-time-string on the ... format specification.}
7257 %t          @r{Timestamp, date only.}
7258 %T          @r{Timestamp, with date and time.}
7259 %u, %U      @r{Like the above, but inactive timestamps.}
7260 %i          @r{Initial content, the region when capture is called while the}
7261             @r{region is active.}
7262             @r{The entire text will be indented like @code{%i} itself.}
7263 %a          @r{Annotation, normally the link created with @code{org-store-link}.}
7264 %A          @r{Like @code{%a}, but prompt for the description part.}
7265 %l          @r{Like %a, but only insert the literal link.}
7266 %c          @r{Current kill ring head.}
7267 %x          @r{Content of the X clipboard.}
7268 %k          @r{Title of the currently clocked task.}
7269 %K          @r{Link to the currently clocked task.}
7270 %n          @r{User name (taken from @code{user-full-name}).}
7271 %f          @r{File visited by current buffer when org-capture was called.}
7272 %F          @r{Full path of the file or directory visited by current buffer.}
7273 %:keyword   @r{Specific information for certain link types, see below.}
7274 %^g         @r{Prompt for tags, with completion on tags in target file.}
7275 %^G         @r{Prompt for tags, with completion all tags in all agenda files.}
7276 %^t         @r{Like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7277             @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7278 %^C         @r{Interactive selection of which kill or clip to use.}
7279 %^L         @r{Like @code{%^C}, but insert as link.}
7280 %^@{@var{prop}@}p   @r{Prompt the user for a value for property @var{prop}.}
7281 %^@{@var{prompt}@}  @r{prompt the user for a string and replace this sequence with it.}
7282             @r{You may specify a default value and a completion table with}
7283             @r{%^@{prompt|default|completion2|completion3...@}.}
7284             @r{The arrow keys access a prompt-specific history.}
7285 %\n         @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7286             @r{a number, starting from 1.}
7287 %?          @r{After completing the template, position cursor here.}
7288 @end smallexample
7290 @noindent
7291 For specific link types, the following keywords will be
7292 defined@footnote{If you define your own link types (@pxref{Adding
7293 hyperlink types}), any property you store with
7294 @code{org-store-link-props} can be accessed in capture templates in a
7295 similar way.}:
7297 @vindex org-from-is-user-regexp
7298 @smallexample
7299 Link type                        |  Available keywords
7300 ---------------------------------+----------------------------------------------
7301 bbdb                             |  %:name %:company
7302 irc                              |  %:server %:port %:nick
7303 vm, vm-imap, wl, mh, mew, rmail  |  %:type %:subject %:message-id
7304                                  |  %:from %:fromname %:fromaddress
7305                                  |  %:to   %:toname   %:toaddress
7306                                  |  %:date @r{(message date header field)}
7307                                  |  %:date-timestamp @r{(date as active timestamp)}
7308                                  |  %:date-timestamp-inactive @r{(date as inactive timestamp)}
7309                                  |  %: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}.}}
7310 gnus                             |  %:group, @r{for messages also all email fields}
7311 w3, w3m                          |  %:url
7312 info                             |  %:file %:node
7313 calendar                         |  %:date
7314 @end smallexample
7316 @noindent
7317 To place the cursor after template expansion use:
7319 @smallexample
7320 %?          @r{After completing the template, position cursor here.}
7321 @end smallexample
7323 @node Templates in contexts
7324 @subsubsection Templates in contexts
7326 @vindex org-capture-templates-contexts
7327 To control whether a capture template should be accessible from a specific
7328 context, you can customize @code{org-capture-templates-contexts}.  Let's say
7329 for example that you have a capture template @code{"p"} for storing Gnus
7330 emails containing patches.  Then you would configure this option like this:
7332 @smalllisp
7333 (setq org-capture-templates-contexts
7334       '(("p" (in-mode . "message-mode"))))
7335 @end smalllisp
7337 You can also tell that the command key @code{"p"} should refer to another
7338 template.  In that case, add this command key like this:
7340 @smalllisp
7341 (setq org-capture-templates-contexts
7342       '(("p" "q" (in-mode . "message-mode"))))
7343 @end smalllisp
7345 See the docstring of the variable for more information.
7347 @node Attachments
7348 @section Attachments
7349 @cindex attachments
7351 @vindex org-attach-directory
7352 It is often useful to associate reference material with an outline node/task.
7353 Small chunks of plain text can simply be stored in the subtree of a project.
7354 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7355 files that live elsewhere on your computer or in the cloud, like emails or
7356 source code files belonging to a project.  Another method is @i{attachments},
7357 which are files located in a directory belonging to an outline node.  Org
7358 uses directories named by the unique ID of each entry.  These directories are
7359 located in the @file{data} directory which lives in the same directory where
7360 your Org file lives@footnote{If you move entries or Org files from one
7361 directory to another, you may want to configure @code{org-attach-directory}
7362 to contain an absolute path.}.  If you initialize this directory with
7363 @code{git init}, Org will automatically commit changes when it sees them.
7364 The attachment system has been contributed to Org by John Wiegley.
7366 In cases where it seems better to do so, you can also attach a directory of your
7367 choice to an entry.  You can also make children inherit the attachment
7368 directory from a parent, so that an entire subtree uses the same attached
7369 directory.
7371 @noindent The following commands deal with attachments:
7373 @table @kbd
7374 @orgcmd{C-c C-a,org-attach}
7375 The dispatcher for commands related to the attachment system.  After these
7376 keys, a list of commands is displayed and you must press an additional key
7377 to select a command:
7379 @table @kbd
7380 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7381 @vindex org-attach-method
7382 Select a file and move it into the task's attachment directory.  The file
7383 will be copied, moved, or linked, depending on @code{org-attach-method}.
7384 Note that hard links are not supported on all systems.
7386 @kindex C-c C-a c
7387 @kindex C-c C-a m
7388 @kindex C-c C-a l
7389 @item c/m/l
7390 Attach a file using the copy/move/link method.
7391 Note that hard links are not supported on all systems.
7393 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7394 Create a new attachment as an Emacs buffer.
7396 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7397 Synchronize the current task with its attachment directory, in case you added
7398 attachments yourself.
7400 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7401 @vindex org-file-apps
7402 Open current task's attachment.  If there is more than one, prompt for a
7403 file name first.  Opening will follow the rules set by @code{org-file-apps}.
7404 For more details, see the information on following hyperlinks
7405 (@pxref{Handling links}).
7407 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7408 Also open the attachment, but force opening the file in Emacs.
7410 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7411 Open the current task's attachment directory.
7413 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7414 Also open the directory, but force using @command{dired} in Emacs.
7416 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7417 Select and delete a single attachment.
7419 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7420 Delete all of a task's attachments.  A safer way is to open the directory in
7421 @command{dired} and delete from there.
7423 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7424 @cindex property, ATTACH_DIR
7425 Set a specific directory as the entry's attachment directory.  This works by
7426 putting the directory path into the @code{ATTACH_DIR} property.
7428 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7429 @cindex property, ATTACH_DIR_INHERIT
7430 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7431 same directory for attachments as the parent does.
7432 @end table
7433 @end table
7435 @node RSS feeds
7436 @section RSS feeds
7437 @cindex RSS feeds
7438 @cindex Atom feeds
7440 Org can add and change entries based on information found in RSS feeds and
7441 Atom feeds.  You could use this to make a task out of each new podcast in a
7442 podcast feed.  Or you could use a phone-based note-creating service on the
7443 web to import tasks into Org.  To access feeds, configure the variable
7444 @code{org-feed-alist}.  The docstring of this variable has detailed
7445 information.  Here is just an example:
7447 @smalllisp
7448 @group
7449 (setq org-feed-alist
7450      '(("Slashdot"
7451          "http://rss.slashdot.org/Slashdot/slashdot"
7452          "~/txt/org/feeds.org" "Slashdot Entries")))
7453 @end group
7454 @end smalllisp
7456 @noindent
7457 will configure that new items from the feed provided by
7458 @code{rss.slashdot.org} will result in new entries in the file
7459 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7460 the following command is used:
7462 @table @kbd
7463 @orgcmd{C-c C-x g,org-feed-update-all}
7464 @item C-c C-x g
7465 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7466 them.
7467 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7468 Prompt for a feed name and go to the inbox configured for this feed.
7469 @end table
7471 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7472 it will store information about the status of items in the feed, to avoid
7473 adding the same item several times.
7475 For more information, including how to read atom feeds, see
7476 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7478 @node Protocols
7479 @section Protocols for external access
7480 @cindex protocols, for external access
7481 @cindex emacsserver
7483 You can set up Org for handling protocol calls from outside applications that
7484 are passed to Emacs through the @file{emacsserver}.  For example, you can
7485 configure bookmarks in your web browser to send a link to the current page to
7486 Org and create a note from it using capture (@pxref{Capture}).  Or you
7487 could create a bookmark that will tell Emacs to open the local source file of
7488 a remote website you are looking at with the browser.  See
7489 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7490 documentation and setup instructions.
7492 @node Refile and copy
7493 @section Refile and copy
7494 @cindex refiling notes
7495 @cindex copying notes
7497 When reviewing the captured data, you may want to refile or to copy some of
7498 the entries into a different list, for example into a project.  Cutting,
7499 finding the right location, and then pasting the note is cumbersome.  To
7500 simplify this process, you can use the following special command:
7502 @table @kbd
7503 @orgcmd{C-c M-w,org-copy}
7504 @findex org-copy
7505 Copying works like refiling, except that the original note is not deleted.
7506 @orgcmd{C-c C-w,org-refile}
7507 @findex org-refile
7508 @vindex org-reverse-note-order
7509 @vindex org-refile-targets
7510 @vindex org-refile-use-outline-path
7511 @vindex org-outline-path-complete-in-steps
7512 @vindex org-refile-allow-creating-parent-nodes
7513 @vindex org-log-refile
7514 @vindex org-refile-use-cache
7515 @vindex org-refile-keep
7516 Refile the entry or region at point.  This command offers possible locations
7517 for refiling the entry and lets you select one with completion.  The item (or
7518 all items in the region) is filed below the target heading as a subitem.
7519 Depending on @code{org-reverse-note-order}, it will be either the first or
7520 last subitem.@*
7521 By default, all level 1 headlines in the current buffer are considered to be
7522 targets, but you can have more complex definitions across a number of files.
7523 See the variable @code{org-refile-targets} for details.  If you would like to
7524 select a location via a file-path-like completion along the outline path, see
7525 the variables @code{org-refile-use-outline-path} and
7526 @code{org-outline-path-complete-in-steps}.  If you would like to be able to
7527 create new nodes as new parents for refiling on the fly, check the
7528 variable @code{org-refile-allow-creating-parent-nodes}.
7529 When the variable @code{org-log-refile}@footnote{with corresponding
7530 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7531 and @code{nologrefile}} is set, a timestamp or a note will be
7532 recorded when an entry has been refiled.
7533 @orgkey{C-u C-c C-w}
7534 Use the refile interface to jump to a heading.
7535 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7536 Jump to the location where @code{org-refile} last moved a tree to.
7537 @item C-2 C-c C-w
7538 Refile as the child of the item currently being clocked.
7539 @item C-3 C-c C-w
7540 Refile and keep the entry in place.  Also see @code{org-refile-keep} to make
7541 this the default behavior, and beware that this may result in duplicated
7542 @code{ID} properties.
7543 @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}
7544 Clear the target cache.  Caching of refile targets can be turned on by
7545 setting @code{org-refile-use-cache}.  To make the command see new possible
7546 targets, you have to clear the cache with this command.
7547 @end table
7549 @node Archiving
7550 @section Archiving
7551 @cindex archiving
7553 When a project represented by a (sub)tree is finished, you may want
7554 to move the tree out of the way and to stop it from contributing to the
7555 agenda.  Archiving is important to keep your working files compact and global
7556 searches like the construction of agenda views fast.
7558 @table @kbd
7559 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7560 @vindex org-archive-default-command
7561 Archive the current entry using the command specified in the variable
7562 @code{org-archive-default-command}.
7563 @end table
7565 @menu
7566 * Moving subtrees::             Moving a tree to an archive file
7567 * Internal archiving::          Switch off a tree but keep it in the file
7568 @end menu
7570 @node Moving subtrees
7571 @subsection Moving a tree to the archive file
7572 @cindex external archiving
7574 The most common archiving action is to move a project tree to another file,
7575 the archive file.
7577 @table @kbd
7578 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7579 @vindex org-archive-location
7580 Archive the subtree starting at the cursor position to the location
7581 given by @code{org-archive-location}.
7582 @orgkey{C-u C-c C-x C-s}
7583 Check if any direct children of the current headline could be moved to
7584 the archive.  To do this, each subtree is checked for open TODO entries.
7585 If none are found, the command offers to move it to the archive
7586 location.  If the cursor is @emph{not} on a headline when this command
7587 is invoked, the level 1 trees will be checked.
7588 @orgkey{C-u C-u C-c C-x C-s}
7589 As above, but check subtree for timestamps instead of TODO entries.  The
7590 command will offer to archive the subtree if it @emph{does} contain a
7591 timestamp, and that timestamp is in the past.
7592 @end table
7594 @cindex archive locations
7595 The default archive location is a file in the same directory as the
7596 current file, with the name derived by appending @file{_archive} to the
7597 current file name.  You can also choose what heading to file archived
7598 items under, with the possibility to add them to a datetree in a file.
7599 For information and examples on how to specify the file and the heading,
7600 see the documentation string of the variable
7601 @code{org-archive-location}.
7603 There is also an in-buffer option for setting this variable, for example:
7605 @cindex #+ARCHIVE
7606 @example
7607 #+ARCHIVE: %s_done::
7608 @end example
7610 @cindex property, ARCHIVE
7611 @noindent
7612 If you would like to have a special ARCHIVE location for a single entry
7613 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7614 location as the value (@pxref{Properties and columns}).
7616 @vindex org-archive-save-context-info
7617 When a subtree is moved, it receives a number of special properties that
7618 record context information like the file from where the entry came, its
7619 outline path the archiving time etc.  Configure the variable
7620 @code{org-archive-save-context-info} to adjust the amount of information
7621 added.
7624 @node Internal archiving
7625 @subsection Internal archiving
7627 If you want to just switch off (for agenda views) certain subtrees without
7628 moving them to a different file, you can use the @code{ARCHIVE tag}.
7630 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7631 its location in the outline tree, but behaves in the following way:
7632 @itemize @minus
7633 @item
7634 @vindex org-cycle-open-archived-trees
7635 It does not open when you attempt to do so with a visibility cycling
7636 command (@pxref{Visibility cycling}).  You can force cycling archived
7637 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7638 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
7639 @code{show-all} will open archived subtrees.
7640 @item
7641 @vindex org-sparse-tree-open-archived-trees
7642 During sparse tree construction (@pxref{Sparse trees}), matches in
7643 archived subtrees are not exposed, unless you configure the option
7644 @code{org-sparse-tree-open-archived-trees}.
7645 @item
7646 @vindex org-agenda-skip-archived-trees
7647 During agenda view construction (@pxref{Agenda views}), the content of
7648 archived trees is ignored unless you configure the option
7649 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7650 be included.  In the agenda you can press @kbd{v a} to get archives
7651 temporarily included.
7652 @item
7653 @vindex org-export-with-archived-trees
7654 Archived trees are not exported (@pxref{Exporting}), only the headline
7655 is.  Configure the details using the variable
7656 @code{org-export-with-archived-trees}.
7657 @item
7658 @vindex org-columns-skip-archived-trees
7659 Archived trees are excluded from column view unless the variable
7660 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7661 @end itemize
7663 The following commands help manage the ARCHIVE tag:
7665 @table @kbd
7666 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7667 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
7668 the headline changes to a shadowed face, and the subtree below it is
7669 hidden.
7670 @orgkey{C-u C-c C-x a}
7671 Check if any direct children of the current headline should be archived.
7672 To do this, each subtree is checked for open TODO entries.  If none are
7673 found, the command offers to set the ARCHIVE tag for the child.  If the
7674 cursor is @emph{not} on a headline when this command is invoked, the
7675 level 1 trees will be checked.
7676 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7677 Cycle a tree even if it is tagged with ARCHIVE.
7678 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7679 Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
7680 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}.  The
7681 entry becomes a child of that sibling and in this way retains a lot of its
7682 original context, including inherited tags and approximate position in the
7683 outline.
7684 @end table
7687 @node Agenda views
7688 @chapter Agenda views
7689 @cindex agenda views
7691 Due to the way Org works, TODO items, time-stamped items, and
7692 tagged headlines can be scattered throughout a file or even a number of
7693 files.  To get an overview of open action items, or of events that are
7694 important for a particular date, this information must be collected,
7695 sorted and displayed in an organized way.
7697 Org can select items based on various criteria and display them
7698 in a separate buffer.  Seven different view types are provided:
7700 @itemize @bullet
7701 @item
7702 an @emph{agenda} that is like a calendar and shows information
7703 for specific dates,
7704 @item
7705 a @emph{TODO list} that covers all unfinished
7706 action items,
7707 @item
7708 a @emph{match view}, showings headlines based on the tags, properties, and
7709 TODO state associated with them,
7710 @item
7711 a @emph{timeline view} that shows all events in a single Org file,
7712 in time-sorted view,
7713 @item
7714 a @emph{text search view} that shows all entries from multiple files
7715 that contain specified keywords,
7716 @item
7717 a @emph{stuck projects view} showing projects that currently don't move
7718 along, and
7719 @item
7720 @emph{custom views} that are special searches and combinations of different
7721 views.
7722 @end itemize
7724 @noindent
7725 The extracted information is displayed in a special @emph{agenda
7726 buffer}.  This buffer is read-only, but provides commands to visit the
7727 corresponding locations in the original Org files, and even to
7728 edit these files remotely.
7730 @vindex org-agenda-window-setup
7731 @vindex org-agenda-restore-windows-after-quit
7732 Two variables control how the agenda buffer is displayed and whether the
7733 window configuration is restored when the agenda exits:
7734 @code{org-agenda-window-setup} and
7735 @code{org-agenda-restore-windows-after-quit}.
7737 @menu
7738 * Agenda files::                Files being searched for agenda information
7739 * Agenda dispatcher::           Keyboard access to agenda views
7740 * Built-in agenda views::       What is available out of the box?
7741 * Presentation and sorting::    How agenda items are prepared for display
7742 * Agenda commands::             Remote editing of Org trees
7743 * Custom agenda views::         Defining special searches and views
7744 * Exporting agenda views::      Writing a view to a file
7745 * Agenda column view::          Using column view for collected entries
7746 @end menu
7748 @node Agenda files
7749 @section Agenda files
7750 @cindex agenda files
7751 @cindex files for agenda
7753 @vindex org-agenda-files
7754 The information to be shown is normally collected from all @emph{agenda
7755 files}, the files listed in the variable
7756 @code{org-agenda-files}@footnote{If the value of that variable is not a
7757 list, but a single file name, then the list of agenda files will be
7758 maintained in that external file.}.  If a directory is part of this list,
7759 all files with the extension @file{.org} in this directory will be part
7760 of the list.
7762 Thus, even if you only work with a single Org file, that file should
7763 be put into the list@footnote{When using the dispatcher, pressing
7764 @kbd{<} before selecting a command will actually limit the command to
7765 the current file, and ignore @code{org-agenda-files} until the next
7766 dispatcher command.}.  You can customize @code{org-agenda-files}, but
7767 the easiest way to maintain it is through the following commands
7769 @cindex files, adding to agenda list
7770 @table @kbd
7771 @orgcmd{C-c [,org-agenda-file-to-front}
7772 Add current file to the list of agenda files.  The file is added to
7773 the front of the list.  If it was already in the list, it is moved to
7774 the front.  With a prefix argument, file is added/moved to the end.
7775 @orgcmd{C-c ],org-remove-file}
7776 Remove current file from the list of agenda files.
7777 @kindex C-,
7778 @cindex cycling, of agenda files
7779 @orgcmd{C-',org-cycle-agenda-files}
7780 @itemx C-,
7781 Cycle through agenda file list, visiting one file after the other.
7782 @kindex M-x org-iswitchb
7783 @item M-x org-iswitchb RET
7784 Command to use an @code{iswitchb}-like interface to switch to and between Org
7785 buffers.
7786 @end table
7788 @noindent
7789 The Org menu contains the current list of files and can be used
7790 to visit any of them.
7792 If you would like to focus the agenda temporarily on a file not in
7793 this list, or on just one file in the list, or even on only a subtree in a
7794 file, then this can be done in different ways.  For a single agenda command,
7795 you may press @kbd{<} once or several times in the dispatcher
7796 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
7797 extended period, use the following commands:
7799 @table @kbd
7800 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7801 Permanently restrict the agenda to the current subtree.  When with a
7802 prefix argument, or with the cursor before the first headline in a file,
7803 the agenda scope is set to the entire file.  This restriction remains in
7804 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7805 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
7806 agenda view, the new restriction takes effect immediately.
7807 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7808 Remove the permanent restriction created by @kbd{C-c C-x <}.
7809 @end table
7811 @noindent
7812 When working with @file{speedbar.el}, you can use the following commands in
7813 the Speedbar frame:
7815 @table @kbd
7816 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7817 Permanently restrict the agenda to the item---either an Org file or a subtree
7818 in such a file---at the cursor in the Speedbar frame.
7819 If there is a window displaying an agenda view, the new restriction takes
7820 effect immediately.
7821 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7822 Lift the restriction.
7823 @end table
7825 @node Agenda dispatcher
7826 @section The agenda dispatcher
7827 @cindex agenda dispatcher
7828 @cindex dispatching agenda commands
7829 The views are created through a dispatcher, which should be bound to a
7830 global key---for example @kbd{C-c a} (@pxref{Activation}).  In the
7831 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7832 is accessed and list keyboard access to commands accordingly.  After
7833 pressing @kbd{C-c a}, an additional letter is required to execute a
7834 command.  The dispatcher offers the following default commands:
7836 @table @kbd
7837 @item a
7838 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7839 @item t @r{/} T
7840 Create a list of all TODO items (@pxref{Global TODO list}).
7841 @item m @r{/} M
7842 Create a list of headlines matching a TAGS expression (@pxref{Matching
7843 tags and properties}).
7844 @item L
7845 Create the timeline view for the current buffer (@pxref{Timeline}).
7846 @item s
7847 Create a list of entries selected by a boolean expression of keywords
7848 and/or regular expressions that must or must not occur in the entry.
7849 @item /
7850 @vindex org-agenda-text-search-extra-files
7851 Search for a regular expression in all agenda files and additionally in
7852 the files listed in @code{org-agenda-text-search-extra-files}.  This
7853 uses the Emacs command @code{multi-occur}.  A prefix argument can be
7854 used to specify the number of context lines for each match, default is
7856 @item # @r{/} !
7857 Create a list of stuck projects (@pxref{Stuck projects}).
7858 @item <
7859 Restrict an agenda command to the current buffer@footnote{For backward
7860 compatibility, you can also press @kbd{1} to restrict to the current
7861 buffer.}.  After pressing @kbd{<}, you still need to press the character
7862 selecting the command.
7863 @item < <
7864 If there is an active region, restrict the following agenda command to
7865 the region.  Otherwise, restrict it to the current subtree@footnote{For
7866 backward compatibility, you can also press @kbd{0} to restrict to the
7867 current region/subtree.}.  After pressing @kbd{< <}, you still need to press the
7868 character selecting the command.
7870 @item *
7871 @cindex agenda, sticky
7872 @vindex org-agenda-sticky
7873 Toggle sticky agenda views.  By default, Org maintains only a single agenda
7874 buffer and rebuilds it each time you change the view, to make sure everything
7875 is always up to date.  If you often switch between agenda views and the build
7876 time bothers you, you can turn on sticky agenda buffers or make this the
7877 default by customizing the variable @code{org-agenda-sticky}.  With sticky
7878 agendas, the agenda dispatcher will not recreate agenda views from scratch,
7879 it will only switch to the selected one, and you need to update the agenda by
7880 hand with @kbd{r} or @kbd{g} when needed.  You can toggle sticky agenda view
7881 any time with @code{org-toggle-sticky-agenda}.
7882 @end table
7884 You can also define custom commands that will be accessible through the
7885 dispatcher, just like the default commands.  This includes the
7886 possibility to create extended agenda buffers that contain several
7887 blocks together, for example the weekly agenda, the global TODO list and
7888 a number of special tags matches.  @xref{Custom agenda views}.
7890 @node Built-in agenda views
7891 @section The built-in agenda views
7893 In this section we describe the built-in views.
7895 @menu
7896 * Weekly/daily agenda::         The calendar page with current tasks
7897 * Global TODO list::            All unfinished action items
7898 * Matching tags and properties::  Structured information with fine-tuned search
7899 * Timeline::                    Time-sorted view for single file
7900 * Search view::                 Find entries by searching for text
7901 * Stuck projects::              Find projects you need to review
7902 @end menu
7904 @node Weekly/daily agenda
7905 @subsection The weekly/daily agenda
7906 @cindex agenda
7907 @cindex weekly agenda
7908 @cindex daily agenda
7910 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7911 paper agenda, showing all the tasks for the current week or day.
7913 @table @kbd
7914 @cindex org-agenda, command
7915 @orgcmd{C-c a a,org-agenda-list}
7916 Compile an agenda for the current week from a list of Org files.  The agenda
7917 shows the entries for each day.  With a numeric prefix@footnote{For backward
7918 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7919 listed before the agenda.  This feature is deprecated, use the dedicated TODO
7920 list, or a block agenda instead (@pxref{Block agenda}).}  (like @kbd{C-u 2 1
7921 C-c a a}) you may set the number of days to be displayed.
7922 @end table
7924 @vindex org-agenda-span
7925 @vindex org-agenda-ndays
7926 @vindex org-agenda-start-day
7927 @vindex org-agenda-start-on-weekday
7928 The default number of days displayed in the agenda is set by the variable
7929 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}).  This
7930 variable can be set to any number of days you want to see by default in the
7931 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7932 @code{year}.  For weekly agendas, the default is to start on the previous
7933 monday (see @code{org-agenda-start-on-weekday}).  You can also set the start
7934 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7935 start the agenda ten days from today in the future.
7937 Remote editing from the agenda buffer means, for example, that you can
7938 change the dates of deadlines and appointments from the agenda buffer.
7939 The commands available in the Agenda buffer are listed in @ref{Agenda
7940 commands}.
7942 @subsubheading Calendar/Diary integration
7943 @cindex calendar integration
7944 @cindex diary integration
7946 Emacs contains the calendar and diary by Edward M. Reingold.  The
7947 calendar displays a three-month calendar with holidays from different
7948 countries and cultures.  The diary allows you to keep track of
7949 anniversaries, lunar phases, sunrise/set, recurrent appointments
7950 (weekly, monthly) and more.  In this way, it is quite complementary to
7951 Org.  It can be very useful to combine output from Org with
7952 the diary.
7954 In order to include entries from the Emacs diary into Org mode's
7955 agenda, you only need to customize the variable
7957 @lisp
7958 (setq org-agenda-include-diary t)
7959 @end lisp
7961 @noindent After that, everything will happen automatically.  All diary
7962 entries including holidays, anniversaries, etc., will be included in the
7963 agenda buffer created by Org mode.  @key{SPC}, @key{TAB}, and
7964 @key{RET} can be used from the agenda buffer to jump to the diary
7965 file in order to edit existing diary entries.  The @kbd{i} command to
7966 insert new entries for the current date works in the agenda buffer, as
7967 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7968 Sunrise/Sunset times, show lunar phases and to convert to other
7969 calendars, respectively.  @kbd{c} can be used to switch back and forth
7970 between calendar and agenda.
7972 If you are using the diary only for sexp entries and holidays, it is
7973 faster to not use the above setting, but instead to copy or even move
7974 the entries into an Org file.  Org mode evaluates diary-style sexp
7975 entries, and does it faster because there is no overhead for first
7976 creating the diary display.  Note that the sexp entries must start at
7977 the left margin, no whitespace is allowed before them.  For example,
7978 the following segment of an Org file will be processed and entries
7979 will be made in the agenda:
7981 @example
7982 * Holidays
7983   :PROPERTIES:
7984   :CATEGORY: Holiday
7985   :END:
7986 %%(org-calendar-holiday)   ; special function for holiday names
7988 * Birthdays
7989   :PROPERTIES:
7990   :CATEGORY: Ann
7991   :END:
7992 %%(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
7993 %%(org-anniversary 1869 10  2) Mahatma Gandhi would be %d years old
7994 @end example
7996 @subsubheading Anniversaries from BBDB
7997 @cindex BBDB, anniversaries
7998 @cindex anniversaries, from BBDB
8000 If you are using the Big Brothers Database to store your contacts, you will
8001 very likely prefer to store anniversaries in BBDB rather than in a
8002 separate Org or diary file.  Org supports this and will show BBDB
8003 anniversaries as part of the agenda.  All you need to do is to add the
8004 following to one of your agenda files:
8006 @example
8007 * Anniversaries
8008   :PROPERTIES:
8009   :CATEGORY: Anniv
8010   :END:
8011 %%(org-bbdb-anniversaries)
8012 @end example
8014 You can then go ahead and define anniversaries for a BBDB record.  Basically,
8015 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
8016 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
8017 followed by a space and the class of the anniversary (@samp{birthday} or
8018 @samp{wedding}, or a format string).  If you omit the class, it will default to
8019 @samp{birthday}.  Here are a few examples, the header for the file
8020 @file{org-bbdb.el} contains more detailed information.
8022 @example
8023 1973-06-22
8024 06-22
8025 1955-08-02 wedding
8026 2008-04-14 %s released version 6.01 of org mode, %d years ago
8027 @end example
8029 After a change to BBDB, or for the first agenda display during an Emacs
8030 session, the agenda display will suffer a short delay as Org updates its
8031 hash with anniversaries.  However, from then on things will be very fast---much
8032 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
8033 in an Org or Diary file.
8035 @subsubheading Appointment reminders
8036 @cindex @file{appt.el}
8037 @cindex appointment reminders
8038 @cindex appointment
8039 @cindex reminders
8041 Org can interact with Emacs appointments notification facility.  To add the
8042 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
8043 This command lets you filter through the list of your appointments and add
8044 only those belonging to a specific category or matching a regular expression.
8045 It also reads a @code{APPT_WARNTIME} property which will then override the
8046 value of @code{appt-message-warning-time} for this appointment.  See the
8047 docstring for details.
8049 @node Global TODO list
8050 @subsection The global TODO list
8051 @cindex global TODO list
8052 @cindex TODO list, global
8054 The global TODO list contains all unfinished TODO items formatted and
8055 collected into a single place.
8057 @table @kbd
8058 @orgcmd{C-c a t,org-todo-list}
8059 Show the global TODO list.  This collects the TODO items from all agenda
8060 files (@pxref{Agenda views}) into a single buffer.  By default, this lists
8061 items with a state the is not a DONE state.  The buffer is in
8062 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
8063 entries directly from that buffer (@pxref{Agenda commands}).
8064 @orgcmd{C-c a T,org-todo-list}
8065 @cindex TODO keyword matching
8066 @vindex org-todo-keywords
8067 Like the above, but allows selection of a specific TODO keyword.  You can
8068 also do this by specifying a prefix argument to @kbd{C-c a t}.  You are
8069 prompted for a keyword, and you may also specify several keywords by
8070 separating them with @samp{|} as the boolean OR operator.  With a numeric
8071 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
8072 @kindex r
8073 The @kbd{r} key in the agenda buffer regenerates it, and you can give
8074 a prefix argument to this command to change the selected TODO keyword,
8075 for example @kbd{3 r}.  If you often need a search for a specific
8076 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
8077 Matching specific TODO keywords can also be done as part of a tags
8078 search (@pxref{Tag searches}).
8079 @end table
8081 Remote editing of TODO items means that you can change the state of a
8082 TODO entry with a single key press.  The commands available in the
8083 TODO list are described in @ref{Agenda commands}.
8085 @cindex sublevels, inclusion into TODO list
8086 Normally the global TODO list simply shows all headlines with TODO
8087 keywords.  This list can become very long.  There are two ways to keep
8088 it more compact:
8089 @itemize @minus
8090 @item
8091 @vindex org-agenda-todo-ignore-scheduled
8092 @vindex org-agenda-todo-ignore-deadlines
8093 @vindex org-agenda-todo-ignore-timestamp
8094 @vindex org-agenda-todo-ignore-with-date
8095 Some people view a TODO item that has been @emph{scheduled} for execution or
8096 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
8097 Configure the variables @code{org-agenda-todo-ignore-scheduled},
8098 @code{org-agenda-todo-ignore-deadlines},
8099 @code{org-agenda-todo-ignore-timestamp} and/or
8100 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
8101 TODO list.
8102 @item
8103 @vindex org-agenda-todo-list-sublevels
8104 TODO items may have sublevels to break up the task into subtasks.  In
8105 such cases it may be enough to list only the highest level TODO headline
8106 and omit the sublevels from the global list.  Configure the variable
8107 @code{org-agenda-todo-list-sublevels} to get this behavior.
8108 @end itemize
8110 @node Matching tags and properties
8111 @subsection Matching tags and properties
8112 @cindex matching, of tags
8113 @cindex matching, of properties
8114 @cindex tags view
8115 @cindex match view
8117 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
8118 or have properties (@pxref{Properties and columns}), you can select headlines
8119 based on this metadata and collect them into an agenda buffer.  The match
8120 syntax described here also applies when creating sparse trees with @kbd{C-c /
8123 @table @kbd
8124 @orgcmd{C-c a m,org-tags-view}
8125 Produce a list of all headlines that match a given set of tags.  The
8126 command prompts for a selection criterion, which is a boolean logic
8127 expression with tags, like @samp{+work+urgent-withboss} or
8128 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
8129 define a custom command for it (@pxref{Agenda dispatcher}).
8130 @orgcmd{C-c a M,org-tags-view}
8131 @vindex org-tags-match-list-sublevels
8132 @vindex org-agenda-tags-todo-honor-ignore-options
8133 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
8134 not-DONE state and force checking subitems (see variable
8135 @code{org-tags-match-list-sublevels}).  To exclude scheduled/deadline items,
8136 see the variable @code{org-agenda-tags-todo-honor-ignore-options}.  Matching
8137 specific TODO keywords together with a tags match is also possible, see
8138 @ref{Tag searches}.
8139 @end table
8141 The commands available in the tags list are described in @ref{Agenda
8142 commands}.
8144 @subsubheading Match syntax
8146 @cindex Boolean logic, for tag/property searches
8147 A search string can use Boolean operators @samp{&} for @code{AND} and
8148 @samp{|} for @code{OR}@.  @samp{&} binds more strongly than @samp{|}.
8149 Parentheses are not implemented.  Each element in the search is either a
8150 tag, a regular expression matching tags, or an expression like
8151 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8152 property value.  Each element may be preceded by @samp{-}, to select
8153 against it, and @samp{+} is syntactic sugar for positive selection.  The
8154 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8155 present.  Here are some examples, using only tags.
8157 @table @samp
8158 @item work
8159 Select headlines tagged @samp{:work:}.
8160 @item work&boss
8161 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8162 @item +work-boss
8163 Select headlines tagged @samp{:work:}, but discard those also tagged
8164 @samp{:boss:}.
8165 @item work|laptop
8166 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8167 @item work|laptop+night
8168 Like before, but require the @samp{:laptop:} lines to be tagged also
8169 @samp{:night:}.
8170 @end table
8172 @cindex regular expressions, with tags search
8173 Instead of a tag, you may also specify a regular expression enclosed in curly
8174 braces.  For example,
8175 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8176 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8178 @cindex group tags, as regular expressions
8179 Group tags (@pxref{Tag hierarchy}) are expanded as regular expressions.  E.g.,
8180 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8181 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8182 and searching for @samp{-work} will search for all headlines but those with
8183 one of the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8185 @cindex TODO keyword matching, with tags search
8186 @cindex level, require for tags/property match
8187 @cindex category, require for tags/property match
8188 @vindex org-odd-levels-only
8189 You may also test for properties (@pxref{Properties and columns}) at the same
8190 time as matching tags.  The properties may be real properties, or special
8191 properties that represent other metadata (@pxref{Special properties}).  For
8192 example, the ``property'' @code{TODO} represents the TODO keyword of the
8193 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8194 the entry.
8196 In addition to the @ref{Special properties}, one other ``property'' can also
8197 be used. @code{LEVEL} represents the level of an entry.  So a search
8198 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8199 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8200 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8201 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8203 Here are more examples:
8205 @table @samp
8206 @item work+TODO="WAITING"
8207 Select @samp{:work:}-tagged TODO lines with the specific TODO
8208 keyword @samp{WAITING}.
8209 @item work+TODO="WAITING"|home+TODO="WAITING"
8210 Waiting tasks both at work and at home.
8211 @end table
8213 When matching properties, a number of different operators can be used to test
8214 the value of a property.  Here is a complex example:
8216 @example
8217 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
8218          +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8219 @end example
8221 @noindent
8222 The type of comparison will depend on how the comparison value is written:
8223 @itemize @minus
8224 @item
8225 If the comparison value is a plain number, a numerical comparison is done,
8226 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8227 @samp{>=}, and @samp{<>}.
8228 @item
8229 If the comparison value is enclosed in double-quotes,
8230 a string comparison is done, and the same operators are allowed.
8231 @item
8232 If the comparison value is enclosed in double-quotes @emph{and} angular
8233 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8234 assumed to be date/time specifications in the standard Org way, and the
8235 comparison will be done accordingly.  Special values that will be recognized
8236 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8237 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8238 specification.  Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8239 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8240 respectively, can be used.
8241 @item
8242 If the comparison value is enclosed
8243 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8244 regexp matches the property value, and @samp{<>} meaning that it does not
8245 match.
8246 @end itemize
8248 So the search string in the example finds entries tagged @samp{:work:} but
8249 not @samp{:boss:}, which also have a priority value @samp{A}, a
8250 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8251 property that is numerically smaller than 2, a @samp{:With:} property that is
8252 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8253 on or after October 11, 2008.
8255 You can configure Org mode to use property inheritance during a search, but
8256 beware that this can slow down searches considerably.  See @ref{Property
8257 inheritance}, for details.
8259 For backward compatibility, and also for typing speed, there is also a
8260 different way to test TODO states in a search.  For this, terminate the
8261 tags/property part of the search string (which may include several terms
8262 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8263 expression just for TODO keywords.  The syntax is then similar to that for
8264 tags, but should be applied with care: for example, a positive selection on
8265 several TODO keywords cannot meaningfully be combined with boolean AND@.
8266 However, @emph{negative selection} combined with AND can be meaningful.  To
8267 make sure that only lines are checked that actually have any TODO keyword
8268 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8269 part after the slash with @samp{!}.  Using @kbd{C-c a M} or @samp{/!} will
8270 not match TODO keywords in a DONE state.  Examples:
8272 @table @samp
8273 @item work/WAITING
8274 Same as @samp{work+TODO="WAITING"}
8275 @item work/!-WAITING-NEXT
8276 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8277 nor @samp{NEXT}
8278 @item work/!+WAITING|+NEXT
8279 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8280 @samp{NEXT}.
8281 @end table
8283 @node Timeline
8284 @subsection Timeline for a single file
8285 @cindex timeline, single file
8286 @cindex time-sorted view
8288 The timeline summarizes all time-stamped items from a single Org mode
8289 file in a @emph{time-sorted view}.  The main purpose of this command is
8290 to give an overview over events in a project.
8292 @table @kbd
8293 @orgcmd{C-c a L,org-timeline}
8294 Show a time-sorted view of the Org file, with all time-stamped items.
8295 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8296 (scheduled or not) are also listed under the current date.
8297 @end table
8299 @noindent
8300 The commands available in the timeline buffer are listed in
8301 @ref{Agenda commands}.
8303 @node Search view
8304 @subsection Search view
8305 @cindex search view
8306 @cindex text search
8307 @cindex searching, for text
8309 This agenda view is a general text search facility for Org mode entries.
8310 It is particularly useful to find notes.
8312 @table @kbd
8313 @orgcmd{C-c a s,org-search-view}
8314 This is a special search that lets you select entries by matching a substring
8315 or specific words using a boolean logic.
8316 @end table
8317 For example, the search string @samp{computer equipment} will find entries
8318 that contain @samp{computer equipment} as a substring.  If the two words are
8319 separated by more space or a line break, the search will still match.
8320 Search view can also search for specific keywords in the entry, using Boolean
8321 logic.  The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8322 will search for note entries that contain the keywords @code{computer}
8323 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8324 not matched by the regular expression @code{8\.11[bg]}, meaning to
8325 exclude both 8.11b and 8.11g.  The first @samp{+} is necessary to turn on
8326 word search, other @samp{+} characters are optional.  For more details, see
8327 the docstring of the command @code{org-search-view}.
8329 @vindex org-agenda-text-search-extra-files
8330 Note that in addition to the agenda files, this command will also search
8331 the files listed in @code{org-agenda-text-search-extra-files}.
8333 @node Stuck projects
8334 @subsection Stuck projects
8335 @pindex GTD, Getting Things Done
8337 If you are following a system like David Allen's GTD to organize your
8338 work, one of the ``duties'' you have is a regular review to make sure
8339 that all projects move along.  A @emph{stuck} project is a project that
8340 has no defined next actions, so it will never show up in the TODO lists
8341 Org mode produces.  During the review, you need to identify such
8342 projects and define next actions for them.
8344 @table @kbd
8345 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8346 List projects that are stuck.
8347 @kindex C-c a !
8348 @item C-c a !
8349 @vindex org-stuck-projects
8350 Customize the variable @code{org-stuck-projects} to define what a stuck
8351 project is and how to find it.
8352 @end table
8354 You almost certainly will have to configure this view before it will
8355 work for you.  The built-in default assumes that all your projects are
8356 level-2 headlines, and that a project is not stuck if it has at least
8357 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8359 Let's assume that you, in your own way of using Org mode, identify
8360 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8361 indicate a project that should not be considered yet.  Let's further
8362 assume that the TODO keyword DONE marks finished projects, and that NEXT
8363 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
8364 is a next action even without the NEXT tag.  Finally, if the project
8365 contains the special word IGNORE anywhere, it should not be listed
8366 either.  In this case you would start by identifying eligible projects
8367 with a tags/todo match@footnote{@xref{Tag searches}.}
8368 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8369 IGNORE in the subtree to identify projects that are not stuck.  The
8370 correct customization for this is
8372 @lisp
8373 (setq org-stuck-projects
8374       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8375                                "\\<IGNORE\\>"))
8376 @end lisp
8378 Note that if a project is identified as non-stuck, the subtree of this entry
8379 will still be searched for stuck projects.
8381 @node Presentation and sorting
8382 @section Presentation and sorting
8383 @cindex presentation, of agenda items
8385 @vindex org-agenda-prefix-format
8386 @vindex org-agenda-tags-column
8387 Before displaying items in an agenda view, Org mode visually prepares the
8388 items and sorts them.  Each item occupies a single line.  The line starts
8389 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8390 of the item and other important information.  You can customize in which
8391 column tags will be displayed through @code{org-agenda-tags-column}.  You can
8392 also customize the prefix using the option @code{org-agenda-prefix-format}.
8393 This prefix is followed by a cleaned-up version of the outline headline
8394 associated with the item.
8396 @menu
8397 * Categories::                  Not all tasks are equal
8398 * Time-of-day specifications::  How the agenda knows the time
8399 * Sorting agenda items::        The order of things
8400 * Filtering/limiting agenda items::  Dynamically narrow the agenda
8401 @end menu
8403 @node Categories
8404 @subsection Categories
8406 @cindex category
8407 @cindex #+CATEGORY
8408 The category is a broad label assigned to each agenda item.  By default, the
8409 category is simply derived from the file name, but you can also specify it
8410 with a special line in the buffer, like this:
8412 @example
8413 #+CATEGORY: Thesis
8414 @end example
8416 @noindent
8417 @cindex property, CATEGORY
8418 If you would like to have a special CATEGORY for a single entry or a
8419 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8420 special category you want to apply as the value.
8422 @noindent
8423 The display in the agenda buffer looks best if the category is not
8424 longer than 10 characters.
8426 @noindent
8427 You can set up icons for category by customizing the
8428 @code{org-agenda-category-icon-alist} variable.
8430 @node Time-of-day specifications
8431 @subsection Time-of-day specifications
8432 @cindex time-of-day specification
8434 Org mode checks each agenda item for a time-of-day specification.  The
8435 time can be part of the timestamp that triggered inclusion into the
8436 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
8437 ranges can be specified with two timestamps, like
8439 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8441 In the headline of the entry itself, a time(range) may also appear as
8442 plain text (like @samp{12:45} or a @samp{8:30-1pm}).  If the agenda
8443 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8444 specifications in diary entries are recognized as well.
8446 For agenda display, Org mode extracts the time and displays it in a
8447 standard 24 hour format as part of the prefix.  The example times in
8448 the previous paragraphs would end up in the agenda like this:
8450 @example
8451     8:30-13:00 Arthur Dent lies in front of the bulldozer
8452    12:45...... Ford Prefect arrives and takes Arthur to the pub
8453    19:00...... The Vogon reads his poem
8454    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8455 @end example
8457 @cindex time grid
8458 If the agenda is in single-day mode, or for the display of today, the
8459 timed entries are embedded in a time grid, like
8461 @example
8462     8:00...... ------------------
8463     8:30-13:00 Arthur Dent lies in front of the bulldozer
8464    10:00...... ------------------
8465    12:00...... ------------------
8466    12:45...... Ford Prefect arrives and takes Arthur to the pub
8467    14:00...... ------------------
8468    16:00...... ------------------
8469    18:00...... ------------------
8470    19:00...... The Vogon reads his poem
8471    20:00...... ------------------
8472    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8473 @end example
8475 @vindex org-agenda-use-time-grid
8476 @vindex org-agenda-time-grid
8477 The time grid can be turned on and off with the variable
8478 @code{org-agenda-use-time-grid}, and can be configured with
8479 @code{org-agenda-time-grid}.
8481 @node Sorting agenda items
8482 @subsection Sorting agenda items
8483 @cindex sorting, of agenda items
8484 @cindex priorities, of agenda items
8485 Before being inserted into a view, the items are sorted.  How this is
8486 done depends on the type of view.
8487 @itemize @bullet
8488 @item
8489 @vindex org-agenda-files
8490 For the daily/weekly agenda, the items for each day are sorted.  The
8491 default order is to first collect all items containing an explicit
8492 time-of-day specification.  These entries will be shown at the beginning
8493 of the list, as a @emph{schedule} for the day.  After that, items remain
8494 grouped in categories, in the sequence given by @code{org-agenda-files}.
8495 Within each category, items are sorted by priority (@pxref{Priorities}),
8496 which is composed of the base priority (2000 for priority @samp{A}, 1000
8497 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8498 overdue scheduled or deadline items.
8499 @item
8500 For the TODO list, items remain in the order of categories, but within
8501 each category, sorting takes place according to priority
8502 (@pxref{Priorities}).  The priority used for sorting derives from the
8503 priority cookie, with additions depending on how close an item is to its due
8504 or scheduled date.
8505 @item
8506 For tags matches, items are not sorted at all, but just appear in the
8507 sequence in which they are found in the agenda files.
8508 @end itemize
8510 @vindex org-agenda-sorting-strategy
8511 Sorting can be customized using the variable
8512 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8513 the estimated effort of an entry (@pxref{Effort estimates}).
8515 @node Filtering/limiting agenda items
8516 @subsection Filtering/limiting agenda items
8518 Agenda built-in or customized commands are statically defined.  Agenda
8519 filters and limits provide two ways of dynamically narrowing down the list of
8520 agenda entries: @emph{filters} and @emph{limits}.  Filters only act on the
8521 display of the items, while limits take effect before the list of agenda
8522 entries is built.  Filters are more often used interactively, while limits are
8523 mostly useful when defined as local variables within custom agenda commands.
8525 @subsubheading Filtering in the agenda
8526 @cindex filtering, by tag, category, top headline and effort, in agenda
8527 @cindex tag filtering, in agenda
8528 @cindex category filtering, in agenda
8529 @cindex top headline filtering, in agenda
8530 @cindex effort filtering, in agenda
8531 @cindex query editing, in agenda
8533 @table @kbd
8534 @orgcmd{/,org-agenda-filter-by-tag}
8535 @vindex org-agenda-tag-filter-preset
8536 Filter the agenda view with respect to a tag and/or effort estimates.  The
8537 difference between this and a custom agenda command is that filtering is very
8538 fast, so that you can switch quickly between different filters without having
8539 to recreate the agenda.@footnote{Custom commands can preset a filter by
8540 binding the variable @code{org-agenda-tag-filter-preset} as an option.  This
8541 filter will then be applied to the view and persist as a basic filter through
8542 refreshes and more secondary filtering.  The filter is a global property of
8543 the entire agenda view---in a block agenda, you should only set this in the
8544 global options section, not in the section of an individual block.}
8546 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8547 all.  Pressing @key{TAB} at that prompt will offer use completion to select a
8548 tag (including any tags that do not have a selection character).  The command
8549 then hides all entries that do not contain or inherit this tag.  When called
8550 with prefix arg, remove the entries that @emph{do} have the tag.  A second
8551 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8552 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8553 will be narrowed by requiring or forbidding the selected additional tag.
8554 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8555 immediately use the @kbd{\} command.
8557 Org also supports automatic, context-aware tag filtering.  If the variable
8558 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8559 that function can decide which tags should be excluded from the agenda
8560 automatically.  Once this is set, the @kbd{/} command then accepts @kbd{RET}
8561 as a sub-option key and runs the auto exclusion logic.  For example, let's
8562 say you use a @code{Net} tag to identify tasks which need network access, an
8563 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8564 calls.  You could auto-exclude these tags based on the availability of the
8565 Internet, and outside of business hours, with something like this:
8567 @smalllisp
8568 @group
8569 (defun org-my-auto-exclude-function (tag)
8570   (and (cond
8571         ((string= tag "Net")
8572          (/= 0 (call-process "/sbin/ping" nil nil nil
8573                              "-c1" "-q" "-t1" "mail.gnu.org")))
8574         ((or (string= tag "Errand") (string= tag "Call"))
8575          (let ((hour (nth 2 (decode-time))))
8576            (or (< hour 8) (> hour 21)))))
8577        (concat "-" tag)))
8579 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8580 @end group
8581 @end smalllisp
8583 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8584 Narrow the current agenda filter by an additional condition.  When called with
8585 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8586 the effort criterion.  You can achieve the same effect by pressing @kbd{+} or
8587 @kbd{-} as the first key after the @kbd{/} command.
8590 @kindex [
8591 @kindex ]
8592 @kindex @{
8593 @kindex @}
8594 @item [ ] @{ @}
8595 @table @i
8596 @item @r{in} search view
8597 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8598 (@kbd{@{} and @kbd{@}}) to the query string.  The opening bracket/brace will
8599 add a positive search term prefixed by @samp{+}, indicating that this search
8600 term @i{must} occur/match in the entry.  The closing bracket/brace will add a
8601 negative search term which @i{must not} occur/match in the entry for it to be
8602 selected.
8603 @end table
8605 @orgcmd{<,org-agenda-filter-by-category}
8606 @vindex org-agenda-category-filter-preset
8608 Filter the current agenda view with respect to the category of the item at
8609 point.  Pressing @code{<} another time will remove this filter.  You can add
8610 a filter preset through the option @code{org-agenda-category-filter-preset}
8611 (see below.)
8613 @orgcmd{^,org-agenda-filter-by-top-headline}
8614 Filter the current agenda view and only display the siblings and the parent
8615 headline of the one at point.
8617 @orgcmd{=,org-agenda-filter-by-regexp}
8618 @vindex org-agenda-regexp-filter-preset
8620 Filter the agenda view by a regular expression: only show agenda entries
8621 matching the regular expression the user entered.  When called with a prefix
8622 argument, it will filter @emph{out} entries matching the regexp.  With two
8623 universal prefix arguments, it will remove all the regexp filters, which can
8624 be accumulated.  You can add a filter preset through the option
8625 @code{org-agenda-category-filter-preset} (see below.)
8627 @orgcmd{_,org-agenda-filter-by-effort}
8628 @vindex org-agenda-effort-filter-preset
8629 @vindex org-sort-agenda-noeffort-is-high
8630 Filter the agenda view with respect to effort estimates.  
8631 You first need to set up allowed efforts globally, for example
8632 @lisp
8633 (setq org-global-properties
8634     '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8635 @end lisp
8636 You can then filter for an effort by first typing an operator, one of
8637 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8638 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8639 The filter will then restrict to entries with effort smaller-or-equal, equal,
8640 or larger-or-equal than the selected value.  For application of the operator,
8641 entries without a defined effort will be treated according to the value of
8642 @code{org-sort-agenda-noeffort-is-high}.
8644 @orgcmd{|,org-agenda-filter-remove-all}
8645 Remove all filters in the current agenda view.
8646 @end table
8648 @subsubheading Setting limits for the agenda
8649 @cindex limits, in agenda
8650 @vindex org-agenda-max-entries
8651 @vindex org-agenda-max-effort
8652 @vindex org-agenda-max-todos
8653 @vindex org-agenda-max-tags
8655 Here is a list of options that you can set, either globally, or locally in
8656 your custom agenda views (@pxref{Custom agenda views}).
8658 @table @code
8659 @item org-agenda-max-entries
8660 Limit the number of entries.
8661 @item org-agenda-max-effort
8662 Limit the duration of accumulated efforts (as minutes).
8663 @item org-agenda-max-todos
8664 Limit the number of entries with TODO keywords.
8665 @item org-agenda-max-tags
8666 Limit the number of tagged entries.
8667 @end table
8669 When set to a positive integer, each option will exclude entries from other
8670 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8671 the agenda to 100 minutes of effort and exclude any entry that has no effort
8672 property.  If you want to include entries with no effort property, use a
8673 negative value for @code{org-agenda-max-effort}.
8675 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8676 command.  For example, this custom command will display the next five entries
8677 with a @code{NEXT} TODO keyword.
8679 @smalllisp
8680 (setq org-agenda-custom-commands
8681       '(("n" todo "NEXT"
8682          ((org-agenda-max-entries 5)))))
8683 @end smalllisp
8685 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8686 will again the next five entries again, including the first entry that was
8687 excluded so far.
8689 You can also dynamically set temporary limits, which will be lost when
8690 rebuilding the agenda:
8692 @table @kbd
8693 @orgcmd{~,org-agenda-limit-interactively}
8694 This prompts for the type of limit to apply and its value.
8695 @end table
8697 @node Agenda commands
8698 @section Commands in the agenda buffer
8699 @cindex commands, in agenda buffer
8701 Entries in the agenda buffer are linked back to the Org file or diary
8702 file where they originate.  You are not allowed to edit the agenda
8703 buffer itself, but commands are provided to show and jump to the
8704 original entry location, and to edit the Org files ``remotely'' from
8705 the agenda buffer.  In this way, all information is stored only once,
8706 removing the risk that your agenda and note files may diverge.
8708 Some commands can be executed with mouse clicks on agenda lines.  For
8709 the other commands, the cursor needs to be in the desired line.
8711 @table @kbd
8712 @tsubheading{Motion}
8713 @cindex motion commands in agenda
8714 @orgcmd{n,org-agenda-next-line}
8715 Next line (same as @key{down} and @kbd{C-n}).
8716 @orgcmd{p,org-agenda-previous-line}
8717 Previous line (same as @key{up} and @kbd{C-p}).
8718 @orgcmd{N,org-agenda-next-item}
8719 Next item: same as next line, but only consider items.
8720 @orgcmd{P,org-agenda-previous-item}
8721 Previous item: same as previous line, but only consider items.
8722 @tsubheading{View/Go to Org file}
8723 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8724 Display the original location of the item in another window.
8725 With prefix arg, make sure that the entire entry is made visible in the
8726 outline, not only the heading.
8728 @orgcmd{L,org-agenda-recenter}
8729 Display original location and recenter that window.
8731 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8732 Go to the original location of the item in another window.
8734 @orgcmd{@key{RET},org-agenda-switch-to}
8735 Go to the original location of the item and delete other windows.
8737 @orgcmd{F,org-agenda-follow-mode}
8738 @vindex org-agenda-start-with-follow-mode
8739 Toggle Follow mode.  In Follow mode, as you move the cursor through
8740 the agenda buffer, the other window always shows the corresponding
8741 location in the Org file.  The initial setting for this mode in new
8742 agenda buffers can be set with the variable
8743 @code{org-agenda-start-with-follow-mode}.
8745 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8746 Display the entire subtree of the current item in an indirect buffer.  With a
8747 numeric prefix argument N, go up to level N and then take that tree.  If N is
8748 negative, go up that many levels.  With a @kbd{C-u} prefix, do not remove the
8749 previously used indirect buffer.
8751 @orgcmd{C-c C-o,org-agenda-open-link}
8752 Follow a link in the entry.  This will offer a selection of any links in the
8753 text belonging to the referenced Org node.  If there is only one link, it
8754 will be followed without a selection prompt.
8756 @tsubheading{Change display}
8757 @cindex display changing, in agenda
8758 @kindex A
8759 @item A
8760 Interactively select another agenda view and append it to the current view.
8762 @kindex o
8763 @item o
8764 Delete other windows.
8766 @orgcmdkskc{v d,d,org-agenda-day-view}
8767 @xorgcmdkskc{v w,w,org-agenda-week-view}
8768 @xorgcmd{v t,org-agenda-fortnight-view}
8769 @xorgcmd{v m,org-agenda-month-view}
8770 @xorgcmd{v y,org-agenda-year-view}
8771 @xorgcmd{v SPC,org-agenda-reset-view}
8772 @vindex org-agenda-span
8773 Switch to day/week/month/year view.  When switching to day or week view, this
8774 setting becomes the default for subsequent agenda refreshes.  Since month and
8775 year views are slow to create, they do not become the default.  A numeric
8776 prefix argument may be used to jump directly to a specific day of the year,
8777 ISO week, month, or year, respectively.  For example, @kbd{32 d} jumps to
8778 February 1st, @kbd{9 w} to ISO week number 9.  When setting day, week, or
8779 month view, a year may be encoded in the prefix argument as well.  For
8780 example, @kbd{200712 w} will jump to week 12 in 2007.  If such a year
8781 specification has only one or two digits, it will be mapped to the interval
8782 1938--2037.  @kbd{v @key{SPC}} will reset to what is set in
8783 @code{org-agenda-span}.
8785 @orgcmd{f,org-agenda-later}
8786 Go forward in time to display the following @code{org-agenda-current-span} days.
8787 For example, if the display covers a week, switch to the following week.
8788 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8790 @orgcmd{b,org-agenda-earlier}
8791 Go backward in time to display earlier dates.
8793 @orgcmd{.,org-agenda-goto-today}
8794 Go to today.
8796 @orgcmd{j,org-agenda-goto-date}
8797 Prompt for a date and go there.
8799 @orgcmd{J,org-agenda-clock-goto}
8800 Go to the currently clocked-in task @i{in the agenda buffer}.
8802 @orgcmd{D,org-agenda-toggle-diary}
8803 Toggle the inclusion of diary entries.  See @ref{Weekly/daily agenda}.
8805 @orgcmdkskc{v l,l,org-agenda-log-mode}
8806 @kindex v L
8807 @vindex org-log-done
8808 @vindex org-agenda-log-mode-items
8809 Toggle Logbook mode.  In Logbook mode, entries that were marked DONE while
8810 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8811 entries that have been clocked on that day.  You can configure the entry
8812 types that should be included in log mode using the variable
8813 @code{org-agenda-log-mode-items}.  When called with a @kbd{C-u} prefix, show
8814 all possible logbook entries, including state changes.  When called with two
8815 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8816 @kbd{v L} is equivalent to @kbd{C-u v l}.
8818 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8819 Include inactive timestamps into the current view.  Only for weekly/daily
8820 agenda and timeline views.
8822 @orgcmd{v a,org-agenda-archives-mode}
8823 @xorgcmd{v A,org-agenda-archives-mode 'files}
8824 Toggle Archives mode.  In Archives mode, trees that are marked
8825 @code{ARCHIVED} are also scanned when producing the agenda.  When you use the
8826 capital @kbd{A}, even all archive files are included.  To exit archives mode,
8827 press @kbd{v a} again.
8829 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8830 @vindex org-agenda-start-with-clockreport-mode
8831 @vindex org-clock-report-include-clocking-task
8832 Toggle Clockreport mode.  In Clockreport mode, the daily/weekly agenda will
8833 always show a table with the clocked times for the time span and file scope
8834 covered by the current agenda view.  The initial setting for this mode in new
8835 agenda buffers can be set with the variable
8836 @code{org-agenda-start-with-clockreport-mode}.  By using a prefix argument
8837 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8838 contributions from entries that are hidden by agenda filtering@footnote{Only
8839 tags filtering will be respected here, effort filtering is ignored.}.  See
8840 also the variable @code{org-clock-report-include-clocking-task}.
8842 @orgkey{v c}
8843 @vindex org-agenda-clock-consistency-checks
8844 Show overlapping clock entries, clocking gaps, and other clocking problems in
8845 the current agenda range.  You can then visit clocking lines and fix them
8846 manually.  See the variable @code{org-agenda-clock-consistency-checks} for
8847 information on how to customize the definition of what constituted a clocking
8848 problem.  To return to normal agenda display, press @kbd{l} to exit Logbook
8849 mode.
8851 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8852 @vindex org-agenda-start-with-entry-text-mode
8853 @vindex org-agenda-entry-text-maxlines
8854 Toggle entry text mode.  In entry text mode, a number of lines from the Org
8855 outline node referenced by an agenda line will be displayed below the line.
8856 The maximum number of lines is given by the variable
8857 @code{org-agenda-entry-text-maxlines}.  Calling this command with a numeric
8858 prefix argument will temporarily modify that number to the prefix value.
8860 @orgcmd{G,org-agenda-toggle-time-grid}
8861 @vindex org-agenda-use-time-grid
8862 @vindex org-agenda-time-grid
8863 Toggle the time grid on and off.  See also the variables
8864 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8866 @orgcmd{r,org-agenda-redo}
8867 Recreate the agenda buffer, for example to reflect the changes after
8868 modification of the timestamps of items with @kbd{S-@key{left}} and
8869 @kbd{S-@key{right}}.  When the buffer is the global TODO list, a prefix
8870 argument is interpreted to create a selective list for a specific TODO
8871 keyword.
8872 @orgcmd{g,org-agenda-redo}
8873 Same as @kbd{r}.
8875 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8876 Save all Org buffers in the current Emacs session, and also the locations of
8877 IDs.
8879 @orgcmd{C-c C-x C-c,org-agenda-columns}
8880 @vindex org-columns-default-format
8881 Invoke column view (@pxref{Column view}) in the agenda buffer.  The column
8882 view format is taken from the entry at point, or (if there is no entry at
8883 point), from the first entry in the agenda view.  So whatever the format for
8884 that entry would be in the original buffer (taken from a property, from a
8885 @code{#+COLUMNS} line, or from the default variable
8886 @code{org-columns-default-format}), will be used in the agenda.
8888 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8889 Remove the restriction lock on the agenda, if it is currently restricted to a
8890 file or subtree (@pxref{Agenda files}).
8892 @tsubheading{Secondary filtering and query editing}
8894 For a detailed description of these commands, see @pxref{Filtering/limiting
8895 agenda items}.
8897 @orgcmd{/,org-agenda-filter-by-tag}
8898 @vindex org-agenda-tag-filter-preset
8899 Filter the agenda view with respect to a tag and/or effort estimates.
8901 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8902 Narrow the current agenda filter by an additional condition.
8904 @orgcmd{<,org-agenda-filter-by-category}
8905 @vindex org-agenda-category-filter-preset
8907 Filter the current agenda view with respect to the category of the item at
8908 point.  Pressing @code{<} another time will remove this filter.
8910 @orgcmd{^,org-agenda-filter-by-top-headline}
8911 Filter the current agenda view and only display the siblings and the parent
8912 headline of the one at point.
8914 @orgcmd{=,org-agenda-filter-by-regexp}
8915 @vindex org-agenda-regexp-filter-preset
8917 Filter the agenda view by a regular expression: only show agenda entries
8918 matching the regular expression the user entered.  When called with a prefix
8919 argument, it will filter @emph{out} entries matching the regexp.  With two
8920 universal prefix arguments, it will remove all the regexp filters, which can
8921 be accumulated.  You can add a filter preset through the option
8922 @code{org-agenda-category-filter-preset} (see below.)
8924 @orgcmd{|,org-agenda-filter-remove-all}
8925 Remove all filters in the current agenda view.
8927 @tsubheading{Remote editing}
8928 @cindex remote editing, from agenda
8930 @item 0--9
8931 Digit argument.
8933 @cindex undoing remote-editing events
8934 @cindex remote editing, undo
8935 @orgcmd{C-_,org-agenda-undo}
8936 Undo a change due to a remote editing command.  The change is undone
8937 both in the agenda buffer and in the remote buffer.
8939 @orgcmd{t,org-agenda-todo}
8940 Change the TODO state of the item, both in the agenda and in the
8941 original org file.
8943 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8944 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8945 Switch to the next/previous set of TODO keywords.
8947 @orgcmd{C-k,org-agenda-kill}
8948 @vindex org-agenda-confirm-kill
8949 Delete the current agenda item along with the entire subtree belonging
8950 to it in the original Org file.  If the text to be deleted remotely
8951 is longer than one line, the kill needs to be confirmed by the user.  See
8952 variable @code{org-agenda-confirm-kill}.
8954 @orgcmd{C-c C-w,org-agenda-refile}
8955 Refile the entry at point.
8957 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8958 @vindex org-archive-default-command
8959 Archive the subtree corresponding to the entry at point using the default
8960 archiving command set in @code{org-archive-default-command}.  When using the
8961 @code{a} key, confirmation will be required.
8963 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8964 Toggle the ARCHIVE tag for the current headline.
8966 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8967 Move the subtree corresponding to the current entry to its @emph{archive
8968 sibling}.
8970 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8971 Archive the subtree corresponding to the current headline.  This means the
8972 entry will be moved to the configured archive location, most likely a
8973 different file.
8975 @orgcmd{T,org-agenda-show-tags}
8976 @vindex org-agenda-show-inherited-tags
8977 Show all tags associated with the current item.  This is useful if you have
8978 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8979 tags of a headline occasionally.
8981 @orgcmd{:,org-agenda-set-tags}
8982 Set tags for the current headline.  If there is an active region in the
8983 agenda, change a tag for all headings in the region.
8985 @kindex ,
8986 @item ,
8987 Set the priority for the current item (@command{org-agenda-priority}).
8988 Org mode prompts for the priority character.  If you reply with @key{SPC},
8989 the priority cookie is removed from the entry.
8991 @orgcmd{P,org-agenda-show-priority}
8992 Display weighted priority of current item.
8994 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8995 Increase the priority of the current item.  The priority is changed in
8996 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
8997 key for this.
8999 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
9000 Decrease the priority of the current item.
9002 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
9003 @vindex org-log-into-drawer
9004 Add a note to the entry.  This note will be recorded, and then filed to the
9005 same location where state change notes are put.  Depending on
9006 @code{org-log-into-drawer}, this may be inside a drawer.
9008 @orgcmd{C-c C-a,org-attach}
9009 Dispatcher for all command related to attachments.
9011 @orgcmd{C-c C-s,org-agenda-schedule}
9012 Schedule this item.  With prefix arg remove the scheduling timestamp
9014 @orgcmd{C-c C-d,org-agenda-deadline}
9015 Set a deadline for this item.  With prefix arg remove the deadline.
9017 @orgcmd{S-@key{right},org-agenda-do-date-later}
9018 Change the timestamp associated with the current line by one day into the
9019 future.  If the date is in the past, the first call to this command will move
9020 it to today.@*
9021 With a numeric prefix argument, change it by that many days.  For example,
9022 @kbd{3 6 5 S-@key{right}} will change it by a year.  With a @kbd{C-u} prefix,
9023 change the time by one hour.  If you immediately repeat the command, it will
9024 continue to change hours even without the prefix arg.  With a double @kbd{C-u
9025 C-u} prefix, do the same for changing minutes.@*
9026 The stamp is changed in the original Org file, but the change is not directly
9027 reflected in the agenda buffer.  Use @kbd{r} or @kbd{g} to update the buffer.
9029 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
9030 Change the timestamp associated with the current line by one day
9031 into the past.
9033 @orgcmd{>,org-agenda-date-prompt}
9034 Change the timestamp associated with the current line.  The key @kbd{>} has
9035 been chosen, because it is the same as @kbd{S-.}  on my keyboard.
9037 @orgcmd{I,org-agenda-clock-in}
9038 Start the clock on the current item.  If a clock is running already, it
9039 is stopped first.
9041 @orgcmd{O,org-agenda-clock-out}
9042 Stop the previously started clock.
9044 @orgcmd{X,org-agenda-clock-cancel}
9045 Cancel the currently running clock.
9047 @orgcmd{J,org-agenda-clock-goto}
9048 Jump to the running clock in another window.
9050 @orgcmd{k,org-agenda-capture}
9051 Like @code{org-capture}, but use the date at point as the default date for
9052 the capture template.  See @code{org-capture-use-agenda-date} to make this
9053 the default behavior of @code{org-capture}.
9054 @cindex capturing, from agenda
9055 @vindex org-capture-use-agenda-date
9057 @tsubheading{Dragging agenda lines forward/backward}
9058 @cindex dragging, agenda lines
9060 @orgcmd{M-<up>,org-agenda-drag-line-backward}
9061 Drag the line at point backward one line@footnote{Moving agenda lines does
9062 not persist after an agenda refresh and does not modify the contributing
9063 @file{.org} files}.  With a numeric prefix argument, drag backward by that
9064 many lines.
9066 @orgcmd{M-<down>,org-agenda-drag-line-forward}
9067 Drag the line at point forward one line.  With a numeric prefix argument,
9068 drag forward by that many lines.
9070 @tsubheading{Bulk remote editing selected entries}
9071 @cindex remote editing, bulk, from agenda
9072 @vindex org-agenda-bulk-custom-functions
9074 @orgcmd{m,org-agenda-bulk-mark}
9075 Mark the entry at point for bulk action.  With numeric prefix argument, mark
9076 that many successive entries.
9078 @orgcmd{*,org-agenda-bulk-mark-all}
9079 Mark all visible agenda entries for bulk action.
9081 @orgcmd{u,org-agenda-bulk-unmark}
9082 Unmark entry at point for bulk action.
9084 @orgcmd{U,org-agenda-bulk-remove-all-marks}
9085 Unmark all marked entries for bulk action.
9087 @orgcmd{M-m,org-agenda-bulk-toggle}
9088 Toggle mark of the entry at point for bulk action.
9090 @orgcmd{M-*,org-agenda-bulk-toggle-all}
9091 Toggle marks of all visible entries for bulk action.
9093 @orgcmd{%,org-agenda-bulk-mark-regexp}
9094 Mark entries matching a regular expression for bulk action.
9096 @orgcmd{B,org-agenda-bulk-action}
9097 Bulk action: act on all marked entries in the agenda.  This will prompt for
9098 another key to select the action to be applied.  The prefix arg to @kbd{B}
9099 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
9100 these special timestamps.  By default, marks are removed after the bulk.  If
9101 you want them to persist, set @code{org-agenda-persistent-marks} to @code{t}
9102 or hit @kbd{p} at the prompt.
9104 @table @kbd
9105 @item *
9106 Toggle persistent marks.
9107 @item $
9108 Archive all selected entries.
9109 @item A
9110 Archive entries by moving them to their respective archive siblings.
9111 @item t
9112 Change TODO state.  This prompts for a single TODO keyword and changes the
9113 state of all selected entries, bypassing blocking and suppressing logging
9114 notes (but not timestamps).
9115 @item +
9116 Add a tag to all selected entries.
9117 @item -
9118 Remove a tag from all selected entries.
9119 @item s
9120 Schedule all items to a new date.  To shift existing schedule dates by a
9121 fixed number of days, use something starting with double plus at the prompt,
9122 for example @samp{++8d} or @samp{++2w}.
9123 @item d
9124 Set deadline to a specific date.
9125 @item r
9126 Prompt for a single refile target and move all entries.  The entries will no
9127 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9128 @item S
9129 Reschedule randomly into the coming N days.  N will be prompted for.  With
9130 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9131 @item f
9132 Apply a function@footnote{You can also create persistent custom functions
9133 through @code{org-agenda-bulk-custom-functions}.} to marked entries.  For
9134 example, the function below sets the CATEGORY property of the entries to web.
9136 @lisp
9137 @group
9138 (defun set-category ()
9139   (interactive "P")
9140   (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9141                      (org-agenda-error)))
9142          (buffer (marker-buffer marker)))
9143     (with-current-buffer buffer
9144       (save-excursion
9145         (save-restriction
9146           (widen)
9147           (goto-char marker)
9148           (org-back-to-heading t)
9149           (org-set-property "CATEGORY" "web"))))))
9150 @end group
9151 @end lisp
9152 @end table
9154 @tsubheading{Calendar commands}
9155 @cindex calendar commands, from agenda
9157 @orgcmd{c,org-agenda-goto-calendar}
9158 Open the Emacs calendar and move to the date at the agenda cursor.
9160 @orgcmd{c,org-calendar-goto-agenda}
9161 When in the calendar, compute and show the Org mode agenda for the
9162 date at the cursor.
9164 @cindex diary entries, creating from agenda
9165 @orgcmd{i,org-agenda-diary-entry}
9166 @vindex org-agenda-diary-file
9167 Insert a new entry into the diary, using the date at the cursor and (for
9168 block entries) the date at the mark.  This will add to the Emacs diary
9169 file@footnote{This file is parsed for the agenda when
9170 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9171 command in the calendar.  The diary file will pop up in another window, where
9172 you can add the entry.
9174 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9175 Org will create entries (in Org mode syntax) in that file instead.  Most
9176 entries will be stored in a date-based outline tree that will later make it
9177 easy to archive appointments from previous months/years.  The tree will be
9178 built under an entry with a @code{DATE_TREE} property, or else with years as
9179 top-level entries.  Emacs will prompt you for the entry text---if you specify
9180 it, the entry will be created in @code{org-agenda-diary-file} without further
9181 interaction.  If you directly press @key{RET} at the prompt without typing
9182 text, the target file will be shown in another window for you to finish the
9183 entry there.  See also the @kbd{k r} command.
9185 @orgcmd{M,org-agenda-phases-of-moon}
9186 Show the phases of the moon for the three months around current date.
9188 @orgcmd{S,org-agenda-sunrise-sunset}
9189 Show sunrise and sunset times.  The geographical location must be set
9190 with calendar variables, see the documentation for the Emacs calendar.
9192 @orgcmd{C,org-agenda-convert-date}
9193 Convert the date at cursor into many other cultural and historic
9194 calendars.
9196 @orgcmd{H,org-agenda-holidays}
9197 Show holidays for three months around the cursor date.
9199 @item M-x org-icalendar-combine-agenda-files RET
9200 Export a single iCalendar file containing entries from all agenda files.
9201 This is a globally available command, and also available in the agenda menu.
9203 @tsubheading{Exporting to a file}
9204 @orgcmd{C-x C-w,org-agenda-write}
9205 @cindex exporting agenda views
9206 @cindex agenda views, exporting
9207 @vindex org-agenda-exporter-settings
9208 Write the agenda view to a file.  Depending on the extension of the selected
9209 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9210 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9211 (any other extension).  When exporting to Org, only the body of original
9212 headlines are exported, not subtrees or inherited tags.  When called with a
9213 @kbd{C-u} prefix argument, immediately open the newly created file.  Use the
9214 variable @code{org-agenda-exporter-settings} to set options for
9215 @file{ps-print} and for @file{htmlize} to be used during export.
9217 @tsubheading{Quit and Exit}
9218 @orgcmd{q,org-agenda-quit}
9219 Quit agenda, remove the agenda buffer.
9221 @cindex agenda files, removing buffers
9222 @orgcmd{x,org-agenda-exit}
9223 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9224 for the compilation of the agenda.  Buffers created by the user to
9225 visit Org files will not be removed.
9226 @end table
9229 @node Custom agenda views
9230 @section Custom agenda views
9231 @cindex custom agenda views
9232 @cindex agenda views, custom
9234 Custom agenda commands serve two purposes: to store and quickly access
9235 frequently used TODO and tags searches, and to create special composite
9236 agenda buffers.  Custom agenda commands will be accessible through the
9237 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9239 @menu
9240 * Storing searches::            Type once, use often
9241 * Block agenda::                All the stuff you need in a single buffer
9242 * Setting options::             Changing the rules
9243 @end menu
9245 @node Storing searches
9246 @subsection Storing searches
9248 The first application of custom searches is the definition of keyboard
9249 shortcuts for frequently used searches, either creating an agenda
9250 buffer, or a sparse tree (the latter covering of course only the current
9251 buffer).
9252 @kindex C-c a C
9253 @vindex org-agenda-custom-commands
9254 @cindex agenda views, main example
9255 @cindex agenda, as an agenda views
9256 @cindex agenda*, as an agenda views
9257 @cindex tags, as an agenda view
9258 @cindex todo, as an agenda view
9259 @cindex tags-todo
9260 @cindex todo-tree
9261 @cindex occur-tree
9262 @cindex tags-tree
9264 Custom commands are configured in the variable
9265 @code{org-agenda-custom-commands}.  You can customize this variable, for
9266 example by pressing @kbd{C-c a C}.  You can also directly set it with Emacs
9267 Lisp in @file{.emacs}.  The following example contains all valid agenda
9268 views:
9270 @lisp
9271 @group
9272 (setq org-agenda-custom-commands
9273       '(("x" agenda)
9274         ("y" agenda*)
9275         ("w" todo "WAITING")
9276         ("W" todo-tree "WAITING")
9277         ("u" tags "+boss-urgent")
9278         ("v" tags-todo "+boss-urgent")
9279         ("U" tags-tree "+boss-urgent")
9280         ("f" occur-tree "\\<FIXME\\>")
9281         ("h" . "HOME+Name tags searches") ; description for "h" prefix
9282         ("hl" tags "+home+Lisa")
9283         ("hp" tags "+home+Peter")
9284         ("hk" tags "+home+Kim")))
9285 @end group
9286 @end lisp
9288 @noindent
9289 The initial string in each entry defines the keys you have to press
9290 after the dispatcher command @kbd{C-c a} in order to access the command.
9291 Usually this will be just a single character, but if you have many
9292 similar commands, you can also define two-letter combinations where the
9293 first character is the same in several combinations and serves as a
9294 prefix key@footnote{You can provide a description for a prefix key by
9295 inserting a cons cell with the prefix and the description.}.  The second
9296 parameter is the search type, followed by the string or regular
9297 expression to be used for the matching.  The example above will
9298 therefore define:
9300 @table @kbd
9301 @item C-c a x
9302 as a global search for agenda entries planned@footnote{@emph{Planned} means
9303 here that these entries have some planning information attached to them, like
9304 a time-stamp, a scheduled or a deadline string.  See
9305 @code{org-agenda-entry-types} on how to set what planning information will be
9306 taken into account.} this week/day.
9307 @item C-c a y
9308 as a global search for agenda entries planned this week/day, but only those
9309 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9310 @item C-c a w
9311 as a global search for TODO entries with @samp{WAITING} as the TODO
9312 keyword
9313 @item C-c a W
9314 as the same search, but only in the current buffer and displaying the
9315 results as a sparse tree
9316 @item C-c a u
9317 as a global tags search for headlines marked @samp{:boss:} but not
9318 @samp{:urgent:}
9319 @item C-c a v
9320 as the same search as @kbd{C-c a u}, but limiting the search to
9321 headlines that are also TODO items
9322 @item C-c a U
9323 as the same search as @kbd{C-c a u}, but only in the current buffer and
9324 displaying the result as a sparse tree
9325 @item C-c a f
9326 to create a sparse tree (again: current buffer only) with all entries
9327 containing the word @samp{FIXME}
9328 @item C-c a h
9329 as a prefix command for a HOME tags search where you have to press an
9330 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9331 Peter, or Kim) as additional tag to match.
9332 @end table
9334 Note that the @code{*-tree} agenda views need to be called from an
9335 Org buffer as they operate on the current buffer only.
9337 @node Block agenda
9338 @subsection Block agenda
9339 @cindex block agenda
9340 @cindex agenda, with block views
9342 Another possibility is the construction of agenda views that comprise
9343 the results of @emph{several} commands, each of which creates a block in
9344 the agenda buffer.  The available commands include @code{agenda} for the
9345 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9346 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9347 matching commands discussed above: @code{todo}, @code{tags}, and
9348 @code{tags-todo}.  Here are two examples:
9350 @lisp
9351 @group
9352 (setq org-agenda-custom-commands
9353       '(("h" "Agenda and Home-related tasks"
9354          ((agenda "")
9355           (tags-todo "home")
9356           (tags "garden")))
9357         ("o" "Agenda and Office-related tasks"
9358          ((agenda "")
9359           (tags-todo "work")
9360           (tags "office")))))
9361 @end group
9362 @end lisp
9364 @noindent
9365 This will define @kbd{C-c a h} to create a multi-block view for stuff
9366 you need to attend to at home.  The resulting agenda buffer will contain
9367 your agenda for the current week, all TODO items that carry the tag
9368 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
9369 command @kbd{C-c a o} provides a similar view for office tasks.
9371 @node Setting options
9372 @subsection Setting options for custom commands
9373 @cindex options, for custom agenda views
9375 @vindex org-agenda-custom-commands
9376 Org mode contains a number of variables regulating agenda construction
9377 and display.  The global variables define the behavior for all agenda
9378 commands, including the custom commands.  However, if you want to change
9379 some settings just for a single custom view, you can do so.  Setting
9380 options requires inserting a list of variable names and values at the
9381 right spot in @code{org-agenda-custom-commands}.  For example:
9383 @lisp
9384 @group
9385 (setq org-agenda-custom-commands
9386       '(("w" todo "WAITING"
9387          ((org-agenda-sorting-strategy '(priority-down))
9388           (org-agenda-prefix-format "  Mixed: ")))
9389         ("U" tags-tree "+boss-urgent"
9390          ((org-show-context-detail 'minimal)))
9391         ("N" search ""
9392          ((org-agenda-files '("~org/notes.org"))
9393           (org-agenda-text-search-extra-files nil)))))
9394 @end group
9395 @end lisp
9397 @noindent
9398 Now the @kbd{C-c a w} command will sort the collected entries only by
9399 priority, and the prefix format is modified to just say @samp{  Mixed: }
9400 instead of giving the category of the entry.  The sparse tags tree of
9401 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9402 headline hierarchy above the match, nor the headline following the match
9403 will be shown.  The command @kbd{C-c a N} will do a text search limited
9404 to only a single file.
9406 @vindex org-agenda-custom-commands
9407 For command sets creating a block agenda,
9408 @code{org-agenda-custom-commands} has two separate spots for setting
9409 options.  You can add options that should be valid for just a single
9410 command in the set, and options that should be valid for all commands in
9411 the set.  The former are just added to the command entry; the latter
9412 must come after the list of command entries.  Going back to the block
9413 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9414 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9415 the results for GARDEN tags query in the opposite order,
9416 @code{priority-up}.  This would look like this:
9418 @lisp
9419 @group
9420 (setq org-agenda-custom-commands
9421       '(("h" "Agenda and Home-related tasks"
9422          ((agenda)
9423           (tags-todo "home")
9424           (tags "garden"
9425                 ((org-agenda-sorting-strategy '(priority-up)))))
9426          ((org-agenda-sorting-strategy '(priority-down))))
9427         ("o" "Agenda and Office-related tasks"
9428          ((agenda)
9429           (tags-todo "work")
9430           (tags "office")))))
9431 @end group
9432 @end lisp
9434 As you see, the values and parentheses setting is a little complex.
9435 When in doubt, use the customize interface to set this variable---it
9436 fully supports its structure.  Just one caveat: when setting options in
9437 this interface, the @emph{values} are just Lisp expressions.  So if the
9438 value is a string, you need to add the double-quotes around the value
9439 yourself.
9441 @vindex org-agenda-custom-commands-contexts
9442 To control whether an agenda command should be accessible from a specific
9443 context, you can customize @code{org-agenda-custom-commands-contexts}.  Let's
9444 say for example that you have an agenda command @code{"o"} displaying a view
9445 that you only need when reading emails.  Then you would configure this option
9446 like this:
9448 @lisp
9449 (setq org-agenda-custom-commands-contexts
9450       '(("o" (in-mode . "message-mode"))))
9451 @end lisp
9453 You can also tell that the command key @code{"o"} should refer to another
9454 command key @code{"r"}.  In that case, add this command key like this:
9456 @lisp
9457 (setq org-agenda-custom-commands-contexts
9458       '(("o" "r" (in-mode . "message-mode"))))
9459 @end lisp
9461 See the docstring of the variable for more information.
9463 @node Exporting agenda views
9464 @section Exporting agenda views
9465 @cindex agenda views, exporting
9467 If you are away from your computer, it can be very useful to have a printed
9468 version of some agenda views to carry around.  Org mode can export custom
9469 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9470 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9471 ghostscript @file{ps2pdf} utility must be installed on the system.  Selecting
9472 a PDF file will also create the postscript file.}, and iCalendar files.  If
9473 you want to do this only occasionally, use the command
9475 @table @kbd
9476 @orgcmd{C-x C-w,org-agenda-write}
9477 @cindex exporting agenda views
9478 @cindex agenda views, exporting
9479 @vindex org-agenda-exporter-settings
9480 Write the agenda view to a file.  Depending on the extension of the selected
9481 file name, the view will be exported as HTML (extension @file{.html} or
9482 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9483 @file{.ics}), or plain text (any other extension).  Use the variable
9484 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9485 for @file{htmlize} to be used during export, for example
9487 @vindex org-agenda-add-entry-text-maxlines
9488 @vindex htmlize-output-type
9489 @vindex ps-number-of-columns
9490 @vindex ps-landscape-mode
9491 @lisp
9492 (setq org-agenda-exporter-settings
9493       '((ps-number-of-columns 2)
9494         (ps-landscape-mode t)
9495         (org-agenda-add-entry-text-maxlines 5)
9496         (htmlize-output-type 'css)))
9497 @end lisp
9498 @end table
9500 If you need to export certain agenda views frequently, you can associate
9501 any custom agenda command with a list of output file names
9502 @footnote{If you want to store standard views like the weekly agenda
9503 or the global TODO list as well, you need to define custom commands for
9504 them in order to be able to specify file names.}.  Here is an example
9505 that first defines custom commands for the agenda and the global
9506 TODO list, together with a number of files to which to export them.
9507 Then we define two block agenda commands and specify file names for them
9508 as well.  File names can be relative to the current working directory,
9509 or absolute.
9511 @lisp
9512 @group
9513 (setq org-agenda-custom-commands
9514       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9515         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9516         ("h" "Agenda and Home-related tasks"
9517          ((agenda "")
9518           (tags-todo "home")
9519           (tags "garden"))
9520          nil
9521          ("~/views/home.html"))
9522         ("o" "Agenda and Office-related tasks"
9523          ((agenda)
9524           (tags-todo "work")
9525           (tags "office"))
9526          nil
9527          ("~/views/office.ps" "~/calendars/office.ics"))))
9528 @end group
9529 @end lisp
9531 The extension of the file name determines the type of export.  If it is
9532 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9533 the buffer to HTML and save it to this file name.  If the extension is
9534 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9535 Postscript output.  If the extension is @file{.ics}, iCalendar export is
9536 run export over all files that were used to construct the agenda, and
9537 limit the export to entries listed in the agenda.  Any other
9538 extension produces a plain ASCII file.
9540 The export files are @emph{not} created when you use one of those
9541 commands interactively because this might use too much overhead.
9542 Instead, there is a special command to produce @emph{all} specified
9543 files in one step:
9545 @table @kbd
9546 @orgcmd{C-c a e,org-store-agenda-views}
9547 Export all agenda views that have export file names associated with
9548 them.
9549 @end table
9551 You can use the options section of the custom agenda commands to also
9552 set options for the export commands.  For example:
9554 @lisp
9555 (setq org-agenda-custom-commands
9556       '(("X" agenda ""
9557          ((ps-number-of-columns 2)
9558           (ps-landscape-mode t)
9559           (org-agenda-prefix-format " [ ] ")
9560           (org-agenda-with-colors nil)
9561           (org-agenda-remove-tags t))
9562          ("theagenda.ps"))))
9563 @end lisp
9565 @noindent
9566 This command sets two options for the Postscript exporter, to make it
9567 print in two columns in landscape format---the resulting page can be cut
9568 in two and then used in a paper agenda.  The remaining settings modify
9569 the agenda prefix to omit category and scheduling information, and
9570 instead include a checkbox to check off items.  We also remove the tags
9571 to make the lines compact, and we don't want to use colors for the
9572 black-and-white printer.  Settings specified in
9573 @code{org-agenda-exporter-settings} will also apply, but the settings
9574 in @code{org-agenda-custom-commands} take precedence.
9576 @noindent
9577 From the command line you may also use
9578 @example
9579 emacs -eval (org-batch-store-agenda-views) -kill
9580 @end example
9581 @noindent
9582 or, if you need to modify some parameters@footnote{Quoting depends on the
9583 system you use, please check the FAQ for examples.}
9584 @example
9585 emacs -eval '(org-batch-store-agenda-views                      \
9586               org-agenda-span (quote month)                     \
9587               org-agenda-start-day "2007-11-01"                 \
9588               org-agenda-include-diary nil                      \
9589               org-agenda-files (quote ("~/org/project.org")))'  \
9590       -kill
9591 @end example
9592 @noindent
9593 which will create the agenda views restricted to the file
9594 @file{~/org/project.org}, without diary entries and with a 30-day
9595 extent.
9597 You can also extract agenda information in a way that allows further
9598 processing by other programs.  See @ref{Extracting agenda information}, for
9599 more information.
9602 @node Agenda column view
9603 @section Using column view in the agenda
9604 @cindex column view, in agenda
9605 @cindex agenda, column view
9607 Column view (@pxref{Column view}) is normally used to view and edit
9608 properties embedded in the hierarchical structure of an Org file.  It can be
9609 quite useful to use column view also from the agenda, where entries are
9610 collected by certain criteria.
9612 @table @kbd
9613 @orgcmd{C-c C-x C-c,org-agenda-columns}
9614 Turn on column view in the agenda.
9615 @end table
9617 To understand how to use this properly, it is important to realize that the
9618 entries in the agenda are no longer in their proper outline environment.
9619 This causes the following issues:
9621 @enumerate
9622 @item
9623 @vindex org-columns-default-format
9624 @vindex org-overriding-columns-format
9625 Org needs to make a decision which @code{COLUMNS} format to use.  Since the
9626 entries in the agenda are collected from different files, and different files
9627 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9628 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9629 currently set, and if so, takes the format from there.  Otherwise it takes
9630 the format associated with the first item in the agenda, or, if that item
9631 does not have a specific format (defined in a property, or in its file), it
9632 uses @code{org-columns-default-format}.
9633 @item
9634 @cindex property, special, CLOCKSUM
9635 If any of the columns has a summary type defined (@pxref{Column attributes}),
9636 turning on column view in the agenda will visit all relevant agenda files and
9637 make sure that the computations of this property are up to date.  This is
9638 also true for the special @code{CLOCKSUM} property.  Org will then sum the
9639 values displayed in the agenda.  In the daily/weekly agenda, the sums will
9640 cover a single day; in all other views they cover the entire block.  It is
9641 vital to realize that the agenda may show the same entry @emph{twice} (for
9642 example as scheduled and as a deadline), and it may show two entries from the
9643 same hierarchy (for example a @emph{parent} and its @emph{child}).  In these
9644 cases, the summation in the agenda will lead to incorrect results because
9645 some values will count double.
9646 @item
9647 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9648 the entire clocked time for this item.  So even in the daily/weekly agenda,
9649 the clocksum listed in column view may originate from times outside the
9650 current view.  This has the advantage that you can compare these values with
9651 a column listing the planned total effort for a task---one of the major
9652 applications for column view in the agenda.  If you want information about
9653 clocked time in the displayed period use clock table mode (press @kbd{R} in
9654 the agenda).
9656 @item
9657 @cindex property, special, CLOCKSUM_T
9658 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9659 always today's clocked time for this item.  So even in the weekly agenda,
9660 the clocksum listed in column view only originates from today.  This lets
9661 you compare the time you spent on a task for today, with the time already
9662 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9663 @end enumerate
9666 @node Markup
9667 @chapter Markup for rich export
9669 When exporting Org mode documents, the exporter tries to reflect the
9670 structure of the document as accurately as possible in the back-end.  Since
9671 export targets like HTML and @LaTeX{} allow much richer formatting, Org mode has
9672 rules on how to prepare text for rich export.  This section summarizes the
9673 markup rules used in an Org mode buffer.
9675 @menu
9676 * Structural markup elements::  The basic structure as seen by the exporter
9677 * Images and tables::           Images, tables and caption mechanism
9678 * Literal examples::            Source code examples with special formatting
9679 * Include files::               Include additional files into a document
9680 * Index entries::               Making an index
9681 * Macro replacement::           Use macros to create templates
9682 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
9683 * Special blocks::              Containers targeted at export back-ends
9684 @end menu
9686 @node Structural markup elements
9687 @section Structural markup elements
9689 @menu
9690 * Document title::              Where the title is taken from
9691 * Headings and sections::       The document structure as seen by the exporter
9692 * Table of contents::           The if and where of the table of contents
9693 * Lists::                       Lists
9694 * Paragraphs::                  Paragraphs
9695 * Footnote markup::             Footnotes
9696 * Emphasis and monospace::      Bold, italic, etc.
9697 * Horizontal rules::            Make a line
9698 * Comment lines::               What will *not* be exported
9699 @end menu
9701 @node Document title
9702 @subheading Document title
9703 @cindex document title, markup rules
9705 @noindent
9706 The title of the exported document is taken from the special line
9708 @cindex #+TITLE
9709 @example
9710 #+TITLE: This is the title of the document
9711 @end example
9713 @cindex property, EXPORT_TITLE
9714 If you are exporting only a subtree, its heading will become the title of the
9715 document.  If the subtree has a property @code{EXPORT_TITLE}, that will take
9716 precedence.
9718 @node Headings and sections
9719 @subheading Headings and sections
9720 @cindex headings and sections, markup rules
9722 @vindex org-export-headline-levels
9723 The outline structure of the document as described in @ref{Document
9724 structure}, forms the basis for defining sections of the exported document.
9725 However, since the outline structure is also used for (for example) lists of
9726 tasks, only the first three outline levels will be used as headings.  Deeper
9727 levels will become itemized lists.  You can change the location of this
9728 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9729 per-file basis with a line
9731 @cindex #+OPTIONS
9732 @example
9733 #+OPTIONS: H:4
9734 @end example
9736 @node Table of contents
9737 @subheading Table of contents
9738 @cindex table of contents, markup rules
9740 @cindex #+TOC
9741 @vindex org-export-with-toc
9742 The table of contents is normally inserted directly before the first headline
9743 of the file.  The depth of the table is by default the same as the number of
9744 headline levels, but you can choose a smaller number, or turn off the table
9745 of contents entirely, by configuring the variable @code{org-export-with-toc},
9746 or on a per-file basis with a line like
9748 @example
9749 #+OPTIONS: toc:2          @r{only inlcude two levels in TOC}
9750 #+OPTIONS: toc:nil        @r{no default TOC at all}
9751 @end example
9753 If you would like to move the table of contents to a different location, you
9754 should turn off the default table using @code{org-export-with-toc} or
9755 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9756 location(s).
9758 @example
9759 #+OPTIONS: toc:nil        @r{no default TOC}
9761 #+TOC: headlines 2        @r{insert TOC here, with two headline levels}
9762 @end example
9764 Moreover, if you append @samp{local} parameter, the table contains only
9765 entries for the children of the current section@footnote{For @LaTeX{} export,
9766 this feature requires the @code{titletoc} package.  Note that @code{titletoc}
9767 must be loaded @emph{before} @code{hyperref}.  Thus, you may have to
9768 customize @code{org-latex-default-packages-alist}.}.  In this case, any depth
9769 parameter becomes relative to the current level.
9771 @example
9772 * Section
9773 #+TOC: headlines 1 local  @r{insert local TOC, with direct children only}
9774 @end example
9776 The same @code{TOC} keyword can also generate a list of all tables (resp.@:
9777 all listings) with a caption in the document.
9779 @example
9780 #+TOC: listings           @r{build a list of listings}
9781 #+TOC: tables             @r{build a list of tables}
9782 @end example
9784 @cindex property, ALT_TITLE
9785 The headline's title usually determines its corresponding entry in a table of
9786 contents.  However, it is possible to specify an alternative title by
9787 setting @code{ALT_TITLE} property accordingly.  It will then be used when
9788 building the table.
9790 @node Lists
9791 @subheading Lists
9792 @cindex lists, markup rules
9794 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9795 syntax for such lists.  Most back-ends support unordered, ordered, and
9796 description lists.
9798 @node Paragraphs
9799 @subheading Paragraphs, line breaks, and quoting
9800 @cindex paragraphs, markup rules
9802 Paragraphs are separated by at least one empty line.  If you need to enforce
9803 a line break within a paragraph, use @samp{\\} at the end of a line.
9805 To keep the line breaks in a region, but otherwise use normal formatting, you
9806 can use this construct, which can also be used to format poetry.
9808 @cindex #+BEGIN_VERSE
9809 @example
9810 #+BEGIN_VERSE
9811  Great clouds overhead
9812  Tiny black birds rise and fall
9813  Snow covers Emacs
9815      -- AlexSchroeder
9816 #+END_VERSE
9817 @end example
9819 When quoting a passage from another document, it is customary to format this
9820 as a paragraph that is indented on both the left and the right margin.  You
9821 can include quotations in Org mode documents like this:
9823 @cindex #+BEGIN_QUOTE
9824 @example
9825 #+BEGIN_QUOTE
9826 Everything should be made as simple as possible,
9827 but not any simpler -- Albert Einstein
9828 #+END_QUOTE
9829 @end example
9831 If you would like to center some text, do it like this:
9832 @cindex #+BEGIN_CENTER
9833 @example
9834 #+BEGIN_CENTER
9835 Everything should be made as simple as possible, \\
9836 but not any simpler
9837 #+END_CENTER
9838 @end example
9841 @node Footnote markup
9842 @subheading Footnote markup
9843 @cindex footnotes, markup rules
9844 @cindex @file{footnote.el}
9846 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9847 by all back-ends.  Org allows multiple references to the same note, and
9848 multiple footnotes side by side.
9850 @node Emphasis and monospace
9851 @subheading Emphasis and monospace
9853 @cindex underlined text, markup rules
9854 @cindex bold text, markup rules
9855 @cindex italic text, markup rules
9856 @cindex verbatim text, markup rules
9857 @cindex code text, markup rules
9858 @cindex strike-through text, markup rules
9859 @vindex org-fontify-emphasized-text
9860 @vindex org-emphasis-regexp-components
9861 @vindex org-emphasis-alist
9862 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9863 and @code{~code~}, and, if you must, @samp{+strike-through+}.  Text
9864 in the code and verbatim string is not processed for Org mode specific
9865 syntax, it is exported verbatim.
9867 To turn off fontification for marked up text, you can set
9868 @code{org-fontify-emphasized-text} to @code{nil}.  To narrow down the list of
9869 available markup syntax, you can customize @code{org-emphasis-alist}.  To fine
9870 tune what characters are allowed before and after the markup characters, you
9871 can tweak @code{org-emphasis-regexp-components}.  Beware that changing one of
9872 the above variables will no take effect until you reload Org, for which you
9873 may need to restart Emacs.
9875 @node Horizontal rules
9876 @subheading  Horizontal rules
9877 @cindex horizontal rules, markup rules
9878 A line consisting of only dashes, and at least 5 of them, will be exported as
9879 a horizontal line.
9881 @node Comment lines
9882 @subheading Comment lines
9883 @cindex comment lines
9884 @cindex exporting, not
9885 @cindex #+BEGIN_COMMENT
9887 Lines starting with zero or more whitespace characters followed by one
9888 @samp{#} and a whitespace are treated as comments and, as such, are not
9889 exported.
9891 Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
9892 ... @samp{#+END_COMMENT} are not exported.
9894 Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
9895 other keyword or priority cookie, comments out the entire subtree.  In this
9896 case, the subtree is not exported and no code block within it is executed
9897 either@footnote{For a less drastic behavior, consider using a select tag
9898 (@pxref{Export settings}) instead.}.  The command below helps changing the
9899 comment status of a headline.
9901 @table @kbd
9902 @kindex C-c ;
9903 @item C-c ;
9904 Toggle the @samp{COMMENT} keyword at the beginning of an entry.
9905 @end table
9908 @node Images and tables
9909 @section Images and Tables
9911 @cindex tables, markup rules
9912 @cindex #+CAPTION
9913 @cindex #+NAME
9914 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9915 the @file{table.el} package will be exported properly.  For Org mode tables,
9916 the lines before the first horizontal separator line will become table header
9917 lines.  You can use the following lines somewhere before the table to assign
9918 a caption and a label for cross references, and in the text you can refer to
9919 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9921 @example
9922 #+CAPTION: This is the caption for the next table (or link)
9923 #+NAME:   tab:basic-data
9924    | ... | ...|
9925    |-----|----|
9926 @end example
9928 Optionally, the caption can take the form:
9929 @example
9930 #+CAPTION[Caption for list of tables]: Caption for table.
9931 @end example
9933 @cindex inlined images, markup rules
9934 Some back-ends allow you to directly include images into the exported
9935 document.  Org does this, if a link to an image files does not have
9936 a description part, for example @code{[[./img/a.jpg]]}.  If you wish to
9937 define a caption for the image and maybe a label for internal cross
9938 references, make sure that the link is on a line by itself and precede it
9939 with @code{#+CAPTION} and @code{#+NAME} as follows:
9941 @example
9942 #+CAPTION: This is the caption for the next figure link (or table)
9943 #+NAME:   fig:SED-HR4049
9944 [[./img/a.jpg]]
9945 @end example
9947 @noindent
9948 Such images can be displayed within the buffer.  @xref{Handling links,the
9949 discussion of image links}.
9951 Even though images and tables are prominent examples of captioned structures,
9952 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9953 equations, source code blocks).  Depending on the export back-end, those may
9954 or may not be handled.
9956 @node Literal examples
9957 @section Literal examples
9958 @cindex literal examples, markup rules
9959 @cindex code line references, markup rules
9961 You can include literal examples that should not be subjected to
9962 markup.  Such examples will be typeset in monospace, so this is well suited
9963 for source code and similar examples.
9964 @cindex #+BEGIN_EXAMPLE
9966 @example
9967 #+BEGIN_EXAMPLE
9968 Some example from a text file.
9969 #+END_EXAMPLE
9970 @end example
9972 Note that such blocks may be @i{indented} in order to align nicely with
9973 indented text and in particular with plain list structure (@pxref{Plain
9974 lists}).  For simplicity when using small examples, you can also start the
9975 example lines with a colon followed by a space.  There may also be additional
9976 whitespace before the colon:
9978 @example
9979 Here is an example
9980    : Some example from a text file.
9981 @end example
9983 @cindex formatting source code, markup rules
9984 @vindex org-latex-listings
9985 If the example is source code from a programming language, or any other text
9986 that can be marked up by font-lock in Emacs, you can ask for the example to
9987 look like the fontified Emacs buffer@footnote{This works automatically for
9988 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9989 which is distributed with Org).  Fontified code chunks in @LaTeX{} can be
9990 achieved using either the listings or the
9991 @url{http://code.google.com/p/minted, minted,} package.  Refer to
9992 @code{org-latex-listings} documentation for details.}.  This is done
9993 with the @samp{src} block, where you also need to specify the name of the
9994 major mode that should be used to fontify the example@footnote{Code in
9995 @samp{src} blocks may also be evaluated either interactively or on export.
9996 See @pxref{Working with source code} for more information on evaluating code
9997 blocks.}, see @ref{Easy templates} for shortcuts to easily insert code
9998 blocks.
9999 @cindex #+BEGIN_SRC
10001 @example
10002 #+BEGIN_SRC emacs-lisp
10003   (defun org-xor (a b)
10004      "Exclusive or."
10005      (if a (not b) b))
10006 #+END_SRC
10007 @end example
10009 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
10010 switch to the end of the @code{BEGIN} line, to get the lines of the example
10011 numbered.  If you use a @code{+n} switch, the numbering from the previous
10012 numbered snippet will be continued in the current one.  In literal examples,
10013 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
10014 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
10015 enclosed in single parenthesis).  In HTML, hovering the mouse over such a
10016 link will remote-highlight the corresponding code line, which is kind of
10017 cool.
10019 You can also add a @code{-r} switch which @i{removes} the labels from the
10020 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
10021 labels in the source code while using line numbers for the links, which might
10022 be useful to explain those in an Org mode example code.}.  With the @code{-n}
10023 switch, links to these references will be labeled by the line numbers from
10024 the code listing, otherwise links will use the labels with no parentheses.
10025 Here is an example:
10027 @example
10028 #+BEGIN_SRC emacs-lisp -n -r
10029 (save-excursion                  (ref:sc)
10030    (goto-char (point-min)))      (ref:jump)
10031 #+END_SRC
10032 In line [[(sc)]] we remember the current position.  [[(jump)][Line (jump)]]
10033 jumps to point-min.
10034 @end example
10036 @cindex indentation, in source blocks
10037 Finally, you can use @code{-i} to preserve the indentation of a specific code
10038 block (@pxref{Editing source code}).
10040 @vindex org-coderef-label-format
10041 If the syntax for the label format conflicts with the language syntax, use a
10042 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
10043 -n -r -l "((%s))"}.  See also the variable @code{org-coderef-label-format}.
10045 HTML export also allows examples to be published as text areas (@pxref{Text
10046 areas in HTML export}).
10048 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
10049 so often, shortcuts are provided using the Easy templates facility
10050 (@pxref{Easy templates}).
10052 @table @kbd
10053 @kindex C-c '
10054 @item C-c '
10055 Edit the source code example at point in its native mode.  This works by
10056 switching to a temporary buffer with the source code.  You need to exit by
10057 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
10058 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
10059 from being interpreted by Org as outline nodes or special syntax.  These
10060 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
10061 The edited version will then replace the old version in the Org buffer.
10062 Fixed-width regions (where each line starts with a colon followed by a space)
10063 will be edited using @code{artist-mode}@footnote{You may select
10064 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
10065 to allow creating ASCII drawings easily.  Using this command in an empty line
10066 will create a new fixed-width region.
10067 @kindex C-c l
10068 @item C-c l
10069 Calling @code{org-store-link} while editing a source code example in a
10070 temporary buffer created with @kbd{C-c '} will prompt for a label.  Make sure
10071 that it is unique in the current buffer, and insert it with the proper
10072 formatting like @samp{(ref:label)} at the end of the current line.  Then the
10073 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
10074 @end table
10077 @node Include files
10078 @section Include files
10079 @cindex include files, markup rules
10081 During export, you can include the content of another file.  For example, to
10082 include your @file{.emacs} file, you could use:
10083 @cindex #+INCLUDE
10085 @example
10086 #+INCLUDE: "~/.emacs" src emacs-lisp
10087 @end example
10089 @noindent
10090 The first parameter names the the file to include.  The optional second and
10091 third parameter specify the markup (i.e., @samp{example} or @samp{src}), and,
10092 if the markup is @samp{src}, the language for formatting the contents.
10094 If markup is requested, the included content will be placed within an
10095 appropriate block@footnote{While you can request paragraphs (@samp{verse},
10096 @samp{quote}, @samp{center}), but this places severe restrictions on the type
10097 of content that is permissible}.  No changes to the included content are made
10098 and it is the responsibility of the user to ensure that the result is valid
10099 Org syntax.  For markup @samp{example} and @samp{src}, which is requesting a
10100 literal example, the content will be code-escaped before inclusion.
10102 If no markup is requested, the text will be assumed to be in Org mode format
10103 and will be processed normally.  However, footnote labels (@pxref{Footnotes})
10104 in the file will be made local to that file.  Contents of the included file
10105 will belong to the same structure (headline, item) containing the
10106 @code{INCLUDE} keyword.  In particular, headlines within the file will become
10107 children of the current section.  That behavior can be changed by providing
10108 an additional keyword parameter, @code{:minlevel}.  In that case, all
10109 headlines in the included file will be shifted so the one with the lowest
10110 level reaches that specified level.  For example, to make a file become a
10111 sibling of the current top-level headline, use
10113 @example
10114 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
10115 @end example
10117 You can also include a portion of a file by specifying a lines range using
10118 the @code{:lines} keyword parameter.  The line at the upper end of the range
10119 will not be included.  The start and/or the end of the range may be omitted
10120 to use the obvious defaults.
10122 @example
10123 #+INCLUDE: "~/.emacs" :lines "5-10"   @r{Include lines 5 to 10, 10 excluded}
10124 #+INCLUDE: "~/.emacs" :lines "-10"    @r{Include lines 1 to 10, 10 excluded}
10125 #+INCLUDE: "~/.emacs" :lines "10-"    @r{Include lines from 10 to EOF}
10126 @end example
10128 Finally, you may use a file-link to extract an object as matched by
10129 @code{org-link-search}@footnote{Note that
10130 @code{org-link-search-must-match-exact-headline} is locally bound to non-@code{nil}.
10131 Therefore, @code{org-link-search} only matches headlines and named elements.}
10132 (@pxref{Search options}).  If the @code{:only-contents} property is non-@code{nil},
10133 only the contents of the requested element will be included, omitting
10134 properties drawer and planning-line if present.  The @code{:lines} keyword
10135 operates locally with respect to the requested element.  Some examples:
10137 @example
10138 #+INCLUDE: "./paper.org::#theory" :only-contents t
10139    @r{Include the body of the heading with the custom id @code{theory}}
10140 #+INCLUDE: "./paper.org::mytable"  @r{Include named element.}
10141 #+INCLUDE: "./paper.org::*conclusion" :lines 1-20
10142    @r{Include the first 20 lines of the headline named conclusion.}
10143 @end example
10145 @table @kbd
10146 @kindex C-c '
10147 @item C-c '
10148 Visit the include file at point.
10149 @end table
10151 @node Index entries
10152 @section Index entries
10153 @cindex index entries, for publishing
10155 You can specify entries that will be used for generating an index during
10156 publishing.  This is done by lines starting with @code{#+INDEX}.  An entry
10157 the contains an exclamation mark will create a sub item.  See @ref{Generating
10158 an index} for more information.
10160 @example
10161 * Curriculum Vitae
10162 #+INDEX: CV
10163 #+INDEX: Application!CV
10164 @end example
10169 @node Macro replacement
10170 @section Macro replacement
10171 @cindex macro replacement, during export
10172 @cindex #+MACRO
10174 You can define text snippets with
10176 @example
10177 #+MACRO: name   replacement text $1, $2 are arguments
10178 @end example
10180 @noindent which can be referenced
10181 @code{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate arguments,
10182 commas within arguments have to be escaped with a backslash character.
10183 Conversely, backslash characters before a comma, and only them, need to be
10184 escaped with another backslash character.}.
10186 These references, called macros, can be inserted anywhere Org markup is
10187 recognized: paragraphs, headlines, verse blocks, tables cells and lists.
10188 They cannot be used within ordinary keywords (starting with @code{#+}) but
10189 are allowed in @code{#+CAPTION}, @code{#+TITLE}, @code{#+AUTHOR} and
10190 @code{#+EMAIL}.
10192 In addition to user-defined macros, a set of predefined macros can be used:
10193 @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, and
10194 @code{@{@{@{email@}@}@}} are replaced with the information set by their
10195 respective keywords.  Further, @code{@{@{@{date(@var{FORMAT})@}@}@}},
10196 @code{@{@{@{time(@var{FORMAT})@}@}@}} and
10197 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to the @code{#+DATE}
10198 keyword, the current date, and the modification time of the file being
10199 exported, respectively.  @var{FORMAT} should be a format string understood by
10200 @code{format-time-string}.  Note that @var{FORMAT} is an optional argument to
10201 the @code{@{@{@{date@}@}@}} macro, and that it will only be used if
10202 @code{#+DATE} is a single timestamp.  Finally, the filename is available via
10203 @code{@{@{@{input-file@}@}@}} and properties can be accessed using
10204 @code{@{@{@{property(@var{PROPERTY-NAME})@}@}@}}.
10206 The surrounding brackets can be made invisible by setting
10207 @code{org-hide-macro-markers} non-@code{nil}.
10209 Macro expansion takes place during the very beginning of the export process.
10212 @node Embedded @LaTeX{}
10213 @section Embedded @LaTeX{}
10214 @cindex @TeX{} interpretation
10215 @cindex @LaTeX{} interpretation
10217 Plain ASCII is normally sufficient for almost all note taking.  Exceptions
10218 include scientific notes, which often require mathematical symbols and the
10219 occasional formula.  @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10220 Donald E. Knuth's @TeX{} system.  Many of the features described here as
10221 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10222 distinction.}  is widely used to typeset scientific documents.  Org mode
10223 supports embedding @LaTeX{} code into its files, because many academics are
10224 used to writing and reading @LaTeX{} source code, and because it can be
10225 readily processed to produce pretty output for a number of export back-ends.
10227 @menu
10228 * Special symbols::             Greek letters and other symbols
10229 * Subscripts and superscripts::  Simple syntax for raising/lowering text
10230 * @LaTeX{} fragments::          Complex formulas made easy
10231 * Previewing @LaTeX{} fragments::  What will this snippet look like?
10232 * CDLaTeX mode::                Speed up entering of formulas
10233 @end menu
10235 @node Special symbols
10236 @subsection Special symbols
10237 @cindex math symbols
10238 @cindex special symbols
10239 @cindex @TeX{} macros
10240 @cindex @LaTeX{} fragments, markup rules
10241 @cindex HTML entities
10242 @cindex @LaTeX{} entities
10244 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10245 to indicate the Greek letter, or @samp{\to} to indicate an arrow.  Completion
10246 for these symbols is available, just type @samp{\} and maybe a few letters,
10247 and press @kbd{M-@key{TAB}} to see possible completions.  Unlike @LaTeX{}
10248 code, Org mode allows these symbols to be present without surrounding math
10249 delimiters, for example:
10251 @example
10252 Angles are written as Greek letters \alpha, \beta and \gamma.
10253 @end example
10255 @vindex org-entities
10256 During export, these symbols will be transformed into the native format of
10257 the exporter back-end.  Strings like @code{\alpha} will be exported as
10258 @code{&alpha;} in the HTML output, and as @code{\(\alpha\)} in the @LaTeX{}
10259 output.  Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
10260 @code{~} in @LaTeX{}.  If you need such a symbol inside a word, terminate it
10261 like this: @samp{\Aacute@{@}stor}.
10263 A large number of entities is provided, with names taken from both HTML and
10264 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10265 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10266 @samp{...} are all converted into special commands creating hyphens of
10267 different lengths or a compact set of dots.
10269 If you would like to see entities displayed as UTF-8 characters, use the
10270 following command@footnote{You can turn this on by default by setting the
10271 variable @code{org-pretty-entities}, or on a per-file base with the
10272 @code{#+STARTUP} option @code{entitiespretty}.}:
10274 @table @kbd
10275 @cindex @code{entitiespretty}, STARTUP keyword
10276 @kindex C-c C-x \
10277 @item C-c C-x \
10278 Toggle display of entities as UTF-8 characters.  This does not change the
10279 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10280 for display purposes only.
10281 @end table
10283 @node Subscripts and superscripts
10284 @subsection Subscripts and superscripts
10285 @cindex subscript
10286 @cindex superscript
10288 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10289 subscripts.  Again, these can be used without embedding them in math-mode
10290 delimiters.  To increase the readability of ASCII text, it is not necessary
10291 (but OK) to surround multi-character sub- and superscripts with curly braces.
10292 For example
10294 @example
10295 The mass of the sun is M_sun = 1.989 x 10^30 kg.  The radius of
10296 the sun is R_@{sun@} = 6.96 x 10^8 m.
10297 @end example
10299 @vindex org-use-sub-superscripts
10300 If you write a text where the underscore is often used in a different
10301 context, Org's convention to always interpret these as subscripts can get in
10302 your way.  Configure the variable @code{org-use-sub-superscripts} to change
10303 this convention.  For example, when setting this variable to @code{@{@}},
10304 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10306 @table @kbd
10307 @kindex C-c C-x \
10308 @item C-c C-x \
10309 In addition to showing entities as UTF-8 characters, this command will also
10310 format sub- and superscripts in a WYSIWYM way.
10311 @end table
10313 @node @LaTeX{} fragments
10314 @subsection @LaTeX{} fragments
10315 @cindex @LaTeX{} fragments
10317 @vindex org-format-latex-header
10318 Going beyond symbols and sub- and superscripts, a full formula language is
10319 needed.  Org mode can contain @LaTeX{} math fragments, and it supports ways
10320 to process these for several export back-ends.  When exporting to @LaTeX{},
10321 the code is left as it is.  When exporting to HTML, Org can use either
10322 @uref{http://www.mathjax.org, MathJax} (@pxref{Math formatting in HTML
10323 export}) or transcode the math into images (see @pxref{Previewing @LaTeX{}
10324 fragments}).
10326 @LaTeX{} fragments don't need any special marking at all.  The following
10327 snippets will be identified as @LaTeX{} source code:
10328 @itemize @bullet
10329 @item
10330 Environments of any kind@footnote{When MathJax is used, only the
10331 environments recognized by MathJax will be processed.  When
10332 @file{dvipng} program or @file{imagemagick} suite is used to create images,
10333 any @LaTeX{} environment will be handled.}.  The only requirement is that the
10334 @code{\begin} statement appears on a new line, at the beginning of the line
10335 or after whitespaces only.
10336 @item
10337 Text within the usual @LaTeX{} math delimiters.  To avoid conflicts with
10338 currency specifications, single @samp{$} characters are only recognized as
10339 math delimiters if the enclosed text contains at most two line breaks, is
10340 directly attached to the @samp{$} characters with no whitespace in between,
10341 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
10342 For the other delimiters, there is no such restriction, so when in doubt, use
10343 @samp{\(...\)} as inline math delimiters.
10344 @end itemize
10346 @noindent For example:
10348 @example
10349 \begin@{equation@}
10350 x=\sqrt@{b@}
10351 \end@{equation@}
10353 If $a^2=b$ and \( b=2 \), then the solution must be
10354 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10355 @end example
10357 @c FIXME
10358 @c @noindent
10359 @c @vindex org-format-latex-options
10360 @c If you need any of the delimiter ASCII sequences for other purposes, you
10361 @c can configure the option @code{org-format-latex-options} to deselect the
10362 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10364 @vindex org-export-with-latex
10365 @LaTeX{} processing can be configured with the variable
10366 @code{org-export-with-latex}.  The default setting is @code{t} which means
10367 MathJax for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10368 You can also set this variable on a per-file basis using one of these
10369 lines:
10371 @example
10372 #+OPTIONS: tex:t          @r{Do the right thing automatically (MathJax)}
10373 #+OPTIONS: tex:nil        @r{Do not process @LaTeX{} fragments at all}
10374 #+OPTIONS: tex:verbatim   @r{Verbatim export, for jsMath or so}
10375 @end example
10377 @node Previewing @LaTeX{} fragments
10378 @subsection Previewing @LaTeX{} fragments
10379 @cindex @LaTeX{} fragments, preview
10381 @vindex org-latex-create-formula-image-program
10382 If you have a working @LaTeX{} installation and either @file{dvipng} or
10383 @file{convert} installed@footnote{These are respectively available at
10384 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10385 suite. Choose the converter by setting the variable
10386 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10387 fragments can be processed to produce images of the typeset expressions to be
10388 used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
10389 or for inline previewing within Org mode.
10391 @vindex org-format-latex-options
10392 @vindex org-format-latex-header
10393 You can customize the variables @code{org-format-latex-options} and
10394 @code{org-format-latex-header} to influence some aspects of the preview.  In
10395 particular, the @code{:scale} (and for HTML export, @code{:html-scale})
10396 property of the former can be used to adjust the size of the preview images.
10398 @table @kbd
10399 @kindex C-c C-x C-l
10400 @item C-c C-x C-l
10401 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10402 over the source code.  If there is no fragment at point, process all
10403 fragments in the current entry (between two headlines).  When called
10404 with a prefix argument, process the entire subtree.  When called with
10405 two prefix arguments, or when the cursor is before the first headline,
10406 process the entire buffer.
10407 @kindex C-c C-c
10408 @item C-c C-c
10409 Remove the overlay preview images.
10410 @end table
10412 @vindex org-startup-with-latex-preview
10413 You can turn on the previewing of all @LaTeX{} fragments in a file with
10415 @example
10416 #+STARTUP: latexpreview
10417 @end example
10419 To disable it, simply use
10421 @example
10422 #+STARTUP: nolatexpreview
10423 @end example
10425 @node CDLaTeX mode
10426 @subsection Using CD@LaTeX{} to enter math
10427 @cindex CD@LaTeX{}
10429 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10430 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10431 environments and math templates.  Inside Org mode, you can make use of
10432 some of the features of CD@LaTeX{} mode.  You need to install
10433 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10434 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10435 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10436 version @code{org-cdlatex-mode} that comes as part of Org mode.  Turn it
10437 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10438 Org files with
10440 @lisp
10441 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10442 @end lisp
10444 When this mode is enabled, the following features are present (for more
10445 details see the documentation of CD@LaTeX{} mode):
10446 @itemize @bullet
10447 @kindex C-c @{
10448 @item
10449 Environment templates can be inserted with @kbd{C-c @{}.
10450 @item
10451 @kindex @key{TAB}
10452 The @key{TAB} key will do template expansion if the cursor is inside a
10453 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10454 inside such a fragment, see the documentation of the function
10455 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
10456 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10457 correctly inside the first brace.  Another @key{TAB} will get you into
10458 the second brace.  Even outside fragments, @key{TAB} will expand
10459 environment abbreviations at the beginning of a line.  For example, if
10460 you write @samp{equ} at the beginning of a line and press @key{TAB},
10461 this abbreviation will be expanded to an @code{equation} environment.
10462 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10463 @item
10464 @kindex _
10465 @kindex ^
10466 @vindex cdlatex-simplify-sub-super-scripts
10467 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10468 characters together with a pair of braces.  If you use @key{TAB} to move
10469 out of the braces, and if the braces surround only a single character or
10470 macro, they are removed again (depending on the variable
10471 @code{cdlatex-simplify-sub-super-scripts}).
10472 @item
10473 @kindex `
10474 Pressing the backquote @kbd{`} followed by a character inserts math
10475 macros, also outside @LaTeX{} fragments.  If you wait more than 1.5 seconds
10476 after the backquote, a help window will pop up.
10477 @item
10478 @kindex '
10479 Pressing the single-quote @kbd{'} followed by another character modifies
10480 the symbol before point with an accent or a font.  If you wait more than
10481 1.5 seconds after the single-quote, a help window will pop up.  Character
10482 modification will work only inside @LaTeX{} fragments; outside the quote
10483 is normal.
10484 @end itemize
10486 @node Special blocks
10487 @section Special blocks
10488 @cindex Special blocks
10490 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10491 examples}).  It is also possible to create blocks containing raw code
10492 targeted at a specific back-end (e.g., @samp{#+BEGIN_LATEX}).
10494 Any other block is a @emph{special block}.  Its name is case-sensitive.
10496 For example, @samp{#+BEGIN_abstract} and @samp{#+BEGIN_video} are special
10497 blocks.  The first one is useful when exporting to @LaTeX{}, the second one
10498 when exporting to HTML5.
10500 Each export back-end decides if they should be exported, and how.  When the
10501 block is ignored, its contents are still exported, as if the opening and
10502 closing block lines were not there.  For example, when exporting a
10503 @samp{#+BEGIN_test} block, HTML back-end wraps its contents within a
10504 @samp{<div name="test">} tag.
10506 Refer to back-end specific documentation for more information.
10508 @node Exporting
10509 @chapter Exporting
10510 @cindex exporting
10512 The Org mode export facilities can be used to export Org documents or parts
10513 of Org documents to a variety of other formats.  In addition, these
10514 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10515 in foreign buffers so you can author tables and lists in Org syntax and
10516 convert them in place to the target language.
10518 ASCII export produces a readable and simple version of an Org file for
10519 printing and sharing notes.  HTML export allows you to easily publish notes
10520 on the web, or to build full-fledged websites.  @LaTeX{} export lets you use
10521 Org mode and its structured editing functions to create arbitrarily complex
10522 @LaTeX{} files for any kind of document.  OpenDocument Text (ODT) export
10523 allows seamless collaboration across organizational boundaries.  Markdown
10524 export lets you seamlessly collaborate with other developers.  Finally, iCal
10525 export can extract entries with deadlines or appointments to produce a file
10526 in the iCalendar format.
10528 @menu
10529 * The export dispatcher::       The main exporter interface
10530 * Export back-ends::            Built-in export formats
10531 * Export settings::             Generic export settings
10532 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
10533 * Beamer export::               Exporting as a Beamer presentation
10534 * HTML export::                 Exporting to HTML
10535 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
10536 * Markdown export::             Exporting to Markdown
10537 * OpenDocument Text export::    Exporting to OpenDocument Text
10538 * Org export::                  Exporting to Org
10539 * Texinfo export::              Exporting to Texinfo
10540 * iCalendar export::            Exporting to iCalendar
10541 * Other built-in back-ends::    Exporting to a man page
10542 * Export in foreign buffers::   Author tables and lists in Org syntax
10543 * Advanced configuration::      Fine-tuning the export output
10544 @end menu
10546 @node The export dispatcher
10547 @section The export dispatcher
10548 @vindex org-export-dispatch-use-expert-ui
10549 @cindex Export, dispatcher
10551 The main entry point for export related tasks is the dispatcher, a
10552 hierarchical menu from which it is possible to select an export format and
10553 toggle export options@footnote{It is also possible to use a less intrusive
10554 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10555 non-@code{nil} value.  In that case, only a prompt is visible from the
10556 minibuffer.  From there one can still switch back to regular menu by pressing
10557 @key{?}.} from which it is possible to select an export format and to toggle
10558 export options.
10560 @c @quotation
10561 @table @asis
10562 @orgcmd{C-c C-e,org-export-dispatch}
10564 Dispatch for export and publishing commands.  When called with a @kbd{C-u}
10565 prefix argument, repeat the last export command on the current buffer while
10566 preserving toggled options.  If the current buffer hasn't changed and subtree
10567 export was activated, the command will affect that same subtree.
10568 @end table
10569 @c @end quotation
10571 Normally the entire buffer is exported, but if there is an active region
10572 only that part of the buffer will be exported.
10574 Several export options (@pxref{Export settings}) can be toggled from the
10575 export dispatcher with the following key combinations:
10577 @table @kbd
10578 @item C-a
10579 @vindex org-export-async-init-file
10580 Toggle asynchronous export.  Asynchronous export uses an external Emacs
10581 process that is configured with a specified initialization file.
10583 While exporting asynchronously, the output is not displayed, but stored in
10584 a place called ``the export stack''.  This stack can be displayed by calling
10585 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10586 from the dispatcher menu.
10588 @vindex org-export-in-background
10589 To make this behavior the default, customize the variable
10590 @code{org-export-in-background}.
10592 @item C-b
10593 Toggle body-only export.  Its effect depends on the back-end used.
10594 Typically, if the back-end has a header section (like @code{<head>...</head>}
10595 in the HTML back-end), a body-only export will not include this header.
10597 @item C-s
10598 @vindex org-export-initial-scope
10599 Toggle subtree export.  The top heading becomes the document title.
10601 You can change the default state of this option by setting
10602 @code{org-export-initial-scope}.
10604 @item C-v
10605 Toggle visible-only export.  Only export the text that is currently
10606 visible, i.e. not hidden by outline visibility in the buffer.
10607 @end table
10609 @node Export back-ends
10610 @section Export back-ends
10611 @cindex Export, back-ends
10613 An export back-end is a library that translates Org syntax into a foreign
10614 format.  An export format is not available until the proper back-end has been
10615 loaded.
10617 @vindex org-export-backends
10618 By default, the following four back-ends are loaded: @code{ascii},
10619 @code{html}, @code{icalendar} and @code{latex}.  It is possible to add more
10620 (or remove some) by customizing @code{org-export-backends}.
10622 Built-in back-ends include:
10624 @itemize
10625 @item ascii (ASCII format)
10626 @item beamer (@LaTeX{} Beamer format)
10627 @item html (HTML format)
10628 @item icalendar (iCalendar format)
10629 @item latex (@LaTeX{} format)
10630 @item man (Man page format)
10631 @item md (Markdown format)
10632 @item odt (OpenDocument Text format)
10633 @item org (Org format)
10634 @item texinfo (Texinfo format)
10635 @end itemize
10637 Other back-ends might be found in the @code{contrib/} directory
10638 (@pxref{Installation}).
10640 @node Export settings
10641 @section Export settings
10642 @cindex Export, settings
10644 @cindex #+OPTIONS
10645 Export options can be set: globally with variables; for an individual file by
10646 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10647 settings}), by setting individual keywords, or by specifying them in a
10648 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10649 properties (@pxref{Properties and columns}).  Options set at a specific level
10650 override options set at a more general level.
10652 @cindex #+SETUPFILE
10653 In-buffer settings may appear anywhere in the file, either directly or
10654 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10655 Option keyword sets tailored to a particular back-end can be inserted from
10656 the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert
10657 template} command by pressing @key{#}.  To insert keywords individually,
10658 a good way to make sure the keyword is correct is to type @code{#+} and then
10659 to use @kbd{M-<TAB>} for completion.
10661 The export keywords available for every back-end, and their equivalent global
10662 variables, include:
10664 @table @samp
10665 @item AUTHOR
10666 @cindex #+AUTHOR
10667 @vindex user-full-name
10668 The document author (@code{user-full-name}).
10670 @item CREATOR
10671 @cindex #+CREATOR
10672 @vindex org-export-creator-string
10673 Entity responsible for output generation (@code{org-export-creator-string}).
10675 @item DATE
10676 @cindex #+DATE
10677 @vindex org-export-date-timestamp-format
10678 A date or a time-stamp@footnote{The variable
10679 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10680 exported.}.
10682 @item DESCRIPTION
10683 @cindex #+DESCRIPTION
10684 The document description.  Back-ends handle it as they see fit (e.g., for the
10685 XHTML meta tag), if at all.  The keyword is supported by @LaTeX{} back-ends,
10686 HTML back-ends, ASCII back-ends, the Texinfo back-end, and the ODT back-end.  You
10687 can use several such keywords for long descriptions.
10689 @item EMAIL
10690 @cindex #+EMAIL
10691 @vindex user-mail-address
10692 The email address (@code{user-mail-address}).
10694 @item KEYWORDS
10695 @cindex #+KEYWORDS
10696 The keywords defining the contents of the document.  Back-ends handle it as
10697 they see fit (e.g., for the XHTML meta tag), if at all.  The keyword is
10698 supported by @LaTeX{} back-ends, HTML back-ends, ASCII back-ends, the Texinfo
10699 back-end, and the ODT back-end.  You can use several such keywords if the list
10700 is long.
10702 @item LANGUAGE
10703 @cindex #+LANGUAGE
10704 @vindex org-export-default-language
10705 The language used for translating some strings
10706 (@code{org-export-default-language}).  E.g., @samp{#+LANGUAGE: fr} will tell
10707 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10708 clocktable.
10710 @item SELECT_TAGS
10711 @cindex #+SELECT_TAGS
10712 @vindex org-export-select-tags
10713 The tags that select a tree for export (@code{org-export-select-tags}).  The
10714 default value is @code{:export:}.  Within a subtree tagged with
10715 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10716 below).  When headlines are selectively exported with @code{:export:}
10717 anywhere in a file, text before the first headline is ignored.
10719 @item EXCLUDE_TAGS
10720 @cindex #+EXCLUDE_TAGS
10721 @vindex org-export-exclude-tags
10722 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10723 The default value is @code{:noexport:}.  Entries with the @code{:noexport:}
10724 tag will be unconditionally excluded from the export, even if they have an
10725 @code{:export:} tag.  Code blocks contained in excluded subtrees will still
10726 be executed during export even though the subtree is not exported.
10728 @item TITLE
10729 @cindex #+TITLE
10730 The title to be shown.  You can use several such keywords for long titles.
10731 @end table
10733 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10734 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10735 recognizes the following arguments:
10737 @table @code
10738 @item ':
10739 @vindex org-export-with-smart-quotes
10740 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10742 @item *:
10743 Toggle emphasized text (@code{org-export-with-emphasize}).
10745 @item -:
10746 @vindex org-export-with-special-strings
10747 Toggle conversion of special strings
10748 (@code{org-export-with-special-strings}).
10750 @item ::
10751 @vindex org-export-with-fixed-width
10752 Toggle fixed-width sections
10753 (@code{org-export-with-fixed-width}).
10755 @item <:
10756 @vindex org-export-with-timestamps
10757 Toggle inclusion of any time/date active/inactive stamps
10758 (@code{org-export-with-timestamps}).
10760 @item \n:
10761 @vindex org-export-preserve-breaks
10762 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10764 @item ^:
10765 @vindex org-export-with-sub-superscripts
10766 Toggle @TeX{}-like syntax for sub- and superscripts.  If you write "^:@{@}",
10767 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10768 it is (@code{org-export-with-sub-superscripts}).
10770 @item arch:
10771 @vindex org-export-with-archived-trees
10772 Configure export of archived trees.  Can be set to @code{headline} to only
10773 process the headline, skipping its contents
10774 (@code{org-export-with-archived-trees}).
10776 @item author:
10777 @vindex org-export-with-author
10778 Toggle inclusion of author name into exported file
10779 (@code{org-export-with-author}).
10781 @item c:
10782 @vindex org-export-with-clocks
10783 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10785 @item creator:
10786 @vindex org-export-with-creator
10787 Toggle inclusion of creator info into exported file
10788 (@code{org-export-with-creator}).
10790 @item d:
10791 @vindex org-export-with-drawers
10792 Toggle inclusion of drawers, or list drawers to include
10793 (@code{org-export-with-drawers}).
10795 @item date:
10796 @vindex org-export-with-date
10797 Toggle inclusion of a date into exported file (@code{org-export-with-date}).
10799 @item e:
10800 @vindex org-export-with-entities
10801 Toggle inclusion of entities (@code{org-export-with-entities}).
10803 @item email:
10804 @vindex org-export-with-email
10805 Toggle inclusion of the author's e-mail into exported file
10806 (@code{org-export-with-email}).
10808 @item f:
10809 @vindex org-export-with-footnotes
10810 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10812 @item H:
10813 @vindex org-export-headline-levels
10814 Set the number of headline levels for export
10815 (@code{org-export-headline-levels}).  Below that level, headlines are treated
10816 differently.  In most back-ends, they become list items.
10818 @item inline:
10819 @vindex org-export-with-inlinetasks
10820 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10822 @item num:
10823 @vindex org-export-with-section-numbers
10824 @cindex property, UNNUMBERED
10825 Toggle section-numbers (@code{org-export-with-section-numbers}).  It can also
10826 be set to a number @samp{n}, so only headlines at that level or above will be
10827 numbered.  Finally, irrespective of the level of a specific headline, the
10828 numbering of it can be disabled by setting the @code{UNNUMBERED} property to
10829 non-@code{nil}.  This also affects subheadings.
10831 @item p:
10832 @vindex org-export-with-planning
10833 Toggle export of planning information (@code{org-export-with-planning}).
10834 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10835 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10837 @item pri:
10838 @vindex org-export-with-priority
10839 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10841 @item prop:
10842 @vindex org-export-with-properties
10843 Toggle inclusion of property drawers, or list properties to include
10844 (@code{org-export-with-properties}).
10846 @item stat:
10847 @vindex org-export-with-statistics-cookies
10848 Toggle inclusion of statistics cookies
10849 (@code{org-export-with-statistics-cookies}).
10851 @item tags:
10852 @vindex org-export-with-tags
10853 Toggle inclusion of tags, may also be @code{not-in-toc}
10854 (@code{org-export-with-tags}).
10856 @item tasks:
10857 @vindex org-export-with-tasks
10858 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10859 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10860 (@code{org-export-with-tasks}).
10862 @item tex:
10863 @vindex org-export-with-latex
10864 Configure export of @LaTeX{} fragments and environments.  It may be set to
10865 @code{verbatim} (@code{org-export-with-latex}).
10867 @item timestamp:
10868 @vindex org-export-time-stamp-file
10869 Toggle inclusion of the creation time into exported file
10870 (@code{org-export-time-stamp-file}).
10872 @item title:
10873 @vindex org-export-with-title
10874 Toggle inclusion of title (@code{org-export-with-title}).
10876 @item toc:
10877 @vindex org-export-with-toc
10878 Toggle inclusion of the table of contents, or set the level limit
10879 (@code{org-export-with-toc}).
10881 @item todo:
10882 @vindex org-export-with-todo-keywords
10883 Toggle inclusion of TODO keywords into exported text
10884 (@code{org-export-with-todo-keywords}).
10886 @item |:
10887 @vindex org-export-with-tables
10888 Toggle inclusion of tables (@code{org-export-with-tables}).
10890 @end table
10892 When exporting only a subtree, each of the previous keywords@footnote{With
10893 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10894 properties.  These begin with @samp{EXPORT_}, followed by the name of the
10895 keyword they supplant.  For example, @samp{DATE} and @samp{OPTIONS} keywords
10896 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10897 properties.
10899 @cindex #+BIND
10900 @vindex org-export-allow-bind-keywords
10901 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10902 can become buffer-local during export by using the BIND keyword.  Its syntax
10903 is @samp{#+BIND: variable value}.  This is particularly useful for in-buffer
10904 settings that cannot be changed using specific keywords.
10906 @cindex property, EXPORT_FILE_NAME
10907 The name of the output file to be generated is taken from the file associated
10908 to the buffer, when possible, or asked to you otherwise.  For subtree export,
10909 you can also set @code{EXPORT_FILE_NAME} property.  In all cases, only the
10910 base name of the file is retained, and a back-end specific extension is
10911 added.
10913 @node ASCII/Latin-1/UTF-8 export
10914 @section ASCII/Latin-1/UTF-8 export
10915 @cindex ASCII export
10916 @cindex Latin-1 export
10917 @cindex UTF-8 export
10919 ASCII export produces a simple and very readable version of an Org mode
10920 file, containing only plain ASCII@.  Latin-1 and UTF-8 export augment the file
10921 with special characters and symbols available in these encodings.
10923 @vindex org-ascii-text-width
10924 Upon exporting, text is filled and justified, when appropriate, according the
10925 text width set in @code{org-ascii-text-width}.
10927 @vindex org-ascii-links-to-notes
10928 Links are exported in a footnote-like style, with the descriptive part in the
10929 text and the link in a note before the next heading.  See the variable
10930 @code{org-ascii-links-to-notes} for details and other options.
10932 @subheading ASCII export commands
10934 @table @kbd
10935 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10936 Export as an ASCII file.  For an Org file, @file{myfile.org}, the ASCII file
10937 will be @file{myfile.txt}.  The file will be overwritten without warning.
10938 When the original file is @file{myfile.txt}, the resulting file becomes
10939 @file{myfile.txt.txt} in order to prevent data loss.
10940 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10941 Export to a temporary buffer.  Do not create a file.
10942 @end table
10944 @subheading Header and sectioning structure
10946 In the exported version, the first three outline levels become headlines,
10947 defining a general document structure.  Additional levels are exported as
10948 lists.  The transition can also occur at a different level (@pxref{Export
10949 settings}).
10951 @subheading Quoting ASCII text
10953 You can insert text that will only appear when using @code{ASCII} back-end
10954 with the following constructs:
10956 @cindex #+ASCII
10957 @cindex #+BEGIN_ASCII
10958 @example
10959 Text @@@@ascii:and additional text@@@@ within a paragraph.
10961 #+ASCII: Some text
10963 #+BEGIN_ASCII
10964 All lines in this block will appear only when using this back-end.
10965 #+END_ASCII
10966 @end example
10968 @subheading ASCII specific attributes
10969 @cindex #+ATTR_ASCII
10970 @cindex horizontal rules, in ASCII export
10972 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10973 specifies the length, in characters, of a given horizontal rule.  It must be
10974 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
10976 @example
10977 #+ATTR_ASCII: :width 10
10978 -----
10979 @end example
10981 @subheading ASCII special blocks
10982 @cindex special blocks, in ASCII export
10983 @cindex #+BEGIN_JUSTIFYLEFT
10984 @cindex #+BEGIN_JUSTIFYRIGHT
10986 In addition to @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), it is
10987 possible to justify contents to the left or the right of the page with the
10988 following dedicated blocks.
10990 @example
10991 #+BEGIN_JUSTIFYLEFT
10992 It's just a jump to the left...
10993 #+END_JUSTIFYLEFT
10995 #+BEGIN_JUSTIFYRIGHT
10996 ...and then a step to the right.
10997 #+END_JUSTIFYRIGHT
10998 @end example
11000 @node Beamer export
11001 @section Beamer export
11002 @cindex Beamer export
11004 The @LaTeX{} class @emph{Beamer} allows production of high quality
11005 presentations using @LaTeX{} and pdf processing.  Org mode has special
11006 support for turning an Org mode file or tree into a Beamer presentation.
11008 @subheading Beamer export commands
11010 @table @kbd
11011 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
11012 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
11013 file will be @file{myfile.tex}.  The file will be overwritten without
11014 warning.
11015 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
11016 Export to a temporary buffer.  Do not create a file.
11017 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
11018 Export as @LaTeX{} and then process to PDF.
11019 @item C-c C-e l O
11020 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11021 @end table
11023 @subheading Sectioning, Frames and Blocks
11025 Any tree with not-too-deep level nesting should in principle be exportable as
11026 a Beamer presentation.  Headlines fall into three categories: sectioning
11027 elements, frames and blocks.
11029 @itemize @minus
11030 @item
11031 @vindex org-beamer-frame-level
11032 Headlines become frames when their level is equal to
11033 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
11034 (@pxref{Export settings}).
11036 @cindex property, BEAMER_ENV
11037 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
11038 set to either to @code{frame} or @code{fullframe}, its level overrides the
11039 variable.  A @code{fullframe} is a frame with an empty (ignored) title.
11041 @item
11042 @vindex org-beamer-environments-default
11043 @vindex org-beamer-environments-extra
11044 All frame's children become @code{block} environments.  Special block types
11045 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
11046 this property is set, the entry will also get a @code{:B_environment:} tag to
11047 make this visible.  This tag has no semantic meaning, it is only a visual
11048 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
11049 supported values and @code{org-beamer-environments-extra} for adding more).
11051 @item
11052 @cindex property, BEAMER_REF
11053 As a special case, if the @code{BEAMER_ENV} property is set to either
11054 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
11055 headline will become, respectively, an appendix, a note (within frame or
11056 between frame, depending on its level), a note with its title ignored or an
11057 @code{\againframe} command.  In the latter case, a @code{BEAMER_REF} property
11058 is mandatory in order to refer to the frame being resumed, and contents are
11059 ignored.
11061 Also, a headline with an @code{ignoreheading} environment will have its
11062 contents only inserted in the output.  This special value is useful to have
11063 data between frames, or to properly close a @code{column} environment.
11064 @end itemize
11066 @cindex property, BEAMER_ACT
11067 @cindex property, BEAMER_OPT
11068 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
11069 The former is translated as an overlay/action specification, or a default
11070 overlay specification when enclosed within square brackets.  The latter
11071 specifies options@footnote{The @code{fragile} option is added automatically
11072 if it contains code that requires a verbatim environment, though.} for the
11073 current frame or block.  The export back-end will automatically wrap
11074 properties within angular or square brackets when appropriate.
11076 @cindex property, BEAMER_COL
11077 Moreover, headlines handle the @code{BEAMER_COL} property.  Its value should
11078 be a decimal number representing the width of the column as a fraction of the
11079 total text width.  If the headline has no specific environment, its title
11080 will be ignored and its contents will fill the column created.  Otherwise,
11081 the block will fill the whole column and the title will be preserved.  Two
11082 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
11083 @code{columns} @LaTeX{} environment.  It will end before the next headline
11084 without such a property.  This environment is generated automatically.
11085 Although, it can also be explicitly created, with a special @code{columns}
11086 value for @code{BEAMER_ENV} property (if it needs to be set up with some
11087 specific options, for example).
11089 @subheading Beamer specific syntax
11091 Beamer back-end is an extension of @LaTeX{} back-end.  As such, all @LaTeX{}
11092 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
11093 recognized.  See @ref{@LaTeX{} and PDF export} for more information.
11095 @cindex #+BEAMER_THEME
11096 @cindex #+BEAMER_COLOR_THEME
11097 @cindex #+BEAMER_FONT_THEME
11098 @cindex #+BEAMER_INNER_THEME
11099 @cindex #+BEAMER_OUTER_THEME
11100 Beamer export introduces a number of keywords to insert code in the
11101 document's header.  Four control appearance of the presentation:
11102 @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
11103 @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
11104 @code{#+BEAMER_OUTER_THEME}.  All of them accept optional arguments within
11105 square brackets.  The last one, @code{#+BEAMER_HEADER}, is more generic and
11106 allows you to append any line of code in the header@footnote{Lines are
11107 appended at the end of the preamble, allowing for any final customization
11108 such as the inclusion of short titles.}.
11110 @example
11111 #+BEAMER_THEME: Rochester [height=20pt]
11112 #+BEAMER_COLOR_THEME: spruce
11113 @end example
11115 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
11116 wrapped within a @code{frame} environment.  Those generated from a @code{TOC}
11117 keyword (@pxref{Table of contents}) are not.  In that case, it is also
11118 possible to specify options, enclosed within square brackets.
11120 @example
11121 #+TOC: headlines [currentsection]
11122 @end example
11124 Beamer specific code can be inserted with the following constructs:
11126 @cindex #+BEAMER
11127 @cindex #+BEGIN_BEAMER
11128 @example
11129 #+BEAMER: \pause
11131 #+BEGIN_BEAMER
11132 All lines in this block will appear only when using this back-end.
11133 #+END_BEAMER
11135 Text @@@@beamer:some code@@@@ within a paragraph.
11136 @end example
11138 In particular, this last example can be used to add overlay specifications to
11139 objects whose type is among @code{bold}, @code{item}, @code{link},
11140 @code{radio-target} and @code{target}, when the value is enclosed within
11141 angular brackets and put at the beginning the object.
11143 @example
11144 A *@@@@beamer:<2->@@@@useful* feature
11145 @end example
11147 @cindex #+ATTR_BEAMER
11148 Eventually, every plain list has support for @code{:environment},
11149 @code{:overlay} and @code{:options} attributes through
11150 @code{ATTR_BEAMER} affiliated keyword.  The first one allows the use
11151 of a different environment, the second sets overlay specifications and
11152 the last one inserts optional arguments in current list environment.
11154 @example
11155 #+ATTR_BEAMER: :overlay +-
11156 - item 1
11157 - item 2
11158 @end example
11160 @subheading Editing support
11162 You can turn on a special minor mode @code{org-beamer-mode} for faster
11163 editing with:
11165 @example
11166 #+STARTUP: beamer
11167 @end example
11169 @table @kbd
11170 @orgcmd{C-c C-b,org-beamer-select-environment}
11171 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
11172 environment or the @code{BEAMER_COL} property.
11173 @end table
11175 @subheading An example
11177 Here is a simple example Org document that is intended for Beamer export.
11179 @smallexample
11180 #+TITLE: Example Presentation
11181 #+AUTHOR: Carsten Dominik
11182 #+OPTIONS: H:2 toc:t num:t
11183 #+LATEX_CLASS: beamer
11184 #+LATEX_CLASS_OPTIONS: [presentation]
11185 #+BEAMER_THEME: Madrid
11186 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
11188 * This is the first structural section
11190 ** Frame 1
11191 *** Thanks to Eric Fraga                                           :B_block:
11192     :PROPERTIES:
11193     :BEAMER_COL: 0.48
11194     :BEAMER_ENV: block
11195     :END:
11196     for the first viable Beamer setup in Org
11197 *** Thanks to everyone else                                        :B_block:
11198     :PROPERTIES:
11199     :BEAMER_COL: 0.48
11200     :BEAMER_ACT: <2->
11201     :BEAMER_ENV: block
11202     :END:
11203     for contributing to the discussion
11204 **** This will be formatted as a beamer note                       :B_note:
11205      :PROPERTIES:
11206      :BEAMER_env: note
11207      :END:
11208 ** Frame 2 (where we will not use columns)
11209 *** Request
11210     Please test this stuff!
11211 @end smallexample
11213 @node HTML export
11214 @section HTML export
11215 @cindex HTML export
11217 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
11218 HTML formatting, in ways similar to John Gruber's @emph{markdown}
11219 language, but with additional support for tables.
11221 @menu
11222 * HTML Export commands::        How to invoke HTML export
11223 * HTML doctypes::               Org can export to various (X)HTML flavors
11224 * HTML preamble and postamble::  How to insert a preamble and a postamble
11225 * Quoting HTML tags::           Using direct HTML in Org mode
11226 * Links in HTML export::        How links will be interpreted and formatted
11227 * Tables in HTML export::       How to modify the formatting of tables
11228 * Images in HTML export::       How to insert figures into HTML output
11229 * Math formatting in HTML export::  Beautiful math also on the web
11230 * Text areas in HTML export::   An alternative way to show an example
11231 * CSS support::                 Changing the appearance of the output
11232 * JavaScript support::          Info and Folding in a web browser
11233 @end menu
11235 @node HTML Export commands
11236 @subsection HTML export commands
11238 @table @kbd
11239 @orgcmd{C-c C-e h h,org-html-export-to-html}
11240 Export as an HTML file.  For an Org file @file{myfile.org},
11241 the HTML file will be @file{myfile.html}.  The file will be overwritten
11242 without warning.
11243 @kbd{C-c C-e h o}
11244 Export as an HTML file and immediately open it with a browser.
11245 @orgcmd{C-c C-e h H,org-html-export-as-html}
11246 Export to a temporary buffer.  Do not create a file.
11247 @end table
11249 @c FIXME Exporting sublevels
11250 @c @cindex headline levels, for exporting
11251 @c In the exported version, the first 3 outline levels will become headlines,
11252 @c defining a general document structure.  Additional levels will be exported as
11253 @c itemized lists.  If you want that transition to occur at a different level,
11254 @c specify it with a numeric prefix argument.  For example,
11256 @c @example
11257 @c @kbd{C-2 C-c C-e b}
11258 @c @end example
11260 @c @noindent
11261 @c creates two levels of headings and does the rest as items.
11263 @node HTML doctypes
11264 @subsection HTML doctypes
11265 @vindex org-html-doctype
11266 @vindex org-html-doctype-alist
11268 Org can export to various (X)HTML flavors.
11270 Setting the variable @code{org-html-doctype} allows you to export to different
11271 (X)HTML variants.  The exported HTML will be adjusted according to the syntax
11272 requirements of that variant.  You can either set this variable to a doctype
11273 string directly, in which case the exporter will try to adjust the syntax
11274 automatically, or you can use a ready-made doctype.  The ready-made options
11275 are:
11277 @itemize
11278 @item
11279 ``html4-strict''
11280 @item
11281 ``html4-transitional''
11282 @item
11283 ``html4-frameset''
11284 @item
11285 ``xhtml-strict''
11286 @item
11287 ``xhtml-transitional''
11288 @item
11289 ``xhtml-frameset''
11290 @item
11291 ``xhtml-11''
11292 @item
11293 ``html5''
11294 @item
11295 ``xhtml5''
11296 @end itemize
11298 See the variable @code{org-html-doctype-alist} for details.  The default is
11299 ``xhtml-strict''.
11301 @subsubheading Fancy HTML5 export
11302 @vindex org-html-html5-fancy
11303 @vindex org-html-html5-elements
11305 HTML5 introduces several new element types.  By default, Org will not make
11306 use of these element types, but you can set @code{org-html-html5-fancy} to
11307 @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11308 enable a few new block-level elements.  These are created using arbitrary
11309 #+BEGIN and #+END blocks. For instance:
11311 @example
11312 #+BEGIN_ASIDE
11313 Lorem ipsum
11314 #+END_ASIDE
11315 @end example
11317 Will export to:
11319 @example
11320 <aside>
11321   <p>Lorem ipsum</p>
11322 </aside>
11323 @end example
11325 While this:
11327 @example
11328 #+ATTR_HTML: :controls controls :width 350
11329 #+BEGIN_VIDEO
11330 #+HTML: <source src="movie.mp4" type="video/mp4">
11331 #+HTML: <source src="movie.ogg" type="video/ogg">
11332 Your browser does not support the video tag.
11333 #+END_VIDEO
11334 @end example
11336 Becomes:
11338 @example
11339 <video controls="controls" width="350">
11340   <source src="movie.mp4" type="video/mp4">
11341   <source src="movie.ogg" type="video/ogg">
11342   <p>Your browser does not support the video tag.</p>
11343 </video>
11344 @end example
11346 Special blocks that do not correspond to HTML5 elements (see
11347 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11348 @code{#+BEGIN_lederhosen} will still export to @samp{<div class="lederhosen">}.
11350 Headlines cannot appear within special blocks.  To wrap a headline and its
11351 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11352 @code{HTML_CONTAINER} property on the headline itself.
11354 @node HTML preamble and postamble
11355 @subsection HTML preamble and postamble
11356 @vindex org-html-preamble
11357 @vindex org-html-postamble
11358 @vindex org-html-preamble-format
11359 @vindex org-html-postamble-format
11360 @vindex org-html-validation-link
11361 @vindex org-export-creator-string
11362 @vindex org-export-time-stamp-file
11364 The HTML exporter lets you define a preamble and a postamble.
11366 The default value for @code{org-html-preamble} is @code{t}, which means
11367 that the preamble is inserted depending on the relevant format string in
11368 @code{org-html-preamble-format}.
11370 Setting @code{org-html-preamble} to a string will override the default format
11371 string.  If you set it to a function, it will insert the output of the
11372 function, which must be a string.  Setting to @code{nil} will not insert any
11373 preamble.
11375 The default value for @code{org-html-postamble} is @code{'auto}, which means
11376 that the HTML exporter will look for information about the author, the email,
11377 the creator and the date, and build the postamble from these values.  Setting
11378 @code{org-html-postamble} to @code{t} will insert the postamble from the
11379 relevant format string found in @code{org-html-postamble-format}.  Setting it
11380 to @code{nil} will not insert any postamble.
11382 @node Quoting HTML tags
11383 @subsection Quoting HTML tags
11385 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
11386 @samp{&gt;} in HTML export.  If you want to include raw HTML code, which
11387 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11388 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}.  For more extensive HTML
11389 that should be copied verbatim to the exported file use either
11391 @cindex #+HTML
11392 @cindex #+BEGIN_HTML
11393 @example
11394 #+HTML: Literal HTML code for export
11395 @end example
11397 @noindent or
11398 @cindex #+BEGIN_HTML
11400 @example
11401 #+BEGIN_HTML
11402 All lines between these markers are exported literally
11403 #+END_HTML
11404 @end example
11407 @node Links in HTML export
11408 @subsection Links in HTML export
11410 @cindex links, in HTML export
11411 @cindex internal links, in HTML export
11412 @cindex external links, in HTML export
11413 @vindex org-html-link-org-files-as-html
11414 Internal links (@pxref{Internal links}) will continue to work in HTML@.  This
11415 includes automatic links created by radio targets (@pxref{Radio
11416 targets}).  Links to external files will still work if the target file is on
11417 the same @i{relative} path as the published Org file.  Links to other
11418 @file{.org} files will be translated into HTML links under the assumption
11419 that an HTML version also exists of the linked file, at the same relative
11420 path; setting @code{org-html-link-org-files-as-html} to @code{nil} disables
11421 this translation.  @samp{id:} links can then be used to jump to specific
11422 entries across files.  For information related to linking files while
11423 publishing them to a publishing directory see @ref{Publishing links}.
11425 If you want to specify attributes for links, you can do so using a special
11426 @code{#+ATTR_HTML} line to define attributes that will be added to the
11427 @code{<a>} or @code{<img>} tags.  Here is an example that sets @code{title}
11428 and @code{style} attributes for a link:
11430 @cindex #+ATTR_HTML
11431 @example
11432 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11433 [[http://orgmode.org]]
11434 @end example
11436 @node Tables in HTML export
11437 @subsection Tables in HTML export
11438 @cindex tables, in HTML
11439 @vindex org-html-table-default-attributes
11441 Org mode tables are exported to HTML using the table attributes defined in
11442 @code{org-html-table-default-attributes}.  The default setting makes tables
11443 without cell borders and frame.  If you would like to change this for
11444 individual tables, place something like the following before the table:
11446 @cindex #+CAPTION
11447 @cindex #+ATTR_HTML
11448 @example
11449 #+CAPTION: This is a table with lines around and between cells
11450 #+ATTR_HTML: :border 2 :rules all :frame border
11451 @end example
11453 You can also group columns in the HTML output (@pxref{Column groups}).
11455 Below is a list of options for customizing tables HTML export.
11457 @table @code
11458 @vindex org-html-table-align-individual-fields
11459 @item org-html-table-align-individual-fields
11460 Non-@code{nil} means attach style attributes for alignment to each table field.
11462 @vindex org-html-table-caption-above
11463 @item org-html-table-caption-above
11464 When non-@code{nil}, place caption string at the beginning of the table.
11466 @vindex org-html-table-data-tags
11467 @item org-html-table-data-tags
11468 The opening and ending tags for table data fields.
11470 @vindex org-html-table-default-attributes
11471 @item org-html-table-default-attributes
11472 Default attributes and values which will be used in table tags.
11474 @vindex org-html-table-header-tags
11475 @item org-html-table-header-tags
11476 The opening and ending tags for table header fields.
11478 @vindex org-html-table-row-tags
11479 @item org-html-table-row-tags
11480 The opening and ending tags for table rows.
11482 @vindex org-html-table-use-header-tags-for-first-column
11483 @item org-html-table-use-header-tags-for-first-column
11484 Non-@code{nil} means format column one in tables with header tags.
11485 @end table
11487 @node Images in HTML export
11488 @subsection Images in HTML export
11490 @cindex images, inline in HTML
11491 @cindex inlining images in HTML
11492 @vindex org-html-inline-images
11493 HTML export can inline images given as links in the Org file, and
11494 it can make an image the clickable part of a link.  By
11495 default@footnote{But see the variable
11496 @code{org-html-inline-images}.}, images are inlined if a link does
11497 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
11498 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11499 @samp{the image} that points to the image.  If the description part
11500 itself is a @code{file:} link or a @code{http:} URL pointing to an
11501 image, this image will be inlined and activated so that clicking on the
11502 image will activate the link.  For example, to include a thumbnail that
11503 will link to a high resolution version of the image, you could use:
11505 @example
11506 [[file:highres.jpg][file:thumb.jpg]]
11507 @end example
11509 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11510 In the example below we specify the @code{alt} and @code{title} attributes to
11511 support text viewers and accessibility, and align it to the right.
11513 @cindex #+CAPTION
11514 @cindex #+ATTR_HTML
11515 @example
11516 #+CAPTION: A black cat stalking a spider
11517 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11518 [[./img/a.jpg]]
11519 @end example
11521 @noindent
11522 You could use @code{http} addresses just as well.
11524 @node Math formatting in HTML export
11525 @subsection Math formatting in HTML export
11526 @cindex MathJax
11527 @cindex dvipng
11528 @cindex imagemagick
11530 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11531 different ways on HTML pages.  The default is to use
11532 @uref{http://www.mathjax.org, MathJax} which should work out of the box with
11533 Org@footnote{By default Org loads MathJax from
11534 @uref{http://docs.mathjax.org/en/latest/start.html#using-the-mathjax-content-delivery-network-cdn,
11535 MathJax.org}.  A link to the terms of service of the MathJax CDN can be found
11536 in the docstring of @code{org-html-mathjax-options}.}.  Some MathJax display
11537 options can be configured via @code{org-html-mathjax-options}, or in the
11538 buffer.  For example, with the following settings,
11539 @smallexample
11540 #+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
11541 @end smallexample
11542 equation labels will be displayed on the left marign and equations will be
11543 five ems from the left margin.
11545 @noindent See the docstring of
11546 @code{org-html-mathjax-options} for all supported variables.  The MathJax
11547 template can be configure via @code{org-html-mathjax-template}.
11549 If you prefer, you can also request that @LaTeX{} fragments are processed
11550 into small images that will be inserted into the browser page.  Before the
11551 availability of MathJax, this was the default method for Org files.  This
11552 method requires that the @file{dvipng} program or @file{imagemagick} suite is
11553 available on your system.  You can still get this processing with
11555 @example
11556 #+OPTIONS: tex:dvipng
11557 @end example
11561 @example
11562 #+OPTIONS: tex:imagemagick
11563 @end example
11565 @node Text areas in HTML export
11566 @subsection Text areas in HTML export
11568 @cindex text areas, in HTML
11569 An alternative way to publish literal code examples in HTML is to use text
11570 areas, where the example can even be edited before pasting it into an
11571 application.  It is triggered by @code{:textarea} attribute at an
11572 @code{example} or @code{src} block.
11574 You may also use @code{:height} and @code{:width} attributes to specify the
11575 height and width of the text area, which default to the number of lines in
11576 the example, and 80, respectively.  For example
11578 @example
11579 #+ATTR_HTML: :textarea t :width 40
11580 #+BEGIN_EXAMPLE
11581   (defun org-xor (a b)
11582      "Exclusive or."
11583      (if a (not b) b))
11584 #+END_EXAMPLE
11585 @end example
11588 @node CSS support
11589 @subsection CSS support
11590 @cindex CSS, for HTML export
11591 @cindex HTML export, CSS
11593 @vindex org-html-todo-kwd-class-prefix
11594 @vindex org-html-tag-class-prefix
11595 You can modify the CSS style definitions for the exported file.  The HTML
11596 exporter assigns the following special CSS classes@footnote{If the classes on
11597 TODO keywords and tags lead to conflicts, use the variables
11598 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11599 make them unique.} to appropriate parts of the document---your style
11600 specifications may change these, in addition to any of the standard classes
11601 like for headlines, tables, etc.
11602 @example
11603 p.author            @r{author information, including email}
11604 p.date              @r{publishing date}
11605 p.creator           @r{creator info, about org mode version}
11606 .title              @r{document title}
11607 .todo               @r{TODO keywords, all not-done states}
11608 .done               @r{the DONE keywords, all states that count as done}
11609 .WAITING            @r{each TODO keyword also uses a class named after itself}
11610 .timestamp          @r{timestamp}
11611 .timestamp-kwd      @r{keyword associated with a timestamp, like SCHEDULED}
11612 .timestamp-wrapper  @r{span around keyword plus timestamp}
11613 .tag                @r{tag in a headline}
11614 ._HOME              @r{each tag uses itself as a class, "@@" replaced by "_"}
11615 .target             @r{target for links}
11616 .linenr             @r{the line number in a code example}
11617 .code-highlighted   @r{for highlighting referenced code lines}
11618 div.outline-N       @r{div for outline level N (headline plus text))}
11619 div.outline-text-N  @r{extra div for text at outline level N}
11620 .section-number-N   @r{section number in headlines, different for each level}
11621 .figure-number      @r{label like "Figure 1:"}
11622 .table-number       @r{label like "Table 1:"}
11623 .listing-number     @r{label like "Listing 1:"}
11624 div.figure          @r{how to format an inlined image}
11625 pre.src             @r{formatted source code}
11626 pre.example         @r{normal example}
11627 p.verse             @r{verse paragraph}
11628 div.footnotes       @r{footnote section headline}
11629 p.footnote          @r{footnote definition paragraph, containing a footnote}
11630 .footref            @r{a footnote reference number (always a <sup>)}
11631 .footnum            @r{footnote number in footnote definition (always <sup>)}
11632 @end example
11634 @vindex org-html-style-default
11635 @vindex org-html-head-include-default-style
11636 @vindex org-html-head
11637 @vindex org-html-head-extra
11638 @cindex #+HTML_INCLUDE_STYLE
11639 Each exported file contains a compact default style that defines these
11640 classes in a basic way@footnote{This style is defined in the constant
11641 @code{org-html-style-default}, which you should not modify.  To turn
11642 inclusion of these defaults off, customize
11643 @code{org-html-head-include-default-style} or set @code{html-style} to
11644 @code{nil} in an @code{OPTIONS} line.}.  You may overwrite these settings, or
11645 add to them by using the variables @code{org-html-head} and
11646 @code{org-html-head-extra}.  You can override the global values of these
11647 variables for each file by using these keywords:
11649 @cindex #+HTML_HEAD
11650 @cindex #+HTML_HEAD_EXTRA
11651 @example
11652 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11653 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11654 @end example
11656 @noindent
11657 For longer style definitions, you can use several such lines.  You could also
11658 directly write a @code{<style>} @code{</style>} section in this way, without
11659 referring to an external file.
11661 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11662 property to assign a class to the tree.  In order to specify CSS styles for a
11663 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11664 property.
11666 @c FIXME: More about header and footer styles
11667 @c FIXME: Talk about links and targets.
11669 @node JavaScript support
11670 @subsection JavaScript supported display of web pages
11672 @cindex Rose, Sebastian
11673 Sebastian Rose has written a JavaScript program especially designed to
11674 enhance the web viewing experience of HTML files created with Org.  This
11675 program allows you to view large files in two different ways.  The first one
11676 is an @emph{Info}-like mode where each section is displayed separately and
11677 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11678 as well, press @kbd{?} for an overview of the available keys).  The second
11679 view type is a @emph{folding} view much like Org provides inside Emacs.  The
11680 script is available at @url{http://orgmode.org/org-info.js} and you can find
11681 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11682 We host the script at our site, but if you use it a lot, you might not want
11683 to be dependent on @url{http://orgmode.org} and prefer to install a local
11684 copy on your own web server.
11686 All it then takes to use this program is adding a single line to the Org
11687 file:
11689 @cindex #+INFOJS_OPT
11690 @example
11691 #+INFOJS_OPT: view:info toc:nil
11692 @end example
11694 @noindent
11695 If this line is found, the HTML header will automatically contain the code
11696 needed to invoke the script.  Using the line above, you can set the following
11697 viewing options:
11699 @example
11700 path:    @r{The path to the script.  The default is to grab the script from}
11701          @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11702          @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11703 view:    @r{Initial view when the website is first shown.  Possible values are:}
11704          info      @r{Info-like interface with one section per page.}
11705          overview  @r{Folding interface, initially showing only top-level.}
11706          content   @r{Folding interface, starting with all headlines visible.}
11707          showall   @r{Folding interface, all headlines and text visible.}
11708 sdepth:  @r{Maximum headline level that will still become an independent}
11709          @r{section for info and folding modes.  The default is taken from}
11710          @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11711          @r{If this is smaller than in @code{org-export-headline-levels}, each}
11712          @r{info/folding section can still contain child headlines.}
11713 toc:     @r{Should the table of contents @emph{initially} be visible?}
11714          @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11715 tdepth:  @r{The depth of the table of contents.  The defaults are taken from}
11716          @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11717 ftoc:    @r{Does the CSS of the page specify a fixed position for the "toc"?}
11718          @r{If yes, the toc will never be displayed as a section.}
11719 ltoc:    @r{Should there be short contents (children) in each section?}
11720          @r{Make this @code{above} if the section should be above initial text.}
11721 mouse:   @r{Headings are highlighted when the mouse is over them.  Should be}
11722          @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11723 buttons: @r{Should view-toggle buttons be everywhere?  When @code{nil} (the}
11724          @r{default), only one such button will be present.}
11725 @end example
11726 @noindent
11727 @vindex org-html-infojs-options
11728 @vindex org-html-use-infojs
11729 You can choose default values for these options by customizing the variable
11730 @code{org-html-infojs-options}.  If you always want to apply the script to your
11731 pages, configure the variable @code{org-html-use-infojs}.
11733 @node @LaTeX{} and PDF export
11734 @section @LaTeX{} and PDF export
11735 @cindex @LaTeX{} export
11736 @cindex PDF export
11738 @LaTeX{} export can produce an arbitrarily complex LaTeX document of any
11739 standard or custom document class.  With further processing@footnote{The
11740 default @LaTeX{} output is designed for processing with @code{pdftex} or
11741 @code{latex}.  The @LaTeX{} exporter can be configured to support alternative
11742 TeX engines, see see @code{org-latex-pdf-process}, and alternative packages,
11743 see @code{org-latex-default-packages-alist} and
11744 @code{org-latex-packages-alist}.}, which the @LaTeX{} exporter is able to
11745 control, this back-end is able to produce PDF output.  Because the @LaTeX{}
11746 exporter can be configured to use the @code{hyperref} package, the default
11747 setup produces fully-linked PDF output.
11749 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11750 will not be started if two contiguous syntactical elements are not separated
11751 by an empty line.
11753 This back-end also offers enhanced support for footnotes.  Thus, it handles
11754 nested footnotes, footnotes in tables and footnotes in a list item's
11755 description.
11757 @menu
11758 * @LaTeX{} export commands::    How to export to LaTeX and PDF
11759 * Header and sectioning::       Setting up the export file structure
11760 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
11761 * @LaTeX{} specific attributes::  Controlling @LaTeX{} output
11762 @end menu
11764 @node @LaTeX{} export commands
11765 @subsection @LaTeX{} export commands
11767 @table @kbd
11768 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11769 Export as a @LaTeX{} file.  For an Org file @file{myfile.org}, the @LaTeX{}
11770 file will be @file{myfile.tex}.  The file will be overwritten without
11771 warning.
11772 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11773 Export to a temporary buffer.  Do not create a file.
11774 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11775 Export as @LaTeX{} and then process to PDF.
11776 @item C-c C-e l o
11777 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11778 @end table
11780 @node Header and sectioning
11781 @subsection Header and sectioning structure
11782 @cindex @LaTeX{} class
11783 @cindex @LaTeX{} sectioning structure
11784 @cindex @LaTeX{} header
11785 @cindex header, for @LaTeX{} files
11786 @cindex sectioning structure, for @LaTeX{} export
11788 By default, the first three outline levels become headlines, defining a
11789 general document structure.  Additional levels are exported as @code{itemize}
11790 or @code{enumerate} lists.  The transition can also occur at a different
11791 level (@pxref{Export settings}).
11793 By default, the @LaTeX{} output uses the class @code{article}.
11795 @vindex org-latex-default-class
11796 @vindex org-latex-classes
11797 @vindex org-latex-default-packages-alist
11798 @vindex org-latex-packages-alist
11799 You can change this globally by setting a different value for
11800 @code{org-latex-default-class} or locally by adding an option like
11801 @code{#+LATEX_CLASS: myclass} in your file, or with
11802 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11803 containing only this (sub)tree.  The class must be listed in
11804 @code{org-latex-classes}.  This variable defines a header template for each
11805 class@footnote{Into which the values of
11806 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
11807 are spliced.}, and allows you to define the sectioning structure for each
11808 class.  You can also define your own classes there.
11810 @cindex #+LATEX_CLASS
11811 @cindex #+LATEX_CLASS_OPTIONS
11812 @cindex property, EXPORT_LATEX_CLASS
11813 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
11814 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
11815 property can specify the options for the @code{\documentclass} macro.  These
11816 options have to be provided, as expected by @LaTeX{}, within square brackets.
11818 @cindex #+LATEX_HEADER
11819 @cindex #+LATEX_HEADER_EXTRA
11820 You can also use the @code{LATEX_HEADER} and
11821 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
11822 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
11823 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
11824 to add lines to the header.  See the docstring of @code{org-latex-classes} for
11825 more information.
11827 An example is shown below.
11829 @example
11830 #+LATEX_CLASS: article
11831 #+LATEX_CLASS_OPTIONS: [a4paper]
11832 #+LATEX_HEADER: \usepackage@{xyz@}
11834 * Headline 1
11835   some text
11836 @end example
11838 @node Quoting @LaTeX{} code
11839 @subsection Quoting @LaTeX{} code
11841 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11842 inserted into the @LaTeX{} file.  Furthermore, you can add special code that
11843 should only be present in @LaTeX{} export with the following constructs:
11845 @cindex #+LATEX
11846 @cindex #+BEGIN_LATEX
11847 @example
11848 Code within @@@@latex:some code@@@@ a paragraph.
11850 #+LATEX: Literal @LaTeX{} code for export
11852 #+BEGIN_LATEX
11853 All lines between these markers are exported literally
11854 #+END_LATEX
11855 @end example
11857 @node @LaTeX{} specific attributes
11858 @subsection @LaTeX{} specific attributes
11859 @cindex #+ATTR_LATEX
11861 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line.  They
11862 affect tables, images, plain lists, special blocks and source blocks.
11864 @subsubheading Tables in @LaTeX{} export
11865 @cindex tables, in @LaTeX{} export
11867 For @LaTeX{} export of a table, you can specify a label and a caption
11868 (@pxref{Images and tables}).  You can also use attributes to control table
11869 layout and contents.  Valid @LaTeX{} attributes include:
11871 @table @code
11872 @item :mode
11873 @vindex org-latex-default-table-mode
11874 Nature of table's contents.  It can be set to @code{table}, @code{math},
11875 @code{inline-math} or @code{verbatim}.  In particular, when in @code{math} or
11876 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11877 ignored and the table will be wrapped in a math environment.  Also,
11878 contiguous tables sharing the same math mode will be wrapped within the same
11879 environment.  Default mode is determined in
11880 @code{org-latex-default-table-mode}.
11881 @item :environment
11882 @vindex org-latex-default-table-environment
11883 Environment used for the table.  It can be set to any @LaTeX{} table
11884 environment, like @code{tabularx}@footnote{Requires adding the
11885 @code{tabularx} package to @code{org-latex-packages-alist}.},
11886 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
11887 @code{tabu} package to @code{org-latex-packages-alist}.},
11888 @code{bmatrix}@enddots{} It defaults to
11889 @code{org-latex-default-table-environment} value.
11890 @item :caption
11891 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
11892 (@pxref{Images and tables}).  If you need more advanced commands for that
11893 task, you can use @code{:caption} attribute instead.  Its value should be raw
11894 @LaTeX{} code.  It has precedence over @code{#+CAPTION}.
11895 @item :float
11896 @itemx :placement
11897 The @code{:float} specifies the float environment for the table.  Possible
11898 values are @code{sideways}@footnote{Formerly, the value was
11899 @code{sidewaystable}.  This is deprecated since Org 8.3.},
11900 @code{multicolumn}, @code{t} and @code{nil}.  When unspecified, a table with
11901 a caption will have a @code{table} environment.  Moreover, the
11902 @code{:placement} attribute can specify the positioning of the float.  Note:
11903 @code{:placement} is ignored for @code{:float sideways} tables.
11904 @item :align
11905 @itemx :font
11906 @itemx :width
11907 Set, respectively, the alignment string of the table, its font size and its
11908 width.  They only apply on regular tables.
11909 @item :spread
11910 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11911 only takes effect when used in conjunction with the @code{:width} attribute.
11912 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
11913 value of @code{:width}.
11914 @item :booktabs
11915 @itemx :center
11916 @itemx :rmlines
11917 @vindex org-latex-tables-booktabs
11918 @vindex org-latex-tables-centered
11919 They toggle, respectively, @code{booktabs} usage (assuming the package is
11920 properly loaded), table centering and removal of every horizontal rule but
11921 the first one (in a "table.el" table only).  In particular,
11922 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
11923 activates the first (respectively second) attribute globally.
11924 @item :math-prefix
11925 @itemx :math-suffix
11926 @itemx :math-arguments
11927 A string that will be inserted, respectively, before the table within the
11928 math environment, after the table within the math environment, and between
11929 the macro name and the contents of the table.  The @code{:math-arguments}
11930 attribute is used for matrix macros that require more than one argument
11931 (e.g., @code{qbordermatrix}).
11932 @end table
11934 Thus, attributes can be used in a wide array of situations, like writing
11935 a table that will span over multiple pages, or a matrix product:
11937 @example
11938 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11939 | ..... | ..... |
11940 | ..... | ..... |
11942 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11943 | a | b |
11944 | c | d |
11945 #+ATTR_LATEX: :mode math :environment bmatrix
11946 | 1 | 2 |
11947 | 3 | 4 |
11948 @end example
11950 In the example below, @LaTeX{} command
11951 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
11953 @example
11954 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11955 | ..... | ..... |
11956 | ..... | ..... |
11957 @end example
11960 @subsubheading Images in @LaTeX{} export
11961 @cindex images, inline in @LaTeX{}
11962 @cindex inlining images in @LaTeX{}
11964 Images that are linked to without a description part in the link, like
11965 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11966 output file resulting from @LaTeX{} processing.  Org will use an
11967 @code{\includegraphics} macro to insert the image@footnote{In the case of
11968 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11969 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
11971 You can specify specify image width or height with, respectively,
11972 @code{:width} and @code{:height} attributes.  It is also possible to add any
11973 other option with the @code{:options} attribute, as shown in the following
11974 example:
11976 @example
11977 #+ATTR_LATEX: :width 5cm :options angle=90
11978 [[./img/sed-hr4049.pdf]]
11979 @end example
11981 If you need a specific command for the caption, use @code{:caption}
11982 attribute.  It will override standard @code{#+CAPTION} value, if any.
11984 @example
11985 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11986 [[./img/sed-hr4049.pdf]]
11987 @end example
11989 If you have specified a caption as described in @ref{Images and tables}, the
11990 picture will be wrapped into a @code{figure} environment and thus become
11991 a floating element.  You can also ask Org to export an image as a float
11992 without specifying caption by setting the @code{:float} attribute.  You may
11993 also set it to:
11994 @itemize @minus
11995 @item
11996 @code{t}: if you want to use the standard @samp{figure} environment.  It is
11997 used by default if you provide a caption to the image.
11998 @item
11999 @code{multicolumn}: if you wish to include an image which spans multiple
12000 columns in a page.  This will export the image wrapped in a @code{figure*}
12001 environment.
12002 @item
12003 @code{wrap}: if you would like to let text flow around the image.  It will
12004 make the figure occupy the left half of the page.
12005 @item
12006 @code{sideways}: if you would like the image to appear alone on a separate
12007 page rotated ninety degrees using the @code{sidewaysfigure}
12008 environment.  Setting this @code{:float} option will ignore the
12009 @code{:placement} setting.
12010 @item
12011 @code{nil}: if you need to avoid any floating environment, even when
12012 a caption is provided.
12013 @end itemize
12014 @noindent
12015 To modify the placement option of any floating environment, set the
12016 @code{placement} attribute.
12018 @example
12019 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
12020 [[./img/hst.png]]
12021 @end example
12023 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
12024 the @LaTeX{} @code{\includegraphics} macro will be commented out.
12026 @subsubheading Plain lists in @LaTeX{} export
12027 @cindex plain lists, in @LaTeX{} export
12029 Plain lists accept two optional attributes: @code{:environment} and
12030 @code{:options}.  The first one allows the use of a non-standard environment
12031 (e.g., @samp{inparaenum}).  The second one specifies additional arguments for
12032 that environment.
12034 @example
12035 #+ATTR_LATEX: :environment compactitem :options [$\circ$]
12036 - you need ``paralist'' package to reproduce this example.
12037 @end example
12039 @subsubheading Source blocks in @LaTeX{} export
12040 @cindex source blocks, in @LaTeX{} export
12042 In addition to syntax defined in @ref{Literal examples}, names and captions
12043 (@pxref{Images and tables}), source blocks also accept two additional
12044 attributes: @code{:float} and @code{:options}.
12046 You may set the former to
12047 @itemize @minus
12048 @item
12049 @code{t}: if you want to make the source block a float.  It is the default
12050 value when a caption is provided.
12051 @item
12052 @code{multicolumn}: if you wish to include a source block which spans multiple
12053 columns in a page.
12054 @item
12055 @code{nil}: if you need to avoid any floating environment, even when a caption
12056 is provided.  It is useful for source code that may not fit in a single page.
12057 @end itemize
12059 @example
12060 #+ATTR_LATEX: :float nil
12061 #+BEGIN_SRC emacs-lisp
12062 Code that may not fit in a single page.
12063 #+END_SRC
12064 @end example
12066 @vindex org-latex-listings-options
12067 @vindex org-latex-minted-options
12068 The latter allows to specify options relative to the package used to
12069 highlight code in the output (e.g., @code{listings}).  This is the local
12070 counterpart to @code{org-latex-listings-options} and
12071 @code{org-latex-minted-options} variables, which see.
12073 @example
12074 #+ATTR_LATEX: :options commentstyle=\bfseries
12075 #+BEGIN_SRC emacs-lisp
12076   (defun Fib (n)                          ; Count rabbits.
12077     (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
12078 #+END_SRC
12079 @end example
12081 @subsubheading Special blocks in @LaTeX{} export
12082 @cindex special blocks, in @LaTeX{} export
12083 @cindex abstract, in @LaTeX{} export
12084 @cindex proof, in @LaTeX{} export
12086 In @LaTeX{} back-end, special blocks become environments of the same name.
12087 Value of @code{:options} attribute will be appended as-is to that
12088 environment's opening string.  For example:
12090 @example
12091 #+BEGIN_abstract
12092 We demonstrate how to solve the Syracuse problem.
12093 #+END_abstract
12095 #+ATTR_LATEX: :options [Proof of important theorem]
12096 #+BEGIN_proof
12098 Therefore, any even number greater than 2 is the sum of two primes.
12099 #+END_proof
12100 @end example
12102 @noindent
12103 becomes
12105 @example
12106 \begin@{abstract@}
12107 We demonstrate how to solve the Syracuse problem.
12108 \end@{abstract@}
12110 \begin@{proof@}[Proof of important theorem]
12112 Therefore, any even number greater than 2 is the sum of two primes.
12113 \end@{proof@}
12114 @end example
12116 If you need to insert a specific caption command, use @code{:caption}
12117 attribute.  It will override standard @code{#+CAPTION} value, if any.  For
12118 example:
12120 @example
12121 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
12122 #+BEGIN_proof
12124 #+END_proof
12125 @end example
12127 @subsubheading Horizontal rules
12128 @cindex horizontal rules, in @LaTeX{} export
12130 Width and thickness of a given horizontal rule can be controlled with,
12131 respectively, @code{:width} and @code{:thickness} attributes:
12133 @example
12134 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
12135 -----
12136 @end example
12138 @node Markdown export
12139 @section Markdown export
12140 @cindex Markdown export
12142 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
12143 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
12144 mode buffer.
12146 It is built over HTML back-end: any construct not supported by Markdown
12147 syntax (e.g., tables) will be controlled and translated by @code{html}
12148 back-end (@pxref{HTML export}).
12150 @subheading Markdown export commands
12152 @table @kbd
12153 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
12154 Export as a text file written in Markdown syntax.  For an Org file,
12155 @file{myfile.org}, the resulting file will be @file{myfile.md}.  The file
12156 will be overwritten without warning.
12157 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
12158 Export to a temporary buffer.  Do not create a file.
12159 @item C-c C-e m o
12160 Export as a text file with Markdown syntax, then open it.
12161 @end table
12163 @subheading Header and sectioning structure
12165 @vindex org-md-headline-style
12166 Markdown export can generate both @code{atx} and @code{setext} types for
12167 headlines, according to @code{org-md-headline-style}.  The former introduces
12168 a hard limit of two levels, whereas the latter pushes it to six.  Headlines
12169 below that limit are exported as lists.  You can also set a soft limit before
12170 that one (@pxref{Export settings}).
12172 @c begin opendocument
12174 @node OpenDocument Text export
12175 @section OpenDocument Text export
12176 @cindex ODT
12177 @cindex OpenDocument
12178 @cindex export, OpenDocument
12179 @cindex LibreOffice
12181 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
12182 (ODT) format.  Documents created by this exporter use the
12183 @cite{OpenDocument-v1.2
12184 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12185 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
12186 are compatible with LibreOffice 3.4.
12188 @menu
12189 * Pre-requisites for ODT export::  What packages ODT exporter relies on
12190 * ODT export commands::         How to invoke ODT export
12191 * Extending ODT export::        How to produce @samp{doc}, @samp{pdf} files
12192 * Applying custom styles::      How to apply custom styles to the output
12193 * Links in ODT export::         How links will be interpreted and formatted
12194 * Tables in ODT export::        How Tables are exported
12195 * Images in ODT export::        How to insert images
12196 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
12197 * Labels and captions in ODT export::  How captions are rendered
12198 * Literal examples in ODT export::  How source and example blocks are formatted
12199 * Advanced topics in ODT export::  Read this if you are a power user
12200 @end menu
12202 @node Pre-requisites for ODT export
12203 @subsection Pre-requisites for ODT export
12204 @cindex zip
12205 The ODT exporter relies on the @file{zip} program to create the final
12206 output.  Check the availability of this program before proceeding further.
12208 @node ODT export commands
12209 @subsection ODT export commands
12211 @subsubheading Exporting to ODT
12212 @anchor{x-export-to-odt}
12214 @cindex region, active
12215 @cindex active region
12216 @cindex transient-mark-mode
12217 @table @kbd
12218 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
12219 @cindex property EXPORT_FILE_NAME
12221 Export as OpenDocument Text file.
12223 @vindex org-odt-preferred-output-format
12224 If @code{org-odt-preferred-output-format} is specified, automatically convert
12225 the exported file to that format.  @xref{x-export-to-other-formats, ,
12226 Automatically exporting to other formats}.
12228 For an Org file @file{myfile.org}, the ODT file will be
12229 @file{myfile.odt}.  The file will be overwritten without warning.  If there
12230 is an active region,@footnote{This requires @code{transient-mark-mode} to be
12231 turned on} only the region will be exported.  If the selected region is a
12232 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
12233 tree head will become the document title.  If the tree head entry has, or
12234 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
12235 export.
12237 @kbd{C-c C-e o O}
12238 Export as an OpenDocument Text file and open the resulting file.
12240 @vindex org-odt-preferred-output-format
12241 If @code{org-odt-preferred-output-format} is specified, open the converted
12242 file instead.  @xref{x-export-to-other-formats, , Automatically exporting to
12243 other formats}.
12244 @end table
12246 @node Extending ODT export
12247 @subsection Extending ODT export
12249 The ODT exporter can interface with a variety of document
12250 converters and supports popular converters out of the box.  As a result, you
12251 can use it to export to formats like @samp{doc} or convert a document from
12252 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
12254 @cindex @file{unoconv}
12255 @cindex LibreOffice
12256 If you have a working installation of LibreOffice, a document converter is
12257 pre-configured for you and you can use it right away.  If you would like to
12258 use @file{unoconv} as your preferred converter, customize the variable
12259 @code{org-odt-convert-process} to point to @code{unoconv}.  You can
12260 also use your own favorite converter or tweak the default settings of the
12261 @file{LibreOffice} and @samp{unoconv} converters.  @xref{Configuring a
12262 document converter}.
12264 @subsubheading Automatically exporting to other formats
12265 @anchor{x-export-to-other-formats}
12267 @vindex org-odt-preferred-output-format
12268 Very often, you will find yourself exporting to ODT format, only to
12269 immediately save the exported document to other formats like @samp{doc},
12270 @samp{docx}, @samp{rtf}, @samp{pdf} etc.  In such cases, you can specify your
12271 preferred output format by customizing the variable
12272 @code{org-odt-preferred-output-format}.  This way, the export commands
12273 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12274 format that is of immediate interest to you.
12276 @subsubheading Converting between document formats
12277 @anchor{x-convert-to-other-formats}
12279 There are many document converters in the wild which support conversion to
12280 and from various file formats, including, but not limited to the
12281 ODT format.  LibreOffice converter, mentioned above, is one such
12282 converter.  Once a converter is configured, you can interact with it using
12283 the following command.
12285 @vindex org-odt-convert
12286 @table @kbd
12288 @item M-x org-odt-convert RET
12289 Convert an existing document from one format to another.  With a prefix
12290 argument, also open the newly produced file.
12291 @end table
12293 @node Applying custom styles
12294 @subsection Applying custom styles
12295 @cindex styles, custom
12296 @cindex template, custom
12298 The ODT exporter ships with a set of OpenDocument styles
12299 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12300 output.  These factory styles, however, may not cater to your specific
12301 tastes.  To customize the output, you can either modify the above styles
12302 files directly, or generate the required styles using an application like
12303 LibreOffice.  The latter method is suitable for expert and non-expert
12304 users alike, and is described here.
12306 @subsubheading Applying custom styles: the easy way
12308 @enumerate
12309 @item
12310 Create a sample @file{example.org} file with the below settings and export it
12311 to ODT format.
12313 @example
12314 #+OPTIONS: H:10 num:t
12315 @end example
12317 @item
12318 Open the above @file{example.odt} using LibreOffice.  Use the @file{Stylist}
12319 to locate the target styles---these typically have the @samp{Org} prefix---and
12320 modify those to your taste.  Save the modified file either as an
12321 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12323 @item
12324 @cindex #+ODT_STYLES_FILE
12325 @vindex org-odt-styles-file
12326 Customize the variable @code{org-odt-styles-file} and point it to the
12327 newly created file.  For additional configuration options
12328 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12330 If you would like to choose a style on a per-file basis, you can use the
12331 @code{#+ODT_STYLES_FILE} option.  A typical setting will look like
12333 @example
12334 #+ODT_STYLES_FILE: "/path/to/example.ott"
12335 @end example
12339 @example
12340 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12341 @end example
12343 @end enumerate
12345 @subsubheading Using third-party styles and templates
12347 You can use third-party styles and templates for customizing your output.
12348 This will produce the desired output only if the template provides all
12349 style names that the @samp{ODT} exporter relies on.  Unless this condition is
12350 met, the output is going to be less than satisfactory.  So it is highly
12351 recommended that you only work with templates that are directly derived from
12352 the factory settings.
12354 @node Links in ODT export
12355 @subsection Links in ODT export
12356 @cindex links, in ODT export
12358 ODT exporter creates native cross-references for internal links.  It creates
12359 Internet-style links for all other links.
12361 A link with no description and destined to a regular (un-itemized) outline
12362 heading is replaced with a cross-reference and section number of the heading.
12364 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
12365 with a cross-reference and sequence number of the labeled entity.
12366 @xref{Labels and captions in ODT export}.
12368 @node Tables in ODT export
12369 @subsection Tables in ODT export
12370 @cindex tables, in ODT export
12372 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12373 tables is supported.  However, export of complex @file{table.el} tables---tables
12374 that have column or row spans---is not supported.  Such tables are
12375 stripped from the exported document.
12377 By default, a table is exported with top and bottom frames and with rules
12378 separating row and column groups (@pxref{Column groups}).  Furthermore, all
12379 tables are typeset to occupy the same width.  If the table specifies
12380 alignment and relative width for its columns (@pxref{Column width and
12381 alignment}) then these are honored on export.@footnote{The column widths are
12382 interpreted as weighted ratios with the default weight being 1}
12384 @cindex #+ATTR_ODT
12385 You can control the width of the table by specifying @code{:rel-width}
12386 property using an @code{#+ATTR_ODT} line.
12388 For example, consider the following table which makes use of all the rules
12389 mentioned above.
12391 @example
12392 #+ATTR_ODT: :rel-width 50
12393 | Area/Month    |   Jan |   Feb |   Mar |   Sum |
12394 |---------------+-------+-------+-------+-------|
12395 | /             |     < |       |       |     < |
12396 | <l13>         |  <r5> |  <r5> |  <r5> |  <r6> |
12397 | North America |     1 |    21 |   926 |   948 |
12398 | Middle East   |     6 |    75 |   844 |   925 |
12399 | Asia Pacific  |     9 |    27 |   790 |   826 |
12400 |---------------+-------+-------+-------+-------|
12401 | Sum           |    16 |   123 |  2560 |  2699 |
12402 @end example
12404 On export, the table will occupy 50% of text area.  The columns will be sized
12405 (roughly) in the ratio of 13:5:5:5:6.  The first column will be left-aligned
12406 and rest of the columns will be right-aligned.  There will be vertical rules
12407 after separating the header and last columns from other columns.  There will
12408 be horizontal rules separating the header and last rows from other rows.
12410 If you are not satisfied with the above formatting options, you can create
12411 custom table styles and associate them with a table using the
12412 @code{#+ATTR_ODT} line.  @xref{Customizing tables in ODT export}.
12414 @node Images in ODT export
12415 @subsection Images in ODT export
12416 @cindex images, embedding in ODT
12417 @cindex embedding images in ODT
12419 @subsubheading Embedding images
12420 You can embed images within the exported document by providing a link to the
12421 desired image file with no link description.  For example, to embed
12422 @samp{img.png} do either of the following:
12424 @example
12425 [[file:img.png]]
12426 @end example
12428 @example
12429 [[./img.png]]
12430 @end example
12432 @subsubheading Embedding clickable images
12433 You can create clickable images by providing a link whose description is a
12434 link to an image file.  For example, to embed a image
12435 @file{org-mode-unicorn.png} which when clicked jumps to
12436 @uref{http://Orgmode.org} website, do the following
12438 @example
12439 [[http://orgmode.org][./org-mode-unicorn.png]]
12440 @end example
12442 @subsubheading Sizing and scaling of embedded images
12444 @cindex #+ATTR_ODT
12445 You can control the size and scale of the embedded images using the
12446 @code{#+ATTR_ODT} attribute.
12448 @cindex identify, ImageMagick
12449 @vindex org-odt-pixels-per-inch
12450 The exporter specifies the desired size of the image in the final document in
12451 units of centimeters.  In order to scale the embedded images, the exporter
12452 queries for pixel dimensions of the images using one of a) ImageMagick's
12453 @file{identify} program or b) Emacs `create-image' and `image-size'
12454 APIs@footnote{Use of @file{ImageMagick} is only desirable.  However, if you
12455 routinely produce documents that have large images or you export your Org
12456 files that has images using a Emacs batch script, then the use of
12457 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12458 converted in to units of centimeters using
12459 @code{org-odt-pixels-per-inch}.  The default value of this variable is
12460 set to @code{display-pixels-per-inch}.  You can tweak this variable to
12461 achieve the best results.
12463 The examples below illustrate the various possibilities.
12465 @table @asis
12466 @item Explicitly size the image
12467 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12469 @example
12470 #+ATTR_ODT: :width 10 :height 10
12471 [[./img.png]]
12472 @end example
12474 @item Scale the image
12475 To embed @file{img.png} at half its size, do the following:
12477 @example
12478 #+ATTR_ODT: :scale 0.5
12479 [[./img.png]]
12480 @end example
12482 @item Scale the image to a specific width
12483 To embed @file{img.png} with a width of 10 cm while retaining the original
12484 height:width ratio, do the following:
12486 @example
12487 #+ATTR_ODT: :width 10
12488 [[./img.png]]
12489 @end example
12491 @item Scale the image to a specific height
12492 To embed @file{img.png} with a height of 10 cm while retaining the original
12493 height:width ratio, do the following
12495 @example
12496 #+ATTR_ODT: :height 10
12497 [[./img.png]]
12498 @end example
12499 @end table
12501 @subsubheading Anchoring of images
12503 @cindex #+ATTR_ODT
12504 You can control the manner in which an image is anchored by setting the
12505 @code{:anchor} property of it's @code{#+ATTR_ODT} line.  You can specify one
12506 of the following three values for the @code{:anchor} property:
12507 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12509 To create an image that is anchored to a page, do the following:
12510 @example
12511 #+ATTR_ODT: :anchor "page"
12512 [[./img.png]]
12513 @end example
12515 @node Math formatting in ODT export
12516 @subsection Math formatting in ODT export
12518 The ODT exporter has special support for handling math.
12520 @menu
12521 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
12522 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
12523 @end menu
12525 @node Working with @LaTeX{} math snippets
12526 @subsubheading Working with @LaTeX{} math snippets
12528 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12529 document in one of the following ways:
12531 @cindex MathML
12532 @enumerate
12533 @item MathML
12535 This option is activated on a per-file basis with
12537 @example
12538 #+OPTIONS: LaTeX:t
12539 @end example
12541 With this option, @LaTeX{} fragments are first converted into MathML
12542 fragments using an external @LaTeX{}-to-MathML converter program.  The
12543 resulting MathML fragments are then embedded as an OpenDocument Formula in
12544 the exported document.
12546 @vindex org-latex-to-mathml-convert-command
12547 @vindex org-latex-to-mathml-jar-file
12549 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12550 @code{org-latex-to-mathml-convert-command} and
12551 @code{org-latex-to-mathml-jar-file}.
12553 To use MathToWeb@footnote{See
12554 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}.} as your
12555 converter, you can configure the above variables as
12557 @lisp
12558 (setq org-latex-to-mathml-convert-command
12559       "java -jar %j -unicode -force -df %o %I"
12560       org-latex-to-mathml-jar-file
12561       "/path/to/mathtoweb.jar")
12562 @end lisp
12563 To use @LaTeX{}ML@footnote{See @uref{http://dlmf.nist.gov/LaTeXML/}.} use
12564 @lisp
12565 (setq org-latex-to-mathml-convert-command
12566       "latexmlmath \"%i\" --presentationmathml=%o")
12567 @end lisp
12569 You can use the following commands to quickly verify the reliability of
12570 the @LaTeX{}-to-MathML converter.
12572 @table @kbd
12573 @item M-x org-odt-export-as-odf RET
12574 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12576 @item M-x org-odt-export-as-odf-and-open RET
12577 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12578 and open the formula file with the system-registered application.
12579 @end table
12581 @cindex dvipng
12582 @cindex imagemagick
12583 @item PNG images
12585 This option is activated on a per-file basis with
12587 @example
12588 #+OPTIONS: tex:dvipng
12589 @end example
12593 @example
12594 #+OPTIONS: tex:imagemagick
12595 @end example
12597 With this option, @LaTeX{} fragments are processed into PNG images and the
12598 resulting images are embedded in the exported document.  This method requires
12599 that the @file{dvipng} program or @file{imagemagick} suite be available on
12600 your system.
12601 @end enumerate
12603 @node Working with MathML or OpenDocument formula files
12604 @subsubheading Working with MathML or OpenDocument formula files
12606 For various reasons, you may find embedding @LaTeX{} math snippets in an
12607 ODT document less than reliable.  In that case, you can embed a
12608 math equation by linking to its MathML (@file{.mml}) source or its
12609 OpenDocument formula (@file{.odf}) file as shown below:
12611 @example
12612 [[./equation.mml]]
12613 @end example
12617 @example
12618 [[./equation.odf]]
12619 @end example
12621 @node Labels and captions in ODT export
12622 @subsection Labels and captions in ODT export
12624 You can label and caption various category of objects---an inline image, a
12625 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12626 @code{#+CAPTION} lines.  @xref{Images and tables}.  ODT exporter enumerates
12627 each labeled or captioned object of a given category separately.  As a
12628 result, each such object is assigned a sequence number based on order of it's
12629 appearance in the Org file.
12631 In the exported document, a user-provided caption is augmented with the
12632 category and sequence number.  Consider the following inline image in an Org
12633 file.
12635 @example
12636 #+CAPTION: Bell curve
12637 #+LABEL:   fig:SED-HR4049
12638 [[./img/a.png]]
12639 @end example
12641 It could be rendered as shown below in the exported document.
12643 @example
12644 Figure 2: Bell curve
12645 @end example
12647 @vindex org-odt-category-map-alist
12648 You can modify the category component of the caption by customizing the
12649 option @code{org-odt-category-map-alist}.  For example, to tag all embedded
12650 images with the string @samp{Illustration} (instead of the default
12651 @samp{Figure}) use the following setting:
12653 @lisp
12654 (setq org-odt-category-map-alist
12655       (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12656 @end lisp
12658 With this, previous image will be captioned as below in the exported
12659 document.
12661 @example
12662 Illustration 2: Bell curve
12663 @end example
12665 @node Literal examples in ODT export
12666 @subsection Literal examples in ODT export
12668 Export of literal examples (@pxref{Literal examples}) with full fontification
12669 is supported.  Internally, the exporter relies on @file{htmlfontify.el} to
12670 generate all style definitions needed for a fancy listing.@footnote{Your
12671 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
12672 fontification to be turned on.}  The auto-generated styles have @samp{OrgSrc}
12673 as prefix and inherit their color from the faces used by Emacs
12674 @code{font-lock} library for the source language.
12676 @vindex org-odt-fontify-srcblocks
12677 If you prefer to use your own custom styles for fontification, you can do
12678 so by customizing the option
12679 @code{org-odt-create-custom-styles-for-srcblocks}.
12681 @vindex org-odt-create-custom-styles-for-srcblocks
12682 You can turn off fontification of literal examples by customizing the
12683 option @code{org-odt-fontify-srcblocks}.
12685 @node Advanced topics in ODT export
12686 @subsection Advanced topics in ODT export
12688 If you rely heavily on ODT export, you may want to exploit the full
12689 set of features that the exporter offers.  This section describes features
12690 that would be of interest to power users.
12692 @menu
12693 * Configuring a document converter::  How to register a document converter
12694 * Working with OpenDocument style files::  Explore the internals
12695 * Creating one-off styles::     How to produce custom highlighting etc
12696 * Customizing tables in ODT export::  How to define and use Table templates
12697 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
12698 @end menu
12700 @node Configuring a document converter
12701 @subsubheading Configuring a document converter
12702 @cindex convert
12703 @cindex doc, docx, rtf
12704 @cindex converter
12706 The ODT exporter can work with popular converters with little or no
12707 extra configuration from your side. @xref{Extending ODT export}.
12708 If you are using a converter that is not supported by default or if you would
12709 like to tweak the default converter settings, proceed as below.
12711 @enumerate
12712 @item Register the converter
12714 @vindex org-odt-convert-processes
12715 Name your converter and add it to the list of known converters by
12716 customizing the option @code{org-odt-convert-processes}.  Also specify how
12717 the converter can be invoked via command-line to effect the conversion.
12719 @item Configure its capabilities
12721 @vindex org-odt-convert-capabilities
12722 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12723 converter can handle by customizing the variable
12724 @code{org-odt-convert-capabilities}.  Use the default value for this
12725 variable as a guide for configuring your converter.  As suggested by the
12726 default setting, you can specify the full set of formats supported by the
12727 converter and not limit yourself to specifying formats that are related to
12728 just the OpenDocument Text format.
12730 @item Choose the converter
12732 @vindex org-odt-convert-process
12733 Select the newly added converter as the preferred one by customizing the
12734 option @code{org-odt-convert-process}.
12735 @end enumerate
12737 @node Working with OpenDocument style files
12738 @subsubheading Working with OpenDocument style files
12739 @cindex styles, custom
12740 @cindex template, custom
12742 This section explores the internals of the ODT exporter and the
12743 means by which it produces styled documents.  Read this section if you are
12744 interested in exploring the automatic and custom OpenDocument styles used by
12745 the exporter.
12747 @anchor{x-factory-styles}
12748 @subsubheading a) Factory styles
12750 The ODT exporter relies on two files for generating its output.
12751 These files are bundled with the distribution under the directory pointed to
12752 by the variable @code{org-odt-styles-dir}.  The two files are:
12754 @itemize
12755 @anchor{x-orgodtstyles-xml}
12756 @item
12757 @file{OrgOdtStyles.xml}
12759 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12760 document.  This file gets modified for the following purposes:
12761 @enumerate
12763 @item
12764 To control outline numbering based on user settings.
12766 @item
12767 To add styles generated by @file{htmlfontify.el} for fontification of code
12768 blocks.
12769 @end enumerate
12771 @anchor{x-orgodtcontenttemplate-xml}
12772 @item
12773 @file{OrgOdtContentTemplate.xml}
12775 This file contributes to the @file{content.xml} file of the final @samp{ODT}
12776 document.  The contents of the Org outline are inserted between the
12777 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
12779 Apart from serving as a template file for the final @file{content.xml}, the
12780 file serves the following purposes:
12781 @enumerate
12783 @item
12784 It contains automatic styles for formatting of tables which are referenced by
12785 the exporter.
12787 @item
12788 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
12789 elements that control how various entities---tables, images, equations,
12790 etc.---are numbered.
12791 @end enumerate
12792 @end itemize
12794 @anchor{x-overriding-factory-styles}
12795 @subsubheading b) Overriding factory styles
12796 The following two variables control the location from which the ODT
12797 exporter picks up the custom styles and content template files.  You can
12798 customize these variables to override the factory styles used by the
12799 exporter.
12801 @itemize
12802 @anchor{x-org-odt-styles-file}
12803 @item
12804 @code{org-odt-styles-file}
12806 Use this variable to specify the @file{styles.xml} that will be used in the
12807 final output.  You can specify one of the following values:
12809 @enumerate
12810 @item A @file{styles.xml} file
12812 Use this file instead of the default @file{styles.xml}
12814 @item A @file{.odt} or @file{.ott} file
12816 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12817 Template file
12819 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
12821 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12822 Template file.  Additionally extract the specified member files and embed
12823 those within the final @samp{ODT} document.
12825 Use this option if the @file{styles.xml} file references additional files
12826 like header and footer images.
12828 @item @code{nil}
12830 Use the default @file{styles.xml}
12831 @end enumerate
12833 @anchor{x-org-odt-content-template-file}
12834 @item
12835 @code{org-odt-content-template-file}
12837 Use this variable to specify the blank @file{content.xml} that will be used
12838 in the final output.
12839 @end itemize
12841 @node Creating one-off styles
12842 @subsubheading Creating one-off styles
12844 There are times when you would want one-off formatting in the exported
12845 document.  You can achieve this by embedding raw OpenDocument XML in the Org
12846 file.  The use of this feature is better illustrated with couple of examples.
12848 @enumerate
12849 @item Embedding ODT tags as part of regular text
12851 You can inline OpenDocument syntax by enclosing it within
12852 @samp{@@@@odt:...@@@@} markup.  For example, to highlight a region of text do
12853 the following:
12855 @example
12856 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
12857 text</text:span>@@@@.  But this is a regular text.
12858 @end example
12860 @strong{Hint:} To see the above example in action, edit your
12861 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12862 custom @samp{Highlight} style as shown below.
12864 @example
12865 <style:style style:name="Highlight" style:family="text">
12866   <style:text-properties fo:background-color="#ff0000"/>
12867 </style:style>
12868 @end example
12870 @item Embedding a one-line OpenDocument XML
12872 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
12873 directive.  For example, to force a page break do the following:
12875 @example
12876 #+ODT: <text:p text:style-name="PageBreak"/>
12877 @end example
12879 @strong{Hint:} To see the above example in action, edit your
12880 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12881 custom @samp{PageBreak} style as shown below.
12883 @example
12884 <style:style style:name="PageBreak" style:family="paragraph"
12885              style:parent-style-name="Text_20_body">
12886   <style:paragraph-properties fo:break-before="page"/>
12887 </style:style>
12888 @end example
12890 @item Embedding a block of OpenDocument XML
12892 You can add a large block of OpenDocument XML using the
12893 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
12895 For example, to create a one-off paragraph that uses bold text, do the
12896 following:
12898 @example
12899 #+BEGIN_ODT
12900 <text:p text:style-name="Text_20_body_20_bold">
12901 This paragraph is specially formatted and uses bold text.
12902 </text:p>
12903 #+END_ODT
12904 @end example
12906 @end enumerate
12908 @node Customizing tables in ODT export
12909 @subsubheading Customizing tables in ODT export
12910 @cindex tables, in ODT export
12912 @cindex #+ATTR_ODT
12913 You can override the default formatting of the table by specifying a custom
12914 table style with the @code{#+ATTR_ODT} line.  For a discussion on default
12915 formatting of tables @pxref{Tables in ODT export}.
12917 This feature closely mimics the way table templates are defined in the
12918 OpenDocument-v1.2
12919 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12920 OpenDocument-v1.2 Specification}}
12922 @vindex org-odt-table-styles
12923 To have a quick preview of this feature, install the below setting and
12924 export the table that follows:
12926 @lisp
12927 (setq org-odt-table-styles
12928       (append org-odt-table-styles
12929             '(("TableWithHeaderRowAndColumn" "Custom"
12930                 ((use-first-row-styles . t)
12931                  (use-first-column-styles . t)))
12932                 ("TableWithFirstRowandLastRow" "Custom"
12933                  ((use-first-row-styles . t)
12934                  (use-last-row-styles . t))))))
12935 @end lisp
12937 @example
12938 #+ATTR_ODT: :style TableWithHeaderRowAndColumn
12939 | Name  | Phone | Age |
12940 | Peter |  1234 |  17 |
12941 | Anna  |  4321 |  25 |
12942 @end example
12944 In the above example, you used a template named @samp{Custom} and installed
12945 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12946 @samp{TableWithFirstRowandLastRow}.  (@strong{Important:} The OpenDocument
12947 styles needed for producing the above template have been pre-defined for
12948 you.  These styles are available under the section marked @samp{Custom
12949 Table Template} in @file{OrgOdtContentTemplate.xml}
12950 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}).  If you need
12951 additional templates you have to define these styles yourselves.
12953 To use this feature proceed as follows:
12955 @enumerate
12956 @item
12957 Create a table template@footnote{See the @code{<table:table-template>}
12958 element of the OpenDocument-v1.2 specification}
12960 A table template is nothing but a set of @samp{table-cell} and
12961 @samp{paragraph} styles for each of the following table cell categories:
12963 @itemize @minus
12964 @item Body
12965 @item First column
12966 @item Last column
12967 @item First row
12968 @item Last row
12969 @item Even row
12970 @item Odd row
12971 @item Even column
12972 @item Odd Column
12973 @end itemize
12975 The names for the above styles must be chosen based on the name of the table
12976 template using a well-defined convention.
12978 The naming convention is better illustrated with an example.  For a table
12979 template with the name @samp{Custom}, the needed style names are listed in
12980 the following table.
12982 @multitable  {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12983 @headitem Table cell type
12984 @tab @code{table-cell} style
12985 @tab @code{paragraph} style
12986 @item
12987 @tab
12988 @tab
12989 @item Body
12990 @tab @samp{CustomTableCell}
12991 @tab @samp{CustomTableParagraph}
12992 @item First column
12993 @tab @samp{CustomFirstColumnTableCell}
12994 @tab @samp{CustomFirstColumnTableParagraph}
12995 @item Last column
12996 @tab @samp{CustomLastColumnTableCell}
12997 @tab @samp{CustomLastColumnTableParagraph}
12998 @item First row
12999 @tab @samp{CustomFirstRowTableCell}
13000 @tab @samp{CustomFirstRowTableParagraph}
13001 @item Last row
13002 @tab @samp{CustomLastRowTableCell}
13003 @tab @samp{CustomLastRowTableParagraph}
13004 @item Even row
13005 @tab @samp{CustomEvenRowTableCell}
13006 @tab @samp{CustomEvenRowTableParagraph}
13007 @item Odd row
13008 @tab @samp{CustomOddRowTableCell}
13009 @tab @samp{CustomOddRowTableParagraph}
13010 @item Even column
13011 @tab @samp{CustomEvenColumnTableCell}
13012 @tab @samp{CustomEvenColumnTableParagraph}
13013 @item Odd column
13014 @tab @samp{CustomOddColumnTableCell}
13015 @tab @samp{CustomOddColumnTableParagraph}
13016 @end multitable
13018 To create a table template with the name @samp{Custom}, define the above
13019 styles in the
13020 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
13021 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
13022 styles}).
13024 @item
13025 Define a table style@footnote{See the attributes @code{table:template-name},
13026 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
13027 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
13028 @code{table:use-banding-rows-styles}, and
13029 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
13030 the OpenDocument-v1.2 specification}
13032 @vindex org-odt-table-styles
13033 To define a table style, create an entry for the style in the variable
13034 @code{org-odt-table-styles} and specify the following:
13036 @itemize @minus
13037 @item the name of the table template created in step (1)
13038 @item the set of cell styles in that template that are to be activated
13039 @end itemize
13041 For example, the entry below defines two different table styles
13042 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
13043 based on the same template @samp{Custom}.  The styles achieve their intended
13044 effect by selectively activating the individual cell styles in that template.
13046 @lisp
13047 (setq org-odt-table-styles
13048       (append org-odt-table-styles
13049               '(("TableWithHeaderRowAndColumn" "Custom"
13050                  ((use-first-row-styles . t)
13051                   (use-first-column-styles . t)))
13052                 ("TableWithFirstRowandLastRow" "Custom"
13053                  ((use-first-row-styles . t)
13054                   (use-last-row-styles . t))))))
13055 @end lisp
13057 @item
13058 Associate a table with the table style
13060 To do this, specify the table style created in step (2) as part of
13061 the @code{ATTR_ODT} line as shown below.
13063 @example
13064 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
13065 | Name  | Phone | Age |
13066 | Peter |  1234 |  17 |
13067 | Anna  |  4321 |  25 |
13068 @end example
13069 @end enumerate
13071 @node Validating OpenDocument XML
13072 @subsubheading Validating OpenDocument XML
13074 Occasionally, you will discover that the document created by the
13075 ODT exporter cannot be opened by your favorite application.  One of
13076 the common reasons for this is that the @file{.odt} file is corrupt.  In such
13077 cases, you may want to validate the document against the OpenDocument RELAX
13078 NG Compact Syntax (RNC) schema.
13080 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
13081 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}.  For
13082 general help with validation (and schema-sensitive editing) of XML files:
13083 @inforef{Introduction,,nxml-mode}.
13085 @vindex org-odt-schema-dir
13086 If you have ready access to OpenDocument @file{.rnc} files and the needed
13087 schema-locating rules in a single folder, you can customize the variable
13088 @code{org-odt-schema-dir} to point to that directory.  The ODT exporter
13089 will take care of updating the @code{rng-schema-locating-files} for you.
13091 @c end opendocument
13093 @node Org export
13094 @section Org export
13095 @cindex Org export
13097 @code{org} export back-end creates a normalized version of the Org document
13098 in current buffer.  In particular, it evaluates Babel code (@pxref{Evaluating
13099 code blocks}) and removes other back-ends specific contents.
13101 @subheading Org export commands
13103 @table @kbd
13104 @orgcmd{C-c C-e O o,org-org-export-to-org}
13105 Export as an Org document.  For an Org file, @file{myfile.org}, the resulting
13106 file will be @file{myfile.org.org}.  The file will be overwritten without
13107 warning.
13108 @orgcmd{C-c C-e O O,org-org-export-as-org}
13109 Export to a temporary buffer.  Do not create a file.
13110 @item C-c C-e O v
13111 Export to an Org file, then open it.
13112 @end table
13114 @node Texinfo export
13115 @section Texinfo export
13116 @cindex Texinfo export
13118 @samp{texinfo} export back-end generates Texinfo code and can compile it into
13119 an Info file.
13121 @menu
13122 * Texinfo export commands::     How to invoke Texinfo export
13123 * Document preamble::           File header, title and copyright page
13124 * Headings and sectioning structure:: Building document structure
13125 * Indices::                     Creating indices
13126 * Quoting Texinfo code::        Incorporating literal Texinfo code
13127 * Texinfo specific attributes:: Controlling Texinfo output
13128 * An example::
13129 @end menu
13131 @node Texinfo export commands
13132 @subsection Texinfo export commands
13134 @vindex org-texinfo-info-process
13135 @table @kbd
13136 @orgcmd{C-c C-e i t,org-texinfo-export-to-texinfo}
13137 Export as a Texinfo file.  For an Org file, @file{myfile.org}, the resulting
13138 file will be @file{myfile.texi}.  The file will be overwritten without
13139 warning.
13140 @orgcmd{C-c C-e i i,org-texinfo-export-to-info}
13141 Export to Texinfo and then process to an Info file@footnote{By setting
13142 @code{org-texinfo-info-process}, it is possible to generate other formats,
13143 including DocBook.}.
13144 @end table
13146 @node Document preamble
13147 @subsection Document preamble
13149 When processing a document, @samp{texinfo} back-end generates a minimal file
13150 header along with a title page, a copyright page, and a menu.  You control
13151 the latter through the structure of the document (@pxref{Headings and
13152 sectioning structure}).  Various keywords allow to tweak the other parts.  It
13153 is also possible to give directions to install the document in the @samp{Top}
13154 node.
13156 @subsubheading File header
13158 @cindex #+TEXINFO_FILENAME
13159 Upon creating the header of a Texinfo file, the back-end guesses a name for
13160 the Info file to be compiled.  This may not be a sensible choice, e.g., if
13161 you want to produce the final document in a different directory.  Specify an
13162 alternate path with @code{#+TEXINFO_FILENAME} keyword to override the default
13163 destination.
13165 @vindex org-texinfo-coding-system
13166 @vindex org-texinfo-classes
13167 @cindex #+TEXINFO_HEADER
13168 @cindex #+TEXINFO_CLASS
13169 Along with the output file name, the header contains information about the
13170 language (@pxref{Export settings}) and current encoding used@footnote{See
13171 @code{org-texinfo-coding-system} for more information.}.  Insert
13172 a @code{#+TEXINFO_HEADER} keyword for each additional command needed, e.g.,
13173 @@code@{@@synindex@}.
13175 If you happen to regularly install the same set of commands, it may be easier
13176 to define your own class in @code{org-texinfo-classes}, which see.  Set
13177 @code{#+TEXINFO_CLASS} keyword accordingly in your document to activate it.
13179 @subsubheading Title and copyright page
13181 @cindex #+TEXINFO_PRINTED_TITLE
13182 @cindex #+SUBTITLE
13183 The default template includes a title page for hard copy output.  The title
13184 and author displayed on this page are extracted from, respectively,
13185 @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}).  It is
13186 also possible to print a different, more specific, title with
13187 @code{#+TEXINFO_PRINTED_TITLE} keyword, and add subtitles with
13188 @code{#+SUBTITLE} keyword.  Both expect raw Texinfo code in their value.
13190 @cindex #+SUBAUTHOR
13191 Likewise, information brought by @code{#+AUTHOR} may not be enough.  You can
13192 include other authors with several @code{#+SUBAUTHOR} keywords.  Values are
13193 also expected to be written in Texinfo code.
13195 @example
13196 #+AUTHOR: Jane Smith
13197 #+SUBAUTHOR: John Doe
13198 #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@}
13199 @end example
13201 @cindex property, COPYING
13202 Copying material is defined in a dedicated headline with a non-@code{nil}
13203 @code{:COPYING:} property.  The contents are inserted within
13204 a @code{@@copying} command at the beginning of the document whereas the
13205 heading itself does not appear in the structure of the document.
13207 Copyright information is printed on the back of the title page.
13209 @example
13210 * Copying
13211   :PROPERTIES:
13212   :COPYING: t
13213   :END:
13215   This is a short example of a complete Texinfo file, version 1.0.
13217   Copyright \copy 2014 Free Software Foundation, Inc.
13218 @end example
13220 @subsubheading The Top node
13222 @cindex #+TEXINFO_DIR_CATEGORY
13223 @cindex #+TEXINFO_DIR_TITLE
13224 @cindex #+TEXINFO_DIR_DESC
13225 You may ultimately want to install your new Info file in your system.  You
13226 can write an appropriate entry in the top level directory specifying its
13227 category and title with, respectively, @code{#+TEXINFO_DIR_CATEGORY} and
13228 @code{#+TEXINFO_DIR_TITLE}.  Optionally, you can add a short description
13229 using @code{#+TEXINFO_DIR_DESC}.  The following example would write an entry
13230 similar to Org's in the @samp{Top} node.
13232 @example
13233 #+TEXINFO_DIR_CATEGORY: Emacs
13234 #+TEXINFO_DIR_TITLE: Org Mode: (org)
13235 #+TEXINFO_DIR_DESC: Outline-based notes management and organizer
13236 @end example
13238 @node Headings and sectioning structure
13239 @subsection Headings and sectioning structure
13241 @vindex org-texinfo-classes
13242 @vindex org-texinfo-default-class
13243 @cindex #+TEXINFO_CLASS
13244 @samp{texinfo} uses a pre-defined scheme, or class, to convert headlines into
13245 Texinfo structuring commands.  For example, a top level headline appears as
13246 @code{@@chapter} if it should be numbered or as @code{@@unnumbered}
13247 otherwise.  If you need to use a different set of commands, e.g., to start
13248 with @code{@@part} instead of @code{@@chapter}, install a new class in
13249 @code{org-texinfo-classes}, then activate it with @code{#+TEXINFO_CLASS}
13250 keyword.  Export process defaults to @code{org-texinfo-default-class} when
13251 there is no such keyword in the document.
13253 If a headline's level has no associated structuring command, or is below
13254 a certain threshold (@pxref{Export settings}), that headline becomes a list
13255 in Texinfo output.
13257 @cindex property, APPENDIX
13258 As an exception, a headline with a non-@code{nil} @code{:APPENDIX:} property becomes
13259 an appendix, independently on its level and the class used.
13261 @cindex property, DESCRIPTION
13262 Each regular sectioning structure creates a menu entry, named after the
13263 heading.  You can provide a different, e.g., shorter, title in
13264 @code{:ALT_TITLE:} property (@pxref{Table of contents}).  Optionally, you can
13265 specify a description for the item in @code{:DESCRIPTION:} property.  E.g.,
13267 @example
13268 * Controlling Screen Display
13269   :PROPERTIES:
13270   :ALT_TITLE: Display
13271   :DESCRIPTION: Controlling Screen Display
13272   :END:
13273 @end example
13275 @node Indices
13276 @subsection Indices
13278 @cindex #+CINDEX
13279 @cindex #+FINDEX
13280 @cindex #+KINDEX
13281 @cindex #+PINDEX
13282 @cindex #+TINDEX
13283 @cindex #+VINDEX
13284 Index entries are created using dedicated keywords.  @samp{texinfo} back-end
13285 provides one for each predefined type: @code{#+CINDEX}, @code{#+FINDEX},
13286 @code{#+KINDEX}, @code{#+PINDEX}, @code{#+TINDEX} and @code{#+VINDEX}.  For
13287 custom indices, you can write raw Texinfo code (@pxref{Quoting Texinfo
13288 code}).
13290 @example
13291 #+CINDEX: Defining indexing entries
13292 @end example
13294 @cindex property, INDEX
13295 To generate an index, you need to set the @code{:INDEX:} property of
13296 a headline to an appropriate abbreviation (e.g., @samp{cp} or @samp{vr}).
13297 The headline is then exported as an unnumbered chapter or section command and
13298 the index is inserted after its contents.
13300 @example
13301 * Concept Index
13302   :PROPERTIES:
13303   :INDEX: cp
13304   :END:
13305 @end example
13307 @node Quoting Texinfo code
13308 @subsection Quoting Texinfo code
13310 It is possible to insert raw Texinfo code using any of the following
13311 constructs
13313 @cindex #+TEXINFO
13314 @cindex #+BEGIN_TEXINFO
13315 @example
13316 Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU.
13318 #+TEXINFO: @@need800
13319 This paragraph is preceded by...
13321 #+BEGIN_TEXINFO
13322 @@auindex Johnson, Mark
13323 @@auindex Lakoff, George
13324 #+END_TEXINFO
13325 @end example
13327 @node Texinfo specific attributes
13328 @subsection Texinfo specific attributes
13330 @cindex #+ATTR_TEXINFO
13331 @samp{texinfo} back-end understands several attributes in plain lists and
13332 tables.  They must be specified using an @code{#+ATTR_TEXINFO} keyword,
13333 written just above the list or table.
13335 @subsubheading Plain lists
13337 In Texinfo output, description lists appear as two-column tables, using the
13338 default command @code{@@table}.  You can use @code{@@ftable} or
13339 @code{@@vtable}@footnote{For more information, @inforef{Two-column
13340 Tables,,texinfo}.} instead with @code{:table-type} attribute.
13342 @vindex org-texinfo-def-table-markup
13343 In any case, these constructs require a highlighting command for entries in
13344 the list.  You can provide one with @code{:indic} attribute.  If you do not,
13345 it defaults to the value stored in @code{org-texinfo-def-table-markup}, which
13346 see.
13348 @example
13349 #+ATTR_TEXINFO: :indic @@asis
13350 - foo :: This is the text for /foo/, with no highlighting.
13351 @end example
13353 @subsubheading Tables
13355 When exporting a table, column widths are deduced from the longest cell in
13356 each column.  You can also define them explicitly as fractions of the line
13357 length, using @code{:columns} attribute.
13359 @example
13360 #+ATTR_TEXINFO: :columns .5 .5
13361 | a cell | another cell |
13362 @end example
13364 @node An example
13365 @subsection An example
13367 Here is a thorough example.  @inforef{GNU Sample Texts,,texinfo} for an
13368 equivalent Texinfo code.
13370 @smallexample
13371 #+MACRO: version 2.0
13372 #+MACRO: updated last updated 4 March 2014
13374 #+OPTIONS: ':t toc:t author:t email:t
13375 #+TITLE: GNU Sample @{@{@{version@}@}@}
13376 #+AUTHOR: A.U. Thor
13377 #+EMAIL: bug-sample@@gnu.org
13378 #+LANGUAGE: en
13380 #+TEXINFO_FILENAME: sample.info
13381 #+TEXINFO_HEADER: @@syncodeindex pg cp
13383 #+TEXINFO_DIR_CATEGORY: Texinfo documentation system
13384 #+TEXINFO_DIR_TITLE: sample: (sample)
13385 #+TEXINFO_DIR_DESC: Invoking sample
13387 #+TEXINFO_PRINTED_TITLE: GNU Sample
13388 #+SUBTITLE: for version 2.0, last updated 4 March 2014
13390 * Copying 
13391   :PROPERTIES:
13392   :COPYING:  t
13393   :END:
13395   This manual is for GNU Sample (version @{@{@{version@}@}@},
13396   @{@{@{updated@}@}@}), which is an example in the Texinfo documentation.
13398   Copyright @@@@texinfo:@@copyright@{@}@@@@ 2013 Free Software Foundation,
13399   Inc.
13401   #+BEGIN_QUOTE
13402   Permission is granted to copy, distribute and/or modify this
13403   document under the terms of the GNU Free Documentation License,
13404   Version 1.3 or any later version published by the Free Software
13405   Foundation; with no Invariant Sections, with no Front-Cover Texts,
13406   and with no Back-Cover Texts.  A copy of the license is included in
13407   the section entitled "GNU Free Documentation License".
13408   #+END_QUOTE
13410 * Invoking sample
13412   #+PINDEX: sample
13413   #+CINDEX: invoking @@command@{sample@}
13415   This is a sample manual.  There is no sample program to invoke, but
13416   if there were, you could see its basic usage and command line
13417   options here.
13419 * GNU Free Documentation License
13420   :PROPERTIES:
13421   :APPENDIX: t
13422   :END:
13424   #+TEXINFO: @@include fdl.texi
13426 * Index
13427   :PROPERTIES:
13428   :INDEX:    cp
13429   :END:
13430 @end smallexample
13432 @node iCalendar export
13433 @section iCalendar export
13434 @cindex iCalendar export
13436 @vindex org-icalendar-include-todo
13437 @vindex org-icalendar-use-deadline
13438 @vindex org-icalendar-use-scheduled
13439 @vindex org-icalendar-categories
13440 @vindex org-icalendar-alarm-time
13441 Some people use Org mode for keeping track of projects, but still prefer a
13442 standard calendar application for anniversaries and appointments.  In this
13443 case it can be useful to show deadlines and other time-stamped items in Org
13444 files in the calendar application.  Org mode can export calendar information
13445 in the standard iCalendar format.  If you also want to have TODO entries
13446 included in the export, configure the variable
13447 @code{org-icalendar-include-todo}.  Plain timestamps are exported as VEVENT,
13448 and TODO items as VTODO@.  It will also create events from deadlines that are
13449 in non-TODO items.  Deadlines and scheduling dates in TODO items will be used
13450 to set the start and due dates for the TODO entry@footnote{See the variables
13451 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
13452 As categories, it will use the tags locally defined in the heading, and the
13453 file/tree category@footnote{To add inherited tags or the TODO state,
13454 configure the variable @code{org-icalendar-categories}.}.  See the variable
13455 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
13456 time.
13458 @vindex org-icalendar-store-UID
13459 @cindex property, ID
13460 The iCalendar standard requires each entry to have a globally unique
13461 identifier (UID).  Org creates these identifiers during export.  If you set
13462 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
13463 @code{:ID:} property of the entry and re-used next time you report this
13464 entry.  Since a single entry can give rise to multiple iCalendar entries (as
13465 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
13466 prefixes to the UID, depending on what triggered the inclusion of the entry.
13467 In this way the UID remains unique, but a synchronization program can still
13468 figure out from which entry all the different instances originate.
13470 @table @kbd
13471 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
13472 Create iCalendar entries for the current buffer and store them in the same
13473 directory, using a file extension @file{.ics}.
13474 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
13475 @vindex org-agenda-files
13476 Like @kbd{C-c C-e c f}, but do this for all files in
13477 @code{org-agenda-files}.  For each of these files, a separate iCalendar
13478 file will be written.
13479 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
13480 @vindex org-icalendar-combined-agenda-file
13481 Create a single large iCalendar file from all files in
13482 @code{org-agenda-files} and write it to the file given by
13483 @code{org-icalendar-combined-agenda-file}.
13484 @end table
13486 @vindex org-use-property-inheritance
13487 @vindex org-icalendar-include-body
13488 @cindex property, SUMMARY
13489 @cindex property, DESCRIPTION
13490 @cindex property, LOCATION
13491 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
13492 property can be inherited from higher in the hierarchy if you configure
13493 @code{org-use-property-inheritance} accordingly.} properties if the selected
13494 entries have them.  If not, the summary will be derived from the headline,
13495 and the description from the body (limited to
13496 @code{org-icalendar-include-body} characters).
13498 How this calendar is best read and updated, depends on the application
13499 you are using.  The FAQ covers this issue.
13501 @node Other built-in back-ends
13502 @section Other built-in back-ends
13503 @cindex export back-ends, built-in
13504 @vindex org-export-backends
13506 On top of the aforementioned back-ends, Org comes with other built-in ones:
13508 @itemize
13509 @item @file{ox-man.el}: export to a man page.
13510 @end itemize
13512 To activate these export back-end, customize @code{org-export-backends} or
13513 load them directly with e.g., @code{(require 'ox-man)}.  This will add new
13514 keys in the export dispatcher (@pxref{The export dispatcher}).
13516 See the comment section of these files for more information on how to use
13517 them.
13519 @node Export in foreign buffers
13520 @section Export in foreign buffers
13522 Most built-in back-ends come with a command to convert the selected region
13523 into a selected format and replace this region by the exported output.  Here
13524 is a list of such conversion commands:
13526 @table @code
13527 @item org-html-convert-region-to-html
13528 Convert the selected region into HTML.
13529 @item org-latex-convert-region-to-latex
13530 Convert the selected region into @LaTeX{}.
13531 @item org-texinfo-convert-region-to-texinfo
13532 Convert the selected region into @code{Texinfo}.
13533 @item org-md-convert-region-to-md
13534 Convert the selected region into @code{MarkDown}.
13535 @end table
13537 This is particularly useful for converting tables and lists in foreign
13538 buffers.  E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
13539 use Org commands for editing a list, and finally select and convert the list
13540 with @code{M-x org-html-convert-region-to-html RET}.
13542 @node Advanced configuration
13543 @section Advanced configuration
13545 @subheading Hooks
13547 @vindex org-export-before-processing-hook
13548 @vindex org-export-before-parsing-hook
13549 Two hooks are run during the first steps of the export process.  The first
13550 one, @code{org-export-before-processing-hook} is called before expanding
13551 macros, Babel code and include keywords in the buffer.  The second one,
13552 @code{org-export-before-parsing-hook}, as its name suggests, happens just
13553 before parsing the buffer.  Their main use is for heavy duties, that is
13554 duties involving structural modifications of the document.  For example, one
13555 may want to remove every headline in the buffer during export.  The following
13556 code can achieve this:
13558 @lisp
13559 @group
13560 (defun my-headline-removal (backend)
13561   "Remove all headlines in the current buffer.
13562 BACKEND is the export back-end being used, as a symbol."
13563   (org-map-entries
13564    (lambda () (delete-region (point) (progn (forward-line) (point))))))
13566 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
13567 @end group
13568 @end lisp
13570 Note that functions used in these hooks require a mandatory argument,
13571 a symbol representing the back-end used.
13573 @subheading Filters
13575 @cindex Filters, exporting
13576 Filters are lists of functions applied on a specific part of the output from
13577 a given back-end.  More explicitly, each time a back-end transforms an Org
13578 object or element into another language, all functions within a given filter
13579 type are called in turn on the string produced.  The string returned by the
13580 last function will be the one used in the final output.
13582 There are filter sets for each type of element or object, for plain text,
13583 for the parse tree, for the export options and for the final output.  They
13584 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
13585 where @code{TYPE} is the type targeted by the filter.  Valid types are:
13587 @multitable @columnfractions .33 .33 .33
13588 @item body
13589 @tab bold
13590 @tab babel-call
13591 @item center-block
13592 @tab clock
13593 @tab code
13594 @item diary-sexp
13595 @tab drawer
13596 @tab dynamic-block
13597 @item entity
13598 @tab example-block
13599 @tab export-block
13600 @item export-snippet
13601 @tab final-output
13602 @tab fixed-width
13603 @item footnote-definition
13604 @tab footnote-reference
13605 @tab headline
13606 @item horizontal-rule
13607 @tab inline-babel-call
13608 @tab inline-src-block
13609 @item inlinetask
13610 @tab italic
13611 @tab item
13612 @item keyword
13613 @tab latex-environment
13614 @tab latex-fragment
13615 @item line-break
13616 @tab link
13617 @tab node-property
13618 @item options
13619 @tab paragraph
13620 @tab parse-tree
13621 @item plain-list
13622 @tab plain-text
13623 @tab planning
13624 @item property-drawer
13625 @tab quote-block
13626 @tab quote-section
13627 @item radio-target
13628 @tab section
13629 @tab special-block
13630 @item src-block
13631 @tab statistics-cookie
13632 @tab strike-through
13633 @item subscript
13634 @tab superscript
13635 @tab table
13636 @item table-cell
13637 @tab table-row
13638 @tab target
13639 @item timestamp
13640 @tab underline
13641 @tab verbatim
13642 @item verse-block
13643 @end multitable
13645 For example, the following snippet allows me to use non-breaking spaces in
13646 the Org buffer and get them translated into @LaTeX{} without using the
13647 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
13649 @lisp
13650 @group
13651 (defun my-latex-filter-nobreaks (text backend info)
13652   "Ensure \" \" are properly handled in LaTeX export."
13653   (when (org-export-derived-backend-p backend 'latex)
13654         (replace-regexp-in-string " " "~" text)))
13656 (add-to-list 'org-export-filter-plain-text-functions
13657              'my-latex-filter-nobreaks)
13658 @end group
13659 @end lisp
13661 Three arguments must be provided to a filter: the code being changed, the
13662 back-end used, and some information about the export process.  You can safely
13663 ignore the third argument for most purposes.  Note the use of
13664 @code{org-export-derived-backend-p}, which ensures that the filter will only
13665 be applied when using @code{latex} back-end or any other back-end derived
13666 from it (e.g., @code{beamer}).
13668 @subheading Defining filters for individual files
13670 You can customize the export for just a specific file by binding export
13671 filter variables using @code{#+BIND}.  Here is an example where we introduce
13672 two filters, one to remove brackets from time stamps, and one to entirely
13673 remove any strike-through text.  The functions doing the filtering are
13674 defined in an src block that allows the filter function definitions to exist
13675 in the file itself and ensures that the functions will be there when needed.
13677 @example
13678 #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
13679 #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
13680 #+begin_src emacs-lisp :exports results :results none
13681   (defun tmp-f-timestamp (s backend info)
13682     (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
13683   (defun tmp-f-strike-through (s backend info) "")
13684 #+end_src
13685 @end example
13687 @subheading Extending an existing back-end
13689 This is obviously the most powerful customization, since the changes happen
13690 at the parser level.  Indeed, some export back-ends are built as extensions
13691 of other ones (e.g. Markdown back-end an extension of HTML back-end).
13693 Extending a back-end means that if an element type is not transcoded by the
13694 new back-end, it will be handled by the original one.  Hence you can extend
13695 specific parts of a back-end without too much work.
13697 As an example, imagine we want the @code{ascii} back-end to display the
13698 language used in a source block, when it is available, but only when some
13699 attribute is non-@code{nil}, like the following:
13701 @example
13702 #+ATTR_ASCII: :language t
13703 @end example
13705 Because that back-end is lacking in that area, we are going to create a new
13706 back-end, @code{my-ascii} that will do the job.
13708 @lisp
13709 @group
13710 (defun my-ascii-src-block (src-block contents info)
13711   "Transcode a SRC-BLOCK element from Org to ASCII.
13712 CONTENTS is nil.  INFO is a plist used as a communication
13713 channel."
13714   (if (not (org-export-read-attribute :attr_ascii src-block :language))
13715     (org-export-with-backend 'ascii src-block contents info)
13716   (concat
13717    (format ",--[ %s ]--\n%s`----"
13718            (org-element-property :language src-block)
13719            (replace-regexp-in-string
13720             "^" "| "
13721             (org-element-normalize-string
13722              (org-export-format-code-default src-block info)))))))
13724 (org-export-define-derived-backend 'my-ascii 'ascii
13725   :translate-alist '((src-block . my-ascii-src-block)))
13726 @end group
13727 @end lisp
13729 The @code{my-ascii-src-block} function looks at the attribute above the
13730 element.  If it isn't true, it gives hand to the @code{ascii} back-end.
13731 Otherwise, it creates a box around the code, leaving room for the language.
13732 A new back-end is then created.  It only changes its behavior when
13733 translating @code{src-block} type element.  Now, all it takes to use the new
13734 back-end is calling the following from an Org buffer:
13736 @smalllisp
13737 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
13738 @end smalllisp
13740 It is obviously possible to write an interactive function for this, install
13741 it in the export dispatcher menu, and so on.
13744 @node Publishing
13745 @chapter Publishing
13746 @cindex publishing
13748 Org includes a publishing management system that allows you to configure
13749 automatic HTML conversion of @emph{projects} composed of interlinked org
13750 files.  You can also configure Org to automatically upload your exported HTML
13751 pages and related attachments, such as images and source code files, to a web
13752 server.
13754 You can also use Org to convert files into PDF, or even combine HTML and PDF
13755 conversion so that files are available in both formats on the server.
13757 Publishing has been contributed to Org by David O'Toole.
13759 @menu
13760 * Configuration::               Defining projects
13761 * Uploading files::             How to get files up on the server
13762 * Sample configuration::        Example projects
13763 * Triggering publication::      Publication commands
13764 @end menu
13766 @node Configuration
13767 @section Configuration
13769 Publishing needs significant configuration to specify files, destination
13770 and many other properties of a project.
13772 @menu
13773 * Project alist::               The central configuration variable
13774 * Sources and destinations::    From here to there
13775 * Selecting files::             What files are part of the project?
13776 * Publishing action::           Setting the function doing the publishing
13777 * Publishing options::          Tweaking HTML/@LaTeX{} export
13778 * Publishing links::            Which links keep working after publishing?
13779 * Sitemap::                     Generating a list of all pages
13780 * Generating an index::         An index that reaches across pages
13781 @end menu
13783 @node Project alist
13784 @subsection The variable @code{org-publish-project-alist}
13785 @cindex org-publish-project-alist
13786 @cindex projects, for publishing
13788 @vindex org-publish-project-alist
13789 Publishing is configured almost entirely through setting the value of one
13790 variable, called @code{org-publish-project-alist}.  Each element of the list
13791 configures one project, and may be in one of the two following forms:
13793 @lisp
13794    ("project-name" :property value :property value ...)
13795      @r{i.e., a well-formed property list with alternating keys and values}
13796 @r{or}
13797    ("project-name" :components ("project-name" "project-name" ...))
13799 @end lisp
13801 In both cases, projects are configured by specifying property values.  A
13802 project defines the set of files that will be published, as well as the
13803 publishing configuration to use when publishing those files.  When a project
13804 takes the second form listed above, the individual members of the
13805 @code{:components} property are taken to be sub-projects, which group
13806 together files requiring different publishing options.  When you publish such
13807 a ``meta-project'', all the components will also be published, in the
13808 sequence given.
13810 @node Sources and destinations
13811 @subsection Sources and destinations for files
13812 @cindex directories, for publishing
13814 Most properties are optional, but some should always be set.  In
13815 particular, Org needs to know where to look for source files,
13816 and where to put published files.
13818 @multitable @columnfractions 0.3 0.7
13819 @item @code{:base-directory}
13820 @tab Directory containing publishing source files
13821 @item @code{:publishing-directory}
13822 @tab Directory where output files will be published.  You can directly
13823 publish to a web server using a file name syntax appropriate for
13824 the Emacs @file{tramp} package.  Or you can publish to a local directory and
13825 use external tools to upload your website (@pxref{Uploading files}).
13826 @item @code{:preparation-function}
13827 @tab Function or list of functions to be called before starting the
13828 publishing process, for example, to run @code{make} for updating files to be
13829 published.  The project property list is scoped into this call as the
13830 variable @code{project-plist}.
13831 @item @code{:completion-function}
13832 @tab Function or list of functions called after finishing the publishing
13833 process, for example, to change permissions of the resulting files.  The
13834 project property list is scoped into this call as the variable
13835 @code{project-plist}.
13836 @end multitable
13837 @noindent
13839 @node Selecting files
13840 @subsection Selecting files
13841 @cindex files, selecting for publishing
13843 By default, all files with extension @file{.org} in the base directory
13844 are considered part of the project.  This can be modified by setting the
13845 properties
13846 @multitable @columnfractions 0.25 0.75
13847 @item @code{:base-extension}
13848 @tab Extension (without the dot!) of source files.  This actually is a
13849 regular expression.  Set this to the symbol @code{any} if you want to get all
13850 files in @code{:base-directory}, even without extension.
13852 @item @code{:exclude}
13853 @tab Regular expression to match file names that should not be
13854 published, even though they have been selected on the basis of their
13855 extension.
13857 @item @code{:include}
13858 @tab List of files to be included regardless of @code{:base-extension}
13859 and @code{:exclude}.
13861 @item @code{:recursive}
13862 @tab non-@code{nil} means, check base-directory recursively for files to publish.
13863 @end multitable
13865 @node Publishing action
13866 @subsection Publishing action
13867 @cindex action, for publishing
13869 Publishing means that a file is copied to the destination directory and
13870 possibly transformed in the process.  The default transformation is to export
13871 Org files as HTML files, and this is done by the function
13872 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
13873 export}).  But you also can publish your content as PDF files using
13874 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
13875 using the corresponding functions.
13877 If you want to publish the Org file as an @code{.org} file but with the
13878 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
13879 function @code{org-org-publish-to-org}.  This will produce @file{file.org}
13880 and put it in the publishing directory.  If you want a htmlized version of
13881 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
13882 produce @file{file.org.html} in the publishing directory@footnote{If the
13883 publishing directory is the same than the source directory, @file{file.org}
13884 will be exported as @file{file.org.org}, so probably don't want to do this.}.
13886 Other files like images only need to be copied to the publishing destination.
13887 For this you can use @code{org-publish-attachment}.  For non-org files, you
13888 always need to specify the publishing function:
13890 @multitable @columnfractions 0.3 0.7
13891 @item @code{:publishing-function}
13892 @tab Function executing the publication of a file.  This may also be a
13893 list of functions, which will all be called in turn.
13894 @item @code{:htmlized-source}
13895 @tab non-@code{nil} means, publish htmlized source.
13896 @end multitable
13898 The function must accept three arguments: a property list containing at least
13899 a @code{:publishing-directory} property, the name of the file to be published
13900 and the path to the publishing directory of the output file.  It should take
13901 the specified file, make the necessary transformation (if any) and place the
13902 result into the destination folder.
13904 @node Publishing options
13905 @subsection Options for the exporters
13906 @cindex options, for publishing
13908 The property list can be used to set export options during the publishing
13909 process.  In most cases, these properties correspond to user variables in
13910 Org.  While some properties are available for all export back-ends, most of
13911 them are back-end specific.  The following sections list properties along
13912 with the variable they belong to.  See the documentation string of these
13913 options for details.
13915 @vindex org-publish-project-alist
13916 When a property is given a value in @code{org-publish-project-alist}, its
13917 setting overrides the value of the corresponding user variable (if any)
13918 during publishing.  Options set within a file (@pxref{Export settings}),
13919 however, override everything.
13921 @subsubheading Generic properties
13923 @multitable {@code{:with-sub-superscript}}  {@code{org-export-with-sub-superscripts}}
13924 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
13925 @item @code{:exclude-tags}          @tab @code{org-export-exclude-tags}
13926 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
13927 @item @code{:language}              @tab @code{org-export-default-language}
13928 @item @code{:preserve-breaks}       @tab @code{org-export-preserve-breaks}
13929 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
13930 @item @code{:select-tags}           @tab @code{org-export-select-tags}
13931 @item @code{:with-author}           @tab @code{org-export-with-author}
13932 @item @code{:with-creator}          @tab @code{org-export-with-creator}
13933 @item @code{:with-date}             @tab @code{org-export-with-date}
13934 @item @code{:with-drawers}          @tab @code{org-export-with-drawers}
13935 @item @code{:with-email}            @tab @code{org-export-with-email}
13936 @item @code{:with-emphasize}        @tab @code{org-export-with-emphasize}
13937 @item @code{:with-fixed-width}      @tab @code{org-export-with-fixed-width}
13938 @item @code{:with-footnotes}        @tab @code{org-export-with-footnotes}
13939 @item @code{:with-latex}            @tab @code{org-export-with-latex}
13940 @item @code{:with-planning}         @tab @code{org-export-with-planning}
13941 @item @code{:with-priority}         @tab @code{org-export-with-priority}
13942 @item @code{:with-properties}       @tab @code{org-export-with-properties}
13943 @item @code{:with-special-strings}  @tab @code{org-export-with-special-strings}
13944 @item @code{:with-sub-superscript}  @tab @code{org-export-with-sub-superscripts}
13945 @item @code{:with-tables}           @tab @code{org-export-with-tables}
13946 @item @code{:with-tags}             @tab @code{org-export-with-tags}
13947 @item @code{:with-tasks}            @tab @code{org-export-with-tasks}
13948 @item @code{:with-timestamps}       @tab @code{org-export-with-timestamps}
13949 @item @code{:with-title}            @tab @code{org-export-with-title}
13950 @item @code{:with-toc}              @tab @code{org-export-with-toc}
13951 @item @code{:with-todo-keywords}    @tab @code{org-export-with-todo-keywords}
13952 @end multitable
13954 @subsubheading ASCII specific properties
13956 @multitable {@code{:ascii-table-keep-all-vertical-lines}} {@code{org-ascii-table-keep-all-vertical-lines}}
13957 @item @code{:ascii-bullets}                       @tab @code{org-ascii-bullets}
13958 @item @code{:ascii-caption-above}                 @tab @code{org-ascii-caption-above}
13959 @item @code{:ascii-charset}                       @tab @code{org-ascii-charset}
13960 @item @code{:ascii-global-margin}                 @tab @code{org-ascii-global-margin}
13961 @item @code{:ascii-format-drawer-function}        @tab @code{org-ascii-format-drawer-function}
13962 @item @code{:ascii-format-inlinetask-function}    @tab @code{org-ascii-format-inlinetask-function}
13963 @item @code{:ascii-headline-spacing}              @tab @code{org-ascii-headline-spacing}
13964 @item @code{:ascii-indented-line-width}           @tab @code{org-ascii-indented-line-width}
13965 @item @code{:ascii-inlinetask-width}              @tab @code{org-ascii-inlinetask-width}
13966 @item @code{:ascii-inner-margin}                  @tab @code{org-ascii-inner-margin}
13967 @item @code{:ascii-links-to-notes}                @tab @code{org-ascii-links-to-notes}
13968 @item @code{:ascii-list-margin}                   @tab @code{org-ascii-list-margin}
13969 @item @code{:ascii-paragraph-spacing}             @tab @code{org-ascii-paragraph-spacing}
13970 @item @code{:ascii-quote-margin}                  @tab @code{org-ascii-quote-margin}
13971 @item @code{:ascii-table-keep-all-vertical-lines} @tab @code{org-ascii-table-keep-all-vertical-lines}
13972 @item @code{:ascii-table-use-ascii-art}           @tab @code{org-ascii-table-use-ascii-art}
13973 @item @code{:ascii-table-widen-columns}           @tab @code{org-ascii-table-widen-columns}
13974 @item @code{:ascii-text-width}                    @tab @code{org-ascii-text-width}
13975 @item @code{:ascii-underline}                     @tab @code{org-ascii-underline}
13976 @item @code{:ascii-verbatim-format}               @tab @code{org-ascii-verbatim-format}
13977 @end multitable
13979 @subsubheading Beamer specific properties
13981 @multitable {@code{:beamer-frame-default-options}} {@code{org-beamer-frame-default-options}}
13982 @item @code{:beamer-theme}                 @tab @code{org-beamer-theme}
13983 @item @code{:beamer-column-view-format}    @tab @code{org-beamer-column-view-format}
13984 @item @code{:beamer-environments-extra}    @tab @code{org-beamer-environments-extra}
13985 @item @code{:beamer-frame-default-options} @tab @code{org-beamer-frame-default-options}
13986 @item @code{:beamer-outline-frame-options} @tab @code{org-beamer-outline-frame-options}
13987 @item @code{:beamer-outline-frame-title}   @tab @code{org-beamer-outline-frame-title}
13988 @end multitable
13990 @subsubheading HTML specific properties
13992 @multitable {@code{:html-table-use-header-tags-for-first-column}} {@code{org-html-table-use-header-tags-for-first-column}}
13993 @item @code{:html-allow-name-attribute-in-anchors} @tab @code{org-html-allow-name-attribute-in-anchors}
13994 @item @code{:html-checkbox-type}              @tab @code{org-html-checkbox-type}
13995 @item @code{:html-container}                  @tab @code{org-html-container-element}
13996 @item @code{:html-divs}                       @tab @code{org-html-divs}
13997 @item @code{:html-doctype}                    @tab @code{org-html-doctype}
13998 @item @code{:html-extension}                  @tab @code{org-html-extension}
13999 @item @code{:html-footnote-format}            @tab @code{org-html-footnote-format}
14000 @item @code{:html-footnote-separator}         @tab @code{org-html-footnote-separator}
14001 @item @code{:html-footnotes-section}          @tab @code{org-html-footnotes-section}
14002 @item @code{:html-format-drawer-function}     @tab @code{org-html-format-drawer-function}
14003 @item @code{:html-format-headline-function}   @tab @code{org-html-format-headline-function}
14004 @item @code{:html-format-inlinetask-function} @tab @code{org-html-format-inlinetask-function}
14005 @item @code{:html-head-extra}                 @tab @code{org-html-head-extra}
14006 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
14007 @item @code{:html-head-include-scripts}       @tab @code{org-html-head-include-scripts}
14008 @item @code{:html-head}                       @tab @code{org-html-head}
14009 @item @code{:html-home/up-format}             @tab @code{org-html-home/up-format}
14010 @item @code{:html-html5-fancy}                @tab @code{org-html-html5-fancy}
14011 @item @code{:html-indent}                     @tab @code{org-html-indent}
14012 @item @code{:html-infojs-options}             @tab @code{org-html-infojs-options}
14013 @item @code{:html-infojs-template}            @tab @code{org-html-infojs-template}
14014 @item @code{:html-inline-image-rules}         @tab @code{org-html-inline-image-rules}
14015 @item @code{:html-inline-images}              @tab @code{org-html-inline-images}
14016 @item @code{:html-link-home}                  @tab @code{org-html-link-home}
14017 @item @code{:html-link-org-files-as-html}     @tab @code{org-html-link-org-files-as-html}
14018 @item @code{:html-link-up}                    @tab @code{org-html-link-up}
14019 @item @code{:html-link-use-abs-url}           @tab @code{org-html-link-use-abs-url}
14020 @item @code{:html-mathjax-options}            @tab @code{org-html-mathjax-options}
14021 @item @code{:html-mathjax-template}           @tab @code{org-html-mathjax-template}
14022 @item @code{:html-metadata-timestamp-format}  @tab @code{org-html-metadata-timestamp-format}
14023 @item @code{:html-postamble-format}           @tab @code{org-html-postamble-format}
14024 @item @code{:html-postamble}                  @tab @code{org-html-postamble}
14025 @item @code{:html-preamble-format}            @tab @code{org-html-preamble-format}
14026 @item @code{:html-preamble}                   @tab @code{org-html-preamble}
14027 @item @code{:html-table-align-individual-fields} @tab @code{org-html-table-align-individual-fields}
14028 @item @code{:html-table-attributes}           @tab @code{org-html-table-default-attributes}
14029 @item @code{:html-table-caption-above}        @tab @code{org-html-table-caption-above}
14030 @item @code{:html-table-data-tags}            @tab @code{org-html-table-data-tags}
14031 @item @code{:html-table-header-tags}          @tab @code{org-html-table-header-tags}
14032 @item @code{:html-table-row-tags}             @tab @code{org-html-table-row-tags}
14033 @item @code{:html-table-use-header-tags-for-first-column} @tab @code{org-html-table-use-header-tags-for-first-column}
14034 @item @code{:html-tag-class-prefix}           @tab @code{org-html-tag-class-prefix}
14035 @item @code{:html-text-markup-alist}          @tab @code{org-html-text-markup-alist}
14036 @item @code{:html-todo-kwd-class-prefix}      @tab @code{org-html-todo-kwd-class-prefix}
14037 @item @code{:html-toplevel-hlevel}            @tab @code{org-html-toplevel-hlevel}
14038 @item @code{:html-use-infojs}                 @tab @code{org-html-use-infojs}
14039 @item @code{:html-use-unicode-chars}          @tab @code{org-html-use-unicode-chars}
14040 @item @code{:html-validation-link}            @tab @code{org-html-validation-link}
14041 @item @code{:html-xml-declaration}            @tab @code{org-html-xml-declaration}
14042 @end multitable
14044 @subsubheading @LaTeX{} specific properties
14046 @multitable {@code{:latex-link-with-unknown-path-format}} {@code{org-latex-link-with-unknown-path-format}} 
14047 @item @code{:latex-active-timestamp-format}    @tab @code{org-latex-active-timestamp-format}
14048 @item @code{:latex-caption-above}              @tab @code{org-latex-caption-above}
14049 @item @code{:latex-classes}                    @tab @code{org-latex-classes}
14050 @item @code{:latex-class}                      @tab @code{org-latex-default-class}
14051 @item @code{:latex-custom-id-labels}           @tab @code{org-latex-custom-id-as-label}
14052 @item @code{:latex-default-figure-position}    @tab @code{org-latex-default-figure-position}
14053 @item @code{:latex-default-table-environment}  @tab @code{org-latex-default-table-environment}
14054 @item @code{:latex-default-table-mode}         @tab @code{org-latex-default-table-mode}
14055 @item @code{:latex-diary-timestamp-format}     @tab @code{org-latex-diary-timestamp-format}
14056 @item @code{:latex-footnote-separator}         @tab @code{org-latex-footnote-separator}
14057 @item @code{:latex-format-drawer-function}     @tab @code{org-latex-format-drawer-function}
14058 @item @code{:latex-format-headline-function}   @tab @code{org-latex-format-headline-function}
14059 @item @code{:latex-format-inlinetask-function} @tab @code{org-latex-format-inlinetask-function}
14060 @item @code{:latex-hyperref-template}          @tab @code{org-latex-hyperref-template}
14061 @item @code{:latex-image-default-height}       @tab @code{org-latex-image-default-height}
14062 @item @code{:latex-image-default-option}       @tab @code{org-latex-image-default-option}
14063 @item @code{:latex-image-default-width}        @tab @code{org-latex-image-default-width}
14064 @item @code{:latex-inactive-timestamp-format}  @tab @code{org-latex-inactive-timestamp-format}
14065 @item @code{:latex-inline-image-rules}         @tab @code{org-latex-inline-image-rules}
14066 @item @code{:latex-link-with-unknown-path-format} @tab @code{org-latex-link-with-unknown-path-format}
14067 @item @code{:latex-listings-langs}             @tab @code{org-latex-listings-langs}
14068 @item @code{:latex-listings-options}           @tab @code{org-latex-listings-options}
14069 @item @code{:latex-listings}                   @tab @code{org-latex-listings}
14070 @item @code{:latex-minted-langs}               @tab @code{org-latex-minted-langs}
14071 @item @code{:latex-minted-options}             @tab @code{org-latex-minted-options}
14072 @item @code{:latex-table-scientific-notation}  @tab @code{org-latex-table-scientific-notation}
14073 @item @code{:latex-tables-booktabs}            @tab @code{org-latex-tables-booktabs}
14074 @item @code{:latex-tables-centered}            @tab @code{org-latex-tables-centered}
14075 @item @code{:latex-text-markup-alist}          @tab @code{org-latex-text-markup-alist}
14076 @item @code{:latex-title-command}              @tab @code{org-latex-title-command}
14077 @item @code{:latex-toc-command}                @tab @code{org-latex-toc-command}
14078 @end multitable
14080 @subsubheading Markdown specific properties
14082 @multitable {@code{:md-headline-style}} {@code{org-md-headline-style}}
14083 @item @code{:md-headline-style} @tab @code{org-md-headline-style}
14084 @end multitable
14086 @subsubheading ODT specific properties
14088 @multitable {@code{:odt-format-inlinetask-function}} {@code{org-odt-format-inlinetask-function}}
14089 @item @code{:odt-content-template-file}      @tab @code{org-odt-content-template-file}
14090 @item @code{:odt-display-outline-level}      @tab @code{org-odt-display-outline-level}
14091 @item @code{:odt-fontify-srcblocks}          @tab @code{org-odt-fontify-srcblocks}
14092 @item @code{:odt-format-drawer-function}     @tab @code{org-odt-format-drawer-function}
14093 @item @code{:odt-format-headline-function}   @tab @code{org-odt-format-headline-function}
14094 @item @code{:odt-format-inlinetask-function} @tab @code{org-odt-format-inlinetask-function}
14095 @item @code{:odt-inline-formula-rules}       @tab @code{org-odt-inline-formula-rules}
14096 @item @code{:odt-inline-image-rules}         @tab @code{org-odt-inline-image-rules}
14097 @item @code{:odt-pixels-per-inch}            @tab @code{org-odt-pixels-per-inch}
14098 @item @code{:odt-styles-file}                @tab @code{org-odt-styles-file}
14099 @item @code{:odt-table-styles}               @tab @code{org-odt-table-styles}
14100 @item @code{:odt-use-date-fields}            @tab @code{org-odt-use-date-fields}
14101 @end multitable
14103 @subsubheading Texinfo specific properties
14105 @multitable {@code{:texinfo-link-with-unknown-path-format}} {@code{org-texinfo-link-with-unknown-path-format}}
14106 @item @code{:texinfo-active-timestamp-format}    @tab @code{org-texinfo-active-timestamp-format}
14107 @item @code{:texinfo-classes}                    @tab @code{org-texinfo-classes}
14108 @item @code{:texinfo-class}                      @tab @code{org-texinfo-default-class}
14109 @item @code{:texinfo-def-table-markup}           @tab @code{org-texinfo-def-table-markup}
14110 @item @code{:texinfo-diary-timestamp-format}     @tab @code{org-texinfo-diary-timestamp-format}
14111 @item @code{:texinfo-filename}                   @tab @code{org-texinfo-filename}
14112 @item @code{:texinfo-format-drawer-function}     @tab @code{org-texinfo-format-drawer-function}
14113 @item @code{:texinfo-format-headline-function}   @tab @code{org-texinfo-format-headline-function}
14114 @item @code{:texinfo-format-inlinetask-function} @tab @code{org-texinfo-format-inlinetask-function}
14115 @item @code{:texinfo-inactive-timestamp-format}  @tab @code{org-texinfo-inactive-timestamp-format}
14116 @item @code{:texinfo-link-with-unknown-path-format} @tab @code{org-texinfo-link-with-unknown-path-format}
14117 @item @code{:texinfo-node-description-column}    @tab @code{org-texinfo-node-description-column}
14118 @item @code{:texinfo-table-scientific-notation}  @tab @code{org-texinfo-table-scientific-notation}
14119 @item @code{:texinfo-tables-verbatim}            @tab @code{org-texinfo-tables-verbatim}
14120 @item @code{:texinfo-text-markup-alist}          @tab @code{org-texinfo-text-markup-alist}
14121 @end multitable
14123 @node Publishing links
14124 @subsection Links between published files
14125 @cindex links, publishing
14127 To create a link from one Org file to another, you would use something like
14128 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
14129 (@pxref{Hyperlinks}).  When published, this link becomes a link to
14130 @file{foo.html}.  You can thus interlink the pages of your "org web" project
14131 and the links will work as expected when you publish them to HTML@.  If you
14132 also publish the Org source file and want to link to it, use an @code{http:}
14133 link instead of a @code{file:} link, because @code{file:} links are converted
14134 to link to the corresponding @file{html} file.
14136 You may also link to related files, such as images.  Provided you are careful
14137 with relative file names, and provided you have also configured Org to upload
14138 the related files, these links will work too.  See @ref{Complex example}, for
14139 an example of this usage.
14141 @node Sitemap
14142 @subsection Generating a sitemap
14143 @cindex sitemap, of published pages
14145 The following properties may be used to control publishing of
14146 a map of files for a given project.
14148 @multitable @columnfractions 0.35 0.65
14149 @item @code{:auto-sitemap}
14150 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
14151 or @code{org-publish-all}.
14153 @item @code{:sitemap-filename}
14154 @tab Filename for output of sitemap.  Defaults to @file{sitemap.org} (which
14155 becomes @file{sitemap.html}).
14157 @item @code{:sitemap-title}
14158 @tab Title of sitemap page.  Defaults to name of file.
14160 @item @code{:sitemap-function}
14161 @tab Plug-in function to use for generation of the sitemap.
14162 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
14163 of links to all files in the project.
14165 @item @code{:sitemap-sort-folders}
14166 @tab Where folders should appear in the sitemap.  Set this to @code{first}
14167 (default) or @code{last} to display folders first or last,
14168 respectively.  Any other value will mix files and folders.
14170 @item @code{:sitemap-sort-files}
14171 @tab How the files are sorted in the site map.  Set this to
14172 @code{alphabetically} (default), @code{chronologically} or
14173 @code{anti-chronologically}.  @code{chronologically} sorts the files with
14174 older date first while @code{anti-chronologically} sorts the files with newer
14175 date first.  @code{alphabetically} sorts the files alphabetically.  The date of
14176 a file is retrieved with @code{org-publish-find-date}.
14178 @item @code{:sitemap-ignore-case}
14179 @tab Should sorting be case-sensitive?  Default @code{nil}.
14181 @item @code{:sitemap-file-entry-format}
14182 @tab With this option one can tell how a sitemap's entry is formatted in the
14183 sitemap.  This is a format string with some escape sequences: @code{%t} stands
14184 for the title of the file, @code{%a} stands for the author of the file and
14185 @code{%d} stands for the date of the file.  The date is retrieved with the
14186 @code{org-publish-find-date} function and formatted with
14187 @code{org-publish-sitemap-date-format}.  Default @code{%t}.
14189 @item @code{:sitemap-date-format}
14190 @tab Format string for the @code{format-time-string} function that tells how
14191 a sitemap entry's date is to be formatted.  This property bypasses
14192 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
14194 @item @code{:sitemap-sans-extension}
14195 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
14196 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
14197 Defaults to @code{nil}.
14199 @end multitable
14201 @node Generating an index
14202 @subsection Generating an index
14203 @cindex index, in a publishing project
14205 Org mode can generate an index across the files of a publishing project.
14207 @multitable @columnfractions 0.25 0.75
14208 @item @code{:makeindex}
14209 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
14210 publish it as @file{theindex.html}.
14211 @end multitable
14213 The file will be created when first publishing a project with the
14214 @code{:makeindex} set.  The file only contains a statement @code{#+INCLUDE:
14215 "theindex.inc"}.  You can then build around this include statement by adding
14216 a title, style information, etc.
14218 @node Uploading files
14219 @section Uploading files
14220 @cindex rsync
14221 @cindex unison
14223 For those people already utilizing third party sync tools such as
14224 @command{rsync} or @command{unison}, it might be preferable not to use the built in
14225 @i{remote} publishing facilities of Org mode which rely heavily on
14226 Tramp.  Tramp, while very useful and powerful, tends not to be
14227 so efficient for multiple file transfer and has been known to cause problems
14228 under heavy usage.
14230 Specialized synchronization utilities offer several advantages.  In addition
14231 to timestamp comparison, they also do content and permissions/attribute
14232 checks.  For this reason you might prefer to publish your web to a local
14233 directory (possibly even @i{in place} with your Org files) and then use
14234 @file{unison} or @file{rsync} to do the synchronization with the remote host.
14236 Since Unison (for example) can be configured as to which files to transfer to
14237 a certain remote destination, it can greatly simplify the project publishing
14238 definition.  Simply keep all files in the correct location, process your Org
14239 files with @code{org-publish} and let the synchronization tool do the rest.
14240 You do not need, in this scenario, to include attachments such as @file{jpg},
14241 @file{css} or @file{gif} files in the project definition since the 3rd party
14242 tool syncs them.
14244 Publishing to a local directory is also much faster than to a remote one, so
14245 that you can afford more easily to republish entire projects.  If you set
14246 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
14247 benefit of re-including any changed external files such as source example
14248 files you might include with @code{#+INCLUDE:}.  The timestamp mechanism in
14249 Org is not smart enough to detect if included files have been modified.
14251 @node Sample configuration
14252 @section Sample configuration
14254 Below we provide two example configurations.  The first one is a simple
14255 project publishing only a set of Org files.  The second example is
14256 more complex, with a multi-component project.
14258 @menu
14259 * Simple example::              One-component publishing
14260 * Complex example::             A multi-component publishing example
14261 @end menu
14263 @node Simple example
14264 @subsection Example: simple publishing configuration
14266 This example publishes a set of Org files to the @file{public_html}
14267 directory on the local machine.
14269 @lisp
14270 (setq org-publish-project-alist
14271       '(("org"
14272          :base-directory "~/org/"
14273          :publishing-directory "~/public_html"
14274          :section-numbers nil
14275          :with-toc nil
14276          :html-head "<link rel=\"stylesheet\"
14277                     href=\"../other/mystyle.css\"
14278                     type=\"text/css\"/>")))
14279 @end lisp
14281 @node Complex example
14282 @subsection Example: complex publishing configuration
14284 This more complicated example publishes an entire website, including
14285 Org files converted to HTML, image files, Emacs Lisp source code, and
14286 style sheets.  The publishing directory is remote and private files are
14287 excluded.
14289 To ensure that links are preserved, care should be taken to replicate
14290 your directory structure on the web server, and to use relative file
14291 paths.  For example, if your Org files are kept in @file{~/org} and your
14292 publishable images in @file{~/images}, you would link to an image with
14294 @example
14295 file:../images/myimage.png
14296 @end example
14298 On the web server, the relative path to the image should be the
14299 same.  You can accomplish this by setting up an "images" folder in the
14300 right place on the web server, and publishing images to it.
14302 @lisp
14303 (setq org-publish-project-alist
14304       '(("orgfiles"
14305           :base-directory "~/org/"
14306           :base-extension "org"
14307           :publishing-directory "/ssh:user@@host:~/html/notebook/"
14308           :publishing-function org-html-publish-to-html
14309           :exclude "PrivatePage.org"   ;; regexp
14310           :headline-levels 3
14311           :section-numbers nil
14312           :with-toc nil
14313           :html-head "<link rel=\"stylesheet\"
14314                   href=\"../other/mystyle.css\" type=\"text/css\"/>"
14315           :html-preamble t)
14317          ("images"
14318           :base-directory "~/images/"
14319           :base-extension "jpg\\|gif\\|png"
14320           :publishing-directory "/ssh:user@@host:~/html/images/"
14321           :publishing-function org-publish-attachment)
14323          ("other"
14324           :base-directory "~/other/"
14325           :base-extension "css\\|el"
14326           :publishing-directory "/ssh:user@@host:~/html/other/"
14327           :publishing-function org-publish-attachment)
14328          ("website" :components ("orgfiles" "images" "other"))))
14329 @end lisp
14331 @node Triggering publication
14332 @section Triggering publication
14334 Once properly configured, Org can publish with the following commands:
14336 @table @kbd
14337 @orgcmd{C-c C-e P x,org-publish}
14338 Prompt for a specific project and publish all files that belong to it.
14339 @orgcmd{C-c C-e P p,org-publish-current-project}
14340 Publish the project containing the current file.
14341 @orgcmd{C-c C-e P f,org-publish-current-file}
14342 Publish only the current file.
14343 @orgcmd{C-c C-e P a,org-publish-all}
14344 Publish every project.
14345 @end table
14347 @vindex org-publish-use-timestamps-flag
14348 Org uses timestamps to track when a file has changed.  The above functions
14349 normally only publish changed files.  You can override this and force
14350 publishing of all files by giving a prefix argument to any of the commands
14351 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
14352 This may be necessary in particular if files include other files via
14353 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
14356 @node Working with source code
14357 @chapter Working with source code
14358 @cindex Schulte, Eric
14359 @cindex Davison, Dan
14360 @cindex source code, working with
14362 Source code can be included in Org mode documents using a @samp{src} block,
14363 e.g.:
14365 @example
14366 #+BEGIN_SRC emacs-lisp
14367   (defun org-xor (a b)
14368      "Exclusive or."
14369      (if a (not b) b))
14370 #+END_SRC
14371 @end example
14373 Org mode provides a number of features for working with live source code,
14374 including editing of code blocks in their native major-mode, evaluation of
14375 code blocks, converting code blocks into source files (known as @dfn{tangling}
14376 in literate programming), and exporting code blocks and their
14377 results in several formats.  This functionality was contributed by Eric
14378 Schulte and Dan Davison, and was originally named Org-babel.
14380 The following sections describe Org mode's code block handling facilities.
14382 @menu
14383 * Structure of code blocks::    Code block syntax described
14384 * Editing source code::         Language major-mode editing
14385 * Exporting code blocks::       Export contents and/or results
14386 * Extracting source code::      Create pure source code files
14387 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
14388 * Library of Babel::            Use and contribute to a library of useful code blocks
14389 * Languages::                   List of supported code block languages
14390 * Header arguments::            Configure code block functionality
14391 * Results of evaluation::       How evaluation results are handled
14392 * Noweb reference syntax::      Literate programming in Org mode
14393 * Key bindings and useful functions::  Work quickly with code blocks
14394 * Batch execution::             Call functions from the command line
14395 @end menu
14398 @node Structure of code blocks
14399 @section Structure of code blocks
14400 @cindex code block, structure
14401 @cindex source code, block structure
14402 @cindex #+NAME
14403 @cindex #+BEGIN_SRC
14405 Live code blocks can be specified with a @samp{src} block or
14406 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
14407 @ref{Easy templates} system}  The structure of a @samp{src} block is
14409 @example
14410 #+NAME: <name>
14411 #+BEGIN_SRC <language> <switches> <header arguments>
14412   <body>
14413 #+END_SRC
14414 @end example
14416 The @code{#+NAME:} line is optional, and can be used to name the code
14417 block.  Live code blocks require that a language be specified on the
14418 @code{#+BEGIN_SRC} line.  Switches and header arguments are optional.
14419 @cindex source code, inline
14421 Live code blocks can also be specified inline using
14423 @example
14424 src_<language>@{<body>@}
14425 @end example
14429 @example
14430 src_<language>[<header arguments>]@{<body>@}
14431 @end example
14433 @table @code
14434 @item <#+NAME: name>
14435 This line associates a name with the code block.  This is similar to the
14436 @code{#+NAME: Name} lines that can be used to name tables in Org mode
14437 files.  Referencing the name of a code block makes it possible to evaluate
14438 the block from other places in the file, from other files, or from Org mode
14439 table formulas (see @ref{The spreadsheet}).  Names are assumed to be unique
14440 and the behavior of Org mode when two or more blocks share the same name is
14441 undefined.
14442 @cindex #+NAME
14443 @item <language>
14444 The language of the code in the block (see @ref{Languages}).
14445 @cindex source code, language
14446 @item <switches>
14447 Optional switches control code block export (see the discussion of switches in
14448 @ref{Literal examples})
14449 @cindex source code, switches
14450 @item <header arguments>
14451 Optional header arguments control many aspects of evaluation, export and
14452 tangling of code blocks (see @ref{Header arguments}).
14453 Header arguments can also be set on a per-buffer or per-subtree
14454 basis using properties.
14455 @item source code, header arguments
14456 @item <body>
14457 Source code in the specified language.
14458 @end table
14461 @node Editing source code
14462 @section Editing source code
14463 @cindex code block, editing
14464 @cindex source code, editing
14466 @vindex org-edit-src-auto-save-idle-delay
14467 @vindex org-edit-src-turn-on-auto-save
14468 @kindex C-c '
14469 Use @kbd{C-c '} to edit the current code block.  This brings up a language
14470 major-mode edit buffer containing the body of the code block.  Manually
14471 saving this buffer with @key{C-x C-s} will write the contents back to the Org
14472 buffer.  You can also set @code{org-edit-src-auto-save-idle-delay} to save the
14473 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
14474 to auto-save this buffer into a separate file using @code{auto-save-mode}.
14475 Use @kbd{C-c '} again to exit.
14477 The @code{org-src-mode} minor mode will be active in the edit buffer.  The
14478 following variables can be used to configure the behavior of the edit
14479 buffer.  See also the customization group @code{org-edit-structure} for
14480 further configuration options.
14482 @table @code
14483 @item org-src-lang-modes
14484 If an Emacs major-mode named @code{<lang>-mode} exists, where
14485 @code{<lang>} is the language named in the header line of the code block,
14486 then the edit buffer will be placed in that major-mode.  This variable
14487 can be used to map arbitrary language names to existing major modes.
14488 @item org-src-window-setup
14489 Controls the way Emacs windows are rearranged when the edit buffer is created.
14490 @item org-src-preserve-indentation
14491 @cindex indentation, in source blocks
14492 By default, the value is @code{nil}, which means that when code blocks are
14493 evaluated during export or tangled, they are re-inserted into the code block,
14494 which may replace sequences of spaces with tab characters.  When non-@code{nil},
14495 whitespace in code blocks will be preserved during export or tangling,
14496 exactly as it appears.  This variable is especially useful for tangling
14497 languages such as Python, in which whitespace indentation in the output is
14498 critical.
14499 @item org-src-ask-before-returning-to-edit-buffer
14500 By default, Org will ask before returning to an open edit buffer.  Set this
14501 variable to @code{nil} to switch without asking.
14502 @end table
14504 To turn on native code fontification in the @emph{Org} buffer, configure the
14505 variable @code{org-src-fontify-natively}.
14508 @node Exporting code blocks
14509 @section Exporting code blocks
14510 @cindex code block, exporting
14511 @cindex source code, exporting
14513 It is possible to export the @emph{code} of code blocks, the @emph{results}
14514 of code block evaluation, @emph{both} the code and the results of code block
14515 evaluation, or @emph{none}.  For most languages, the default exports code.
14516 However, for some languages (e.g., @code{ditaa}) the default exports the
14517 results of code block evaluation.  For information on exporting code block
14518 bodies, see @ref{Literal examples}.
14520 The @code{:exports} header argument can be used to specify export
14521 behavior (note that these arguments are only relevant for code blocks, not
14522 inline code):
14524 @subsubheading Header arguments:
14526 @table @code
14527 @cindex @code{:exports}, src header argument
14528 @item :exports code
14529 The default in most languages.  The body of the code block is exported, as
14530 described in @ref{Literal examples}.
14531 @item :exports results
14532 The code block will be evaluated each time to buffer is exported, and the
14533 results will be placed in the Org mode buffer for export, either updating
14534 previous results of the code block located anywhere in the buffer or, if no
14535 previous results exist, placing the results immediately after the code block.
14536 The body of the code block will not be exported.
14537 @item :exports both
14538 Both the code block and its results will be exported.
14539 @item :exports none
14540 Neither the code block nor its results will be exported.
14541 @end table
14543 It is possible to inhibit the evaluation of code blocks during export.
14544 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
14545 ensure that no code blocks are evaluated as part of the export process.  This
14546 can be useful in situations where potentially untrusted Org mode files are
14547 exported in an automated fashion, for example when Org mode is used as the
14548 markup language for a wiki.  It is also possible to set this variable to
14549 @code{inline-only}.  In that case, only inline code blocks will be
14550 evaluated, in order to insert their results.  Non-inline code blocks are
14551 assumed to have their results already inserted in the buffer by manual
14552 evaluation.  This setting is useful to avoid expensive recalculations during
14553 export, not to provide security.
14555 Code blocks in commented subtrees (@pxref{Comment lines}) are never evaluated
14556 on export.  However, code blocks in subtrees excluded from export
14557 (@pxref{Export settings}) may be evaluated on export.
14559 @node Extracting source code
14560 @section Extracting source code
14561 @cindex tangling
14562 @cindex source code, extracting
14563 @cindex code block, extracting source code
14565 Creating pure source code files by extracting code from source blocks is
14566 referred to as ``tangling''---a term adopted from the literate programming
14567 community.  During ``tangling'' of code blocks their bodies are expanded
14568 using @code{org-babel-expand-src-block} which can expand both variable and
14569 ``noweb'' style references  (see @ref{Noweb reference syntax}).
14571 @subsubheading Header arguments
14573 @table @code
14574 @cindex @code{:tangle}, src header argument
14575 @item :tangle no
14576 The default.  The code block is not included in the tangled output.
14577 @item :tangle yes
14578 Include the code block in the tangled output.  The output file name is the
14579 name of the org file with the extension @samp{.org} replaced by the extension
14580 for the block language.
14581 @item :tangle filename
14582 Include the code block in the tangled output to file @samp{filename}.
14583 @end table
14585 @kindex  C-c C-v t
14586 @subsubheading Functions
14588 @table @code
14589 @item org-babel-tangle
14590 Tangle the current file.  Bound to @kbd{C-c C-v t}.
14592 With prefix argument only tangle the current code block.
14593 @item org-babel-tangle-file
14594 Choose a file to tangle.  Bound to @kbd{C-c C-v f}.
14595 @end table
14597 @subsubheading Hooks
14599 @table @code
14600 @item org-babel-post-tangle-hook
14601 This hook is run from within code files tangled by @code{org-babel-tangle}.
14602 Example applications could include post-processing, compilation or evaluation
14603 of tangled code files.
14604 @end table
14606 @subsubheading Jumping between code and Org
14608 When tangling code from an Org-mode buffer to a source code file, you'll
14609 frequently find yourself viewing the file of tangled source code (e.g., many
14610 debuggers point to lines of the source code file).  It is useful to be able
14611 to navigate from the tangled source to the Org-mode buffer from which the
14612 code originated.
14614 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
14615 code to Org-mode functionality.  Two header arguments are required for
14616 jumping to work, first the @code{padline} (@ref{padline}) option must be set
14617 to true (the default setting), second the @code{comments} (@ref{comments})
14618 header argument must be set to @code{links}, which will insert comments into
14619 the source code buffer which point back to the original Org-mode file.
14621 @node Evaluating code blocks
14622 @section Evaluating code blocks
14623 @cindex code block, evaluating
14624 @cindex source code, evaluating
14625 @cindex #+RESULTS
14627 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
14628 potential for that code to do harm.  Org mode provides safeguards to ensure
14629 that code is only evaluated after explicit confirmation from the user.  For
14630 information on these safeguards (and on how to disable them) see @ref{Code
14631 evaluation security}.} and the results of evaluation optionally placed in the
14632 Org mode buffer.  The results of evaluation are placed following a line that
14633 begins by default with @code{#+RESULTS} and optionally a cache identifier
14634 and/or the name of the evaluated code block.  The default value of
14635 @code{#+RESULTS} can be changed with the customizable variable
14636 @code{org-babel-results-keyword}.
14638 By default, the evaluation facility is only enabled for Lisp code blocks
14639 specified as @code{emacs-lisp}.  However, source code blocks in many languages
14640 can be evaluated within Org mode (see @ref{Languages} for a list of supported
14641 languages and @ref{Structure of code blocks} for information on the syntax
14642 used to define a code block).
14644 @kindex C-c C-c
14645 There are a number of ways to evaluate code blocks.  The simplest is to press
14646 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
14647 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
14648 evaluation from the @kbd{C-c C-c} key binding.}.  This will call the
14649 @code{org-babel-execute-src-block} function to evaluate the block and insert
14650 its results into the Org mode buffer.
14652 @cindex #+CALL
14653 It is also possible to evaluate named code blocks from anywhere in an Org
14654 mode buffer or an Org mode table.  These named code blocks can be located in
14655 the current Org mode buffer or in the ``Library of Babel'' (@pxref{Library of
14656 Babel}).  Named code blocks can be evaluated with a separate @code{#+CALL:}
14657 line or inline within a block of text.  In both cases the result is wrapped
14658 according to the value of @code{org-babel-inline-result-wrap}, which by
14659 default is @code{"=%s="} for markup that produces verbatim text.
14661 The syntax of the @code{#+CALL:} line is
14663 @example
14664 #+CALL: <name>(<arguments>)
14665 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
14666 @end example
14668 The syntax for inline evaluation of named code blocks is
14670 @example
14671 ... call_<name>(<arguments>) ...
14672 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
14673 @end example
14675 @table @code
14676 @item <name>
14677 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
14678 @item <arguments>
14679 Arguments specified in this section will be passed to the code block.  These
14680 arguments use standard function call syntax, rather than
14681 header argument syntax.  For example, a @code{#+CALL:} line that passes the
14682 number four to a code block named @code{double}, which declares the header
14683 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
14684 @item <inside header arguments>
14685 Inside header arguments are passed through and applied to the named code
14686 block.  These arguments use header argument syntax rather than standard
14687 function call syntax.  Inside header arguments affect how the code block is
14688 evaluated.  For example, @code{[:results output]} will collect the results of
14689 everything printed to @code{STDOUT} during execution of the code block.
14690 @item <end header arguments>
14691 End header arguments are applied to the calling instance and do not affect
14692 evaluation of the named code block.  They affect how the results are
14693 incorporated into the Org mode buffer and how the call line is exported.  For
14694 example, @code{:results html} will insert the results of the call line
14695 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
14697 For more examples of passing header arguments to @code{#+CALL:} lines see
14698 @ref{Header arguments in function calls}.
14699 @end table
14701 @node Library of Babel
14702 @section Library of Babel
14703 @cindex babel, library of
14704 @cindex source code, library
14705 @cindex code block, library
14707 The ``Library of Babel'' consists of code blocks that can be called from any
14708 Org mode file.  Code blocks defined in the ``Library of Babel'' can be called
14709 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
14710 code blocks} for information on the syntax of remote code block evaluation).
14713 The central repository of code blocks in the ``Library of Babel'' is housed
14714 in an Org mode file located in the @samp{contrib} directory of Org mode.
14716 Users can add code blocks they believe to be generally useful to their
14717 ``Library of Babel.''  The code blocks can be stored in any Org mode file and
14718 then loaded into the library with @code{org-babel-lob-ingest}.
14721 @kindex C-c C-v i
14722 Code blocks located in any Org mode file can be loaded into the ``Library of
14723 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
14726 @node Languages
14727 @section Languages
14728 @cindex babel, languages
14729 @cindex source code, languages
14730 @cindex code block, languages
14732 Code blocks in the following languages are supported.
14734 @multitable @columnfractions 0.28 0.3 0.22 0.2
14735 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
14736 @item Asymptote @tab asymptote @tab Awk @tab awk
14737 @item Emacs Calc @tab calc @tab C @tab C
14738 @item C++ @tab C++ @tab Clojure @tab clojure
14739 @item CSS @tab css @tab D @tab d
14740 @item ditaa @tab ditaa @tab Graphviz @tab dot
14741 @item Emacs Lisp @tab emacs-lisp @tab gnuplot @tab gnuplot
14742 @item Haskell @tab haskell @tab Java @tab java
14743 @item Javascript @tab js @tab LaTeX @tab latex
14744 @item Ledger @tab ledger @tab Lisp @tab lisp
14745 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
14746 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
14747 @item Octave @tab octave @tab Org mode @tab org
14748 @item Oz @tab oz @tab Perl @tab perl
14749 @item Plantuml @tab plantuml @tab Python @tab python
14750 @item R @tab R @tab Ruby @tab ruby
14751 @item Sass @tab sass @tab Scheme @tab scheme
14752 @item GNU Screen @tab screen @tab shell @tab sh
14753 @item SQL @tab sql @tab SQLite @tab sqlite
14754 @end multitable
14756 Language-specific documentation is available for some languages.  If
14757 available, it can be found at
14758 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
14760 The option @code{org-babel-load-languages} controls which languages are
14761 enabled for evaluation (by default only @code{emacs-lisp} is enabled).  This
14762 variable can be set using the customization interface or by adding code like
14763 the following to your emacs configuration.
14765 @quotation
14766 The following disables @code{emacs-lisp} evaluation and enables evaluation of
14767 @code{R} code blocks.
14768 @end quotation
14770 @lisp
14771 (org-babel-do-load-languages
14772  'org-babel-load-languages
14773  '((emacs-lisp . nil)
14774    (R . t)))
14775 @end lisp
14777 It is also possible to enable support for a language by loading the related
14778 elisp file with @code{require}.
14780 @quotation
14781 The following adds support for evaluating @code{clojure} code blocks.
14782 @end quotation
14784 @lisp
14785 (require 'ob-clojure)
14786 @end lisp
14788 @node Header arguments
14789 @section Header arguments
14790 @cindex code block, header arguments
14791 @cindex source code, block header arguments
14793 Code block functionality can be configured with header arguments.  This
14794 section provides an overview of the use of header arguments, and then
14795 describes each header argument in detail.
14797 @menu
14798 * Using header arguments::      Different ways to set header arguments
14799 * Specific header arguments::   List of header arguments
14800 @end menu
14802 @node Using header arguments
14803 @subsection Using header arguments
14805 The values of header arguments can be set in several way.  When the header
14806 arguments in each layer have been determined, they are combined in order from
14807 the first, least specific (having the lowest priority) up to the last, most
14808 specific (having the highest priority).  A header argument with a higher
14809 priority replaces the same header argument specified at lower priority.
14810 @menu
14811 * System-wide header arguments::  Set global default values
14812 * Language-specific header arguments::  Set default values by language
14813 * Header arguments in Org mode properties::  Set default values for a buffer or heading
14814 * Language-specific header arguments in Org mode properties::  Set language-specific default values for a buffer or heading
14815 * Code block specific header arguments::  The most common way to set values
14816 * Header arguments in function calls::  The most specific level
14817 @end menu
14820 @node System-wide header arguments
14821 @subsubheading System-wide header arguments
14822 @vindex org-babel-default-header-args
14823 System-wide values of header arguments can be specified by adapting the
14824 @code{org-babel-default-header-args} variable:
14826 @cindex @code{:session}, src header argument
14827 @cindex @code{:results}, src header argument
14828 @cindex @code{:exports}, src header argument
14829 @cindex @code{:cache}, src header argument
14830 @cindex @code{:noweb}, src header argument
14831 @example
14832 :session    => "none"
14833 :results    => "replace"
14834 :exports    => "code"
14835 :cache      => "no"
14836 :noweb      => "no"
14837 @end example
14839 For example, the following example could be used to set the default value of
14840 @code{:noweb} header arguments to @code{yes}.  This would have the effect of
14841 expanding @code{:noweb} references by default when evaluating source code
14842 blocks.
14844 @lisp
14845 (setq org-babel-default-header-args
14846       (cons '(:noweb . "yes")
14847             (assq-delete-all :noweb org-babel-default-header-args)))
14848 @end lisp
14850 @node Language-specific header arguments
14851 @subsubheading Language-specific header arguments
14852 Each language can define its own set of default header arguments in variable
14853 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
14854 of the language.  See the language-specific documentation available online at
14855 @uref{http://orgmode.org/worg/org-contrib/babel}.
14857 @node Header arguments in Org mode properties
14858 @subsubheading Header arguments in Org mode properties
14860 Buffer-wide header arguments may be specified as properties through the use
14861 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
14862 @ref{Property syntax}).
14864 For example the following would set @code{session} to @code{*R*} (only for R
14865 code blocks), and @code{results} to @code{silent} for every code block in the
14866 buffer, ensuring that all execution took place in the same session, and no
14867 results would be inserted into the buffer.
14869 @example
14870 #+PROPERTY: header-args:R  :session *R*
14871 #+PROPERTY: header-args    :results silent
14872 @end example
14874 Header arguments read from Org mode properties can also be set on a
14875 per-subtree basis using property drawers (see @ref{Property syntax}).
14876 @vindex org-use-property-inheritance
14877 When properties are used to set default header arguments, they are always
14878 looked up with inheritance, regardless of the value of
14879 @code{org-use-property-inheritance}.  Properties are evaluated as seen by the
14880 outermost call or source block.@footnote{The deprecated syntax for default
14881 header argument properties, using the name of the header argument as a
14882 property name directly, evaluates the property as seen by the corresponding
14883 source block definition.  This behavior has been kept for backwards
14884 compatibility.}
14886 In the following example the value of
14887 the @code{:cache} header argument will default to @code{yes} in all code
14888 blocks in the subtree rooted at the following heading:
14890 @example
14891 * outline header
14892   :PROPERTIES:
14893   :header-args:    :cache yes
14894   :END:
14895 @end example
14897 @kindex C-c C-x p
14898 @vindex org-babel-default-header-args
14899 Properties defined in this way override the properties set in
14900 @code{org-babel-default-header-args} and are applied for all activated
14901 languages.  It is convenient to use the @code{org-set-property} function
14902 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
14904 @node Language-specific header arguments in Org mode properties
14905 @subsubheading Language-specific header arguments in Org mode properties
14907 Language-specific header arguments are also read from properties
14908 @code{header-args:<lang>} where @code{<lang>} is the name of the language
14909 targeted.  As an example
14911 @example
14912 * Heading
14913   :PROPERTIES:
14914   :header-args:clojure:    :session *clojure-1*
14915   :header-args:R:          :session *R*
14916   :END:
14917 ** Subheading
14918   :PROPERTIES:
14919   :header-args:clojure:    :session *clojure-2*
14920   :END:
14921 @end example
14923 would independently set a default session header argument for R and clojure
14924 for calls and source blocks under subtree ``Heading'' and change to a
14925 different clojure setting for evaluations under subtree ``Subheading'', while
14926 the R session is inherited from ``Heading'' and therefore unchanged.
14928 @node Code block specific header arguments
14929 @subsubheading Code block specific header arguments
14931 The most common way to assign values to header arguments is at the
14932 code block level.  This can be done by listing a sequence of header
14933 arguments and their values as part of the @code{#+BEGIN_SRC} line.
14934 Properties set in this way override both the values of
14935 @code{org-babel-default-header-args} and header arguments specified as
14936 properties.  In the following example, the @code{:results} header argument
14937 is set to @code{silent}, meaning the results of execution will not be
14938 inserted in the buffer, and the @code{:exports} header argument is set to
14939 @code{code}, meaning only the body of the code block will be
14940 preserved on export to HTML or @LaTeX{}.
14942 @example
14943 #+NAME: factorial
14944 #+BEGIN_SRC haskell :results silent :exports code :var n=0
14945 fac 0 = 1
14946 fac n = n * fac (n-1)
14947 #+END_SRC
14948 @end example
14949 Similarly, it is possible to set header arguments for inline code blocks
14951 @example
14952 src_haskell[:exports both]@{fac 5@}
14953 @end example
14955 Code block header arguments can span multiple lines using @code{#+HEADER:} or
14956 @code{#+HEADERS:} lines preceding a code block or nested between the
14957 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
14958 @cindex #+HEADER:
14959 @cindex #+HEADERS:
14961 Multi-line header arguments on an un-named code block:
14963 @example
14964  #+HEADERS: :var data1=1
14965  #+BEGIN_SRC emacs-lisp :var data2=2
14966    (message "data1:%S, data2:%S" data1 data2)
14967  #+END_SRC
14969  #+RESULTS:
14970  : data1:1, data2:2
14971 @end example
14973 Multi-line header arguments on a named code block:
14975 @example
14976    #+NAME: named-block
14977    #+HEADER: :var data=2
14978    #+BEGIN_SRC emacs-lisp
14979      (message "data:%S" data)
14980    #+END_SRC
14982    #+RESULTS: named-block
14983    : data:2
14984 @end example
14986 @node Header arguments in function calls
14987 @subsubheading Header arguments in function calls
14989 At the most specific level, header arguments for ``Library of Babel'' or
14990 @code{#+CALL:} lines can be set as shown in the two examples below.  For more
14991 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
14992 blocks}.
14994 The following will apply the @code{:exports results} header argument to the
14995 evaluation of the @code{#+CALL:} line.
14997 @example
14998 #+CALL: factorial(n=5) :exports results
14999 @end example
15001 The following will apply the @code{:session special} header argument to the
15002 evaluation of the @code{factorial} code block.
15004 @example
15005 #+CALL: factorial[:session special](n=5)
15006 @end example
15008 @node Specific header arguments
15009 @subsection Specific header arguments
15010 Header arguments consist of an initial colon followed by the name of the
15011 argument in lowercase letters.  The following header arguments are defined:
15013 @menu
15014 * var::                         Pass arguments to code blocks
15015 * Results::                     Specify the type of results and how they will
15016                                 be collected and handled
15017 * file::                        Specify a path for file output
15018 * file-desc::                   Specify a description for file results
15019 * file-ext::                    Specify an extension for file output
15020 * output-dir::                  Specify a directory to write file output to
15021 * dir::                         Specify the default (possibly remote)
15022                                 directory for code block execution
15023 * exports::                     Export code and/or results
15024 * tangle::                      Toggle tangling and specify file name
15025 * mkdirp::                      Toggle creation of parent directories of target
15026                                 files during tangling
15027 * comments::                    Toggle insertion of comments in tangled
15028                                 code files
15029 * padline::                     Control insertion of padding lines in tangled
15030                                 code files
15031 * no-expand::                   Turn off variable assignment and noweb
15032                                 expansion during tangling
15033 * session::                     Preserve the state of code evaluation
15034 * noweb::                       Toggle expansion of noweb references
15035 * noweb-ref::                   Specify block's noweb reference resolution target
15036 * noweb-sep::                   String used to separate noweb references
15037 * cache::                       Avoid re-evaluating unchanged code blocks
15038 * sep::                         Delimiter for writing tabular results outside Org
15039 * hlines::                      Handle horizontal lines in tables
15040 * colnames::                    Handle column names in tables
15041 * rownames::                    Handle row names in tables
15042 * shebang::                     Make tangled files executable
15043 * tangle-mode::                 Set permission of tangled files
15044 * eval::                        Limit evaluation of specific code blocks
15045 * wrap::                        Mark source block evaluation results
15046 * post::                        Post processing of code block results
15047 * prologue::                    Text to prepend to code block body
15048 * epilogue::                    Text to append to code block body
15049 @end menu
15051 Additional header arguments are defined on a language-specific basis, see
15052 @ref{Languages}.
15054 @node var
15055 @subsubsection @code{:var}
15056 @cindex @code{:var}, src header argument
15057 The @code{:var} header argument is used to pass arguments to code blocks.
15058 The specifics of how arguments are included in a code block vary by language;
15059 these are addressed in the language-specific documentation.  However, the
15060 syntax used to specify arguments is the same across all languages.  In every
15061 case, variables require a default value when they are declared.
15063 The values passed to arguments can either be literal values, references, or
15064 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
15065 References include anything in the Org mode file that takes a @code{#+NAME:}
15066 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
15067 other code blocks and the results of other code blocks.
15069 Note: When a reference is made to another code block, the referenced block
15070 will be evaluated unless it has current cached results (see @ref{cache}).
15072 Argument values can be indexed in a manner similar to arrays (see @ref{var,
15073 Indexable variable values}).
15075 The following syntax is used to pass arguments to code blocks using the
15076 @code{:var} header argument.
15078 @example
15079 :var name=assign
15080 @end example
15082 The argument, @code{assign}, can either be a literal value, such as a string
15083 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
15084 literal example, another code block (with or without arguments), or the
15085 results of evaluating another code block.
15087 Here are examples of passing values by reference:
15089 @table @dfn
15091 @item table
15092 an Org mode table named with either a @code{#+NAME:} line
15094 @example
15095 #+NAME: example-table
15096 | 1 |
15097 | 2 |
15098 | 3 |
15099 | 4 |
15101 #+NAME: table-length
15102 #+BEGIN_SRC emacs-lisp :var table=example-table
15103 (length table)
15104 #+END_SRC
15106 #+RESULTS: table-length
15107 : 4
15108 @end example
15110 @item list
15111 a simple list named with a @code{#+NAME:} line (note that nesting is not
15112 carried through to the source code block)
15114 @example
15115 #+NAME: example-list
15116   - simple
15117     - not
15118     - nested
15119   - list
15121 #+BEGIN_SRC emacs-lisp :var x=example-list
15122   (print x)
15123 #+END_SRC
15125 #+RESULTS:
15126 | simple | list |
15127 @end example
15129 @item code block without arguments
15130 a code block name (from the example above), as assigned by @code{#+NAME:},
15131 optionally followed by parentheses
15133 @example
15134 #+BEGIN_SRC emacs-lisp :var length=table-length()
15135 (* 2 length)
15136 #+END_SRC
15138 #+RESULTS:
15139 : 8
15140 @end example
15142 @item code block with arguments
15143 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
15144 optional arguments passed within the parentheses following the
15145 code block name using standard function call syntax
15147 @example
15148 #+NAME: double
15149 #+BEGIN_SRC emacs-lisp :var input=8
15150 (* 2 input)
15151 #+END_SRC
15153 #+RESULTS: double
15154 : 16
15156 #+NAME: squared
15157 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
15158 (* input input)
15159 #+END_SRC
15161 #+RESULTS: squared
15162 : 4
15163 @end example
15165 @item literal example
15166 a literal example block named with a @code{#+NAME:} line
15168 @example
15169 #+NAME: literal-example
15170 #+BEGIN_EXAMPLE
15171 A literal example
15172 on two lines
15173 #+END_EXAMPLE
15175 #+NAME: read-literal-example
15176 #+BEGIN_SRC emacs-lisp :var x=literal-example
15177   (concatenate 'string x " for you.")
15178 #+END_SRC
15180 #+RESULTS: read-literal-example
15181 : A literal example
15182 : on two lines for you.
15184 @end example
15186 @end table
15188 @subsubheading Indexable variable values
15189 It is possible to reference portions of variable values by ``indexing'' into
15190 the variables.  Indexes are 0 based with negative values counting back from
15191 the end.  If an index is separated by @code{,}s then each subsequent section
15192 will index into the next deepest nesting or dimension of the value.  Note
15193 that this indexing occurs @emph{before} other table related header arguments
15194 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied.  The
15195 following example assigns the last cell of the first row the table
15196 @code{example-table} to the variable @code{data}:
15198 @example
15199 #+NAME: example-table
15200 | 1 | a |
15201 | 2 | b |
15202 | 3 | c |
15203 | 4 | d |
15205 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
15206   data
15207 #+END_SRC
15209 #+RESULTS:
15210 : a
15211 @end example
15213 Ranges of variable values can be referenced using two integers separated by a
15214 @code{:}, in which case the entire inclusive range is referenced.  For
15215 example the following assigns the middle three rows of @code{example-table}
15216 to @code{data}.
15218 @example
15219 #+NAME: example-table
15220 | 1 | a |
15221 | 2 | b |
15222 | 3 | c |
15223 | 4 | d |
15224 | 5 | 3 |
15226 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
15227   data
15228 #+END_SRC
15230 #+RESULTS:
15231 | 2 | b |
15232 | 3 | c |
15233 | 4 | d |
15234 @end example
15236 Additionally, an empty index, or the single character @code{*}, are both
15237 interpreted to mean the entire range and as such are equivalent to
15238 @code{0:-1}, as shown in the following example in which the entire first
15239 column is referenced.
15241 @example
15242 #+NAME: example-table
15243 | 1 | a |
15244 | 2 | b |
15245 | 3 | c |
15246 | 4 | d |
15248 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
15249   data
15250 #+END_SRC
15252 #+RESULTS:
15253 | 1 | 2 | 3 | 4 |
15254 @end example
15256 It is possible to index into the results of code blocks as well as tables.
15257 Any number of dimensions can be indexed.  Dimensions are separated from one
15258 another by commas, as shown in the following example.
15260 @example
15261 #+NAME: 3D
15262 #+BEGIN_SRC emacs-lisp
15263   '(((1  2  3)  (4  5  6)  (7  8  9))
15264     ((10 11 12) (13 14 15) (16 17 18))
15265     ((19 20 21) (22 23 24) (25 26 27)))
15266 #+END_SRC
15268 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
15269   data
15270 #+END_SRC
15272 #+RESULTS:
15273 | 11 | 14 | 17 |
15274 @end example
15276 @subsubheading Emacs Lisp evaluation of variables
15278 Emacs lisp code can be used to initialize variable values.  When a variable
15279 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
15280 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
15281 the variable value.  The following example demonstrates use of this
15282 evaluation to reliably pass the file-name of the Org mode buffer to a code
15283 block---note that evaluation of header arguments is guaranteed to take place
15284 in the original Org mode file, while there is no such guarantee for
15285 evaluation of the code block body.
15287 @example
15288 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
15289   wc -w $filename
15290 #+END_SRC
15291 @end example
15293 Note that values read from tables and lists will not be evaluated as
15294 Emacs Lisp, as shown in the following example.
15296 @example
15297 #+NAME: table
15298 | (a b c) |
15300 #+HEADERS: :var data=table[0,0]
15301 #+BEGIN_SRC perl
15302   $data
15303 #+END_SRC
15305 #+RESULTS:
15306 : (a b c)
15307 @end example
15309 @node Results
15310 @subsubsection @code{:results}
15311 @cindex @code{:results}, src header argument
15313 There are four classes of @code{:results} header argument.  Only one option
15314 per class may be supplied per code block.
15316 @itemize @bullet
15317 @item
15318 @b{collection} header arguments specify how the results should be collected
15319 from the code block
15320 @item
15321 @b{type} header arguments specify what type of result the code block will
15322 return---which has implications for how they will be processed before
15323 insertion into the Org mode buffer
15324 @item
15325 @b{format} header arguments specify what type of result the code block will
15326 return---which has implications for how they will be inserted into the
15327 Org mode buffer
15328 @item
15329 @b{handling} header arguments specify how the results of evaluating the code
15330 block should be handled.
15331 @end itemize
15333 @subsubheading Collection
15334 The following options are mutually exclusive, and specify how the results
15335 should be collected from the code block.
15337 @itemize @bullet
15338 @item @code{value}
15339 This is the default.  The result is the value of the last statement in the
15340 code block.  This header argument places the evaluation in functional
15341 mode.  Note that in some languages, e.g., Python, use of this result type
15342 requires that a @code{return} statement be included in the body of the source
15343 code block.  E.g., @code{:results value}.
15344 @item @code{output}
15345 The result is the collection of everything printed to STDOUT during the
15346 execution of the code block.  This header argument places the
15347 evaluation in scripting mode.  E.g., @code{:results output}.
15348 @end itemize
15350 @subsubheading Type
15352 The following options are mutually exclusive and specify what type of results
15353 the code block will return.  By default, results are inserted as either a
15354 table or scalar depending on their value.
15356 @itemize @bullet
15357 @item @code{table}, @code{vector}
15358 The results should be interpreted as an Org mode table.  If a single value is
15359 returned, it will be converted into a table with one row and one column.
15360 E.g., @code{:results value table}.
15361 @item @code{list}
15362 The results should be interpreted as an Org mode list.  If a single scalar
15363 value is returned it will be converted into a list with only one element.
15364 @item @code{scalar}, @code{verbatim}
15365 The results should be interpreted literally---they will not be
15366 converted into a table.  The results will be inserted into the Org mode
15367 buffer as quoted text.  E.g., @code{:results value verbatim}.
15368 @item @code{file}
15369 The results will be interpreted as the path to a file, and will be inserted
15370 into the Org mode buffer as a file link.  E.g., @code{:results value file}.
15371 @end itemize
15373 @subsubheading Format
15375 The following options are mutually exclusive and specify what type of results
15376 the code block will return.  By default, results are inserted according to the
15377 type as specified above.
15379 @itemize @bullet
15380 @item @code{raw}
15381 The results are interpreted as raw Org mode code and are inserted directly
15382 into the buffer.  If the results look like a table they will be aligned as
15383 such by Org mode.  E.g., @code{:results value raw}.
15384 @item @code{org}
15385 The results are will be enclosed in a @code{BEGIN_SRC org} block.
15386 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
15387 in the block and/or if you export the file.  E.g., @code{:results value org}.
15388 @item @code{html}
15389 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
15390 block.  E.g., @code{:results value html}.
15391 @item @code{latex}
15392 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
15393 E.g., @code{:results value latex}.
15394 @item @code{code}
15395 Result are assumed to be parsable code and are enclosed in a code block.
15396 E.g., @code{:results value code}.
15397 @item @code{pp}
15398 The result is converted to pretty-printed code and is enclosed in a code
15399 block.  This option currently supports Emacs Lisp, Python, and Ruby.  E.g.,
15400 @code{:results value pp}.
15401 @item @code{drawer}
15402 The result is wrapped in a RESULTS drawer.  This can be useful for
15403 inserting @code{raw} or @code{org} syntax results in such a way that their
15404 extent is known and they can be automatically removed or replaced.
15405 @end itemize
15407 @subsubheading Handling
15408 The following results options indicate what happens with the
15409 results once they are collected.
15411 @itemize @bullet
15412 @item @code{silent}
15413 The results will be echoed in the minibuffer but will not be inserted into
15414 the Org mode buffer.  E.g., @code{:results output silent}.
15415 @item @code{replace}
15416 The default value.  Any existing results will be removed, and the new results
15417 will be inserted into the Org mode buffer in their place.  E.g.,
15418 @code{:results output replace}.
15419 @item @code{append}
15420 If there are pre-existing results of the code block then the new results will
15421 be appended to the existing results.  Otherwise the new results will be
15422 inserted as with @code{replace}.
15423 @item @code{prepend}
15424 If there are pre-existing results of the code block then the new results will
15425 be prepended to the existing results.  Otherwise the new results will be
15426 inserted as with @code{replace}.
15427 @end itemize
15429 @node file
15430 @subsubsection @code{:file}
15431 @cindex @code{:file}, src header argument
15433 The header argument @code{:file} is used to specify an external file in which
15434 to save code block results.  After code block evaluation an Org mode style
15435 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
15436 into the Org mode buffer.  Some languages including R, gnuplot, dot, and
15437 ditaa provide special handling of the @code{:file} header argument
15438 automatically wrapping the code block body in the boilerplate code required
15439 to save output to the specified file.  This is often useful for saving
15440 graphical output of a code block to the specified file.
15442 The argument to @code{:file} should be either a string specifying the path to
15443 a file, or a list of two strings in which case the first element of the list
15444 should be the path to a file and the second a description for the link.
15446 @node file-desc
15447 @subsubsection @code{:file-desc}
15449 The value of the @code{:file-desc} header argument is used to provide a
15450 description for file code block results which are inserted as Org mode links
15451 (see @ref{Link format}).  If the @code{:file-desc} header argument is given
15452 with no value the link path will be placed in both the ``link'' and the
15453 ``description'' portion of the Org mode link.
15455 @node file-ext
15456 @subsubsection @code{:file-ext}
15457 @cindex @code{:file-ext}, src header argument
15459 The value of the @code{:file-ext} header argument is used to provide an
15460 extension to write the file output to.  It is combined with the
15461 @code{#+NAME:} of the source block and the value of the @ref{output-dir}
15462 header argument to generate a complete file name.
15464 This header arg will be overridden by @code{:file}, and thus has no effect
15465 when the latter is specified.
15467 @node output-dir
15468 @subsubsection @code{:output-dir}
15469 @cindex @code{:output-dir}, src header argument
15471 The value of the @code{:output-dir} header argument is used to provide a
15472 directory to write the file output to.  It may specify an absolute directory
15473 (beginning with @code{/}) or a relative directory (without @code{/}).  It can
15474 be combined with the @code{#+NAME:} of the source block and the value of the
15475 @ref{file-ext} header argument to generate a complete file name, or used
15476 along with a @ref{file} header arg.
15478 @node dir
15479 @subsubsection @code{:dir} and remote execution
15480 @cindex @code{:dir}, src header argument
15482 While the @code{:file} header argument can be used to specify the path to the
15483 output file, @code{:dir} specifies the default directory during code block
15484 execution.  If it is absent, then the directory associated with the current
15485 buffer is used.  In other words, supplying @code{:dir path} temporarily has
15486 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
15487 then not supplying @code{:dir}.  Under the surface, @code{:dir} simply sets
15488 the value of the Emacs variable @code{default-directory}.
15490 When using @code{:dir}, you should supply a relative path for file output
15491 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
15492 case that path will be interpreted relative to the default directory.
15494 In other words, if you want your plot to go into a folder called @file{Work}
15495 in your home directory, you could use
15497 @example
15498 #+BEGIN_SRC R :file myplot.png :dir ~/Work
15499 matplot(matrix(rnorm(100), 10), type="l")
15500 #+END_SRC
15501 @end example
15503 @subsubheading Remote execution
15504 A directory on a remote machine can be specified using tramp file syntax, in
15505 which case the code will be evaluated on the remote machine.  An example is
15507 @example
15508 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
15509 plot(1:10, main=system("hostname", intern=TRUE))
15510 #+END_SRC
15511 @end example
15513 Text results will be returned to the local Org mode buffer as usual, and file
15514 output will be created on the remote machine with relative paths interpreted
15515 relative to the remote directory.  An Org mode link to the remote file will be
15516 created.
15518 So, in the above example a plot will be created on the remote machine,
15519 and a link of the following form will be inserted in the org buffer:
15521 @example
15522 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
15523 @end example
15525 Most of this functionality follows immediately from the fact that @code{:dir}
15526 sets the value of the Emacs variable @code{default-directory}, thanks to
15527 tramp.  Those using XEmacs, or GNU Emacs prior to version 23 may need to
15528 install tramp separately in order for these features to work correctly.
15530 @subsubheading Further points
15532 @itemize @bullet
15533 @item
15534 If @code{:dir} is used in conjunction with @code{:session}, although it will
15535 determine the starting directory for a new session as expected, no attempt is
15536 currently made to alter the directory associated with an existing session.
15537 @item
15538 @code{:dir} should typically not be used to create files during export with
15539 @code{:exports results} or @code{:exports both}.  The reason is that, in order
15540 to retain portability of exported material between machines, during export
15541 links inserted into the buffer will @emph{not} be expanded against @code{default
15542 directory}.  Therefore, if @code{default-directory} is altered using
15543 @code{:dir}, it is probable that the file will be created in a location to
15544 which the link does not point.
15545 @end itemize
15547 @node exports
15548 @subsubsection @code{:exports}
15549 @cindex @code{:exports}, src header argument
15551 The @code{:exports} header argument specifies what should be included in HTML
15552 or @LaTeX{} exports of the Org mode file.  Note that the @code{:exports}
15553 option is only relevant for code blocks, not inline code.
15555 @itemize @bullet
15556 @item @code{code}
15557 The default.  The body of code is included into the exported file.  E.g.,
15558 @code{:exports code}.
15559 @item @code{results}
15560 The result of evaluating the code is included in the exported file.  E.g.,
15561 @code{:exports results}.
15562 @item @code{both}
15563 Both the code and results are included in the exported file.  E.g.,
15564 @code{:exports both}.
15565 @item @code{none}
15566 Nothing is included in the exported file.  E.g., @code{:exports none}.
15567 @end itemize
15569 @node tangle
15570 @subsubsection @code{:tangle}
15571 @cindex @code{:tangle}, src header argument
15573 The @code{:tangle} header argument specifies whether or not the code
15574 block should be included in tangled extraction of source code files.
15576 @itemize @bullet
15577 @item @code{tangle}
15578 The code block is exported to a source code file named after the full path
15579 (including the directory) and file name (w/o extension) of the Org mode file.
15580 E.g., @code{:tangle yes}.
15581 @item @code{no}
15582 The default.  The code block is not exported to a source code file.
15583 E.g., @code{:tangle no}.
15584 @item other
15585 Any other string passed to the @code{:tangle} header argument is interpreted
15586 as a path (directory and file name relative to the directory of the Org mode
15587 file) to which the block will be exported.  E.g., @code{:tangle path}.
15588 @end itemize
15590 @node mkdirp
15591 @subsubsection @code{:mkdirp}
15592 @cindex @code{:mkdirp}, src header argument
15594 The @code{:mkdirp} header argument can be used to create parent directories
15595 of tangled files when missing.  This can be set to @code{yes} to enable
15596 directory creation or to @code{no} to inhibit directory creation.
15598 @node comments
15599 @subsubsection @code{:comments}
15600 @cindex @code{:comments}, src header argument
15601 By default code blocks are tangled to source-code files without any insertion
15602 of comments beyond those which may already exist in the body of the code
15603 block.  The @code{:comments} header argument can be set as follows to control
15604 the insertion of extra comments into the tangled code file.
15606 @itemize @bullet
15607 @item @code{no}
15608 The default.  No extra comments are inserted during tangling.
15609 @item @code{link}
15610 The code block is wrapped in comments which contain pointers back to the
15611 original Org file from which the code was tangled.
15612 @item @code{yes}
15613 A synonym for ``link'' to maintain backwards compatibility.
15614 @item @code{org}
15615 Include text from the Org mode file as a comment.
15616 The text is picked from the leading context of the tangled code and is
15617 limited by the nearest headline or source block as the case may be.
15618 @item @code{both}
15619 Turns on both the ``link'' and ``org'' comment options.
15620 @item @code{noweb}
15621 Turns on the ``link'' comment option, and additionally wraps expanded noweb
15622 references in the code block body in link comments.
15623 @end itemize
15625 @node padline
15626 @subsubsection @code{:padline}
15627 @cindex @code{:padline}, src header argument
15628 Control in insertion of padding lines around code block bodies in tangled
15629 code files.  The default value is @code{yes} which results in insertion of
15630 newlines before and after each tangled code block.  The following arguments
15631 are accepted.
15633 @itemize @bullet
15634 @item @code{yes}
15635 Insert newlines before and after each code block body in tangled code files.
15636 @item @code{no}
15637 Do not insert any newline padding in tangled output.
15638 @end itemize
15640 @node no-expand
15641 @subsubsection @code{:no-expand}
15642 @cindex @code{:no-expand}, src header argument
15644 By default, code blocks are expanded with @code{org-babel-expand-src-block}
15645 during tangling.  This has the effect of assigning values to variables
15646 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
15647 references (see @ref{Noweb reference syntax}) with their targets.  The
15648 @code{:no-expand} header argument can be used to turn off this behavior.
15649 Note: The @code{:no-expand} header argument has no impact on export,
15650 i.e. code blocks will irrespective of this header argument expanded for
15651 execution.
15653 @node session
15654 @subsubsection @code{:session}
15655 @cindex @code{:session}, src header argument
15657 The @code{:session} header argument starts a (possibly named) session for an
15658 interpreted language where the interpreter’s state is preserved.  All code
15659 blocks sharing the same name are exectuted by the same interpreter process.
15660 By default, a session is not started.
15662 @itemize @bullet
15663 @item @code{none}
15664 The default.  Each block is evaluated in its own interpreter process, which
15665 is terminated after the evaluation.
15666 @item @code{other}
15667 Any other string passed to the @code{:session} header argument will give the
15668 session a name.  For example, @code{:session mysession}.  If @code{:session}
15669 is given but no name string is specified, the session is named according to
15670 the language used in the block.  All blocks with the same session name share
15671 the same session.  Using different session names enables concurrent sessions
15672 (even for the same interpreted language).
15674 @end itemize
15676 @node noweb
15677 @subsubsection @code{:noweb}
15678 @cindex @code{:noweb}, src header argument
15680 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
15681 references (see @ref{Noweb reference syntax}) when the code block is
15682 evaluated, tangled, or exported.  The @code{:noweb} header argument can have
15683 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
15684 @code{no-export} @code{strip-export}.
15686 @itemize @bullet
15687 @item @code{no}
15688 The default.  ``Noweb'' syntax references in the body of the code block will
15689 not be expanded before the code block is evaluated, tangled or exported.
15690 @item @code{yes}
15691 ``Noweb'' syntax references in the body of the code block will be
15692 expanded before the code block is evaluated, tangled or exported.
15693 @item @code{tangle}
15694 ``Noweb'' syntax references in the body of the code block will be expanded
15695 before the code block is tangled.  However, ``noweb'' syntax references will
15696 not be expanded when the code block is evaluated or exported.
15697 @item @code{no-export}
15698 ``Noweb'' syntax references in the body of the code block will be expanded
15699 before the block is evaluated or tangled.  However, ``noweb'' syntax
15700 references will not be expanded when the code block is exported.
15701 @item @code{strip-export}
15702 ``Noweb'' syntax references in the body of the code block will be expanded
15703 before the block is evaluated or tangled.  However, ``noweb'' syntax
15704 references will be removed when the code block is exported.
15705 @item @code{eval}
15706 ``Noweb'' syntax references in the body of the code block will only be
15707 expanded before the block is evaluated.
15708 @end itemize
15710 @subsubheading Noweb prefix lines
15711 Noweb insertions are now placed behind the line prefix of the
15712 @code{<<reference>>}.
15713 This behavior is illustrated in the following example.  Because the
15714 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
15715 each line of the expanded noweb reference will be commented.
15717 This code block:
15719 @example
15720 -- <<example>>
15721 @end example
15723 expands to:
15725 @example
15726 -- this is the
15727 -- multi-line body of example
15728 @end example
15730 Note that noweb replacement text that does not contain any newlines will not
15731 be affected by this change, so it is still possible to use inline noweb
15732 references.
15734 @node noweb-ref
15735 @subsubsection @code{:noweb-ref}
15736 @cindex @code{:noweb-ref}, src header argument
15737 When expanding ``noweb'' style references, the bodies of all code block with
15738 @emph{either} a block name matching the reference name @emph{or} a
15739 @code{:noweb-ref} header argument matching the reference name will be
15740 concatenated together to form the replacement text.
15742 By setting this header argument at the subtree or file level, simple code
15743 block concatenation may be achieved.  For example, when tangling the
15744 following Org mode file, the bodies of code blocks will be concatenated into
15745 the resulting pure code file@footnote{(The example needs property inheritance
15746 to be turned on for the @code{noweb-ref} property, see @ref{Property
15747 inheritance}).}.
15749 @example
15750  #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
15751    <<fullest-disk>>
15752  #+END_SRC
15753  * the mount point of the fullest disk
15754    :PROPERTIES:
15755    :noweb-ref: fullest-disk
15756    :END:
15758  ** query all mounted disks
15759  #+BEGIN_SRC sh
15760    df \
15761  #+END_SRC
15763  ** strip the header row
15764  #+BEGIN_SRC sh
15765    |sed '1d' \
15766  #+END_SRC
15768  ** sort by the percent full
15769  #+BEGIN_SRC sh
15770    |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
15771  #+END_SRC
15773  ** extract the mount point
15774  #+BEGIN_SRC sh
15775    |awk '@{print $2@}'
15776  #+END_SRC
15777 @end example
15779 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
15780 used to separate accumulate noweb references like those above.  By default a
15781 newline is used.
15783 @node noweb-sep
15784 @subsubsection @code{:noweb-sep}
15785 @cindex @code{:noweb-sep}, src header argument
15787 The @code{:noweb-sep} header argument holds the string used to separate
15788 accumulate noweb references (see @ref{noweb-ref}).  By default a newline is
15789 used.
15791 @node cache
15792 @subsubsection @code{:cache}
15793 @cindex @code{:cache}, src header argument
15795 The @code{:cache} header argument controls the use of in-buffer caching of
15796 the results of evaluating code blocks.  It can be used to avoid re-evaluating
15797 unchanged code blocks.  Note that the @code{:cache} header argument will not
15798 attempt to cache results when the @code{:session} header argument is used,
15799 because the results of the code block execution may be stored in the session
15800 outside of the Org mode buffer.  The @code{:cache} header argument can have
15801 one of two values: @code{yes} or @code{no}.
15803 @itemize @bullet
15804 @item @code{no}
15805 The default.  No caching takes place, and the code block will be evaluated
15806 every time it is called.
15807 @item @code{yes}
15808 Every time the code block is run a SHA1 hash of the code and arguments
15809 passed to the block will be generated.  This hash is packed into the
15810 @code{#+RESULTS:} line and will be checked on subsequent
15811 executions of the code block.  If the code block has not
15812 changed since the last time it was evaluated, it will not be re-evaluated.
15813 @end itemize
15815 Code block caches notice if the value of a variable argument
15816 to the code block has changed.  If this is the case, the cache is
15817 invalidated and the code block is re-run.  In the following example,
15818 @code{caller} will not be re-run unless the results of @code{random} have
15819 changed since it was last run.
15821 @example
15822  #+NAME: random
15823  #+BEGIN_SRC R :cache yes
15824  runif(1)
15825  #+END_SRC
15827  #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
15828  0.4659510825295
15830  #+NAME: caller
15831  #+BEGIN_SRC emacs-lisp :var x=random :cache yes
15833  #+END_SRC
15835  #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
15836  0.254227238707244
15837 @end example
15839 @node sep
15840 @subsubsection @code{:sep}
15841 @cindex @code{:sep}, src header argument
15843 The @code{:sep} header argument can be used to control the delimiter used
15844 when writing tabular results out to files external to Org mode.  This is used
15845 either when opening tabular results of a code block by calling the
15846 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
15847 or when writing code block results to an external file (see @ref{file})
15848 header argument.
15850 By default, when @code{:sep} is not specified output tables are tab
15851 delimited.
15853 @node hlines
15854 @subsubsection @code{:hlines}
15855 @cindex @code{:hlines}, src header argument
15857 Tables are frequently represented with one or more horizontal lines, or
15858 hlines.  The @code{:hlines} argument to a code block accepts the
15859 values @code{yes} or @code{no}, with a default value of @code{no}.
15861 @itemize @bullet
15862 @item @code{no}
15863 Strips horizontal lines from the input table.  In most languages this is the
15864 desired effect because an @code{hline} symbol is interpreted as an unbound
15865 variable and raises an error.  Setting @code{:hlines no} or relying on the
15866 default value yields the following results.
15868 @example
15869 #+NAME: many-cols
15870 | a | b | c |
15871 |---+---+---|
15872 | d | e | f |
15873 |---+---+---|
15874 | g | h | i |
15876 #+NAME: echo-table
15877 #+BEGIN_SRC python :var tab=many-cols
15878   return tab
15879 #+END_SRC
15881 #+RESULTS: echo-table
15882 | a | b | c |
15883 | d | e | f |
15884 | g | h | i |
15885 @end example
15887 @item @code{yes}
15888 Leaves hlines in the table.  Setting @code{:hlines yes} has this effect.
15890 @example
15891 #+NAME: many-cols
15892 | a | b | c |
15893 |---+---+---|
15894 | d | e | f |
15895 |---+---+---|
15896 | g | h | i |
15898 #+NAME: echo-table
15899 #+BEGIN_SRC python :var tab=many-cols :hlines yes
15900   return tab
15901 #+END_SRC
15903 #+RESULTS: echo-table
15904 | a | b | c |
15905 |---+---+---|
15906 | d | e | f |
15907 |---+---+---|
15908 | g | h | i |
15909 @end example
15910 @end itemize
15912 @node colnames
15913 @subsubsection @code{:colnames}
15914 @cindex @code{:colnames}, src header argument
15916 The @code{:colnames} header argument accepts the values @code{yes},
15917 @code{no}, or @code{nil} for unassigned.  The default value is @code{nil}.
15918 Note that the behavior of the @code{:colnames} header argument may differ
15919 across languages.
15921 @itemize @bullet
15922 @item @code{nil}
15923 If an input table looks like it has column names
15924 (because its second row is an hline), then the column
15925 names will be removed from the table before
15926 processing, then reapplied to the results.
15928 @example
15929 #+NAME: less-cols
15930 | a |
15931 |---|
15932 | b |
15933 | c |
15935 #+NAME: echo-table-again
15936 #+BEGIN_SRC python :var tab=less-cols
15937   return [[val + '*' for val in row] for row in tab]
15938 #+END_SRC
15940 #+RESULTS: echo-table-again
15941 | a  |
15942 |----|
15943 | b* |
15944 | c* |
15945 @end example
15947 Please note that column names are not removed before the table is indexed
15948 using variable indexing @xref{var, Indexable variable values}.
15950 @item @code{no}
15951 No column name pre-processing takes place
15953 @item @code{yes}
15954 Column names are removed and reapplied as with @code{nil} even if the table
15955 does not ``look like'' it has column names (i.e., the second row is not an
15956 hline)
15957 @end itemize
15959 @node rownames
15960 @subsubsection @code{:rownames}
15961 @cindex @code{:rownames}, src header argument
15963 The @code{:rownames} header argument can take on the values @code{yes} or
15964 @code{no}, with a default value of @code{no}.  Note that Emacs Lisp code
15965 blocks ignore the @code{:rownames} header argument entirely given the ease
15966 with which tables with row names may be handled directly in Emacs Lisp.
15968 @itemize @bullet
15969 @item @code{no}
15970 No row name pre-processing will take place.
15972 @item @code{yes}
15973 The first column of the table is removed from the table before processing,
15974 and is then reapplied to the results.
15976 @example
15977 #+NAME: with-rownames
15978 | one | 1 | 2 | 3 | 4 |  5 |
15979 | two | 6 | 7 | 8 | 9 | 10 |
15981 #+NAME: echo-table-once-again
15982 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
15983   return [[val + 10 for val in row] for row in tab]
15984 #+END_SRC
15986 #+RESULTS: echo-table-once-again
15987 | one | 11 | 12 | 13 | 14 | 15 |
15988 | two | 16 | 17 | 18 | 19 | 20 |
15989 @end example
15991 Please note that row names are not removed before the table is indexed using
15992 variable indexing @xref{var, Indexable variable values}.
15994 @end itemize
15996 @node shebang
15997 @subsubsection @code{:shebang}
15998 @cindex @code{:shebang}, src header argument
16000 Setting the @code{:shebang} header argument to a string value
16001 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
16002 first line of any tangled file holding the code block, and the file
16003 permissions of the tangled file are set to make it executable.
16006 @node tangle-mode
16007 @subsubsection @code{:tangle-mode}
16008 @cindex @code{:tangle-mode}, src header argument
16010 The @code{tangle-mode} header argument controls the permission set on tangled
16011 files.  The value of this header argument will be passed to
16012 @code{set-file-modes}.  For example, to set a tangled file as read only use
16013 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
16014 use @code{:tangle-mode (identity #o755)}.  Blocks with @code{shebang}
16015 (@ref{shebang}) header arguments will automatically be made executable unless
16016 the @code{tangle-mode} header argument is also used.  The behavior is
16017 undefined if multiple code blocks with different values for the
16018 @code{tangle-mode} header argument are tangled to the same file.
16020 @node eval
16021 @subsubsection @code{:eval}
16022 @cindex @code{:eval}, src header argument
16023 The @code{:eval} header argument can be used to limit the evaluation of
16024 specific code blocks.  The @code{:eval} header argument can be useful for
16025 protecting against the evaluation of dangerous code blocks or to ensure that
16026 evaluation will require a query regardless of the value of the
16027 @code{org-confirm-babel-evaluate} variable.  The possible values of
16028 @code{:eval} and their effects are shown below.
16030 @table @code
16031 @item never or no
16032 The code block will not be evaluated under any circumstances.
16033 @item query
16034 Evaluation of the code block will require a query.
16035 @item never-export or no-export
16036 The code block will not be evaluated during export but may still be called
16037 interactively.
16038 @item query-export
16039 Evaluation of the code block during export will require a query.
16040 @end table
16042 If this header argument is not set then evaluation is determined by the value
16043 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
16044 security}.
16046 @node wrap
16047 @subsubsection @code{:wrap}
16048 @cindex @code{:wrap}, src header argument
16049 The @code{:wrap} header argument is used to mark the results of source block
16050 evaluation.  The header argument can be passed a string that will be appended
16051 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
16052 results.  If not string is specified then the results will be wrapped in a
16053 @code{#+BEGIN/END_RESULTS} block.
16055 @node post
16056 @subsubsection @code{:post}
16057 @cindex @code{:post}, src header argument
16058 The @code{:post} header argument is used to post-process the results of a
16059 code block execution.  When a post argument is given, the results of the code
16060 block will temporarily be bound to the @code{*this*} variable.  This variable
16061 may then be included in header argument forms such as those used in @ref{var}
16062 header argument specifications allowing passing of results to other code
16063 blocks, or direct execution via Emacs Lisp.  Additional header arguments may
16064 be passed to the @code{:post}-function.
16066 The following two examples illustrate the usage of the @code{:post} header
16067 argument.  The first example shows how to attach a attribute-line via @code{:post}.
16069 @example
16070 #+name: attr_wrap
16071 #+begin_src sh :var data="" :var width="\\textwidth" :results output
16072   echo "#+ATTR_LATEX :width $width"
16073   echo "$data"
16074 #+end_src
16076 #+header: :file /tmp/it.png
16077 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
16078   digraph@{
16079           a -> b;
16080           b -> c;
16081           c -> a;
16082   @}
16083 #+end_src
16085 #+RESULTS:
16086 :RESULTS:
16087 #+ATTR_LATEX :width 5cm
16088 [[file:/tmp/it.png]]
16089 :END:
16090 @end example
16092 The second examples shows how to use @code{:post} together with the
16093 @code{:colnames} header argument.
16094 @example
16095 #+name: round-tbl
16096 #+begin_src emacs-lisp :var tbl="" fmt="%.3f"
16097   (mapcar (lambda (row)
16098             (mapcar (lambda (cell)
16099                       (if (numberp cell)
16100                           (format fmt cell)
16101                         cell))
16102                     row))
16103           tbl)
16104 #+end_src
16106 #+begin_src R :colnames yes :post round-tbl[:colnames yes](*this*)
16107 set.seed(42)
16108 data.frame(foo=rnorm(1))
16109 #+end_src
16111 #+RESULTS:
16112 |   foo |
16113 |-------|
16114 | 1.371 |
16115 @end example
16117 @node prologue
16118 @subsubsection @code{:prologue}
16119 @cindex @code{:prologue}, src header argument
16120 The value of the @code{prologue} header argument will be prepended to the
16121 code block body before execution.  For example, @code{:prologue "reset"} may
16122 be used to reset a gnuplot session before execution of a particular code
16123 block, or the following configuration may be used to do this for all gnuplot
16124 code blocks.  Also see @ref{epilogue}.
16126 @lisp
16127 (add-to-list 'org-babel-default-header-args:gnuplot
16128              '((:prologue . "reset")))
16129 @end lisp
16131 @node epilogue
16132 @subsubsection @code{:epilogue}
16133 @cindex @code{:epilogue}, src header argument
16134 The value of the @code{epilogue} header argument will be appended to the code
16135 block body before execution.  Also see @ref{prologue}.
16137 @node Results of evaluation
16138 @section Results of evaluation
16139 @cindex code block, results of evaluation
16140 @cindex source code, results of evaluation
16142 The way in which results are handled depends on whether a session is invoked,
16143 as well as on whether @code{:results value} or @code{:results output} is
16144 used.  The following table shows the table possibilities.  For a full listing
16145 of the possible results header arguments see @ref{Results}.
16147 @multitable @columnfractions 0.26 0.33 0.41
16148 @item @tab @b{Non-session} @tab @b{Session}
16149 @item @code{:results value} @tab value of last expression @tab value of last expression
16150 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
16151 @end multitable
16153 Note: With @code{:results value}, the result in both @code{:session} and
16154 non-session is returned to Org mode as a table (a one- or two-dimensional
16155 vector of strings or numbers) when appropriate.
16157 @subsection Non-session
16158 @subsubsection @code{:results value}
16159 @cindex @code{:results}, src header argument
16160 This is the default.  Internally, the value is obtained by wrapping the code
16161 in a function definition in the external language, and evaluating that
16162 function.  Therefore, code should be written as if it were the body of such a
16163 function.  In particular, note that Python does not automatically return a
16164 value from a function unless a @code{return} statement is present, and so a
16165 @samp{return} statement will usually be required in Python.
16167 This is the only one of the four evaluation contexts in which the code is
16168 automatically wrapped in a function definition.
16170 @subsubsection @code{:results output}
16171 @cindex @code{:results}, src header argument
16172 The code is passed to the interpreter as an external process, and the
16173 contents of the standard output stream are returned as text.  (In certain
16174 languages this also contains the error output stream; this is an area for
16175 future work.)
16177 @subsection Session
16178 @subsubsection @code{:results value}
16179 @cindex @code{:results}, src header argument
16180 The code is passed to an interpreter running as an interactive Emacs inferior
16181 process.  Only languages which provide tools for interactive evaluation of
16182 code have session support, so some language (e.g., C and ditaa) do not
16183 support the @code{:session} header argument, and in other languages (e.g.,
16184 Python and Haskell) which have limitations on the code which may be entered
16185 into interactive sessions, those limitations apply to the code in code blocks
16186 using the @code{:session} header argument as well.
16188 Unless the @code{:results output} option is supplied (see below) the result
16189 returned is the result of the last evaluation performed by the
16190 interpreter.  (This is obtained in a language-specific manner: the value of
16191 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
16192 in R).
16194 @subsubsection @code{:results output}
16195 @cindex @code{:results}, src header argument
16196 The code is passed to the interpreter running as an interactive Emacs
16197 inferior process.  The result returned is the concatenation of the sequence of
16198 (text) output from the interactive interpreter.  Notice that this is not
16199 necessarily the same as what would be sent to @code{STDOUT} if the same code
16200 were passed to a non-interactive interpreter running as an external
16201 process.  For example, compare the following two blocks:
16203 @example
16204 #+BEGIN_SRC python :results output
16205  print "hello"
16207  print "bye"
16208 #+END_SRC
16210 #+RESULTS:
16211 : hello
16212 : bye
16213 @end example
16215 In non-session mode, the `2' is not printed and does not appear.
16217 @example
16218 #+BEGIN_SRC python :results output :session
16219  print "hello"
16221  print "bye"
16222 #+END_SRC
16224 #+RESULTS:
16225 : hello
16226 : 2
16227 : bye
16228 @end example
16230 But in @code{:session} mode, the interactive interpreter receives input `2'
16231 and prints out its value, `2'.  (Indeed, the other print statements are
16232 unnecessary here).
16234 @node Noweb reference syntax
16235 @section Noweb reference syntax
16236 @cindex code block, noweb reference
16237 @cindex syntax, noweb
16238 @cindex source code, noweb reference
16240 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
16241 Programming system allows named blocks of code to be referenced by using the
16242 familiar Noweb syntax:
16244 @example
16245 <<code-block-name>>
16246 @end example
16248 When a code block is tangled or evaluated, whether or not ``noweb''
16249 references are expanded depends upon the value of the @code{:noweb} header
16250 argument.  If @code{:noweb yes}, then a Noweb reference is expanded before
16251 evaluation.  If @code{:noweb no}, the default, then the reference is not
16252 expanded before evaluation.  See the @ref{noweb-ref} header argument for
16253 a more flexible way to resolve noweb references.
16255 It is possible to include the @emph{results} of a code block rather than the
16256 body.  This is done by appending parenthesis to the code block name which may
16257 optionally contain arguments to the code block as shown below.
16259 @example
16260 <<code-block-name(optional arguments)>>
16261 @end example
16263 Note: the default value, @code{:noweb no}, was chosen to ensure that
16264 correct code is not broken in a language, such as Ruby, where
16265 @code{<<arg>>} is a syntactically valid construct.  If @code{<<arg>>} is not
16266 syntactically valid in languages that you use, then please consider setting
16267 the default value.
16269 Note: if noweb tangling is slow in large Org mode files consider setting the
16270 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
16271 This will result in faster noweb reference resolution at the expense of not
16272 correctly resolving inherited values of the @code{:noweb-ref} header
16273 argument.
16275 @node Key bindings and useful functions
16276 @section Key bindings and useful functions
16277 @cindex code block, key bindings
16279 Many common Org mode key sequences are re-bound depending on
16280 the context.
16282 Within a code block, the following key bindings
16283 are active:
16285 @multitable @columnfractions 0.25 0.75
16286 @kindex C-c C-c
16287 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
16288 @kindex C-c C-o
16289 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
16290 @kindex M-up
16291 @item @kbd{M-@key{up}}    @tab @code{org-babel-load-in-session}
16292 @kindex M-down
16293 @item @kbd{M-@key{down}}  @tab @code{org-babel-switch-to-session}
16294 @end multitable
16296 In an Org mode buffer, the following key bindings are active:
16298 @multitable @columnfractions 0.45 0.55
16299 @kindex C-c C-v p
16300 @kindex C-c C-v C-p
16301 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
16302 @kindex C-c C-v n
16303 @kindex C-c C-v C-n
16304 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
16305 @kindex C-c C-v e
16306 @kindex C-c C-v C-e
16307 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
16308 @kindex C-c C-v o
16309 @kindex C-c C-v C-o
16310 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
16311 @kindex C-c C-v v
16312 @kindex C-c C-v C-v
16313 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
16314 @kindex C-c C-v u
16315 @kindex C-c C-v C-u
16316 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
16317 @kindex C-c C-v g
16318 @kindex C-c C-v C-g
16319 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
16320 @kindex C-c C-v r
16321 @kindex C-c C-v C-r
16322 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
16323 @kindex C-c C-v b
16324 @kindex C-c C-v C-b
16325 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16326 @kindex C-c C-v s
16327 @kindex C-c C-v C-s
16328 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16329 @kindex C-c C-v d
16330 @kindex C-c C-v C-d
16331 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
16332 @kindex C-c C-v t
16333 @kindex C-c C-v C-t
16334 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16335 @kindex C-c C-v f
16336 @kindex C-c C-v C-f
16337 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16338 @kindex C-c C-v c
16339 @kindex C-c C-v C-c
16340 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
16341 @kindex C-c C-v j
16342 @kindex C-c C-v C-j
16343 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
16344 @kindex C-c C-v l
16345 @kindex C-c C-v C-l
16346 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
16347 @kindex C-c C-v i
16348 @kindex C-c C-v C-i
16349 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
16350 @kindex C-c C-v I
16351 @kindex C-c C-v C-I
16352 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
16353 @kindex C-c C-v z
16354 @kindex C-c C-v C-z
16355 @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}
16356 @kindex C-c C-v a
16357 @kindex C-c C-v C-a
16358 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16359 @kindex C-c C-v h
16360 @kindex C-c C-v C-h
16361 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
16362 @kindex C-c C-v x
16363 @kindex C-c C-v C-x
16364 @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}
16365 @end multitable
16367 @c When possible these keybindings were extended to work when the control key is
16368 @c kept pressed, resulting in the following additional keybindings.
16370 @c @multitable @columnfractions 0.25 0.75
16371 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16372 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16373 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16374 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
16375 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
16376 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16377 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16378 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
16379 @c @end multitable
16381 @node Batch execution
16382 @section Batch execution
16383 @cindex code block, batch execution
16384 @cindex source code, batch execution
16386 It is possible to call functions from the command line.  This shell
16387 script calls @code{org-babel-tangle} on every one of its arguments.
16389 Be sure to adjust the paths to fit your system.
16391 @example
16392 #!/bin/sh
16393 # -*- mode: shell-script -*-
16395 # tangle files with org-mode
16397 DIR=`pwd`
16398 FILES=""
16400 # wrap each argument in the code required to call tangle on it
16401 for i in $@@; do
16402     FILES="$FILES \"$i\""
16403 done
16405 emacs -Q --batch \
16406 --eval "(progn
16407 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
16408 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
16409 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
16410 (mapc (lambda (file)
16411        (find-file (expand-file-name file \"$DIR\"))
16412        (org-babel-tangle)
16413        (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
16414 @end example
16416 @node Miscellaneous
16417 @chapter Miscellaneous
16419 @menu
16420 * Completion::                  M-TAB knows what you need
16421 * Easy templates::              Quick insertion of structural elements
16422 * Speed keys::                  Electric commands at the beginning of a headline
16423 * Code evaluation security::    Org mode files evaluate inline code
16424 * Customization::               Adapting Org to your taste
16425 * In-buffer settings::          Overview of the #+KEYWORDS
16426 * The very busy C-c C-c key::   When in doubt, press C-c C-c
16427 * Clean view::                  Getting rid of leading stars in the outline
16428 * TTY keys::                    Using Org on a tty
16429 * Interaction::                 Other Emacs packages
16430 * org-crypt::                   Encrypting Org files
16431 @end menu
16434 @node Completion
16435 @section Completion
16436 @cindex completion, of @TeX{} symbols
16437 @cindex completion, of TODO keywords
16438 @cindex completion, of dictionary words
16439 @cindex completion, of option keywords
16440 @cindex completion, of tags
16441 @cindex completion, of property keys
16442 @cindex completion, of link abbreviations
16443 @cindex @TeX{} symbol completion
16444 @cindex TODO keywords completion
16445 @cindex dictionary word completion
16446 @cindex option keyword completion
16447 @cindex tag completion
16448 @cindex link abbreviations, completion of
16450 Emacs would not be Emacs without completion, and Org mode uses it whenever it
16451 makes sense.  If you prefer an @i{iswitchb}- or @i{ido}-like interface for
16452 some of the completion prompts, you can specify your preference by setting at
16453 most one of the variables @code{org-completion-use-iswitchb}
16454 @code{org-completion-use-ido}.
16456 Org supports in-buffer completion.  This type of completion does
16457 not make use of the minibuffer.  You simply type a few letters into
16458 the buffer and use the key to complete text right there.
16460 @table @kbd
16461 @kindex M-@key{TAB}
16462 @item M-@key{TAB}
16463 Complete word at point
16464 @itemize @bullet
16465 @item
16466 At the beginning of a headline, complete TODO keywords.
16467 @item
16468 After @samp{\}, complete @TeX{} symbols supported by the exporter.
16469 @item
16470 After @samp{*}, complete headlines in the current buffer so that they
16471 can be used in search links like @samp{[[*find this headline]]}.
16472 @item
16473 After @samp{:} in a headline, complete tags.  The list of tags is taken
16474 from the variable @code{org-tag-alist} (possibly set through the
16475 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
16476 dynamically from all tags used in the current buffer.
16477 @item
16478 After @samp{:} and not in a headline, complete property keys.  The list
16479 of keys is constructed dynamically from all keys used in the current
16480 buffer.
16481 @item
16482 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
16483 @item
16484 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
16485 @samp{OPTIONS} which set file-specific options for Org mode.  When the
16486 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
16487 will insert example settings for this keyword.
16488 @item
16489 In the line after @samp{#+STARTUP: }, complete startup keywords,
16490 i.e., valid keys for this line.
16491 @item
16492 Elsewhere, complete dictionary words using Ispell.
16493 @end itemize
16494 @end table
16496 @node Easy templates
16497 @section Easy templates
16498 @cindex template insertion
16499 @cindex insertion, of templates
16501 Org mode supports insertion of empty structural elements (like
16502 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
16503 strokes.  This is achieved through a native template expansion mechanism.
16504 Note that Emacs has several other template mechanisms which could be used in
16505 a similar way, for example @file{yasnippet}.
16507 To insert a structural element, type a @samp{<}, followed by a template
16508 selector and @kbd{@key{TAB}}.  Completion takes effect only when the above
16509 keystrokes are typed on a line by itself.
16511 The following template selectors are currently supported.
16513 @multitable @columnfractions 0.1 0.9
16514 @item @kbd{s} @tab @code{#+BEGIN_SRC     ... #+END_SRC}
16515 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
16516 @item @kbd{q} @tab @code{#+BEGIN_QUOTE   ... #+END_QUOTE}
16517 @item @kbd{v} @tab @code{#+BEGIN_VERSE   ... #+END_VERSE}
16518 @item @kbd{c} @tab @code{#+BEGIN_CENTER  ... #+END_CENTER}
16519 @item @kbd{l} @tab @code{#+BEGIN_LaTeX   ... #+END_LaTeX}
16520 @item @kbd{L} @tab @code{#+LaTeX:}
16521 @item @kbd{h} @tab @code{#+BEGIN_HTML    ... #+END_HTML}
16522 @item @kbd{H} @tab @code{#+HTML:}
16523 @item @kbd{a} @tab @code{#+BEGIN_ASCII   ... #+END_ASCII}
16524 @item @kbd{A} @tab @code{#+ASCII:}
16525 @item @kbd{i} @tab @code{#+INDEX:} line
16526 @item @kbd{I} @tab @code{#+INCLUDE:} line
16527 @end multitable
16529 For example, on an empty line, typing "<e" and then pressing TAB, will expand
16530 into a complete EXAMPLE template.
16532 You can install additional templates by customizing the variable
16533 @code{org-structure-template-alist}.  See the docstring of the variable for
16534 additional details.
16536 @node Speed keys
16537 @section Speed keys
16538 @cindex speed keys
16539 @vindex org-use-speed-commands
16540 @vindex org-speed-commands-user
16542 Single keys can be made to execute commands when the cursor is at the
16543 beginning of a headline, i.e., before the first star.  Configure the variable
16544 @code{org-use-speed-commands} to activate this feature.  There is a
16545 pre-defined list of commands, and you can add more such commands using the
16546 variable @code{org-speed-commands-user}.  Speed keys not only speed up
16547 navigation and other commands, but they also provide an alternative way to
16548 execute commands bound to keys that are not or not easily available on a TTY,
16549 or on a small mobile device with a limited keyboard.
16551 To see which commands are available, activate the feature and press @kbd{?}
16552 with the cursor at the beginning of a headline.
16554 @node Code evaluation security
16555 @section Code evaluation and security issues
16557 Org provides tools to work with code snippets, including evaluating them.
16559 Running code on your machine always comes with a security risk.  Badly
16560 written or malicious code can be executed on purpose or by accident.  Org has
16561 default settings which will only evaluate such code if you give explicit
16562 permission to do so, and as a casual user of these features you should leave
16563 these precautions intact.
16565 For people who regularly work with such code, the confirmation prompts can
16566 become annoying, and you might want to turn them off.  This can be done, but
16567 you must be aware of the risks that are involved.
16569 Code evaluation can happen under the following circumstances:
16571 @table @i
16572 @item Source code blocks
16573 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
16574 C-c} in the block.  The most important thing to realize here is that Org mode
16575 files which contain code snippets are, in a certain sense, like executable
16576 files.  So you should accept them and load them into Emacs only from trusted
16577 sources---just like you would do with a program you install on your computer.
16579 Make sure you know what you are doing before customizing the variables
16580 which take off the default security brakes.
16582 @defopt org-confirm-babel-evaluate
16583 When t (the default), the user is asked before every code block evaluation.
16584 When @code{nil}, the user is not asked.  When set to a function, it is called with
16585 two arguments (language and body of the code block) and should return t to
16586 ask and @code{nil} not to ask.
16587 @end defopt
16589 For example, here is how to execute "ditaa" code (which is considered safe)
16590 without asking:
16592 @lisp
16593 (defun my-org-confirm-babel-evaluate (lang body)
16594   (not (string= lang "ditaa")))  ; don't ask for ditaa
16595 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
16596 @end lisp
16598 @item Following @code{shell} and @code{elisp} links
16599 Org has two link types that can directly evaluate code (@pxref{External
16600 links}).  These links can be problematic because the code to be evaluated is
16601 not visible.
16603 @defopt org-confirm-shell-link-function
16604 Function to queries user about shell link execution.
16605 @end defopt
16606 @defopt org-confirm-elisp-link-function
16607 Functions to query user for Emacs Lisp link execution.
16608 @end defopt
16610 @item Formulas in tables
16611 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
16612 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
16613 @end table
16615 @node Customization
16616 @section Customization
16617 @cindex customization
16618 @cindex options, for customization
16619 @cindex variables, for customization
16621 There are more than 500 variables that can be used to customize
16622 Org.  For the sake of compactness of the manual, I am not
16623 describing the variables here.  A structured overview of customization
16624 variables is available with @kbd{M-x org-customize RET}.  Or select
16625 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
16626 settings can also be activated on a per-file basis, by putting special
16627 lines into the buffer (@pxref{In-buffer settings}).
16629 @node In-buffer settings
16630 @section Summary of in-buffer settings
16631 @cindex in-buffer settings
16632 @cindex special keywords
16634 Org mode uses special lines in the buffer to define settings on a
16635 per-file basis.  These lines start with a @samp{#+} followed by a
16636 keyword, a colon, and then individual words defining a setting.  Several
16637 setting words can be in the same line, but you can also have multiple
16638 lines for the keyword.  While these settings are described throughout
16639 the manual, here is a summary.  After changing any of these lines in the
16640 buffer, press @kbd{C-c C-c} with the cursor still in the line to
16641 activate the changes immediately.  Otherwise they become effective only
16642 when the file is visited again in a new Emacs session.
16644 @vindex org-archive-location
16645 @table @kbd
16646 @item #+ARCHIVE: %s_done::
16647 This line sets the archive location for the agenda file.  It applies for
16648 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
16649 of the file.  The first such line also applies to any entries before it.
16650 The corresponding variable is @code{org-archive-location}.
16651 @item #+CATEGORY:
16652 This line sets the category for the agenda file.  The category applies to the
16653 whole document.
16654 @item #+COLUMNS: %25ITEM ...
16655 @cindex property, COLUMNS
16656 Set the default format for columns view.  This format applies when
16657 columns view is invoked in locations where no @code{COLUMNS} property
16658 applies.
16659 @item #+CONSTANTS: name1=value1 ...
16660 @vindex org-table-formula-constants
16661 @vindex org-table-formula
16662 Set file-local values for constants to be used in table formulas.  This
16663 line sets the local variable @code{org-table-formula-constants-local}.
16664 The global version of this variable is
16665 @code{org-table-formula-constants}.
16666 @item #+FILETAGS: :tag1:tag2:tag3:
16667 Set tags that can be inherited by any entry in the file, including the
16668 top-level entries.
16669 @item #+LINK: linkword replace
16670 @vindex org-link-abbrev-alist
16671 These lines (several are allowed) specify link abbreviations.
16672 @xref{Link abbreviations}.  The corresponding variable is
16673 @code{org-link-abbrev-alist}.
16674 @item #+PRIORITIES: highest lowest default
16675 @vindex org-highest-priority
16676 @vindex org-lowest-priority
16677 @vindex org-default-priority
16678 This line sets the limits and the default for the priorities.  All three
16679 must be either letters A--Z or numbers 0--9.  The highest priority must
16680 have a lower ASCII number than the lowest priority.
16681 @item #+PROPERTY: Property_Name Value
16682 This line sets a default inheritance value for entries in the current
16683 buffer, most useful for specifying the allowed values of a property.
16684 @cindex #+SETUPFILE
16685 @item #+SETUPFILE: file
16686 This line defines a file that holds more in-buffer setup.  Normally this is
16687 entirely ignored.  Only when the buffer is parsed for option-setting lines
16688 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
16689 settings line, or when exporting), then the contents of this file are parsed
16690 as if they had been included in the buffer.  In particular, the file can be
16691 any other Org mode file with internal setup.  You can visit the file the
16692 cursor is in the line with @kbd{C-c '}.
16693 @item #+STARTUP:
16694 @cindex #+STARTUP
16695 This line sets options to be used at startup of Org mode, when an
16696 Org file is being visited.
16698 The first set of options deals with the initial visibility of the outline
16699 tree.  The corresponding variable for global default settings is
16700 @code{org-startup-folded}, with a default value @code{t}, which means
16701 @code{overview}.
16702 @vindex org-startup-folded
16703 @cindex @code{overview}, STARTUP keyword
16704 @cindex @code{content}, STARTUP keyword
16705 @cindex @code{showall}, STARTUP keyword
16706 @cindex @code{showeverything}, STARTUP keyword
16707 @example
16708 overview         @r{top-level headlines only}
16709 content          @r{all headlines}
16710 showall          @r{no folding of any entries}
16711 showeverything   @r{show even drawer contents}
16712 @end example
16714 @vindex org-startup-indented
16715 @cindex @code{indent}, STARTUP keyword
16716 @cindex @code{noindent}, STARTUP keyword
16717 Dynamic virtual indentation is controlled by the variable
16718 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
16719 @example
16720 indent     @r{start with @code{org-indent-mode} turned on}
16721 noindent   @r{start with @code{org-indent-mode} turned off}
16722 @end example
16724 @vindex org-startup-align-all-tables
16725 Then there are options for aligning tables upon visiting a file.  This
16726 is useful in files containing narrowed table columns.  The corresponding
16727 variable is @code{org-startup-align-all-tables}, with a default value
16728 @code{nil}.
16729 @cindex @code{align}, STARTUP keyword
16730 @cindex @code{noalign}, STARTUP keyword
16731 @example
16732 align      @r{align all tables}
16733 noalign    @r{don't align tables on startup}
16734 @end example
16736 @vindex org-startup-with-inline-images
16737 When visiting a file, inline images can be automatically displayed.  The
16738 corresponding variable is @code{org-startup-with-inline-images}, with a
16739 default value @code{nil} to avoid delays when visiting a file.
16740 @cindex @code{inlineimages}, STARTUP keyword
16741 @cindex @code{noinlineimages}, STARTUP keyword
16742 @example
16743 inlineimages   @r{show inline images}
16744 noinlineimages @r{don't show inline images on startup}
16745 @end example
16747 @vindex org-startup-with-latex-preview
16748 When visiting a file, @LaTeX{} fragments can be converted to images
16749 automatically.  The variable @code{org-startup-with-latex-preview} which
16750 controls this behavior, is set to @code{nil} by default to avoid delays on
16751 startup.
16752 @cindex @code{latexpreview}, STARTUP keyword
16753 @cindex @code{nolatexpreview}, STARTUP keyword
16754 @example
16755 latexpreview   @r{preview @LaTeX{} fragments}
16756 nolatexpreview @r{don't preview @LaTeX{} fragments}
16757 @end example
16759 @vindex org-log-done
16760 @vindex org-log-note-clock-out
16761 @vindex org-log-repeat
16762 Logging the closing and reopening of TODO items and clock intervals can be
16763 configured using these options (see variables @code{org-log-done},
16764 @code{org-log-note-clock-out} and @code{org-log-repeat})
16765 @cindex @code{logdone}, STARTUP keyword
16766 @cindex @code{lognotedone}, STARTUP keyword
16767 @cindex @code{nologdone}, STARTUP keyword
16768 @cindex @code{lognoteclock-out}, STARTUP keyword
16769 @cindex @code{nolognoteclock-out}, STARTUP keyword
16770 @cindex @code{logrepeat}, STARTUP keyword
16771 @cindex @code{lognoterepeat}, STARTUP keyword
16772 @cindex @code{nologrepeat}, STARTUP keyword
16773 @cindex @code{logreschedule}, STARTUP keyword
16774 @cindex @code{lognotereschedule}, STARTUP keyword
16775 @cindex @code{nologreschedule}, STARTUP keyword
16776 @cindex @code{logredeadline}, STARTUP keyword
16777 @cindex @code{lognoteredeadline}, STARTUP keyword
16778 @cindex @code{nologredeadline}, STARTUP keyword
16779 @cindex @code{logrefile}, STARTUP keyword
16780 @cindex @code{lognoterefile}, STARTUP keyword
16781 @cindex @code{nologrefile}, STARTUP keyword
16782 @cindex @code{logdrawer}, STARTUP keyword
16783 @cindex @code{nologdrawer}, STARTUP keyword
16784 @cindex @code{logstatesreversed}, STARTUP keyword
16785 @cindex @code{nologstatesreversed}, STARTUP keyword
16786 @example
16787 logdone             @r{record a timestamp when an item is marked DONE}
16788 lognotedone         @r{record timestamp and a note when DONE}
16789 nologdone           @r{don't record when items are marked DONE}
16790 logrepeat           @r{record a time when reinstating a repeating item}
16791 lognoterepeat       @r{record a note when reinstating a repeating item}
16792 nologrepeat         @r{do not record when reinstating repeating item}
16793 lognoteclock-out    @r{record a note when clocking out}
16794 nolognoteclock-out  @r{don't record a note when clocking out}
16795 logreschedule       @r{record a timestamp when scheduling time changes}
16796 lognotereschedule   @r{record a note when scheduling time changes}
16797 nologreschedule     @r{do not record when a scheduling date changes}
16798 logredeadline       @r{record a timestamp when deadline changes}
16799 lognoteredeadline   @r{record a note when deadline changes}
16800 nologredeadline     @r{do not record when a deadline date changes}
16801 logrefile           @r{record a timestamp when refiling}
16802 lognoterefile       @r{record a note when refiling}
16803 nologrefile         @r{do not record when refiling}
16804 logdrawer           @r{store log into drawer}
16805 nologdrawer         @r{store log outside of drawer}
16806 logstatesreversed   @r{reverse the order of states notes}
16807 nologstatesreversed @r{do not reverse the order of states notes}
16808 @end example
16810 @vindex org-hide-leading-stars
16811 @vindex org-odd-levels-only
16812 Here are the options for hiding leading stars in outline headings, and for
16813 indenting outlines.  The corresponding variables are
16814 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
16815 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
16816 @cindex @code{hidestars}, STARTUP keyword
16817 @cindex @code{showstars}, STARTUP keyword
16818 @cindex @code{odd}, STARTUP keyword
16819 @cindex @code{even}, STARTUP keyword
16820 @example
16821 hidestars  @r{make all but one of the stars starting a headline invisible.}
16822 showstars  @r{show all stars starting a headline}
16823 indent     @r{virtual indentation according to outline level}
16824 noindent   @r{no virtual indentation according to outline level}
16825 odd        @r{allow only odd outline levels (1,3,...)}
16826 oddeven    @r{allow all outline levels}
16827 @end example
16829 @vindex org-put-time-stamp-overlays
16830 @vindex org-time-stamp-overlay-formats
16831 To turn on custom format overlays over timestamps (variables
16832 @code{org-put-time-stamp-overlays} and
16833 @code{org-time-stamp-overlay-formats}), use
16834 @cindex @code{customtime}, STARTUP keyword
16835 @example
16836 customtime @r{overlay custom time format}
16837 @end example
16839 @vindex constants-unit-system
16840 The following options influence the table spreadsheet (variable
16841 @code{constants-unit-system}).
16842 @cindex @code{constcgs}, STARTUP keyword
16843 @cindex @code{constSI}, STARTUP keyword
16844 @example
16845 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
16846 constSI    @r{@file{constants.el} should use the SI unit system}
16847 @end example
16849 @vindex org-footnote-define-inline
16850 @vindex org-footnote-auto-label
16851 @vindex org-footnote-auto-adjust
16852 To influence footnote settings, use the following keywords.  The
16853 corresponding variables are @code{org-footnote-define-inline},
16854 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
16855 @cindex @code{fninline}, STARTUP keyword
16856 @cindex @code{nofninline}, STARTUP keyword
16857 @cindex @code{fnlocal}, STARTUP keyword
16858 @cindex @code{fnprompt}, STARTUP keyword
16859 @cindex @code{fnauto}, STARTUP keyword
16860 @cindex @code{fnconfirm}, STARTUP keyword
16861 @cindex @code{fnplain}, STARTUP keyword
16862 @cindex @code{fnadjust}, STARTUP keyword
16863 @cindex @code{nofnadjust}, STARTUP keyword
16864 @example
16865 fninline    @r{define footnotes inline}
16866 fnnoinline  @r{define footnotes in separate section}
16867 fnlocal     @r{define footnotes near first reference, but not inline}
16868 fnprompt    @r{prompt for footnote labels}
16869 fnauto      @r{create @code{[fn:1]}-like labels automatically (default)}
16870 fnconfirm   @r{offer automatic label for editing or confirmation}
16871 fnplain     @r{create @code{[1]}-like labels automatically}
16872 fnadjust    @r{automatically renumber and sort footnotes}
16873 nofnadjust  @r{do not renumber and sort automatically}
16874 @end example
16876 @cindex org-hide-block-startup
16877 To hide blocks on startup, use these keywords.  The corresponding variable is
16878 @code{org-hide-block-startup}.
16879 @cindex @code{hideblocks}, STARTUP keyword
16880 @cindex @code{nohideblocks}, STARTUP keyword
16881 @example
16882 hideblocks   @r{Hide all begin/end blocks on startup}
16883 nohideblocks @r{Do not hide blocks on startup}
16884 @end example
16886 @cindex org-pretty-entities
16887 The display of entities as UTF-8 characters is governed by the variable
16888 @code{org-pretty-entities} and the keywords
16889 @cindex @code{entitiespretty}, STARTUP keyword
16890 @cindex @code{entitiesplain}, STARTUP keyword
16891 @example
16892 entitiespretty  @r{Show entities as UTF-8 characters where possible}
16893 entitiesplain   @r{Leave entities plain}
16894 @end example
16896 @item #+TAGS:  TAG1(c1) TAG2(c2)
16897 @vindex org-tag-alist
16898 These lines (several such lines are allowed) specify the valid tags in
16899 this file, and (potentially) the corresponding @emph{fast tag selection}
16900 keys.  The corresponding variable is @code{org-tag-alist}.
16901 @cindex #+TBLFM
16902 @item #+TBLFM:
16903 This line contains the formulas for the table directly above the line.
16905 Table can have multiple lines containing @samp{#+TBLFM:}.  Note
16906 that only the first line of @samp{#+TBLFM:} will be applied when
16907 you recalculate the table.  For more details see @ref{Using
16908 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
16910 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
16911 @itemx #+OPTIONS:, #+BIND:,
16912 @itemx #+DESCRIPTION:, #+KEYWORDS:,
16913 @itemx #+LATEX_HEADER:, #+LATEX_HEADER_EXTRA:,
16914 @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
16915 @itemx #+ODT_STYLES_FILE:,
16916 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
16917 These lines provide settings for exporting files.  For more details see
16918 @ref{Export settings}.
16919 @item #+TODO:    #+SEQ_TODO:   #+TYP_TODO:
16920 @vindex org-todo-keywords
16921 These lines set the TODO keywords and their interpretation in the
16922 current file.  The corresponding variable is @code{org-todo-keywords}.
16923 @end table
16925 @node The very busy C-c C-c key
16926 @section The very busy C-c C-c key
16927 @kindex C-c C-c
16928 @cindex C-c C-c, overview
16930 The key @kbd{C-c C-c} has many purposes in Org, which are all
16931 mentioned scattered throughout this manual.  One specific function of
16932 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
16933 other circumstances it means something like @emph{``Hey Org, look
16934 here and update according to what you see here''}.  Here is a summary of
16935 what this means in different contexts.
16937 @itemize @minus
16938 @item
16939 If there are highlights in the buffer from the creation of a sparse
16940 tree, or from clock display, remove these highlights.
16941 @item
16942 If the cursor is in one of the special @code{#+KEYWORD} lines, this
16943 triggers scanning the buffer for these lines and updating the
16944 information.
16945 @item
16946 If the cursor is inside a table, realign the table.  This command
16947 works even if the automatic table editor has been turned off.
16948 @item
16949 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
16950 the entire table.
16951 @item
16952 If the current buffer is a capture buffer, close the note and file it.
16953 With a prefix argument, file it, without further interaction, to the
16954 default location.
16955 @item
16956 If the cursor is on a @code{<<<target>>>}, update radio targets and
16957 corresponding links in this buffer.
16958 @item
16959 If the cursor is in a property line or at the start or end of a property
16960 drawer, offer property commands.
16961 @item
16962 If the cursor is at a footnote reference, go to the corresponding
16963 definition, and @emph{vice versa}.
16964 @item
16965 If the cursor is on a statistics cookie, update it.
16966 @item
16967 If the cursor is in a plain list item with a checkbox, toggle the status
16968 of the checkbox.
16969 @item
16970 If the cursor is on a numbered item in a plain list, renumber the
16971 ordered list.
16972 @item
16973 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
16974 block is updated.
16975 @item
16976 If the cursor is at a timestamp, fix the day name in the timestamp.
16977 @end itemize
16979 @node Clean view
16980 @section A cleaner outline view
16981 @cindex hiding leading stars
16982 @cindex dynamic indentation
16983 @cindex odd-levels-only outlines
16984 @cindex clean outline view
16986 Some people find it noisy and distracting that the Org headlines start with a
16987 potentially large number of stars, and that text below the headlines is not
16988 indented.  While this is no problem when writing a @emph{book-like} document
16989 where the outline headings are really section headings, in a more
16990 @emph{list-oriented} outline, indented structure is a lot cleaner:
16992 @example
16993 @group
16994 * Top level headline             |    * Top level headline
16995 ** Second level                  |      * Second level
16996 *** 3rd level                    |        * 3rd level
16997 some text                        |          some text
16998 *** 3rd level                    |        * 3rd level
16999 more text                        |          more text
17000 * Another top level headline     |    * Another top level headline
17001 @end group
17002 @end example
17004 @noindent
17006 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
17007 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
17008 be achieved dynamically at display time using @code{org-indent-mode}.  In
17009 this minor mode, all lines are prefixed for display with the necessary amount
17010 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
17011 property, such that @code{visual-line-mode} (or purely setting
17012 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
17013 }.  Also headlines are prefixed with additional stars, so that the amount of
17014 indentation shifts by two@footnote{See the variable
17015 @code{org-indent-indentation-per-level}.}  spaces per level.  All headline
17016 stars but the last one are made invisible using the @code{org-hide}
17017 face@footnote{Turning on @code{org-indent-mode} sets
17018 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
17019 @code{nil}.}; see below under @samp{2.} for more information on how this
17020 works.  You can turn on @code{org-indent-mode} for all files by customizing
17021 the variable @code{org-startup-indented}, or you can turn it on for
17022 individual files using
17024 @example
17025 #+STARTUP: indent
17026 @end example
17028 If you want a similar effect in an earlier version of Emacs and/or Org, or if
17029 you want the indentation to be hard space characters so that the plain text
17030 file looks as similar as possible to the Emacs display, Org supports you in
17031 the following way:
17033 @enumerate
17034 @item
17035 @emph{Indentation of text below headlines}@*
17036 You may indent text below each headline to make the left boundary line up
17037 with the headline, like
17039 @example
17040 *** 3rd level
17041     more text, now indented
17042 @end example
17044 @vindex org-adapt-indentation
17045 Org supports this with paragraph filling, line wrapping, and structure
17046 editing@footnote{See also the variable @code{org-adapt-indentation}.},
17047 preserving or adapting the indentation as appropriate.
17049 @item
17050 @vindex org-hide-leading-stars
17051 @emph{Hiding leading stars}@* You can modify the display in such a way that
17052 all leading stars become invisible.  To do this in a global way, configure
17053 the variable @code{org-hide-leading-stars} or change this on a per-file basis
17054 with
17056 @example
17057 #+STARTUP: hidestars
17058 #+STARTUP: showstars
17059 @end example
17061 With hidden stars, the tree becomes:
17063 @example
17064 @group
17065 * Top level headline
17066  * Second level
17067   * 3rd level
17068   ...
17069 @end group
17070 @end example
17072 @noindent
17073 @vindex org-hide @r{(face)}
17074 The leading stars are not truly replaced by whitespace, they are only
17075 fontified with the face @code{org-hide} that uses the background color as
17076 font color.  If you are not using either white or black background, you may
17077 have to customize this face to get the wanted effect.  Another possibility is
17078 to set this font such that the extra stars are @i{almost} invisible, for
17079 example using the color @code{grey90} on a white background.
17081 @item
17082 @vindex org-odd-levels-only
17083 Things become cleaner still if you skip all the even levels and use only odd
17084 levels 1, 3, 5..., effectively adding two stars to go from one outline level
17085 to the next@footnote{When you need to specify a level for a property search
17086 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}.  In this
17087 way we get the outline view shown at the beginning of this section.  In order
17088 to make the structure editing and export commands handle this convention
17089 correctly, configure the variable @code{org-odd-levels-only}, or set this on
17090 a per-file basis with one of the following lines:
17092 @example
17093 #+STARTUP: odd
17094 #+STARTUP: oddeven
17095 @end example
17097 You can convert an Org file from single-star-per-level to the
17098 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
17099 RET} in that file.  The reverse operation is @kbd{M-x
17100 org-convert-to-oddeven-levels}.
17101 @end enumerate
17103 @node TTY keys
17104 @section Using Org on a tty
17105 @cindex tty key bindings
17107 Because Org contains a large number of commands, by default many of
17108 Org's core commands are bound to keys that are generally not
17109 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
17110 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
17111 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
17112 these commands on a tty when special keys are unavailable, the following
17113 alternative bindings can be used.  The tty bindings below will likely be
17114 more cumbersome; you may find for some of the bindings below that a
17115 customized workaround suits you better.  For example, changing a timestamp
17116 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
17117 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
17119 @multitable @columnfractions 0.15 0.2 0.1 0.2
17120 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
17121 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab @kbd{C} @tab
17122 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
17123 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab @kbd{L} @tab
17124 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x r}           @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
17125 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab @kbd{R} @tab
17126 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
17127 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab @kbd{U} @tab
17128 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
17129 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab @kbd{D} @tab
17130 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab @kbd{ } @tab
17131 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
17132 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab @kbd{ } @tab
17133 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab @kbd{ } @tab
17134 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab @kbd{ } @tab
17135 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab @kbd{ } @tab
17136 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab @kbd{ } @tab
17137 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab @kbd{ } @tab
17138 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
17139 @end multitable
17142 @node Interaction
17143 @section Interaction with other packages
17144 @cindex packages, interaction with other
17145 Org lives in the world of GNU Emacs and interacts in various ways
17146 with other code out there.
17148 @menu
17149 * Cooperation::                 Packages Org cooperates with
17150 * Conflicts::                   Packages that lead to conflicts
17151 @end menu
17153 @node Cooperation
17154 @subsection Packages that Org cooperates with
17156 @table @asis
17157 @cindex @file{calc.el}
17158 @cindex Gillespie, Dave
17159 @item @file{calc.el} by Dave Gillespie
17160 Org uses the Calc package for implementing spreadsheet
17161 functionality in its tables (@pxref{The spreadsheet}).  Org
17162 checks for the availability of Calc by looking for the function
17163 @code{calc-eval} which will have been autoloaded during setup if Calc has
17164 been installed properly.  As of Emacs 22, Calc is part of the Emacs
17165 distribution.  Another possibility for interaction between the two
17166 packages is using Calc for embedded calculations.  @xref{Embedded Mode,
17167 , Embedded Mode, calc, GNU Emacs Calc Manual}.
17168 @item @file{constants.el} by Carsten Dominik
17169 @cindex @file{constants.el}
17170 @cindex Dominik, Carsten
17171 @vindex org-table-formula-constants
17172 In a table formula (@pxref{The spreadsheet}), it is possible to use
17173 names for natural constants or units.  Instead of defining your own
17174 constants in the variable @code{org-table-formula-constants}, install
17175 the @file{constants} package which defines a large number of constants
17176 and units, and lets you use unit prefixes like @samp{M} for
17177 @samp{Mega}, etc.  You will need version 2.0 of this package, available
17178 at @url{http://www.astro.uva.nl/~dominik/Tools}.  Org checks for
17179 the function @code{constants-get}, which has to be autoloaded in your
17180 setup.  See the installation instructions in the file
17181 @file{constants.el}.
17182 @item @file{cdlatex.el} by Carsten Dominik
17183 @cindex @file{cdlatex.el}
17184 @cindex Dominik, Carsten
17185 Org mode can make use of the CD@LaTeX{} package to efficiently enter
17186 @LaTeX{} fragments into Org files.  See @ref{CDLaTeX mode}.
17187 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
17188 @cindex @file{imenu.el}
17189 Imenu allows menu access to an index of items in a file.  Org mode
17190 supports Imenu---all you need to do to get the index is the following:
17191 @lisp
17192 (add-hook 'org-mode-hook
17193           (lambda () (imenu-add-to-menubar "Imenu")))
17194 @end lisp
17195 @vindex org-imenu-depth
17196 By default the index is two levels deep---you can modify the depth using
17197 the option @code{org-imenu-depth}.
17198 @item @file{remember.el} by John Wiegley
17199 @cindex @file{remember.el}
17200 @cindex Wiegley, John
17201 Org used to use this package for capture, but no longer does.
17202 @item @file{speedbar.el} by Eric M. Ludlam
17203 @cindex @file{speedbar.el}
17204 @cindex Ludlam, Eric M.
17205 Speedbar is a package that creates a special frame displaying files and
17206 index items in files.  Org mode supports Speedbar and allows you to
17207 drill into Org files directly from the Speedbar.  It also allows you to
17208 restrict the scope of agenda commands to a file or a subtree by using
17209 the command @kbd{<} in the Speedbar frame.
17210 @cindex @file{table.el}
17211 @item @file{table.el} by Takaaki Ota
17212 @kindex C-c C-c
17213 @cindex table editor, @file{table.el}
17214 @cindex @file{table.el}
17215 @cindex Ota, Takaaki
17217 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
17218 and alignment can be created using the Emacs table package by Takaaki Ota
17219 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
17220 Org mode will recognize these tables and export them properly.  Because of
17221 interference with other Org mode functionality, you unfortunately cannot edit
17222 these tables directly in the buffer.  Instead, you need to use the command
17223 @kbd{C-c '} to edit them, similar to source code snippets.
17225 @table @kbd
17226 @orgcmd{C-c ',org-edit-special}
17227 Edit a @file{table.el} table.  Works when the cursor is in a table.el table.
17229 @orgcmd{C-c ~,org-table-create-with-table.el}
17230 Insert a @file{table.el} table.  If there is already a table at point, this
17231 command converts it between the @file{table.el} format and the Org mode
17232 format.  See the documentation string of the command
17233 @code{org-convert-table} for the restrictions under which this is
17234 possible.
17235 @end table
17236 @file{table.el} is part of Emacs since Emacs 22.
17237 @item @file{footnote.el} by Steven L. Baur
17238 @cindex @file{footnote.el}
17239 @cindex Baur, Steven L.
17240 Org mode recognizes numerical footnotes as provided by this package.
17241 However, Org mode also has its own footnote support (@pxref{Footnotes}),
17242 which makes using @file{footnote.el} unnecessary.
17243 @end table
17245 @node Conflicts
17246 @subsection Packages that lead to conflicts with Org mode
17248 @table @asis
17250 @cindex @code{shift-selection-mode}
17251 @vindex org-support-shift-select
17252 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
17253 cursor motions combined with the shift key should start or enlarge regions.
17254 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
17255 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
17256 at such a location.  By default, @kbd{S-@key{cursor}} commands outside
17257 special contexts don't do anything, but you can customize the variable
17258 @code{org-support-shift-select}.  Org mode then tries to accommodate shift
17259 selection by (i) using it outside of the special contexts where special
17260 commands apply, and by (ii) extending an existing active region even if the
17261 cursor moves across a special context.
17263 @item @file{CUA.el} by Kim. F. Storm
17264 @cindex @file{CUA.el}
17265 @cindex Storm, Kim. F.
17266 @vindex org-replace-disputed-keys
17267 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
17268 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and
17269 extend the region.  In fact, Emacs 23 has this built-in in the form of
17270 @code{shift-selection-mode}, see previous paragraph.  If you are using Emacs
17271 23, you probably don't want to use another package for this purpose.
17272 However, if you prefer to leave these keys to a different package while
17273 working in Org mode, configure the variable @code{org-replace-disputed-keys}.
17274 When set, Org will move the following key bindings in Org files, and in the
17275 agenda buffer (but not during date selection).
17277 @example
17278 S-UP      @result{}  M-p             S-DOWN     @result{}  M-n
17279 S-LEFT    @result{}  M--             S-RIGHT    @result{}  M-+
17280 C-S-LEFT  @result{}  M-S--           C-S-RIGHT  @result{}  M-S-+
17281 @end example
17283 @vindex org-disputed-keys
17284 Yes, these are unfortunately more difficult to remember.  If you want
17285 to have other replacement keys, look at the variable
17286 @code{org-disputed-keys}.
17288 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
17289 @cindex @file{ecomplete.el}
17291 Ecomplete provides ``electric'' address completion in address header
17292 lines in message buffers.  Sadly Orgtbl mode cuts ecompletes power
17293 supply: No completion happens when Orgtbl mode is enabled in message
17294 buffers while entering text in address header lines.  If one wants to
17295 use ecomplete one should @emph{not} follow the advice to automagically
17296 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
17297 instead---after filling in the message headers---turn on Orgtbl mode
17298 manually when needed in the messages body.
17300 @item @file{filladapt.el} by Kyle Jones
17301 @cindex @file{filladapt.el}
17303 Org mode tries to do the right thing when filling paragraphs, list items and
17304 other elements.  Many users reported they had problems using both
17305 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
17306 this:
17308 @lisp
17309 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
17310 @end lisp
17312 @item @file{yasnippet.el}
17313 @cindex @file{yasnippet.el}
17314 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
17315 @code{"\t"}) overrules YASnippet's access to this key.  The following code
17316 fixed this problem:
17318 @lisp
17319 (add-hook 'org-mode-hook
17320           (lambda ()
17321             (org-set-local 'yas/trigger-key [tab])
17322             (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
17323 @end lisp
17325 The latest version of yasnippet doesn't play well with Org mode.  If the
17326 above code does not fix the conflict, start by defining the following
17327 function:
17329 @lisp
17330 (defun yas/org-very-safe-expand ()
17331   (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
17332 @end lisp
17334 Then, tell Org mode what to do with the new function:
17336 @lisp
17337 (add-hook 'org-mode-hook
17338           (lambda ()
17339             (make-variable-buffer-local 'yas/trigger-key)
17340             (setq yas/trigger-key [tab])
17341             (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
17342             (define-key yas/keymap [tab] 'yas/next-field)))
17343 @end lisp
17345 @item @file{windmove.el} by Hovav Shacham
17346 @cindex @file{windmove.el}
17347 This package also uses the @kbd{S-<cursor>} keys, so everything written
17348 in the paragraph above about CUA mode also applies here.  If you want make
17349 the windmove function active in locations where Org mode does not have
17350 special functionality on @kbd{S-@key{cursor}}, add this to your
17351 configuration:
17353 @lisp
17354 ;; Make windmove work in org-mode:
17355 (add-hook 'org-shiftup-final-hook 'windmove-up)
17356 (add-hook 'org-shiftleft-final-hook 'windmove-left)
17357 (add-hook 'org-shiftdown-final-hook 'windmove-down)
17358 (add-hook 'org-shiftright-final-hook 'windmove-right)
17359 @end lisp
17361 @item @file{viper.el} by Michael Kifer
17362 @cindex @file{viper.el}
17363 @kindex C-c /
17364 Viper uses @kbd{C-c /} and therefore makes this key not access the
17365 corresponding Org mode command @code{org-sparse-tree}.  You need to find
17366 another key for this command, or override the key in
17367 @code{viper-vi-global-user-map} with
17369 @lisp
17370 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
17371 @end lisp
17375 @end table
17377 @node org-crypt
17378 @section org-crypt.el
17379 @cindex @file{org-crypt.el}
17380 @cindex @code{org-decrypt-entry}
17382 Org-crypt will encrypt the text of an entry, but not the headline, or
17383 properties.  Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
17384 files.
17386 Any text below a headline that has a @samp{:crypt:} tag will be automatically
17387 be encrypted when the file is saved.  If you want to use a different tag just
17388 customize the @code{org-crypt-tag-matcher} setting.
17390 To use org-crypt it is suggested that you have the following in your
17391 @file{.emacs}:
17393 @lisp
17394 (require 'org-crypt)
17395 (org-crypt-use-before-save-magic)
17396 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
17398 (setq org-crypt-key nil)
17399   ;; GPG key to use for encryption
17400   ;; Either the Key ID or set to nil to use symmetric encryption.
17402 (setq auto-save-default nil)
17403   ;; Auto-saving does not cooperate with org-crypt.el: so you need
17404   ;; to turn it off if you plan to use org-crypt.el quite often.
17405   ;; Otherwise, you'll get an (annoying) message each time you
17406   ;; start Org.
17408   ;; To turn it off only locally, you can insert this:
17409   ;;
17410   ;; # -*- buffer-auto-save-file-name: nil; -*-
17411 @end lisp
17413 Excluding the crypt tag from inheritance prevents already encrypted text
17414 being encrypted again.
17416 @node Hacking
17417 @appendix Hacking
17418 @cindex hacking
17420 This appendix covers some areas where users can extend the functionality of
17421 Org.
17423 @menu
17424 * Hooks::                       How to reach into Org's internals
17425 * Add-on packages::             Available extensions
17426 * Adding hyperlink types::      New custom link types
17427 * Adding export back-ends::     How to write new export back-ends
17428 * Context-sensitive commands::  How to add functionality to such commands
17429 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
17430 * Dynamic blocks::              Automatically filled blocks
17431 * Special agenda views::        Customized views
17432 * Speeding up your agendas::    Tips on how to speed up your agendas
17433 * Extracting agenda information::  Post-processing of agenda information
17434 * Using the property API::      Writing programs that use entry properties
17435 * Using the mapping API::       Mapping over all or selected entries
17436 @end menu
17438 @node Hooks
17439 @section Hooks
17440 @cindex hooks
17442 Org has a large number of hook variables that can be used to add
17443 functionality.  This appendix about hacking is going to illustrate the
17444 use of some of them.  A complete list of all hooks with documentation is
17445 maintained by the Worg project and can be found at
17446 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
17448 @node Add-on packages
17449 @section Add-on packages
17450 @cindex add-on packages
17452 A large number of add-on packages have been written by various authors.
17454 These packages are not part of Emacs, but they are distributed as contributed
17455 packages with the separate release available at @uref{http://orgmode.org}.
17456 See the @file{contrib/README} file in the source code directory for a list of
17457 contributed files.  You may also find some more information on the Worg page:
17458 @uref{http://orgmode.org/worg/org-contrib/}.
17460 @node Adding hyperlink types
17461 @section Adding hyperlink types
17462 @cindex hyperlinks, adding new types
17464 Org has a large number of hyperlink types built-in
17465 (@pxref{Hyperlinks}).  If you would like to add new link types, Org
17466 provides an interface for doing so.  Let's look at an example file,
17467 @file{org-man.el}, that will add support for creating links like
17468 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
17469 Emacs:
17471 @lisp
17472 ;;; org-man.el - Support for links to manpages in Org
17474 (require 'org)
17476 (org-add-link-type "man" 'org-man-open)
17477 (add-hook 'org-store-link-functions 'org-man-store-link)
17479 (defcustom org-man-command 'man
17480   "The Emacs command to be used to display a man page."
17481   :group 'org-link
17482   :type '(choice (const man) (const woman)))
17484 (defun org-man-open (path)
17485   "Visit the manpage on PATH.
17486 PATH should be a topic that can be thrown at the man command."
17487   (funcall org-man-command path))
17489 (defun org-man-store-link ()
17490   "Store a link to a manpage."
17491   (when (memq major-mode '(Man-mode woman-mode))
17492     ;; This is a man page, we do make this link
17493     (let* ((page (org-man-get-page-name))
17494            (link (concat "man:" page))
17495            (description (format "Manpage for %s" page)))
17496       (org-store-link-props
17497        :type "man"
17498        :link link
17499        :description description))))
17501 (defun org-man-get-page-name ()
17502   "Extract the page name from the buffer name."
17503   ;; This works for both `Man-mode' and `woman-mode'.
17504   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
17505       (match-string 1 (buffer-name))
17506     (error "Cannot create link to this man page")))
17508 (provide 'org-man)
17510 ;;; org-man.el ends here
17511 @end lisp
17513 @noindent
17514 You would activate this new link type in @file{.emacs} with
17516 @lisp
17517 (require 'org-man)
17518 @end lisp
17520 @noindent
17521 Let's go through the file and see what it does.
17522 @enumerate
17523 @item
17524 It does @code{(require 'org)} to make sure that @file{org.el} has been
17525 loaded.
17526 @item
17527 The next line calls @code{org-add-link-type} to define a new link type
17528 with prefix @samp{man}.  The call also contains the name of a function
17529 that will be called to follow such a link.
17530 @item
17531 @vindex org-store-link-functions
17532 The next line adds a function to @code{org-store-link-functions}, in
17533 order to allow the command @kbd{C-c l} to record a useful link in a
17534 buffer displaying a man page.
17535 @end enumerate
17537 The rest of the file defines the necessary variables and functions.
17538 First there is a customization variable that determines which Emacs
17539 command should be used to display man pages.  There are two options,
17540 @code{man} and @code{woman}.  Then the function to follow a link is
17541 defined.  It gets the link path as an argument---in this case the link
17542 path is just a topic for the manual command.  The function calls the
17543 value of @code{org-man-command} to display the man page.
17545 Finally the function @code{org-man-store-link} is defined.  When you try
17546 to store a link with @kbd{C-c l}, this function will be called to
17547 try to make a link.  The function must first decide if it is supposed to
17548 create the link for this buffer type; we do this by checking the value
17549 of the variable @code{major-mode}.  If not, the function must exit and
17550 return the value @code{nil}.  If yes, the link is created by getting the
17551 manual topic from the buffer name and prefixing it with the string
17552 @samp{man:}.  Then it must call the command @code{org-store-link-props}
17553 and set the @code{:type} and @code{:link} properties.  Optionally you
17554 can also set the @code{:description} property to provide a default for
17555 the link description when the link is later inserted into an Org
17556 buffer with @kbd{C-c C-l}.
17558 When it makes sense for your new link type, you may also define a function
17559 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
17560 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
17561 not accept any arguments, and return the full link with prefix.
17563 @node Adding export back-ends
17564 @section Adding export back-ends
17565 @cindex Export, writing back-ends
17567 Org 8.0 comes with a completely rewritten export engine which makes it easy
17568 to write new export back-ends, either from scratch, or by deriving them
17569 from existing ones.
17571 Your two entry points are respectively @code{org-export-define-backend} and
17572 @code{org-export-define-derived-backend}.  To grok these functions, you
17573 should first have a look at @file{ox-latex.el} (for how to define a new
17574 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
17575 back-end from an existing one.
17577 When creating a new back-end from scratch, the basic idea is to set the name
17578 of the back-end (as a symbol) and an alist of elements and export functions.
17579 On top of this, you will need to set additional keywords like
17580 @code{:menu-entry} (to display the back-end in the export dispatcher),
17581 @code{:export-block} (to specify what blocks should not be exported by this
17582 back-end), and @code{:options-alist} (to let the user set export options that
17583 are specific to this back-end.)
17585 Deriving a new back-end is similar, except that you need to set
17586 @code{:translate-alist} to an alist of export functions that should be used
17587 instead of the parent back-end functions.
17589 For a complete reference documentation, see
17590 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
17591 Reference on Worg}.
17593 @node Context-sensitive commands
17594 @section Context-sensitive commands
17595 @cindex context-sensitive commands, hooks
17596 @cindex add-ons, context-sensitive commands
17597 @vindex org-ctrl-c-ctrl-c-hook
17599 Org has several commands that act differently depending on context.  The most
17600 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
17601 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
17603 Add-ons can tap into this functionality by providing a function that detects
17604 special context for that add-on and executes functionality appropriate for
17605 the context.  Here is an example from Dan Davison's @file{org-R.el} which
17606 allows you to evaluate commands based on the @file{R} programming language
17607 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
17608 described in @ref{Working with source code} and is now obsolete.}.  For this
17609 package, special contexts are lines that start with @code{#+R:} or
17610 @code{#+RR:}.
17612 @lisp
17613 (defun org-R-apply-maybe ()
17614   "Detect if this is context for org-R and execute R commands."
17615   (if (save-excursion
17616         (beginning-of-line 1)
17617         (looking-at "#\\+RR?:"))
17618       (progn (call-interactively 'org-R-apply)
17619              t) ;; to signal that we took action
17620     nil)) ;; to signal that we did not
17622 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
17623 @end lisp
17625 The function first checks if the cursor is in such a line.  If that is the
17626 case, @code{org-R-apply} is called and the function returns @code{t} to
17627 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
17628 contexts.  If the function finds it should do nothing locally, it returns
17629 @code{nil} so that other, similar functions can have a try.
17632 @node Tables in arbitrary syntax
17633 @section Tables and lists in arbitrary syntax
17634 @cindex tables, in other modes
17635 @cindex lists, in other modes
17636 @cindex Orgtbl mode
17638 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
17639 frequent feature request has been to make it work with native tables in
17640 specific languages, for example @LaTeX{}.  However, this is extremely
17641 hard to do in a general way, would lead to a customization nightmare,
17642 and would take away much of the simplicity of the Orgtbl mode table
17643 editor.
17645 This appendix describes a different approach.  We keep the Orgtbl mode
17646 table in its native format (the @i{source table}), and use a custom
17647 function to @i{translate} the table to the correct syntax, and to
17648 @i{install} it in the right location (the @i{target table}).  This puts
17649 the burden of writing conversion functions on the user, but it allows
17650 for a very flexible system.
17652 Bastien added the ability to do the same with lists, in Orgstruct mode.  You
17653 can use Org's facilities to edit and structure lists by turning
17654 @code{orgstruct-mode} on, then locally exporting such lists in another format
17655 (HTML, @LaTeX{} or Texinfo.)
17658 @menu
17659 * Radio tables::                Sending and receiving radio tables
17660 * A @LaTeX{} example::          Step by step, almost a tutorial
17661 * Translator functions::        Copy and modify
17662 * Radio lists::                 Sending and receiving lists
17663 @end menu
17665 @node Radio tables
17666 @subsection Radio tables
17667 @cindex radio tables
17669 To define the location of the target table, you first need to create two
17670 lines that are comments in the current mode, but contain magic words
17671 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find.  Orgtbl mode will
17672 insert the translated table between these lines, replacing whatever was there
17673 before.  For example in C mode where comments are between @code{/* ... */}:
17675 @example
17676 /* BEGIN RECEIVE ORGTBL table_name */
17677 /* END RECEIVE ORGTBL table_name */
17678 @end example
17680 @noindent
17681 Just above the source table, we put a special line that tells
17682 Orgtbl mode how to translate this table and where to install it.  For
17683 example:
17684 @cindex #+ORGTBL
17685 @example
17686 #+ORGTBL: SEND table_name translation_function arguments...
17687 @end example
17689 @noindent
17690 @code{table_name} is the reference name for the table that is also used
17691 in the receiver lines.  @code{translation_function} is the Lisp function
17692 that does the translation.  Furthermore, the line can contain a list of
17693 arguments (alternating key and value) at the end.  The arguments will be
17694 passed as a property list to the translation function for
17695 interpretation.  A few standard parameters are already recognized and
17696 acted upon before the translation function is called:
17698 @table @code
17699 @item :skip N
17700 Skip the first N lines of the table.  Hlines do count as separate lines for
17701 this parameter!
17703 @item :skipcols (n1 n2 ...)
17704 List of columns that should be skipped.  If the table has a column with
17705 calculation marks, that column is automatically discarded as well.
17706 Please note that the translator function sees the table @emph{after} the
17707 removal of these columns, the function never knows that there have been
17708 additional columns.
17709 @end table
17711 @noindent
17712 The one problem remaining is how to keep the source table in the buffer
17713 without disturbing the normal workings of the file, for example during
17714 compilation of a C file or processing of a @LaTeX{} file.  There are a
17715 number of different solutions:
17717 @itemize @bullet
17718 @item
17719 The table could be placed in a block comment if that is supported by the
17720 language.  For example, in C mode you could wrap the table between
17721 @samp{/*} and @samp{*/} lines.
17722 @item
17723 Sometimes it is possible to put the table after some kind of @i{END}
17724 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
17725 in @LaTeX{}.
17726 @item
17727 You can just comment the table line-by-line whenever you want to process
17728 the file, and uncomment it whenever you need to edit the table.  This
17729 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
17730 makes this comment-toggling very easy, in particular if you bind it to a
17731 key.
17732 @end itemize
17734 @node A @LaTeX{} example
17735 @subsection A @LaTeX{} example of radio tables
17736 @cindex @LaTeX{}, and Orgtbl mode
17738 The best way to wrap the source table in @LaTeX{} is to use the
17739 @code{comment} environment provided by @file{comment.sty}.  It has to be
17740 activated by placing @code{\usepackage@{comment@}} into the document
17741 header.  Orgtbl mode can insert a radio table skeleton@footnote{By
17742 default this works only for @LaTeX{}, HTML, and Texinfo.  Configure the
17743 variable @code{orgtbl-radio-table-templates} to install templates for other
17744 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table RET}.  You will
17745 be prompted for a table name, let's say we use @samp{salesfigures}.  You
17746 will then get the following template:
17748 @cindex #+ORGTBL, SEND
17749 @example
17750 % BEGIN RECEIVE ORGTBL salesfigures
17751 % END RECEIVE ORGTBL salesfigures
17752 \begin@{comment@}
17753 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17754 | | |
17755 \end@{comment@}
17756 @end example
17758 @noindent
17759 @vindex @LaTeX{}-verbatim-environments
17760 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
17761 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
17762 into the receiver location with name @code{salesfigures}.  You may now
17763 fill in the table---feel free to use the spreadsheet features@footnote{If
17764 the @samp{#+TBLFM} line contains an odd number of dollar characters,
17765 this may cause problems with font-lock in @LaTeX{} mode.  As shown in the
17766 example you can fix this by adding an extra line inside the
17767 @code{comment} environment that is used to balance the dollar
17768 expressions.  If you are using AUC@TeX{} with the font-latex library, a
17769 much better solution is to add the @code{comment} environment to the
17770 variable @code{LaTeX-verbatim-environments}.}:
17772 @example
17773 % BEGIN RECEIVE ORGTBL salesfigures
17774 % END RECEIVE ORGTBL salesfigures
17775 \begin@{comment@}
17776 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17777 | Month | Days | Nr sold | per day |
17778 |-------+------+---------+---------|
17779 | Jan   |   23 |      55 |     2.4 |
17780 | Feb   |   21 |      16 |     0.8 |
17781 | March |   22 |     278 |    12.6 |
17782 #+TBLFM: $4=$3/$2;%.1f
17783 % $ (optional extra dollar to keep font-lock happy, see footnote)
17784 \end@{comment@}
17785 @end example
17787 @noindent
17788 When you are done, press @kbd{C-c C-c} in the table to get the converted
17789 table inserted between the two marker lines.
17791 Now let's assume you want to make the table header by hand, because you
17792 want to control how columns are aligned, etc.  In this case we make sure
17793 that the table translator skips the first 2 lines of the source
17794 table, and tell the command to work as a @i{splice}, i.e., to not produce
17795 header and footer commands of the target table:
17797 @example
17798 \begin@{tabular@}@{lrrr@}
17799 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
17800 % BEGIN RECEIVE ORGTBL salesfigures
17801 % END RECEIVE ORGTBL salesfigures
17802 \end@{tabular@}
17804 \begin@{comment@}
17805 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
17806 | Month | Days | Nr sold | per day |
17807 |-------+------+---------+---------|
17808 | Jan   |   23 |      55 |     2.4 |
17809 | Feb   |   21 |      16 |     0.8 |
17810 | March |   22 |     278 |    12.6 |
17811 #+TBLFM: $4=$3/$2;%.1f
17812 \end@{comment@}
17813 @end example
17815 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
17816 Orgtbl mode.  By default, it uses a @code{tabular} environment to typeset the
17817 table and marks horizontal lines with @code{\hline}.  You can control the
17818 output through several parameters (see also @pxref{Translator functions}),
17819 including the following ones :
17821 @table @code
17822 @item :splice nil/t
17823 When non-@code{nil}, return only table body lines, don't wrap them into a tabular
17824 environment.  Default is @code{nil}.
17826 @item :fmt fmt
17827 A format to be used to wrap each field, it should contain @code{%s} for the
17828 original field value.  For example, to wrap each field value in dollars,
17829 you could use @code{:fmt "$%s$"}.  This may also be a property list with
17830 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
17831 A function of one argument can be used in place of the strings; the
17832 function must return a formatted string.
17834 @item :efmt efmt
17835 Use this format to print numbers with exponentials.  The format should have
17836 @code{%s} twice for inserting mantissa and exponent, for example
17837 @code{"%s\\times10^@{%s@}"}.  This may also be a property list with column
17838 numbers and formats, for example @code{:efmt (2 "$%s\\times10^@{%s@}$"
17839 4 "$%s\\cdot10^@{%s@}$")}.  After @code{efmt} has been applied to a value,
17840 @code{fmt} will also be applied.  Similar to @code{fmt}, functions of two
17841 arguments can be supplied instead of strings.  By default, no special
17842 formatting is applied.
17843 @end table
17845 @node Translator functions
17846 @subsection Translator functions
17847 @cindex HTML, and Orgtbl mode
17848 @cindex translator function
17850 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
17851 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
17852 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, @code{orgtbl-to-texinfo},
17853 @code{orgtbl-to-unicode} and @code{orgtbl-to-orgtbl}.  These all use
17854 a generic translator, @code{orgtbl-to-generic}, which, in turn, can delegate
17855 translations to various export back-ends (@pxref{Export back-ends}).
17857 In particular, properties passed into the function (i.e., the ones set by the
17858 @samp{ORGTBL SEND} line) take precedence over translations defined in the
17859 function.  So if you would like to use the @LaTeX{} translator, but wanted
17860 the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you
17861 could just overrule the default with
17863 @example
17864 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
17865 @end example
17867 For a new language, you can use the generic function to write your own
17868 converter function.  For example, if you have a language where a table is
17869 started with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines
17870 are started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
17871 separator is a TAB, you could define your generic translator like this:
17873 @lisp
17874 (defun orgtbl-to-language (table params)
17875   "Convert the orgtbl-mode TABLE to language."
17876   (orgtbl-to-generic
17877    table
17878    (org-combine-plists
17879     '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
17880     params)))
17881 @end lisp
17883 @noindent
17884 Please check the documentation string of the function
17885 @code{orgtbl-to-generic} for a full list of parameters understood by
17886 that function, and remember that you can pass each of them into
17887 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
17888 using the generic function.
17890 Of course you can also write a completely new function doing complicated
17891 things the generic translator cannot do.  A translator function takes
17892 two arguments.  The first argument is the table, a list of lines, each
17893 line either the symbol @code{hline} or a list of fields.  The second
17894 argument is the property list containing all parameters specified in the
17895 @samp{#+ORGTBL: SEND} line.  The function must return a single string
17896 containing the formatted table.  If you write a generally useful
17897 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
17898 others can benefit from your work.
17900 @node Radio lists
17901 @subsection Radio lists
17902 @cindex radio lists
17903 @cindex org-list-insert-radio-list
17905 Sending and receiving radio lists works exactly the same way as sending and
17906 receiving radio tables (@pxref{Radio tables}).  As for radio tables, you can
17907 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
17908 @code{org-list-insert-radio-list}.
17910 Here are the differences with radio tables:
17912 @itemize @minus
17913 @item
17914 Orgstruct mode must be active.
17915 @item
17916 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
17917 @item
17918 The available translation functions for radio lists don't take
17919 parameters.
17920 @item
17921 @kbd{C-c C-c} will work when pressed on the first item of the list.
17922 @end itemize
17924 Here is a @LaTeX{} example.  Let's say that you have this in your
17925 @LaTeX{} file:
17927 @cindex #+ORGLST
17928 @example
17929 % BEGIN RECEIVE ORGLST to-buy
17930 % END RECEIVE ORGLST to-buy
17931 \begin@{comment@}
17932 #+ORGLST: SEND to-buy org-list-to-latex
17933 - a new house
17934 - a new computer
17935   + a new keyboard
17936   + a new mouse
17937 - a new life
17938 \end@{comment@}
17939 @end example
17941 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
17942 @LaTeX{} list between the two marker lines.
17944 @node Dynamic blocks
17945 @section Dynamic blocks
17946 @cindex dynamic blocks
17948 Org documents can contain @emph{dynamic blocks}.  These are
17949 specially marked regions that are updated by some user-written function.
17950 A good example for such a block is the clock table inserted by the
17951 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
17953 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
17954 to the block and can also specify parameters for the function producing
17955 the content of the block.
17957 @cindex #+BEGIN:dynamic block
17958 @example
17959 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
17961 #+END:
17962 @end example
17964 Dynamic blocks are updated with the following commands
17966 @table @kbd
17967 @orgcmd{C-c C-x C-u,org-dblock-update}
17968 Update dynamic block at point.
17969 @orgkey{C-u C-c C-x C-u}
17970 Update all dynamic blocks in the current file.
17971 @end table
17973 Updating a dynamic block means to remove all the text between BEGIN and
17974 END, parse the BEGIN line for parameters and then call the specific
17975 writer function for this block to insert the new content.  If you want
17976 to use the original content in the writer function, you can use the
17977 extra parameter @code{:content}.
17979 For a block with name @code{myblock}, the writer function is
17980 @code{org-dblock-write:myblock} with as only parameter a property list
17981 with the parameters given in the begin line.  Here is a trivial example
17982 of a block that keeps track of when the block update function was last
17983 run:
17985 @example
17986 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
17988 #+END:
17989 @end example
17991 @noindent
17992 The corresponding block writer function could look like this:
17994 @lisp
17995 (defun org-dblock-write:block-update-time (params)
17996   (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
17997     (insert "Last block update at: "
17998             (format-time-string fmt (current-time)))))
17999 @end lisp
18001 If you want to make sure that all dynamic blocks are always up-to-date,
18002 you could add the function @code{org-update-all-dblocks} to a hook, for
18003 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
18004 written in a way such that it does nothing in buffers that are not in
18005 @code{org-mode}.
18007 You can narrow the current buffer to the current dynamic block (like any
18008 other block) with @code{org-narrow-to-block}.
18010 @node Special agenda views
18011 @section Special agenda views
18012 @cindex agenda views, user-defined
18014 @vindex org-agenda-skip-function
18015 @vindex org-agenda-skip-function-global
18016 Org provides a special hook that can be used to narrow down the selection
18017 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
18018 @code{agenda*} view is the same as @code{agenda} except that it only
18019 considers @emph{appointments}, i.e., scheduled and deadline items that have a
18020 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
18021 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}.  You may
18022 specify a function that is used at each match to verify if the match should
18023 indeed be part of the agenda view, and if not, how much should be skipped.
18024 You can specify a global condition that will be applied to all agenda views,
18025 this condition would be stored in the variable
18026 @code{org-agenda-skip-function-global}.  More commonly, such a definition is
18027 applied only to specific custom searches, using
18028 @code{org-agenda-skip-function}.
18030 Let's say you want to produce a list of projects that contain a WAITING
18031 tag anywhere in the project tree.  Let's further assume that you have
18032 marked all tree headings that define a project with the TODO keyword
18033 PROJECT@.  In this case you would run a TODO search for the keyword
18034 PROJECT, but skip the match unless there is a WAITING tag anywhere in
18035 the subtree belonging to the project line.
18037 To achieve this, you must write a function that searches the subtree for
18038 the tag.  If the tag is found, the function must return @code{nil} to
18039 indicate that this match should not be skipped.  If there is no such
18040 tag, return the location of the end of the subtree, to indicate that
18041 search should continue from there.
18043 @lisp
18044 (defun my-skip-unless-waiting ()
18045   "Skip trees that are not waiting"
18046   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
18047     (if (re-search-forward ":waiting:" subtree-end t)
18048         nil          ; tag found, do not skip
18049       subtree-end))) ; tag not found, continue after end of subtree
18050 @end lisp
18052 Now you may use this function in an agenda custom command, for example
18053 like this:
18055 @lisp
18056 (org-add-agenda-custom-command
18057  '("b" todo "PROJECT"
18058    ((org-agenda-skip-function 'my-skip-unless-waiting)
18059     (org-agenda-overriding-header "Projects waiting for something: "))))
18060 @end lisp
18062 @vindex org-agenda-overriding-header
18063 Note that this also binds @code{org-agenda-overriding-header} to get a
18064 meaningful header in the agenda view.
18066 @vindex org-odd-levels-only
18067 @vindex org-agenda-skip-function
18068 A general way to create custom searches is to base them on a search for
18069 entries with a certain level limit.  If you want to study all entries with
18070 your custom search function, simply do a search for
18071 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
18072 level number corresponds to order in the hierarchy, not to the number of
18073 stars.}, and then use @code{org-agenda-skip-function} to select the entries
18074 you really want to have.
18076 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
18077 particular, you may use the functions @code{org-agenda-skip-entry-if}
18078 and @code{org-agenda-skip-subtree-if} in this form, for example:
18080 @table @code
18081 @item (org-agenda-skip-entry-if 'scheduled)
18082 Skip current entry if it has been scheduled.
18083 @item (org-agenda-skip-entry-if 'notscheduled)
18084 Skip current entry if it has not been scheduled.
18085 @item (org-agenda-skip-entry-if 'deadline)
18086 Skip current entry if it has a deadline.
18087 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
18088 Skip current entry if it has a deadline, or if it is scheduled.
18089 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
18090 Skip current entry if the TODO keyword is TODO or WAITING.
18091 @item (org-agenda-skip-entry-if 'todo 'done)
18092 Skip current entry if the TODO keyword marks a DONE state.
18093 @item (org-agenda-skip-entry-if 'timestamp)
18094 Skip current entry if it has any timestamp, may also be deadline or scheduled.
18095 @anchor{x-agenda-skip-entry-regexp}
18096 @item (org-agenda-skip-entry-if 'regexp "regular expression")
18097 Skip current entry if the regular expression matches in the entry.
18098 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
18099 Skip current entry unless the regular expression matches.
18100 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
18101 Same as above, but check and skip the entire subtree.
18102 @end table
18104 Therefore we could also have written the search for WAITING projects
18105 like this, even without defining a special function:
18107 @lisp
18108 (org-add-agenda-custom-command
18109  '("b" todo "PROJECT"
18110    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
18111                                 'regexp ":waiting:"))
18112     (org-agenda-overriding-header "Projects waiting for something: "))))
18113 @end lisp
18115 @node Speeding up your agendas
18116 @section Speeding up your agendas
18117 @cindex agenda views, optimization
18119 When your Org files grow in both number and size, agenda commands may start
18120 to become slow.  Below are some tips on how to speed up the agenda commands.
18122 @enumerate
18123 @item
18124 Reduce the number of Org agenda files: this will reduce the slowdown caused
18125 by accessing a hard drive.
18126 @item
18127 Reduce the number of DONE and archived headlines: this way the agenda does
18128 not need to skip them.
18129 @item
18130 @vindex org-agenda-dim-blocked-tasks
18131 Inhibit the dimming of blocked tasks:
18132 @lisp
18133 (setq org-agenda-dim-blocked-tasks nil)
18134 @end lisp
18135 @item
18136 @vindex org-startup-folded
18137 @vindex org-agenda-inhibit-startup
18138 Inhibit agenda files startup options:
18139 @lisp
18140 (setq org-agenda-inhibit-startup nil)
18141 @end lisp
18142 @item
18143 @vindex org-agenda-show-inherited-tags
18144 @vindex org-agenda-use-tag-inheritance
18145 Disable tag inheritance in agenda:
18146 @lisp
18147 (setq org-agenda-use-tag-inheritance nil)
18148 @end lisp
18149 @end enumerate
18151 You can set these options for specific agenda views only.  See the docstrings
18152 of these variables for details on why they affect the agenda generation, and
18153 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
18154 page} for further explanations.
18156 @node Extracting agenda information
18157 @section Extracting agenda information
18158 @cindex agenda, pipe
18159 @cindex Scripts, for agenda processing
18161 @vindex org-agenda-custom-commands
18162 Org provides commands to access agenda information for the command
18163 line in Emacs batch mode.  This extracted information can be sent
18164 directly to a printer, or it can be read by a program that does further
18165 processing of the data.  The first of these commands is the function
18166 @code{org-batch-agenda}, that produces an agenda view and sends it as
18167 ASCII text to STDOUT@.  The command takes a single string as parameter.
18168 If the string has length 1, it is used as a key to one of the commands
18169 you have configured in @code{org-agenda-custom-commands}, basically any
18170 key you can use after @kbd{C-c a}.  For example, to directly print the
18171 current TODO list, you could use
18173 @example
18174 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
18175 @end example
18177 If the parameter is a string with 2 or more characters, it is used as a
18178 tags/TODO match string.  For example, to print your local shopping list
18179 (all items with the tag @samp{shop}, but excluding the tag
18180 @samp{NewYork}), you could use
18182 @example
18183 emacs -batch -l ~/.emacs                                      \
18184       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
18185 @end example
18187 @noindent
18188 You may also modify parameters on the fly like this:
18190 @example
18191 emacs -batch -l ~/.emacs                                      \
18192    -eval '(org-batch-agenda "a"                               \
18193             org-agenda-span (quote month)                     \
18194             org-agenda-include-diary nil                      \
18195             org-agenda-files (quote ("~/org/project.org")))'  \
18196    | lpr
18197 @end example
18199 @noindent
18200 which will produce a 30-day agenda, fully restricted to the Org file
18201 @file{~/org/projects.org}, not even including the diary.
18203 If you want to process the agenda data in more sophisticated ways, you
18204 can use the command @code{org-batch-agenda-csv} to get a comma-separated
18205 list of values for each agenda item.  Each line in the output will
18206 contain a number of fields separated by commas.  The fields in a line
18207 are:
18209 @example
18210 category     @r{The category of the item}
18211 head         @r{The headline, without TODO keyword, TAGS and PRIORITY}
18212 type         @r{The type of the agenda entry, can be}
18213                 todo               @r{selected in TODO match}
18214                 tagsmatch          @r{selected in tags match}
18215                 diary              @r{imported from diary}
18216                 deadline           @r{a deadline}
18217                 scheduled          @r{scheduled}
18218                 timestamp          @r{appointment, selected by timestamp}
18219                 closed             @r{entry was closed on date}
18220                 upcoming-deadline  @r{warning about nearing deadline}
18221                 past-scheduled     @r{forwarded scheduled item}
18222                 block              @r{entry has date block including date}
18223 todo         @r{The TODO keyword, if any}
18224 tags         @r{All tags including inherited ones, separated by colons}
18225 date         @r{The relevant date, like 2007-2-14}
18226 time         @r{The time, like 15:00-16:50}
18227 extra        @r{String with extra planning info}
18228 priority-l   @r{The priority letter if any was given}
18229 priority-n   @r{The computed numerical priority}
18230 @end example
18232 @noindent
18233 Time and date will only be given if a timestamp (or deadline/scheduled)
18234 led to the selection of the item.
18236 A CSV list like this is very easy to use in a post-processing script.
18237 For example, here is a Perl program that gets the TODO list from
18238 Emacs/Org and prints all the items, preceded by a checkbox:
18240 @example
18241 #!/usr/bin/perl
18243 # define the Emacs command to run
18244 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
18246 # run it and capture the output
18247 $agenda = qx@{$cmd 2>/dev/null@};
18249 # loop over all lines
18250 foreach $line (split(/\n/,$agenda)) @{
18251   # get the individual values
18252   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
18253    $priority_l,$priority_n) = split(/,/,$line);
18254   # process and print
18255   print "[ ] $head\n";
18257 @end example
18259 @node Using the property API
18260 @section Using the property API
18261 @cindex API, for properties
18262 @cindex properties, API
18264 Here is a description of the functions that can be used to work with
18265 properties.
18267 @defun org-entry-properties &optional pom which
18268 Get all properties of the entry at point-or-marker POM.@*
18269 This includes the TODO keyword, the tags, time strings for deadline,
18270 scheduled, and clocking, and any additional properties defined in the
18271 entry.  The return value is an alist.  Keys may occur multiple times
18272 if the property key was used several times.@*
18273 POM may also be @code{nil}, in which case the current entry is used.
18274 If WHICH is @code{nil} or `all', get all properties.  If WHICH is
18275 `special' or `standard', only get that subclass.
18276 @end defun
18277 @vindex org-use-property-inheritance
18278 @findex org-insert-property-drawer
18279 @defun org-entry-get pom property &optional inherit
18280 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@.  By default,
18281 this only looks at properties defined locally in the entry.  If @code{INHERIT}
18282 is non-@code{nil} and the entry does not have the property, then also check
18283 higher levels of the hierarchy.  If @code{INHERIT} is the symbol
18284 @code{selective}, use inheritance if and only if the setting of
18285 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
18286 @end defun
18288 @defun org-entry-delete pom property
18289 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
18290 @end defun
18292 @defun org-entry-put pom property value
18293 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
18294 @end defun
18296 @defun org-buffer-property-keys &optional include-specials
18297 Get all property keys in the current buffer.
18298 @end defun
18300 @defun org-insert-property-drawer
18301 Insert a property drawer for the current entry.
18302 @end defun
18304 @defun org-entry-put-multivalued-property pom property &rest values
18305 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
18306 @code{VALUES} should be a list of strings.  They will be concatenated, with
18307 spaces as separators.
18308 @end defun
18310 @defun org-entry-get-multivalued-property pom property
18311 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18312 list of values and return the values as a list of strings.
18313 @end defun
18315 @defun org-entry-add-to-multivalued-property pom property value
18316 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18317 list of values and make sure that @code{VALUE} is in this list.
18318 @end defun
18320 @defun org-entry-remove-from-multivalued-property pom property value
18321 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18322 list of values and make sure that @code{VALUE} is @emph{not} in this list.
18323 @end defun
18325 @defun org-entry-member-in-multivalued-property pom property value
18326 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18327 list of values and check if @code{VALUE} is in this list.
18328 @end defun
18330 @defopt org-property-allowed-value-functions
18331 Hook for functions supplying allowed values for a specific property.
18332 The functions must take a single argument, the name of the property, and
18333 return a flat list of allowed values.  If @samp{:ETC} is one of
18334 the values, use the values as completion help, but allow also other values
18335 to be entered.  The functions must return @code{nil} if they are not
18336 responsible for this property.
18337 @end defopt
18339 @node Using the mapping API
18340 @section Using the mapping API
18341 @cindex API, for mapping
18342 @cindex mapping entries, API
18344 Org has sophisticated mapping capabilities to find all entries satisfying
18345 certain criteria.  Internally, this functionality is used to produce agenda
18346 views, but there is also an API that can be used to execute arbitrary
18347 functions for each or selected entries.  The main entry point for this API
18350 @defun org-map-entries func &optional match scope &rest skip
18351 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
18353 @code{FUNC} is a function or a Lisp form.  The function will be called
18354 without arguments, with the cursor positioned at the beginning of the
18355 headline.  The return values of all calls to the function will be collected
18356 and returned as a list.
18358 The call to @code{FUNC} will be wrapped into a save-excursion form, so
18359 @code{FUNC} does not need to preserve point.  After evaluation, the cursor
18360 will be moved to the end of the line (presumably of the headline of the
18361 processed entry) and search continues from there.  Under some circumstances,
18362 this may not produce the wanted results.  For example, if you have removed
18363 (e.g., archived) the current (sub)tree it could mean that the next entry will
18364 be skipped entirely.  In such cases, you can specify the position from where
18365 search should continue by making @code{FUNC} set the variable
18366 @code{org-map-continue-from} to the desired buffer position.
18368 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
18369 view.  Only headlines that are matched by this query will be considered
18370 during the iteration.  When @code{MATCH} is @code{nil} or @code{t}, all
18371 headlines will be visited by the iteration.
18373 @code{SCOPE} determines the scope of this command.  It can be any of:
18375 @example
18376 nil     @r{the current buffer, respecting the restriction if any}
18377 tree    @r{the subtree started with the entry at point}
18378 region  @r{The entries within the active region, if any}
18379 file    @r{the current buffer, without restriction}
18380 file-with-archives
18381         @r{the current buffer, and any archives associated with it}
18382 agenda  @r{all agenda files}
18383 agenda-with-archives
18384         @r{all agenda files with any archive files associated with them}
18385 (file1 file2 ...)
18386         @r{if this is a list, all files in the list will be scanned}
18387 @end example
18388 @noindent
18389 The remaining args are treated as settings for the skipping facilities of
18390 the scanner.  The following items can be given here:
18392 @vindex org-agenda-skip-function
18393 @example
18394 archive   @r{skip trees with the archive tag}
18395 comment   @r{skip trees with the COMMENT keyword}
18396 function or Lisp form
18397           @r{will be used as value for @code{org-agenda-skip-function},}
18398           @r{so whenever the function returns t, FUNC}
18399           @r{will not be called for that entry and search will}
18400           @r{continue from the point where the function leaves it}
18401 @end example
18402 @end defun
18404 The function given to that mapping routine can really do anything you like.
18405 It can use the property API (@pxref{Using the property API}) to gather more
18406 information about the entry, or in order to change metadata in the entry.
18407 Here are a couple of functions that might be handy:
18409 @defun org-todo &optional arg
18410 Change the TODO state of the entry.  See the docstring of the functions for
18411 the many possible values for the argument @code{ARG}.
18412 @end defun
18414 @defun org-priority &optional action
18415 Change the priority of the entry.  See the docstring of this function for the
18416 possible values for @code{ACTION}.
18417 @end defun
18419 @defun org-toggle-tag tag &optional onoff
18420 Toggle the tag @code{TAG} in the current entry.  Setting @code{ONOFF} to
18421 either @code{on} or @code{off} will not toggle tag, but ensure that it is
18422 either on or off.
18423 @end defun
18425 @defun org-promote
18426 Promote the current entry.
18427 @end defun
18429 @defun org-demote
18430 Demote the current entry.
18431 @end defun
18433 Here is a simple example that will turn all entries in the current file with
18434 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
18435 Entries in comment trees and in archive trees will be ignored.
18437 @lisp
18438 (org-map-entries
18439  '(org-todo "UPCOMING")
18440  "+TOMORROW" 'file 'archive 'comment)
18441 @end lisp
18443 The following example counts the number of entries with TODO keyword
18444 @code{WAITING}, in all agenda files.
18446 @lisp
18447 (length (org-map-entries t "/+WAITING" 'agenda))
18448 @end lisp
18450 @node MobileOrg
18451 @appendix MobileOrg
18452 @cindex iPhone
18453 @cindex MobileOrg
18455 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
18456 available for iOS and for Android.  @i{MobileOrg} offers offline viewing and
18457 capture support for an Org mode system rooted on a ``real'' computer.  It
18458 also allows you to record changes to existing entries.  The
18459 @uref{https://github.com/MobileOrg/, iOS implementation} for the
18460 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
18461 and is now in the hands Sean Escriva.  Android users should check out
18462 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
18463 by Matt Jones.  The two implementations are not identical but offer similar
18464 features.
18466 This appendix describes the support Org has for creating agenda views in a
18467 format that can be displayed by @i{MobileOrg}, and for integrating notes
18468 captured and changes made by @i{MobileOrg} into the main system.
18470 For changing tags and TODO states in MobileOrg, you should have set up the
18471 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
18472 cover all important tags and TODO keywords, even if individual files use only
18473 part of these.  MobileOrg will also offer you states and tags set up with
18474 in-buffer settings, but it will understand the logistics of TODO state
18475 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
18476 (@pxref{Setting tags}) only for those set in these variables.
18478 @menu
18479 * Setting up the staging area::  Where to interact with the mobile device
18480 * Pushing to MobileOrg::        Uploading Org files and agendas
18481 * Pulling from MobileOrg::      Integrating captured and flagged items
18482 @end menu
18484 @node Setting up the staging area
18485 @section Setting up the staging area
18487 MobileOrg needs to interact with Emacs through a directory on a server.  If
18488 you are using a public server, you should consider encrypting the files that
18489 are uploaded to the server.  This can be done with Org mode 7.02 and with
18490 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
18491 installation on your system.  To turn on encryption, set a password in
18492 @i{MobileOrg} and, on the Emacs side, configure the variable
18493 @code{org-mobile-use-encryption}@footnote{If you can safely store the
18494 password in your Emacs setup, you might also want to configure
18495 @code{org-mobile-encryption-password}.  Please read the docstring of that
18496 variable.  Note that encryption will apply only to the contents of the
18497 @file{.org} files.  The file names themselves will remain visible.}.
18499 The easiest way to create that directory is to use a free
18500 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
18501 Dropbox, or if your version of MobileOrg does not support it, you can use a
18502 webdav server.  For more information, check out the documentation of MobileOrg and also this
18503 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
18504 When MobileOrg first connects to your Dropbox, it will create a directory
18505 @i{MobileOrg} inside the Dropbox.  After the directory has been created, tell
18506 Emacs about it:
18508 @lisp
18509 (setq org-mobile-directory "~/Dropbox/MobileOrg")
18510 @end lisp
18512 Org mode has commands to put files for @i{MobileOrg} into that directory,
18513 and to read captured notes from there.
18515 @node Pushing to MobileOrg
18516 @section Pushing to MobileOrg
18518 This operation copies all files currently listed in @code{org-mobile-files}
18519 to the directory @code{org-mobile-directory}.  By default this list contains
18520 all agenda files (as listed in @code{org-agenda-files}), but additional files
18521 can be included by customizing @code{org-mobile-files}.  File names will be
18522 staged with paths relative to @code{org-directory}, so all files should be
18523 inside this directory@footnote{Symbolic links in @code{org-directory} need to
18524 have the same name as their targets.}.
18526 The push operation also creates a special Org file @file{agendas.org} with
18527 all custom agenda view defined by the user@footnote{While creating the
18528 agendas, Org mode will force ID properties on all referenced entries, so that
18529 these entries can be uniquely identified if @i{MobileOrg} flags them for
18530 further action.  If you do not want to get these properties in so many
18531 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
18532 to @code{nil}.  Org mode will then rely on outline paths, in the hope that
18533 these will be unique enough.}.
18535 Finally, Org writes the file @file{index.org}, containing links to all other
18536 files.  @i{MobileOrg} first reads this file from the server, and then
18537 downloads all agendas and Org files listed in it.  To speed up the download,
18538 MobileOrg will only read files whose checksums@footnote{Checksums are stored
18539 automatically in the file @file{checksums.dat}} have changed.
18541 @node Pulling from MobileOrg
18542 @section Pulling from MobileOrg
18544 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
18545 files for viewing.  It also appends captured entries and pointers to flagged
18546 and changed entries to the file @file{mobileorg.org} on the server.  Org has
18547 a @emph{pull} operation that integrates this information into an inbox file
18548 and operates on the pointers to flagged entries.  Here is how it works:
18550 @enumerate
18551 @item
18552 Org moves all entries found in
18553 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
18554 operation.} and appends them to the file pointed to by the variable
18555 @code{org-mobile-inbox-for-pull}.  Each captured entry and each editing event
18556 will be a top-level entry in the inbox file.
18557 @item
18558 After moving the entries, Org will attempt to implement the changes made in
18559 @i{MobileOrg}.  Some changes are applied directly and without user
18560 interaction.  Examples are all changes to tags, TODO state, headline and body
18561 text that can be cleanly applied.  Entries that have been flagged for further
18562 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
18563 again.  When there is a problem finding an entry or applying the change, the
18564 pointer entry will remain in the inbox and will be marked with an error
18565 message.  You need to later resolve these issues by hand.
18566 @item
18567 Org will then generate an agenda view with all flagged entries.  The user
18568 should then go through these entries and do whatever actions are necessary.
18569 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
18570 will be displayed in the echo area when the cursor is on the corresponding
18571 agenda line.
18573 @table @kbd
18574 @kindex ?
18575 @item ?
18576 Pressing @kbd{?} in that special agenda will display the full flagging note in
18577 another window and also push it onto the kill ring.  So you could use @kbd{?
18578 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
18579 Pressing @kbd{?} twice in succession will offer to remove the
18580 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
18581 in a property).  In this way you indicate that the intended processing for
18582 this flagged entry is finished.
18583 @end table
18584 @end enumerate
18586 @kindex C-c a ?
18587 If you are not able to process all flagged entries directly, you can always
18588 return to this agenda view@footnote{Note, however, that there is a subtle
18589 difference.  The view created automatically by @kbd{M-x org-mobile-pull RET}
18590 is guaranteed to search all files that have been addressed by the last pull.
18591 This might include a file that is not currently in your list of agenda files.
18592 If you later use @kbd{C-c a ?} to regenerate the view, only the current
18593 agenda files will be searched.} using @kbd{C-c a ?}.
18595 @node History and acknowledgments
18596 @appendix History and acknowledgments
18597 @cindex acknowledgments
18598 @cindex history
18599 @cindex thanks
18601 @section From Carsten
18603 Org was born in 2003, out of frustration over the user interface of the Emacs
18604 Outline mode.  I was trying to organize my notes and projects, and using
18605 Emacs seemed to be the natural way to go.  However, having to remember eleven
18606 different commands with two or three keys per command, only to hide and show
18607 parts of the outline tree, that seemed entirely unacceptable to me.  Also,
18608 when using outlines to take notes, I constantly wanted to restructure the
18609 tree, organizing it parallel to my thoughts and plans.  @emph{Visibility
18610 cycling} and @emph{structure editing} were originally implemented in the
18611 package @file{outline-magic.el}, but quickly moved to the more general
18612 @file{org.el}.  As this environment became comfortable for project planning,
18613 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
18614 @emph{table support}.  These areas highlighted the two main goals that Org
18615 still has today: to be a new, outline-based, plain text mode with innovative
18616 and intuitive editing features, and to incorporate project planning
18617 functionality directly into a notes file.
18619 Since the first release, literally thousands of emails to me or to
18620 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
18621 reports, feedback, new ideas, and sometimes patches and add-on code.
18622 Many thanks to everyone who has helped to improve this package.  I am
18623 trying to keep here a list of the people who had significant influence
18624 in shaping one or more aspects of Org.  The list may not be
18625 complete, if I have forgotten someone, please accept my apologies and
18626 let me know.
18628 Before I get to this list, a few special mentions are in order:
18630 @table @i
18631 @item Bastien Guerry
18632 Bastien has written a large number of extensions to Org (most of them
18633 integrated into the core by now), including the @LaTeX{} exporter and the
18634 plain list parser.  His support during the early days was central to the
18635 success of this project.  Bastien also invented Worg, helped establishing the
18636 Web presence of Org, and sponsored hosting costs for the orgmode.org website.
18637 Bastien stepped in as maintainer of Org between 2011 and 2013, at a time when
18638 I desparately needed a break.
18639 @item Eric Schulte and Dan Davison
18640 Eric and Dan are jointly responsible for the Org-babel system, which turns
18641 Org into a multi-language environment for evaluating code and doing literate
18642 programming and reproducible research.  This has become one of Org's killer
18643 features that define what Org is today.
18644 @item John Wiegley
18645 John has contributed a number of great ideas and patches directly to Org,
18646 including the attachment system (@file{org-attach.el}), integration with
18647 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
18648 items, habit tracking (@file{org-habits.el}), and encryption
18649 (@file{org-crypt.el}).  Also, the capture system is really an extended copy
18650 of his great @file{remember.el}.
18651 @item Sebastian Rose
18652 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
18653 of an ignorant amateur.  Sebastian has pushed this part of Org onto a much
18654 higher level.  He also wrote @file{org-info.js}, a Java script for displaying
18655 web pages derived from Org using an Info-like or a folding interface with
18656 single-key navigation.
18657 @end table
18659 @noindent See below for the full list of contributions!  Again, please
18660 let me know what I am missing here!
18662 @section From Bastien
18664 I (Bastien) have been maintaining Org between 2011 and 2013.  This appendix
18665 would not be complete without adding a few more acknowledgements and thanks.
18667 I am first grateful to Carsten for his trust while handing me over the
18668 maintainership of Org.  His unremitting support is what really helped me
18669 getting more confident over time, with both the community and the code.
18671 When I took over maintainership, I knew I would have to make Org more
18672 collaborative than ever, as I would have to rely on people that are more
18673 knowledgeable than I am on many parts of the code.  Here is a list of the
18674 persons I could rely on, they should really be considered co-maintainers,
18675 either of the code or the community:
18677 @table @i
18678 @item Eric Schulte
18679 Eric is maintaining the Babel parts of Org.  His reactivity here kept me away
18680 from worrying about possible bugs here and let me focus on other parts.
18682 @item Nicolas Goaziou
18683 Nicolas is maintaining the consistency of the deepest parts of Org.  His work
18684 on @file{org-element.el} and @file{ox.el} has been outstanding, and it opened
18685 the doors for many new ideas and features.  He rewrote many of the old
18686 exporters to use the new export engine, and helped with documenting this
18687 major change.  More importantly (if that's possible), he has been more than
18688 reliable during all the work done for Org 8.0, and always very reactive on
18689 the mailing list.
18691 @item Achim Gratz
18692 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
18693 into a flexible and conceptually clean process.  He patiently coped with the
18694 many hiccups that such a change can create for users.
18696 @item Nick Dokos
18697 The Org mode mailing list would not be such a nice place without Nick, who
18698 patiently helped users so many times.  It is impossible to overestimate such
18699 a great help, and the list would not be so active without him.
18700 @end table
18702 I received support from so many users that it is clearly impossible to be
18703 fair when shortlisting a few of them, but Org's history would not be
18704 complete if the ones above were not mentioned in this manual.
18706 @section List of contributions
18708 @itemize @bullet
18710 @item
18711 @i{Russel Adams} came up with the idea for drawers.
18712 @item
18713 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
18714 feedback on many features and several patches.
18715 @item
18716 @i{Luis Anaya} wrote @file{ox-man.el}.
18717 @item
18718 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
18719 @item
18720 @i{Michael Brand} helped by reporting many bugs and testing many features.
18721 He also implemented the distinction between empty fields and 0-value fields
18722 in Org's spreadsheets.
18723 @item
18724 @i{Christophe Bataillon} created the great unicorn logo that we use on the
18725 Org mode website.
18726 @item
18727 @i{Alex Bochannek} provided a patch for rounding timestamps.
18728 @item
18729 @i{Jan Böcker} wrote @file{org-docview.el}.
18730 @item
18731 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
18732 @item
18733 @i{Tom Breton} wrote @file{org-choose.el}.
18734 @item
18735 @i{Charles Cave}'s suggestion sparked the implementation of templates
18736 for Remember, which are now templates for capture.
18737 @item
18738 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
18739 specified time.
18740 @item
18741 @i{Gregory Chernov} patched support for Lisp forms into table
18742 calculations and improved XEmacs compatibility, in particular by porting
18743 @file{nouline.el} to XEmacs.
18744 @item
18745 @i{Sacha Chua} suggested copying some linking code from Planner, and helped
18746 make Org pupular through her blog.
18747 @item
18748 @i{Toby S. Cubitt} contributed to the code for clock formats.
18749 @item
18750 @i{Baoqiu Cui} contributed the first DocBook exporter.  In Org 8.0, we go a
18751 different route: you can now export to Texinfo and export the @file{.texi}
18752 file to DocBook using @code{makeinfo}.
18753 @item
18754 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
18755 came up with the idea of properties, and that there should be an API for
18756 them.
18757 @item
18758 @i{Nick Dokos} tracked down several nasty bugs.
18759 @item
18760 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
18761 inspired some of the early development, including HTML export.  He also
18762 asked for a way to narrow wide table columns.
18763 @item
18764 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
18765 several years now.  He also sponsored the hosting costs until Rackspace
18766 started to host us for free.
18767 @item
18768 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
18769 the Org-Babel documentation into the manual.
18770 @item
18771 @i{Christian Egli} converted the documentation into Texinfo format, inspired
18772 the agenda, patched CSS formatting into the HTML exporter, and wrote
18773 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
18774 @file{ox-taskjuggler.el} for Org 8.0.
18775 @item
18776 @i{David Emery} provided a patch for custom CSS support in exported
18777 HTML agendas.
18778 @item
18779 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
18780 @item
18781 @i{Nic Ferrier} contributed mailcap and XOXO support.
18782 @item
18783 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
18784 @item
18785 @i{John Foerch} figured out how to make incremental search show context
18786 around a match in a hidden outline tree.
18787 @item
18788 @i{Raimar Finken} wrote @file{org-git-line.el}.
18789 @item
18790 @i{Mikael Fornius} works as a mailing list moderator.
18791 @item
18792 @i{Austin Frank} works as a mailing list moderator.
18793 @item
18794 @i{Eric Fraga} drove the development of BEAMER export with ideas and
18795 testing.
18796 @item
18797 @i{Barry Gidden} did proofreading the manual in preparation for the book
18798 publication through Network Theory Ltd.
18799 @item
18800 @i{Niels Giesen} had the idea to automatically archive DONE trees.
18801 @item
18802 @i{Nicolas Goaziou} rewrote much of the plain list code.  He also wrote
18803 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
18804 in implementing a clean framework for Org exporters.
18805 @item
18806 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
18807 @item
18808 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
18809 book.
18810 @item
18811 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
18812 task state change logging, and the clocktable.  His clear explanations have
18813 been critical when we started to adopt the Git version control system.
18814 @item
18815 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
18816 patches.
18817 @item
18818 @i{Phil Jackson} wrote @file{org-irc.el}.
18819 @item
18820 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
18821 folded entries, and column view for properties.
18822 @item
18823 @i{Matt Jones} wrote @i{MobileOrg Android}.
18824 @item
18825 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
18826 @item
18827 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
18828 @item
18829 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it.  He also
18830 provided frequent feedback and some patches.
18831 @item
18832 @i{Matt Lundin} has proposed last-row references for table formulas and named
18833 invisible anchors.  He has also worked a lot on the FAQ.
18834 @item
18835 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
18836 and is a prolific contributor on the mailing list with competent replies,
18837 small fixes and patches.
18838 @item
18839 @i{Jason F. McBrayer} suggested agenda export to CSV format.
18840 @item
18841 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
18842 @item
18843 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
18844 basis.
18845 @item
18846 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
18847 happy.
18848 @item
18849 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
18850 @item
18851 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
18852 and being able to quickly restrict the agenda to a subtree.
18853 @item
18854 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
18855 @item
18856 @i{Greg Newman} refreshed the unicorn logo into its current form.
18857 @item
18858 @i{Tim O'Callaghan} suggested in-file links, search options for general
18859 file links, and TAGS.
18860 @item
18861 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
18862 version of the reference card.
18863 @item
18864 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
18865 into Japanese.
18866 @item
18867 @i{Oliver Oppitz} suggested multi-state TODO items.
18868 @item
18869 @i{Scott Otterson} sparked the introduction of descriptive text for
18870 links, among other things.
18871 @item
18872 @i{Pete Phillips} helped during the development of the TAGS feature, and
18873 provided frequent feedback.
18874 @item
18875 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
18876 generation.
18877 @item
18878 @i{Martin Pohlack} provided the code snippet to bundle character insertion
18879 into bundles of 20 for undo.
18880 @item
18881 @i{Rackspace.com} is hosting our website for free.  Thank you Rackspace!
18882 @item
18883 @i{T.V. Raman} reported bugs and suggested improvements.
18884 @item
18885 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
18886 control.
18887 @item
18888 @i{Paul Rivier} provided the basic implementation of named footnotes.  He
18889 also acted as mailing list moderator for some time.
18890 @item
18891 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
18892 @item
18893 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
18894 conflict with @file{allout.el}.
18895 @item
18896 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
18897 extensive patches.
18898 @item
18899 @i{Philip Rooke} created the Org reference card, provided lots
18900 of feedback, developed and applied standards to the Org documentation.
18901 @item
18902 @i{Christian Schlauer} proposed angular brackets around links, among
18903 other things.
18904 @item
18905 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
18906 enjoy folding in non-org buffers by using Org headlines in comments.
18907 @item
18908 @i{Paul Sexton} wrote @file{org-ctags.el}.
18909 @item
18910 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
18911 @file{organizer-mode.el}.
18912 @item
18913 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
18914 examples, and remote highlighting for referenced code lines.
18915 @item
18916 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
18917 now packaged into Org's @file{contrib} directory.
18918 @item
18919 @i{Daniel Sinder} came up with the idea of internal archiving by locking
18920 subtrees.
18921 @item
18922 @i{Dale Smith} proposed link abbreviations.
18923 @item
18924 @i{James TD Smith} has contributed a large number of patches for useful
18925 tweaks and features.
18926 @item
18927 @i{Adam Spiers} asked for global linking commands, inspired the link
18928 extension system, added support for mairix, and proposed the mapping API.
18929 @item
18930 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
18931 @LaTeX{}, UTF-8, Latin-1 and ASCII.
18932 @item
18933 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
18934 with links transformation to Org syntax.
18935 @item
18936 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
18937 chapter about publishing.
18938 @item
18939 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
18940 @item
18941 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
18942 enabled source code highlighting in Gnus.
18943 @item
18944 @i{Stefan Vollmar} organized a video-recorded talk at the
18945 Max-Planck-Institute for Neurology.  He also inspired the creation of a
18946 concept index for HTML export.
18947 @item
18948 @i{J@"urgen Vollmer} contributed code generating the table of contents
18949 in HTML output.
18950 @item
18951 @i{Samuel Wales} has provided important feedback and bug reports.
18952 @item
18953 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
18954 keyword.
18955 @item
18956 @i{David Wainberg} suggested archiving, and improvements to the linking
18957 system.
18958 @item
18959 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
18960 linking to Gnus.
18961 @item
18962 @i{Roland Winkler} requested additional key bindings to make Org
18963 work on a tty.
18964 @item
18965 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
18966 and contributed various ideas and code snippets.
18967 @end itemize
18970 @node GNU Free Documentation License
18971 @appendix GNU Free Documentation License
18972 @include doclicense.texi
18975 @node Main Index
18976 @unnumbered Concept index
18978 @printindex cp
18980 @node Key Index
18981 @unnumbered Key index
18983 @printindex ky
18985 @node Command and Function Index
18986 @unnumbered Command and function index
18988 @printindex fn
18990 @node Variable Index
18991 @unnumbered Variable index
18993 This is not a complete index of variables and faces, only the ones that are
18994 mentioned in the manual.  For a more complete list, use @kbd{M-x
18995 org-customize @key{RET}} and then click yourself through the tree.
18997 @printindex vr
18999 @bye
19001 @c Local variables:
19002 @c fill-column: 77
19003 @c indent-tabs-mode: nil
19004 @c paragraph-start:    "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[  ]*$"
19005 @c paragraph-separate: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[       \f]*$"
19006 @c End:
19009 @c  LocalWords:  webdavhost pre