Update version 7.8.05
[org-mode/org-mode-NeilSmithlineMods.git] / doc / org.texi
blob5ff9269872a9a075941a817cca2228d0f85e5d36
2 \input texinfo
3 @c %**start of header
4 @setfilename ../../info/org
5 @settitle The Org Manual
7 @set VERSION 7.8.05
8 @set DATE mars 2012
10 @c Use proper quote and backtick for code sections in PDF output
11 @c Cf. Texinfo manual 14.2
12 @set txicodequoteundirected
13 @set txicodequotebacktick
15 @c Version and Contact Info
16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
17 @set AUTHOR Carsten Dominik
18 @set MAINTAINER Carsten Dominik
19 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
21 @c %**end of header
22 @finalout
25 @c -----------------------------------------------------------------------------
27 @c Macro definitions for commands and keys
28 @c =======================================
30 @c The behavior of the key/command macros will depend on the flag cmdnames
31 @c When set, commands names are shown.  When clear, they are not shown.
33 @set cmdnames
35 @c Below we define the following macros for Org key tables:
37 @c orgkey{key}                        A key item
38 @c orgcmd{key,cmd}                    Key with command name
39 @c xorgcmd{key,cmd}                   Key with command name as @itemx
40 @c orgcmdnki{key,cmd}                 Like orgcmd, but do not index the key
41 @c orgcmdtkc{text,key,cmd}            Like orgcmd,special text instead of key
42 @c orgcmdkkc{key1,key2,cmd}           Two keys with one command name, use "or"
43 @c orgcmdkxkc{key1,key2,cmd}          Two keys with one command name, but
44 @c                                    different functions, so format as @itemx
45 @c orgcmdkskc{key1,key2,cmd}          Same as orgcmdkkc, but use "or short"
46 @c xorgcmdkskc{key1,key2,cmd}         Same as previous, but use @itemx
47 @c orgcmdkkcc{key1,key2,cmd1,cmd2}    Two keys and two commands
49 @c a key but no command
50 @c    Inserts:    @item key
51 @macro orgkey{key}
52 @kindex \key\
53 @item @kbd{\key\}
54 @end macro
56 @macro xorgkey{key}
57 @kindex \key\
58 @itemx @kbd{\key\}
59 @end macro
61 @c one key with a command
62 @c   Inserts:    @item KEY               COMMAND
63 @macro orgcmd{key,command}
64 @ifset cmdnames
65 @kindex \key\
66 @findex \command\
67 @iftex
68 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
69 @end iftex
70 @ifnottex
71 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
72 @end ifnottex
73 @end ifset
74 @ifclear cmdnames
75 @kindex \key\
76 @item @kbd{\key\}
77 @end ifclear
78 @end macro
80 @c One key with one command, formatted using @itemx
81 @c   Inserts:    @itemx KEY               COMMAND
82 @macro xorgcmd{key,command}
83 @ifset cmdnames
84 @kindex \key\
85 @findex \command\
86 @iftex
87 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
88 @end iftex
89 @ifnottex
90 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
91 @end ifnottex
92 @end ifset
93 @ifclear cmdnames
94 @kindex \key\
95 @itemx @kbd{\key\}
96 @end ifclear
97 @end macro
99 @c one key with a command, bit do not index the key
100 @c   Inserts:    @item KEY               COMMAND
101 @macro orgcmdnki{key,command}
102 @ifset cmdnames
103 @findex \command\
104 @iftex
105 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
106 @end iftex
107 @ifnottex
108 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
109 @end ifnottex
110 @end ifset
111 @ifclear cmdnames
112 @item @kbd{\key\}
113 @end ifclear
114 @end macro
116 @c one key with a command, and special text to replace key in item
117 @c   Inserts:    @item TEXT                    COMMAND
118 @macro orgcmdtkc{text,key,command}
119 @ifset cmdnames
120 @kindex \key\
121 @findex \command\
122 @iftex
123 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
124 @end iftex
125 @ifnottex
126 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
127 @end ifnottex
128 @end ifset
129 @ifclear cmdnames
130 @kindex \key\
131 @item @kbd{\text\}
132 @end ifclear
133 @end macro
135 @c two keys with one command
136 @c   Inserts:    @item KEY1 or KEY2            COMMAND
137 @macro orgcmdkkc{key1,key2,command}
138 @ifset cmdnames
139 @kindex \key1\
140 @kindex \key2\
141 @findex \command\
142 @iftex
143 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
144 @end iftex
145 @ifnottex
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
147 @end ifnottex
148 @end ifset
149 @ifclear cmdnames
150 @kindex \key1\
151 @kindex \key2\
152 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
153 @end ifclear
154 @end macro
156 @c Two keys with one command name, but different functions, so format as
157 @c @itemx
158 @c   Inserts:    @item KEY1
159 @c               @itemx KEY2                COMMAND
160 @macro orgcmdkxkc{key1,key2,command}
161 @ifset cmdnames
162 @kindex \key1\
163 @kindex \key2\
164 @findex \command\
165 @iftex
166 @item @kbd{\key1\}
167 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
168 @end iftex
169 @ifnottex
170 @item @kbd{\key1\}
171 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
172 @end ifnottex
173 @end ifset
174 @ifclear cmdnames
175 @kindex \key1\
176 @kindex \key2\
177 @item @kbd{\key1\}
178 @itemx @kbd{\key2\}
179 @end ifclear
180 @end macro
182 @c Same as previous, but use "or short"
183 @c   Inserts:    @item KEY1 or short KEY2            COMMAND
184 @macro orgcmdkskc{key1,key2,command}
185 @ifset cmdnames
186 @kindex \key1\
187 @kindex \key2\
188 @findex \command\
189 @iftex
190 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
191 @end iftex
192 @ifnottex
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
194 @end ifnottex
195 @end ifset
196 @ifclear cmdnames
197 @kindex \key1\
198 @kindex \key2\
199 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
200 @end ifclear
201 @end macro
203 @c Same as previous, but use @itemx
204 @c   Inserts:    @itemx KEY1 or short KEY2            COMMAND
205 @macro xorgcmdkskc{key1,key2,command}
206 @ifset cmdnames
207 @kindex \key1\
208 @kindex \key2\
209 @findex \command\
210 @iftex
211 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
212 @end iftex
213 @ifnottex
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
215 @end ifnottex
216 @end ifset
217 @ifclear cmdnames
218 @kindex \key1\
219 @kindex \key2\
220 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
221 @end ifclear
222 @end macro
224 @c two keys with two commands
225 @c   Inserts:    @item KEY1                        COMMAND1
226 @c               @itemx KEY2                       COMMAND2
227 @macro orgcmdkkcc{key1,key2,command1,command2}
228 @ifset cmdnames
229 @kindex \key1\
230 @kindex \key2\
231 @findex \command1\
232 @findex \command2\
233 @iftex
234 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
235 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
236 @end iftex
237 @ifnottex
238 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
239 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
240 @end ifnottex
241 @end ifset
242 @ifclear cmdnames
243 @kindex \key1\
244 @kindex \key2\
245 @item @kbd{\key1\}
246 @itemx @kbd{\key2\}
247 @end ifclear
248 @end macro
249 @c -----------------------------------------------------------------------------
251 @iftex
252 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
253 @end iftex
255 @c Subheadings inside a table.
256 @macro tsubheading{text}
257 @ifinfo
258 @subsubheading \text\
259 @end ifinfo
260 @ifnotinfo
261 @item @b{\text\}
262 @end ifnotinfo
263 @end macro
265 @copying
266 This manual is for Org version @value{VERSION}.
268 Copyright @copyright{} 2004-2011  Free Software Foundation, Inc.
270 @quotation
271 Permission is granted to copy, distribute and/or modify this document
272 under the terms of the GNU Free Documentation License, Version 1.3 or
273 any later version published by the Free Software Foundation; with no
274 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
275 and with the Back-Cover Texts as in (a) below.  A copy of the license
276 is included in the section entitled ``GNU Free Documentation License.''
278 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
279 modify this GNU manual.  Buying copies from the FSF supports it in
280 developing GNU and promoting software freedom.''
282 This document is part of a collection distributed under the GNU Free
283 Documentation License.  If you want to distribute this document
284 separately from the collection, you can do so by adding a copy of the
285 license to the document, as described in section 6 of the license.
286 @end quotation
287 @end copying
289 @dircategory Emacs
290 @direntry
291 * Org Mode: (org).      Outline-based notes management and organizer
292 @end direntry
294 @titlepage
295 @title The Org Manual
297 @subtitle Release @value{VERSION}
298 @author by Carsten Dominik
299 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, Thomas Dye and Jambunathan K.
301 @c The following two commands start the copyright page.
302 @page
303 @vskip 0pt plus 1filll
304 @insertcopying
305 @end titlepage
307 @c Output the table of contents at the beginning.
308 @contents
310 @ifnottex
311 @node Top, Introduction, (dir), (dir)
312 @top Org Mode Manual
314 @insertcopying
315 @end ifnottex
317 @menu
318 * Introduction::                Getting started
319 * Document Structure::          A tree works like your brain
320 * Tables::                      Pure magic for quick formatting
321 * Hyperlinks::                  Notes in context
322 * TODO Items::                  Every tree branch can be a TODO item
323 * Tags::                        Tagging headlines and matching sets of tags
324 * Properties and Columns::      Storing information about an entry
325 * Dates and Times::             Making items useful for planning
326 * Capture - Refile - Archive::  The ins and outs for projects
327 * Agenda Views::                Collecting information into views
328 * Markup::                      Prepare text for rich export
329 * Exporting::                   Sharing and publishing of notes
330 * Publishing::                  Create a web site of linked Org files
331 * Working With Source Code::    Export, evaluate, and tangle code blocks
332 * Miscellaneous::               All the rest which did not fit elsewhere
333 * Hacking::                     How to hack your way around
334 * MobileOrg::                   Viewing and capture on a mobile device
335 * History and Acknowledgments::  How Org came into being
336 * Main Index::                  An index of Org's concepts and features
337 * Key Index::                   Key bindings and where they are described
338 * Command and Function Index::  Command names and some internal functions
339 * Variable Index::              Variables mentioned in the manual
341 @detailmenu
342  --- The Detailed Node Listing ---
344 Introduction
346 * Summary::                     Brief summary of what Org does
347 * Installation::                How to install a downloaded version of Org
348 * Activation::                  How to activate Org for certain buffers
349 * Feedback::                    Bug reports, ideas, patches etc.
350 * Conventions::                 Type-setting conventions in the manual
352 Document structure
354 * Outlines::                    Org is based on Outline mode
355 * Headlines::                   How to typeset Org tree headlines
356 * Visibility cycling::          Show and hide, much simplified
357 * Motion::                      Jumping to other headlines
358 * Structure editing::           Changing sequence and level of headlines
359 * Sparse trees::                Matches embedded in context
360 * Plain lists::                 Additional structure within an entry
361 * Drawers::                     Tucking stuff away
362 * Blocks::                      Folding blocks
363 * Footnotes::                   How footnotes are defined in Org's syntax
364 * Orgstruct mode::              Structure editing outside Org
366 Tables
368 * Built-in table editor::       Simple tables
369 * Column width and alignment::  Overrule the automatic settings
370 * Column groups::               Grouping to trigger vertical lines
371 * Orgtbl mode::                 The table editor as minor mode
372 * The spreadsheet::             The table editor has spreadsheet capabilities
373 * Org-Plot::                    Plotting from org tables
375 The spreadsheet
377 * References::                  How to refer to another field or range
378 * Formula syntax for Calc::     Using Calc to compute stuff
379 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
380 * Durations and time values::   How to compute durations and time values
381 * Field and range formulas::    Formula for specific (ranges of) fields
382 * Column formulas::             Formulas valid for an entire column
383 * Editing and debugging formulas::  Fixing formulas
384 * Updating the table::          Recomputing all dependent fields
385 * Advanced features::           Field and column names, parameters and automatic recalc
387 Hyperlinks
389 * Link format::                 How links in Org are formatted
390 * Internal links::              Links to other places in the current file
391 * External links::              URL-like links to the world
392 * Handling links::              Creating, inserting and following
393 * Using links outside Org::     Linking from my C source code?
394 * Link abbreviations::          Shortcuts for writing complex links
395 * Search options::              Linking to a specific location
396 * Custom searches::             When the default search is not enough
398 Internal links
400 * Radio targets::               Make targets trigger links in plain text
402 TODO items
404 * TODO basics::                 Marking and displaying TODO entries
405 * TODO extensions::             Workflow and assignments
406 * Progress logging::            Dates and notes for progress
407 * Priorities::                  Some things are more important than others
408 * Breaking down tasks::         Splitting a task into manageable pieces
409 * Checkboxes::                  Tick-off lists
411 Extended use of TODO keywords
413 * Workflow states::             From TODO to DONE in steps
414 * TODO types::                  I do this, Fred does the rest
415 * Multiple sets in one file::   Mixing it all, and still finding your way
416 * Fast access to TODO states::  Single letter selection of a state
417 * Per-file keywords::           Different files, different requirements
418 * Faces for TODO keywords::     Highlighting states
419 * TODO dependencies::           When one task needs to wait for others
421 Progress logging
423 * Closing items::               When was this entry marked DONE?
424 * Tracking TODO state changes::  When did the status change?
425 * Tracking your habits::        How consistent have you been?
427 Tags
429 * Tag inheritance::             Tags use the tree structure of the outline
430 * Setting tags::                How to assign tags to a headline
431 * Tag searches::                Searching for combinations of tags
433 Properties and columns
435 * Property syntax::             How properties are spelled out
436 * Special properties::          Access to other Org mode features
437 * Property searches::           Matching property values
438 * Property inheritance::        Passing values down the tree
439 * Column view::                 Tabular viewing and editing
440 * Property API::                Properties for Lisp programmers
442 Column view
444 * Defining columns::            The COLUMNS format property
445 * Using column view::           How to create and use column view
446 * Capturing column view::       A dynamic block for column view
448 Defining columns
450 * Scope of column definitions::  Where defined, where valid?
451 * Column attributes::           Appearance and content of a column
453 Dates and times
455 * Timestamps::                  Assigning a time to a tree entry
456 * Creating timestamps::         Commands which insert timestamps
457 * Deadlines and scheduling::    Planning your work
458 * Clocking work time::          Tracking how long you spend on a task
459 * Effort estimates::            Planning work effort in advance
460 * Relative timer::              Notes with a running timer
461 * Countdown timer::             Starting a countdown timer for a task
463 Creating timestamps
465 * The date/time prompt::        How Org mode helps you entering date and time
466 * Custom time format::          Making dates look different
468 Deadlines and scheduling
470 * Inserting deadline/schedule::  Planning items
471 * Repeated tasks::              Items that show up again and again
473 Clocking work time
475 * Clocking commands::           Starting and stopping a clock
476 * The clock table::             Detailed reports
477 * Resolving idle time::         Resolving time when you've been idle
479 Capture - Refile - Archive
481 * Capture::                     Capturing new stuff
482 * Attachments::                 Add files to tasks
483 * RSS Feeds::                   Getting input from RSS feeds
484 * Protocols::                   External (e.g.@: Browser) access to Emacs and Org
485 * Refiling notes::              Moving a tree from one place to another
486 * Archiving::                   What to do with finished projects
488 Capture
490 * Setting up capture::          Where notes will be stored
491 * Using capture::               Commands to invoke and terminate capture
492 * Capture templates::           Define the outline of different note types
494 Capture templates
496 * Template elements::           What is needed for a complete template entry
497 * Template expansion::          Filling in information about time and context
499 Archiving
501 * Moving subtrees::             Moving a tree to an archive file
502 * Internal archiving::          Switch off a tree but keep it in the file
504 Agenda views
506 * Agenda files::                Files being searched for agenda information
507 * Agenda dispatcher::           Keyboard access to agenda views
508 * Built-in agenda views::       What is available out of the box?
509 * Presentation and sorting::    How agenda items are prepared for display
510 * Agenda commands::             Remote editing of Org trees
511 * Custom agenda views::         Defining special searches and views
512 * Exporting Agenda Views::      Writing a view to a file
513 * Agenda column view::          Using column view for collected entries
515 The built-in agenda views
517 * Weekly/daily agenda::         The calendar page with current tasks
518 * Global TODO list::            All unfinished action items
519 * Matching tags and properties::  Structured information with fine-tuned search
520 * Timeline::                    Time-sorted view for single file
521 * Search view::                 Find entries by searching for text
522 * Stuck projects::              Find projects you need to review
524 Presentation and sorting
526 * Categories::                  Not all tasks are equal
527 * Time-of-day specifications::  How the agenda knows the time
528 * Sorting of agenda items::     The order of things
530 Custom agenda views
532 * Storing searches::            Type once, use often
533 * Block agenda::                All the stuff you need in a single buffer
534 * Setting Options::             Changing the rules
536 Markup for rich export
538 * Structural markup elements::  The basic structure as seen by the exporter
539 * Images and tables::           Tables and Images will be included
540 * Literal examples::            Source code examples with special formatting
541 * Include files::               Include additional files into a document
542 * Index entries::               Making an index
543 * Macro replacement::           Use macros to create complex output
544 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
546 Structural markup elements
548 * Document title::              Where the title is taken from
549 * Headings and sections::       The document structure as seen by the exporter
550 * Table of contents::           The if and where of the table of contents
551 * Initial text::                Text before the first heading?
552 * Lists::                       Lists
553 * Paragraphs::                  Paragraphs
554 * Footnote markup::             Footnotes
555 * Emphasis and monospace::      Bold, italic, etc.
556 * Horizontal rules::            Make a line
557 * Comment lines::               What will *not* be exported
559 Embedded @LaTeX{}
561 * Special symbols::             Greek letters and other symbols
562 * Subscripts and superscripts::  Simple syntax for raising/lowering text
563 * @LaTeX{} fragments::             Complex formulas made easy
564 * Previewing @LaTeX{} fragments::  What will this snippet look like?
565 * CDLaTeX mode::                Speed up entering of formulas
567 Exporting
569 * Selective export::            Using tags to select and exclude trees
570 * Export options::              Per-file export settings
571 * The export dispatcher::       How to access exporter commands
572 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
573 * HTML export::                 Exporting to HTML
574 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
575 * DocBook export::              Exporting to DocBook
576 * OpenDocument Text export::    Exporting to OpenDocument Text
577 * TaskJuggler export::          Exporting to TaskJuggler
578 * Freemind export::             Exporting to Freemind mind maps
579 * XOXO export::                 Exporting to XOXO
580 * iCalendar export::            Exporting in iCalendar format
582 HTML export
584 * HTML Export commands::        How to invoke HTML export
585 * HTML preamble and postamble::  How to insert a preamble and a postamble
586 * Quoting HTML tags::           Using direct HTML in Org mode
587 * Links in HTML export::        How links will be interpreted and formatted
588 * Tables in HTML export::       How to modify the formatting of tables
589 * Images in HTML export::       How to insert figures into HTML output
590 * Math formatting in HTML export::  Beautiful math also on the web
591 * Text areas in HTML export::   An alternative way to show an example
592 * CSS support::                 Changing the appearance of the output
593 * JavaScript support::          Info and Folding in a web browser
595 @LaTeX{} and PDF export
597 * @LaTeX{}/PDF export commands::
598 * Header and sectioning::       Setting up the export file structure
599 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
600 * Tables in @LaTeX{} export::   Options for exporting tables to @LaTeX{}
601 * Images in @LaTeX{} export::   How to insert figures into @LaTeX{} output
602 * Beamer class export::         Turning the file into a presentation
604 DocBook export
606 * DocBook export commands::     How to invoke DocBook export
607 * Quoting DocBook code::        Incorporating DocBook code in Org files
608 * Recursive sections::          Recursive sections in DocBook
609 * Tables in DocBook export::    Tables are exported as HTML tables
610 * Images in DocBook export::    How to insert figures into DocBook output
611 * Special characters::          How to handle special characters
613 OpenDocument Text export
615 * Pre-requisites for ODT export::  What packages ODT exporter relies on
616 * ODT export commands::  How to invoke ODT export
617 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
618 * Applying custom styles::      How to apply custom styles to the output
619 * Links in ODT export::  How links will be interpreted and formatted
620 * Tables in ODT export::  How Tables are exported
621 * Images in ODT export::  How to insert images
622 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
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 Publishing
641 * Configuration::               Defining projects
642 * Uploading files::             How to get files up on the server
643 * Sample configuration::        Example projects
644 * Triggering publication::      Publication commands
646 Configuration
648 * Project alist::               The central configuration variable
649 * Sources and destinations::    From here to there
650 * Selecting files::             What files are part of the project?
651 * Publishing action::           Setting the function doing the publishing
652 * Publishing options::          Tweaking HTML/@LaTeX{} export
653 * Publishing links::            Which links keep working after publishing?
654 * Sitemap::                     Generating a list of all pages
655 * Generating an index::         An index that reaches across pages
657 Sample configuration
659 * Simple example::              One-component publishing
660 * Complex example::             A multi-component publishing example
662 Working with source code
664 * Structure of code blocks::    Code block syntax described
665 * Editing source code::         Language major-mode editing
666 * Exporting code blocks::       Export contents and/or results
667 * Extracting source code::      Create pure source code files
668 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
669 * Library of Babel::            Use and contribute to a library of useful code blocks
670 * Languages::                   List of supported code block languages
671 * Header arguments::            Configure code block functionality
672 * Results of evaluation::       How evaluation results are handled
673 * Noweb reference syntax::      Literate programming in Org mode
674 * Key bindings and useful functions::  Work quickly with code blocks
675 * Batch execution::             Call functions from the command line
677 Header arguments
679 * Using header arguments::      Different ways to set header arguments
680 * Specific header arguments::   List of header arguments
682 Using header arguments
684 * System-wide header arguments::  Set global default values
685 * Language-specific header arguments::  Set default values by language
686 * Buffer-wide header arguments::  Set default values for a specific buffer
687 * Header arguments in Org mode properties::  Set default values for a buffer or heading
688 * Code block specific header arguments::  The most common way to set values
689 * Header arguments in function calls::  The most specific level
691 Specific header arguments
693 * var::                         Pass arguments to code blocks
694 * results::                     Specify the type of results and how they will
695                                 be collected and handled
696 * file::                        Specify a path for file output
697 * dir::                         Specify the default (possibly remote)
698                                 directory for code block execution
699 * exports::                     Export code and/or results
700 * tangle::                      Toggle tangling and specify file name
701 * mkdirp::                      Toggle creation of parent directories of target
702                                 files during tangling
703 * comments::                    Toggle insertion of comments in tangled
704                                 code files
705 * padline::                     Control insertion of padding lines in tangled
706                                 code files
707 * no-expand::                   Turn off variable assignment and noweb
708                                 expansion during tangling
709 * session::                     Preserve the state of code evaluation
710 * noweb::                       Toggle expansion of noweb references
711 * noweb-ref::                   Specify block's noweb reference resolution target
712 * noweb-sep::                   String used to separate noweb references
713 * cache::                       Avoid re-evaluating unchanged code blocks
714 * sep::                         Delimiter for writing tabular results outside Org
715 * hlines::                      Handle horizontal lines in tables
716 * colnames::                    Handle column names in tables
717 * rownames::                    Handle row names in tables
718 * shebang::                     Make tangled files executable
719 * eval::                        Limit evaluation of specific code blocks
721 Miscellaneous
723 * Completion::                  M-TAB knows what you need
724 * Easy Templates::              Quick insertion of structural elements
725 * Speed keys::                  Electric commands at the beginning of a headline
726 * Code evaluation security::    Org mode files evaluate inline code
727 * Customization::               Adapting Org to your taste
728 * In-buffer settings::          Overview of the #+KEYWORDS
729 * The very busy C-c C-c key::   When in doubt, press C-c C-c
730 * Clean view::                  Getting rid of leading stars in the outline
731 * TTY keys::                    Using Org on a tty
732 * Interaction::                 Other Emacs packages
733 * org-crypt.el::                Encrypting Org files
735 Interaction with other packages
737 * Cooperation::                 Packages Org cooperates with
738 * Conflicts::                   Packages that lead to conflicts
740 Hacking
742 * Hooks::                       Who to reach into Org's internals
743 * Add-on packages::             Available extensions
744 * Adding hyperlink types::      New custom link types
745 * Context-sensitive commands::  How to add functionality to such commands
746 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
747 * Dynamic blocks::              Automatically filled blocks
748 * Special agenda views::        Customized views
749 * Extracting agenda information::  Postprocessing of agenda information
750 * Using the property API::      Writing programs that use entry properties
751 * Using the mapping API::       Mapping over all or selected entries
753 Tables and lists in arbitrary syntax
755 * Radio tables::                Sending and receiving radio tables
756 * A @LaTeX{} example::          Step by step, almost a tutorial
757 * Translator functions::        Copy and modify
758 * Radio lists::                 Doing the same for lists
760 MobileOrg
762 * Setting up the staging area::  Where to interact with the mobile device
763 * Pushing to MobileOrg::        Uploading Org files and agendas
764 * Pulling from MobileOrg::      Integrating captured and flagged items
766 @end detailmenu
767 @end menu
769 @node Introduction, Document Structure, Top, Top
770 @chapter Introduction
771 @cindex introduction
773 @menu
774 * Summary::                     Brief summary of what Org does
775 * Installation::                How to install a downloaded version of Org
776 * Activation::                  How to activate Org for certain buffers
777 * Feedback::                    Bug reports, ideas, patches etc.
778 * Conventions::                 Type-setting conventions in the manual
779 @end menu
781 @node Summary, Installation, Introduction, Introduction
782 @section Summary
783 @cindex summary
785 Org is a mode for keeping notes, maintaining TODO lists, and doing
786 project planning with a fast and effective plain-text system.
788 Org develops organizational tasks around NOTES files that contain
789 lists or information about projects as plain text.  Org is
790 implemented on top of Outline mode, which makes it possible to keep the
791 content of large files well structured.  Visibility cycling and
792 structure editing help to work with the tree.  Tables are easily created
793 with a built-in table editor.  Org supports TODO items, deadlines,
794 timestamps, and scheduling.  It dynamically compiles entries into an
795 agenda that utilizes and smoothly integrates much of the Emacs calendar
796 and diary.  Plain text URL-like links connect to websites, emails,
797 Usenet messages, BBDB entries, and any files related to the projects.
798 For printing and sharing of notes, an Org file can be exported as a
799 structured ASCII file, as HTML, or (TODO and agenda items only) as an
800 iCalendar file.  It can also serve as a publishing tool for a set of
801 linked web pages.
803 As a project planning environment, Org works by adding metadata to outline
804 nodes.  Based on this data, specific entries can be extracted in queries and
805 create dynamic @i{agenda views}.
807 Org mode contains the Org Babel environment which allows you to work with
808 embedded source code blocks in a file, to facilitate code evaluation,
809 documentation, and literate programming techniques.
811 Org's automatic, context-sensitive table editor with spreadsheet
812 capabilities can be integrated into any major mode by activating the
813 minor Orgtbl mode.  Using a translation step, it can be used to maintain
814 tables in arbitrary file types, for example in @LaTeX{}.  The structure
815 editing and list creation capabilities can be used outside Org with
816 the minor Orgstruct mode.
818 Org keeps simple things simple.  When first fired up, it should
819 feel like a straightforward, easy to use outliner.  Complexity is not
820 imposed, but a large amount of functionality is available when you need
821 it.  Org is a toolbox and can be used in different ways and for different
822 ends, for example:
824 @example
825 @r{@bullet{} an outline extension with visibility cycling and structure editing}
826 @r{@bullet{} an ASCII system and table editor for taking structured notes}
827 @r{@bullet{} a TODO list editor}
828 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
829 @pindex GTD, Getting Things Done
830 @r{@bullet{} an environment in which to implement David Allen's GTD system}
831 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
832 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
833 @r{@bullet{} an environment for literate programming}
834 @end example
837 @cindex FAQ
838 There is a website for Org which provides links to the newest
839 version of Org, as well as additional information, frequently asked
840 questions (FAQ), links to tutorials, etc@.  This page is located at
841 @uref{http://orgmode.org}.
843 @cindex print edition
844 The version 7.3 of this manual is available as a
845 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
846 Theory Ltd.}
848 @page
851 @node Installation, Activation, Summary, Introduction
852 @section Installation
853 @cindex installation
854 @cindex XEmacs
856 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
857 distribution or an XEmacs package, please skip this section and go directly
858 to @ref{Activation}.  To see what version of Org (if any) is part of your
859 Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x
860 org-version}.}
862 If you have downloaded Org from the Web, either as a distribution @file{.zip}
863 or @file{.tar} file, or as a Git archive, you must take the following steps
864 to install it: go into the unpacked Org distribution directory and edit the
865 top section of the file @file{Makefile}.  You must set the name of the Emacs
866 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
867 directories where local Lisp and Info files are kept.  If you don't have
868 access to the system-wide directories, you can simply run Org directly from
869 the distribution directory by adding the @file{lisp} subdirectory to the
870 Emacs load path.  To do this, add the following line to @file{.emacs}:
872 @example
873 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
874 @end example
876 @noindent
877 If you plan to use code from the @file{contrib} subdirectory, do a similar
878 step for this directory:
880 @example
881 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
882 @end example
884 @noindent Now byte-compile the Lisp files with the shell command:
886 @example
887 make
888 @end example
890 @noindent If you are running Org from the distribution directory, this is
891 all.  If you want to install Org into the system directories, use (as
892 administrator)
894 @example
895 make install
896 @end example
898 Installing Info files is system dependent, because of differences in the
899 @file{install-info} program.  The following should correctly install the Info
900 files on most systems, please send a bug report if not@footnote{The output
901 from install-info (if any) is also system dependent.  In particular Debian
902 and its derivatives use two different versions of install-info and you may
903 see the message:
905 @example
906 This is not dpkg install-info anymore, but GNU install-info
907 See the man page for ginstall-info for command line arguments
908 @end example
910 @noindent which can be safely ignored.}.
912 @example
913 make install-info
914 @end example
916 Then add the following line to @file{.emacs}.  It is needed so that
917 Emacs can autoload functions that are located in files not immediately loaded
918 when Org mode starts.
919 @lisp
920 (require 'org-install)
921 @end lisp
923 Do not forget to activate Org as described in the following section.
924 @page
926 @node Activation, Feedback, Installation, Introduction
927 @section Activation
928 @cindex activation
929 @cindex autoload
930 @cindex global key bindings
931 @cindex key bindings, global
933 To make sure files with extension @file{.org} use Org mode, add the following
934 line to your @file{.emacs} file.
935 @lisp
936 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
937 @end lisp
938 @noindent Org mode buffers need font-lock to be turned on - this is the
939 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
940 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
942 The four Org commands @command{org-store-link}, @command{org-capture},
943 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
944 global keys (i.e.@: anywhere in Emacs, not just in Org buffers).  Here are
945 suggested bindings for these keys, please modify the keys to your own
946 liking.
947 @lisp
948 (global-set-key "\C-cl" 'org-store-link)
949 (global-set-key "\C-cc" 'org-capture)
950 (global-set-key "\C-ca" 'org-agenda)
951 (global-set-key "\C-cb" 'org-iswitchb)
952 @end lisp
954 @cindex Org mode, turning on
955 With this setup, all files with extension @samp{.org} will be put
956 into Org mode.  As an alternative, make the first line of a file look
957 like this:
959 @example
960 MY PROJECTS    -*- mode: org; -*-
961 @end example
963 @vindex org-insert-mode-line-in-empty-file
964 @noindent which will select Org mode for this buffer no matter what
965 the file's name is.  See also the variable
966 @code{org-insert-mode-line-in-empty-file}.
968 Many commands in Org work on the region if the region is @i{active}.  To make
969 use of this, you need to have @code{transient-mark-mode}
970 (@code{zmacs-regions} in XEmacs) turned on.  In Emacs 23 this is the default,
971 in Emacs 22 you need to do this yourself with
972 @lisp
973 (transient-mark-mode 1)
974 @end lisp
975 @noindent If you do not like @code{transient-mark-mode}, you can create an
976 active region by using the mouse to select a region, or pressing
977 @kbd{C-@key{SPC}} twice before moving the cursor.
979 @node Feedback, Conventions, Activation, Introduction
980 @section Feedback
981 @cindex feedback
982 @cindex bug reports
983 @cindex maintainer
984 @cindex author
986 If you find problems with Org, or if you have questions, remarks, or ideas
987 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
988 If you are not a member of the mailing list, your mail will be passed to the
989 list after a moderator has approved it@footnote{Please consider subscribing
990 to the mailing list, in order to minimize the work the mailing list
991 moderators have to do.}.
993 For bug reports, please first try to reproduce the bug with the latest
994 version of Org available---if you are running an outdated version, it is
995 quite possible that the bug has been fixed already.  If the bug persists,
996 prepare a report and provide as much information as possible, including the
997 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
998 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
999 @file{.emacs}.  The easiest way to do this is to use the command
1000 @example
1001 @kbd{M-x org-submit-bug-report}
1002 @end example
1003 @noindent which will put all this information into an Emacs mail buffer so
1004 that you only need to add your description.  If you re not sending the Email
1005 from within Emacs, please copy and paste the content into your Email program.
1007 Sometimes you might face a problem due to an error in your Emacs or Org mode
1008 setup.  Before reporting a bug, it is very helpful to start Emacs with minimal
1009 customisations and reproduce the problem.  Doing so often helps you determine
1010 if the problem is with your customization or with Org mode itself.  You can
1011 start a typical minimal session with a command like the example below.
1013 @example
1014 $ emacs -Q -l /path/to/minimal-org.el
1015 @end example
1017 However if you are using Org mode as distributed with Emacs, a minimal setup
1018 is not necessary.  In that case it is sufficient to start Emacs as @code{emacs
1019 -Q}.  The @code{minimal-org.el} setup file can have contents as shown below.
1021 @example
1022 ;;; Minimal setup to load latest `org-mode'
1024 ;; activate debugging
1025 (setq debug-on-error t
1026       debug-on-signal nil
1027       debug-on-quit nil)
1029 ;; add latest org-mode to load path
1030 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1031 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp"))
1033 ;; activate org
1034 (require 'org-install)
1035 @end example
1037 If an error occurs, a backtrace can be very useful (see below on how to
1038 create one).  Often a small example file helps, along with clear information
1039 about:
1041 @enumerate
1042 @item What exactly did you do?
1043 @item What did you expect to happen?
1044 @item What happened instead?
1045 @end enumerate
1046 @noindent Thank you for helping to improve this program.
1048 @subsubheading How to create a useful backtrace
1050 @cindex backtrace of an error
1051 If working with Org produces an error with a message you don't
1052 understand, you may have hit a bug.  The best way to report this is by
1053 providing, in addition to what was mentioned above, a @emph{backtrace}.
1054 This is information from the built-in debugger about where and how the
1055 error occurred.  Here is how to produce a useful backtrace:
1057 @enumerate
1058 @item
1059 Reload uncompiled versions of all Org mode Lisp files.  The backtrace
1060 contains much more information if it is produced with uncompiled code.
1061 To do this, use
1062 @example
1063 C-u M-x org-reload RET
1064 @end example
1065 @noindent
1066 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1067 menu.
1068 @item
1069 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1070 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1071 @item
1072 Do whatever you have to do to hit the error.  Don't forget to
1073 document the steps you take.
1074 @item
1075 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1076 screen.  Save this buffer to a file (for example using @kbd{C-x C-w}) and
1077 attach it to your bug report.
1078 @end enumerate
1080 @node Conventions,  , Feedback, Introduction
1081 @section Typesetting conventions used in this manual
1083 Org uses three types of keywords: TODO keywords, tags, and property
1084 names.  In this manual we use the following conventions:
1086 @table @code
1087 @item TODO
1088 @itemx WAITING
1089 TODO keywords are written with all capitals, even if they are
1090 user-defined.
1091 @item boss
1092 @itemx ARCHIVE
1093 User-defined tags are written in lowercase; built-in tags with special
1094 meaning are written with all capitals.
1095 @item Release
1096 @itemx PRIORITY
1097 User-defined properties are capitalized; built-in properties with
1098 special meaning are written with all capitals.
1099 @end table
1101 The manual lists both the keys and the corresponding commands for accessing
1102 functionality.  Org mode often uses the same key for different functions,
1103 depending on context.  The command that is bound to such keys has a generic
1104 name, like @code{org-metaright}.  In the manual we will, wherever possible,
1105 give the function that is internally called by the generic command.  For
1106 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1107 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1108 be listed to call org-table-move-column-right.
1110 If you prefer, you can compile the manual without the command names by
1111 unsetting the flag @code{cmdnames} in @file{org.texi}.
1113 @node Document Structure, Tables, Introduction, Top
1114 @chapter Document structure
1115 @cindex document structure
1116 @cindex structure of document
1118 Org is based on Outline mode and provides flexible commands to
1119 edit the structure of the document.
1121 @menu
1122 * Outlines::                    Org is based on Outline mode
1123 * Headlines::                   How to typeset Org tree headlines
1124 * Visibility cycling::          Show and hide, much simplified
1125 * Motion::                      Jumping to other headlines
1126 * Structure editing::           Changing sequence and level of headlines
1127 * Sparse trees::                Matches embedded in context
1128 * Plain lists::                 Additional structure within an entry
1129 * Drawers::                     Tucking stuff away
1130 * Blocks::                      Folding blocks
1131 * Footnotes::                   How footnotes are defined in Org's syntax
1132 * Orgstruct mode::              Structure editing outside Org
1133 @end menu
1135 @node Outlines, Headlines, Document Structure, Document Structure
1136 @section Outlines
1137 @cindex outlines
1138 @cindex Outline mode
1140 Org is implemented on top of Outline mode.  Outlines allow a
1141 document to be organized in a hierarchical structure, which (at least
1142 for me) is the best representation of notes and thoughts.  An overview
1143 of this structure is achieved by folding (hiding) large parts of the
1144 document to show only the general document structure and the parts
1145 currently being worked on.  Org greatly simplifies the use of
1146 outlines by compressing the entire show/hide functionality into a single
1147 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1149 @node Headlines, Visibility cycling, Outlines, Document Structure
1150 @section Headlines
1151 @cindex headlines
1152 @cindex outline tree
1153 @vindex org-special-ctrl-a/e
1154 @vindex org-special-ctrl-k
1155 @vindex org-ctrl-k-protect-subtree
1157 Headlines define the structure of an outline tree.  The headlines in Org
1158 start with one or more stars, on the left margin@footnote{See the variables
1159 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1160 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1161 @kbd{C-e}, and @kbd{C-k} in headlines.}.  For example:
1163 @example
1164 * Top level headline
1165 ** Second level
1166 *** 3rd level
1167     some text
1168 *** 3rd level
1169     more text
1171 * Another top level headline
1172 @end example
1174 @noindent Some people find the many stars too noisy and would prefer an
1175 outline that has whitespace followed by a single star as headline
1176 starters.  @ref{Clean view}, describes a setup to realize this.
1178 @vindex org-cycle-separator-lines
1179 An empty line after the end of a subtree is considered part of it and
1180 will be hidden when the subtree is folded.  However, if you leave at
1181 least two empty lines, one empty line will remain visible after folding
1182 the subtree, in order to structure the collapsed view.  See the
1183 variable @code{org-cycle-separator-lines} to modify this behavior.
1185 @node Visibility cycling, Motion, Headlines, Document Structure
1186 @section Visibility cycling
1187 @cindex cycling, visibility
1188 @cindex visibility cycling
1189 @cindex trees, visibility
1190 @cindex show hidden text
1191 @cindex hide text
1193 Outlines make it possible to hide parts of the text in the buffer.
1194 Org uses just two commands, bound to @key{TAB} and
1195 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1197 @cindex subtree visibility states
1198 @cindex subtree cycling
1199 @cindex folded, subtree visibility state
1200 @cindex children, subtree visibility state
1201 @cindex subtree, subtree visibility state
1202 @table @asis
1203 @orgcmd{@key{TAB},org-cycle}
1204 @emph{Subtree cycling}: Rotate current subtree among the states
1206 @example
1207 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1208 '-----------------------------------'
1209 @end example
1211 @vindex org-cycle-emulate-tab
1212 @vindex org-cycle-global-at-bob
1213 The cursor must be on a headline for this to work@footnote{see, however,
1214 the option @code{org-cycle-emulate-tab}.}.  When the cursor is at the
1215 beginning of the buffer and the first line is not a headline, then
1216 @key{TAB} actually runs global cycling (see below)@footnote{see the
1217 option @code{org-cycle-global-at-bob}.}.  Also when called with a prefix
1218 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1220 @cindex global visibility states
1221 @cindex global cycling
1222 @cindex overview, global visibility state
1223 @cindex contents, global visibility state
1224 @cindex show all, global visibility state
1225 @orgcmd{S-@key{TAB},org-global-cycle}
1226 @itemx C-u @key{TAB}
1227 @emph{Global cycling}: Rotate the entire buffer among the states
1229 @example
1230 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1231 '--------------------------------------'
1232 @end example
1234 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1235 CONTENTS view up to headlines of level N will be shown.  Note that inside
1236 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1238 @cindex show all, command
1239 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1240 Show all, including drawers.
1241 @orgcmd{C-c C-r,org-reveal}
1242 Reveal context around point, showing the current entry, the following heading
1243 and the hierarchy above.  Useful for working near a location that has been
1244 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1245 (@pxref{Agenda commands}).  With a prefix argument show, on each
1246 level, all sibling headings.  With a double prefix argument, also show the
1247 entire subtree of the parent.
1248 @orgcmd{C-c C-k,show-branches}
1249 Expose all the headings of the subtree, CONTENT view for just one subtree.
1250 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1251 Show the current subtree in an indirect buffer@footnote{The indirect
1252 buffer
1253 @ifinfo
1254 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1255 @end ifinfo
1256 @ifnotinfo
1257 (see the Emacs manual for more information about indirect buffers)
1258 @end ifnotinfo
1259 will contain the entire buffer, but will be narrowed to the current
1260 tree.  Editing the indirect buffer will also change the original buffer,
1261 but without affecting visibility in that buffer.}.  With a numeric
1262 prefix argument N, go up to level N and then take that tree.  If N is
1263 negative then go up that many levels.  With a @kbd{C-u} prefix, do not remove
1264 the previously used indirect buffer.
1265 @orgcmd{C-c C-x v,org-copy-visible}
1266 Copy the @i{visible} text in the region into the kill ring.
1267 @end table
1269 @vindex org-startup-folded
1270 @cindex @code{overview}, STARTUP keyword
1271 @cindex @code{content}, STARTUP keyword
1272 @cindex @code{showall}, STARTUP keyword
1273 @cindex @code{showeverything}, STARTUP keyword
1275 When Emacs first visits an Org file, the global state is set to
1276 OVERVIEW, i.e.@: only the top level headlines are visible.  This can be
1277 configured through the variable @code{org-startup-folded}, or on a
1278 per-file basis by adding one of the following lines anywhere in the
1279 buffer:
1281 @example
1282 #+STARTUP: overview
1283 #+STARTUP: content
1284 #+STARTUP: showall
1285 #+STARTUP: showeverything
1286 @end example
1288 @cindex property, VISIBILITY
1289 @noindent
1290 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1291 and Columns}) will get their visibility adapted accordingly.  Allowed values
1292 for this property are @code{folded}, @code{children}, @code{content}, and
1293 @code{all}.
1294 @table @asis
1295 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1296 Switch back to the startup visibility of the buffer, i.e.@: whatever is
1297 requested by startup options and @samp{VISIBILITY} properties in individual
1298 entries.
1299 @end table
1301 @node Motion, Structure editing, Visibility cycling, Document Structure
1302 @section Motion
1303 @cindex motion, between headlines
1304 @cindex jumping, to headlines
1305 @cindex headline navigation
1306 The following commands jump to other headlines in the buffer.
1308 @table @asis
1309 @orgcmd{C-c C-n,outline-next-visible-heading}
1310 Next heading.
1311 @orgcmd{C-c C-p,outline-previous-visible-heading}
1312 Previous heading.
1313 @orgcmd{C-c C-f,org-forward-same-level}
1314 Next heading same level.
1315 @orgcmd{C-c C-b,org-backward-same-level}
1316 Previous heading same level.
1317 @orgcmd{C-c C-u,outline-up-heading}
1318 Backward to higher level heading.
1319 @orgcmd{C-c C-j,org-goto}
1320 Jump to a different place without changing the current outline
1321 visibility.  Shows the document structure in a temporary buffer, where
1322 you can use the following keys to find your destination:
1323 @vindex org-goto-auto-isearch
1324 @example
1325 @key{TAB}         @r{Cycle visibility.}
1326 @key{down} / @key{up}   @r{Next/previous visible headline.}
1327 @key{RET}         @r{Select this location.}
1328 @kbd{/}           @r{Do a Sparse-tree search}
1329 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1330 n / p        @r{Next/previous visible headline.}
1331 f / b        @r{Next/previous headline same level.}
1332 u            @r{One level up.}
1333 0-9          @r{Digit argument.}
1334 q            @r{Quit}
1335 @end example
1336 @vindex org-goto-interface
1337 @noindent
1338 See also the variable @code{org-goto-interface}.
1339 @end table
1341 @node Structure editing, Sparse trees, Motion, Document Structure
1342 @section Structure editing
1343 @cindex structure editing
1344 @cindex headline, promotion and demotion
1345 @cindex promotion, of subtrees
1346 @cindex demotion, of subtrees
1347 @cindex subtree, cut and paste
1348 @cindex pasting, of subtrees
1349 @cindex cutting, of subtrees
1350 @cindex copying, of subtrees
1351 @cindex sorting, of subtrees
1352 @cindex subtrees, cut and paste
1354 @table @asis
1355 @orgcmd{M-@key{RET},org-insert-heading}
1356 @vindex org-M-RET-may-split-line
1357 Insert new heading with same level as current.  If the cursor is in a plain
1358 list item, a new item is created (@pxref{Plain lists}).  To force creation of
1359 a new headline, use a prefix argument.  When this command is used in the
1360 middle of a line, the line is split and the rest of the line becomes the new
1361 headline@footnote{If you do not want the line to be split, customize the
1362 variable @code{org-M-RET-may-split-line}.}.  If the command is used at the
1363 beginning of a headline, the new headline is created before the current line.
1364 If at the beginning of any other line, the content of that line is made the
1365 new heading.  If the command is used at the end of a folded subtree (i.e.@:
1366 behind the ellipses at the end of a headline), then a headline like the
1367 current one will be inserted after the end of the subtree.
1368 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1369 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1370 current heading, the new heading is placed after the body instead of before
1371 it.  This command works from anywhere in the entry.
1372 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1373 @vindex org-treat-insert-todo-heading-as-state-change
1374 Insert new TODO entry with same level as current heading.  See also the
1375 variable @code{org-treat-insert-todo-heading-as-state-change}.
1376 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1377 Insert new TODO entry with same level as current heading.  Like
1378 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1379 subtree.
1380 @orgcmd{@key{TAB},org-cycle}
1381 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1382 become a child of the previous one.  The next @key{TAB} makes it a parent,
1383 and so on, all the way to top level.  Yet another @key{TAB}, and you are back
1384 to the initial level.
1385 @orgcmd{M-@key{left},org-do-promote}
1386 Promote current heading by one level.
1387 @orgcmd{M-@key{right},org-do-demote}
1388 Demote current heading by one level.
1389 @orgcmd{M-S-@key{left},org-promote-subtree}
1390 Promote the current subtree by one level.
1391 @orgcmd{M-S-@key{right},org-demote-subtree}
1392 Demote the current subtree by one level.
1393 @orgcmd{M-S-@key{up},org-move-subtree-up}
1394 Move subtree up (swap with previous subtree of same
1395 level).
1396 @orgcmd{M-S-@key{down},org-move-subtree-down}
1397 Move subtree down (swap with next subtree of same level).
1398 @orgcmd{C-c C-x C-w,org-cut-subtree}
1399 Kill subtree, i.e.@: remove it from buffer but save in kill ring.
1400 With a numeric prefix argument N, kill N sequential subtrees.
1401 @orgcmd{C-c C-x M-w,org-copy-subtree}
1402 Copy subtree to kill ring.  With a numeric prefix argument N, copy the N
1403 sequential subtrees.
1404 @orgcmd{C-c C-x C-y,org-paste-subtree}
1405 Yank subtree from kill ring.  This does modify the level of the subtree to
1406 make sure the tree fits in nicely at the yank position.  The yank level can
1407 also be specified with a numeric prefix argument, or by yanking after a
1408 headline marker like @samp{****}.
1409 @orgcmd{C-y,org-yank}
1410 @vindex org-yank-adjusted-subtrees
1411 @vindex org-yank-folded-subtrees
1412 Depending on the variables @code{org-yank-adjusted-subtrees} and
1413 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1414 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1415 C-x C-y}.  With the default settings, no level adjustment will take place,
1416 but the yanked tree will be folded unless doing so would swallow text
1417 previously visible.  Any prefix argument to this command will force a normal
1418 @code{yank} to be executed, with the prefix passed along.  A good way to
1419 force a normal yank is @kbd{C-u C-y}.  If you use @code{yank-pop} after a
1420 yank, it will yank previous kill items plainly, without adjustment and
1421 folding.
1422 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1423 Clone a subtree by making a number of sibling copies of it.  You will be
1424 prompted for the number of copies to make, and you can also specify if any
1425 timestamps in the entry should be shifted.  This can be useful, for example,
1426 to create a number of tasks related to a series of lectures to prepare.  For
1427 more details, see the docstring of the command
1428 @code{org-clone-subtree-with-time-shift}.
1429 @orgcmd{C-c C-w,org-refile}
1430 Refile entry or region to a different location.  @xref{Refiling notes}.
1431 @orgcmd{C-c ^,org-sort-entries-or-items}
1432 Sort same-level entries.  When there is an active region, all entries in the
1433 region will be sorted.  Otherwise the children of the current headline are
1434 sorted.  The command prompts for the sorting method, which can be
1435 alphabetically, numerically, by time (first timestamp with active preferred,
1436 creation time, scheduled time, deadline time), by priority, by TODO keyword
1437 (in the sequence the keywords have been defined in the setup) or by the value
1438 of a property.  Reverse sorting is possible as well.  You can also supply
1439 your own function to extract the sorting key.  With a @kbd{C-u} prefix,
1440 sorting will be case-sensitive.
1441 @orgcmd{C-x n s,org-narrow-to-subtree}
1442 Narrow buffer to current subtree.
1443 @orgcmd{C-x n b,org-narrow-to-block}
1444 Narrow buffer to current block.
1445 @orgcmd{C-x n w,widen}
1446 Widen buffer to remove narrowing.
1447 @orgcmd{C-c *,org-toggle-heading}
1448 Turn a normal line or plain list item into a headline (so that it becomes a
1449 subheading at its location).  Also turn a headline into a normal line by
1450 removing the stars.  If there is an active region, turn all lines in the
1451 region into headlines.  If the first line in the region was an item, turn
1452 only the item lines into headlines.  Finally, if the first line is a
1453 headline, remove the stars from all headlines in the region.
1454 @end table
1456 @cindex region, active
1457 @cindex active region
1458 @cindex transient mark mode
1459 When there is an active region (Transient Mark mode), promotion and
1460 demotion work on all headlines in the region.  To select a region of
1461 headlines, it is best to place both point and mark at the beginning of a
1462 line, mark at the beginning of the first headline, and point at the line
1463 just after the last headline to change.  Note that when the cursor is
1464 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1465 functionality.
1468 @node Sparse trees, Plain lists, Structure editing, Document Structure
1469 @section Sparse trees
1470 @cindex sparse trees
1471 @cindex trees, sparse
1472 @cindex folding, sparse trees
1473 @cindex occur, command
1475 @vindex org-show-hierarchy-above
1476 @vindex org-show-following-heading
1477 @vindex org-show-siblings
1478 @vindex org-show-entry-below
1479 An important feature of Org mode is the ability to construct @emph{sparse
1480 trees} for selected information in an outline tree, so that the entire
1481 document is folded as much as possible, but the selected information is made
1482 visible along with the headline structure above it@footnote{See also the
1483 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1484 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1485 control on how much context is shown around each match.}.  Just try it out
1486 and you will see immediately how it works.
1488 Org mode contains several commands creating such trees, all these
1489 commands can be accessed through a dispatcher:
1491 @table @asis
1492 @orgcmd{C-c /,org-sparse-tree}
1493 This prompts for an extra key to select a sparse-tree creating command.
1494 @orgcmd{C-c / r,org-occur}
1495 @vindex org-remove-highlights-with-change
1496 Prompts for a regexp and shows a sparse tree with all matches.  If
1497 the match is in a headline, the headline is made visible.  If the match is in
1498 the body of an entry, headline and body are made visible.  In order to
1499 provide minimal context, also the full hierarchy of headlines above the match
1500 is shown, as well as the headline following the match.  Each match is also
1501 highlighted; the highlights disappear when the buffer is changed by an
1502 editing command@footnote{This depends on the option
1503 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1504 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1505 so several calls to this command can be stacked.
1506 @orgcmdkkc{M-g n,M-g M-n,next-error}
1507 Jump to the next sparse tree match in this buffer.
1508 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1509 Jump to the previous sparse tree match in this buffer.
1510 @end table
1513 @noindent
1514 @vindex org-agenda-custom-commands
1515 For frequently used sparse trees of specific search strings, you can
1516 use the variable @code{org-agenda-custom-commands} to define fast
1517 keyboard access to specific sparse trees.  These commands will then be
1518 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1519 For example:
1521 @lisp
1522 (setq org-agenda-custom-commands
1523       '(("f" occur-tree "FIXME")))
1524 @end lisp
1526 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1527 a sparse tree matching the string @samp{FIXME}.
1529 The other sparse tree commands select headings based on TODO keywords,
1530 tags, or properties and will be discussed later in this manual.
1532 @kindex C-c C-e v
1533 @cindex printing sparse trees
1534 @cindex visible text, printing
1535 To print a sparse tree, you can use the Emacs command
1536 @code{ps-print-buffer-with-faces} which does not print invisible parts
1537 of the document @footnote{This does not work under XEmacs, because
1538 XEmacs uses selective display for outlining, not text properties.}.
1539 Or you can use the command @kbd{C-c C-e v} to export only the visible
1540 part of the document and print the resulting file.
1542 @node Plain lists, Drawers, Sparse trees, Document Structure
1543 @section Plain lists
1544 @cindex plain lists
1545 @cindex lists, plain
1546 @cindex lists, ordered
1547 @cindex ordered lists
1549 Within an entry of the outline tree, hand-formatted lists can provide
1550 additional structure.  They also provide a way to create lists of checkboxes
1551 (@pxref{Checkboxes}).  Org supports editing such lists, and every exporter
1552 (@pxref{Exporting}) can parse and format them.
1554 Org knows ordered lists, unordered lists, and description lists.
1555 @itemize @bullet
1556 @item
1557 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1558 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1559 they will be seen as top-level headlines.  Also, when you are hiding leading
1560 stars to get a clean outline view, plain list items starting with a star may
1561 be hard to distinguish from true headlines.  In short: even though @samp{*}
1562 is supported, it may be better to not use it for plain list items.}  as
1563 bullets.
1564 @item
1565 @vindex org-plain-list-ordered-item-terminator
1566 @vindex org-alphabetical-lists
1567 @emph{Ordered} list items start with a numeral followed by either a period or
1568 a right parenthesis@footnote{You can filter out any of them by configuring
1569 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1570 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1571 @samp{A)} by configuring @code{org-alphabetical-lists}.  To minimize
1572 confusion with normal text, those are limited to one character only.  Beyond
1573 that limit, bullets will automatically fallback to numbers.}.  If you want a
1574 list to start with a different value (e.g.@: 20), start the text of the item
1575 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1576 must be put @emph{before} the checkbox.  If you have activated alphabetical
1577 lists, you can also use counters like @code{[@@b]}.}.  Those constructs can
1578 be used in any item of the list in order to enforce a particular numbering.
1579 @item
1580 @emph{Description} list items are unordered list items, and contain the
1581 separator @samp{ :: } to distinguish the description @emph{term} from the
1582 description.
1583 @end itemize
1585 Items belonging to the same list must have the same indentation on the first
1586 line.  In particular, if an ordered list reaches number @samp{10.}, then the
1587 2--digit numbers must be written left-aligned with the other numbers in the
1588 list.  An item ends before the next line that is less or equally indented
1589 than its bullet/number.
1591 @vindex org-empty-line-terminates-plain-lists
1592 A list ends whenever every item has ended, which means before any line less
1593 or equally indented than items at top level.  It also ends before two blank
1594 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}.  In
1595 that case, all items are closed.  Here is an example:
1597 @example
1598 @group
1599 ** Lord of the Rings
1600    My favorite scenes are (in this order)
1601    1. The attack of the Rohirrim
1602    2. Eowyn's fight with the witch king
1603       + this was already my favorite scene in the book
1604       + I really like Miranda Otto.
1605    3. Peter Jackson being shot by Legolas
1606       - on DVD only
1607       He makes a really funny face when it happens.
1608    But in the end, no individual scenes matter but the film as a whole.
1609    Important actors in this film are:
1610    - @b{Elijah Wood} :: He plays Frodo
1611    - @b{Sean Austin} :: He plays Sam, Frodo's friend.  I still remember
1612      him very well from his role as Mikey Walsh in @i{The Goonies}.
1613 @end group
1614 @end example
1616 Org supports these lists by tuning filling and wrapping commands to deal with
1617 them correctly@footnote{Org only changes the filling settings for Emacs.  For
1618 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}.  To turn this on,
1619 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1620 properly (@pxref{Exporting}).  Since indentation is what governs the
1621 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1622 blocks can be indented to signal that they belong to a particular item.
1624 @vindex org-list-demote-modify-bullet
1625 @vindex org-list-indent-offset
1626 If you find that using a different bullet for a sub-list (than that used for
1627 the current list-level) improves readability, customize the variable
1628 @code{org-list-demote-modify-bullet}.  To get a greater difference of
1629 indentation between items and theirs sub-items, customize
1630 @code{org-list-indent-offset}.
1632 @vindex org-list-automatic-rules
1633 The following commands act on items when the cursor is in the first line of
1634 an item (the line with the bullet or number).  Some of them imply the
1635 application of automatic rules to keep list structure intact.  If some of
1636 these actions get in your way, configure @code{org-list-automatic-rules}
1637 to disable them individually.
1639 @table @asis
1640 @orgcmd{@key{TAB},org-cycle}
1641 @cindex cycling, in plain lists
1642 @vindex org-cycle-include-plain-lists
1643 Items can be folded just like headline levels.  Normally this works only if
1644 the cursor is on a plain list item.  For more details, see the variable
1645 @code{org-cycle-include-plain-lists}.  If this variable is set to
1646 @code{integrate}, plain list items will be treated like low-level
1647 headlines.  The level of an item is then given by the indentation of the
1648 bullet/number.  Items are always subordinate to real headlines, however; the
1649 hierarchies remain completely separated.  In a new item with no text yet, the
1650 first @key{TAB} demotes the item to become a child of the previous
1651 one.  Subsequent @key{TAB}s move the item to meaningful levels in the list
1652 and eventually get it back to its initial position.
1653 @orgcmd{M-@key{RET},org-insert-heading}
1654 @vindex org-M-RET-may-split-line
1655 @vindex org-list-automatic-rules
1656 Insert new item at current level.  With a prefix argument, force a new
1657 heading (@pxref{Structure editing}).  If this command is used in the middle
1658 of an item, that item is @emph{split} in two, and the second part becomes the
1659 new item@footnote{If you do not want the item to be split, customize the
1660 variable @code{org-M-RET-may-split-line}.}.  If this command is executed
1661 @emph{before item's body}, the new item is created @emph{before} the current
1662 one.
1663 @end table
1665 @table @kbd
1666 @kindex M-S-@key{RET}
1667 @item M-S-RET
1668 Insert a new item with a checkbox (@pxref{Checkboxes}).
1669 @kindex S-@key{down}
1670 @item S-up
1671 @itemx S-down
1672 @cindex shift-selection-mode
1673 @vindex org-support-shift-select
1674 @vindex org-list-use-circular-motion
1675 Jump to the previous/next item in the current list@footnote{If you want to
1676 cycle around items that way, you may customize
1677 @code{org-list-use-circular-motion}.}, but only if
1678 @code{org-support-shift-select} is off.  If not, you can still use paragraph
1679 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1680 similar effect.
1681 @kindex M-@key{up}
1682 @kindex M-@key{down}
1683 @item M-up
1684 @itemx M-down
1685 Move the item including subitems up/down@footnote{See
1686 @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
1687 previous/next item of same indentation).  If the list is ordered, renumbering
1688 is automatic.
1689 @kindex M-@key{left}
1690 @kindex M-@key{right}
1691 @item M-left
1692 @itemx M-right
1693 Decrease/increase the indentation of an item, leaving children alone.
1694 @kindex M-S-@key{left}
1695 @kindex M-S-@key{right}
1696 @item M-S-left
1697 @itemx M-S-right
1698 Decrease/increase the indentation of the item, including subitems.
1699 Initially, the item tree is selected based on current indentation.  When
1700 these commands are executed several times in direct succession, the initially
1701 selected region is used, even if the new indentation would imply a different
1702 hierarchy.  To use the new hierarchy, break the command chain with a cursor
1703 motion or so.
1705 As a special case, using this command on the very first item of a list will
1706 move the whole list.  This behavior can be disabled by configuring
1707 @code{org-list-automatic-rules}.  The global indentation of a list has no
1708 influence on the text @emph{after} the list.
1709 @kindex C-c C-c
1710 @item C-c C-c
1711 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1712 state of the checkbox.  In any case, verify bullets and indentation
1713 consistency in the whole list.
1714 @kindex C-c -
1715 @vindex org-plain-list-ordered-item-terminator
1716 @vindex org-list-automatic-rules
1717 @item C-c -
1718 Cycle the entire list level through the different itemize/enumerate bullets
1719 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1720 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1721 and its position@footnote{See @code{bullet} rule in
1722 @code{org-list-automatic-rules} for more information.}.  With a numeric
1723 prefix argument N, select the Nth bullet from this list.  If there is an
1724 active region when calling this, selected text will be changed into an item.
1725 With a prefix argument, all lines will be converted to list items.  If the
1726 first line already was a list item, any item marker will be removed from the
1727 list.  Finally, even without an active region, a normal line will be
1728 converted into a list item.
1729 @kindex C-c *
1730 @item C-c *
1731 Turn a plain list item into a headline (so that it becomes a subheading at
1732 its location).  @xref{Structure editing}, for a detailed explanation.
1733 @kindex C-c C-*
1734 @item C-c C-*
1735 Turn the whole plain list into a subtree of the current heading.  Checkboxes
1736 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1737 (resp. checked).
1738 @kindex S-@key{left}
1739 @kindex S-@key{right}
1740 @item S-left/right
1741 @vindex org-support-shift-select
1742 This command also cycles bullet styles when the cursor in on the bullet or
1743 anywhere in an item line, details depending on
1744 @code{org-support-shift-select}.
1745 @kindex C-c ^
1746 @item C-c ^
1747 Sort the plain list.  You will be prompted for the sorting method:
1748 numerically, alphabetically, by time, or by custom function.
1749 @end table
1751 @node Drawers, Blocks, Plain lists, Document Structure
1752 @section Drawers
1753 @cindex drawers
1754 @cindex #+DRAWERS
1755 @cindex visibility cycling, drawers
1757 @vindex org-drawers
1758 Sometimes you want to keep information associated with an entry, but you
1759 normally don't want to see it.  For this, Org mode has @emph{drawers}.
1760 Drawers need to be configured with the variable
1761 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1762 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}.  Drawers
1763 look like this:
1765 @example
1766 ** This is a headline
1767    Still outside the drawer
1768    :DRAWERNAME:
1769    This is inside the drawer.
1770    :END:
1771    After the drawer.
1772 @end example
1774 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1775 show the entry, but keep the drawer collapsed to a single line.  In order to
1776 look inside the drawer, you need to move the cursor to the drawer line and
1777 press @key{TAB} there.  Org mode uses the @code{PROPERTIES} drawer for
1778 storing properties (@pxref{Properties and Columns}), and you can also arrange
1779 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1780 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.  If you
1781 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1783 @table @kbd
1784 @kindex C-c C-z
1785 @item C-c C-z
1786 Add a time-stamped note to the LOGBOOK drawer.
1787 @end table
1789 @node Blocks, Footnotes, Drawers, Document Structure
1790 @section Blocks
1792 @vindex org-hide-block-startup
1793 @cindex blocks, folding
1794 Org mode uses begin...end blocks for various purposes from including source
1795 code examples (@pxref{Literal examples}) to capturing time logging
1796 information (@pxref{Clocking work time}).  These blocks can be folded and
1797 unfolded by pressing TAB in the begin line.  You can also get all blocks
1798 folded at startup by configuring the variable @code{org-hide-block-startup}
1799 or on a per-file basis by using
1801 @cindex @code{hideblocks}, STARTUP keyword
1802 @cindex @code{nohideblocks}, STARTUP keyword
1803 @example
1804 #+STARTUP: hideblocks
1805 #+STARTUP: nohideblocks
1806 @end example
1808 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1809 @section Footnotes
1810 @cindex footnotes
1812 Org mode supports the creation of footnotes.  In contrast to the
1813 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1814 larger document, not only for one-off documents like emails.  The basic
1815 syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
1816 defined in a paragraph that is started by a footnote marker in square
1817 brackets in column 0, no indentation allowed.  If you need a paragraph break
1818 inside a footnote, use the @LaTeX{} idiom @samp{\par}.  The footnote reference
1819 is simply the marker in square brackets, inside text.  For example:
1821 @example
1822 The Org homepage[fn:1] now looks a lot better than it used to.
1824 [fn:1] The link is: http://orgmode.org
1825 @end example
1827 Org mode extends the number-based syntax to @emph{named} footnotes and
1828 optional inline definition.  Using plain numbers as markers (as
1829 @file{footnote.el} does) is supported for backward compatibility, but not
1830 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1831 @LaTeX{}}).  Here are the valid references:
1833 @table @code
1834 @item [1]
1835 A plain numeric footnote marker.  Compatible with @file{footnote.el}, but not
1836 recommended because something like @samp{[1]} could easily be part of a code
1837 snippet.
1838 @item [fn:name]
1839 A named footnote reference, where @code{name} is a unique label word, or, for
1840 simplicity of automatic creation, a number.
1841 @item [fn:: This is the inline definition of this footnote]
1842 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1843 reference point.
1844 @item [fn:name: a definition]
1845 An inline definition of a footnote, which also specifies a name for the note.
1846 Since Org allows multiple references to the same note, you can then use
1847 @code{[fn:name]} to create additional references.
1848 @end table
1850 @vindex org-footnote-auto-label
1851 Footnote labels can be created automatically, or you can create names yourself.
1852 This is handled by the variable @code{org-footnote-auto-label} and its
1853 corresponding @code{#+STARTUP} keywords.  See the docstring of that variable
1854 for details.
1856 @noindent The following command handles footnotes:
1858 @table @kbd
1859 @kindex C-c C-x f
1860 @item C-c C-x f
1861 The footnote action command.
1863 When the cursor is on a footnote reference, jump to the definition.  When it
1864 is at a definition, jump to the (first) reference.
1866 @vindex org-footnote-define-inline
1867 @vindex org-footnote-section
1868 @vindex org-footnote-auto-adjust
1869 Otherwise, create a new footnote.  Depending on the variable
1870 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1871 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1872 definition will be placed right into the text as part of the reference, or
1873 separately into the location determined by the variable
1874 @code{org-footnote-section}.
1876 When this command is called with a prefix argument, a menu of additional
1877 options is offered:
1878 @example
1879 s   @r{Sort the footnote definitions by reference sequence.  During editing,}
1880     @r{Org makes no effort to sort footnote definitions into a particular}
1881     @r{sequence.  If you want them sorted, use this command, which will}
1882     @r{also move entries according to @code{org-footnote-section}.  Automatic}
1883     @r{sorting after each insertion/deletion can be configured using the}
1884     @r{variable @code{org-footnote-auto-adjust}.}
1885 r   @r{Renumber the simple @code{fn:N} footnotes.  Automatic renumbering}
1886     @r{after each insertion/deletion can be configured using the variable}
1887     @r{@code{org-footnote-auto-adjust}.}
1888 S   @r{Short for first @code{r}, then @code{s} action.}
1889 n   @r{Normalize the footnotes by collecting all definitions (including}
1890     @r{inline definitions) into a special section, and then numbering them}
1891     @r{in sequence.  The references will then also be numbers.  This is}
1892     @r{meant to be the final step before finishing a document (e.g.@: sending}
1893     @r{off an email).  The exporters do this automatically, and so could}
1894     @r{something like @code{message-send-hook}.}
1895 d   @r{Delete the footnote at point, and all definitions of and references}
1896     @r{to it.}
1897 @end example
1898 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1899 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1900 renumbering and sorting footnotes can be automatic after each insertion or
1901 deletion.
1903 @kindex C-c C-c
1904 @item C-c C-c
1905 If the cursor is on a footnote reference, jump to the definition.  If it is a
1906 the definition, jump back to the reference.  When called at a footnote
1907 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1908 @kindex C-c C-o
1909 @kindex mouse-1
1910 @kindex mouse-2
1911 @item C-c C-o  @r{or} mouse-1/2
1912 Footnote labels are also links to the corresponding definition/reference, and
1913 you can use the usual commands to follow these links.
1914 @end table
1916 @node Orgstruct mode,  , Footnotes, Document Structure
1917 @section The Orgstruct minor mode
1918 @cindex Orgstruct mode
1919 @cindex minor mode for structure editing
1921 If you like the intuitive way the Org mode structure editing and list
1922 formatting works, you might want to use these commands in other modes like
1923 Text mode or Mail mode as well.  The minor mode @code{orgstruct-mode} makes
1924 this possible.   Toggle the mode with @kbd{M-x orgstruct-mode}, or
1925 turn it on by default, for example in Message mode, with one of:
1927 @lisp
1928 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1929 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1930 @end lisp
1932 When this mode is active and the cursor is on a line that looks to Org like a
1933 headline or the first line of a list item, most structure editing commands
1934 will work, even if the same keys normally have different functionality in the
1935 major mode you are using.  If the cursor is not in one of those special
1936 lines, Orgstruct mode lurks silently in the shadows.  When you use
1937 @code{orgstruct++-mode}, Org will also export indentation and autofill
1938 settings into that mode, and detect item context after the first line of an
1939 item.
1941 @node Tables, Hyperlinks, Document Structure, Top
1942 @chapter Tables
1943 @cindex tables
1944 @cindex editing tables
1946 Org comes with a fast and intuitive table editor.  Spreadsheet-like
1947 calculations are supported using the Emacs @file{calc} package
1948 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
1950 @menu
1951 * Built-in table editor::       Simple tables
1952 * Column width and alignment::  Overrule the automatic settings
1953 * Column groups::               Grouping to trigger vertical lines
1954 * Orgtbl mode::                 The table editor as minor mode
1955 * The spreadsheet::             The table editor has spreadsheet capabilities
1956 * Org-Plot::                    Plotting from org tables
1957 @end menu
1959 @node Built-in table editor, Column width and alignment, Tables, Tables
1960 @section The built-in table editor
1961 @cindex table editor, built-in
1963 Org makes it easy to format tables in plain ASCII.  Any line with @samp{|} as
1964 the first non-whitespace character is considered part of a table.  @samp{|}
1965 is also the column separator@footnote{To insert a vertical bar into a table
1966 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}.  A table
1967 might look like this:
1969 @example
1970 | Name  | Phone | Age |
1971 |-------+-------+-----|
1972 | Peter |  1234 |  17 |
1973 | Anna  |  4321 |  25 |
1974 @end example
1976 A table is re-aligned automatically each time you press @key{TAB} or
1977 @key{RET} or @kbd{C-c C-c} inside the table.  @key{TAB} also moves to
1978 the next field (@key{RET} to the next row) and creates new table rows
1979 at the end of the table or before horizontal lines.  The indentation
1980 of the table is set by the first line.  Any line starting with
1981 @samp{|-} is considered as a horizontal separator line and will be
1982 expanded on the next re-align to span the whole table width.  So, to
1983 create the above table, you would only type
1985 @example
1986 |Name|Phone|Age|
1988 @end example
1990 @noindent and then press @key{TAB} to align the table and start filling in
1991 fields.  Even faster would be to type @code{|Name|Phone|Age} followed by
1992 @kbd{C-c @key{RET}}.
1994 @vindex org-enable-table-editor
1995 @vindex org-table-auto-blank-field
1996 When typing text into a field, Org treats @key{DEL},
1997 @key{Backspace}, and all character keys in a special way, so that
1998 inserting and deleting avoids shifting other fields.  Also, when
1999 typing @emph{immediately after the cursor was moved into a new field
2000 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2001 field is automatically made blank.  If this behavior is too
2002 unpredictable for you, configure the variables
2003 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2005 @table @kbd
2006 @tsubheading{Creation and conversion}
2007 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2008 Convert the active region to table.  If every line contains at least one
2009 TAB character, the function assumes that the material is tab separated.
2010 If every line contains a comma, comma-separated values (CSV) are assumed.
2011 If not, lines are split at whitespace into fields.  You can use a prefix
2012 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2013 C-u} forces TAB, and a numeric argument N indicates that at least N
2014 consecutive spaces, or alternatively a TAB will be the separator.
2016 If there is no active region, this command creates an empty Org
2017 table.  But it is easier just to start typing, like
2018 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2020 @tsubheading{Re-aligning and field motion}
2021 @orgcmd{C-c C-c,org-table-align}
2022 Re-align the table without moving the cursor.
2024 @orgcmd{<TAB>,org-table-next-field}
2025 Re-align the table, move to the next field.  Creates a new row if
2026 necessary.
2028 @orgcmd{S-@key{TAB},org-table-previous-field}
2029 Re-align, move to previous field.
2031 @orgcmd{@key{RET},org-table-next-row}
2032 Re-align the table and move down to next row.  Creates a new row if
2033 necessary.  At the beginning or end of a line, @key{RET} still does
2034 NEWLINE, so it can be used to split a table.
2036 @orgcmd{M-a,org-table-beginning-of-field}
2037 Move to beginning of the current table field, or on to the previous field.
2038 @orgcmd{M-e,org-table-end-of-field}
2039 Move to end of the current table field, or on to the next field.
2041 @tsubheading{Column and row editing}
2042 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2043 Move the current column left/right.
2045 @orgcmd{M-S-@key{left},org-table-delete-column}
2046 Kill the current column.
2048 @orgcmd{M-S-@key{right},org-table-insert-column}
2049 Insert a new column to the left of the cursor position.
2051 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2052 Move the current row up/down.
2054 @orgcmd{M-S-@key{up},org-table-kill-row}
2055 Kill the current row or horizontal line.
2057 @orgcmd{M-S-@key{down},org-table-insert-row}
2058 Insert a new row above the current row.  With a prefix argument, the line is
2059 created below the current one.
2061 @orgcmd{C-c -,org-table-insert-hline}
2062 Insert a horizontal line below current row.  With a prefix argument, the line
2063 is created above the current line.
2065 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2066 Insert a horizontal line below current row, and move the cursor into the row
2067 below that line.
2069 @orgcmd{C-c ^,org-table-sort-lines}
2070 Sort the table lines in the region.  The position of point indicates the
2071 column to be used for sorting, and the range of lines is the range
2072 between the nearest horizontal separator lines, or the entire table.  If
2073 point is before the first column, you will be prompted for the sorting
2074 column.  If there is an active region, the mark specifies the first line
2075 and the sorting column, while point should be in the last line to be
2076 included into the sorting.  The command prompts for the sorting type
2077 (alphabetically, numerically, or by time).  When called with a prefix
2078 argument, alphabetic sorting will be case-sensitive.
2080 @tsubheading{Regions}
2081 @orgcmd{C-c C-x M-w,org-table-copy-region}
2082 Copy a rectangular region from a table to a special clipboard.  Point and
2083 mark determine edge fields of the rectangle.  If there is no active region,
2084 copy just the current field.  The process ignores horizontal separator lines.
2086 @orgcmd{C-c C-x C-w,org-table-cut-region}
2087 Copy a rectangular region from a table to a special clipboard, and
2088 blank all fields in the rectangle.  So this is the ``cut'' operation.
2090 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2091 Paste a rectangular region into a table.
2092 The upper left corner ends up in the current field.  All involved fields
2093 will be overwritten.  If the rectangle does not fit into the present table,
2094 the table is enlarged as needed.  The process ignores horizontal separator
2095 lines.
2097 @orgcmd{M-@key{RET},org-table-wrap-region}
2098 Split the current field at the cursor position and move the rest to the line
2099 below.  If there is an active region, and both point and mark are in the same
2100 column, the text in the column is wrapped to minimum width for the given
2101 number of lines.  A numeric prefix argument may be used to change the number
2102 of desired lines.  If there is no region, but you specify a prefix argument,
2103 the current field is made blank, and the content is appended to the field
2104 above.
2106 @tsubheading{Calculations}
2107 @cindex formula, in tables
2108 @cindex calculations, in tables
2109 @cindex region, active
2110 @cindex active region
2111 @cindex transient mark mode
2112 @orgcmd{C-c +,org-table-sum}
2113 Sum the numbers in the current column, or in the rectangle defined by
2114 the active region.  The result is shown in the echo area and can
2115 be inserted with @kbd{C-y}.
2117 @orgcmd{S-@key{RET},org-table-copy-down}
2118 @vindex org-table-copy-increment
2119 When current field is empty, copy from first non-empty field above.  When not
2120 empty, copy current field down to next row and move cursor along with it.
2121 Depending on the variable @code{org-table-copy-increment}, integer field
2122 values will be incremented during copy.  Integers that are too large will not
2123 be incremented.  Also, a @code{0} prefix argument temporarily disables the
2124 increment.  This key is also used by shift-selection and related modes
2125 (@pxref{Conflicts}).
2127 @tsubheading{Miscellaneous}
2128 @orgcmd{C-c `,org-table-edit-field}
2129 Edit the current field in a separate window.  This is useful for fields that
2130 are not fully visible (@pxref{Column width and alignment}).  When called with
2131 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2132 edited in place.  When called with two @kbd{C-u} prefixes, make the editor
2133 window follow the cursor through the table and always show the current
2134 field.  The follow mode exits automatically when the cursor leaves the table,
2135 or when you repeat this command with @kbd{C-u C-u C-c `}.
2137 @item M-x org-table-import
2138 Import a file as a table.  The table should be TAB or whitespace
2139 separated.  Use, for example, to import a spreadsheet table or data
2140 from a database, because these programs generally can write
2141 TAB-separated text files.  This command works by inserting the file into
2142 the buffer and then converting the region to a table.  Any prefix
2143 argument is passed on to the converter, which uses it to determine the
2144 separator.
2145 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2146 Tables can also be imported by pasting tabular text into the Org
2147 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2148 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2150 @item M-x org-table-export
2151 @findex org-table-export
2152 @vindex org-table-export-default-format
2153 Export the table, by default as a TAB-separated file.  Use for data
2154 exchange with, for example, spreadsheet or database programs.  The format
2155 used to export the file can be configured in the variable
2156 @code{org-table-export-default-format}.  You may also use properties
2157 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2158 name and the format for table export in a subtree.  Org supports quite
2159 general formats for exported tables.  The exporter format is the same as the
2160 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2161 detailed description.
2162 @end table
2164 If you don't like the automatic table editor because it gets in your
2165 way on lines which you would like to start with @samp{|}, you can turn
2166 it off with
2168 @lisp
2169 (setq org-enable-table-editor nil)
2170 @end lisp
2172 @noindent Then the only table command that still works is
2173 @kbd{C-c C-c} to do a manual re-align.
2175 @node Column width and alignment, Column groups, Built-in table editor, Tables
2176 @section Column width and alignment
2177 @cindex narrow columns in tables
2178 @cindex alignment in tables
2180 The width of columns is automatically determined by the table editor.  And
2181 also the alignment of a column is determined automatically from the fraction
2182 of number-like versus non-number fields in the column.
2184 Sometimes a single field or a few fields need to carry more text, leading to
2185 inconveniently wide columns.  Or maybe you want to make a table with several
2186 columns having a fixed width, regardless of content.  To set@footnote{This
2187 feature does not work on XEmacs.} the width of a column, one field anywhere
2188 in the column may contain just the string @samp{<N>} where @samp{N} is an
2189 integer specifying the width of the column in characters.  The next re-align
2190 will then set the width of this column to this value.
2192 @example
2193 @group
2194 |---+------------------------------|               |---+--------|
2195 |   |                              |               |   | <6>    |
2196 | 1 | one                          |               | 1 | one    |
2197 | 2 | two                          |     ----\     | 2 | two    |
2198 | 3 | This is a long chunk of text |     ----/     | 3 | This=> |
2199 | 4 | four                         |               | 4 | four   |
2200 |---+------------------------------|               |---+--------|
2201 @end group
2202 @end example
2204 @noindent
2205 Fields that are wider become clipped and end in the string @samp{=>}.
2206 Note that the full text is still in the buffer but is hidden.
2207 To see the full text, hold the mouse over the field---a tool-tip window
2208 will show the full content.  To edit such a field, use the command
2209 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote).  This will
2210 open a new window with the full field.  Edit it and finish with @kbd{C-c
2211 C-c}.
2213 @vindex org-startup-align-all-tables
2214 When visiting a file containing a table with narrowed columns, the
2215 necessary character hiding has not yet happened, and the table needs to
2216 be aligned before it looks nice.  Setting the option
2217 @code{org-startup-align-all-tables} will realign all tables in a file
2218 upon visiting, but also slow down startup.  You can also set this option
2219 on a per-file basis with:
2221 @example
2222 #+STARTUP: align
2223 #+STARTUP: noalign
2224 @end example
2226 If you would like to overrule the automatic alignment of number-rich columns
2227 to the right and of string-rich column to the left, you can use @samp{<r>},
2228 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2229 effect when exporting to HTML.} or @samp{<l>} in a similar fashion.  You may
2230 also combine alignment and field width like this: @samp{<l10>}.
2232 Lines which only contain these formatting cookies will be removed
2233 automatically when exporting the document.
2235 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2236 @section Column groups
2237 @cindex grouping columns in tables
2239 When Org exports tables, it does so by default without vertical
2240 lines because that is visually more satisfying in general.  Occasionally
2241 however, vertical lines can be useful to structure a table into groups
2242 of columns, much like horizontal lines can do for groups of rows.  In
2243 order to specify column groups, you can use a special row where the
2244 first field contains only @samp{/}.  The further fields can either
2245 contain @samp{<} to indicate that this column should start a group,
2246 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2247 a group of its own.  Boundaries between column groups will upon export be
2248 marked with vertical lines.  Here is an example:
2250 @example
2251 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2252 |---+-----+-----+-----+---------+------------|
2253 | / |   < |     |   > |       < |          > |
2254 | 1 |   1 |   1 |   1 |       1 |          1 |
2255 | 2 |   4 |   8 |  16 |  1.4142 |     1.1892 |
2256 | 3 |   9 |  27 |  81 |  1.7321 |     1.3161 |
2257 |---+-----+-----+-----+---------+------------|
2258 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2259 @end example
2261 It is also sufficient to just insert the column group starters after
2262 every vertical line you would like to have:
2264 @example
2265 |  N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2266 |----+-----+-----+-----+---------+------------|
2267 | /  | <   |     |     | <       |            |
2268 @end example
2270 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2271 @section The Orgtbl minor mode
2272 @cindex Orgtbl mode
2273 @cindex minor mode for tables
2275 If you like the intuitive way the Org table editor works, you
2276 might also want to use it in other modes like Text mode or Mail mode.
2277 The minor mode Orgtbl mode makes this possible.  You can always toggle
2278 the mode with @kbd{M-x orgtbl-mode}.  To turn it on by default, for
2279 example in Message mode, use
2281 @lisp
2282 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2283 @end lisp
2285 Furthermore, with some special setup, it is possible to maintain tables
2286 in arbitrary syntax with Orgtbl mode.  For example, it is possible to
2287 construct @LaTeX{} tables with the underlying ease and power of
2288 Orgtbl mode, including spreadsheet capabilities.  For details, see
2289 @ref{Tables in arbitrary syntax}.
2291 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2292 @section The spreadsheet
2293 @cindex calculations, in tables
2294 @cindex spreadsheet capabilities
2295 @cindex @file{calc} package
2297 The table editor makes use of the Emacs @file{calc} package to implement
2298 spreadsheet-like capabilities.  It can also evaluate Emacs Lisp forms to
2299 derive fields from other fields.  While fully featured, Org's implementation
2300 is not identical to other spreadsheets.  For example, Org knows the concept
2301 of a @emph{column formula} that will be applied to all non-header fields in a
2302 column without having to copy the formula to each relevant field.  There is
2303 also a formula debugger, and a formula editor with features for highlighting
2304 fields in the table corresponding to the references at the point in the
2305 formula, moving these references by arrow keys
2307 @menu
2308 * References::                  How to refer to another field or range
2309 * Formula syntax for Calc::     Using Calc to compute stuff
2310 * Formula syntax for Lisp::     Writing formulas in Emacs Lisp
2311 * Durations and time values::   How to compute durations and time values
2312 * Field and range formulas::    Formula for specific (ranges of) fields
2313 * Column formulas::             Formulas valid for an entire column
2314 * Editing and debugging formulas::  Fixing formulas
2315 * Updating the table::          Recomputing all dependent fields
2316 * Advanced features::           Field and column names, parameters and automatic recalc
2317 @end menu
2319 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2320 @subsection References
2321 @cindex references
2323 To compute fields in the table from other fields, formulas must
2324 reference other fields or ranges.  In Org, fields can be referenced
2325 by name, by absolute coordinates, and by relative coordinates.  To find
2326 out what the coordinates of a field are, press @kbd{C-c ?} in that
2327 field, or press @kbd{C-c @}} to toggle the display of a grid.
2329 @subsubheading Field references
2330 @cindex field references
2331 @cindex references, to fields
2333 Formulas can reference the value of another field in two ways.  Like in
2334 any other spreadsheet, you may reference fields with a letter/number
2335 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2336 @vindex org-table-use-standard-references
2337 However, Org prefers@footnote{Org will understand references typed by the
2338 user as @samp{B4}, but it will not use this syntax when offering a formula
2339 for editing.  You can customize this behavior using the variable
2340 @code{org-table-use-standard-references}.}  to use another, more general
2341 representation that looks like this:
2342 @example
2343 @@@var{row}$@var{column}
2344 @end example
2346 Column specifications can be absolute like @code{$1},
2347 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
2348 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2349 @code{$<} and @code{$>} are immutable references to the first and last
2350 column, respectively, and you can use @code{$>>>} to indicate the third
2351 column from the right.
2353 The row specification only counts data lines and ignores horizontal separator
2354 lines (hlines).  Like with columns, you can use absolute row numbers
2355 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2356 current row like @code{@@+3} or @code{@@-1}.  @code{@@<} and @code{@@>} are
2357 immutable references the first and last@footnote{For backward compatibility
2358 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2359 a stable way to the 5th and 12th field in the last row of the table.
2360 However, this syntax is deprecated, it should not be used for new documents.
2361 Use @code{@@>$} instead.} row in the table, respectively.  You may also
2362 specify the row relative to one of the hlines: @code{@@I} refers to the first
2363 hline, @code{@@II} to the second, etc@.  @code{@@-I} refers to the first such
2364 line above the current line, @code{@@+I} to the first such line below the
2365 current line.  You can also write @code{@@III+2} which is the second data line
2366 after the third hline in the table.
2368 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2369 i.e. to the row/column for the field being computed.  Also, if you omit
2370 either the column or the row part of the reference, the current row/column is
2371 implied.
2373 Org's references with @emph{unsigned} numbers are fixed references
2374 in the sense that if you use the same reference in the formula for two
2375 different fields, the same field will be referenced each time.
2376 Org's references with @emph{signed} numbers are floating
2377 references because the same reference operator can reference different
2378 fields depending on the field being calculated by the formula.
2380 Here are a few examples:
2382 @example
2383 @@2$3      @r{2nd row, 3rd column (same as @code{C2})}
2384 $5        @r{column 5 in the current row (same as @code{E&})}
2385 @@2        @r{current column, row 2}
2386 @@-1$-3    @r{the field one row up, three columns to the left}
2387 @@-I$2     @r{field just under hline above current row, column 2}
2388 @@>$5      @r{field in the last row, in column 5}
2389 @end example
2391 @subsubheading Range references
2392 @cindex range references
2393 @cindex references, to ranges
2395 You may reference a rectangular range of fields by specifying two field
2396 references connected by two dots @samp{..}.  If both fields are in the
2397 current row, you may simply use @samp{$2..$7}, but if at least one field
2398 is in a different row, you need to use the general @code{@@row$column}
2399 format at least for the first field (i.e the reference must start with
2400 @samp{@@} in order to be interpreted correctly).  Examples:
2402 @example
2403 $1..$3        @r{first three fields in the current row}
2404 $P..$Q        @r{range, using column names (see under Advanced)}
2405 $<<<..$>>     @r{start in third column, continue to the one but last}
2406 @@2$1..@@4$3    @r{6 fields between these two fields (same as @code{A2..C4})}
2407 @@-1$-2..@@-1   @r{3 numbers from the column to the left, 2 up to current row}
2408 @@I..II        @r{between first and second hline, short for @code{@@I..@@II}}
2409 @end example
2411 @noindent Range references return a vector of values that can be fed
2412 into Calc vector functions.  Empty fields in ranges are normally
2413 suppressed, so that the vector contains only the non-empty fields (but
2414 see the @samp{E} mode switch below).  If there are no non-empty fields,
2415 @samp{[0]} is returned to avoid syntax errors in formulas.
2417 @subsubheading Field coordinates in formulas
2418 @cindex field coordinates
2419 @cindex coordinates, of field
2420 @cindex row, of field coordinates
2421 @cindex column, of field coordinates
2423 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2424 get the row or column number of the field where the formula result goes.
2425 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2426 and @code{org-table-current-column}.  Examples:
2428 @example
2429 if(@@# % 2, $#, string(""))   @r{column number on odd lines only}
2430 $3 = remote(FOO, @@@@#$2)      @r{copy column 2 from table FOO into}
2431                              @r{column 3 of the current table}
2432 @end example
2434 @noindent For the second example, table FOO must have at least as many rows
2435 as the current table.  Note that this is inefficient@footnote{The computation time scales as
2436 O(N^2) because table FOO is parsed for each field to be copied.} for large
2437 number of rows.
2439 @subsubheading Named references
2440 @cindex named references
2441 @cindex references, named
2442 @cindex name, of column or field
2443 @cindex constants, in calculations
2444 @cindex #+CONSTANTS
2446 @vindex org-table-formula-constants
2447 @samp{$name} is interpreted as the name of a column, parameter or
2448 constant.  Constants are defined globally through the variable
2449 @code{org-table-formula-constants}, and locally (for the file) through a
2450 line like
2452 @example
2453 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2454 @end example
2456 @noindent
2457 @vindex constants-unit-system
2458 @pindex constants.el
2459 Also properties (@pxref{Properties and Columns}) can be used as
2460 constants in table formulas: for a property @samp{:Xyz:} use the name
2461 @samp{$PROP_Xyz}, and the property will be searched in the current
2462 outline entry and in the hierarchy above it.  If you have the
2463 @file{constants.el} package, it will also be used to resolve constants,
2464 including natural constants like @samp{$h} for Planck's constant, and
2465 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2466 supply the values of constants in two different unit systems, @code{SI}
2467 and @code{cgs}.  Which one is used depends on the value of the variable
2468 @code{constants-unit-system}.  You can use the @code{#+STARTUP} options
2469 @code{constSI} and @code{constcgs} to set this value for the current
2470 buffer.}.  Column names and parameters can be specified in special table
2471 lines.  These are described below, see @ref{Advanced features}.  All
2472 names must start with a letter, and further consist of letters and
2473 numbers.
2475 @subsubheading Remote references
2476 @cindex remote references
2477 @cindex references, remote
2478 @cindex references, to a different table
2479 @cindex name, of column or field
2480 @cindex constants, in calculations
2481 @cindex #+TBLNAME
2483 You may also reference constants, fields and ranges from a different table,
2484 either in the current file or even in a different file.  The syntax is
2486 @example
2487 remote(NAME-OR-ID,REF)
2488 @end example
2490 @noindent
2491 where NAME can be the name of a table in the current file as set by a
2492 @code{#+TBLNAME: NAME} line before the table.  It can also be the ID of an
2493 entry, even in a different file, and the reference then refers to the first
2494 table in that entry.  REF is an absolute field or range reference as
2495 described above for example @code{@@3$3} or @code{$somename}, valid in the
2496 referenced table.
2498 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2499 @subsection Formula syntax for Calc
2500 @cindex formula syntax, Calc
2501 @cindex syntax, of formulas
2503 A formula can be any algebraic expression understood by the Emacs
2504 @file{Calc} package.  @b{Note that @file{calc} has the
2505 non-standard convention that @samp{/} has lower precedence than
2506 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.}  Before
2507 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2508 Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc, GNU
2509 Emacs Calc Manual}),
2510 variable substitution takes place according to the rules described above.
2511 @cindex vectors, in table calculations
2512 The range vectors can be directly fed into the Calc vector functions
2513 like @samp{vmean} and @samp{vsum}.
2515 @cindex format specifier
2516 @cindex mode, for @file{calc}
2517 @vindex org-calc-default-modes
2518 A formula can contain an optional mode string after a semicolon.  This
2519 string consists of flags to influence Calc and other modes during
2520 execution.  By default, Org uses the standard Calc modes (precision
2521 12, angular units degrees, fraction and symbolic modes off).  The display
2522 format, however, has been changed to @code{(float 8)} to keep tables
2523 compact.  The default settings can be configured using the variable
2524 @code{org-calc-default-modes}.
2526 @example
2527 p20           @r{set the internal Calc calculation precision to 20 digits}
2528 n3 s3 e2 f4   @r{Normal, scientific, engineering, or fixed}
2529               @r{format of the result of Calc passed back to Org.}
2530               @r{Calc formatting is unlimited in precision as}
2531               @r{long as the Calc calculation precision is greater.}
2532 D R           @r{angle modes: degrees, radians}
2533 F S           @r{fraction and symbolic modes}
2534 N             @r{interpret all fields as numbers, use 0 for non-numbers}
2535 E             @r{keep empty fields in ranges}
2536 L             @r{literal}
2537 @end example
2539 @noindent
2540 Unless you use large integer numbers or high-precision-calculation
2541 and -display for floating point numbers you may alternatively provide a
2542 @code{printf} format specifier to reformat the Calc result after it has been
2543 passed back to Org instead of letting Calc already do the
2544 formatting@footnote{The @code{printf} reformatting is limited in precision
2545 because the value passed to it is converted into an @code{integer} or
2546 @code{double}.  The @code{integer} is limited in size by truncating the
2547 signed value to 32 bits.  The @code{double} is limited in precision to 64
2548 bits overall which leaves approximately 16 significant decimal digits.}.
2549 A few examples:
2551 @example
2552 $1+$2                @r{Sum of first and second field}
2553 $1+$2;%.2f           @r{Same, format result to two decimals}
2554 exp($2)+exp($1)      @r{Math functions can be used}
2555 $0;%.1f              @r{Reformat current cell to 1 decimal}
2556 ($3-32)*5/9          @r{Degrees F -> C conversion}
2557 $c/$1/$cm            @r{Hz -> cm conversion, using @file{constants.el}}
2558 tan($1);Dp3s1        @r{Compute in degrees, precision 3, display SCI 1}
2559 sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
2560 vmean($2..$7)        @r{Compute column range mean, using vector function}
2561 vmean($2..$7);EN     @r{Same, but treat empty fields as 0}
2562 taylor($3,x=7,2)     @r{Taylor series of $3, at x=7, second degree}
2563 @end example
2565 Calc also contains a complete set of logical operations.  For example
2567 @example
2568 if($1<20,teen,string(""))  @r{"teen" if age $1 less than 20, else empty}
2569 @end example
2571 Note that you can also use two org-specific flags @code{T} and @code{t} for
2572 durations computations @ref{Durations and time values}.
2574 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2575 @subsection Emacs Lisp forms as formulas
2576 @cindex Lisp forms, as table formulas
2578 It is also possible to write a formula in Emacs Lisp; this can be useful for
2579 string manipulation and control structures, if Calc's functionality is not
2580 enough.  If a formula starts with a single-quote followed by an opening
2581 parenthesis, then it is evaluated as a Lisp form.  The evaluation should
2582 return either a string or a number.  Just as with @file{calc} formulas, you
2583 can specify modes and a printf format after a semicolon.  With Emacs Lisp
2584 forms, you need to be conscious about the way field references are
2585 interpolated into the form.  By default, a reference will be interpolated as
2586 a Lisp string (in double-quotes) containing the field.  If you provide the
2587 @samp{N} mode switch, all referenced elements will be numbers (non-number
2588 fields will be zero) and interpolated as Lisp numbers, without quotes.  If
2589 you provide the @samp{L} flag, all fields will be interpolated literally,
2590 without quotes.  I.e., if you want a reference to be interpreted as a string
2591 by the Lisp form, enclose the reference operator itself in double-quotes,
2592 like @code{"$3"}.  Ranges are inserted as space-separated fields, so you can
2593 embed them in list or vector syntax.  Here are a few examples---note how the
2594 @samp{N} mode is used when we do computations in Lisp:
2596 @example
2597 @r{Swap the first two characters of the content of column 1}
2598   '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2599 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2600   '(+ $1 $2);N
2601 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2602   '(apply '+ '($1..$4));N
2603 @end example
2605 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2606 @subsection Durations and time values
2607 @cindex Duration, computing
2608 @cindex Time, computing
2609 @vindex org-table-duration-custom-format
2611 If you want to compute time values use the @code{T} flag, either in Calc
2612 formulas or Elisp formulas:
2614 @example
2615 @group
2616   |  Task 1 |   Task 2 |    Total |
2617   |---------+----------+----------|
2618   |    2:12 |     1:47 | 03:59:00 |
2619   | 3:02:20 | -2:07:00 |     0.92 |
2620   #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2621 @end group
2622 @end example
2624 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2625 are optional.  With the @code{T} flag, computed durations will be displayed
2626 as @code{[HH:MM:SS} (see the first formula above).  With the @code{t} flag,
2627 computed durations will be displayed according to the value of the variable
2628 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2629 will display the result as a fraction of hours (see the second formula in the
2630 example above).
2632 Negative duration values can be manipulated as well, and integers will be
2633 considered as seconds in addition and subtraction.
2635 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2636 @subsection Field and range formulas
2637 @cindex field formula
2638 @cindex range formula
2639 @cindex formula, for individual table field
2640 @cindex formula, for range of fields
2642 To assign a formula to a particular field, type it directly into the field,
2643 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}.  When you press
2644 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2645 the formula will be stored as the formula for this field, evaluated, and the
2646 current field will be replaced with the result.
2648 @cindex #+TBLFM
2649 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2650 below the table.  If you type the equation in the 4th field of the 3rd data
2651 line in the table, the formula will look like @samp{@@3$4=$1+$2}.  When
2652 inserting/deleting/swapping column and rows with the appropriate commands,
2653 @i{absolute references} (but not relative ones) in stored formulas are
2654 modified in order to still reference the same field.  To avoid this from
2655 happening, in particular in range references, anchor ranges at the table
2656 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2657 using the @code{@@I} notation.  Automatic adaptation of field references does
2658 of cause not happen if you edit the table structure with normal editing
2659 commands---then you must fix the equations yourself.
2661 Instead of typing an equation into the field, you may also use the following
2662 command
2664 @table @kbd
2665 @orgcmd{C-u C-c =,org-table-eval-formula}
2666 Install a new formula for the current field.  The command prompts for a
2667 formula with default taken from the @samp{#+TBLFM:} line, applies
2668 it to the current field, and stores it.
2669 @end table
2671 The left-hand side of a formula can also be a special expression in order to
2672 assign the formula to a number of different fields.  There is no keyboard
2673 shortcut to enter such range formulas.  To add them, use the formula editor
2674 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2675 directly.
2677 @table @code
2678 @item $2=
2679 Column formula, valid for the entire column.  This is so common that Org
2680 treats these formulas in a special way, see @ref{Column formulas}.
2681 @item @@3=
2682 Row formula, applies to all fields in the specified row.  @code{@@>=} means
2683 the last row.
2684 @item @@1$2..@@4$3=
2685 Range formula, applies to all fields in the given rectangular range.  This
2686 can also be used to assign a formula to some but not all fields in a row.
2687 @item $name=
2688 Named field, see @ref{Advanced features}.
2689 @end table
2691 @node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
2692 @subsection Column formulas
2693 @cindex column formula
2694 @cindex formula, for table column
2696 When you assign a formula to a simple column reference like @code{$3=}, the
2697 same formula will be used in all fields of that column, with the following
2698 very convenient exceptions: (i) If the table contains horizontal separator
2699 hlines, everything before the first such line is considered part of the table
2700 @emph{header} and will not be modified by column formulas.  (ii) Fields that
2701 already get a value from a field/range formula will be left alone by column
2702 formulas.  These conditions make column formulas very easy to use.
2704 To assign a formula to a column, type it directly into any field in the
2705 column, preceded by an equal sign, like @samp{=$1+$2}.  When you press
2706 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2707 the formula will be stored as the formula for the current column, evaluated
2708 and the current field replaced with the result.  If the field contains only
2709 @samp{=}, the previously stored formula for this column is used.  For each
2710 column, Org will only remember the most recently used formula.  In the
2711 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}.  The
2712 left-hand side of a column formula can not be the name of column, it must be
2713 the numeric column reference or @code{$>}.
2715 Instead of typing an equation into the field, you may also use the
2716 following command:
2718 @table @kbd
2719 @orgcmd{C-c =,org-table-eval-formula}
2720 Install a new formula for the current column and replace current field with
2721 the result of the formula.  The command prompts for a formula, with default
2722 taken from the @samp{#+TBLFM} line, applies it to the current field and
2723 stores it.  With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
2724 will apply it to that many consecutive fields in the current column.
2725 @end table
2727 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2728 @subsection Editing and debugging formulas
2729 @cindex formula editing
2730 @cindex editing, of table formulas
2732 @vindex org-table-use-standard-references
2733 You can edit individual formulas in the minibuffer or directly in the
2734 field.  Org can also prepare a special buffer with all active
2735 formulas of a table.  When offering a formula for editing, Org
2736 converts references to the standard format (like @code{B3} or @code{D&})
2737 if possible.  If you prefer to only work with the internal format (like
2738 @code{@@3$2} or @code{$4}), configure the variable
2739 @code{org-table-use-standard-references}.
2741 @table @kbd
2742 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2743 Edit the formula associated with the current column/field in the
2744 minibuffer.  See @ref{Column formulas}, and @ref{Field and range formulas}.
2745 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2746 Re-insert the active formula (either a
2747 field formula, or a column formula) into the current field, so that you
2748 can edit it directly in the field.  The advantage over editing in the
2749 minibuffer is that you can use the command @kbd{C-c ?}.
2750 @orgcmd{C-c ?,org-table-field-info}
2751 While editing a formula in a table field, highlight the field(s)
2752 referenced by the reference at the cursor position in the formula.
2753 @kindex C-c @}
2754 @findex org-table-toggle-coordinate-overlays
2755 @item C-c @}
2756 Toggle the display of row and column numbers for a table, using overlays
2757 (@command{org-table-toggle-coordinate-overlays}).  These are updated each
2758 time the table is aligned; you can force it with @kbd{C-c C-c}.
2759 @kindex C-c @{
2760 @findex org-table-toggle-formula-debugger
2761 @item C-c @{
2762 Toggle the formula debugger on and off
2763 (@command{org-table-toggle-formula-debugger}).  See below.
2764 @orgcmd{C-c ',org-table-edit-formulas}
2765 Edit all formulas for the current table in a special buffer, where the
2766 formulas will be displayed one per line.  If the current field has an
2767 active formula, the cursor in the formula editor will mark it.
2768 While inside the special buffer, Org will automatically highlight
2769 any field or range reference at the cursor position.  You may edit,
2770 remove and add formulas, and use the following commands:
2771 @table @kbd
2772 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2773 Exit the formula editor and store the modified formulas.  With @kbd{C-u}
2774 prefix, also apply the new formulas to the entire table.
2775 @orgcmd{C-c C-q,org-table-fedit-abort}
2776 Exit the formula editor without installing changes.
2777 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2778 Toggle all references in the formula editor between standard (like
2779 @code{B3}) and internal (like @code{@@3$2}).
2780 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2781 Pretty-print or indent Lisp formula at point.  When in a line containing
2782 a Lisp formula, format the formula according to Emacs Lisp rules.
2783 Another @key{TAB} collapses the formula back again.  In the open
2784 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2785 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2786 Complete Lisp symbols, just like in Emacs Lisp mode.
2787 @kindex S-@key{up}
2788 @kindex S-@key{down}
2789 @kindex S-@key{left}
2790 @kindex S-@key{right}
2791 @findex org-table-fedit-ref-up
2792 @findex org-table-fedit-ref-down
2793 @findex org-table-fedit-ref-left
2794 @findex org-table-fedit-ref-right
2795 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2796 Shift the reference at point.  For example, if the reference is
2797 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2798 This also works for relative references and for hline references.
2799 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2800 Move the test line for column formulas in the Org buffer up and
2801 down.
2802 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2803 Scroll the window displaying the table.
2804 @kindex C-c @}
2805 @findex org-table-toggle-coordinate-overlays
2806 @item C-c @}
2807 Turn the coordinate grid in the table on and off.
2808 @end table
2809 @end table
2811 Making a table field blank does not remove the formula associated with
2812 the field, because that is stored in a different line (the @samp{#+TBLFM}
2813 line)---during the next recalculation the field will be filled again.
2814 To remove a formula from a field, you have to give an empty reply when
2815 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2817 @kindex C-c C-c
2818 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2819 equations with @kbd{C-c C-c} in that line or with the normal
2820 recalculation commands in the table.
2822 @subsubheading Debugging formulas
2823 @cindex formula debugging
2824 @cindex debugging, of table formulas
2825 When the evaluation of a formula leads to an error, the field content
2826 becomes the string @samp{#ERROR}.  If you would like see what is going
2827 on during variable substitution and calculation in order to find a bug,
2828 turn on formula debugging in the @code{Tbl} menu and repeat the
2829 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2830 field.  Detailed information will be displayed.
2832 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2833 @subsection Updating the table
2834 @cindex recomputing table fields
2835 @cindex updating, table
2837 Recalculation of a table is normally not automatic, but needs to be
2838 triggered by a command.  See @ref{Advanced features}, for a way to make
2839 recalculation at least semi-automatic.
2841 In order to recalculate a line of a table or the entire table, use the
2842 following commands:
2844 @table @kbd
2845 @orgcmd{C-c *,org-table-recalculate}
2846 Recalculate the current row by first applying the stored column formulas
2847 from left to right, and all field/range formulas in the current row.
2849 @kindex C-u C-c *
2850 @item C-u C-c *
2851 @kindex C-u C-c C-c
2852 @itemx C-u C-c C-c
2853 Recompute the entire table, line by line.  Any lines before the first
2854 hline are left alone, assuming that these are part of the table header.
2856 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2857 Iterate the table by recomputing it until no further changes occur.
2858 This may be necessary if some computed fields use the value of other
2859 fields that are computed @i{later} in the calculation sequence.
2860 @item M-x org-table-recalculate-buffer-tables
2861 @findex org-table-recalculate-buffer-tables
2862 Recompute all tables in the current buffer.
2863 @item M-x org-table-iterate-buffer-tables
2864 @findex org-table-iterate-buffer-tables
2865 Iterate all tables in the current buffer, in order to converge table-to-table
2866 dependencies.
2867 @end table
2869 @node Advanced features,  , Updating the table, The spreadsheet
2870 @subsection Advanced features
2872 If you want the recalculation of fields to happen automatically, or if you
2873 want to be able to assign @i{names}@footnote{Such names must start by an
2874 alphabetic character and use only alphanumeric/underscore characters.} to
2875 fields and columns, you need to reserve the first column of the table for
2876 special marking characters.
2878 @table @kbd
2879 @orgcmd{C-#,org-table-rotate-recalc-marks}
2880 Rotate the calculation mark in first column through the states @samp{ },
2881 @samp{#}, @samp{*}, @samp{!}, @samp{$}.  When there is an active region,
2882 change all marks in the region.
2883 @end table
2885 Here is an example of a table that collects exam results of students and
2886 makes use of these features:
2888 @example
2889 @group
2890 |---+---------+--------+--------+--------+-------+------|
2891 |   | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2892 |---+---------+--------+--------+--------+-------+------|
2893 | ! |         |     P1 |     P2 |     P3 |   Tot |      |
2894 | # | Maximum |     10 |     15 |     25 |    50 | 10.0 |
2895 | ^ |         |     m1 |     m2 |     m3 |    mt |      |
2896 |---+---------+--------+--------+--------+-------+------|
2897 | # | Peter   |     10 |      8 |     23 |    41 |  8.2 |
2898 | # | Sam     |      2 |      4 |      3 |     9 |  1.8 |
2899 |---+---------+--------+--------+--------+-------+------|
2900 |   | Average |        |        |        |  29.7 |      |
2901 | ^ |         |        |        |        |    at |      |
2902 | $ | max=50  |        |        |        |       |      |
2903 |---+---------+--------+--------+--------+-------+------|
2904 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2905 @end group
2906 @end example
2908 @noindent @b{Important}: please note that for these special tables,
2909 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2910 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2911 to the field itself.  The column formulas are not applied in rows with
2912 empty first field.
2914 @cindex marking characters, tables
2915 The marking characters have the following meaning:
2916 @table @samp
2917 @item !
2918 The fields in this line define names for the columns, so that you may
2919 refer to a column as @samp{$Tot} instead of @samp{$6}.
2920 @item ^
2921 This row defines names for the fields @emph{above} the row.  With such
2922 a definition, any formula in the table may use @samp{$m1} to refer to
2923 the value @samp{10}.  Also, if you assign a formula to a names field, it
2924 will be stored as @samp{$name=...}.
2925 @item _
2926 Similar to @samp{^}, but defines names for the fields in the row
2927 @emph{below}.
2928 @item $
2929 Fields in this row can define @emph{parameters} for formulas.  For
2930 example, if a field in a @samp{$} row contains @samp{max=50}, then
2931 formulas in this table can refer to the value 50 using @samp{$max}.
2932 Parameters work exactly like constants, only that they can be defined on
2933 a per-table basis.
2934 @item #
2935 Fields in this row are automatically recalculated when pressing
2936 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row.  Also, this row
2937 is selected for a global recalculation with @kbd{C-u C-c *}.  Unmarked
2938 lines will be left alone by this command.
2939 @item *
2940 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2941 not for automatic recalculation.  Use this when automatic
2942 recalculation slows down editing too much.
2943 @item
2944 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2945 All lines that should be recalculated should be marked with @samp{#}
2946 or @samp{*}.
2947 @item /
2948 Do not export this line.  Useful for lines that contain the narrowing
2949 @samp{<N>} markers or column group markers.
2950 @end table
2952 Finally, just to whet your appetite for what can be done with the
2953 fantastic @file{calc.el} package, here is a table that computes the Taylor
2954 series of degree @code{n} at location @code{x} for a couple of
2955 functions.
2957 @example
2958 @group
2959 |---+-------------+---+-----+--------------------------------------|
2960 |   | Func        | n | x   | Result                               |
2961 |---+-------------+---+-----+--------------------------------------|
2962 | # | exp(x)      | 1 | x   | 1 + x                                |
2963 | # | exp(x)      | 2 | x   | 1 + x + x^2 / 2                      |
2964 | # | exp(x)      | 3 | x   | 1 + x + x^2 / 2 + x^3 / 6            |
2965 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2966 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2    |
2967 | * | tan(x)      | 3 | x   | 0.0175 x + 1.77e-6 x^3               |
2968 |---+-------------+---+-----+--------------------------------------|
2969 #+TBLFM: $5=taylor($2,$4,$3);n3
2970 @end group
2971 @end example
2973 @node Org-Plot,  , The spreadsheet, Tables
2974 @section Org-Plot
2975 @cindex graph, in tables
2976 @cindex plot tables using Gnuplot
2977 @cindex #+PLOT
2979 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2980 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2981 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}.  To see
2982 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2983 on your system, then call @code{org-plot/gnuplot} on the following table.
2985 @example
2986 @group
2987 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2988 | Sede      | Max cites | H-index |
2989 |-----------+-----------+---------|
2990 | Chile     |    257.72 |   21.39 |
2991 | Leeds     |    165.77 |   19.68 |
2992 | Sao Paolo |     71.00 |   11.50 |
2993 | Stockholm |    134.19 |   14.33 |
2994 | Morelia   |    257.56 |   17.67 |
2995 @end group
2996 @end example
2998 Notice that Org Plot is smart enough to apply the table's headers as labels.
2999 Further control over the labels, type, content, and appearance of plots can
3000 be exercised through the @code{#+PLOT:} lines preceding a table.  See below
3001 for a complete list of Org-plot options.  For more information and examples
3002 see the Org-plot tutorial at
3003 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3005 @subsubheading Plot Options
3007 @table @code
3008 @item set
3009 Specify any @command{gnuplot} option to be set when graphing.
3011 @item title
3012 Specify the title of the plot.
3014 @item ind
3015 Specify which column of the table to use as the @code{x} axis.
3017 @item deps
3018 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3019 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3020 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3021 column).
3023 @item type
3024 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3026 @item with
3027 Specify a @code{with} option to be inserted for every col being plotted
3028 (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3029 Defaults to @code{lines}.
3031 @item file
3032 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3034 @item labels
3035 List of labels to be used for the @code{deps} (defaults to the column headers
3036 if they exist).
3038 @item line
3039 Specify an entire line to be inserted in the Gnuplot script.
3041 @item map
3042 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3043 flat mapping rather than a @code{3d} slope.
3045 @item timefmt
3046 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3047 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3049 @item script
3050 If you want total control, you can specify a script file (place the file name
3051 between double-quotes) which will be used to plot.  Before plotting, every
3052 instance of @code{$datafile} in the specified script will be replaced with
3053 the path to the generated data file.  Note: even if you set this option, you
3054 may still want to specify the plot type, as that can impact the content of
3055 the data file.
3056 @end table
3058 @node Hyperlinks, TODO Items, Tables, Top
3059 @chapter Hyperlinks
3060 @cindex hyperlinks
3062 Like HTML, Org provides links inside a file, external links to
3063 other files, Usenet articles, emails, and much more.
3065 @menu
3066 * Link format::                 How links in Org are formatted
3067 * Internal links::              Links to other places in the current file
3068 * External links::              URL-like links to the world
3069 * Handling links::              Creating, inserting and following
3070 * Using links outside Org::     Linking from my C source code?
3071 * Link abbreviations::          Shortcuts for writing complex links
3072 * Search options::              Linking to a specific location
3073 * Custom searches::             When the default search is not enough
3074 @end menu
3076 @node Link format, Internal links, Hyperlinks, Hyperlinks
3077 @section Link format
3078 @cindex link format
3079 @cindex format, of links
3081 Org will recognize plain URL-like links and activate them as
3082 clickable links.  The general link format, however, looks like this:
3084 @example
3085 [[link][description]]       @r{or alternatively}           [[link]]
3086 @end example
3088 @noindent
3089 Once a link in the buffer is complete (all brackets present), Org
3090 will change the display so that @samp{description} is displayed instead
3091 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3092 @samp{[[link]]}.  Links will be highlighted in the face @code{org-link},
3093 which by default is an underlined face.  You can directly edit the
3094 visible part of a link.  Note that this can be either the @samp{link}
3095 part (if there is no description) or the @samp{description} part.  To
3096 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3097 cursor on the link.
3099 If you place the cursor at the beginning or just behind the end of the
3100 displayed text and press @key{BACKSPACE}, you will remove the
3101 (invisible) bracket at that location.  This makes the link incomplete
3102 and the internals are again displayed as plain text.  Inserting the
3103 missing bracket hides the link internals again.  To show the
3104 internal structure of all links, use the menu entry
3105 @code{Org->Hyperlinks->Literal links}.
3107 @node Internal links, External links, Link format, Hyperlinks
3108 @section Internal links
3109 @cindex internal links
3110 @cindex links, internal
3111 @cindex targets, for links
3113 @cindex property, CUSTOM_ID
3114 If the link does not look like a URL, it is considered to be internal in the
3115 current file.  The most important case is a link like
3116 @samp{[[#my-custom-id]]} which will link to the entry with the
3117 @code{CUSTOM_ID} property @samp{my-custom-id}.  Such custom IDs are very good
3118 for HTML export (@pxref{HTML export}) where they produce pretty section
3119 links.  You are responsible yourself to make sure these custom IDs are unique
3120 in a file.
3122 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3123 lead to a text search in the current file.
3125 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3126 or with a mouse click (@pxref{Handling links}).  Links to custom IDs will
3127 point to the corresponding headline.  The preferred match for a text link is
3128 a @i{dedicated target}: the same string in double angular brackets.  Targets
3129 may be located anywhere; sometimes it is convenient to put them into a
3130 comment line.  For example
3132 @example
3133 # <<My Target>>
3134 @end example
3136 @noindent In HTML export (@pxref{HTML export}), such targets will become
3137 named anchors for direct access through @samp{http} links@footnote{Note that
3138 text before the first headline is usually not exported, so the first such
3139 target should be after the first headline, or in the line directly before the
3140 first headline.}.
3142 If no dedicated target exists, Org will search for a headline that is exactly
3143 the link text but may also include a TODO keyword and tags@footnote{To insert
3144 a link targeting a headline, in-buffer completion can be used.  Just type a
3145 star followed by a few optional letters into the buffer and press
3146 @kbd{M-@key{TAB}}.  All headlines in the current buffer will be offered as
3147 completions.}.  In non-Org files, the search will look for the words in the
3148 link text.  In the above example the search would be for @samp{my target}.
3150 Following a link pushes a mark onto Org's own mark ring.  You can
3151 return to the previous position with @kbd{C-c &}.  Using this command
3152 several times in direct succession goes back to positions recorded
3153 earlier.
3155 @menu
3156 * Radio targets::               Make targets trigger links in plain text
3157 @end menu
3159 @node Radio targets,  , Internal links, Internal links
3160 @subsection Radio targets
3161 @cindex radio targets
3162 @cindex targets, radio
3163 @cindex links, radio targets
3165 Org can automatically turn any occurrences of certain target names
3166 in normal text into a link.  So without explicitly creating a link, the
3167 text connects to the target radioing its position.  Radio targets are
3168 enclosed by triple angular brackets.  For example, a target @samp{<<<My
3169 Target>>>} causes each occurrence of @samp{my target} in normal text to
3170 become activated as a link.  The Org file is scanned automatically
3171 for radio targets only when the file is first loaded into Emacs.  To
3172 update the target list during editing, press @kbd{C-c C-c} with the
3173 cursor on or at a target.
3175 @node External links, Handling links, Internal links, Hyperlinks
3176 @section External links
3177 @cindex links, external
3178 @cindex external links
3179 @cindex links, external
3180 @cindex Gnus links
3181 @cindex BBDB links
3182 @cindex IRC links
3183 @cindex URL links
3184 @cindex file links
3185 @cindex VM links
3186 @cindex RMAIL links
3187 @cindex WANDERLUST links
3188 @cindex MH-E links
3189 @cindex USENET links
3190 @cindex SHELL links
3191 @cindex Info links
3192 @cindex Elisp links
3194 Org supports links to files, websites, Usenet and email messages,
3195 BBDB database entries and links to both IRC conversations and their
3196 logs.  External links are URL-like locators.  They start with a short
3197 identifying string followed by a colon.  There can be no space after
3198 the colon.  The following list shows examples for each link type.
3200 @example
3201 http://www.astro.uva.nl/~dominik          @r{on the web}
3202 doi:10.1000/182                           @r{DOI for an electronic resource}
3203 file:/home/dominik/images/jupiter.jpg     @r{file, absolute path}
3204 /home/dominik/images/jupiter.jpg          @r{same as above}
3205 file:papers/last.pdf                      @r{file, relative path}
3206 ./papers/last.pdf                         @r{same as above}
3207 file:/myself@@some.where:papers/last.pdf   @r{file, path on remote machine}
3208 /myself@@some.where:papers/last.pdf        @r{same as above}
3209 file:sometextfile::NNN                    @r{file, jump to line number}
3210 file:projects.org                         @r{another Org file}
3211 file:projects.org::some words             @r{text search in Org file}@footnote{
3212 The actual behavior of the search will depend on the value of
3213 the variable @code{org-link-search-must-match-exact-headline}.  If its value
3214 is nil, then a fuzzy text search will be done.  If it is t, then only the
3215 exact headline will be matched.  If the value is @code{'query-to-create},
3216 then an exact headline will be searched; if it is not found, then the user
3217 will be queried to create it.}
3218 file:projects.org::*task title            @r{heading search in Org file}
3219 file+sys:/path/to/file                    @r{open via OS, like double-click}
3220 file+emacs:/path/to/file                  @r{force opening by Emacs}
3221 docview:papers/last.pdf::NNN              @r{open in doc-view mode at page}
3222 id:B7423F4D-2E8A-471B-8810-C40F074717E9   @r{Link to heading by ID}
3223 news:comp.emacs                           @r{Usenet link}
3224 mailto:adent@@galaxy.net                   @r{Mail link}
3225 vm:folder                                 @r{VM folder link}
3226 vm:folder#id                              @r{VM message link}
3227 vm://myself@@some.where.org/folder#id      @r{VM on remote machine}
3228 wl:folder                                 @r{WANDERLUST folder link}
3229 wl:folder#id                              @r{WANDERLUST message link}
3230 mhe:folder                                @r{MH-E folder link}
3231 mhe:folder#id                             @r{MH-E message link}
3232 rmail:folder                              @r{RMAIL folder link}
3233 rmail:folder#id                           @r{RMAIL message link}
3234 gnus:group                                @r{Gnus group link}
3235 gnus:group#id                             @r{Gnus article link}
3236 bbdb:R.*Stallman                          @r{BBDB link (with regexp)}
3237 irc:/irc.com/#emacs/bob                   @r{IRC link}
3238 info:org#External links                   @r{Info node link}
3239 shell:ls *.org                            @r{A shell command}
3240 elisp:org-agenda                          @r{Interactive Elisp command}
3241 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3242 @end example
3244 For customizing Org to add new link types @ref{Adding hyperlink types}.
3246 A link should be enclosed in double brackets and may contain a
3247 descriptive text to be displayed instead of the URL (@pxref{Link
3248 format}), for example:
3250 @example
3251 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3252 @end example
3254 @noindent
3255 If the description is a file name or URL that points to an image, HTML
3256 export (@pxref{HTML export}) will inline the image as a clickable
3257 button.  If there is no description at all and the link points to an
3258 image,
3259 that image will be inlined into the exported HTML file.
3261 @cindex square brackets, around links
3262 @cindex plain text external links
3263 Org also finds external links in the normal text and activates them
3264 as links.  If spaces must be part of the link (for example in
3265 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3266 about the end of the link, enclose them in square brackets.
3268 @node Handling links, Using links outside Org, External links, Hyperlinks
3269 @section Handling links
3270 @cindex links, handling
3272 Org provides methods to create a link in the correct syntax, to
3273 insert it into an Org file, and to follow the link.
3275 @table @kbd
3276 @orgcmd{C-c l,org-store-link}
3277 @cindex storing links
3278 Store a link to the current location.  This is a @emph{global} command (you
3279 must create the key binding yourself) which can be used in any buffer to
3280 create a link.  The link will be stored for later insertion into an Org
3281 buffer (see below).  What kind of link will be created depends on the current
3282 buffer:
3284 @b{Org mode buffers}@*
3285 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3286 to the target.  Otherwise it points to the current headline, which will also
3287 be the description@footnote{If the headline contains a timestamp, it will be
3288 removed from the link and result in a wrong link -- you should avoid putting
3289 timestamp in the headline.}.
3291 @vindex org-link-to-org-use-id
3292 @cindex property, CUSTOM_ID
3293 @cindex property, ID
3294 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3295 will be stored.  In addition or alternatively (depending on the value of
3296 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3297 created and/or used to construct a link.  So using this command in Org
3298 buffers will potentially create two links: a human-readable from the custom
3299 ID, and one that is globally unique and works even if the entry is moved from
3300 file to file.  Later, when inserting the link, you need to decide which one
3301 to use.
3303 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3304 Pretty much all Emacs mail clients are supported.  The link will point to the
3305 current article, or, in some GNUS buffers, to the group.  The description is
3306 constructed from the author and the subject.
3308 @b{Web browsers: W3 and W3M}@*
3309 Here the link will be the current URL, with the page title as description.
3311 @b{Contacts: BBDB}@*
3312 Links created in a BBDB buffer will point to the current entry.
3314 @b{Chat: IRC}@*
3315 @vindex org-irc-link-to-logs
3316 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3317 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3318 the current conversation is created.  Otherwise an @samp{irc:/} style link to
3319 the user/channel/server under the point will be stored.
3321 @b{Other files}@*
3322 For any other files, the link will point to the file, with a search string
3323 (@pxref{Search options}) pointing to the contents of the current line.  If
3324 there is an active region, the selected words will form the basis of the
3325 search string.  If the automatically created link is not working correctly or
3326 accurately enough, you can write custom functions to select the search string
3327 and to do the search for particular file types---see @ref{Custom searches}.
3328 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3330 @b{Agenda view}@*
3331 When the cursor is in an agenda view, the created link points to the
3332 entry referenced by the current line.
3335 @orgcmd{C-c C-l,org-insert-link}
3336 @cindex link completion
3337 @cindex completion, of links
3338 @cindex inserting links
3339 @vindex org-keep-stored-link-after-insertion
3340 Insert a link@footnote{ Note that you don't have to use this command to
3341 insert a link.  Links in Org are plain text, and you can type or paste them
3342 straight into the buffer.  By using this command, the links are automatically
3343 enclosed in double brackets, and you will be asked for the optional
3344 descriptive text.}.  This prompts for a link to be inserted into the buffer.
3345 You can just type a link, using text for an internal link, or one of the link
3346 type prefixes mentioned in the examples above.  The link will be inserted
3347 into the buffer@footnote{After insertion of a stored link, the link will be
3348 removed from the list of stored links.  To keep it in the list later use, use
3349 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3350 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3351 If some text was selected when this command is called, the selected text
3352 becomes the default description.
3354 @b{Inserting stored links}@*
3355 All links stored during the
3356 current session are part of the history for this prompt, so you can access
3357 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3359 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3360 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3361 defined through link abbreviations (@pxref{Link abbreviations}).  If you
3362 press @key{RET} after inserting only the @var{prefix}, Org will offer
3363 specific completion support for some link types@footnote{This works by
3364 calling a special function @code{org-PREFIX-complete-link}.}  For
3365 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3366 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3367 @key{RET}} you can complete contact names.
3368 @orgkey C-u C-c C-l
3369 @cindex file name completion
3370 @cindex completion, of file names
3371 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3372 a file will be inserted and you may use file name completion to select
3373 the name of the file.  The path to the file is inserted relative to the
3374 directory of the current Org file, if the linked file is in the current
3375 directory or in a sub-directory of it, or if the path is written relative
3376 to the current directory using @samp{../}.  Otherwise an absolute path
3377 is used, if possible with @samp{~/} for your home directory.  You can
3378 force an absolute path with two @kbd{C-u} prefixes.
3380 @item C-c C-l @ @r{(with cursor on existing link)}
3381 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3382 link and description parts of the link.
3384 @cindex following links
3385 @orgcmd{C-c C-o,org-open-at-point}
3386 @vindex org-file-apps
3387 @vindex org-link-frame-setup
3388 Open link at point.  This will launch a web browser for URLs (using
3389 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3390 the corresponding links, and execute the command in a shell link.  When the
3391 cursor is on an internal link, this command runs the corresponding search.
3392 When the cursor is on a TAG list in a headline, it creates the corresponding
3393 TAGS view.  If the cursor is on a timestamp, it compiles the agenda for that
3394 date.  Furthermore, it will visit text and remote files in @samp{file:} links
3395 with Emacs and select a suitable application for local non-text files.
3396 Classification of files is based on file extension only.  See option
3397 @code{org-file-apps}.  If you want to override the default application and
3398 visit the file with Emacs, use a @kbd{C-u} prefix.  If you want to avoid
3399 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3400 If the cursor is on a headline, but not on a link, offer all links in the
3401 headline and entry text.  If you want to setup the frame configuration for
3402 following links, customize @code{org-link-frame-setup}.
3404 @orgkey @key{RET}
3405 @vindex org-return-follows-link
3406 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3407 the link at point.
3409 @kindex mouse-2
3410 @kindex mouse-1
3411 @item mouse-2
3412 @itemx mouse-1
3413 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3414 would.  Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3416 @kindex mouse-3
3417 @item mouse-3
3418 @vindex org-display-internal-link-with-indirect-buffer
3419 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3420 internal links to be displayed in another window@footnote{See the
3421 variable @code{org-display-internal-link-with-indirect-buffer}}.
3423 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3424 @cindex inlining images
3425 @cindex images, inlining
3426 @vindex org-startup-with-inline-images
3427 @cindex @code{inlineimages}, STARTUP keyword
3428 @cindex @code{noinlineimages}, STARTUP keyword
3429 Toggle the inline display of linked images.  Normally this will only inline
3430 images that have no description part in the link, i.e.@: images that will also
3431 be inlined during export.  When called with a prefix argument, also display
3432 images that do have a link description.  You can ask for inline images to be
3433 displayed at startup by configuring the variable
3434 @code{org-startup-with-inline-images}@footnote{with corresponding
3435 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3436 @orgcmd{C-c %,org-mark-ring-push}
3437 @cindex mark ring
3438 Push the current position onto the mark ring, to be able to return
3439 easily.  Commands following an internal link do this automatically.
3441 @orgcmd{C-c &,org-mark-ring-goto}
3442 @cindex links, returning to
3443 Jump back to a recorded position.  A position is recorded by the
3444 commands following internal links, and by @kbd{C-c %}.  Using this
3445 command several times in direct succession moves through a ring of
3446 previously recorded positions.
3448 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3449 @cindex links, finding next/previous
3450 Move forward/backward to the next link in the buffer.  At the limit of
3451 the buffer, the search fails once, and then wraps around.  The key
3452 bindings for this are really too long; you might want to bind this also
3453 to @kbd{C-n} and @kbd{C-p}
3454 @lisp
3455 (add-hook 'org-load-hook
3456   (lambda ()
3457     (define-key org-mode-map "\C-n" 'org-next-link)
3458     (define-key org-mode-map "\C-p" 'org-previous-link)))
3459 @end lisp
3460 @end table
3462 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3463 @section Using links outside Org
3465 You can insert and follow links that have Org syntax not only in
3466 Org, but in any Emacs buffer.  For this, you should create two
3467 global commands, like this (please select suitable global keys
3468 yourself):
3470 @lisp
3471 (global-set-key "\C-c L" 'org-insert-link-global)
3472 (global-set-key "\C-c o" 'org-open-at-point-global)
3473 @end lisp
3475 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3476 @section Link abbreviations
3477 @cindex link abbreviations
3478 @cindex abbreviation, links
3480 Long URLs can be cumbersome to type, and often many similar links are
3481 needed in a document.  For this you can use link abbreviations.  An
3482 abbreviated link looks like this
3484 @example
3485 [[linkword:tag][description]]
3486 @end example
3488 @noindent
3489 @vindex org-link-abbrev-alist
3490 where the tag is optional.
3491 The @i{linkword} must be a word, starting with a letter, followed by
3492 letters, numbers, @samp{-}, and @samp{_}.  Abbreviations are resolved
3493 according to the information in the variable @code{org-link-abbrev-alist}
3494 that relates the linkwords to replacement text.  Here is an example:
3496 @smalllisp
3497 @group
3498 (setq org-link-abbrev-alist
3499   '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3500     ("google"   . "http://www.google.com/search?q=")
3501     ("gmap"     . "http://maps.google.com/maps?q=%s")
3502     ("omap"     . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3503     ("ads"      . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3504 @end group
3505 @end smalllisp
3507 If the replacement text contains the string @samp{%s}, it will be
3508 replaced with the tag.  Otherwise the tag will be appended to the string
3509 in order to create the link.  You may also specify a function that will
3510 be called with the tag as the only argument to create the link.
3512 With the above setting, you could link to a specific bug with
3513 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3514 @code{[[google:OrgMode]]}, show the map location of the Free Software
3515 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3516 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3517 what the Org author is doing besides Emacs hacking with
3518 @code{[[ads:Dominik,C]]}.
3520 If you need special abbreviations just for a single Org buffer, you
3521 can define them in the file with
3523 @cindex #+LINK
3524 @example
3525 #+LINK: bugzilla  http://10.1.2.9/bugzilla/show_bug.cgi?id=
3526 #+LINK: google    http://www.google.com/search?q=%s
3527 @end example
3529 @noindent
3530 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3531 complete link abbreviations.  You may also define a function
3532 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
3533 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
3534 not accept any arguments, and return the full link with prefix.
3536 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3537 @section Search options in file links
3538 @cindex search option in file links
3539 @cindex file links, searching
3541 File links can contain additional information to make Emacs jump to a
3542 particular location in the file when following a link.  This can be a
3543 line number or a search option after a double@footnote{For backward
3544 compatibility, line numbers can also follow a single colon.} colon.  For
3545 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3546 links}) to a file, it encodes the words in the current line as a search
3547 string that can be used to find this line back later when following the
3548 link with @kbd{C-c C-o}.
3550 Here is the syntax of the different ways to attach a search to a file
3551 link, together with an explanation:
3553 @example
3554 [[file:~/code/main.c::255]]
3555 [[file:~/xx.org::My Target]]
3556 [[file:~/xx.org::*My Target]]
3557 [[file:~/xx.org::#my-custom-id]]
3558 [[file:~/xx.org::/regexp/]]
3559 @end example
3561 @table @code
3562 @item 255
3563 Jump to line 255.
3564 @item My Target
3565 Search for a link target @samp{<<My Target>>}, or do a text search for
3566 @samp{my target}, similar to the search in internal links, see
3567 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
3568 link will become an HTML reference to the corresponding named anchor in
3569 the linked file.
3570 @item *My Target
3571 In an Org file, restrict search to headlines.
3572 @item #my-custom-id
3573 Link to a heading with a @code{CUSTOM_ID} property
3574 @item /regexp/
3575 Do a regular expression search for @code{regexp}.  This uses the Emacs
3576 command @code{occur} to list all matches in a separate window.  If the
3577 target file is in Org mode, @code{org-occur} is used to create a
3578 sparse tree with the matches.
3579 @c If the target file is a directory,
3580 @c @code{grep} will be used to search all files in the directory.
3581 @end table
3583 As a degenerate case, a file link with an empty file name can be used
3584 to search the current file.  For example, @code{[[file:::find me]]} does
3585 a search for @samp{find me} in the current file, just as
3586 @samp{[[find me]]} would.
3588 @node Custom searches,  , Search options, Hyperlinks
3589 @section Custom Searches
3590 @cindex custom search strings
3591 @cindex search strings, custom
3593 The default mechanism for creating search strings and for doing the
3594 actual search related to a file link may not work correctly in all
3595 cases.  For example, Bib@TeX{} database files have many entries like
3596 @samp{year="1993"} which would not result in good search strings,
3597 because the only unique identification for a Bib@TeX{} entry is the
3598 citation key.
3600 @vindex org-create-file-search-functions
3601 @vindex org-execute-file-search-functions
3602 If you come across such a problem, you can write custom functions to set
3603 the right search string for a particular file type, and to do the search
3604 for the string in the file.  Using @code{add-hook}, these functions need
3605 to be added to the hook variables
3606 @code{org-create-file-search-functions} and
3607 @code{org-execute-file-search-functions}.  See the docstring for these
3608 variables for more information.  Org actually uses this mechanism
3609 for Bib@TeX{} database files, and you can use the corresponding code as
3610 an implementation example.  See the file @file{org-bibtex.el}.
3612 @node TODO Items, Tags, Hyperlinks, Top
3613 @chapter TODO items
3614 @cindex TODO items
3616 Org mode does not maintain TODO lists as separate documents@footnote{Of
3617 course, you can make a document that contains only long lists of TODO items,
3618 but this is not required.}.  Instead, TODO items are an integral part of the
3619 notes file, because TODO items usually come up while taking notes!  With Org
3620 mode, simply mark any entry in a tree as being a TODO item.  In this way,
3621 information is not duplicated, and the entire context from which the TODO
3622 item emerged is always present.
3624 Of course, this technique for managing TODO items scatters them
3625 throughout your notes file.  Org mode compensates for this by providing
3626 methods to give you an overview of all the things that you have to do.
3628 @menu
3629 * TODO basics::                 Marking and displaying TODO entries
3630 * TODO extensions::             Workflow and assignments
3631 * Progress logging::            Dates and notes for progress
3632 * Priorities::                  Some things are more important than others
3633 * Breaking down tasks::         Splitting a task into manageable pieces
3634 * Checkboxes::                  Tick-off lists
3635 @end menu
3637 @node TODO basics, TODO extensions, TODO Items, TODO Items
3638 @section Basic TODO functionality
3640 Any headline becomes a TODO item when it starts with the word
3641 @samp{TODO}, for example:
3643 @example
3644 *** TODO Write letter to Sam Fortune
3645 @end example
3647 @noindent
3648 The most important commands to work with TODO entries are:
3650 @table @kbd
3651 @orgcmd{C-c C-t,org-todo}
3652 @cindex cycling, of TODO states
3653 Rotate the TODO state of the current item among
3655 @example
3656 ,-> (unmarked) -> TODO -> DONE --.
3657 '--------------------------------'
3658 @end example
3660 The same rotation can also be done ``remotely'' from the timeline and
3661 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3663 @orgkey{C-u C-c C-t}
3664 Select a specific keyword using completion or (if it has been set up)
3665 the fast selection interface.  For the latter, you need to assign keys
3666 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3667 more information.
3669 @kindex S-@key{right}
3670 @kindex S-@key{left}
3671 @item S-@key{right} @ @r{/} @ S-@key{left}
3672 @vindex org-treat-S-cursor-todo-selection-as-state-change
3673 Select the following/preceding TODO state, similar to cycling.  Useful
3674 mostly if more than two TODO states are possible (@pxref{TODO
3675 extensions}).  See also @ref{Conflicts}, for a discussion of the interaction
3676 with @code{shift-selection-mode}.  See also the variable
3677 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3678 @orgcmd{C-c / t,org-show-todo-key}
3679 @cindex sparse tree, for TODO
3680 @vindex org-todo-keywords
3681 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}).  Folds the
3682 entire buffer, but shows all TODO items (with not-DONE state) and the
3683 headings hierarchy above them.  With a prefix argument (or by using @kbd{C-c
3684 / T}), search for a specific TODO.  You will be prompted for the keyword, and
3685 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3686 entries that match any one of these keywords.  With a numeric prefix argument
3687 N, show the tree for the Nth keyword in the variable
3688 @code{org-todo-keywords}.  With two prefix arguments, find all TODO states,
3689 both un-done and done.
3690 @orgcmd{C-c a t,org-todo-list}
3691 Show the global TODO list.  Collects the TODO items (with not-DONE states)
3692 from all agenda files (@pxref{Agenda Views}) into a single buffer.  The new
3693 buffer will be in @code{agenda-mode}, which provides commands to examine and
3694 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3695 @xref{Global TODO list}, for more information.
3696 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3697 Insert a new TODO entry below the current one.
3698 @end table
3700 @noindent
3701 @vindex org-todo-state-tags-triggers
3702 Changing a TODO state can also trigger tag changes.  See the docstring of the
3703 option @code{org-todo-state-tags-triggers} for details.
3705 @node TODO extensions, Progress logging, TODO basics, TODO Items
3706 @section Extended use of TODO keywords
3707 @cindex extended TODO keywords
3709 @vindex org-todo-keywords
3710 By default, marked TODO entries have one of only two states: TODO and
3711 DONE.  Org mode allows you to classify TODO items in more complex ways
3712 with @emph{TODO keywords} (stored in @code{org-todo-keywords}).  With
3713 special setup, the TODO keyword system can work differently in different
3714 files.
3716 Note that @i{tags} are another way to classify headlines in general and
3717 TODO items in particular (@pxref{Tags}).
3719 @menu
3720 * Workflow states::             From TODO to DONE in steps
3721 * TODO types::                  I do this, Fred does the rest
3722 * Multiple sets in one file::   Mixing it all, and still finding your way
3723 * Fast access to TODO states::  Single letter selection of a state
3724 * Per-file keywords::           Different files, different requirements
3725 * Faces for TODO keywords::     Highlighting states
3726 * TODO dependencies::           When one task needs to wait for others
3727 @end menu
3729 @node Workflow states, TODO types, TODO extensions, TODO extensions
3730 @subsection TODO keywords as workflow states
3731 @cindex TODO workflow
3732 @cindex workflow states as TODO keywords
3734 You can use TODO keywords to indicate different @emph{sequential} states
3735 in the process of working on an item, for example@footnote{Changing
3736 this variable only becomes effective after restarting Org mode in a
3737 buffer.}:
3739 @lisp
3740 (setq org-todo-keywords
3741   '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3742 @end lisp
3744 The vertical bar separates the TODO keywords (states that @emph{need
3745 action}) from the DONE states (which need @emph{no further action}).  If
3746 you don't provide the separator bar, the last state is used as the DONE
3747 state.
3748 @cindex completion, of TODO keywords
3749 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3750 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED.  You may
3751 also use a numeric prefix argument to quickly select a specific state.  For
3752 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3753 Or you can use @kbd{S-@key{left}} to go backward through the sequence.  If you
3754 define many keywords, you can use in-buffer completion
3755 (@pxref{Completion}) or even a special one-key selection scheme
3756 (@pxref{Fast access to TODO states}) to insert these words into the
3757 buffer.  Changing a TODO state can be logged with a timestamp, see
3758 @ref{Tracking TODO state changes}, for more information.
3760 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3761 @subsection TODO keywords as types
3762 @cindex TODO types
3763 @cindex names as TODO keywords
3764 @cindex types as TODO keywords
3766 The second possibility is to use TODO keywords to indicate different
3767 @emph{types} of action items.  For example, you might want to indicate
3768 that items are for ``work'' or ``home''.  Or, when you work with several
3769 people on a single project, you might want to assign action items
3770 directly to persons, by using their names as TODO keywords.  This would
3771 be set up like this:
3773 @lisp
3774 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3775 @end lisp
3777 In this case, different keywords do not indicate a sequence, but rather
3778 different types.  So the normal work flow would be to assign a task to a
3779 person, and later to mark it DONE.  Org mode supports this style by adapting
3780 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3781 @kbd{t} command in the timeline and agenda buffers.}.  When used several
3782 times in succession, it will still cycle through all names, in order to first
3783 select the right type for a task.  But when you return to the item after some
3784 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3785 to DONE.  Use prefix arguments or completion to quickly select a specific
3786 name.  You can also review the items of a specific TODO type in a sparse tree
3787 by using a numeric prefix to @kbd{C-c / t}.  For example, to see all things
3788 Lucy has to do, you would use @kbd{C-3 C-c / t}.  To collect Lucy's items
3789 from all agenda files into a single buffer, you would use the numeric prefix
3790 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3792 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3793 @subsection Multiple keyword sets in one file
3794 @cindex TODO keyword sets
3796 Sometimes you may want to use different sets of TODO keywords in
3797 parallel.  For example, you may want to have the basic
3798 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3799 separate state indicating that an item has been canceled (so it is not
3800 DONE, but also does not require action).  Your setup would then look
3801 like this:
3803 @lisp
3804 (setq org-todo-keywords
3805       '((sequence "TODO" "|" "DONE")
3806         (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3807         (sequence "|" "CANCELED")))
3808 @end lisp
3810 The keywords should all be different, this helps Org mode to keep track
3811 of which subsequence should be used for a given entry.  In this setup,
3812 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3813 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3814 (nothing) to @code{REPORT}.  Therefore you need a mechanism to initially
3815 select the correct sequence.  Besides the obvious ways like typing a
3816 keyword or using completion, you may also apply the following commands:
3818 @table @kbd
3819 @kindex C-S-@key{right}
3820 @kindex C-S-@key{left}
3821 @kindex C-u C-u C-c C-t
3822 @item C-u C-u C-c C-t
3823 @itemx C-S-@key{right}
3824 @itemx C-S-@key{left}
3825 These keys jump from one TODO subset to the next.  In the above example,
3826 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3827 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3828 @code{CANCELED}.  Note that the @kbd{C-S-} key binding conflict with
3829 @code{shift-selection-mode} (@pxref{Conflicts}).
3830 @kindex S-@key{right}
3831 @kindex S-@key{left}
3832 @item S-@key{right}
3833 @itemx S-@key{left}
3834 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3835 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3836 from @code{DONE} to @code{REPORT} in the example above.  See also
3837 @ref{Conflicts}, for a discussion of the interaction with
3838 @code{shift-selection-mode}.
3839 @end table
3841 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3842 @subsection Fast access to TODO states
3844 If you would like to quickly change an entry to an arbitrary TODO state
3845 instead of cycling through the states, you can set up keys for
3846 single-letter access to the states.  This is done by adding the section
3847 key after each keyword, in parentheses.  For example:
3849 @lisp
3850 (setq org-todo-keywords
3851       '((sequence "TODO(t)" "|" "DONE(d)")
3852         (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3853         (sequence "|" "CANCELED(c)")))
3854 @end lisp
3856 @vindex org-fast-tag-selection-include-todo
3857 If you then press @kbd{C-c C-t} followed by the selection key, the entry
3858 will be switched to this state.  @kbd{SPC} can be used to remove any TODO
3859 keyword from an entry.@footnote{Check also the variable
3860 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3861 state through the tags interface (@pxref{Setting tags}), in case you like to
3862 mingle the two concepts.  Note that this means you need to come up with
3863 unique keys across both sets of keywords.}
3865 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3866 @subsection Setting up keywords for individual files
3867 @cindex keyword options
3868 @cindex per-file keywords
3869 @cindex #+TODO
3870 @cindex #+TYP_TODO
3871 @cindex #+SEQ_TODO
3873 It can be very useful to use different aspects of the TODO mechanism in
3874 different files.  For file-local settings, you need to add special lines
3875 to the file which set the keywords and interpretation for that file
3876 only.  For example, to set one of the two examples discussed above, you
3877 need one of the following lines, starting in column zero anywhere in the
3878 file:
3880 @example
3881 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3882 @end example
3883 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3884 interpretation, but it means the same as @code{#+TODO}), or
3885 @example
3886 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3887 @end example
3889 A setup for using several sets in parallel would be:
3891 @example
3892 #+TODO: TODO | DONE
3893 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3894 #+TODO: | CANCELED
3895 @end example
3897 @cindex completion, of option keywords
3898 @kindex M-@key{TAB}
3899 @noindent To make sure you are using the correct keyword, type
3900 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3902 @cindex DONE, final TODO keyword
3903 Remember that the keywords after the vertical bar (or the last keyword
3904 if no bar is there) must always mean that the item is DONE (although you
3905 may use a different word).  After changing one of these lines, use
3906 @kbd{C-c C-c} with the cursor still in the line to make the changes
3907 known to Org mode@footnote{Org mode parses these lines only when
3908 Org mode is activated after visiting a file.  @kbd{C-c C-c} with the
3909 cursor in a line starting with @samp{#+} is simply restarting Org mode
3910 for the current buffer.}.
3912 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3913 @subsection Faces for TODO keywords
3914 @cindex faces, for TODO keywords
3916 @vindex org-todo @r{(face)}
3917 @vindex org-done @r{(face)}
3918 @vindex org-todo-keyword-faces
3919 Org mode highlights TODO keywords with special faces: @code{org-todo}
3920 for keywords indicating that an item still has to be acted upon, and
3921 @code{org-done} for keywords indicating that an item is finished.  If
3922 you are using more than 2 different states, you might want to use
3923 special faces for some of them.  This can be done using the variable
3924 @code{org-todo-keyword-faces}.  For example:
3926 @lisp
3927 @group
3928 (setq org-todo-keyword-faces
3929       '(("TODO" . org-warning) ("STARTED" . "yellow")
3930         ("CANCELED" . (:foreground "blue" :weight bold))))
3931 @end group
3932 @end lisp
3934 While using a list with face properties as shown for CANCELED @emph{should}
3935 work, this does not always seem to be the case.  If necessary, define a
3936 special face and use that.  A string is interpreted as a color.  The variable
3937 @code{org-faces-easy-properties} determines if that color is interpreted as a
3938 foreground or a background color.
3940 @node TODO dependencies,  , Faces for TODO keywords, TODO extensions
3941 @subsection TODO dependencies
3942 @cindex TODO dependencies
3943 @cindex dependencies, of TODO states
3945 @vindex org-enforce-todo-dependencies
3946 @cindex property, ORDERED
3947 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3948 dependencies.  Usually, a parent TODO task should not be marked DONE until
3949 all subtasks (defined as children tasks) are marked as DONE.  And sometimes
3950 there is a logical sequence to a number of (sub)tasks, so that one task
3951 cannot be acted upon before all siblings above it are done.  If you customize
3952 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3953 from changing state to DONE while they have children that are not DONE.
3954 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3955 will be blocked until all earlier siblings are marked DONE.  Here is an
3956 example:
3958 @example
3959 * TODO Blocked until (two) is done
3960 ** DONE one
3961 ** TODO two
3963 * Parent
3964   :PROPERTIES:
3965   :ORDERED: t
3966   :END:
3967 ** TODO a
3968 ** TODO b, needs to wait for (a)
3969 ** TODO c, needs to wait for (a) and (b)
3970 @end example
3972 @table @kbd
3973 @orgcmd{C-c C-x o,org-toggle-ordered-property}
3974 @vindex org-track-ordered-property-with-tag
3975 @cindex property, ORDERED
3976 Toggle the @code{ORDERED} property of the current entry.  A property is used
3977 for this behavior because this should be local to the current entry, not
3978 inherited like a tag.  However, if you would like to @i{track} the value of
3979 this property with a tag for better visibility, customize the variable
3980 @code{org-track-ordered-property-with-tag}.
3981 @orgkey{C-u C-u C-u C-c C-t}
3982 Change TODO state, circumventing any state blocking.
3983 @end table
3985 @vindex org-agenda-dim-blocked-tasks
3986 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3987 that cannot be closed because of such dependencies will be shown in a dimmed
3988 font or even made invisible in agenda views (@pxref{Agenda Views}).
3990 @cindex checkboxes and TODO dependencies
3991 @vindex org-enforce-todo-dependencies
3992 You can also block changes of TODO states by looking at checkboxes
3993 (@pxref{Checkboxes}).  If you set the variable
3994 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3995 checkboxes will be blocked from switching to DONE.
3997 If you need more complex dependency structures, for example dependencies
3998 between entries in different trees or files, check out the contributed
3999 module @file{org-depend.el}.
4001 @page
4002 @node Progress logging, Priorities, TODO extensions, TODO Items
4003 @section Progress logging
4004 @cindex progress logging
4005 @cindex logging, of progress
4007 Org mode can automatically record a timestamp and possibly a note when
4008 you mark a TODO item as DONE, or even each time you change the state of
4009 a TODO item.  This system is highly configurable, settings can be on a
4010 per-keyword basis and can be localized to a file or even a subtree.  For
4011 information on how to clock working time for a task, see @ref{Clocking
4012 work time}.
4014 @menu
4015 * Closing items::               When was this entry marked DONE?
4016 * Tracking TODO state changes::  When did the status change?
4017 * Tracking your habits::        How consistent have you been?
4018 @end menu
4020 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4021 @subsection Closing items
4023 The most basic logging is to keep track of @emph{when} a certain TODO
4024 item was finished.  This is achieved with@footnote{The corresponding
4025 in-buffer setting is: @code{#+STARTUP: logdone}}
4027 @lisp
4028 (setq org-log-done 'time)
4029 @end lisp
4031 @noindent
4032 Then each time you turn an entry from a TODO (not-done) state into any
4033 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
4034 just after the headline.  If you turn the entry back into a TODO item
4035 through further state cycling, that line will be removed again.  If you
4036 want to record a note along with the timestamp, use@footnote{The
4037 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4039 @lisp
4040 (setq org-log-done 'note)
4041 @end lisp
4043 @noindent
4044 You will then be prompted for a note, and that note will be stored below
4045 the entry with a @samp{Closing Note} heading.
4047 In the timeline (@pxref{Timeline}) and in the agenda
4048 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4049 display the TODO items with a @samp{CLOSED} timestamp on each day,
4050 giving you an overview of what has been done.
4052 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4053 @subsection Tracking TODO state changes
4054 @cindex drawer, for state change recording
4056 @vindex org-log-states-order-reversed
4057 @vindex org-log-into-drawer
4058 @cindex property, LOG_INTO_DRAWER
4059 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4060 might want to keep track of when a state change occurred and maybe take a
4061 note about this change.  You can either record just a timestamp, or a
4062 time-stamped note for a change.  These records will be inserted after the
4063 headline as an itemized list, newest first@footnote{See the variable
4064 @code{org-log-states-order-reversed}}.  When taking a lot of notes, you might
4065 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4066 Customize the variable @code{org-log-into-drawer} to get this
4067 behavior---the recommended drawer for this is called @code{LOGBOOK}.  You can
4068 also overrule the setting of this variable for a subtree by setting a
4069 @code{LOG_INTO_DRAWER} property.
4071 Since it is normally too much to record a note for every state, Org mode
4072 expects configuration on a per-keyword basis for this.  This is achieved by
4073 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4074 with timestamp) in parentheses after each keyword.  For example, with the
4075 setting
4077 @lisp
4078 (setq org-todo-keywords
4079   '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4080 @end lisp
4082 To record a timestamp without a note for TODO keywords configured with
4083 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4085 @noindent
4086 @vindex org-log-done
4087 you not only define global TODO keywords and fast access keys, but also
4088 request that a time is recorded when the entry is set to
4089 DONE@footnote{It is possible that Org mode will record two timestamps
4090 when you are using both @code{org-log-done} and state change logging.
4091 However, it will never prompt for two notes---if you have configured
4092 both, the state change recording note will take precedence and cancel
4093 the @samp{Closing Note}.}, and that a note is recorded when switching to
4094 WAIT or CANCELED.  The setting for WAIT is even more special: the
4095 @samp{!} after the slash means that in addition to the note taken when
4096 entering the state, a timestamp should be recorded when @i{leaving} the
4097 WAIT state, if and only if the @i{target} state does not configure
4098 logging for entering it.  So it has no effect when switching from WAIT
4099 to DONE, because DONE is configured to record a timestamp only.  But
4100 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4101 setting now triggers a timestamp even though TODO has no logging
4102 configured.
4104 You can use the exact same syntax for setting logging preferences local
4105 to a buffer:
4106 @example
4107 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4108 @end example
4110 @cindex property, LOGGING
4111 In order to define logging settings that are local to a subtree or a
4112 single item, define a LOGGING property in this entry.  Any non-empty
4113 LOGGING property resets all logging settings to nil.  You may then turn
4114 on logging for this specific tree using STARTUP keywords like
4115 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4116 settings like @code{TODO(!)}.  For example
4118 @example
4119 * TODO Log each state with only a time
4120   :PROPERTIES:
4121   :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4122   :END:
4123 * TODO Only log when switching to WAIT, and when repeating
4124   :PROPERTIES:
4125   :LOGGING: WAIT(@@) logrepeat
4126   :END:
4127 * TODO No logging at all
4128   :PROPERTIES:
4129   :LOGGING: nil
4130   :END:
4131 @end example
4133 @node Tracking your habits,  , Tracking TODO state changes, Progress logging
4134 @subsection Tracking your habits
4135 @cindex habits
4137 Org has the ability to track the consistency of a special category of TODOs,
4138 called ``habits''.  A habit has the following properties:
4140 @enumerate
4141 @item
4142 You have enabled the @code{habits} module by customizing the variable
4143 @code{org-modules}.
4144 @item
4145 The habit is a TODO item, with a TODO keyword representing an open state.
4146 @item
4147 The property @code{STYLE} is set to the value @code{habit}.
4148 @item
4149 The TODO has a scheduled date, usually with a @code{.+} style repeat
4150 interval.  A @code{++} style may be appropriate for habits with time
4151 constraints, e.g., must be done on weekends, or a @code{+} style for an
4152 unusual habit that can have a backlog, e.g., weekly reports.
4153 @item
4154 The TODO may also have minimum and maximum ranges specified by using the
4155 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4156 three days, but at most every two days.
4157 @item
4158 You must also have state logging for the @code{DONE} state enabled, in order
4159 for historical data to be represented in the consistency graph.  If it is not
4160 enabled it is not an error, but the consistency graphs will be largely
4161 meaningless.
4162 @end enumerate
4164 To give you an idea of what the above rules look like in action, here's an
4165 actual habit with some history:
4167 @example
4168 ** TODO Shave
4169    SCHEDULED: <2009-10-17 Sat .+2d/4d>
4170    - State "DONE"       from "TODO"       [2009-10-15 Thu]
4171    - State "DONE"       from "TODO"       [2009-10-12 Mon]
4172    - State "DONE"       from "TODO"       [2009-10-10 Sat]
4173    - State "DONE"       from "TODO"       [2009-10-04 Sun]
4174    - State "DONE"       from "TODO"       [2009-10-02 Fri]
4175    - State "DONE"       from "TODO"       [2009-09-29 Tue]
4176    - State "DONE"       from "TODO"       [2009-09-25 Fri]
4177    - State "DONE"       from "TODO"       [2009-09-19 Sat]
4178    - State "DONE"       from "TODO"       [2009-09-16 Wed]
4179    - State "DONE"       from "TODO"       [2009-09-12 Sat]
4180    :PROPERTIES:
4181    :STYLE:    habit
4182    :LAST_REPEAT: [2009-10-19 Mon 00:36]
4183    :END:
4184 @end example
4186 What this habit says is: I want to shave at most every 2 days (given by the
4187 @code{SCHEDULED} date and repeat interval) and at least every 4 days.  If
4188 today is the 15th, then the habit first appears in the agenda on Oct 17,
4189 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4190 after four days have elapsed.
4192 What's really useful about habits is that they are displayed along with a
4193 consistency graph, to show how consistent you've been at getting that task
4194 done in the past.  This graph shows every day that the task was done over the
4195 past three weeks, with colors for each day.  The colors used are:
4197 @table @code
4198 @item Blue
4199 If the task wasn't to be done yet on that day.
4200 @item Green
4201 If the task could have been done on that day.
4202 @item Yellow
4203 If the task was going to be overdue the next day.
4204 @item Red
4205 If the task was overdue on that day.
4206 @end table
4208 In addition to coloring each day, the day is also marked with an asterisk if
4209 the task was actually done that day, and an exclamation mark to show where
4210 the current day falls in the graph.
4212 There are several configuration variables that can be used to change the way
4213 habits are displayed in the agenda.
4215 @table @code
4216 @item org-habit-graph-column
4217 The buffer column at which the consistency graph should be drawn.  This will
4218 overwrite any text in that column, so it is a good idea to keep your habits'
4219 titles brief and to the point.
4220 @item org-habit-preceding-days
4221 The amount of history, in days before today, to appear in consistency graphs.
4222 @item org-habit-following-days
4223 The number of days after today that will appear in consistency graphs.
4224 @item org-habit-show-habits-only-for-today
4225 If non-nil, only show habits in today's agenda view.  This is set to true by
4226 default.
4227 @end table
4229 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4230 temporarily be disabled and they won't appear at all.  Press @kbd{K} again to
4231 bring them back.  They are also subject to tag filtering, if you have habits
4232 which should only be done in certain contexts, for example.
4234 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4235 @section Priorities
4236 @cindex priorities
4238 If you use Org mode extensively, you may end up with enough TODO items that
4239 it starts to make sense to prioritize them.  Prioritizing can be done by
4240 placing a @emph{priority cookie} into the headline of a TODO item, like this
4242 @example
4243 *** TODO [#A] Write letter to Sam Fortune
4244 @end example
4246 @noindent
4247 @vindex org-priority-faces
4248 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4249 @samp{C}.  @samp{A} is the highest priority.  An entry without a cookie is
4250 treated just like priority @samp{B}.  Priorities make a difference only for
4251 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4252 have no inherent meaning to Org mode.  The cookies can be highlighted with
4253 special faces by customizing the variable @code{org-priority-faces}.
4255 Priorities can be attached to any outline node; they do not need to be TODO
4256 items.
4258 @table @kbd
4259 @item @kbd{C-c ,}
4260 @kindex @kbd{C-c ,}
4261 @findex org-priority
4262 Set the priority of the current headline (@command{org-priority}).  The
4263 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4264 When you press @key{SPC} instead, the priority cookie is removed from the
4265 headline.  The priorities can also be changed ``remotely'' from the timeline
4266 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4268 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4269 @vindex org-priority-start-cycle-with-default
4270 Increase/decrease priority of current headline@footnote{See also the option
4271 @code{org-priority-start-cycle-with-default}.}.  Note that these keys are
4272 also used to modify timestamps (@pxref{Creating timestamps}).  See also
4273 @ref{Conflicts}, for a discussion of the interaction with
4274 @code{shift-selection-mode}.
4275 @end table
4277 @vindex org-highest-priority
4278 @vindex org-lowest-priority
4279 @vindex org-default-priority
4280 You can change the range of allowed priorities by setting the variables
4281 @code{org-highest-priority}, @code{org-lowest-priority}, and
4282 @code{org-default-priority}.  For an individual buffer, you may set
4283 these values (highest, lowest, default) like this (please make sure that
4284 the highest priority is earlier in the alphabet than the lowest
4285 priority):
4287 @cindex #+PRIORITIES
4288 @example
4289 #+PRIORITIES: A C B
4290 @end example
4292 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4293 @section Breaking tasks down into subtasks
4294 @cindex tasks, breaking down
4295 @cindex statistics, for TODO items
4297 @vindex org-agenda-todo-list-sublevels
4298 It is often advisable to break down large tasks into smaller, manageable
4299 subtasks.  You can do this by creating an outline tree below a TODO item,
4300 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4301 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.  To keep
4302 the overview over the fraction of subtasks that are already completed, insert
4303 either @samp{[/]} or @samp{[%]} anywhere in the headline.  These cookies will
4304 be updated each time the TODO status of a child changes, or when pressing
4305 @kbd{C-c C-c} on the cookie.  For example:
4307 @example
4308 * Organize Party [33%]
4309 ** TODO Call people [1/2]
4310 *** TODO Peter
4311 *** DONE Sarah
4312 ** TODO Buy food
4313 ** DONE Talk to neighbor
4314 @end example
4316 @cindex property, COOKIE_DATA
4317 If a heading has both checkboxes and TODO children below it, the meaning of
4318 the statistics cookie become ambiguous.  Set the property
4319 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4320 this issue.
4322 @vindex org-hierarchical-todo-statistics
4323 If you would like to have the statistics cookie count any TODO entries in the
4324 subtree (not just direct children), configure the variable
4325 @code{org-hierarchical-todo-statistics}.  To do this for a single subtree,
4326 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4327 property.
4329 @example
4330 * Parent capturing statistics [2/20]
4331   :PROPERTIES:
4332   :COOKIE_DATA: todo recursive
4333   :END:
4334 @end example
4336 If you would like a TODO entry to automatically change to DONE
4337 when all children are done, you can use the following setup:
4339 @example
4340 (defun org-summary-todo (n-done n-not-done)
4341   "Switch entry to DONE when all subentries are done, to TODO otherwise."
4342   (let (org-log-done org-log-states)   ; turn off logging
4343     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4345 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4346 @end example
4349 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4350 large number of subtasks (@pxref{Checkboxes}).
4353 @node Checkboxes,  , Breaking down tasks, TODO Items
4354 @section Checkboxes
4355 @cindex checkboxes
4357 @vindex org-list-automatic-rules
4358 Every item in a plain list@footnote{With the exception of description
4359 lists.  But you can allow it by modifying @code{org-list-automatic-rules}
4360 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4361 it with the string @samp{[ ]}.  This feature is similar to TODO items
4362 (@pxref{TODO Items}), but is more lightweight.  Checkboxes are not included
4363 into the global TODO list, so they are often great to split a task into a
4364 number of simple steps.  Or you can use them in a shopping list.  To toggle a
4365 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4366 @file{org-mouse.el}).
4368 Here is an example of a checkbox list.
4370 @example
4371 * TODO Organize party [2/4]
4372   - [-] call people [1/3]
4373     - [ ] Peter
4374     - [X] Sarah
4375     - [ ] Sam
4376   - [X] order food
4377   - [ ] think about what music to play
4378   - [X] talk to the neighbors
4379 @end example
4381 Checkboxes work hierarchically, so if a checkbox item has children that
4382 are checkboxes, toggling one of the children checkboxes will make the
4383 parent checkbox reflect if none, some, or all of the children are
4384 checked.
4386 @cindex statistics, for checkboxes
4387 @cindex checkbox statistics
4388 @cindex property, COOKIE_DATA
4389 @vindex org-hierarchical-checkbox-statistics
4390 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4391 indicating how many checkboxes present in this entry have been checked off,
4392 and the total number of checkboxes present.  This can give you an idea on how
4393 many checkboxes remain, even without opening a folded entry.  The cookies can
4394 be placed into a headline or into (the first line of) a plain list item.
4395 Each cookie covers checkboxes of direct children structurally below the
4396 headline/item on which the cookie appears@footnote{Set the variable
4397 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4398 count all checkboxes below the cookie, not just those belonging to direct
4399 children.}.  You have to insert the cookie yourself by typing either
4400 @samp{[/]} or @samp{[%]}.  With @samp{[/]} you get an @samp{n out of m}
4401 result, as in the examples above.  With @samp{[%]} you get information about
4402 the percentage of checkboxes checked (in the above example, this would be
4403 @samp{[50%]} and @samp{[33%]}, respectively).  In a headline, a cookie can
4404 count either checkboxes below the heading or TODO states of children, and it
4405 will display whatever was changed last.  Set the property @code{COOKIE_DATA}
4406 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4408 @cindex blocking, of checkboxes
4409 @cindex checkbox blocking
4410 @cindex property, ORDERED
4411 If the current outline node has an @code{ORDERED} property, checkboxes must
4412 be checked off in sequence, and an error will be thrown if you try to check
4413 off a box while there are unchecked boxes above it.
4415 @noindent The following commands work with checkboxes:
4417 @table @kbd
4418 @orgcmd{C-c C-c,org-toggle-checkbox}
4419 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4420 With a single prefix argument, add an empty checkbox or remove the current
4421 one@footnote{`C-u C-c C-c' on the @emph{first} item of a list with no checkbox
4422 will add checkboxes to the rest of the list.}.  With a double prefix argument, set it to @samp{[-]}, which is
4423 considered to be an intermediate state.
4424 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4425 Toggle checkbox status or (with prefix arg) checkbox presence at point.  With
4426 double prefix argument, set it to @samp{[-]}, which is considered to be an
4427 intermediate state.
4428 @itemize @minus
4429 @item
4430 If there is an active region, toggle the first checkbox in the region
4431 and set all remaining boxes to the same status as the first.  With a prefix
4432 arg, add or remove the checkbox for all items in the region.
4433 @item
4434 If the cursor is in a headline, toggle checkboxes in the region between
4435 this headline and the next (so @emph{not} the entire subtree).
4436 @item
4437 If there is no active region, just toggle the checkbox at point.
4438 @end itemize
4439 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4440 Insert a new item with a checkbox.  This works only if the cursor is already
4441 in a plain list item (@pxref{Plain lists}).
4442 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4443 @vindex org-track-ordered-property-with-tag
4444 @cindex property, ORDERED
4445 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4446 be checked off in sequence.  A property is used for this behavior because
4447 this should be local to the current entry, not inherited like a tag.
4448 However, if you would like to @i{track} the value of this property with a tag
4449 for better visibility, customize the variable
4450 @code{org-track-ordered-property-with-tag}.
4451 @orgcmd{C-c #,org-update-statistics-cookies}
4452 Update the statistics cookie in the current outline entry.  When called with
4453 a @kbd{C-u} prefix, update the entire file.  Checkbox statistic cookies are
4454 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4455 new ones with @kbd{M-S-@key{RET}}.  TODO statistics cookies update when
4456 changing TODO states.  If you delete boxes/entries or add/change them by
4457 hand, use this command to get things back into sync.
4458 @end table
4460 @node Tags, Properties and Columns, TODO Items, Top
4461 @chapter Tags
4462 @cindex tags
4463 @cindex headline tagging
4464 @cindex matching, tags
4465 @cindex sparse tree, tag based
4467 An excellent way to implement labels and contexts for cross-correlating
4468 information is to assign @i{tags} to headlines.  Org mode has extensive
4469 support for tags.
4471 @vindex org-tag-faces
4472 Every headline can contain a list of tags; they occur at the end of the
4473 headline.  Tags are normal words containing letters, numbers, @samp{_}, and
4474 @samp{@@}.  Tags must be preceded and followed by a single colon, e.g.,
4475 @samp{:work:}.  Several tags can be specified, as in @samp{:work:urgent:}.
4476 Tags will by default be in bold face with the same color as the headline.
4477 You may specify special faces for specific tags using the variable
4478 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4479 (@pxref{Faces for TODO keywords}).
4481 @menu
4482 * Tag inheritance::             Tags use the tree structure of the outline
4483 * Setting tags::                How to assign tags to a headline
4484 * Tag searches::                Searching for combinations of tags
4485 @end menu
4487 @node Tag inheritance, Setting tags, Tags, Tags
4488 @section Tag inheritance
4489 @cindex tag inheritance
4490 @cindex inheritance, of tags
4491 @cindex sublevels, inclusion into tags match
4493 @i{Tags} make use of the hierarchical structure of outline trees.  If a
4494 heading has a certain tag, all subheadings will inherit the tag as
4495 well.  For example, in the list
4497 @example
4498 * Meeting with the French group      :work:
4499 ** Summary by Frank                  :boss:notes:
4500 *** TODO Prepare slides for him      :action:
4501 @end example
4503 @noindent
4504 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4505 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4506 explicitly marked with those tags.  You can also set tags that all entries in
4507 a file should inherit just as if these tags were defined in a hypothetical
4508 level zero that surrounds the entire file.  Use a line like this@footnote{As
4509 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4510 changes in the line.}:
4512 @cindex #+FILETAGS
4513 @example
4514 #+FILETAGS: :Peter:Boss:Secret:
4515 @end example
4517 @noindent
4518 @vindex org-use-tag-inheritance
4519 @vindex org-tags-exclude-from-inheritance
4520 To limit tag inheritance to specific tags, or to turn it off entirely, use
4521 the variables @code{org-use-tag-inheritance} and
4522 @code{org-tags-exclude-from-inheritance}.
4524 @vindex org-tags-match-list-sublevels
4525 When a headline matches during a tags search while tag inheritance is turned
4526 on, all the sublevels in the same tree will (for a simple match form) match
4527 as well@footnote{This is only true if the search does not involve more
4528 complex tests including properties (@pxref{Property searches}).}.  The list
4529 of matches may then become very long.  If you only want to see the first tags
4530 match in a subtree, configure the variable
4531 @code{org-tags-match-list-sublevels} (not recommended).
4533 @node Setting tags, Tag searches, Tag inheritance, Tags
4534 @section Setting tags
4535 @cindex setting tags
4536 @cindex tags, setting
4538 @kindex M-@key{TAB}
4539 Tags can simply be typed into the buffer at the end of a headline.
4540 After a colon, @kbd{M-@key{TAB}} offers completion on tags.  There is
4541 also a special command for inserting tags:
4543 @table @kbd
4544 @orgcmd{C-c C-q,org-set-tags-command}
4545 @cindex completion, of tags
4546 @vindex org-tags-column
4547 Enter new tags for the current headline.  Org mode will either offer
4548 completion or a special single-key interface for setting tags, see
4549 below.  After pressing @key{RET}, the tags will be inserted and aligned
4550 to @code{org-tags-column}.  When called with a @kbd{C-u} prefix, all
4551 tags in the current buffer will be aligned to that column, just to make
4552 things look nice.  TAGS are automatically realigned after promotion,
4553 demotion, and TODO state changes (@pxref{TODO basics}).
4554 @orgcmd{C-c C-c,org-set-tags-command}
4555 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4556 @end table
4558 @vindex org-tag-alist
4559 Org supports tag insertion based on a @emph{list of tags}.  By
4560 default this list is constructed dynamically, containing all tags
4561 currently used in the buffer.  You may also globally specify a hard list
4562 of tags with the variable @code{org-tag-alist}.  Finally you can set
4563 the default tags for a given file with lines like
4565 @cindex #+TAGS
4566 @example
4567 #+TAGS: @@work @@home @@tennisclub
4568 #+TAGS: laptop car pc sailboat
4569 @end example
4571 If you have globally defined your preferred set of tags using the
4572 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4573 in a specific file, add an empty TAGS option line to that file:
4575 @example
4576 #+TAGS:
4577 @end example
4579 @vindex org-tag-persistent-alist
4580 If you have a preferred set of tags that you would like to use in every file,
4581 in addition to those defined on a per-file basis by TAGS option lines, then
4582 you may specify a list of tags with the variable
4583 @code{org-tag-persistent-alist}.  You may turn this off on a per-file basis
4584 by adding a STARTUP option line to that file:
4586 @example
4587 #+STARTUP: noptag
4588 @end example
4590 By default Org mode uses the standard minibuffer completion facilities for
4591 entering tags.  However, it also implements another, quicker, tag selection
4592 method called @emph{fast tag selection}.  This allows you to select and
4593 deselect tags with just a single key press.  For this to work well you should
4594 assign unique letters to most of your commonly used tags.  You can do this
4595 globally by configuring the variable @code{org-tag-alist} in your
4596 @file{.emacs} file.  For example, you may find the need to tag many items in
4597 different files with @samp{:@@home:}.  In this case you can set something
4598 like:
4600 @lisp
4601 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4602 @end lisp
4604 @noindent If the tag is only relevant to the file you are working on, then you
4605 can instead set the TAGS option line as:
4607 @example
4608 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)  laptop(l)  pc(p)
4609 @end example
4611 @noindent The tags interface will show the available tags in a splash
4612 window.  If you want to start a new line after a specific tag, insert
4613 @samp{\n} into the tag list
4615 @example
4616 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t) \n laptop(l)  pc(p)
4617 @end example
4619 @noindent or write them in two lines:
4621 @example
4622 #+TAGS: @@work(w)  @@home(h)  @@tennisclub(t)
4623 #+TAGS: laptop(l)  pc(p)
4624 @end example
4626 @noindent
4627 You can also group together tags that are mutually exclusive by using
4628 braces, as in:
4630 @example
4631 #+TAGS: @{ @@work(w)  @@home(h)  @@tennisclub(t) @}  laptop(l)  pc(p)
4632 @end example
4634 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4635 and @samp{@@tennisclub} should be selected.  Multiple such groups are allowed.
4637 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4638 these lines to activate any changes.
4640 @noindent
4641 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4642 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4643 of the braces.  Similarly, you can use @code{:newline} to indicate a line
4644 break.  The previous example would be set globally by the following
4645 configuration:
4647 @lisp
4648 (setq org-tag-alist '((:startgroup . nil)
4649                       ("@@work" . ?w) ("@@home" . ?h)
4650                       ("@@tennisclub" . ?t)
4651                       (:endgroup . nil)
4652                       ("laptop" . ?l) ("pc" . ?p)))
4653 @end lisp
4655 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4656 automatically present you with a special interface, listing inherited tags,
4657 the tags of the current headline, and a list of all valid tags with
4658 corresponding keys@footnote{Keys will automatically be assigned to tags which
4659 have no configured keys.}.  In this interface, you can use the following
4660 keys:
4662 @table @kbd
4663 @item a-z...
4664 Pressing keys assigned to tags will add or remove them from the list of
4665 tags in the current line.  Selecting a tag in a group of mutually
4666 exclusive tags will turn off any other tags from that group.
4667 @kindex @key{TAB}
4668 @item @key{TAB}
4669 Enter a tag in the minibuffer, even if the tag is not in the predefined
4670 list.  You will be able to complete on all tags present in the buffer.
4671 You can also add several tags: just separate them with a comma.
4673 @kindex @key{SPC}
4674 @item @key{SPC}
4675 Clear all tags for this line.
4676 @kindex @key{RET}
4677 @item @key{RET}
4678 Accept the modified set.
4679 @item C-g
4680 Abort without installing changes.
4681 @item q
4682 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4683 @item !
4684 Turn off groups of mutually exclusive tags.  Use this to (as an
4685 exception) assign several tags from such a group.
4686 @item C-c
4687 Toggle auto-exit after the next change (see below).
4688 If you are using expert mode, the first @kbd{C-c} will display the
4689 selection window.
4690 @end table
4692 @noindent
4693 This method lets you assign tags to a headline with very few keys.  With
4694 the above setup, you could clear the current tags and set @samp{@@home},
4695 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4696 C-c @key{SPC} h l p @key{RET}}.  Switching from @samp{@@home} to
4697 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4698 alternatively with @kbd{C-c C-c C-c w}.  Adding the non-predefined tag
4699 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4700 @key{RET} @key{RET}}.
4702 @vindex org-fast-tag-selection-single-key
4703 If you find that most of the time you need only a single key press to
4704 modify your list of tags, set the variable
4705 @code{org-fast-tag-selection-single-key}.  Then you no longer have to
4706 press @key{RET} to exit fast tag selection---it will immediately exit
4707 after the first change.  If you then occasionally need more keys, press
4708 @kbd{C-c} to turn off auto-exit for the current tag selection process
4709 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4710 C-c}).  If you set the variable to the value @code{expert}, the special
4711 window is not even shown for single-key tag selection, it comes up only
4712 when you press an extra @kbd{C-c}.
4714 @node Tag searches,  , Setting tags, Tags
4715 @section Tag searches
4716 @cindex tag searches
4717 @cindex searching for tags
4719 Once a system of tags has been set up, it can be used to collect related
4720 information into special lists.
4722 @table @kbd
4723 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
4724 Create a sparse tree with all headlines matching a tags search.  With a
4725 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4726 @orgcmd{C-c a m,org-tags-view}
4727 Create a global list of tag matches from all agenda files.
4728 @xref{Matching tags and properties}.
4729 @orgcmd{C-c a M,org-tags-view}
4730 @vindex org-tags-match-list-sublevels
4731 Create a global list of tag matches from all agenda files, but check
4732 only TODO items and force checking subitems (see variable
4733 @code{org-tags-match-list-sublevels}).
4734 @end table
4736 These commands all prompt for a match string which allows basic Boolean logic
4737 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4738 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4739 which are tagged, like @samp{Kathy} or @samp{Sally}.  The full syntax of the search
4740 string is rich and allows also matching against TODO keywords, entry levels
4741 and properties.  For a complete description with many examples, see
4742 @ref{Matching tags and properties}.
4745 @node Properties and Columns, Dates and Times, Tags, Top
4746 @chapter Properties and columns
4747 @cindex properties
4749 A property is a key-value pair associated with an entry.  Properties can be
4750 set so they are associated with a single entry, with every entry in a tree,
4751 or with every entry in an Org mode file.
4753 There are two main applications for properties in Org mode.  First,
4754 properties are like tags, but with a value.  Imagine maintaining a file where
4755 you document bugs and plan releases for a piece of software.  Instead of
4756 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
4757 property, say @code{:Release:}, that in different subtrees has different
4758 values, such as @code{1.0} or @code{2.0}.  Second, you can use properties to
4759 implement (very basic) database capabilities in an Org buffer.  Imagine
4760 keeping track of your music CDs, where properties could be things such as the
4761 album, artist, date of release, number of tracks, and so on.
4763 Properties can be conveniently edited and viewed in column view
4764 (@pxref{Column view}).
4766 @menu
4767 * Property syntax::             How properties are spelled out
4768 * Special properties::          Access to other Org mode features
4769 * Property searches::           Matching property values
4770 * Property inheritance::        Passing values down the tree
4771 * Column view::                 Tabular viewing and editing
4772 * Property API::                Properties for Lisp programmers
4773 @end menu
4775 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4776 @section Property syntax
4777 @cindex property syntax
4778 @cindex drawer, for properties
4780 Properties are key-value pairs.  When they are associated with a single entry
4781 or with a tree they need to be inserted into a special
4782 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}.  Each property
4783 is specified on a single line, with the key (surrounded by colons)
4784 first, and the value after it.  Here is an example:
4786 @example
4787 * CD collection
4788 ** Classic
4789 *** Goldberg Variations
4790     :PROPERTIES:
4791     :Title:     Goldberg Variations
4792     :Composer:  J.S. Bach
4793     :Artist:    Glen Gould
4794     :Publisher: Deutsche Grammophon
4795     :NDisks:    1
4796     :END:
4797 @end example
4799 Depending on the value of @code{org-use-property-inheritance}, a property set
4800 this way will either be associated with a single entry, or the sub-tree
4801 defined by the entry, see @ref{Property inheritance}.
4803 You may define the allowed values for a particular property @samp{:Xyz:}
4804 by setting a property @samp{:Xyz_ALL:}.  This special property is
4805 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4806 the entire tree.  When allowed values are defined, setting the
4807 corresponding property becomes easier and is less prone to typing
4808 errors.  For the example with the CD collection, we can predefine
4809 publishers and the number of disks in a box like this:
4811 @example
4812 * CD collection
4813   :PROPERTIES:
4814   :NDisks_ALL:  1 2 3 4
4815   :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4816   :END:
4817 @end example
4819 If you want to set properties that can be inherited by any entry in a
4820 file, use a line like
4821 @cindex property, _ALL
4822 @cindex #+PROPERTY
4823 @example
4824 #+PROPERTY: NDisks_ALL 1 2 3 4
4825 @end example
4827 If you want to add to the value of an existing property, append a @code{+} to
4828 the property name.  The following results in the property @code{var} having
4829 the value ``foo=1 bar=2''.
4830 @cindex property, +
4831 @example
4832 #+PROPERTY: var  foo=1
4833 #+PROPERTY: var+ bar=2
4834 @end example
4836 It is also possible to add to the values of inherited properties.  The
4837 following results in the @code{genres} property having the value ``Classic
4838 Baroque'' under the @code{Goldberg Variations} subtree.
4839 @cindex property, +
4840 @example
4841 * CD collection
4842 ** Classic
4843     :PROPERTIES:
4844     :GENRES: Classic
4845     :END:
4846 *** Goldberg Variations
4847     :PROPERTIES:
4848     :Title:     Goldberg Variations
4849     :Composer:  J.S. Bach
4850     :Artist:    Glen Gould
4851     :Publisher: Deutsche Grammophon
4852     :NDisks:    1
4853     :GENRES+:   Baroque
4854     :END:
4855 @end example
4856 Note that a property can only have one entry per Drawer.
4858 @vindex org-global-properties
4859 Property values set with the global variable
4860 @code{org-global-properties} can be inherited by all entries in all
4861 Org files.
4863 @noindent
4864 The following commands help to work with properties:
4866 @table @kbd
4867 @orgcmd{M-@key{TAB},pcomplete}
4868 After an initial colon in a line, complete property keys.  All keys used
4869 in the current file will be offered as possible completions.
4870 @orgcmd{C-c C-x p,org-set-property}
4871 Set a property.  This prompts for a property name and a value.  If
4872 necessary, the property drawer is created as well.
4873 @item M-x org-insert-property-drawer
4874 @findex org-insert-property-drawer
4875 Insert a property drawer into the current entry.  The drawer will be
4876 inserted early in the entry, but after the lines with planning
4877 information like deadlines.
4878 @orgcmd{C-c C-c,org-property-action}
4879 With the cursor in a property drawer, this executes property commands.
4880 @orgcmd{C-c C-c s,org-set-property}
4881 Set a property in the current entry.  Both the property and the value
4882 can be inserted using completion.
4883 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4884 Switch property at point to the next/previous allowed value.
4885 @orgcmd{C-c C-c d,org-delete-property}
4886 Remove a property from the current entry.
4887 @orgcmd{C-c C-c D,org-delete-property-globally}
4888 Globally remove a property, from all entries in the current file.
4889 @orgcmd{C-c C-c c,org-compute-property-at-point}
4890 Compute the property at point, using the operator and scope from the
4891 nearest column format definition.
4892 @end table
4894 @node Special properties, Property searches, Property syntax, Properties and Columns
4895 @section Special properties
4896 @cindex properties, special
4898 Special properties provide an alternative access method to Org mode features,
4899 like the TODO state or the priority of an entry, discussed in the previous
4900 chapters.  This interface exists so that you can include these states in a
4901 column view (@pxref{Column view}), or to use them in queries.  The following
4902 property names are special and (except for @code{:CATEGORY:}) should not be
4903 used as keys in the properties drawer:
4905 @cindex property, special, TODO
4906 @cindex property, special, TAGS
4907 @cindex property, special, ALLTAGS
4908 @cindex property, special, CATEGORY
4909 @cindex property, special, PRIORITY
4910 @cindex property, special, DEADLINE
4911 @cindex property, special, SCHEDULED
4912 @cindex property, special, CLOSED
4913 @cindex property, special, TIMESTAMP
4914 @cindex property, special, TIMESTAMP_IA
4915 @cindex property, special, CLOCKSUM
4916 @cindex property, special, BLOCKED
4917 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4918 @cindex property, special, ITEM
4919 @cindex property, special, FILE
4920 @example
4921 TODO         @r{The TODO keyword of the entry.}
4922 TAGS         @r{The tags defined directly in the headline.}
4923 ALLTAGS      @r{All tags, including inherited ones.}
4924 CATEGORY     @r{The category of an entry.}
4925 PRIORITY     @r{The priority of the entry, a string with a single letter.}
4926 DEADLINE     @r{The deadline time string, without the angular brackets.}
4927 SCHEDULED    @r{The scheduling timestamp, without the angular brackets.}
4928 CLOSED       @r{When was this entry closed?}
4929 TIMESTAMP    @r{The first keyword-less timestamp in the entry.}
4930 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4931 CLOCKSUM     @r{The sum of CLOCK intervals in the subtree.  @code{org-clock-sum}}
4932              @r{must be run first to compute the values in the current buffer.}
4933 BLOCKED      @r{"t" if task is currently blocked by children or siblings}
4934 ITEM         @r{The content of the entry.}
4935 FILE         @r{The filename the entry is located in.}
4936 @end example
4938 @node Property searches, Property inheritance, Special properties, Properties and Columns
4939 @section Property searches
4940 @cindex properties, searching
4941 @cindex searching, of properties
4943 To create sparse trees and special lists with selection based on properties,
4944 the same commands are used as for tag searches (@pxref{Tag searches}).
4945 @table @kbd
4946 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4947 Create a sparse tree with all matching entries.  With a
4948 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4949 @orgcmd{C-c a m,org-tags-view}
4950 Create a global list of tag/property  matches from all agenda files.
4951 @xref{Matching tags and properties}.
4952 @orgcmd{C-c a M,org-tags-view}
4953 @vindex org-tags-match-list-sublevels
4954 Create a global list of tag matches from all agenda files, but check
4955 only TODO items and force checking of subitems (see variable
4956 @code{org-tags-match-list-sublevels}).
4957 @end table
4959 The syntax for the search string is described in @ref{Matching tags and
4960 properties}.
4962 There is also a special command for creating sparse trees based on a
4963 single property:
4965 @table @kbd
4966 @orgkey{C-c / p}
4967 Create a sparse tree based on the value of a property.  This first
4968 prompts for the name of a property, and then for a value.  A sparse tree
4969 is created with all entries that define this property with the given
4970 value.  If you enclose the value in curly braces, it is interpreted as
4971 a regular expression and matched against the property values.
4972 @end table
4974 @node Property inheritance, Column view, Property searches, Properties and Columns
4975 @section Property Inheritance
4976 @cindex properties, inheritance
4977 @cindex inheritance, of properties
4979 @vindex org-use-property-inheritance
4980 The outline structure of Org mode documents lends itself to an
4981 inheritance model of properties: if the parent in a tree has a certain
4982 property, the children can inherit this property.  Org mode does not
4983 turn this on by default, because it can slow down property searches
4984 significantly and is often not needed.  However, if you find inheritance
4985 useful, you can turn it on by setting the variable
4986 @code{org-use-property-inheritance}.  It may be set to @code{t} to make
4987 all properties inherited from the parent, to a list of properties
4988 that should be inherited, or to a regular expression that matches
4989 inherited properties.  If a property has the value @samp{nil}, this is
4990 interpreted as an explicit undefine of the property, so that inheritance
4991 search will stop at this value and return @code{nil}.
4993 Org mode has a few properties for which inheritance is hard-coded, at
4994 least for the special applications for which they are used:
4996 @cindex property, COLUMNS
4997 @table @code
4998 @item COLUMNS
4999 The @code{:COLUMNS:} property defines the format of column view
5000 (@pxref{Column view}).  It is inherited in the sense that the level
5001 where a @code{:COLUMNS:} property is defined is used as the starting
5002 point for a column view table, independently of the location in the
5003 subtree from where columns view is turned on.
5004 @item CATEGORY
5005 @cindex property, CATEGORY
5006 For agenda view, a category set through a @code{:CATEGORY:} property
5007 applies to the entire subtree.
5008 @item ARCHIVE
5009 @cindex property, ARCHIVE
5010 For archiving, the @code{:ARCHIVE:} property may define the archive
5011 location for the entire subtree (@pxref{Moving subtrees}).
5012 @item LOGGING
5013 @cindex property, LOGGING
5014 The LOGGING property may define logging settings for an entry or a
5015 subtree (@pxref{Tracking TODO state changes}).
5016 @end table
5018 @node Column view, Property API, Property inheritance, Properties and Columns
5019 @section Column view
5021 A great way to view and edit properties in an outline tree is
5022 @emph{column view}.  In column view, each outline node is turned into a
5023 table row.  Columns in this table provide access to properties of the
5024 entries.  Org mode implements columns by overlaying a tabular structure
5025 over the headline of each item.  While the headlines have been turned
5026 into a table row, you can still change the visibility of the outline
5027 tree.  For example, you get a compact table by switching to CONTENTS
5028 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5029 is active), but you can still open, read, and edit the entry below each
5030 headline.  Or, you can switch to column view after executing a sparse
5031 tree command and in this way get a table only for the selected items.
5032 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5033 queries have collected selected items, possibly from a number of files.
5035 @menu
5036 * Defining columns::            The COLUMNS format property
5037 * Using column view::           How to create and use column view
5038 * Capturing column view::       A dynamic block for column view
5039 @end menu
5041 @node Defining columns, Using column view, Column view, Column view
5042 @subsection Defining columns
5043 @cindex column view, for properties
5044 @cindex properties, column view
5046 Setting up a column view first requires defining the columns.  This is
5047 done by defining a column format line.
5049 @menu
5050 * Scope of column definitions::  Where defined, where valid?
5051 * Column attributes::           Appearance and content of a column
5052 @end menu
5054 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5055 @subsubsection Scope of column definitions
5057 To define a column format for an entire file, use a line like
5059 @cindex #+COLUMNS
5060 @example
5061 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5062 @end example
5064 To specify a format that only applies to a specific tree, add a
5065 @code{:COLUMNS:} property to the top node of that tree, for example:
5067 @example
5068 ** Top node for columns view
5069    :PROPERTIES:
5070    :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5071    :END:
5072 @end example
5074 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5075 for the entry itself, and for the entire subtree below it.  Since the
5076 column definition is part of the hierarchical structure of the document,
5077 you can define columns on level 1 that are general enough for all
5078 sublevels, and more specific columns further down, when you edit a
5079 deeper part of the tree.
5081 @node Column attributes,  , Scope of column definitions, Defining columns
5082 @subsubsection Column attributes
5083 A column definition sets the attributes of a column.  The general
5084 definition looks like this:
5086 @example
5087  %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5088 @end example
5090 @noindent
5091 Except for the percent sign and the property name, all items are
5092 optional.  The individual parts have the following meaning:
5094 @example
5095 @var{width}           @r{An integer specifying the width of the column in characters.}
5096                 @r{If omitted, the width will be determined automatically.}
5097 @var{property}        @r{The property that should be edited in this column.}
5098                 @r{Special properties representing meta data are allowed here}
5099                 @r{as well (@pxref{Special properties})}
5100 @var{title}           @r{The header text for the column.  If omitted, the property}
5101                 @r{name is used.}
5102 @{@var{summary-type}@}  @r{The summary type.  If specified, the column values for}
5103                 @r{parent nodes are computed from the children.}
5104                 @r{Supported summary types are:}
5105                 @{+@}       @r{Sum numbers in this column.}
5106                 @{+;%.1f@}  @r{Like @samp{+}, but format result with @samp{%.1f}.}
5107                 @{$@}       @r{Currency, short for @samp{+;%.2f}.}
5108                 @{:@}       @r{Sum times, HH:MM, plain numbers are hours.}
5109                 @{X@}       @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5110                 @{X/@}      @r{Checkbox status, @samp{[n/m]}.}
5111                 @{X%@}      @r{Checkbox status, @samp{[n%]}.}
5112                 @{min@}     @r{Smallest number in column.}
5113                 @{max@}     @r{Largest number.}
5114                 @{mean@}    @r{Arithmetic mean of numbers.}
5115                 @{:min@}    @r{Smallest time value in column.}
5116                 @{:max@}    @r{Largest time value.}
5117                 @{:mean@}   @r{Arithmetic mean of time values.}
5118                 @{@@min@}    @r{Minimum age (in days/hours/mins/seconds).}
5119                 @{@@max@}    @r{Maximum age (in days/hours/mins/seconds).}
5120                 @{@@mean@}   @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5121                 @{est+@}    @r{Add low-high estimates.}
5122 @end example
5124 @noindent
5125 Be aware that you can only have one summary type for any property you
5126 include.  Subsequent columns referencing the same property will all display the
5127 same summary information.
5129 The @code{est+} summary type requires further explanation.  It is used for
5130 combining estimates, expressed as low-high ranges.  For example, instead
5131 of estimating a particular task will take 5 days, you might estimate it as
5132 5-6 days if you're fairly confident you know how much work is required, or
5133 1-10 days if you don't really know what needs to be done.  Both ranges
5134 average at 5.5 days, but the first represents a more predictable delivery.
5136 When combining a set of such estimates, simply adding the lows and highs
5137 produces an unrealistically wide result.  Instead, @code{est+} adds the
5138 statistical mean and variance of the sub-tasks, generating a final estimate
5139 from the sum.  For example, suppose you had ten tasks, each of which was
5140 estimated at 0.5 to 2 days of work.  Straight addition produces an estimate
5141 of 5 to 20 days, representing what to expect if everything goes either
5142 extremely well or extremely poorly.  In contrast, @code{est+} estimates the
5143 full job more realistically, at 10-15 days.
5145 Here is an example for a complete columns definition, along with allowed
5146 values.
5148 @example
5149 :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.}
5150                    %10Time_Estimate@{:@} %CLOCKSUM
5151 :Owner_ALL:    Tammy Mark Karl Lisa Don
5152 :Status_ALL:   "In progress" "Not started yet" "Finished" ""
5153 :Approved_ALL: "[ ]" "[X]"
5154 @end example
5156 @noindent
5157 The first column, @samp{%25ITEM}, means the first 25 characters of the
5158 item itself, i.e.@: of the headline.  You probably always should start the
5159 column definition with the @samp{ITEM} specifier.  The other specifiers
5160 create columns @samp{Owner} with a list of names as allowed values, for
5161 @samp{Status} with four different possible values, and for a checkbox
5162 field @samp{Approved}.  When no width is given after the @samp{%}
5163 character, the column will be exactly as wide as it needs to be in order
5164 to fully display all values.  The @samp{Approved} column does have a
5165 modified title (@samp{Approved?}, with a question mark).  Summaries will
5166 be created for the @samp{Time_Estimate} column by adding time duration
5167 expressions like HH:MM, and for the @samp{Approved} column, by providing
5168 an @samp{[X]} status if all children have been checked.  The
5169 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
5170 in the subtree.
5172 @node Using column view, Capturing column view, Defining columns, Column view
5173 @subsection Using column view
5175 @table @kbd
5176 @tsubheading{Turning column view on and off}
5177 @orgcmd{C-c C-x C-c,org-columns}
5178 @vindex org-columns-default-format
5179 Turn on column view.  If the cursor is before the first headline in the file,
5180 column view is turned on for the entire file, using the @code{#+COLUMNS}
5181 definition.  If the cursor is somewhere inside the outline, this command
5182 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5183 defines a format.  When one is found, the column view table is established
5184 for the tree starting at the entry that contains the @code{:COLUMNS:}
5185 property.  If no such property is found, the format is taken from the
5186 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5187 and column view is established for the current entry and its subtree.
5188 @orgcmd{r,org-columns-redo}
5189 Recreate the column view, to include recent changes made in the buffer.
5190 @orgcmd{g,org-columns-redo}
5191 Same as @kbd{r}.
5192 @orgcmd{q,org-columns-quit}
5193 Exit column view.
5194 @tsubheading{Editing values}
5195 @item @key{left} @key{right} @key{up} @key{down}
5196 Move through the column view from field to field.
5197 @kindex S-@key{left}
5198 @kindex S-@key{right}
5199 @item  S-@key{left}/@key{right}
5200 Switch to the next/previous allowed value of the field.  For this, you
5201 have to have specified allowed values for a property.
5202 @item 1..9,0
5203 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5204 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5205 Same as @kbd{S-@key{left}/@key{right}}
5206 @orgcmd{e,org-columns-edit-value}
5207 Edit the property at point.  For the special properties, this will
5208 invoke the same interface that you normally use to change that
5209 property.  For example, when editing a TAGS property, the tag completion
5210 or fast selection interface will pop up.
5211 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5212 When there is a checkbox at point, toggle it.
5213 @orgcmd{v,org-columns-show-value}
5214 View the full value of this property.  This is useful if the width of
5215 the column is smaller than that of the value.
5216 @orgcmd{a,org-columns-edit-allowed}
5217 Edit the list of allowed values for this property.  If the list is found
5218 in the hierarchy, the modified values is stored there.  If no list is
5219 found, the new value is stored in the first entry that is part of the
5220 current column view.
5221 @tsubheading{Modifying the table structure}
5222 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5223 Make the column narrower/wider by one character.
5224 @orgcmd{S-M-@key{right},org-columns-new}
5225 Insert a new column, to the left of the current column.
5226 @orgcmd{S-M-@key{left},org-columns-delete}
5227 Delete the current column.
5228 @end table
5230 @node Capturing column view,  , Using column view, Column view
5231 @subsection Capturing column view
5233 Since column view is just an overlay over a buffer, it cannot be
5234 exported or printed directly.  If you want to capture a column view, use
5235 a @code{columnview} dynamic block (@pxref{Dynamic blocks}).  The frame
5236 of this block looks like this:
5238 @cindex #+BEGIN, columnview
5239 @example
5240 * The column view
5241 #+BEGIN: columnview :hlines 1 :id "label"
5243 #+END:
5244 @end example
5246 @noindent This dynamic block has the following parameters:
5248 @table @code
5249 @item :id
5250 This is the most important parameter.  Column view is a feature that is
5251 often localized to a certain (sub)tree, and the capture block might be
5252 at a different location in the file.  To identify the tree whose view to
5253 capture, you can use 4 values:
5254 @cindex property, ID
5255 @example
5256 local     @r{use the tree in which the capture block is located}
5257 global    @r{make a global view, including all headings in the file}
5258 "file:@var{path-to-file}"
5259           @r{run column view at the top of this file}
5260 "@var{ID}"      @r{call column view in the tree that has an @code{:ID:}}
5261           @r{property with the value @i{label}.  You can use}
5262           @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5263           @r{the current entry and copy it to the kill-ring.}
5264 @end example
5265 @item :hlines
5266 When @code{t}, insert an hline after every line.  When a number @var{N}, insert
5267 an hline before each headline with level @code{<= @var{N}}.
5268 @item :vlines
5269 When set to @code{t}, force column groups to get vertical lines.
5270 @item :maxlevel
5271 When set to a number, don't capture entries below this level.
5272 @item :skip-empty-rows
5273 When set to @code{t}, skip rows where the only non-empty specifier of the
5274 column view is @code{ITEM}.
5276 @end table
5278 @noindent
5279 The following commands insert or update the dynamic block:
5281 @table @kbd
5282 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5283 Insert a dynamic block capturing a column view.  You will be prompted
5284 for the scope or ID of the view.
5285 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5286 Update dynamic block at point.  The cursor needs to be in the
5287 @code{#+BEGIN} line of the dynamic block.
5288 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5289 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
5290 you have several clock table blocks, column-capturing blocks or other dynamic
5291 blocks in a buffer.
5292 @end table
5294 You can add formulas to the column view table and you may add plotting
5295 instructions in front of the table---these will survive an update of the
5296 block.  If there is a @code{#+TBLFM:} after the table, the table will
5297 actually be recalculated automatically after an update.
5299 An alternative way to capture and process property values into a table is
5300 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5301 package@footnote{Contributed packages are not part of Emacs, but are
5302 distributed with the main distribution of Org (visit
5303 @uref{http://orgmode.org}).}.  It provides a general API to collect
5304 properties from entries in a certain scope, and arbitrary Lisp expressions to
5305 process these values before inserting them into a table or a dynamic block.
5307 @node Property API,  , Column view, Properties and Columns
5308 @section The Property API
5309 @cindex properties, API
5310 @cindex API, for properties
5312 There is a full API for accessing and changing properties.  This API can
5313 be used by Emacs Lisp programs to work with properties and to implement
5314 features based on them.  For more information see @ref{Using the
5315 property API}.
5317 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5318 @chapter Dates and times
5319 @cindex dates
5320 @cindex times
5321 @cindex timestamp
5322 @cindex date stamp
5324 To assist project planning, TODO items can be labeled with a date and/or
5325 a time.  The specially formatted string carrying the date and time
5326 information is called a @emph{timestamp} in Org mode.  This may be a
5327 little confusing because timestamp is often used as indicating when
5328 something was created or last changed.  However, in Org mode this term
5329 is used in a much wider sense.
5331 @menu
5332 * Timestamps::                  Assigning a time to a tree entry
5333 * Creating timestamps::         Commands which insert timestamps
5334 * Deadlines and scheduling::    Planning your work
5335 * Clocking work time::          Tracking how long you spend on a task
5336 * Effort estimates::            Planning work effort in advance
5337 * Relative timer::              Notes with a running timer
5338 * Countdown timer::             Starting a countdown timer for a task
5339 @end menu
5342 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5343 @section Timestamps, deadlines, and scheduling
5344 @cindex timestamps
5345 @cindex ranges, time
5346 @cindex date stamps
5347 @cindex deadlines
5348 @cindex scheduling
5350 A timestamp is a specification of a date (possibly with a time or a range of
5351 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5352 simplest form, the day name is optional when you type the date yourself.
5353 However, any dates inserted or modified by Org will add that day name, for
5354 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5355 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5356 date/time format.  To use an alternative format, see @ref{Custom time
5357 format}.}.  A timestamp can appear anywhere in the headline or body of an Org
5358 tree entry.  Its presence causes entries to be shown on specific dates in the
5359 agenda (@pxref{Weekly/daily agenda}).  We distinguish:
5361 @table @var
5362 @item Plain timestamp; Event; Appointment
5363 @cindex timestamp
5364 @cindex appointment
5365 A simple timestamp just assigns a date/time to an item.  This is just
5366 like writing down an appointment or event in a paper agenda.  In the
5367 timeline and agenda displays, the headline of an entry associated with a
5368 plain timestamp will be shown exactly on that date.
5370 @example
5371 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5372 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5373 @end example
5375 @item Timestamp with repeater interval
5376 @cindex timestamp, with repeater interval
5377 A timestamp may contain a @emph{repeater interval}, indicating that it
5378 applies not only on the given date, but again and again after a certain
5379 interval of N days (d), weeks (w), months (m), or years (y).  The
5380 following will show up in the agenda every Wednesday:
5382 @example
5383 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5384 @end example
5386 @item Diary-style sexp entries
5387 For more complex date specifications, Org mode supports using the special
5388 sexp diary entries implemented in the Emacs calendar/diary
5389 package@footnote{When working with the standard diary sexp functions, you
5390 need to be very careful with the order of the arguments.  That order depend
5391 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5392 versions, @code{european-calendar-style}).  For example, to specify a date
5393 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5394 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5395 the settings.  This has been the source of much confusion.  Org mode users
5396 can resort to special versions of these functions like @code{org-date} or
5397 @code{org-anniversary}.  These work just like the corresponding @code{diary-}
5398 functions, but with stable ISO order of arguments (year, month, day) wherever
5399 applicable, independent of the value of @code{calendar-date-style}.}.  For
5400 example with optional time
5402 @example
5403 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5404   <%%(org-float t 4 2)>
5405 @end example
5407 @item Time/Date range
5408 @cindex timerange
5409 @cindex date range
5410 Two timestamps connected by @samp{--} denote a range.  The headline
5411 will be shown on the first and last day of the range, and on any dates
5412 that are displayed and fall in the range.  Here is an example:
5414 @example
5415 ** Meeting in Amsterdam
5416    <2004-08-23 Mon>--<2004-08-26 Thu>
5417 @end example
5419 @item Inactive timestamp
5420 @cindex timestamp, inactive
5421 @cindex inactive timestamp
5422 Just like a plain timestamp, but with square brackets instead of
5423 angular ones.  These timestamps are inactive in the sense that they do
5424 @emph{not} trigger an entry to show up in the agenda.
5426 @example
5427 * Gillian comes late for the fifth time [2006-11-01 Wed]
5428 @end example
5430 @end table
5432 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5433 @section Creating timestamps
5434 @cindex creating timestamps
5435 @cindex timestamps, creating
5437 For Org mode to recognize timestamps, they need to be in the specific
5438 format.  All commands listed below produce timestamps in the correct
5439 format.
5441 @table @kbd
5442 @orgcmd{C-c .,org-time-stamp}
5443 Prompt for a date and insert a corresponding timestamp.  When the cursor is
5444 at an existing timestamp in the buffer, the command is used to modify this
5445 timestamp instead of inserting a new one.  When this command is used twice in
5446 succession, a time range is inserted.
5448 @orgcmd{C-c !,org-time-stamp-inactive}
5449 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5450 an agenda entry.
5452 @kindex C-u C-c .
5453 @kindex C-u C-c !
5454 @item C-u C-c .
5455 @itemx C-u C-c !
5456 @vindex org-time-stamp-rounding-minutes
5457 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5458 contains date and time.  The default time can be rounded to multiples of 5
5459 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5461 @orgkey{C-c C-c}
5462 Normalize timestamp, insert/fix day name if missing or wrong.
5464 @orgcmd{C-c <,org-date-from-calendar}
5465 Insert a timestamp corresponding to the cursor date in the Calendar.
5467 @orgcmd{C-c >,org-goto-calendar}
5468 Access the Emacs calendar for the current date.  If there is a
5469 timestamp in the current line, go to the corresponding date
5470 instead.
5472 @orgcmd{C-c C-o,org-open-at-point}
5473 Access the agenda for the date given by the timestamp or -range at
5474 point (@pxref{Weekly/daily agenda}).
5476 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5477 Change date at cursor by one day.  These key bindings conflict with
5478 shift-selection and related modes (@pxref{Conflicts}).
5480 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5481 Change the item under the cursor in a timestamp.  The cursor can be on a
5482 year, month, day, hour or minute.  When the timestamp contains a time range
5483 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5484 shifting the time block with constant length.  To change the length, modify
5485 the second time.  Note that if the cursor is in a headline and not at a
5486 timestamp, these same keys modify the priority of an item.
5487 (@pxref{Priorities}).  The key bindings also conflict with shift-selection and
5488 related modes (@pxref{Conflicts}).
5490 @orgcmd{C-c C-y,org-evaluate-time-range}
5491 @cindex evaluate time range
5492 Evaluate a time range by computing the difference between start and end.
5493 With a prefix argument, insert result after the time range (in a table: into
5494 the following column).
5495 @end table
5498 @menu
5499 * The date/time prompt::        How Org mode helps you entering date and time
5500 * Custom time format::          Making dates look different
5501 @end menu
5503 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5504 @subsection The date/time prompt
5505 @cindex date, reading in minibuffer
5506 @cindex time, reading in minibuffer
5508 @vindex org-read-date-prefer-future
5509 When Org mode prompts for a date/time, the default is shown in default
5510 date/time format, and the prompt therefore seems to ask for a specific
5511 format.  But it will in fact accept any string containing some date and/or
5512 time information, and it is really smart about interpreting your input.  You
5513 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5514 copied from an email message.  Org mode will find whatever information is in
5515 there and derive anything you have not specified from the @emph{default date
5516 and time}.  The default is usually the current date and time, but when
5517 modifying an existing timestamp, or when entering the second stamp of a
5518 range, it is taken from the stamp in the buffer.  When filling in
5519 information, Org mode assumes that most of the time you will want to enter a
5520 date in the future: if you omit the month/year and the given day/month is
5521 @i{before} today, it will assume that you mean a future date@footnote{See the
5522 variable @code{org-read-date-prefer-future}.  You may set that variable to
5523 the symbol @code{time} to even make a time before now shift the date to
5524 tomorrow.}.  If the date has been automatically shifted into the future, the
5525 time prompt will show this with @samp{(=>F).}
5527 For example, let's assume that today is @b{June 13, 2006}.  Here is how
5528 various inputs will be interpreted, the items filled in by Org mode are
5529 in @b{bold}.
5531 @example
5532 3-2-5         @result{} 2003-02-05
5533 2/5/3         @result{} 2003-02-05
5534 14            @result{} @b{2006}-@b{06}-14
5535 12            @result{} @b{2006}-@b{07}-12
5536 2/5           @result{} @b{2007}-02-05
5537 Fri           @result{} nearest Friday (default date or later)
5538 sep 15        @result{} @b{2006}-09-15
5539 feb 15        @result{} @b{2007}-02-15
5540 sep 12 9      @result{} 2009-09-12
5541 12:45         @result{} @b{2006}-@b{06}-@b{13} 12:45
5542 22 sept 0:34  @result{} @b{2006}-09-22 0:34
5543 w4            @result{} ISO week for of the current year @b{2006}
5544 2012 w4 fri   @result{} Friday of ISO week 4 in 2012
5545 2012-w04-5    @result{} Same as above
5546 @end example
5548 Furthermore you can specify a relative date by giving, as the
5549 @emph{first} thing in the input: a plus/minus sign, a number and a
5550 letter ([dwmy]) to indicate change in days, weeks, months, or years.  With a
5551 single plus or minus, the date is always relative to today.  With a
5552 double plus or minus, it is relative to the default date.  If instead of
5553 a single letter, you use the abbreviation of day name, the date will be
5554 the Nth such day, e.g.@:
5556 @example
5557 +0            @result{} today
5558 .             @result{} today
5559 +4d           @result{} four days from today
5560 +4            @result{} same as above
5561 +2w           @result{} two weeks from today
5562 ++5           @result{} five days from default date
5563 +2tue         @result{} second Tuesday from now.
5564 @end example
5566 @vindex parse-time-months
5567 @vindex parse-time-weekdays
5568 The function understands English month and weekday abbreviations.  If
5569 you want to use unabbreviated names and/or other languages, configure
5570 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5572 @vindex org-read-date-force-compatible-dates
5573 Not all dates can be represented in a given Emacs implementation.  By default
5574 Org mode forces dates into the compatibility range 1970--2037 which works on
5575 all Emacs implementations.  If you want to use dates outside of this range,
5576 read the docstring of the variable
5577 @code{org-read-date-force-compatible-dates}.
5579 You can specify a time range by giving start and end times or by giving a
5580 start time and a duration (in HH:MM format).  Use one or two dash(es) as the
5581 separator in the former case and use '+' as the separator in the latter
5582 case, e.g.@:
5584 @example
5585 11am-1:15pm    @result{} 11:00-13:15
5586 11am--1:15pm   @result{} same as above
5587 11am+2:15      @result{} same as above
5588 @end example
5590 @cindex calendar, for selecting date
5591 @vindex org-popup-calendar-for-date-prompt
5592 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5593 you don't need/want the calendar, configure the variable
5594 @code{org-popup-calendar-for-date-prompt}.}.  When you exit the date
5595 prompt, either by clicking on a date in the calendar, or by pressing
5596 @key{RET}, the date selected in the calendar will be combined with the
5597 information entered at the prompt.  You can control the calendar fully
5598 from the minibuffer:
5600 @kindex <
5601 @kindex >
5602 @kindex M-v
5603 @kindex C-v
5604 @kindex mouse-1
5605 @kindex S-@key{right}
5606 @kindex S-@key{left}
5607 @kindex S-@key{down}
5608 @kindex S-@key{up}
5609 @kindex M-S-@key{right}
5610 @kindex M-S-@key{left}
5611 @kindex @key{RET}
5612 @example
5613 @key{RET}           @r{Choose date at cursor in calendar.}
5614 mouse-1        @r{Select date by clicking on it.}
5615 S-@key{right}/@key{left}     @r{One day forward/backward.}
5616 S-@key{down}/@key{up}     @r{One week forward/backward.}
5617 M-S-@key{right}/@key{left}   @r{One month forward/backward.}
5618 > / <          @r{Scroll calendar forward/backward by one month.}
5619 M-v / C-v      @r{Scroll calendar forward/backward by 3 months.}
5620 @end example
5622 @vindex org-read-date-display-live
5623 The actions of the date/time prompt may seem complex, but I assure you they
5624 will grow on you, and you will start getting annoyed by pretty much any other
5625 way of entering a date/time out there.  To help you understand what is going
5626 on, the current interpretation of your input will be displayed live in the
5627 minibuffer@footnote{If you find this distracting, turn the display of with
5628 @code{org-read-date-display-live}.}.
5630 @node Custom time format,  , The date/time prompt, Creating timestamps
5631 @subsection Custom time format
5632 @cindex custom date/time format
5633 @cindex time format, custom
5634 @cindex date format, custom
5636 @vindex org-display-custom-times
5637 @vindex org-time-stamp-custom-formats
5638 Org mode uses the standard ISO notation for dates and times as it is
5639 defined in ISO 8601.  If you cannot get used to this and require another
5640 representation of date and time to keep you happy, you can get it by
5641 customizing the variables @code{org-display-custom-times} and
5642 @code{org-time-stamp-custom-formats}.
5644 @table @kbd
5645 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5646 Toggle the display of custom formats for dates and times.
5647 @end table
5649 @noindent
5650 Org mode needs the default format for scanning, so the custom date/time
5651 format does not @emph{replace} the default format---instead it is put
5652 @emph{over} the default format using text properties.  This has the
5653 following consequences:
5654 @itemize @bullet
5655 @item
5656 You cannot place the cursor onto a timestamp anymore, only before or
5657 after.
5658 @item
5659 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5660 each component of a timestamp.  If the cursor is at the beginning of
5661 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5662 just like @kbd{S-@key{left}/@key{right}}.  At the end of the stamp, the
5663 time will be changed by one minute.
5664 @item
5665 If the timestamp contains a range of clock times or a repeater, these
5666 will not be overlaid, but remain in the buffer as they were.
5667 @item
5668 When you delete a timestamp character-by-character, it will only
5669 disappear from the buffer after @emph{all} (invisible) characters
5670 belonging to the ISO timestamp have been removed.
5671 @item
5672 If the custom timestamp format is longer than the default and you are
5673 using dates in tables, table alignment will be messed up.  If the custom
5674 format is shorter, things do work as expected.
5675 @end itemize
5678 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5679 @section Deadlines and scheduling
5681 A timestamp may be preceded by special keywords to facilitate planning:
5683 @table @var
5684 @item DEADLINE
5685 @cindex DEADLINE keyword
5687 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5688 to be finished on that date.
5690 @vindex org-deadline-warning-days
5691 On the deadline date, the task will be listed in the agenda.  In
5692 addition, the agenda for @emph{today} will carry a warning about the
5693 approaching or missed deadline, starting
5694 @code{org-deadline-warning-days} before the due date, and continuing
5695 until the entry is marked DONE.  An example:
5697 @example
5698 *** TODO write article about the Earth for the Guide
5699     The editor in charge is [[bbdb:Ford Prefect]]
5700     DEADLINE: <2004-02-29 Sun>
5701 @end example
5703 You can specify a different lead time for warnings for a specific
5704 deadlines using the following syntax.  Here is an example with a warning
5705 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5707 @item SCHEDULED
5708 @cindex SCHEDULED keyword
5710 Meaning: you are planning to start working on that task on the given
5711 date.
5713 @vindex org-agenda-skip-scheduled-if-done
5714 The headline will be listed under the given date@footnote{It will still
5715 be listed on that date after it has been marked DONE.  If you don't like
5716 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}.  In
5717 addition, a reminder that the scheduled date has passed will be present
5718 in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
5719 the task will automatically be forwarded until completed.
5721 @example
5722 *** TODO Call Trillian for a date on New Years Eve.
5723     SCHEDULED: <2004-12-25 Sat>
5724 @end example
5726 @noindent
5727 @b{Important:} Scheduling an item in Org mode should @i{not} be
5728 understood in the same way that we understand @i{scheduling a meeting}.
5729 Setting a date for a meeting is just a simple appointment, you should
5730 mark this entry with a simple plain timestamp, to get this item shown
5731 on the date where it applies.  This is a frequent misunderstanding by
5732 Org users.  In Org mode, @i{scheduling} means setting a date when you
5733 want to start working on an action item.
5734 @end table
5736 You may use timestamps with repeaters in scheduling and deadline
5737 entries.  Org mode will issue early and late warnings based on the
5738 assumption that the timestamp represents the @i{nearest instance} of
5739 the repeater.  However, the use of diary sexp entries like
5741 @code{<%%(org-float t 42)>}
5743 in scheduling and deadline timestamps is limited.  Org mode does not
5744 know enough about the internals of each sexp function to issue early and
5745 late warnings.  However, it will show the item on each day where the
5746 sexp entry matches.
5748 @menu
5749 * Inserting deadline/schedule::  Planning items
5750 * Repeated tasks::              Items that show up again and again
5751 @end menu
5753 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5754 @subsection Inserting deadlines or schedules
5756 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
5757 @samp{DEADLINE} dates are inserted on the line right below the headline.  Don't put
5758 any text between this line and the headline.} a deadline or to schedule
5759 an item:
5761 @table @kbd
5763 @orgcmd{C-c C-d,org-deadline}
5764 Insert @samp{DEADLINE} keyword along with a stamp.  The insertion will happen
5765 in the line directly following the headline.  Any CLOSED timestamp will be
5766 removed.  When called with a prefix arg, an existing deadline will be removed
5767 from the entry.  Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
5768 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5769 and @code{nologredeadline}}, a note will be taken when changing an existing
5770 deadline.
5772 @orgcmd{C-c C-s,org-schedule}
5773 Insert @samp{SCHEDULED} keyword along with a stamp.  The insertion will
5774 happen in the line directly following the headline.  Any CLOSED timestamp
5775 will be removed.  When called with a prefix argument, remove the scheduling
5776 date from the entry.  Depending on the variable
5777 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5778 keywords @code{logreschedule}, @code{lognotereschedule}, and
5779 @code{nologreschedule}}, a note will be taken when changing an existing
5780 scheduling time.
5782 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5783 @kindex k a
5784 @kindex k s
5785 Mark the current entry for agenda action.  After you have marked the entry
5786 like this, you can open the agenda or the calendar to find an appropriate
5787 date.  With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5788 schedule the marked item.
5790 @orgcmd{C-c / d,org-check-deadlines}
5791 @cindex sparse tree, for deadlines
5792 @vindex org-deadline-warning-days
5793 Create a sparse tree with all deadlines that are either past-due, or
5794 which will become due within @code{org-deadline-warning-days}.
5795 With @kbd{C-u} prefix, show all deadlines in the file.  With a numeric
5796 prefix, check that many days.  For example, @kbd{C-1 C-c / d} shows
5797 all deadlines due tomorrow.
5799 @orgcmd{C-c / b,org-check-before-date}
5800 Sparse tree for deadlines and scheduled items before a given date.
5802 @orgcmd{C-c / a,org-check-after-date}
5803 Sparse tree for deadlines and scheduled items after a given date.
5804 @end table
5806 Note that @code{org-schedule} and @code{org-deadline} supports
5807 setting the date by indicating a relative time: e.g. +1d will set
5808 the date to the next day after today, and --1w will set the date
5809 to the previous week before any current timestamp.
5811 @node Repeated tasks,  , Inserting deadline/schedule, Deadlines and scheduling
5812 @subsection Repeated tasks
5813 @cindex tasks, repeated
5814 @cindex repeated tasks
5816 Some tasks need to be repeated again and again.  Org mode helps to
5817 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5818 or plain timestamp.  In the following example
5819 @example
5820 ** TODO Pay the rent
5821    DEADLINE: <2005-10-01 Sat +1m>
5822 @end example
5823 @noindent
5824 the @code{+1m} is a repeater; the intended interpretation is that the task
5825 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5826 from that time.  If you need both a repeater and a special warning period in
5827 a deadline entry, the repeater should come first and the warning period last:
5828 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5830 @vindex org-todo-repeat-to-state
5831 Deadlines and scheduled items produce entries in the agenda when they are
5832 over-due, so it is important to be able to mark such an entry as completed
5833 once you have done so.  When you mark a DEADLINE or a SCHEDULE with the TODO
5834 keyword DONE, it will no longer produce entries in the agenda.  The problem
5835 with this is, however, that then also the @emph{next} instance of the
5836 repeated entry will not be active.  Org mode deals with this in the following
5837 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5838 shift the base date of the repeating timestamp by the repeater interval, and
5839 immediately set the entry state back to TODO@footnote{In fact, the target
5840 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5841 the variable @code{org-todo-repeat-to-state}.  If neither of these is
5842 specified, the target state defaults to the first state of the TODO state
5843 sequence.}.  In the example above, setting the state to DONE would actually
5844 switch the date like this:
5846 @example
5847 ** TODO Pay the rent
5848    DEADLINE: <2005-11-01 Tue +1m>
5849 @end example
5851 @vindex org-log-repeat
5852 A timestamp@footnote{You can change this using the option
5853 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5854 @code{lognoterepeat}, and @code{nologrepeat}.  With @code{lognoterepeat}, you
5855 will also be prompted for a note.} will be added under the deadline, to keep
5856 a record that you actually acted on the previous instance of this deadline.
5858 As a consequence of shifting the base date, this entry will no longer be
5859 visible in the agenda when checking past dates, but all future instances
5860 will be visible.
5862 With the @samp{+1m} cookie, the date shift will always be exactly one
5863 month.  So if you have not paid the rent for three months, marking this
5864 entry DONE will still keep it as an overdue deadline.  Depending on the
5865 task, this may not be the best way to handle it.  For example, if you
5866 forgot to call your father for 3 weeks, it does not make sense to call
5867 him 3 times in a single day to make up for it.  Finally, there are tasks
5868 like changing batteries which should always repeat a certain time
5869 @i{after} the last time you did it.  For these tasks, Org mode has
5870 special repeaters  @samp{++} and @samp{.+}.  For example:
5872 @example
5873 ** TODO Call Father
5874    DEADLINE: <2008-02-10 Sun ++1w>
5875    Marking this DONE will shift the date by at least one week,
5876    but also by as many weeks as it takes to get this date into
5877    the future.  However, it stays on a Sunday, even if you called
5878    and marked it done on Saturday.
5879 ** TODO Check the batteries in the smoke detectors
5880    DEADLINE: <2005-11-01 Tue .+1m>
5881    Marking this DONE will shift the date to one month after
5882    today.
5883 @end example
5885 You may have both scheduling and deadline information for a specific
5886 task---just make sure that the repeater intervals on both are the same.
5888 An alternative to using a repeater is to create a number of copies of a task
5889 subtree, with dates shifted in each copy.  The command @kbd{C-c C-x c} was
5890 created for this purpose, it is described in @ref{Structure editing}.
5893 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5894 @section Clocking work time
5895 @cindex clocking time
5896 @cindex time clocking
5898 Org mode allows you to clock the time you spend on specific tasks in a
5899 project.  When you start working on an item, you can start the clock.
5900 When you stop working on that task, or when you mark the task done, the
5901 clock is stopped and the corresponding time interval is recorded.  It
5902 also computes the total time spent on each subtree of a project.  And it
5903 remembers a history or tasks recently clocked, to that you can jump quickly
5904 between a number of tasks absorbing your time.
5906 To save the clock history across Emacs sessions, use
5907 @lisp
5908 (setq org-clock-persist 'history)
5909 (org-clock-persistence-insinuate)
5910 @end lisp
5911 When you clock into a new task after resuming Emacs, the incomplete
5912 clock@footnote{To resume the clock under the assumption that you have worked
5913 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5914 will be found (@pxref{Resolving idle time}) and you will be prompted about
5915 what to do with it.
5917 @menu
5918 * Clocking commands::           Starting and stopping a clock
5919 * The clock table::             Detailed reports
5920 * Resolving idle time::         Resolving time when you've been idle
5921 @end menu
5923 @node Clocking commands, The clock table, Clocking work time, Clocking work time
5924 @subsection Clocking commands
5926 @table @kbd
5927 @orgcmd{C-c C-x C-i,org-clock-in}
5928 @vindex org-clock-into-drawer
5929 @cindex property, LOG_INTO_DRAWER
5930 Start the clock on the current item (clock-in).  This inserts the CLOCK
5931 keyword together with a timestamp.  If this is not the first clocking of
5932 this item, the multiple CLOCK lines will be wrapped into a
5933 @code{:LOGBOOK:} drawer (see also the variable
5934 @code{org-clock-into-drawer}).  You can also overrule
5935 the setting of this variable for a subtree by setting a
5936 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
5937 When called with a @kbd{C-u} prefix argument,
5938 select the task from a list of recently clocked tasks.  With two @kbd{C-u
5939 C-u} prefixes, clock into the task at point and mark it as the default task.
5940 The default task will always be available when selecting a clocking task,
5941 with letter @kbd{d}.@*
5942 @cindex property: CLOCK_MODELINE_TOTAL
5943 @cindex property: LAST_REPEAT
5944 @vindex org-clock-modeline-total
5945 While the clock is running, the current clocking time is shown in the mode
5946 line, along with the title of the task.  The clock time shown will be all
5947 time ever clocked for this task and its children.  If the task has an effort
5948 estimate (@pxref{Effort estimates}), the mode line displays the current
5949 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5950 hook a function doing this to @code{org-clock-in-prepare-hook}.}  If the task
5951 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5952 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5953 will be shown.  More control over what time is shown can be exercised with
5954 the @code{CLOCK_MODELINE_TOTAL} property.  It may have the values
5955 @code{current} to show only the current clocking instance, @code{today} to
5956 show all time clocked on this tasks today (see also the variable
5957 @code{org-extend-today-until}), @code{all} to include all time, or
5958 @code{auto} which is the default@footnote{See also the variable
5959 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5960 mode line entry will pop up a menu with clocking options.
5962 @orgcmd{C-c C-x C-o,org-clock-out}
5963 @vindex org-log-note-clock-out
5964 Stop the clock (clock-out).  This inserts another timestamp at the same
5965 location where the clock was last started.  It also directly computes
5966 the resulting time in inserts it after the time range as @samp{=>
5967 HH:MM}.  See the variable @code{org-log-note-clock-out} for the
5968 possibility to record an additional note together with the clock-out
5969 timestamp@footnote{The corresponding in-buffer setting is:
5970 @code{#+STARTUP: lognoteclock-out}}.
5971 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5972 Update the effort estimate for the current clock task.
5973 @kindex C-c C-y
5974 @kindex C-c C-c
5975 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
5976 Recompute the time interval after changing one of the timestamps.  This
5977 is only necessary if you edit the timestamps directly.  If you change
5978 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5979 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
5980 On @code{CLOCK} log lines, increase/decrease both timestamps at the same
5981 time so that duration keeps the same.
5982 @orgcmd{C-c C-t,org-todo}
5983 Changing the TODO state of an item to DONE automatically stops the clock
5984 if it is running in this same item.
5985 @orgcmd{C-c C-x C-x,org-clock-cancel}
5986 Cancel the current clock.  This is useful if a clock was started by
5987 mistake, or if you ended up working on something else.
5988 @orgcmd{C-c C-x C-j,org-clock-goto}
5989 Jump to the headline of the currently clocked in task.  With a @kbd{C-u}
5990 prefix arg, select the target task from a list of recently clocked tasks.
5991 @orgcmd{C-c C-x C-d,org-clock-display}
5992 @vindex org-remove-highlights-with-change
5993 Display time summaries for each subtree in the current buffer.  This puts
5994 overlays at the end of each headline, showing the total time recorded under
5995 that heading, including the time of any subheadings.  You can use visibility
5996 cycling to study the tree, but the overlays disappear when you change the
5997 buffer (see variable @code{org-remove-highlights-with-change}) or press
5998 @kbd{C-c C-c}.
5999 @end table
6001 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6002 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6003 worked on or closed during a day.
6005 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6006 @subsection The clock table
6007 @cindex clocktable, dynamic block
6008 @cindex report, of clocked time
6010 Org mode can produce quite complex reports based on the time clocking
6011 information.  Such a report is called a @emph{clock table}, because it is
6012 formatted as one or several Org tables.
6014 @table @kbd
6015 @orgcmd{C-c C-x C-r,org-clock-report}
6016 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6017 report as an Org mode table into the current file.  When the cursor is
6018 at an existing clock table, just update it.  When called with a prefix
6019 argument, jump to the first clock report in the current document and
6020 update it.  The clock table always includes also trees with
6021 @code{:ARCHIVE:} tag.
6022 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6023 Update dynamic block at point.  The cursor needs to be in the
6024 @code{#+BEGIN} line of the dynamic block.
6025 @orgkey{C-u C-c C-x C-u}
6026 Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if
6027 you have several clock table blocks in a buffer.
6028 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6029 Shift the current @code{:block} interval and update the table.  The cursor
6030 needs to be in the @code{#+BEGIN: clocktable} line for this command.  If
6031 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6032 @end table
6035 Here is an example of the frame for a clock table as it is inserted into the
6036 buffer with the @kbd{C-c C-x C-r} command:
6038 @cindex #+BEGIN, clocktable
6039 @example
6040 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6041 #+END: clocktable
6042 @end example
6043 @noindent
6044 @vindex org-clocktable-defaults
6045 The @samp{BEGIN} line and specify a number of options to define the scope,
6046 structure, and formatting of the report.  Defaults for all these options can
6047 be configured in the variable @code{org-clocktable-defaults}.
6049 @noindent First there are options that determine which clock entries are to
6050 be selected:
6051 @example
6052 :maxlevel    @r{Maximum level depth to which times are listed in the table.}
6053              @r{Clocks at deeper levels will be summed into the upper level.}
6054 :scope       @r{The scope to consider.  This can be any of the following:}
6055              nil        @r{the current buffer or narrowed region}
6056              file       @r{the full current buffer}
6057              subtree    @r{the subtree where the clocktable is located}
6058              tree@var{N}      @r{the surrounding level @var{N} tree, for example @code{tree3}}
6059              tree       @r{the surrounding level 1 tree}
6060              agenda     @r{all agenda files}
6061              ("file"..) @r{scan these files}
6062              file-with-archives    @r{current file and its archives}
6063              agenda-with-archives  @r{all agenda files, including archives}
6064 :block       @r{The time block to consider.  This block is specified either}
6065              @r{absolute, or relative to the current time and may be any of}
6066              @r{these formats:}
6067              2007-12-31    @r{New year eve 2007}
6068              2007-12       @r{December 2007}
6069              2007-W50      @r{ISO-week 50 in 2007}
6070              2007-Q2       @r{2nd quarter in 2007}
6071              2007          @r{the year 2007}
6072              today, yesterday, today-@var{N}          @r{a relative day}
6073              thisweek, lastweek, thisweek-@var{N}     @r{a relative week}
6074              thismonth, lastmonth, thismonth-@var{N}  @r{a relative month}
6075              thisyear, lastyear, thisyear-@var{N}     @r{a relative year}
6076              @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6077 :tstart      @r{A time string specifying when to start considering times.}
6078 :tend        @r{A time string specifying when to stop considering times.}
6079 :step        @r{@code{week} or @code{day}, to split the table into chunks.}
6080              @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6081 :stepskip0   @r{Do not show steps that have zero time.}
6082 :fileskip0   @r{Do not show table sections from files which did not contribute.}
6083 :tags        @r{A tags match to select entries that should contribute.  See}
6084              @r{@ref{Matching tags and properties} for the match syntax.}
6085 @end example
6087 Then there are options which determine the formatting of the table.  There
6088 options are interpreted by the function @code{org-clocktable-write-default},
6089 but you can specify your own function using the @code{:formatter} parameter.
6090 @example
6091 :emphasize   @r{When @code{t}, emphasize level one and level two items.}
6092 :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".}
6093 :link        @r{Link the item headlines in the table to their origins.}
6094 :narrow      @r{An integer to limit the width of the headline column in}
6095              @r{the org table.  If you write it like @samp{50!}, then the}
6096              @r{headline will also be shortened in export.}
6097 :indent      @r{Indent each headline field according to its level.}
6098 :tcolumns    @r{Number of columns to be used for times.  If this is smaller}
6099              @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6100 :level       @r{Should a level number column be included?}
6101 :compact     @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6102              @r{All are overwritten except if there is an explicit @code{:narrow}}
6103 :timestamp   @r{A timestamp for the entry, when available.  Look for SCHEDULED,}
6104              @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6105 :properties  @r{List of properties that should be shown in the table.  Each}
6106              @r{property will get its own column.}
6107 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6108 :formula     @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6109              @r{As a special case, @samp{:formula %} adds a column with % time.}
6110              @r{If you do not specify a formula here, any existing formula}
6111              @r{below the clock table will survive updates and be evaluated.}
6112 :formatter   @r{A function to format clock data and insert it into the buffer.}
6113 @end example
6114 To get a clock summary of the current level 1 tree, for the current
6115 day, you could write
6116 @example
6117 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6118 #+END: clocktable
6119 @end example
6120 @noindent
6121 and to use a specific time range you could write@footnote{Note that all
6122 parameters must be specified in a single line---the line is broken here
6123 only to fit it into the manual.}
6124 @example
6125 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6126                     :tend "<2006-08-10 Thu 12:00>"
6127 #+END: clocktable
6128 @end example
6129 A summary of the current subtree with % times would be
6130 @example
6131 #+BEGIN: clocktable :scope subtree :link t :formula %
6132 #+END: clocktable
6133 @end example
6134 A horizontally compact representation of everything clocked during last week
6135 would be
6136 @example
6137 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6138 #+END: clocktable
6139 @end example
6141 @node Resolving idle time,  , The clock table, Clocking work time
6142 @subsection Resolving idle time
6143 @cindex resolve idle time
6145 @cindex idle, resolve, dangling
6146 If you clock in on a work item, and then walk away from your
6147 computer---perhaps to take a phone call---you often need to ``resolve'' the
6148 time you were away by either subtracting it from the current clock, or
6149 applying it to another one.
6151 @vindex org-clock-idle-time
6152 By customizing the variable @code{org-clock-idle-time} to some integer, such
6153 as 10 or 15, Emacs can alert you when you get back to your computer after
6154 being idle for that many minutes@footnote{On computers using Mac OS X,
6155 idleness is based on actual user idleness, not just Emacs' idle time.  For
6156 X11, you can install a utility program @file{x11idle.c}, available in the
6157 UTILITIES directory of the Org git distribution, to get the same general
6158 treatment of idleness.  On other systems, idle time refers to Emacs idle time
6159 only.}, and ask what you want to do with the idle time.  There will be a
6160 question waiting for you when you get back, indicating how much idle time has
6161 passed (constantly updated with the current amount), as well as a set of
6162 choices to correct the discrepancy:
6164 @table @kbd
6165 @item k
6166 To keep some or all of the minutes and stay clocked in, press @kbd{k}.  Org
6167 will ask how many of the minutes to keep.  Press @key{RET} to keep them all,
6168 effectively changing nothing, or enter a number to keep that many minutes.
6169 @item K
6170 If you use the shift key and press @kbd{K}, it will keep however many minutes
6171 you request and then immediately clock out of that task.  If you keep all of
6172 the minutes, this is the same as just clocking out of the current task.
6173 @item s
6174 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6175 the clock, and then check back in from the moment you returned.
6176 @item S
6177 To keep none of the minutes and just clock out at the start of the away time,
6178 use the shift key and press @kbd{S}.  Remember that using shift will always
6179 leave you clocked out, no matter which option you choose.
6180 @item C
6181 To cancel the clock altogether, use @kbd{C}.  Note that if instead of
6182 canceling you subtract the away time, and the resulting clock amount is less
6183 than a minute, the clock will still be canceled rather than clutter up the
6184 log with an empty entry.
6185 @end table
6187 What if you subtracted those away minutes from the current clock, and now
6188 want to apply them to a new clock?  Simply clock in to any task immediately
6189 after the subtraction.  Org will notice that you have subtracted time ``on
6190 the books'', so to speak, and will ask if you want to apply those minutes to
6191 the next task you clock in on.
6193 There is one other instance when this clock resolution magic occurs.  Say you
6194 were clocked in and hacking away, and suddenly your cat chased a mouse who
6195 scared a hamster that crashed into your UPS's power button!  You suddenly
6196 lose all your buffers, but thanks to auto-save you still have your recent Org
6197 mode changes, including your last clock in.
6199 If you restart Emacs and clock into any task, Org will notice that you have a
6200 dangling clock which was never clocked out from your last session.  Using
6201 that clock's starting time as the beginning of the unaccounted-for period,
6202 Org will ask how you want to resolve that time.  The logic and behavior is
6203 identical to dealing with away time due to idleness; it is just happening due
6204 to a recovery event rather than a set amount of idle time.
6206 You can also check all the files visited by your Org agenda for dangling
6207 clocks at any time using @kbd{M-x org-resolve-clocks}.
6209 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6210 @section Effort estimates
6211 @cindex effort estimates
6213 @cindex property, Effort
6214 @vindex org-effort-property
6215 If you want to plan your work in a very detailed way, or if you need to
6216 produce offers with quotations of the estimated work effort, you may want to
6217 assign effort estimates to entries.  If you are also clocking your work, you
6218 may later want to compare the planned effort with the actual working time, a
6219 great way to improve planning estimates.  Effort estimates are stored in a
6220 special property @samp{Effort}@footnote{You may change the property being
6221 used with the variable @code{org-effort-property}.}.  You can set the effort
6222 for an entry with the following commands:
6224 @table @kbd
6225 @orgcmd{C-c C-x e,org-set-effort}
6226 Set the effort estimate for the current entry.  With a numeric prefix
6227 argument, set it to the Nth allowed value (see below).  This command is also
6228 accessible from the agenda with the @kbd{e} key.
6229 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6230 Modify the effort estimate of the item currently being clocked.
6231 @end table
6233 Clearly the best way to work with effort estimates is through column view
6234 (@pxref{Column view}).  You should start by setting up discrete values for
6235 effort estimates, and a @code{COLUMNS} format that displays these values
6236 together with clock sums (if you want to clock your time).  For a specific
6237 buffer you can use
6239 @example
6240 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6241 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6242 @end example
6244 @noindent
6245 @vindex org-global-properties
6246 @vindex org-columns-default-format
6247 or, even better, you can set up these values globally by customizing the
6248 variables @code{org-global-properties} and @code{org-columns-default-format}.
6249 In particular if you want to use this setup also in the agenda, a global
6250 setup may be advised.
6252 The way to assign estimates to individual items is then to switch to column
6253 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6254 value.  The values you enter will immediately be summed up in the hierarchy.
6255 In the column next to it, any clocked time will be displayed.
6257 @vindex org-agenda-columns-add-appointments-to-effort-sum
6258 If you switch to column view in the daily/weekly agenda, the effort column
6259 will summarize the estimated work effort for each day@footnote{Please note
6260 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6261 column view}).}, and you can use this to find space in your schedule.  To get
6262 an overview of the entire part of the day that is committed, you can set the
6263 option @code{org-agenda-columns-add-appointments-to-effort-sum}.  The
6264 appointments on a day that take place over a specified time interval will
6265 then also be added to the load estimate of the day.
6267 Effort estimates can be used in secondary agenda filtering that is triggered
6268 with the @kbd{/} key in the agenda (@pxref{Agenda commands}).  If you have
6269 these estimates defined consistently, two or three key presses will narrow
6270 down the list to stuff that fits into an available time slot.
6272 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6273 @section Taking notes with a relative timer
6274 @cindex relative timer
6276 When taking notes during, for example, a meeting or a video viewing, it can
6277 be useful to have access to times relative to a starting time.  Org provides
6278 such a relative timer and make it easy to create timed notes.
6280 @table @kbd
6281 @orgcmd{C-c C-x .,org-timer}
6282 Insert a relative time into the buffer.  The first time you use this, the
6283 timer will be started.  When called with a prefix argument, the timer is
6284 restarted.
6285 @orgcmd{C-c C-x -,org-timer-item}
6286 Insert a description list item with the current relative time.  With a prefix
6287 argument, first reset the timer to 0.
6288 @orgcmd{M-@key{RET},org-insert-heading}
6289 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6290 new timer items.
6291 @c for key sequences with a comma, command name macros fail :(
6292 @kindex C-c C-x ,
6293 @item C-c C-x ,
6294 Pause the timer, or continue it if it is already paused
6295 (@command{org-timer-pause-or-continue}).
6296 @c removed the sentence because it is redundant to the following item
6297 @kindex C-u C-c C-x ,
6298 @item C-u C-c C-x ,
6299 Stop the timer.  After this, you can only start a new timer, not continue the
6300 old one.  This command also removes the timer from the mode line.
6301 @orgcmd{C-c C-x 0,org-timer-start}
6302 Reset the timer without inserting anything into the buffer.  By default, the
6303 timer is reset to 0.  When called with a @kbd{C-u} prefix, reset the timer to
6304 specific starting offset.  The user is prompted for the offset, with a
6305 default taken from a timer string at point, if any, So this can be used to
6306 restart taking notes after a break in the process.  When called with a double
6307 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6308 by a certain amount.  This can be used to fix timer strings if the timer was
6309 not started at exactly the right moment.
6310 @end table
6312 @node Countdown timer,  , Relative timer, Dates and Times
6313 @section Countdown timer
6314 @cindex Countdown timer
6315 @kindex C-c C-x ;
6316 @kindex ;
6318 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6319 timer.  Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6321 @code{org-timer-set-timer} prompts the user for a duration and displays a
6322 countdown timer in the modeline.  @code{org-timer-default-timer} sets the
6323 default countdown value.  Giving a prefix numeric argument overrides this
6324 default value.
6326 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6327 @chapter Capture - Refile - Archive
6328 @cindex capture
6330 An important part of any organization system is the ability to quickly
6331 capture new ideas and tasks, and to associate reference material with them.
6332 Org does this using a process called @i{capture}.  It also can store files
6333 related to a task (@i{attachments}) in a special directory.  Once in the
6334 system, tasks and projects need to be moved around.  Moving completed project
6335 trees to an archive file keeps the system compact and fast.
6337 @menu
6338 * Capture::                     Capturing new stuff
6339 * Attachments::                 Add files to tasks
6340 * RSS Feeds::                   Getting input from RSS feeds
6341 * Protocols::                   External (e.g.@: Browser) access to Emacs and Org
6342 * Refiling notes::              Moving a tree from one place to another
6343 * Archiving::                   What to do with finished projects
6344 @end menu
6346 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6347 @section Capture
6348 @cindex capture
6350 Org's method for capturing new items is heavily inspired by John Wiegley
6351 excellent remember package.  Up to version 6.36 Org used a special setup
6352 for @file{remember.el}.  @file{org-remember.el} is still part of Org mode for
6353 backward compatibility with existing setups.  You can find the documentation
6354 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6356 The new capturing setup described here is preferred and should be used by new
6357 users.  To convert your @code{org-remember-templates}, run the command
6358 @example
6359 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6360 @end example
6361 @noindent and then customize the new variable with @kbd{M-x
6362 customize-variable org-capture-templates}, check the result, and save the
6363 customization.  You can then use both remember and capture until
6364 you are familiar with the new mechanism.
6366 Capture lets you quickly store notes with little interruption of your work
6367 flow.  The basic process of capturing is very similar to remember, but Org
6368 does enhance it with templates and more.
6370 @menu
6371 * Setting up capture::          Where notes will be stored
6372 * Using capture::               Commands to invoke and terminate capture
6373 * Capture templates::           Define the outline of different note types
6374 @end menu
6376 @node Setting up capture, Using capture, Capture, Capture
6377 @subsection Setting up capture
6379 The following customization sets a default target file for notes, and defines
6380 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6381 suggestion.}  for capturing new material.
6383 @vindex org-default-notes-file
6384 @example
6385 (setq org-default-notes-file (concat org-directory "/notes.org"))
6386 (define-key global-map "\C-cc" 'org-capture)
6387 @end example
6389 @node Using capture, Capture templates, Setting up capture, Capture
6390 @subsection Using capture
6392 @table @kbd
6393 @orgcmd{C-c c,org-capture}
6394 Call the command @code{org-capture}.  Note that this keybinding is global and
6395 not active by default - you need to install it.  If you have templates
6396 @cindex date tree
6397 defined @pxref{Capture templates}, it will offer these templates for
6398 selection or use a new Org outline node as the default template.  It will
6399 insert the template into the target file and switch to an indirect buffer
6400 narrowed to this new node.  You may then insert the information you want.
6402 @orgcmd{C-c C-c,org-capture-finalize}
6403 Once you have finished entering information into the capture buffer, @kbd{C-c
6404 C-c} will return you to the window configuration before the capture process,
6405 so that you can resume your work without further distraction.  When called
6406 with a prefix arg, finalize and then jump to the captured item.
6408 @orgcmd{C-c C-w,org-capture-refile}
6409 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6410 a different place.  Please realize that this is a normal refiling command
6411 that will be executed---so the cursor position at the moment you run this
6412 command is important.  If you have inserted a tree with a parent and
6413 children, first move the cursor back to the parent.  Any prefix argument
6414 given to this command will be passed on to the @code{org-refile} command.
6416 @orgcmd{C-c C-k,org-capture-kill}
6417 Abort the capture process and return to the previous state.
6419 @end table
6421 You can also call @code{org-capture} in a special way from the agenda, using
6422 the @kbd{k c} key combination.  With this access, any timestamps inserted by
6423 the selected capture template will default to the cursor date in the agenda,
6424 rather than to the current date.
6426 To find the locations of the last stored capture, use @code{org-capture} with
6427 prefix commands:
6429 @table @kbd
6430 @orgkey{C-u C-c c}
6431 Visit the target location of a capture template.  You get to select the
6432 template in the usual way.
6433 @orgkey{C-u C-u C-c c}
6434 Visit the last stored capture item in its buffer.
6435 @end table
6437 @node Capture templates,  , Using capture, Capture
6438 @subsection Capture templates
6439 @cindex templates, for Capture
6441 You can use templates for different types of capture items, and
6442 for different target locations.  The easiest way to create such templates is
6443 through the customize interface.
6445 @table @kbd
6446 @orgkey{C-c c C}
6447 Customize the variable @code{org-capture-templates}.
6448 @end table
6450 Before we give the formal description of template definitions, let's look at
6451 an example.  Say you would like to use one template to create general TODO
6452 entries, and you want to put these entries under the heading @samp{Tasks} in
6453 your file @file{~/org/gtd.org}.  Also, a date tree in the file
6454 @file{journal.org} should capture journal entries.  A possible configuration
6455 would look like:
6457 @example
6458 (setq org-capture-templates
6459  '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6460         "* TODO %?\n  %i\n  %a")
6461    ("j" "Journal" entry (file+datetree "~/org/journal.org")
6462         "* %?\nEntered on %U\n  %i\n  %a")))
6463 @end example
6465 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6466 for you like this:
6467 @example
6468 * TODO
6469   [[file:@var{link to where you initiated capture}]]
6470 @end example
6472 @noindent
6473 During expansion of the template, @code{%a} has been replaced by a link to
6474 the location from where you called the capture command.  This can be
6475 extremely useful for deriving tasks from emails, for example.  You fill in
6476 the task definition, press @code{C-c C-c} and Org returns you to the same
6477 place where you started the capture process.
6479 To define special keys to capture to a particular template without going
6480 through the interactive template selection, you can create your key binding
6481 like this:
6483 @lisp
6484 (define-key global-map "\C-cx"
6485    (lambda () (interactive) (org-capture nil "x")))
6486 @end lisp
6488 @menu
6489 * Template elements::           What is needed for a complete template entry
6490 * Template expansion::          Filling in information about time and context
6491 @end menu
6493 @node Template elements, Template expansion, Capture templates, Capture templates
6494 @subsubsection Template elements
6496 Now lets look at the elements of a template definition.  Each entry in
6497 @code{org-capture-templates} is a list with the following items:
6499 @table @var
6500 @item keys
6501 The keys that will select the template, as a string, characters
6502 only, for example @code{"a"} for a template to be selected with a
6503 single key, or @code{"bt"} for selection with two keys.  When using
6504 several keys, keys using the same prefix key must be sequential
6505 in the list and preceded by a 2-element entry explaining the
6506 prefix key, for example
6507 @example
6508          ("b" "Templates for marking stuff to buy")
6509 @end example
6510 @noindent If you do not define a template for the @kbd{C} key, this key will
6511 be used to open the customize buffer for this complex variable.
6513 @item description
6514 A short string describing the template, which will be shown during
6515 selection.
6517 @item type
6518 The type of entry, a symbol.  Valid values are:
6519 @table @code
6520 @item entry
6521 An Org mode node, with a headline.  Will be filed as the child of the target
6522 entry or as a top-level entry.  The target file should be an Org mode file.
6523 @item item
6524 A plain list item, placed in the first plain  list at the target
6525 location.  Again the target file should be an Org file.
6526 @item checkitem
6527 A checkbox item.  This only differs from the plain list item by the
6528 default template.
6529 @item table-line
6530 a new line in the first table at the target location.  Where exactly the
6531 line will be inserted depends on the properties @code{:prepend} and
6532 @code{:table-line-pos} (see below).
6533 @item plain
6534 Text to be inserted as it is.
6535 @end table
6537 @item target
6538 @vindex org-default-notes-file
6539 Specification of where the captured item should be placed.  In Org mode
6540 files, targets usually define a node.  Entries will become children of this
6541 node.  Other types will be added to the table or list in the body of this
6542 node.  Most target specifications contain a file name.  If that file name is
6543 the empty string, it defaults to @code{org-default-notes-file}.  A file can
6544 also be given as a variable, function, or Emacs Lisp form.
6546 Valid values are:
6547 @table @code
6548 @item (file "path/to/file")
6549 Text will be placed at the beginning or end of that file.
6551 @item (id "id of existing org entry")
6552 Filing as child of this entry, or in the body of the entry.
6554 @item (file+headline "path/to/file" "node headline")
6555 Fast configuration if the target heading is unique in the file.
6557 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6558 For non-unique headings, the full path is safer.
6560 @item (file+regexp  "path/to/file" "regexp to find location")
6561 Use a regular expression to position the cursor.
6563 @item (file+datetree "path/to/file")
6564 Will create a heading in a date tree for today's date.
6566 @item (file+datetree+prompt "path/to/file")
6567 Will create a heading in a date tree, but will prompt for the date.
6569 @item (file+function "path/to/file" function-finding-location)
6570 A function to find the right location in the file.
6572 @item (clock)
6573 File to the entry that is currently being clocked.
6575 @item (function function-finding-location)
6576 Most general way, write your own function to find both
6577 file and location.
6578 @end table
6580 @item template
6581 The template for creating the capture item.  If you leave this empty, an
6582 appropriate default template will be used.  Otherwise this is a string with
6583 escape codes, which will be replaced depending on time and context of the
6584 capture call.  The string with escapes may be loaded from a template file,
6585 using the special syntax @code{(file "path/to/template")}.  See below for
6586 more details.
6588 @item properties
6589 The rest of the entry is a property list of additional options.
6590 Recognized properties are:
6591 @table @code
6592 @item :prepend
6593 Normally new captured information will be appended at
6594 the target location (last child, last table line, last list item...).
6595 Setting this property will change that.
6597 @item :immediate-finish
6598 When set, do not offer to edit the information, just
6599 file it away immediately.  This makes sense if the template only needs
6600 information that can be added automatically.
6602 @item :empty-lines
6603 Set this to the number of lines to insert
6604 before and after the new item.  Default 0, only common other value is 1.
6606 @item :clock-in
6607 Start the clock in this item.
6609 @item :clock-keep
6610 Keep the clock running when filing the captured entry.
6612 @item :clock-resume
6613 If starting the capture interrupted a clock, restart that clock when finished
6614 with the capture.  Note that @code{:clock-keep} has precedence over
6615 @code{:clock-resume}.  When setting both to @code{t}, the current clock will
6616 run and the previous one will not be resumed.
6618 @item :unnarrowed
6619 Do not narrow the target buffer, simply show the full buffer.  Default is to
6620 narrow it so that you only see the new material.
6622 @item :table-line-pos
6623 Specification of the location in the table where the new line should be
6624 inserted.  It should be a string like @code{"II-3"} meaning that the new
6625 line should become the third line before the second horizontal separator
6626 line.
6628 @item :kill-buffer
6629 If the target file was not yet visited when capture was invoked, kill the
6630 buffer again after capture is completed.
6631 @end table
6632 @end table
6634 @node Template expansion,  , Template elements, Capture templates
6635 @subsubsection Template expansion
6637 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6638 these sequences literally, escape the @kbd{%} with a backslash.}  allow
6639 dynamic insertion of content.  The templates are expanded in the order given here:
6641 @smallexample
6642 %[@var{file}]     @r{insert the contents of the file given by @var{file}.}
6643 %(@var{sexp})     @r{evaluate Elisp @var{sexp} and replace with the result.}
6644 %<...>      @r{the result of format-time-string on the ... format specification.}
6645 %t          @r{timestamp, date only.}
6646 %T          @r{timestamp with date and time.}
6647 %u, %U      @r{like the above, but inactive timestamps.}
6648 %a          @r{annotation, normally the link created with @code{org-store-link}.}
6649 %i          @r{initial content, the region when capture is called while the}
6650             @r{region is active.}
6651             @r{The entire text will be indented like @code{%i} itself.}
6652 %A          @r{like @code{%a}, but prompt for the description part.}
6653 %c          @r{Current kill ring head.}
6654 %x          @r{Content of the X clipboard.}
6655 %k          @r{title of the currently clocked task.}
6656 %K          @r{link to the currently clocked task.}
6657 %n          @r{user name (taken from @code{user-full-name}).}
6658 %f          @r{file visited by current buffer when org-capture was called.}
6659 %F          @r{full path of the file or directory visited by current buffer.}
6660 %:keyword   @r{specific information for certain link types, see below.}
6661 %^g         @r{prompt for tags, with completion on tags in target file.}
6662 %^G         @r{prompt for tags, with completion all tags in all agenda files.}
6663 %^t         @r{like @code{%t}, but prompt for date.  Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
6664             @r{You may define a prompt like @code{%^@{Birthday@}t}.}
6665 %^C         @r{Interactive selection of which kill or clip to use.}
6666 %^L         @r{Like @code{%^C}, but insert as link.}
6667 %^@{@var{prop}@}p   @r{Prompt the user for a value for property @var{prop}.}
6668 %^@{@var{prompt}@}  @r{prompt the user for a string and replace this sequence with it.}
6669             @r{You may specify a default value and a completion table with}
6670             @r{%^@{prompt|default|completion2|completion3...@}.}
6671             @r{The arrow keys access a prompt-specific history.}
6672 @end smallexample
6674 @noindent
6675 For specific link types, the following keywords will be
6676 defined@footnote{If you define your own link types (@pxref{Adding
6677 hyperlink types}), any property you store with
6678 @code{org-store-link-props} can be accessed in capture templates in a
6679 similar way.}:
6681 @vindex org-from-is-user-regexp
6682 @smallexample
6683 Link type               |  Available keywords
6684 ------------------------+----------------------------------------------
6685 bbdb                    |  %:name %:company
6686 irc                     |  %:server %:port %:nick
6687 vm, wl, mh, mew, rmail  |  %:type %:subject %:message-id
6688                         |  %:from %:fromname %:fromaddress
6689                         |  %:to   %:toname   %:toaddress
6690                         |  %:date @r{(message date header field)}
6691                         |  %:date-timestamp @r{(date as active timestamp)}
6692                         |  %:date-timestamp-inactive @r{(date as inactive timestamp)}
6693                         |  %: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}.}}
6694 gnus                    |  %:group, @r{for messages also all email fields}
6695 w3, w3m                 |  %:url
6696 info                    |  %:file %:node
6697 calendar                |  %:date
6698 @end smallexample
6700 @noindent
6701 To place the cursor after template expansion use:
6703 @smallexample
6704 %?          @r{After completing the template, position cursor here.}
6705 @end smallexample
6708 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6709 @section Attachments
6710 @cindex attachments
6712 @vindex org-attach-directory
6713 It is often useful to associate reference material with an outline node/task.
6714 Small chunks of plain text can simply be stored in the subtree of a project.
6715 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6716 files that live elsewhere on your computer or in the cloud, like emails or
6717 source code files belonging to a project.  Another method is @i{attachments},
6718 which are files located in a directory belonging to an outline node.  Org
6719 uses directories named by the unique ID of each entry.  These directories are
6720 located in the @file{data} directory which lives in the same directory where
6721 your Org file lives@footnote{If you move entries or Org files from one
6722 directory to another, you may want to configure @code{org-attach-directory}
6723 to contain an absolute path.}.  If you initialize this directory with
6724 @code{git init}, Org will automatically commit changes when it sees them.
6725 The attachment system has been contributed to Org by John Wiegley.
6727 In cases where it seems better to do so, you can also attach a directory of your
6728 choice to an entry.  You can also make children inherit the attachment
6729 directory from a parent, so that an entire subtree uses the same attached
6730 directory.
6732 @noindent The following commands deal with attachments:
6734 @table @kbd
6736 @orgcmd{C-c C-a,org-attach}
6737 The dispatcher for commands related to the attachment system.  After these
6738 keys, a list of commands is displayed and you must press an additional key
6739 to select a command:
6741 @table @kbd
6742 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6743 @vindex org-attach-method
6744 Select a file and move it into the task's attachment directory.  The file
6745 will be copied, moved, or linked, depending on @code{org-attach-method}.
6746 Note that hard links are not supported on all systems.
6748 @kindex C-c C-a c
6749 @kindex C-c C-a m
6750 @kindex C-c C-a l
6751 @item c/m/l
6752 Attach a file using the copy/move/link method.
6753 Note that hard links are not supported on all systems.
6755 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6756 Create a new attachment as an Emacs buffer.
6758 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6759 Synchronize the current task with its attachment directory, in case you added
6760 attachments yourself.
6762 @orgcmdtkc{o,C-c C-a o,org-attach-open}
6763 @vindex org-file-apps
6764 Open current task's attachment.  If there is more than one, prompt for a
6765 file name first.  Opening will follow the rules set by @code{org-file-apps}.
6766 For more details, see the information on following hyperlinks
6767 (@pxref{Handling links}).
6769 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6770 Also open the attachment, but force opening the file in Emacs.
6772 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6773 Open the current task's attachment directory.
6775 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6776 Also open the directory, but force using @command{dired} in Emacs.
6778 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6779 Select and delete a single attachment.
6781 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6782 Delete all of a task's attachments.  A safer way is to open the directory in
6783 @command{dired} and delete from there.
6785 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6786 @cindex property, ATTACH_DIR
6787 Set a specific directory as the entry's attachment directory.  This works by
6788 putting the directory path into the @code{ATTACH_DIR} property.
6790 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6791 @cindex property, ATTACH_DIR_INHERIT
6792 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6793 same directory for attachments as the parent does.
6794 @end table
6795 @end table
6797 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6798 @section RSS feeds
6799 @cindex RSS feeds
6800 @cindex Atom feeds
6802 Org can add and change entries based on information found in RSS feeds and
6803 Atom feeds.  You could use this to make a task out of each new podcast in a
6804 podcast feed.  Or you could use a phone-based note-creating service on the
6805 web to import tasks into Org.  To access feeds, configure the variable
6806 @code{org-feed-alist}.  The docstring of this variable has detailed
6807 information.  Here is just an example:
6809 @example
6810 (setq org-feed-alist
6811      '(("Slashdot"
6812          "http://rss.slashdot.org/Slashdot/slashdot"
6813          "~/txt/org/feeds.org" "Slashdot Entries")))
6814 @end example
6816 @noindent
6817 will configure that new items from the feed provided by
6818 @code{rss.slashdot.org} will result in new entries in the file
6819 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6820 the following command is used:
6822 @table @kbd
6823 @orgcmd{C-c C-x g,org-feed-update-all}
6824 @item C-c C-x g
6825 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6826 them.
6827 @orgcmd{C-c C-x G,org-feed-goto-inbox}
6828 Prompt for a feed name and go to the inbox configured for this feed.
6829 @end table
6831 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6832 it will store information about the status of items in the feed, to avoid
6833 adding the same item several times.  You should add @samp{FEEDSTATUS} to the
6834 list of drawers in that file:
6836 @example
6837 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6838 @end example
6840 For more information, including how to read atom feeds, see
6841 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6843 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6844 @section Protocols for external access
6845 @cindex protocols, for external access
6846 @cindex emacsserver
6848 You can set up Org for handling protocol calls from outside applications that
6849 are passed to Emacs through the @file{emacsserver}.  For example, you can
6850 configure bookmarks in your web browser to send a link to the current page to
6851 Org and create a note from it using capture (@pxref{Capture}).  Or you
6852 could create a bookmark that will tell Emacs to open the local source file of
6853 a remote website you are looking at with the browser.  See
6854 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6855 documentation and setup instructions.
6857 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6858 @section Refiling notes
6859 @cindex refiling notes
6861 When reviewing the captured data, you may want to refile some of the entries
6862 into a different list, for example into a project.  Cutting, finding the
6863 right location, and then pasting the note is cumbersome.  To simplify this
6864 process, you can use the following special command:
6866 @table @kbd
6867 @orgcmd{C-c C-w,org-refile}
6868 @vindex org-reverse-note-order
6869 @vindex org-refile-targets
6870 @vindex org-refile-use-outline-path
6871 @vindex org-outline-path-complete-in-steps
6872 @vindex org-refile-allow-creating-parent-nodes
6873 @vindex org-log-refile
6874 @vindex org-refile-use-cache
6875 Refile the entry or region at point.  This command offers possible locations
6876 for refiling the entry and lets you select one with completion.  The item (or
6877 all items in the region) is filed below the target heading as a subitem.
6878 Depending on @code{org-reverse-note-order}, it will be either the first or
6879 last subitem.@*
6880 By default, all level 1 headlines in the current buffer are considered to be
6881 targets, but you can have more complex definitions across a number of files.
6882 See the variable @code{org-refile-targets} for details.  If you would like to
6883 select a location via a file-path-like completion along the outline path, see
6884 the variables @code{org-refile-use-outline-path} and
6885 @code{org-outline-path-complete-in-steps}.  If you would like to be able to
6886 create new nodes as new parents for refiling on the fly, check the
6887 variable @code{org-refile-allow-creating-parent-nodes}.
6888 When the variable @code{org-log-refile}@footnote{with corresponding
6889 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6890 and @code{nologrefile}} is set, a timestamp or a note will be
6891 recorded when an entry has been refiled.
6892 @orgkey{C-u C-c C-w}
6893 Use the refile interface to jump to a heading.
6894 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
6895 Jump to the location where @code{org-refile} last moved a tree to.
6896 @item C-2 C-c C-w
6897 Refile as the child of the item currently being clocked.
6898 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6900 @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}
6902 Clear the target cache.  Caching of refile targets can be turned on by
6903 setting @code{org-refile-use-cache}.  To make the command see new possible
6904 targets, you have to clear the cache with this command.
6905 @end table
6907 @node Archiving,  , Refiling notes, Capture - Refile - Archive
6908 @section Archiving
6909 @cindex archiving
6911 When a project represented by a (sub)tree is finished, you may want
6912 to move the tree out of the way and to stop it from contributing to the
6913 agenda.  Archiving is important to keep your working files compact and global
6914 searches like the construction of agenda views fast.
6916 @table @kbd
6917 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
6918 @vindex org-archive-default-command
6919 Archive the current entry using the command specified in the variable
6920 @code{org-archive-default-command}.
6921 @end table
6923 @menu
6924 * Moving subtrees::             Moving a tree to an archive file
6925 * Internal archiving::          Switch off a tree but keep it in the file
6926 @end menu
6928 @node Moving subtrees, Internal archiving, Archiving, Archiving
6929 @subsection Moving a tree to the archive file
6930 @cindex external archiving
6932 The most common archiving action is to move a project tree to another file,
6933 the archive file.
6935 @table @kbd
6936 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
6937 @vindex org-archive-location
6938 Archive the subtree starting at the cursor position to the location
6939 given by @code{org-archive-location}.
6940 @orgkey{C-u C-c C-x C-s}
6941 Check if any direct children of the current headline could be moved to
6942 the archive.  To do this, each subtree is checked for open TODO entries.
6943 If none are found, the command offers to move it to the archive
6944 location.  If the cursor is @emph{not} on a headline when this command
6945 is invoked, the level 1 trees will be checked.
6946 @end table
6948 @cindex archive locations
6949 The default archive location is a file in the same directory as the
6950 current file, with the name derived by appending @file{_archive} to the
6951 current file name.  For information and examples on how to change this,
6952 see the documentation string of the variable
6953 @code{org-archive-location}.  There is also an in-buffer option for
6954 setting this variable, for example@footnote{For backward compatibility,
6955 the following also works: If there are several such lines in a file,
6956 each specifies the archive location for the text below it.  The first
6957 such line also applies to any text before its definition.  However,
6958 using this method is @emph{strongly} deprecated as it is incompatible
6959 with the outline structure of the document.  The correct method for
6960 setting multiple archive locations in a buffer is using properties.}:
6962 @cindex #+ARCHIVE
6963 @example
6964 #+ARCHIVE: %s_done::
6965 @end example
6967 @cindex property, ARCHIVE
6968 @noindent
6969 If you would like to have a special ARCHIVE location for a single entry
6970 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6971 location as the value (@pxref{Properties and Columns}).
6973 @vindex org-archive-save-context-info
6974 When a subtree is moved, it receives a number of special properties that
6975 record context information like the file from where the entry came, its
6976 outline path the archiving time etc.  Configure the variable
6977 @code{org-archive-save-context-info} to adjust the amount of information
6978 added.
6981 @node Internal archiving,  , Moving subtrees, Archiving
6982 @subsection Internal archiving
6984 If you want to just switch off (for agenda views) certain subtrees without
6985 moving them to a different file, you can use the @code{ARCHIVE tag}.
6987 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6988 its location in the outline tree, but behaves in the following way:
6989 @itemize @minus
6990 @item
6991 @vindex org-cycle-open-archived-trees
6992 It does not open when you attempt to do so with a visibility cycling
6993 command (@pxref{Visibility cycling}).  You can force cycling archived
6994 subtrees with @kbd{C-@key{TAB}}, or by setting the option
6995 @code{org-cycle-open-archived-trees}.  Also normal outline commands like
6996 @code{show-all} will open archived subtrees.
6997 @item
6998 @vindex org-sparse-tree-open-archived-trees
6999 During sparse tree construction (@pxref{Sparse trees}), matches in
7000 archived subtrees are not exposed, unless you configure the option
7001 @code{org-sparse-tree-open-archived-trees}.
7002 @item
7003 @vindex org-agenda-skip-archived-trees
7004 During agenda view construction (@pxref{Agenda Views}), the content of
7005 archived trees is ignored unless you configure the option
7006 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7007 be included.  In the agenda you can press @kbd{v a} to get archives
7008 temporarily included.
7009 @item
7010 @vindex org-export-with-archived-trees
7011 Archived trees are not exported (@pxref{Exporting}), only the headline
7012 is.  Configure the details using the variable
7013 @code{org-export-with-archived-trees}.
7014 @item
7015 @vindex org-columns-skip-archived-trees
7016 Archived trees are excluded from column view unless the variable
7017 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7018 @end itemize
7020 The following commands help manage the ARCHIVE tag:
7022 @table @kbd
7023 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7024 Toggle the ARCHIVE tag for the current headline.  When the tag is set,
7025 the headline changes to a shadowed face, and the subtree below it is
7026 hidden.
7027 @orgkey{C-u C-c C-x a}
7028 Check if any direct children of the current headline should be archived.
7029 To do this, each subtree is checked for open TODO entries.  If none are
7030 found, the command offers to set the ARCHIVE tag for the child.  If the
7031 cursor is @emph{not} on a headline when this command is invoked, the
7032 level 1 trees will be checked.
7033 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7034 Cycle a tree even if it is tagged with ARCHIVE.
7035 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7036 Move the current entry to the @emph{Archive Sibling}.  This is a sibling of
7037 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}.  The
7038 entry becomes a child of that sibling and in this way retains a lot of its
7039 original context, including inherited tags and approximate position in the
7040 outline.
7041 @end table
7044 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7045 @chapter Agenda views
7046 @cindex agenda views
7048 Due to the way Org works, TODO items, time-stamped items, and
7049 tagged headlines can be scattered throughout a file or even a number of
7050 files.  To get an overview of open action items, or of events that are
7051 important for a particular date, this information must be collected,
7052 sorted and displayed in an organized way.
7054 Org can select items based on various criteria and display them
7055 in a separate buffer.  Seven different view types are provided:
7057 @itemize @bullet
7058 @item
7059 an @emph{agenda} that is like a calendar and shows information
7060 for specific dates,
7061 @item
7062 a @emph{TODO list} that covers all unfinished
7063 action items,
7064 @item
7065 a @emph{match view}, showings headlines based on the tags, properties, and
7066 TODO state associated with them,
7067 @item
7068 a @emph{timeline view} that shows all events in a single Org file,
7069 in time-sorted view,
7070 @item
7071 a @emph{text search view} that shows all entries from multiple files
7072 that contain specified keywords,
7073 @item
7074 a @emph{stuck projects view} showing projects that currently don't move
7075 along, and
7076 @item
7077 @emph{custom views} that are special searches and combinations of different
7078 views.
7079 @end itemize
7081 @noindent
7082 The extracted information is displayed in a special @emph{agenda
7083 buffer}.  This buffer is read-only, but provides commands to visit the
7084 corresponding locations in the original Org files, and even to
7085 edit these files remotely.
7087 @vindex org-agenda-window-setup
7088 @vindex org-agenda-restore-windows-after-quit
7089 Two variables control how the agenda buffer is displayed and whether the
7090 window configuration is restored when the agenda exits:
7091 @code{org-agenda-window-setup} and
7092 @code{org-agenda-restore-windows-after-quit}.
7094 @menu
7095 * Agenda files::                Files being searched for agenda information
7096 * Agenda dispatcher::           Keyboard access to agenda views
7097 * Built-in agenda views::       What is available out of the box?
7098 * Presentation and sorting::    How agenda items are prepared for display
7099 * Agenda commands::             Remote editing of Org trees
7100 * Custom agenda views::         Defining special searches and views
7101 * Exporting Agenda Views::      Writing a view to a file
7102 * Agenda column view::          Using column view for collected entries
7103 @end menu
7105 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7106 @section Agenda files
7107 @cindex agenda files
7108 @cindex files for agenda
7110 @vindex org-agenda-files
7111 The information to be shown is normally collected from all @emph{agenda
7112 files}, the files listed in the variable
7113 @code{org-agenda-files}@footnote{If the value of that variable is not a
7114 list, but a single file name, then the list of agenda files will be
7115 maintained in that external file.}.  If a directory is part of this list,
7116 all files with the extension @file{.org} in this directory will be part
7117 of the list.
7119 Thus, even if you only work with a single Org file, that file should
7120 be put into the list@footnote{When using the dispatcher, pressing
7121 @kbd{<} before selecting a command will actually limit the command to
7122 the current file, and ignore @code{org-agenda-files} until the next
7123 dispatcher command.}.  You can customize @code{org-agenda-files}, but
7124 the easiest way to maintain it is through the following commands
7126 @cindex files, adding to agenda list
7127 @table @kbd
7128 @orgcmd{C-c [,org-agenda-file-to-front}
7129 Add current file to the list of agenda files.  The file is added to
7130 the front of the list.  If it was already in the list, it is moved to
7131 the front.  With a prefix argument, file is added/moved to the end.
7132 @orgcmd{C-c ],org-remove-file}
7133 Remove current file from the list of agenda files.
7134 @kindex C-,
7135 @cindex cycling, of agenda files
7136 @orgcmd{C-',org-cycle-agenda-files}
7137 @itemx C-,
7138 Cycle through agenda file list, visiting one file after the other.
7139 @kindex M-x org-iswitchb
7140 @item M-x org-iswitchb
7141 Command to use an @code{iswitchb}-like interface to switch to and between Org
7142 buffers.
7143 @end table
7145 @noindent
7146 The Org menu contains the current list of files and can be used
7147 to visit any of them.
7149 If you would like to focus the agenda temporarily on a file not in
7150 this list, or on just one file in the list, or even on only a subtree in a
7151 file, then this can be done in different ways.  For a single agenda command,
7152 you may press @kbd{<} once or several times in the dispatcher
7153 (@pxref{Agenda dispatcher}).  To restrict the agenda scope for an
7154 extended period, use the following commands:
7156 @table @kbd
7157 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7158 Permanently restrict the agenda to the current subtree.  When with a
7159 prefix argument, or with the cursor before the first headline in a file,
7160 the agenda scope is set to the entire file.  This restriction remains in
7161 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7162 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
7163 agenda view, the new restriction takes effect immediately.
7164 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7165 Remove the permanent restriction created by @kbd{C-c C-x <}.
7166 @end table
7168 @noindent
7169 When working with @file{speedbar.el}, you can use the following commands in
7170 the Speedbar frame:
7171 @table @kbd
7172 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7173 Permanently restrict the agenda to the item---either an Org file or a subtree
7174 in such a file---at the cursor in the Speedbar frame.
7175 If there is a window displaying an agenda view, the new restriction takes
7176 effect immediately.
7177 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7178 Lift the restriction.
7179 @end table
7181 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7182 @section The agenda dispatcher
7183 @cindex agenda dispatcher
7184 @cindex dispatching agenda commands
7185 The views are created through a dispatcher, which should be bound to a
7186 global key---for example @kbd{C-c a} (@pxref{Activation}).  In the
7187 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7188 is accessed and list keyboard access to commands accordingly.  After
7189 pressing @kbd{C-c a}, an additional letter is required to execute a
7190 command.  The dispatcher offers the following default commands:
7191 @table @kbd
7192 @item a
7193 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7194 @item t @r{/} T
7195 Create a list of all TODO items (@pxref{Global TODO list}).
7196 @item m @r{/} M
7197 Create a list of headlines matching a TAGS expression (@pxref{Matching
7198 tags and properties}).
7199 @item L
7200 Create the timeline view for the current buffer (@pxref{Timeline}).
7201 @item s
7202 Create a list of entries selected by a boolean expression of keywords
7203 and/or regular expressions that must or must not occur in the entry.
7204 @item /
7205 @vindex org-agenda-text-search-extra-files
7206 Search for a regular expression in all agenda files and additionally in
7207 the files listed in @code{org-agenda-text-search-extra-files}.  This
7208 uses the Emacs command @code{multi-occur}.  A prefix argument can be
7209 used to specify the number of context lines for each match, default is
7211 @item # @r{/} !
7212 Create a list of stuck projects (@pxref{Stuck projects}).
7213 @item <
7214 Restrict an agenda command to the current buffer@footnote{For backward
7215 compatibility, you can also press @kbd{1} to restrict to the current
7216 buffer.}.  After pressing @kbd{<}, you still need to press the character
7217 selecting the command.
7218 @item < <
7219 If there is an active region, restrict the following agenda command to
7220 the region.  Otherwise, restrict it to the current subtree@footnote{For
7221 backward compatibility, you can also press @kbd{0} to restrict to the
7222 current region/subtree.}.  After pressing @kbd{< <}, you still need to press the
7223 character selecting the command.
7224 @end table
7226 You can also define custom commands that will be accessible through the
7227 dispatcher, just like the default commands.  This includes the
7228 possibility to create extended agenda buffers that contain several
7229 blocks together, for example the weekly agenda, the global TODO list and
7230 a number of special tags matches.  @xref{Custom agenda views}.
7232 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7233 @section The built-in agenda views
7235 In this section we describe the built-in views.
7237 @menu
7238 * Weekly/daily agenda::         The calendar page with current tasks
7239 * Global TODO list::            All unfinished action items
7240 * Matching tags and properties::  Structured information with fine-tuned search
7241 * Timeline::                    Time-sorted view for single file
7242 * Search view::                 Find entries by searching for text
7243 * Stuck projects::              Find projects you need to review
7244 @end menu
7246 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7247 @subsection The weekly/daily agenda
7248 @cindex agenda
7249 @cindex weekly agenda
7250 @cindex daily agenda
7252 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7253 paper agenda, showing all the tasks for the current week or day.
7255 @table @kbd
7256 @cindex org-agenda, command
7257 @orgcmd{C-c a a,org-agenda-list}
7258 Compile an agenda for the current week from a list of Org files.  The agenda
7259 shows the entries for each day.  With a numeric prefix@footnote{For backward
7260 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7261 listed before the agenda.  This feature is deprecated, use the dedicated TODO
7262 list, or a block agenda instead (@pxref{Block agenda}).}  (like @kbd{C-u 2 1
7263 C-c a a}) you may set the number of days to be displayed.
7264 @end table
7266 @vindex org-agenda-span
7267 @vindex org-agenda-ndays
7268 The default number of days displayed in the agenda is set by the variable
7269 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}).  This
7270 variable can be set to any number of days you want to see by default in the
7271 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7272 @code{year}.
7274 Remote editing from the agenda buffer means, for example, that you can
7275 change the dates of deadlines and appointments from the agenda buffer.
7276 The commands available in the Agenda buffer are listed in @ref{Agenda
7277 commands}.
7279 @subsubheading Calendar/Diary integration
7280 @cindex calendar integration
7281 @cindex diary integration
7283 Emacs contains the calendar and diary by Edward M. Reingold.  The
7284 calendar displays a three-month calendar with holidays from different
7285 countries and cultures.  The diary allows you to keep track of
7286 anniversaries, lunar phases, sunrise/set, recurrent appointments
7287 (weekly, monthly) and more.  In this way, it is quite complementary to
7288 Org.  It can be very useful to combine output from Org with
7289 the diary.
7291 In order to include entries from the Emacs diary into Org mode's
7292 agenda, you only need to customize the variable
7294 @lisp
7295 (setq org-agenda-include-diary t)
7296 @end lisp
7298 @noindent After that, everything will happen automatically.  All diary
7299 entries including holidays, anniversaries, etc., will be included in the
7300 agenda buffer created by Org mode.  @key{SPC}, @key{TAB}, and
7301 @key{RET} can be used from the agenda buffer to jump to the diary
7302 file in order to edit existing diary entries.  The @kbd{i} command to
7303 insert new entries for the current date works in the agenda buffer, as
7304 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7305 Sunrise/Sunset times, show lunar phases and to convert to other
7306 calendars, respectively.  @kbd{c} can be used to switch back and forth
7307 between calendar and agenda.
7309 If you are using the diary only for sexp entries and holidays, it is
7310 faster to not use the above setting, but instead to copy or even move
7311 the entries into an Org file.  Org mode evaluates diary-style sexp
7312 entries, and does it faster because there is no overhead for first
7313 creating the diary display.  Note that the sexp entries must start at
7314 the left margin, no whitespace is allowed before them.  For example,
7315 the following segment of an Org file will be processed and entries
7316 will be made in the agenda:
7318 @example
7319 * Birthdays and similar stuff
7320 #+CATEGORY: Holiday
7321 %%(org-calendar-holiday)   ; special function for holiday names
7322 #+CATEGORY: Ann
7323 %%(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
7324 %%(org-anniversary 1869 10  2) Mahatma Gandhi would be %d years old
7325 @end example
7327 @subsubheading Anniversaries from BBDB
7328 @cindex BBDB, anniversaries
7329 @cindex anniversaries, from BBDB
7331 If you are using the Big Brothers Database to store your contacts, you will
7332 very likely prefer to store anniversaries in BBDB rather than in a
7333 separate Org or diary file.  Org supports this and will show BBDB
7334 anniversaries as part of the agenda.  All you need to do is to add the
7335 following to one of your agenda files:
7337 @example
7338 * Anniversaries
7339   :PROPERTIES:
7340   :CATEGORY: Anniv
7341   :END:
7342 %%(org-bbdb-anniversaries)
7343 @end example
7345 You can then go ahead and define anniversaries for a BBDB record.  Basically,
7346 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7347 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7348 followed by a space and the class of the anniversary (@samp{birthday} or
7349 @samp{wedding}, or a format string).  If you omit the class, it will default to
7350 @samp{birthday}.  Here are a few examples, the header for the file
7351 @file{org-bbdb.el} contains more detailed information.
7353 @example
7354 1973-06-22
7355 06-22
7356 1955-08-02 wedding
7357 2008-04-14 %s released version 6.01 of org mode, %d years ago
7358 @end example
7360 After a change to BBDB, or for the first agenda display during an Emacs
7361 session, the agenda display will suffer a short delay as Org updates its
7362 hash with anniversaries.  However, from then on things will be very fast---much
7363 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7364 in an Org or Diary file.
7366 @subsubheading Appointment reminders
7367 @cindex @file{appt.el}
7368 @cindex appointment reminders
7369 @cindex appointment
7370 @cindex reminders
7372 Org can interact with Emacs appointments notification facility.  To add all
7373 the appointments of your agenda files, use the command
7374 @code{org-agenda-to-appt}.  This command also lets you filter through the
7375 list of your appointments and add only those belonging to a specific category
7376 or matching a regular expression.  See the docstring for details.
7378 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7379 @subsection The global TODO list
7380 @cindex global TODO list
7381 @cindex TODO list, global
7383 The global TODO list contains all unfinished TODO items formatted and
7384 collected into a single place.
7386 @table @kbd
7387 @orgcmd{C-c a t,org-todo-list}
7388 Show the global TODO list.  This collects the TODO items from all agenda
7389 files (@pxref{Agenda Views}) into a single buffer.  By default, this lists
7390 items with a state the is not a DONE state.  The buffer is in
7391 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7392 entries directly from that buffer (@pxref{Agenda commands}).
7393 @orgcmd{C-c a T,org-todo-list}
7394 @cindex TODO keyword matching
7395 @vindex org-todo-keywords
7396 Like the above, but allows selection of a specific TODO keyword.  You can
7397 also do this by specifying a prefix argument to @kbd{C-c a t}.  You are
7398 prompted for a keyword, and you may also specify several keywords by
7399 separating them with @samp{|} as the boolean OR operator.  With a numeric
7400 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7401 @kindex r
7402 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7403 a prefix argument to this command to change the selected TODO keyword,
7404 for example @kbd{3 r}.  If you often need a search for a specific
7405 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7406 Matching specific TODO keywords can also be done as part of a tags
7407 search (@pxref{Tag searches}).
7408 @end table
7410 Remote editing of TODO items means that you can change the state of a
7411 TODO entry with a single key press.  The commands available in the
7412 TODO list are described in @ref{Agenda commands}.
7414 @cindex sublevels, inclusion into TODO list
7415 Normally the global TODO list simply shows all headlines with TODO
7416 keywords.  This list can become very long.  There are two ways to keep
7417 it more compact:
7418 @itemize @minus
7419 @item
7420 @vindex org-agenda-todo-ignore-scheduled
7421 @vindex org-agenda-todo-ignore-deadlines
7422 @vindex org-agenda-todo-ignore-timestamp
7423 @vindex org-agenda-todo-ignore-with-date
7424 Some people view a TODO item that has been @emph{scheduled} for execution or
7425 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7426 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7427 @code{org-agenda-todo-ignore-deadlines},
7428 @code{org-agenda-todo-ignore-timestamp} and/or
7429 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7430 TODO list.
7431 @item
7432 @vindex org-agenda-todo-list-sublevels
7433 TODO items may have sublevels to break up the task into subtasks.  In
7434 such cases it may be enough to list only the highest level TODO headline
7435 and omit the sublevels from the global list.  Configure the variable
7436 @code{org-agenda-todo-list-sublevels} to get this behavior.
7437 @end itemize
7439 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7440 @subsection Matching tags and properties
7441 @cindex matching, of tags
7442 @cindex matching, of properties
7443 @cindex tags view
7444 @cindex match view
7446 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7447 or have properties (@pxref{Properties and Columns}), you can select headlines
7448 based on this metadata and collect them into an agenda buffer.  The match
7449 syntax described here also applies when creating sparse trees with @kbd{C-c /
7452 @table @kbd
7453 @orgcmd{C-c a m,org-tags-view}
7454 Produce a list of all headlines that match a given set of tags.  The
7455 command prompts for a selection criterion, which is a boolean logic
7456 expression with tags, like @samp{+work+urgent-withboss} or
7457 @samp{work|home} (@pxref{Tags}).  If you often need a specific search,
7458 define a custom command for it (@pxref{Agenda dispatcher}).
7459 @orgcmd{C-c a M,org-tags-view}
7460 @vindex org-tags-match-list-sublevels
7461 @vindex org-agenda-tags-todo-honor-ignore-options
7462 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7463 not-DONE state and force checking subitems (see variable
7464 @code{org-tags-match-list-sublevels}).  To exclude scheduled/deadline items,
7465 see the variable @code{org-agenda-tags-todo-honor-ignore-options}.  Matching
7466 specific TODO keywords together with a tags match is also possible, see
7467 @ref{Tag searches}.
7468 @end table
7470 The commands available in the tags list are described in @ref{Agenda
7471 commands}.
7473 @subsubheading Match syntax
7475 @cindex Boolean logic, for tag/property searches
7476 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7477 OR.  @samp{&} binds more strongly than @samp{|}.  Parentheses are currently
7478 not implemented.  Each element in the search is either a tag, a regular
7479 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7480 VALUE} with a comparison operator, accessing a property value.  Each element
7481 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7482 sugar for positive selection.  The AND operator @samp{&} is optional when
7483 @samp{+} or @samp{-} is present.  Here are some examples, using only tags.
7485 @table @samp
7486 @item +work-boss
7487 Select headlines tagged @samp{:work:}, but discard those also tagged
7488 @samp{:boss:}.
7489 @item work|laptop
7490 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7491 @item work|laptop+night
7492 Like before, but require the @samp{:laptop:} lines to be tagged also
7493 @samp{:night:}.
7494 @end table
7496 @cindex regular expressions, with tags search
7497 Instead of a tag, you may also specify a regular expression enclosed in curly
7498 braces.  For example,
7499 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7500 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7502 @cindex TODO keyword matching, with tags search
7503 @cindex level, require for tags/property match
7504 @cindex category, require for tags/property match
7505 @vindex org-odd-levels-only
7506 You may also test for properties (@pxref{Properties and Columns}) at the same
7507 time as matching tags.  The properties may be real properties, or special
7508 properties that represent other metadata (@pxref{Special properties}).  For
7509 example, the ``property'' @code{TODO} represents the TODO keyword of the
7510 entry.  Or, the ``property'' @code{LEVEL} represents the level of an entry.
7511 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7512 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7513 DONE.  In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7514 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7516 Here are more examples:
7517 @table @samp
7518 @item work+TODO="WAITING"
7519 Select @samp{:work:}-tagged TODO lines with the specific TODO
7520 keyword @samp{WAITING}.
7521 @item work+TODO="WAITING"|home+TODO="WAITING"
7522 Waiting tasks both at work and at home.
7523 @end table
7525 When matching properties, a number of different operators can be used to test
7526 the value of a property.  Here is a complex example:
7528 @example
7529 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2         \
7530          +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7531 @end example
7533 @noindent
7534 The type of comparison will depend on how the comparison value is written:
7535 @itemize @minus
7536 @item
7537 If the comparison value is a plain number, a numerical comparison is done,
7538 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7539 @samp{>=}, and @samp{<>}.
7540 @item
7541 If the comparison value is enclosed in double-quotes,
7542 a string comparison is done, and the same operators are allowed.
7543 @item
7544 If the comparison value is enclosed in double-quotes @emph{and} angular
7545 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7546 assumed to be date/time specifications in the standard Org way, and the
7547 comparison will be done accordingly.  Special values that will be recognized
7548 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7549 @code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
7550 specification.  Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7551 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7552 respectively, can be used.
7553 @item
7554 If the comparison value is enclosed
7555 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7556 regexp matches the property value, and @samp{<>} meaning that it does not
7557 match.
7558 @end itemize
7560 So the search string in the example finds entries tagged @samp{:work:} but
7561 not @samp{:boss:}, which also have a priority value @samp{A}, a
7562 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7563 property that is numerically smaller than 2, a @samp{:With:} property that is
7564 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7565 on or after October 11, 2008.
7567 Accessing TODO, LEVEL, and CATEGORY during a search is fast.  Accessing any
7568 other properties will slow down the search.  However, once you have paid the
7569 price by accessing one property, testing additional properties is cheap
7570 again.
7572 You can configure Org mode to use property inheritance during a search, but
7573 beware that this can slow down searches considerably.  See @ref{Property
7574 inheritance}, for details.
7576 For backward compatibility, and also for typing speed, there is also a
7577 different way to test TODO states in a search.  For this, terminate the
7578 tags/property part of the search string (which may include several terms
7579 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7580 expression just for TODO keywords.  The syntax is then similar to that for
7581 tags, but should be applied with care: for example, a positive selection on
7582 several TODO keywords cannot meaningfully be combined with boolean AND.
7583 However, @emph{negative selection} combined with AND can be meaningful.  To
7584 make sure that only lines are checked that actually have any TODO keyword
7585 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7586 part after the slash with @samp{!}.  Using @kbd{C-c a M} or @samp{/!} will
7587 not match TODO keywords in a DONE state.  Examples:
7589 @table @samp
7590 @item work/WAITING
7591 Same as @samp{work+TODO="WAITING"}
7592 @item work/!-WAITING-NEXT
7593 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7594 nor @samp{NEXT}
7595 @item work/!+WAITING|+NEXT
7596 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7597 @samp{NEXT}.
7598 @end table
7600 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7601 @subsection Timeline for a single file
7602 @cindex timeline, single file
7603 @cindex time-sorted view
7605 The timeline summarizes all time-stamped items from a single Org mode
7606 file in a @emph{time-sorted view}.  The main purpose of this command is
7607 to give an overview over events in a project.
7609 @table @kbd
7610 @orgcmd{C-c a L,org-timeline}
7611 Show a time-sorted view of the Org file, with all time-stamped items.
7612 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7613 (scheduled or not) are also listed under the current date.
7614 @end table
7616 @noindent
7617 The commands available in the timeline buffer are listed in
7618 @ref{Agenda commands}.
7620 @node Search view, Stuck projects, Timeline, Built-in agenda views
7621 @subsection Search view
7622 @cindex search view
7623 @cindex text search
7624 @cindex searching, for text
7626 This agenda view is a general text search facility for Org mode entries.
7627 It is particularly useful to find notes.
7629 @table @kbd
7630 @orgcmd{C-c a s,org-search-view}
7631 This is a special search that lets you select entries by matching a substring
7632 or specific words using a boolean logic.
7633 @end table
7634 For example, the search string @samp{computer equipment} will find entries
7635 that contain @samp{computer equipment} as a substring.  If the two words are
7636 separated by more space or a line break, the search will still match.
7637 Search view can also search for specific keywords in the entry, using Boolean
7638 logic.  The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7639 will search for note entries that contain the keywords @code{computer}
7640 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7641 not matched by the regular expression @code{8\.11[bg]}, meaning to
7642 exclude both 8.11b and 8.11g.  The first @samp{+} is necessary to turn on
7643 word search, other @samp{+} characters are optional.  For more details, see
7644 the docstring of the command @code{org-search-view}.
7646 @vindex org-agenda-text-search-extra-files
7647 Note that in addition to the agenda files, this command will also search
7648 the files listed in @code{org-agenda-text-search-extra-files}.
7650 @node Stuck projects,  , Search view, Built-in agenda views
7651 @subsection Stuck projects
7652 @pindex GTD, Getting Things Done
7654 If you are following a system like David Allen's GTD to organize your
7655 work, one of the ``duties'' you have is a regular review to make sure
7656 that all projects move along.  A @emph{stuck} project is a project that
7657 has no defined next actions, so it will never show up in the TODO lists
7658 Org mode produces.  During the review, you need to identify such
7659 projects and define next actions for them.
7661 @table @kbd
7662 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7663 List projects that are stuck.
7664 @kindex C-c a !
7665 @item C-c a !
7666 @vindex org-stuck-projects
7667 Customize the variable @code{org-stuck-projects} to define what a stuck
7668 project is and how to find it.
7669 @end table
7671 You almost certainly will have to configure this view before it will
7672 work for you.  The built-in default assumes that all your projects are
7673 level-2 headlines, and that a project is not stuck if it has at least
7674 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7676 Let's assume that you, in your own way of using Org mode, identify
7677 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7678 indicate a project that should not be considered yet.  Let's further
7679 assume that the TODO keyword DONE marks finished projects, and that NEXT
7680 and TODO indicate next actions.  The tag @@SHOP indicates shopping and
7681 is a next action even without the NEXT tag.  Finally, if the project
7682 contains the special word IGNORE anywhere, it should not be listed
7683 either.  In this case you would start by identifying eligible projects
7684 with a tags/todo match@footnote{@xref{Tag searches}.}
7685 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7686 IGNORE in the subtree to identify projects that are not stuck.  The
7687 correct customization for this is
7689 @lisp
7690 (setq org-stuck-projects
7691       '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7692                                "\\<IGNORE\\>"))
7693 @end lisp
7695 Note that if a project is identified as non-stuck, the subtree of this entry
7696 will still be searched for stuck projects.
7698 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7699 @section Presentation and sorting
7700 @cindex presentation, of agenda items
7702 @vindex org-agenda-prefix-format
7703 @vindex org-agenda-tags-column
7704 Before displaying items in an agenda view, Org mode visually prepares the
7705 items and sorts them.  Each item occupies a single line.  The line starts
7706 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
7707 of the item and other important information.  You can customize in which
7708 column tags will be displayed through @code{org-agenda-tags-column}.  You can
7709 also customize the prefix using the option @code{org-agenda-prefix-format}.
7710 This prefix is followed by a cleaned-up version of the outline headline
7711 associated with the item.
7713 @menu
7714 * Categories::                  Not all tasks are equal
7715 * Time-of-day specifications::  How the agenda knows the time
7716 * Sorting of agenda items::     The order of things
7717 @end menu
7719 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7720 @subsection Categories
7722 @cindex category
7723 @cindex #+CATEGORY
7724 The category is a broad label assigned to each agenda item.  By default,
7725 the category is simply derived from the file name, but you can also
7726 specify it with a special line in the buffer, like this@footnote{For
7727 backward compatibility, the following also works: if there are several
7728 such lines in a file, each specifies the category for the text below it.
7729 The first category also applies to any text before the first CATEGORY
7730 line.  However, using this method is @emph{strongly} deprecated as it is
7731 incompatible with the outline structure of the document.  The correct
7732 method for setting multiple categories in a buffer is using a
7733 property.}:
7735 @example
7736 #+CATEGORY: Thesis
7737 @end example
7739 @noindent
7740 @cindex property, CATEGORY
7741 If you would like to have a special CATEGORY for a single entry or a
7742 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7743 special category you want to apply as the value.
7745 @noindent
7746 The display in the agenda buffer looks best if the category is not
7747 longer than 10 characters.
7749 @noindent
7750 You can set up icons for category by customizing the
7751 @code{org-agenda-category-icon-alist} variable.
7753 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7754 @subsection Time-of-day specifications
7755 @cindex time-of-day specification
7757 Org mode checks each agenda item for a time-of-day specification.  The
7758 time can be part of the timestamp that triggered inclusion into the
7759 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}.  Time
7760 ranges can be specified with two timestamps, like
7762 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7764 In the headline of the entry itself, a time(range) may also appear as
7765 plain text (like @samp{12:45} or a @samp{8:30-1pm}).  If the agenda
7766 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7767 specifications in diary entries are recognized as well.
7769 For agenda display, Org mode extracts the time and displays it in a
7770 standard 24 hour format as part of the prefix.  The example times in
7771 the previous paragraphs would end up in the agenda like this:
7773 @example
7774     8:30-13:00 Arthur Dent lies in front of the bulldozer
7775    12:45...... Ford Prefect arrives and takes Arthur to the pub
7776    19:00...... The Vogon reads his poem
7777    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7778 @end example
7780 @cindex time grid
7781 If the agenda is in single-day mode, or for the display of today, the
7782 timed entries are embedded in a time grid, like
7784 @example
7785     8:00...... ------------------
7786     8:30-13:00 Arthur Dent lies in front of the bulldozer
7787    10:00...... ------------------
7788    12:00...... ------------------
7789    12:45...... Ford Prefect arrives and takes Arthur to the pub
7790    14:00...... ------------------
7791    16:00...... ------------------
7792    18:00...... ------------------
7793    19:00...... The Vogon reads his poem
7794    20:00...... ------------------
7795    20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7796 @end example
7798 @vindex org-agenda-use-time-grid
7799 @vindex org-agenda-time-grid
7800 The time grid can be turned on and off with the variable
7801 @code{org-agenda-use-time-grid}, and can be configured with
7802 @code{org-agenda-time-grid}.
7804 @node Sorting of agenda items,  , Time-of-day specifications, Presentation and sorting
7805 @subsection Sorting of agenda items
7806 @cindex sorting, of agenda items
7807 @cindex priorities, of agenda items
7808 Before being inserted into a view, the items are sorted.  How this is
7809 done depends on the type of view.
7810 @itemize @bullet
7811 @item
7812 @vindex org-agenda-files
7813 For the daily/weekly agenda, the items for each day are sorted.  The
7814 default order is to first collect all items containing an explicit
7815 time-of-day specification.  These entries will be shown at the beginning
7816 of the list, as a @emph{schedule} for the day.  After that, items remain
7817 grouped in categories, in the sequence given by @code{org-agenda-files}.
7818 Within each category, items are sorted by priority (@pxref{Priorities}),
7819 which is composed of the base priority (2000 for priority @samp{A}, 1000
7820 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7821 overdue scheduled or deadline items.
7822 @item
7823 For the TODO list, items remain in the order of categories, but within
7824 each category, sorting takes place according to priority
7825 (@pxref{Priorities}).  The priority used for sorting derives from the
7826 priority cookie, with additions depending on how close an item is to its due
7827 or scheduled date.
7828 @item
7829 For tags matches, items are not sorted at all, but just appear in the
7830 sequence in which they are found in the agenda files.
7831 @end itemize
7833 @vindex org-agenda-sorting-strategy
7834 Sorting can be customized using the variable
7835 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7836 the estimated effort of an entry (@pxref{Effort estimates}).
7838 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7839 @section Commands in the agenda buffer
7840 @cindex commands, in agenda buffer
7842 Entries in the agenda buffer are linked back to the Org file or diary
7843 file where they originate.  You are not allowed to edit the agenda
7844 buffer itself, but commands are provided to show and jump to the
7845 original entry location, and to edit the Org files ``remotely'' from
7846 the agenda buffer.  In this way, all information is stored only once,
7847 removing the risk that your agenda and note files may diverge.
7849 Some commands can be executed with mouse clicks on agenda lines.  For
7850 the other commands, the cursor needs to be in the desired line.
7852 @table @kbd
7853 @tsubheading{Motion}
7854 @cindex motion commands in agenda
7855 @orgcmd{n,org-agenda-next-line}
7856 Next line (same as @key{up} and @kbd{C-p}).
7857 @orgcmd{p,org-agenda-previous-line}
7858 Previous line (same as @key{down} and @kbd{C-n}).
7859 @tsubheading{View/Go to Org file}
7860 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
7861 Display the original location of the item in another window.
7862 With prefix arg, make sure that the entire entry is made visible in the
7863 outline, not only the heading.
7865 @orgcmd{L,org-agenda-recenter}
7866 Display original location and recenter that window.
7868 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
7869 Go to the original location of the item in another window.
7871 @orgcmd{@key{RET},org-agenda-switch-to}
7872 Go to the original location of the item and delete other windows.
7874 @orgcmd{F,org-agenda-follow-mode}
7875 @vindex org-agenda-start-with-follow-mode
7876 Toggle Follow mode.  In Follow mode, as you move the cursor through
7877 the agenda buffer, the other window always shows the corresponding
7878 location in the Org file.  The initial setting for this mode in new
7879 agenda buffers can be set with the variable
7880 @code{org-agenda-start-with-follow-mode}.
7882 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
7883 Display the entire subtree of the current item in an indirect buffer.  With a
7884 numeric prefix argument N, go up to level N and then take that tree.  If N is
7885 negative, go up that many levels.  With a @kbd{C-u} prefix, do not remove the
7886 previously used indirect buffer.
7888 @orgcmd{C-c C-o,org-agenda-open-link}
7889 Follow a link in the entry.  This will offer a selection of any links in the
7890 text belonging to the referenced Org node.  If there is only one link, it
7891 will be followed without a selection prompt.
7893 @tsubheading{Change display}
7894 @cindex display changing, in agenda
7895 @kindex A
7896 @item A
7897 Interactively select another agenda view and append it to the current view.
7899 @kindex o
7900 @item o
7901 Delete other windows.
7903 @orgcmdkskc{v d,d,org-agenda-day-view}
7904 @xorgcmdkskc{v w,w,org-agenda-day-view}
7905 @xorgcmd{v m,org-agenda-month-view}
7906 @xorgcmd{v y,org-agenda-month-year}
7907 @xorgcmd{v SPC,org-agenda-reset-view}
7908 @vindex org-agenda-span
7909 Switch to day/week/month/year view.  When switching to day or week view, this
7910 setting becomes the default for subsequent agenda refreshes.  Since month and
7911 year views are slow to create, they do not become the default.  A numeric
7912 prefix argument may be used to jump directly to a specific day of the year,
7913 ISO week, month, or year, respectively.  For example, @kbd{32 d} jumps to
7914 February 1st, @kbd{9 w} to ISO week number 9.  When setting day, week, or
7915 month view, a year may be encoded in the prefix argument as well.  For
7916 example, @kbd{200712 w} will jump to week 12 in 2007.  If such a year
7917 specification has only one or two digits, it will be mapped to the interval
7918 1938-2037.  @kbd{v @key{SPC}} will reset to what is set in
7919 @code{org-agenda-span}.
7921 @orgcmd{f,org-agenda-later}
7922 Go forward in time to display the following @code{org-agenda-current-span} days.
7923 For example, if the display covers a week, switch to the following week.
7924 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
7926 @orgcmd{b,org-agenda-earlier}
7927 Go backward in time to display earlier dates.
7929 @orgcmd{.,org-agenda-goto-today}
7930 Go to today.
7932 @orgcmd{j,org-agenda-goto-date}
7933 Prompt for a date and go there.
7935 @orgcmd{J,org-agenda-clock-goto}
7936 Go to the currently clocked-in task @i{in the agenda buffer}.
7938 @orgcmd{D,org-agenda-toggle-diary}
7939 Toggle the inclusion of diary entries.  See @ref{Weekly/daily agenda}.
7941 @orgcmdkskc{v l,l,org-agenda-log-mode}
7942 @kindex v L
7943 @vindex org-log-done
7944 @vindex org-agenda-log-mode-items
7945 Toggle Logbook mode.  In Logbook mode, entries that were marked DONE while
7946 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7947 entries that have been clocked on that day.  You can configure the entry
7948 types that should be included in log mode using the variable
7949 @code{org-agenda-log-mode-items}.  When called with a @kbd{C-u} prefix, show
7950 all possible logbook entries, including state changes.  When called with two
7951 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7952 @kbd{v L} is equivalent to @kbd{C-u v l}.
7954 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
7955 Include inactive timestamps into the current view.  Only for weekly/daily
7956 agenda and timeline views.
7958 @orgcmd{v a,org-agenda-archives-mode}
7959 @xorgcmd{v A,org-agenda-archives-mode 'files}
7960 Toggle Archives mode.  In Archives mode, trees that are marked
7961 @code{ARCHIVED} are also scanned when producing the agenda.  When you use the
7962 capital @kbd{A}, even all archive files are included.  To exit archives mode,
7963 press @kbd{v a} again.
7965 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
7966 @vindex org-agenda-start-with-clockreport-mode
7967 @vindex org-clock-report-include-clocking-task
7968 Toggle Clockreport mode.  In Clockreport mode, the daily/weekly agenda will
7969 always show a table with the clocked times for the timespan and file scope
7970 covered by the current agenda view.  The initial setting for this mode in new
7971 agenda buffers can be set with the variable
7972 @code{org-agenda-start-with-clockreport-mode}.  By using a prefix argument
7973 when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
7974 contributions from entries that are hidden by agenda filtering@footnote{Only
7975 tags filtering will be respected here, effort filtering is ignored.}.  See
7976 also the variable @code{org-clock-report-include-clocking-task}.
7978 @orgkey{v c}
7979 @vindex org-agenda-clock-consistency-checks
7980 Show overlapping clock entries, clocking gaps, and other clocking problems in
7981 the current agenda range.  You can then visit clocking lines and fix them
7982 manually.  See the variable @code{org-agenda-clock-consistency-checks} for
7983 information on how to customize the definition of what constituted a clocking
7984 problem.  To return to normal agenda display, press @kbd{l} to exit Logbook
7985 mode.
7987 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
7988 @vindex org-agenda-start-with-entry-text-mode
7989 @vindex org-agenda-entry-text-maxlines
7990 Toggle entry text mode.  In entry text mode, a number of lines from the Org
7991 outline node referenced by an agenda line will be displayed below the line.
7992 The maximum number of lines is given by the variable
7993 @code{org-agenda-entry-text-maxlines}.  Calling this command with a numeric
7994 prefix argument will temporarily modify that number to the prefix value.
7996 @orgcmd{G,org-agenda-toggle-time-grid}
7997 @vindex org-agenda-use-time-grid
7998 @vindex org-agenda-time-grid
7999 Toggle the time grid on and off.  See also the variables
8000 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8002 @orgcmd{r,org-agenda-redo}
8003 Recreate the agenda buffer, for example to reflect the changes after
8004 modification of the timestamps of items with @kbd{S-@key{left}} and
8005 @kbd{S-@key{right}}.  When the buffer is the global TODO list, a prefix
8006 argument is interpreted to create a selective list for a specific TODO
8007 keyword.
8008 @orgcmd{g,org-agenda-redo}
8009 Same as @kbd{r}.
8011 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8012 Save all Org buffers in the current Emacs session, and also the locations of
8013 IDs.
8015 @orgcmd{C-c C-x C-c,org-agenda-columns}
8016 @vindex org-columns-default-format
8017 Invoke column view (@pxref{Column view}) in the agenda buffer.  The column
8018 view format is taken from the entry at point, or (if there is no entry at
8019 point), from the first entry in the agenda view.  So whatever the format for
8020 that entry would be in the original buffer (taken from a property, from a
8021 @code{#+COLUMNS} line, or from the default variable
8022 @code{org-columns-default-format}), will be used in the agenda.
8024 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8025 Remove the restriction lock on the agenda, if it is currently restricted to a
8026 file or subtree (@pxref{Agenda files}).
8028 @tsubheading{Secondary filtering and query editing}
8029 @cindex filtering, by tag category and effort, in agenda
8030 @cindex tag filtering, in agenda
8031 @cindex category filtering, in agenda
8032 @cindex effort filtering, in agenda
8033 @cindex query editing, in agenda
8035 @orgcmd{<,org-agenda-filter-by-category}
8036 @vindex org-agenda-category-filter-preset
8038 Filter the current agenda view with respect to the category of the item at
8039 point.  Pressing @code{<} another time will remove this filter.  You can add
8040 a filter preset through the option @code{org-agenda-category-filter-preset}
8041 (see below.)
8043 @orgcmd{/,org-agenda-filter-by-tag}
8044 @vindex org-agenda-tag-filter-preset
8045 Filter the current agenda view with respect to a tag and/or effort estimates.
8046 The difference between this and a custom agenda command is that filtering is
8047 very fast, so that you can switch quickly between different filters without
8048 having to recreate the agenda.@footnote{Custom commands can preset a filter by
8049 binding the variable @code{org-agenda-tag-filter-preset} as an option.  This
8050 filter will then be applied to the view and persist as a basic filter through
8051 refreshes and more secondary filtering.  The filter is a global property of
8052 the entire agenda view---in a block agenda, you should only set this in the
8053 global options section, not in the section of an individual block.}
8055 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8056 all.  Pressing @key{TAB} at that prompt will offer use completion to select a
8057 tag (including any tags that do not have a selection character).  The command
8058 then hides all entries that do not contain or inherit this tag.  When called
8059 with prefix arg, remove the entries that @emph{do} have the tag.  A second
8060 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8061 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8062 will be narrowed by requiring or forbidding the selected additional tag.
8063 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8064 immediately use the @kbd{\} command.
8066 @vindex org-sort-agenda-noeffort-is-high
8067 In order to filter for effort estimates, you should set up allowed
8068 efforts globally, for example
8069 @lisp
8070 (setq org-global-properties
8071     '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8072 @end lisp
8073 You can then filter for an effort by first typing an operator, one of
8074 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8075 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8076 The filter will then restrict to entries with effort smaller-or-equal, equal,
8077 or larger-or-equal than the selected value.  If the digits 0-9 are not used
8078 as fast access keys to tags, you can also simply press the index digit
8079 directly without an operator.  In this case, @kbd{<} will be assumed.  For
8080 application of the operator, entries without a defined effort will be treated
8081 according to the value of @code{org-sort-agenda-noeffort-is-high}.  To filter
8082 for tasks without effort definition, press @kbd{?} as the operator.
8084 Org also supports automatic, context-aware tag filtering.  If the variable
8085 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8086 that function can decide which tags should be excluded from the agenda
8087 automatically.  Once this is set, the @kbd{/} command then accepts @kbd{RET}
8088 as a sub-option key and runs the auto exclusion logic.  For example, let's
8089 say you use a @code{Net} tag to identify tasks which need network access, an
8090 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8091 calls.  You could auto-exclude these tags based on the availability of the
8092 Internet, and outside of business hours, with something like this:
8094 @lisp
8095 @group
8096 (defun org-my-auto-exclude-function (tag)
8097   (and (cond
8098         ((string= tag "Net")
8099          (/= 0 (call-process "/sbin/ping" nil nil nil
8100                              "-c1" "-q" "-t1" "mail.gnu.org")))
8101         ((or (string= tag "Errand") (string= tag "Call"))
8102          (let ((hour (nth 2 (decode-time))))
8103            (or (< hour 8) (> hour 21)))))
8104        (concat "-" tag)))
8106 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8107 @end group
8108 @end lisp
8110 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8111 Narrow the current agenda filter by an additional condition.  When called with
8112 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8113 the effort criterion.  You can achieve the same effect by pressing @kbd{+} or
8114 @kbd{-} as the first key after the @kbd{/} command.
8117 @kindex [
8118 @kindex ]
8119 @kindex @{
8120 @kindex @}
8121 @item [ ] @{ @}
8122 @table @i
8123 @item @r{in} search view
8124 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8125 (@kbd{@{} and @kbd{@}}) to the query string.  The opening bracket/brace will
8126 add a positive search term prefixed by @samp{+}, indicating that this search
8127 term @i{must} occur/match in the entry.  The closing bracket/brace will add a
8128 negative search term which @i{must not} occur/match in the entry for it to be
8129 selected.
8130 @end table
8132 @tsubheading{Remote editing}
8133 @cindex remote editing, from agenda
8135 @item 0-9
8136 Digit argument.
8138 @cindex undoing remote-editing events
8139 @cindex remote editing, undo
8140 @orgcmd{C-_,org-agenda-undo}
8141 Undo a change due to a remote editing command.  The change is undone
8142 both in the agenda buffer and in the remote buffer.
8144 @orgcmd{t,org-agenda-todo}
8145 Change the TODO state of the item, both in the agenda and in the
8146 original org file.
8148 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8149 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8150 Switch to the next/previous set of TODO keywords.
8152 @orgcmd{C-k,org-agenda-kill}
8153 @vindex org-agenda-confirm-kill
8154 Delete the current agenda item along with the entire subtree belonging
8155 to it in the original Org file.  If the text to be deleted remotely
8156 is longer than one line, the kill needs to be confirmed by the user.  See
8157 variable @code{org-agenda-confirm-kill}.
8159 @orgcmd{C-c C-w,org-agenda-refile}
8160 Refile the entry at point.
8162 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8163 @vindex org-archive-default-command
8164 Archive the subtree corresponding to the entry at point using the default
8165 archiving command set in @code{org-archive-default-command}.  When using the
8166 @code{a} key, confirmation will be required.
8168 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8169 Toggle the ARCHIVE tag for the current headline.
8171 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8172 Move the subtree corresponding to the current entry to its @emph{archive
8173 sibling}.
8175 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8176 Archive the subtree corresponding to the current headline.  This means the
8177 entry will be moved to the configured archive location, most likely a
8178 different file.
8180 @orgcmd{T,org-agenda-show-tags}
8181 @vindex org-agenda-show-inherited-tags
8182 Show all tags associated with the current item.  This is useful if you have
8183 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8184 tags of a headline occasionally.
8186 @orgcmd{:,org-agenda-set-tags}
8187 Set tags for the current headline.  If there is an active region in the
8188 agenda, change a tag for all headings in the region.
8190 @kindex ,
8191 @item ,
8192 Set the priority for the current item (@command{org-agenda-priority}).
8193 Org mode prompts for the priority character.  If you reply with @key{SPC},
8194 the priority cookie is removed from the entry.
8196 @orgcmd{P,org-agenda-show-priority}
8197 Display weighted priority of current item.
8199 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8200 Increase the priority of the current item.  The priority is changed in
8201 the original buffer, but the agenda is not resorted.  Use the @kbd{r}
8202 key for this.
8204 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8205 Decrease the priority of the current item.
8207 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8208 @vindex org-log-into-drawer
8209 Add a note to the entry.  This note will be recorded, and then filed to the
8210 same location where state change notes are put.  Depending on
8211 @code{org-log-into-drawer}, this may be inside a drawer.
8213 @orgcmd{C-c C-a,org-attach}
8214 Dispatcher for all command related to attachments.
8216 @orgcmd{C-c C-s,org-agenda-schedule}
8217 Schedule this item.  With prefix arg remove the scheduling timestamp
8219 @orgcmd{C-c C-d,org-agenda-deadline}
8220 Set a deadline for this item.  With prefix arg remove the deadline.
8222 @orgcmd{k,org-agenda-action}
8223 Agenda actions, to set dates for selected items to the cursor date.
8224 This command also works in the calendar!  The command prompts for an
8225 additional key:
8226 @example
8227 m   @r{Mark the entry at point for action.  You can also make entries}
8228     @r{in Org files with @kbd{C-c C-x C-k}.}
8229 d   @r{Set the deadline of the marked entry to the date at point.}
8230 s   @r{Schedule the marked entry at the date at point.}
8231 r   @r{Call @code{org-capture} with the cursor date as default date.}
8232 @end example
8233 @noindent
8234 Press @kbd{r} afterward to refresh the agenda and see the effect of the
8235 command.
8237 @orgcmd{S-@key{right},org-agenda-do-date-later}
8238 Change the timestamp associated with the current line by one day into the
8239 future.  If the date is in the past, the first call to this command will move
8240 it to today.@*
8241 With a numeric prefix argument, change it by that many days.  For example,
8242 @kbd{3 6 5 S-@key{right}} will change it by a year.  With a @kbd{C-u} prefix,
8243 change the time by one hour.  If you immediately repeat the command, it will
8244 continue to change hours even without the prefix arg.  With a double @kbd{C-u
8245 C-u} prefix, do the same for changing minutes.@*
8246 The stamp is changed in the original Org file, but the change is not directly
8247 reflected in the agenda buffer.  Use @kbd{r} or @kbd{g} to update the buffer.
8249 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8250 Change the timestamp associated with the current line by one day
8251 into the past.
8253 @orgcmd{>,org-agenda-date-prompt}
8254 Change the timestamp associated with the current line.  The key @kbd{>} has
8255 been chosen, because it is the same as @kbd{S-.}  on my keyboard.
8257 @orgcmd{I,org-agenda-clock-in}
8258 Start the clock on the current item.  If a clock is running already, it
8259 is stopped first.
8261 @orgcmd{O,org-agenda-clock-out}
8262 Stop the previously started clock.
8264 @orgcmd{X,org-agenda-clock-cancel}
8265 Cancel the currently running clock.
8267 @orgcmd{J,org-agenda-clock-goto}
8268 Jump to the running clock in another window.
8270 @tsubheading{Bulk remote editing selected entries}
8271 @cindex remote editing, bulk, from agenda
8273 @orgcmd{m,org-agenda-bulk-mark}
8274 Mark the entry at point for bulk action.  With prefix arg, mark that many
8275 successive entries.
8277 @orgcmd{%,org-agenda-bulk-mark-regexp}
8278 Mark entries matching a regular expression for bulk action.
8280 @orgcmd{u,org-agenda-bulk-unmark}
8281 Unmark entry for bulk action.
8283 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8284 Unmark all marked entries for bulk action.
8286 @orgcmd{B,org-agenda-bulk-action}
8287 Bulk action: act on all marked entries in the agenda.  This will prompt for
8288 another key to select the action to be applied.  The prefix arg to @kbd{B}
8289 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8290 these special timestamps.
8291 @example
8292 r  @r{Prompt for a single refile target and move all entries.  The entries}
8293    @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8294 $  @r{Archive all selected entries.}
8295 A  @r{Archive entries by moving them to their respective archive siblings.}
8296 t  @r{Change TODO state.  This prompts for a single TODO keyword and}
8297    @r{changes the state of all selected entries, bypassing blocking and}
8298    @r{suppressing logging notes (but not timestamps).}
8299 +  @r{Add a tag to all selected entries.}
8300 -  @r{Remove a tag from all selected entries.}
8301 s  @r{Schedule all items to a new date.  To shift existing schedule dates}
8302    @r{by a fixed number of days, use something starting with double plus}
8303    @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8304 S  @r{Reschedule randomly into the coming N days.  N will be prompted for.}
8305    @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
8306 d  @r{Set deadline to a specific date.}
8307 f  @r{Apply a function to marked entries.}
8308    @r{For example, the function below sets the CATEGORY property of the}
8309    @r{entries to web.}
8310    @r{(defun set-category ()}
8311    @r{  (interactive "P")}
8312    @r{  (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
8313    @r{                     (org-agenda-error)))}
8314    @r{            (buffer (marker-buffer marker)))}
8315    @r{       (with-current-buffer buffer}
8316    @r{         (save-excursion}
8317    @r{           (save-restriction}
8318    @r{             (widen)}
8319    @r{             (goto-char marker)}
8320    @r{             (org-back-to-heading t)}
8321    @r{             (org-set-property "CATEGORY" "web"))))))}
8322 @end example
8325 @tsubheading{Calendar commands}
8326 @cindex calendar commands, from agenda
8328 @orgcmd{c,org-agenda-goto-calendar}
8329 Open the Emacs calendar and move to the date at the agenda cursor.
8331 @orgcmd{c,org-calendar-goto-agenda}
8332 When in the calendar, compute and show the Org mode agenda for the
8333 date at the cursor.
8335 @cindex diary entries, creating from agenda
8336 @orgcmd{i,org-agenda-diary-entry}
8337 @vindex org-agenda-diary-file
8338 Insert a new entry into the diary, using the date at the cursor and (for
8339 block entries) the date at the mark.  This will add to the Emacs diary
8340 file@footnote{This file is parsed for the agenda when
8341 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8342 command in the calendar.  The diary file will pop up in another window, where
8343 you can add the entry.
8345 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
8346 Org will create entries (in Org mode syntax) in that file instead.  Most
8347 entries will be stored in a date-based outline tree that will later make it
8348 easy to archive appointments from previous months/years.  The tree will be
8349 built under an entry with a @code{DATE_TREE} property, or else with years as
8350 top-level entries.  Emacs will prompt you for the entry text---if you specify
8351 it, the entry will be created in @code{org-agenda-diary-file} without further
8352 interaction.  If you directly press @key{RET} at the prompt without typing
8353 text, the target file will be shown in another window for you to finish the
8354 entry there.  See also the @kbd{k r} command.
8356 @orgcmd{M,org-agenda-phases-of-moon}
8357 Show the phases of the moon for the three months around current date.
8359 @orgcmd{S,org-agenda-sunrise-sunset}
8360 Show sunrise and sunset times.  The geographical location must be set
8361 with calendar variables, see the documentation for the Emacs calendar.
8363 @orgcmd{C,org-agenda-convert-date}
8364 Convert the date at cursor into many other cultural and historic
8365 calendars.
8367 @orgcmd{H,org-agenda-holidays}
8368 Show holidays for three months around the cursor date.
8370 @item M-x org-export-icalendar-combine-agenda-files
8371 Export a single iCalendar file containing entries from all agenda files.
8372 This is a globally available command, and also available in the agenda menu.
8374 @tsubheading{Exporting to a file}
8375 @orgcmd{C-x C-w,org-write-agenda}
8376 @cindex exporting agenda views
8377 @cindex agenda views, exporting
8378 @vindex org-agenda-exporter-settings
8379 Write the agenda view to a file.  Depending on the extension of the selected
8380 file name, the view will be exported as HTML (extension @file{.html} or
8381 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8382 and plain text (any other extension).  When called with a @kbd{C-u} prefix
8383 argument, immediately open the newly created file.  Use the variable
8384 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8385 for @file{htmlize} to be used during export.
8387 @tsubheading{Quit and Exit}
8388 @orgcmd{q,org-agenda-quit}
8389 Quit agenda, remove the agenda buffer.
8391 @cindex agenda files, removing buffers
8392 @orgcmd{x,org-agenda-exit}
8393 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8394 for the compilation of the agenda.  Buffers created by the user to
8395 visit Org files will not be removed.
8396 @end table
8399 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8400 @section Custom agenda views
8401 @cindex custom agenda views
8402 @cindex agenda views, custom
8404 Custom agenda commands serve two purposes: to store and quickly access
8405 frequently used TODO and tags searches, and to create special composite
8406 agenda buffers.  Custom agenda commands will be accessible through the
8407 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8409 @menu
8410 * Storing searches::            Type once, use often
8411 * Block agenda::                All the stuff you need in a single buffer
8412 * Setting Options::             Changing the rules
8413 @end menu
8415 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8416 @subsection Storing searches
8418 The first application of custom searches is the definition of keyboard
8419 shortcuts for frequently used searches, either creating an agenda
8420 buffer, or a sparse tree (the latter covering of course only the current
8421 buffer).
8422 @kindex C-c a C
8423 @vindex org-agenda-custom-commands
8424 Custom commands are configured in the variable
8425 @code{org-agenda-custom-commands}.  You can customize this variable, for
8426 example by pressing @kbd{C-c a C}.  You can also directly set it with
8427 Emacs Lisp in @file{.emacs}.  The following example contains all valid
8428 search types:
8430 @lisp
8431 @group
8432 (setq org-agenda-custom-commands
8433       '(("w" todo "WAITING")
8434         ("W" todo-tree "WAITING")
8435         ("u" tags "+boss-urgent")
8436         ("v" tags-todo "+boss-urgent")
8437         ("U" tags-tree "+boss-urgent")
8438         ("f" occur-tree "\\<FIXME\\>")
8439         ("h" . "HOME+Name tags searches") ; description for "h" prefix
8440         ("hl" tags "+home+Lisa")
8441         ("hp" tags "+home+Peter")
8442         ("hk" tags "+home+Kim")))
8443 @end group
8444 @end lisp
8446 @noindent
8447 The initial string in each entry defines the keys you have to press
8448 after the dispatcher command @kbd{C-c a} in order to access the command.
8449 Usually this will be just a single character, but if you have many
8450 similar commands, you can also define two-letter combinations where the
8451 first character is the same in several combinations and serves as a
8452 prefix key@footnote{You can provide a description for a prefix key by
8453 inserting a cons cell with the prefix and the description.}.  The second
8454 parameter is the search type, followed by the string or regular
8455 expression to be used for the matching.  The example above will
8456 therefore define:
8458 @table @kbd
8459 @item C-c a w
8460 as a global search for TODO entries with @samp{WAITING} as the TODO
8461 keyword
8462 @item C-c a W
8463 as the same search, but only in the current buffer and displaying the
8464 results as a sparse tree
8465 @item C-c a u
8466 as a global tags search for headlines marked @samp{:boss:} but not
8467 @samp{:urgent:}
8468 @item C-c a v
8469 as the same search as @kbd{C-c a u}, but limiting the search to
8470 headlines that are also TODO items
8471 @item C-c a U
8472 as the same search as @kbd{C-c a u}, but only in the current buffer and
8473 displaying the result as a sparse tree
8474 @item C-c a f
8475 to create a sparse tree (again: current buffer only) with all entries
8476 containing the word @samp{FIXME}
8477 @item C-c a h
8478 as a prefix command for a HOME tags search where you have to press an
8479 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8480 Peter, or Kim) as additional tag to match.
8481 @end table
8483 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8484 @subsection Block agenda
8485 @cindex block agenda
8486 @cindex agenda, with block views
8488 Another possibility is the construction of agenda views that comprise
8489 the results of @emph{several} commands, each of which creates a block in
8490 the agenda buffer.  The available commands include @code{agenda} for the
8491 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8492 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8493 matching commands discussed above: @code{todo}, @code{tags}, and
8494 @code{tags-todo}.  Here are two examples:
8496 @lisp
8497 @group
8498 (setq org-agenda-custom-commands
8499       '(("h" "Agenda and Home-related tasks"
8500          ((agenda "")
8501           (tags-todo "home")
8502           (tags "garden")))
8503         ("o" "Agenda and Office-related tasks"
8504          ((agenda "")
8505           (tags-todo "work")
8506           (tags "office")))))
8507 @end group
8508 @end lisp
8510 @noindent
8511 This will define @kbd{C-c a h} to create a multi-block view for stuff
8512 you need to attend to at home.  The resulting agenda buffer will contain
8513 your agenda for the current week, all TODO items that carry the tag
8514 @samp{home}, and also all lines tagged with @samp{garden}.  Finally the
8515 command @kbd{C-c a o} provides a similar view for office tasks.
8517 @node Setting Options,  , Block agenda, Custom agenda views
8518 @subsection Setting options for custom commands
8519 @cindex options, for custom agenda views
8521 @vindex org-agenda-custom-commands
8522 Org mode contains a number of variables regulating agenda construction
8523 and display.  The global variables define the behavior for all agenda
8524 commands, including the custom commands.  However, if you want to change
8525 some settings just for a single custom view, you can do so.  Setting
8526 options requires inserting a list of variable names and values at the
8527 right spot in @code{org-agenda-custom-commands}.  For example:
8529 @lisp
8530 @group
8531 (setq org-agenda-custom-commands
8532       '(("w" todo "WAITING"
8533          ((org-agenda-sorting-strategy '(priority-down))
8534           (org-agenda-prefix-format "  Mixed: ")))
8535         ("U" tags-tree "+boss-urgent"
8536          ((org-show-following-heading nil)
8537           (org-show-hierarchy-above nil)))
8538         ("N" search ""
8539          ((org-agenda-files '("~org/notes.org"))
8540           (org-agenda-text-search-extra-files nil)))))
8541 @end group
8542 @end lisp
8544 @noindent
8545 Now the @kbd{C-c a w} command will sort the collected entries only by
8546 priority, and the prefix format is modified to just say @samp{  Mixed: }
8547 instead of giving the category of the entry.  The sparse tags tree of
8548 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8549 headline hierarchy above the match, nor the headline following the match
8550 will be shown.  The command @kbd{C-c a N} will do a text search limited
8551 to only a single file.
8553 @vindex org-agenda-custom-commands
8554 For command sets creating a block agenda,
8555 @code{org-agenda-custom-commands} has two separate spots for setting
8556 options.  You can add options that should be valid for just a single
8557 command in the set, and options that should be valid for all commands in
8558 the set.  The former are just added to the command entry; the latter
8559 must come after the list of command entries.  Going back to the block
8560 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8561 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8562 the results for GARDEN tags query in the opposite order,
8563 @code{priority-up}.  This would look like this:
8565 @lisp
8566 @group
8567 (setq org-agenda-custom-commands
8568       '(("h" "Agenda and Home-related tasks"
8569          ((agenda)
8570           (tags-todo "home")
8571           (tags "garden"
8572                 ((org-agenda-sorting-strategy '(priority-up)))))
8573          ((org-agenda-sorting-strategy '(priority-down))))
8574         ("o" "Agenda and Office-related tasks"
8575          ((agenda)
8576           (tags-todo "work")
8577           (tags "office")))))
8578 @end group
8579 @end lisp
8581 As you see, the values and parentheses setting is a little complex.
8582 When in doubt, use the customize interface to set this variable---it
8583 fully supports its structure.  Just one caveat: when setting options in
8584 this interface, the @emph{values} are just Lisp expressions.  So if the
8585 value is a string, you need to add the double-quotes around the value
8586 yourself.
8589 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8590 @section Exporting Agenda Views
8591 @cindex agenda views, exporting
8593 If you are away from your computer, it can be very useful to have a printed
8594 version of some agenda views to carry around.  Org mode can export custom
8595 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8596 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8597 ghostscript @file{ps2pdf} utility must be installed on the system.  Selecting
8598 a PDF file will also create the postscript file.}, and iCalendar files.  If
8599 you want to do this only occasionally, use the command
8601 @table @kbd
8602 @orgcmd{C-x C-w,org-write-agenda}
8603 @cindex exporting agenda views
8604 @cindex agenda views, exporting
8605 @vindex org-agenda-exporter-settings
8606 Write the agenda view to a file.  Depending on the extension of the selected
8607 file name, the view will be exported as HTML (extension @file{.html} or
8608 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8609 @file{.ics}), or plain text (any other extension).  Use the variable
8610 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8611 for @file{htmlize} to be used during export, for example
8613 @vindex org-agenda-add-entry-text-maxlines
8614 @vindex htmlize-output-type
8615 @vindex ps-number-of-columns
8616 @vindex ps-landscape-mode
8617 @lisp
8618 (setq org-agenda-exporter-settings
8619       '((ps-number-of-columns 2)
8620         (ps-landscape-mode t)
8621         (org-agenda-add-entry-text-maxlines 5)
8622         (htmlize-output-type 'css)))
8623 @end lisp
8624 @end table
8626 If you need to export certain agenda views frequently, you can associate
8627 any custom agenda command with a list of output file names
8628 @footnote{If you want to store standard views like the weekly agenda
8629 or the global TODO list as well, you need to define custom commands for
8630 them in order to be able to specify file names.}.  Here is an example
8631 that first defines custom commands for the agenda and the global
8632 TODO list, together with a number of files to which to export them.
8633 Then we define two block agenda commands and specify file names for them
8634 as well.  File names can be relative to the current working directory,
8635 or absolute.
8637 @lisp
8638 @group
8639 (setq org-agenda-custom-commands
8640       '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8641         ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8642         ("h" "Agenda and Home-related tasks"
8643          ((agenda "")
8644           (tags-todo "home")
8645           (tags "garden"))
8646          nil
8647          ("~/views/home.html"))
8648         ("o" "Agenda and Office-related tasks"
8649          ((agenda)
8650           (tags-todo "work")
8651           (tags "office"))
8652          nil
8653          ("~/views/office.ps" "~/calendars/office.ics"))))
8654 @end group
8655 @end lisp
8657 The extension of the file name determines the type of export.  If it is
8658 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
8659 the buffer to HTML and save it to this file name.  If the extension is
8660 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8661 Postscript output.  If the extension is @file{.ics}, iCalendar export is
8662 run export over all files that were used to construct the agenda, and
8663 limit the export to entries listed in the agenda.  Any other
8664 extension produces a plain ASCII file.
8666 The export files are @emph{not} created when you use one of those
8667 commands interactively because this might use too much overhead.
8668 Instead, there is a special command to produce @emph{all} specified
8669 files in one step:
8671 @table @kbd
8672 @orgcmd{C-c a e,org-store-agenda-views}
8673 Export all agenda views that have export file names associated with
8674 them.
8675 @end table
8677 You can use the options section of the custom agenda commands to also
8678 set options for the export commands.  For example:
8680 @lisp
8681 (setq org-agenda-custom-commands
8682       '(("X" agenda ""
8683          ((ps-number-of-columns 2)
8684           (ps-landscape-mode t)
8685           (org-agenda-prefix-format " [ ] ")
8686           (org-agenda-with-colors nil)
8687           (org-agenda-remove-tags t))
8688          ("theagenda.ps"))))
8689 @end lisp
8691 @noindent
8692 This command sets two options for the Postscript exporter, to make it
8693 print in two columns in landscape format---the resulting page can be cut
8694 in two and then used in a paper agenda.  The remaining settings modify
8695 the agenda prefix to omit category and scheduling information, and
8696 instead include a checkbox to check off items.  We also remove the tags
8697 to make the lines compact, and we don't want to use colors for the
8698 black-and-white printer.  Settings specified in
8699 @code{org-agenda-exporter-settings} will also apply, but the settings
8700 in @code{org-agenda-custom-commands} take precedence.
8702 @noindent
8703 From the command line you may also use
8704 @example
8705 emacs -eval (org-batch-store-agenda-views) -kill
8706 @end example
8707 @noindent
8708 or, if you need to modify some parameters@footnote{Quoting depends on the
8709 system you use, please check the FAQ for examples.}
8710 @example
8711 emacs -eval '(org-batch-store-agenda-views                      \
8712               org-agenda-span (quote month)                     \
8713               org-agenda-start-day "2007-11-01"                 \
8714               org-agenda-include-diary nil                      \
8715               org-agenda-files (quote ("~/org/project.org")))'  \
8716       -kill
8717 @end example
8718 @noindent
8719 which will create the agenda views restricted to the file
8720 @file{~/org/project.org}, without diary entries and with a 30-day
8721 extent.
8723 You can also extract agenda information in a way that allows further
8724 processing by other programs.  See @ref{Extracting agenda information}, for
8725 more information.
8728 @node Agenda column view,  , Exporting Agenda Views, Agenda Views
8729 @section Using column view in the agenda
8730 @cindex column view, in agenda
8731 @cindex agenda, column view
8733 Column view (@pxref{Column view}) is normally used to view and edit
8734 properties embedded in the hierarchical structure of an Org file.  It can be
8735 quite useful to use column view also from the agenda, where entries are
8736 collected by certain criteria.
8738 @table @kbd
8739 @orgcmd{C-c C-x C-c,org-agenda-columns}
8740 Turn on column view in the agenda.
8741 @end table
8743 To understand how to use this properly, it is important to realize that the
8744 entries in the agenda are no longer in their proper outline environment.
8745 This causes the following issues:
8747 @enumerate
8748 @item
8749 @vindex org-columns-default-format
8750 @vindex org-overriding-columns-format
8751 Org needs to make a decision which @code{COLUMNS} format to use.  Since the
8752 entries in the agenda are collected from different files, and different files
8753 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8754 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
8755 currently set, and if so, takes the format from there.  Otherwise it takes
8756 the format associated with the first item in the agenda, or, if that item
8757 does not have a specific format (defined in a property, or in its file), it
8758 uses @code{org-columns-default-format}.
8759 @item
8760 @cindex property, special, CLOCKSUM
8761 If any of the columns has a summary type defined (@pxref{Column attributes}),
8762 turning on column view in the agenda will visit all relevant agenda files and
8763 make sure that the computations of this property are up to date.  This is
8764 also true for the special @code{CLOCKSUM} property.  Org will then sum the
8765 values displayed in the agenda.  In the daily/weekly agenda, the sums will
8766 cover a single day; in all other views they cover the entire block.  It is
8767 vital to realize that the agenda may show the same entry @emph{twice} (for
8768 example as scheduled and as a deadline), and it may show two entries from the
8769 same hierarchy (for example a @emph{parent} and its @emph{child}).  In these
8770 cases, the summation in the agenda will lead to incorrect results because
8771 some values will count double.
8772 @item
8773 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8774 the entire clocked time for this item.  So even in the daily/weekly agenda,
8775 the clocksum listed in column view may originate from times outside the
8776 current view.  This has the advantage that you can compare these values with
8777 a column listing the planned total effort for a task---one of the major
8778 applications for column view in the agenda.  If you want information about
8779 clocked time in the displayed period use clock table mode (press @kbd{R} in
8780 the agenda).
8781 @end enumerate
8784 @node Markup, Exporting, Agenda Views, Top
8785 @chapter Markup for rich export
8787 When exporting Org mode documents, the exporter tries to reflect the
8788 structure of the document as accurately as possible in the backend.  Since
8789 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
8790 Org mode has rules on how to prepare text for rich export.  This section
8791 summarizes the markup rules used in an Org mode buffer.
8793 @menu
8794 * Structural markup elements::  The basic structure as seen by the exporter
8795 * Images and tables::           Tables and Images will be included
8796 * Literal examples::            Source code examples with special formatting
8797 * Include files::               Include additional files into a document
8798 * Index entries::               Making an index
8799 * Macro replacement::           Use macros to create complex output
8800 * Embedded @LaTeX{}::           LaTeX can be freely used inside Org documents
8801 @end menu
8803 @node Structural markup elements, Images and tables, Markup, Markup
8804 @section Structural markup elements
8806 @menu
8807 * Document title::              Where the title is taken from
8808 * Headings and sections::       The document structure as seen by the exporter
8809 * Table of contents::           The if and where of the table of contents
8810 * Initial text::                Text before the first heading?
8811 * Lists::                       Lists
8812 * Paragraphs::                  Paragraphs
8813 * Footnote markup::             Footnotes
8814 * Emphasis and monospace::      Bold, italic, etc.
8815 * Horizontal rules::            Make a line
8816 * Comment lines::               What will *not* be exported
8817 @end menu
8819 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8820 @subheading Document title
8821 @cindex document title, markup rules
8823 @noindent
8824 The title of the exported document is taken from the special line
8826 @cindex #+TITLE
8827 @example
8828 #+TITLE: This is the title of the document
8829 @end example
8831 @noindent
8832 If this line does not exist, the title is derived from the first non-empty,
8833 non-comment line in the buffer.  If no such line exists, or if you have
8834 turned off exporting of the text before the first headline (see below), the
8835 title will be the file name without extension.
8837 @cindex property, EXPORT_TITLE
8838 If you are exporting only a subtree by marking is as the region, the heading
8839 of the subtree will become the title of the document.  If the subtree has a
8840 property @code{EXPORT_TITLE}, that will take precedence.
8842 @node Headings and sections, Table of contents, Document title, Structural markup elements
8843 @subheading Headings and sections
8844 @cindex headings and sections, markup rules
8846 @vindex org-export-headline-levels
8847 The outline structure of the document as described in @ref{Document
8848 Structure}, forms the basis for defining sections of the exported document.
8849 However, since the outline structure is also used for (for example) lists of
8850 tasks, only the first three outline levels will be used as headings.  Deeper
8851 levels will become itemized lists.  You can change the location of this
8852 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8853 per-file basis with a line
8855 @cindex #+OPTIONS
8856 @example
8857 #+OPTIONS: H:4
8858 @end example
8860 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8861 @subheading Table of contents
8862 @cindex table of contents, markup rules
8864 @vindex org-export-with-toc
8865 The table of contents is normally inserted directly before the first headline
8866 of the file.  If you would like to get it to a different location, insert the
8867 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8868 location.  The depth of the table of contents is by default the same as the
8869 number of headline levels, but you can choose a smaller number, or turn off
8870 the table of contents entirely, by configuring the variable
8871 @code{org-export-with-toc}, or on a per-file basis with a line like
8873 @example
8874 #+OPTIONS: toc:2          (only to two levels in TOC)
8875 #+OPTIONS: toc:nil        (no TOC at all)
8876 @end example
8878 @node Initial text, Lists, Table of contents, Structural markup elements
8879 @subheading Text before the first headline
8880 @cindex text before first headline, markup rules
8881 @cindex #+TEXT
8883 Org mode normally exports the text before the first headline, and even uses
8884 the first line as the document title.  The text will be fully marked up.  If
8885 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
8886 constructs described below in the sections for the individual exporters.
8888 @vindex org-export-skip-text-before-1st-heading
8889 Some people like to use the space before the first headline for setup and
8890 internal links and therefore would like to control the exported text before
8891 the first headline in a different way.  You can do so by setting the variable
8892 @code{org-export-skip-text-before-1st-heading} to @code{t}.  On a per-file
8893 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8895 @noindent
8896 If you still want to have some text before the first headline, use the
8897 @code{#+TEXT} construct:
8899 @example
8900 #+OPTIONS: skip:t
8901 #+TEXT: This text will go before the *first* headline.
8902 #+TEXT: [TABLE-OF-CONTENTS]
8903 #+TEXT: This goes between the table of contents and the *first* headline
8904 @end example
8906 @node Lists, Paragraphs, Initial text, Structural markup elements
8907 @subheading Lists
8908 @cindex lists, markup rules
8910 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8911 syntax for such lists.  Most backends support unordered, ordered, and
8912 description lists.
8914 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8915 @subheading Paragraphs, line breaks, and quoting
8916 @cindex paragraphs, markup rules
8918 Paragraphs are separated by at least one empty line.  If you need to enforce
8919 a line break within a paragraph, use @samp{\\} at the end of a line.
8921 To keep the line breaks in a region, but otherwise use normal formatting, you
8922 can use this construct, which can also be used to format poetry.
8924 @cindex #+BEGIN_VERSE
8925 @example
8926 #+BEGIN_VERSE
8927  Great clouds overhead
8928  Tiny black birds rise and fall
8929  Snow covers Emacs
8931      -- AlexSchroeder
8932 #+END_VERSE
8933 @end example
8935 When quoting a passage from another document, it is customary to format this
8936 as a paragraph that is indented on both the left and the right margin.  You
8937 can include quotations in Org mode documents like this:
8939 @cindex #+BEGIN_QUOTE
8940 @example
8941 #+BEGIN_QUOTE
8942 Everything should be made as simple as possible,
8943 but not any simpler -- Albert Einstein
8944 #+END_QUOTE
8945 @end example
8947 If you would like to center some text, do it like this:
8948 @cindex #+BEGIN_CENTER
8949 @example
8950 #+BEGIN_CENTER
8951 Everything should be made as simple as possible, \\
8952 but not any simpler
8953 #+END_CENTER
8954 @end example
8957 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8958 @subheading Footnote markup
8959 @cindex footnotes, markup rules
8960 @cindex @file{footnote.el}
8962 Footnotes defined in the way described in @ref{Footnotes}, will be exported
8963 by all backends.  Org allows multiple references to the same note, and
8964 multiple footnotes side by side.
8966 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8967 @subheading Emphasis and monospace
8969 @cindex underlined text, markup rules
8970 @cindex bold text, markup rules
8971 @cindex italic text, markup rules
8972 @cindex verbatim text, markup rules
8973 @cindex code text, markup rules
8974 @cindex strike-through text, markup rules
8975 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8976 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}.  Text
8977 in the code and verbatim string is not processed for Org mode specific
8978 syntax; it is exported verbatim.
8980 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8981 @subheading  Horizontal rules
8982 @cindex horizontal rules, markup rules
8983 A line consisting of only dashes, and at least 5 of them, will be exported as
8984 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
8986 @node Comment lines,  , Horizontal rules, Structural markup elements
8987 @subheading Comment lines
8988 @cindex comment lines
8989 @cindex exporting, not
8990 @cindex #+BEGIN_COMMENT
8992 Lines starting with @samp{#} in column zero are treated as comments and will
8993 never be exported.  If you want an indented line to be treated as a comment,
8994 start it with @samp{#+ }.  Also entire subtrees starting with the word
8995 @samp{COMMENT} will never be exported.  Finally, regions surrounded by
8996 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8998 @table @kbd
8999 @kindex C-c ;
9000 @item C-c ;
9001 Toggle the COMMENT keyword at the beginning of an entry.
9002 @end table
9005 @node Images and tables, Literal examples, Structural markup elements, Markup
9006 @section Images and Tables
9008 @cindex tables, markup rules
9009 @cindex #+CAPTION
9010 @cindex #+LABEL
9011 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9012 the @file{table.el} package will be exported properly.  For Org mode tables,
9013 the lines before the first horizontal separator line will become table header
9014 lines.  You can use the following lines somewhere before the table to assign
9015 a caption and a label for cross references, and in the text you can refer to
9016 the object with @code{\ref@{tab:basic-data@}}:
9018 @example
9019 #+CAPTION: This is the caption for the next table (or link)
9020 #+LABEL:   tbl:basic-data
9021    | ... | ...|
9022    |-----|----|
9023 @end example
9025 Optionally, the caption can take the form:
9026 @example
9027 #+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
9028 @end example
9030 @cindex inlined images, markup rules
9031 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
9032 images into the exported document.  Org does this, if a link to an image
9033 files does not have a description part, for example @code{[[./img/a.jpg]]}.
9034 If you wish to define a caption for the image and maybe a label for internal
9035 cross references, make sure that the link is on a line by itself and precede
9036 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
9038 @example
9039 #+CAPTION: This is the caption for the next figure link (or table)
9040 #+LABEL:   fig:SED-HR4049
9041 [[./img/a.jpg]]
9042 @end example
9044 You may also define additional attributes for the figure.  As this is
9045 backend-specific, see the sections about the individual backends for more
9046 information.
9048 @xref{Handling links,the discussion of image links}.
9050 @node Literal examples, Include files, Images and tables, Markup
9051 @section Literal examples
9052 @cindex literal examples, markup rules
9053 @cindex code line references, markup rules
9055 You can include literal examples that should not be subjected to
9056 markup.  Such examples will be typeset in monospace, so this is well suited
9057 for source code and similar examples.
9058 @cindex #+BEGIN_EXAMPLE
9060 @example
9061 #+BEGIN_EXAMPLE
9062 Some example from a text file.
9063 #+END_EXAMPLE
9064 @end example
9066 Note that such blocks may be @i{indented} in order to align nicely with
9067 indented text and in particular with plain list structure (@pxref{Plain
9068 lists}).  For simplicity when using small examples, you can also start the
9069 example lines with a colon followed by a space.  There may also be additional
9070 whitespace before the colon:
9072 @example
9073 Here is an example
9074    : Some example from a text file.
9075 @end example
9077 @cindex formatting source code, markup rules
9078 If the example is source code from a programming language, or any other text
9079 that can be marked up by font-lock in Emacs, you can ask for the example to
9080 look like the fontified Emacs buffer@footnote{This works automatically for
9081 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
9082 which is distributed with Org).  Fontified code chunks in @LaTeX{} can be
9083 achieved using either the listings or the
9084 @url{http://code.google.com/p/minted, minted,} package.  To use listings, turn
9085 on the variable @code{org-export-latex-listings} and ensure that the listings
9086 package is included by the @LaTeX{} header (e.g.@: by configuring
9087 @code{org-export-latex-packages-alist}).  See the listings documentation for
9088 configuration options, including obtaining colored output.  For minted it is
9089 necessary to install the program @url{http://pygments.org, pygments}, in
9090 addition to setting @code{org-export-latex-minted}, ensuring that the minted
9091 package is included by the @LaTeX{} header, and ensuring that the
9092 @code{-shell-escape} option is passed to @file{pdflatex} (see
9093 @code{org-latex-to-pdf-process}).  See the documentation of the variables
9094 @code{org-export-latex-listings} and @code{org-export-latex-minted} for
9095 further details.}.  This is done with the @samp{src} block, where you also
9096 need to specify the name of the major mode that should be used to fontify the
9097 example@footnote{Code in @samp{src} blocks may also be evaluated either
9098 interactively or on export.  See @pxref{Working With Source Code} for more
9099 information on evaluating code blocks.}, see @ref{Easy Templates} for
9100 shortcuts to easily insert code blocks.
9101 @cindex #+BEGIN_SRC
9103 @example
9104 #+BEGIN_SRC emacs-lisp
9105   (defun org-xor (a b)
9106      "Exclusive or."
9107      (if a (not b) b))
9108 #+END_SRC
9109 @end example
9111 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9112 switch to the end of the @code{BEGIN} line, to get the lines of the example
9113 numbered.  If you use a @code{+n} switch, the numbering from the previous
9114 numbered snippet will be continued in the current one.  In literal examples,
9115 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9116 targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
9117 enclosed in single parenthesis).  In HTML, hovering the mouse over such a
9118 link will remote-highlight the corresponding code line, which is kind of
9119 cool.
9121 You can also add a @code{-r} switch which @i{removes} the labels from the
9122 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9123 labels in the source code while using line numbers for the links, which might
9124 be useful to explain those in an Org mode example code.}.  With the @code{-n}
9125 switch, links to these references will be labeled by the line numbers from
9126 the code listing, otherwise links will use the labels with no parentheses.
9127 Here is an example:
9129 @example
9130 #+BEGIN_SRC emacs-lisp -n -r
9131 (save-excursion                  (ref:sc)
9132    (goto-char (point-min))       (ref:jump)
9133 #+END_SRC
9134 In line [[(sc)]] we remember the current position.  [[(jump)][Line (jump)]]
9135 jumps to point-min.
9136 @end example
9138 @vindex org-coderef-label-format
9139 If the syntax for the label format conflicts with the language syntax, use a
9140 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9141 -n -r -l "((%s))"}.  See also the variable @code{org-coderef-label-format}.
9143 HTML export also allows examples to be published as text areas (@pxref{Text
9144 areas in HTML export}).
9146 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9147 so often, shortcuts are provided using the Easy Templates facility
9148 (@pxref{Easy Templates}).
9150 @table @kbd
9151 @kindex C-c '
9152 @item C-c '
9153 Edit the source code example at point in its native mode.  This works by
9154 switching to a temporary buffer with the source code.  You need to exit by
9155 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
9156 or @samp{#} will get a comma prepended, to keep them from being interpreted
9157 by Org as outline nodes or special comments.  These commas will be stripped
9158 for editing with @kbd{C-c '}, and also for export.}.  The edited version will
9159 then replace the old version in the Org buffer.  Fixed-width regions
9160 (where each line starts with a colon followed by a space) will be edited
9161 using @code{artist-mode}@footnote{You may select a different-mode with the
9162 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
9163 drawings easily.  Using this command in an empty line will create a new
9164 fixed-width region.
9165 @kindex C-c l
9166 @item C-c l
9167 Calling @code{org-store-link} while editing a source code example in a
9168 temporary buffer created with @kbd{C-c '} will prompt for a label.  Make sure
9169 that it is unique in the current buffer, and insert it with the proper
9170 formatting like @samp{(ref:label)} at the end of the current line.  Then the
9171 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9172 @end table
9175 @node Include files, Index entries, Literal examples, Markup
9176 @section Include files
9177 @cindex include files, markup rules
9179 During export, you can include the content of another file.  For example, to
9180 include your @file{.emacs} file, you could use:
9181 @cindex #+INCLUDE
9183 @example
9184 #+INCLUDE: "~/.emacs" src emacs-lisp
9185 @end example
9186 @noindent
9187 The optional second and third parameter are the markup (e.g.@: @samp{quote},
9188 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9189 language for formatting the contents.  The markup is optional; if it is not
9190 given, the text will be assumed to be in Org mode format and will be
9191 processed normally.  The include line will also allow additional keyword
9192 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
9193 first line and for each following line, @code{:minlevel} in order to get
9194 Org mode content demoted to a specified level, as well as any options
9195 accepted by the selected markup.  For example, to include a file as an item,
9198 @example
9199 #+INCLUDE: "~/snippets/xx" :prefix1 "   + " :prefix "     "
9200 @end example
9202 You can also include a portion of a file by specifying a lines range using
9203 the @code{:lines} parameter.  The line at the upper end of the range will not
9204 be included.  The start and/or the end of the range may be omitted to use the
9205 obvious defaults.
9207 @example
9208 #+INCLUDE: "~/.emacs" :lines "5-10"   @r{Include lines 5 to 10, 10 excluded}
9209 #+INCLUDE: "~/.emacs" :lines "-10"    @r{Include lines 1 to 10, 10 excluded}
9210 #+INCLUDE: "~/.emacs" :lines "10-"    @r{Include lines from 10 to EOF}
9211 @end example
9213 @table @kbd
9214 @kindex C-c '
9215 @item C-c '
9216 Visit the include file at point.
9217 @end table
9219 @node Index entries, Macro replacement, Include files, Markup
9220 @section Index entries
9221 @cindex index entries, for publishing
9223 You can specify entries that will be used for generating an index during
9224 publishing.  This is done by lines starting with @code{#+INDEX}.  An entry
9225 the contains an exclamation mark will create a sub item.  See @ref{Generating
9226 an index} for more information.
9228 @example
9229 * Curriculum Vitae
9230 #+INDEX: CV
9231 #+INDEX: Application!CV
9232 @end example
9237 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
9238 @section Macro replacement
9239 @cindex macro replacement, during export
9240 @cindex #+MACRO
9242 You can define text snippets with
9244 @example
9245 #+MACRO: name   replacement text $1, $2 are arguments
9246 @end example
9248 @noindent which can be referenced anywhere in the document (even in
9249 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}.  In addition to
9250 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
9251 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
9252 similar lines.  Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9253 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9254 and to the modification time of the file being exported, respectively.
9255 @var{FORMAT} should be a format string understood by
9256 @code{format-time-string}.
9258 Macro expansion takes place during export, and some people use it to
9259 construct complex HTML code.
9262 @node Embedded @LaTeX{},  , Macro replacement, Markup
9263 @section Embedded @LaTeX{}
9264 @cindex @TeX{} interpretation
9265 @cindex @LaTeX{} interpretation
9267 Plain ASCII is normally sufficient for almost all note taking.  Exceptions
9268 include scientific notes, which often require mathematical symbols and the
9269 occasional formula.  @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9270 Donald E. Knuth's @TeX{} system.  Many of the features described here as
9271 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9272 distinction.}  is widely used to typeset scientific documents.  Org mode
9273 supports embedding @LaTeX{} code into its files, because many academics are
9274 used to writing and reading @LaTeX{} source code, and because it can be
9275 readily processed to produce pretty output for a number of export backends.
9277 @menu
9278 * Special symbols::             Greek letters and other symbols
9279 * Subscripts and superscripts::  Simple syntax for raising/lowering text
9280 * @LaTeX{} fragments::             Complex formulas made easy
9281 * Previewing @LaTeX{} fragments::  What will this snippet look like?
9282 * CDLaTeX mode::                Speed up entering of formulas
9283 @end menu
9285 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
9286 @subsection Special symbols
9287 @cindex math symbols
9288 @cindex special symbols
9289 @cindex @TeX{} macros
9290 @cindex @LaTeX{} fragments, markup rules
9291 @cindex HTML entities
9292 @cindex @LaTeX{} entities
9294 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
9295 indicate the Greek letter, or @samp{\to} to indicate an arrow.  Completion
9296 for these macros is available, just type @samp{\} and maybe a few letters,
9297 and press @kbd{M-@key{TAB}} to see possible completions.  Unlike @LaTeX{}
9298 code, Org mode allows these macros to be present without surrounding math
9299 delimiters, for example:
9301 @example
9302 Angles are written as Greek letters \alpha, \beta and \gamma.
9303 @end example
9305 @vindex org-entities
9306 During export, these symbols will be transformed into the native format of
9307 the exporter backend.  Strings like @code{\alpha} will be exported as
9308 @code{&alpha;} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9309 output.  Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
9310 @code{~} in @LaTeX{}.  If you need such a symbol inside a word, terminate it
9311 like this: @samp{\Aacute@{@}stor}.
9313 A large number of entities is provided, with names taken from both HTML and
9314 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9315 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9316 @samp{...} are all converted into special commands creating hyphens of
9317 different lengths or a compact set of dots.
9319 If you would like to see entities displayed as UTF8 characters, use the
9320 following command@footnote{You can turn this on by default by setting the
9321 variable @code{org-pretty-entities}, or on a per-file base with the
9322 @code{#+STARTUP} option @code{entitiespretty}.}:
9324 @table @kbd
9325 @kindex C-c C-x \
9326 @item C-c C-x \
9327 Toggle display of entities as UTF-8 characters.  This does not change the
9328 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9329 for display purposes only.
9330 @end table
9332 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
9333 @subsection Subscripts and superscripts
9334 @cindex subscript
9335 @cindex superscript
9337 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9338 and subscripts.  Again, these can be used without embedding them in
9339 math-mode delimiters.  To increase the readability of ASCII text, it is
9340 not necessary (but OK) to surround multi-character sub- and superscripts
9341 with curly braces.  For example
9343 @example
9344 The mass of the sun is M_sun = 1.989 x 10^30 kg.  The radius of
9345 the sun is R_@{sun@} = 6.96 x 10^8 m.
9346 @end example
9348 @vindex org-export-with-sub-superscripts
9349 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9350 @samp{_} with a backslash: @samp{\^} and @samp{\_}.  If you write a text
9351 where the underscore is often used in a different context, Org's convention
9352 to always interpret these as subscripts can get in your way.  Configure the
9353 variable @code{org-export-with-sub-superscripts} to globally change this
9354 convention, or use, on a per-file basis:
9356 @example
9357 #+OPTIONS: ^:@{@}
9358 @end example
9360 @noindent With this setting, @samp{a_b} will not be interpreted as a
9361 subscript, but @samp{a_@{b@}} will.
9363 @table @kbd
9364 @kindex C-c C-x \
9365 @item C-c C-x \
9366 In addition to showing entities as UTF-8 characters, this command will also
9367 format sub- and superscripts in a WYSIWYM way.
9368 @end table
9370 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
9371 @subsection @LaTeX{} fragments
9372 @cindex @LaTeX{} fragments
9374 @vindex org-format-latex-header
9375 Going beyond symbols and sub- and superscripts, a full formula language is
9376 needed.  Org mode can contain @LaTeX{} math fragments, and it supports ways
9377 to process these for several export backends.  When exporting to @LaTeX{},
9378 the code is obviously left as it is.  When exporting to HTML, Org invokes the
9379 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9380 HTML export}) to process and display the math@footnote{If you plan to use
9381 this regularly or on pages with significant page views, you should install
9382 @file{MathJax} on your own
9383 server in order to limit the load of our server.}.  Finally, it can also
9384 process the mathematical expressions into images@footnote{For this to work
9385 you need to be on a system with a working @LaTeX{} installation.  You also
9386 need the @file{dvipng} program, available at
9387 @url{http://sourceforge.net/projects/dvipng/}.  The @LaTeX{} header that will
9388 be used when processing a fragment can be configured with the variable
9389 @code{org-format-latex-header}.}  that can be displayed in a browser or in
9390 DocBook documents.
9392 @LaTeX{} fragments don't need any special marking at all.  The following
9393 snippets will be identified as @LaTeX{} source code:
9394 @itemize @bullet
9395 @item
9396 Environments of any kind@footnote{When @file{MathJax} is used, only the
9397 environment recognized by @file{MathJax} will be processed.  When
9398 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9399 handled.}.  The only requirement is that the @code{\begin} statement appears
9400 on a new line, preceded by only whitespace.
9401 @item
9402 Text within the usual @LaTeX{} math delimiters.  To avoid conflicts with
9403 currency specifications, single @samp{$} characters are only recognized as
9404 math delimiters if the enclosed text contains at most two line breaks, is
9405 directly attached to the @samp{$} characters with no whitespace in between,
9406 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9407 For the other delimiters, there is no such restriction, so when in doubt, use
9408 @samp{\(...\)} as inline math delimiters.
9409 @end itemize
9411 @noindent For example:
9413 @example
9414 \begin@{equation@}                          % arbitrary environments,
9415 x=\sqrt@{b@}                                % even tables, figures
9416 \end@{equation@}                            % etc
9418 If $a^2=b$ and \( b=2 \), then the solution must be
9419 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9420 @end example
9422 @noindent
9423 @vindex org-format-latex-options
9424 If you need any of the delimiter ASCII sequences for other purposes, you
9425 can configure the option @code{org-format-latex-options} to deselect the
9426 ones you do not wish to have interpreted by the @LaTeX{} converter.
9428 @vindex org-export-with-LaTeX-fragments
9429 @LaTeX{} processing can be configured with the variable
9430 @code{org-export-with-LaTeX-fragments}.  The default setting is @code{t}
9431 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9432 @LaTeX{} backends.  You can also set this variable on a per-file basis using one
9433 of these lines:
9435 @example
9436 #+OPTIONS: LaTeX:t          @r{Do the right thing automatically (MathJax)}
9437 #+OPTIONS: LaTeX:dvipng     @r{Force using dvipng images}
9438 #+OPTIONS: LaTeX:nil        @r{Do not process @LaTeX{} fragments at all}
9439 #+OPTIONS: LaTeX:verbatim   @r{Verbatim export, for jsMath or so}
9440 @end example
9442 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
9443 @subsection Previewing @LaTeX{} fragments
9444 @cindex @LaTeX{} fragments, preview
9446 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9447 produce preview images of the typeset expressions:
9449 @table @kbd
9450 @kindex C-c C-x C-l
9451 @item C-c C-x C-l
9452 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9453 over the source code.  If there is no fragment at point, process all
9454 fragments in the current entry (between two headlines).  When called
9455 with a prefix argument, process the entire subtree.  When called with
9456 two prefix arguments, or when the cursor is before the first headline,
9457 process the entire buffer.
9458 @kindex C-c C-c
9459 @item C-c C-c
9460 Remove the overlay preview images.
9461 @end table
9463 @vindex org-format-latex-options
9464 You can customize the variable @code{org-format-latex-options} to influence
9465 some aspects of the preview.  In particular, the @code{:scale} (and for HTML
9466 export, @code{:html-scale}) property can be used to adjust the size of the
9467 preview images.
9469 @node CDLaTeX mode,  , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
9470 @subsection Using CD@LaTeX{} to enter math
9471 @cindex CD@LaTeX{}
9473 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
9474 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9475 environments and math templates.  Inside Org mode, you can make use of
9476 some of the features of CD@LaTeX{} mode.  You need to install
9477 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9478 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9479 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
9480 version @code{org-cdlatex-mode} that comes as part of Org mode.  Turn it
9481 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9482 Org files with
9484 @lisp
9485 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9486 @end lisp
9488 When this mode is enabled, the following features are present (for more
9489 details see the documentation of CD@LaTeX{} mode):
9490 @itemize @bullet
9491 @kindex C-c @{
9492 @item
9493 Environment templates can be inserted with @kbd{C-c @{}.
9494 @item
9495 @kindex @key{TAB}
9496 The @key{TAB} key will do template expansion if the cursor is inside a
9497 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
9498 inside such a fragment, see the documentation of the function
9499 @code{org-inside-LaTeX-fragment-p}.}.  For example, @key{TAB} will
9500 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9501 correctly inside the first brace.  Another @key{TAB} will get you into
9502 the second brace.  Even outside fragments, @key{TAB} will expand
9503 environment abbreviations at the beginning of a line.  For example, if
9504 you write @samp{equ} at the beginning of a line and press @key{TAB},
9505 this abbreviation will be expanded to an @code{equation} environment.
9506 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9507 @item
9508 @kindex _
9509 @kindex ^
9510 @vindex cdlatex-simplify-sub-super-scripts
9511 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9512 characters together with a pair of braces.  If you use @key{TAB} to move
9513 out of the braces, and if the braces surround only a single character or
9514 macro, they are removed again (depending on the variable
9515 @code{cdlatex-simplify-sub-super-scripts}).
9516 @item
9517 @kindex `
9518 Pressing the backquote @kbd{`} followed by a character inserts math
9519 macros, also outside @LaTeX{} fragments.  If you wait more than 1.5 seconds
9520 after the backquote, a help window will pop up.
9521 @item
9522 @kindex '
9523 Pressing the single-quote @kbd{'} followed by another character modifies
9524 the symbol before point with an accent or a font.  If you wait more than
9525 1.5 seconds after the single-quote, a help window will pop up.  Character
9526 modification will work only inside @LaTeX{} fragments; outside the quote
9527 is normal.
9528 @end itemize
9530 @node Exporting, Publishing, Markup, Top
9531 @chapter Exporting
9532 @cindex exporting
9534 Org mode documents can be exported into a variety of other formats.  For
9535 printing and sharing of notes, ASCII export produces a readable and simple
9536 version of an Org file.  HTML export allows you to publish a notes file on
9537 the web, while the XOXO format provides a solid base for exchange with a
9538 broad range of other applications.  @LaTeX{} export lets you use Org mode and
9539 its structured editing functions to easily create @LaTeX{} files.  DocBook
9540 export makes it possible to convert Org files to many other formats using
9541 DocBook tools.  OpenDocument Text(ODT) export allows seamless
9542 collaboration across organizational boundaries.  For project management you
9543 can create gantt and resource charts by using TaskJuggler export.  To
9544 incorporate entries with associated times like deadlines or appointments into
9545 a desktop calendar program like iCal, Org mode can also produce extracts in
9546 the iCalendar format.  Currently Org mode only supports export, not import of
9547 these different formats.
9549 Org supports export of selected regions when @code{transient-mark-mode} is
9550 enabled (default in Emacs 23).
9552 @menu
9553 * Selective export::            Using tags to select and exclude trees
9554 * Export options::              Per-file export settings
9555 * The export dispatcher::       How to access exporter commands
9556 * ASCII/Latin-1/UTF-8 export::  Exporting to flat files with encoding
9557 * HTML export::                 Exporting to HTML
9558 * @LaTeX{} and PDF export::     Exporting to @LaTeX{}, and processing to PDF
9559 * DocBook export::              Exporting to DocBook
9560 * OpenDocument Text export::    Exporting to OpenDocument Text
9561 * TaskJuggler export::          Exporting to TaskJuggler
9562 * Freemind export::             Exporting to Freemind mind maps
9563 * XOXO export::                 Exporting to XOXO
9564 * iCalendar export::            Exporting in iCalendar format
9565 @end menu
9567 @node Selective export, Export options, Exporting, Exporting
9568 @section Selective export
9569 @cindex export, selective by tags or TODO keyword
9571 @vindex org-export-select-tags
9572 @vindex org-export-exclude-tags
9573 @cindex org-export-with-tasks
9574 You may use tags to select the parts of a document that should be exported,
9575 or to exclude parts from export.  This behavior is governed by two variables:
9576 @code{org-export-select-tags} and @code{org-export-exclude-tags},
9577 respectively defaulting to @code{'(:export:)} and @code{'(:noexport:)}.
9579 @enumerate
9580 @item
9581 Org first checks if any of the @emph{select} tags is present in the
9582 buffer.  If yes, all trees that do not carry one of these tags will be
9583 excluded.  If a selected tree is a subtree, the heading hierarchy above it
9584 will also be selected for export, but not the text below those headings.
9586 @item
9587 If none of the select tags is found, the whole buffer will be selected for
9588 export.
9590 @item
9591 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9592 be removed from the export buffer.
9593 @end enumerate
9595 The variable @code{org-export-with-tasks} can be configured to select which
9596 kind of tasks should be included for export.  See the docstring of the
9597 variable for more information.
9599 @node Export options, The export dispatcher, Selective export, Exporting
9600 @section Export options
9601 @cindex options, for export
9603 @cindex completion, of option keywords
9604 The exporter recognizes special lines in the buffer which provide
9605 additional information.  These lines may be put anywhere in the file.
9606 The whole set of lines can be inserted into the buffer with @kbd{C-c
9607 C-e t}.  For individual lines, a good way to make sure the keyword is
9608 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9609 (@pxref{Completion}).   For a summary of other in-buffer settings not
9610 specifically related to export, see @ref{In-buffer settings}.
9611 In particular, note that you can place commonly-used (export) options in
9612 a separate file which can be included using @code{#+SETUPFILE}.
9614 @table @kbd
9615 @orgcmd{C-c C-e t,org-insert-export-options-template}
9616 Insert template with export options, see example below.
9617 @end table
9619 @cindex #+TITLE
9620 @cindex #+AUTHOR
9621 @cindex #+DATE
9622 @cindex #+EMAIL
9623 @cindex #+DESCRIPTION
9624 @cindex #+KEYWORDS
9625 @cindex #+LANGUAGE
9626 @cindex #+TEXT
9627 @cindex #+OPTIONS
9628 @cindex #+BIND
9629 @cindex #+LINK_UP
9630 @cindex #+LINK_HOME
9631 @cindex #+EXPORT_SELECT_TAGS
9632 @cindex #+EXPORT_EXCLUDE_TAGS
9633 @cindex #+XSLT
9634 @cindex #+LATEX_HEADER
9635 @vindex user-full-name
9636 @vindex user-mail-address
9637 @vindex org-export-default-language
9638 @vindex org-export-date-timestamp-format
9639 @example
9640 #+TITLE:       the title to be shown (default is the buffer name)
9641 #+AUTHOR:      the author (default taken from @code{user-full-name})
9642 #+DATE:        a date, an Org timestamp@footnote{@code{org-export-date-timestamp-format} defines how this timestamp will be exported.}, or a format string for @code{format-time-string}
9643 #+EMAIL:       his/her email address (default from @code{user-mail-address})
9644 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
9645 #+KEYWORDS:    the page keywords, e.g.@: for the XHTML meta tag
9646 #+LANGUAGE:    language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
9647 #+TEXT:        Some descriptive text to be inserted at the beginning.
9648 #+TEXT:        Several lines may be given.
9649 #+OPTIONS:     H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9650 #+BIND:        lisp-var lisp-val, e.g.@:: @code{org-export-latex-low-levels itemize}
9651                @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9652 #+LINK_UP:     the ``up'' link of an exported page
9653 #+LINK_HOME:   the ``home'' link of an exported page
9654 #+LATEX_HEADER: extra line(s) for the @LaTeX{} header, like \usepackage@{xyz@}
9655 #+EXPORT_SELECT_TAGS:   Tags that select a tree for export
9656 #+EXPORT_EXCLUDE_TAGS:  Tags that exclude a tree from export
9657 #+XSLT:        the XSLT stylesheet used by DocBook exporter to generate FO file
9658 @end example
9660 @noindent
9661 The @code{#+OPTIONS} line is a compact@footnote{If you want to configure many options
9662 this way, you can use several @code{#+OPTIONS} lines.} form to specify export
9663 settings.  Here you can:
9664 @cindex headline levels
9665 @cindex section-numbers
9666 @cindex table of contents
9667 @cindex line-break preservation
9668 @cindex quoted HTML tags
9669 @cindex fixed-width sections
9670 @cindex tables
9671 @cindex @TeX{}-like syntax for sub- and superscripts
9672 @cindex footnotes
9673 @cindex special strings
9674 @cindex emphasized text
9675 @cindex @TeX{} macros
9676 @cindex @LaTeX{} fragments
9677 @cindex author info, in export
9678 @cindex time info, in export
9679 @vindex org-export-plist-vars
9680 @vindex org-export-author-info
9681 @vindex org-export-creator-info
9682 @vindex org-export-email-info
9683 @vindex org-export-time-stamp-file
9684 @example
9685 H:         @r{set the number of headline levels for export}
9686 num:       @r{turn on/off section-numbers}
9687 toc:       @r{turn on/off table of contents, or set level limit (integer)}
9688 \n:        @r{turn on/off line-break-preservation (DOES NOT WORK)}
9689 @@:         @r{turn on/off quoted HTML tags}
9690 ::         @r{turn on/off fixed-width sections}
9691 |:         @r{turn on/off tables}
9692 ^:         @r{turn on/off @TeX{}-like syntax for sub- and superscripts.  If}
9693            @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9694            @r{the simple @code{a_b} will be left as it is.}
9695 -:         @r{turn on/off conversion of special strings.}
9696 f:         @r{turn on/off footnotes like this[1].}
9697 todo:      @r{turn on/off inclusion of TODO keywords into exported text}
9698 tasks:     @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
9699            @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
9700 pri:       @r{turn on/off priority cookies}
9701 tags:      @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9702 <:         @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9703 *:         @r{turn on/off emphasized text (bold, italic, underlined)}
9704 TeX:       @r{turn on/off simple @TeX{} macros in plain text}
9705 LaTeX:     @r{configure export of @LaTeX{} fragments.  Default @code{auto}}
9706 skip:      @r{turn on/off skipping the text before the first heading}
9707 author:    @r{turn on/off inclusion of author name/email into exported file}
9708 email:     @r{turn on/off inclusion of author email into exported file}
9709 creator:   @r{turn on/off inclusion of creator info into exported file}
9710 timestamp: @r{turn on/off inclusion creation time into exported file}
9711 d:         @r{turn on/off inclusion of drawers}
9712 @end example
9713 @noindent
9714 These options take effect in both the HTML and @LaTeX{} export, except for
9715 @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
9716 @code{nil} for the @LaTeX{} export.
9718 The default values for these and many other options are given by a set of
9719 variables.  For a list of such variables, the corresponding OPTIONS keys and
9720 also the publishing keys (@pxref{Project alist}), see the constant
9721 @code{org-export-plist-vars}.
9723 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9724 calling an export command, the subtree can overrule some of the file's export
9725 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9726 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9727 @code{EXPORT_OPTIONS}.
9729 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9730 @section The export dispatcher
9731 @cindex dispatcher, for export commands
9733 All export commands can be reached using the export dispatcher, which is a
9734 prefix key that prompts for an additional key specifying the command.
9735 Normally the entire file is exported, but if there is an active region that
9736 contains one outline tree, the first heading is used as document title and
9737 the subtrees are exported.
9739 @table @kbd
9740 @orgcmd{C-c C-e,org-export}
9741 @vindex org-export-run-in-background
9742 Dispatcher for export and publishing commands.  Displays a help-window
9743 listing the additional key(s) needed to launch an export or publishing
9744 command.  The prefix arg is passed through to the exporter.  A double prefix
9745 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9746 separate Emacs process@footnote{To make this behavior the default, customize
9747 the variable @code{org-export-run-in-background}.}.
9748 @orgcmd{C-c C-e v,org-export-visible}
9749 Like @kbd{C-c C-e}, but only export the text that is currently visible
9750 (i.e.@: not hidden by outline visibility).
9751 @orgcmd{C-u C-u C-c C-e,org-export}
9752 @vindex org-export-run-in-background
9753 Call the exporter, but reverse the setting of
9754 @code{org-export-run-in-background}, i.e.@: request background processing if
9755 not set, or force processing in the current Emacs process if set.
9756 @end table
9758 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9759 @section ASCII/Latin-1/UTF-8 export
9760 @cindex ASCII export
9761 @cindex Latin-1 export
9762 @cindex UTF-8 export
9764 ASCII export produces a simple and very readable version of an Org mode
9765 file, containing only plain ASCII.  Latin-1 and UTF-8 export augment the file
9766 with special characters and symbols available in these encodings.
9768 @cindex region, active
9769 @cindex active region
9770 @cindex transient-mark-mode
9771 @table @kbd
9772 @orgcmd{C-c C-e a,org-export-as-ascii}
9773 @cindex property, EXPORT_FILE_NAME
9774 Export as ASCII file.  For an Org file, @file{myfile.org}, the ASCII file
9775 will be @file{myfile.txt}.  The file will be overwritten without
9776 warning.  If there is an active region@footnote{This requires
9777 @code{transient-mark-mode} be turned on.}, only the region will be
9778 exported.  If the selected region is a single tree@footnote{To select the
9779 current subtree, use @kbd{C-c @@}.}, the tree head will
9780 become the document title.  If the tree head entry has or inherits an
9781 @code{EXPORT_FILE_NAME} property, that name will be used for the
9782 export.
9783 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9784 Export to a temporary buffer.  Do not create a file.
9785 @orgcmd{C-c C-e n,org-export-as-latin1}
9786 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
9787 Like the above commands, but use Latin-1 encoding.
9788 @orgcmd{C-c C-e u,org-export-as-utf8}
9789 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
9790 Like the above commands, but use UTF-8 encoding.
9791 @item C-c C-e v a/n/u
9792 Export only the visible part of the document.
9793 @end table
9795 @cindex headline levels, for exporting
9796 In the exported version, the first 3 outline levels will become
9797 headlines, defining a general document structure.  Additional levels
9798 will be exported as itemized lists.  If you want that transition to occur
9799 at a different level, specify it with a prefix argument.  For example,
9801 @example
9802 @kbd{C-1 C-c C-e a}
9803 @end example
9805 @noindent
9806 creates only top level headlines and does the rest as items.  When
9807 headlines are converted to items, the indentation of the text following
9808 the headline is changed to fit nicely under the item.  This is done with
9809 the assumption that the first body line indicates the base indentation of
9810 the body text.  Any indentation larger than this is adjusted to preserve
9811 the layout relative to the first line.  Should there be lines with less
9812 indentation than the first, these are left alone.
9814 @vindex org-export-ascii-links-to-notes
9815 Links will be exported in a footnote-like style, with the descriptive part in
9816 the text and the link in a note before the next heading.  See the variable
9817 @code{org-export-ascii-links-to-notes} for details and other options.
9819 @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9820 @section HTML export
9821 @cindex HTML export
9823 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9824 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9825 language, but with additional support for tables.
9827 @menu
9828 * HTML Export commands::        How to invoke HTML export
9829 * HTML preamble and postamble::  How to insert a preamble and a postamble
9830 * Quoting HTML tags::           Using direct HTML in Org mode
9831 * Links in HTML export::        How links will be interpreted and formatted
9832 * Tables in HTML export::       How to modify the formatting of tables
9833 * Images in HTML export::       How to insert figures into HTML output
9834 * Math formatting in HTML export::  Beautiful math also on the web
9835 * Text areas in HTML export::   An alternative way to show an example
9836 * CSS support::                 Changing the appearance of the output
9837 * JavaScript support::          Info and Folding in a web browser
9838 @end menu
9840 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
9841 @subsection HTML export commands
9843 @cindex region, active
9844 @cindex active region
9845 @cindex transient-mark-mode
9846 @table @kbd
9847 @orgcmd{C-c C-e h,org-export-as-html}
9848 @cindex property, EXPORT_FILE_NAME
9849 Export as HTML file.  For an Org file @file{myfile.org},
9850 the HTML file will be @file{myfile.html}.  The file will be overwritten
9851 without warning.  If there is an active region@footnote{This requires
9852 @code{transient-mark-mode} be turned on.}, only the region will be
9853 exported.  If the selected region is a single tree@footnote{To select the
9854 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9855 title.  If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9856 property, that name will be used for the export.
9857 @orgcmd{C-c C-e b,org-export-as-html-and-open}
9858 Export as HTML file and immediately open it with a browser.
9859 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
9860 Export to a temporary buffer.  Do not create a file.
9861 @orgcmd{C-c C-e R,org-export-region-as-html}
9862 Export the active region to a temporary buffer.  With a prefix argument, do
9863 not produce the file header and footer, but just the plain HTML section for
9864 the region.  This is good for cut-and-paste operations.
9865 @item C-c C-e v h/b/H/R
9866 Export only the visible part of the document.
9867 @item M-x org-export-region-as-html
9868 Convert the region to HTML under the assumption that it was Org mode
9869 syntax before.  This is a global command that can be invoked in any
9870 buffer.
9871 @item M-x org-replace-region-by-HTML
9872 Replace the active region (assumed to be in Org mode syntax) by HTML
9873 code.
9874 @end table
9876 @cindex headline levels, for exporting
9877 In the exported version, the first 3 outline levels will become headlines,
9878 defining a general document structure.  Additional levels will be exported as
9879 itemized lists.  If you want that transition to occur at a different level,
9880 specify it with a numeric prefix argument.  For example,
9882 @example
9883 @kbd{C-2 C-c C-e b}
9884 @end example
9886 @noindent
9887 creates two levels of headings and does the rest as items.
9890 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
9891 @subsection HTML preamble and postamble
9892 @vindex org-export-html-preamble
9893 @vindex org-export-html-postamble
9894 @vindex org-export-html-preamble-format
9895 @vindex org-export-html-postamble-format
9896 @vindex org-export-html-validation-link
9897 @vindex org-export-author-info
9898 @vindex org-export-email-info
9899 @vindex org-export-creator-info
9900 @vindex org-export-time-stamp-file
9902 The HTML exporter lets you define a preamble and a postamble.
9904 The default value for @code{org-export-html-preamble} is @code{t}, which
9905 means that the preamble is inserted depending on the relevant formatting
9906 string in @code{org-export-html-preamble-format}.
9908 Setting @code{org-export-html-preamble} to a string will override the default
9909 formatting string.  Setting it to a function, will insert the output of the
9910 function, which must be a string; such a function takes no argument but you
9911 can check against the value of @code{opt-plist}, which contains the list of
9912 publishing properties for the current file.  Setting to @code{nil} will not
9913 insert any preamble.
9915 The default value for @code{org-export-html-postamble} is @code{'auto}, which
9916 means that the HTML exporter will look for the value of
9917 @code{org-export-author-info}, @code{org-export-email-info},
9918 @code{org-export-creator-info} and @code{org-export-time-stamp-file},
9919 @code{org-export-html-validation-link} and build the postamble from these
9920 values.  Setting @code{org-export-html-postamble} to @code{t} will insert the
9921 postamble from the relevant formatting string found in
9922 @code{org-export-html-postamble-format}.  Setting it to @code{nil} will not
9923 insert any postamble.
9925 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
9926 @subsection Quoting HTML tags
9928 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
9929 @samp{&gt;} in HTML export.  If you want to include simple HTML tags
9930 which should be interpreted as such, mark them with @samp{@@} as in
9931 @samp{@@<b>bold text@@</b>}.  Note that this really works only for
9932 simple tags.  For more extensive HTML that should be copied verbatim to
9933 the exported file use either
9935 @cindex #+HTML
9936 @cindex #+BEGIN_HTML
9937 @example
9938 #+HTML: Literal HTML code for export
9939 @end example
9941 @noindent or
9942 @cindex #+BEGIN_HTML
9944 @example
9945 #+BEGIN_HTML
9946 All lines between these markers are exported literally
9947 #+END_HTML
9948 @end example
9951 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9952 @subsection Links in HTML export
9954 @cindex links, in HTML export
9955 @cindex internal links, in HTML export
9956 @cindex external links, in HTML export
9957 Internal links (@pxref{Internal links}) will continue to work in HTML.  This
9958 includes automatic links created by radio targets (@pxref{Radio
9959 targets}).  Links to external files will still work if the target file is on
9960 the same @i{relative} path as the published Org file.  Links to other
9961 @file{.org} files will be translated into HTML links under the assumption
9962 that an HTML version also exists of the linked file, at the same relative
9963 path.  @samp{id:} links can then be used to jump to specific entries across
9964 files.  For information related to linking files while publishing them to a
9965 publishing directory see @ref{Publishing links}.
9967 If you want to specify attributes for links, you can do so using a special
9968 @code{#+ATTR_HTML} line to define attributes that will be added to the
9969 @code{<a>} or @code{<img>} tags.  Here is an example that sets @code{title}
9970 and @code{style} attributes for a link:
9972 @cindex #+ATTR_HTML
9973 @example
9974 #+ATTR_HTML: title="The Org mode homepage" style="color:red;"
9975 [[http://orgmode.org]]
9976 @end example
9978 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9979 @subsection Tables
9980 @cindex tables, in HTML
9981 @vindex org-export-html-table-tag
9983 Org mode tables are exported to HTML using the table tag defined in
9984 @code{org-export-html-table-tag}.  The default setting makes tables without
9985 cell borders and frame.  If you would like to change this for individual
9986 tables, place something like the following before the table:
9988 @cindex #+CAPTION
9989 @cindex #+ATTR_HTML
9990 @example
9991 #+CAPTION: This is a table with lines around and between cells
9992 #+ATTR_HTML: border="2" rules="all" frame="border"
9993 @end example
9995 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
9996 @subsection Images in HTML export
9998 @cindex images, inline in HTML
9999 @cindex inlining images in HTML
10000 @vindex org-export-html-inline-images
10001 HTML export can inline images given as links in the Org file, and
10002 it can make an image the clickable part of a link.  By
10003 default@footnote{But see the variable
10004 @code{org-export-html-inline-images}.}, images are inlined if a link does
10005 not have a description.  So @samp{[[file:myimg.jpg]]} will be inlined,
10006 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
10007 @samp{the image} that points to the image.  If the description part
10008 itself is a @code{file:} link or a @code{http:} URL pointing to an
10009 image, this image will be inlined and activated so that clicking on the
10010 image will activate the link.  For example, to include a thumbnail that
10011 will link to a high resolution version of the image, you could use:
10013 @example
10014 [[file:highres.jpg][file:thumb.jpg]]
10015 @end example
10017 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
10018 In the example below we specify the @code{alt} and @code{title} attributes to
10019 support text viewers and accessibility, and align it to the right.
10021 @cindex #+CAPTION
10022 @cindex #+ATTR_HTML
10023 @example
10024 #+CAPTION: A black cat stalking a spider
10025 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
10026 [[./img/a.jpg]]
10027 @end example
10029 @noindent
10030 You could use @code{http} addresses just as well.
10032 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
10033 @subsection Math formatting in HTML export
10034 @cindex MathJax
10035 @cindex dvipng
10037 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
10038 different ways on HTML pages.  The default is to use the
10039 @uref{http://www.mathjax.org, MathJax system} which should work out of the
10040 box with Org mode installation because @code{http://orgmode.org} serves
10041 @file{MathJax} for Org mode users for small applications and for testing
10042 purposes.  @b{If you plan to use this regularly or on pages with significant
10043 page views, you should install@footnote{Installation instructions can be
10044 found on the MathJax website, see
10045 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
10046 your own server in order to limit the load of our server.}  To configure
10047 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
10048 insert something like the following into the buffer:
10050 @example
10051 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
10052 @end example
10054 @noindent See the docstring of the variable
10055 @code{org-export-html-mathjax-options} for the meaning of the parameters in
10056 this line.
10058 If you prefer, you can also request that @LaTeX{} fragments are processed
10059 into small images that will be inserted into the browser page.  Before the
10060 availability of MathJax, this was the default method for Org files.  This
10061 method requires that the @file{dvipng} program is available on your system.
10062 You can still get this processing with
10064 @example
10065 #+OPTIONS: LaTeX:dvipng
10066 @end example
10068 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
10069 @subsection Text areas in HTML export
10071 @cindex text areas, in HTML
10072 An alternative way to publish literal code examples in HTML is to use text
10073 areas, where the example can even be edited before pasting it into an
10074 application.  It is triggered by a @code{-t} switch at an @code{example} or
10075 @code{src} block.  Using this switch disables any options for syntax and
10076 label highlighting, and line numbering, which may be present.  You may also
10077 use @code{-h} and @code{-w} switches to specify the height and width of the
10078 text area, which default to the number of lines in the example, and 80,
10079 respectively.  For example
10081 @example
10082 #+BEGIN_EXAMPLE -t -w 40
10083   (defun org-xor (a b)
10084      "Exclusive or."
10085      (if a (not b) b))
10086 #+END_EXAMPLE
10087 @end example
10090 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
10091 @subsection CSS support
10092 @cindex CSS, for HTML export
10093 @cindex HTML export, CSS
10095 @vindex org-export-html-todo-kwd-class-prefix
10096 @vindex org-export-html-tag-class-prefix
10097 You can also give style information for the exported file.  The HTML exporter
10098 assigns the following special CSS classes@footnote{If the classes on TODO
10099 keywords and tags lead to conflicts, use the variables
10100 @code{org-export-html-todo-kwd-class-prefix} and
10101 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
10102 parts of the document---your style specifications may change these, in
10103 addition to any of the standard classes like for headlines, tables, etc.
10104 @example
10105 p.author            @r{author information, including email}
10106 p.date              @r{publishing date}
10107 p.creator           @r{creator info, about org mode version}
10108 .title              @r{document title}
10109 .todo               @r{TODO keywords, all not-done states}
10110 .done               @r{the DONE keywords, all states that count as done}
10111 .WAITING            @r{each TODO keyword also uses a class named after itself}
10112 .timestamp          @r{timestamp}
10113 .timestamp-kwd      @r{keyword associated with a timestamp, like SCHEDULED}
10114 .timestamp-wrapper  @r{span around keyword plus timestamp}
10115 .tag                @r{tag in a headline}
10116 ._HOME              @r{each tag uses itself as a class, "@@" replaced by "_"}
10117 .target             @r{target for links}
10118 .linenr             @r{the line number in a code example}
10119 .code-highlighted   @r{for highlighting referenced code lines}
10120 div.outline-N       @r{div for outline level N (headline plus text))}
10121 div.outline-text-N  @r{extra div for text at outline level N}
10122 .section-number-N   @r{section number in headlines, different for each level}
10123 div.figure          @r{how to format an inlined image}
10124 pre.src             @r{formatted source code}
10125 pre.example         @r{normal example}
10126 p.verse             @r{verse paragraph}
10127 div.footnotes       @r{footnote section headline}
10128 p.footnote          @r{footnote definition paragraph, containing a footnote}
10129 .footref            @r{a footnote reference number (always a <sup>)}
10130 .footnum            @r{footnote number in footnote definition (always <sup>)}
10131 @end example
10133 @vindex org-export-html-style-default
10134 @vindex org-export-html-style-include-default
10135 @vindex org-export-html-style
10136 @vindex org-export-html-extra
10137 @vindex org-export-html-style-default
10138 Each exported file contains a compact default style that defines these
10139 classes in a basic way@footnote{This style is defined in the constant
10140 @code{org-export-html-style-default}, which you should not modify.  To turn
10141 inclusion of these defaults off, customize
10142 @code{org-export-html-style-include-default}}.  You may overwrite these
10143 settings, or add to them by using the variables @code{org-export-html-style}
10144 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
10145 fine-grained settings, like file-local settings).  To set the latter variable
10146 individually for each file, you can use
10148 @cindex #+STYLE
10149 @example
10150 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
10151 @end example
10153 @noindent
10154 For longer style definitions, you can use several such lines.  You could also
10155 directly write a @code{<style>} @code{</style>} section in this way, without
10156 referring to an external file.
10158 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
10159 property to assign a class to the tree.  In order to specify CSS styles for a
10160 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
10161 property.
10163 @c FIXME: More about header and footer styles
10164 @c FIXME: Talk about links and targets.
10166 @node JavaScript support,  , CSS support, HTML export
10167 @subsection JavaScript supported display of web pages
10169 @cindex Rose, Sebastian
10170 Sebastian Rose has written a JavaScript program especially designed to
10171 enhance the web viewing experience of HTML files created with Org.  This
10172 program allows you to view large files in two different ways.  The first one
10173 is an @emph{Info}-like mode where each section is displayed separately and
10174 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
10175 as well, press @kbd{?} for an overview of the available keys).  The second
10176 view type is a @emph{folding} view much like Org provides inside Emacs.  The
10177 script is available at @url{http://orgmode.org/org-info.js} and you can find
10178 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
10179 We host the script at our site, but if you use it a lot, you might
10180 not want to be dependent on @url{orgmode.org} and prefer to install a local
10181 copy on your own web server.
10183 To use the script, you need to make sure that the @file{org-jsinfo.el} module
10184 gets loaded.  It should be loaded by default, but you can try @kbd{M-x
10185 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
10186 this is indeed the case.  All it then takes to make use of the program is
10187 adding a single line to the Org file:
10189 @cindex #+INFOJS_OPT
10190 @example
10191 #+INFOJS_OPT: view:info toc:nil
10192 @end example
10194 @noindent
10195 If this line is found, the HTML header will automatically contain the code
10196 needed to invoke the script.  Using the line above, you can set the following
10197 viewing options:
10199 @example
10200 path:    @r{The path to the script.  The default is to grab the script from}
10201          @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
10202          @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
10203 view:    @r{Initial view when website is first shown.  Possible values are:}
10204          info      @r{Info-like interface with one section per page.}
10205          overview  @r{Folding interface, initially showing only top-level.}
10206          content   @r{Folding interface, starting with all headlines visible.}
10207          showall   @r{Folding interface, all headlines and text visible.}
10208 sdepth:  @r{Maximum headline level that will still become an independent}
10209          @r{section for info and folding modes.  The default is taken from}
10210          @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
10211          @r{If this is smaller than in @code{org-export-headline-levels}, each}
10212          @r{info/folding section can still contain child headlines.}
10213 toc:     @r{Should the table of contents @emph{initially} be visible?}
10214          @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
10215 tdepth:  @r{The depth of the table of contents.  The defaults are taken from}
10216          @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
10217 ftoc:    @r{Does the CSS of the page specify a fixed position for the "toc"?}
10218          @r{If yes, the toc will never be displayed as a section.}
10219 ltoc:    @r{Should there be short contents (children) in each section?}
10220          @r{Make this @code{above} if the section should be above initial text.}
10221 mouse:   @r{Headings are highlighted when the mouse is over them.  Should be}
10222          @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
10223 buttons: @r{Should view-toggle buttons be everywhere?  When @code{nil} (the}
10224          @r{default), only one such button will be present.}
10225 @end example
10226 @noindent
10227 @vindex org-infojs-options
10228 @vindex org-export-html-use-infojs
10229 You can choose default values for these options by customizing the variable
10230 @code{org-infojs-options}.  If you always want to apply the script to your
10231 pages, configure the variable @code{org-export-html-use-infojs}.
10233 @node @LaTeX{} and PDF export, DocBook export, HTML export, Exporting
10234 @section @LaTeX{} and PDF export
10235 @cindex @LaTeX{} export
10236 @cindex PDF export
10237 @cindex Guerry, Bastien
10239 Org mode contains a @LaTeX{} exporter written by Bastien Guerry.  With
10240 further processing@footnote{The default @LaTeX{} output is designed for
10241 processing with @code{pdftex} or @LaTeX{}.  It includes packages that are not
10242 compatible with @code{xetex} and possibly @code{luatex}.  See the variables
10243 @code{org-export-latex-default-packages-alist} and
10244 @code{org-export-latex-packages-alist}.}, this backend is also used to
10245 produce PDF output.  Since the @LaTeX{} output uses @file{hyperref} to
10246 implement links and cross references, the PDF output file will be fully
10247 linked.  Beware of the fact that your @code{org} file has to be properly
10248 structured in order to be correctly exported: respect the hierarchy of
10249 sections.
10251 @menu
10252 * @LaTeX{}/PDF export commands::
10253 * Header and sectioning::       Setting up the export file structure
10254 * Quoting @LaTeX{} code::       Incorporating literal @LaTeX{} code
10255 * Tables in @LaTeX{} export::   Options for exporting tables to @LaTeX{}
10256 * Images in @LaTeX{} export::   How to insert figures into @LaTeX{} output
10257 * Beamer class export::         Turning the file into a presentation
10258 @end menu
10260 @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
10261 @subsection @LaTeX{} export commands
10263 @cindex region, active
10264 @cindex active region
10265 @cindex transient-mark-mode
10266 @table @kbd
10267 @orgcmd{C-c C-e l,org-export-as-latex}
10268 @cindex property EXPORT_FILE_NAME
10269 Export as @LaTeX{} file.  For an Org file
10270 @file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}.  The file will
10271 be overwritten without warning.  If there is an active region@footnote{This
10272 requires @code{transient-mark-mode} be turned on.}, only the region will be
10273 exported.  If the selected region is a single tree@footnote{To select the
10274 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10275 title.  If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
10276 property, that name will be used for the export.
10277 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
10278 Export to a temporary buffer.  Do not create a file.
10279 @item C-c C-e v l/L
10280 Export only the visible part of the document.
10281 @item M-x org-export-region-as-latex
10282 Convert the region to @LaTeX{} under the assumption that it was Org mode
10283 syntax before.  This is a global command that can be invoked in any
10284 buffer.
10285 @item M-x org-replace-region-by-latex
10286 Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
10287 code.
10288 @orgcmd{C-c C-e p,org-export-as-pdf}
10289 Export as @LaTeX{} and then process to PDF.
10290 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
10291 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10292 @end table
10294 @cindex headline levels, for exporting
10295 @vindex org-latex-low-levels
10296 In the exported version, the first 3 outline levels will become
10297 headlines, defining a general document structure.  Additional levels
10298 will be exported as description lists.  The exporter can ignore them or
10299 convert them to a custom string depending on
10300 @code{org-latex-low-levels}.
10302 If you want that transition to occur at a different level, specify it
10303 with a numeric prefix argument.  For example,
10305 @example
10306 @kbd{C-2 C-c C-e l}
10307 @end example
10309 @noindent
10310 creates two levels of headings and does the rest as items.
10312 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
10313 @subsection Header and sectioning structure
10314 @cindex @LaTeX{} class
10315 @cindex @LaTeX{} sectioning structure
10316 @cindex @LaTeX{} header
10317 @cindex header, for @LaTeX{} files
10318 @cindex sectioning structure, for @LaTeX{} export
10320 By default, the @LaTeX{} output uses the class @code{article}.
10322 @vindex org-export-latex-default-class
10323 @vindex org-export-latex-classes
10324 @vindex org-export-latex-default-packages-alist
10325 @vindex org-export-latex-packages-alist
10326 @cindex #+LATEX_HEADER
10327 @cindex #+LATEX_CLASS
10328 @cindex #+LATEX_CLASS_OPTIONS
10329 @cindex property, LATEX_CLASS
10330 @cindex property, LATEX_CLASS_OPTIONS
10331 You can change this globally by setting a different value for
10332 @code{org-export-latex-default-class} or locally by adding an option like
10333 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
10334 property that applies when exporting a region containing only this (sub)tree.
10335 The class must be listed in @code{org-export-latex-classes}.  This variable
10336 defines a header template for each class@footnote{Into which the values of
10337 @code{org-export-latex-default-packages-alist} and
10338 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
10339 define the sectioning structure for each class.  You can also define your own
10340 classes there.  @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
10341 property can specify the options for the @code{\documentclass} macro.  You
10342 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
10343 header.  See the docstring of @code{org-export-latex-classes} for more
10344 information.
10346 @node Quoting @LaTeX{} code, Tables in @LaTeX{} export, Header and sectioning, @LaTeX{} and PDF export
10347 @subsection Quoting @LaTeX{} code
10349 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
10350 inserted into the @LaTeX{} file.  This includes simple macros like
10351 @samp{\ref@{LABEL@}} to create a cross reference to a figure.  Furthermore,
10352 you can add special code that should only be present in @LaTeX{} export with
10353 the following constructs:
10355 @cindex #+LaTeX
10356 @cindex #+BEGIN_LaTeX
10357 @example
10358 #+LaTeX: Literal @LaTeX{} code for export
10359 @end example
10361 @noindent or
10362 @cindex #+BEGIN_LaTeX
10364 @example
10365 #+BEGIN_LaTeX
10366 All lines between these markers are exported literally
10367 #+END_LaTeX
10368 @end example
10371 @node Tables in @LaTeX{} export, Images in @LaTeX{} export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
10372 @subsection Tables in @LaTeX{} export
10373 @cindex tables, in @LaTeX{} export
10375 For @LaTeX{} export of a table, you can specify a label, a caption and
10376 placement options (@pxref{Images and tables}).  You can also use the
10377 @code{ATTR_LaTeX} line to request a @code{longtable} environment for the
10378 table, so that it may span several pages, or to change the default table
10379 environment from @code{table} to @code{table*} or to change the default inner
10380 tabular environment to @code{tabularx} or @code{tabulary}.  Finally, you can
10381 set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
10382 width:
10384 @cindex #+CAPTION
10385 @cindex #+LABEL
10386 @cindex #+ATTR_LaTeX
10387 @example
10388 #+CAPTION: A long table
10389 #+LABEL: tbl:long
10390 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10391 | ..... | ..... |
10392 | ..... | ..... |
10393 @end example
10395 or to specify a multicolumn table with @code{tabulary}
10397 @cindex #+CAPTION
10398 @cindex #+LABEL
10399 @cindex #+ATTR_LaTeX
10400 @example
10401 #+CAPTION: A wide table with tabulary
10402 #+LABEL: tbl:wide
10403 #+ATTR_LaTeX: table* tabulary width=\textwidth
10404 | ..... | ..... |
10405 | ..... | ..... |
10406 @end example
10408 @node Images in @LaTeX{} export, Beamer class export, Tables in @LaTeX{} export, @LaTeX{} and PDF export
10409 @subsection Images in @LaTeX{} export
10410 @cindex images, inline in @LaTeX{}
10411 @cindex inlining images in @LaTeX{}
10413 Images that are linked to without a description part in the link, like
10414 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10415 output file resulting from @LaTeX{} processing.  Org will use an
10416 @code{\includegraphics} macro to insert the image.  If you have specified a
10417 caption and/or a label as described in @ref{Images and tables}, the figure
10418 will be wrapped into a @code{figure} environment and thus become a floating
10419 element.  You can use an @code{#+ATTR_LaTeX:} line to specify various other
10420 options.  You can ask org to export an image as a float without specifying
10421 a label or a caption by using the keyword @code{float} in this line.  Various
10422 optional arguments to the @code{\includegraphics} macro can also be specified
10423 in this fashion.  To modify the placement option of the floating environment,
10424 add something like @samp{placement=[h!]} to the attributes.  It is to be noted
10425 this option can be used with tables as well@footnote{One can also take
10426 advantage of this option to pass other, unrelated options into the figure or
10427 table environment.  For an example see the section ``Exporting org files'' in
10428 @url{http://orgmode.org/worg/org-hacks.html}}.  For example the
10429 @code{#+ATTR_LaTeX:} line below is exported as the @code{figure} environment
10430 below it.
10432 If you would like to let text flow around the image, add the word @samp{wrap}
10433 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10434 half of the page.  To fine-tune, the @code{placement} field will be the set
10435 of additional arguments needed by the @code{wrapfigure} environment.  Note
10436 that if you change the size of the image, you need to use compatible settings
10437 for @code{\includegraphics} and @code{wrapfigure}.
10439 @cindex #+CAPTION
10440 @cindex #+LABEL
10441 @cindex #+ATTR_LaTeX
10442 @example
10443 #+CAPTION:    The black-body emission of the disk around HR 4049
10444 #+LABEL:      fig:SED-HR4049
10445 #+ATTR_LaTeX: width=5cm,angle=90
10446 [[./img/sed-hr4049.pdf]]
10448 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10449 [[./img/hst.png]]
10450 @end example
10452 If you wish to include an image which spans multiple columns in a page, you
10453 can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line.  This
10454 will export the image wrapped in a @code{figure*} environment.
10456 If you need references to a label created in this way, write
10457 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10459 @node Beamer class export,  , Images in @LaTeX{} export, @LaTeX{} and PDF export
10460 @subsection Beamer class export
10462 The @LaTeX{} class @file{beamer} allows production of high quality presentations
10463 using @LaTeX{} and pdf processing.  Org mode has special support for turning an
10464 Org mode file or tree into a @file{beamer} presentation.
10466 When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
10467 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10468 @code{beamer}, a special export mode will turn the file or tree into a beamer
10469 presentation.  Any tree with not-too-deep level nesting should in principle be
10470 exportable as a beamer presentation.  By default, the top-level entries (or
10471 the first level below the selected subtree heading) will be turned into
10472 frames, and the outline structure below this level will become itemize lists.
10473 You can also configure the variable @code{org-beamer-frame-level} to a
10474 different level---then the hierarchy above frames will produce the sectioning
10475 structure of the presentation.
10477 A template for useful in-buffer settings or properties can be inserted into
10478 the buffer with @kbd{M-x org-insert-beamer-options-template}.  Among other
10479 things, this will install a column view format which is very handy for
10480 editing special properties used by beamer.
10482 You can influence the structure of the presentation using the following
10483 properties:
10485 @table @code
10486 @item BEAMER_env
10487 The environment that should be used to format this entry.  Valid environments
10488 are defined in the constant @code{org-beamer-environments-default}, and you
10489 can define more in @code{org-beamer-environments-extra}.  If this property is
10490 set, the entry will also get a @code{:B_environment:} tag to make this
10491 visible.  This tag has no semantic meaning, it is only a visual aid.
10492 @item BEAMER_envargs
10493 The beamer-special arguments that should be used for the environment, like
10494 @code{[t]} or @code{[<+->]} of @code{<2-3>}.  If the @code{BEAMER_col}
10495 property is also set, something like @code{C[t]} can be added here as well to
10496 set an options argument for the implied @code{columns} environment.
10497 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10498 environment.
10499 @item BEAMER_col
10500 The width of a column that should start with this entry.  If this property is
10501 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10502 Also this tag is only a visual aid.  When this is a plain number, it will be
10503 interpreted as a fraction of @code{\textwidth}.  Otherwise it will be assumed
10504 that you have specified the units, like @samp{3cm}.  The first such property
10505 in a frame will start a @code{columns} environment to surround the columns.
10506 This environment is closed when an entry has a @code{BEAMER_col} property
10507 with value 0 or 1, or automatically at the end of the frame.
10508 @item BEAMER_extra
10509 Additional commands that should be inserted after the environment has been
10510 opened.  For example, when creating a frame, this can be used to specify
10511 transitions.
10512 @end table
10514 Frames will automatically receive a @code{fragile} option if they contain
10515 source code that uses the verbatim environment.  Special @file{beamer}
10516 specific code can be inserted using @code{#+BEAMER:} and
10517 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
10518 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10519 in the presentation as well.
10521 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10522 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10523 into @code{\note@{...@}}.  The former will include the heading as part of the
10524 note text, the latter will ignore the heading of that node.  To simplify note
10525 generation, it is actually enough to mark the note with a @emph{tag} (either
10526 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10527 @code{BEAMER_env} property.
10529 You can turn on a special minor mode @code{org-beamer-mode} for editing
10530 support with
10532 @example
10533 #+STARTUP: beamer
10534 @end example
10536 @table @kbd
10537 @orgcmd{C-c C-b,org-beamer-select-environment}
10538 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10539 environment or the @code{BEAMER_col} property.
10540 @end table
10542 Column view provides a great way to set the environment of a node and other
10543 important parameters.  Make sure you are using a COLUMN format that is geared
10544 toward this special purpose.  The command @kbd{M-x
10545 org-insert-beamer-options-template} defines such a format.
10547 Here is a simple example Org document that is intended for beamer export.
10549 @smallexample
10550 #+LaTeX_CLASS: beamer
10551 #+TITLE: Example Presentation
10552 #+AUTHOR: Carsten Dominik
10553 #+LaTeX_CLASS_OPTIONS: [presentation]
10554 #+BEAMER_FRAME_LEVEL: 2
10555 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10556 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10558 * This is the first structural section
10560 ** Frame 1 \\ with a subtitle
10561 *** Thanks to Eric Fraga                                      :BMCOL:B_block:
10562     :PROPERTIES:
10563     :BEAMER_env: block
10564     :BEAMER_envargs: C[t]
10565     :BEAMER_col: 0.5
10566     :END:
10567     for the first viable beamer setup in Org
10568 *** Thanks to everyone else                                   :BMCOL:B_block:
10569     :PROPERTIES:
10570     :BEAMER_col: 0.5
10571     :BEAMER_env: block
10572     :BEAMER_envargs: <2->
10573     :END:
10574     for contributing to the discussion
10575 **** This will be formatted as a beamer note                  :B_note:
10576 ** Frame 2 \\ where we will not use columns
10577 *** Request                                                   :B_block:
10578     Please test this stuff!
10579     :PROPERTIES:
10580     :BEAMER_env: block
10581     :END:
10582 @end smallexample
10584 For more information, see the documentation on Worg.
10586 @node DocBook export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
10587 @section DocBook export
10588 @cindex DocBook export
10589 @cindex PDF export
10590 @cindex Cui, Baoqiu
10592 Org contains a DocBook exporter written by Baoqiu Cui.  Once an Org file is
10593 exported to DocBook format, it can be further processed to produce other
10594 formats, including PDF, HTML, man pages, etc., using many available DocBook
10595 tools and stylesheets.
10597 Currently DocBook exporter only supports DocBook V5.0.
10599 @menu
10600 * DocBook export commands::     How to invoke DocBook export
10601 * Quoting DocBook code::        Incorporating DocBook code in Org files
10602 * Recursive sections::          Recursive sections in DocBook
10603 * Tables in DocBook export::    Tables are exported as HTML tables
10604 * Images in DocBook export::    How to insert figures into DocBook output
10605 * Special characters::          How to handle special characters
10606 @end menu
10608 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10609 @subsection DocBook export commands
10611 @cindex region, active
10612 @cindex active region
10613 @cindex transient-mark-mode
10614 @table @kbd
10615 @orgcmd{C-c C-e D,org-export-as-docbook}
10616 @cindex property EXPORT_FILE_NAME
10617 Export as DocBook file.  For an Org file, @file{myfile.org}, the DocBook XML
10618 file will be @file{myfile.xml}.  The file will be overwritten without
10619 warning.  If there is an active region@footnote{This requires
10620 @code{transient-mark-mode} to be turned on}, only the region will be
10621 exported.  If the selected region is a single tree@footnote{To select the
10622 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10623 title.  If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10624 property, that name will be used for the export.
10625 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10626 Export as DocBook file, process to PDF, then open the resulting PDF file.
10628 @vindex org-export-docbook-xslt-proc-command
10629 @vindex org-export-docbook-xsl-fo-proc-command
10630 Note that, in order to produce PDF output based on exported DocBook file, you
10631 need to have XSLT processor and XSL-FO processor software installed on your
10632 system.  Check variables @code{org-export-docbook-xslt-proc-command} and
10633 @code{org-export-docbook-xsl-fo-proc-command}.
10635 @vindex org-export-docbook-xslt-stylesheet
10636 The stylesheet argument @code{%s} in variable
10637 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10638 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10639 the user.  You can also overrule this global setting on a per-file basis by
10640 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10642 @orgkey{C-c C-e v D}
10643 Export only the visible part of the document.
10644 @end table
10646 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10647 @subsection Quoting DocBook code
10649 You can quote DocBook code in Org files and copy it verbatim into exported
10650 DocBook file with the following constructs:
10652 @cindex #+DOCBOOK
10653 @cindex #+BEGIN_DOCBOOK
10654 @example
10655 #+DOCBOOK: Literal DocBook code for export
10656 @end example
10658 @noindent or
10659 @cindex #+BEGIN_DOCBOOK
10661 @example
10662 #+BEGIN_DOCBOOK
10663 All lines between these markers are exported by DocBook exporter
10664 literally.
10665 #+END_DOCBOOK
10666 @end example
10668 For example, you can use the following lines to include a DocBook warning
10669 admonition.  As to what this warning says, you should pay attention to the
10670 document context when quoting DocBook code in Org files.  You may make
10671 exported DocBook XML files invalid by not quoting DocBook code correctly.
10673 @example
10674 #+BEGIN_DOCBOOK
10675 <warning>
10676   <para>You should know what you are doing when quoting DocBook XML code
10677   in your Org file.  Invalid DocBook XML may be generated by
10678   DocBook exporter if you are not careful!</para>
10679 </warning>
10680 #+END_DOCBOOK
10681 @end example
10683 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10684 @subsection Recursive sections
10685 @cindex DocBook recursive sections
10687 DocBook exporter exports Org files as articles using the @code{article}
10688 element in DocBook.  Recursive sections, i.e.@: @code{section} elements, are
10689 used in exported articles.  Top level headlines in Org files are exported as
10690 top level sections, and lower level headlines are exported as nested
10691 sections.  The entire structure of Org files will be exported completely, no
10692 matter how many nested levels of headlines there are.
10694 Using recursive sections makes it easy to port and reuse exported DocBook
10695 code in other DocBook document types like @code{book} or @code{set}.
10697 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10698 @subsection Tables in DocBook export
10699 @cindex tables, in DocBook export
10701 Tables in Org files are exported as HTML tables, which have been supported since
10702 DocBook V4.3.
10704 If a table does not have a caption, an informal table is generated using the
10705 @code{informaltable} element; otherwise, a formal table will be generated
10706 using the @code{table} element.
10708 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10709 @subsection Images in DocBook export
10710 @cindex images, inline in DocBook
10711 @cindex inlining images in DocBook
10713 Images that are linked to without a description part in the link, like
10714 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10715 using @code{mediaobject} elements.  Each @code{mediaobject} element contains
10716 an @code{imageobject} that wraps an @code{imagedata} element.  If you have
10717 specified a caption for an image as described in @ref{Images and tables}, a
10718 @code{caption} element will be added in @code{mediaobject}.  If a label is
10719 also specified, it will be exported as an @code{xml:id} attribute of the
10720 @code{mediaobject} element.
10722 @vindex org-export-docbook-default-image-attributes
10723 Image attributes supported by the @code{imagedata} element, like @code{align}
10724 or @code{width}, can be specified in two ways: you can either customize
10725 variable @code{org-export-docbook-default-image-attributes} or use the
10726 @code{#+ATTR_DOCBOOK:} line.  Attributes specified in variable
10727 @code{org-export-docbook-default-image-attributes} are applied to all inline
10728 images in the Org file to be exported (unless they are overridden by image
10729 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10731 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10732 attributes or override default image attributes for individual images.  If
10733 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10734 variable @code{org-export-docbook-default-image-attributes}, the former
10735 takes precedence.  Here is an example about how image attributes can be
10736 set:
10738 @cindex #+CAPTION
10739 @cindex #+LABEL
10740 @cindex #+ATTR_DOCBOOK
10741 @example
10742 #+CAPTION:    The logo of Org mode
10743 #+LABEL:      unicorn-svg
10744 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10745 [[./img/org-mode-unicorn.svg]]
10746 @end example
10748 @vindex org-export-docbook-inline-image-extensions
10749 By default, DocBook exporter recognizes the following image file types:
10750 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}.  You can
10751 customize variable @code{org-export-docbook-inline-image-extensions} to add
10752 more types to this list as long as DocBook supports them.
10754 @node Special characters,  , Images in DocBook export, DocBook export
10755 @subsection Special characters in DocBook export
10756 @cindex Special characters in DocBook export
10758 @vindex org-export-docbook-doctype
10759 @vindex org-entities
10760 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10761 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter.  These
10762 characters are rewritten to XML entities, like @code{&alpha;},
10763 @code{&Gamma;}, and @code{&Zeta;}, based on the list saved in variable
10764 @code{org-entities}.  As long as the generated DocBook file includes the
10765 corresponding entities, these special characters are recognized.
10767 You can customize variable @code{org-export-docbook-doctype} to include the
10768 entities you need.  For example, you can set variable
10769 @code{org-export-docbook-doctype} to the following value to recognize all
10770 special characters included in XHTML entities:
10772 @example
10773 "<!DOCTYPE article [
10774 <!ENTITY % xhtml1-symbol PUBLIC
10775 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10776 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10778 %xhtml1-symbol;
10781 @end example
10783 @c begin opendocument
10785 @node OpenDocument Text export, TaskJuggler export, DocBook export, Exporting
10786 @section OpenDocument Text export
10787 @cindex K, Jambunathan
10788 @cindex ODT
10789 @cindex OpenDocument
10790 @cindex export, OpenDocument
10791 @cindex LibreOffice
10792 @cindex org-odt.el
10793 @cindex org-modules
10795 Orgmode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
10796 (ODT) format using the @file{org-odt.el} module.  Documents created
10797 by this exporter use the @cite{OpenDocument-v1.2
10798 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
10799 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
10800 are compatible with LibreOffice 3.4.
10802 @menu
10803 * Pre-requisites for ODT export::  What packages ODT exporter relies on
10804 * ODT export commands::  How to invoke ODT export
10805 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
10806 * Applying custom styles::      How to apply custom styles to the output
10807 * Links in ODT export::  How links will be interpreted and formatted
10808 * Tables in ODT export::  How Tables are exported
10809 * Images in ODT export::  How to insert images
10810 * Math formatting in ODT export::  How @LaTeX{} fragments are formatted
10811 * Literal examples in ODT export::  How source and example blocks are formatted
10812 * Advanced topics in ODT export::  Read this if you are a power user
10813 @end menu
10815 @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
10816 @subsection Pre-requisites for ODT export
10817 @cindex zip
10818 The ODT exporter relies on the @file{zip} program to create the final
10819 output.  Check the availability of this program before proceeding further.
10821 @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
10822 @subsection ODT export commands
10824 @subsubheading Exporting to ODT
10825 @anchor{x-export-to-odt}
10827 @cindex region, active
10828 @cindex active region
10829 @cindex transient-mark-mode
10830 @table @kbd
10831 @orgcmd{C-c C-e o,org-export-as-odt}
10832 @cindex property EXPORT_FILE_NAME
10834 Export as OpenDocument Text file.
10836 @vindex org-export-odt-preferred-output-format
10837 If @code{org-export-odt-preferred-output-format} is specified, automatically
10838 convert the exported file to that format.  @xref{x-export-to-other-formats, ,
10839 Automatically exporting to other formats}.
10841 For an Org file @file{myfile.org}, the ODT file will be
10842 @file{myfile.odt}.  The file will be overwritten without warning.  If there
10843 is an active region,@footnote{This requires @code{transient-mark-mode} to be
10844 turned on} only the region will be exported.  If the selected region is a
10845 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
10846 tree head will become the document title.  If the tree head entry has, or
10847 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
10848 export.
10850 @orgcmd{C-c C-e O,org-export-as-odt-and-open}
10851 Export as OpenDocument Text file and open the resulting file.
10853 @vindex org-export-odt-preferred-output-format
10854 If @code{org-export-odt-preferred-output-format} is specified, open the
10855 converted file instead.  @xref{x-export-to-other-formats, , Automatically
10856 exporting to other formats}.
10857 @end table
10859 @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
10860 @subsection Extending ODT export
10862 The ODT exporter can interface with a variety of document
10863 converters and supports popular converters out of the box.  As a result, you
10864 can use it to export to formats like @samp{doc} or convert a document from
10865 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
10867 @cindex @file{unoconv}
10868 @cindex LibreOffice
10869 If you have a working installation of LibreOffice, a document converter is
10870 pre-configured for you and you can use it right away.  If you would like to
10871 use @file{unoconv} as your preferred converter, customize the variable
10872 @code{org-export-odt-convert-process} to point to @code{unoconv}.  If you
10873 would like to use a converter of your own choosing or tweak the default
10874 settings of the default @file{LibreOffice} and @samp{unoconv} converters
10875 @xref{Configuring a document converter}.
10877 @subsubsection Automatically exporting to other formats
10878 @anchor{x-export-to-other-formats}
10880 @vindex org-export-odt-preferred-output-format
10881 Very often, you will find yourself exporting to ODT format, only to
10882 immediately save the exported document to other formats like @samp{doc},
10883 @samp{docx}, @samp{rtf}, @samp{pdf} etc.  In such cases, you can specify your
10884 preferred output format by customizing the variable
10885 @code{org-export-odt-preferred-output-format}.  This way, the export commands
10886 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
10887 format that is of immediate interest to you.
10889 @subsubsection Converting between document formats
10890 @anchor{x-convert-to-other-formats}
10892 There are many document converters in the wild which support conversion to
10893 and from various file formats, including, but not limited to the
10894 ODT format.  LibreOffice converter, mentioned above, is one such
10895 converter.  Once a converter is configured, you can interact with it using
10896 the following command.
10898 @vindex org-export-odt-convert
10899 @table @kbd
10901 @item M-x org-export-odt-convert
10902 Convert an existing document from one format to another.  With a prefix
10903 argument, also open the newly produced file.
10904 @end table
10906 @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
10907 @subsection Applying custom styles
10908 @cindex styles, custom
10909 @cindex template, custom
10911 The ODT exporter ships with a set of OpenDocument styles
10912 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
10913 output.  These factory styles, however, may not cater to your specific
10914 tastes.  To customize the output, you can either modify the above styles
10915 files directly, or generate the required styles using an application like
10916 LibreOffice.  The latter method is suitable for expert and non-expert
10917 users alike, and is described here.
10919 @subsubsection Applying custom styles - the easy way
10921 @enumerate
10922 @item
10923 Create a sample @file{example.org} file with the below settings and export it
10924 to ODT format.
10926 @example
10927 #+OPTIONS: H:10 num:t
10928 @end example
10930 @item
10931 Open the above @file{example.odt} using LibreOffice.  Use the @file{Stylist}
10932 to locate the target styles - these typically have the @samp{Org} prefix -
10933 and modify those to your taste.  Save the modified file either as an
10934 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
10936 @item
10937 @cindex #+ODT_STYLES_FILE
10938 @vindex org-export-odt-styles-file
10939 Customize the variable @code{org-export-odt-styles-file} and point it to the
10940 newly created file.  For additional configuration options
10941 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
10943 If you would like to choose a style on a per-file basis, you can use the
10944 @code{#+ODT_STYLES_FILE} option.  A typical setting will look like
10946 @example
10947 #+ODT_STYLES_FILE: "/path/to/example.ott"
10948 @end example
10952 @example
10953 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
10954 @end example
10956 @end enumerate
10958 @subsubsection Using third-party styles and templates
10960 You can use third-party styles and templates for customizing your output.
10961 This will produce the desired output only if the template provides all
10962 style names that the @samp{ODT} exporter relies on.  Unless this condition is
10963 met, the output is going to be less than satisfactory.  So it is highly
10964 recommended that you only work with templates that are directly derived from
10965 the factory settings.
10967 @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
10968 @subsection Links in ODT export
10969 @cindex tables, in DocBook export
10971 The ODT exporter creates cross-references (aka bookmarks) for
10972 internal links.  It creates Internet-style links for all other links.
10974 @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
10975 @subsection Tables in ODT export
10976 @cindex tables, in DocBook export
10978 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
10979 tables is supported.  However, export of complex @file{table.el} tables -
10980 tables that have column or row spans - is not supported.  Such tables are
10981 stripped from the exported document.
10983 By default, a table is exported with top and bottom frames and with rules
10984 separating row and column groups (@pxref{Column groups}).  Furthermore, all
10985 tables are typeset to occupy the same width.  If the table specifies
10986 alignment and relative width for its columns (@pxref{Column width and
10987 alignment}) then these are honored on export.@footnote{The column widths are
10988 interpreted as weighted ratios with the default weight being 1}
10990 @cindex #+ATTR_ODT
10991 You can control the width of the table by specifying @code{:rel-width}
10992 property using an @code{#+ATTR_ODT} line.
10994 For example, consider the following table which makes use of all the rules
10995 mentoned above.
10997 @example
10998 #+ATTR_ODT: :rel-width 50
10999 | Area/Month    |   Jan |   Feb |   Mar |   Sum |
11000 |---------------+-------+-------+-------+-------|
11001 | /             |     < |       |       |     < |
11002 | <l13>         |  <r5> |  <r5> |  <r5> |  <r6> |
11003 | North America |     1 |    21 |   926 |   948 |
11004 | Middle East   |     6 |    75 |   844 |   925 |
11005 | Asia Pacific  |     9 |    27 |   790 |   826 |
11006 |---------------+-------+-------+-------+-------|
11007 | Sum           |    16 |   123 |  2560 |  2699 |
11008 @end example
11010 On export, the table will occupy 50% of text area.  The columns will be sized
11011 (roughly) in the ratio of 13:5:5:5:6.  The first column will be left-aligned
11012 and rest of the columns will be right-aligned.  There will be vertical rules
11013 after separating the header and last columns from other columns.  There will
11014 be horizontal rules separating the header and last rows from other rows.
11016 If you are not satisfied with the above formatting options, you can create
11017 custom table styles and associate them with a table using the
11018 @code{#+ATTR_ODT} line.  @xref{Customizing tables in ODT export}.
11020 @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
11021 @subsection Images in ODT export
11022 @cindex images, embedding in ODT
11023 @cindex embedding images in ODT
11025 @subsubheading Embedding images
11026 You can embed images within the exported document by providing a link to the
11027 desired image file with no link description.  For example, to embed
11028 @samp{img.png} do either of the following:
11030 @example
11031 [[file:img.png]]
11032 @end example
11034 @example
11035 [[./img.png]]
11036 @end example
11038 @subsubheading Embedding clickable images
11039 You can create clickable images by providing a link whose description is a
11040 link to an image file.  For example, to embed a image
11041 @file{org-mode-unicorn.png} which when clicked jumps to
11042 @uref{http://Orgmode.org} website, do the following
11044 @example
11045 [[http://orgmode.org][./org-mode-unicorn.png]]
11046 @end example
11048 @subsubheading Sizing and scaling of embedded images
11050 @cindex #+ATTR_ODT
11051 You can control the size and scale of the embedded images using the
11052 @code{#+ATTR_ODT} attribute.
11054 @cindex identify, ImageMagick
11055 @vindex org-export-odt-pixels-per-inch
11056 The exporter specifies the desired size of the image in the final document in
11057 units of centimeters.  In order to scale the embedded images, the exporter
11058 queries for pixel dimensions of the images using one of a) ImageMagick's
11059 @file{identify} program or b) Emacs `create-image' and `image-size'
11060 APIs.@footnote{Use of @file{ImageMagick} is only desirable.  However, if you
11061 routinely produce documents that have large images or you export your Org
11062 files that has images using a Emacs batch script, then the use of
11063 @file{ImageMagick} is mandatory.} The pixel dimensions are subsequently
11064 converted in to units of centimeters using
11065 @code{org-export-odt-pixels-per-inch}.  The default value of this variable is
11066 set to @code{display-pixels-per-inch}.  You can tweak this variable to
11067 achieve the best results.
11069 The examples below illustrate the various possibilities.
11071 @table @asis
11072 @item Explicitly size the image
11073 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
11075 @example
11076 #+ATTR_ODT: :width 10 :height 10
11077 [[./img.png]]
11078 @end example
11080 @item Scale the image
11081 To embed @file{img.png} at half its size, do the following:
11083 @example
11084 #+ATTR_ODT: :scale 0.5
11085 [[./img.png]]
11086 @end example
11088 @item Scale the image to a specific width
11089 To embed @file{img.png} with a width of 10 cm while retaining the original
11090 height:width ratio, do the following:
11092 @example
11093 #+ATTR_ODT: :width 10
11094 [[./img.png]]
11095 @end example
11097 @item Scale the image to a specific height
11098 To embed @file{img.png} with a height of 10 cm while retaining the original
11099 height:width ratio, do the following
11101 @example
11102 #+ATTR_ODT: :height 10
11103 [[./img.png]]
11104 @end example
11105 @end table
11107 @subsubheading Anchoring of images
11109 @cindex #+ATTR_ODT
11110 You can control the manner in which an image is anchored by setting the
11111 @code{:anchor} property of it's @code{#+ATTR_ODT} line.  You can specify one
11112 of the the following three values for the @code{:anchor} property -
11113 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
11115 To create an image that is anchored to a page, do the following:
11116 @example
11117 #+ATTR_ODT: :anchor "page"
11118 [[./img.png]]
11119 @end example
11121 @node Math formatting in ODT export, Literal examples in ODT export, Images in ODT export, OpenDocument Text export
11122 @subsection Math formatting in ODT export
11124 The ODT exporter has special support for handling math.
11126 @menu
11127 * Working with @LaTeX{} math snippets::  How to embed @LaTeX{} math fragments
11128 * Working with MathML or OpenDocument formula files::  How to embed equations in native format
11129 @end menu
11131 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
11132 @subsubsection Working with @LaTeX{} math snippets
11134 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
11135 document in one of the following ways:
11137 @cindex MathML
11138 @enumerate
11139 @item MathML
11141 This option is activated on a per-file basis with
11143 @example
11144 #+OPTIONS: LaTeX:t
11145 @end example
11147 With this option, @LaTeX{} fragments are first converted into MathML
11148 fragments using an external @LaTeX{}-to-MathML converter program.  The
11149 resulting MathML fragments are then embedded as an OpenDocument Formula in
11150 the exported document.
11152 @vindex org-latex-to-mathml-convert-command
11153 @vindex org-latex-to-mathml-jar-file
11155 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
11156 @code{org-latex-to-mathml-convert-command} and
11157 @code{org-latex-to-mathml-jar-file}.
11159 If you prefer to use @file{MathToWeb}@footnote{See
11160 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
11161 converter, you can configure the above variables as shown below.
11163 @lisp
11164 (setq org-latex-to-mathml-convert-command
11165       "java -jar %j -unicode -force -df %o %I"
11166       org-latex-to-mathml-jar-file
11167       "/path/to/mathtoweb.jar")
11168 @end lisp
11170 You can use the following commands to quickly verify the reliability of
11171 the @LaTeX{}-to-MathML converter.
11173 @table @kbd
11175 @item M-x org-export-as-odf
11176 Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file.
11178 @item M-x org-export-as-odf-and-open
11179 Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file and
11180 open the formula file with the system-registered application.
11181 @end table
11183 @cindex dvipng
11184 @item PNG images
11186 This option is activated on a per-file basis with
11188 @example
11189 #+OPTIONS: LaTeX:dvipng
11190 @end example
11192 With this option, @LaTeX{} fragments are processed into PNG images and the
11193 resulting images are embedded in the exported document.  This method requires
11194 that the @file{dvipng} program be available on your system.
11195 @end enumerate
11197 @node Working with MathML or OpenDocument formula files,  , Working with @LaTeX{} math snippets, Math formatting in ODT export
11198 @subsubsection Working with MathML or OpenDocument formula files
11200 For various reasons, you may find embedding @LaTeX{} math snippets in an
11201 ODT document less than reliable.  In that case, you can embed a
11202 math equation by linking to its MathML(@file{.mml}) source or its
11203 OpenDocument formula (@file{.odf}) file as shown below:
11205 @example
11206 [[./equation.mml]]
11207 @end example
11211 @example
11212 [[./equation.odf]]
11213 @end example
11215 @node Literal examples in ODT export, Advanced topics in ODT export, Math formatting in ODT export, OpenDocument Text export
11216 @subsection Literal examples in ODT export
11218 Export of literal examples (@pxref{Literal examples}) with full fontification
11219 is supported.  This feature is enabled by default and is activated
11220 automatically if an enhanced version of @file{htmlfontify.el} is available in
11221 the @code{load-path}.@footnote{The @file{htmlfontify.el} that ships with
11222 standard Emacs <= 24.1 has no support for ODT fontification.  A
11223 copy of the proposed version is available as an attachment to
11224 @url{http://debbugs.gnu.org/cgi/bugreport.cgi?msg=5;filename=htmlfontify.el;att=9;bug=9914,
11225 Emacs Bug #9914}.}
11227 @vindex org-export-odt-fontify-srcblocks
11229 The character styles used for fontification of the literal blocks are
11230 auto-generated by the exporter in conjunction with @file{htmlfontify.el}
11231 library and need not be included in the default @file{styles.xml} file.
11232 These auto-generated styles have the @samp{OrgSrc} prefix and inherit their color
11233 based on the face used by Emacs @code{font-lock} library.
11235 @vindex org-export-odt-create-custom-styles-for-srcblocks
11236 If you prefer to use your own custom styles for fontification and disable
11237 their auto-generation altogether, you can do so by customizing the variable
11238 @code{org-export-odt-create-custom-styles-for-srcblocks}.
11240 You can turn off fontification support for literal examples by customizing
11241 the variable @code{org-export-odt-fontify-srcblocks}.
11244 @node Advanced topics in ODT export,  , Literal examples in ODT export, OpenDocument Text export
11245 @subsection Advanced topics in ODT export
11247 If you rely heavily on ODT export, you may want to exploit the full
11248 set of features that the exporter offers.  This section describes features
11249 that would be of interest to power users.
11251 @menu
11252 * Configuring a document converter::  How to register a document converter
11253 * Working with OpenDocument style files::  Explore the internals
11254 * Creating one-off styles::     How to produce custom highlighting etc
11255 * Customizing tables in ODT export::  How to define and use Table templates
11256 * Validating OpenDocument XML::  How to debug corrupt OpenDocument files
11257 @end menu
11259 @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
11260 @subsubsection Configuring a document converter
11261 @cindex convert
11262 @cindex doc, docx, rtf
11263 @cindex converter
11265 The ODT exporter can work with popular converters with little or no
11266 extra configuration from your side. @xref{Extending ODT export}.
11267 If you are using a converter that is not supported by default or if you would
11268 like to tweak the default converter settings, proceed as below.
11270 @enumerate
11271 @item Register the converter
11273 @vindex org-export-odt-convert-processes
11274 Name your converter and add it to the list of known converters by customizing
11275 the variable @code{org-export-odt-convert-processes}.  Also specify how the
11276 converter can be invoked via command-line to effect the conversion.
11278 @item Configure its capabilities
11279 @vindex org-export-odt-convert-capabilities
11281 @anchor{x-odt-converter-capabilities}
11283 Specify the set of formats the converter can handle by customizing the
11284 variable @code{org-export-odt-convert-capabilities}.  Use the default value
11285 for this variable as a guide for configuring your converter.  As suggested by
11286 the default setting, you can specify the full set of formats supported by the
11287 converter and not limit yourself to specifying formats that are related to
11288 just the OpenDocument Text format.
11290 @item Choose the converter
11292 @vindex org-export-odt-convert-process
11293 Select the newly added converter as the preferred one by customizing the
11294 variable @code{org-export-odt-convert-process}.
11295 @end enumerate
11297 @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
11298 @subsubsection Working with OpenDocument style files
11299 @cindex styles, custom
11300 @cindex template, custom
11302 This section explores the internals of the ODT exporter and the
11303 means by which it produces styled documents.  Read this section if you are
11304 interested in exploring the automatic and custom OpenDocument styles used by
11305 the exporter.
11307 @anchor{x-factory-styles}
11308 @subsubheading Factory styles
11310 The ODT exporter relies on two files for generating its output.
11311 These files are bundled with the distribution under the directory pointed to
11312 by the variable @code{org-odt-styles-dir}.  The two files are:
11314 @itemize
11315 @anchor{x-orgodtstyles-xml}
11316 @item
11317 @file{OrgOdtStyles.xml}
11319 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
11320 document.  This file gets modified for the following purposes:
11321 @enumerate
11323 @item
11324 To control outline numbering based on user settings.
11326 @item
11327 To add styles generated by @file{htmlfontify.el} for fontification of code
11328 blocks.
11329 @end enumerate
11331 @anchor{x-orgodtcontenttemplate-xml}
11332 @item
11333 @file{OrgOdtContentTemplate.xml}
11335 This file contributes to the @file{content.xml} file of the final @samp{ODT}
11336 document.  The contents of the Org outline are inserted between the
11337 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
11339 Apart from serving as a template file for the final @file{content.xml}, the
11340 file serves the following purposes:
11341 @enumerate
11343 @item
11344 It contains automatic styles for formatting of tables which are referenced by
11345 the exporter.
11347 @item
11348 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
11349 elements that control how various entities - tables, images, equations etc -
11350 are numbered.
11351 @end enumerate
11352 @end itemize
11354 @anchor{x-overriding-factory-styles}
11355 @subsubheading Overriding factory styles
11356 The following two variables control the location from which the ODT
11357 exporter picks up the custom styles and content template files.  You can
11358 customize these variables to override the factory styles used by the
11359 exporter.
11361 @itemize
11362 @anchor{x-org-export-odt-styles-file}
11363 @item
11364 @code{org-export-odt-styles-file}
11366 Use this variable to specify the @file{styles.xml} that will be used in the
11367 final output.  You can specify one of the following values:
11369 @enumerate
11370 @item A @file{styles.xml} file
11372 Use this file instead of the default @file{styles.xml}
11374 @item A @file{.odt} or @file{.ott} file
11376 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11377 Template file
11379 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
11381 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11382 Template file.  Additionally extract the specified member files and embed
11383 those within the final @samp{ODT} document.
11385 Use this option if the @file{styles.xml} file references additional files
11386 like header and footer images.
11388 @item @code{nil}
11390 Use the default @file{styles.xml}
11391 @end enumerate
11393 @anchor{x-org-export-odt-content-template-file}
11394 @item
11395 @code{org-export-odt-content-template-file}
11397 Use this variable to specify the blank @file{content.xml} that will be used
11398 in the final output.
11399 @end itemize
11401 @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
11402 @subsubsection Creating one-off styles
11404 There are times when you would want one-off formatting in the exported
11405 document.  You can achieve this by embedding raw OpenDocument XML in the Org
11406 file.  The use of this feature is better illustrated with couple of examples.
11408 @enumerate
11409 @item Embedding ODT tags as part of regular text
11411 You can include simple OpenDocument tags by prefixing them with
11412 @samp{@@}.  For example, to highlight a region of text do the following:
11414 @example
11415 @@<text:span text:style-name="Highlight">This is a
11416 highlighted text@@</text:span>.  But this is a
11417 regular text.
11418 @end example
11420 @strong{Hint:} To see the above example in action, edit your
11421 @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11422 custom @samp{Highlight} style as shown below.
11424 @example
11425 <style:style style:name="Highlight" style:family="text">
11426   <style:text-properties fo:background-color="#ff0000"/>
11427 </style:style>
11428 @end example
11430 @item Embedding a one-line OpenDocument XML
11432 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
11433 directive.  For example, to force a page break do the following:
11435 @example
11436 #+ODT: <text:p text:style-name="PageBreak"/>
11437 @end example
11439 @strong{Hint:} To see the above example in action, edit your
11440 @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11441 custom @samp{PageBreak} style as shown below.
11443 @example
11444 <style:style style:name="PageBreak" style:family="paragraph"
11445              style:parent-style-name="Text_20_body">
11446   <style:paragraph-properties fo:break-before="page"/>
11447 </style:style>
11448 @end example
11450 @item Embedding a block of OpenDocument XML
11452 You can add a large block of OpenDocument XML using the
11453 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
11455 For example, to create a one-off paragraph that uses bold text, do the
11456 following:
11458 @example
11459 #+BEGIN_ODT
11460 <text:p text:style-name="Text_20_body_20_bold">
11461 This paragraph is specially formatted and uses bold text.
11462 </text:p>
11463 #+END_ODT
11464 @end example
11466 @end enumerate
11468 @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
11469 @subsubsection Customizing tables in ODT export
11470 @cindex tables, in ODT export
11472 @cindex #+ATTR_ODT
11473 You can override the default formatting of the table by specifying a custom
11474 table style with the @code{#+ATTR_ODT} line.  For a discussion on default
11475 formatting of tables @pxref{Tables in ODT export}.
11477 This feature closely mimics the way table templates are defined in the
11478 OpenDocument-v1.2
11479 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11480 OpenDocument-v1.2 Specification}}
11484 @subsubheading Custom table styles - an illustration
11486 To have a quick preview of this feature, install the below setting and export
11487 the table that follows.
11489 @lisp
11490 (setq org-export-odt-table-styles
11491       (append org-export-odt-table-styles
11492               '(("TableWithHeaderRowAndColumn" "Custom"
11493                  ((use-first-row-styles . t)
11494                   (use-first-column-styles . t)))
11495                 ("TableWithFirstRowandLastRow" "Custom"
11496                  ((use-first-row-styles . t)
11497                   (use-last-row-styles . t))))))
11498 @end lisp
11500 @example
11501 #+ATTR_ODT: TableWithHeaderRowAndColumn
11502 | Name  | Phone | Age |
11503 | Peter |  1234 |  17 |
11504 | Anna  |  4321 |  25 |
11505 @end example
11507 In the above example, you used a template named @samp{Custom} and installed
11508 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
11509 @samp{TableWithFirstRowandLastRow}.  (@strong{Important:} The OpenDocument
11510 styles needed for producing the above template have been pre-defined for you.
11511 These styles are available under the section marked @samp{Custom Table
11512 Template} in @file{OrgOdtContentTemplate.xml}
11513 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}).  If you need
11514 additional templates you have to define these styles yourselves.
11516 @subsubheading Custom table styles - the nitty-gritty
11517 To use this feature proceed as follows:
11519 @enumerate
11520 @item
11521 Create a table template@footnote{See the @code{<table:table-template>}
11522 element of the OpenDocument-v1.2 specification}
11524 A table template is nothing but a set of @samp{table-cell} and
11525 @samp{paragraph} styles for each of the following table cell categories:
11527 @itemize @minus
11528 @item Body
11529 @item First column
11530 @item Last column
11531 @item First row
11532 @item Last row
11533 @item Even row
11534 @item Odd row
11535 @item Even column
11536 @item Odd Column
11537 @end itemize
11539 The names for the above styles must be chosen based on the name of the table
11540 template using a well-defined convention.
11542 The naming convention is better illustrated with an example.  For a table
11543 template with the name @samp{Custom}, the needed style names are listed in
11544 the following table.
11546 @multitable  {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
11547 @headitem Table cell type
11548 @tab @code{table-cell} style
11549 @tab @code{paragraph} style
11550 @item
11551 @tab
11552 @tab
11553 @item Body
11554 @tab @samp{CustomTableCell}
11555 @tab @samp{CustomTableParagraph}
11556 @item First column
11557 @tab @samp{CustomFirstColumnTableCell}
11558 @tab @samp{CustomFirstColumnTableParagraph}
11559 @item Last column
11560 @tab @samp{CustomLastColumnTableCell}
11561 @tab @samp{CustomLastColumnTableParagraph}
11562 @item First row
11563 @tab @samp{CustomFirstRowTableCell}
11564 @tab @samp{CustomFirstRowTableParagraph}
11565 @item Last row
11566 @tab @samp{CustomLastRowTableCell}
11567 @tab @samp{CustomLastRowTableParagraph}
11568 @item Even row
11569 @tab @samp{CustomEvenRowTableCell}
11570 @tab @samp{CustomEvenRowTableParagraph}
11571 @item Odd row
11572 @tab @samp{CustomOddRowTableCell}
11573 @tab @samp{CustomOddRowTableParagraph}
11574 @item Even column
11575 @tab @samp{CustomEvenColumnTableCell}
11576 @tab @samp{CustomEvenColumnTableParagraph}
11577 @item Odd column
11578 @tab @samp{CustomOddColumnTableCell}
11579 @tab @samp{CustomOddColumnTableParagraph}
11580 @end multitable
11582 To create a table template with the name @samp{Custom}, define the above
11583 styles in the
11584 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
11585 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
11586 styles}).
11588 @item
11589 Define a table style@footnote{See the attributes @code{table:template-name},
11590 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
11591 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
11592 @code{table:use-banding-rows-styles}, and
11593 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
11594 the OpenDocument-v1.2 specification}
11596 @vindex org-export-odt-table-styles
11597 To define a table style, create an entry for the style in the variable
11598 @code{org-export-odt-table-styles} and specify the following:
11600 @itemize @minus
11601 @item the name of the table template created in step (1)
11602 @item the set of cell styles in that template that are to be activated
11603 @end itemize
11605 For example, the entry below defines two different table styles
11606 @samp{TableWithHeaderRowsAndColumns} and @samp{TableWithHeaderColumns} based
11607 on the same template @samp{Custom}.  The styles achieve their intended effect
11608 by selectively activating the individual cell styles in that template.
11610 @lisp
11611 (setq org-export-odt-table-styles
11612       (append org-export-odt-table-styles
11613               '(("TableWithHeaderRowAndColumn" "Custom"
11614                  ((use-first-row-styles . t)
11615                   (use-first-column-styles . t)))
11616                 ("TableWithFirstRowandLastRow" "Custom"
11617                  ((use-first-row-styles . t)
11618                   (use-last-row-styles . t))))))
11619 @end lisp
11621 @item
11622 Associate a table with the table style
11624 To do this, specify the table style created in step (2) as part of
11625 the @code{ATTR_ODT} line as shown below.
11627 @example
11628 #+ATTR_ODT: TableWithHeaderRowAndColumn
11629 | Name  | Phone | Age |
11630 | Peter |  1234 |  17 |
11631 | Anna  |  4321 |  25 |
11632 @end example
11633 @end enumerate
11635 @node Validating OpenDocument XML,  , Customizing tables in ODT export, Advanced topics in ODT export
11636 @subsubsection Validating OpenDocument XML
11638 Occasionally, you will discover that the document created by the
11639 ODT exporter cannot be opened by your favorite application.  One of
11640 the common reasons for this is that the @file{.odt} file is corrupt.  In such
11641 cases, you may want to validate the document against the OpenDocument RELAX
11642 NG Compact Syntax (RNC) schema.
11644 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
11645 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}.  For
11646 general help with validation (and schema-sensitive editing) of XML files:
11647 @inforef{Introduction,,nxml-mode}.
11649 @vindex org-export-odt-schema-dir
11650 If you have ready access to OpenDocument @file{.rnc} files and the needed
11651 schema-locating rules in a single folder, you can customize the variable
11652 @code{org-export-odt-schema-dir} to point to that directory.  The
11653 ODT exporter will take care of updating the
11654 @code{rng-schema-locating-files} for you.
11656 @c end opendocument
11658 @node  TaskJuggler export, Freemind export, OpenDocument Text export, Exporting
11659 @section TaskJuggler export
11660 @cindex TaskJuggler export
11661 @cindex Project management
11663 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
11664 It provides an optimizing scheduler that computes your project time lines and
11665 resource assignments based on the project outline and the constraints that
11666 you have provided.
11668 The TaskJuggler exporter is a bit different from other exporters, such as the
11669 @code{HTML} and @LaTeX{} exporters for example, in that it does not export all the
11670 nodes of a document or strictly follow the order of the nodes in the
11671 document.
11673 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
11674 a optionally tree that defines the resources for this project.  It then
11675 creates a TaskJuggler file based on these trees and the attributes defined in
11676 all the nodes.
11678 @subsection TaskJuggler export commands
11680 @table @kbd
11681 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
11682 Export as TaskJuggler file.
11684 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
11685 Export as TaskJuggler file and then open the file with TaskJugglerUI.
11686 @end table
11688 @subsection Tasks
11690 @vindex org-export-taskjuggler-project-tag
11691 Create your tasks as you usually do with Org mode.  Assign efforts to each
11692 task using properties (it is easiest to do this in the column view).  You
11693 should end up with something similar to the example by Peter Jones in
11694 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
11695 Now mark the top node of your tasks with a tag named
11696 @code{:taskjuggler_project:} (or whatever you customized
11697 @code{org-export-taskjuggler-project-tag} to).  You are now ready to export
11698 the project plan with @kbd{C-c C-e J} which will export the project plan and
11699 open a gantt chart in TaskJugglerUI.
11701 @subsection Resources
11703 @vindex org-export-taskjuggler-resource-tag
11704 Next you can define resources and assign those to work on specific tasks.  You
11705 can group your resources hierarchically.  Tag the top node of the resources
11706 with @code{:taskjuggler_resource:} (or whatever you customized
11707 @code{org-export-taskjuggler-resource-tag} to).  You can optionally assign an
11708 identifier (named @samp{resource_id}) to the resources (using the standard
11709 Org properties commands, @pxref{Property syntax}) or you can let the exporter
11710 generate identifiers automatically (the exporter picks the first word of the
11711 headline as the identifier as long as it is unique---see the documentation of
11712 @code{org-taskjuggler-get-unique-id}).  Using that identifier you can then
11713 allocate resources to tasks.  This is again done with the @samp{allocate}
11714 property on the tasks.  Do this in column view or when on the task type
11715 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
11717 Once the allocations are done you can again export to TaskJuggler and check
11718 in the Resource Allocation Graph which person is working on what task at what
11719 time.
11721 @subsection Export of properties
11723 The exporter also takes TODO state information into consideration, i.e.@: if a
11724 task is marked as done it will have the corresponding attribute in
11725 TaskJuggler (@samp{complete 100}).  Also it will export any property on a task
11726 resource or resource node which is known to TaskJuggler, such as
11727 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
11728 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
11729 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
11730 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
11731 @samp{scheduling}, etc for tasks.
11733 @subsection Dependencies
11735 The exporter will handle dependencies that are defined in the tasks either
11736 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
11737 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
11738 @samp{depends} attribute.  Both the @samp{BLOCKER} and the @samp{depends}
11739 attribute can be either @samp{previous-sibling} or a reference to an
11740 identifier (named @samp{task_id}) which is defined for another task in the
11741 project.  @samp{BLOCKER} and the @samp{depends} attribute can define multiple
11742 dependencies separated by either space or comma.  You can also specify
11743 optional attributes on the dependency by simply appending it.  The following
11744 examples should illustrate this:
11746 @example
11747 * Preparation
11748   :PROPERTIES:
11749   :task_id:  preparation
11750   :ORDERED:  t
11751   :END:
11752 * Training material
11753   :PROPERTIES:
11754   :task_id:  training_material
11755   :ORDERED:  t
11756   :END:
11757 ** Markup Guidelines
11758    :PROPERTIES:
11759    :Effort:   2d
11760    :END:
11761 ** Workflow Guidelines
11762    :PROPERTIES:
11763    :Effort:   2d
11764    :END:
11765 * Presentation
11766   :PROPERTIES:
11767   :Effort:   2d
11768   :BLOCKER:  training_material @{ gapduration 1d @} preparation
11769   :END:
11770 @end example
11772 @subsection Reports
11774 @vindex org-export-taskjuggler-default-reports
11775 TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
11776 allocation, etc).  The user defines what kind of reports should be generated
11777 for a project in the TaskJuggler file.  The exporter will automatically insert
11778 some default reports in the file.  These defaults are defined in
11779 @code{org-export-taskjuggler-default-reports}.  They can be modified using
11780 customize along with a number of other options.  For a more complete list, see
11781 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
11783 For more information and examples see the Org-taskjuggler tutorial at
11784 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
11786 @node Freemind export, XOXO export, TaskJuggler export, Exporting
11787 @section Freemind export
11788 @cindex Freemind export
11789 @cindex mind map
11791 The Freemind exporter was written by Lennart Borgman.
11793 @table @kbd
11794 @orgcmd{C-c C-e m,org-export-as-freemind}
11795 Export as Freemind mind map.  For an Org file @file{myfile.org}, the Freemind
11796 file will be @file{myfile.mm}.
11797 @end table
11799 @node XOXO export, iCalendar export, Freemind export, Exporting
11800 @section XOXO export
11801 @cindex XOXO export
11803 Org mode contains an exporter that produces XOXO-style output.
11804 Currently, this exporter only handles the general outline structure and
11805 does not interpret any additional Org mode features.
11807 @table @kbd
11808 @orgcmd{C-c C-e x,org-export-as-xoxo}
11809 Export as XOXO file.  For an Org file @file{myfile.org}, the XOXO file will be
11810 @file{myfile.html}.
11811 @orgkey{C-c C-e v x}
11812 Export only the visible part of the document.
11813 @end table
11815 @node iCalendar export,  , XOXO export, Exporting
11816 @section iCalendar export
11817 @cindex iCalendar export
11819 @vindex org-icalendar-include-todo
11820 @vindex org-icalendar-use-deadline
11821 @vindex org-icalendar-use-scheduled
11822 @vindex org-icalendar-categories
11823 @vindex org-icalendar-alarm-time
11824 Some people use Org mode for keeping track of projects, but still prefer a
11825 standard calendar application for anniversaries and appointments.  In this
11826 case it can be useful to show deadlines and other time-stamped items in Org
11827 files in the calendar application.  Org mode can export calendar information
11828 in the standard iCalendar format.  If you also want to have TODO entries
11829 included in the export, configure the variable
11830 @code{org-icalendar-include-todo}.  Plain timestamps are exported as VEVENT,
11831 and TODO items as VTODO.  It will also create events from deadlines that are
11832 in non-TODO items.  Deadlines and scheduling dates in TODO items will be used
11833 to set the start and due dates for the TODO entry@footnote{See the variables
11834 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
11835 As categories, it will use the tags locally defined in the heading, and the
11836 file/tree category@footnote{To add inherited tags or the TODO state,
11837 configure the variable @code{org-icalendar-categories}.}.  See the variable
11838 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
11839 time.
11841 @vindex org-icalendar-store-UID
11842 @cindex property, ID
11843 The iCalendar standard requires each entry to have a globally unique
11844 identifier (UID).  Org creates these identifiers during export.  If you set
11845 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
11846 @code{:ID:} property of the entry and re-used next time you report this
11847 entry.  Since a single entry can give rise to multiple iCalendar entries (as
11848 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
11849 prefixes to the UID, depending on what triggered the inclusion of the entry.
11850 In this way the UID remains unique, but a synchronization program can still
11851 figure out from which entry all the different instances originate.
11853 @table @kbd
11854 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
11855 Create iCalendar entries for the current file and store them in the same
11856 directory, using a file extension @file{.ics}.
11857 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
11858 @vindex org-agenda-files
11859 Like @kbd{C-c C-e i}, but do this for all files in
11860 @code{org-agenda-files}.  For each of these files, a separate iCalendar
11861 file will be written.
11862 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
11863 @vindex org-combined-agenda-icalendar-file
11864 Create a single large iCalendar file from all files in
11865 @code{org-agenda-files} and write it to the file given by
11866 @code{org-combined-agenda-icalendar-file}.
11867 @end table
11869 @vindex org-use-property-inheritance
11870 @vindex org-icalendar-include-body
11871 @cindex property, SUMMARY
11872 @cindex property, DESCRIPTION
11873 @cindex property, LOCATION
11874 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
11875 property can be inherited from higher in the hierarchy if you configure
11876 @code{org-use-property-inheritance} accordingly.} properties if the selected
11877 entries have them.  If not, the summary will be derived from the headline,
11878 and the description from the body (limited to
11879 @code{org-icalendar-include-body} characters).
11881 How this calendar is best read and updated, depends on the application
11882 you are using.  The FAQ covers this issue.
11884 @node Publishing, Working With Source Code, Exporting, Top
11885 @chapter Publishing
11886 @cindex publishing
11888 Org includes a publishing management system that allows you to configure
11889 automatic HTML conversion of @emph{projects} composed of interlinked org
11890 files.  You can also configure Org to automatically upload your exported HTML
11891 pages and related attachments, such as images and source code files, to a web
11892 server.
11894 You can also use Org to convert files into PDF, or even combine HTML and PDF
11895 conversion so that files are available in both formats on the server.
11897 Publishing has been contributed to Org by David O'Toole.
11899 @menu
11900 * Configuration::               Defining projects
11901 * Uploading files::             How to get files up on the server
11902 * Sample configuration::        Example projects
11903 * Triggering publication::      Publication commands
11904 @end menu
11906 @node Configuration, Uploading files, Publishing, Publishing
11907 @section Configuration
11909 Publishing needs significant configuration to specify files, destination
11910 and many other properties of a project.
11912 @menu
11913 * Project alist::               The central configuration variable
11914 * Sources and destinations::    From here to there
11915 * Selecting files::             What files are part of the project?
11916 * Publishing action::           Setting the function doing the publishing
11917 * Publishing options::          Tweaking HTML/@LaTeX{} export
11918 * Publishing links::            Which links keep working after publishing?
11919 * Sitemap::                     Generating a list of all pages
11920 * Generating an index::         An index that reaches across pages
11921 @end menu
11923 @node Project alist, Sources and destinations, Configuration, Configuration
11924 @subsection The variable @code{org-publish-project-alist}
11925 @cindex org-publish-project-alist
11926 @cindex projects, for publishing
11928 @vindex org-publish-project-alist
11929 Publishing is configured almost entirely through setting the value of one
11930 variable, called @code{org-publish-project-alist}.  Each element of the list
11931 configures one project, and may be in one of the two following forms:
11933 @lisp
11934    ("project-name" :property value :property value ...)
11935      @r{i.e.@: a well-formed property list with alternating keys and values}
11936 @r{or}
11937    ("project-name" :components ("project-name" "project-name" ...))
11939 @end lisp
11941 In both cases, projects are configured by specifying property values.  A
11942 project defines the set of files that will be published, as well as the
11943 publishing configuration to use when publishing those files.  When a project
11944 takes the second form listed above, the individual members of the
11945 @code{:components} property are taken to be sub-projects, which group
11946 together files requiring different publishing options.  When you publish such
11947 a ``meta-project'', all the components will also be published, in the
11948 sequence given.
11950 @node Sources and destinations, Selecting files, Project alist, Configuration
11951 @subsection Sources and destinations for files
11952 @cindex directories, for publishing
11954 Most properties are optional, but some should always be set.  In
11955 particular, Org needs to know where to look for source files,
11956 and where to put published files.
11958 @multitable @columnfractions 0.3 0.7
11959 @item @code{:base-directory}
11960 @tab Directory containing publishing source files
11961 @item @code{:publishing-directory}
11962 @tab Directory where output files will be published.  You can directly
11963 publish to a webserver using a file name syntax appropriate for
11964 the Emacs @file{tramp} package.  Or you can publish to a local directory and
11965 use external tools to upload your website (@pxref{Uploading files}).
11966 @item @code{:preparation-function}
11967 @tab Function or list of functions to be called before starting the
11968 publishing process, for example, to run @code{make} for updating files to be
11969 published.  The project property list is scoped into this call as the
11970 variable @code{project-plist}.
11971 @item @code{:completion-function}
11972 @tab Function or list of functions called after finishing the publishing
11973 process, for example, to change permissions of the resulting files.  The
11974 project property list is scoped into this call as the variable
11975 @code{project-plist}.
11976 @end multitable
11977 @noindent
11979 @node Selecting files, Publishing action, Sources and destinations, Configuration
11980 @subsection Selecting files
11981 @cindex files, selecting for publishing
11983 By default, all files with extension @file{.org} in the base directory
11984 are considered part of the project.  This can be modified by setting the
11985 properties
11986 @multitable @columnfractions 0.25 0.75
11987 @item @code{:base-extension}
11988 @tab Extension (without the dot!) of source files.  This actually is a
11989 regular expression.  Set this to the symbol @code{any} if you want to get all
11990 files in @code{:base-directory}, even without extension.
11992 @item @code{:exclude}
11993 @tab Regular expression to match file names that should not be
11994 published, even though they have been selected on the basis of their
11995 extension.
11997 @item @code{:include}
11998 @tab List of files to be included regardless of @code{:base-extension}
11999 and @code{:exclude}.
12001 @item @code{:recursive}
12002 @tab Non-nil means, check base-directory recursively for files to publish.
12003 @end multitable
12005 @node Publishing action, Publishing options, Selecting files, Configuration
12006 @subsection Publishing action
12007 @cindex action, for publishing
12009 Publishing means that a file is copied to the destination directory and
12010 possibly transformed in the process.  The default transformation is to export
12011 Org files as HTML files, and this is done by the function
12012 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
12013 export}).  But you also can publish your content as PDF files using
12014 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
12015 @code{utf8} encoded files using the corresponding functions.  If you want to
12016 publish the Org file itself, but with @i{archived}, @i{commented}, and
12017 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
12018 parameters @code{:plain-source} and/or @code{:htmlized-source}.  This will
12019 produce @file{file.org} and @file{file.org.html} in the publishing
12020 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
12021 source and publishing directories are equal.  Note that with this kind of
12022 setup, you need to add @code{:exclude "-source\\.org"} to the project
12023 definition in @code{org-publish-project-alist} to prevent the published
12024 source files from being considered as new org files the next time the project
12025 is published.}.  Other files like images only need to be copied to the
12026 publishing destination; for this you may use @code{org-publish-attachment}.
12027 For non-Org files, you always need to specify the publishing function:
12029 @multitable @columnfractions 0.3 0.7
12030 @item @code{:publishing-function}
12031 @tab Function executing the publication of a file.  This may also be a
12032 list of functions, which will all be called in turn.
12033 @item @code{:plain-source}
12034 @tab Non-nil means, publish plain source.
12035 @item @code{:htmlized-source}
12036 @tab Non-nil means, publish htmlized source.
12037 @end multitable
12039 The function must accept three arguments: a property list containing at least
12040 a @code{:publishing-directory} property, the name of the file to be
12041 published, and the path to the publishing directory of the output file.  It
12042 should take the specified file, make the necessary transformation (if any)
12043 and place the result into the destination folder.
12045 @node Publishing options, Publishing links, Publishing action, Configuration
12046 @subsection Options for the HTML/@LaTeX{} exporters
12047 @cindex options, for publishing
12049 The property list can be used to set many export options for the HTML
12050 and @LaTeX{} exporters.  In most cases, these properties correspond to user
12051 variables in Org.  The table below lists these properties along
12052 with the variable they belong to.  See the documentation string for the
12053 respective variable for details.
12055 @vindex org-export-html-link-up
12056 @vindex org-export-html-link-home
12057 @vindex org-export-default-language
12058 @vindex org-display-custom-times
12059 @vindex org-export-headline-levels
12060 @vindex org-export-with-section-numbers
12061 @vindex org-export-section-number-format
12062 @vindex org-export-with-toc
12063 @vindex org-export-preserve-breaks
12064 @vindex org-export-with-archived-trees
12065 @vindex org-export-with-emphasize
12066 @vindex org-export-with-sub-superscripts
12067 @vindex org-export-with-special-strings
12068 @vindex org-export-with-footnotes
12069 @vindex org-export-with-drawers
12070 @vindex org-export-with-tags
12071 @vindex org-export-with-todo-keywords
12072 @vindex org-export-with-tasks
12073 @vindex org-export-with-done-tasks
12074 @vindex org-export-with-priority
12075 @vindex org-export-with-TeX-macros
12076 @vindex org-export-with-LaTeX-fragments
12077 @vindex org-export-skip-text-before-1st-heading
12078 @vindex org-export-with-fixed-width
12079 @vindex org-export-with-timestamps
12080 @vindex org-export-author-info
12081 @vindex org-export-email-info
12082 @vindex org-export-creator-info
12083 @vindex org-export-time-stamp-file
12084 @vindex org-export-with-tables
12085 @vindex org-export-highlight-first-table-line
12086 @vindex org-export-html-style-include-default
12087 @vindex org-export-html-style-include-scripts
12088 @vindex org-export-html-style
12089 @vindex org-export-html-style-extra
12090 @vindex org-export-html-link-org-files-as-html
12091 @vindex org-export-html-inline-images
12092 @vindex org-export-html-extension
12093 @vindex org-export-html-table-tag
12094 @vindex org-export-html-expand
12095 @vindex org-export-html-with-timestamp
12096 @vindex org-export-publishing-directory
12097 @vindex org-export-html-preamble
12098 @vindex org-export-html-postamble
12099 @vindex user-full-name
12100 @vindex user-mail-address
12101 @vindex org-export-select-tags
12102 @vindex org-export-exclude-tags
12104 @multitable @columnfractions 0.32 0.68
12105 @item @code{:link-up}               @tab @code{org-export-html-link-up}
12106 @item @code{:link-home}             @tab @code{org-export-html-link-home}
12107 @item @code{:language}              @tab @code{org-export-default-language}
12108 @item @code{:customtime}            @tab @code{org-display-custom-times}
12109 @item @code{:headline-levels}       @tab @code{org-export-headline-levels}
12110 @item @code{:section-numbers}       @tab @code{org-export-with-section-numbers}
12111 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
12112 @item @code{:table-of-contents}     @tab @code{org-export-with-toc}
12113 @item @code{:preserve-breaks}       @tab @code{org-export-preserve-breaks}
12114 @item @code{:archived-trees}        @tab @code{org-export-with-archived-trees}
12115 @item @code{:emphasize}             @tab @code{org-export-with-emphasize}
12116 @item @code{:sub-superscript}       @tab @code{org-export-with-sub-superscripts}
12117 @item @code{:special-strings}       @tab @code{org-export-with-special-strings}
12118 @item @code{:footnotes}             @tab @code{org-export-with-footnotes}
12119 @item @code{:drawers}               @tab @code{org-export-with-drawers}
12120 @item @code{:tags}                  @tab @code{org-export-with-tags}
12121 @item @code{:todo-keywords}         @tab @code{org-export-with-todo-keywords}
12122 @item @code{:tasks}                 @tab @code{org-export-with-tasks}
12123 @item @code{:priority}              @tab @code{org-export-with-priority}
12124 @item @code{:TeX-macros}            @tab @code{org-export-with-TeX-macros}
12125 @item @code{:LaTeX-fragments}       @tab @code{org-export-with-LaTeX-fragments}
12126 @item @code{:latex-listings}        @tab @code{org-export-latex-listings}
12127 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
12128 @item @code{:fixed-width}           @tab @code{org-export-with-fixed-width}
12129 @item @code{:timestamps}            @tab @code{org-export-with-timestamps}
12130 @item @code{:author}                @tab @code{user-full-name}
12131 @item @code{:email}                 @tab @code{user-mail-address} : @code{addr;addr;..}
12132 @item @code{:author-info}           @tab @code{org-export-author-info}
12133 @item @code{:email-info}            @tab @code{org-export-email-info}
12134 @item @code{:creator-info}          @tab @code{org-export-creator-info}
12135 @item @code{:tables}                @tab @code{org-export-with-tables}
12136 @item @code{:table-auto-headline}   @tab @code{org-export-highlight-first-table-line}
12137 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
12138 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
12139 @item @code{:style}                 @tab @code{org-export-html-style}
12140 @item @code{:style-extra}           @tab @code{org-export-html-style-extra}
12141 @item @code{:convert-org-links}     @tab @code{org-export-html-link-org-files-as-html}
12142 @item @code{:inline-images}         @tab @code{org-export-html-inline-images}
12143 @item @code{:html-extension}        @tab @code{org-export-html-extension}
12144 @item @code{:html-preamble}         @tab @code{org-export-html-preamble}
12145 @item @code{:html-postamble}        @tab @code{org-export-html-postamble}
12146 @item @code{:xml-declaration}       @tab @code{org-export-html-xml-declaration}
12147 @item @code{:html-table-tag}        @tab @code{org-export-html-table-tag}
12148 @item @code{:expand-quoted-html}    @tab @code{org-export-html-expand}
12149 @item @code{:timestamp}             @tab @code{org-export-html-with-timestamp}
12150 @item @code{:publishing-directory}  @tab @code{org-export-publishing-directory}
12151 @item @code{:select-tags}           @tab @code{org-export-select-tags}
12152 @item @code{:exclude-tags}          @tab @code{org-export-exclude-tags}
12153 @item @code{:latex-image-options}   @tab @code{org-export-latex-image-default-option}
12154 @end multitable
12156 Most of the @code{org-export-with-*} variables have the same effect in
12157 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
12158 @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
12159 @LaTeX{} export.  See @code{org-export-plist-vars} to check this list of
12160 options.
12164 @vindex org-publish-project-alist
12165 When a property is given a value in @code{org-publish-project-alist},
12166 its setting overrides the value of the corresponding user variable (if
12167 any) during publishing.  Options set within a file (@pxref{Export
12168 options}), however, override everything.
12170 @node Publishing links, Sitemap, Publishing options, Configuration
12171 @subsection Links between published files
12172 @cindex links, publishing
12174 To create a link from one Org file to another, you would use
12175 something like @samp{[[file:foo.org][The foo]]} or simply
12176 @samp{file:foo.org.} (@pxref{Hyperlinks}).  When published, this link
12177 becomes a link to @file{foo.html}.  In this way, you can interlink the
12178 pages of your "org web" project and the links will work as expected when
12179 you publish them to HTML.  If you also publish the Org source file and want
12180 to link to that, use an @code{http:} link instead of a @code{file:} link,
12181 because @code{file:} links are converted to link to the corresponding
12182 @file{html} file.
12184 You may also link to related files, such as images.  Provided you are careful
12185 with relative file names, and provided you have also configured Org to upload
12186 the related files, these links will work too.  See @ref{Complex example}, for
12187 an example of this usage.
12189 Sometimes an Org file to be published may contain links that are
12190 only valid in your production environment, but not in the publishing
12191 location.  In this case, use the property
12193 @multitable @columnfractions 0.4 0.6
12194 @item @code{:link-validation-function}
12195 @tab Function to validate links
12196 @end multitable
12198 @noindent
12199 to define a function for checking link validity.  This function must
12200 accept two arguments, the file name and a directory relative to which
12201 the file name is interpreted in the production environment.  If this
12202 function returns @code{nil}, then the HTML generator will only insert a
12203 description into the HTML file, but no link.  One option for this
12204 function is @code{org-publish-validate-link} which checks if the given
12205 file is part of any project in @code{org-publish-project-alist}.
12207 @node Sitemap, Generating an index, Publishing links, Configuration
12208 @subsection Generating a sitemap
12209 @cindex sitemap, of published pages
12211 The following properties may be used to control publishing of
12212 a map of files for a given project.
12214 @multitable @columnfractions 0.35 0.65
12215 @item @code{:auto-sitemap}
12216 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
12217 or @code{org-publish-all}.
12219 @item @code{:sitemap-filename}
12220 @tab Filename for output of sitemap.  Defaults to @file{sitemap.org} (which
12221 becomes @file{sitemap.html}).
12223 @item @code{:sitemap-title}
12224 @tab Title of sitemap page.  Defaults to name of file.
12226 @item @code{:sitemap-function}
12227 @tab Plug-in function to use for generation of the sitemap.
12228 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
12229 of links to all files in the project.
12231 @item @code{:sitemap-sort-folders}
12232 @tab Where folders should appear in the sitemap.  Set this to @code{first}
12233 (default) or @code{last} to display folders first or last,
12234 respectively.  Any other value will mix files and folders.
12236 @item @code{:sitemap-sort-files}
12237 @tab How the files are sorted in the site map.  Set this to
12238 @code{alphabetically} (default), @code{chronologically} or
12239 @code{anti-chronologically}.  @code{chronologically} sorts the files with
12240 older date first while @code{anti-chronologically} sorts the files with newer
12241 date first.  @code{alphabetically} sorts the files alphabetically.  The date of
12242 a file is retrieved with @code{org-publish-find-date}.
12244 @item @code{:sitemap-ignore-case}
12245 @tab Should sorting be case-sensitive?  Default @code{nil}.
12247 @item @code{:sitemap-file-entry-format}
12248 @tab With this option one can tell how a sitemap's entry is formatted in the
12249 sitemap.  This is a format string with some escape sequences: @code{%t} stands
12250 for the title of the file, @code{%a} stands for the author of the file and
12251 @code{%d} stands for the date of the file.  The date is retrieved with the
12252 @code{org-publish-find-date} function and formatted with
12253 @code{org-publish-sitemap-date-format}.  Default @code{%t}.
12255 @item @code{:sitemap-date-format}
12256 @tab Format string for the @code{format-time-string} function that tells how
12257 a sitemap entry's date is to be formatted.  This property bypasses
12258 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
12260 @item @code{:sitemap-sans-extension}
12261 @tab When non-nil, remove filenames' extensions from the generated sitemap.
12262 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
12263 Defaults to @code{nil}.
12265 @end multitable
12267 @node Generating an index,  , Sitemap, Configuration
12268 @subsection Generating an index
12269 @cindex index, in a publishing project
12271 Org mode can generate an index across the files of a publishing project.
12273 @multitable @columnfractions 0.25 0.75
12274 @item @code{:makeindex}
12275 @tab When non-nil, generate in index in the file @file{theindex.org} and
12276 publish it as @file{theindex.html}.
12277 @end multitable
12279 The file will be created when first publishing a project with the
12280 @code{:makeindex} set.  The file only contains a statement @code{#+include:
12281 "theindex.inc"}.  You can then build around this include statement by adding
12282 a title, style information, etc.
12284 @node Uploading files, Sample configuration, Configuration, Publishing
12285 @section Uploading files
12286 @cindex rsync
12287 @cindex unison
12289 For those people already utilizing third party sync tools such as
12290 @command{rsync} or @command{unison}, it might be preferable not to use the built in
12291 @i{remote} publishing facilities of Org mode which rely heavily on
12292 Tramp.  Tramp, while very useful and powerful, tends not to be
12293 so efficient for multiple file transfer and has been known to cause problems
12294 under heavy usage.
12296 Specialized synchronization utilities offer several advantages.  In addition
12297 to timestamp comparison, they also do content and permissions/attribute
12298 checks.  For this reason you might prefer to publish your web to a local
12299 directory (possibly even @i{in place} with your Org files) and then use
12300 @file{unison} or @file{rsync} to do the synchronization with the remote host.
12302 Since Unison (for example) can be configured as to which files to transfer to
12303 a certain remote destination, it can greatly simplify the project publishing
12304 definition.  Simply keep all files in the correct location, process your Org
12305 files with @code{org-publish} and let the synchronization tool do the rest.
12306 You do not need, in this scenario, to include attachments such as @file{jpg},
12307 @file{css} or @file{gif} files in the project definition since the 3rd party
12308 tool syncs them.
12310 Publishing to a local directory is also much faster than to a remote one, so
12311 that you can afford more easily to republish entire projects.  If you set
12312 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
12313 benefit of re-including any changed external files such as source example
12314 files you might include with @code{#+INCLUDE}.  The timestamp mechanism in
12315 Org is not smart enough to detect if included files have been modified.
12317 @node Sample configuration, Triggering publication, Uploading files, Publishing
12318 @section Sample configuration
12320 Below we provide two example configurations.  The first one is a simple
12321 project publishing only a set of Org files.  The second example is
12322 more complex, with a multi-component project.
12324 @menu
12325 * Simple example::              One-component publishing
12326 * Complex example::             A multi-component publishing example
12327 @end menu
12329 @node Simple example, Complex example, Sample configuration, Sample configuration
12330 @subsection Example: simple publishing configuration
12332 This example publishes a set of Org files to the @file{public_html}
12333 directory on the local machine.
12335 @lisp
12336 (setq org-publish-project-alist
12337       '(("org"
12338          :base-directory "~/org/"
12339          :publishing-directory "~/public_html"
12340          :section-numbers nil
12341          :table-of-contents nil
12342          :style "<link rel=\"stylesheet\"
12343                 href=\"../other/mystyle.css\"
12344                 type=\"text/css\"/>")))
12345 @end lisp
12347 @node Complex example,  , Simple example, Sample configuration
12348 @subsection Example: complex publishing configuration
12350 This more complicated example publishes an entire website, including
12351 Org files converted to HTML, image files, Emacs Lisp source code, and
12352 style sheets.  The publishing directory is remote and private files are
12353 excluded.
12355 To ensure that links are preserved, care should be taken to replicate
12356 your directory structure on the web server, and to use relative file
12357 paths.  For example, if your Org files are kept in @file{~/org} and your
12358 publishable images in @file{~/images}, you would link to an image with
12360 @example
12361 file:../images/myimage.png
12362 @end example
12364 On the web server, the relative path to the image should be the
12365 same.  You can accomplish this by setting up an "images" folder in the
12366 right place on the web server, and publishing images to it.
12368 @lisp
12369 (setq org-publish-project-alist
12370       '(("orgfiles"
12371           :base-directory "~/org/"
12372           :base-extension "org"
12373           :publishing-directory "/ssh:user@@host:~/html/notebook/"
12374           :publishing-function org-publish-org-to-html
12375           :exclude "PrivatePage.org"   ;; regexp
12376           :headline-levels 3
12377           :section-numbers nil
12378           :table-of-contents nil
12379           :style "<link rel=\"stylesheet\"
12380                   href=\"../other/mystyle.css\" type=\"text/css\"/>"
12381           :html-preamble t)
12383          ("images"
12384           :base-directory "~/images/"
12385           :base-extension "jpg\\|gif\\|png"
12386           :publishing-directory "/ssh:user@@host:~/html/images/"
12387           :publishing-function org-publish-attachment)
12389          ("other"
12390           :base-directory "~/other/"
12391           :base-extension "css\\|el"
12392           :publishing-directory "/ssh:user@@host:~/html/other/"
12393           :publishing-function org-publish-attachment)
12394          ("website" :components ("orgfiles" "images" "other"))))
12395 @end lisp
12397 @node Triggering publication,  , Sample configuration, Publishing
12398 @section Triggering publication
12400 Once properly configured, Org can publish with the following commands:
12402 @table @kbd
12403 @orgcmd{C-c C-e X,org-publish}
12404 Prompt for a specific project and publish all files that belong to it.
12405 @orgcmd{C-c C-e P,org-publish-current-project}
12406 Publish the project containing the current file.
12407 @orgcmd{C-c C-e F,org-publish-current-file}
12408 Publish only the current file.
12409 @orgcmd{C-c C-e E,org-publish-all}
12410 Publish every project.
12411 @end table
12413 @vindex org-publish-use-timestamps-flag
12414 Org uses timestamps to track when a file has changed.  The above functions
12415 normally only publish changed files.  You can override this and force
12416 publishing of all files by giving a prefix argument to any of the commands
12417 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
12418 This may be necessary in particular if files include other files via
12419 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
12421 @comment  node-name,  next,  previous,  up
12422 @comment Working With Source Code, Miscellaneous, Publishing, Top
12424 @node Working With Source Code, Miscellaneous, Publishing, Top
12425 @chapter Working with source code
12426 @cindex Schulte, Eric
12427 @cindex Davison, Dan
12428 @cindex source code, working with
12430 Source code can be included in Org mode documents using a @samp{src} block,
12431 e.g.@:
12433 @example
12434 #+BEGIN_SRC emacs-lisp
12435   (defun org-xor (a b)
12436      "Exclusive or."
12437      (if a (not b) b))
12438 #+END_SRC
12439 @end example
12441 Org mode provides a number of features for working with live source code,
12442 including editing of code blocks in their native major-mode, evaluation of
12443 code blocks, converting code blocks into source files (known as @dfn{tangling}
12444 in literate programming), and exporting code blocks and their
12445 results in several formats.  This functionality was contributed by Eric
12446 Schulte and Dan Davison, and was originally named Org-babel.
12448 The following sections describe Org mode's code block handling facilities.
12450 @menu
12451 * Structure of code blocks::    Code block syntax described
12452 * Editing source code::         Language major-mode editing
12453 * Exporting code blocks::       Export contents and/or results
12454 * Extracting source code::      Create pure source code files
12455 * Evaluating code blocks::      Place results of evaluation in the Org mode buffer
12456 * Library of Babel::            Use and contribute to a library of useful code blocks
12457 * Languages::                   List of supported code block languages
12458 * Header arguments::            Configure code block functionality
12459 * Results of evaluation::       How evaluation results are handled
12460 * Noweb reference syntax::      Literate programming in Org mode
12461 * Key bindings and useful functions::  Work quickly with code blocks
12462 * Batch execution::             Call functions from the command line
12463 @end menu
12465 @comment  node-name,  next,  previous,  up
12466 @comment  Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12468 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12469 @section Structure of code blocks
12470 @cindex code block, structure
12471 @cindex source code, block structure
12472 @cindex #+NAME
12473 @cindex #+BEGIN_SRC
12475 Live code blocks can be specified with a @samp{src} block or
12476 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
12477 @ref{Easy Templates} system}  The structure of a @samp{src} block is
12479 @example
12480 #+NAME: <name>
12481 #+BEGIN_SRC <language> <switches> <header arguments>
12482   <body>
12483 #+END_SRC
12484 @end example
12486 The @code{#+NAME:} line is optional, and can be used to name the code
12487 block.  Live code blocks require that a language be specified on the
12488 @code{#+BEGIN_SRC} line.  Switches and header arguments are optional.
12489 @cindex source code, inline
12491 Live code blocks can also be specified inline using
12493 @example
12494 src_<language>@{<body>@}
12495 @end example
12499 @example
12500 src_<language>[<header arguments>]@{<body>@}
12501 @end example
12503 @table @code
12504 @item <#+NAME: name>
12505 This line associates a name with the code block.  This is similar to the
12506 @code{#+TBLNAME: NAME} lines that can be used to name tables in Org mode
12507 files.  Referencing the name of a code block makes it possible to evaluate
12508 the block from other places in the file, from other files, or from Org mode
12509 table formulas (see @ref{The spreadsheet}).  Names are assumed to be unique
12510 and the behavior of Org mode when two or more blocks share the same name is
12511 undefined.
12512 @cindex #+NAME
12513 @item <language>
12514 The language of the code in the block (see @ref{Languages}).
12515 @cindex source code, language
12516 @item <switches>
12517 Optional switches control code block export (see the discussion of switches in
12518 @ref{Literal examples})
12519 @cindex source code, switches
12520 @item <header arguments>
12521 Optional header arguments control many aspects of evaluation, export and
12522 tangling of code blocks (see @ref{Header arguments}).
12523 Header arguments can also be set on a per-buffer or per-subtree
12524 basis using properties.
12525 @item source code, header arguments
12526 @item <body>
12527 Source code in the specified language.
12528 @end table
12530 @comment  node-name,  next,  previous,  up
12531 @comment  Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12533 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12534 @section Editing source code
12535 @cindex code block, editing
12536 @cindex source code, editing
12538 @kindex C-c '
12539 Use @kbd{C-c '} to edit the current code block.  This brings up
12540 a language major-mode edit buffer containing the body of the code
12541 block.  Saving this buffer will write the new contents back to the Org
12542 buffer.  Use @kbd{C-c '} again to exit.
12544 The @code{org-src-mode} minor mode will be active in the edit buffer.  The
12545 following variables can be used to configure the behavior of the edit
12546 buffer.  See also the customization group @code{org-edit-structure} for
12547 further configuration options.
12549 @table @code
12550 @item org-src-lang-modes
12551 If an Emacs major-mode named @code{<lang>-mode} exists, where
12552 @code{<lang>} is the language named in the header line of the code block,
12553 then the edit buffer will be placed in that major-mode.  This variable
12554 can be used to map arbitrary language names to existing major modes.
12555 @item org-src-window-setup
12556 Controls the way Emacs windows are rearranged when the edit buffer is created.
12557 @item org-src-preserve-indentation
12558 This variable is especially useful for tangling languages such as
12559 Python, in which whitespace indentation in the output is critical.
12560 @item org-src-ask-before-returning-to-edit-buffer
12561 By default, Org will ask before returning to an open edit buffer.  Set this
12562 variable to nil to switch without asking.
12563 @end table
12565 To turn on native code fontification in the @emph{Org} buffer, configure the
12566 variable @code{org-src-fontify-natively}.
12568 @comment  node-name,  next,  previous,  up
12569 @comment  Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12571 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12572 @section Exporting code blocks
12573 @cindex code block, exporting
12574 @cindex source code, exporting
12576 It is possible to export the @emph{code} of code blocks, the @emph{results}
12577 of code block evaluation, @emph{both} the code and the results of code block
12578 evaluation, or @emph{none}.  For most languages, the default exports code.
12579 However, for some languages (e.g.@: @code{ditaa}) the default exports the
12580 results of code block evaluation.  For information on exporting code block
12581 bodies, see @ref{Literal examples}.
12583 The @code{:exports} header argument can be used to specify export
12584 behavior:
12586 @subsubheading Header arguments:
12587 @table @code
12588 @item :exports code
12589 The default in most languages.  The body of the code block is exported, as
12590 described in @ref{Literal examples}.
12591 @item :exports results
12592 The code block will be evaluated and the results will be placed in the
12593 Org mode buffer for export, either updating previous results of the code
12594 block located anywhere in the buffer or, if no previous results exist,
12595 placing the results immediately after the code block.  The body of the code
12596 block will not be exported.
12597 @item :exports both
12598 Both the code block and its results will be exported.
12599 @item :exports none
12600 Neither the code block nor its results will be exported.
12601 @end table
12603 It is possible to inhibit the evaluation of code blocks during export.
12604 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
12605 ensure that no code blocks are evaluated as part of the export process.  This
12606 can be useful in situations where potentially untrusted Org mode files are
12607 exported in an automated fashion, for example when Org mode is used as the
12608 markup language for a wiki.
12610 @comment  node-name,  next,  previous,  up
12611 @comment  Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12612 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12613 @section Extracting source code
12614 @cindex tangling
12615 @cindex source code, extracting
12616 @cindex code block, extracting source code
12618 Creating pure source code files by extracting code from source blocks is
12619 referred to as ``tangling''---a term adopted from the literate programming
12620 community.  During ``tangling'' of code blocks their bodies are expanded
12621 using @code{org-babel-expand-src-block} which can expand both variable and
12622 ``noweb'' style references  (see @ref{Noweb reference syntax}).
12624 @subsubheading Header arguments
12625 @table @code
12626 @item :tangle no
12627 The default.  The code block is not included in the tangled output.
12628 @item :tangle yes
12629 Include the code block in the tangled output.  The output file name is the
12630 name of the org file with the extension @samp{.org} replaced by the extension
12631 for the block language.
12632 @item :tangle filename
12633 Include the code block in the tangled output to file @samp{filename}.
12634 @end table
12636 @kindex  C-c C-v t
12637 @subsubheading Functions
12638 @table @code
12639 @item org-babel-tangle
12640 Tangle the current file.  Bound to @kbd{C-c C-v t}.
12641 @item org-babel-tangle-file
12642 Choose a file to tangle.  Bound to @kbd{C-c C-v f}.
12643 @end table
12645 @subsubheading Hooks
12646 @table @code
12647 @item org-babel-post-tangle-hook
12648 This hook is run from within code files tangled by @code{org-babel-tangle}.
12649 Example applications could include post-processing, compilation or evaluation
12650 of tangled code files.
12651 @end table
12653 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
12654 @section Evaluating code blocks
12655 @cindex code block, evaluating
12656 @cindex source code, evaluating
12657 @cindex #+RESULTS
12659 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
12660 potential for that code to do harm.  Org mode provides safeguards to ensure
12661 that code is only evaluated after explicit confirmation from the user.  For
12662 information on these safeguards (and on how to disable them) see @ref{Code
12663 evaluation security}.} and the results of evaluation optionally placed in the
12664 Org mode buffer.  The results of evaluation are placed following a line that
12665 begins by default with @code{#+RESULTS} and optionally a cache identifier
12666 and/or the name of the evaluated code block.  The default value of
12667 @code{#+RESULTS} can be changed with the customizable variable
12668 @code{org-babel-results-keyword}. 
12670 By default, the evaluation facility is only enabled for Lisp code blocks
12671 specified as @code{emacs-lisp}. However, source code blocks in many languages
12672 can be evaluated within Org mode (see @ref{Languages} for a list of supported
12673 languages and @ref{Structure of code blocks} for information on the syntax
12674 used to define a code block).
12676 @kindex C-c C-c
12677 There are a number of ways to evaluate code blocks.  The simplest is to press
12678 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
12679 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
12680 evaluation from the @kbd{C-c C-c} key binding.}.  This will call the
12681 @code{org-babel-execute-src-block} function to evaluate the block and insert
12682 its results into the Org mode buffer.
12683 @cindex #+CALL
12685 It is also possible to evaluate named code blocks from anywhere in an
12686 Org mode buffer or an Org mode table. Live code blocks located in the current
12687 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
12688 can be executed.  Named code blocks can be executed with a separate
12689 @code{#+CALL:} line or inline within a block of text.
12691 The syntax of the @code{#+CALL:} line is
12693 @example
12694 #+CALL: <name>(<arguments>)
12695 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
12696 @end example
12698 The syntax for inline evaluation of named code blocks is
12700 @example
12701 ... call_<name>(<arguments>) ...
12702 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
12703 @end example
12705 @table @code
12706 @item <name>
12707 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
12708 @item <arguments>
12709 Arguments specified in this section will be passed to the code block.  These
12710 arguments use standard function call syntax, rather than
12711 header argument syntax.  For example, a @code{#+CALL:} line that passes the
12712 number four to a code block named @code{double}, which declares the header
12713 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
12714 @item <inside header arguments>
12715 Inside header arguments are passed through and applied to the named code
12716 block.  These arguments use header argument syntax rather than standard
12717 function call syntax.  Inside header arguments affect how the code block is
12718 evaluated.  For example, @code{[:results output]} will collect the results of
12719 everything printed to @code{STDOUT} during execution of the code block.
12720 @item <end header arguments>
12721 End header arguments are applied to the calling instance and do not affect
12722 evaluation of the named code block.  They affect how the results are
12723 incorporated into the Org mode buffer and how the call line is exported.  For
12724 example, @code{:results html} will insert the results of the call line
12725 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
12727 For more examples of passing header arguments to @code{#+CALL:} lines see
12728 @ref{Header arguments in function calls}.
12729 @end table
12731 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
12732 @section Library of Babel
12733 @cindex babel, library of
12734 @cindex source code, library
12735 @cindex code block, library
12737 The ``Library of Babel'' consists of code blocks that can be called from any
12738 Org mode file.  Code blocks defined in the ``Library of Babel'' can be called
12739 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
12740 code blocks} for information on the syntax of remote code block evaluation).
12743 The central repository of code blocks in the ``Library of Babel'' is housed
12744 in an Org mode file located in the @samp{contrib} directory of Org mode.
12746 Users can add code blocks they believe to be generally useful to their
12747 ``Library of Babel.''  The code blocks can be stored in any Org mode file and
12748 then loaded into the library with @code{org-babel-lob-ingest}.
12751 @kindex C-c C-v i
12752 Code blocks located in any Org mode file can be loaded into the ``Library of
12753 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
12756 @node Languages, Header arguments, Library of Babel, Working With Source Code
12757 @section Languages
12758 @cindex babel, languages
12759 @cindex source code, languages
12760 @cindex code block, languages
12762 Code blocks in the following languages are supported.
12764 @multitable @columnfractions 0.28 0.3 0.22 0.2
12765 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
12766 @item Asymptote @tab asymptote @tab Awk @tab awk
12767 @item Emacs Calc @tab calc @tab C @tab C
12768 @item C++ @tab C++ @tab Clojure @tab clojure
12769 @item CSS @tab css @tab ditaa @tab ditaa
12770 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
12771 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
12772 @item Java @tab java @tab @tab
12773 @item Javascript @tab js @tab LaTeX @tab latex
12774 @item Ledger @tab ledger @tab Lisp @tab lisp
12775 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
12776 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
12777 @item Octave @tab octave @tab Org mode @tab org
12778 @item Oz @tab oz @tab Perl @tab perl
12779 @item Plantuml @tab plantuml @tab Python @tab python
12780 @item R @tab R @tab Ruby @tab ruby
12781 @item Sass @tab sass @tab Scheme @tab scheme
12782 @item GNU Screen @tab screen @tab shell @tab sh
12783 @item SQL @tab sql @tab SQLite @tab sqlite
12784 @end multitable
12786 Language-specific documentation is available for some languages.  If
12787 available, it can be found at
12788 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
12790 The @code{org-babel-load-languages} controls which languages are enabled for
12791 evaluation (by default only @code{emacs-lisp} is enabled).  This variable can
12792 be set using the customization interface or by adding code like the following
12793 to your emacs configuration.
12795 @quotation
12796 The following disables @code{emacs-lisp} evaluation and enables evaluation of
12797 @code{R} code blocks.
12798 @end quotation
12800 @lisp
12801 (org-babel-do-load-languages
12802  'org-babel-load-languages
12803  '((emacs-lisp . nil)
12804    (R . t)))
12805 @end lisp
12807 It is also possible to enable support for a language by loading the related
12808 elisp file with @code{require}.
12810 @quotation
12811 The following adds support for evaluating @code{clojure} code blocks.
12812 @end quotation
12814 @lisp
12815 (require 'ob-clojure)
12816 @end lisp
12818 @node Header arguments, Results of evaluation, Languages, Working With Source Code
12819 @section Header arguments
12820 @cindex code block, header arguments
12821 @cindex source code, block header arguments
12823 Code block functionality can be configured with header arguments.  This
12824 section provides an overview of the use of header arguments, and then
12825 describes each header argument in detail.
12827 @menu
12828 * Using header arguments::      Different ways to set header arguments
12829 * Specific header arguments::   List of header arguments
12830 @end menu
12832 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
12833 @subsection Using header arguments
12835 The values of header arguments can be set in six different ways, each more
12836 specific (and having higher priority) than the last.
12837 @menu
12838 * System-wide header arguments::  Set global default values
12839 * Language-specific header arguments::  Set default values by language
12840 * Buffer-wide header arguments::  Set default values for a specific buffer
12841 * Header arguments in Org mode properties::  Set default values for a buffer or heading
12842 * Code block specific header arguments::  The most common way to set values
12843 * Header arguments in function calls::  The most specific level
12844 @end menu
12847 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
12848 @subsubheading System-wide header arguments
12849 @vindex org-babel-default-header-args
12850 System-wide values of header arguments can be specified by customizing the
12851 @code{org-babel-default-header-args} variable:
12853 @example
12854 :session    => "none"
12855 :results    => "replace"
12856 :exports    => "code"
12857 :cache      => "no"
12858 :noweb      => "no"
12859 @end example
12861 @c @example
12862 @c   org-babel-default-header-args is a variable defined in `org-babel.el'.
12863 @c   Its value is
12864 @c   ((:session . "none")
12865 @c    (:results . "replace")
12866 @c    (:exports . "code")
12867 @c    (:cache . "no")
12868 @c    (:noweb . "no"))
12871 @c   Documentation:
12872 @c   Default arguments to use when evaluating a code block.
12873 @c @end example
12875 For example, the following example could be used to set the default value of
12876 @code{:noweb} header arguments to @code{yes}.  This would have the effect of
12877 expanding @code{:noweb} references by default when evaluating source code
12878 blocks.
12880 @lisp
12881 (setq org-babel-default-header-args
12882 (cons '(:noweb . "yes")
12883 (assq-delete-all :noweb org-babel-default-header-args)))
12884 @end lisp
12886 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
12887 @subsubheading Language-specific header arguments
12888 Each language can define its own set of default header arguments.  See the
12889 language-specific documentation available online at
12890 @uref{http://orgmode.org/worg/org-contrib/babel}.
12892 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
12893 @subsubheading Buffer-wide header arguments
12894 Buffer-wide header arguments may be specified as properties through the use
12895 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
12896 @ref{Property syntax}).
12898 For example the following would set @code{session} to @code{*R*}, and
12899 @code{results} to @code{silent} for every code block in the buffer, ensuring
12900 that all execution took place in the same session, and no results would be
12901 inserted into the buffer.
12903 @example
12904 #+PROPERTY: session *R*
12905 #+PROPERTY: results silent
12906 @end example
12908 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
12909 @subsubheading Header arguments in Org mode properties
12911 Header arguments are also read from Org mode properties (see @ref{Property
12912 syntax}), which can be set on a buffer-wide or per-heading basis.  An example
12913 of setting a header argument for all code blocks in a buffer is
12915 @example
12916 #+PROPERTY: tangle yes
12917 @end example
12919 @vindex org-use-property-inheritance
12920 When properties are used to set default header arguments, they are looked up
12921 with inheritance, regardless of the value of
12922 @code{org-use-property-inheritance}.  In the following example the value of
12923 the @code{:cache} header argument will default to @code{yes} in all code
12924 blocks in the subtree rooted at the following heading:
12926 @example
12927 * outline header
12928 :PROPERTIES:
12929 :cache:    yes
12930 :END:
12931 @end example
12933 @kindex C-c C-x p
12934 @vindex org-babel-default-header-args
12935 Properties defined in this way override the properties set in
12936 @code{org-babel-default-header-args}.  It is convenient to use the
12937 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
12938 in Org mode documents.
12940 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
12941 @subsubheading Code block specific header arguments
12943 The most common way to assign values to header arguments is at the
12944 code block level.  This can be done by listing a sequence of header
12945 arguments and their values as part of the @code{#+BEGIN_SRC} line.
12946 Properties set in this way override both the values of
12947 @code{org-babel-default-header-args} and header arguments specified as
12948 properties.  In the following example, the @code{:results} header argument
12949 is set to @code{silent}, meaning the results of execution will not be
12950 inserted in the buffer, and the @code{:exports} header argument is set to
12951 @code{code}, meaning only the body of the code block will be
12952 preserved on export to HTML or @LaTeX{}.
12954 @example
12955 #+NAME: factorial
12956 #+BEGIN_SRC haskell :results silent :exports code :var n=0
12957 fac 0 = 1
12958 fac n = n * fac (n-1)
12959 #+END_SRC
12960 @end example
12961 Similarly, it is possible to set header arguments for inline code blocks
12963 @example
12964 src_haskell[:exports both]@{fac 5@}
12965 @end example
12967 Code block header arguments can span multiple lines using @code{#+HEADER:} or
12968 @code{#+HEADERS:} lines preceding a code block or nested between the
12969 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
12970 @cindex #+HEADER:
12971 @cindex #+HEADERS:
12973 Multi-line header arguments on an un-named code block:
12974 @example
12975  #+HEADERS: :var data1=1
12976  #+BEGIN_SRC emacs-lisp :var data2=2
12977    (message "data1:%S, data2:%S" data1 data2)
12978  #+END_SRC
12980  #+results:
12981  : data1:1, data2:2
12982 @end example
12984 Multi-line header arguments on a named code block:
12985 @example
12986    #+NAME: named-block
12987    #+HEADER: :var data=2
12988    #+BEGIN_SRC emacs-lisp
12989      (message "data:%S" data)
12990    #+END_SRC
12992    #+results: named-block
12993    : data:2
12994 @end example
12996 @node Header arguments in function calls,  , Code block specific header arguments, Using header arguments
12997 @comment  node-name,  next,  previous,  up
12998 @subsubheading Header arguments in function calls
13000 At the most specific level, header arguments for ``Library of Babel'' or
13001 @code{#+CALL:} lines can be set as shown in the two examples below.  For more
13002 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
13003 blocks}.
13005 The following will apply the @code{:exports results} header argument to the
13006 evaluation of the @code{#+CALL:} line.
13007 @example
13008 #+CALL: factorial(n=5) :exports results
13009 @end example
13011 The following will apply the @code{:session special} header argument to the
13012 evaluation of the @code{factorial} code block.
13013 @example
13014 #+CALL: factorial[:session special](n=5)
13015 @end example
13017 @node Specific header arguments,  , Using header arguments, Header arguments
13018 @subsection Specific header arguments
13019 Header arguments consist of an initial colon followed by the name of the
13020 argument in lowercase letters.  The following header arguments are defined:
13022 @menu
13023 * var::                         Pass arguments to code blocks
13024 * results::                     Specify the type of results and how they will
13025                                 be collected and handled
13026 * file::                        Specify a path for file output
13027 * dir::                         Specify the default (possibly remote)
13028                                 directory for code block execution
13029 * exports::                     Export code and/or results
13030 * tangle::                      Toggle tangling and specify file name
13031 * mkdirp::                      Toggle creation of parent directories of target
13032                                 files during tangling
13033 * comments::                    Toggle insertion of comments in tangled
13034                                 code files
13035 * padline::                     Control insertion of padding lines in tangled
13036                                 code files
13037 * no-expand::                   Turn off variable assignment and noweb
13038                                 expansion during tangling
13039 * session::                     Preserve the state of code evaluation
13040 * noweb::                       Toggle expansion of noweb references
13041 * noweb-ref::                   Specify block's noweb reference resolution target
13042 * noweb-sep::                   String used to separate noweb references
13043 * cache::                       Avoid re-evaluating unchanged code blocks
13044 * sep::                         Delimiter for writing tabular results outside Org
13045 * hlines::                      Handle horizontal lines in tables
13046 * colnames::                    Handle column names in tables
13047 * rownames::                    Handle row names in tables
13048 * shebang::                     Make tangled files executable
13049 * eval::                        Limit evaluation of specific code blocks
13050 @end menu
13052 Additional header arguments are defined on a language-specific basis, see
13053 @ref{Languages}.
13055 @node var, results, Specific header arguments, Specific header arguments
13056 @subsubsection @code{:var}
13057 The @code{:var} header argument is used to pass arguments to code blocks.
13058 The specifics of how arguments are included in a code block vary by language;
13059 these are addressed in the language-specific documentation.  However, the
13060 syntax used to specify arguments is the same across all languages.  In every
13061 case, variables require a default value when they are declared.
13063 The values passed to arguments can either be literal values, references, or
13064 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
13065 include anything in the Org mode file that takes a @code{#+NAME:},
13066 @code{#+TBLNAME:}, or @code{#+RESULTS:} line.  This includes tables, lists,
13067 @code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
13068 code blocks.
13070 Argument values can be indexed in a manner similar to arrays (see @ref{var,
13071 Indexable variable values}).
13073 The following syntax is used to pass arguments to code blocks using the
13074 @code{:var} header argument.
13076 @example
13077 :var name=assign
13078 @end example
13080 The argument, @code{assign}, can either be a literal value, such as a string
13081 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
13082 literal example, another code block (with or without arguments), or the
13083 results of evaluating another code block.
13085 Here are examples of passing values by reference:
13087 @table @dfn
13089 @item table
13090 an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
13091 @example
13092 #+TBLNAME: example-table
13093 | 1 |
13094 | 2 |
13095 | 3 |
13096 | 4 |
13098 #+NAME: table-length
13099 #+BEGIN_SRC emacs-lisp :var table=example-table
13100 (length table)
13101 #+END_SRC
13103 #+results: table-length
13104 : 4
13105 @end example
13107 @item list
13108 a simple list named with a @code{#+NAME:} line (note that nesting is not
13109 carried through to the source code block)
13111 @example
13112 #+NAME: example-list
13113   - simple
13114     - not
13115     - nested
13116   - list
13118 #+BEGIN_SRC emacs-lisp :var x=example-list
13119   (print x)
13120 #+END_SRC
13122 #+results:
13123 | simple | list |
13124 @end example
13126 @item code block without arguments
13127 a code block name (from the example above), as assigned by @code{#+NAME:},
13128 optionally followed by parentheses
13130 @example
13131 #+BEGIN_SRC emacs-lisp :var length=table-length()
13132 (* 2 length)
13133 #+END_SRC
13135 #+results:
13136 : 8
13137 @end example
13139 @item code block with arguments
13140 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
13141 optional arguments passed within the parentheses following the
13142 code block name using standard function call syntax
13144 @example
13145 #+NAME: double
13146 #+BEGIN_SRC emacs-lisp :var input=8
13147 (* 2 input)
13148 #+END_SRC
13150 #+results: double
13151 : 16
13153 #+NAME: squared
13154 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
13155 (* input input)
13156 #+END_SRC
13158 #+results: squared
13159 : 4
13160 @end example
13162 @item literal example
13163 a literal example block named with a @code{#+NAME:} line
13165 @example
13166 #+NAME: literal-example
13167 #+BEGIN_EXAMPLE
13168 A literal example
13169 on two lines
13170 #+END_EXAMPLE
13172 #+NAME: read-literal-example
13173 #+BEGIN_SRC emacs-lisp :var x=literal-example
13174   (concatenate 'string x " for you.")
13175 #+END_SRC
13177 #+results: read-literal-example
13178 : A literal example
13179 : on two lines for you.
13181 @end example
13183 @end table
13185 @subsubheading Alternate argument syntax
13186 It is also possible to specify arguments in a potentially more natural way
13187 using the @code{#+NAME:} line of a code block.  As in the following
13188 example, arguments can be packed inside of parentheses, separated by commas,
13189 following the source name.
13191 @example
13192 #+NAME: double(input=0, x=2)
13193 #+BEGIN_SRC emacs-lisp
13194 (* 2 (+ input x))
13195 #+END_SRC
13196 @end example
13198 @subsubheading Indexable variable values
13199 It is possible to reference portions of variable values by ``indexing'' into
13200 the variables.  Indexes are 0 based with negative values counting back from
13201 the end.  If an index is separated by @code{,}s then each subsequent section
13202 will index into the next deepest nesting or dimension of the value.  Note
13203 that this indexing occurs @emph{before} other table related header arguments
13204 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied.  The
13205 following example assigns the last cell of the first row the table
13206 @code{example-table} to the variable @code{data}:
13208 @example
13209 #+NAME: example-table
13210 | 1 | a |
13211 | 2 | b |
13212 | 3 | c |
13213 | 4 | d |
13215 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
13216   data
13217 #+END_SRC
13219 #+results:
13220 : a
13221 @end example
13223 Ranges of variable values can be referenced using two integers separated by a
13224 @code{:}, in which case the entire inclusive range is referenced.  For
13225 example the following assigns the middle three rows of @code{example-table}
13226 to @code{data}.
13228 @example
13229 #+NAME: example-table
13230 | 1 | a |
13231 | 2 | b |
13232 | 3 | c |
13233 | 4 | d |
13234 | 5 | 3 |
13236 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
13237   data
13238 #+END_SRC
13240 #+results:
13241 | 2 | b |
13242 | 3 | c |
13243 | 4 | d |
13244 @end example
13246 Additionally, an empty index, or the single character @code{*}, are both
13247 interpreted to mean the entire range and as such are equivalent to
13248 @code{0:-1}, as shown in the following example in which the entire first
13249 column is referenced.
13251 @example
13252 #+NAME: example-table
13253 | 1 | a |
13254 | 2 | b |
13255 | 3 | c |
13256 | 4 | d |
13258 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
13259   data
13260 #+END_SRC
13262 #+results:
13263 | 1 | 2 | 3 | 4 |
13264 @end example
13266 It is possible to index into the results of code blocks as well as tables.
13267 Any number of dimensions can be indexed.  Dimensions are separated from one
13268 another by commas, as shown in the following example.
13270 @example
13271 #+NAME: 3D
13272 #+BEGIN_SRC emacs-lisp
13273   '(((1  2  3)  (4  5  6)  (7  8  9))
13274     ((10 11 12) (13 14 15) (16 17 18))
13275     ((19 20 21) (22 23 24) (25 26 27)))
13276 #+END_SRC
13278 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
13279   data
13280 #+END_SRC
13282 #+results:
13283 | 11 | 14 | 17 |
13284 @end example
13286 @subsubheading Emacs Lisp evaluation of variables
13288 Emacs lisp code can be used to initialize variable values.  When a variable
13289 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
13290 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
13291 the variable value.  The following example demonstrates use of this
13292 evaluation to reliably pass the file-name of the Org mode buffer to a code
13293 block---note that evaluation of header arguments is guaranteed to take place
13294 in the original Org mode file, while there is no such guarantee for
13295 evaluation of the code block body.
13297 @example
13298 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
13299   wc -w $filename
13300 #+END_SRC
13301 @end example
13303 Note that values read from tables and lists will not be evaluated as
13304 Emacs Lisp, as shown in the following example.
13306 @example
13307 #+NAME: table
13308 | (a b c) |
13310 #+HEADERS: :var data=table[0,0]
13311 #+BEGIN_SRC perl
13312   $data
13313 #+END_SRC
13315 #+results:
13316 : (a b c)
13317 @end example
13319 @node results, file, var, Specific header arguments
13320 @subsubsection @code{:results}
13322 There are three classes of @code{:results} header argument.  Only one option
13323 per class may be supplied per code block.
13325 @itemize @bullet
13326 @item
13327 @b{collection} header arguments specify how the results should be collected
13328 from the code block
13329 @item
13330 @b{type} header arguments specify what type of result the code block will
13331 return---which has implications for how they will be inserted into the
13332 Org mode buffer
13333 @item
13334 @b{handling} header arguments specify how the results of evaluating the code
13335 block should be handled.
13336 @end itemize
13338 @subsubheading Collection
13339 The following options are mutually exclusive, and specify how the results
13340 should be collected from the code block.
13342 @itemize @bullet
13343 @item @code{value}
13344 This is the default.  The result is the value of the last statement in the
13345 code block.  This header argument places the evaluation in functional
13346 mode.  Note that in some languages, e.g., Python, use of this result type
13347 requires that a @code{return} statement be included in the body of the source
13348 code block.  E.g., @code{:results value}.
13349 @item @code{output}
13350 The result is the collection of everything printed to STDOUT during the
13351 execution of the code block.  This header argument places the
13352 evaluation in scripting mode.  E.g., @code{:results output}.
13353 @end itemize
13355 @subsubheading Type
13357 The following options are mutually exclusive and specify what type of results
13358 the code block will return.  By default, results are inserted as either a
13359 table or scalar depending on their value.
13361 @itemize @bullet
13362 @item @code{table}, @code{vector}
13363 The results should be interpreted as an Org mode table.  If a single value is
13364 returned, it will be converted into a table with one row and one column.
13365 E.g., @code{:results value table}.
13366 @item @code{list}
13367 The results should be interpreted as an Org mode list.  If a single scalar
13368 value is returned it will be converted into a list with only one element.
13369 @item @code{scalar}, @code{verbatim}
13370 The results should be interpreted literally---they will not be
13371 converted into a table.  The results will be inserted into the Org mode
13372 buffer as quoted text.  E.g., @code{:results value verbatim}.
13373 @item @code{file}
13374 The results will be interpreted as the path to a file, and will be inserted
13375 into the Org mode buffer as a file link.  E.g., @code{:results value file}.
13376 @item @code{raw}, @code{org}
13377 The results are interpreted as raw Org mode code and are inserted directly
13378 into the buffer.  If the results look like a table they will be aligned as
13379 such by Org mode.  E.g., @code{:results value raw}.
13380 @item @code{html}
13381 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
13382 block.  E.g., @code{:results value html}.
13383 @item @code{latex}
13384 Results assumed to be @LaTeX{} and are enclosed in a @code{begin_latex} block.
13385 E.g., @code{:results value latex}.
13386 @item @code{code}
13387 Result are assumed to be parsable code and are enclosed in a code block.
13388 E.g., @code{:results value code}.
13389 @item @code{pp}
13390 The result is converted to pretty-printed code and is enclosed in a code
13391 block.  This option currently supports Emacs Lisp, Python, and Ruby.  E.g.,
13392 @code{:results value pp}.
13393 @item @code{wrap}
13394 The result is wrapped in a RESULTS drawer.  This can be useful for
13395 inserting @code{raw} or @code{org} syntax results in such a way that their
13396 extent is known and they can be automatically removed or replaced.
13397 @end itemize
13399 @subsubheading Handling
13400 The following results options indicate what happens with the
13401 results once they are collected.
13403 @itemize @bullet
13404 @item @code{silent}
13405 The results will be echoed in the minibuffer but will not be inserted into
13406 the Org mode buffer.  E.g., @code{:results output silent}.
13407 @item @code{replace}
13408 The default value.  Any existing results will be removed, and the new results
13409 will be inserted into the Org mode buffer in their place.  E.g.,
13410 @code{:results output replace}.
13411 @item @code{append}
13412 If there are pre-existing results of the code block then the new results will
13413 be appended to the existing results.  Otherwise the new results will be
13414 inserted as with @code{replace}.
13415 @item @code{prepend}
13416 If there are pre-existing results of the code block then the new results will
13417 be prepended to the existing results.  Otherwise the new results will be
13418 inserted as with @code{replace}.
13419 @end itemize
13421 @node file, dir, results, Specific header arguments
13422 @subsubsection @code{:file}
13424 The header argument @code{:file} is used to specify an external file in which
13425 to save code block results.  After code block evaluation an Org mode style
13426 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
13427 into the Org mode buffer.  Some languages including R, gnuplot, dot, and
13428 ditaa provide special handling of the @code{:file} header argument
13429 automatically wrapping the code block body in the boilerplate code required
13430 to save output to the specified file.  This is often useful for saving
13431 graphical output of a code block to the specified file.
13433 The argument to @code{:file} should be either a string specifying the path to
13434 a file, or a list of two strings in which case the first element of the list
13435 should be the path to a file and the second a description for the link.
13437 @node dir, exports, file, Specific header arguments
13438 @subsubsection @code{:dir} and remote execution
13440 While the @code{:file} header argument can be used to specify the path to the
13441 output file, @code{:dir} specifies the default directory during code block
13442 execution.  If it is absent, then the directory associated with the current
13443 buffer is used.  In other words, supplying @code{:dir path} temporarily has
13444 the same effect as changing the current directory with @kbd{M-x cd path}, and
13445 then not supplying @code{:dir}.  Under the surface, @code{:dir} simply sets
13446 the value of the Emacs variable @code{default-directory}.
13448 When using @code{:dir}, you should supply a relative path for file output
13449 (e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
13450 case that path will be interpreted relative to the default directory.
13452 In other words, if you want your plot to go into a folder called @file{Work}
13453 in your home directory, you could use
13455 @example
13456 #+BEGIN_SRC R :file myplot.png :dir ~/Work
13457 matplot(matrix(rnorm(100), 10), type="l")
13458 #+END_SRC
13459 @end example
13461 @subsubheading Remote execution
13462 A directory on a remote machine can be specified using tramp file syntax, in
13463 which case the code will be evaluated on the remote machine.  An example is
13465 @example
13466 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
13467 plot(1:10, main=system("hostname", intern=TRUE))
13468 #+END_SRC
13469 @end example
13471 Text results will be returned to the local Org mode buffer as usual, and file
13472 output will be created on the remote machine with relative paths interpreted
13473 relative to the remote directory.  An Org mode link to the remote file will be
13474 created.
13476 So, in the above example a plot will be created on the remote machine,
13477 and a link of the following form will be inserted in the org buffer:
13479 @example
13480 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
13481 @end example
13483 Most of this functionality follows immediately from the fact that @code{:dir}
13484 sets the value of the Emacs variable @code{default-directory}, thanks to
13485 tramp.  Those using XEmacs, or GNU Emacs prior to version 23 may need to
13486 install tramp separately in order for these features to work correctly.
13488 @subsubheading Further points
13490 @itemize @bullet
13491 @item
13492 If @code{:dir} is used in conjunction with @code{:session}, although it will
13493 determine the starting directory for a new session as expected, no attempt is
13494 currently made to alter the directory associated with an existing session.
13495 @item
13496 @code{:dir} should typically not be used to create files during export with
13497 @code{:exports results} or @code{:exports both}.  The reason is that, in order
13498 to retain portability of exported material between machines, during export
13499 links inserted into the buffer will @emph{not} be expanded against @code{default
13500 directory}.  Therefore, if @code{default-directory} is altered using
13501 @code{:dir}, it is probable that the file will be created in a location to
13502 which the link does not point.
13503 @end itemize
13505 @node exports, tangle, dir, Specific header arguments
13506 @subsubsection @code{:exports}
13508 The @code{:exports} header argument specifies what should be included in HTML
13509 or @LaTeX{} exports of the Org mode file.
13511 @itemize @bullet
13512 @item @code{code}
13513 The default.  The body of code is included into the exported file.  E.g.,
13514 @code{:exports code}.
13515 @item @code{results}
13516 The result of evaluating the code is included in the exported file.  E.g.,
13517 @code{:exports results}.
13518 @item @code{both}
13519 Both the code and results are included in the exported file.  E.g.,
13520 @code{:exports both}.
13521 @item @code{none}
13522 Nothing is included in the exported file.  E.g., @code{:exports none}.
13523 @end itemize
13525 @node tangle, mkdirp, exports, Specific header arguments
13526 @subsubsection @code{:tangle}
13528 The @code{:tangle} header argument specifies whether or not the code
13529 block should be included in tangled extraction of source code files.
13531 @itemize @bullet
13532 @item @code{tangle}
13533 The code block is exported to a source code file named after the full path
13534 (including the directory) and file name (w/o extension) of the Org mode file.
13535 E.g., @code{:tangle yes}.
13536 @item @code{no}
13537 The default.  The code block is not exported to a source code file.
13538 E.g., @code{:tangle no}.
13539 @item other
13540 Any other string passed to the @code{:tangle} header argument is interpreted
13541 as a path (directory and file name relative to the directory of the Org mode
13542 file) to which the block will be exported.  E.g., @code{:tangle path}.
13543 @end itemize
13545 @node mkdirp, comments, tangle, Specific header arguments
13546 @subsubsection @code{:mkdirp}
13548 The @code{:mkdirp} header argument can be used to create parent directories
13549 of tangled files when missing.  This can be set to @code{yes} to enable
13550 directory creation or to @code{no} to inhibit directory creation.
13552 @node comments, padline, mkdirp, Specific header arguments
13553 @subsubsection @code{:comments}
13554 By default code blocks are tangled to source-code files without any insertion
13555 of comments beyond those which may already exist in the body of the code
13556 block.  The @code{:comments} header argument can be set as follows to control
13557 the insertion of extra comments into the tangled code file.
13559 @itemize @bullet
13560 @item @code{no}
13561 The default.  No extra comments are inserted during tangling.
13562 @item @code{link}
13563 The code block is wrapped in comments which contain pointers back to the
13564 original Org file from which the code was tangled.
13565 @item @code{yes}
13566 A synonym for ``link'' to maintain backwards compatibility.
13567 @item @code{org}
13568 Include text from the Org mode file as a comment.
13570 The text is picked from the leading context of the tangled code and is
13571 limited by the nearest headline or source block as the case may be.
13572 @item @code{both}
13573 Turns on both the ``link'' and ``org'' comment options.
13574 @item @code{noweb}
13575 Turns on the ``link'' comment option, and additionally wraps expanded noweb
13576 references in the code block body in link comments.
13577 @end itemize
13579 @node padline, no-expand, comments, Specific header arguments
13580 @subsubsection @code{:padline}
13581 Control in insertion of padding lines around code block bodies in tangled
13582 code files.  The default value is @code{yes} which results in insertion of
13583 newlines before and after each tangled code block.  The following arguments
13584 are accepted.
13586 @itemize @bullet
13587 @item @code{yes}
13588 Insert newlines before and after each code block body in tangled code files.
13589 @item @code{no}
13590 Do not insert any newline padding in tangled output.
13591 @end itemize
13593 @node no-expand, session, padline, Specific header arguments
13594 @subsubsection @code{:no-expand}
13596 By default, code blocks are expanded with @code{org-babel-expand-src-block}
13597 during tangling.  This has the effect of assigning values to variables
13598 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
13599 references (see @ref{Noweb reference syntax}) with their targets.  The
13600 @code{:no-expand} header argument can be used to turn off this behavior.
13602 @node session, noweb, no-expand, Specific header arguments
13603 @subsubsection @code{:session}
13605 The @code{:session} header argument starts a session for an interpreted
13606 language where state is preserved.
13608 By default, a session is not started.
13610 A string passed to the @code{:session} header argument will give the session
13611 a name.  This makes it possible to run concurrent sessions for each
13612 interpreted language.
13614 @node noweb, noweb-ref, session, Specific header arguments
13615 @subsubsection @code{:noweb}
13617 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
13618 @ref{Noweb reference syntax}) references in a code block.  This header
13619 argument can have one of three values: @code{yes}, @code{no}, or @code{tangle}.
13621 @itemize @bullet
13622 @item @code{yes}
13623 All ``noweb'' syntax references in the body of the code block will be
13624 expanded before the block is evaluated, tangled or exported.
13625 @item @code{no}
13626 The default.  No ``noweb'' syntax specific action is taken when the code
13627 block is evaluated, tangled or exported.
13628 @item @code{tangle}
13629 All ``noweb'' syntax references in the body of the code block will be
13630 expanded before the block is tangled, however ``noweb'' references will not
13631 be expanded when the block is evaluated or exported.
13632 @end itemize
13634 @subsubheading Noweb prefix lines
13635 Noweb insertions are now placed behind the line prefix of the
13636 @code{<<reference>>}.
13637 This behavior is illustrated in the following example.  Because the
13638 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
13639 each line of the expanded noweb reference will be commented.
13641 This code block:
13643 @example
13644 -- <<example>>
13645 @end example
13648 expands to:
13650 @example
13651 -- this is the
13652 -- multi-line body of example
13653 @end example
13655 Note that noweb replacement text that does not contain any newlines will not
13656 be affected by this change, so it is still possible to use inline noweb
13657 references.
13659 @node noweb-ref, noweb-sep, noweb, Specific header arguments
13660 @subsubsection @code{:noweb-ref}
13661 When expanding ``noweb'' style references the bodies of all code block with
13662 @emph{either} a block name matching the reference name @emph{or} a
13663 @code{:noweb-ref} header argument matching the reference name will be
13664 concatenated together to form the replacement text.
13666 By setting this header argument at the sub-tree or file level, simple code
13667 block concatenation may be achieved.  For example, when tangling the
13668 following Org mode file, the bodies of code blocks will be concatenated into
13669 the resulting pure code file@footnote{(The example needs property inheritance
13670 to be turned on for the @code{noweb-ref} property, see @ref{Property
13671 inheritance}).}.
13673 @example
13674  #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
13675    <<fullest-disk>>
13676  #+END_SRC
13677  * the mount point of the fullest disk
13678    :PROPERTIES:
13679    :noweb-ref: fullest-disk
13680    :END:
13682  ** query all mounted disks
13683  #+BEGIN_SRC sh
13684    df \
13685  #+END_SRC
13687  ** strip the header row
13688  #+BEGIN_SRC sh
13689    |sed '1d' \
13690  #+END_SRC
13692  ** sort by the percent full
13693  #+BEGIN_SRC sh
13694    |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
13695  #+END_SRC
13697  ** extract the mount point
13698  #+BEGIN_SRC sh
13699    |awk '@{print $2@}'
13700  #+END_SRC
13701 @end example
13703 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
13704 used to separate accumulate noweb references like those above.  By default a
13705 newline is used.
13707 @node noweb-sep, cache, noweb-ref, Specific header arguments
13708 @subsubsection @code{:noweb-sep}
13710 The @code{:noweb-sep} header argument holds the string used to separate
13711 accumulate noweb references (see @ref{noweb-ref}).  By default a newline is
13712 used.
13714 @node cache, sep, noweb-sep, Specific header arguments
13715 @subsubsection @code{:cache}
13717 The @code{:cache} header argument controls the use of in-buffer caching of
13718 the results of evaluating code blocks.  It can be used to avoid re-evaluating
13719 unchanged code blocks.  Note that the @code{:cache} header argument will not
13720 attempt to cache results when the @code{:session} header argument is used,
13721 because the results of the code block execution may be stored in the session
13722 outside of the Org-mode buffer.  The @code{:cache} header argument can have
13723 one of two values: @code{yes} or @code{no}.
13725 @itemize @bullet
13726 @item @code{no}
13727 The default.  No caching takes place, and the code block will be evaluated
13728 every time it is called.
13729 @item @code{yes}
13730 Every time the code block is run a SHA1 hash of the code and arguments
13731 passed to the block will be generated.  This hash is packed into the
13732 @code{#+results:} line and will be checked on subsequent
13733 executions of the code block.  If the code block has not
13734 changed since the last time it was evaluated, it will not be re-evaluated.
13735 @end itemize
13737 Code block caches notice if the value of a variable argument
13738 to the code block has changed.  If this is the case, the cache is
13739 invalidated and the code block is re-run.  In the following example,
13740 @code{caller} will not be re-run unless the results of @code{random} have
13741 changed since it was last run.
13743 @example
13744  #+NAME: random
13745  #+BEGIN_SRC R :cache yes
13746  runif(1)
13747  #+END_SRC
13749  #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
13750  0.4659510825295
13752  #+NAME: caller
13753  #+BEGIN_SRC emacs-lisp :var x=random :cache yes
13755  #+END_SRC
13757  #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
13758  0.254227238707244
13759 @end example
13761 @node sep, hlines, cache, Specific header arguments
13762 @subsubsection @code{:sep}
13764 The @code{:sep} header argument can be used to control the delimiter used
13765 when writing tabular results out to files external to Org mode.  This is used
13766 either when opening tabular results of a code block by calling the
13767 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
13768 or when writing code block results to an external file (see @ref{file})
13769 header argument.
13771 By default, when @code{:sep} is not specified output tables are tab
13772 delimited.
13774 @node hlines, colnames, sep, Specific header arguments
13775 @subsubsection @code{:hlines}
13777 Tables are frequently represented with one or more horizontal lines, or
13778 hlines.  The @code{:hlines} argument to a code block accepts the
13779 values @code{yes} or @code{no}, with a default value of @code{no}.
13781 @itemize @bullet
13782 @item @code{no}
13783 Strips horizontal lines from the input table.  In most languages this is the
13784 desired effect because an @code{hline} symbol is interpreted as an unbound
13785 variable and raises an error.  Setting @code{:hlines no} or relying on the
13786 default value yields the following results.
13788 @example
13789 #+TBLNAME: many-cols
13790 | a | b | c |
13791 |---+---+---|
13792 | d | e | f |
13793 |---+---+---|
13794 | g | h | i |
13796 #+NAME: echo-table
13797 #+BEGIN_SRC python :var tab=many-cols
13798   return tab
13799 #+END_SRC
13801 #+results: echo-table
13802 | a | b | c |
13803 | d | e | f |
13804 | g | h | i |
13805 @end example
13807 @item @code{yes}
13808 Leaves hlines in the table.  Setting @code{:hlines yes} has this effect.
13810 @example
13811 #+TBLNAME: many-cols
13812 | a | b | c |
13813 |---+---+---|
13814 | d | e | f |
13815 |---+---+---|
13816 | g | h | i |
13818 #+NAME: echo-table
13819 #+BEGIN_SRC python :var tab=many-cols :hlines yes
13820   return tab
13821 #+END_SRC
13823 #+results: echo-table
13824 | a | b | c |
13825 |---+---+---|
13826 | d | e | f |
13827 |---+---+---|
13828 | g | h | i |
13829 @end example
13830 @end itemize
13832 @node colnames, rownames, hlines, Specific header arguments
13833 @subsubsection @code{:colnames}
13835 The @code{:colnames} header argument accepts the values @code{yes},
13836 @code{no}, or @code{nil} for unassigned.  The default value is @code{nil}.
13837 Note that the behavior of the @code{:colnames} header argument may differ
13838 across languages.  For example Emacs Lisp code blocks ignore the
13839 @code{:colnames} header argument entirely given the ease with which tables
13840 with column names may be handled directly in Emacs Lisp.
13842 @itemize @bullet
13843 @item @code{nil}
13844 If an input table looks like it has column names
13845 (because its second row is an hline), then the column
13846 names will be removed from the table before
13847 processing, then reapplied to the results.
13849 @example
13850 #+TBLNAME: less-cols
13851 | a |
13852 |---|
13853 | b |
13854 | c |
13856 #+NAME: echo-table-again
13857 #+BEGIN_SRC python :var tab=less-cols
13858   return [[val + '*' for val in row] for row in tab]
13859 #+END_SRC
13861 #+results: echo-table-again
13862 | a  |
13863 |----|
13864 | b* |
13865 | c* |
13866 @end example
13868 Please note that column names are not removed before the table is indexed
13869 using variable indexing @xref{var, Indexable variable values}.
13871 @item @code{no}
13872 No column name pre-processing takes place
13874 @item @code{yes}
13875 Column names are removed and reapplied as with @code{nil} even if the table
13876 does not ``look like'' it has column names (i.e.@: the second row is not an
13877 hline)
13878 @end itemize
13880 @node rownames, shebang, colnames, Specific header arguments
13881 @subsubsection @code{:rownames}
13883 The @code{:rownames} header argument can take on the values @code{yes}
13884 or @code{no}, with a default value of @code{no}.
13886 @itemize @bullet
13887 @item @code{no}
13888 No row name pre-processing will take place.
13890 @item @code{yes}
13891 The first column of the table is removed from the table before processing,
13892 and is then reapplied to the results.
13894 @example
13895 #+TBLNAME: with-rownames
13896 | one | 1 | 2 | 3 | 4 |  5 |
13897 | two | 6 | 7 | 8 | 9 | 10 |
13899 #+NAME: echo-table-once-again
13900 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
13901   return [[val + 10 for val in row] for row in tab]
13902 #+END_SRC
13904 #+results: echo-table-once-again
13905 | one | 11 | 12 | 13 | 14 | 15 |
13906 | two | 16 | 17 | 18 | 19 | 20 |
13907 @end example
13909 Please note that row names are not removed before the table is indexed using
13910 variable indexing @xref{var, Indexable variable values}.
13912 @end itemize
13914 @node shebang, eval, rownames, Specific header arguments
13915 @subsubsection @code{:shebang}
13917 Setting the @code{:shebang} header argument to a string value
13918 (e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
13919 first line of any tangled file holding the code block, and the file
13920 permissions of the tangled file are set to make it executable.
13922 @node eval,  , shebang, Specific header arguments
13923 @subsubsection @code{:eval}
13924 The @code{:eval} header argument can be used to limit the evaluation of
13925 specific code blocks.  The @code{:eval} header argument can be useful for
13926 protecting against the evaluation of dangerous code blocks or to ensure that
13927 evaluation will require a query regardless of the value of the
13928 @code{org-confirm-babel-evaluate} variable.  The possible values of
13929 @code{:eval} and their effects are shown below.
13931 @table @code
13932 @item never or no
13933 The code block will not be evaluated under any circumstances.
13934 @item query
13935 Evaluation of the code block will require a query.
13936 @item never-export or no-export
13937 The code block will not be evaluated during export but may still be called
13938 interactively.
13939 @item query-export
13940 Evaluation of the code block during export will require a query.
13941 @end table
13943 If this header argument is not set then evaluation is determined by the value
13944 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
13945 security}.
13947 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
13948 @section Results of evaluation
13949 @cindex code block, results of evaluation
13950 @cindex source code, results of evaluation
13952 The way in which results are handled depends on whether a session is invoked,
13953 as well as on whether @code{:results value} or @code{:results output} is
13954 used.  The following table shows the table possibilities.  For a full listing
13955 of the possible results header arguments see @ref{results}.
13957 @multitable @columnfractions 0.26 0.33 0.41
13958 @item @tab @b{Non-session} @tab @b{Session}
13959 @item @code{:results value} @tab value of last expression @tab value of last expression
13960 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
13961 @end multitable
13963 Note: With @code{:results value}, the result in both @code{:session} and
13964 non-session is returned to Org mode as a table (a one- or two-dimensional
13965 vector of strings or numbers) when appropriate.
13967 @subsection Non-session
13968 @subsubsection @code{:results value}
13969 This is the default.  Internally, the value is obtained by wrapping the code
13970 in a function definition in the external language, and evaluating that
13971 function.  Therefore, code should be written as if it were the body of such a
13972 function.  In particular, note that Python does not automatically return a
13973 value from a function unless a @code{return} statement is present, and so a
13974 @samp{return} statement will usually be required in Python.
13976 This is the only one of the four evaluation contexts in which the code is
13977 automatically wrapped in a function definition.
13979 @subsubsection @code{:results output}
13980 The code is passed to the interpreter as an external process, and the
13981 contents of the standard output stream are returned as text.  (In certain
13982 languages this also contains the error output stream; this is an area for
13983 future work.)
13985 @subsection Session
13986 @subsubsection @code{:results value}
13987 The code is passed to an interpreter running as an interactive Emacs inferior
13988 process.  Only languages which provide tools for interactive evaluation of
13989 code have session support, so some language (e.g., C and ditaa) do not
13990 support the @code{:session} header argument, and in other languages (e.g.,
13991 Python and Haskell) which have limitations on the code which may be entered
13992 into interactive sessions, those limitations apply to the code in code blocks
13993 using the @code{:session} header argument as well.
13995 Unless the @code{:results output} option is supplied (see below) the result
13996 returned is the result of the last evaluation performed by the
13997 interpreter.  (This is obtained in a language-specific manner: the value of
13998 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
13999 in R).
14001 @subsubsection @code{:results output}
14002 The code is passed to the interpreter running as an interactive Emacs
14003 inferior process.  The result returned is the concatenation of the sequence of
14004 (text) output from the interactive interpreter.  Notice that this is not
14005 necessarily the same as what would be sent to @code{STDOUT} if the same code
14006 were passed to a non-interactive interpreter running as an external
14007 process.  For example, compare the following two blocks:
14009 @example
14010 #+BEGIN_SRC python :results output
14011  print "hello"
14013  print "bye"
14014 #+END_SRC
14016 #+results:
14017 : hello
14018 : bye
14019 @end example
14021 In non-session mode, the `2' is not printed and does not appear.
14022 @example
14023 #+BEGIN_SRC python :results output :session
14024  print "hello"
14026  print "bye"
14027 #+END_SRC
14029 #+results:
14030 : hello
14031 : 2
14032 : bye
14033 @end example
14035 But in @code{:session} mode, the interactive interpreter receives input `2'
14036 and prints out its value, `2'.  (Indeed, the other print statements are
14037 unnecessary here).
14039 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
14040 @section Noweb reference syntax
14041 @cindex code block, noweb reference
14042 @cindex syntax, noweb
14043 @cindex source code, noweb reference
14045 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
14046 Programming system allows named blocks of code to be referenced by using the
14047 familiar Noweb syntax:
14049 @example
14050 <<code-block-name>>
14051 @end example
14053 When a code block is tangled or evaluated, whether or not ``noweb''
14054 references are expanded depends upon the value of the @code{:noweb} header
14055 argument.  If @code{:noweb yes}, then a Noweb reference is expanded before
14056 evaluation.  If @code{:noweb no}, the default, then the reference is not
14057 expanded before evaluation.  See the @ref{noweb-ref} header argument for
14058 a more flexible way to resolve noweb references.
14060 It is possible to include the @emph{results} of a code block rather than the
14061 body.  This is done by appending parenthesis to the code block name which may
14062 optionally contain arguments to the code block as shown below.
14064 @example
14065 <<code-block-name(optional arguments)>>
14066 @end example
14068 Note: the default value, @code{:noweb no}, was chosen to ensure that
14069 correct code is not broken in a language, such as Ruby, where
14070 @code{<<arg>>} is a syntactically valid construct.  If @code{<<arg>>} is not
14071 syntactically valid in languages that you use, then please consider setting
14072 the default value.
14074 Note: if noweb tangling is slow in large Org-mode files consider setting the
14075 @code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
14076 This will result in faster noweb reference resolution at the expense of not
14077 correctly resolving inherited values of the @code{:noweb-ref} header
14078 argument.
14080 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
14081 @section Key bindings and useful functions
14082 @cindex code block, key bindings
14084 Many common Org mode key sequences are re-bound depending on
14085 the context.
14087 Within a code block, the following key bindings
14088 are active:
14090 @multitable @columnfractions 0.25 0.75
14091 @kindex C-c C-c
14092 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
14093 @kindex C-c C-o
14094 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
14095 @kindex C-up
14096 @item @kbd{C-@key{up}}    @tab @code{org-babel-load-in-session}
14097 @kindex M-down
14098 @item @kbd{M-@key{down}}  @tab @code{org-babel-pop-to-session}
14099 @end multitable
14101 In an Org mode buffer, the following key bindings are active:
14103 @multitable @columnfractions 0.45 0.55
14104 @kindex C-c C-v p
14105 @kindex C-c C-v C-p
14106 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
14107 @kindex C-c C-v n
14108 @kindex C-c C-v C-n
14109 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
14110 @kindex C-c C-v e
14111 @kindex C-c C-v C-e
14112 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
14113 @kindex C-c C-v o
14114 @kindex C-c C-v C-o
14115 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
14116 @kindex C-c C-v v
14117 @kindex C-c C-v C-v
14118 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
14119 @kindex C-c C-v u
14120 @kindex C-c C-v C-u
14121 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
14122 @kindex C-c C-v g
14123 @kindex C-c C-v C-g
14124 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
14125 @kindex C-c C-v r
14126 @kindex C-c C-v C-r
14127 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
14128 @kindex C-c C-v b
14129 @kindex C-c C-v C-b
14130 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14131 @kindex C-c C-v s
14132 @kindex C-c C-v C-s
14133 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14134 @kindex C-c C-v d
14135 @kindex C-c C-v C-d
14136 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
14137 @kindex C-c C-v t
14138 @kindex C-c C-v C-t
14139 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14140 @kindex C-c C-v f
14141 @kindex C-c C-v C-f
14142 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14143 @kindex C-c C-v c
14144 @kindex C-c C-v C-c
14145 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
14146 @kindex C-c C-v j
14147 @kindex C-c C-v C-j
14148 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
14149 @kindex C-c C-v l
14150 @kindex C-c C-v C-l
14151 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
14152 @kindex C-c C-v i
14153 @kindex C-c C-v C-i
14154 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
14155 @kindex C-c C-v I
14156 @kindex C-c C-v C-I
14157 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
14158 @kindex C-c C-v z
14159 @kindex C-c C-v C-z
14160 @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}
14161 @kindex C-c C-v a
14162 @kindex C-c C-v C-a
14163 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14164 @kindex C-c C-v h
14165 @kindex C-c C-v C-h
14166 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
14167 @kindex C-c C-v x
14168 @kindex C-c C-v C-x
14169 @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}
14170 @end multitable
14172 @c When possible these keybindings were extended to work when the control key is
14173 @c kept pressed, resulting in the following additional keybindings.
14175 @c @multitable @columnfractions 0.25 0.75
14176 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14177 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14178 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14179 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14180 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14181 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14182 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14183 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14184 @c @end multitable
14186 @node Batch execution,  , Key bindings and useful functions, Working With Source Code
14187 @section Batch execution
14188 @cindex code block, batch execution
14189 @cindex source code, batch execution
14191 It is possible to call functions from the command line.  This shell
14192 script calls @code{org-babel-tangle} on every one of its arguments.
14194 Be sure to adjust the paths to fit your system.
14196 @example
14197 #!/bin/sh
14198 # -*- mode: shell-script -*-
14200 # tangle files with org-mode
14202 DIR=`pwd`
14203 FILES=""
14204 ORGINSTALL="~/src/org/lisp/org-install.el"
14206 # wrap each argument in the code required to call tangle on it
14207 for i in $@@; do
14208     FILES="$FILES \"$i\""
14209 done
14211 emacs -Q --batch -l $ORGINSTALL \
14212 --eval "(progn
14213 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
14214 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
14215 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
14216 (mapc (lambda (file)
14217        (find-file (expand-file-name file \"$DIR\"))
14218        (org-babel-tangle)
14219        (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
14220 @end example
14222 @node Miscellaneous, Hacking, Working With Source Code, Top
14223 @chapter Miscellaneous
14225 @menu
14226 * Completion::                  M-TAB knows what you need
14227 * Easy Templates::              Quick insertion of structural elements
14228 * Speed keys::                  Electric commands at the beginning of a headline
14229 * Code evaluation security::    Org mode files evaluate inline code
14230 * Customization::               Adapting Org to your taste
14231 * In-buffer settings::          Overview of the #+KEYWORDS
14232 * The very busy C-c C-c key::   When in doubt, press C-c C-c
14233 * Clean view::                  Getting rid of leading stars in the outline
14234 * TTY keys::                    Using Org on a tty
14235 * Interaction::                 Other Emacs packages
14236 * org-crypt.el::                Encrypting Org files
14237 @end menu
14240 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
14241 @section Completion
14242 @cindex completion, of @TeX{} symbols
14243 @cindex completion, of TODO keywords
14244 @cindex completion, of dictionary words
14245 @cindex completion, of option keywords
14246 @cindex completion, of tags
14247 @cindex completion, of property keys
14248 @cindex completion, of link abbreviations
14249 @cindex @TeX{} symbol completion
14250 @cindex TODO keywords completion
14251 @cindex dictionary word completion
14252 @cindex option keyword completion
14253 @cindex tag completion
14254 @cindex link abbreviations, completion of
14256 Emacs would not be Emacs without completion, and Org mode uses it whenever it
14257 makes sense.  If you prefer an @i{iswitchb}- or @i{ido}-like interface for
14258 some of the completion prompts, you can specify your preference by setting at
14259 most one of the variables @code{org-completion-use-iswitchb}
14260 @code{org-completion-use-ido}.
14262 Org supports in-buffer completion.  This type of completion does
14263 not make use of the minibuffer.  You simply type a few letters into
14264 the buffer and use the key to complete text right there.
14266 @table @kbd
14267 @kindex M-@key{TAB}
14268 @item M-@key{TAB}
14269 Complete word at point
14270 @itemize @bullet
14271 @item
14272 At the beginning of a headline, complete TODO keywords.
14273 @item
14274 After @samp{\}, complete @TeX{} symbols supported by the exporter.
14275 @item
14276 After @samp{*}, complete headlines in the current buffer so that they
14277 can be used in search links like @samp{[[*find this headline]]}.
14278 @item
14279 After @samp{:} in a headline, complete tags.  The list of tags is taken
14280 from the variable @code{org-tag-alist} (possibly set through the
14281 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
14282 dynamically from all tags used in the current buffer.
14283 @item
14284 After @samp{:} and not in a headline, complete property keys.  The list
14285 of keys is constructed dynamically from all keys used in the current
14286 buffer.
14287 @item
14288 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
14289 @item
14290 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
14291 @samp{OPTIONS} which set file-specific options for Org mode.  When the
14292 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
14293 will insert example settings for this keyword.
14294 @item
14295 In the line after @samp{#+STARTUP: }, complete startup keywords,
14296 i.e.@: valid keys for this line.
14297 @item
14298 Elsewhere, complete dictionary words using Ispell.
14299 @end itemize
14300 @end table
14302 @node Easy Templates, Speed keys, Completion, Miscellaneous
14303 @section Easy Templates
14304 @cindex template insertion
14305 @cindex insertion, of templates
14307 Org mode supports insertion of empty structural elements (like
14308 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
14309 strokes.  This is achieved through a native template expansion mechanism.
14310 Note that Emacs has several other template mechanisms which could be used in
14311 a similar way, for example @file{yasnippet}.
14313 To insert a structural element, type a @samp{<}, followed by a template
14314 selector and @kbd{@key{TAB}}.  Completion takes effect only when the above
14315 keystrokes are typed on a line by itself.
14317 The following template selectors are currently supported.
14319 @multitable @columnfractions 0.1 0.9
14320 @item @kbd{s} @tab @code{#+begin_src     ... #+end_src}
14321 @item @kbd{e} @tab @code{#+begin_example ... #+end_example}
14322 @item @kbd{q} @tab @code{#+begin_quote   ... #+end_quote}
14323 @item @kbd{v} @tab @code{#+begin_verse   ... #+end_verse}
14324 @item @kbd{c} @tab @code{#+begin_center  ... #+end_center}
14325 @item @kbd{l} @tab @code{#+begin_latex   ... #+end_latex}
14326 @item @kbd{L} @tab @code{#+latex:}
14327 @item @kbd{h} @tab @code{#+begin_html    ... #+end_html}
14328 @item @kbd{H} @tab @code{#+html:}
14329 @item @kbd{a} @tab @code{#+begin_ascii   ... #+end_ascii}
14330 @item @kbd{A} @tab @code{#+ascii:}
14331 @item @kbd{i} @tab @code{#+index:} line
14332 @item @kbd{I} @tab @code{#+include:} line
14333 @end multitable
14335 For example, on an empty line, typing "<e" and then pressing TAB, will expand
14336 into a complete EXAMPLE template.
14338 You can install additional templates by customizing the variable
14339 @code{org-structure-template-alist}.  See the docstring of the variable for
14340 additional details.
14342 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
14343 @section Speed keys
14344 @cindex speed keys
14345 @vindex org-use-speed-commands
14346 @vindex org-speed-commands-user
14348 Single keys can be made to execute commands when the cursor is at the
14349 beginning of a headline, i.e.@: before the first star.  Configure the variable
14350 @code{org-use-speed-commands} to activate this feature.  There is a
14351 pre-defined list of commands, and you can add more such commands using the
14352 variable @code{org-speed-commands-user}.  Speed keys do not only speed up
14353 navigation and other commands, but they also provide an alternative way to
14354 execute commands bound to keys that are not or not easily available on a TTY,
14355 or on a small mobile device with a limited keyboard.
14357 To see which commands are available, activate the feature and press @kbd{?}
14358 with the cursor at the beginning of a headline.
14360 @node Code evaluation security, Customization, Speed keys, Miscellaneous
14361 @section Code evaluation and security issues
14363 Org provides tools to work with the code snippets, including evaluating them.
14365 Running code on your machine always comes with a security risk.  Badly
14366 written or malicious code can be executed on purpose or by accident.  Org has
14367 default settings which will only evaluate such code if you give explicit
14368 permission to do so, and as a casual user of these features you should leave
14369 these precautions intact.
14371 For people who regularly work with such code, the confirmation prompts can
14372 become annoying, and you might want to turn them off.  This can be done, but
14373 you must be aware of the risks that are involved.
14375 Code evaluation can happen under the following circumstances:
14377 @table @i
14378 @item Source code blocks
14379 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
14380 C-c} in the block.  The most important thing to realize here is that Org mode
14381 files which contain code snippets are, in a certain sense, like executable
14382 files.  So you should accept them and load them into Emacs only from trusted
14383 sources---just like you would do with a program you install on your computer.
14385 Make sure you know what you are doing before customizing the variables
14386 which take off the default security brakes.
14388 @defopt org-confirm-babel-evaluate
14389 When t (the default), the user is asked before every code block evaluation.
14390 When nil, the user is not asked.  When set to a function, it is called with
14391 two arguments (language and body of the code block) and should return t to
14392 ask and nil not to ask.
14393 @end defopt
14395 For example, here is how to execute "ditaa" code (which is considered safe)
14396 without asking:
14397 @example
14398 (defun my-org-confirm-babel-evaluate (lang body)
14399   (not (string= lang "ditaa")))  ; don't ask for ditaa
14400 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
14401 @end example
14403 @item Following @code{shell} and @code{elisp} links
14404 Org has two link types that can directly evaluate code (@pxref{External
14405 links}).  These links can be problematic because the code to be evaluated is
14406 not visible.
14408 @defopt org-confirm-shell-link-function
14409 Function to queries user about shell link execution.
14410 @end defopt
14411 @defopt org-confirm-elisp-link-function
14412 Functions to query user for Emacs Lisp link execution.
14413 @end defopt
14415 @item Formulas in tables
14416 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
14417 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
14418 @end table
14420 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
14421 @section Customization
14422 @cindex customization
14423 @cindex options, for customization
14424 @cindex variables, for customization
14426 There are more than 180 variables that can be used to customize
14427 Org.  For the sake of compactness of the manual, I am not
14428 describing the variables here.  A structured overview of customization
14429 variables is available with @kbd{M-x org-customize}.  Or select
14430 @code{Browse Org Group} from the @code{Org->Customization} menu.  Many
14431 settings can also be activated on a per-file basis, by putting special
14432 lines into the buffer (@pxref{In-buffer settings}).
14434 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
14435 @section Summary of in-buffer settings
14436 @cindex in-buffer settings
14437 @cindex special keywords
14439 Org mode uses special lines in the buffer to define settings on a
14440 per-file basis.  These lines start with a @samp{#+} followed by a
14441 keyword, a colon, and then individual words defining a setting.  Several
14442 setting words can be in the same line, but you can also have multiple
14443 lines for the keyword.  While these settings are described throughout
14444 the manual, here is a summary.  After changing any of those lines in the
14445 buffer, press @kbd{C-c C-c} with the cursor still in the line to
14446 activate the changes immediately.  Otherwise they become effective only
14447 when the file is visited again in a new Emacs session.
14449 @vindex org-archive-location
14450 @table @kbd
14451 @item #+ARCHIVE: %s_done::
14452 This line sets the archive location for the agenda file.  It applies for
14453 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
14454 of the file.  The first such line also applies to any entries before it.
14455 The corresponding variable is @code{org-archive-location}.
14456 @item #+CATEGORY:
14457 This line sets the category for the agenda file.  The category applies
14458 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
14459 end of the file.  The first such line also applies to any entries before it.
14460 @item #+COLUMNS: %25ITEM .....
14461 @cindex property, COLUMNS
14462 Set the default format for columns view.  This format applies when
14463 columns view is invoked in locations where no @code{COLUMNS} property
14464 applies.
14465 @item #+CONSTANTS: name1=value1 ...
14466 @vindex org-table-formula-constants
14467 @vindex org-table-formula
14468 Set file-local values for constants to be used in table formulas.  This
14469 line sets the local variable @code{org-table-formula-constants-local}.
14470 The global version of this variable is
14471 @code{org-table-formula-constants}.
14472 @item #+FILETAGS: :tag1:tag2:tag3:
14473 Set tags that can be inherited by any entry in the file, including the
14474 top-level entries.
14475 @item #+DRAWERS: NAME1 .....
14476 @vindex org-drawers
14477 Set the file-local set of drawers.  The corresponding global variable is
14478 @code{org-drawers}.
14479 @item #+LINK:  linkword replace
14480 @vindex org-link-abbrev-alist
14481 These lines (several are allowed) specify link abbreviations.
14482 @xref{Link abbreviations}.  The corresponding variable is
14483 @code{org-link-abbrev-alist}.
14484 @item #+PRIORITIES: highest lowest default
14485 @vindex org-highest-priority
14486 @vindex org-lowest-priority
14487 @vindex org-default-priority
14488 This line sets the limits and the default for the priorities.  All three
14489 must be either letters A-Z or numbers 0-9.  The highest priority must
14490 have a lower ASCII number than the lowest priority.
14491 @item #+PROPERTY: Property_Name Value
14492 This line sets a default inheritance value for entries in the current
14493 buffer, most useful for specifying the allowed values of a property.
14494 @cindex #+SETUPFILE
14495 @item #+SETUPFILE: file
14496 This line defines a file that holds more in-buffer setup.  Normally this is
14497 entirely ignored.  Only when the buffer is parsed for option-setting lines
14498 (i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
14499 settings line, or when exporting), then the contents of this file are parsed
14500 as if they had been included in the buffer.  In particular, the file can be
14501 any other Org mode file with internal setup.  You can visit the file the
14502 cursor is in the line with @kbd{C-c '}.
14503 @item #+STARTUP:
14504 @cindex #+STARTUP:
14505 This line sets options to be used at startup of Org mode, when an
14506 Org file is being visited.
14508 The first set of options deals with the initial visibility of the outline
14509 tree.  The corresponding variable for global default settings is
14510 @code{org-startup-folded}, with a default value @code{t}, which means
14511 @code{overview}.
14512 @vindex org-startup-folded
14513 @cindex @code{overview}, STARTUP keyword
14514 @cindex @code{content}, STARTUP keyword
14515 @cindex @code{showall}, STARTUP keyword
14516 @cindex @code{showeverything}, STARTUP keyword
14517 @example
14518 overview         @r{top-level headlines only}
14519 content          @r{all headlines}
14520 showall          @r{no folding of any entries}
14521 showeverything   @r{show even drawer contents}
14522 @end example
14524 @vindex org-startup-indented
14525 @cindex @code{indent}, STARTUP keyword
14526 @cindex @code{noindent}, STARTUP keyword
14527 Dynamic virtual indentation is controlled by the variable
14528 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
14529 @example
14530 indent     @r{start with @code{org-indent-mode} turned on}
14531 noindent   @r{start with @code{org-indent-mode} turned off}
14532 @end example
14534 @vindex org-startup-align-all-tables
14535 Then there are options for aligning tables upon visiting a file.  This
14536 is useful in files containing narrowed table columns.  The corresponding
14537 variable is @code{org-startup-align-all-tables}, with a default value
14538 @code{nil}.
14539 @cindex @code{align}, STARTUP keyword
14540 @cindex @code{noalign}, STARTUP keyword
14541 @example
14542 align      @r{align all tables}
14543 noalign    @r{don't align tables on startup}
14544 @end example
14546 @vindex org-startup-with-inline-images
14547 When visiting a file, inline images can be automatically displayed.  The
14548 corresponding variable is @code{org-startup-with-inline-images}, with a
14549 default value @code{nil} to avoid delays when visiting a file.
14550 @cindex @code{inlineimages}, STARTUP keyword
14551 @cindex @code{noinlineimages}, STARTUP keyword
14552 @example
14553 inlineimages   @r{show inline images}
14554 noinlineimages @r{don't show inline images on startup}
14555 @end example
14557 @vindex org-log-done
14558 @vindex org-log-note-clock-out
14559 @vindex org-log-repeat
14560 Logging the closing and reopening of TODO items and clock intervals can be
14561 configured using these options (see variables @code{org-log-done},
14562 @code{org-log-note-clock-out} and @code{org-log-repeat})
14563 @cindex @code{logdone}, STARTUP keyword
14564 @cindex @code{lognotedone}, STARTUP keyword
14565 @cindex @code{nologdone}, STARTUP keyword
14566 @cindex @code{lognoteclock-out}, STARTUP keyword
14567 @cindex @code{nolognoteclock-out}, STARTUP keyword
14568 @cindex @code{logrepeat}, STARTUP keyword
14569 @cindex @code{lognoterepeat}, STARTUP keyword
14570 @cindex @code{nologrepeat}, STARTUP keyword
14571 @cindex @code{logreschedule}, STARTUP keyword
14572 @cindex @code{lognotereschedule}, STARTUP keyword
14573 @cindex @code{nologreschedule}, STARTUP keyword
14574 @cindex @code{logredeadline}, STARTUP keyword
14575 @cindex @code{lognoteredeadline}, STARTUP keyword
14576 @cindex @code{nologredeadline}, STARTUP keyword
14577 @cindex @code{logrefile}, STARTUP keyword
14578 @cindex @code{lognoterefile}, STARTUP keyword
14579 @cindex @code{nologrefile}, STARTUP keyword
14580 @example
14581 logdone            @r{record a timestamp when an item is marked DONE}
14582 lognotedone        @r{record timestamp and a note when DONE}
14583 nologdone          @r{don't record when items are marked DONE}
14584 logrepeat          @r{record a time when reinstating a repeating item}
14585 lognoterepeat      @r{record a note when reinstating a repeating item}
14586 nologrepeat        @r{do not record when reinstating repeating item}
14587 lognoteclock-out   @r{record a note when clocking out}
14588 nolognoteclock-out @r{don't record a note when clocking out}
14589 logreschedule      @r{record a timestamp when scheduling time changes}
14590 lognotereschedule  @r{record a note when scheduling time changes}
14591 nologreschedule    @r{do not record when a scheduling date changes}
14592 logredeadline      @r{record a timestamp when deadline changes}
14593 lognoteredeadline  @r{record a note when deadline changes}
14594 nologredeadline    @r{do not record when a deadline date changes}
14595 logrefile          @r{record a timestamp when refiling}
14596 lognoterefile      @r{record a note when refiling}
14597 nologrefile        @r{do not record when refiling}
14598 @end example
14599 @vindex org-hide-leading-stars
14600 @vindex org-odd-levels-only
14601 Here are the options for hiding leading stars in outline headings, and for
14602 indenting outlines.  The corresponding variables are
14603 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
14604 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
14605 @cindex @code{hidestars}, STARTUP keyword
14606 @cindex @code{showstars}, STARTUP keyword
14607 @cindex @code{odd}, STARTUP keyword
14608 @cindex @code{even}, STARTUP keyword
14609 @example
14610 hidestars  @r{make all but one of the stars starting a headline invisible.}
14611 showstars  @r{show all stars starting a headline}
14612 indent     @r{virtual indentation according to outline level}
14613 noindent   @r{no virtual indentation according to outline level}
14614 odd        @r{allow only odd outline levels (1,3,...)}
14615 oddeven    @r{allow all outline levels}
14616 @end example
14617 @vindex org-put-time-stamp-overlays
14618 @vindex org-time-stamp-overlay-formats
14619 To turn on custom format overlays over timestamps (variables
14620 @code{org-put-time-stamp-overlays} and
14621 @code{org-time-stamp-overlay-formats}), use
14622 @cindex @code{customtime}, STARTUP keyword
14623 @example
14624 customtime @r{overlay custom time format}
14625 @end example
14626 @vindex constants-unit-system
14627 The following options influence the table spreadsheet (variable
14628 @code{constants-unit-system}).
14629 @cindex @code{constcgs}, STARTUP keyword
14630 @cindex @code{constSI}, STARTUP keyword
14631 @example
14632 constcgs   @r{@file{constants.el} should use the c-g-s unit system}
14633 constSI    @r{@file{constants.el} should use the SI unit system}
14634 @end example
14635 @vindex org-footnote-define-inline
14636 @vindex org-footnote-auto-label
14637 @vindex org-footnote-auto-adjust
14638 To influence footnote settings, use the following keywords.  The
14639 corresponding variables are @code{org-footnote-define-inline},
14640 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
14641 @cindex @code{fninline}, STARTUP keyword
14642 @cindex @code{nofninline}, STARTUP keyword
14643 @cindex @code{fnlocal}, STARTUP keyword
14644 @cindex @code{fnprompt}, STARTUP keyword
14645 @cindex @code{fnauto}, STARTUP keyword
14646 @cindex @code{fnconfirm}, STARTUP keyword
14647 @cindex @code{fnplain}, STARTUP keyword
14648 @cindex @code{fnadjust}, STARTUP keyword
14649 @cindex @code{nofnadjust}, STARTUP keyword
14650 @example
14651 fninline    @r{define footnotes inline}
14652 fnnoinline  @r{define footnotes in separate section}
14653 fnlocal     @r{define footnotes near first reference, but not inline}
14654 fnprompt    @r{prompt for footnote labels}
14655 fnauto      @r{create @code{[fn:1]}-like labels automatically (default)}
14656 fnconfirm   @r{offer automatic label for editing or confirmation}
14657 fnplain     @r{create @code{[1]}-like labels automatically}
14658 fnadjust    @r{automatically renumber and sort footnotes}
14659 nofnadjust  @r{do not renumber and sort automatically}
14660 @end example
14661 @cindex org-hide-block-startup
14662 To hide blocks on startup, use these keywords.  The corresponding variable is
14663 @code{org-hide-block-startup}.
14664 @cindex @code{hideblocks}, STARTUP keyword
14665 @cindex @code{nohideblocks}, STARTUP keyword
14666 @example
14667 hideblocks   @r{Hide all begin/end blocks on startup}
14668 nohideblocks @r{Do not hide blocks on startup}
14669 @end example
14670 @cindex org-pretty-entities
14671 The display of entities as UTF-8 characters is governed by the variable
14672 @code{org-pretty-entities} and the keywords
14673 @cindex @code{entitiespretty}, STARTUP keyword
14674 @cindex @code{entitiesplain}, STARTUP keyword
14675 @example
14676 entitiespretty  @r{Show entities as UTF-8 characters where possible}
14677 entitiesplain   @r{Leave entities plain}
14678 @end example
14679 @item #+TAGS:  TAG1(c1) TAG2(c2)
14680 @vindex org-tag-alist
14681 These lines (several such lines are allowed) specify the valid tags in
14682 this file, and (potentially) the corresponding @emph{fast tag selection}
14683 keys.  The corresponding variable is @code{org-tag-alist}.
14684 @item #+TBLFM:
14685 This line contains the formulas for the table directly above the line.
14686 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
14687 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
14688 @itemx #+DESCRIPTION:, #+KEYWORDS:,
14689 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
14690 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
14691 These lines provide settings for exporting files.  For more details see
14692 @ref{Export options}.
14693 @item #+TODO:    #+SEQ_TODO:   #+TYP_TODO:
14694 @vindex org-todo-keywords
14695 These lines set the TODO keywords and their interpretation in the
14696 current file.  The corresponding variable is @code{org-todo-keywords}.
14697 @end table
14699 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
14700 @section The very busy C-c C-c key
14701 @kindex C-c C-c
14702 @cindex C-c C-c, overview
14704 The key @kbd{C-c C-c} has many purposes in Org, which are all
14705 mentioned scattered throughout this manual.  One specific function of
14706 this key is to add @emph{tags} to a headline (@pxref{Tags}).  In many
14707 other circumstances it means something like @emph{``Hey Org, look
14708 here and update according to what you see here''}.  Here is a summary of
14709 what this means in different contexts.
14711 @itemize @minus
14712 @item
14713 If there are highlights in the buffer from the creation of a sparse
14714 tree, or from clock display, remove these highlights.
14715 @item
14716 If the cursor is in one of the special @code{#+KEYWORD} lines, this
14717 triggers scanning the buffer for these lines and updating the
14718 information.
14719 @item
14720 If the cursor is inside a table, realign the table.  This command
14721 works even if the automatic table editor has been turned off.
14722 @item
14723 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
14724 the entire table.
14725 @item
14726 If the current buffer is a capture buffer, close the note and file it.
14727 With a prefix argument, file it, without further interaction, to the
14728 default location.
14729 @item
14730 If the cursor is on a @code{<<<target>>>}, update radio targets and
14731 corresponding links in this buffer.
14732 @item
14733 If the cursor is in a property line or at the start or end of a property
14734 drawer, offer property commands.
14735 @item
14736 If the cursor is at a footnote reference, go to the corresponding
14737 definition, and vice versa.
14738 @item
14739 If the cursor is on a statistics cookie, update it.
14740 @item
14741 If the cursor is in a plain list item with a checkbox, toggle the status
14742 of the checkbox.
14743 @item
14744 If the cursor is on a numbered item in a plain list, renumber the
14745 ordered list.
14746 @item
14747 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
14748 block is updated.
14749 @item
14750 If the cursor is at a timestamp, fix the day name in the timestamp.
14751 @end itemize
14753 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
14754 @section A cleaner outline view
14755 @cindex hiding leading stars
14756 @cindex dynamic indentation
14757 @cindex odd-levels-only outlines
14758 @cindex clean outline view
14760 Some people find it noisy and distracting that the Org headlines start with a
14761 potentially large number of stars, and that text below the headlines is not
14762 indented.  While this is no problem when writing a @emph{book-like} document
14763 where the outline headings are really section headings, in a more
14764 @emph{list-oriented} outline, indented structure is a lot cleaner:
14766 @example
14767 @group
14768 * Top level headline             |    * Top level headline
14769 ** Second level                  |      * Second level
14770 *** 3rd level                    |        * 3rd level
14771 some text                        |          some text
14772 *** 3rd level                    |        * 3rd level
14773 more text                        |          more text
14774 * Another top level headline     |    * Another top level headline
14775 @end group
14776 @end example
14778 @noindent
14780 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
14781 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
14782 be achieved dynamically at display time using @code{org-indent-mode}.  In
14783 this minor mode, all lines are prefixed for display with the necessary amount
14784 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
14785 property, such that @code{visual-line-mode} (or purely setting
14786 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
14787 }.  Also headlines are prefixed with additional stars, so that the amount of
14788 indentation shifts by two@footnote{See the variable
14789 @code{org-indent-indentation-per-level}.}  spaces per level.  All headline
14790 stars but the last one are made invisible using the @code{org-hide}
14791 face@footnote{Turning on @code{org-indent-mode} sets
14792 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
14793 @code{nil}.} - see below under @samp{2.} for more information on how this
14794 works.  You can turn on @code{org-indent-mode} for all files by customizing
14795 the variable @code{org-startup-indented}, or you can turn it on for
14796 individual files using
14798 @example
14799 #+STARTUP: indent
14800 @end example
14802 If you want a similar effect in an earlier version of Emacs and/or Org, or if
14803 you want the indentation to be hard space characters so that the plain text
14804 file looks as similar as possible to the Emacs display, Org supports you in
14805 the following way:
14807 @enumerate
14808 @item
14809 @emph{Indentation of text below headlines}@*
14810 You may indent text below each headline to make the left boundary line up
14811 with the headline, like
14813 @example
14814 *** 3rd level
14815     more text, now indented
14816 @end example
14818 @vindex org-adapt-indentation
14819 Org supports this with paragraph filling, line wrapping, and structure
14820 editing@footnote{See also the variable @code{org-adapt-indentation}.},
14821 preserving or adapting the indentation as appropriate.
14823 @item
14824 @vindex org-hide-leading-stars
14825 @emph{Hiding leading stars}@* You can modify the display in such a way that
14826 all leading stars become invisible.  To do this in a global way, configure
14827 the variable @code{org-hide-leading-stars} or change this on a per-file basis
14828 with
14830 @example
14831 #+STARTUP: hidestars
14832 #+STARTUP: showstars
14833 @end example
14835 With hidden stars, the tree becomes:
14837 @example
14838 @group
14839 * Top level headline
14840  * Second level
14841   * 3rd level
14842   ...
14843 @end group
14844 @end example
14846 @noindent
14847 @vindex org-hide @r{(face)}
14848 The leading stars are not truly replaced by whitespace, they are only
14849 fontified with the face @code{org-hide} that uses the background color as
14850 font color.  If you are not using either white or black background, you may
14851 have to customize this face to get the wanted effect.  Another possibility is
14852 to set this font such that the extra stars are @i{almost} invisible, for
14853 example using the color @code{grey90} on a white background.
14855 @item
14856 @vindex org-odd-levels-only
14857 Things become cleaner still if you skip all the even levels and use only odd
14858 levels 1, 3, 5..., effectively adding two stars to go from one outline level
14859 to the next@footnote{When you need to specify a level for a property search
14860 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}.  In this
14861 way we get the outline view shown at the beginning of this section.  In order
14862 to make the structure editing and export commands handle this convention
14863 correctly, configure the variable @code{org-odd-levels-only}, or set this on
14864 a per-file basis with one of the following lines:
14866 @example
14867 #+STARTUP: odd
14868 #+STARTUP: oddeven
14869 @end example
14871 You can convert an Org file from single-star-per-level to the
14872 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
14873 RET} in that file.  The reverse operation is @kbd{M-x
14874 org-convert-to-oddeven-levels}.
14875 @end enumerate
14877 @node TTY keys, Interaction, Clean view, Miscellaneous
14878 @section Using Org on a tty
14879 @cindex tty key bindings
14881 Because Org contains a large number of commands, by default many of
14882 Org's core commands are bound to keys that are generally not
14883 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
14884 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
14885 together with modifiers like @key{Meta} and/or @key{Shift}.  To access
14886 these commands on a tty when special keys are unavailable, the following
14887 alternative bindings can be used.  The tty bindings below will likely be
14888 more cumbersome; you may find for some of the bindings below that a
14889 customized workaround suits you better.  For example, changing a timestamp
14890 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
14891 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
14893 @multitable @columnfractions 0.15 0.2 0.1 0.2
14894 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
14895 @item @kbd{S-@key{TAB}}     @tab @kbd{C-u @key{TAB}}       @tab @kbd{C} @tab
14896 @item @kbd{M-@key{left}}    @tab @kbd{C-c C-x l}           @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
14897 @item @kbd{M-S-@key{left}}  @tab @kbd{C-c C-x L}           @tab @kbd{L} @tab
14898 @item @kbd{M-@key{right}}   @tab @kbd{C-c C-x r}           @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
14899 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R}           @tab @kbd{R} @tab
14900 @item @kbd{M-@key{up}}      @tab @kbd{C-c C-x u}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
14901 @item @kbd{M-S-@key{up}}    @tab @kbd{C-c C-x U}           @tab @kbd{U} @tab
14902 @item @kbd{M-@key{down}}    @tab @kbd{C-c C-x d}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
14903 @item @kbd{M-S-@key{down}}  @tab @kbd{C-c C-x D}           @tab @kbd{D} @tab
14904 @item @kbd{S-@key{RET}}     @tab @kbd{C-c C-x c}           @tab @kbd{ } @tab
14905 @item @kbd{M-@key{RET}}     @tab @kbd{C-c C-x m}           @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
14906 @item @kbd{M-S-@key{RET}}   @tab @kbd{C-c C-x M}           @tab @kbd{ } @tab
14907 @item @kbd{S-@key{left}}    @tab @kbd{C-c @key{left}}      @tab @kbd{ } @tab
14908 @item @kbd{S-@key{right}}   @tab @kbd{C-c @key{right}}     @tab @kbd{ } @tab
14909 @item @kbd{S-@key{up}}      @tab @kbd{C-c @key{up}}        @tab @kbd{ } @tab
14910 @item @kbd{S-@key{down}}    @tab @kbd{C-c @key{down}}      @tab @kbd{ } @tab
14911 @item @kbd{C-S-@key{left}}  @tab @kbd{C-c C-x @key{left}}  @tab @kbd{ } @tab
14912 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
14913 @end multitable
14916 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
14917 @section Interaction with other packages
14918 @cindex packages, interaction with other
14919 Org lives in the world of GNU Emacs and interacts in various ways
14920 with other code out there.
14922 @menu
14923 * Cooperation::                 Packages Org cooperates with
14924 * Conflicts::                   Packages that lead to conflicts
14925 @end menu
14927 @node Cooperation, Conflicts, Interaction, Interaction
14928 @subsection Packages that Org cooperates with
14930 @table @asis
14931 @cindex @file{calc.el}
14932 @cindex Gillespie, Dave
14933 @item @file{calc.el} by Dave Gillespie
14934 Org uses the Calc package for implementing spreadsheet
14935 functionality in its tables (@pxref{The spreadsheet}).  Org
14936 checks for the availability of Calc by looking for the function
14937 @code{calc-eval} which will have been autoloaded during setup if Calc has
14938 been installed properly.  As of Emacs 22, Calc is part of the Emacs
14939 distribution.  Another possibility for interaction between the two
14940 packages is using Calc for embedded calculations.  @xref{Embedded Mode,
14941 , Embedded Mode, calc, GNU Emacs Calc Manual}.
14942 @item @file{constants.el} by Carsten Dominik
14943 @cindex @file{constants.el}
14944 @cindex Dominik, Carsten
14945 @vindex org-table-formula-constants
14946 In a table formula (@pxref{The spreadsheet}), it is possible to use
14947 names for natural constants or units.  Instead of defining your own
14948 constants in the variable @code{org-table-formula-constants}, install
14949 the @file{constants} package which defines a large number of constants
14950 and units, and lets you use unit prefixes like @samp{M} for
14951 @samp{Mega}, etc@.  You will need version 2.0 of this package, available
14952 at @url{http://www.astro.uva.nl/~dominik/Tools}.  Org checks for
14953 the function @code{constants-get}, which has to be autoloaded in your
14954 setup.  See the installation instructions in the file
14955 @file{constants.el}.
14956 @item @file{cdlatex.el} by Carsten Dominik
14957 @cindex @file{cdlatex.el}
14958 @cindex Dominik, Carsten
14959 Org mode can make use of the CD@LaTeX{} package to efficiently enter
14960 @LaTeX{} fragments into Org files.  See @ref{CDLaTeX mode}.
14961 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
14962 @cindex @file{imenu.el}
14963 Imenu allows menu access to an index of items in a file.  Org mode
14964 supports Imenu---all you need to do to get the index is the following:
14965 @lisp
14966 (add-hook 'org-mode-hook
14967           (lambda () (imenu-add-to-menubar "Imenu")))
14968 @end lisp
14969 @vindex org-imenu-depth
14970 By default the index is two levels deep---you can modify the depth using
14971 the option @code{org-imenu-depth}.
14972 @item @file{remember.el} by John Wiegley
14973 @cindex @file{remember.el}
14974 @cindex Wiegley, John
14975 Org used to use this package for capture, but no longer does.
14976 @item @file{speedbar.el} by Eric M. Ludlam
14977 @cindex @file{speedbar.el}
14978 @cindex Ludlam, Eric M.
14979 Speedbar is a package that creates a special frame displaying files and
14980 index items in files.  Org mode supports Speedbar and allows you to
14981 drill into Org files directly from the Speedbar.  It also allows you to
14982 restrict the scope of agenda commands to a file or a subtree by using
14983 the command @kbd{<} in the Speedbar frame.
14984 @cindex @file{table.el}
14985 @item @file{table.el} by Takaaki Ota
14986 @kindex C-c C-c
14987 @cindex table editor, @file{table.el}
14988 @cindex @file{table.el}
14989 @cindex Ota, Takaaki
14991 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
14992 and alignment can be created using the Emacs table package by Takaaki Ota
14993 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
14994 Org mode will recognize these tables and export them properly.  Because of
14995 interference with other Org mode functionality, you unfortunately cannot edit
14996 these tables directly in the buffer.  Instead, you need to use the command
14997 @kbd{C-c '} to edit them, similar to source code snippets.
14999 @table @kbd
15000 @orgcmd{C-c ',org-edit-special}
15001 Edit a @file{table.el} table.  Works when the cursor is in a table.el table.
15003 @orgcmd{C-c ~,org-table-create-with-table.el}
15004 Insert a @file{table.el} table.  If there is already a table at point, this
15005 command converts it between the @file{table.el} format and the Org mode
15006 format.  See the documentation string of the command
15007 @code{org-convert-table} for the restrictions under which this is
15008 possible.
15009 @end table
15010 @file{table.el} is part of Emacs since Emacs 22.
15011 @item @file{footnote.el} by Steven L. Baur
15012 @cindex @file{footnote.el}
15013 @cindex Baur, Steven L.
15014 Org mode recognizes numerical footnotes as provided by this package.
15015 However, Org mode also has its own footnote support (@pxref{Footnotes}),
15016 which makes using @file{footnote.el} unnecessary.
15017 @end table
15019 @node Conflicts,  , Cooperation, Interaction
15020 @subsection Packages that lead to conflicts with Org mode
15022 @table @asis
15024 @cindex @code{shift-selection-mode}
15025 @vindex org-support-shift-select
15026 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
15027 cursor motions combined with the shift key should start or enlarge regions.
15028 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
15029 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
15030 at such a location.  By default, @kbd{S-@key{cursor}} commands outside
15031 special contexts don't do anything, but you can customize the variable
15032 @code{org-support-shift-select}.  Org mode then tries to accommodate shift
15033 selection by (i) using it outside of the special contexts where special
15034 commands apply, and by (ii) extending an existing active region even if the
15035 cursor moves across a special context.
15037 @item @file{CUA.el} by Kim. F. Storm
15038 @cindex @file{CUA.el}
15039 @cindex Storm, Kim. F.
15040 @vindex org-replace-disputed-keys
15041 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
15042 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
15043 region.  In fact, Emacs 23 has this built-in in the form of
15044 @code{shift-selection-mode}, see previous paragraph.  If you are using Emacs
15045 23, you probably don't want to use another package for this purpose.  However,
15046 if you prefer to leave these keys to a different package while working in
15047 Org mode, configure the variable @code{org-replace-disputed-keys}.  When set,
15048 Org will move the following key bindings in Org files, and in the agenda
15049 buffer (but not during date selection).
15051 @example
15052 S-UP      @result{}  M-p             S-DOWN     @result{}  M-n
15053 S-LEFT    @result{}  M--             S-RIGHT    @result{}  M-+
15054 C-S-LEFT  @result{}  M-S--           C-S-RIGHT  @result{}  M-S-+
15055 @end example
15057 @vindex org-disputed-keys
15058 Yes, these are unfortunately more difficult to remember.  If you want
15059 to have other replacement keys, look at the variable
15060 @code{org-disputed-keys}.
15062 @item @file{yasnippet.el}
15063 @cindex @file{yasnippet.el}
15064 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
15065 @code{"\t"}) overrules YASnippet's access to this key.  The following code
15066 fixed this problem:
15068 @lisp
15069 (add-hook 'org-mode-hook
15070           (lambda ()
15071             (org-set-local 'yas/trigger-key [tab])
15072             (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
15073 @end lisp
15075 The latest version of yasnippet doesn't play well with Org mode.  If the
15076 above code does not fix the conflict, start by defining the following
15077 function:
15079 @lisp
15080 (defun yas/org-very-safe-expand ()
15081        (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
15082 @end lisp
15084 Then, tell Org mode what to do with the new function:
15086 @lisp
15087 (add-hook 'org-mode-hook
15088           (lambda ()
15089               (make-variable-buffer-local 'yas/trigger-key)
15090               (setq yas/trigger-key [tab])
15091               (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
15092               (define-key yas/keymap [tab] 'yas/next-field)))
15093 @end lisp
15095 @item @file{windmove.el} by Hovav Shacham
15096 @cindex @file{windmove.el}
15097 This package also uses the @kbd{S-<cursor>} keys, so everything written
15098 in the paragraph above about CUA mode also applies here.  If you want make
15099 the windmove function active in locations where Org mode does not have
15100 special functionality on @kbd{S-@key{cursor}}, add this to your
15101 configuration:
15103 @lisp
15104 ;; Make windmove work in org-mode:
15105 (add-hook 'org-shiftup-final-hook 'windmove-up)
15106 (add-hook 'org-shiftleft-final-hook 'windmove-left)
15107 (add-hook 'org-shiftdown-final-hook 'windmove-down)
15108 (add-hook 'org-shiftright-final-hook 'windmove-right)
15109 @end lisp
15111 @item @file{viper.el} by Michael Kifer
15112 @cindex @file{viper.el}
15113 @kindex C-c /
15114 Viper uses @kbd{C-c /} and therefore makes this key not access the
15115 corresponding Org mode command @code{org-sparse-tree}.  You need to find
15116 another key for this command, or override the key in
15117 @code{viper-vi-global-user-map} with
15119 @lisp
15120 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
15121 @end lisp
15123 @end table
15125 @node org-crypt.el,  , Interaction, Miscellaneous
15126 @section org-crypt.el
15127 @cindex @file{org-crypt.el}
15128 @cindex @code{org-decrypt-entry}
15130 Org-crypt will encrypt the text of an entry, but not the headline, or
15131 properties.  Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
15132 files.
15134 Any text below a headline that has a @samp{:crypt:} tag will be automatically
15135 be encrypted when the file is saved.  If you want to use a different tag just
15136 customize the @code{org-crypt-tag-matcher} setting.
15138 To use org-crypt it is suggested that you have the following in your
15139 @file{.emacs}:
15141 @example
15142 (require 'org-crypt)
15143 (org-crypt-use-before-save-magic)
15144 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
15146 (setq org-crypt-key nil)
15147   ;; GPG key to use for encryption
15148   ;; Either the Key ID or set to nil to use symmetric encryption.
15150 (setq auto-save-default nil)
15151   ;; Auto-saving does not cooperate with org-crypt.el: so you need
15152   ;; to turn it off if you plan to use org-crypt.el quite often.
15153   ;; Otherwise, you'll get an (annoying) message each time you
15154   ;; start Org.
15156   ;; To turn it off only locally, you can insert this:
15157   ;;
15158   ;; # -*- buffer-auto-save-file-name: nil; -*-
15159 @end example
15161 Excluding the crypt tag from inheritance prevents already encrypted text
15162 being encrypted again.
15164 @node Hacking, MobileOrg, Miscellaneous, Top
15165 @appendix Hacking
15166 @cindex hacking
15168 This appendix covers some aspects where users can extend the functionality of
15169 Org.
15171 @menu
15172 * Hooks::                       Who to reach into Org's internals
15173 * Add-on packages::             Available extensions
15174 * Adding hyperlink types::      New custom link types
15175 * Context-sensitive commands::  How to add functionality to such commands
15176 * Tables in arbitrary syntax::  Orgtbl for @LaTeX{} and other programs
15177 * Dynamic blocks::              Automatically filled blocks
15178 * Special agenda views::        Customized views
15179 * Extracting agenda information::  Postprocessing of agenda information
15180 * Using the property API::      Writing programs that use entry properties
15181 * Using the mapping API::       Mapping over all or selected entries
15182 @end menu
15184 @node Hooks, Add-on packages, Hacking, Hacking
15185 @section Hooks
15186 @cindex hooks
15188 Org has a large number of hook variables that can be used to add
15189 functionality.  This appendix about hacking is going to illustrate the
15190 use of some of them.  A complete list of all hooks with documentation is
15191 maintained by the Worg project and can be found at
15192 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
15194 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
15195 @section Add-on packages
15196 @cindex add-on packages
15198 A large number of add-on packages have been written by various authors.
15199 These packages are not part of Emacs, but they are distributed as contributed
15200 packages with the separate release available at the Org mode home page at
15201 @uref{http://orgmode.org}.  The list of contributed packages, along with
15202 documentation about each package, is maintained by the Worg project at
15203 @uref{http://orgmode.org/worg/org-contrib/}.
15207 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
15208 @section Adding hyperlink types
15209 @cindex hyperlinks, adding new types
15211 Org has a large number of hyperlink types built-in
15212 (@pxref{Hyperlinks}).  If you would like to add new link types, Org
15213 provides an interface for doing so.  Let's look at an example file,
15214 @file{org-man.el}, that will add support for creating links like
15215 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
15216 Emacs:
15218 @lisp
15219 ;;; org-man.el - Support for links to manpages in Org
15221 (require 'org)
15223 (org-add-link-type "man" 'org-man-open)
15224 (add-hook 'org-store-link-functions 'org-man-store-link)
15226 (defcustom org-man-command 'man
15227   "The Emacs command to be used to display a man page."
15228   :group 'org-link
15229   :type '(choice (const man) (const woman)))
15231 (defun org-man-open (path)
15232   "Visit the manpage on PATH.
15233 PATH should be a topic that can be thrown at the man command."
15234   (funcall org-man-command path))
15236 (defun org-man-store-link ()
15237   "Store a link to a manpage."
15238   (when (memq major-mode '(Man-mode woman-mode))
15239     ;; This is a man page, we do make this link
15240     (let* ((page (org-man-get-page-name))
15241            (link (concat "man:" page))
15242            (description (format "Manpage for %s" page)))
15243       (org-store-link-props
15244        :type "man"
15245        :link link
15246        :description description))))
15248 (defun org-man-get-page-name ()
15249   "Extract the page name from the buffer name."
15250   ;; This works for both `Man-mode' and `woman-mode'.
15251   (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
15252       (match-string 1 (buffer-name))
15253     (error "Cannot create link to this man page")))
15255 (provide 'org-man)
15257 ;;; org-man.el ends here
15258 @end lisp
15260 @noindent
15261 You would activate this new link type in @file{.emacs} with
15263 @lisp
15264 (require 'org-man)
15265 @end lisp
15267 @noindent
15268 Let's go through the file and see what it does.
15269 @enumerate
15270 @item
15271 It does @code{(require 'org)} to make sure that @file{org.el} has been
15272 loaded.
15273 @item
15274 The next line calls @code{org-add-link-type} to define a new link type
15275 with prefix @samp{man}.  The call also contains the name of a function
15276 that will be called to follow such a link.
15277 @item
15278 @vindex org-store-link-functions
15279 The next line adds a function to @code{org-store-link-functions}, in
15280 order to allow the command @kbd{C-c l} to record a useful link in a
15281 buffer displaying a man page.
15282 @end enumerate
15284 The rest of the file defines the necessary variables and functions.
15285 First there is a customization variable that determines which Emacs
15286 command should be used to display man pages.  There are two options,
15287 @code{man} and @code{woman}.  Then the function to follow a link is
15288 defined.  It gets the link path as an argument---in this case the link
15289 path is just a topic for the manual command.  The function calls the
15290 value of @code{org-man-command} to display the man page.
15292 Finally the function @code{org-man-store-link} is defined.  When you try
15293 to store a link with @kbd{C-c l}, this function will be called to
15294 try to make a link.  The function must first decide if it is supposed to
15295 create the link for this buffer type; we do this by checking the value
15296 of the variable @code{major-mode}.  If not, the function must exit and
15297 return the value @code{nil}.  If yes, the link is created by getting the
15298 manual topic from the buffer name and prefixing it with the string
15299 @samp{man:}.  Then it must call the command @code{org-store-link-props}
15300 and set the @code{:type} and @code{:link} properties.  Optionally you
15301 can also set the @code{:description} property to provide a default for
15302 the link description when the link is later inserted into an Org
15303 buffer with @kbd{C-c C-l}.
15305 When it makes sense for your new link type, you may also define a function
15306 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
15307 support for inserting such a link with @kbd{C-c C-l}.  Such a function should
15308 not accept any arguments, and return the full link with prefix.
15310 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
15311 @section Context-sensitive commands
15312 @cindex context-sensitive commands, hooks
15313 @cindex add-ons, context-sensitive commands
15314 @vindex org-ctrl-c-ctrl-c-hook
15316 Org has several commands that act differently depending on context.  The most
15317 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
15318 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
15320 Add-ons can tap into this functionality by providing a function that detects
15321 special context for that add-on and executes functionality appropriate for
15322 the context.  Here is an example from Dan Davison's @file{org-R.el} which
15323 allows you to evaluate commands based on the @file{R} programming language
15324 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
15325 described in @ref{Working With Source Code} and is now obsolete.}.  For this
15326 package, special contexts are lines that start with @code{#+R:} or
15327 @code{#+RR:}.
15329 @lisp
15330 (defun org-R-apply-maybe ()
15331   "Detect if this is context for org-R and execute R commands."
15332   (if (save-excursion
15333         (beginning-of-line 1)
15334         (looking-at "#\\+RR?:"))
15335       (progn (call-interactively 'org-R-apply)
15336              t) ;; to signal that we took action
15337     nil)) ;; to signal that we did not
15339 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
15340 @end lisp
15342 The function first checks if the cursor is in such a line.  If that is the
15343 case, @code{org-R-apply} is called and the function returns @code{t} to
15344 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
15345 contexts.  If the function finds it should do nothing locally, it returns
15346 @code{nil} so that other, similar functions can have a try.
15349 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
15350 @section Tables and lists in arbitrary syntax
15351 @cindex tables, in other modes
15352 @cindex lists, in other modes
15353 @cindex Orgtbl mode
15355 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
15356 frequent feature request has been to make it work with native tables in
15357 specific languages, for example @LaTeX{}.  However, this is extremely
15358 hard to do in a general way, would lead to a customization nightmare,
15359 and would take away much of the simplicity of the Orgtbl mode table
15360 editor.
15362 This appendix describes a different approach.  We keep the Orgtbl mode
15363 table in its native format (the @i{source table}), and use a custom
15364 function to @i{translate} the table to the correct syntax, and to
15365 @i{install} it in the right location (the @i{target table}).  This puts
15366 the burden of writing conversion functions on the user, but it allows
15367 for a very flexible system.
15369 Bastien added the ability to do the same with lists, in Orgstruct mode.  You
15370 can use Org's facilities to edit and structure lists by turning
15371 @code{orgstruct-mode} on, then locally exporting such lists in another format
15372 (HTML, @LaTeX{} or Texinfo.)
15375 @menu
15376 * Radio tables::                Sending and receiving radio tables
15377 * A @LaTeX{} example::          Step by step, almost a tutorial
15378 * Translator functions::        Copy and modify
15379 * Radio lists::                 Doing the same for lists
15380 @end menu
15382 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
15383 @subsection Radio tables
15384 @cindex radio tables
15386 To define the location of the target table, you first need to create two
15387 lines that are comments in the current mode, but contain magic words for
15388 Orgtbl mode to find.  Orgtbl mode will insert the translated table
15389 between these lines, replacing whatever was there before.  For example:
15391 @example
15392 /* BEGIN RECEIVE ORGTBL table_name */
15393 /* END RECEIVE ORGTBL table_name */
15394 @end example
15396 @noindent
15397 Just above the source table, we put a special line that tells
15398 Orgtbl mode how to translate this table and where to install it.  For
15399 example:
15400 @cindex #+ORGTBL
15401 @example
15402 #+ORGTBL: SEND table_name translation_function arguments....
15403 @end example
15405 @noindent
15406 @code{table_name} is the reference name for the table that is also used
15407 in the receiver lines.  @code{translation_function} is the Lisp function
15408 that does the translation.  Furthermore, the line can contain a list of
15409 arguments (alternating key and value) at the end.  The arguments will be
15410 passed as a property list to the translation function for
15411 interpretation.  A few standard parameters are already recognized and
15412 acted upon before the translation function is called:
15414 @table @code
15415 @item :skip N
15416 Skip the first N lines of the table.  Hlines do count as separate lines for
15417 this parameter!
15419 @item :skipcols (n1 n2 ...)
15420 List of columns that should be skipped.  If the table has a column with
15421 calculation marks, that column is automatically discarded as well.
15422 Please note that the translator function sees the table @emph{after} the
15423 removal of these columns, the function never knows that there have been
15424 additional columns.
15425 @end table
15427 @noindent
15428 The one problem remaining is how to keep the source table in the buffer
15429 without disturbing the normal workings of the file, for example during
15430 compilation of a C file or processing of a @LaTeX{} file.  There are a
15431 number of different solutions:
15433 @itemize @bullet
15434 @item
15435 The table could be placed in a block comment if that is supported by the
15436 language.  For example, in C mode you could wrap the table between
15437 @samp{/*} and @samp{*/} lines.
15438 @item
15439 Sometimes it is possible to put the table after some kind of @i{END}
15440 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
15441 in @LaTeX{}.
15442 @item
15443 You can just comment the table line-by-line whenever you want to process
15444 the file, and uncomment it whenever you need to edit the table.  This
15445 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
15446 makes this comment-toggling very easy, in particular if you bind it to a
15447 key.
15448 @end itemize
15450 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
15451 @subsection A @LaTeX{} example of radio tables
15452 @cindex @LaTeX{}, and Orgtbl mode
15454 The best way to wrap the source table in @LaTeX{} is to use the
15455 @code{comment} environment provided by @file{comment.sty}.  It has to be
15456 activated by placing @code{\usepackage@{comment@}} into the document
15457 header.  Orgtbl mode can insert a radio table skeleton@footnote{By
15458 default this works only for @LaTeX{}, HTML, and Texinfo.  Configure the
15459 variable @code{orgtbl-radio-tables} to install templates for other
15460 modes.}  with the command @kbd{M-x orgtbl-insert-radio-table}.  You will
15461 be prompted for a table name, let's say we use @samp{salesfigures}.  You
15462 will then get the following template:
15464 @cindex #+ORGTBL, SEND
15465 @example
15466 % BEGIN RECEIVE ORGTBL salesfigures
15467 % END RECEIVE ORGTBL salesfigures
15468 \begin@{comment@}
15469 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15470 | | |
15471 \end@{comment@}
15472 @end example
15474 @noindent
15475 @vindex @LaTeX{}-verbatim-environments
15476 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
15477 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
15478 into the receiver location with name @code{salesfigures}.  You may now
15479 fill in the table---feel free to use the spreadsheet features@footnote{If
15480 the @samp{#+TBLFM} line contains an odd number of dollar characters,
15481 this may cause problems with font-lock in @LaTeX{} mode.  As shown in the
15482 example you can fix this by adding an extra line inside the
15483 @code{comment} environment that is used to balance the dollar
15484 expressions.  If you are using AUC@TeX{} with the font-latex library, a
15485 much better solution is to add the @code{comment} environment to the
15486 variable @code{LaTeX-verbatim-environments}.}:
15488 @example
15489 % BEGIN RECEIVE ORGTBL salesfigures
15490 % END RECEIVE ORGTBL salesfigures
15491 \begin@{comment@}
15492 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15493 | Month | Days | Nr sold | per day |
15494 |-------+------+---------+---------|
15495 | Jan   |   23 |      55 |     2.4 |
15496 | Feb   |   21 |      16 |     0.8 |
15497 | March |   22 |     278 |    12.6 |
15498 #+TBLFM: $4=$3/$2;%.1f
15499 % $ (optional extra dollar to keep font-lock happy, see footnote)
15500 \end@{comment@}
15501 @end example
15503 @noindent
15504 When you are done, press @kbd{C-c C-c} in the table to get the converted
15505 table inserted between the two marker lines.
15507 Now let's assume you want to make the table header by hand, because you
15508 want to control how columns are aligned, etc@.  In this case we make sure
15509 that the table translator skips the first 2 lines of the source
15510 table, and tell the command to work as a @i{splice}, i.e.@: to not produce
15511 header and footer commands of the target table:
15513 @example
15514 \begin@{tabular@}@{lrrr@}
15515 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
15516 % BEGIN RECEIVE ORGTBL salesfigures
15517 % END RECEIVE ORGTBL salesfigures
15518 \end@{tabular@}
15520 \begin@{comment@}
15521 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
15522 | Month | Days | Nr sold | per day |
15523 |-------+------+---------+---------|
15524 | Jan   |   23 |      55 |     2.4 |
15525 | Feb   |   21 |      16 |     0.8 |
15526 | March |   22 |     278 |    12.6 |
15527 #+TBLFM: $4=$3/$2;%.1f
15528 \end@{comment@}
15529 @end example
15531 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
15532 Orgtbl mode.  It uses a @code{tabular} environment to typeset the table
15533 and marks horizontal lines with @code{\hline}.  Furthermore, it
15534 interprets the following parameters (see also @pxref{Translator functions}):
15536 @table @code
15537 @item :splice nil/t
15538 When set to t, return only table body lines, don't wrap them into a
15539 tabular environment.  Default is nil.
15541 @item :fmt fmt
15542 A format to be used to wrap each field, it should contain @code{%s} for the
15543 original field value.  For example, to wrap each field value in dollars,
15544 you could use @code{:fmt "$%s$"}.  This may also be a property list with
15545 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
15546 A function of one argument can be used in place of the strings; the
15547 function must return a formatted string.
15549 @item :efmt efmt
15550 Use this format to print numbers with exponentials.  The format should
15551 have @code{%s} twice for inserting mantissa and exponent, for example
15552 @code{"%s\\times10^@{%s@}"}.  The default is @code{"%s\\,(%s)"}.  This
15553 may also be a property list with column numbers and formats, for example
15554 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}.  After
15555 @code{efmt} has been applied to a value, @code{fmt} will also be
15556 applied.  Similar to @code{fmt}, functions of two arguments can be
15557 supplied instead of strings.
15558 @end table
15560 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
15561 @subsection Translator functions
15562 @cindex HTML, and Orgtbl mode
15563 @cindex translator function
15565 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
15566 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
15567 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
15568 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
15569 code that produces tables during HTML export.}, these all use a generic
15570 translator, @code{orgtbl-to-generic}.  For example, @code{orgtbl-to-latex}
15571 itself is a very short function that computes the column definitions for the
15572 @code{tabular} environment, defines a few field and line separators and then
15573 hands processing over to the generic translator.  Here is the entire code:
15575 @lisp
15576 @group
15577 (defun orgtbl-to-latex (table params)
15578   "Convert the Orgtbl mode TABLE to LaTeX."
15579   (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
15580                                org-table-last-alignment ""))
15581          (params2
15582           (list
15583            :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
15584            :tend "\\end@{tabular@}"
15585            :lstart "" :lend " \\\\" :sep " & "
15586            :efmt "%s\\,(%s)" :hline "\\hline")))
15587     (orgtbl-to-generic table (org-combine-plists params2 params))))
15588 @end group
15589 @end lisp
15591 As you can see, the properties passed into the function (variable
15592 @var{PARAMS}) are combined with the ones newly defined in the function
15593 (variable @var{PARAMS2}).  The ones passed into the function (i.e.@: the
15594 ones set by the @samp{ORGTBL SEND} line) take precedence.  So if you
15595 would like to use the @LaTeX{} translator, but wanted the line endings to
15596 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
15597 overrule the default with
15599 @example
15600 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
15601 @end example
15603 For a new language, you can either write your own converter function in
15604 analogy with the @LaTeX{} translator, or you can use the generic function
15605 directly.  For example, if you have a language where a table is started
15606 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
15607 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
15608 separator is a TAB, you could call the generic translator like this (on
15609 a single line!):
15611 @example
15612 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
15613                               :lstart "!BL! " :lend " !EL!" :sep "\t"
15614 @end example
15616 @noindent
15617 Please check the documentation string of the function
15618 @code{orgtbl-to-generic} for a full list of parameters understood by
15619 that function, and remember that you can pass each of them into
15620 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
15621 using the generic function.
15623 Of course you can also write a completely new function doing complicated
15624 things the generic translator cannot do.  A translator function takes
15625 two arguments.  The first argument is the table, a list of lines, each
15626 line either the symbol @code{hline} or a list of fields.  The second
15627 argument is the property list containing all parameters specified in the
15628 @samp{#+ORGTBL: SEND} line.  The function must return a single string
15629 containing the formatted table.  If you write a generally useful
15630 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
15631 others can benefit from your work.
15633 @node Radio lists,  , Translator functions, Tables in arbitrary syntax
15634 @subsection Radio lists
15635 @cindex radio lists
15636 @cindex org-list-insert-radio-list
15638 Sending and receiving radio lists works exactly the same way as sending and
15639 receiving radio tables (@pxref{Radio tables}).  As for radio tables, you can
15640 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
15641 @code{org-list-insert-radio-list}.
15643 Here are the differences with radio tables:
15645 @itemize @minus
15646 @item
15647 Orgstruct mode must be active.
15648 @item
15649 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
15650 @item
15651 The available translation functions for radio lists don't take
15652 parameters.
15653 @item
15654 @kbd{C-c C-c} will work when pressed on the first item of the list.
15655 @end itemize
15657 Here is a @LaTeX{} example.  Let's say that you have this in your
15658 @LaTeX{} file:
15660 @cindex #+ORGLST
15661 @example
15662 % BEGIN RECEIVE ORGLST to-buy
15663 % END RECEIVE ORGLST to-buy
15664 \begin@{comment@}
15665 #+ORGLST: SEND to-buy org-list-to-latex
15666 - a new house
15667 - a new computer
15668   + a new keyboard
15669   + a new mouse
15670 - a new life
15671 \end@{comment@}
15672 @end example
15674 Pressing `C-c C-c' on @code{a new house} and will insert the converted
15675 @LaTeX{} list between the two marker lines.
15677 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
15678 @section Dynamic blocks
15679 @cindex dynamic blocks
15681 Org documents can contain @emph{dynamic blocks}.  These are
15682 specially marked regions that are updated by some user-written function.
15683 A good example for such a block is the clock table inserted by the
15684 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
15686 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
15687 to the block and can also specify parameters for the function producing
15688 the content of the block.
15690 @cindex #+BEGIN:dynamic block
15691 @example
15692 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
15694 #+END:
15695 @end example
15697 Dynamic blocks are updated with the following commands
15699 @table @kbd
15700 @orgcmd{C-c C-x C-u,org-dblock-update}
15701 Update dynamic block at point.
15702 @orgkey{C-u C-c C-x C-u}
15703 Update all dynamic blocks in the current file.
15704 @end table
15706 Updating a dynamic block means to remove all the text between BEGIN and
15707 END, parse the BEGIN line for parameters and then call the specific
15708 writer function for this block to insert the new content.  If you want
15709 to use the original content in the writer function, you can use the
15710 extra parameter @code{:content}.
15712 For a block with name @code{myblock}, the writer function is
15713 @code{org-dblock-write:myblock} with as only parameter a property list
15714 with the parameters given in the begin line.  Here is a trivial example
15715 of a block that keeps track of when the block update function was last
15716 run:
15718 @example
15719 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
15721 #+END:
15722 @end example
15724 @noindent
15725 The corresponding block writer function could look like this:
15727 @lisp
15728 (defun org-dblock-write:block-update-time (params)
15729    (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
15730      (insert "Last block update at: "
15731              (format-time-string fmt (current-time)))))
15732 @end lisp
15734 If you want to make sure that all dynamic blocks are always up-to-date,
15735 you could add the function @code{org-update-all-dblocks} to a hook, for
15736 example @code{before-save-hook}.  @code{org-update-all-dblocks} is
15737 written in a way such that it does nothing in buffers that are not in
15738 @code{org-mode}.
15740 You can narrow the current buffer to the current dynamic block (like any
15741 other block) with @code{org-narrow-to-block}.
15743 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
15744 @section Special agenda views
15745 @cindex agenda views, user-defined
15747 @vindex org-agenda-skip-function
15748 @vindex org-agenda-skip-function-global
15749 Org provides a special hook that can be used to narrow down the selection
15750 made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
15751 @code{tags}, @code{tags-todo}, @code{tags-tree}.  You may specify a function
15752 that is used at each match to verify if the match should indeed be part of
15753 the agenda view, and if not, how much should be skipped.  You can specify a
15754 global condition that will be applied to all agenda views, this condition
15755 would be stored in the variable @code{org-agenda-skip-function-global}.  More
15756 commonly, such a definition is applied only to specific custom searches,
15757 using @code{org-agenda-skip-function}.
15759 Let's say you want to produce a list of projects that contain a WAITING
15760 tag anywhere in the project tree.  Let's further assume that you have
15761 marked all tree headings that define a project with the TODO keyword
15762 PROJECT.  In this case you would run a TODO search for the keyword
15763 PROJECT, but skip the match unless there is a WAITING tag anywhere in
15764 the subtree belonging to the project line.
15766 To achieve this, you must write a function that searches the subtree for
15767 the tag.  If the tag is found, the function must return @code{nil} to
15768 indicate that this match should not be skipped.  If there is no such
15769 tag, return the location of the end of the subtree, to indicate that
15770 search should continue from there.
15772 @lisp
15773 (defun my-skip-unless-waiting ()
15774   "Skip trees that are not waiting"
15775   (let ((subtree-end (save-excursion (org-end-of-subtree t))))
15776     (if (re-search-forward ":waiting:" subtree-end t)
15777         nil          ; tag found, do not skip
15778       subtree-end))) ; tag not found, continue after end of subtree
15779 @end lisp
15781 Now you may use this function in an agenda custom command, for example
15782 like this:
15784 @lisp
15785 (org-add-agenda-custom-command
15786  '("b" todo "PROJECT"
15787    ((org-agenda-skip-function 'my-skip-unless-waiting)
15788     (org-agenda-overriding-header "Projects waiting for something: "))))
15789 @end lisp
15791 @vindex org-agenda-overriding-header
15792 Note that this also binds @code{org-agenda-overriding-header} to get a
15793 meaningful header in the agenda view.
15795 @vindex org-odd-levels-only
15796 @vindex org-agenda-skip-function
15797 A general way to create custom searches is to base them on a search for
15798 entries with a certain level limit.  If you want to study all entries with
15799 your custom search function, simply do a search for
15800 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
15801 level number corresponds to order in the hierarchy, not to the number of
15802 stars.}, and then use @code{org-agenda-skip-function} to select the entries
15803 you really want to have.
15805 You may also put a Lisp form into @code{org-agenda-skip-function}.  In
15806 particular, you may use the functions @code{org-agenda-skip-entry-if}
15807 and @code{org-agenda-skip-subtree-if} in this form, for example:
15809 @table @code
15810 @item (org-agenda-skip-entry-if 'scheduled)
15811 Skip current entry if it has been scheduled.
15812 @item (org-agenda-skip-entry-if 'notscheduled)
15813 Skip current entry if it has not been scheduled.
15814 @item (org-agenda-skip-entry-if 'deadline)
15815 Skip current entry if it has a deadline.
15816 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
15817 Skip current entry if it has a deadline, or if it is scheduled.
15818 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
15819 Skip current entry if the TODO keyword is TODO or WAITING.
15820 @item (org-agenda-skip-entry-if 'todo 'done)
15821 Skip current entry if the TODO keyword marks a DONE state.
15822 @item (org-agenda-skip-entry-if 'timestamp)
15823 Skip current entry if it has any timestamp, may also be deadline or scheduled.
15824 @item (org-agenda-skip-entry 'regexp "regular expression")
15825 Skip current entry if the regular expression matches in the entry.
15826 @item (org-agenda-skip-entry 'notregexp "regular expression")
15827 Skip current entry unless the regular expression matches.
15828 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
15829 Same as above, but check and skip the entire subtree.
15830 @end table
15832 Therefore we could also have written the search for WAITING projects
15833 like this, even without defining a special function:
15835 @lisp
15836 (org-add-agenda-custom-command
15837  '("b" todo "PROJECT"
15838    ((org-agenda-skip-function '(org-agenda-skip-subtree-if
15839                                 'regexp ":waiting:"))
15840     (org-agenda-overriding-header "Projects waiting for something: "))))
15841 @end lisp
15843 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
15844 @section Extracting agenda information
15845 @cindex agenda, pipe
15846 @cindex Scripts, for agenda processing
15848 @vindex org-agenda-custom-commands
15849 Org provides commands to access agenda information for the command
15850 line in Emacs batch mode.  This extracted information can be sent
15851 directly to a printer, or it can be read by a program that does further
15852 processing of the data.  The first of these commands is the function
15853 @code{org-batch-agenda}, that produces an agenda view and sends it as
15854 ASCII text to STDOUT.  The command takes a single string as parameter.
15855 If the string has length 1, it is used as a key to one of the commands
15856 you have configured in @code{org-agenda-custom-commands}, basically any
15857 key you can use after @kbd{C-c a}.  For example, to directly print the
15858 current TODO list, you could use
15860 @example
15861 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
15862 @end example
15864 If the parameter is a string with 2 or more characters, it is used as a
15865 tags/TODO match string.  For example, to print your local shopping list
15866 (all items with the tag @samp{shop}, but excluding the tag
15867 @samp{NewYork}), you could use
15869 @example
15870 emacs -batch -l ~/.emacs                                      \
15871       -eval '(org-batch-agenda "+shop-NewYork")' | lpr
15872 @end example
15874 @noindent
15875 You may also modify parameters on the fly like this:
15877 @example
15878 emacs -batch -l ~/.emacs                                      \
15879    -eval '(org-batch-agenda "a"                               \
15880             org-agenda-span (quote month)                     \
15881             org-agenda-include-diary nil                      \
15882             org-agenda-files (quote ("~/org/project.org")))'  \
15883    | lpr
15884 @end example
15886 @noindent
15887 which will produce a 30-day agenda, fully restricted to the Org file
15888 @file{~/org/projects.org}, not even including the diary.
15890 If you want to process the agenda data in more sophisticated ways, you
15891 can use the command @code{org-batch-agenda-csv} to get a comma-separated
15892 list of values for each agenda item.  Each line in the output will
15893 contain a number of fields separated by commas.  The fields in a line
15894 are:
15896 @example
15897 category     @r{The category of the item}
15898 head         @r{The headline, without TODO keyword, TAGS and PRIORITY}
15899 type         @r{The type of the agenda entry, can be}
15900                 todo               @r{selected in TODO match}
15901                 tagsmatch          @r{selected in tags match}
15902                 diary              @r{imported from diary}
15903                 deadline           @r{a deadline}
15904                 scheduled          @r{scheduled}
15905                 timestamp          @r{appointment, selected by timestamp}
15906                 closed             @r{entry was closed on date}
15907                 upcoming-deadline  @r{warning about nearing deadline}
15908                 past-scheduled     @r{forwarded scheduled item}
15909                 block              @r{entry has date block including date}
15910 todo         @r{The TODO keyword, if any}
15911 tags         @r{All tags including inherited ones, separated by colons}
15912 date         @r{The relevant date, like 2007-2-14}
15913 time         @r{The time, like 15:00-16:50}
15914 extra        @r{String with extra planning info}
15915 priority-l   @r{The priority letter if any was given}
15916 priority-n   @r{The computed numerical priority}
15917 @end example
15919 @noindent
15920 Time and date will only be given if a timestamp (or deadline/scheduled)
15921 led to the selection of the item.
15923 A CSV list like this is very easy to use in a post-processing script.
15924 For example, here is a Perl program that gets the TODO list from
15925 Emacs/Org and prints all the items, preceded by a checkbox:
15927 @example
15928 #!/usr/bin/perl
15930 # define the Emacs command to run
15931 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
15933 # run it and capture the output
15934 $agenda = qx@{$cmd 2>/dev/null@};
15936 # loop over all lines
15937 foreach $line (split(/\n/,$agenda)) @{
15938   # get the individual values
15939   ($category,$head,$type,$todo,$tags,$date,$time,$extra,
15940    $priority_l,$priority_n) = split(/,/,$line);
15941   # process and print
15942   print "[ ] $head\n";
15944 @end example
15946 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
15947 @section Using the property API
15948 @cindex API, for properties
15949 @cindex properties, API
15951 Here is a description of the functions that can be used to work with
15952 properties.
15954 @defun org-entry-properties &optional pom which
15955 Get all properties of the entry at point-or-marker POM.@*
15956 This includes the TODO keyword, the tags, time strings for deadline,
15957 scheduled, and clocking, and any additional properties defined in the
15958 entry.  The return value is an alist.  Keys may occur multiple times
15959 if the property key was used several times.@*
15960 POM may also be nil, in which case the current entry is used.
15961 If WHICH is nil or `all', get all properties.  If WHICH is
15962 `special' or `standard', only get that subclass.
15963 @end defun
15964 @vindex org-use-property-inheritance
15965 @defun org-entry-get pom property &optional inherit
15966 Get value of PROPERTY for entry at point-or-marker POM.  By default,
15967 this only looks at properties defined locally in the entry.  If INHERIT
15968 is non-nil and the entry does not have the property, then also check
15969 higher levels of the hierarchy.  If INHERIT is the symbol
15970 @code{selective}, use inheritance if and only if the setting of
15971 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
15972 @end defun
15974 @defun org-entry-delete pom property
15975 Delete the property PROPERTY from entry at point-or-marker POM.
15976 @end defun
15978 @defun org-entry-put pom property value
15979 Set PROPERTY to VALUE for entry at point-or-marker POM.
15980 @end defun
15982 @defun org-buffer-property-keys &optional include-specials
15983 Get all property keys in the current buffer.
15984 @end defun
15986 @defun org-insert-property-drawer
15987 Insert a property drawer at point.
15988 @end defun
15990 @defun org-entry-put-multivalued-property pom property &rest values
15991 Set PROPERTY at point-or-marker POM to VALUES.  VALUES should be a list of
15992 strings.  They will be concatenated, with spaces as separators.
15993 @end defun
15995 @defun org-entry-get-multivalued-property pom property
15996 Treat the value of the property PROPERTY as a whitespace-separated list of
15997 values and return the values as a list of strings.
15998 @end defun
16000 @defun org-entry-add-to-multivalued-property pom property value
16001 Treat the value of the property PROPERTY as a whitespace-separated list of
16002 values and make sure that VALUE is in this list.
16003 @end defun
16005 @defun org-entry-remove-from-multivalued-property pom property value
16006 Treat the value of the property PROPERTY as a whitespace-separated list of
16007 values and make sure that VALUE is @emph{not} in this list.
16008 @end defun
16010 @defun org-entry-member-in-multivalued-property pom property value
16011 Treat the value of the property PROPERTY as a whitespace-separated list of
16012 values and check if VALUE is in this list.
16013 @end defun
16015 @defopt org-property-allowed-value-functions
16016 Hook for functions supplying allowed values for a specific property.
16017 The functions must take a single argument, the name of the property, and
16018 return a flat list of allowed values.  If @samp{:ETC} is one of
16019 the values, use the values as completion help, but allow also other values
16020 to be entered.  The functions must return @code{nil} if they are not
16021 responsible for this property.
16022 @end defopt
16024 @node Using the mapping API,  , Using the property API, Hacking
16025 @section Using the mapping API
16026 @cindex API, for mapping
16027 @cindex mapping entries, API
16029 Org has sophisticated mapping capabilities to find all entries satisfying
16030 certain criteria.  Internally, this functionality is used to produce agenda
16031 views, but there is also an API that can be used to execute arbitrary
16032 functions for each or selected entries.  The main entry point for this API
16035 @defun org-map-entries func &optional match scope &rest skip
16036 Call FUNC at each headline selected by MATCH in SCOPE.
16038 FUNC is a function or a Lisp form.  The function will be called without
16039 arguments, with the cursor positioned at the beginning of the headline.
16040 The return values of all calls to the function will be collected and
16041 returned as a list.
16043 The call to FUNC will be wrapped into a save-excursion form, so FUNC
16044 does not need to preserve point.  After evaluation, the cursor will be
16045 moved to the end of the line (presumably of the headline of the
16046 processed entry) and search continues from there.  Under some
16047 circumstances, this may not produce the wanted results.  For example,
16048 if you have removed (e.g.@: archived) the current (sub)tree it could
16049 mean that the next entry will be skipped entirely.  In such cases, you
16050 can specify the position from where search should continue by making
16051 FUNC set the variable `org-map-continue-from' to the desired buffer
16052 position.
16054 MATCH is a tags/property/todo match as it is used in the agenda match view.
16055 Only headlines that are matched by this query will be considered during
16056 the iteration.  When MATCH is nil or t, all headlines will be
16057 visited by the iteration.
16059 SCOPE determines the scope of this command.  It can be any of:
16061 @example
16062 nil     @r{the current buffer, respecting the restriction if any}
16063 tree    @r{the subtree started with the entry at point}
16064 region  @r{The entries within the active region, if any}
16065 file    @r{the current buffer, without restriction}
16066 file-with-archives
16067         @r{the current buffer, and any archives associated with it}
16068 agenda  @r{all agenda files}
16069 agenda-with-archives
16070         @r{all agenda files with any archive files associated with them}
16071 (file1 file2 ...)
16072         @r{if this is a list, all files in the list will be scanned}
16073 @end example
16074 @noindent
16075 The remaining args are treated as settings for the skipping facilities of
16076 the scanner.  The following items can be given here:
16078 @vindex org-agenda-skip-function
16079 @example
16080 archive   @r{skip trees with the archive tag}
16081 comment   @r{skip trees with the COMMENT keyword}
16082 function or Lisp form
16083           @r{will be used as value for @code{org-agenda-skip-function},}
16084           @r{so whenever the function returns t, FUNC}
16085           @r{will not be called for that entry and search will}
16086           @r{continue from the point where the function leaves it}
16087 @end example
16088 @end defun
16090 The function given to that mapping routine can really do anything you like.
16091 It can use the property API (@pxref{Using the property API}) to gather more
16092 information about the entry, or in order to change metadata in the entry.
16093 Here are a couple of functions that might be handy:
16095 @defun org-todo &optional arg
16096 Change the TODO state of the entry.  See the docstring of the functions for
16097 the many possible values for the argument ARG.
16098 @end defun
16100 @defun org-priority &optional action
16101 Change the priority of the entry.  See the docstring of this function for the
16102 possible values for ACTION.
16103 @end defun
16105 @defun org-toggle-tag tag &optional onoff
16106 Toggle the tag TAG in the current entry.  Setting ONOFF to either @code{on}
16107 or @code{off} will not toggle tag, but ensure that it is either on or off.
16108 @end defun
16110 @defun org-promote
16111 Promote the current entry.
16112 @end defun
16114 @defun org-demote
16115 Demote the current entry.
16116 @end defun
16118 Here is a simple example that will turn all entries in the current file with
16119 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
16120 Entries in comment trees and in archive trees will be ignored.
16122 @lisp
16123 (org-map-entries
16124    '(org-todo "UPCOMING")
16125    "+TOMORROW" 'file 'archive 'comment)
16126 @end lisp
16128 The following example counts the number of entries with TODO keyword
16129 @code{WAITING}, in all agenda files.
16131 @lisp
16132 (length (org-map-entries t "/+WAITING" 'agenda))
16133 @end lisp
16135 @node MobileOrg, History and Acknowledgments, Hacking, Top
16136 @appendix MobileOrg
16137 @cindex iPhone
16138 @cindex MobileOrg
16140 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
16141 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
16142 @i{MobileOrg} offers offline viewing and capture support for an Org mode
16143 system rooted on a ``real'' computer.  It does also allow you to record
16144 changes to existing entries.  Android users should check out
16145 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
16146 by Matt Jones.
16148 This appendix describes the support Org has for creating agenda views in a
16149 format that can be displayed by @i{MobileOrg}, and for integrating notes
16150 captured and changes made by @i{MobileOrg} into the main system.
16152 For changing tags and TODO states in MobileOrg, you should have set up the
16153 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
16154 cover all important tags and TODO keywords, even if individual files use only
16155 part of these.  MobileOrg will also offer you states and tags set up with
16156 in-buffer settings, but it will understand the logistics of TODO state
16157 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
16158 (@pxref{Setting tags}) only for those set in these variables.
16160 @menu
16161 * Setting up the staging area::  Where to interact with the mobile device
16162 * Pushing to MobileOrg::        Uploading Org files and agendas
16163 * Pulling from MobileOrg::      Integrating captured and flagged items
16164 @end menu
16166 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
16167 @section Setting up the staging area
16169 MobileOrg needs to interact with Emacs through a directory on a server.  If you
16170 are using a public server, you should consider to encrypt the files that are
16171 uploaded to the server.  This can be done with Org mode 7.02 and with
16172 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
16173 installation on your system.  To turn on encryption, set a password in
16174 @i{MobileOrg} and, on the Emacs side, configure the variable
16175 @code{org-mobile-use-encryption}@footnote{If you can safely store the
16176 password in your Emacs setup, you might also want to configure
16177 @code{org-mobile-encryption-password}.  Please read the docstring of that
16178 variable.  Note that encryption will apply only to the contents of the
16179 @file{.org} files.  The file names themselves will remain visible.}.
16181 The easiest way to create that directory is to use a free
16182 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
16183 Dropbox, or if your version of MobileOrg does not support it, you can use a
16184 webdav server.  For more information, check out the documentation of MobileOrg and also this
16185 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
16186 When MobileOrg first connects to your Dropbox, it will create a directory
16187 @i{MobileOrg} inside the Dropbox.  After the directory has been created, tell
16188 Emacs about it:
16190 @lisp
16191 (setq org-mobile-directory "~/Dropbox/MobileOrg")
16192 @end lisp
16194 Org mode has commands to put files for @i{MobileOrg} into that directory,
16195 and to read captured notes from there.
16197 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
16198 @section Pushing to MobileOrg
16200 This operation copies all files currently listed in @code{org-mobile-files}
16201 to the directory @code{org-mobile-directory}.  By default this list contains
16202 all agenda files (as listed in @code{org-agenda-files}), but additional files
16203 can be included by customizing @code{org-mobile-files}.  File names will be
16204 staged with paths relative to @code{org-directory}, so all files should be
16205 inside this directory.  The push operation also creates a special Org file
16206 @file{agendas.org} with all custom agenda view defined by the
16207 user@footnote{While creating the agendas, Org mode will force ID properties
16208 on all referenced entries, so that these entries can be uniquely identified
16209 if @i{MobileOrg} flags them for further action.  If you do not want to get
16210 these properties in so many entries, you can set the variable
16211 @code{org-mobile-force-id-on-agenda-items} to @code{nil}.  Org mode will then
16212 rely on outline paths, in the hope that these will be unique enough.}.
16213 Finally, Org writes the file @file{index.org}, containing links to all other
16214 files.  @i{MobileOrg} first reads this file from the server, and then
16215 downloads all agendas and Org files listed in it.  To speed up the download,
16216 MobileOrg will only read files whose checksums@footnote{stored automatically
16217 in the file @file{checksums.dat}} have changed.
16219 @node Pulling from MobileOrg,  , Pushing to MobileOrg, MobileOrg
16220 @section Pulling from MobileOrg
16222 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
16223 files for viewing.  It also appends captured entries and pointers to flagged
16224 and changed entries to the file @file{mobileorg.org} on the server.  Org has
16225 a @emph{pull} operation that integrates this information into an inbox file
16226 and operates on the pointers to flagged entries.  Here is how it works:
16228 @enumerate
16229 @item
16230 Org moves all entries found in
16231 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
16232 operation.} and appends them to the file pointed to by the variable
16233 @code{org-mobile-inbox-for-pull}.  Each captured entry and each editing event
16234 will be a top-level entry in the inbox file.
16235 @item
16236 After moving the entries, Org will attempt to implement the changes made in
16237 @i{MobileOrg}.  Some changes are applied directly and without user
16238 interaction.  Examples are all changes to tags, TODO state, headline and body
16239 text that can be cleanly applied.  Entries that have been flagged for further
16240 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
16241 again.  When there is a problem finding an entry or applying the change, the
16242 pointer entry will remain in the inbox and will be marked with an error
16243 message.  You need to later resolve these issues by hand.
16244 @item
16245 Org will then generate an agenda view with all flagged entries.  The user
16246 should then go through these entries and do whatever actions are necessary.
16247 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
16248 will be displayed in the echo area when the cursor is on the corresponding
16249 agenda line.
16250 @table @kbd
16251 @kindex ?
16252 @item ?
16253 Pressing @kbd{?} in that special agenda will display the full flagging note in
16254 another window and also push it onto the kill ring.  So you could use @kbd{?
16255 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
16256 Pressing @kbd{?} twice in succession will offer to remove the
16257 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
16258 in a property).  In this way you indicate that the intended processing for
16259 this flagged entry is finished.
16260 @end table
16261 @end enumerate
16263 @kindex C-c a ?
16264 If you are not able to process all flagged entries directly, you can always
16265 return to this agenda view@footnote{Note, however, that there is a subtle
16266 difference.  The view created automatically by @kbd{M-x org-mobile-pull
16267 @key{RET}} is guaranteed to search all files that have been addressed by the
16268 last pull.  This might include a file that is not currently in your list of
16269 agenda files.  If you later use @kbd{C-c a ?} to regenerate the view, only
16270 the current agenda files will be searched.} using @kbd{C-c a ?}.
16272 @node History and Acknowledgments, Main Index, MobileOrg, Top
16273 @appendix History and acknowledgments
16274 @cindex acknowledgments
16275 @cindex history
16276 @cindex thanks
16278 Org was born in 2003, out of frustration over the user interface of the Emacs
16279 Outline mode.  I was trying to organize my notes and projects, and using
16280 Emacs seemed to be the natural way to go.  However, having to remember eleven
16281 different commands with two or three keys per command, only to hide and show
16282 parts of the outline tree, that seemed entirely unacceptable to me.  Also,
16283 when using outlines to take notes, I constantly wanted to restructure the
16284 tree, organizing it parallel to my thoughts and plans.  @emph{Visibility
16285 cycling} and @emph{structure editing} were originally implemented in the
16286 package @file{outline-magic.el}, but quickly moved to the more general
16287 @file{org.el}.  As this environment became comfortable for project planning,
16288 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
16289 @emph{table support}.  These areas highlighted the two main goals that Org
16290 still has today: to be a new, outline-based, plain text mode with innovative
16291 and intuitive editing features, and to incorporate project planning
16292 functionality directly into a notes file.
16294 Since the first release, literally thousands of emails to me or to
16295 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
16296 reports, feedback, new ideas, and sometimes patches and add-on code.
16297 Many thanks to everyone who has helped to improve this package.  I am
16298 trying to keep here a list of the people who had significant influence
16299 in shaping one or more aspects of Org.  The list may not be
16300 complete, if I have forgotten someone, please accept my apologies and
16301 let me know.
16303 Before I get to this list, a few special mentions are in order:
16305 @table @i
16306 @item Bastien Guerry
16307 Bastien has written a large number of extensions to Org (most of them
16308 integrated into the core by now), including the @LaTeX{} exporter and the plain
16309 list parser.  His support during the early days, when he basically acted as
16310 co-maintainer, was central to the success of this project.  Bastien also
16311 invented Worg, helped establishing the Web presence of Org, and sponsors
16312 hosting costs for the orgmode.org website.
16313 @item Eric Schulte and Dan Davison
16314 Eric and Dan are jointly responsible for the Org-babel system, which turns
16315 Org into a multi-language environment for evaluating code and doing literate
16316 programming and reproducible research.
16317 @item John Wiegley
16318 John has contributed a number of great ideas and patches directly to Org,
16319 including the attachment system (@file{org-attach.el}), integration with
16320 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
16321 items, habit tracking (@file{org-habits.el}), and encryption
16322 (@file{org-crypt.el}).  Also, the capture system is really an extended copy
16323 of his great @file{remember.el}.
16324 @item Sebastian Rose
16325 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
16326 of an ignorant amateur.  Sebastian has pushed this part of Org onto a much
16327 higher level.  He also wrote @file{org-info.js}, a Java script for displaying
16328 webpages derived from Org using an Info-like or a folding interface with
16329 single-key navigation.
16330 @end table
16332 @noindent OK, now to the full list of contributions!  Again, please let me
16333 know what I am missing here!
16335 @itemize @bullet
16337 @item
16338 @i{Russel Adams} came up with the idea for drawers.
16339 @item
16340 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
16341 @item
16342 @i{Christophe Bataillon} created the great unicorn logo that we use on the
16343 Org mode website.
16344 @item
16345 @i{Alex Bochannek} provided a patch for rounding timestamps.
16346 @item
16347 @i{Jan Böcker} wrote @file{org-docview.el}.
16348 @item
16349 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
16350 @item
16351 @i{Tom Breton} wrote @file{org-choose.el}.
16352 @item
16353 @i{Charles Cave}'s suggestion sparked the implementation of templates
16354 for Remember, which are now templates for capture.
16355 @item
16356 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
16357 specified time.
16358 @item
16359 @i{Gregory Chernov} patched support for Lisp forms into table
16360 calculations and improved XEmacs compatibility, in particular by porting
16361 @file{nouline.el} to XEmacs.
16362 @item
16363 @i{Sacha Chua} suggested copying some linking code from Planner.
16364 @item
16365 @i{Baoqiu Cui} contributed the DocBook exporter.
16366 @item
16367 @i{Eddward DeVilla} proposed and tested checkbox statistics.  He also
16368 came up with the idea of properties, and that there should be an API for
16369 them.
16370 @item
16371 @i{Nick Dokos} tracked down several nasty bugs.
16372 @item
16373 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
16374 inspired some of the early development, including HTML export.  He also
16375 asked for a way to narrow wide table columns.
16376 @item
16377 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
16378 the Org-Babel documentation into the manual.
16379 @item
16380 @i{Christian Egli} converted the documentation into Texinfo format, inspired
16381 the agenda, patched CSS formatting into the HTML exporter, and wrote
16382 @file{org-taskjuggler.el}.
16383 @item
16384 @i{David Emery} provided a patch for custom CSS support in exported
16385 HTML agendas.
16386 @item
16387 @i{Nic Ferrier} contributed mailcap and XOXO support.
16388 @item
16389 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
16390 @item
16391 @i{John Foerch} figured out how to make incremental search show context
16392 around a match in a hidden outline tree.
16393 @item
16394 @i{Raimar Finken} wrote @file{org-git-line.el}.
16395 @item
16396 @i{Mikael Fornius} works as a mailing list moderator.
16397 @item
16398 @i{Austin Frank} works as a mailing list moderator.
16399 @item
16400 @i{Eric Fraga} drove the development of BEAMER export with ideas and
16401 testing.
16402 @item
16403 @i{Barry Gidden} did proofreading the manual in preparation for the book
16404 publication through Network Theory Ltd.
16405 @item
16406 @i{Niels Giesen} had the idea to automatically archive DONE trees.
16407 @item
16408 @i{Nicolas Goaziou} rewrote much of the plain list code.
16409 @item
16410 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
16411 @item
16412 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
16413 book.
16414 @item
16415 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
16416 task state change logging, and the clocktable.  His clear explanations have
16417 been critical when we started to adopt the Git version control system.
16418 @item
16419 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
16420 patches.
16421 @item
16422 @i{Phil Jackson} wrote @file{org-irc.el}.
16423 @item
16424 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
16425 folded entries, and column view for properties.
16426 @item
16427 @i{Matt Jones} wrote @i{MobileOrg Android}.
16428 @item
16429 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
16430 @item
16431 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it.  He also
16432 provided frequent feedback and some patches.
16433 @item
16434 @i{Matt Lundin} has proposed last-row references for table formulas and named
16435 invisible anchors.  He has also worked a lot on the FAQ.
16436 @item
16437 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
16438 and is a prolific contributor on the mailing list with competent replies,
16439 small fixes and patches.
16440 @item
16441 @i{Jason F. McBrayer} suggested agenda export to CSV format.
16442 @item
16443 @i{Max Mikhanosha} came up with the idea of refiling.
16444 @item
16445 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
16446 basis.
16447 @item
16448 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
16449 happy.
16450 @item
16451 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
16452 @item
16453 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
16454 and being able to quickly restrict the agenda to a subtree.
16455 @item
16456 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
16457 @item
16458 @i{Greg Newman} refreshed the unicorn logo into its current form.
16459 @item
16460 @i{Tim O'Callaghan} suggested in-file links, search options for general
16461 file links, and TAGS.
16462 @item
16463 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
16464 version of the reference card.
16465 @item
16466 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
16467 into Japanese.
16468 @item
16469 @i{Oliver Oppitz} suggested multi-state TODO items.
16470 @item
16471 @i{Scott Otterson} sparked the introduction of descriptive text for
16472 links, among other things.
16473 @item
16474 @i{Pete Phillips} helped during the development of the TAGS feature, and
16475 provided frequent feedback.
16476 @item
16477 @i{Martin Pohlack} provided the code snippet to bundle character insertion
16478 into bundles of 20 for undo.
16479 @item
16480 @i{T.V. Raman} reported bugs and suggested improvements.
16481 @item
16482 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
16483 control.
16484 @item
16485 @i{Paul Rivier} provided the basic implementation of named footnotes.  He
16486 also acted as mailing list moderator for some time.
16487 @item
16488 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
16489 @item
16490 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
16491 conflict with @file{allout.el}.
16492 @item
16493 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
16494 extensive patches.
16495 @item
16496 @i{Philip Rooke} created the Org reference card, provided lots
16497 of feedback, developed and applied standards to the Org documentation.
16498 @item
16499 @i{Christian Schlauer} proposed angular brackets around links, among
16500 other things.
16501 @item
16502 @i{Paul Sexton} wrote @file{org-ctags.el}.
16503 @item
16504 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
16505 @file{organizer-mode.el}.
16506 @item
16507 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
16508 examples, and remote highlighting for referenced code lines.
16509 @item
16510 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
16511 now packaged into Org's @file{contrib} directory.
16512 @item
16513 @i{Daniel Sinder} came up with the idea of internal archiving by locking
16514 subtrees.
16515 @item
16516 @i{Dale Smith} proposed link abbreviations.
16517 @item
16518 @i{James TD Smith} has contributed a large number of patches for useful
16519 tweaks and features.
16520 @item
16521 @i{Adam Spiers} asked for global linking commands, inspired the link
16522 extension system, added support for mairix, and proposed the mapping API.
16523 @item
16524 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
16525 @LaTeX{}, UTF-8, Latin-1 and ASCII.
16526 @item
16527 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
16528 with links transformation to Org syntax.
16529 @item
16530 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
16531 chapter about publishing.
16532 @item
16533 @i{Jambunathan K} contributed the ODT exporter.
16534 @item
16535 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
16536 enabled source code highlighting in Gnus.
16537 @item
16538 @i{Stefan Vollmar} organized a video-recorded talk at the
16539 Max-Planck-Institute for Neurology.  He also inspired the creation of a
16540 concept index for HTML export.
16541 @item
16542 @i{J@"urgen Vollmer} contributed code generating the table of contents
16543 in HTML output.
16544 @item
16545 @i{Samuel Wales} has provided important feedback and bug reports.
16546 @item
16547 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
16548 keyword.
16549 @item
16550 @i{David Wainberg} suggested archiving, and improvements to the linking
16551 system.
16552 @item
16553 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
16554 linking to Gnus.
16555 @item
16556 @i{Roland Winkler} requested additional key bindings to make Org
16557 work on a tty.
16558 @item
16559 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
16560 and contributed various ideas and code snippets.
16561 @item
16562 @end itemize
16565 @node Main Index, Key Index, History and Acknowledgments, Top
16566 @unnumbered Concept index
16568 @printindex cp
16570 @node Key Index, Command and Function Index, Main Index, Top
16571 @unnumbered Key index
16573 @printindex ky
16575 @node Command and Function Index, Variable Index, Key Index, Top
16576 @unnumbered Command and function index
16578 @printindex fn
16580 @node Variable Index,  , Command and Function Index, Top
16581 @unnumbered Variable index
16583 This is not a complete index of variables and faces, only the ones that are
16584 mentioned in the manual.  For a more complete list, use @kbd{M-x
16585 org-customize @key{RET}} and then click yourself through the tree.
16587 @printindex vr
16589 @bye
16591 @c Local variables:
16592 @c fill-column: 77
16593 @c indent-tabs-mode: nil
16594 @c paragraph-start:    "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[  ]*$"
16595 @c paragraph-separate: "\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[       \f]*$"
16596 @c End:
16599 @c  LocalWords:  webdavhost pre