3 @setfilename ../../info/org.info
4 @settitle The Org Manual
6 @include org-version.inc
8 @c Version and Contact Info
9 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page}
10 @set AUTHOR Carsten Dominik
11 @set MAINTAINER Carsten Dominik
12 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
13 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
14 @documentencoding UTF-8
19 @c -----------------------------------------------------------------------------
21 @c Macro definitions for commands and keys
22 @c =======================================
24 @c The behavior of the key/command macros will depend on the flag cmdnames
25 @c When set, commands names are shown. When clear, they are not shown.
29 @c Below we define the following macros for Org key tables:
31 @c orgkey{key} A key item
32 @c orgcmd{key,cmd} Key with command name
33 @c xorgcmd{key,cmd} Key with command name as @itemx
34 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
35 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
36 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
37 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
38 @c different functions, so format as @itemx
39 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
40 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
41 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
43 @c a key but no command
55 @c one key with a command
56 @c Inserts: @item KEY COMMAND
57 @macro orgcmd{key,command}
62 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
65 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
74 @c One key with one command, formatted using @itemx
75 @c Inserts: @itemx KEY COMMAND
76 @macro xorgcmd{key,command}
81 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
84 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
93 @c one key with a command, bit do not index the key
94 @c Inserts: @item KEY COMMAND
95 @macro orgcmdnki{key,command}
99 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
102 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
110 @c one key with a command, and special text to replace key in item
111 @c Inserts: @item TEXT COMMAND
112 @macro orgcmdtkc{text,key,command}
117 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
120 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
129 @c two keys with one command
130 @c Inserts: @item KEY1 or KEY2 COMMAND
131 @macro orgcmdkkc{key1,key2,command}
137 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
140 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
150 @c Two keys with one command name, but different functions, so format as
152 @c Inserts: @item KEY1
153 @c @itemx KEY2 COMMAND
154 @macro orgcmdkxkc{key1,key2,command}
161 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
165 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
176 @c Same as previous, but use "or short"
177 @c Inserts: @item KEY1 or short KEY2 COMMAND
178 @macro orgcmdkskc{key1,key2,command}
184 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
187 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
197 @c Same as previous, but use @itemx
198 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
199 @macro xorgcmdkskc{key1,key2,command}
205 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
208 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
218 @c two keys with two commands
219 @c Inserts: @item KEY1 COMMAND1
220 @c @itemx KEY2 COMMAND2
221 @macro orgcmdkkcc{key1,key2,command1,command2}
228 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
229 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
232 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
233 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
243 @c -----------------------------------------------------------------------------
246 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
249 @c Subheadings inside a table.
250 @macro tsubheading{text}
252 @subsubheading \text\
260 This manual is for Org version @value{VERSION}.
262 Copyright @copyright{} 2004--2014 Free Software Foundation, Inc.
265 Permission is granted to copy, distribute and/or modify this document
266 under the terms of the GNU Free Documentation License, Version 1.3 or
267 any later version published by the Free Software Foundation; with no
268 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
269 and with the Back-Cover Texts as in (a) below. A copy of the license
270 is included in the section entitled ``GNU Free Documentation License.''
272 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
273 modify this GNU manual.''
277 @dircategory Emacs editing modes
279 * Org Mode: (org). Outline-based notes management and organizer
283 @title The Org Manual
285 @subtitle Release @value{VERSION}
286 @author by Carsten Dominik
287 with contributions by Bastien Guerry, Nicolas Goaziou, Eric Schulte,
288 Jambunathan K, Dan Davison, Thomas Dye, David O'Toole, and Philip Rooke.
290 @c The following two commands start the copyright page.
292 @vskip 0pt plus 1filll
296 @c Output the short table of contents at the beginning.
299 @c Output the table of contents at the beginning.
303 @c FIXME These hand-written next,prev,up node pointers make editing a lot
304 @c harder. There should be no need for them, makeinfo can do it
305 @c automatically for any document with a normal structure.
306 @node Top, Introduction, (dir), (dir)
313 * Introduction:: Getting started
314 * Document structure:: A tree works like your brain
315 * Tables:: Pure magic for quick formatting
316 * Hyperlinks:: Notes in context
317 * TODO items:: Every tree branch can be a TODO item
318 * Tags:: Tagging headlines and matching sets of tags
319 * Properties and columns:: Storing information about an entry
320 * Dates and times:: Making items useful for planning
321 * Capture - Refile - Archive:: The ins and outs for projects
322 * Agenda views:: Collecting information into views
323 * Markup:: Prepare text for rich export
324 * Exporting:: Sharing and publishing notes
325 * Publishing:: Create a web site of linked Org files
326 * Working with source code:: Export, evaluate, and tangle code blocks
327 * Miscellaneous:: All the rest which did not fit elsewhere
328 * Hacking:: How to hack your way around
329 * MobileOrg:: Viewing and capture on a mobile device
330 * History and acknowledgments:: How Org came into being
331 * GNU Free Documentation License:: The license for this documentation.
332 * Main Index:: An index of Org's concepts and features
333 * Key Index:: Key bindings and where they are described
334 * Command and Function Index:: Command names and some internal functions
335 * Variable Index:: Variables mentioned in the manual
338 --- The Detailed Node Listing ---
342 * Summary:: Brief summary of what Org does
343 * Installation:: Installing Org
344 * Activation:: How to activate Org for certain buffers
345 * Feedback:: Bug reports, ideas, patches etc.
346 * Conventions:: Typesetting conventions in the manual
350 * Outlines:: Org is based on Outline mode
351 * Headlines:: How to typeset Org tree headlines
352 * Visibility cycling:: Show and hide, much simplified
353 * Motion:: Jumping to other headlines
354 * Structure editing:: Changing sequence and level of headlines
355 * Sparse trees:: Matches embedded in context
356 * Plain lists:: Additional structure within an entry
357 * Drawers:: Tucking stuff away
358 * Blocks:: Folding blocks
359 * Footnotes:: How footnotes are defined in Org's syntax
360 * Orgstruct mode:: Structure editing outside Org
361 * Org syntax:: Formal description of Org's syntax
365 * Global and local cycling:: Cycling through various visibility states
366 * Initial visibility:: Setting the initial visibility state
367 * Catching invisible edits:: Preventing mistakes when editing invisible parts
371 * Built-in table editor:: Simple tables
372 * Column width and alignment:: Overrule the automatic settings
373 * Column groups:: Grouping to trigger vertical lines
374 * Orgtbl mode:: The table editor as minor mode
375 * The spreadsheet:: The table editor has spreadsheet capabilities
376 * Org-Plot:: Plotting from org tables
380 * References:: How to refer to another field or range
381 * Formula syntax for Calc:: Using Calc to compute stuff
382 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
383 * Durations and time values:: How to compute durations and time values
384 * Field and range formulas:: Formula for specific (ranges of) fields
385 * Column formulas:: Formulas valid for an entire column
386 * Lookup functions:: Lookup functions for searching tables
387 * Editing and debugging formulas:: Fixing formulas
388 * Updating the table:: Recomputing all dependent fields
389 * Advanced features:: Field and column names, parameters and automatic recalc
393 * Link format:: How links in Org are formatted
394 * Internal links:: Links to other places in the current file
395 * External links:: URL-like links to the world
396 * Handling links:: Creating, inserting and following
397 * Using links outside Org:: Linking from my C source code?
398 * Link abbreviations:: Shortcuts for writing complex links
399 * Search options:: Linking to a specific location
400 * Custom searches:: When the default search is not enough
404 * Radio targets:: Make targets trigger links in plain text
408 * TODO basics:: Marking and displaying TODO entries
409 * TODO extensions:: Workflow and assignments
410 * Progress logging:: Dates and notes for progress
411 * Priorities:: Some things are more important than others
412 * Breaking down tasks:: Splitting a task into manageable pieces
413 * Checkboxes:: Tick-off lists
415 Extended use of TODO keywords
417 * Workflow states:: From TODO to DONE in steps
418 * TODO types:: I do this, Fred does the rest
419 * Multiple sets in one file:: Mixing it all, and still finding your way
420 * Fast access to TODO states:: Single letter selection of a state
421 * Per-file keywords:: Different files, different requirements
422 * Faces for TODO keywords:: Highlighting states
423 * TODO dependencies:: When one task needs to wait for others
427 * Closing items:: When was this entry marked DONE?
428 * Tracking TODO state changes:: When did the status change?
429 * Tracking your habits:: How consistent have you been?
433 * Tag inheritance:: Tags use the tree structure of the outline
434 * Setting tags:: How to assign tags to a headline
435 * Tag groups:: Use one tag to search for several tags
436 * Tag searches:: Searching for combinations of tags
438 Properties and columns
440 * Property syntax:: How properties are spelled out
441 * Special properties:: Access to other Org mode features
442 * Property searches:: Matching property values
443 * Property inheritance:: Passing values down the tree
444 * Column view:: Tabular viewing and editing
445 * Property API:: Properties for Lisp programmers
449 * Defining columns:: The COLUMNS format property
450 * Using column view:: How to create and use column view
451 * Capturing column view:: A dynamic block for column view
455 * Scope of column definitions:: Where defined, where valid?
456 * Column attributes:: Appearance and content of a column
460 * Timestamps:: Assigning a time to a tree entry
461 * Creating timestamps:: Commands which insert timestamps
462 * Deadlines and scheduling:: Planning your work
463 * Clocking work time:: Tracking how long you spend on a task
464 * Effort estimates:: Planning work effort in advance
465 * Relative timer:: Notes with a running timer
466 * Countdown timer:: Starting a countdown timer for a task
470 * The date/time prompt:: How Org mode helps you entering date and time
471 * Custom time format:: Making dates look different
473 Deadlines and scheduling
475 * Inserting deadline/schedule:: Planning items
476 * Repeated tasks:: Items that show up again and again
480 * Clocking commands:: Starting and stopping a clock
481 * The clock table:: Detailed reports
482 * Resolving idle time:: Resolving time when you've been idle
484 Capture - Refile - Archive
486 * Capture:: Capturing new stuff
487 * Attachments:: Add files to tasks
488 * RSS feeds:: Getting input from RSS feeds
489 * Protocols:: External (e.g., Browser) access to Emacs and Org
490 * Refile and copy:: Moving/copying a tree from one place to another
491 * Archiving:: What to do with finished projects
495 * Setting up capture:: Where notes will be stored
496 * Using capture:: Commands to invoke and terminate capture
497 * Capture templates:: Define the outline of different note types
501 * Template elements:: What is needed for a complete template entry
502 * Template expansion:: Filling in information about time and context
503 * Templates in contexts:: Only show a template in a specific context
507 * Moving subtrees:: Moving a tree to an archive file
508 * Internal archiving:: Switch off a tree but keep it in the file
512 * Agenda files:: Files being searched for agenda information
513 * Agenda dispatcher:: Keyboard access to agenda views
514 * Built-in agenda views:: What is available out of the box?
515 * Presentation and sorting:: How agenda items are prepared for display
516 * Agenda commands:: Remote editing of Org trees
517 * Custom agenda views:: Defining special searches and views
518 * Exporting agenda views:: Writing a view to a file
519 * Agenda column view:: Using column view for collected entries
521 The built-in agenda views
523 * Weekly/daily agenda:: The calendar page with current tasks
524 * Global TODO list:: All unfinished action items
525 * Matching tags and properties:: Structured information with fine-tuned search
526 * Timeline:: Time-sorted view for single file
527 * Search view:: Find entries by searching for text
528 * Stuck projects:: Find projects you need to review
530 Presentation and sorting
532 * Categories:: Not all tasks are equal
533 * Time-of-day specifications:: How the agenda knows the time
534 * Sorting agenda items:: The order of things
535 * Filtering/limiting agenda items:: Dynamically narrow the agenda
539 * Storing searches:: Type once, use often
540 * Block agenda:: All the stuff you need in a single buffer
541 * Setting options:: Changing the rules
543 Markup for rich export
545 * Structural markup elements:: The basic structure as seen by the exporter
546 * Images and tables:: Images, tables and caption mechanism
547 * Literal examples:: Source code examples with special formatting
548 * Include files:: Include additional files into a document
549 * Index entries:: Making an index
550 * Macro replacement:: Use macros to create templates
551 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
552 * Special blocks:: Containers targeted at export back-ends
554 Structural markup elements
556 * Document title:: Where the title is taken from
557 * Headings and sections:: The document structure as seen by the exporter
558 * Table of contents:: The if and where of the table of contents
560 * Paragraphs:: Paragraphs
561 * Footnote markup:: Footnotes
562 * Emphasis and monospace:: Bold, italic, etc.
563 * Horizontal rules:: Make a line
564 * Comment lines:: What will *not* be exported
568 * Special symbols:: Greek letters and other symbols
569 * Subscripts and superscripts:: Simple syntax for raising/lowering text
570 * @LaTeX{} fragments:: Complex formulas made easy
571 * Previewing @LaTeX{} fragments:: What will this snippet look like?
572 * CDLaTeX mode:: Speed up entering of formulas
576 * The export dispatcher:: The main exporter interface
577 * Export back-ends:: Built-in export formats
578 * Export settings:: Generic export settings
579 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
580 * Beamer export:: Exporting as a Beamer presentation
581 * HTML export:: Exporting to HTML
582 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
583 * Markdown export:: Exporting to Markdown
584 * OpenDocument Text export:: Exporting to OpenDocument Text
585 * Org export:: Exporting to Org
586 * Texinfo export:: Exporting to Texinfo
587 * iCalendar export:: Exporting to iCalendar
588 * Other built-in back-ends:: Exporting to a man page
589 * Export in foreign buffers:: Author tables and lists in Org syntax
590 * Advanced configuration:: Fine-tuning the export output
594 * HTML Export commands:: How to invoke HTML export
595 * HTML doctypes:: Org can export to various (X)HTML flavors
596 * HTML preamble and postamble:: How to insert a preamble and a postamble
597 * Quoting HTML tags:: Using direct HTML in Org mode
598 * Links in HTML export:: How links will be interpreted and formatted
599 * Tables in HTML export:: How to modify the formatting of tables
600 * Images in HTML export:: How to insert figures into HTML output
601 * Math formatting in HTML export:: Beautiful math also on the web
602 * Text areas in HTML export:: An alternative way to show an example
603 * CSS support:: Changing the appearance of the output
604 * JavaScript support:: Info and Folding in a web browser
606 @LaTeX{} and PDF export
608 * @LaTeX{} export commands:: How to export to LaTeX and PDF
609 * Header and sectioning:: Setting up the export file structure
610 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
611 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
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 * Labels and captions in ODT export:: How captions are rendered
624 * Literal examples in ODT export:: How source and example blocks are formatted
625 * Advanced topics in ODT export:: Read this if you are a power user
627 Math formatting in ODT export
629 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
630 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
632 Advanced topics in ODT export
634 * Configuring a document converter:: How to register a document converter
635 * Working with OpenDocument style files:: Explore the internals
636 * Creating one-off styles:: How to produce custom highlighting etc
637 * Customizing tables in ODT export:: How to define and use Table templates
638 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
642 * Texinfo export commands:: How to invoke Texinfo export
643 * Document preamble:: File header, title and copyright page
644 * Headings and sectioning structure:: Building document structure
645 * Indices:: Creating indices
646 * Quoting Texinfo code:: Incorporating literal Texinfo code
647 * Texinfo specific attributes:: Controlling Texinfo output
652 * Configuration:: Defining projects
653 * Uploading files:: How to get files up on the server
654 * Sample configuration:: Example projects
655 * Triggering publication:: Publication commands
659 * Project alist:: The central configuration variable
660 * Sources and destinations:: From here to there
661 * Selecting files:: What files are part of the project?
662 * Publishing action:: Setting the function doing the publishing
663 * Publishing options:: Tweaking HTML/@LaTeX{} export
664 * Publishing links:: Which links keep working after publishing?
665 * Sitemap:: Generating a list of all pages
666 * Generating an index:: An index that reaches across pages
670 * Simple example:: One-component publishing
671 * Complex example:: A multi-component publishing example
673 Working with source code
675 * Structure of code blocks:: Code block syntax described
676 * Editing source code:: Language major-mode editing
677 * Exporting code blocks:: Export contents and/or results
678 * Extracting source code:: Create pure source code files
679 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
680 * Library of Babel:: Use and contribute to a library of useful code blocks
681 * Languages:: List of supported code block languages
682 * Header arguments:: Configure code block functionality
683 * Results of evaluation:: How evaluation results are handled
684 * Noweb reference syntax:: Literate programming in Org mode
685 * Key bindings and useful functions:: Work quickly with code blocks
686 * Batch execution:: Call functions from the command line
690 * Using header arguments:: Different ways to set header arguments
691 * Specific header arguments:: List of header arguments
693 Using header arguments
695 * System-wide header arguments:: Set global default values
696 * Language-specific header arguments:: Set default values by language
697 * Header arguments in Org mode properties:: Set default values for a buffer or heading
698 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
699 * Code block specific header arguments:: The most common way to set values
700 * Header arguments in function calls:: The most specific level
702 Specific header arguments
704 * var:: Pass arguments to code blocks
705 * Results:: Specify the type of results and how they will
706 be collected and handled
707 * file:: Specify a path for file output
708 * file-desc:: Specify a description for file results
709 * dir:: Specify the default (possibly remote)
710 directory for code block execution
711 * exports:: Export code and/or results
712 * tangle:: Toggle tangling and specify file name
713 * mkdirp:: Toggle creation of parent directories of target
714 files during tangling
715 * comments:: Toggle insertion of comments in tangled
717 * padline:: Control insertion of padding lines in tangled
719 * no-expand:: Turn off variable assignment and noweb
720 expansion during tangling
721 * session:: Preserve the state of code evaluation
722 * noweb:: Toggle expansion of noweb references
723 * noweb-ref:: Specify block's noweb reference resolution target
724 * noweb-sep:: String used to separate noweb references
725 * cache:: Avoid re-evaluating unchanged code blocks
726 * sep:: Delimiter for writing tabular results outside Org
727 * hlines:: Handle horizontal lines in tables
728 * colnames:: Handle column names in tables
729 * rownames:: Handle row names in tables
730 * shebang:: Make tangled files executable
731 * tangle-mode:: Set permission of tangled files
732 * eval:: Limit evaluation of specific code blocks
733 * wrap:: Mark source block evaluation results
734 * post:: Post processing of code block results
735 * prologue:: Text to prepend to code block body
736 * epilogue:: Text to append to code block body
740 * Completion:: M-TAB knows what you need
741 * Easy templates:: Quick insertion of structural elements
742 * Speed keys:: Electric commands at the beginning of a headline
743 * Code evaluation security:: Org mode files evaluate inline code
744 * Customization:: Adapting Org to your taste
745 * In-buffer settings:: Overview of the #+KEYWORDS
746 * The very busy C-c C-c key:: When in doubt, press C-c C-c
747 * Clean view:: Getting rid of leading stars in the outline
748 * TTY keys:: Using Org on a tty
749 * Interaction:: Other Emacs packages
750 * org-crypt:: Encrypting Org files
752 Interaction with other packages
754 * Cooperation:: Packages Org cooperates with
755 * Conflicts:: Packages that lead to conflicts
759 * Hooks:: How to reach into Org's internals
760 * Add-on packages:: Available extensions
761 * Adding hyperlink types:: New custom link types
762 * Adding export back-ends:: How to write new export back-ends
763 * Context-sensitive commands:: How to add functionality to such commands
764 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
765 * Dynamic blocks:: Automatically filled blocks
766 * Special agenda views:: Customized views
767 * Speeding up your agendas:: Tips on how to speed up your agendas
768 * Extracting agenda information:: Post-processing of agenda information
769 * Using the property API:: Writing programs that use entry properties
770 * Using the mapping API:: Mapping over all or selected entries
772 Tables and lists in arbitrary syntax
774 * Radio tables:: Sending and receiving radio tables
775 * A @LaTeX{} example:: Step by step, almost a tutorial
776 * Translator functions:: Copy and modify
777 * Radio lists:: Sending and receiving lists
781 * Setting up the staging area:: Where to interact with the mobile device
782 * Pushing to MobileOrg:: Uploading Org files and agendas
783 * Pulling from MobileOrg:: Integrating captured and flagged items
789 @chapter Introduction
793 * Summary:: Brief summary of what Org does
794 * Installation:: Installing Org
795 * Activation:: How to activate Org for certain buffers
796 * Feedback:: Bug reports, ideas, patches etc.
797 * Conventions:: Typesetting conventions in the manual
804 Org is a mode for keeping notes, maintaining TODO lists, and project planning
805 with a fast and effective plain-text system. It also is an authoring system
806 with unique support for literate programming and reproducible research.
808 Org is implemented on top of Outline mode, which makes it possible to keep
809 the content of large files well structured. Visibility cycling and structure
810 editing help to work with the tree. Tables are easily created with a
811 built-in table editor. Plain text URL-like links connect to websites,
812 emails, Usenet messages, BBDB entries, and any files related to the projects.
814 Org develops organizational tasks around notes files that contain lists or
815 information about projects as plain text. Project planning and task
816 management makes use of metadata which is part of an outline node. Based on
817 this data, specific entries can be extracted in queries and create dynamic
818 @i{agenda views} that also integrate the Emacs calendar and diary. Org can
819 be used to implement many different project planning schemes, such as David
822 Org files can serve as a single source authoring system with export to many
823 different formats such as HTML, @LaTeX{}, Open Document, and Markdown. New
824 export backends can be derived from existing ones, or defined from scratch.
826 Org files can include source code blocks, which makes Org uniquely suited for
827 authoring technical documents with code examples. Org source code blocks are
828 fully functional; they can be evaluated in place and their results can be
829 captured in the file. This makes it possible to create a single file
830 reproducible research compendium.
832 Org keeps simple things simple. When first fired up, it should feel like a
833 straightforward, easy to use outliner. Complexity is not imposed, but a
834 large amount of functionality is available when needed. Org is a toolbox.
835 Many users usilize only a (very personal) fraction of Org's capabilities, and
836 know that there is more whenever they need it.
838 All of this is achieved with strictly plain text files, the most portable and
839 future-proof file format. Org runs in Emacs. Emacs is one of the most
840 widely ported programs, so that Org mode is available on every major
844 There is a website for Org which provides links to the newest
845 version of Org, as well as additional information, frequently asked
846 questions (FAQ), links to tutorials, etc. This page is located at
847 @uref{http://orgmode.org}.
848 @cindex print edition
850 An earlier version (7.3) of this manual is available as a
851 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from
857 @section Installation
861 Org is part of recent distributions of GNU Emacs, so you normally don't need
862 to install it. If, for one reason or another, you want to install Org on top
863 of this pre-packaged version, there are three ways to do it:
866 @item By using Emacs package system.
867 @item By downloading Org as an archive.
868 @item By using Org's git repository.
871 We @b{strongly recommend} to stick to a single installation method.
873 @subsubheading Using Emacs packaging system
875 Recent Emacs distributions include a packaging system which lets you install
876 Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
878 @noindent @b{Important}: you need to do this in a session where no @code{.org} file has
879 been visited, i.e. where no Org built-in function have been loaded.
880 Otherwise autoload Org functions will mess up the installation.
882 Then, to make sure your Org configuration is taken into account, initialize
883 the package system with @code{(package-initialize)} in your @file{.emacs}
884 before setting any Org option. If you want to use Org's package repository,
885 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
887 @subsubheading Downloading Org as an archive
889 You can download Org latest release from @uref{http://orgmode.org/, Org's
890 website}. In this case, make sure you set the load-path correctly in your
894 (add-to-list 'load-path "~/path/to/orgdir/lisp")
897 The downloaded archive contains contributed libraries that are not included
898 in Emacs. If you want to use them, add the @file{contrib} directory to your
902 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
905 Optionally, you can compile the files and/or install them in your system.
906 Run @code{make help} to list compilation and installation options.
908 @subsubheading Using Org's git repository
910 You can clone Org's repository and install Org like this:
914 $ git clone git://orgmode.org/org-mode.git
918 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
919 version in @file{org-version.el} and Org's autoloads in
920 @file{org-loaddefs.el}.
922 Remember to add the correct load-path as described in the method above.
924 You can also compile with @code{make}, generate the documentation with
925 @code{make doc}, create a local configuration with @code{make config} and
926 install Org with @code{make install}. Please run @code{make help} to get
927 the list of compilation/installation options.
929 For more detailed explanations on Org's build system, please check the Org
930 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
938 @cindex global key bindings
939 @cindex key bindings, global
942 @findex org-store-link
945 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
946 default. If you are using an earlier version of Emacs, add this line to your
950 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
953 Org mode buffers need font-lock to be turned on: this is the default in
954 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
955 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
957 There are compatibility issues between Org mode and some other Elisp
958 packages, please take the time to check the list (@pxref{Conflicts}).
960 The four Org commands @command{org-store-link}, @command{org-capture},
961 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
962 global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
963 suggested bindings for these keys, please modify the keys to your own
966 (global-set-key "\C-cl" 'org-store-link)
967 (global-set-key "\C-ca" 'org-agenda)
968 (global-set-key "\C-cc" 'org-capture)
969 (global-set-key "\C-cb" 'org-iswitchb)
972 @cindex Org mode, turning on
973 To turn on Org mode in a file that does not have the extension @file{.org},
974 make the first line of a file look like this:
977 MY PROJECTS -*- mode: org; -*-
980 @vindex org-insert-mode-line-in-empty-file
981 @noindent which will select Org mode for this buffer no matter what
982 the file's name is. See also the variable
983 @code{org-insert-mode-line-in-empty-file}.
985 Many commands in Org work on the region if the region is @i{active}. To make
986 use of this, you need to have @code{transient-mark-mode}
987 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
988 in Emacs 22 you need to do this yourself with
990 (transient-mark-mode 1)
992 @noindent If you do not like @code{transient-mark-mode}, you can create an
993 active region by using the mouse to select a region, or pressing
994 @kbd{C-@key{SPC}} twice before moving the cursor.
1003 If you find problems with Org, or if you have questions, remarks, or ideas
1004 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1005 You can subscribe to the list
1006 @uref{https://lists.gnu.org/mailman/listinfo/emacs-orgmode, on this web page}.
1007 If you are not a member of the mailing list, your mail will be passed to the
1008 list after a moderator has approved it@footnote{Please consider subscribing
1009 to the mailing list, in order to minimize the work the mailing list
1010 moderators have to do.}.
1012 For bug reports, please first try to reproduce the bug with the latest
1013 version of Org available---if you are running an outdated version, it is
1014 quite possible that the bug has been fixed already. If the bug persists,
1015 prepare a report and provide as much information as possible, including the
1016 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1017 (@kbd{M-x org-version RET}), as well as the Org related setup in
1018 @file{.emacs}. The easiest way to do this is to use the command
1020 @kbd{M-x org-submit-bug-report RET}
1022 @noindent which will put all this information into an Emacs mail buffer so
1023 that you only need to add your description. If you are not sending the Email
1024 from within Emacs, please copy and paste the content into your Email program.
1026 Sometimes you might face a problem due to an error in your Emacs or Org mode
1027 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1028 customizations and reproduce the problem. Doing so often helps you determine
1029 if the problem is with your customization or with Org mode itself. You can
1030 start a typical minimal session with a command like the example below.
1033 $ emacs -Q -l /path/to/minimal-org.el
1036 However if you are using Org mode as distributed with Emacs, a minimal setup
1037 is not necessary. In that case it is sufficient to start Emacs as
1038 @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
1042 ;;; Minimal setup to load latest `org-mode'
1044 ;; activate debugging
1045 (setq debug-on-error t
1049 ;; add latest org-mode to load path
1050 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1051 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1054 If an error occurs, a backtrace can be very useful (see below on how to
1055 create one). Often a small example file helps, along with clear information
1059 @item What exactly did you do?
1060 @item What did you expect to happen?
1061 @item What happened instead?
1063 @noindent Thank you for helping to improve this program.
1065 @subsubheading How to create a useful backtrace
1067 @cindex backtrace of an error
1068 If working with Org produces an error with a message you don't
1069 understand, you may have hit a bug. The best way to report this is by
1070 providing, in addition to what was mentioned above, a @emph{backtrace}.
1071 This is information from the built-in debugger about where and how the
1072 error occurred. Here is how to produce a useful backtrace:
1076 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1077 contains much more information if it is produced with uncompiled code.
1080 @kbd{C-u M-x org-reload RET}
1083 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1086 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1087 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1089 Do whatever you have to do to hit the error. Don't forget to
1090 document the steps you take.
1092 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1093 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1094 attach it to your bug report.
1098 @section Typesetting conventions used in this manual
1100 @subsubheading TODO keywords, tags, properties, etc.
1102 Org mainly uses three types of keywords: TODO keywords, tags and property
1103 names. In this manual we use the following conventions:
1108 TODO keywords are written with all capitals, even if they are
1112 User-defined tags are written in lowercase; built-in tags with special
1113 meaning are written with all capitals.
1116 User-defined properties are capitalized; built-in properties with
1117 special meaning are written with all capitals.
1120 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1121 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1122 environment). They are written in uppercase in the manual to enhance its
1123 readability, but you can use lowercase in your Org files@footnote{Easy
1124 templates insert lowercase keywords and Babel dynamically inserts
1127 @subsubheading Keybindings and commands
1133 The manual suggests a few global keybindings, in particular @kbd{C-c a} for
1134 @code{org-agenda} and @kbd{C-c c} for @code{org-capture}. These are only
1135 suggestions, but the rest of the manual assumes that these keybindings are in
1136 place in order to list commands by key access.
1138 Also, the manual lists both the keys and the corresponding commands for
1139 accessing a functionality. Org mode often uses the same key for different
1140 functions, depending on context. The command that is bound to such keys has
1141 a generic name, like @code{org-metaright}. In the manual we will, wherever
1142 possible, give the function that is internally called by the generic command.
1143 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1144 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1145 will be listed to call @code{org-table-move-column-right}. If you prefer,
1146 you can compile the manual without the command names by unsetting the flag
1147 @code{cmdnames} in @file{org.texi}.
1149 @node Document structure
1150 @chapter Document structure
1151 @cindex document structure
1152 @cindex structure of document
1154 Org is based on Outline mode and provides flexible commands to
1155 edit the structure of the document.
1158 * Outlines:: Org is based on Outline mode
1159 * Headlines:: How to typeset Org tree headlines
1160 * Visibility cycling:: Show and hide, much simplified
1161 * Motion:: Jumping to other headlines
1162 * Structure editing:: Changing sequence and level of headlines
1163 * Sparse trees:: Matches embedded in context
1164 * Plain lists:: Additional structure within an entry
1165 * Drawers:: Tucking stuff away
1166 * Blocks:: Folding blocks
1167 * Footnotes:: How footnotes are defined in Org's syntax
1168 * Orgstruct mode:: Structure editing outside Org
1169 * Org syntax:: Formal description of Org's syntax
1175 @cindex Outline mode
1177 Org is implemented on top of Outline mode. Outlines allow a
1178 document to be organized in a hierarchical structure, which (at least
1179 for me) is the best representation of notes and thoughts. An overview
1180 of this structure is achieved by folding (hiding) large parts of the
1181 document to show only the general document structure and the parts
1182 currently being worked on. Org greatly simplifies the use of
1183 outlines by compressing the entire show/hide functionality into a single
1184 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1189 @cindex outline tree
1190 @vindex org-special-ctrl-a/e
1191 @vindex org-special-ctrl-k
1192 @vindex org-ctrl-k-protect-subtree
1194 Headlines define the structure of an outline tree. The headlines in Org
1195 start with one or more stars, on the left margin@footnote{See the variables
1196 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1197 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1198 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1199 headings indented less then 30 stars.}. For example:
1202 * Top level headline
1209 * Another top level headline
1212 @noindent Some people find the many stars too noisy and would prefer an
1213 outline that has whitespace followed by a single star as headline
1214 starters. @ref{Clean view}, describes a setup to realize this.
1216 @vindex org-cycle-separator-lines
1217 An empty line after the end of a subtree is considered part of it and
1218 will be hidden when the subtree is folded. However, if you leave at
1219 least two empty lines, one empty line will remain visible after folding
1220 the subtree, in order to structure the collapsed view. See the
1221 variable @code{org-cycle-separator-lines} to modify this behavior.
1223 @node Visibility cycling
1224 @section Visibility cycling
1225 @cindex cycling, visibility
1226 @cindex visibility cycling
1227 @cindex trees, visibility
1228 @cindex show hidden text
1232 * Global and local cycling:: Cycling through various visibility states
1233 * Initial visibility:: Setting the initial visibility state
1234 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1237 @node Global and local cycling
1238 @subsection Global and local cycling
1240 Outlines make it possible to hide parts of the text in the buffer.
1241 Org uses just two commands, bound to @key{TAB} and
1242 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1244 @cindex subtree visibility states
1245 @cindex subtree cycling
1246 @cindex folded, subtree visibility state
1247 @cindex children, subtree visibility state
1248 @cindex subtree, subtree visibility state
1250 @orgcmd{@key{TAB},org-cycle}
1251 @emph{Subtree cycling}: Rotate current subtree among the states
1254 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1255 '-----------------------------------'
1258 @vindex org-cycle-emulate-tab
1259 @vindex org-cycle-global-at-bob
1260 The cursor must be on a headline for this to work@footnote{see, however,
1261 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1262 beginning of the buffer and the first line is not a headline, then
1263 @key{TAB} actually runs global cycling (see below)@footnote{see the
1264 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1265 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1267 @cindex global visibility states
1268 @cindex global cycling
1269 @cindex overview, global visibility state
1270 @cindex contents, global visibility state
1271 @cindex show all, global visibility state
1272 @orgcmd{S-@key{TAB},org-global-cycle}
1273 @itemx C-u @key{TAB}
1274 @emph{Global cycling}: Rotate the entire buffer among the states
1277 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1278 '--------------------------------------'
1281 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1282 CONTENTS view up to headlines of level N will be shown. Note that inside
1283 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1285 @cindex set startup visibility, command
1286 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1287 Switch back to the startup visibility of the buffer (@pxref{Initial visibility}).
1288 @cindex show all, command
1289 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1290 Show all, including drawers.
1291 @cindex revealing context
1292 @orgcmd{C-c C-r,org-reveal}
1293 Reveal context around point, showing the current entry, the following heading
1294 and the hierarchy above. Useful for working near a location that has been
1295 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1296 (@pxref{Agenda commands}). With a prefix argument show, on each
1297 level, all sibling headings. With a double prefix argument, also show the
1298 entire subtree of the parent.
1299 @cindex show branches, command
1300 @orgcmd{C-c C-k,show-branches}
1301 Expose all the headings of the subtree, CONTENT view for just one subtree.
1302 @cindex show children, command
1303 @orgcmd{C-c @key{TAB},show-children}
1304 Expose all direct children of the subtree. With a numeric prefix argument N,
1305 expose all children down to level N@.
1306 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1307 Show the current subtree in an indirect buffer@footnote{The indirect buffer
1308 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) will contain the entire
1309 buffer, but will be narrowed to the current tree. Editing the indirect
1310 buffer will also change the original buffer, but without affecting visibility
1311 in that buffer.}. With a numeric prefix argument N, go up to level N and
1312 then take that tree. If N is negative then go up that many levels. With a
1313 @kbd{C-u} prefix, do not remove the previously used indirect buffer.
1314 @orgcmd{C-c C-x v,org-copy-visible}
1315 Copy the @i{visible} text in the region into the kill ring.
1318 @node Initial visibility
1319 @subsection Initial visibility
1321 @cindex visibility, initialize
1322 @vindex org-startup-folded
1323 @vindex org-agenda-inhibit-startup
1324 @cindex @code{overview}, STARTUP keyword
1325 @cindex @code{content}, STARTUP keyword
1326 @cindex @code{showall}, STARTUP keyword
1327 @cindex @code{showeverything}, STARTUP keyword
1329 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1330 i.e., only the top level headlines are visible@footnote{When
1331 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1332 visibility state when first opening a file for the agenda (@pxref{Speeding up
1333 your agendas}).}. This can be configured through the variable
1334 @code{org-startup-folded}, or on a per-file basis by adding one of the
1335 following lines anywhere in the buffer:
1341 #+STARTUP: showeverything
1344 The startup visibility options are ignored when the file is open for the
1345 first time during the agenda generation: if you want the agenda to honor
1346 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1348 @cindex property, VISIBILITY
1350 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1351 and columns}) will get their visibility adapted accordingly. Allowed values
1352 for this property are @code{folded}, @code{children}, @code{content}, and
1356 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1357 Switch back to the startup visibility of the buffer, i.e., whatever is
1358 requested by startup options and @samp{VISIBILITY} properties in individual
1362 @node Catching invisible edits
1363 @subsection Catching invisible edits
1365 @vindex org-catch-invisible-edits
1366 @cindex edits, catching invisible
1367 Sometimes you may inadvertently edit an invisible part of the buffer and be
1368 confused on what has been edited and how to undo the mistake. Setting
1369 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this. See the
1370 docstring of this option on how Org should catch invisible edits and process
1375 @cindex motion, between headlines
1376 @cindex jumping, to headlines
1377 @cindex headline navigation
1378 The following commands jump to other headlines in the buffer.
1381 @orgcmd{C-c C-n,outline-next-visible-heading}
1383 @orgcmd{C-c C-p,outline-previous-visible-heading}
1385 @orgcmd{C-c C-f,org-forward-same-level}
1386 Next heading same level.
1387 @orgcmd{C-c C-b,org-backward-same-level}
1388 Previous heading same level.
1389 @orgcmd{C-c C-u,outline-up-heading}
1390 Backward to higher level heading.
1391 @orgcmd{C-c C-j,org-goto}
1392 Jump to a different place without changing the current outline
1393 visibility. Shows the document structure in a temporary buffer, where
1394 you can use the following keys to find your destination:
1395 @vindex org-goto-auto-isearch
1397 @key{TAB} @r{Cycle visibility.}
1398 @key{down} / @key{up} @r{Next/previous visible headline.}
1399 @key{RET} @r{Select this location.}
1400 @kbd{/} @r{Do a Sparse-tree search}
1401 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1402 n / p @r{Next/previous visible headline.}
1403 f / b @r{Next/previous headline same level.}
1405 0-9 @r{Digit argument.}
1408 @vindex org-goto-interface
1410 See also the option @code{org-goto-interface}.
1413 @node Structure editing
1414 @section Structure editing
1415 @cindex structure editing
1416 @cindex headline, promotion and demotion
1417 @cindex promotion, of subtrees
1418 @cindex demotion, of subtrees
1419 @cindex subtree, cut and paste
1420 @cindex pasting, of subtrees
1421 @cindex cutting, of subtrees
1422 @cindex copying, of subtrees
1423 @cindex sorting, of subtrees
1424 @cindex subtrees, cut and paste
1427 @orgcmd{M-@key{RET},org-insert-heading}
1428 @vindex org-M-RET-may-split-line
1429 Insert a new heading/item with the same level as the one at point.
1431 If the cursor is in a plain list item, a new item is created (@pxref{Plain
1432 lists}). To prevent this behavior in lists, call the command with one prefix
1433 argument. When this command is used in the middle of a line, the line is
1434 split and the rest of the line becomes the new item or headline. If you do
1435 not want the line to be split, customize @code{org-M-RET-may-split-line}.
1437 If the command is used at the @emph{beginning} of a line, and if there is a
1438 heading or an item at point, the new heading/item is created @emph{before}
1439 the current line. If the command is used at the @emph{end} of a folded
1440 subtree (i.e., behind the ellipses at the end of a headline), then a headline
1441 will be inserted after the end of the subtree.
1443 Calling this command with @kbd{C-u C-u} will unconditionally respect the
1444 headline's content and create a new item at the end of the parent subtree.
1446 If point is at the beginning of a normal line, turn this line into a heading.
1447 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1448 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1449 current heading, the new heading is placed after the body instead of before
1450 it. This command works from anywhere in the entry.
1451 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1452 @vindex org-treat-insert-todo-heading-as-state-change
1453 Insert new TODO entry with same level as current heading. See also the
1454 variable @code{org-treat-insert-todo-heading-as-state-change}.
1455 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1456 Insert new TODO entry with same level as current heading. Like
1457 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1459 @orgcmd{@key{TAB},org-cycle}
1460 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1461 become a child of the previous one. The next @key{TAB} makes it a parent,
1462 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1463 to the initial level.
1464 @orgcmd{M-@key{left},org-do-promote}
1465 Promote current heading by one level.
1466 @orgcmd{M-@key{right},org-do-demote}
1467 Demote current heading by one level.
1468 @orgcmd{M-S-@key{left},org-promote-subtree}
1469 Promote the current subtree by one level.
1470 @orgcmd{M-S-@key{right},org-demote-subtree}
1471 Demote the current subtree by one level.
1472 @orgcmd{M-S-@key{up},org-move-subtree-up}
1473 Move subtree up (swap with previous subtree of same
1475 @orgcmd{M-S-@key{down},org-move-subtree-down}
1476 Move subtree down (swap with next subtree of same level).
1477 @orgcmd{M-h,org-mark-element}
1478 Mark the element at point. Hitting repeatedly will mark subsequent elements
1479 of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it,
1480 hitting @key{M-h} immediately again will mark the next one.
1481 @orgcmd{C-c @@,org-mark-subtree}
1482 Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
1483 of the same level than the marked subtree.
1484 @orgcmd{C-c C-x C-w,org-cut-subtree}
1485 Kill subtree, i.e., remove it from buffer but save in kill ring.
1486 With a numeric prefix argument N, kill N sequential subtrees.
1487 @orgcmd{C-c C-x M-w,org-copy-subtree}
1488 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1489 sequential subtrees.
1490 @orgcmd{C-c C-x C-y,org-paste-subtree}
1491 Yank subtree from kill ring. This does modify the level of the subtree to
1492 make sure the tree fits in nicely at the yank position. The yank level can
1493 also be specified with a numeric prefix argument, or by yanking after a
1494 headline marker like @samp{****}.
1495 @orgcmd{C-y,org-yank}
1496 @vindex org-yank-adjusted-subtrees
1497 @vindex org-yank-folded-subtrees
1498 Depending on the options @code{org-yank-adjusted-subtrees} and
1499 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1500 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1501 C-x C-y}. With the default settings, no level adjustment will take place,
1502 but the yanked tree will be folded unless doing so would swallow text
1503 previously visible. Any prefix argument to this command will force a normal
1504 @code{yank} to be executed, with the prefix passed along. A good way to
1505 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1506 yank, it will yank previous kill items plainly, without adjustment and
1508 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1509 Clone a subtree by making a number of sibling copies of it. You will be
1510 prompted for the number of copies to make, and you can also specify if any
1511 timestamps in the entry should be shifted. This can be useful, for example,
1512 to create a number of tasks related to a series of lectures to prepare. For
1513 more details, see the docstring of the command
1514 @code{org-clone-subtree-with-time-shift}.
1515 @orgcmd{C-c C-w,org-refile}
1516 Refile entry or region to a different location. @xref{Refile and copy}.
1517 @orgcmd{C-c ^,org-sort}
1518 Sort same-level entries. When there is an active region, all entries in the
1519 region will be sorted. Otherwise the children of the current headline are
1520 sorted. The command prompts for the sorting method, which can be
1521 alphabetically, numerically, by time (first timestamp with active preferred,
1522 creation time, scheduled time, deadline time), by priority, by TODO keyword
1523 (in the sequence the keywords have been defined in the setup) or by the value
1524 of a property. Reverse sorting is possible as well. You can also supply
1525 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1526 sorting will be case-sensitive.
1527 @orgcmd{C-x n s,org-narrow-to-subtree}
1528 Narrow buffer to current subtree.
1529 @orgcmd{C-x n b,org-narrow-to-block}
1530 Narrow buffer to current block.
1531 @orgcmd{C-x n w,widen}
1532 Widen buffer to remove narrowing.
1533 @orgcmd{C-c *,org-toggle-heading}
1534 Turn a normal line or plain list item into a headline (so that it becomes a
1535 subheading at its location). Also turn a headline into a normal line by
1536 removing the stars. If there is an active region, turn all lines in the
1537 region into headlines. If the first line in the region was an item, turn
1538 only the item lines into headlines. Finally, if the first line is a
1539 headline, remove the stars from all headlines in the region.
1542 @cindex region, active
1543 @cindex active region
1544 @cindex transient mark mode
1545 When there is an active region (Transient Mark mode), promotion and
1546 demotion work on all headlines in the region. To select a region of
1547 headlines, it is best to place both point and mark at the beginning of a
1548 line, mark at the beginning of the first headline, and point at the line
1549 just after the last headline to change. Note that when the cursor is
1550 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1555 @section Sparse trees
1556 @cindex sparse trees
1557 @cindex trees, sparse
1558 @cindex folding, sparse trees
1559 @cindex occur, command
1561 @vindex org-show-hierarchy-above
1562 @vindex org-show-following-heading
1563 @vindex org-show-siblings
1564 @vindex org-show-entry-below
1565 An important feature of Org mode is the ability to construct @emph{sparse
1566 trees} for selected information in an outline tree, so that the entire
1567 document is folded as much as possible, but the selected information is made
1568 visible along with the headline structure above it@footnote{See also the
1569 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1570 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1571 control on how much context is shown around each match.}. Just try it out
1572 and you will see immediately how it works.
1574 Org mode contains several commands for creating such trees, all these
1575 commands can be accessed through a dispatcher:
1578 @orgcmd{C-c /,org-sparse-tree}
1579 This prompts for an extra key to select a sparse-tree creating command.
1580 @orgcmd{C-c / r,org-occur}
1581 @vindex org-remove-highlights-with-change
1582 Prompts for a regexp and shows a sparse tree with all matches. If
1583 the match is in a headline, the headline is made visible. If the match is in
1584 the body of an entry, headline and body are made visible. In order to
1585 provide minimal context, also the full hierarchy of headlines above the match
1586 is shown, as well as the headline following the match. Each match is also
1587 highlighted; the highlights disappear when the buffer is changed by an
1588 editing command@footnote{This depends on the option
1589 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1590 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1591 so several calls to this command can be stacked.
1592 @orgcmdkkc{M-g n,M-g M-n,next-error}
1593 Jump to the next sparse tree match in this buffer.
1594 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1595 Jump to the previous sparse tree match in this buffer.
1599 @vindex org-agenda-custom-commands
1600 For frequently used sparse trees of specific search strings, you can
1601 use the option @code{org-agenda-custom-commands} to define fast
1602 keyboard access to specific sparse trees. These commands will then be
1603 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1607 (setq org-agenda-custom-commands
1608 '(("f" occur-tree "FIXME")))
1611 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1612 a sparse tree matching the string @samp{FIXME}.
1614 The other sparse tree commands select headings based on TODO keywords,
1615 tags, or properties and will be discussed later in this manual.
1618 @cindex printing sparse trees
1619 @cindex visible text, printing
1620 To print a sparse tree, you can use the Emacs command
1621 @code{ps-print-buffer-with-faces} which does not print invisible parts
1622 of the document @footnote{This does not work under XEmacs, because
1623 XEmacs uses selective display for outlining, not text properties.}.
1624 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1625 the document and print the resulting file.
1628 @section Plain lists
1630 @cindex lists, plain
1631 @cindex lists, ordered
1632 @cindex ordered lists
1634 Within an entry of the outline tree, hand-formatted lists can provide
1635 additional structure. They also provide a way to create lists of checkboxes
1636 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1637 (@pxref{Exporting}) can parse and format them.
1639 Org knows ordered lists, unordered lists, and description lists.
1642 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1643 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1644 they will be seen as top-level headlines. Also, when you are hiding leading
1645 stars to get a clean outline view, plain list items starting with a star may
1646 be hard to distinguish from true headlines. In short: even though @samp{*}
1647 is supported, it may be better to not use it for plain list items.} as
1650 @vindex org-plain-list-ordered-item-terminator
1651 @vindex org-list-allow-alphabetical
1652 @emph{Ordered} list items start with a numeral followed by either a period or
1653 a right parenthesis@footnote{You can filter out any of them by configuring
1654 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1655 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1656 @samp{A)} by configuring @code{org-list-allow-alphabetical}. To minimize
1657 confusion with normal text, those are limited to one character only. Beyond
1658 that limit, bullets will automatically fallback to numbers.}. If you want a
1659 list to start with a different value (e.g., 20), start the text of the item
1660 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1661 must be put @emph{before} the checkbox. If you have activated alphabetical
1662 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1663 be used in any item of the list in order to enforce a particular numbering.
1665 @emph{Description} list items are unordered list items, and contain the
1666 separator @samp{ :: } to distinguish the description @emph{term} from the
1670 Items belonging to the same list must have the same indentation on the first
1671 line. In particular, if an ordered list reaches number @samp{10.}, then the
1672 2--digit numbers must be written left-aligned with the other numbers in the
1673 list. An item ends before the next line that is less or equally indented
1674 than its bullet/number.
1676 @vindex org-list-empty-line-terminates-plain-lists
1677 A list ends whenever every item has ended, which means before any line less
1678 or equally indented than items at top level. It also ends before two blank
1679 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1680 In that case, all items are closed. Here is an example:
1684 ** Lord of the Rings
1685 My favorite scenes are (in this order)
1686 1. The attack of the Rohirrim
1687 2. Eowyn's fight with the witch king
1688 + this was already my favorite scene in the book
1689 + I really like Miranda Otto.
1690 3. Peter Jackson being shot by Legolas
1692 He makes a really funny face when it happens.
1693 But in the end, no individual scenes matter but the film as a whole.
1694 Important actors in this film are:
1695 - @b{Elijah Wood} :: He plays Frodo
1696 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1697 him very well from his role as Mikey Walsh in @i{The Goonies}.
1701 Org supports these lists by tuning filling and wrapping commands to deal with
1702 them correctly@footnote{Org only changes the filling settings for Emacs. For
1703 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1704 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1705 properly (@pxref{Exporting}). Since indentation is what governs the
1706 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1707 blocks can be indented to signal that they belong to a particular item.
1709 @vindex org-list-demote-modify-bullet
1710 @vindex org-list-indent-offset
1711 If you find that using a different bullet for a sub-list (than that used for
1712 the current list-level) improves readability, customize the variable
1713 @code{org-list-demote-modify-bullet}. To get a greater difference of
1714 indentation between items and their sub-items, customize
1715 @code{org-list-indent-offset}.
1717 @vindex org-list-automatic-rules
1718 The following commands act on items when the cursor is in the first line of
1719 an item (the line with the bullet or number). Some of them imply the
1720 application of automatic rules to keep list structure intact. If some of
1721 these actions get in your way, configure @code{org-list-automatic-rules}
1722 to disable them individually.
1725 @orgcmd{@key{TAB},org-cycle}
1726 @cindex cycling, in plain lists
1727 @vindex org-cycle-include-plain-lists
1728 Items can be folded just like headline levels. Normally this works only if
1729 the cursor is on a plain list item. For more details, see the variable
1730 @code{org-cycle-include-plain-lists}. If this variable is set to
1731 @code{integrate}, plain list items will be treated like low-level
1732 headlines. The level of an item is then given by the indentation of the
1733 bullet/number. Items are always subordinate to real headlines, however; the
1734 hierarchies remain completely separated. In a new item with no text yet, the
1735 first @key{TAB} demotes the item to become a child of the previous
1736 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1737 and eventually get it back to its initial position.
1738 @orgcmd{M-@key{RET},org-insert-heading}
1739 @vindex org-M-RET-may-split-line
1740 @vindex org-list-automatic-rules
1741 Insert new item at current level. With a prefix argument, force a new
1742 heading (@pxref{Structure editing}). If this command is used in the middle
1743 of an item, that item is @emph{split} in two, and the second part becomes the
1744 new item@footnote{If you do not want the item to be split, customize the
1745 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1746 @emph{before item's body}, the new item is created @emph{before} the current
1751 @kindex M-S-@key{RET}
1753 Insert a new item with a checkbox (@pxref{Checkboxes}).
1754 @kindex S-@key{down}
1757 @cindex shift-selection-mode
1758 @vindex org-support-shift-select
1759 @vindex org-list-use-circular-motion
1760 Jump to the previous/next item in the current list@footnote{If you want to
1761 cycle around items that way, you may customize
1762 @code{org-list-use-circular-motion}.}, but only if
1763 @code{org-support-shift-select} is off. If not, you can still use paragraph
1764 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1767 @kindex M-@key{down}
1770 Move the item including subitems up/down@footnote{See
1771 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1772 previous/next item of same indentation). If the list is ordered, renumbering
1774 @kindex M-@key{left}
1775 @kindex M-@key{right}
1778 Decrease/increase the indentation of an item, leaving children alone.
1779 @kindex M-S-@key{left}
1780 @kindex M-S-@key{right}
1781 @item M-S-@key{left}
1782 @itemx M-S-@key{right}
1783 Decrease/increase the indentation of the item, including subitems.
1784 Initially, the item tree is selected based on current indentation. When
1785 these commands are executed several times in direct succession, the initially
1786 selected region is used, even if the new indentation would imply a different
1787 hierarchy. To use the new hierarchy, break the command chain with a cursor
1790 As a special case, using this command on the very first item of a list will
1791 move the whole list. This behavior can be disabled by configuring
1792 @code{org-list-automatic-rules}. The global indentation of a list has no
1793 influence on the text @emph{after} the list.
1796 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1797 state of the checkbox. In any case, verify bullets and indentation
1798 consistency in the whole list.
1800 @vindex org-plain-list-ordered-item-terminator
1802 Cycle the entire list level through the different itemize/enumerate bullets
1803 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1804 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1805 and its indentation. With a numeric prefix argument N, select the Nth bullet
1806 from this list. If there is an active region when calling this, selected
1807 text will be changed into an item. With a prefix argument, all lines will be
1808 converted to list items. If the first line already was a list item, any item
1809 marker will be removed from the list. Finally, even without an active
1810 region, a normal line will be converted into a list item.
1813 Turn a plain list item into a headline (so that it becomes a subheading at
1814 its location). @xref{Structure editing}, for a detailed explanation.
1817 Turn the whole plain list into a subtree of the current heading. Checkboxes
1818 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1820 @kindex S-@key{left}
1821 @kindex S-@key{right}
1823 @vindex org-support-shift-select
1824 This command also cycles bullet styles when the cursor in on the bullet or
1825 anywhere in an item line, details depending on
1826 @code{org-support-shift-select}.
1828 @cindex sorting, of plain list
1830 Sort the plain list. You will be prompted for the sorting method:
1831 numerically, alphabetically, by time, by checked status for check lists,
1832 or by a custom function.
1838 @cindex visibility cycling, drawers
1840 @cindex org-insert-drawer
1842 Sometimes you want to keep information associated with an entry, but you
1843 normally don't want to see it. For this, Org mode has @emph{drawers}. They
1844 can contain anything but a headline and another drawer. Drawers look like
1848 ** This is a headline
1849 Still outside the drawer
1851 This is inside the drawer.
1856 You can interactively insert drawers at point by calling
1857 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1858 region, this command will put the region inside the drawer. With a prefix
1859 argument, this command calls @code{org-insert-property-drawer} and add a
1860 property drawer right below the current headline. Completion over drawer
1861 keywords is also possible using @key{M-TAB}.
1863 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1864 show the entry, but keep the drawer collapsed to a single line. In order to
1865 look inside the drawer, you need to move the cursor to the drawer line and
1866 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1867 storing properties (@pxref{Properties and columns}), and you can also arrange
1868 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1869 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1870 want to store a quick note in the LOGBOOK drawer, in a similar way to state
1876 Add a time-stamped note to the LOGBOOK drawer.
1879 @vindex org-export-with-drawers
1880 @vindex org-export-with-properties
1881 You can select the name of the drawers which should be exported with
1882 @code{org-export-with-drawers}. In that case, drawer contents will appear in
1883 export output. Property drawers are not affected by this variable: configure
1884 @code{org-export-with-properties} instead.
1889 @vindex org-hide-block-startup
1890 @cindex blocks, folding
1891 Org mode uses begin...end blocks for various purposes from including source
1892 code examples (@pxref{Literal examples}) to capturing time logging
1893 information (@pxref{Clocking work time}). These blocks can be folded and
1894 unfolded by pressing TAB in the begin line. You can also get all blocks
1895 folded at startup by configuring the option @code{org-hide-block-startup}
1896 or on a per-file basis by using
1898 @cindex @code{hideblocks}, STARTUP keyword
1899 @cindex @code{nohideblocks}, STARTUP keyword
1901 #+STARTUP: hideblocks
1902 #+STARTUP: nohideblocks
1909 Org mode supports the creation of footnotes. In contrast to the
1910 @file{footnote.el} package, Org mode's footnotes are designed for work on
1911 a larger document, not only for one-off documents like emails.
1913 A footnote is started by a footnote marker in square brackets in column 0, no
1914 indentation allowed. It ends at the next footnote definition, headline, or
1915 after two consecutive empty lines. The footnote reference is simply the
1916 marker in square brackets, inside text. For example:
1919 The Org homepage[fn:1] now looks a lot better than it used to.
1921 [fn:1] The link is: http://orgmode.org
1924 Org mode extends the number-based syntax to @emph{named} footnotes and
1925 optional inline definition. Using plain numbers as markers (as
1926 @file{footnote.el} does) is supported for backward compatibility, but not
1927 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1928 @LaTeX{}}). Here are the valid references:
1932 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1933 recommended because something like @samp{[1]} could easily be part of a code
1936 A named footnote reference, where @code{name} is a unique label word, or, for
1937 simplicity of automatic creation, a number.
1938 @item [fn:: This is the inline definition of this footnote]
1939 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1941 @item [fn:name: a definition]
1942 An inline definition of a footnote, which also specifies a name for the note.
1943 Since Org allows multiple references to the same note, you can then use
1944 @code{[fn:name]} to create additional references.
1947 @vindex org-footnote-auto-label
1948 Footnote labels can be created automatically, or you can create names yourself.
1949 This is handled by the variable @code{org-footnote-auto-label} and its
1950 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1953 @noindent The following command handles footnotes:
1958 The footnote action command.
1960 When the cursor is on a footnote reference, jump to the definition. When it
1961 is at a definition, jump to the (first) reference.
1963 @vindex org-footnote-define-inline
1964 @vindex org-footnote-section
1965 @vindex org-footnote-auto-adjust
1966 Otherwise, create a new footnote. Depending on the option
1967 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1968 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1969 definition will be placed right into the text as part of the reference, or
1970 separately into the location determined by the option
1971 @code{org-footnote-section}.
1973 When this command is called with a prefix argument, a menu of additional
1976 s @r{Sort the footnote definitions by reference sequence. During editing,}
1977 @r{Org makes no effort to sort footnote definitions into a particular}
1978 @r{sequence. If you want them sorted, use this command, which will}
1979 @r{also move entries according to @code{org-footnote-section}. Automatic}
1980 @r{sorting after each insertion/deletion can be configured using the}
1981 @r{option @code{org-footnote-auto-adjust}.}
1982 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1983 @r{after each insertion/deletion can be configured using the option}
1984 @r{@code{org-footnote-auto-adjust}.}
1985 S @r{Short for first @code{r}, then @code{s} action.}
1986 n @r{Normalize the footnotes by collecting all definitions (including}
1987 @r{inline definitions) into a special section, and then numbering them}
1988 @r{in sequence. The references will then also be numbers. This is}
1989 @r{meant to be the final step before finishing a document (e.g., sending}
1991 d @r{Delete the footnote at point, and all definitions of and references}
1994 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1995 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1996 renumbering and sorting footnotes can be automatic after each insertion or
2001 If the cursor is on a footnote reference, jump to the definition. If it is a
2002 the definition, jump back to the reference. When called at a footnote
2003 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
2007 @item C-c C-o @r{or} mouse-1/2
2008 Footnote labels are also links to the corresponding definition/reference, and
2009 you can use the usual commands to follow these links.
2012 @node Orgstruct mode
2013 @section The Orgstruct minor mode
2014 @cindex Orgstruct mode
2015 @cindex minor mode for structure editing
2017 If you like the intuitive way the Org mode structure editing and list
2018 formatting works, you might want to use these commands in other modes like
2019 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
2020 this possible. Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2021 turn it on by default, for example in Message mode, with one of:
2024 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2025 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2028 When this mode is active and the cursor is on a line that looks to Org like a
2029 headline or the first line of a list item, most structure editing commands
2030 will work, even if the same keys normally have different functionality in the
2031 major mode you are using. If the cursor is not in one of those special
2032 lines, Orgstruct mode lurks silently in the shadows.
2034 When you use @code{orgstruct++-mode}, Org will also export indentation and
2035 autofill settings into that mode, and detect item context after the first
2038 @vindex orgstruct-heading-prefix-regexp
2039 You can also use Org structure editing to fold and unfold headlines in
2040 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2041 the regular expression must match the local prefix to use before Org's
2042 headlines. For example, if you set this variable to @code{";; "} in Emacs
2043 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2044 commented lines. Some commands like @code{org-demote} are disabled when the
2045 prefix is set, but folding/unfolding will work correctly.
2051 A reference document providing a formal description of Org's syntax is
2052 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2053 Worg}, written and maintained by Nicolas Goaziou. It defines Org's core
2054 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2055 keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org
2056 file falls into one of the categories above.
2058 To explore the abstract structure of an Org buffer, run this in a buffer:
2061 M-: (org-element-parse-buffer) RET
2064 It will output a list containing the buffer's content represented as an
2065 abstract structure. The export engine relies on the information stored in
2066 this list. Most interactive commands (e.g., for structure editing) also
2067 rely on the syntactic meaning of the surrounding context.
2072 @cindex editing tables
2074 Org comes with a fast and intuitive table editor. Spreadsheet-like
2075 calculations are supported using the Emacs @file{calc} package
2076 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2079 * Built-in table editor:: Simple tables
2080 * Column width and alignment:: Overrule the automatic settings
2081 * Column groups:: Grouping to trigger vertical lines
2082 * Orgtbl mode:: The table editor as minor mode
2083 * The spreadsheet:: The table editor has spreadsheet capabilities
2084 * Org-Plot:: Plotting from org tables
2087 @node Built-in table editor
2088 @section The built-in table editor
2089 @cindex table editor, built-in
2091 Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
2092 the first non-whitespace character is considered part of a table. @samp{|}
2093 is also the column separator@footnote{To insert a vertical bar into a table
2094 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2095 might look like this:
2098 | Name | Phone | Age |
2099 |-------+-------+-----|
2100 | Peter | 1234 | 17 |
2101 | Anna | 4321 | 25 |
2104 A table is re-aligned automatically each time you press @key{TAB} or
2105 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2106 the next field (@key{RET} to the next row) and creates new table rows
2107 at the end of the table or before horizontal lines. The indentation
2108 of the table is set by the first line. Any line starting with
2109 @samp{|-} is considered as a horizontal separator line and will be
2110 expanded on the next re-align to span the whole table width. So, to
2111 create the above table, you would only type
2118 @noindent and then press @key{TAB} to align the table and start filling in
2119 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2120 @kbd{C-c @key{RET}}.
2122 @vindex org-enable-table-editor
2123 @vindex org-table-auto-blank-field
2124 When typing text into a field, Org treats @key{DEL},
2125 @key{Backspace}, and all character keys in a special way, so that
2126 inserting and deleting avoids shifting other fields. Also, when
2127 typing @emph{immediately after the cursor was moved into a new field
2128 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2129 field is automatically made blank. If this behavior is too
2130 unpredictable for you, configure the options
2131 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2134 @tsubheading{Creation and conversion}
2135 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2136 Convert the active region to a table. If every line contains at least one
2137 TAB character, the function assumes that the material is tab separated.
2138 If every line contains a comma, comma-separated values (CSV) are assumed.
2139 If not, lines are split at whitespace into fields. You can use a prefix
2140 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2141 C-u} forces TAB, @kbd{C-u C-u C-u} will prompt for a regular expression to
2142 match the separator, and a numeric argument N indicates that at least N
2143 consecutive spaces, or alternatively a TAB will be the separator.
2145 If there is no active region, this command creates an empty Org
2146 table. But it is easier just to start typing, like
2147 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2149 @tsubheading{Re-aligning and field motion}
2150 @orgcmd{C-c C-c,org-table-align}
2151 Re-align the table and don't move to another field.
2153 @orgcmd{<TAB>,org-table-next-field}
2154 Re-align the table, move to the next field. Creates a new row if
2157 @orgcmd{S-@key{TAB},org-table-previous-field}
2158 Re-align, move to previous field.
2160 @orgcmd{@key{RET},org-table-next-row}
2161 Re-align the table and move down to next row. Creates a new row if
2162 necessary. At the beginning or end of a line, @key{RET} still does
2163 NEWLINE, so it can be used to split a table.
2165 @orgcmd{M-a,org-table-beginning-of-field}
2166 Move to beginning of the current table field, or on to the previous field.
2167 @orgcmd{M-e,org-table-end-of-field}
2168 Move to end of the current table field, or on to the next field.
2170 @tsubheading{Column and row editing}
2171 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2172 Move the current column left/right.
2174 @orgcmd{M-S-@key{left},org-table-delete-column}
2175 Kill the current column.
2177 @orgcmd{M-S-@key{right},org-table-insert-column}
2178 Insert a new column to the left of the cursor position.
2180 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2181 Move the current row up/down.
2183 @orgcmd{M-S-@key{up},org-table-kill-row}
2184 Kill the current row or horizontal line.
2186 @orgcmd{M-S-@key{down},org-table-insert-row}
2187 Insert a new row above the current row. With a prefix argument, the line is
2188 created below the current one.
2190 @orgcmd{C-c -,org-table-insert-hline}
2191 Insert a horizontal line below current row. With a prefix argument, the line
2192 is created above the current line.
2194 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2195 Insert a horizontal line below current row, and move the cursor into the row
2198 @orgcmd{C-c ^,org-table-sort-lines}
2199 Sort the table lines in the region. The position of point indicates the
2200 column to be used for sorting, and the range of lines is the range
2201 between the nearest horizontal separator lines, or the entire table. If
2202 point is before the first column, you will be prompted for the sorting
2203 column. If there is an active region, the mark specifies the first line
2204 and the sorting column, while point should be in the last line to be
2205 included into the sorting. The command prompts for the sorting type
2206 (alphabetically, numerically, or by time). When called with a prefix
2207 argument, alphabetic sorting will be case-sensitive.
2209 @tsubheading{Regions}
2210 @orgcmd{C-c C-x M-w,org-table-copy-region}
2211 Copy a rectangular region from a table to a special clipboard. Point and
2212 mark determine edge fields of the rectangle. If there is no active region,
2213 copy just the current field. The process ignores horizontal separator lines.
2215 @orgcmd{C-c C-x C-w,org-table-cut-region}
2216 Copy a rectangular region from a table to a special clipboard, and
2217 blank all fields in the rectangle. So this is the ``cut'' operation.
2219 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2220 Paste a rectangular region into a table.
2221 The upper left corner ends up in the current field. All involved fields
2222 will be overwritten. If the rectangle does not fit into the present table,
2223 the table is enlarged as needed. The process ignores horizontal separator
2226 @orgcmd{M-@key{RET},org-table-wrap-region}
2227 Split the current field at the cursor position and move the rest to the line
2228 below. If there is an active region, and both point and mark are in the same
2229 column, the text in the column is wrapped to minimum width for the given
2230 number of lines. A numeric prefix argument may be used to change the number
2231 of desired lines. If there is no region, but you specify a prefix argument,
2232 the current field is made blank, and the content is appended to the field
2235 @tsubheading{Calculations}
2236 @cindex formula, in tables
2237 @cindex calculations, in tables
2238 @cindex region, active
2239 @cindex active region
2240 @cindex transient mark mode
2241 @orgcmd{C-c +,org-table-sum}
2242 Sum the numbers in the current column, or in the rectangle defined by
2243 the active region. The result is shown in the echo area and can
2244 be inserted with @kbd{C-y}.
2246 @orgcmd{S-@key{RET},org-table-copy-down}
2247 @vindex org-table-copy-increment
2248 When current field is empty, copy from first non-empty field above. When not
2249 empty, copy current field down to next row and move cursor along with it.
2250 Depending on the option @code{org-table-copy-increment}, integer field
2251 values will be incremented during copy. Integers that are too large will not
2252 be incremented. Also, a @code{0} prefix argument temporarily disables the
2253 increment. This key is also used by shift-selection and related modes
2254 (@pxref{Conflicts}).
2256 @tsubheading{Miscellaneous}
2257 @orgcmd{C-c `,org-table-edit-field}
2258 Edit the current field in a separate window. This is useful for fields that
2259 are not fully visible (@pxref{Column width and alignment}). When called with
2260 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2261 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2262 window follow the cursor through the table and always show the current
2263 field. The follow mode exits automatically when the cursor leaves the table,
2264 or when you repeat this command with @kbd{C-u C-u C-c `}.
2266 @item M-x org-table-import RET
2267 Import a file as a table. The table should be TAB or whitespace
2268 separated. Use, for example, to import a spreadsheet table or data
2269 from a database, because these programs generally can write
2270 TAB-separated text files. This command works by inserting the file into
2271 the buffer and then converting the region to a table. Any prefix
2272 argument is passed on to the converter, which uses it to determine the
2274 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2275 Tables can also be imported by pasting tabular text into the Org
2276 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2277 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2279 @item M-x org-table-export RET
2280 @findex org-table-export
2281 @vindex org-table-export-default-format
2282 Export the table, by default as a TAB-separated file. Use for data
2283 exchange with, for example, spreadsheet or database programs. The format
2284 used to export the file can be configured in the option
2285 @code{org-table-export-default-format}. You may also use properties
2286 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2287 name and the format for table export in a subtree. Org supports quite
2288 general formats for exported tables. The exporter format is the same as the
2289 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2290 detailed description.
2293 If you don't like the automatic table editor because it gets in your
2294 way on lines which you would like to start with @samp{|}, you can turn
2298 (setq org-enable-table-editor nil)
2301 @noindent Then the only table command that still works is
2302 @kbd{C-c C-c} to do a manual re-align.
2304 @node Column width and alignment
2305 @section Column width and alignment
2306 @cindex narrow columns in tables
2307 @cindex alignment in tables
2309 The width of columns is automatically determined by the table editor. And
2310 also the alignment of a column is determined automatically from the fraction
2311 of number-like versus non-number fields in the column.
2313 Sometimes a single field or a few fields need to carry more text, leading to
2314 inconveniently wide columns. Or maybe you want to make a table with several
2315 columns having a fixed width, regardless of content. To set@footnote{This
2316 feature does not work on XEmacs.} the width of a column, one field anywhere
2317 in the column may contain just the string @samp{<N>} where @samp{N} is an
2318 integer specifying the width of the column in characters. The next re-align
2319 will then set the width of this column to this value.
2323 |---+------------------------------| |---+--------|
2325 | 1 | one | | 1 | one |
2326 | 2 | two | ----\ | 2 | two |
2327 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2328 | 4 | four | | 4 | four |
2329 |---+------------------------------| |---+--------|
2334 Fields that are wider become clipped and end in the string @samp{=>}.
2335 Note that the full text is still in the buffer but is hidden.
2336 To see the full text, hold the mouse over the field---a tool-tip window
2337 will show the full content. To edit such a field, use the command
2338 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2339 open a new window with the full field. Edit it and finish with @kbd{C-c
2342 @vindex org-startup-align-all-tables
2343 When visiting a file containing a table with narrowed columns, the
2344 necessary character hiding has not yet happened, and the table needs to
2345 be aligned before it looks nice. Setting the option
2346 @code{org-startup-align-all-tables} will realign all tables in a file
2347 upon visiting, but also slow down startup. You can also set this option
2348 on a per-file basis with:
2355 If you would like to overrule the automatic alignment of number-rich columns
2356 to the right and of string-rich column to the left, you can use @samp{<r>},
2357 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2358 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2359 also combine alignment and field width like this: @samp{<r10>}.
2361 Lines which only contain these formatting cookies will be removed
2362 automatically when exporting the document.
2365 @section Column groups
2366 @cindex grouping columns in tables
2368 When Org exports tables, it does so by default without vertical
2369 lines because that is visually more satisfying in general. Occasionally
2370 however, vertical lines can be useful to structure a table into groups
2371 of columns, much like horizontal lines can do for groups of rows. In
2372 order to specify column groups, you can use a special row where the
2373 first field contains only @samp{/}. The further fields can either
2374 contain @samp{<} to indicate that this column should start a group,
2375 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2376 and @samp{>}) to make a column
2377 a group of its own. Boundaries between column groups will upon export be
2378 marked with vertical lines. Here is an example:
2381 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2382 |---+-----+-----+-----+---------+------------|
2383 | / | < | | > | < | > |
2384 | 1 | 1 | 1 | 1 | 1 | 1 |
2385 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2386 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2387 |---+-----+-----+-----+---------+------------|
2388 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2391 It is also sufficient to just insert the column group starters after
2392 every vertical line you would like to have:
2395 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2396 |----+-----+-----+-----+---------+------------|
2401 @section The Orgtbl minor mode
2403 @cindex minor mode for tables
2405 If you like the intuitive way the Org table editor works, you
2406 might also want to use it in other modes like Text mode or Mail mode.
2407 The minor mode Orgtbl mode makes this possible. You can always toggle
2408 the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for
2409 example in Message mode, use
2412 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2415 Furthermore, with some special setup, it is possible to maintain tables
2416 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2417 construct @LaTeX{} tables with the underlying ease and power of
2418 Orgtbl mode, including spreadsheet capabilities. For details, see
2419 @ref{Tables in arbitrary syntax}.
2421 @node The spreadsheet
2422 @section The spreadsheet
2423 @cindex calculations, in tables
2424 @cindex spreadsheet capabilities
2425 @cindex @file{calc} package
2427 The table editor makes use of the Emacs @file{calc} package to implement
2428 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2429 derive fields from other fields. While fully featured, Org's implementation
2430 is not identical to other spreadsheets. For example, Org knows the concept
2431 of a @emph{column formula} that will be applied to all non-header fields in a
2432 column without having to copy the formula to each relevant field. There is
2433 also a formula debugger, and a formula editor with features for highlighting
2434 fields in the table corresponding to the references at the point in the
2435 formula, moving these references by arrow keys
2438 * References:: How to refer to another field or range
2439 * Formula syntax for Calc:: Using Calc to compute stuff
2440 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2441 * Durations and time values:: How to compute durations and time values
2442 * Field and range formulas:: Formula for specific (ranges of) fields
2443 * Column formulas:: Formulas valid for an entire column
2444 * Lookup functions:: Lookup functions for searching tables
2445 * Editing and debugging formulas:: Fixing formulas
2446 * Updating the table:: Recomputing all dependent fields
2447 * Advanced features:: Field and column names, parameters and automatic recalc
2451 @subsection References
2454 To compute fields in the table from other fields, formulas must
2455 reference other fields or ranges. In Org, fields can be referenced
2456 by name, by absolute coordinates, and by relative coordinates. To find
2457 out what the coordinates of a field are, press @kbd{C-c ?} in that
2458 field, or press @kbd{C-c @}} to toggle the display of a grid.
2460 @subsubheading Field references
2461 @cindex field references
2462 @cindex references, to fields
2464 Formulas can reference the value of another field in two ways. Like in
2465 any other spreadsheet, you may reference fields with a letter/number
2466 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2467 @vindex org-table-use-standard-references
2468 However, Org prefers@footnote{Org will understand references typed by the
2469 user as @samp{B4}, but it will not use this syntax when offering a formula
2470 for editing. You can customize this behavior using the option
2471 @code{org-table-use-standard-references}.} to use another, more general
2472 representation that looks like this:
2474 @@@var{row}$@var{column}
2477 Column specifications can be absolute like @code{$1},
2478 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2479 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2480 @code{$<} and @code{$>} are immutable references to the first and last
2481 column, respectively, and you can use @code{$>>>} to indicate the third
2482 column from the right.
2484 The row specification only counts data lines and ignores horizontal separator
2485 lines (hlines). Like with columns, you can use absolute row numbers
2486 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2487 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2488 immutable references the first and last@footnote{For backward compatibility
2489 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2490 a stable way to the 5th and 12th field in the last row of the table.
2491 However, this syntax is deprecated, it should not be used for new documents.
2492 Use @code{@@>$} instead.} row in the table, respectively. You may also
2493 specify the row relative to one of the hlines: @code{@@I} refers to the first
2494 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2495 line above the current line, @code{@@+I} to the first such line below the
2496 current line. You can also write @code{@@III+2} which is the second data line
2497 after the third hline in the table.
2499 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2500 i.e., to the row/column for the field being computed. Also, if you omit
2501 either the column or the row part of the reference, the current row/column is
2504 Org's references with @emph{unsigned} numbers are fixed references
2505 in the sense that if you use the same reference in the formula for two
2506 different fields, the same field will be referenced each time.
2507 Org's references with @emph{signed} numbers are floating
2508 references because the same reference operator can reference different
2509 fields depending on the field being calculated by the formula.
2511 Here are a few examples:
2514 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2515 $5 @r{column 5 in the current row (same as @code{E&})}
2516 @@2 @r{current column, row 2}
2517 @@-1$-3 @r{the field one row up, three columns to the left}
2518 @@-I$2 @r{field just under hline above current row, column 2}
2519 @@>$5 @r{field in the last row, in column 5}
2522 @subsubheading Range references
2523 @cindex range references
2524 @cindex references, to ranges
2526 You may reference a rectangular range of fields by specifying two field
2527 references connected by two dots @samp{..}. If both fields are in the
2528 current row, you may simply use @samp{$2..$7}, but if at least one field
2529 is in a different row, you need to use the general @code{@@row$column}
2530 format at least for the first field (i.e the reference must start with
2531 @samp{@@} in order to be interpreted correctly). Examples:
2534 $1..$3 @r{first three fields in the current row}
2535 $P..$Q @r{range, using column names (see under Advanced)}
2536 $<<<..$>> @r{start in third column, continue to the last but one}
2537 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2538 @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
2539 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2542 @noindent Range references return a vector of values that can be fed
2543 into Calc vector functions. Empty fields in ranges are normally suppressed,
2544 so that the vector contains only the non-empty fields. For other options
2545 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2548 @subsubheading Field coordinates in formulas
2549 @cindex field coordinates
2550 @cindex coordinates, of field
2551 @cindex row, of field coordinates
2552 @cindex column, of field coordinates
2554 One of the very first actions during evaluation of Calc formulas and Lisp
2555 formulas is to substitute @code{@@#} and @code{$#} in the formula with the
2556 row or column number of the field where the current result will go to. The
2557 traditional Lisp formula equivalents are @code{org-table-current-dline} and
2558 @code{org-table-current-column}. Examples:
2561 @item if(@@# % 2, $#, string(""))
2562 Insert column number on odd rows, set field to empty on even rows.
2563 @item $2 = '(identity remote(FOO, @@@@#$1))
2564 Copy text or values of each row of column 1 of the table named @code{FOO}
2565 into column 2 of the current table.
2566 @item @@3 = 2 * remote(FOO, @@1$$#)
2567 Insert the doubled value of each column of row 1 of the table named
2568 @code{FOO} into row 3 of the current table.
2571 @noindent For the second/third example, the table named @code{FOO} must have
2572 at least as many rows/columns as the current table. Note that this is
2573 inefficient@footnote{The computation time scales as O(N^2) because the table
2574 named @code{FOO} is parsed for each field to be read.} for large number of
2577 @subsubheading Named references
2578 @cindex named references
2579 @cindex references, named
2580 @cindex name, of column or field
2581 @cindex constants, in calculations
2584 @vindex org-table-formula-constants
2585 @samp{$name} is interpreted as the name of a column, parameter or
2586 constant. Constants are defined globally through the option
2587 @code{org-table-formula-constants}, and locally (for the file) through a
2591 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2595 @vindex constants-unit-system
2596 @pindex constants.el
2597 Also properties (@pxref{Properties and columns}) can be used as
2598 constants in table formulas: for a property @samp{:Xyz:} use the name
2599 @samp{$PROP_Xyz}, and the property will be searched in the current
2600 outline entry and in the hierarchy above it. If you have the
2601 @file{constants.el} package, it will also be used to resolve constants,
2602 including natural constants like @samp{$h} for Planck's constant, and
2603 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2604 supply the values of constants in two different unit systems, @code{SI}
2605 and @code{cgs}. Which one is used depends on the value of the variable
2606 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2607 @code{constSI} and @code{constcgs} to set this value for the current
2608 buffer.}. Column names and parameters can be specified in special table
2609 lines. These are described below, see @ref{Advanced features}. All
2610 names must start with a letter, and further consist of letters and
2613 @subsubheading Remote references
2614 @cindex remote references
2615 @cindex references, remote
2616 @cindex references, to a different table
2617 @cindex name, of column or field
2618 @cindex constants, in calculations
2619 @cindex #+NAME, for table
2621 You may also reference constants, fields and ranges from a different table,
2622 either in the current file or even in a different file. The syntax is
2625 remote(NAME-OR-ID,REF)
2629 where NAME can be the name of a table in the current file as set by a
2630 @code{#+NAME: Name} line before the table. It can also be the ID of an
2631 entry, even in a different file, and the reference then refers to the first
2632 table in that entry. REF is an absolute field or range reference as
2633 described above for example @code{@@3$3} or @code{$somename}, valid in the
2636 Indirection of NAME-OR-ID: When NAME-OR-ID has the format @code{@@ROW$COLUMN}
2637 it will be substituted with the name or ID found in this field of the current
2638 table. For example @code{remote($1, @@>$2)} => @code{remote(year_2013,
2639 @@>$1)}. The format @code{B3} is not supported because it can not be
2640 distinguished from a plain table name or ID.
2642 @node Formula syntax for Calc
2643 @subsection Formula syntax for Calc
2644 @cindex formula syntax, Calc
2645 @cindex syntax, of formulas
2647 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2648 package. Note that @file{calc} has the non-standard convention that @samp{/}
2649 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2650 @samp{a/(b*c)}. Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2651 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2652 GNU Emacs Calc Manual}), variable substitution takes place according to the
2653 rules described above.
2654 @cindex vectors, in table calculations
2655 The range vectors can be directly fed into the Calc vector functions
2656 like @samp{vmean} and @samp{vsum}.
2658 @cindex format specifier
2659 @cindex mode, for @file{calc}
2660 @vindex org-calc-default-modes
2661 A formula can contain an optional mode string after a semicolon. This
2662 string consists of flags to influence Calc and other modes during
2663 execution. By default, Org uses the standard Calc modes (precision
2664 12, angular units degrees, fraction and symbolic modes off). The display
2665 format, however, has been changed to @code{(float 8)} to keep tables
2666 compact. The default settings can be configured using the option
2667 @code{org-calc-default-modes}.
2669 @noindent List of modes:
2673 Set the internal Calc calculation precision to 20 digits.
2674 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2675 Normal, scientific, engineering or fixed format of the result of Calc passed
2676 back to Org. Calc formatting is unlimited in precision as long as the Calc
2677 calculation precision is greater.
2678 @item @code{D}, @code{R}
2679 Degree and radian angle modes of Calc.
2680 @item @code{F}, @code{S}
2681 Fraction and symbolic modes of Calc.
2682 @item @code{T}, @code{t}
2683 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2685 If and how to consider empty fields. Without @samp{E} empty fields in range
2686 references are suppressed so that the Calc vector or Lisp list contains only
2687 the non-empty fields. With @samp{E} the empty fields are kept. For empty
2688 fields in ranges or empty field references the value @samp{nan} (not a
2689 number) is used in Calc formulas and the empty string is used for Lisp
2690 formulas. Add @samp{N} to use 0 instead for both formula types. For the
2691 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2693 Interpret all fields as numbers, use 0 for non-numbers. See the next section
2694 to see how this is essential for computations with Lisp formulas. In Calc
2695 formulas it is used only occasionally because there number strings are
2696 already interpreted as numbers without @samp{N}.
2698 Literal, for Lisp formulas only. See the next section.
2702 Unless you use large integer numbers or high-precision-calculation and
2703 -display for floating point numbers you may alternatively provide a
2704 @samp{printf} format specifier to reformat the Calc result after it has been
2705 passed back to Org instead of letting Calc already do the
2706 formatting@footnote{The @samp{printf} reformatting is limited in precision
2707 because the value passed to it is converted into an @samp{integer} or
2708 @samp{double}. The @samp{integer} is limited in size by truncating the
2709 signed value to 32 bits. The @samp{double} is limited in precision to 64
2710 bits overall which leaves approximately 16 significant decimal digits.}. A
2714 $1+$2 @r{Sum of first and second field}
2715 $1+$2;%.2f @r{Same, format result to two decimals}
2716 exp($2)+exp($1) @r{Math functions can be used}
2717 $0;%.1f @r{Reformat current cell to 1 decimal}
2718 ($3-32)*5/9 @r{Degrees F -> C conversion}
2719 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2720 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2721 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2722 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2725 Calc also contains a complete set of logical operations, (@pxref{Logical
2726 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example
2729 @item if($1 < 20, teen, string(""))
2730 "teen" if age $1 is less than 20, else the Org table result field is set to
2731 empty with the empty string.
2732 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1
2733 Sum of the first two columns. When at least one of the input fields is empty
2734 the Org table result field is set to empty. @samp{E} is required to not
2735 convert empty fields to 0. @samp{f-1} is an optional Calc format string
2736 similar to @samp{%.1f} but leaves empty results empty.
2737 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2738 Mean value of a range unless there is any empty field. Every field in the
2739 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2740 in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from
2741 @samp{vmean} and the Org table result field is set to empty. Use this when
2742 the sample set is expected to never have missing values.
2743 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2744 Mean value of a range with empty fields skipped. Every field in the range
2745 that is empty is skipped. When all fields in the range are empty the mean
2746 value is not defined and the Org table result field is set to empty. Use
2747 this when the sample set can have a variable size.
2748 @item vmean($1..$7); EN
2749 To complete the example before: Mean value of a range with empty fields
2750 counting as samples with value 0. Use this only when incomplete sample sets
2751 should be padded with 0 to the full size.
2754 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2755 and use them in formula syntax for Calc.
2757 @node Formula syntax for Lisp
2758 @subsection Emacs Lisp forms as formulas
2759 @cindex Lisp forms, as table formulas
2761 It is also possible to write a formula in Emacs Lisp. This can be useful
2762 for string manipulation and control structures, if Calc's functionality is
2765 If a formula starts with a single-quote followed by an opening parenthesis,
2766 then it is evaluated as a Lisp form. The evaluation should return either a
2767 string or a number. Just as with @file{calc} formulas, you can specify modes
2768 and a printf format after a semicolon.
2770 With Emacs Lisp forms, you need to be conscious about the way field
2771 references are interpolated into the form. By default, a reference will be
2772 interpolated as a Lisp string (in double-quotes) containing the field. If
2773 you provide the @samp{N} mode switch, all referenced elements will be numbers
2774 (non-number fields will be zero) and interpolated as Lisp numbers, without
2775 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2776 literally, without quotes. I.e., if you want a reference to be interpreted
2777 as a string by the Lisp form, enclose the reference operator itself in
2778 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2779 fields, so you can embed them in list or vector syntax.
2781 Here are a few examples---note how the @samp{N} mode is used when we do
2782 computations in Lisp:
2785 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2786 Swap the first two characters of the content of column 1.
2788 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2789 @item '(apply '+ '($1..$4));N
2790 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2793 @node Durations and time values
2794 @subsection Durations and time values
2795 @cindex Duration, computing
2796 @cindex Time, computing
2797 @vindex org-table-duration-custom-format
2799 If you want to compute time values use the @code{T} flag, either in Calc
2800 formulas or Elisp formulas:
2804 | Task 1 | Task 2 | Total |
2805 |---------+----------+----------|
2806 | 2:12 | 1:47 | 03:59:00 |
2807 | 3:02:20 | -2:07:00 | 0.92 |
2808 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2812 Input duration values must be of the form @code{HH:MM[:SS]}, where seconds
2813 are optional. With the @code{T} flag, computed durations will be displayed
2814 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2815 computed durations will be displayed according to the value of the option
2816 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2817 will display the result as a fraction of hours (see the second formula in the
2820 Negative duration values can be manipulated as well, and integers will be
2821 considered as seconds in addition and subtraction.
2823 @node Field and range formulas
2824 @subsection Field and range formulas
2825 @cindex field formula
2826 @cindex range formula
2827 @cindex formula, for individual table field
2828 @cindex formula, for range of fields
2830 To assign a formula to a particular field, type it directly into the field,
2831 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2832 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2833 the formula will be stored as the formula for this field, evaluated, and the
2834 current field will be replaced with the result.
2837 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2838 below the table. If you type the equation in the 4th field of the 3rd data
2839 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2840 inserting/deleting/swapping columns and rows with the appropriate commands,
2841 @i{absolute references} (but not relative ones) in stored formulas are
2842 modified in order to still reference the same field. To avoid this, in
2843 particular in range references, anchor ranges at the table borders (using
2844 @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines using the
2845 @code{@@I} notation. Automatic adaptation of field references does of course
2846 not happen if you edit the table structure with normal editing
2847 commands---then you must fix the equations yourself.
2849 Instead of typing an equation into the field, you may also use the following
2853 @orgcmd{C-u C-c =,org-table-eval-formula}
2854 Install a new formula for the current field. The command prompts for a
2855 formula with default taken from the @samp{#+TBLFM:} line, applies
2856 it to the current field, and stores it.
2859 The left-hand side of a formula can also be a special expression in order to
2860 assign the formula to a number of different fields. There is no keyboard
2861 shortcut to enter such range formulas. To add them, use the formula editor
2862 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2867 Column formula, valid for the entire column. This is so common that Org
2868 treats these formulas in a special way, see @ref{Column formulas}.
2870 Row formula, applies to all fields in the specified row. @code{@@>=} means
2873 Range formula, applies to all fields in the given rectangular range. This
2874 can also be used to assign a formula to some but not all fields in a row.
2876 Named field, see @ref{Advanced features}.
2879 @node Column formulas
2880 @subsection Column formulas
2881 @cindex column formula
2882 @cindex formula, for table column
2884 When you assign a formula to a simple column reference like @code{$3=}, the
2885 same formula will be used in all fields of that column, with the following
2886 very convenient exceptions: (i) If the table contains horizontal separator
2887 hlines with rows above and below, everything before the first such hline is
2888 considered part of the table @emph{header} and will not be modified by column
2889 formulas. Therefore a header is mandatory when you use column formulas and
2890 want to add hlines to group rows, like for example to separate a total row at
2891 the bottom from the summand rows above. (ii) Fields that already get a value
2892 from a field/range formula will be left alone by column formulas. These
2893 conditions make column formulas very easy to use.
2895 To assign a formula to a column, type it directly into any field in the
2896 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2897 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2898 the formula will be stored as the formula for the current column, evaluated
2899 and the current field replaced with the result. If the field contains only
2900 @samp{=}, the previously stored formula for this column is used. For each
2901 column, Org will only remember the most recently used formula. In the
2902 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2903 left-hand side of a column formula cannot be the name of column, it must be
2904 the numeric column reference or @code{$>}.
2906 Instead of typing an equation into the field, you may also use the
2910 @orgcmd{C-c =,org-table-eval-formula}
2911 Install a new formula for the current column and replace current field with
2912 the result of the formula. The command prompts for a formula, with default
2913 taken from the @samp{#+TBLFM} line, applies it to the current field and
2914 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2915 will apply it to that many consecutive fields in the current column.
2918 @node Lookup functions
2919 @subsection Lookup functions
2920 @cindex lookup functions in tables
2921 @cindex table lookup functions
2923 Org has three predefined Emacs Lisp functions for lookups in tables.
2925 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2926 @findex org-lookup-first
2927 Searches for the first element @code{S} in list @code{S-LIST} for which
2931 is @code{t}; returns the value from the corresponding position in list
2932 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2933 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2934 order as the corresponding parameters are in the call to
2935 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2936 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2938 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2939 @findex org-lookup-last
2940 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2941 element for which @code{PREDICATE} is @code{t}.
2942 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2943 @findex org-lookup-all
2944 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2945 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2946 values. This function can not be used by itself in a formula, because it
2947 returns a list of values. However, powerful lookups can be built when this
2948 function is combined with other Emacs Lisp functions.
2951 If the ranges used in these functions contain empty fields, the @code{E} mode
2952 for the formula should usually be specified: otherwise empty fields will not be
2953 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2954 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2955 element of @code{R-LIST}.
2957 These three functions can be used to implement associative arrays, count
2958 matching cells, rank results, group data etc. For practical examples
2959 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2962 @node Editing and debugging formulas
2963 @subsection Editing and debugging formulas
2964 @cindex formula editing
2965 @cindex editing, of table formulas
2967 @vindex org-table-use-standard-references
2968 You can edit individual formulas in the minibuffer or directly in the field.
2969 Org can also prepare a special buffer with all active formulas of a table.
2970 When offering a formula for editing, Org converts references to the standard
2971 format (like @code{B3} or @code{D&}) if possible. If you prefer to only work
2972 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2973 option @code{org-table-use-standard-references}.
2976 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2977 Edit the formula associated with the current column/field in the
2978 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2979 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2980 Re-insert the active formula (either a
2981 field formula, or a column formula) into the current field, so that you
2982 can edit it directly in the field. The advantage over editing in the
2983 minibuffer is that you can use the command @kbd{C-c ?}.
2984 @orgcmd{C-c ?,org-table-field-info}
2985 While editing a formula in a table field, highlight the field(s)
2986 referenced by the reference at the cursor position in the formula.
2988 @findex org-table-toggle-coordinate-overlays
2990 Toggle the display of row and column numbers for a table, using overlays
2991 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2992 time the table is aligned; you can force it with @kbd{C-c C-c}.
2994 @findex org-table-toggle-formula-debugger
2996 Toggle the formula debugger on and off
2997 (@command{org-table-toggle-formula-debugger}). See below.
2998 @orgcmd{C-c ',org-table-edit-formulas}
2999 Edit all formulas for the current table in a special buffer, where the
3000 formulas will be displayed one per line. If the current field has an
3001 active formula, the cursor in the formula editor will mark it.
3002 While inside the special buffer, Org will automatically highlight
3003 any field or range reference at the cursor position. You may edit,
3004 remove and add formulas, and use the following commands:
3007 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
3008 Exit the formula editor and store the modified formulas. With @kbd{C-u}
3009 prefix, also apply the new formulas to the entire table.
3010 @orgcmd{C-c C-q,org-table-fedit-abort}
3011 Exit the formula editor without installing changes.
3012 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3013 Toggle all references in the formula editor between standard (like
3014 @code{B3}) and internal (like @code{@@3$2}).
3015 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3016 Pretty-print or indent Lisp formula at point. When in a line containing
3017 a Lisp formula, format the formula according to Emacs Lisp rules.
3018 Another @key{TAB} collapses the formula back again. In the open
3019 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3020 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3021 Complete Lisp symbols, just like in Emacs Lisp mode.
3023 @kindex S-@key{down}
3024 @kindex S-@key{left}
3025 @kindex S-@key{right}
3026 @findex org-table-fedit-ref-up
3027 @findex org-table-fedit-ref-down
3028 @findex org-table-fedit-ref-left
3029 @findex org-table-fedit-ref-right
3030 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3031 Shift the reference at point. For example, if the reference is
3032 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3033 This also works for relative references and for hline references.
3034 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3035 Move the test line for column formulas in the Org buffer up and
3037 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3038 Scroll the window displaying the table.
3040 @findex org-table-toggle-coordinate-overlays
3042 Turn the coordinate grid in the table on and off.
3046 Making a table field blank does not remove the formula associated with
3047 the field, because that is stored in a different line (the @samp{#+TBLFM}
3048 line)---during the next recalculation the field will be filled again.
3049 To remove a formula from a field, you have to give an empty reply when
3050 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3053 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3054 equations with @kbd{C-c C-c} in that line or with the normal
3055 recalculation commands in the table.
3057 @anchor{Using multiple #+TBLFM lines}
3058 @subsubheading Using multiple #+TBLFM lines
3059 @cindex #+TBLFM line, multiple
3061 @cindex #+TBLFM, switching
3064 You may apply the formula temporarily. This is useful when you
3065 switch the formula. Place multiple @samp{#+TBLFM} lines right
3066 after the table, and then press @kbd{C-c C-c} on the formula to
3067 apply. Here is an example:
3079 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3091 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3092 will get the following result of applying only the first @samp{#+TBLFM} line.
3103 @subsubheading Debugging formulas
3104 @cindex formula debugging
3105 @cindex debugging, of table formulas
3106 When the evaluation of a formula leads to an error, the field content
3107 becomes the string @samp{#ERROR}. If you would like see what is going
3108 on during variable substitution and calculation in order to find a bug,
3109 turn on formula debugging in the @code{Tbl} menu and repeat the
3110 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3111 field. Detailed information will be displayed.
3113 @node Updating the table
3114 @subsection Updating the table
3115 @cindex recomputing table fields
3116 @cindex updating, table
3118 Recalculation of a table is normally not automatic, but needs to be
3119 triggered by a command. See @ref{Advanced features}, for a way to make
3120 recalculation at least semi-automatic.
3122 In order to recalculate a line of a table or the entire table, use the
3126 @orgcmd{C-c *,org-table-recalculate}
3127 Recalculate the current row by first applying the stored column formulas
3128 from left to right, and all field/range formulas in the current row.
3134 Recompute the entire table, line by line. Any lines before the first
3135 hline are left alone, assuming that these are part of the table header.
3137 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3138 Iterate the table by recomputing it until no further changes occur.
3139 This may be necessary if some computed fields use the value of other
3140 fields that are computed @i{later} in the calculation sequence.
3141 @item M-x org-table-recalculate-buffer-tables RET
3142 @findex org-table-recalculate-buffer-tables
3143 Recompute all tables in the current buffer.
3144 @item M-x org-table-iterate-buffer-tables RET
3145 @findex org-table-iterate-buffer-tables
3146 Iterate all tables in the current buffer, in order to converge table-to-table
3150 @node Advanced features
3151 @subsection Advanced features
3153 If you want the recalculation of fields to happen automatically, or if you
3154 want to be able to assign @i{names}@footnote{Such names must start by an
3155 alphabetic character and use only alphanumeric/underscore characters.} to
3156 fields and columns, you need to reserve the first column of the table for
3157 special marking characters.
3160 @orgcmd{C-#,org-table-rotate-recalc-marks}
3161 Rotate the calculation mark in first column through the states @samp{ },
3162 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
3163 change all marks in the region.
3166 Here is an example of a table that collects exam results of students and
3167 makes use of these features:
3171 |---+---------+--------+--------+--------+-------+------|
3172 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3173 |---+---------+--------+--------+--------+-------+------|
3174 | ! | | P1 | P2 | P3 | Tot | |
3175 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
3176 | ^ | | m1 | m2 | m3 | mt | |
3177 |---+---------+--------+--------+--------+-------+------|
3178 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3179 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3180 |---+---------+--------+--------+--------+-------+------|
3181 | | Average | | | | 25.0 | |
3182 | ^ | | | | | at | |
3183 | $ | max=50 | | | | | |
3184 |---+---------+--------+--------+--------+-------+------|
3185 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3189 @noindent @b{Important}: please note that for these special tables,
3190 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3191 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3192 to the field itself. The column formulas are not applied in rows with
3195 @cindex marking characters, tables
3196 The marking characters have the following meaning:
3200 The fields in this line define names for the columns, so that you may
3201 refer to a column as @samp{$Tot} instead of @samp{$6}.
3203 This row defines names for the fields @emph{above} the row. With such
3204 a definition, any formula in the table may use @samp{$m1} to refer to
3205 the value @samp{10}. Also, if you assign a formula to a names field, it
3206 will be stored as @samp{$name=...}.
3208 Similar to @samp{^}, but defines names for the fields in the row
3211 Fields in this row can define @emph{parameters} for formulas. For
3212 example, if a field in a @samp{$} row contains @samp{max=50}, then
3213 formulas in this table can refer to the value 50 using @samp{$max}.
3214 Parameters work exactly like constants, only that they can be defined on
3217 Fields in this row are automatically recalculated when pressing
3218 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3219 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3220 lines will be left alone by this command.
3222 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3223 not for automatic recalculation. Use this when automatic
3224 recalculation slows down editing too much.
3226 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3227 All lines that should be recalculated should be marked with @samp{#}
3230 Do not export this line. Useful for lines that contain the narrowing
3231 @samp{<N>} markers or column group markers.
3234 Finally, just to whet your appetite for what can be done with the
3235 fantastic @file{calc.el} package, here is a table that computes the Taylor
3236 series of degree @code{n} at location @code{x} for a couple of
3241 |---+-------------+---+-----+--------------------------------------|
3242 | | Func | n | x | Result |
3243 |---+-------------+---+-----+--------------------------------------|
3244 | # | exp(x) | 1 | x | 1 + x |
3245 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3246 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3247 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3248 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3249 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3250 |---+-------------+---+-----+--------------------------------------|
3251 #+TBLFM: $5=taylor($2,$4,$3);n3
3257 @cindex graph, in tables
3258 @cindex plot tables using Gnuplot
3261 Org-Plot can produce graphs of information stored in org tables, either
3262 graphically or in ASCII-art.
3264 @subheading Graphical plots using @file{Gnuplot}
3266 Org-Plot produces 2D and 3D graphs using @file{Gnuplot}
3267 @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3268 @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
3269 that you have both Gnuplot and Gnuplot mode installed on your system, then
3270 call @kbd{C-c " g} or @kbd{M-x org-plot/gnuplot @key{RET}} on the following
3275 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3276 | Sede | Max cites | H-index |
3277 |-----------+-----------+---------|
3278 | Chile | 257.72 | 21.39 |
3279 | Leeds | 165.77 | 19.68 |
3280 | Sao Paolo | 71.00 | 11.50 |
3281 | Stockholm | 134.19 | 14.33 |
3282 | Morelia | 257.56 | 17.67 |
3286 Notice that Org Plot is smart enough to apply the table's headers as labels.
3287 Further control over the labels, type, content, and appearance of plots can
3288 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3289 for a complete list of Org-plot options. The @code{#+PLOT:} lines are
3290 optional. For more information and examples see the Org-plot tutorial at
3291 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3293 @subsubheading Plot Options
3297 Specify any @command{gnuplot} option to be set when graphing.
3300 Specify the title of the plot.
3303 Specify which column of the table to use as the @code{x} axis.
3306 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3307 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3308 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3312 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3315 Specify a @code{with} option to be inserted for every col being plotted
3316 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3317 Defaults to @code{lines}.
3320 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3323 List of labels to be used for the @code{deps} (defaults to the column headers
3327 Specify an entire line to be inserted in the Gnuplot script.
3330 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3331 flat mapping rather than a @code{3d} slope.
3334 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3335 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3338 If you want total control, you can specify a script file (place the file name
3339 between double-quotes) which will be used to plot. Before plotting, every
3340 instance of @code{$datafile} in the specified script will be replaced with
3341 the path to the generated data file. Note: even if you set this option, you
3342 may still want to specify the plot type, as that can impact the content of
3346 @subheading ASCII bar plots
3348 While the cursor is on a column, typing @kbd{C-c " a} or
3349 @kbd{M-x orgtbl-ascii-plot @key{RET}} create a new column containing an
3350 ASCII-art bars plot. The plot is implemented through a regular column
3351 formula. When the source column changes, the bar plot may be updated by
3352 refreshing the table, for example typing @kbd{C-u C-c *}.
3356 | Sede | Max cites | |
3357 |---------------+-----------+--------------|
3358 | Chile | 257.72 | WWWWWWWWWWWW |
3359 | Leeds | 165.77 | WWWWWWWh |
3360 | Sao Paolo | 71.00 | WWW; |
3361 | Stockholm | 134.19 | WWWWWW: |
3362 | Morelia | 257.56 | WWWWWWWWWWWH |
3363 | Rochefourchat | 0.00 | |
3364 #+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)
3368 The formula is an elisp call:
3370 (orgtbl-ascii-draw COLUMN MIN MAX WIDTH)
3375 is a reference to the source column.
3378 are the minimal and maximal values displayed. Sources values
3379 outside this range are displayed as @samp{too small}
3380 or @samp{too large}.
3383 is the width in characters of the bar-plot. It defaults to @samp{12}.
3391 Like HTML, Org provides links inside a file, external links to
3392 other files, Usenet articles, emails, and much more.
3395 * Link format:: How links in Org are formatted
3396 * Internal links:: Links to other places in the current file
3397 * External links:: URL-like links to the world
3398 * Handling links:: Creating, inserting and following
3399 * Using links outside Org:: Linking from my C source code?
3400 * Link abbreviations:: Shortcuts for writing complex links
3401 * Search options:: Linking to a specific location
3402 * Custom searches:: When the default search is not enough
3406 @section Link format
3408 @cindex format, of links
3410 Org will recognize plain URL-like links and activate them as
3411 clickable links. The general link format, however, looks like this:
3414 [[link][description]] @r{or alternatively} [[link]]
3418 Once a link in the buffer is complete (all brackets present), Org
3419 will change the display so that @samp{description} is displayed instead
3420 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3421 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3422 which by default is an underlined face. You can directly edit the
3423 visible part of a link. Note that this can be either the @samp{link}
3424 part (if there is no description) or the @samp{description} part. To
3425 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3428 If you place the cursor at the beginning or just behind the end of the
3429 displayed text and press @key{BACKSPACE}, you will remove the
3430 (invisible) bracket at that location. This makes the link incomplete
3431 and the internals are again displayed as plain text. Inserting the
3432 missing bracket hides the link internals again. To show the
3433 internal structure of all links, use the menu entry
3434 @code{Org->Hyperlinks->Literal links}.
3436 @node Internal links
3437 @section Internal links
3438 @cindex internal links
3439 @cindex links, internal
3440 @cindex targets, for links
3442 @cindex property, CUSTOM_ID
3443 If the link does not look like a URL, it is considered to be internal in the
3444 current file. The most important case is a link like
3445 @samp{[[#my-custom-id]]} which will link to the entry with the
3446 @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
3447 to make sure these custom IDs are unique in a file.
3449 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3450 lead to a text search in the current file.
3452 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3453 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3454 point to the corresponding headline. The preferred match for a text link is
3455 a @i{dedicated target}: the same string in double angular brackets, like
3456 @samp{<<My Target>>}.
3459 If no dedicated target exists, the link will then try to match the exact name
3460 of an element within the buffer. Naming is done with the @code{#+NAME}
3461 keyword, which has to be put in the line before the element it refers to, as
3462 in the following example
3471 If none of the above succeeds, Org will search for a headline that is exactly
3472 the link text but may also include a TODO keyword and tags@footnote{To insert
3473 a link targeting a headline, in-buffer completion can be used. Just type
3474 a star followed by a few optional letters into the buffer and press
3475 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3478 During export, internal links will be used to mark objects and assign them
3479 a number. Marked objects will then be referenced by links pointing to them.
3480 In particular, links without a description will appear as the number assigned
3481 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3482 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3483 (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
3487 - <<target>>another item
3488 Here we refer to item [[target]].
3492 The last sentence will appear as @samp{Here we refer to item 2} when
3495 In non-Org files, the search will look for the words in the link text. In
3496 the above example the search would be for @samp{my target}.
3498 Following a link pushes a mark onto Org's own mark ring. You can
3499 return to the previous position with @kbd{C-c &}. Using this command
3500 several times in direct succession goes back to positions recorded
3504 * Radio targets:: Make targets trigger links in plain text
3508 @subsection Radio targets
3509 @cindex radio targets
3510 @cindex targets, radio
3511 @cindex links, radio targets
3513 Org can automatically turn any occurrences of certain target names
3514 in normal text into a link. So without explicitly creating a link, the
3515 text connects to the target radioing its position. Radio targets are
3516 enclosed by triple angular brackets. For example, a target @samp{<<<My
3517 Target>>>} causes each occurrence of @samp{my target} in normal text to
3518 become activated as a link. The Org file is scanned automatically
3519 for radio targets only when the file is first loaded into Emacs. To
3520 update the target list during editing, press @kbd{C-c C-c} with the
3521 cursor on or at a target.
3523 @node External links
3524 @section External links
3525 @cindex links, external
3526 @cindex external links
3534 @cindex USENET links
3539 Org supports links to files, websites, Usenet and email messages, BBDB
3540 database entries and links to both IRC conversations and their logs.
3541 External links are URL-like locators. They start with a short identifying
3542 string followed by a colon. There can be no space after the colon. The
3543 following list shows examples for each link type.
3546 http://www.astro.uva.nl/~dominik @r{on the web}
3547 doi:10.1000/182 @r{DOI for an electronic resource}
3548 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3549 /home/dominik/images/jupiter.jpg @r{same as above}
3550 file:papers/last.pdf @r{file, relative path}
3551 ./papers/last.pdf @r{same as above}
3552 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3553 /myself@@some.where:papers/last.pdf @r{same as above}
3554 file:sometextfile::NNN @r{file, jump to line number}
3555 file:projects.org @r{another Org file}
3556 file:projects.org::some words @r{text search in Org file}@footnote{
3557 The actual behavior of the search will depend on the value of
3558 the option @code{org-link-search-must-match-exact-headline}. If its value
3559 is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
3560 exact headline will be matched. If the value is @code{'query-to-create},
3561 then an exact headline will be searched; if it is not found, then the user
3562 will be queried to create it.}
3563 file:projects.org::*task title @r{heading search in Org file}
3564 file+sys:/path/to/file @r{open via OS, like double-click}
3565 file+emacs:/path/to/file @r{force opening by Emacs}
3566 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3567 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3568 news:comp.emacs @r{Usenet link}
3569 mailto:adent@@galaxy.net @r{Mail link}
3570 mhe:folder @r{MH-E folder link}
3571 mhe:folder#id @r{MH-E message link}
3572 rmail:folder @r{RMAIL folder link}
3573 rmail:folder#id @r{RMAIL message link}
3574 gnus:group @r{Gnus group link}
3575 gnus:group#id @r{Gnus article link}
3576 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3577 irc:/irc.com/#emacs/bob @r{IRC link}
3578 info:org#External links @r{Info node link}
3579 shell:ls *.org @r{A shell command}
3580 elisp:org-agenda @r{Interactive Elisp command}
3581 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3585 @cindex WANDERLUST links
3586 On top of these built-in link types, some are available through the
3587 @code{contrib/} directory (@pxref{Installation}). For example, these links
3588 to VM or Wanderlust messages are available when you load the corresponding
3589 libraries from the @code{contrib/} directory:
3592 vm:folder @r{VM folder link}
3593 vm:folder#id @r{VM message link}
3594 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3595 vm-imap:account:folder @r{VM IMAP folder link}
3596 vm-imap:account:folder#id @r{VM IMAP message link}
3597 wl:folder @r{WANDERLUST folder link}
3598 wl:folder#id @r{WANDERLUST message link}
3601 For customizing Org to add new link types @ref{Adding hyperlink types}.
3603 A link should be enclosed in double brackets and may contain a descriptive
3604 text to be displayed instead of the URL (@pxref{Link format}), for example:
3607 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3611 If the description is a file name or URL that points to an image, HTML
3612 export (@pxref{HTML export}) will inline the image as a clickable
3613 button. If there is no description at all and the link points to an
3615 that image will be inlined into the exported HTML file.
3617 @cindex square brackets, around links
3618 @cindex plain text external links
3619 Org also finds external links in the normal text and activates them
3620 as links. If spaces must be part of the link (for example in
3621 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3622 about the end of the link, enclose them in square brackets.
3624 @node Handling links
3625 @section Handling links
3626 @cindex links, handling
3628 Org provides methods to create a link in the correct syntax, to
3629 insert it into an Org file, and to follow the link.
3632 @orgcmd{C-c l,org-store-link}
3633 @cindex storing links
3634 Store a link to the current location. This is a @emph{global} command (you
3635 must create the key binding yourself) which can be used in any buffer to
3636 create a link. The link will be stored for later insertion into an Org
3637 buffer (see below). What kind of link will be created depends on the current
3640 @b{Org mode buffers}@*
3641 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3642 to the target. Otherwise it points to the current headline, which will also
3643 be the description@footnote{If the headline contains a timestamp, it will be
3644 removed from the link and result in a wrong link---you should avoid putting
3645 timestamp in the headline.}.
3647 @vindex org-id-link-to-org-use-id
3648 @cindex property, CUSTOM_ID
3649 @cindex property, ID
3650 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3651 will be stored. In addition or alternatively (depending on the value of
3652 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3653 be created and/or used to construct a link@footnote{The library
3654 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3655 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3656 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3657 potentially create two links: a human-readable from the custom ID, and one
3658 that is globally unique and works even if the entry is moved from file to
3659 file. Later, when inserting the link, you need to decide which one to use.
3661 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3662 Pretty much all Emacs mail clients are supported. The link will point to the
3663 current article, or, in some GNUS buffers, to the group. The description is
3664 constructed from the author and the subject.
3666 @b{Web browsers: W3 and W3M}@*
3667 Here the link will be the current URL, with the page title as description.
3669 @b{Contacts: BBDB}@*
3670 Links created in a BBDB buffer will point to the current entry.
3673 @vindex org-irc-link-to-logs
3674 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3675 a @samp{file:/} style link to the relevant point in the logs for the current
3676 conversation is created. Otherwise an @samp{irc:/} style link to the
3677 user/channel/server under the point will be stored.
3680 For any other files, the link will point to the file, with a search string
3681 (@pxref{Search options}) pointing to the contents of the current line. If
3682 there is an active region, the selected words will form the basis of the
3683 search string. If the automatically created link is not working correctly or
3684 accurately enough, you can write custom functions to select the search string
3685 and to do the search for particular file types---see @ref{Custom searches}.
3686 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3689 When the cursor is in an agenda view, the created link points to the
3690 entry referenced by the current line.
3693 @orgcmd{C-c C-l,org-insert-link}
3694 @cindex link completion
3695 @cindex completion, of links
3696 @cindex inserting links
3697 @vindex org-keep-stored-link-after-insertion
3698 Insert a link@footnote{Note that you don't have to use this command to
3699 insert a link. Links in Org are plain text, and you can type or paste them
3700 straight into the buffer. By using this command, the links are automatically
3701 enclosed in double brackets, and you will be asked for the optional
3702 descriptive text.}. This prompts for a link to be inserted into the buffer.
3703 You can just type a link, using text for an internal link, or one of the link
3704 type prefixes mentioned in the examples above. The link will be inserted
3705 into the buffer@footnote{After insertion of a stored link, the link will be
3706 removed from the list of stored links. To keep it in the list later use, use
3707 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3708 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3709 If some text was selected when this command is called, the selected text
3710 becomes the default description.
3712 @b{Inserting stored links}@*
3713 All links stored during the
3714 current session are part of the history for this prompt, so you can access
3715 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3717 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3718 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3719 defined through link abbreviations (@pxref{Link abbreviations}). If you
3720 press @key{RET} after inserting only the @var{prefix}, Org will offer
3721 specific completion support for some link types@footnote{This works by
3722 calling a special function @code{org-PREFIX-complete-link}.} For
3723 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3724 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3725 @key{RET}} you can complete contact names.
3727 @cindex file name completion
3728 @cindex completion, of file names
3729 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3730 a file will be inserted and you may use file name completion to select
3731 the name of the file. The path to the file is inserted relative to the
3732 directory of the current Org file, if the linked file is in the current
3733 directory or in a sub-directory of it, or if the path is written relative
3734 to the current directory using @samp{../}. Otherwise an absolute path
3735 is used, if possible with @samp{~/} for your home directory. You can
3736 force an absolute path with two @kbd{C-u} prefixes.
3738 @item C-c C-l @ @r{(with cursor on existing link)}
3739 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3740 link and description parts of the link.
3742 @cindex following links
3743 @orgcmd{C-c C-o,org-open-at-point}
3744 @vindex org-file-apps
3745 @vindex org-link-frame-setup
3746 Open link at point. This will launch a web browser for URLs (using
3747 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3748 the corresponding links, and execute the command in a shell link. When the
3749 cursor is on an internal link, this command runs the corresponding search.
3750 When the cursor is on a TAG list in a headline, it creates the corresponding
3751 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3752 date. Furthermore, it will visit text and remote files in @samp{file:} links
3753 with Emacs and select a suitable application for local non-text files.
3754 Classification of files is based on file extension only. See option
3755 @code{org-file-apps}. If you want to override the default application and
3756 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3757 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3758 If the cursor is on a headline, but not on a link, offer all links in the
3759 headline and entry text. If you want to setup the frame configuration for
3760 following links, customize @code{org-link-frame-setup}.
3763 @vindex org-return-follows-link
3764 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3771 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3772 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3776 @vindex org-display-internal-link-with-indirect-buffer
3777 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3778 internal links to be displayed in another window@footnote{See the
3779 option @code{org-display-internal-link-with-indirect-buffer}}.
3781 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3782 @cindex inlining images
3783 @cindex images, inlining
3784 @vindex org-startup-with-inline-images
3785 @cindex @code{inlineimages}, STARTUP keyword
3786 @cindex @code{noinlineimages}, STARTUP keyword
3787 Toggle the inline display of linked images. Normally this will only inline
3788 images that have no description part in the link, i.e., images that will also
3789 be inlined during export. When called with a prefix argument, also display
3790 images that do have a link description. You can ask for inline images to be
3791 displayed at startup by configuring the variable
3792 @code{org-startup-with-inline-images}@footnote{with corresponding
3793 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3794 @orgcmd{C-c %,org-mark-ring-push}
3796 Push the current position onto the mark ring, to be able to return
3797 easily. Commands following an internal link do this automatically.
3799 @orgcmd{C-c &,org-mark-ring-goto}
3800 @cindex links, returning to
3801 Jump back to a recorded position. A position is recorded by the
3802 commands following internal links, and by @kbd{C-c %}. Using this
3803 command several times in direct succession moves through a ring of
3804 previously recorded positions.
3806 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3807 @cindex links, finding next/previous
3808 Move forward/backward to the next link in the buffer. At the limit of
3809 the buffer, the search fails once, and then wraps around. The key
3810 bindings for this are really too long; you might want to bind this also
3811 to @kbd{C-n} and @kbd{C-p}
3813 (add-hook 'org-load-hook
3815 (define-key org-mode-map "\C-n" 'org-next-link)
3816 (define-key org-mode-map "\C-p" 'org-previous-link)))
3820 @node Using links outside Org
3821 @section Using links outside Org
3823 You can insert and follow links that have Org syntax not only in
3824 Org, but in any Emacs buffer. For this, you should create two
3825 global commands, like this (please select suitable global keys
3829 (global-set-key "\C-c L" 'org-insert-link-global)
3830 (global-set-key "\C-c o" 'org-open-at-point-global)
3833 @node Link abbreviations
3834 @section Link abbreviations
3835 @cindex link abbreviations
3836 @cindex abbreviation, links
3838 Long URLs can be cumbersome to type, and often many similar links are
3839 needed in a document. For this you can use link abbreviations. An
3840 abbreviated link looks like this
3843 [[linkword:tag][description]]
3847 @vindex org-link-abbrev-alist
3848 where the tag is optional.
3849 The @i{linkword} must be a word, starting with a letter, followed by
3850 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3851 according to the information in the variable @code{org-link-abbrev-alist}
3852 that relates the linkwords to replacement text. Here is an example:
3856 (setq org-link-abbrev-alist
3857 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3858 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3859 ("google" . "http://www.google.com/search?q=")
3860 ("gmap" . "http://maps.google.com/maps?q=%s")
3861 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3862 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3866 If the replacement text contains the string @samp{%s}, it will be
3867 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3868 url-encode the tag (see the example above, where we need to encode
3869 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3870 to a custom function, and replace it by the resulting string.
3872 If the replacement text doesn't contain any specifier, it will simply
3873 be appended to the string in order to create the link.
3875 Instead of a string, you may also specify a function that will be
3876 called with the tag as the only argument to create the link.
3878 With the above setting, you could link to a specific bug with
3879 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3880 @code{[[google:OrgMode]]}, show the map location of the Free Software
3881 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3882 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3883 what the Org author is doing besides Emacs hacking with
3884 @code{[[ads:Dominik,C]]}.
3886 If you need special abbreviations just for a single Org buffer, you
3887 can define them in the file with
3891 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3892 #+LINK: google http://www.google.com/search?q=%s
3896 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3897 complete link abbreviations. You may also define a function
3898 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3899 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3900 not accept any arguments, and return the full link with prefix.
3902 @node Search options
3903 @section Search options in file links
3904 @cindex search option in file links
3905 @cindex file links, searching
3907 File links can contain additional information to make Emacs jump to a
3908 particular location in the file when following a link. This can be a
3909 line number or a search option after a double@footnote{For backward
3910 compatibility, line numbers can also follow a single colon.} colon. For
3911 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3912 links}) to a file, it encodes the words in the current line as a search
3913 string that can be used to find this line back later when following the
3914 link with @kbd{C-c C-o}.
3916 Here is the syntax of the different ways to attach a search to a file
3917 link, together with an explanation:
3920 [[file:~/code/main.c::255]]
3921 [[file:~/xx.org::My Target]]
3922 [[file:~/xx.org::*My Target]]
3923 [[file:~/xx.org::#my-custom-id]]
3924 [[file:~/xx.org::/regexp/]]
3931 Search for a link target @samp{<<My Target>>}, or do a text search for
3932 @samp{my target}, similar to the search in internal links, see
3933 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3934 link will become an HTML reference to the corresponding named anchor in
3937 In an Org file, restrict search to headlines.
3939 Link to a heading with a @code{CUSTOM_ID} property
3941 Do a regular expression search for @code{regexp}. This uses the Emacs
3942 command @code{occur} to list all matches in a separate window. If the
3943 target file is in Org mode, @code{org-occur} is used to create a
3944 sparse tree with the matches.
3945 @c If the target file is a directory,
3946 @c @code{grep} will be used to search all files in the directory.
3949 As a degenerate case, a file link with an empty file name can be used
3950 to search the current file. For example, @code{[[file:::find me]]} does
3951 a search for @samp{find me} in the current file, just as
3952 @samp{[[find me]]} would.
3954 @node Custom searches
3955 @section Custom Searches
3956 @cindex custom search strings
3957 @cindex search strings, custom
3959 The default mechanism for creating search strings and for doing the
3960 actual search related to a file link may not work correctly in all
3961 cases. For example, Bib@TeX{} database files have many entries like
3962 @samp{year="1993"} which would not result in good search strings,
3963 because the only unique identification for a Bib@TeX{} entry is the
3966 @vindex org-create-file-search-functions
3967 @vindex org-execute-file-search-functions
3968 If you come across such a problem, you can write custom functions to set
3969 the right search string for a particular file type, and to do the search
3970 for the string in the file. Using @code{add-hook}, these functions need
3971 to be added to the hook variables
3972 @code{org-create-file-search-functions} and
3973 @code{org-execute-file-search-functions}. See the docstring for these
3974 variables for more information. Org actually uses this mechanism
3975 for Bib@TeX{} database files, and you can use the corresponding code as
3976 an implementation example. See the file @file{org-bibtex.el}.
3982 Org mode does not maintain TODO lists as separate documents@footnote{Of
3983 course, you can make a document that contains only long lists of TODO items,
3984 but this is not required.}. Instead, TODO items are an integral part of the
3985 notes file, because TODO items usually come up while taking notes! With Org
3986 mode, simply mark any entry in a tree as being a TODO item. In this way,
3987 information is not duplicated, and the entire context from which the TODO
3988 item emerged is always present.
3990 Of course, this technique for managing TODO items scatters them
3991 throughout your notes file. Org mode compensates for this by providing
3992 methods to give you an overview of all the things that you have to do.
3995 * TODO basics:: Marking and displaying TODO entries
3996 * TODO extensions:: Workflow and assignments
3997 * Progress logging:: Dates and notes for progress
3998 * Priorities:: Some things are more important than others
3999 * Breaking down tasks:: Splitting a task into manageable pieces
4000 * Checkboxes:: Tick-off lists
4004 @section Basic TODO functionality
4006 Any headline becomes a TODO item when it starts with the word
4007 @samp{TODO}, for example:
4010 *** TODO Write letter to Sam Fortune
4014 The most important commands to work with TODO entries are:
4017 @orgcmd{C-c C-t,org-todo}
4018 @cindex cycling, of TODO states
4019 @vindex org-use-fast-todo-selection
4021 Rotate the TODO state of the current item among
4024 ,-> (unmarked) -> TODO -> DONE --.
4025 '--------------------------------'
4028 If TODO keywords have fast access keys (see @ref{Fast access to TODO
4029 states}), you will be prompted for a TODO keyword through the fast selection
4030 interface; this is the default behavior when
4031 @code{org-use-fast-todo-selection} is non-@code{nil}.
4033 The same rotation can also be done ``remotely'' from the timeline and agenda
4034 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
4036 @orgkey{C-u C-c C-t}
4037 When TODO keywords have no selection keys, select a specific keyword using
4038 completion; otherwise force cycling through TODO states with no prompt. When
4039 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
4040 selection interface.
4042 @kindex S-@key{right}
4043 @kindex S-@key{left}
4044 @item S-@key{right} @ @r{/} @ S-@key{left}
4045 @vindex org-treat-S-cursor-todo-selection-as-state-change
4046 Select the following/preceding TODO state, similar to cycling. Useful
4047 mostly if more than two TODO states are possible (@pxref{TODO
4048 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
4049 with @code{shift-selection-mode}. See also the variable
4050 @code{org-treat-S-cursor-todo-selection-as-state-change}.
4051 @orgcmd{C-c / t,org-show-todo-tree}
4052 @cindex sparse tree, for TODO
4053 @vindex org-todo-keywords
4054 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
4055 entire buffer, but shows all TODO items (with not-DONE state) and the
4056 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
4057 / T}), search for a specific TODO@. You will be prompted for the keyword,
4058 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
4059 entries that match any one of these keywords. With a numeric prefix argument
4060 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
4061 With two prefix arguments, find all TODO states, both un-done and done.
4062 @orgcmd{C-c a t,org-todo-list}
4063 Show the global TODO list. Collects the TODO items (with not-DONE states)
4064 from all agenda files (@pxref{Agenda views}) into a single buffer. The new
4065 buffer will be in @code{agenda-mode}, which provides commands to examine and
4066 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4067 @xref{Global TODO list}, for more information.
4068 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4069 Insert a new TODO entry below the current one.
4073 @vindex org-todo-state-tags-triggers
4074 Changing a TODO state can also trigger tag changes. See the docstring of the
4075 option @code{org-todo-state-tags-triggers} for details.
4077 @node TODO extensions
4078 @section Extended use of TODO keywords
4079 @cindex extended TODO keywords
4081 @vindex org-todo-keywords
4082 By default, marked TODO entries have one of only two states: TODO and
4083 DONE@. Org mode allows you to classify TODO items in more complex ways
4084 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
4085 special setup, the TODO keyword system can work differently in different
4088 Note that @i{tags} are another way to classify headlines in general and
4089 TODO items in particular (@pxref{Tags}).
4092 * Workflow states:: From TODO to DONE in steps
4093 * TODO types:: I do this, Fred does the rest
4094 * Multiple sets in one file:: Mixing it all, and still finding your way
4095 * Fast access to TODO states:: Single letter selection of a state
4096 * Per-file keywords:: Different files, different requirements
4097 * Faces for TODO keywords:: Highlighting states
4098 * TODO dependencies:: When one task needs to wait for others
4101 @node Workflow states
4102 @subsection TODO keywords as workflow states
4103 @cindex TODO workflow
4104 @cindex workflow states as TODO keywords
4106 You can use TODO keywords to indicate different @emph{sequential} states
4107 in the process of working on an item, for example@footnote{Changing
4108 this variable only becomes effective after restarting Org mode in a
4112 (setq org-todo-keywords
4113 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4116 The vertical bar separates the TODO keywords (states that @emph{need
4117 action}) from the DONE states (which need @emph{no further action}). If
4118 you don't provide the separator bar, the last state is used as the DONE
4120 @cindex completion, of TODO keywords
4121 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4122 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
4123 also use a numeric prefix argument to quickly select a specific state. For
4124 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4125 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
4126 define many keywords, you can use in-buffer completion
4127 (@pxref{Completion}) or even a special one-key selection scheme
4128 (@pxref{Fast access to TODO states}) to insert these words into the
4129 buffer. Changing a TODO state can be logged with a timestamp, see
4130 @ref{Tracking TODO state changes}, for more information.
4133 @subsection TODO keywords as types
4135 @cindex names as TODO keywords
4136 @cindex types as TODO keywords
4138 The second possibility is to use TODO keywords to indicate different
4139 @emph{types} of action items. For example, you might want to indicate
4140 that items are for ``work'' or ``home''. Or, when you work with several
4141 people on a single project, you might want to assign action items
4142 directly to persons, by using their names as TODO keywords. This would
4143 be set up like this:
4146 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4149 In this case, different keywords do not indicate a sequence, but rather
4150 different types. So the normal work flow would be to assign a task to a
4151 person, and later to mark it DONE@. Org mode supports this style by adapting
4152 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4153 @kbd{t} command in the timeline and agenda buffers.}. When used several
4154 times in succession, it will still cycle through all names, in order to first
4155 select the right type for a task. But when you return to the item after some
4156 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4157 to DONE@. Use prefix arguments or completion to quickly select a specific
4158 name. You can also review the items of a specific TODO type in a sparse tree
4159 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
4160 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
4161 from all agenda files into a single buffer, you would use the numeric prefix
4162 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4164 @node Multiple sets in one file
4165 @subsection Multiple keyword sets in one file
4166 @cindex TODO keyword sets
4168 Sometimes you may want to use different sets of TODO keywords in
4169 parallel. For example, you may want to have the basic
4170 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4171 separate state indicating that an item has been canceled (so it is not
4172 DONE, but also does not require action). Your setup would then look
4176 (setq org-todo-keywords
4177 '((sequence "TODO" "|" "DONE")
4178 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4179 (sequence "|" "CANCELED")))
4182 The keywords should all be different, this helps Org mode to keep track
4183 of which subsequence should be used for a given entry. In this setup,
4184 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4185 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4186 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
4187 select the correct sequence. Besides the obvious ways like typing a
4188 keyword or using completion, you may also apply the following commands:
4191 @kindex C-S-@key{right}
4192 @kindex C-S-@key{left}
4193 @kindex C-u C-u C-c C-t
4194 @item C-u C-u C-c C-t
4195 @itemx C-S-@key{right}
4196 @itemx C-S-@key{left}
4197 These keys jump from one TODO subset to the next. In the above example,
4198 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4199 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4200 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
4201 @code{shift-selection-mode} (@pxref{Conflicts}).
4202 @kindex S-@key{right}
4203 @kindex S-@key{left}
4206 @kbd{S-@key{left}} and @kbd{S-@key{right}} and walk through @emph{all}
4207 keywords from all sets, so for example @kbd{S-@key{right}} would switch
4208 from @code{DONE} to @code{REPORT} in the example above. See also
4209 @ref{Conflicts}, for a discussion of the interaction with
4210 @code{shift-selection-mode}.
4213 @node Fast access to TODO states
4214 @subsection Fast access to TODO states
4216 If you would like to quickly change an entry to an arbitrary TODO state
4217 instead of cycling through the states, you can set up keys for single-letter
4218 access to the states. This is done by adding the selection character after
4219 each keyword, in parentheses@footnote{All characters are allowed except
4220 @code{@@^!}, which have a special meaning here.}. For example:
4223 (setq org-todo-keywords
4224 '((sequence "TODO(t)" "|" "DONE(d)")
4225 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4226 (sequence "|" "CANCELED(c)")))
4229 @vindex org-fast-tag-selection-include-todo
4230 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4231 will be switched to this state. @kbd{SPC} can be used to remove any TODO
4232 keyword from an entry.@footnote{Check also the option
4233 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4234 state through the tags interface (@pxref{Setting tags}), in case you like to
4235 mingle the two concepts. Note that this means you need to come up with
4236 unique keys across both sets of keywords.}
4238 @node Per-file keywords
4239 @subsection Setting up keywords for individual files
4240 @cindex keyword options
4241 @cindex per-file keywords
4246 It can be very useful to use different aspects of the TODO mechanism in
4247 different files. For file-local settings, you need to add special lines to
4248 the file which set the keywords and interpretation for that file only. For
4249 example, to set one of the two examples discussed above, you need one of the
4250 following lines anywhere in the file:
4253 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4255 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4256 interpretation, but it means the same as @code{#+TODO}), or
4258 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4261 A setup for using several sets in parallel would be:
4265 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4269 @cindex completion, of option keywords
4271 @noindent To make sure you are using the correct keyword, type
4272 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4274 @cindex DONE, final TODO keyword
4275 Remember that the keywords after the vertical bar (or the last keyword
4276 if no bar is there) must always mean that the item is DONE (although you
4277 may use a different word). After changing one of these lines, use
4278 @kbd{C-c C-c} with the cursor still in the line to make the changes
4279 known to Org mode@footnote{Org mode parses these lines only when
4280 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
4281 cursor in a line starting with @samp{#+} is simply restarting Org mode
4282 for the current buffer.}.
4284 @node Faces for TODO keywords
4285 @subsection Faces for TODO keywords
4286 @cindex faces, for TODO keywords
4288 @vindex org-todo @r{(face)}
4289 @vindex org-done @r{(face)}
4290 @vindex org-todo-keyword-faces
4291 Org mode highlights TODO keywords with special faces: @code{org-todo}
4292 for keywords indicating that an item still has to be acted upon, and
4293 @code{org-done} for keywords indicating that an item is finished. If
4294 you are using more than 2 different states, you might want to use
4295 special faces for some of them. This can be done using the option
4296 @code{org-todo-keyword-faces}. For example:
4300 (setq org-todo-keyword-faces
4301 '(("TODO" . org-warning) ("STARTED" . "yellow")
4302 ("CANCELED" . (:foreground "blue" :weight bold))))
4306 While using a list with face properties as shown for CANCELED @emph{should}
4307 work, this does not always seem to be the case. If necessary, define a
4308 special face and use that. A string is interpreted as a color. The option
4309 @code{org-faces-easy-properties} determines if that color is interpreted as a
4310 foreground or a background color.
4312 @node TODO dependencies
4313 @subsection TODO dependencies
4314 @cindex TODO dependencies
4315 @cindex dependencies, of TODO states
4317 @vindex org-enforce-todo-dependencies
4318 @cindex property, ORDERED
4319 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4320 dependencies. Usually, a parent TODO task should not be marked DONE until
4321 all subtasks (defined as children tasks) are marked as DONE@. And sometimes
4322 there is a logical sequence to a number of (sub)tasks, so that one task
4323 cannot be acted upon before all siblings above it are done. If you customize
4324 the option @code{org-enforce-todo-dependencies}, Org will block entries
4325 from changing state to DONE while they have children that are not DONE@.
4326 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4327 will be blocked until all earlier siblings are marked DONE@. Here is an
4331 * TODO Blocked until (two) is done
4340 ** TODO b, needs to wait for (a)
4341 ** TODO c, needs to wait for (a) and (b)
4345 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4346 @vindex org-track-ordered-property-with-tag
4347 @cindex property, ORDERED
4348 Toggle the @code{ORDERED} property of the current entry. A property is used
4349 for this behavior because this should be local to the current entry, not
4350 inherited like a tag. However, if you would like to @i{track} the value of
4351 this property with a tag for better visibility, customize the option
4352 @code{org-track-ordered-property-with-tag}.
4353 @orgkey{C-u C-u C-u C-c C-t}
4354 Change TODO state, circumventing any state blocking.
4357 @vindex org-agenda-dim-blocked-tasks
4358 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4359 that cannot be closed because of such dependencies will be shown in a dimmed
4360 font or even made invisible in agenda views (@pxref{Agenda views}).
4362 @cindex checkboxes and TODO dependencies
4363 @vindex org-enforce-todo-dependencies
4364 You can also block changes of TODO states by looking at checkboxes
4365 (@pxref{Checkboxes}). If you set the option
4366 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4367 checkboxes will be blocked from switching to DONE.
4369 If you need more complex dependency structures, for example dependencies
4370 between entries in different trees or files, check out the contributed
4371 module @file{org-depend.el}.
4374 @node Progress logging
4375 @section Progress logging
4376 @cindex progress logging
4377 @cindex logging, of progress
4379 Org mode can automatically record a timestamp and possibly a note when
4380 you mark a TODO item as DONE, or even each time you change the state of
4381 a TODO item. This system is highly configurable; settings can be on a
4382 per-keyword basis and can be localized to a file or even a subtree. For
4383 information on how to clock working time for a task, see @ref{Clocking
4387 * Closing items:: When was this entry marked DONE?
4388 * Tracking TODO state changes:: When did the status change?
4389 * Tracking your habits:: How consistent have you been?
4393 @subsection Closing items
4395 The most basic logging is to keep track of @emph{when} a certain TODO
4396 item was finished. This is achieved with@footnote{The corresponding
4397 in-buffer setting is: @code{#+STARTUP: logdone}}
4400 (setq org-log-done 'time)
4403 @vindex org-closed-keep-when-no-todo
4405 Then each time you turn an entry from a TODO (not-done) state into any of the
4406 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4407 the headline. If you turn the entry back into a TODO item through further
4408 state cycling, that line will be removed again. If you turn the entry back
4409 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4410 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4411 non-@code{nil}. If you want to record a note along with the timestamp,
4412 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4416 (setq org-log-done 'note)
4420 You will then be prompted for a note, and that note will be stored below
4421 the entry with a @samp{Closing Note} heading.
4423 In the timeline (@pxref{Timeline}) and in the agenda
4424 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4425 display the TODO items with a @samp{CLOSED} timestamp on each day,
4426 giving you an overview of what has been done.
4428 @node Tracking TODO state changes
4429 @subsection Tracking TODO state changes
4430 @cindex drawer, for state change recording
4432 @vindex org-log-states-order-reversed
4433 @vindex org-log-into-drawer
4434 @cindex property, LOG_INTO_DRAWER
4435 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4436 might want to keep track of when a state change occurred and maybe take a
4437 note about this change. You can either record just a timestamp, or a
4438 time-stamped note for a change. These records will be inserted after the
4439 headline as an itemized list, newest first@footnote{See the option
4440 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4441 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4442 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4443 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4444 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4445 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4446 overrule the setting of this variable for a subtree by setting a
4447 @code{LOG_INTO_DRAWER} property.
4449 Since it is normally too much to record a note for every state, Org mode
4450 expects configuration on a per-keyword basis for this. This is achieved by
4451 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4452 with timestamp) in parentheses after each keyword. For example, with the
4456 (setq org-todo-keywords
4457 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4460 To record a timestamp without a note for TODO keywords configured with
4461 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4464 @vindex org-log-done
4465 You not only define global TODO keywords and fast access keys, but also
4466 request that a time is recorded when the entry is set to
4467 DONE@footnote{It is possible that Org mode will record two timestamps
4468 when you are using both @code{org-log-done} and state change logging.
4469 However, it will never prompt for two notes---if you have configured
4470 both, the state change recording note will take precedence and cancel
4471 the @samp{Closing Note}.}, and that a note is recorded when switching to
4472 WAIT or CANCELED@. The setting for WAIT is even more special: the
4473 @samp{!} after the slash means that in addition to the note taken when
4474 entering the state, a timestamp should be recorded when @i{leaving} the
4475 WAIT state, if and only if the @i{target} state does not configure
4476 logging for entering it. So it has no effect when switching from WAIT
4477 to DONE, because DONE is configured to record a timestamp only. But
4478 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4479 setting now triggers a timestamp even though TODO has no logging
4482 You can use the exact same syntax for setting logging preferences local
4485 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4488 @cindex property, LOGGING
4489 In order to define logging settings that are local to a subtree or a
4490 single item, define a LOGGING property in this entry. Any non-empty
4491 LOGGING property resets all logging settings to @code{nil}. You may then turn
4492 on logging for this specific tree using STARTUP keywords like
4493 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4494 settings like @code{TODO(!)}. For example
4497 * TODO Log each state with only a time
4499 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4501 * TODO Only log when switching to WAIT, and when repeating
4503 :LOGGING: WAIT(@@) logrepeat
4505 * TODO No logging at all
4511 @node Tracking your habits
4512 @subsection Tracking your habits
4515 Org has the ability to track the consistency of a special category of TODOs,
4516 called ``habits''. A habit has the following properties:
4520 You have enabled the @code{habits} module by customizing @code{org-modules}.
4522 The habit is a TODO item, with a TODO keyword representing an open state.
4524 The property @code{STYLE} is set to the value @code{habit}.
4526 The TODO has a scheduled date, usually with a @code{.+} style repeat
4527 interval. A @code{++} style may be appropriate for habits with time
4528 constraints, e.g., must be done on weekends, or a @code{+} style for an
4529 unusual habit that can have a backlog, e.g., weekly reports.
4531 The TODO may also have minimum and maximum ranges specified by using the
4532 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4533 three days, but at most every two days.
4535 You must also have state logging for the @code{DONE} state enabled
4536 (@pxref{Tracking TODO state changes}), in order for historical data to be
4537 represented in the consistency graph. If it is not enabled it is not an
4538 error, but the consistency graphs will be largely meaningless.
4541 To give you an idea of what the above rules look like in action, here's an
4542 actual habit with some history:
4546 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4549 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4551 - State "DONE" from "TODO" [2009-10-15 Thu]
4552 - State "DONE" from "TODO" [2009-10-12 Mon]
4553 - State "DONE" from "TODO" [2009-10-10 Sat]
4554 - State "DONE" from "TODO" [2009-10-04 Sun]
4555 - State "DONE" from "TODO" [2009-10-02 Fri]
4556 - State "DONE" from "TODO" [2009-09-29 Tue]
4557 - State "DONE" from "TODO" [2009-09-25 Fri]
4558 - State "DONE" from "TODO" [2009-09-19 Sat]
4559 - State "DONE" from "TODO" [2009-09-16 Wed]
4560 - State "DONE" from "TODO" [2009-09-12 Sat]
4563 What this habit says is: I want to shave at most every 2 days (given by the
4564 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4565 today is the 15th, then the habit first appears in the agenda on Oct 17,
4566 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4567 after four days have elapsed.
4569 What's really useful about habits is that they are displayed along with a
4570 consistency graph, to show how consistent you've been at getting that task
4571 done in the past. This graph shows every day that the task was done over the
4572 past three weeks, with colors for each day. The colors used are:
4576 If the task wasn't to be done yet on that day.
4578 If the task could have been done on that day.
4580 If the task was going to be overdue the next day.
4582 If the task was overdue on that day.
4585 In addition to coloring each day, the day is also marked with an asterisk if
4586 the task was actually done that day, and an exclamation mark to show where
4587 the current day falls in the graph.
4589 There are several configuration variables that can be used to change the way
4590 habits are displayed in the agenda.
4593 @item org-habit-graph-column
4594 The buffer column at which the consistency graph should be drawn. This will
4595 overwrite any text in that column, so it is a good idea to keep your habits'
4596 titles brief and to the point.
4597 @item org-habit-preceding-days
4598 The amount of history, in days before today, to appear in consistency graphs.
4599 @item org-habit-following-days
4600 The number of days after today that will appear in consistency graphs.
4601 @item org-habit-show-habits-only-for-today
4602 If non-@code{nil}, only show habits in today's agenda view. This is set to true by
4606 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4607 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4608 bring them back. They are also subject to tag filtering, if you have habits
4609 which should only be done in certain contexts, for example.
4615 If you use Org mode extensively, you may end up with enough TODO items that
4616 it starts to make sense to prioritize them. Prioritizing can be done by
4617 placing a @emph{priority cookie} into the headline of a TODO item, like this
4620 *** TODO [#A] Write letter to Sam Fortune
4624 @vindex org-priority-faces
4625 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4626 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4627 treated just like priority @samp{B}. Priorities make a difference only for
4628 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4629 have no inherent meaning to Org mode. The cookies can be highlighted with
4630 special faces by customizing @code{org-priority-faces}.
4632 Priorities can be attached to any outline node; they do not need to be TODO
4638 @findex org-priority
4639 Set the priority of the current headline (@command{org-priority}). The
4640 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4641 When you press @key{SPC} instead, the priority cookie is removed from the
4642 headline. The priorities can also be changed ``remotely'' from the timeline
4643 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4645 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4646 @vindex org-priority-start-cycle-with-default
4647 Increase/decrease priority of current headline@footnote{See also the option
4648 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4649 also used to modify timestamps (@pxref{Creating timestamps}). See also
4650 @ref{Conflicts}, for a discussion of the interaction with
4651 @code{shift-selection-mode}.
4654 @vindex org-highest-priority
4655 @vindex org-lowest-priority
4656 @vindex org-default-priority
4657 You can change the range of allowed priorities by setting the options
4658 @code{org-highest-priority}, @code{org-lowest-priority}, and
4659 @code{org-default-priority}. For an individual buffer, you may set
4660 these values (highest, lowest, default) like this (please make sure that
4661 the highest priority is earlier in the alphabet than the lowest
4664 @cindex #+PRIORITIES
4669 @node Breaking down tasks
4670 @section Breaking tasks down into subtasks
4671 @cindex tasks, breaking down
4672 @cindex statistics, for TODO items
4674 @vindex org-agenda-todo-list-sublevels
4675 It is often advisable to break down large tasks into smaller, manageable
4676 subtasks. You can do this by creating an outline tree below a TODO item,
4677 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4678 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4679 the overview over the fraction of subtasks that are already completed, insert
4680 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4681 be updated each time the TODO status of a child changes, or when pressing
4682 @kbd{C-c C-c} on the cookie. For example:
4685 * Organize Party [33%]
4686 ** TODO Call people [1/2]
4690 ** DONE Talk to neighbor
4693 @cindex property, COOKIE_DATA
4694 If a heading has both checkboxes and TODO children below it, the meaning of
4695 the statistics cookie become ambiguous. Set the property
4696 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4699 @vindex org-hierarchical-todo-statistics
4700 If you would like to have the statistics cookie count any TODO entries in the
4701 subtree (not just direct children), configure
4702 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4703 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4707 * Parent capturing statistics [2/20]
4709 :COOKIE_DATA: todo recursive
4713 If you would like a TODO entry to automatically change to DONE
4714 when all children are done, you can use the following setup:
4717 (defun org-summary-todo (n-done n-not-done)
4718 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4719 (let (org-log-done org-log-states) ; turn off logging
4720 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4722 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4726 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4727 large number of subtasks (@pxref{Checkboxes}).
4734 @vindex org-list-automatic-rules
4735 Every item in a plain list@footnote{With the exception of description
4736 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4737 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4738 it with the string @samp{[ ]}. This feature is similar to TODO items
4739 (@pxref{TODO items}), but is more lightweight. Checkboxes are not included
4740 in the global TODO list, so they are often great to split a task into a
4741 number of simple steps. Or you can use them in a shopping list. To toggle a
4742 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4743 @file{org-mouse.el}).
4745 Here is an example of a checkbox list.
4748 * TODO Organize party [2/4]
4749 - [-] call people [1/3]
4754 - [ ] think about what music to play
4755 - [X] talk to the neighbors
4758 Checkboxes work hierarchically, so if a checkbox item has children that
4759 are checkboxes, toggling one of the children checkboxes will make the
4760 parent checkbox reflect if none, some, or all of the children are
4763 @cindex statistics, for checkboxes
4764 @cindex checkbox statistics
4765 @cindex property, COOKIE_DATA
4766 @vindex org-checkbox-hierarchical-statistics
4767 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4768 indicating how many checkboxes present in this entry have been checked off,
4769 and the total number of checkboxes present. This can give you an idea on how
4770 many checkboxes remain, even without opening a folded entry. The cookies can
4771 be placed into a headline or into (the first line of) a plain list item.
4772 Each cookie covers checkboxes of direct children structurally below the
4773 headline/item on which the cookie appears@footnote{Set the option
4774 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4775 count all checkboxes below the cookie, not just those belonging to direct
4776 children.}. You have to insert the cookie yourself by typing either
4777 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4778 result, as in the examples above. With @samp{[%]} you get information about
4779 the percentage of checkboxes checked (in the above example, this would be
4780 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4781 count either checkboxes below the heading or TODO states of children, and it
4782 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4783 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4785 @cindex blocking, of checkboxes
4786 @cindex checkbox blocking
4787 @cindex property, ORDERED
4788 If the current outline node has an @code{ORDERED} property, checkboxes must
4789 be checked off in sequence, and an error will be thrown if you try to check
4790 off a box while there are unchecked boxes above it.
4792 @noindent The following commands work with checkboxes:
4795 @orgcmd{C-c C-c,org-toggle-checkbox}
4796 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4797 With a single prefix argument, add an empty checkbox or remove the current
4798 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4799 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4800 considered to be an intermediate state.
4801 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4802 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4803 double prefix argument, set it to @samp{[-]}, which is considered to be an
4807 If there is an active region, toggle the first checkbox in the region
4808 and set all remaining boxes to the same status as the first. With a prefix
4809 arg, add or remove the checkbox for all items in the region.
4811 If the cursor is in a headline, toggle checkboxes in the region between
4812 this headline and the next (so @emph{not} the entire subtree).
4814 If there is no active region, just toggle the checkbox at point.
4816 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4817 Insert a new item with a checkbox. This works only if the cursor is already
4818 in a plain list item (@pxref{Plain lists}).
4819 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4820 @vindex org-track-ordered-property-with-tag
4821 @cindex property, ORDERED
4822 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4823 be checked off in sequence. A property is used for this behavior because
4824 this should be local to the current entry, not inherited like a tag.
4825 However, if you would like to @i{track} the value of this property with a tag
4826 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4827 @orgcmd{C-c #,org-update-statistics-cookies}
4828 Update the statistics cookie in the current outline entry. When called with
4829 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4830 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4831 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4832 changing TODO states. If you delete boxes/entries or add/change them by
4833 hand, use this command to get things back into sync.
4839 @cindex headline tagging
4840 @cindex matching, tags
4841 @cindex sparse tree, tag based
4843 An excellent way to implement labels and contexts for cross-correlating
4844 information is to assign @i{tags} to headlines. Org mode has extensive
4847 @vindex org-tag-faces
4848 Every headline can contain a list of tags; they occur at the end of the
4849 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4850 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4851 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4852 Tags will by default be in bold face with the same color as the headline.
4853 You may specify special faces for specific tags using the option
4854 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4855 (@pxref{Faces for TODO keywords}).
4858 * Tag inheritance:: Tags use the tree structure of the outline
4859 * Setting tags:: How to assign tags to a headline
4860 * Tag groups:: Use one tag to search for several tags
4861 * Tag searches:: Searching for combinations of tags
4864 @node Tag inheritance
4865 @section Tag inheritance
4866 @cindex tag inheritance
4867 @cindex inheritance, of tags
4868 @cindex sublevels, inclusion into tags match
4870 @i{Tags} make use of the hierarchical structure of outline trees. If a
4871 heading has a certain tag, all subheadings will inherit the tag as
4872 well. For example, in the list
4875 * Meeting with the French group :work:
4876 ** Summary by Frank :boss:notes:
4877 *** TODO Prepare slides for him :action:
4881 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4882 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4883 explicitly marked with those tags. You can also set tags that all entries in
4884 a file should inherit just as if these tags were defined in a hypothetical
4885 level zero that surrounds the entire file. Use a line like this@footnote{As
4886 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4887 changes in the line.}:
4891 #+FILETAGS: :Peter:Boss:Secret:
4895 @vindex org-use-tag-inheritance
4896 @vindex org-tags-exclude-from-inheritance
4897 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4898 To turn it off entirely, use @code{org-use-tag-inheritance}.
4900 @vindex org-tags-match-list-sublevels
4901 When a headline matches during a tags search while tag inheritance is turned
4902 on, all the sublevels in the same tree will (for a simple match form) match
4903 as well@footnote{This is only true if the search does not involve more
4904 complex tests including properties (@pxref{Property searches}).}. The list
4905 of matches may then become very long. If you only want to see the first tags
4906 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4909 @vindex org-agenda-use-tag-inheritance
4910 Tag inheritance is relevant when the agenda search tries to match a tag,
4911 either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4912 types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4913 have your tags correctly set in the agenda, so that tag filtering works fine,
4914 with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4915 this: the default value includes all agenda types, but setting this to @code{nil}
4916 can really speed up agenda generation.
4919 @section Setting tags
4920 @cindex setting tags
4921 @cindex tags, setting
4924 Tags can simply be typed into the buffer at the end of a headline.
4925 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4926 also a special command for inserting tags:
4929 @orgcmd{C-c C-q,org-set-tags-command}
4930 @cindex completion, of tags
4931 @vindex org-tags-column
4932 Enter new tags for the current headline. Org mode will either offer
4933 completion or a special single-key interface for setting tags, see
4934 below. After pressing @key{RET}, the tags will be inserted and aligned
4935 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4936 tags in the current buffer will be aligned to that column, just to make
4937 things look nice. TAGS are automatically realigned after promotion,
4938 demotion, and TODO state changes (@pxref{TODO basics}).
4940 @orgcmd{C-c C-c,org-set-tags-command}
4941 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4944 @vindex org-tag-alist
4945 Org supports tag insertion based on a @emph{list of tags}. By
4946 default this list is constructed dynamically, containing all tags
4947 currently used in the buffer. You may also globally specify a hard list
4948 of tags with the variable @code{org-tag-alist}. Finally you can set
4949 the default tags for a given file with lines like
4953 #+TAGS: @@work @@home @@tennisclub
4954 #+TAGS: laptop car pc sailboat
4957 If you have globally defined your preferred set of tags using the
4958 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4959 in a specific file, add an empty TAGS option line to that file:
4965 @vindex org-tag-persistent-alist
4966 If you have a preferred set of tags that you would like to use in every file,
4967 in addition to those defined on a per-file basis by TAGS option lines, then
4968 you may specify a list of tags with the variable
4969 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4970 by adding a STARTUP option line to that file:
4976 By default Org mode uses the standard minibuffer completion facilities for
4977 entering tags. However, it also implements another, quicker, tag selection
4978 method called @emph{fast tag selection}. This allows you to select and
4979 deselect tags with just a single key press. For this to work well you should
4980 assign unique letters to most of your commonly used tags. You can do this
4981 globally by configuring the variable @code{org-tag-alist} in your
4982 @file{.emacs} file. For example, you may find the need to tag many items in
4983 different files with @samp{:@@home:}. In this case you can set something
4987 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4990 @noindent If the tag is only relevant to the file you are working on, then you
4991 can instead set the TAGS option line as:
4994 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4997 @noindent The tags interface will show the available tags in a splash
4998 window. If you want to start a new line after a specific tag, insert
4999 @samp{\n} into the tag list
5002 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
5005 @noindent or write them in two lines:
5008 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
5009 #+TAGS: laptop(l) pc(p)
5013 You can also group together tags that are mutually exclusive by using
5017 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
5020 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
5021 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
5023 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
5024 these lines to activate any changes.
5027 To set these mutually exclusive groups in the variable @code{org-tag-alist},
5028 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
5029 of the braces. Similarly, you can use @code{:newline} to indicate a line
5030 break. The previous example would be set globally by the following
5034 (setq org-tag-alist '((:startgroup . nil)
5035 ("@@work" . ?w) ("@@home" . ?h)
5036 ("@@tennisclub" . ?t)
5038 ("laptop" . ?l) ("pc" . ?p)))
5041 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
5042 automatically present you with a special interface, listing inherited tags,
5043 the tags of the current headline, and a list of all valid tags with
5044 corresponding keys@footnote{Keys will automatically be assigned to tags which
5045 have no configured keys.}. In this interface, you can use the following
5050 Pressing keys assigned to tags will add or remove them from the list of
5051 tags in the current line. Selecting a tag in a group of mutually
5052 exclusive tags will turn off any other tags from that group.
5055 Enter a tag in the minibuffer, even if the tag is not in the predefined
5056 list. You will be able to complete on all tags present in the buffer.
5057 You can also add several tags: just separate them with a comma.
5061 Clear all tags for this line.
5064 Accept the modified set.
5066 Abort without installing changes.
5068 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5070 Turn off groups of mutually exclusive tags. Use this to (as an
5071 exception) assign several tags from such a group.
5073 Toggle auto-exit after the next change (see below).
5074 If you are using expert mode, the first @kbd{C-c} will display the
5079 This method lets you assign tags to a headline with very few keys. With
5080 the above setup, you could clear the current tags and set @samp{@@home},
5081 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5082 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
5083 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5084 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
5085 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5086 @key{RET} @key{RET}}.
5088 @vindex org-fast-tag-selection-single-key
5089 If you find that most of the time you need only a single key press to
5090 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5091 Then you no longer have to press @key{RET} to exit fast tag selection---it
5092 will immediately exit after the first change. If you then occasionally
5093 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5094 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5095 instead of @kbd{C-c C-c}). If you set the variable to the value
5096 @code{expert}, the special window is not even shown for single-key tag
5097 selection, it comes up only when you press an extra @kbd{C-c}.
5103 @cindex tags, groups
5104 In a set of mutually exclusive tags, the first tag can be defined as a
5105 @emph{group tag}. When you search for a group tag, it will return matches
5106 for all members in the group. In an agenda view, filtering by a group tag
5107 will display headlines tagged with at least one of the members of the
5108 group. This makes tag searches and filters even more flexible.
5110 You can set group tags by inserting a colon between the group tag and other
5111 tags---beware that all whitespaces are mandatory so that Org can parse this
5115 #+TAGS: @{ @@read : @@read_book @@read_ebook @}
5118 In this example, @samp{@@read} is a @emph{group tag} for a set of three
5119 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
5121 You can also use the @code{:grouptags} keyword directly when setting
5122 @code{org-tag-alist}:
5125 (setq org-tag-alist '((:startgroup . nil)
5128 ("@@read_book" . nil)
5129 ("@@read_ebook" . nil)
5133 You cannot nest group tags or use a group tag as a tag in another group.
5136 @vindex org-group-tags
5137 If you want to ignore group tags temporarily, toggle group tags support
5138 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
5139 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5142 @section Tag searches
5143 @cindex tag searches
5144 @cindex searching for tags
5146 Once a system of tags has been set up, it can be used to collect related
5147 information into special lists.
5150 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5151 Create a sparse tree with all headlines matching a tags/property/TODO search.
5152 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5153 @xref{Matching tags and properties}.
5154 @orgcmd{C-c a m,org-tags-view}
5155 Create a global list of tag matches from all agenda files. @xref{Matching
5156 tags and properties}.
5157 @orgcmd{C-c a M,org-tags-view}
5158 @vindex org-tags-match-list-sublevels
5159 Create a global list of tag matches from all agenda files, but check
5160 only TODO items and force checking subitems (see the option
5161 @code{org-tags-match-list-sublevels}).
5164 These commands all prompt for a match string which allows basic Boolean logic
5165 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5166 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5167 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
5168 string is rich and allows also matching against TODO keywords, entry levels
5169 and properties. For a complete description with many examples, see
5170 @ref{Matching tags and properties}.
5173 @node Properties and columns
5174 @chapter Properties and columns
5177 A property is a key-value pair associated with an entry. Properties can be
5178 set so they are associated with a single entry, with every entry in a tree,
5179 or with every entry in an Org mode file.
5181 There are two main applications for properties in Org mode. First,
5182 properties are like tags, but with a value. Imagine maintaining a file where
5183 you document bugs and plan releases for a piece of software. Instead of
5184 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5185 property, say @code{:Release:}, that in different subtrees has different
5186 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
5187 implement (very basic) database capabilities in an Org buffer. Imagine
5188 keeping track of your music CDs, where properties could be things such as the
5189 album, artist, date of release, number of tracks, and so on.
5191 Properties can be conveniently edited and viewed in column view
5192 (@pxref{Column view}).
5195 * Property syntax:: How properties are spelled out
5196 * Special properties:: Access to other Org mode features
5197 * Property searches:: Matching property values
5198 * Property inheritance:: Passing values down the tree
5199 * Column view:: Tabular viewing and editing
5200 * Property API:: Properties for Lisp programmers
5203 @node Property syntax
5204 @section Property syntax
5205 @cindex property syntax
5206 @cindex drawer, for properties
5208 Properties are key-value pairs. When they are associated with a single entry
5209 or with a tree they need to be inserted into a special drawer
5210 (@pxref{Drawers}) with the name @code{PROPERTIES}, which has to be located
5211 right below a headline, and its planning line (@pxref{Deadlines and
5212 scheduling}) when applicable. Each property is specified on a single line,
5213 with the key (surrounded by colons) first, and the value after it. Keys are
5214 case-insensitives. Here is an example:
5219 *** Goldberg Variations
5221 :Title: Goldberg Variations
5222 :Composer: J.S. Bach
5224 :Publisher: Deutsche Grammophon
5229 Depending on the value of @code{org-use-property-inheritance}, a property set
5230 this way will either be associated with a single entry, or the subtree
5231 defined by the entry, see @ref{Property inheritance}.
5233 You may define the allowed values for a particular property @samp{:Xyz:}
5234 by setting a property @samp{:Xyz_ALL:}. This special property is
5235 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5236 the entire tree. When allowed values are defined, setting the
5237 corresponding property becomes easier and is less prone to typing
5238 errors. For the example with the CD collection, we can predefine
5239 publishers and the number of disks in a box like this:
5244 :NDisks_ALL: 1 2 3 4
5245 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5249 If you want to set properties that can be inherited by any entry in a
5250 file, use a line like
5251 @cindex property, _ALL
5254 #+PROPERTY: NDisks_ALL 1 2 3 4
5257 Contrary to properties set from a special drawer, you have to refresh the
5258 buffer with @kbd{C-c C-c} to activate this change.
5260 If you want to add to the value of an existing property, append a @code{+} to
5261 the property name. The following results in the property @code{var} having
5262 the value ``foo=1 bar=2''.
5265 #+PROPERTY: var foo=1
5266 #+PROPERTY: var+ bar=2
5269 It is also possible to add to the values of inherited properties. The
5270 following results in the @code{genres} property having the value ``Classic
5271 Baroque'' under the @code{Goldberg Variations} subtree.
5279 *** Goldberg Variations
5281 :Title: Goldberg Variations
5282 :Composer: J.S. Bach
5284 :Publisher: Deutsche Grammophon
5289 Note that a property can only have one entry per Drawer.
5291 @vindex org-global-properties
5292 Property values set with the global variable
5293 @code{org-global-properties} can be inherited by all entries in all
5297 The following commands help to work with properties:
5300 @orgcmd{M-@key{TAB},pcomplete}
5301 After an initial colon in a line, complete property keys. All keys used
5302 in the current file will be offered as possible completions.
5303 @orgcmd{C-c C-x p,org-set-property}
5304 Set a property. This prompts for a property name and a value. If
5305 necessary, the property drawer is created as well.
5306 @item C-u M-x org-insert-drawer RET
5307 @cindex org-insert-drawer
5308 Insert a property drawer into the current entry. The drawer will be
5309 inserted early in the entry, but after the lines with planning
5310 information like deadlines.
5311 @orgcmd{C-c C-c,org-property-action}
5312 With the cursor in a property drawer, this executes property commands.
5313 @orgcmd{C-c C-c s,org-set-property}
5314 Set a property in the current entry. Both the property and the value
5315 can be inserted using completion.
5316 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5317 Switch property at point to the next/previous allowed value.
5318 @orgcmd{C-c C-c d,org-delete-property}
5319 Remove a property from the current entry.
5320 @orgcmd{C-c C-c D,org-delete-property-globally}
5321 Globally remove a property, from all entries in the current file.
5322 @orgcmd{C-c C-c c,org-compute-property-at-point}
5323 Compute the property at point, using the operator and scope from the
5324 nearest column format definition.
5327 @node Special properties
5328 @section Special properties
5329 @cindex properties, special
5331 Special properties provide an alternative access method to Org mode features,
5332 like the TODO state or the priority of an entry, discussed in the previous
5333 chapters. This interface exists so that you can include these states in a
5334 column view (@pxref{Column view}), or to use them in queries. The following
5335 property names are special and (except for @code{:CATEGORY:}) should not be
5336 used as keys in the properties drawer:
5338 @cindex property, special, ID
5339 @cindex property, special, TODO
5340 @cindex property, special, TAGS
5341 @cindex property, special, ALLTAGS
5342 @cindex property, special, CATEGORY
5343 @cindex property, special, PRIORITY
5344 @cindex property, special, DEADLINE
5345 @cindex property, special, SCHEDULED
5346 @cindex property, special, CLOSED
5347 @cindex property, special, TIMESTAMP
5348 @cindex property, special, TIMESTAMP_IA
5349 @cindex property, special, CLOCKSUM
5350 @cindex property, special, CLOCKSUM_T
5351 @cindex property, special, BLOCKED
5352 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5353 @cindex property, special, ITEM
5354 @cindex property, special, FILE
5356 ID @r{A globally unique ID used for synchronization during}
5357 @r{iCalendar or MobileOrg export.}
5358 TODO @r{The TODO keyword of the entry.}
5359 TAGS @r{The tags defined directly in the headline.}
5360 ALLTAGS @r{All tags, including inherited ones.}
5361 CATEGORY @r{The category of an entry.}
5362 PRIORITY @r{The priority of the entry, a string with a single letter.}
5363 DEADLINE @r{The deadline time string, without the angular brackets.}
5364 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5365 CLOSED @r{When was this entry closed?}
5366 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5367 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5368 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5369 @r{must be run first to compute the values in the current buffer.}
5370 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5371 @r{@code{org-clock-sum-today} must be run first to compute the}
5372 @r{values in the current buffer.}
5373 BLOCKED @r{"t" if task is currently blocked by children or siblings}
5374 ITEM @r{The headline of the entry.}
5375 FILE @r{The filename the entry is located in.}
5378 @node Property searches
5379 @section Property searches
5380 @cindex properties, searching
5381 @cindex searching, of properties
5383 To create sparse trees and special lists with selection based on properties,
5384 the same commands are used as for tag searches (@pxref{Tag searches}).
5387 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5388 Create a sparse tree with all matching entries. With a
5389 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5390 @orgcmd{C-c a m,org-tags-view}
5391 Create a global list of tag/property matches from all agenda files.
5392 @xref{Matching tags and properties}.
5393 @orgcmd{C-c a M,org-tags-view}
5394 @vindex org-tags-match-list-sublevels
5395 Create a global list of tag matches from all agenda files, but check
5396 only TODO items and force checking of subitems (see the option
5397 @code{org-tags-match-list-sublevels}).
5400 The syntax for the search string is described in @ref{Matching tags and
5403 There is also a special command for creating sparse trees based on a
5408 Create a sparse tree based on the value of a property. This first
5409 prompts for the name of a property, and then for a value. A sparse tree
5410 is created with all entries that define this property with the given
5411 value. If you enclose the value in curly braces, it is interpreted as
5412 a regular expression and matched against the property values.
5415 @node Property inheritance
5416 @section Property Inheritance
5417 @cindex properties, inheritance
5418 @cindex inheritance, of properties
5420 @vindex org-use-property-inheritance
5421 The outline structure of Org mode documents lends itself to an
5422 inheritance model of properties: if the parent in a tree has a certain
5423 property, the children can inherit this property. Org mode does not
5424 turn this on by default, because it can slow down property searches
5425 significantly and is often not needed. However, if you find inheritance
5426 useful, you can turn it on by setting the variable
5427 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5428 all properties inherited from the parent, to a list of properties
5429 that should be inherited, or to a regular expression that matches
5430 inherited properties. If a property has the value @code{nil}, this is
5431 interpreted as an explicit undefine of the property, so that inheritance
5432 search will stop at this value and return @code{nil}.
5434 Org mode has a few properties for which inheritance is hard-coded, at
5435 least for the special applications for which they are used:
5437 @cindex property, COLUMNS
5440 The @code{:COLUMNS:} property defines the format of column view
5441 (@pxref{Column view}). It is inherited in the sense that the level
5442 where a @code{:COLUMNS:} property is defined is used as the starting
5443 point for a column view table, independently of the location in the
5444 subtree from where columns view is turned on.
5446 @cindex property, CATEGORY
5447 For agenda view, a category set through a @code{:CATEGORY:} property
5448 applies to the entire subtree.
5450 @cindex property, ARCHIVE
5451 For archiving, the @code{:ARCHIVE:} property may define the archive
5452 location for the entire subtree (@pxref{Moving subtrees}).
5454 @cindex property, LOGGING
5455 The LOGGING property may define logging settings for an entry or a
5456 subtree (@pxref{Tracking TODO state changes}).
5460 @section Column view
5462 A great way to view and edit properties in an outline tree is
5463 @emph{column view}. In column view, each outline node is turned into a
5464 table row. Columns in this table provide access to properties of the
5465 entries. Org mode implements columns by overlaying a tabular structure
5466 over the headline of each item. While the headlines have been turned
5467 into a table row, you can still change the visibility of the outline
5468 tree. For example, you get a compact table by switching to CONTENTS
5469 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5470 is active), but you can still open, read, and edit the entry below each
5471 headline. Or, you can switch to column view after executing a sparse
5472 tree command and in this way get a table only for the selected items.
5473 Column view also works in agenda buffers (@pxref{Agenda views}) where
5474 queries have collected selected items, possibly from a number of files.
5477 * Defining columns:: The COLUMNS format property
5478 * Using column view:: How to create and use column view
5479 * Capturing column view:: A dynamic block for column view
5482 @node Defining columns
5483 @subsection Defining columns
5484 @cindex column view, for properties
5485 @cindex properties, column view
5487 Setting up a column view first requires defining the columns. This is
5488 done by defining a column format line.
5491 * Scope of column definitions:: Where defined, where valid?
5492 * Column attributes:: Appearance and content of a column
5495 @node Scope of column definitions
5496 @subsubsection Scope of column definitions
5498 To define a column format for an entire file, use a line like
5502 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5505 To specify a format that only applies to a specific tree, add a
5506 @code{:COLUMNS:} property to the top node of that tree, for example:
5509 ** Top node for columns view
5511 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5515 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5516 for the entry itself, and for the entire subtree below it. Since the
5517 column definition is part of the hierarchical structure of the document,
5518 you can define columns on level 1 that are general enough for all
5519 sublevels, and more specific columns further down, when you edit a
5520 deeper part of the tree.
5522 @node Column attributes
5523 @subsubsection Column attributes
5524 A column definition sets the attributes of a column. The general
5525 definition looks like this:
5528 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5532 Except for the percent sign and the property name, all items are
5533 optional. The individual parts have the following meaning:
5536 @var{width} @r{An integer specifying the width of the column in characters.}
5537 @r{If omitted, the width will be determined automatically.}
5538 @var{property} @r{The property that should be edited in this column.}
5539 @r{Special properties representing meta data are allowed here}
5540 @r{as well (@pxref{Special properties})}
5541 @var{title} @r{The header text for the column. If omitted, the property}
5543 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5544 @r{parent nodes are computed from the children.}
5545 @r{Supported summary types are:}
5546 @{+@} @r{Sum numbers in this column.}
5547 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5548 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5549 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5550 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5551 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5552 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5553 @{min@} @r{Smallest number in column.}
5554 @{max@} @r{Largest number.}
5555 @{mean@} @r{Arithmetic mean of numbers.}
5556 @{:min@} @r{Smallest time value in column.}
5557 @{:max@} @r{Largest time value.}
5558 @{:mean@} @r{Arithmetic mean of time values.}
5559 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5560 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5561 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5562 @{est+@} @r{Add low-high estimates.}
5566 Be aware that you can only have one summary type for any property you
5567 include. Subsequent columns referencing the same property will all display the
5568 same summary information.
5570 The @code{est+} summary type requires further explanation. It is used for
5571 combining estimates, expressed as low-high ranges. For example, instead
5572 of estimating a particular task will take 5 days, you might estimate it as
5573 5--6 days if you're fairly confident you know how much work is required, or
5574 1--10 days if you don't really know what needs to be done. Both ranges
5575 average at 5.5 days, but the first represents a more predictable delivery.
5577 When combining a set of such estimates, simply adding the lows and highs
5578 produces an unrealistically wide result. Instead, @code{est+} adds the
5579 statistical mean and variance of the sub-tasks, generating a final estimate
5580 from the sum. For example, suppose you had ten tasks, each of which was
5581 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5582 of 5 to 20 days, representing what to expect if everything goes either
5583 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5584 full job more realistically, at 10--15 days.
5586 Numbers are right-aligned when a format specifier with an explicit width like
5587 @code{%5d} or @code{%5.1f} is used.
5589 Here is an example for a complete columns definition, along with allowed
5593 :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.}
5594 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5595 :Owner_ALL: Tammy Mark Karl Lisa Don
5596 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5597 :Approved_ALL: "[ ]" "[X]"
5601 The first column, @samp{%25ITEM}, means the first 25 characters of the
5602 item itself, i.e., of the headline. You probably always should start the
5603 column definition with the @samp{ITEM} specifier. The other specifiers
5604 create columns @samp{Owner} with a list of names as allowed values, for
5605 @samp{Status} with four different possible values, and for a checkbox
5606 field @samp{Approved}. When no width is given after the @samp{%}
5607 character, the column will be exactly as wide as it needs to be in order
5608 to fully display all values. The @samp{Approved} column does have a
5609 modified title (@samp{Approved?}, with a question mark). Summaries will
5610 be created for the @samp{Time_Estimate} column by adding time duration
5611 expressions like HH:MM, and for the @samp{Approved} column, by providing
5612 an @samp{[X]} status if all children have been checked. The
5613 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5614 sums of CLOCK intervals in the subtree, either for all clocks or just for
5617 @node Using column view
5618 @subsection Using column view
5621 @tsubheading{Turning column view on and off}
5622 @orgcmd{C-c C-x C-c,org-columns}
5623 @vindex org-columns-default-format
5624 Turn on column view. If the cursor is before the first headline in the file,
5625 column view is turned on for the entire file, using the @code{#+COLUMNS}
5626 definition. If the cursor is somewhere inside the outline, this command
5627 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5628 defines a format. When one is found, the column view table is established
5629 for the tree starting at the entry that contains the @code{:COLUMNS:}
5630 property. If no such property is found, the format is taken from the
5631 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5632 and column view is established for the current entry and its subtree.
5633 @orgcmd{r,org-columns-redo}
5634 Recreate the column view, to include recent changes made in the buffer.
5635 @orgcmd{g,org-columns-redo}
5637 @orgcmd{q,org-columns-quit}
5639 @tsubheading{Editing values}
5640 @item @key{left} @key{right} @key{up} @key{down}
5641 Move through the column view from field to field.
5642 @kindex S-@key{left}
5643 @kindex S-@key{right}
5644 @item S-@key{left}/@key{right}
5645 Switch to the next/previous allowed value of the field. For this, you
5646 have to have specified allowed values for a property.
5648 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5649 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5650 Same as @kbd{S-@key{left}/@key{right}}
5651 @orgcmd{e,org-columns-edit-value}
5652 Edit the property at point. For the special properties, this will
5653 invoke the same interface that you normally use to change that
5654 property. For example, when editing a TAGS property, the tag completion
5655 or fast selection interface will pop up.
5656 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5657 When there is a checkbox at point, toggle it.
5658 @orgcmd{v,org-columns-show-value}
5659 View the full value of this property. This is useful if the width of
5660 the column is smaller than that of the value.
5661 @orgcmd{a,org-columns-edit-allowed}
5662 Edit the list of allowed values for this property. If the list is found
5663 in the hierarchy, the modified value is stored there. If no list is
5664 found, the new value is stored in the first entry that is part of the
5665 current column view.
5666 @tsubheading{Modifying the table structure}
5667 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5668 Make the column narrower/wider by one character.
5669 @orgcmd{S-M-@key{right},org-columns-new}
5670 Insert a new column, to the left of the current column.
5671 @orgcmd{S-M-@key{left},org-columns-delete}
5672 Delete the current column.
5675 @node Capturing column view
5676 @subsection Capturing column view
5678 Since column view is just an overlay over a buffer, it cannot be
5679 exported or printed directly. If you want to capture a column view, use
5680 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5681 of this block looks like this:
5683 @cindex #+BEGIN, columnview
5686 #+BEGIN: columnview :hlines 1 :id "label"
5691 @noindent This dynamic block has the following parameters:
5695 This is the most important parameter. Column view is a feature that is
5696 often localized to a certain (sub)tree, and the capture block might be
5697 at a different location in the file. To identify the tree whose view to
5698 capture, you can use 4 values:
5699 @cindex property, ID
5701 local @r{use the tree in which the capture block is located}
5702 global @r{make a global view, including all headings in the file}
5703 "file:@var{path-to-file}"
5704 @r{run column view at the top of this file}
5705 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5706 @r{property with the value @i{label}. You can use}
5707 @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5708 @r{the current entry and copy it to the kill-ring.}
5711 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5712 an hline before each headline with level @code{<= @var{N}}.
5714 When set to @code{t}, force column groups to get vertical lines.
5716 When set to a number, don't capture entries below this level.
5717 @item :skip-empty-rows
5718 When set to @code{t}, skip rows where the only non-empty specifier of the
5719 column view is @code{ITEM}.
5724 The following commands insert or update the dynamic block:
5727 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5728 Insert a dynamic block capturing a column view. You will be prompted
5729 for the scope or ID of the view.
5730 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5731 Update dynamic block at point. The cursor needs to be in the
5732 @code{#+BEGIN} line of the dynamic block.
5733 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5734 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5735 you have several clock table blocks, column-capturing blocks or other dynamic
5739 You can add formulas to the column view table and you may add plotting
5740 instructions in front of the table---these will survive an update of the
5741 block. If there is a @code{#+TBLFM:} after the table, the table will
5742 actually be recalculated automatically after an update.
5744 An alternative way to capture and process property values into a table is
5745 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5746 package@footnote{Contributed packages are not part of Emacs, but are
5747 distributed with the main distribution of Org (visit
5748 @uref{http://orgmode.org}).}. It provides a general API to collect
5749 properties from entries in a certain scope, and arbitrary Lisp expressions to
5750 process these values before inserting them into a table or a dynamic block.
5753 @section The Property API
5754 @cindex properties, API
5755 @cindex API, for properties
5757 There is a full API for accessing and changing properties. This API can
5758 be used by Emacs Lisp programs to work with properties and to implement
5759 features based on them. For more information see @ref{Using the
5762 @node Dates and times
5763 @chapter Dates and times
5769 To assist project planning, TODO items can be labeled with a date and/or
5770 a time. The specially formatted string carrying the date and time
5771 information is called a @emph{timestamp} in Org mode. This may be a
5772 little confusing because timestamp is often used to indicate when
5773 something was created or last changed. However, in Org mode this term
5774 is used in a much wider sense.
5777 * Timestamps:: Assigning a time to a tree entry
5778 * Creating timestamps:: Commands which insert timestamps
5779 * Deadlines and scheduling:: Planning your work
5780 * Clocking work time:: Tracking how long you spend on a task
5781 * Effort estimates:: Planning work effort in advance
5782 * Relative timer:: Notes with a running timer
5783 * Countdown timer:: Starting a countdown timer for a task
5788 @section Timestamps, deadlines, and scheduling
5790 @cindex ranges, time
5795 A timestamp is a specification of a date (possibly with a time or a range of
5796 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5797 simplest form, the day name is optional when you type the date yourself.
5798 However, any dates inserted or modified by Org will add that day name, for
5799 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5800 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5801 date/time format. To use an alternative format, see @ref{Custom time
5802 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5803 tree entry. Its presence causes entries to be shown on specific dates in the
5804 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5807 @item Plain timestamp; Event; Appointment
5810 A simple timestamp just assigns a date/time to an item. This is just
5811 like writing down an appointment or event in a paper agenda. In the
5812 timeline and agenda displays, the headline of an entry associated with a
5813 plain timestamp will be shown exactly on that date.
5816 * Meet Peter at the movies
5817 <2006-11-01 Wed 19:15>
5818 * Discussion on climate change
5819 <2006-11-02 Thu 20:00-22:00>
5822 @item Timestamp with repeater interval
5823 @cindex timestamp, with repeater interval
5824 A timestamp may contain a @emph{repeater interval}, indicating that it
5825 applies not only on the given date, but again and again after a certain
5826 interval of N days (d), weeks (w), months (m), or years (y). The
5827 following will show up in the agenda every Wednesday:
5830 * Pick up Sam at school
5831 <2007-05-16 Wed 12:30 +1w>
5834 @item Diary-style sexp entries
5835 For more complex date specifications, Org mode supports using the special
5836 sexp diary entries implemented in the Emacs calendar/diary
5837 package@footnote{When working with the standard diary sexp functions, you
5838 need to be very careful with the order of the arguments. That order depends
5839 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5840 versions, @code{european-calendar-style}). For example, to specify a date
5841 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5842 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5843 the settings. This has been the source of much confusion. Org mode users
5844 can resort to special versions of these functions like @code{org-date} or
5845 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5846 functions, but with stable ISO order of arguments (year, month, day) wherever
5847 applicable, independent of the value of @code{calendar-date-style}.}. For
5848 example with optional time
5851 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5852 <%%(diary-float t 4 2)>
5855 @item Time/Date range
5858 Two timestamps connected by @samp{--} denote a range. The headline
5859 will be shown on the first and last day of the range, and on any dates
5860 that are displayed and fall in the range. Here is an example:
5863 ** Meeting in Amsterdam
5864 <2004-08-23 Mon>--<2004-08-26 Thu>
5867 @item Inactive timestamp
5868 @cindex timestamp, inactive
5869 @cindex inactive timestamp
5870 Just like a plain timestamp, but with square brackets instead of
5871 angular ones. These timestamps are inactive in the sense that they do
5872 @emph{not} trigger an entry to show up in the agenda.
5875 * Gillian comes late for the fifth time
5881 @node Creating timestamps
5882 @section Creating timestamps
5883 @cindex creating timestamps
5884 @cindex timestamps, creating
5886 For Org mode to recognize timestamps, they need to be in the specific
5887 format. All commands listed below produce timestamps in the correct
5891 @orgcmd{C-c .,org-time-stamp}
5892 Prompt for a date and insert a corresponding timestamp. When the cursor is
5893 at an existing timestamp in the buffer, the command is used to modify this
5894 timestamp instead of inserting a new one. When this command is used twice in
5895 succession, a time range is inserted.
5897 @orgcmd{C-c !,org-time-stamp-inactive}
5898 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5905 @vindex org-time-stamp-rounding-minutes
5906 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5907 contains date and time. The default time can be rounded to multiples of 5
5908 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5911 Normalize timestamp, insert/fix day name if missing or wrong.
5913 @orgcmd{C-c <,org-date-from-calendar}
5914 Insert a timestamp corresponding to the cursor date in the Calendar.
5916 @orgcmd{C-c >,org-goto-calendar}
5917 Access the Emacs calendar for the current date. If there is a
5918 timestamp in the current line, go to the corresponding date
5921 @orgcmd{C-c C-o,org-open-at-point}
5922 Access the agenda for the date given by the timestamp or -range at
5923 point (@pxref{Weekly/daily agenda}).
5925 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5926 Change date at cursor by one day. These key bindings conflict with
5927 shift-selection and related modes (@pxref{Conflicts}).
5929 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5930 Change the item under the cursor in a timestamp. The cursor can be on a
5931 year, month, day, hour or minute. When the timestamp contains a time range
5932 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5933 shifting the time block with constant length. To change the length, modify
5934 the second time. Note that if the cursor is in a headline and not at a
5935 timestamp, these same keys modify the priority of an item.
5936 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5937 related modes (@pxref{Conflicts}).
5939 @orgcmd{C-c C-y,org-evaluate-time-range}
5940 @cindex evaluate time range
5941 Evaluate a time range by computing the difference between start and end.
5942 With a prefix argument, insert result after the time range (in a table: into
5943 the following column).
5948 * The date/time prompt:: How Org mode helps you entering date and time
5949 * Custom time format:: Making dates look different
5952 @node The date/time prompt
5953 @subsection The date/time prompt
5954 @cindex date, reading in minibuffer
5955 @cindex time, reading in minibuffer
5957 @vindex org-read-date-prefer-future
5958 When Org mode prompts for a date/time, the default is shown in default
5959 date/time format, and the prompt therefore seems to ask for a specific
5960 format. But it will in fact accept date/time information in a variety of
5961 formats. Generally, the information should start at the beginning of the
5962 string. Org mode will find whatever information is in
5963 there and derive anything you have not specified from the @emph{default date
5964 and time}. The default is usually the current date and time, but when
5965 modifying an existing timestamp, or when entering the second stamp of a
5966 range, it is taken from the stamp in the buffer. When filling in
5967 information, Org mode assumes that most of the time you will want to enter a
5968 date in the future: if you omit the month/year and the given day/month is
5969 @i{before} today, it will assume that you mean a future date@footnote{See the
5970 variable @code{org-read-date-prefer-future}. You may set that variable to
5971 the symbol @code{time} to even make a time before now shift the date to
5972 tomorrow.}. If the date has been automatically shifted into the future, the
5973 time prompt will show this with @samp{(=>F).}
5975 For example, let's assume that today is @b{June 13, 2006}. Here is how
5976 various inputs will be interpreted, the items filled in by Org mode are
5980 3-2-5 @result{} 2003-02-05
5981 2/5/3 @result{} 2003-02-05
5982 14 @result{} @b{2006}-@b{06}-14
5983 12 @result{} @b{2006}-@b{07}-12
5984 2/5 @result{} @b{2007}-02-05
5985 Fri @result{} nearest Friday after the default date
5986 sep 15 @result{} @b{2006}-09-15
5987 feb 15 @result{} @b{2007}-02-15
5988 sep 12 9 @result{} 2009-09-12
5989 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5990 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5991 w4 @result{} ISO week for of the current year @b{2006}
5992 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5993 2012-w04-5 @result{} Same as above
5996 Furthermore you can specify a relative date by giving, as the @emph{first}
5997 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
5998 indicate change in hours, days, weeks, months, or years. With a single plus
5999 or minus, the date is always relative to today. With a double plus or minus,
6000 it is relative to the default date. If instead of a single letter, you use
6001 the abbreviation of day name, the date will be the Nth such day, e.g.:
6006 +4d @result{} four days from today
6007 +4 @result{} same as above
6008 +2w @result{} two weeks from today
6009 ++5 @result{} five days from default date
6010 +2tue @result{} second Tuesday from now
6011 -wed @result{} last Wednesday
6014 @vindex parse-time-months
6015 @vindex parse-time-weekdays
6016 The function understands English month and weekday abbreviations. If
6017 you want to use unabbreviated names and/or other languages, configure
6018 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
6020 @vindex org-read-date-force-compatible-dates
6021 Not all dates can be represented in a given Emacs implementation. By default
6022 Org mode forces dates into the compatibility range 1970--2037 which works on
6023 all Emacs implementations. If you want to use dates outside of this range,
6024 read the docstring of the variable
6025 @code{org-read-date-force-compatible-dates}.
6027 You can specify a time range by giving start and end times or by giving a
6028 start time and a duration (in HH:MM format). Use one or two dash(es) as the
6029 separator in the former case and use '+' as the separator in the latter
6033 11am-1:15pm @result{} 11:00-13:15
6034 11am--1:15pm @result{} same as above
6035 11am+2:15 @result{} same as above
6038 @cindex calendar, for selecting date
6039 @vindex org-popup-calendar-for-date-prompt
6040 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
6041 you don't need/want the calendar, configure the variable
6042 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
6043 prompt, either by clicking on a date in the calendar, or by pressing
6044 @key{RET}, the date selected in the calendar will be combined with the
6045 information entered at the prompt. You can control the calendar fully
6046 from the minibuffer:
6053 @kindex S-@key{right}
6054 @kindex S-@key{left}
6055 @kindex S-@key{down}
6057 @kindex M-S-@key{right}
6058 @kindex M-S-@key{left}
6061 @key{RET} @r{Choose date at cursor in calendar.}
6062 mouse-1 @r{Select date by clicking on it.}
6063 S-@key{right}/@key{left} @r{One day forward/backward.}
6064 S-@key{down}/@key{up} @r{One week forward/backward.}
6065 M-S-@key{right}/@key{left} @r{One month forward/backward.}
6066 > / < @r{Scroll calendar forward/backward by one month.}
6067 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
6070 @vindex org-read-date-display-live
6071 The actions of the date/time prompt may seem complex, but I assure you they
6072 will grow on you, and you will start getting annoyed by pretty much any other
6073 way of entering a date/time out there. To help you understand what is going
6074 on, the current interpretation of your input will be displayed live in the
6075 minibuffer@footnote{If you find this distracting, turn the display off with
6076 @code{org-read-date-display-live}.}.
6078 @node Custom time format
6079 @subsection Custom time format
6080 @cindex custom date/time format
6081 @cindex time format, custom
6082 @cindex date format, custom
6084 @vindex org-display-custom-times
6085 @vindex org-time-stamp-custom-formats
6086 Org mode uses the standard ISO notation for dates and times as it is
6087 defined in ISO 8601. If you cannot get used to this and require another
6088 representation of date and time to keep you happy, you can get it by
6089 customizing the options @code{org-display-custom-times} and
6090 @code{org-time-stamp-custom-formats}.
6093 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6094 Toggle the display of custom formats for dates and times.
6098 Org mode needs the default format for scanning, so the custom date/time
6099 format does not @emph{replace} the default format---instead it is put
6100 @emph{over} the default format using text properties. This has the
6101 following consequences:
6104 You cannot place the cursor onto a timestamp anymore, only before or
6107 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6108 each component of a timestamp. If the cursor is at the beginning of
6109 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6110 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
6111 time will be changed by one minute.
6113 If the timestamp contains a range of clock times or a repeater, these
6114 will not be overlaid, but remain in the buffer as they were.
6116 When you delete a timestamp character-by-character, it will only
6117 disappear from the buffer after @emph{all} (invisible) characters
6118 belonging to the ISO timestamp have been removed.
6120 If the custom timestamp format is longer than the default and you are
6121 using dates in tables, table alignment will be messed up. If the custom
6122 format is shorter, things do work as expected.
6126 @node Deadlines and scheduling
6127 @section Deadlines and scheduling
6129 A timestamp may be preceded by special keywords to facilitate planning:
6133 @cindex DEADLINE keyword
6135 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6136 to be finished on that date.
6138 @vindex org-deadline-warning-days
6139 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6140 On the deadline date, the task will be listed in the agenda. In
6141 addition, the agenda for @emph{today} will carry a warning about the
6142 approaching or missed deadline, starting
6143 @code{org-deadline-warning-days} before the due date, and continuing
6144 until the entry is marked DONE@. An example:
6147 *** TODO write article about the Earth for the Guide
6148 DEADLINE: <2004-02-29 Sun>
6149 The editor in charge is [[bbdb:Ford Prefect]]
6152 You can specify a different lead time for warnings for a specific
6153 deadline using the following syntax. Here is an example with a warning
6154 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is
6155 deactivated if the task gets scheduled and you set
6156 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6159 @cindex SCHEDULED keyword
6161 Meaning: you are planning to start working on that task on the given
6164 @vindex org-agenda-skip-scheduled-if-done
6165 The headline will be listed under the given date@footnote{It will still
6166 be listed on that date after it has been marked DONE@. If you don't like
6167 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
6168 addition, a reminder that the scheduled date has passed will be present
6169 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6170 the task will automatically be forwarded until completed.
6173 *** TODO Call Trillian for a date on New Years Eve.
6174 SCHEDULED: <2004-12-25 Sat>
6177 @vindex org-scheduled-delay-days
6178 @vindex org-agenda-skip-scheduled-delay-if-deadline
6179 If you want to @emph{delay} the display of this task in the agenda, use
6180 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6181 25th but will appear two days later. In case the task contains a repeater,
6182 the delay is considered to affect all occurrences; if you want the delay to
6183 only affect the first scheduled occurrence of the task, use @code{--2d}
6184 instead. See @code{org-scheduled-delay-days} and
6185 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6186 control this globally or per agenda.
6189 @b{Important:} Scheduling an item in Org mode should @i{not} be
6190 understood in the same way that we understand @i{scheduling a meeting}.
6191 Setting a date for a meeting is just a simple appointment, you should
6192 mark this entry with a simple plain timestamp, to get this item shown
6193 on the date where it applies. This is a frequent misunderstanding by
6194 Org users. In Org mode, @i{scheduling} means setting a date when you
6195 want to start working on an action item.
6198 You may use timestamps with repeaters in scheduling and deadline
6199 entries. Org mode will issue early and late warnings based on the
6200 assumption that the timestamp represents the @i{nearest instance} of
6201 the repeater. However, the use of diary sexp entries like
6203 @code{<%%(diary-float t 42)>}
6205 in scheduling and deadline timestamps is limited. Org mode does not
6206 know enough about the internals of each sexp function to issue early and
6207 late warnings. However, it will show the item on each day where the
6211 * Inserting deadline/schedule:: Planning items
6212 * Repeated tasks:: Items that show up again and again
6215 @node Inserting deadline/schedule
6216 @subsection Inserting deadlines or schedules
6218 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6219 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
6220 any text between this line and the headline.} a deadline or to schedule
6225 @orgcmd{C-c C-d,org-deadline}
6226 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
6227 in the line directly following the headline. Any CLOSED timestamp will be
6228 removed. When called with a prefix arg, an existing deadline will be removed
6229 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6230 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6231 and @code{nologredeadline}}, a note will be taken when changing an existing
6234 @orgcmd{C-c C-s,org-schedule}
6235 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
6236 happen in the line directly following the headline. Any CLOSED timestamp
6237 will be removed. When called with a prefix argument, remove the scheduling
6238 date from the entry. Depending on the variable
6239 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6240 keywords @code{logreschedule}, @code{lognotereschedule}, and
6241 @code{nologreschedule}}, a note will be taken when changing an existing
6244 @orgcmd{C-c / d,org-check-deadlines}
6245 @cindex sparse tree, for deadlines
6246 @vindex org-deadline-warning-days
6247 Create a sparse tree with all deadlines that are either past-due, or
6248 which will become due within @code{org-deadline-warning-days}.
6249 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
6250 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
6251 all deadlines due tomorrow.
6253 @orgcmd{C-c / b,org-check-before-date}
6254 Sparse tree for deadlines and scheduled items before a given date.
6256 @orgcmd{C-c / a,org-check-after-date}
6257 Sparse tree for deadlines and scheduled items after a given date.
6260 Note that @code{org-schedule} and @code{org-deadline} supports
6261 setting the date by indicating a relative time: e.g., +1d will set
6262 the date to the next day after today, and --1w will set the date
6263 to the previous week before any current timestamp.
6265 @node Repeated tasks
6266 @subsection Repeated tasks
6267 @cindex tasks, repeated
6268 @cindex repeated tasks
6270 Some tasks need to be repeated again and again. Org mode helps to
6271 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6272 or plain timestamp. In the following example
6274 ** TODO Pay the rent
6275 DEADLINE: <2005-10-01 Sat +1m>
6278 the @code{+1m} is a repeater; the intended interpretation is that the task
6279 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6280 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
6281 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
6282 and a special warning period in a deadline entry, the repeater should come
6283 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6285 @vindex org-todo-repeat-to-state
6286 Deadlines and scheduled items produce entries in the agenda when they are
6287 over-due, so it is important to be able to mark such an entry as completed
6288 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
6289 keyword DONE, it will no longer produce entries in the agenda. The problem
6290 with this is, however, that then also the @emph{next} instance of the
6291 repeated entry will not be active. Org mode deals with this in the following
6292 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6293 shift the base date of the repeating timestamp by the repeater interval, and
6294 immediately set the entry state back to TODO@footnote{In fact, the target
6295 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6296 the variable @code{org-todo-repeat-to-state}. If neither of these is
6297 specified, the target state defaults to the first state of the TODO state
6298 sequence.}. In the example above, setting the state to DONE would actually
6299 switch the date like this:
6302 ** TODO Pay the rent
6303 DEADLINE: <2005-11-01 Tue +1m>
6306 To mark a task with a repeater as @code{DONE}, use @kbd{C-- 1 C-c C-t}
6307 (i.e., @code{org-todo} with a numeric prefix argument of -1.)
6309 @vindex org-log-repeat
6310 A timestamp@footnote{You can change this using the option
6311 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6312 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
6313 will also be prompted for a note.} will be added under the deadline, to keep
6314 a record that you actually acted on the previous instance of this deadline.
6316 As a consequence of shifting the base date, this entry will no longer be
6317 visible in the agenda when checking past dates, but all future instances
6320 With the @samp{+1m} cookie, the date shift will always be exactly one
6321 month. So if you have not paid the rent for three months, marking this
6322 entry DONE will still keep it as an overdue deadline. Depending on the
6323 task, this may not be the best way to handle it. For example, if you
6324 forgot to call your father for 3 weeks, it does not make sense to call
6325 him 3 times in a single day to make up for it. Finally, there are tasks
6326 like changing batteries which should always repeat a certain time
6327 @i{after} the last time you did it. For these tasks, Org mode has
6328 special repeaters @samp{++} and @samp{.+}. For example:
6332 DEADLINE: <2008-02-10 Sun ++1w>
6333 Marking this DONE will shift the date by at least one week,
6334 but also by as many weeks as it takes to get this date into
6335 the future. However, it stays on a Sunday, even if you called
6336 and marked it done on Saturday.
6337 ** TODO Check the batteries in the smoke detectors
6338 DEADLINE: <2005-11-01 Tue .+1m>
6339 Marking this DONE will shift the date to one month after
6343 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6344 You may have both scheduling and deadline information for a specific task.
6345 If the repeater is set for the scheduling information only, you probably want
6346 the repeater to be ignored after the deadline. If so, set the variable
6347 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6348 @code{repeated-after-deadline}. If you want both scheduling and deadline
6349 information to repeat after the same interval, set the same repeater for both
6352 An alternative to using a repeater is to create a number of copies of a task
6353 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6354 created for this purpose, it is described in @ref{Structure editing}.
6357 @node Clocking work time
6358 @section Clocking work time
6359 @cindex clocking time
6360 @cindex time clocking
6362 Org mode allows you to clock the time you spend on specific tasks in a
6363 project. When you start working on an item, you can start the clock. When
6364 you stop working on that task, or when you mark the task done, the clock is
6365 stopped and the corresponding time interval is recorded. It also computes
6366 the total time spent on each subtree@footnote{Clocking only works if all
6367 headings are indented with less than 30 stars. This is a hardcoded
6368 limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
6369 history or tasks recently clocked, so that you can jump quickly between a
6370 number of tasks absorbing your time.
6372 To save the clock history across Emacs sessions, use
6374 (setq org-clock-persist 'history)
6375 (org-clock-persistence-insinuate)
6377 When you clock into a new task after resuming Emacs, the incomplete
6378 clock@footnote{To resume the clock under the assumption that you have worked
6379 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6380 will be found (@pxref{Resolving idle time}) and you will be prompted about
6384 * Clocking commands:: Starting and stopping a clock
6385 * The clock table:: Detailed reports
6386 * Resolving idle time:: Resolving time when you've been idle
6389 @node Clocking commands
6390 @subsection Clocking commands
6393 @orgcmd{C-c C-x C-i,org-clock-in}
6394 @vindex org-clock-into-drawer
6395 @vindex org-clock-continuously
6396 @cindex property, LOG_INTO_DRAWER
6397 Start the clock on the current item (clock-in). This inserts the CLOCK
6398 keyword together with a timestamp. If this is not the first clocking of
6399 this item, the multiple CLOCK lines will be wrapped into a
6400 @code{:LOGBOOK:} drawer (see also the variable
6401 @code{org-clock-into-drawer}). You can also overrule
6402 the setting of this variable for a subtree by setting a
6403 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6404 When called with a @kbd{C-u} prefix argument,
6405 select the task from a list of recently clocked tasks. With two @kbd{C-u
6406 C-u} prefixes, clock into the task at point and mark it as the default task;
6407 the default task will then always be available with letter @kbd{d} when
6408 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6409 continuous clocking by starting the clock when the last clock stopped.@*
6410 @cindex property: CLOCK_MODELINE_TOTAL
6411 @cindex property: LAST_REPEAT
6412 @vindex org-clock-modeline-total
6413 While the clock is running, the current clocking time is shown in the mode
6414 line, along with the title of the task. The clock time shown will be all
6415 time ever clocked for this task and its children. If the task has an effort
6416 estimate (@pxref{Effort estimates}), the mode line displays the current
6417 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6418 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6419 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6420 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6421 will be shown. More control over what time is shown can be exercised with
6422 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6423 @code{current} to show only the current clocking instance, @code{today} to
6424 show all time clocked on this tasks today (see also the variable
6425 @code{org-extend-today-until}), @code{all} to include all time, or
6426 @code{auto} which is the default@footnote{See also the variable
6427 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6428 mode line entry will pop up a menu with clocking options.
6430 @orgcmd{C-c C-x C-o,org-clock-out}
6431 @vindex org-log-note-clock-out
6432 Stop the clock (clock-out). This inserts another timestamp at the same
6433 location where the clock was last started. It also directly computes
6434 the resulting time and inserts it after the time range as @samp{=>
6435 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6436 possibility to record an additional note together with the clock-out
6437 timestamp@footnote{The corresponding in-buffer setting is:
6438 @code{#+STARTUP: lognoteclock-out}}.
6439 @orgcmd{C-c C-x C-x,org-clock-in-last}
6440 @vindex org-clock-continuously
6441 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6442 select the task from the clock history. With two @kbd{C-u} prefixes,
6443 force continuous clocking by starting the clock when the last clock
6445 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6446 Update the effort estimate for the current clock task.
6449 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6450 Recompute the time interval after changing one of the timestamps. This
6451 is only necessary if you edit the timestamps directly. If you change
6452 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6453 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6454 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6455 clock duration keeps the same.
6456 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6457 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6458 the one of the previous (or the next clock) timestamp by the same duration.
6459 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6460 by five minutes, then the clocked-in timestamp of the next clock will be
6461 increased by five minutes.
6462 @orgcmd{C-c C-t,org-todo}
6463 Changing the TODO state of an item to DONE automatically stops the clock
6464 if it is running in this same item.
6465 @orgcmd{C-c C-x C-q,org-clock-cancel}
6466 Cancel the current clock. This is useful if a clock was started by
6467 mistake, or if you ended up working on something else.
6468 @orgcmd{C-c C-x C-j,org-clock-goto}
6469 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6470 prefix arg, select the target task from a list of recently clocked tasks.
6471 @orgcmd{C-c C-x C-d,org-clock-display}
6472 @vindex org-remove-highlights-with-change
6473 Display time summaries for each subtree in the current buffer. This puts
6474 overlays at the end of each headline, showing the total time recorded under
6475 that heading, including the time of any subheadings. You can use visibility
6476 cycling to study the tree, but the overlays disappear when you change the
6477 buffer (see variable @code{org-remove-highlights-with-change}) or press
6481 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6482 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6483 worked on or closed during a day.
6485 @strong{Important:} note that both @code{org-clock-out} and
6486 @code{org-clock-in-last} can have a global keybinding and will not
6487 modify the window disposition.
6489 @node The clock table
6490 @subsection The clock table
6491 @cindex clocktable, dynamic block
6492 @cindex report, of clocked time
6494 Org mode can produce quite complex reports based on the time clocking
6495 information. Such a report is called a @emph{clock table}, because it is
6496 formatted as one or several Org tables.
6499 @orgcmd{C-c C-x C-r,org-clock-report}
6500 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6501 report as an Org mode table into the current file. When the cursor is
6502 at an existing clock table, just update it. When called with a prefix
6503 argument, jump to the first clock report in the current document and
6504 update it. The clock table always includes also trees with
6505 @code{:ARCHIVE:} tag.
6506 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6507 Update dynamic block at point. The cursor needs to be in the
6508 @code{#+BEGIN} line of the dynamic block.
6509 @orgkey{C-u C-c C-x C-u}
6510 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6511 you have several clock table blocks in a buffer.
6512 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6513 Shift the current @code{:block} interval and update the table. The cursor
6514 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6515 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6519 Here is an example of the frame for a clock table as it is inserted into the
6520 buffer with the @kbd{C-c C-x C-r} command:
6522 @cindex #+BEGIN, clocktable
6524 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6528 @vindex org-clocktable-defaults
6529 The @samp{BEGIN} line specifies a number of options to define the scope,
6530 structure, and formatting of the report. Defaults for all these options can
6531 be configured in the variable @code{org-clocktable-defaults}.
6533 @noindent First there are options that determine which clock entries are to
6536 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6537 @r{Clocks at deeper levels will be summed into the upper level.}
6538 :scope @r{The scope to consider. This can be any of the following:}
6539 nil @r{the current buffer or narrowed region}
6540 file @r{the full current buffer}
6541 subtree @r{the subtree where the clocktable is located}
6542 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6543 tree @r{the surrounding level 1 tree}
6544 agenda @r{all agenda files}
6545 ("file"..) @r{scan these files}
6546 file-with-archives @r{current file and its archives}
6547 agenda-with-archives @r{all agenda files, including archives}
6548 :block @r{The time block to consider. This block is specified either}
6549 @r{absolutely, or relative to the current time and may be any of}
6551 2007-12-31 @r{New year eve 2007}
6552 2007-12 @r{December 2007}
6553 2007-W50 @r{ISO-week 50 in 2007}
6554 2007-Q2 @r{2nd quarter in 2007}
6555 2007 @r{the year 2007}
6556 today, yesterday, today-@var{N} @r{a relative day}
6557 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6558 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6559 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6560 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6561 :tstart @r{A time string specifying when to start considering times.}
6562 @r{Relative times like @code{"<-2w>"} can also be used. See}
6563 @r{@ref{Matching tags and properties} for relative time syntax.}
6564 :tend @r{A time string specifying when to stop considering times.}
6565 @r{Relative times like @code{"<now>"} can also be used. See}
6566 @r{@ref{Matching tags and properties} for relative time syntax.}
6567 :wstart @r{The starting day of the week. The default is 1 for monday.}
6568 :mstart @r{The starting day of the month. The default 1 is for the first}
6569 @r{day of the month.}
6570 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6571 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6572 :stepskip0 @r{Do not show steps that have zero time.}
6573 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6574 :tags @r{A tags match to select entries that should contribute. See}
6575 @r{@ref{Matching tags and properties} for the match syntax.}
6578 Then there are options which determine the formatting of the table. These
6579 options are interpreted by the function @code{org-clocktable-write-default},
6580 but you can specify your own function using the @code{:formatter} parameter.
6582 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6583 :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".}
6584 :link @r{Link the item headlines in the table to their origins.}
6585 :narrow @r{An integer to limit the width of the headline column in}
6586 @r{the org table. If you write it like @samp{50!}, then the}
6587 @r{headline will also be shortened in export.}
6588 :indent @r{Indent each headline field according to its level.}
6589 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6590 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6591 :level @r{Should a level number column be included?}
6592 :sort @r{A cons cell like containing the column to sort and a sorting type.}
6593 @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.}
6594 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6595 @r{All are overwritten except if there is an explicit @code{:narrow}}
6596 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6597 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6598 :properties @r{List of properties that should be shown in the table. Each}
6599 @r{property will get its own column.}
6600 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6601 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6602 @r{As a special case, @samp{:formula %} adds a column with % time.}
6603 @r{If you do not specify a formula here, any existing formula}
6604 @r{below the clock table will survive updates and be evaluated.}
6605 :formatter @r{A function to format clock data and insert it into the buffer.}
6607 To get a clock summary of the current level 1 tree, for the current
6608 day, you could write
6610 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6614 and to use a specific time range you could write@footnote{Note that all
6615 parameters must be specified in a single line---the line is broken here
6616 only to fit it into the manual.}
6618 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6619 :tend "<2006-08-10 Thu 12:00>"
6622 A range starting a week ago and ending right now could be written as
6624 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6627 A summary of the current subtree with % times would be
6629 #+BEGIN: clocktable :scope subtree :link t :formula %
6632 A horizontally compact representation of everything clocked during last week
6635 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6639 @node Resolving idle time
6640 @subsection Resolving idle time and continuous clocking
6642 @subsubheading Resolving idle time
6643 @cindex resolve idle time
6644 @vindex org-clock-x11idle-program-name
6646 @cindex idle, resolve, dangling
6647 If you clock in on a work item, and then walk away from your
6648 computer---perhaps to take a phone call---you often need to ``resolve'' the
6649 time you were away by either subtracting it from the current clock, or
6650 applying it to another one.
6652 @vindex org-clock-idle-time
6653 By customizing the variable @code{org-clock-idle-time} to some integer, such
6654 as 10 or 15, Emacs can alert you when you get back to your computer after
6655 being idle for that many minutes@footnote{On computers using Mac OS X,
6656 idleness is based on actual user idleness, not just Emacs' idle time. For
6657 X11, you can install a utility program @file{x11idle.c}, available in the
6658 @code{contrib/scripts} directory of the Org git distribution, or install the
6659 @file{xprintidle} package and set it to the variable
6660 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6661 same general treatment of idleness. On other systems, idle time refers to
6662 Emacs idle time only.}, and ask what you want to do with the idle time.
6663 There will be a question waiting for you when you get back, indicating how
6664 much idle time has passed (constantly updated with the current amount), as
6665 well as a set of choices to correct the discrepancy:
6669 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6670 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6671 effectively changing nothing, or enter a number to keep that many minutes.
6673 If you use the shift key and press @kbd{K}, it will keep however many minutes
6674 you request and then immediately clock out of that task. If you keep all of
6675 the minutes, this is the same as just clocking out of the current task.
6677 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6678 the clock, and then check back in from the moment you returned.
6680 To keep none of the minutes and just clock out at the start of the away time,
6681 use the shift key and press @kbd{S}. Remember that using shift will always
6682 leave you clocked out, no matter which option you choose.
6684 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6685 canceling you subtract the away time, and the resulting clock amount is less
6686 than a minute, the clock will still be canceled rather than clutter up the
6687 log with an empty entry.
6690 What if you subtracted those away minutes from the current clock, and now
6691 want to apply them to a new clock? Simply clock in to any task immediately
6692 after the subtraction. Org will notice that you have subtracted time ``on
6693 the books'', so to speak, and will ask if you want to apply those minutes to
6694 the next task you clock in on.
6696 There is one other instance when this clock resolution magic occurs. Say you
6697 were clocked in and hacking away, and suddenly your cat chased a mouse who
6698 scared a hamster that crashed into your UPS's power button! You suddenly
6699 lose all your buffers, but thanks to auto-save you still have your recent Org
6700 mode changes, including your last clock in.
6702 If you restart Emacs and clock into any task, Org will notice that you have a
6703 dangling clock which was never clocked out from your last session. Using
6704 that clock's starting time as the beginning of the unaccounted-for period,
6705 Org will ask how you want to resolve that time. The logic and behavior is
6706 identical to dealing with away time due to idleness; it is just happening due
6707 to a recovery event rather than a set amount of idle time.
6709 You can also check all the files visited by your Org agenda for dangling
6710 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6712 @subsubheading Continuous clocking
6713 @cindex continuous clocking
6714 @vindex org-clock-continuously
6716 You may want to start clocking from the time when you clocked out the
6717 previous task. To enable this systematically, set @code{org-clock-continuously}
6718 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6719 last clocked entry for this session, and start the new clock from there.
6721 If you only want this from time to time, use three universal prefix arguments
6722 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6724 @node Effort estimates
6725 @section Effort estimates
6726 @cindex effort estimates
6728 @cindex property, Effort
6729 @vindex org-effort-property
6730 If you want to plan your work in a very detailed way, or if you need to
6731 produce offers with quotations of the estimated work effort, you may want to
6732 assign effort estimates to entries. If you are also clocking your work, you
6733 may later want to compare the planned effort with the actual working time, a
6734 great way to improve planning estimates. Effort estimates are stored in a
6735 special property @samp{Effort}@footnote{You may change the property being
6736 used with the variable @code{org-effort-property}.}. You can set the effort
6737 for an entry with the following commands:
6740 @orgcmd{C-c C-x e,org-set-effort}
6741 Set the effort estimate for the current entry. With a numeric prefix
6742 argument, set it to the Nth allowed value (see below). This command is also
6743 accessible from the agenda with the @kbd{e} key.
6744 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6745 Modify the effort estimate of the item currently being clocked.
6748 Clearly the best way to work with effort estimates is through column view
6749 (@pxref{Column view}). You should start by setting up discrete values for
6750 effort estimates, and a @code{COLUMNS} format that displays these values
6751 together with clock sums (if you want to clock your time). For a specific
6755 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6756 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6760 @vindex org-global-properties
6761 @vindex org-columns-default-format
6762 or, even better, you can set up these values globally by customizing the
6763 variables @code{org-global-properties} and @code{org-columns-default-format}.
6764 In particular if you want to use this setup also in the agenda, a global
6765 setup may be advised.
6767 The way to assign estimates to individual items is then to switch to column
6768 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6769 value. The values you enter will immediately be summed up in the hierarchy.
6770 In the column next to it, any clocked time will be displayed.
6772 @vindex org-agenda-columns-add-appointments-to-effort-sum
6773 If you switch to column view in the daily/weekly agenda, the effort column
6774 will summarize the estimated work effort for each day@footnote{Please note
6775 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6776 column view}).}, and you can use this to find space in your schedule. To get
6777 an overview of the entire part of the day that is committed, you can set the
6778 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6779 appointments on a day that take place over a specified time interval will
6780 then also be added to the load estimate of the day.
6782 Effort estimates can be used in secondary agenda filtering that is triggered
6783 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6784 these estimates defined consistently, two or three key presses will narrow
6785 down the list to stuff that fits into an available time slot.
6787 @node Relative timer
6788 @section Taking notes with a relative timer
6789 @cindex relative timer
6791 When taking notes during, for example, a meeting or a video viewing, it can
6792 be useful to have access to times relative to a starting time. Org provides
6793 such a relative timer and make it easy to create timed notes.
6796 @orgcmd{C-c C-x .,org-timer}
6797 Insert a relative time into the buffer. The first time you use this, the
6798 timer will be started. When called with a prefix argument, the timer is
6800 @orgcmd{C-c C-x -,org-timer-item}
6801 Insert a description list item with the current relative time. With a prefix
6802 argument, first reset the timer to 0.
6803 @orgcmd{M-@key{RET},org-insert-heading}
6804 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6806 @c for key sequences with a comma, command name macros fail :(
6809 Pause the timer, or continue it if it is already paused
6810 (@command{org-timer-pause-or-continue}).
6811 @c removed the sentence because it is redundant to the following item
6812 @kindex C-u C-c C-x ,
6814 Stop the timer. After this, you can only start a new timer, not continue the
6815 old one. This command also removes the timer from the mode line.
6816 @orgcmd{C-c C-x 0,org-timer-start}
6817 Reset the timer without inserting anything into the buffer. By default, the
6818 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6819 specific starting offset. The user is prompted for the offset, with a
6820 default taken from a timer string at point, if any, So this can be used to
6821 restart taking notes after a break in the process. When called with a double
6822 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6823 by a certain amount. This can be used to fix timer strings if the timer was
6824 not started at exactly the right moment.
6827 @node Countdown timer
6828 @section Countdown timer
6829 @cindex Countdown timer
6833 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6834 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6836 @code{org-timer-set-timer} prompts the user for a duration and displays a
6837 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6838 default countdown value. Giving a prefix numeric argument overrides this
6841 @node Capture - Refile - Archive
6842 @chapter Capture - Refile - Archive
6845 An important part of any organization system is the ability to quickly
6846 capture new ideas and tasks, and to associate reference material with them.
6847 Org does this using a process called @i{capture}. It also can store files
6848 related to a task (@i{attachments}) in a special directory. Once in the
6849 system, tasks and projects need to be moved around. Moving completed project
6850 trees to an archive file keeps the system compact and fast.
6853 * Capture:: Capturing new stuff
6854 * Attachments:: Add files to tasks
6855 * RSS feeds:: Getting input from RSS feeds
6856 * Protocols:: External (e.g., Browser) access to Emacs and Org
6857 * Refile and copy:: Moving/copying a tree from one place to another
6858 * Archiving:: What to do with finished projects
6865 Capture lets you quickly store notes with little interruption of your work
6866 flow. Org's method for capturing new items is heavily inspired by John
6867 Wiegley excellent @file{remember.el} package. Up to version 6.36, Org
6868 used a special setup for @file{remember.el}, then replaced it with
6869 @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has
6870 been completely replaced by @file{org-capture.el}.
6872 If your configuration depends on @file{org-remember.el}, you need to update
6873 it and use the setup described below. To convert your
6874 @code{org-remember-templates}, run the command
6876 @kbd{M-x org-capture-import-remember-templates RET}
6878 @noindent and then customize the new variable with @kbd{M-x
6879 customize-variable org-capture-templates}, check the result, and save the
6883 * Setting up capture:: Where notes will be stored
6884 * Using capture:: Commands to invoke and terminate capture
6885 * Capture templates:: Define the outline of different note types
6888 @node Setting up capture
6889 @subsection Setting up capture
6891 The following customization sets a default target file for notes, and defines
6892 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6893 suggestion.} for capturing new material.
6895 @vindex org-default-notes-file
6898 (setq org-default-notes-file (concat org-directory "/notes.org"))
6899 (define-key global-map "\C-cc" 'org-capture)
6904 @subsection Using capture
6907 @orgcmd{C-c c,org-capture}
6908 Call the command @code{org-capture}. Note that this keybinding is global and
6909 not active by default: you need to install it. If you have templates
6911 defined @pxref{Capture templates}, it will offer these templates for
6912 selection or use a new Org outline node as the default template. It will
6913 insert the template into the target file and switch to an indirect buffer
6914 narrowed to this new node. You may then insert the information you want.
6916 @orgcmd{C-c C-c,org-capture-finalize}
6917 Once you have finished entering information into the capture buffer, @kbd{C-c
6918 C-c} will return you to the window configuration before the capture process,
6919 so that you can resume your work without further distraction. When called
6920 with a prefix arg, finalize and then jump to the captured item.
6922 @orgcmd{C-c C-w,org-capture-refile}
6923 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6924 a different place. Please realize that this is a normal refiling command
6925 that will be executed---so the cursor position at the moment you run this
6926 command is important. If you have inserted a tree with a parent and
6927 children, first move the cursor back to the parent. Any prefix argument
6928 given to this command will be passed on to the @code{org-refile} command.
6930 @orgcmd{C-c C-k,org-capture-kill}
6931 Abort the capture process and return to the previous state.
6935 You can also call @code{org-capture} in a special way from the agenda, using
6936 the @kbd{k c} key combination. With this access, any timestamps inserted by
6937 the selected capture template will default to the cursor date in the agenda,
6938 rather than to the current date.
6940 To find the locations of the last stored capture, use @code{org-capture} with
6945 Visit the target location of a capture template. You get to select the
6946 template in the usual way.
6947 @orgkey{C-u C-u C-c c}
6948 Visit the last stored capture item in its buffer.
6951 @vindex org-capture-bookmark
6952 @cindex org-capture-last-stored
6953 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6954 automatically be created unless you set @code{org-capture-bookmark} to
6957 To insert the capture at point in an Org buffer, call @code{org-capture} with
6958 a @code{C-0} prefix argument.
6960 @node Capture templates
6961 @subsection Capture templates
6962 @cindex templates, for Capture
6964 You can use templates for different types of capture items, and
6965 for different target locations. The easiest way to create such templates is
6966 through the customize interface.
6970 Customize the variable @code{org-capture-templates}.
6973 Before we give the formal description of template definitions, let's look at
6974 an example. Say you would like to use one template to create general TODO
6975 entries, and you want to put these entries under the heading @samp{Tasks} in
6976 your file @file{~/org/gtd.org}. Also, a date tree in the file
6977 @file{journal.org} should capture journal entries. A possible configuration
6982 (setq org-capture-templates
6983 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6984 "* TODO %?\n %i\n %a")
6985 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6986 "* %?\nEntered on %U\n %i\n %a")))
6990 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6994 [[file:@var{link to where you initiated capture}]]
6998 During expansion of the template, @code{%a} has been replaced by a link to
6999 the location from where you called the capture command. This can be
7000 extremely useful for deriving tasks from emails, for example. You fill in
7001 the task definition, press @kbd{C-c C-c} and Org returns you to the same
7002 place where you started the capture process.
7004 To define special keys to capture to a particular template without going
7005 through the interactive template selection, you can create your key binding
7009 (define-key global-map "\C-cx"
7010 (lambda () (interactive) (org-capture nil "x")))
7014 * Template elements:: What is needed for a complete template entry
7015 * Template expansion:: Filling in information about time and context
7016 * Templates in contexts:: Only show a template in a specific context
7019 @node Template elements
7020 @subsubsection Template elements
7022 Now lets look at the elements of a template definition. Each entry in
7023 @code{org-capture-templates} is a list with the following items:
7027 The keys that will select the template, as a string, characters
7028 only, for example @code{"a"} for a template to be selected with a
7029 single key, or @code{"bt"} for selection with two keys. When using
7030 several keys, keys using the same prefix key must be sequential
7031 in the list and preceded by a 2-element entry explaining the
7032 prefix key, for example
7034 ("b" "Templates for marking stuff to buy")
7036 @noindent If you do not define a template for the @kbd{C} key, this key will
7037 be used to open the customize buffer for this complex variable.
7040 A short string describing the template, which will be shown during
7044 The type of entry, a symbol. Valid values are:
7048 An Org mode node, with a headline. Will be filed as the child of the target
7049 entry or as a top-level entry. The target file should be an Org mode file.
7051 A plain list item, placed in the first plain list at the target
7052 location. Again the target file should be an Org file.
7054 A checkbox item. This only differs from the plain list item by the
7057 a new line in the first table at the target location. Where exactly the
7058 line will be inserted depends on the properties @code{:prepend} and
7059 @code{:table-line-pos} (see below).
7061 Text to be inserted as it is.
7065 @vindex org-default-notes-file
7066 Specification of where the captured item should be placed. In Org mode
7067 files, targets usually define a node. Entries will become children of this
7068 node. Other types will be added to the table or list in the body of this
7069 node. Most target specifications contain a file name. If that file name is
7070 the empty string, it defaults to @code{org-default-notes-file}. A file can
7071 also be given as a variable, function, or Emacs Lisp form.
7076 @item (file "path/to/file")
7077 Text will be placed at the beginning or end of that file.
7079 @item (id "id of existing org entry")
7080 Filing as child of this entry, or in the body of the entry.
7082 @item (file+headline "path/to/file" "node headline")
7083 Fast configuration if the target heading is unique in the file.
7085 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7086 For non-unique headings, the full path is safer.
7088 @item (file+regexp "path/to/file" "regexp to find location")
7089 Use a regular expression to position the cursor.
7091 @item (file+datetree "path/to/file")
7092 Will create a heading in a date tree for today's date@footnote{Datetree
7093 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7094 and @code{* 2013} in your file, the capture will refile the note to the first
7097 @item (file+datetree+prompt "path/to/file")
7098 Will create a heading in a date tree, but will prompt for the date.
7100 @item (file+function "path/to/file" function-finding-location)
7101 A function to find the right location in the file.
7104 File to the entry that is currently being clocked.
7106 @item (function function-finding-location)
7107 Most general way, write your own function to find both
7112 The template for creating the capture item. If you leave this empty, an
7113 appropriate default template will be used. Otherwise this is a string with
7114 escape codes, which will be replaced depending on time and context of the
7115 capture call. The string with escapes may be loaded from a template file,
7116 using the special syntax @code{(file "path/to/template")}. See below for
7120 The rest of the entry is a property list of additional options.
7121 Recognized properties are:
7125 Normally new captured information will be appended at
7126 the target location (last child, last table line, last list item...).
7127 Setting this property will change that.
7129 @item :immediate-finish
7130 When set, do not offer to edit the information, just
7131 file it away immediately. This makes sense if the template only needs
7132 information that can be added automatically.
7135 Set this to the number of lines to insert
7136 before and after the new item. Default 0, only common other value is 1.
7139 Start the clock in this item.
7142 Keep the clock running when filing the captured entry.
7145 If starting the capture interrupted a clock, restart that clock when finished
7146 with the capture. Note that @code{:clock-keep} has precedence over
7147 @code{:clock-resume}. When setting both to @code{t}, the current clock will
7148 run and the previous one will not be resumed.
7151 Do not narrow the target buffer, simply show the full buffer. Default is to
7152 narrow it so that you only see the new material.
7154 @item :table-line-pos
7155 Specification of the location in the table where the new line should be
7156 inserted. It can be a string, a variable holding a string or a function
7157 returning a string. The string should look like @code{"II-3"} meaning that
7158 the new line should become the third line before the second horizontal
7162 If the target file was not yet visited when capture was invoked, kill the
7163 buffer again after capture is completed.
7167 @node Template expansion
7168 @subsubsection Template expansion
7170 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7171 these sequences literally, escape the @kbd{%} with a backslash.} allow
7172 dynamic insertion of content. The templates are expanded in the order given here:
7175 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
7176 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
7177 @r{For convenience, %:keyword (see below) placeholders}
7178 @r{within the expression will be expanded prior to this.}
7179 @r{The sexp must return a string.}
7180 %<...> @r{The result of format-time-string on the ... format specification.}
7181 %t @r{Timestamp, date only.}
7182 %T @r{Timestamp, with date and time.}
7183 %u, %U @r{Like the above, but inactive timestamps.}
7184 %i @r{Initial content, the region when capture is called while the}
7185 @r{region is active.}
7186 @r{The entire text will be indented like @code{%i} itself.}
7187 %a @r{Annotation, normally the link created with @code{org-store-link}.}
7188 %A @r{Like @code{%a}, but prompt for the description part.}
7189 %l @r{Like %a, but only insert the literal link.}
7190 %c @r{Current kill ring head.}
7191 %x @r{Content of the X clipboard.}
7192 %k @r{Title of the currently clocked task.}
7193 %K @r{Link to the currently clocked task.}
7194 %n @r{User name (taken from @code{user-full-name}).}
7195 %f @r{File visited by current buffer when org-capture was called.}
7196 %F @r{Full path of the file or directory visited by current buffer.}
7197 %:keyword @r{Specific information for certain link types, see below.}
7198 %^g @r{Prompt for tags, with completion on tags in target file.}
7199 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
7200 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7201 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7202 %^C @r{Interactive selection of which kill or clip to use.}
7203 %^L @r{Like @code{%^C}, but insert as link.}
7204 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
7205 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
7206 @r{You may specify a default value and a completion table with}
7207 @r{%^@{prompt|default|completion2|completion3...@}.}
7208 @r{The arrow keys access a prompt-specific history.}
7209 %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7210 @r{a number, starting from 1.}
7211 %? @r{After completing the template, position cursor here.}
7215 For specific link types, the following keywords will be
7216 defined@footnote{If you define your own link types (@pxref{Adding
7217 hyperlink types}), any property you store with
7218 @code{org-store-link-props} can be accessed in capture templates in a
7221 @vindex org-from-is-user-regexp
7223 Link type | Available keywords
7224 ---------------------------------+----------------------------------------------
7225 bbdb | %:name %:company
7226 irc | %:server %:port %:nick
7227 vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
7228 | %:from %:fromname %:fromaddress
7229 | %:to %:toname %:toaddress
7230 | %:date @r{(message date header field)}
7231 | %:date-timestamp @r{(date as active timestamp)}
7232 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
7233 | %: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}.}}
7234 gnus | %:group, @r{for messages also all email fields}
7236 info | %:file %:node
7241 To place the cursor after template expansion use:
7244 %? @r{After completing the template, position cursor here.}
7247 @node Templates in contexts
7248 @subsubsection Templates in contexts
7250 @vindex org-capture-templates-contexts
7251 To control whether a capture template should be accessible from a specific
7252 context, you can customize @code{org-capture-templates-contexts}. Let's say
7253 for example that you have a capture template @code{"p"} for storing Gnus
7254 emails containing patches. Then you would configure this option like this:
7257 (setq org-capture-templates-contexts
7258 '(("p" (in-mode . "message-mode"))))
7261 You can also tell that the command key @code{"p"} should refer to another
7262 template. In that case, add this command key like this:
7265 (setq org-capture-templates-contexts
7266 '(("p" "q" (in-mode . "message-mode"))))
7269 See the docstring of the variable for more information.
7272 @section Attachments
7275 @vindex org-attach-directory
7276 It is often useful to associate reference material with an outline node/task.
7277 Small chunks of plain text can simply be stored in the subtree of a project.
7278 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7279 files that live elsewhere on your computer or in the cloud, like emails or
7280 source code files belonging to a project. Another method is @i{attachments},
7281 which are files located in a directory belonging to an outline node. Org
7282 uses directories named by the unique ID of each entry. These directories are
7283 located in the @file{data} directory which lives in the same directory where
7284 your Org file lives@footnote{If you move entries or Org files from one
7285 directory to another, you may want to configure @code{org-attach-directory}
7286 to contain an absolute path.}. If you initialize this directory with
7287 @code{git init}, Org will automatically commit changes when it sees them.
7288 The attachment system has been contributed to Org by John Wiegley.
7290 In cases where it seems better to do so, you can also attach a directory of your
7291 choice to an entry. You can also make children inherit the attachment
7292 directory from a parent, so that an entire subtree uses the same attached
7295 @noindent The following commands deal with attachments:
7298 @orgcmd{C-c C-a,org-attach}
7299 The dispatcher for commands related to the attachment system. After these
7300 keys, a list of commands is displayed and you must press an additional key
7301 to select a command:
7304 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7305 @vindex org-attach-method
7306 Select a file and move it into the task's attachment directory. The file
7307 will be copied, moved, or linked, depending on @code{org-attach-method}.
7308 Note that hard links are not supported on all systems.
7314 Attach a file using the copy/move/link method.
7315 Note that hard links are not supported on all systems.
7317 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7318 Create a new attachment as an Emacs buffer.
7320 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7321 Synchronize the current task with its attachment directory, in case you added
7322 attachments yourself.
7324 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7325 @vindex org-file-apps
7326 Open current task's attachment. If there is more than one, prompt for a
7327 file name first. Opening will follow the rules set by @code{org-file-apps}.
7328 For more details, see the information on following hyperlinks
7329 (@pxref{Handling links}).
7331 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7332 Also open the attachment, but force opening the file in Emacs.
7334 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7335 Open the current task's attachment directory.
7337 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7338 Also open the directory, but force using @command{dired} in Emacs.
7340 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7341 Select and delete a single attachment.
7343 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7344 Delete all of a task's attachments. A safer way is to open the directory in
7345 @command{dired} and delete from there.
7347 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7348 @cindex property, ATTACH_DIR
7349 Set a specific directory as the entry's attachment directory. This works by
7350 putting the directory path into the @code{ATTACH_DIR} property.
7352 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7353 @cindex property, ATTACH_DIR_INHERIT
7354 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7355 same directory for attachments as the parent does.
7364 Org can add and change entries based on information found in RSS feeds and
7365 Atom feeds. You could use this to make a task out of each new podcast in a
7366 podcast feed. Or you could use a phone-based note-creating service on the
7367 web to import tasks into Org. To access feeds, configure the variable
7368 @code{org-feed-alist}. The docstring of this variable has detailed
7369 information. Here is just an example:
7373 (setq org-feed-alist
7375 "http://rss.slashdot.org/Slashdot/slashdot"
7376 "~/txt/org/feeds.org" "Slashdot Entries")))
7381 will configure that new items from the feed provided by
7382 @code{rss.slashdot.org} will result in new entries in the file
7383 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7384 the following command is used:
7387 @orgcmd{C-c C-x g,org-feed-update-all}
7389 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7391 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7392 Prompt for a feed name and go to the inbox configured for this feed.
7395 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7396 it will store information about the status of items in the feed, to avoid
7397 adding the same item several times.
7399 For more information, including how to read atom feeds, see
7400 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7403 @section Protocols for external access
7404 @cindex protocols, for external access
7407 You can set up Org for handling protocol calls from outside applications that
7408 are passed to Emacs through the @file{emacsserver}. For example, you can
7409 configure bookmarks in your web browser to send a link to the current page to
7410 Org and create a note from it using capture (@pxref{Capture}). Or you
7411 could create a bookmark that will tell Emacs to open the local source file of
7412 a remote website you are looking at with the browser. See
7413 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7414 documentation and setup instructions.
7416 @node Refile and copy
7417 @section Refile and copy
7418 @cindex refiling notes
7419 @cindex copying notes
7421 When reviewing the captured data, you may want to refile or to copy some of
7422 the entries into a different list, for example into a project. Cutting,
7423 finding the right location, and then pasting the note is cumbersome. To
7424 simplify this process, you can use the following special command:
7427 @orgcmd{C-c M-w,org-copy}
7429 Copying works like refiling, except that the original note is not deleted.
7430 @orgcmd{C-c C-w,org-refile}
7432 @vindex org-reverse-note-order
7433 @vindex org-refile-targets
7434 @vindex org-refile-use-outline-path
7435 @vindex org-outline-path-complete-in-steps
7436 @vindex org-refile-allow-creating-parent-nodes
7437 @vindex org-log-refile
7438 @vindex org-refile-use-cache
7439 @vindex org-refile-keep
7440 Refile the entry or region at point. This command offers possible locations
7441 for refiling the entry and lets you select one with completion. The item (or
7442 all items in the region) is filed below the target heading as a subitem.
7443 Depending on @code{org-reverse-note-order}, it will be either the first or
7445 By default, all level 1 headlines in the current buffer are considered to be
7446 targets, but you can have more complex definitions across a number of files.
7447 See the variable @code{org-refile-targets} for details. If you would like to
7448 select a location via a file-path-like completion along the outline path, see
7449 the variables @code{org-refile-use-outline-path} and
7450 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7451 create new nodes as new parents for refiling on the fly, check the
7452 variable @code{org-refile-allow-creating-parent-nodes}.
7453 When the variable @code{org-log-refile}@footnote{with corresponding
7454 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7455 and @code{nologrefile}} is set, a timestamp or a note will be
7456 recorded when an entry has been refiled.
7457 @orgkey{C-u C-c C-w}
7458 Use the refile interface to jump to a heading.
7459 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7460 Jump to the location where @code{org-refile} last moved a tree to.
7462 Refile as the child of the item currently being clocked.
7464 Refile and keep the entry in place. Also see @code{org-refile-keep} to make
7465 this the default behavior, and beware that this may result in duplicated
7466 @code{ID} properties.
7467 @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}
7468 Clear the target cache. Caching of refile targets can be turned on by
7469 setting @code{org-refile-use-cache}. To make the command see new possible
7470 targets, you have to clear the cache with this command.
7477 When a project represented by a (sub)tree is finished, you may want
7478 to move the tree out of the way and to stop it from contributing to the
7479 agenda. Archiving is important to keep your working files compact and global
7480 searches like the construction of agenda views fast.
7483 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7484 @vindex org-archive-default-command
7485 Archive the current entry using the command specified in the variable
7486 @code{org-archive-default-command}.
7490 * Moving subtrees:: Moving a tree to an archive file
7491 * Internal archiving:: Switch off a tree but keep it in the file
7494 @node Moving subtrees
7495 @subsection Moving a tree to the archive file
7496 @cindex external archiving
7498 The most common archiving action is to move a project tree to another file,
7502 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7503 @vindex org-archive-location
7504 Archive the subtree starting at the cursor position to the location
7505 given by @code{org-archive-location}.
7506 @orgkey{C-u C-c C-x C-s}
7507 Check if any direct children of the current headline could be moved to
7508 the archive. To do this, each subtree is checked for open TODO entries.
7509 If none are found, the command offers to move it to the archive
7510 location. If the cursor is @emph{not} on a headline when this command
7511 is invoked, the level 1 trees will be checked.
7514 @cindex archive locations
7515 The default archive location is a file in the same directory as the
7516 current file, with the name derived by appending @file{_archive} to the
7517 current file name. You can also choose what heading to file archived
7518 items under, with the possibility to add them to a datetree in a file.
7519 For information and examples on how to specify the file and the heading,
7520 see the documentation string of the variable
7521 @code{org-archive-location}.
7523 There is also an in-buffer option for setting this variable, for
7524 example@footnote{For backward compatibility, the following also works:
7525 If there are several such lines in a file, each specifies the archive
7526 location for the text below it. The first such line also applies to any
7527 text before its definition. However, using this method is
7528 @emph{strongly} deprecated as it is incompatible with the outline
7529 structure of the document. The correct method for setting multiple
7530 archive locations in a buffer is using properties.}:
7534 #+ARCHIVE: %s_done::
7537 @cindex property, ARCHIVE
7539 If you would like to have a special ARCHIVE location for a single entry
7540 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7541 location as the value (@pxref{Properties and columns}).
7543 @vindex org-archive-save-context-info
7544 When a subtree is moved, it receives a number of special properties that
7545 record context information like the file from where the entry came, its
7546 outline path the archiving time etc. Configure the variable
7547 @code{org-archive-save-context-info} to adjust the amount of information
7551 @node Internal archiving
7552 @subsection Internal archiving
7554 If you want to just switch off (for agenda views) certain subtrees without
7555 moving them to a different file, you can use the @code{ARCHIVE tag}.
7557 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7558 its location in the outline tree, but behaves in the following way:
7561 @vindex org-cycle-open-archived-trees
7562 It does not open when you attempt to do so with a visibility cycling
7563 command (@pxref{Visibility cycling}). You can force cycling archived
7564 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7565 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7566 @code{show-all} will open archived subtrees.
7568 @vindex org-sparse-tree-open-archived-trees
7569 During sparse tree construction (@pxref{Sparse trees}), matches in
7570 archived subtrees are not exposed, unless you configure the option
7571 @code{org-sparse-tree-open-archived-trees}.
7573 @vindex org-agenda-skip-archived-trees
7574 During agenda view construction (@pxref{Agenda views}), the content of
7575 archived trees is ignored unless you configure the option
7576 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7577 be included. In the agenda you can press @kbd{v a} to get archives
7578 temporarily included.
7580 @vindex org-export-with-archived-trees
7581 Archived trees are not exported (@pxref{Exporting}), only the headline
7582 is. Configure the details using the variable
7583 @code{org-export-with-archived-trees}.
7585 @vindex org-columns-skip-archived-trees
7586 Archived trees are excluded from column view unless the variable
7587 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7590 The following commands help manage the ARCHIVE tag:
7593 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7594 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7595 the headline changes to a shadowed face, and the subtree below it is
7597 @orgkey{C-u C-c C-x a}
7598 Check if any direct children of the current headline should be archived.
7599 To do this, each subtree is checked for open TODO entries. If none are
7600 found, the command offers to set the ARCHIVE tag for the child. If the
7601 cursor is @emph{not} on a headline when this command is invoked, the
7602 level 1 trees will be checked.
7603 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7604 Cycle a tree even if it is tagged with ARCHIVE.
7605 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7606 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7607 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7608 entry becomes a child of that sibling and in this way retains a lot of its
7609 original context, including inherited tags and approximate position in the
7615 @chapter Agenda views
7616 @cindex agenda views
7618 Due to the way Org works, TODO items, time-stamped items, and
7619 tagged headlines can be scattered throughout a file or even a number of
7620 files. To get an overview of open action items, or of events that are
7621 important for a particular date, this information must be collected,
7622 sorted and displayed in an organized way.
7624 Org can select items based on various criteria and display them
7625 in a separate buffer. Seven different view types are provided:
7629 an @emph{agenda} that is like a calendar and shows information
7632 a @emph{TODO list} that covers all unfinished
7635 a @emph{match view}, showings headlines based on the tags, properties, and
7636 TODO state associated with them,
7638 a @emph{timeline view} that shows all events in a single Org file,
7639 in time-sorted view,
7641 a @emph{text search view} that shows all entries from multiple files
7642 that contain specified keywords,
7644 a @emph{stuck projects view} showing projects that currently don't move
7647 @emph{custom views} that are special searches and combinations of different
7652 The extracted information is displayed in a special @emph{agenda
7653 buffer}. This buffer is read-only, but provides commands to visit the
7654 corresponding locations in the original Org files, and even to
7655 edit these files remotely.
7657 @vindex org-agenda-window-setup
7658 @vindex org-agenda-restore-windows-after-quit
7659 Two variables control how the agenda buffer is displayed and whether the
7660 window configuration is restored when the agenda exits:
7661 @code{org-agenda-window-setup} and
7662 @code{org-agenda-restore-windows-after-quit}.
7665 * Agenda files:: Files being searched for agenda information
7666 * Agenda dispatcher:: Keyboard access to agenda views
7667 * Built-in agenda views:: What is available out of the box?
7668 * Presentation and sorting:: How agenda items are prepared for display
7669 * Agenda commands:: Remote editing of Org trees
7670 * Custom agenda views:: Defining special searches and views
7671 * Exporting agenda views:: Writing a view to a file
7672 * Agenda column view:: Using column view for collected entries
7676 @section Agenda files
7677 @cindex agenda files
7678 @cindex files for agenda
7680 @vindex org-agenda-files
7681 The information to be shown is normally collected from all @emph{agenda
7682 files}, the files listed in the variable
7683 @code{org-agenda-files}@footnote{If the value of that variable is not a
7684 list, but a single file name, then the list of agenda files will be
7685 maintained in that external file.}. If a directory is part of this list,
7686 all files with the extension @file{.org} in this directory will be part
7689 Thus, even if you only work with a single Org file, that file should
7690 be put into the list@footnote{When using the dispatcher, pressing
7691 @kbd{<} before selecting a command will actually limit the command to
7692 the current file, and ignore @code{org-agenda-files} until the next
7693 dispatcher command.}. You can customize @code{org-agenda-files}, but
7694 the easiest way to maintain it is through the following commands
7696 @cindex files, adding to agenda list
7698 @orgcmd{C-c [,org-agenda-file-to-front}
7699 Add current file to the list of agenda files. The file is added to
7700 the front of the list. If it was already in the list, it is moved to
7701 the front. With a prefix argument, file is added/moved to the end.
7702 @orgcmd{C-c ],org-remove-file}
7703 Remove current file from the list of agenda files.
7705 @cindex cycling, of agenda files
7706 @orgcmd{C-',org-cycle-agenda-files}
7708 Cycle through agenda file list, visiting one file after the other.
7709 @kindex M-x org-iswitchb
7710 @item M-x org-iswitchb RET
7711 Command to use an @code{iswitchb}-like interface to switch to and between Org
7716 The Org menu contains the current list of files and can be used
7717 to visit any of them.
7719 If you would like to focus the agenda temporarily on a file not in
7720 this list, or on just one file in the list, or even on only a subtree in a
7721 file, then this can be done in different ways. For a single agenda command,
7722 you may press @kbd{<} once or several times in the dispatcher
7723 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7724 extended period, use the following commands:
7727 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7728 Permanently restrict the agenda to the current subtree. When with a
7729 prefix argument, or with the cursor before the first headline in a file,
7730 the agenda scope is set to the entire file. This restriction remains in
7731 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7732 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7733 agenda view, the new restriction takes effect immediately.
7734 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7735 Remove the permanent restriction created by @kbd{C-c C-x <}.
7739 When working with @file{speedbar.el}, you can use the following commands in
7743 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7744 Permanently restrict the agenda to the item---either an Org file or a subtree
7745 in such a file---at the cursor in the Speedbar frame.
7746 If there is a window displaying an agenda view, the new restriction takes
7748 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7749 Lift the restriction.
7752 @node Agenda dispatcher
7753 @section The agenda dispatcher
7754 @cindex agenda dispatcher
7755 @cindex dispatching agenda commands
7756 The views are created through a dispatcher, which should be bound to a
7757 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7758 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7759 is accessed and list keyboard access to commands accordingly. After
7760 pressing @kbd{C-c a}, an additional letter is required to execute a
7761 command. The dispatcher offers the following default commands:
7765 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7767 Create a list of all TODO items (@pxref{Global TODO list}).
7769 Create a list of headlines matching a TAGS expression (@pxref{Matching
7770 tags and properties}).
7772 Create the timeline view for the current buffer (@pxref{Timeline}).
7774 Create a list of entries selected by a boolean expression of keywords
7775 and/or regular expressions that must or must not occur in the entry.
7777 @vindex org-agenda-text-search-extra-files
7778 Search for a regular expression in all agenda files and additionally in
7779 the files listed in @code{org-agenda-text-search-extra-files}. This
7780 uses the Emacs command @code{multi-occur}. A prefix argument can be
7781 used to specify the number of context lines for each match, default is
7784 Create a list of stuck projects (@pxref{Stuck projects}).
7786 Restrict an agenda command to the current buffer@footnote{For backward
7787 compatibility, you can also press @kbd{1} to restrict to the current
7788 buffer.}. After pressing @kbd{<}, you still need to press the character
7789 selecting the command.
7791 If there is an active region, restrict the following agenda command to
7792 the region. Otherwise, restrict it to the current subtree@footnote{For
7793 backward compatibility, you can also press @kbd{0} to restrict to the
7794 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7795 character selecting the command.
7798 @cindex agenda, sticky
7799 @vindex org-agenda-sticky
7800 Toggle sticky agenda views. By default, Org maintains only a single agenda
7801 buffer and rebuilds it each time you change the view, to make sure everything
7802 is always up to date. If you often switch between agenda views and the build
7803 time bothers you, you can turn on sticky agenda buffers or make this the
7804 default by customizing the variable @code{org-agenda-sticky}. With sticky
7805 agendas, the agenda dispatcher will not recreate agenda views from scratch,
7806 it will only switch to the selected one, and you need to update the agenda by
7807 hand with @kbd{r} or @kbd{g} when needed. You can toggle sticky agenda view
7808 any time with @code{org-toggle-sticky-agenda}.
7811 You can also define custom commands that will be accessible through the
7812 dispatcher, just like the default commands. This includes the
7813 possibility to create extended agenda buffers that contain several
7814 blocks together, for example the weekly agenda, the global TODO list and
7815 a number of special tags matches. @xref{Custom agenda views}.
7817 @node Built-in agenda views
7818 @section The built-in agenda views
7820 In this section we describe the built-in views.
7823 * Weekly/daily agenda:: The calendar page with current tasks
7824 * Global TODO list:: All unfinished action items
7825 * Matching tags and properties:: Structured information with fine-tuned search
7826 * Timeline:: Time-sorted view for single file
7827 * Search view:: Find entries by searching for text
7828 * Stuck projects:: Find projects you need to review
7831 @node Weekly/daily agenda
7832 @subsection The weekly/daily agenda
7834 @cindex weekly agenda
7835 @cindex daily agenda
7837 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7838 paper agenda, showing all the tasks for the current week or day.
7841 @cindex org-agenda, command
7842 @orgcmd{C-c a a,org-agenda-list}
7843 Compile an agenda for the current week from a list of Org files. The agenda
7844 shows the entries for each day. With a numeric prefix@footnote{For backward
7845 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7846 listed before the agenda. This feature is deprecated, use the dedicated TODO
7847 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7848 C-c a a}) you may set the number of days to be displayed.
7851 @vindex org-agenda-span
7852 @vindex org-agenda-ndays
7853 @vindex org-agenda-start-day
7854 @vindex org-agenda-start-on-weekday
7855 The default number of days displayed in the agenda is set by the variable
7856 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7857 variable can be set to any number of days you want to see by default in the
7858 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7859 @code{year}. For weekly agendas, the default is to start on the previous
7860 monday (see @code{org-agenda-start-on-weekday}). You can also set the start
7861 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7862 start the agenda ten days from today in the future.
7864 Remote editing from the agenda buffer means, for example, that you can
7865 change the dates of deadlines and appointments from the agenda buffer.
7866 The commands available in the Agenda buffer are listed in @ref{Agenda
7869 @subsubheading Calendar/Diary integration
7870 @cindex calendar integration
7871 @cindex diary integration
7873 Emacs contains the calendar and diary by Edward M. Reingold. The
7874 calendar displays a three-month calendar with holidays from different
7875 countries and cultures. The diary allows you to keep track of
7876 anniversaries, lunar phases, sunrise/set, recurrent appointments
7877 (weekly, monthly) and more. In this way, it is quite complementary to
7878 Org. It can be very useful to combine output from Org with
7881 In order to include entries from the Emacs diary into Org mode's
7882 agenda, you only need to customize the variable
7885 (setq org-agenda-include-diary t)
7888 @noindent After that, everything will happen automatically. All diary
7889 entries including holidays, anniversaries, etc., will be included in the
7890 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7891 @key{RET} can be used from the agenda buffer to jump to the diary
7892 file in order to edit existing diary entries. The @kbd{i} command to
7893 insert new entries for the current date works in the agenda buffer, as
7894 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7895 Sunrise/Sunset times, show lunar phases and to convert to other
7896 calendars, respectively. @kbd{c} can be used to switch back and forth
7897 between calendar and agenda.
7899 If you are using the diary only for sexp entries and holidays, it is
7900 faster to not use the above setting, but instead to copy or even move
7901 the entries into an Org file. Org mode evaluates diary-style sexp
7902 entries, and does it faster because there is no overhead for first
7903 creating the diary display. Note that the sexp entries must start at
7904 the left margin, no whitespace is allowed before them. For example,
7905 the following segment of an Org file will be processed and entries
7906 will be made in the agenda:
7909 * Birthdays and similar stuff
7911 %%(org-calendar-holiday) ; special function for holiday names
7913 %%(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
7914 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7917 @subsubheading Anniversaries from BBDB
7918 @cindex BBDB, anniversaries
7919 @cindex anniversaries, from BBDB
7921 If you are using the Big Brothers Database to store your contacts, you will
7922 very likely prefer to store anniversaries in BBDB rather than in a
7923 separate Org or diary file. Org supports this and will show BBDB
7924 anniversaries as part of the agenda. All you need to do is to add the
7925 following to one of your agenda files:
7932 %%(org-bbdb-anniversaries)
7935 You can then go ahead and define anniversaries for a BBDB record. Basically,
7936 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7937 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7938 followed by a space and the class of the anniversary (@samp{birthday} or
7939 @samp{wedding}, or a format string). If you omit the class, it will default to
7940 @samp{birthday}. Here are a few examples, the header for the file
7941 @file{org-bbdb.el} contains more detailed information.
7947 2008-04-14 %s released version 6.01 of org mode, %d years ago
7950 After a change to BBDB, or for the first agenda display during an Emacs
7951 session, the agenda display will suffer a short delay as Org updates its
7952 hash with anniversaries. However, from then on things will be very fast---much
7953 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7954 in an Org or Diary file.
7956 @subsubheading Appointment reminders
7957 @cindex @file{appt.el}
7958 @cindex appointment reminders
7962 Org can interact with Emacs appointments notification facility. To add the
7963 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7964 This command lets you filter through the list of your appointments and add
7965 only those belonging to a specific category or matching a regular expression.
7966 It also reads a @code{APPT_WARNTIME} property which will then override the
7967 value of @code{appt-message-warning-time} for this appointment. See the
7968 docstring for details.
7970 @node Global TODO list
7971 @subsection The global TODO list
7972 @cindex global TODO list
7973 @cindex TODO list, global
7975 The global TODO list contains all unfinished TODO items formatted and
7976 collected into a single place.
7979 @orgcmd{C-c a t,org-todo-list}
7980 Show the global TODO list. This collects the TODO items from all agenda
7981 files (@pxref{Agenda views}) into a single buffer. By default, this lists
7982 items with a state the is not a DONE state. The buffer is in
7983 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7984 entries directly from that buffer (@pxref{Agenda commands}).
7985 @orgcmd{C-c a T,org-todo-list}
7986 @cindex TODO keyword matching
7987 @vindex org-todo-keywords
7988 Like the above, but allows selection of a specific TODO keyword. You can
7989 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7990 prompted for a keyword, and you may also specify several keywords by
7991 separating them with @samp{|} as the boolean OR operator. With a numeric
7992 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7994 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7995 a prefix argument to this command to change the selected TODO keyword,
7996 for example @kbd{3 r}. If you often need a search for a specific
7997 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7998 Matching specific TODO keywords can also be done as part of a tags
7999 search (@pxref{Tag searches}).
8002 Remote editing of TODO items means that you can change the state of a
8003 TODO entry with a single key press. The commands available in the
8004 TODO list are described in @ref{Agenda commands}.
8006 @cindex sublevels, inclusion into TODO list
8007 Normally the global TODO list simply shows all headlines with TODO
8008 keywords. This list can become very long. There are two ways to keep
8012 @vindex org-agenda-todo-ignore-scheduled
8013 @vindex org-agenda-todo-ignore-deadlines
8014 @vindex org-agenda-todo-ignore-timestamp
8015 @vindex org-agenda-todo-ignore-with-date
8016 Some people view a TODO item that has been @emph{scheduled} for execution or
8017 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
8018 Configure the variables @code{org-agenda-todo-ignore-scheduled},
8019 @code{org-agenda-todo-ignore-deadlines},
8020 @code{org-agenda-todo-ignore-timestamp} and/or
8021 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
8024 @vindex org-agenda-todo-list-sublevels
8025 TODO items may have sublevels to break up the task into subtasks. In
8026 such cases it may be enough to list only the highest level TODO headline
8027 and omit the sublevels from the global list. Configure the variable
8028 @code{org-agenda-todo-list-sublevels} to get this behavior.
8031 @node Matching tags and properties
8032 @subsection Matching tags and properties
8033 @cindex matching, of tags
8034 @cindex matching, of properties
8038 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
8039 or have properties (@pxref{Properties and columns}), you can select headlines
8040 based on this metadata and collect them into an agenda buffer. The match
8041 syntax described here also applies when creating sparse trees with @kbd{C-c /
8045 @orgcmd{C-c a m,org-tags-view}
8046 Produce a list of all headlines that match a given set of tags. The
8047 command prompts for a selection criterion, which is a boolean logic
8048 expression with tags, like @samp{+work+urgent-withboss} or
8049 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
8050 define a custom command for it (@pxref{Agenda dispatcher}).
8051 @orgcmd{C-c a M,org-tags-view}
8052 @vindex org-tags-match-list-sublevels
8053 @vindex org-agenda-tags-todo-honor-ignore-options
8054 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
8055 not-DONE state and force checking subitems (see variable
8056 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
8057 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
8058 specific TODO keywords together with a tags match is also possible, see
8062 The commands available in the tags list are described in @ref{Agenda
8065 @subsubheading Match syntax
8067 @cindex Boolean logic, for tag/property searches
8068 A search string can use Boolean operators @samp{&} for @code{AND} and
8069 @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}.
8070 Parentheses are not implemented. Each element in the search is either a
8071 tag, a regular expression matching tags, or an expression like
8072 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8073 property value. Each element may be preceded by @samp{-}, to select
8074 against it, and @samp{+} is syntactic sugar for positive selection. The
8075 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8076 present. Here are some examples, using only tags.
8080 Select headlines tagged @samp{:work:}.
8082 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8084 Select headlines tagged @samp{:work:}, but discard those also tagged
8087 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8088 @item work|laptop+night
8089 Like before, but require the @samp{:laptop:} lines to be tagged also
8093 @cindex regular expressions, with tags search
8094 Instead of a tag, you may also specify a regular expression enclosed in curly
8095 braces. For example,
8096 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8097 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8099 @cindex group tags, as regular expressions
8100 Group tags (@pxref{Tag groups}) are expanded as regular expressions. E.g.,
8101 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8102 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8103 and searching for @samp{-work} will search for all headlines but those with
8104 one of the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8106 @cindex TODO keyword matching, with tags search
8107 @cindex level, require for tags/property match
8108 @cindex category, require for tags/property match
8109 @vindex org-odd-levels-only
8110 You may also test for properties (@pxref{Properties and columns}) at the same
8111 time as matching tags. The properties may be real properties, or special
8112 properties that represent other metadata (@pxref{Special properties}). For
8113 example, the ``property'' @code{TODO} represents the TODO keyword of the
8114 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8115 the entry. The ITEM special property cannot currently be used in tags/property
8116 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
8117 ,skipping entries based on regexp}.}.
8119 In addition to the @pxref{Special properties}, one other ``property'' can
8120 also be used. @code{LEVEL} represents the level of an entry. So a search
8121 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8122 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8123 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8124 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8126 Here are more examples:
8129 @item work+TODO="WAITING"
8130 Select @samp{:work:}-tagged TODO lines with the specific TODO
8131 keyword @samp{WAITING}.
8132 @item work+TODO="WAITING"|home+TODO="WAITING"
8133 Waiting tasks both at work and at home.
8136 When matching properties, a number of different operators can be used to test
8137 the value of a property. Here is a complex example:
8140 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
8141 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8145 The type of comparison will depend on how the comparison value is written:
8148 If the comparison value is a plain number, a numerical comparison is done,
8149 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8150 @samp{>=}, and @samp{<>}.
8152 If the comparison value is enclosed in double-quotes,
8153 a string comparison is done, and the same operators are allowed.
8155 If the comparison value is enclosed in double-quotes @emph{and} angular
8156 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8157 assumed to be date/time specifications in the standard Org way, and the
8158 comparison will be done accordingly. Special values that will be recognized
8159 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8160 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8161 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8162 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8163 respectively, can be used.
8165 If the comparison value is enclosed
8166 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8167 regexp matches the property value, and @samp{<>} meaning that it does not
8171 So the search string in the example finds entries tagged @samp{:work:} but
8172 not @samp{:boss:}, which also have a priority value @samp{A}, a
8173 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8174 property that is numerically smaller than 2, a @samp{:With:} property that is
8175 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8176 on or after October 11, 2008.
8178 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
8179 other properties will slow down the search. However, once you have paid the
8180 price by accessing one property, testing additional properties is cheap
8183 You can configure Org mode to use property inheritance during a search, but
8184 beware that this can slow down searches considerably. See @ref{Property
8185 inheritance}, for details.
8187 For backward compatibility, and also for typing speed, there is also a
8188 different way to test TODO states in a search. For this, terminate the
8189 tags/property part of the search string (which may include several terms
8190 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8191 expression just for TODO keywords. The syntax is then similar to that for
8192 tags, but should be applied with care: for example, a positive selection on
8193 several TODO keywords cannot meaningfully be combined with boolean AND@.
8194 However, @emph{negative selection} combined with AND can be meaningful. To
8195 make sure that only lines are checked that actually have any TODO keyword
8196 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8197 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
8198 not match TODO keywords in a DONE state. Examples:
8202 Same as @samp{work+TODO="WAITING"}
8203 @item work/!-WAITING-NEXT
8204 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8206 @item work/!+WAITING|+NEXT
8207 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8212 @subsection Timeline for a single file
8213 @cindex timeline, single file
8214 @cindex time-sorted view
8216 The timeline summarizes all time-stamped items from a single Org mode
8217 file in a @emph{time-sorted view}. The main purpose of this command is
8218 to give an overview over events in a project.
8221 @orgcmd{C-c a L,org-timeline}
8222 Show a time-sorted view of the Org file, with all time-stamped items.
8223 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8224 (scheduled or not) are also listed under the current date.
8228 The commands available in the timeline buffer are listed in
8229 @ref{Agenda commands}.
8232 @subsection Search view
8235 @cindex searching, for text
8237 This agenda view is a general text search facility for Org mode entries.
8238 It is particularly useful to find notes.
8241 @orgcmd{C-c a s,org-search-view}
8242 This is a special search that lets you select entries by matching a substring
8243 or specific words using a boolean logic.
8245 For example, the search string @samp{computer equipment} will find entries
8246 that contain @samp{computer equipment} as a substring. If the two words are
8247 separated by more space or a line break, the search will still match.
8248 Search view can also search for specific keywords in the entry, using Boolean
8249 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8250 will search for note entries that contain the keywords @code{computer}
8251 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8252 not matched by the regular expression @code{8\.11[bg]}, meaning to
8253 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
8254 word search, other @samp{+} characters are optional. For more details, see
8255 the docstring of the command @code{org-search-view}.
8257 @vindex org-agenda-text-search-extra-files
8258 Note that in addition to the agenda files, this command will also search
8259 the files listed in @code{org-agenda-text-search-extra-files}.
8261 @node Stuck projects
8262 @subsection Stuck projects
8263 @pindex GTD, Getting Things Done
8265 If you are following a system like David Allen's GTD to organize your
8266 work, one of the ``duties'' you have is a regular review to make sure
8267 that all projects move along. A @emph{stuck} project is a project that
8268 has no defined next actions, so it will never show up in the TODO lists
8269 Org mode produces. During the review, you need to identify such
8270 projects and define next actions for them.
8273 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8274 List projects that are stuck.
8277 @vindex org-stuck-projects
8278 Customize the variable @code{org-stuck-projects} to define what a stuck
8279 project is and how to find it.
8282 You almost certainly will have to configure this view before it will
8283 work for you. The built-in default assumes that all your projects are
8284 level-2 headlines, and that a project is not stuck if it has at least
8285 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8287 Let's assume that you, in your own way of using Org mode, identify
8288 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8289 indicate a project that should not be considered yet. Let's further
8290 assume that the TODO keyword DONE marks finished projects, and that NEXT
8291 and TODO indicate next actions. The tag @@SHOP indicates shopping and
8292 is a next action even without the NEXT tag. Finally, if the project
8293 contains the special word IGNORE anywhere, it should not be listed
8294 either. In this case you would start by identifying eligible projects
8295 with a tags/todo match@footnote{@xref{Tag searches}.}
8296 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8297 IGNORE in the subtree to identify projects that are not stuck. The
8298 correct customization for this is
8301 (setq org-stuck-projects
8302 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8306 Note that if a project is identified as non-stuck, the subtree of this entry
8307 will still be searched for stuck projects.
8309 @node Presentation and sorting
8310 @section Presentation and sorting
8311 @cindex presentation, of agenda items
8313 @vindex org-agenda-prefix-format
8314 @vindex org-agenda-tags-column
8315 Before displaying items in an agenda view, Org mode visually prepares the
8316 items and sorts them. Each item occupies a single line. The line starts
8317 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8318 of the item and other important information. You can customize in which
8319 column tags will be displayed through @code{org-agenda-tags-column}. You can
8320 also customize the prefix using the option @code{org-agenda-prefix-format}.
8321 This prefix is followed by a cleaned-up version of the outline headline
8322 associated with the item.
8325 * Categories:: Not all tasks are equal
8326 * Time-of-day specifications:: How the agenda knows the time
8327 * Sorting agenda items:: The order of things
8328 * Filtering/limiting agenda items:: Dynamically narrow the agenda
8332 @subsection Categories
8336 The category is a broad label assigned to each agenda item. By default,
8337 the category is simply derived from the file name, but you can also
8338 specify it with a special line in the buffer, like this@footnote{For
8339 backward compatibility, the following also works: if there are several
8340 such lines in a file, each specifies the category for the text below it.
8341 The first category also applies to any text before the first CATEGORY
8342 line. However, using this method is @emph{strongly} deprecated as it is
8343 incompatible with the outline structure of the document. The correct
8344 method for setting multiple categories in a buffer is using a
8352 @cindex property, CATEGORY
8353 If you would like to have a special CATEGORY for a single entry or a
8354 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8355 special category you want to apply as the value.
8358 The display in the agenda buffer looks best if the category is not
8359 longer than 10 characters.
8362 You can set up icons for category by customizing the
8363 @code{org-agenda-category-icon-alist} variable.
8365 @node Time-of-day specifications
8366 @subsection Time-of-day specifications
8367 @cindex time-of-day specification
8369 Org mode checks each agenda item for a time-of-day specification. The
8370 time can be part of the timestamp that triggered inclusion into the
8371 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8372 ranges can be specified with two timestamps, like
8374 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8376 In the headline of the entry itself, a time(range) may also appear as
8377 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8378 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8379 specifications in diary entries are recognized as well.
8381 For agenda display, Org mode extracts the time and displays it in a
8382 standard 24 hour format as part of the prefix. The example times in
8383 the previous paragraphs would end up in the agenda like this:
8386 8:30-13:00 Arthur Dent lies in front of the bulldozer
8387 12:45...... Ford Prefect arrives and takes Arthur to the pub
8388 19:00...... The Vogon reads his poem
8389 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8393 If the agenda is in single-day mode, or for the display of today, the
8394 timed entries are embedded in a time grid, like
8397 8:00...... ------------------
8398 8:30-13:00 Arthur Dent lies in front of the bulldozer
8399 10:00...... ------------------
8400 12:00...... ------------------
8401 12:45...... Ford Prefect arrives and takes Arthur to the pub
8402 14:00...... ------------------
8403 16:00...... ------------------
8404 18:00...... ------------------
8405 19:00...... The Vogon reads his poem
8406 20:00...... ------------------
8407 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8410 @vindex org-agenda-use-time-grid
8411 @vindex org-agenda-time-grid
8412 The time grid can be turned on and off with the variable
8413 @code{org-agenda-use-time-grid}, and can be configured with
8414 @code{org-agenda-time-grid}.
8416 @node Sorting agenda items
8417 @subsection Sorting agenda items
8418 @cindex sorting, of agenda items
8419 @cindex priorities, of agenda items
8420 Before being inserted into a view, the items are sorted. How this is
8421 done depends on the type of view.
8424 @vindex org-agenda-files
8425 For the daily/weekly agenda, the items for each day are sorted. The
8426 default order is to first collect all items containing an explicit
8427 time-of-day specification. These entries will be shown at the beginning
8428 of the list, as a @emph{schedule} for the day. After that, items remain
8429 grouped in categories, in the sequence given by @code{org-agenda-files}.
8430 Within each category, items are sorted by priority (@pxref{Priorities}),
8431 which is composed of the base priority (2000 for priority @samp{A}, 1000
8432 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8433 overdue scheduled or deadline items.
8435 For the TODO list, items remain in the order of categories, but within
8436 each category, sorting takes place according to priority
8437 (@pxref{Priorities}). The priority used for sorting derives from the
8438 priority cookie, with additions depending on how close an item is to its due
8441 For tags matches, items are not sorted at all, but just appear in the
8442 sequence in which they are found in the agenda files.
8445 @vindex org-agenda-sorting-strategy
8446 Sorting can be customized using the variable
8447 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8448 the estimated effort of an entry (@pxref{Effort estimates}).
8450 @node Filtering/limiting agenda items
8451 @subsection Filtering/limiting agenda items
8453 Agenda built-in or customized commands are statically defined. Agenda
8454 filters and limits provide two ways of dynamically narrowing down the list of
8455 agenda entries: @emph{filters} and @emph{limits}. Filters only act on the
8456 display of the items, while limits take effect before the list of agenda
8457 entries is built. Filters are more often used interactively, while limits are
8458 mostly useful when defined as local variables within custom agenda commands.
8460 @subsubheading Filtering in the agenda
8461 @cindex filtering, by tag, category, top headline and effort, in agenda
8462 @cindex tag filtering, in agenda
8463 @cindex category filtering, in agenda
8464 @cindex top headline filtering, in agenda
8465 @cindex effort filtering, in agenda
8466 @cindex query editing, in agenda
8469 @orgcmd{/,org-agenda-filter-by-tag}
8470 @vindex org-agenda-tag-filter-preset
8471 Filter the agenda view with respect to a tag and/or effort estimates. The
8472 difference between this and a custom agenda command is that filtering is very
8473 fast, so that you can switch quickly between different filters without having
8474 to recreate the agenda.@footnote{Custom commands can preset a filter by
8475 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8476 filter will then be applied to the view and persist as a basic filter through
8477 refreshes and more secondary filtering. The filter is a global property of
8478 the entire agenda view---in a block agenda, you should only set this in the
8479 global options section, not in the section of an individual block.}
8481 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8482 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8483 tag (including any tags that do not have a selection character). The command
8484 then hides all entries that do not contain or inherit this tag. When called
8485 with prefix arg, remove the entries that @emph{do} have the tag. A second
8486 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8487 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8488 will be narrowed by requiring or forbidding the selected additional tag.
8489 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8490 immediately use the @kbd{\} command.
8492 Org also supports automatic, context-aware tag filtering. If the variable
8493 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8494 that function can decide which tags should be excluded from the agenda
8495 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8496 as a sub-option key and runs the auto exclusion logic. For example, let's
8497 say you use a @code{Net} tag to identify tasks which need network access, an
8498 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8499 calls. You could auto-exclude these tags based on the availability of the
8500 Internet, and outside of business hours, with something like this:
8504 (defun org-my-auto-exclude-function (tag)
8506 ((string= tag "Net")
8507 (/= 0 (call-process "/sbin/ping" nil nil nil
8508 "-c1" "-q" "-t1" "mail.gnu.org")))
8509 ((or (string= tag "Errand") (string= tag "Call"))
8510 (let ((hour (nth 2 (decode-time))))
8511 (or (< hour 8) (> hour 21)))))
8514 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8518 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8519 Narrow the current agenda filter by an additional condition. When called with
8520 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8521 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8522 @kbd{-} as the first key after the @kbd{/} command.
8531 @item @r{in} search view
8532 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8533 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8534 add a positive search term prefixed by @samp{+}, indicating that this search
8535 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8536 negative search term which @i{must not} occur/match in the entry for it to be
8540 @orgcmd{<,org-agenda-filter-by-category}
8541 @vindex org-agenda-category-filter-preset
8543 Filter the current agenda view with respect to the category of the item at
8544 point. Pressing @code{<} another time will remove this filter. You can add
8545 a filter preset through the option @code{org-agenda-category-filter-preset}
8548 @orgcmd{^,org-agenda-filter-by-top-headline}
8549 Filter the current agenda view and only display the siblings and the parent
8550 headline of the one at point.
8552 @orgcmd{=,org-agenda-filter-by-regexp}
8553 @vindex org-agenda-regexp-filter-preset
8555 Filter the agenda view by a regular expression: only show agenda entries
8556 matching the regular expression the user entered. When called with a prefix
8557 argument, it will filter @emph{out} entries matching the regexp. With two
8558 universal prefix arguments, it will remove all the regexp filters, which can
8559 be accumulated. You can add a filter preset through the option
8560 @code{org-agenda-category-filter-preset} (see below.)
8562 @orgcmd{_,org-agenda-filter-by-effort}
8563 @vindex org-agenda-effort-filter-preset
8564 @vindex org-sort-agenda-noeffort-is-high
8565 Filter the agenda view with respect to effort estimates.
8566 You first need to set up allowed efforts globally, for example
8568 (setq org-global-properties
8569 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8571 You can then filter for an effort by first typing an operator, one of
8572 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8573 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8574 The filter will then restrict to entries with effort smaller-or-equal, equal,
8575 or larger-or-equal than the selected value. For application of the operator,
8576 entries without a defined effort will be treated according to the value of
8577 @code{org-sort-agenda-noeffort-is-high}.
8579 @orgcmd{|,org-agenda-filter-remove-all}
8580 Remove all filters in the current agenda view.
8583 @subsubheading Setting limits for the agenda
8584 @cindex limits, in agenda
8585 @vindex org-agenda-max-entries
8586 @vindex org-agenda-max-effort
8587 @vindex org-agenda-max-todos
8588 @vindex org-agenda-max-tags
8590 Here is a list of options that you can set, either globally, or locally in
8591 your custom agenda views@pxref{Custom agenda views}.
8594 @item org-agenda-max-entries
8595 Limit the number of entries.
8596 @item org-agenda-max-effort
8597 Limit the duration of accumulated efforts (as minutes).
8598 @item org-agenda-max-todos
8599 Limit the number of entries with TODO keywords.
8600 @item org-agenda-max-tags
8601 Limit the number of tagged entries.
8604 When set to a positive integer, each option will exclude entries from other
8605 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8606 the agenda to 100 minutes of effort and exclude any entry that has no effort
8607 property. If you want to include entries with no effort property, use a
8608 negative value for @code{org-agenda-max-effort}.
8610 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8611 command. For example, this custom command will display the next five entries
8612 with a @code{NEXT} TODO keyword.
8615 (setq org-agenda-custom-commands
8617 ((org-agenda-max-entries 5)))))
8620 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8621 will again the next five entries again, including the first entry that was
8624 You can also dynamically set temporary limits, which will be lost when
8625 rebuilding the agenda:
8628 @orgcmd{~,org-agenda-limit-interactively}
8629 This prompts for the type of limit to apply and its value.
8632 @node Agenda commands
8633 @section Commands in the agenda buffer
8634 @cindex commands, in agenda buffer
8636 Entries in the agenda buffer are linked back to the Org file or diary
8637 file where they originate. You are not allowed to edit the agenda
8638 buffer itself, but commands are provided to show and jump to the
8639 original entry location, and to edit the Org files ``remotely'' from
8640 the agenda buffer. In this way, all information is stored only once,
8641 removing the risk that your agenda and note files may diverge.
8643 Some commands can be executed with mouse clicks on agenda lines. For
8644 the other commands, the cursor needs to be in the desired line.
8647 @tsubheading{Motion}
8648 @cindex motion commands in agenda
8649 @orgcmd{n,org-agenda-next-line}
8650 Next line (same as @key{down} and @kbd{C-n}).
8651 @orgcmd{p,org-agenda-previous-line}
8652 Previous line (same as @key{up} and @kbd{C-p}).
8653 @orgcmd{N,org-agenda-next-item}
8654 Next item: same as next line, but only consider items.
8655 @orgcmd{P,org-agenda-previous-item}
8656 Previous item: same as previous line, but only consider items.
8657 @tsubheading{View/Go to Org file}
8658 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8659 Display the original location of the item in another window.
8660 With prefix arg, make sure that the entire entry is made visible in the
8661 outline, not only the heading.
8663 @orgcmd{L,org-agenda-recenter}
8664 Display original location and recenter that window.
8666 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8667 Go to the original location of the item in another window.
8669 @orgcmd{@key{RET},org-agenda-switch-to}
8670 Go to the original location of the item and delete other windows.
8672 @orgcmd{F,org-agenda-follow-mode}
8673 @vindex org-agenda-start-with-follow-mode
8674 Toggle Follow mode. In Follow mode, as you move the cursor through
8675 the agenda buffer, the other window always shows the corresponding
8676 location in the Org file. The initial setting for this mode in new
8677 agenda buffers can be set with the variable
8678 @code{org-agenda-start-with-follow-mode}.
8680 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8681 Display the entire subtree of the current item in an indirect buffer. With a
8682 numeric prefix argument N, go up to level N and then take that tree. If N is
8683 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8684 previously used indirect buffer.
8686 @orgcmd{C-c C-o,org-agenda-open-link}
8687 Follow a link in the entry. This will offer a selection of any links in the
8688 text belonging to the referenced Org node. If there is only one link, it
8689 will be followed without a selection prompt.
8691 @tsubheading{Change display}
8692 @cindex display changing, in agenda
8695 Interactively select another agenda view and append it to the current view.
8699 Delete other windows.
8701 @orgcmdkskc{v d,d,org-agenda-day-view}
8702 @xorgcmdkskc{v w,w,org-agenda-week-view}
8703 @xorgcmd{v t,org-agenda-fortnight-view}
8704 @xorgcmd{v m,org-agenda-month-view}
8705 @xorgcmd{v y,org-agenda-year-view}
8706 @xorgcmd{v SPC,org-agenda-reset-view}
8707 @vindex org-agenda-span
8708 Switch to day/week/month/year view. When switching to day or week view, this
8709 setting becomes the default for subsequent agenda refreshes. Since month and
8710 year views are slow to create, they do not become the default. A numeric
8711 prefix argument may be used to jump directly to a specific day of the year,
8712 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8713 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8714 month view, a year may be encoded in the prefix argument as well. For
8715 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8716 specification has only one or two digits, it will be mapped to the interval
8717 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8718 @code{org-agenda-span}.
8720 @orgcmd{f,org-agenda-later}
8721 Go forward in time to display the following @code{org-agenda-current-span} days.
8722 For example, if the display covers a week, switch to the following week.
8723 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8725 @orgcmd{b,org-agenda-earlier}
8726 Go backward in time to display earlier dates.
8728 @orgcmd{.,org-agenda-goto-today}
8731 @orgcmd{j,org-agenda-goto-date}
8732 Prompt for a date and go there.
8734 @orgcmd{J,org-agenda-clock-goto}
8735 Go to the currently clocked-in task @i{in the agenda buffer}.
8737 @orgcmd{D,org-agenda-toggle-diary}
8738 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8740 @orgcmdkskc{v l,l,org-agenda-log-mode}
8742 @vindex org-log-done
8743 @vindex org-agenda-log-mode-items
8744 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8745 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8746 entries that have been clocked on that day. You can configure the entry
8747 types that should be included in log mode using the variable
8748 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8749 all possible logbook entries, including state changes. When called with two
8750 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8751 @kbd{v L} is equivalent to @kbd{C-u v l}.
8753 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8754 Include inactive timestamps into the current view. Only for weekly/daily
8755 agenda and timeline views.
8757 @orgcmd{v a,org-agenda-archives-mode}
8758 @xorgcmd{v A,org-agenda-archives-mode 'files}
8759 Toggle Archives mode. In Archives mode, trees that are marked
8760 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8761 capital @kbd{A}, even all archive files are included. To exit archives mode,
8762 press @kbd{v a} again.
8764 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8765 @vindex org-agenda-start-with-clockreport-mode
8766 @vindex org-clock-report-include-clocking-task
8767 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8768 always show a table with the clocked times for the time span and file scope
8769 covered by the current agenda view. The initial setting for this mode in new
8770 agenda buffers can be set with the variable
8771 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8772 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8773 contributions from entries that are hidden by agenda filtering@footnote{Only
8774 tags filtering will be respected here, effort filtering is ignored.}. See
8775 also the variable @code{org-clock-report-include-clocking-task}.
8778 @vindex org-agenda-clock-consistency-checks
8779 Show overlapping clock entries, clocking gaps, and other clocking problems in
8780 the current agenda range. You can then visit clocking lines and fix them
8781 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8782 information on how to customize the definition of what constituted a clocking
8783 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8786 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8787 @vindex org-agenda-start-with-entry-text-mode
8788 @vindex org-agenda-entry-text-maxlines
8789 Toggle entry text mode. In entry text mode, a number of lines from the Org
8790 outline node referenced by an agenda line will be displayed below the line.
8791 The maximum number of lines is given by the variable
8792 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8793 prefix argument will temporarily modify that number to the prefix value.
8795 @orgcmd{G,org-agenda-toggle-time-grid}
8796 @vindex org-agenda-use-time-grid
8797 @vindex org-agenda-time-grid
8798 Toggle the time grid on and off. See also the variables
8799 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8801 @orgcmd{r,org-agenda-redo}
8802 Recreate the agenda buffer, for example to reflect the changes after
8803 modification of the timestamps of items with @kbd{S-@key{left}} and
8804 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8805 argument is interpreted to create a selective list for a specific TODO
8807 @orgcmd{g,org-agenda-redo}
8810 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8811 Save all Org buffers in the current Emacs session, and also the locations of
8814 @orgcmd{C-c C-x C-c,org-agenda-columns}
8815 @vindex org-columns-default-format
8816 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8817 view format is taken from the entry at point, or (if there is no entry at
8818 point), from the first entry in the agenda view. So whatever the format for
8819 that entry would be in the original buffer (taken from a property, from a
8820 @code{#+COLUMNS} line, or from the default variable
8821 @code{org-columns-default-format}), will be used in the agenda.
8823 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8824 Remove the restriction lock on the agenda, if it is currently restricted to a
8825 file or subtree (@pxref{Agenda files}).
8827 @tsubheading{Secondary filtering and query editing}
8829 For a detailed description of these commands, see @pxref{Filtering/limiting
8832 @orgcmd{/,org-agenda-filter-by-tag}
8833 @vindex org-agenda-tag-filter-preset
8834 Filter the agenda view with respect to a tag and/or effort estimates.
8836 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8837 Narrow the current agenda filter by an additional condition.
8839 @orgcmd{<,org-agenda-filter-by-category}
8840 @vindex org-agenda-category-filter-preset
8842 Filter the current agenda view with respect to the category of the item at
8843 point. Pressing @code{<} another time will remove this filter.
8845 @orgcmd{^,org-agenda-filter-by-top-headline}
8846 Filter the current agenda view and only display the siblings and the parent
8847 headline of the one at point.
8849 @orgcmd{=,org-agenda-filter-by-regexp}
8850 @vindex org-agenda-regexp-filter-preset
8852 Filter the agenda view by a regular expression: only show agenda entries
8853 matching the regular expression the user entered. When called with a prefix
8854 argument, it will filter @emph{out} entries matching the regexp. With two
8855 universal prefix arguments, it will remove all the regexp filters, which can
8856 be accumulated. You can add a filter preset through the option
8857 @code{org-agenda-category-filter-preset} (see below.)
8859 @orgcmd{|,org-agenda-filter-remove-all}
8860 Remove all filters in the current agenda view.
8862 @tsubheading{Remote editing}
8863 @cindex remote editing, from agenda
8868 @cindex undoing remote-editing events
8869 @cindex remote editing, undo
8870 @orgcmd{C-_,org-agenda-undo}
8871 Undo a change due to a remote editing command. The change is undone
8872 both in the agenda buffer and in the remote buffer.
8874 @orgcmd{t,org-agenda-todo}
8875 Change the TODO state of the item, both in the agenda and in the
8878 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8879 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8880 Switch to the next/previous set of TODO keywords.
8882 @orgcmd{C-k,org-agenda-kill}
8883 @vindex org-agenda-confirm-kill
8884 Delete the current agenda item along with the entire subtree belonging
8885 to it in the original Org file. If the text to be deleted remotely
8886 is longer than one line, the kill needs to be confirmed by the user. See
8887 variable @code{org-agenda-confirm-kill}.
8889 @orgcmd{C-c C-w,org-agenda-refile}
8890 Refile the entry at point.
8892 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8893 @vindex org-archive-default-command
8894 Archive the subtree corresponding to the entry at point using the default
8895 archiving command set in @code{org-archive-default-command}. When using the
8896 @code{a} key, confirmation will be required.
8898 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8899 Toggle the ARCHIVE tag for the current headline.
8901 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8902 Move the subtree corresponding to the current entry to its @emph{archive
8905 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8906 Archive the subtree corresponding to the current headline. This means the
8907 entry will be moved to the configured archive location, most likely a
8910 @orgcmd{T,org-agenda-show-tags}
8911 @vindex org-agenda-show-inherited-tags
8912 Show all tags associated with the current item. This is useful if you have
8913 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8914 tags of a headline occasionally.
8916 @orgcmd{:,org-agenda-set-tags}
8917 Set tags for the current headline. If there is an active region in the
8918 agenda, change a tag for all headings in the region.
8922 Set the priority for the current item (@command{org-agenda-priority}).
8923 Org mode prompts for the priority character. If you reply with @key{SPC},
8924 the priority cookie is removed from the entry.
8926 @orgcmd{P,org-agenda-show-priority}
8927 Display weighted priority of current item.
8929 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8930 Increase the priority of the current item. The priority is changed in
8931 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8934 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8935 Decrease the priority of the current item.
8937 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8938 @vindex org-log-into-drawer
8939 Add a note to the entry. This note will be recorded, and then filed to the
8940 same location where state change notes are put. Depending on
8941 @code{org-log-into-drawer}, this may be inside a drawer.
8943 @orgcmd{C-c C-a,org-attach}
8944 Dispatcher for all command related to attachments.
8946 @orgcmd{C-c C-s,org-agenda-schedule}
8947 Schedule this item. With prefix arg remove the scheduling timestamp
8949 @orgcmd{C-c C-d,org-agenda-deadline}
8950 Set a deadline for this item. With prefix arg remove the deadline.
8952 @orgcmd{S-@key{right},org-agenda-do-date-later}
8953 Change the timestamp associated with the current line by one day into the
8954 future. If the date is in the past, the first call to this command will move
8956 With a numeric prefix argument, change it by that many days. For example,
8957 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8958 change the time by one hour. If you immediately repeat the command, it will
8959 continue to change hours even without the prefix arg. With a double @kbd{C-u
8960 C-u} prefix, do the same for changing minutes.@*
8961 The stamp is changed in the original Org file, but the change is not directly
8962 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8964 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8965 Change the timestamp associated with the current line by one day
8968 @orgcmd{>,org-agenda-date-prompt}
8969 Change the timestamp associated with the current line. The key @kbd{>} has
8970 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8972 @orgcmd{I,org-agenda-clock-in}
8973 Start the clock on the current item. If a clock is running already, it
8976 @orgcmd{O,org-agenda-clock-out}
8977 Stop the previously started clock.
8979 @orgcmd{X,org-agenda-clock-cancel}
8980 Cancel the currently running clock.
8982 @orgcmd{J,org-agenda-clock-goto}
8983 Jump to the running clock in another window.
8985 @orgcmd{k,org-agenda-capture}
8986 Like @code{org-capture}, but use the date at point as the default date for
8987 the capture template. See @code{org-capture-use-agenda-date} to make this
8988 the default behavior of @code{org-capture}.
8989 @cindex capturing, from agenda
8990 @vindex org-capture-use-agenda-date
8992 @tsubheading{Dragging agenda lines forward/backward}
8993 @cindex dragging, agenda lines
8995 @orgcmd{M-<up>,org-agenda-drag-line-backward}
8996 Drag the line at point backward one line@footnote{Moving agenda lines does
8997 not persist after an agenda refresh and does not modify the contributing
8998 @file{.org} files}. With a numeric prefix argument, drag backward by that
9001 @orgcmd{M-<down>,org-agenda-drag-line-forward}
9002 Drag the line at point forward one line. With a numeric prefix argument,
9003 drag forward by that many lines.
9005 @tsubheading{Bulk remote editing selected entries}
9006 @cindex remote editing, bulk, from agenda
9007 @vindex org-agenda-bulk-custom-functions
9009 @orgcmd{m,org-agenda-bulk-mark}
9010 Mark the entry at point for bulk action. With numeric prefix argument, mark
9011 that many successive entries.
9013 @orgcmd{*,org-agenda-bulk-mark-all}
9014 Mark all visible agenda entries for bulk action.
9016 @orgcmd{u,org-agenda-bulk-unmark}
9017 Unmark entry at point for bulk action.
9019 @orgcmd{U,org-agenda-bulk-remove-all-marks}
9020 Unmark all marked entries for bulk action.
9022 @orgcmd{M-m,org-agenda-bulk-toggle}
9023 Toggle mark of the entry at point for bulk action.
9025 @orgcmd{M-*,org-agenda-bulk-toggle-all}
9026 Toggle marks of all visible entries for bulk action.
9028 @orgcmd{%,org-agenda-bulk-mark-regexp}
9029 Mark entries matching a regular expression for bulk action.
9031 @orgcmd{B,org-agenda-bulk-action}
9032 Bulk action: act on all marked entries in the agenda. This will prompt for
9033 another key to select the action to be applied. The prefix arg to @kbd{B}
9034 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
9035 these special timestamps. By default, marks are removed after the bulk. If
9036 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
9037 @code{t} or hit @kbd{p} at the prompt.
9041 Toggle persistent marks.
9043 Archive all selected entries.
9045 Archive entries by moving them to their respective archive siblings.
9047 Change TODO state. This prompts for a single TODO keyword and changes the
9048 state of all selected entries, bypassing blocking and suppressing logging
9049 notes (but not timestamps).
9051 Add a tag to all selected entries.
9053 Remove a tag from all selected entries.
9055 Schedule all items to a new date. To shift existing schedule dates by a
9056 fixed number of days, use something starting with double plus at the prompt,
9057 for example @samp{++8d} or @samp{++2w}.
9059 Set deadline to a specific date.
9061 Prompt for a single refile target and move all entries. The entries will no
9062 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9064 Reschedule randomly into the coming N days. N will be prompted for. With
9065 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9067 Apply a function@footnote{You can also create persistent custom functions
9068 through @code{org-agenda-bulk-custom-functions}.} to marked entries. For
9069 example, the function below sets the CATEGORY property of the entries to web.
9073 (defun set-category ()
9075 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9076 (org-agenda-error)))
9077 (buffer (marker-buffer marker)))
9078 (with-current-buffer buffer
9083 (org-back-to-heading t)
9084 (org-set-property "CATEGORY" "web"))))))
9089 @tsubheading{Calendar commands}
9090 @cindex calendar commands, from agenda
9092 @orgcmd{c,org-agenda-goto-calendar}
9093 Open the Emacs calendar and move to the date at the agenda cursor.
9095 @orgcmd{c,org-calendar-goto-agenda}
9096 When in the calendar, compute and show the Org mode agenda for the
9099 @cindex diary entries, creating from agenda
9100 @orgcmd{i,org-agenda-diary-entry}
9101 @vindex org-agenda-diary-file
9102 Insert a new entry into the diary, using the date at the cursor and (for
9103 block entries) the date at the mark. This will add to the Emacs diary
9104 file@footnote{This file is parsed for the agenda when
9105 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9106 command in the calendar. The diary file will pop up in another window, where
9107 you can add the entry.
9109 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9110 Org will create entries (in Org mode syntax) in that file instead. Most
9111 entries will be stored in a date-based outline tree that will later make it
9112 easy to archive appointments from previous months/years. The tree will be
9113 built under an entry with a @code{DATE_TREE} property, or else with years as
9114 top-level entries. Emacs will prompt you for the entry text---if you specify
9115 it, the entry will be created in @code{org-agenda-diary-file} without further
9116 interaction. If you directly press @key{RET} at the prompt without typing
9117 text, the target file will be shown in another window for you to finish the
9118 entry there. See also the @kbd{k r} command.
9120 @orgcmd{M,org-agenda-phases-of-moon}
9121 Show the phases of the moon for the three months around current date.
9123 @orgcmd{S,org-agenda-sunrise-sunset}
9124 Show sunrise and sunset times. The geographical location must be set
9125 with calendar variables, see the documentation for the Emacs calendar.
9127 @orgcmd{C,org-agenda-convert-date}
9128 Convert the date at cursor into many other cultural and historic
9131 @orgcmd{H,org-agenda-holidays}
9132 Show holidays for three months around the cursor date.
9134 @item M-x org-icalendar-combine-agenda-files RET
9135 Export a single iCalendar file containing entries from all agenda files.
9136 This is a globally available command, and also available in the agenda menu.
9138 @tsubheading{Exporting to a file}
9139 @orgcmd{C-x C-w,org-agenda-write}
9140 @cindex exporting agenda views
9141 @cindex agenda views, exporting
9142 @vindex org-agenda-exporter-settings
9143 Write the agenda view to a file. Depending on the extension of the selected
9144 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9145 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9146 (any other extension). When exporting to Org, only the body of original
9147 headlines are exported, not subtrees or inherited tags. When called with a
9148 @kbd{C-u} prefix argument, immediately open the newly created file. Use the
9149 variable @code{org-agenda-exporter-settings} to set options for
9150 @file{ps-print} and for @file{htmlize} to be used during export.
9152 @tsubheading{Quit and Exit}
9153 @orgcmd{q,org-agenda-quit}
9154 Quit agenda, remove the agenda buffer.
9156 @cindex agenda files, removing buffers
9157 @orgcmd{x,org-agenda-exit}
9158 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9159 for the compilation of the agenda. Buffers created by the user to
9160 visit Org files will not be removed.
9164 @node Custom agenda views
9165 @section Custom agenda views
9166 @cindex custom agenda views
9167 @cindex agenda views, custom
9169 Custom agenda commands serve two purposes: to store and quickly access
9170 frequently used TODO and tags searches, and to create special composite
9171 agenda buffers. Custom agenda commands will be accessible through the
9172 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9175 * Storing searches:: Type once, use often
9176 * Block agenda:: All the stuff you need in a single buffer
9177 * Setting options:: Changing the rules
9180 @node Storing searches
9181 @subsection Storing searches
9183 The first application of custom searches is the definition of keyboard
9184 shortcuts for frequently used searches, either creating an agenda
9185 buffer, or a sparse tree (the latter covering of course only the current
9188 @vindex org-agenda-custom-commands
9189 @cindex agenda views, main example
9190 @cindex agenda, as an agenda views
9191 @cindex agenda*, as an agenda views
9192 @cindex tags, as an agenda view
9193 @cindex todo, as an agenda view
9199 Custom commands are configured in the variable
9200 @code{org-agenda-custom-commands}. You can customize this variable, for
9201 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
9202 Lisp in @file{.emacs}. The following example contains all valid agenda
9207 (setq org-agenda-custom-commands
9210 ("w" todo "WAITING")
9211 ("W" todo-tree "WAITING")
9212 ("u" tags "+boss-urgent")
9213 ("v" tags-todo "+boss-urgent")
9214 ("U" tags-tree "+boss-urgent")
9215 ("f" occur-tree "\\<FIXME\\>")
9216 ("h" . "HOME+Name tags searches") ; description for "h" prefix
9217 ("hl" tags "+home+Lisa")
9218 ("hp" tags "+home+Peter")
9219 ("hk" tags "+home+Kim")))
9224 The initial string in each entry defines the keys you have to press
9225 after the dispatcher command @kbd{C-c a} in order to access the command.
9226 Usually this will be just a single character, but if you have many
9227 similar commands, you can also define two-letter combinations where the
9228 first character is the same in several combinations and serves as a
9229 prefix key@footnote{You can provide a description for a prefix key by
9230 inserting a cons cell with the prefix and the description.}. The second
9231 parameter is the search type, followed by the string or regular
9232 expression to be used for the matching. The example above will
9237 as a global search for agenda entries planned@footnote{@emph{Planned} means
9238 here that these entries have some planning information attached to them, like
9239 a time-stamp, a scheduled or a deadline string. See
9240 @code{org-agenda-entry-types} on how to set what planning information will be
9241 taken into account.} this week/day.
9243 as a global search for agenda entries planned this week/day, but only those
9244 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9246 as a global search for TODO entries with @samp{WAITING} as the TODO
9249 as the same search, but only in the current buffer and displaying the
9250 results as a sparse tree
9252 as a global tags search for headlines marked @samp{:boss:} but not
9255 as the same search as @kbd{C-c a u}, but limiting the search to
9256 headlines that are also TODO items
9258 as the same search as @kbd{C-c a u}, but only in the current buffer and
9259 displaying the result as a sparse tree
9261 to create a sparse tree (again: current buffer only) with all entries
9262 containing the word @samp{FIXME}
9264 as a prefix command for a HOME tags search where you have to press an
9265 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9266 Peter, or Kim) as additional tag to match.
9269 Note that the @code{*-tree} agenda views need to be called from an
9270 Org buffer as they operate on the current buffer only.
9273 @subsection Block agenda
9274 @cindex block agenda
9275 @cindex agenda, with block views
9277 Another possibility is the construction of agenda views that comprise
9278 the results of @emph{several} commands, each of which creates a block in
9279 the agenda buffer. The available commands include @code{agenda} for the
9280 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9281 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9282 matching commands discussed above: @code{todo}, @code{tags}, and
9283 @code{tags-todo}. Here are two examples:
9287 (setq org-agenda-custom-commands
9288 '(("h" "Agenda and Home-related tasks"
9292 ("o" "Agenda and Office-related tasks"
9300 This will define @kbd{C-c a h} to create a multi-block view for stuff
9301 you need to attend to at home. The resulting agenda buffer will contain
9302 your agenda for the current week, all TODO items that carry the tag
9303 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
9304 command @kbd{C-c a o} provides a similar view for office tasks.
9306 @node Setting options
9307 @subsection Setting options for custom commands
9308 @cindex options, for custom agenda views
9310 @vindex org-agenda-custom-commands
9311 Org mode contains a number of variables regulating agenda construction
9312 and display. The global variables define the behavior for all agenda
9313 commands, including the custom commands. However, if you want to change
9314 some settings just for a single custom view, you can do so. Setting
9315 options requires inserting a list of variable names and values at the
9316 right spot in @code{org-agenda-custom-commands}. For example:
9320 (setq org-agenda-custom-commands
9321 '(("w" todo "WAITING"
9322 ((org-agenda-sorting-strategy '(priority-down))
9323 (org-agenda-prefix-format " Mixed: ")))
9324 ("U" tags-tree "+boss-urgent"
9325 ((org-show-following-heading nil)
9326 (org-show-hierarchy-above nil)))
9328 ((org-agenda-files '("~org/notes.org"))
9329 (org-agenda-text-search-extra-files nil)))))
9334 Now the @kbd{C-c a w} command will sort the collected entries only by
9335 priority, and the prefix format is modified to just say @samp{ Mixed: }
9336 instead of giving the category of the entry. The sparse tags tree of
9337 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9338 headline hierarchy above the match, nor the headline following the match
9339 will be shown. The command @kbd{C-c a N} will do a text search limited
9340 to only a single file.
9342 @vindex org-agenda-custom-commands
9343 For command sets creating a block agenda,
9344 @code{org-agenda-custom-commands} has two separate spots for setting
9345 options. You can add options that should be valid for just a single
9346 command in the set, and options that should be valid for all commands in
9347 the set. The former are just added to the command entry; the latter
9348 must come after the list of command entries. Going back to the block
9349 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9350 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9351 the results for GARDEN tags query in the opposite order,
9352 @code{priority-up}. This would look like this:
9356 (setq org-agenda-custom-commands
9357 '(("h" "Agenda and Home-related tasks"
9361 ((org-agenda-sorting-strategy '(priority-up)))))
9362 ((org-agenda-sorting-strategy '(priority-down))))
9363 ("o" "Agenda and Office-related tasks"
9370 As you see, the values and parentheses setting is a little complex.
9371 When in doubt, use the customize interface to set this variable---it
9372 fully supports its structure. Just one caveat: when setting options in
9373 this interface, the @emph{values} are just Lisp expressions. So if the
9374 value is a string, you need to add the double-quotes around the value
9377 @vindex org-agenda-custom-commands-contexts
9378 To control whether an agenda command should be accessible from a specific
9379 context, you can customize @code{org-agenda-custom-commands-contexts}. Let's
9380 say for example that you have an agenda command @code{"o"} displaying a view
9381 that you only need when reading emails. Then you would configure this option
9385 (setq org-agenda-custom-commands-contexts
9386 '(("o" (in-mode . "message-mode"))))
9389 You can also tell that the command key @code{"o"} should refer to another
9390 command key @code{"r"}. In that case, add this command key like this:
9393 (setq org-agenda-custom-commands-contexts
9394 '(("o" "r" (in-mode . "message-mode"))))
9397 See the docstring of the variable for more information.
9399 @node Exporting agenda views
9400 @section Exporting agenda views
9401 @cindex agenda views, exporting
9403 If you are away from your computer, it can be very useful to have a printed
9404 version of some agenda views to carry around. Org mode can export custom
9405 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9406 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9407 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
9408 a PDF file will also create the postscript file.}, and iCalendar files. If
9409 you want to do this only occasionally, use the command
9412 @orgcmd{C-x C-w,org-agenda-write}
9413 @cindex exporting agenda views
9414 @cindex agenda views, exporting
9415 @vindex org-agenda-exporter-settings
9416 Write the agenda view to a file. Depending on the extension of the selected
9417 file name, the view will be exported as HTML (extension @file{.html} or
9418 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9419 @file{.ics}), or plain text (any other extension). Use the variable
9420 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9421 for @file{htmlize} to be used during export, for example
9423 @vindex org-agenda-add-entry-text-maxlines
9424 @vindex htmlize-output-type
9425 @vindex ps-number-of-columns
9426 @vindex ps-landscape-mode
9428 (setq org-agenda-exporter-settings
9429 '((ps-number-of-columns 2)
9430 (ps-landscape-mode t)
9431 (org-agenda-add-entry-text-maxlines 5)
9432 (htmlize-output-type 'css)))
9436 If you need to export certain agenda views frequently, you can associate
9437 any custom agenda command with a list of output file names
9438 @footnote{If you want to store standard views like the weekly agenda
9439 or the global TODO list as well, you need to define custom commands for
9440 them in order to be able to specify file names.}. Here is an example
9441 that first defines custom commands for the agenda and the global
9442 TODO list, together with a number of files to which to export them.
9443 Then we define two block agenda commands and specify file names for them
9444 as well. File names can be relative to the current working directory,
9449 (setq org-agenda-custom-commands
9450 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9451 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9452 ("h" "Agenda and Home-related tasks"
9457 ("~/views/home.html"))
9458 ("o" "Agenda and Office-related tasks"
9463 ("~/views/office.ps" "~/calendars/office.ics"))))
9467 The extension of the file name determines the type of export. If it is
9468 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9469 the buffer to HTML and save it to this file name. If the extension is
9470 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9471 Postscript output. If the extension is @file{.ics}, iCalendar export is
9472 run export over all files that were used to construct the agenda, and
9473 limit the export to entries listed in the agenda. Any other
9474 extension produces a plain ASCII file.
9476 The export files are @emph{not} created when you use one of those
9477 commands interactively because this might use too much overhead.
9478 Instead, there is a special command to produce @emph{all} specified
9482 @orgcmd{C-c a e,org-store-agenda-views}
9483 Export all agenda views that have export file names associated with
9487 You can use the options section of the custom agenda commands to also
9488 set options for the export commands. For example:
9491 (setq org-agenda-custom-commands
9493 ((ps-number-of-columns 2)
9494 (ps-landscape-mode t)
9495 (org-agenda-prefix-format " [ ] ")
9496 (org-agenda-with-colors nil)
9497 (org-agenda-remove-tags t))
9502 This command sets two options for the Postscript exporter, to make it
9503 print in two columns in landscape format---the resulting page can be cut
9504 in two and then used in a paper agenda. The remaining settings modify
9505 the agenda prefix to omit category and scheduling information, and
9506 instead include a checkbox to check off items. We also remove the tags
9507 to make the lines compact, and we don't want to use colors for the
9508 black-and-white printer. Settings specified in
9509 @code{org-agenda-exporter-settings} will also apply, but the settings
9510 in @code{org-agenda-custom-commands} take precedence.
9513 From the command line you may also use
9515 emacs -eval (org-batch-store-agenda-views) -kill
9518 or, if you need to modify some parameters@footnote{Quoting depends on the
9519 system you use, please check the FAQ for examples.}
9521 emacs -eval '(org-batch-store-agenda-views \
9522 org-agenda-span (quote month) \
9523 org-agenda-start-day "2007-11-01" \
9524 org-agenda-include-diary nil \
9525 org-agenda-files (quote ("~/org/project.org")))' \
9529 which will create the agenda views restricted to the file
9530 @file{~/org/project.org}, without diary entries and with a 30-day
9533 You can also extract agenda information in a way that allows further
9534 processing by other programs. See @ref{Extracting agenda information}, for
9538 @node Agenda column view
9539 @section Using column view in the agenda
9540 @cindex column view, in agenda
9541 @cindex agenda, column view
9543 Column view (@pxref{Column view}) is normally used to view and edit
9544 properties embedded in the hierarchical structure of an Org file. It can be
9545 quite useful to use column view also from the agenda, where entries are
9546 collected by certain criteria.
9549 @orgcmd{C-c C-x C-c,org-agenda-columns}
9550 Turn on column view in the agenda.
9553 To understand how to use this properly, it is important to realize that the
9554 entries in the agenda are no longer in their proper outline environment.
9555 This causes the following issues:
9559 @vindex org-columns-default-format
9560 @vindex org-overriding-columns-format
9561 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9562 entries in the agenda are collected from different files, and different files
9563 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9564 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9565 currently set, and if so, takes the format from there. Otherwise it takes
9566 the format associated with the first item in the agenda, or, if that item
9567 does not have a specific format (defined in a property, or in its file), it
9568 uses @code{org-columns-default-format}.
9570 @cindex property, special, CLOCKSUM
9571 If any of the columns has a summary type defined (@pxref{Column attributes}),
9572 turning on column view in the agenda will visit all relevant agenda files and
9573 make sure that the computations of this property are up to date. This is
9574 also true for the special @code{CLOCKSUM} property. Org will then sum the
9575 values displayed in the agenda. In the daily/weekly agenda, the sums will
9576 cover a single day; in all other views they cover the entire block. It is
9577 vital to realize that the agenda may show the same entry @emph{twice} (for
9578 example as scheduled and as a deadline), and it may show two entries from the
9579 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9580 cases, the summation in the agenda will lead to incorrect results because
9581 some values will count double.
9583 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9584 the entire clocked time for this item. So even in the daily/weekly agenda,
9585 the clocksum listed in column view may originate from times outside the
9586 current view. This has the advantage that you can compare these values with
9587 a column listing the planned total effort for a task---one of the major
9588 applications for column view in the agenda. If you want information about
9589 clocked time in the displayed period use clock table mode (press @kbd{R} in
9593 @cindex property, special, CLOCKSUM_T
9594 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9595 always today's clocked time for this item. So even in the weekly agenda,
9596 the clocksum listed in column view only originates from today. This lets
9597 you compare the time you spent on a task for today, with the time already
9598 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9603 @chapter Markup for rich export
9605 When exporting Org mode documents, the exporter tries to reflect the
9606 structure of the document as accurately as possible in the back-end. Since
9607 export targets like HTML and @LaTeX{} allow much richer formatting, Org mode has
9608 rules on how to prepare text for rich export. This section summarizes the
9609 markup rules used in an Org mode buffer.
9612 * Structural markup elements:: The basic structure as seen by the exporter
9613 * Images and tables:: Images, tables and caption mechanism
9614 * Literal examples:: Source code examples with special formatting
9615 * Include files:: Include additional files into a document
9616 * Index entries:: Making an index
9617 * Macro replacement:: Use macros to create templates
9618 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9619 * Special blocks:: Containers targeted at export back-ends
9622 @node Structural markup elements
9623 @section Structural markup elements
9626 * Document title:: Where the title is taken from
9627 * Headings and sections:: The document structure as seen by the exporter
9628 * Table of contents:: The if and where of the table of contents
9630 * Paragraphs:: Paragraphs
9631 * Footnote markup:: Footnotes
9632 * Emphasis and monospace:: Bold, italic, etc.
9633 * Horizontal rules:: Make a line
9634 * Comment lines:: What will *not* be exported
9637 @node Document title
9638 @subheading Document title
9639 @cindex document title, markup rules
9642 The title of the exported document is taken from the special line
9646 #+TITLE: This is the title of the document
9649 @cindex property, EXPORT_TITLE
9650 If you are exporting only a subtree, its heading will become the title of the
9651 document. If the subtree has a property @code{EXPORT_TITLE}, that will take
9654 @node Headings and sections
9655 @subheading Headings and sections
9656 @cindex headings and sections, markup rules
9658 @vindex org-export-headline-levels
9659 The outline structure of the document as described in @ref{Document
9660 structure}, forms the basis for defining sections of the exported document.
9661 However, since the outline structure is also used for (for example) lists of
9662 tasks, only the first three outline levels will be used as headings. Deeper
9663 levels will become itemized lists. You can change the location of this
9664 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9665 per-file basis with a line
9672 @node Table of contents
9673 @subheading Table of contents
9674 @cindex table of contents, markup rules
9677 @vindex org-export-with-toc
9678 The table of contents is normally inserted directly before the first headline
9679 of the file. The depth of the table is by default the same as the number of
9680 headline levels, but you can choose a smaller number, or turn off the table
9681 of contents entirely, by configuring the variable @code{org-export-with-toc},
9682 or on a per-file basis with a line like
9685 #+OPTIONS: toc:2 (only to two levels in TOC)
9686 #+OPTIONS: toc:nil (no default TOC at all)
9689 If you would like to move the table of contents to a different location, you
9690 should turn off the default table using @code{org-export-with-toc} or
9691 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9695 #+OPTIONS: toc:nil (no default TOC)
9697 #+TOC: headlines 2 (insert TOC here, with two headline levels)
9700 Multiple @code{#+TOC: headline} lines are allowed. The same @code{TOC}
9701 keyword can also generate a list of all tables (resp.@: all listings) with a
9702 caption in the buffer.
9705 #+TOC: listings (build a list of listings)
9706 #+TOC: tables (build a list of tables)
9709 @cindex property, ALT_TITLE
9710 The headline's title usually determines its corresponding entry in a table of
9711 contents. However, it is possible to specify an alternative title by
9712 setting @code{ALT_TITLE} property accordingly. It will then be used when
9717 @cindex lists, markup rules
9719 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9720 syntax for such lists. Most back-ends support unordered, ordered, and
9724 @subheading Paragraphs, line breaks, and quoting
9725 @cindex paragraphs, markup rules
9727 Paragraphs are separated by at least one empty line. If you need to enforce
9728 a line break within a paragraph, use @samp{\\} at the end of a line.
9730 To keep the line breaks in a region, but otherwise use normal formatting, you
9731 can use this construct, which can also be used to format poetry.
9733 @cindex #+BEGIN_VERSE
9736 Great clouds overhead
9737 Tiny black birds rise and fall
9744 When quoting a passage from another document, it is customary to format this
9745 as a paragraph that is indented on both the left and the right margin. You
9746 can include quotations in Org mode documents like this:
9748 @cindex #+BEGIN_QUOTE
9751 Everything should be made as simple as possible,
9752 but not any simpler -- Albert Einstein
9756 If you would like to center some text, do it like this:
9757 @cindex #+BEGIN_CENTER
9760 Everything should be made as simple as possible, \\
9766 @node Footnote markup
9767 @subheading Footnote markup
9768 @cindex footnotes, markup rules
9769 @cindex @file{footnote.el}
9771 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9772 by all back-ends. Org allows multiple references to the same note, and
9773 multiple footnotes side by side.
9775 @node Emphasis and monospace
9776 @subheading Emphasis and monospace
9778 @cindex underlined text, markup rules
9779 @cindex bold text, markup rules
9780 @cindex italic text, markup rules
9781 @cindex verbatim text, markup rules
9782 @cindex code text, markup rules
9783 @cindex strike-through text, markup rules
9784 @vindex org-fontify-emphasized-text
9785 @vindex org-emphasis-regexp-components
9786 @vindex org-emphasis-alist
9787 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=verbatim=}
9788 and @code{~code~}, and, if you must, @samp{+strike-through+}. Text
9789 in the code and verbatim string is not processed for Org mode specific
9790 syntax, it is exported verbatim.
9792 To turn off fontification for marked up text, you can set
9793 @code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of
9794 available markup syntax, you can customize @code{org-emphasis-alist}. To fine
9795 tune what characters are allowed before and after the markup characters, you
9796 can tweak @code{org-emphasis-regexp-components}. Beware that changing one of
9797 the above variables will no take effect until you reload Org, for which you
9798 may need to restart Emacs.
9800 @node Horizontal rules
9801 @subheading Horizontal rules
9802 @cindex horizontal rules, markup rules
9803 A line consisting of only dashes, and at least 5 of them, will be exported as
9807 @subheading Comment lines
9808 @cindex comment lines
9809 @cindex exporting, not
9810 @cindex #+BEGIN_COMMENT
9812 Lines starting with zero or more whitespace characters followed by one
9813 @samp{#} and a whitespace are treated as comments and, as such, are not
9816 Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
9817 ... @samp{#+END_COMMENT} are not exported.
9819 Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
9820 other keyword or priority cookie, comments out the entire subtree. In this
9821 case, the subtree is not exported and no code block within it is executed
9822 either. The command below helps changing the comment status of a headline.
9827 Toggle the @samp{COMMENT} keyword at the beginning of an entry.
9831 @node Images and tables
9832 @section Images and Tables
9834 @cindex tables, markup rules
9837 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9838 the @file{table.el} package will be exported properly. For Org mode tables,
9839 the lines before the first horizontal separator line will become table header
9840 lines. You can use the following lines somewhere before the table to assign
9841 a caption and a label for cross references, and in the text you can refer to
9842 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9845 #+CAPTION: This is the caption for the next table (or link)
9846 #+NAME: tab:basic-data
9851 Optionally, the caption can take the form:
9853 #+CAPTION[Caption for list of tables]: Caption for table.
9856 @cindex inlined images, markup rules
9857 Some back-ends allow you to directly include images into the exported
9858 document. Org does this, if a link to an image files does not have
9859 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
9860 define a caption for the image and maybe a label for internal cross
9861 references, make sure that the link is on a line by itself and precede it
9862 with @code{#+CAPTION} and @code{#+NAME} as follows:
9865 #+CAPTION: This is the caption for the next figure link (or table)
9866 #+NAME: fig:SED-HR4049
9871 Such images can be displayed within the buffer. @xref{Handling links,the
9872 discussion of image links}.
9874 Even though images and tables are prominent examples of captioned structures,
9875 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9876 equations, source code blocks). Depending on the export back-end, those may
9877 or may not be handled.
9879 @node Literal examples
9880 @section Literal examples
9881 @cindex literal examples, markup rules
9882 @cindex code line references, markup rules
9884 You can include literal examples that should not be subjected to
9885 markup. Such examples will be typeset in monospace, so this is well suited
9886 for source code and similar examples.
9887 @cindex #+BEGIN_EXAMPLE
9891 Some example from a text file.
9895 Note that such blocks may be @i{indented} in order to align nicely with
9896 indented text and in particular with plain list structure (@pxref{Plain
9897 lists}). For simplicity when using small examples, you can also start the
9898 example lines with a colon followed by a space. There may also be additional
9899 whitespace before the colon:
9903 : Some example from a text file.
9906 @cindex formatting source code, markup rules
9907 @vindex org-latex-listings
9908 If the example is source code from a programming language, or any other text
9909 that can be marked up by font-lock in Emacs, you can ask for the example to
9910 look like the fontified Emacs buffer@footnote{This works automatically for
9911 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9912 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9913 achieved using either the listings or the
9914 @url{http://code.google.com/p/minted, minted,} package. Refer to
9915 @code{org-latex-listings} documentation for details.}. This is done
9916 with the @samp{src} block, where you also need to specify the name of the
9917 major mode that should be used to fontify the example@footnote{Code in
9918 @samp{src} blocks may also be evaluated either interactively or on export.
9919 See @pxref{Working with source code} for more information on evaluating code
9920 blocks.}, see @ref{Easy templates} for shortcuts to easily insert code
9925 #+BEGIN_SRC emacs-lisp
9926 (defun org-xor (a b)
9932 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9933 switch to the end of the @code{BEGIN} line, to get the lines of the example
9934 numbered. If you use a @code{+n} switch, the numbering from the previous
9935 numbered snippet will be continued in the current one. In literal examples,
9936 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9937 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9938 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9939 link will remote-highlight the corresponding code line, which is kind of
9942 You can also add a @code{-r} switch which @i{removes} the labels from the
9943 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9944 labels in the source code while using line numbers for the links, which might
9945 be useful to explain those in an Org mode example code.}. With the @code{-n}
9946 switch, links to these references will be labeled by the line numbers from
9947 the code listing, otherwise links will use the labels with no parentheses.
9951 #+BEGIN_SRC emacs-lisp -n -r
9952 (save-excursion (ref:sc)
9953 (goto-char (point-min))) (ref:jump)
9955 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9959 @cindex indentation, in source blocks
9960 Finally, you can use @code{-i} to preserve the indentation of a specific code
9961 block (@pxref{Editing source code}).
9963 @vindex org-coderef-label-format
9964 If the syntax for the label format conflicts with the language syntax, use a
9965 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9966 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9968 HTML export also allows examples to be published as text areas (@pxref{Text
9969 areas in HTML export}).
9971 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9972 so often, shortcuts are provided using the Easy templates facility
9973 (@pxref{Easy templates}).
9978 Edit the source code example at point in its native mode. This works by
9979 switching to a temporary buffer with the source code. You need to exit by
9980 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9981 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9982 from being interpreted by Org as outline nodes or special syntax. These
9983 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9984 The edited version will then replace the old version in the Org buffer.
9985 Fixed-width regions (where each line starts with a colon followed by a space)
9986 will be edited using @code{artist-mode}@footnote{You may select
9987 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9988 to allow creating ASCII drawings easily. Using this command in an empty line
9989 will create a new fixed-width region.
9992 Calling @code{org-store-link} while editing a source code example in a
9993 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9994 that it is unique in the current buffer, and insert it with the proper
9995 formatting like @samp{(ref:label)} at the end of the current line. Then the
9996 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
10000 @node Include files
10001 @section Include files
10002 @cindex include files, markup rules
10004 During export, you can include the content of another file. For example, to
10005 include your @file{.emacs} file, you could use:
10009 #+INCLUDE: "~/.emacs" src emacs-lisp
10013 The first parameter names the the file to include. The optional second and
10014 third parameter specify the markup (i.e., @samp{example} or @samp{src}), and,
10015 if the markup is @samp{src}, the language for formatting the contents.
10017 If markup is requested, the included content will be placed within an
10018 appropriate block@footnote{While you can request paragraphs (@samp{verse},
10019 @samp{quote}, @samp{center}), but this places severe restrictions on the type
10020 of content that is permissible}. No changes to the included content are made
10021 and it is the responsibility of the user to ensure that the result is valid
10022 Org syntax. For markup @samp{example} and @samp{src}, which is requesting a
10023 literal example, the content will be code-escaped before inclusion.
10025 If no markup is requested, the text will be assumed to be in Org mode format
10026 and will be processed normally. However, footnote labels (@pxref{Footnotes})
10027 in the file will be made local to that file. Contents of the included file
10028 will belong to the same structure (headline, item) containing the
10029 @code{INCLUDE} keyword. In particular, headlines within the file will become
10030 children of the current section. That behavior can be changed by providing
10031 an additional keyword parameter, @code{:minlevel}. In that case, all
10032 headlines in the included file will be shifted so the one with the lowest
10033 level reaches that specified level. For example, to make a file become a
10034 sibling of the current top-level headline, use
10037 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
10040 You can also include a portion of a file by specifying a lines range using
10041 the @code{:lines} keyword parameter. The line at the upper end of the range
10042 will not be included. The start and/or the end of the range may be omitted
10043 to use the obvious defaults.
10046 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
10047 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
10048 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
10051 Finally, you may use a file-link to extract an object as matched by
10052 @code{org-link-search}@footnote{Note that
10053 @code{org-link-search-must-match-exact-headline} is locally bound to non-nil.
10054 Therefore, @code{org-link-search} only matches headlines and named elements.}
10055 (@pxref{Search options}). If the @code{:only-contents} property is non-nil,
10056 only the contents of the requested element will be included, omitting
10057 properties drawer and planning-line if present. The @code{:lines} keyword
10058 operates locally with respect to the requested element. Some examples:
10061 #+INCLUDE: "./paper.org::#theory" :only-contents t
10062 @r{Include the body of the heading with the custom id @code{theory}}
10063 #+INCLUDE: "./paper.org::mytable" @r{Include named element.}
10064 #+INCLUDE: "./paper.org::*conclusion" :lines 1-20
10065 @r{Include the first 20 lines of the headline named conclusion.}
10071 Visit the include file at point.
10074 @node Index entries
10075 @section Index entries
10076 @cindex index entries, for publishing
10078 You can specify entries that will be used for generating an index during
10079 publishing. This is done by lines starting with @code{#+INDEX}. An entry
10080 the contains an exclamation mark will create a sub item. See @ref{Generating
10081 an index} for more information.
10086 #+INDEX: Application!CV
10092 @node Macro replacement
10093 @section Macro replacement
10094 @cindex macro replacement, during export
10097 You can define text snippets with
10100 #+MACRO: name replacement text $1, $2 are arguments
10103 @noindent which can be referenced
10104 @code{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate arguments,
10105 commas within arguments have to be escaped with a backslash character.
10106 Conversely, backslash characters before a comma, and only them, need to be
10107 escaped with another backslash character.}.
10109 These references, called macros, can be inserted anywhere Org markup is
10110 recognized: paragraphs, headlines, verse blocks, tables cells and lists.
10111 They cannot be used within ordinary keywords (starting with @code{#+}) but
10112 are allowed in @code{#+CAPTION}, @code{#+TITLE}, @code{#+AUTHOR} and
10115 In addition to user-defined macros, a set of already defined macros can be
10116 used: @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will
10117 reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
10118 similar lines. Also, @code{@{@{@{time(@var{FORMAT})@}@}@}} and
10119 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
10120 and to the modification time of the file being exported, respectively.
10121 @var{FORMAT} should be a format string understood by
10122 @code{format-time-string}.
10124 The surrounding brackets can be made invisible by setting
10125 @code{org-hide-macro-markers} to @code{t}.
10127 Macro expansion takes place during the very beginning of the export process.
10130 @node Embedded @LaTeX{}
10131 @section Embedded @LaTeX{}
10132 @cindex @TeX{} interpretation
10133 @cindex @LaTeX{} interpretation
10135 Plain ASCII is normally sufficient for almost all note taking. Exceptions
10136 include scientific notes, which often require mathematical symbols and the
10137 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10138 Donald E. Knuth's @TeX{} system. Many of the features described here as
10139 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10140 distinction.} is widely used to typeset scientific documents. Org mode
10141 supports embedding @LaTeX{} code into its files, because many academics are
10142 used to writing and reading @LaTeX{} source code, and because it can be
10143 readily processed to produce pretty output for a number of export back-ends.
10146 * Special symbols:: Greek letters and other symbols
10147 * Subscripts and superscripts:: Simple syntax for raising/lowering text
10148 * @LaTeX{} fragments:: Complex formulas made easy
10149 * Previewing @LaTeX{} fragments:: What will this snippet look like?
10150 * CDLaTeX mode:: Speed up entering of formulas
10153 @node Special symbols
10154 @subsection Special symbols
10155 @cindex math symbols
10156 @cindex special symbols
10157 @cindex @TeX{} macros
10158 @cindex @LaTeX{} fragments, markup rules
10159 @cindex HTML entities
10160 @cindex @LaTeX{} entities
10162 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10163 to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
10164 for these symbols is available, just type @samp{\} and maybe a few letters,
10165 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
10166 code, Org mode allows these symbols to be present without surrounding math
10167 delimiters, for example:
10170 Angles are written as Greek letters \alpha, \beta and \gamma.
10173 @vindex org-entities
10174 During export, these symbols will be transformed into the native format of
10175 the exporter back-end. Strings like @code{\alpha} will be exported as
10176 @code{α} in the HTML output, and as @code{\(\alpha\)} in the @LaTeX{}
10177 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
10178 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
10179 like this: @samp{\Aacute@{@}stor}.
10181 A large number of entities is provided, with names taken from both HTML and
10182 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10183 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10184 @samp{...} are all converted into special commands creating hyphens of
10185 different lengths or a compact set of dots.
10187 If you would like to see entities displayed as UTF-8 characters, use the
10188 following command@footnote{You can turn this on by default by setting the
10189 variable @code{org-pretty-entities}, or on a per-file base with the
10190 @code{#+STARTUP} option @code{entitiespretty}.}:
10193 @cindex @code{entitiespretty}, STARTUP keyword
10196 Toggle display of entities as UTF-8 characters. This does not change the
10197 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10198 for display purposes only.
10201 @node Subscripts and superscripts
10202 @subsection Subscripts and superscripts
10204 @cindex superscript
10206 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10207 subscripts. Again, these can be used without embedding them in math-mode
10208 delimiters. To increase the readability of ASCII text, it is not necessary
10209 (but OK) to surround multi-character sub- and superscripts with curly braces.
10213 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
10214 the sun is R_@{sun@} = 6.96 x 10^8 m.
10217 @vindex org-use-sub-superscripts
10218 If you write a text where the underscore is often used in a different
10219 context, Org's convention to always interpret these as subscripts can get in
10220 your way. Configure the variable @code{org-use-sub-superscripts} to change
10221 this convention. For example, when setting this variable to @code{@{@}},
10222 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10227 In addition to showing entities as UTF-8 characters, this command will also
10228 format sub- and superscripts in a WYSIWYM way.
10231 @node @LaTeX{} fragments
10232 @subsection @LaTeX{} fragments
10233 @cindex @LaTeX{} fragments
10235 @vindex org-format-latex-header
10236 Going beyond symbols and sub- and superscripts, a full formula language is
10237 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
10238 to process these for several export back-ends. When exporting to @LaTeX{},
10239 the code is obviously left as it is. When exporting to HTML, Org can invoke
10240 the @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
10241 HTML export}) to process and display the math@footnote{If you plan to use
10242 this regularly or on pages with significant page views, you should install
10243 @file{MathJax} on your own server in order to limit the load of our server.}.
10244 It can also process the mathematical expressions into images that can be
10245 displayed in a browser (see @pxref{Previewing @LaTeX{} fragments}).
10247 @LaTeX{} fragments don't need any special marking at all. The following
10248 snippets will be identified as @LaTeX{} source code:
10251 Environments of any kind@footnote{When @file{MathJax} is used, only the
10252 environments recognized by @file{MathJax} will be processed. When
10253 @file{dvipng} program or @file{imagemagick} suite is used to create images,
10254 any @LaTeX{} environment will be handled.}. The only requirement is that the
10255 @code{\begin} statement appears on a new line, at the beginning of the line
10256 or after whitespaces only.
10258 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
10259 currency specifications, single @samp{$} characters are only recognized as
10260 math delimiters if the enclosed text contains at most two line breaks, is
10261 directly attached to the @samp{$} characters with no whitespace in between,
10262 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
10263 For the other delimiters, there is no such restriction, so when in doubt, use
10264 @samp{\(...\)} as inline math delimiters.
10267 @noindent For example:
10274 If $a^2=b$ and \( b=2 \), then the solution must be
10275 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10280 @c @vindex org-format-latex-options
10281 @c If you need any of the delimiter ASCII sequences for other purposes, you
10282 @c can configure the option @code{org-format-latex-options} to deselect the
10283 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10285 @vindex org-export-with-latex
10286 @LaTeX{} processing can be configured with the variable
10287 @code{org-export-with-latex}. The default setting is @code{t} which means
10288 @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10289 You can also set this variable on a per-file basis using one of these
10293 #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)}
10294 #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all}
10295 #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so}
10298 @node Previewing @LaTeX{} fragments
10299 @subsection Previewing @LaTeX{} fragments
10300 @cindex @LaTeX{} fragments, preview
10302 @vindex org-latex-create-formula-image-program
10303 If you have a working @LaTeX{} installation and either @file{dvipng} or
10304 @file{convert} installed@footnote{These are respectively available at
10305 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10306 suite. Choose the converter by setting the variable
10307 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10308 fragments can be processed to produce images of the typeset expressions to be
10309 used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}),
10310 or for inline previewing within Org mode.
10312 @vindex org-format-latex-options
10313 @vindex org-format-latex-header
10314 You can customize the variables @code{org-format-latex-options} and
10315 @code{org-format-latex-header} to influence some aspects of the preview. In
10316 particular, the @code{:scale} (and for HTML export, @code{:html-scale})
10317 property of the former can be used to adjust the size of the preview images.
10320 @kindex C-c C-x C-l
10322 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10323 over the source code. If there is no fragment at point, process all
10324 fragments in the current entry (between two headlines). When called
10325 with a prefix argument, process the entire subtree. When called with
10326 two prefix arguments, or when the cursor is before the first headline,
10327 process the entire buffer.
10330 Remove the overlay preview images.
10333 @vindex org-startup-with-latex-preview
10334 You can turn on the previewing of all @LaTeX{} fragments in a file with
10337 #+STARTUP: latexpreview
10340 To disable it, simply use
10343 #+STARTUP: nolatexpreview
10347 @subsection Using CD@LaTeX{} to enter math
10350 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10351 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10352 environments and math templates. Inside Org mode, you can make use of
10353 some of the features of CD@LaTeX{} mode. You need to install
10354 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10355 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10356 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10357 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
10358 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10362 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10365 When this mode is enabled, the following features are present (for more
10366 details see the documentation of CD@LaTeX{} mode):
10370 Environment templates can be inserted with @kbd{C-c @{}.
10373 The @key{TAB} key will do template expansion if the cursor is inside a
10374 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10375 inside such a fragment, see the documentation of the function
10376 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
10377 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10378 correctly inside the first brace. Another @key{TAB} will get you into
10379 the second brace. Even outside fragments, @key{TAB} will expand
10380 environment abbreviations at the beginning of a line. For example, if
10381 you write @samp{equ} at the beginning of a line and press @key{TAB},
10382 this abbreviation will be expanded to an @code{equation} environment.
10383 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10387 @vindex cdlatex-simplify-sub-super-scripts
10388 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10389 characters together with a pair of braces. If you use @key{TAB} to move
10390 out of the braces, and if the braces surround only a single character or
10391 macro, they are removed again (depending on the variable
10392 @code{cdlatex-simplify-sub-super-scripts}).
10395 Pressing the backquote @kbd{`} followed by a character inserts math
10396 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
10397 after the backquote, a help window will pop up.
10400 Pressing the single-quote @kbd{'} followed by another character modifies
10401 the symbol before point with an accent or a font. If you wait more than
10402 1.5 seconds after the single-quote, a help window will pop up. Character
10403 modification will work only inside @LaTeX{} fragments; outside the quote
10407 @node Special blocks
10408 @section Special blocks
10409 @cindex Special blocks
10411 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10412 examples}). It is also possible to create blocks containing raw code
10413 targeted at a specific back-end (e.g., @samp{#+BEGIN_LATEX}).
10415 Any other block is a @emph{special block}. Its name is case-sensitive.
10417 For example, @samp{#+BEGIN_abstract} and @samp{#+BEGIN_video} are special
10418 blocks. The first one is useful when exporting to @LaTeX{}, the second one
10419 when exporting to HTML5.
10421 Each export back-end decides if they should be exported, and how. When the
10422 block is ignored, its contents are still exported, as if the opening and
10423 closing block lines were not there. For example, when exporting a
10424 @samp{#+BEGIN_test} block, HTML back-end wraps its contents within a
10425 @samp{<div name="test">} tag.
10427 Refer to back-end specific documentation for more information.
10433 The Org mode export facilities can be used to export Org documents or parts
10434 of Org documents to a variety of other formats. In addition, these
10435 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10436 in foreign buffers so you can author tables and lists in Org syntax and
10437 convert them in place to the target language.
10439 ASCII export produces a readable and simple version of an Org file for
10440 printing and sharing notes. HTML export allows you to easily publish notes
10441 on the web, or to build full-fledged websites. @LaTeX{} export lets you use
10442 Org mode and its structured editing functions to create arbitrarily complex
10443 @LaTeX{} files for any kind of document. OpenDocument Text (ODT) export
10444 allows seamless collaboration across organizational boundaries. Markdown
10445 export lets you seamlessly collaborate with other developers. Finally, iCal
10446 export can extract entries with deadlines or appointments to produce a file
10447 in the iCalendar format.
10450 * The export dispatcher:: The main exporter interface
10451 * Export back-ends:: Built-in export formats
10452 * Export settings:: Generic export settings
10453 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
10454 * Beamer export:: Exporting as a Beamer presentation
10455 * HTML export:: Exporting to HTML
10456 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
10457 * Markdown export:: Exporting to Markdown
10458 * OpenDocument Text export:: Exporting to OpenDocument Text
10459 * Org export:: Exporting to Org
10460 * Texinfo export:: Exporting to Texinfo
10461 * iCalendar export:: Exporting to iCalendar
10462 * Other built-in back-ends:: Exporting to a man page
10463 * Export in foreign buffers:: Author tables and lists in Org syntax
10464 * Advanced configuration:: Fine-tuning the export output
10467 @node The export dispatcher
10468 @section The export dispatcher
10469 @vindex org-export-dispatch-use-expert-ui
10470 @cindex Export, dispatcher
10472 The main entry point for export related tasks is the dispatcher, a
10473 hierarchical menu from which it is possible to select an export format and
10474 toggle export options@footnote{It is also possible to use a less intrusive
10475 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10476 non-@code{nil} value. In that case, only a prompt is visible from the
10477 minibuffer. From there one can still switch back to regular menu by pressing
10478 @key{?}.} from which it is possible to select an export format and to toggle
10483 @orgcmd{C-c C-e,org-export-dispatch}
10485 Dispatch for export and publishing commands. When called with a @kbd{C-u}
10486 prefix argument, repeat the last export command on the current buffer while
10487 preserving toggled options. If the current buffer hasn't changed and subtree
10488 export was activated, the command will affect that same subtree.
10492 Normally the entire buffer is exported, but if there is an active region
10493 only that part of the buffer will be exported.
10495 Several export options (@pxref{Export settings}) can be toggled from the
10496 export dispatcher with the following key combinations:
10500 @vindex org-export-async-init-file
10501 Toggle asynchronous export. Asynchronous export uses an external Emacs
10502 process that is configured with a specified initialization file.
10504 While exporting asynchronously, the output is not displayed, but stored in
10505 a place called ``the export stack''. This stack can be displayed by calling
10506 the dispatcher with a double @kbd{C-u} prefix argument, or with @kbd{&} key
10507 from the dispatcher menu.
10509 @vindex org-export-in-background
10510 To make this behavior the default, customize the variable
10511 @code{org-export-in-background}.
10514 Toggle body-only export. Its effect depends on the back-end used.
10515 Typically, if the back-end has a header section (like @code{<head>...</head>}
10516 in the HTML back-end), a body-only export will not include this header.
10519 @vindex org-export-initial-scope
10520 Toggle subtree export. The top heading becomes the document title.
10522 You can change the default state of this option by setting
10523 @code{org-export-initial-scope}.
10526 Toggle visible-only export. Only export the text that is currently
10527 visible, i.e. not hidden by outline visibility in the buffer.
10530 @node Export back-ends
10531 @section Export back-ends
10532 @cindex Export, back-ends
10534 An export back-end is a library that translates Org syntax into a foreign
10535 format. An export format is not available until the proper back-end has been
10538 @vindex org-export-backends
10539 By default, the following four back-ends are loaded: @code{ascii},
10540 @code{html}, @code{icalendar} and @code{latex}. It is possible to add more
10541 (or remove some) by customizing @code{org-export-backends}.
10543 Built-in back-ends include:
10546 @item ascii (ASCII format)
10547 @item beamer (@LaTeX{} Beamer format)
10548 @item html (HTML format)
10549 @item icalendar (iCalendar format)
10550 @item latex (@LaTeX{} format)
10551 @item man (Man page format)
10552 @item md (Markdown format)
10553 @item odt (OpenDocument Text format)
10554 @item org (Org format)
10555 @item texinfo (Texinfo format)
10558 Other back-ends might be found in the @code{contrib/} directory
10559 (@pxref{Installation}).
10561 @node Export settings
10562 @section Export settings
10563 @cindex Export, settings
10566 Export options can be set: globally with variables; for an individual file by
10567 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10568 settings}), by setting individual keywords, or by specifying them in a
10569 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10570 properties (@pxref{Properties and columns}). Options set at a specific level
10571 override options set at a more general level.
10573 @cindex #+SETUPFILE
10574 In-buffer settings may appear anywhere in the file, either directly or
10575 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10576 Option keyword sets tailored to a particular back-end can be inserted from
10577 the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert
10578 template} command by pressing @key{#}. To insert keywords individually,
10579 a good way to make sure the keyword is correct is to type @code{#+} and then
10580 to use @kbd{M-<TAB>} for completion.
10582 The export keywords available for every back-end, and their equivalent global
10583 variables, include:
10588 @vindex user-full-name
10589 The document author (@code{user-full-name}).
10593 @vindex org-export-creator-string
10594 Entity responsible for output generation (@code{org-export-creator-string}).
10598 @vindex org-export-date-timestamp-format
10599 A date or a time-stamp@footnote{The variable
10600 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10604 @cindex #+DESCRIPTION
10605 The document description. Back-ends handle it as they see fit (e.g., for the
10606 XHTML meta tag), if at all. You can use several such keywords for long
10611 @vindex user-mail-address
10612 The email address (@code{user-mail-address}).
10616 The keywords defining the contents of the document. Back-ends handle it as
10617 they see fit (e.g., for the XHTML meta tag), if at all. You can use several
10618 such keywords if the list is long.
10622 @vindex org-export-default-language
10623 The language used for translating some strings
10624 (@code{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell
10625 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10629 @cindex #+SELECT_TAGS
10630 @vindex org-export-select-tags
10631 The tags that select a tree for export (@code{org-export-select-tags}). The
10632 default value is @code{:export:}. Within a subtree tagged with
10633 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10634 below). When headlines are selectively exported with @code{:export:}
10635 anywhere in a file, text before the first headline is ignored.
10638 @cindex #+EXCLUDE_TAGS
10639 @vindex org-export-exclude-tags
10640 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10641 The default value is @code{:noexport:}. Entries with the @code{:noexport:}
10642 tag will be unconditionally excluded from the export, even if they have an
10643 @code{:export:} tag. Code blocks contained in excluded subtrees will still
10644 be executed during export even though the subtree is not exported.
10648 The title to be shown. You can use several such keywords for long titles.
10651 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10652 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10653 recognizes the following arguments:
10657 @vindex org-export-with-smart-quotes
10658 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10661 Toggle emphasized text (@code{org-export-with-emphasize}).
10664 @vindex org-export-with-special-strings
10665 Toggle conversion of special strings
10666 (@code{org-export-with-special-strings}).
10669 @vindex org-export-with-fixed-width
10670 Toggle fixed-width sections
10671 (@code{org-export-with-fixed-width}).
10674 @vindex org-export-with-timestamps
10675 Toggle inclusion of any time/date active/inactive stamps
10676 (@code{org-export-with-timestamps}).
10679 @vindex org-export-preserve-breaks
10680 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10683 @vindex org-export-with-sub-superscripts
10684 Toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}",
10685 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10686 it is (@code{org-export-with-sub-superscripts}).
10689 @vindex org-export-with-archived-trees
10690 Configure export of archived trees. Can be set to @code{headline} to only
10691 process the headline, skipping its contents
10692 (@code{org-export-with-archived-trees}).
10695 @vindex org-export-with-author
10696 Toggle inclusion of author name into exported file
10697 (@code{org-export-with-author}).
10700 @vindex org-export-with-clocks
10701 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10704 @vindex org-export-with-creator
10705 Configure inclusion of creator info into exported file. It may be set to
10706 @code{comment} (@code{org-export-with-creator}).
10709 @vindex org-export-with-drawers
10710 Toggle inclusion of drawers, or list drawers to include
10711 (@code{org-export-with-drawers}).
10714 @vindex org-export-with-entities
10715 Toggle inclusion of entities (@code{org-export-with-entities}).
10718 @vindex org-export-with-email
10719 Toggle inclusion of the author's e-mail into exported file
10720 (@code{org-export-with-email}).
10723 @vindex org-export-with-footnotes
10724 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10727 @vindex org-export-headline-levels
10728 Set the number of headline levels for export
10729 (@code{org-export-headline-levels}). Below that level, headlines are treated
10730 differently. In most back-ends, they become list items.
10733 @vindex org-export-with-inlinetasks
10734 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10737 @vindex org-export-with-section-numbers
10738 Toggle section-numbers (@code{org-export-with-section-numbers}). It can also
10739 be set to a number @samp{n}, so only headlines at that level or above will be
10743 @vindex org-export-with-planning
10744 Toggle export of planning information (@code{org-export-with-planning}).
10745 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10746 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10749 @vindex org-export-with-priority
10750 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10753 @vindex org-export-with-properties
10754 Toggle inclusion of property drawers, or list properties to include
10755 (@code{org-export-with-properties}).
10758 @vindex org-export-with-statistics-cookies
10759 Toggle inclusion of statistics cookies
10760 (@code{org-export-with-statistics-cookies}).
10763 @vindex org-export-with-tags
10764 Toggle inclusion of tags, may also be @code{not-in-toc}
10765 (@code{org-export-with-tags}).
10768 @vindex org-export-with-tasks
10769 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10770 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10771 (@code{org-export-with-tasks}).
10774 @vindex org-export-with-latex
10775 Configure export of @LaTeX{} fragments and environments. It may be set to
10776 @code{verbatim} (@code{org-export-with-latex}).
10779 @vindex org-export-time-stamp-file
10780 Toggle inclusion of the creation time into exported file
10781 (@code{org-export-time-stamp-file}).
10784 @vindex org-export-with-toc
10785 Toggle inclusion of the table of contents, or set the level limit
10786 (@code{org-export-with-toc}).
10789 @vindex org-export-with-todo-keywords
10790 Toggle inclusion of TODO keywords into exported text
10791 (@code{org-export-with-todo-keywords}).
10794 @vindex org-export-with-tables
10795 Toggle inclusion of tables (@code{org-export-with-tables}).
10798 When exporting only a subtree, each of the previous keywords@footnote{With
10799 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
10800 properties. These begin with @samp{EXPORT_}, followed by the name of the
10801 keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords
10802 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10806 @vindex org-export-allow-bind-keywords
10807 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10808 can become buffer-local during export by using the BIND keyword. Its syntax
10809 is @samp{#+BIND: variable value}. This is particularly useful for in-buffer
10810 settings that cannot be changed using specific keywords.
10812 @cindex property, EXPORT_FILE_NAME
10813 The name of the output file to be generated is taken from the file associated
10814 to the buffer, when possible, or asked to you otherwise. For subtree export,
10815 you can also set @samp{EXPORT_FILE_NAME} property. In all cases, only the
10816 base name of the file is retained, and a back-end specific extension is
10819 @node ASCII/Latin-1/UTF-8 export
10820 @section ASCII/Latin-1/UTF-8 export
10821 @cindex ASCII export
10822 @cindex Latin-1 export
10823 @cindex UTF-8 export
10825 ASCII export produces a simple and very readable version of an Org mode
10826 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10827 with special characters and symbols available in these encodings.
10829 @vindex org-ascii-text-width
10830 Upon exporting, text is filled and justified, when appropriate, according the
10831 text width set in @code{org-ascii-text-width}.
10833 @vindex org-ascii-links-to-notes
10834 Links are exported in a footnote-like style, with the descriptive part in the
10835 text and the link in a note before the next heading. See the variable
10836 @code{org-ascii-links-to-notes} for details and other options.
10838 @subheading ASCII export commands
10841 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10842 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
10843 will be @file{myfile.txt}. The file will be overwritten without warning.
10844 When the original file is @file{myfile.txt}, the resulting file becomes
10845 @file{myfile.txt.txt} in order to prevent data loss.
10846 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10847 Export to a temporary buffer. Do not create a file.
10850 @subheading Header and sectioning structure
10852 In the exported version, the first three outline levels become headlines,
10853 defining a general document structure. Additional levels are exported as
10854 lists. The transition can also occur at a different level (@pxref{Export
10857 @subheading Quoting ASCII text
10859 You can insert text that will only appear when using @code{ASCII} back-end
10860 with the following constructs:
10863 @cindex #+BEGIN_ASCII
10865 Text @@@@ascii:and additional text@@@@ within a paragraph.
10870 All lines in this block will appear only when using this back-end.
10874 @subheading ASCII specific attributes
10875 @cindex #+ATTR_ASCII
10876 @cindex horizontal rules, in ASCII export
10878 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10879 specifies the length, in characters, of a given horizontal rule. It must be
10880 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
10883 #+ATTR_ASCII: :width 10
10887 @subheading ASCII special blocks
10888 @cindex special blocks, in ASCII export
10889 @cindex #+BEGIN_JUSTIFYLEFT
10890 @cindex #+BEGIN_JUSTIFYRIGHT
10892 In addition to @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), it is
10893 possible to justify contents to the left or the right of the page with the
10894 following dedicated blocks.
10897 #+BEGIN_JUSTIFYLEFT
10898 It's just a jump to the left...
10901 #+BEGIN_JUSTIFYRIGHT
10902 ...and then a step to the right.
10906 @node Beamer export
10907 @section Beamer export
10908 @cindex Beamer export
10910 The @LaTeX{} class @emph{Beamer} allows production of high quality
10911 presentations using @LaTeX{} and pdf processing. Org mode has special
10912 support for turning an Org mode file or tree into a Beamer presentation.
10914 @subheading Beamer export commands
10917 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
10918 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
10919 file will be @file{myfile.tex}. The file will be overwritten without
10921 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
10922 Export to a temporary buffer. Do not create a file.
10923 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
10924 Export as @LaTeX{} and then process to PDF.
10926 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10929 @subheading Sectioning, Frames and Blocks
10931 Any tree with not-too-deep level nesting should in principle be exportable as
10932 a Beamer presentation. Headlines fall into three categories: sectioning
10933 elements, frames and blocks.
10937 @vindex org-beamer-frame-level
10938 Headlines become frames when their level is equal to
10939 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
10940 (@pxref{Export settings}).
10942 @cindex property, BEAMER_ENV
10943 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
10944 set to either to @code{frame} or @code{fullframe}, its level overrides the
10945 variable. A @code{fullframe} is a frame with an empty (ignored) title.
10948 @vindex org-beamer-environments-default
10949 @vindex org-beamer-environments-extra
10950 All frame's children become @code{block} environments. Special block types
10951 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
10952 this property is set, the entry will also get a @code{:B_environment:} tag to
10953 make this visible. This tag has no semantic meaning, it is only a visual
10954 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
10955 supported values and @code{org-beamer-environments-extra} for adding more).
10958 @cindex property, BEAMER_REF
10959 As a special case, if the @code{BEAMER_ENV} property is set to either
10960 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
10961 headline will become, respectively, an appendix, a note (within frame or
10962 between frame, depending on its level), a note with its title ignored or an
10963 @code{\againframe} command. In the latter case, a @code{BEAMER_REF} property
10964 is mandatory in order to refer to the frame being resumed, and contents are
10967 Also, a headline with an @code{ignoreheading} environment will have its
10968 contents only inserted in the output. This special value is useful to have
10969 data between frames, or to properly close a @code{column} environment.
10972 @cindex property, BEAMER_ACT
10973 @cindex property, BEAMER_OPT
10974 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
10975 The former is translated as an overlay/action specification, or a default
10976 overlay specification when enclosed within square brackets. The latter
10977 specifies options@footnote{The @code{fragile} option is added automatically
10978 if it contains code that requires a verbatim environment, though.} for the
10979 current frame or block. The export back-end will automatically wrap
10980 properties within angular or square brackets when appropriate.
10982 @cindex property, BEAMER_COL
10983 Moreover, headlines handle the @code{BEAMER_COL} property. Its value should
10984 be a decimal number representing the width of the column as a fraction of the
10985 total text width. If the headline has no specific environment, its title
10986 will be ignored and its contents will fill the column created. Otherwise,
10987 the block will fill the whole column and the title will be preserved. Two
10988 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
10989 @code{columns} @LaTeX{} environment. It will end before the next headline
10990 without such a property. This environment is generated automatically.
10991 Although, it can also be explicitly created, with a special @code{columns}
10992 value for @code{BEAMER_ENV} property (if it needs to be set up with some
10993 specific options, for example).
10995 @subheading Beamer specific syntax
10997 Beamer back-end is an extension of @LaTeX{} back-end. As such, all @LaTeX{}
10998 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
10999 recognized. See @ref{@LaTeX{} and PDF export} for more information.
11001 @cindex #+BEAMER_THEME
11002 @cindex #+BEAMER_COLOR_THEME
11003 @cindex #+BEAMER_FONT_THEME
11004 @cindex #+BEAMER_INNER_THEME
11005 @cindex #+BEAMER_OUTER_THEME
11006 Beamer export introduces a number of keywords to insert code in the
11007 document's header. Four control appearance of the presentation:
11008 @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
11009 @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
11010 @code{#+BEAMER_OUTER_THEME}. All of them accept optional arguments
11011 within square brackets. The last one, @code{#+BEAMER_HEADER}, is more
11012 generic and allows you to append any line of code in the header.
11015 #+BEAMER_THEME: Rochester [height=20pt]
11016 #+BEAMER_COLOR_THEME: spruce
11019 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
11020 wrapped within a @code{frame} environment. Those generated from a @code{TOC}
11021 keyword (@pxref{Table of contents}) are not. In that case, it is also
11022 possible to specify options, enclosed within square brackets.
11025 #+TOC: headlines [currentsection]
11028 Beamer specific code can be inserted with the following constructs:
11031 @cindex #+BEGIN_BEAMER
11036 All lines in this block will appear only when using this back-end.
11039 Text @@@@beamer:some code@@@@ within a paragraph.
11042 In particular, this last example can be used to add overlay specifications to
11043 objects whose type is among @code{bold}, @code{item}, @code{link},
11044 @code{radio-target} and @code{target}, when the value is enclosed within
11045 angular brackets and put at the beginning the object.
11048 A *@@@@beamer:<2->@@@@useful* feature
11051 @cindex #+ATTR_BEAMER
11052 Eventually, every plain list has support for @code{:environment},
11053 @code{:overlay} and @code{:options} attributes through
11054 @code{ATTR_BEAMER} affiliated keyword. The first one allows the use
11055 of a different environment, the second sets overlay specifications and
11056 the last one inserts optional arguments in current list environment.
11059 #+ATTR_BEAMER: :overlay +-
11064 @subheading Editing support
11066 You can turn on a special minor mode @code{org-beamer-mode} for faster
11074 @orgcmd{C-c C-b,org-beamer-select-environment}
11075 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
11076 environment or the @code{BEAMER_COL} property.
11079 @subheading An example
11081 Here is a simple example Org document that is intended for Beamer export.
11084 #+TITLE: Example Presentation
11085 #+AUTHOR: Carsten Dominik
11086 #+OPTIONS: H:2 toc:t num:t
11087 #+LATEX_CLASS: beamer
11088 #+LATEX_CLASS_OPTIONS: [presentation]
11089 #+BEAMER_THEME: Madrid
11090 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
11092 * This is the first structural section
11095 *** Thanks to Eric Fraga :B_block:
11100 for the first viable Beamer setup in Org
11101 *** Thanks to everyone else :B_block:
11107 for contributing to the discussion
11108 **** This will be formatted as a beamer note :B_note:
11112 ** Frame 2 (where we will not use columns)
11114 Please test this stuff!
11118 @section HTML export
11119 @cindex HTML export
11121 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
11122 HTML formatting, in ways similar to John Gruber's @emph{markdown}
11123 language, but with additional support for tables.
11126 * HTML Export commands:: How to invoke HTML export
11127 * HTML doctypes:: Org can export to various (X)HTML flavors
11128 * HTML preamble and postamble:: How to insert a preamble and a postamble
11129 * Quoting HTML tags:: Using direct HTML in Org mode
11130 * Links in HTML export:: How links will be interpreted and formatted
11131 * Tables in HTML export:: How to modify the formatting of tables
11132 * Images in HTML export:: How to insert figures into HTML output
11133 * Math formatting in HTML export:: Beautiful math also on the web
11134 * Text areas in HTML export:: An alternative way to show an example
11135 * CSS support:: Changing the appearance of the output
11136 * JavaScript support:: Info and Folding in a web browser
11139 @node HTML Export commands
11140 @subsection HTML export commands
11143 @orgcmd{C-c C-e h h,org-html-export-to-html}
11144 Export as an HTML file. For an Org file @file{myfile.org},
11145 the HTML file will be @file{myfile.html}. The file will be overwritten
11148 Export as an HTML file and immediately open it with a browser.
11149 @orgcmd{C-c C-e h H,org-html-export-as-html}
11150 Export to a temporary buffer. Do not create a file.
11153 @c FIXME Exporting sublevels
11154 @c @cindex headline levels, for exporting
11155 @c In the exported version, the first 3 outline levels will become headlines,
11156 @c defining a general document structure. Additional levels will be exported as
11157 @c itemized lists. If you want that transition to occur at a different level,
11158 @c specify it with a numeric prefix argument. For example,
11161 @c @kbd{C-2 C-c C-e b}
11165 @c creates two levels of headings and does the rest as items.
11167 @node HTML doctypes
11168 @subsection HTML doctypes
11169 @vindex org-html-doctype
11170 @vindex org-html-doctype-alist
11172 Org can export to various (X)HTML flavors.
11174 Setting the variable @code{org-html-doctype} allows you to export to different
11175 (X)HTML variants. The exported HTML will be adjusted according to the syntax
11176 requirements of that variant. You can either set this variable to a doctype
11177 string directly, in which case the exporter will try to adjust the syntax
11178 automatically, or you can use a ready-made doctype. The ready-made options
11185 ``html4-transitional''
11191 ``xhtml-transitional''
11202 See the variable @code{org-html-doctype-alist} for details. The default is
11205 @subsubheading Fancy HTML5 export
11206 @vindex org-html-html5-fancy
11207 @vindex org-html-html5-elements
11209 HTML5 introduces several new element types. By default, Org will not make
11210 use of these element types, but you can set @code{org-html-html5-fancy} to
11211 @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11212 enable a few new block-level elements. These are created using arbitrary
11213 #+BEGIN and #+END blocks. For instance:
11232 #+ATTR_HTML: :controls controls :width 350
11234 #+HTML: <source src="movie.mp4" type="video/mp4">
11235 #+HTML: <source src="movie.ogg" type="video/ogg">
11236 Your browser does not support the video tag.
11243 <video controls="controls" width="350">
11244 <source src="movie.mp4" type="video/mp4">
11245 <source src="movie.ogg" type="video/ogg">
11246 <p>Your browser does not support the video tag.</p>
11250 Special blocks that do not correspond to HTML5 elements (see
11251 @code{org-html-html5-elements}) will revert to the usual behavior, i.e.,
11252 @code{#+BEGIN_lederhosen} will still export to @samp{<div class="lederhosen">}.
11254 Headlines cannot appear within special blocks. To wrap a headline and its
11255 contents in e.g., @samp{<section>} or @samp{<article>} tags, set the
11256 @code{HTML_CONTAINER} property on the headline itself.
11258 @node HTML preamble and postamble
11259 @subsection HTML preamble and postamble
11260 @vindex org-html-preamble
11261 @vindex org-html-postamble
11262 @vindex org-html-preamble-format
11263 @vindex org-html-postamble-format
11264 @vindex org-html-validation-link
11265 @vindex org-export-creator-string
11266 @vindex org-export-time-stamp-file
11268 The HTML exporter lets you define a preamble and a postamble.
11270 The default value for @code{org-html-preamble} is @code{t}, which means
11271 that the preamble is inserted depending on the relevant format string in
11272 @code{org-html-preamble-format}.
11274 Setting @code{org-html-preamble} to a string will override the default format
11275 string. If you set it to a function, it will insert the output of the
11276 function, which must be a string. Setting to @code{nil} will not insert any
11279 The default value for @code{org-html-postamble} is @code{'auto}, which means
11280 that the HTML exporter will look for information about the author, the email,
11281 the creator and the date, and build the postamble from these values. Setting
11282 @code{org-html-postamble} to @code{t} will insert the postamble from the
11283 relevant format string found in @code{org-html-postamble-format}. Setting it
11284 to @code{nil} will not insert any postamble.
11286 @node Quoting HTML tags
11287 @subsection Quoting HTML tags
11289 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
11290 @samp{>} in HTML export. If you want to include raw HTML code, which
11291 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11292 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}. For more extensive HTML
11293 that should be copied verbatim to the exported file use either
11296 @cindex #+BEGIN_HTML
11298 #+HTML: Literal HTML code for export
11302 @cindex #+BEGIN_HTML
11306 All lines between these markers are exported literally
11311 @node Links in HTML export
11312 @subsection Links in HTML export
11314 @cindex links, in HTML export
11315 @cindex internal links, in HTML export
11316 @cindex external links, in HTML export
11317 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
11318 includes automatic links created by radio targets (@pxref{Radio
11319 targets}). Links to external files will still work if the target file is on
11320 the same @i{relative} path as the published Org file. Links to other
11321 @file{.org} files will be translated into HTML links under the assumption
11322 that an HTML version also exists of the linked file, at the same relative
11323 path. @samp{id:} links can then be used to jump to specific entries across
11324 files. For information related to linking files while publishing them to a
11325 publishing directory see @ref{Publishing links}.
11327 If you want to specify attributes for links, you can do so using a special
11328 @code{#+ATTR_HTML} line to define attributes that will be added to the
11329 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
11330 and @code{style} attributes for a link:
11332 @cindex #+ATTR_HTML
11334 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11335 [[http://orgmode.org]]
11338 @node Tables in HTML export
11339 @subsection Tables in HTML export
11340 @cindex tables, in HTML
11341 @vindex org-html-table-default-attributes
11343 Org mode tables are exported to HTML using the table attributes defined in
11344 @code{org-html-table-default-attributes}. The default setting makes tables
11345 without cell borders and frame. If you would like to change this for
11346 individual tables, place something like the following before the table:
11349 @cindex #+ATTR_HTML
11351 #+CAPTION: This is a table with lines around and between cells
11352 #+ATTR_HTML: :border 2 :rules all :frame border
11355 You can also group columns in the HTML output (@pxref{Column groups}).
11357 Below is a list of options for customizing tables HTML export.
11360 @vindex org-html-table-align-individual-fields
11361 @item org-html-table-align-individual-fields
11362 Non-nil means attach style attributes for alignment to each table field.
11364 @vindex org-html-table-caption-above
11365 @item org-html-table-caption-above
11366 When non-nil, place caption string at the beginning of the table.
11368 @vindex org-html-table-data-tags
11369 @item org-html-table-data-tags
11370 The opening and ending tags for table data fields.
11372 @vindex org-html-table-default-attributes
11373 @item org-html-table-default-attributes
11374 Default attributes and values which will be used in table tags.
11376 @vindex org-html-table-header-tags
11377 @item org-html-table-header-tags
11378 The opening and ending tags for table header fields.
11380 @vindex org-html-table-row-tags
11381 @item org-html-table-row-tags
11382 The opening and ending tags for table rows.
11384 @vindex org-html-table-use-header-tags-for-first-column
11385 @item org-html-table-use-header-tags-for-first-column
11386 Non-nil means format column one in tables with header tags.
11389 @node Images in HTML export
11390 @subsection Images in HTML export
11392 @cindex images, inline in HTML
11393 @cindex inlining images in HTML
11394 @vindex org-html-inline-images
11395 HTML export can inline images given as links in the Org file, and
11396 it can make an image the clickable part of a link. By
11397 default@footnote{But see the variable
11398 @code{org-html-inline-images}.}, images are inlined if a link does
11399 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
11400 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11401 @samp{the image} that points to the image. If the description part
11402 itself is a @code{file:} link or a @code{http:} URL pointing to an
11403 image, this image will be inlined and activated so that clicking on the
11404 image will activate the link. For example, to include a thumbnail that
11405 will link to a high resolution version of the image, you could use:
11408 [[file:highres.jpg][file:thumb.jpg]]
11411 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11412 In the example below we specify the @code{alt} and @code{title} attributes to
11413 support text viewers and accessibility, and align it to the right.
11416 @cindex #+ATTR_HTML
11418 #+CAPTION: A black cat stalking a spider
11419 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11424 You could use @code{http} addresses just as well.
11426 @node Math formatting in HTML export
11427 @subsection Math formatting in HTML export
11430 @cindex imagemagick
11432 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11433 different ways on HTML pages. The default is to use the
11434 @uref{http://www.mathjax.org, MathJax system} which should work out of the
11435 box with Org mode installation because @uref{http://orgmode.org} serves
11436 @file{MathJax} for Org mode users for small applications and for testing
11437 purposes. @b{If you plan to use this regularly or on pages with significant
11438 page views, you should install@footnote{Installation instructions can be
11439 found on the MathJax website, see
11440 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
11441 your own server in order to limit the load of our server.} To configure
11442 @file{MathJax}, use the variable @code{org-html-mathjax-options} or
11443 insert something like the following into the buffer:
11446 #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
11449 @noindent See the docstring of the variable
11450 @code{org-html-mathjax-options} for the meaning of the parameters in
11453 If you prefer, you can also request that @LaTeX{} fragments are processed
11454 into small images that will be inserted into the browser page. Before the
11455 availability of MathJax, this was the default method for Org files. This
11456 method requires that the @file{dvipng} program or @file{imagemagick} suite is
11457 available on your system. You can still get this processing with
11460 #+OPTIONS: tex:dvipng
11466 #+OPTIONS: tex:imagemagick
11469 @node Text areas in HTML export
11470 @subsection Text areas in HTML export
11472 @cindex text areas, in HTML
11473 An alternative way to publish literal code examples in HTML is to use text
11474 areas, where the example can even be edited before pasting it into an
11475 application. It is triggered by @code{:textarea} attribute at an
11476 @code{example} or @code{src} block.
11478 You may also use @code{:height} and @code{:width} attributes to specify the
11479 height and width of the text area, which default to the number of lines in
11480 the example, and 80, respectively. For example
11483 #+ATTR_HTML: :textarea t :width 40
11485 (defun org-xor (a b)
11493 @subsection CSS support
11494 @cindex CSS, for HTML export
11495 @cindex HTML export, CSS
11497 @vindex org-html-todo-kwd-class-prefix
11498 @vindex org-html-tag-class-prefix
11499 You can modify the CSS style definitions for the exported file. The HTML
11500 exporter assigns the following special CSS classes@footnote{If the classes on
11501 TODO keywords and tags lead to conflicts, use the variables
11502 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11503 make them unique.} to appropriate parts of the document---your style
11504 specifications may change these, in addition to any of the standard classes
11505 like for headlines, tables, etc.
11507 p.author @r{author information, including email}
11508 p.date @r{publishing date}
11509 p.creator @r{creator info, about org mode version}
11510 .title @r{document title}
11511 .todo @r{TODO keywords, all not-done states}
11512 .done @r{the DONE keywords, all states that count as done}
11513 .WAITING @r{each TODO keyword also uses a class named after itself}
11514 .timestamp @r{timestamp}
11515 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
11516 .timestamp-wrapper @r{span around keyword plus timestamp}
11517 .tag @r{tag in a headline}
11518 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
11519 .target @r{target for links}
11520 .linenr @r{the line number in a code example}
11521 .code-highlighted @r{for highlighting referenced code lines}
11522 div.outline-N @r{div for outline level N (headline plus text))}
11523 div.outline-text-N @r{extra div for text at outline level N}
11524 .section-number-N @r{section number in headlines, different for each level}
11525 .figure-number @r{label like "Figure 1:"}
11526 .table-number @r{label like "Table 1:"}
11527 .listing-number @r{label like "Listing 1:"}
11528 div.figure @r{how to format an inlined image}
11529 pre.src @r{formatted source code}
11530 pre.example @r{normal example}
11531 p.verse @r{verse paragraph}
11532 div.footnotes @r{footnote section headline}
11533 p.footnote @r{footnote definition paragraph, containing a footnote}
11534 .footref @r{a footnote reference number (always a <sup>)}
11535 .footnum @r{footnote number in footnote definition (always <sup>)}
11538 @vindex org-html-style-default
11539 @vindex org-html-head-include-default-style
11540 @vindex org-html-head
11541 @vindex org-html-head-extra
11542 @cindex #+HTML_INCLUDE_STYLE
11543 Each exported file contains a compact default style that defines these
11544 classes in a basic way@footnote{This style is defined in the constant
11545 @code{org-html-style-default}, which you should not modify. To turn
11546 inclusion of these defaults off, customize
11547 @code{org-html-head-include-default-style} or set @code{html-style} to
11548 @code{nil} in an @code{OPTIONS} line.}. You may overwrite these settings, or
11549 add to them by using the variables @code{org-html-head} and
11550 @code{org-html-head-extra}. You can override the global values of these
11551 variables for each file by using these keywords:
11553 @cindex #+HTML_HEAD
11554 @cindex #+HTML_HEAD_EXTRA
11556 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11557 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11561 For longer style definitions, you can use several such lines. You could also
11562 directly write a @code{<style>} @code{</style>} section in this way, without
11563 referring to an external file.
11565 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11566 property to assign a class to the tree. In order to specify CSS styles for a
11567 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11570 @c FIXME: More about header and footer styles
11571 @c FIXME: Talk about links and targets.
11573 @node JavaScript support
11574 @subsection JavaScript supported display of web pages
11576 @cindex Rose, Sebastian
11577 Sebastian Rose has written a JavaScript program especially designed to
11578 enhance the web viewing experience of HTML files created with Org. This
11579 program allows you to view large files in two different ways. The first one
11580 is an @emph{Info}-like mode where each section is displayed separately and
11581 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11582 as well, press @kbd{?} for an overview of the available keys). The second
11583 view type is a @emph{folding} view much like Org provides inside Emacs. The
11584 script is available at @url{http://orgmode.org/org-info.js} and you can find
11585 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11586 We host the script at our site, but if you use it a lot, you might not want
11587 to be dependent on @url{http://orgmode.org} and prefer to install a local
11588 copy on your own web server.
11590 All it then takes to use this program is adding a single line to the Org
11593 @cindex #+INFOJS_OPT
11595 #+INFOJS_OPT: view:info toc:nil
11599 If this line is found, the HTML header will automatically contain the code
11600 needed to invoke the script. Using the line above, you can set the following
11604 path: @r{The path to the script. The default is to grab the script from}
11605 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11606 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11607 view: @r{Initial view when the website is first shown. Possible values are:}
11608 info @r{Info-like interface with one section per page.}
11609 overview @r{Folding interface, initially showing only top-level.}
11610 content @r{Folding interface, starting with all headlines visible.}
11611 showall @r{Folding interface, all headlines and text visible.}
11612 sdepth: @r{Maximum headline level that will still become an independent}
11613 @r{section for info and folding modes. The default is taken from}
11614 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11615 @r{If this is smaller than in @code{org-export-headline-levels}, each}
11616 @r{info/folding section can still contain child headlines.}
11617 toc: @r{Should the table of contents @emph{initially} be visible?}
11618 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11619 tdepth: @r{The depth of the table of contents. The defaults are taken from}
11620 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11621 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
11622 @r{If yes, the toc will never be displayed as a section.}
11623 ltoc: @r{Should there be short contents (children) in each section?}
11624 @r{Make this @code{above} if the section should be above initial text.}
11625 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
11626 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11627 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
11628 @r{default), only one such button will be present.}
11631 @vindex org-html-infojs-options
11632 @vindex org-html-use-infojs
11633 You can choose default values for these options by customizing the variable
11634 @code{org-html-infojs-options}. If you always want to apply the script to your
11635 pages, configure the variable @code{org-html-use-infojs}.
11637 @node @LaTeX{} and PDF export
11638 @section @LaTeX{} and PDF export
11639 @cindex @LaTeX{} export
11642 @LaTeX{} export can produce an arbitrarily complex LaTeX document of any
11643 standard or custom document class. With further processing@footnote{The
11644 default @LaTeX{} output is designed for processing with @code{pdftex} or
11645 @LaTeX{}. It includes packages that are not compatible with @code{xetex} and
11646 possibly @code{luatex}. The @LaTeX{} exporter can be configured to support
11647 alternative TeX engines, see the options
11648 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}.},
11649 which the @LaTeX{} exporter is able to control, this back-end is able to
11650 produce PDF output. Because the @LaTeX{} exporter can be configured to use
11651 the @code{hyperref} package, the default setup produces fully-linked PDF
11654 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11655 will not be started if two contiguous syntactical elements are not separated
11658 This back-end also offers enhanced support for footnotes. Thus, it handles
11659 nested footnotes, footnotes in tables and footnotes in a list item's
11663 * @LaTeX{} export commands:: How to export to LaTeX and PDF
11664 * Header and sectioning:: Setting up the export file structure
11665 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
11666 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
11669 @node @LaTeX{} export commands
11670 @subsection @LaTeX{} export commands
11673 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11674 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11675 file will be @file{myfile.tex}. The file will be overwritten without
11677 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11678 Export to a temporary buffer. Do not create a file.
11679 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11680 Export as @LaTeX{} and then process to PDF.
11682 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11685 @node Header and sectioning
11686 @subsection Header and sectioning structure
11687 @cindex @LaTeX{} class
11688 @cindex @LaTeX{} sectioning structure
11689 @cindex @LaTeX{} header
11690 @cindex header, for @LaTeX{} files
11691 @cindex sectioning structure, for @LaTeX{} export
11693 By default, the first three outline levels become headlines, defining a
11694 general document structure. Additional levels are exported as @code{itemize}
11695 or @code{enumerate} lists. The transition can also occur at a different
11696 level (@pxref{Export settings}).
11698 By default, the @LaTeX{} output uses the class @code{article}.
11700 @vindex org-latex-default-class
11701 @vindex org-latex-classes
11702 @vindex org-latex-default-packages-alist
11703 @vindex org-latex-packages-alist
11704 You can change this globally by setting a different value for
11705 @code{org-latex-default-class} or locally by adding an option like
11706 @code{#+LATEX_CLASS: myclass} in your file, or with
11707 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11708 containing only this (sub)tree. The class must be listed in
11709 @code{org-latex-classes}. This variable defines a header template for each
11710 class@footnote{Into which the values of
11711 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
11712 are spliced.}, and allows you to define the sectioning structure for each
11713 class. You can also define your own classes there.
11715 @cindex #+LATEX_CLASS
11716 @cindex #+LATEX_CLASS_OPTIONS
11717 @cindex property, EXPORT_LATEX_CLASS
11718 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
11719 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
11720 property can specify the options for the @code{\documentclass} macro. These
11721 options have to be provided, as expected by @LaTeX{}, within square brackets.
11723 @cindex #+LATEX_HEADER
11724 @cindex #+LATEX_HEADER_EXTRA
11725 You can also use the @code{LATEX_HEADER} and
11726 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
11727 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
11728 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
11729 to add lines to the header. See the docstring of @code{org-latex-classes} for
11732 An example is shown below.
11735 #+LATEX_CLASS: article
11736 #+LATEX_CLASS_OPTIONS: [a4paper]
11737 #+LATEX_HEADER: \usepackage@{xyz@}
11743 @node Quoting @LaTeX{} code
11744 @subsection Quoting @LaTeX{} code
11746 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11747 inserted into the @LaTeX{} file. Furthermore, you can add special code that
11748 should only be present in @LaTeX{} export with the following constructs:
11751 @cindex #+BEGIN_LATEX
11753 Code within @@@@latex:some code@@@@ a paragraph.
11755 #+LATEX: Literal @LaTeX{} code for export
11758 All lines between these markers are exported literally
11762 @node @LaTeX{} specific attributes
11763 @subsection @LaTeX{} specific attributes
11764 @cindex #+ATTR_LATEX
11766 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line. They
11767 affect tables, images, plain lists, special blocks and source blocks.
11769 @subsubheading Tables in @LaTeX{} export
11770 @cindex tables, in @LaTeX{} export
11772 For @LaTeX{} export of a table, you can specify a label and a caption
11773 (@pxref{Images and tables}). You can also use attributes to control table
11774 layout and contents. Valid @LaTeX{} attributes include:
11778 @vindex org-latex-default-table-mode
11779 Nature of table's contents. It can be set to @code{table}, @code{math},
11780 @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or
11781 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11782 ignored and the table will be wrapped in a math environment. Also,
11783 contiguous tables sharing the same math mode will be wrapped within the same
11784 environment. Default mode is determined in
11785 @code{org-latex-default-table-mode}.
11787 @vindex org-latex-default-table-environment
11788 Environment used for the table. It can be set to any @LaTeX{} table
11789 environment, like @code{tabularx}@footnote{Requires adding the
11790 @code{tabularx} package to @code{org-latex-packages-alist}.},
11791 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
11792 @code{tabu} package to @code{org-latex-packages-alist}.},
11793 @code{bmatrix}@enddots{} It defaults to
11794 @code{org-latex-default-table-environment} value.
11796 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
11797 (@pxref{Images and tables}). If you need more advanced commands for that
11798 task, you can use @code{:caption} attribute instead. Its value should be raw
11799 @LaTeX{} code. It has precedence over @code{#+CAPTION}.
11802 The @code{:float} specifies the float environment for the table. Possible
11803 values are @code{sideways}@footnote{Formerly, the value was
11804 @code{sidewaystable}. This is deprecated since Org 8.3.},
11805 @code{multicolumn}, @code{t} and @code{nil}. When unspecified, a table with
11806 a caption will have a @code{table} environment. Moreover, the
11807 @code{:placement} attribute can specify the positioning of the float. Note:
11808 @code{:placement} is ignored for @code{:float sideways} tables.
11812 Set, respectively, the alignment string of the table, its font size and its
11813 width. They only apply on regular tables.
11815 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11816 only takes effect when used in conjunction with the @code{:width} attribute.
11817 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
11818 value of @code{:width}.
11822 @vindex org-latex-tables-booktabs
11823 @vindex org-latex-tables-centered
11824 They toggle, respectively, @code{booktabs} usage (assuming the package is
11825 properly loaded), table centering and removal of every horizontal rule but
11826 the first one (in a "table.el" table only). In particular,
11827 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
11828 activates the first (respectively second) attribute globally.
11830 @itemx :math-suffix
11831 @itemx :math-arguments
11832 A string that will be inserted, respectively, before the table within the
11833 math environment, after the table within the math environment, and between
11834 the macro name and the contents of the table. The @code{:math-arguments}
11835 attribute is used for matrix macros that require more than one argument
11836 (e.g., @code{qbordermatrix}).
11839 Thus, attributes can be used in a wide array of situations, like writing
11840 a table that will span over multiple pages, or a matrix product:
11843 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11847 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11850 #+ATTR_LATEX: :mode math :environment bmatrix
11855 In the example below, @LaTeX{} command
11856 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
11859 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11865 @subsubheading Images in @LaTeX{} export
11866 @cindex images, inline in @LaTeX{}
11867 @cindex inlining images in @LaTeX{}
11869 Images that are linked to without a description part in the link, like
11870 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11871 output file resulting from @LaTeX{} processing. Org will use an
11872 @code{\includegraphics} macro to insert the image@footnote{In the case of
11873 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11874 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
11876 You can specify specify image width or height with, respectively,
11877 @code{:width} and @code{:height} attributes. It is also possible to add any
11878 other option with the @code{:options} attribute, as shown in the following
11882 #+ATTR_LATEX: :width 5cm :options angle=90
11883 [[./img/sed-hr4049.pdf]]
11886 If you need a specific command for the caption, use @code{:caption}
11887 attribute. It will override standard @code{#+CAPTION} value, if any.
11890 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11891 [[./img/sed-hr4049.pdf]]
11894 If you have specified a caption as described in @ref{Images and tables}, the
11895 picture will be wrapped into a @code{figure} environment and thus become
11896 a floating element. You can also ask Org to export an image as a float
11897 without specifying caption by setting the @code{:float} attribute. You may
11901 @code{t}: if you want to use the standard @samp{figure} environment. It is
11902 used by default if you provide a caption to the image.
11904 @code{multicolumn}: if you wish to include an image which spans multiple
11905 columns in a page. This will export the image wrapped in a @code{figure*}
11908 @code{wrap}: if you would like to let text flow around the image. It will
11909 make the figure occupy the left half of the page.
11911 @code{sideways}: if you would like the image to appear alone on a separate
11912 page rotated ninety degrees using the @code{sidewaysfigure}
11913 environment. Setting this @code{:float} option will ignore the
11914 @code{:placement} setting.
11916 @code{nil}: if you need to avoid any floating environment, even when
11917 a caption is provided.
11920 To modify the placement option of any floating environment, set the
11921 @code{placement} attribute.
11924 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
11928 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
11929 the @LaTeX{} @code{\includegraphics} macro will be commented out.
11931 @subsubheading Plain lists in @LaTeX{} export
11932 @cindex plain lists, in @LaTeX{} export
11934 Plain lists accept two optional attributes: @code{:environment} and
11935 @code{:options}. The first one allows the use of a non-standard environment
11936 (e.g., @samp{inparaenum}). The second one specifies additional arguments for
11940 #+ATTR_LATEX: :environment compactitem :options [$\circ$]
11941 - you need ``paralist'' package to reproduce this example.
11944 @subsubheading Source blocks in @LaTeX{} export
11945 @cindex source blocks, in @LaTeX{} export
11947 In addition to syntax defined in @ref{Literal examples}, names and captions
11948 (@pxref{Images and tables}), source blocks also accept two additional
11949 attributes: @code{:float} and @code{:options}.
11951 You may set the former to
11954 @code{t}: if you want to make the source block a float. It is the default
11955 value when a caption is provided.
11957 @code{multicolumn}: if you wish to include a source block which spans multiple
11960 @code{nil}: if you need to avoid any floating environment, even when a caption
11961 is provided. It is useful for source code that may not fit in a single page.
11965 #+ATTR_LATEX: :float nil
11966 #+BEGIN_SRC emacs-lisp
11967 Code that may not fit in a single page.
11971 @vindex org-latex-listings-options
11972 @vindex org-latex-minted-options
11973 The latter allows to specify options relative to the package used to
11974 highlight code in the output (e.g., @code{listings}). This is the local
11975 counterpart to @code{org-latex-listings-options} and
11976 @code{org-latex-minted-options} variables, which see.
11979 #+ATTR_LATEX: :options commentstyle=\bfseries
11980 #+BEGIN_SRC emacs-lisp
11981 (defun Fib (n) ; Count rabbits.
11982 (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
11986 @subsubheading Special blocks in @LaTeX{} export
11987 @cindex special blocks, in @LaTeX{} export
11988 @cindex abstract, in @LaTeX{} export
11989 @cindex proof, in @LaTeX{} export
11991 In @LaTeX{} back-end, special blocks become environments of the same name.
11992 Value of @code{:options} attribute will be appended as-is to that
11993 environment's opening string. For example:
11997 We demonstrate how to solve the Syracuse problem.
12000 #+ATTR_LATEX: :options [Proof of important theorem]
12003 Therefore, any even number greater than 2 is the sum of two primes.
12012 We demonstrate how to solve the Syracuse problem.
12015 \begin@{proof@}[Proof of important theorem]
12017 Therefore, any even number greater than 2 is the sum of two primes.
12021 If you need to insert a specific caption command, use @code{:caption}
12022 attribute. It will override standard @code{#+CAPTION} value, if any. For
12026 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
12032 @subsubheading Horizontal rules
12033 @cindex horizontal rules, in @LaTeX{} export
12035 Width and thickness of a given horizontal rule can be controlled with,
12036 respectively, @code{:width} and @code{:thickness} attributes:
12039 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
12043 @node Markdown export
12044 @section Markdown export
12045 @cindex Markdown export
12047 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
12048 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
12051 It is built over HTML back-end: any construct not supported by Markdown
12052 syntax (e.g., tables) will be controlled and translated by @code{html}
12053 back-end (@pxref{HTML export}).
12055 @subheading Markdown export commands
12058 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
12059 Export as a text file written in Markdown syntax. For an Org file,
12060 @file{myfile.org}, the resulting file will be @file{myfile.md}. The file
12061 will be overwritten without warning.
12062 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
12063 Export to a temporary buffer. Do not create a file.
12065 Export as a text file with Markdown syntax, then open it.
12068 @subheading Header and sectioning structure
12070 @vindex org-md-headline-style
12071 Markdown export can generate both @code{atx} and @code{setext} types for
12072 headlines, according to @code{org-md-headline-style}. The former introduces
12073 a hard limit of two levels, whereas the latter pushes it to six. Headlines
12074 below that limit are exported as lists. You can also set a soft limit before
12075 that one (@pxref{Export settings}).
12077 @c begin opendocument
12079 @node OpenDocument Text export
12080 @section OpenDocument Text export
12082 @cindex OpenDocument
12083 @cindex export, OpenDocument
12084 @cindex LibreOffice
12086 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
12087 (ODT) format. Documents created by this exporter use the
12088 @cite{OpenDocument-v1.2
12089 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12090 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
12091 are compatible with LibreOffice 3.4.
12094 * Pre-requisites for ODT export:: What packages ODT exporter relies on
12095 * ODT export commands:: How to invoke ODT export
12096 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
12097 * Applying custom styles:: How to apply custom styles to the output
12098 * Links in ODT export:: How links will be interpreted and formatted
12099 * Tables in ODT export:: How Tables are exported
12100 * Images in ODT export:: How to insert images
12101 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
12102 * Labels and captions in ODT export:: How captions are rendered
12103 * Literal examples in ODT export:: How source and example blocks are formatted
12104 * Advanced topics in ODT export:: Read this if you are a power user
12107 @node Pre-requisites for ODT export
12108 @subsection Pre-requisites for ODT export
12110 The ODT exporter relies on the @file{zip} program to create the final
12111 output. Check the availability of this program before proceeding further.
12113 @node ODT export commands
12114 @subsection ODT export commands
12116 @subsubheading Exporting to ODT
12117 @anchor{x-export-to-odt}
12119 @cindex region, active
12120 @cindex active region
12121 @cindex transient-mark-mode
12123 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
12124 @cindex property EXPORT_FILE_NAME
12126 Export as OpenDocument Text file.
12128 @vindex org-odt-preferred-output-format
12129 If @code{org-odt-preferred-output-format} is specified, automatically convert
12130 the exported file to that format. @xref{x-export-to-other-formats, ,
12131 Automatically exporting to other formats}.
12133 For an Org file @file{myfile.org}, the ODT file will be
12134 @file{myfile.odt}. The file will be overwritten without warning. If there
12135 is an active region,@footnote{This requires @code{transient-mark-mode} to be
12136 turned on} only the region will be exported. If the selected region is a
12137 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
12138 tree head will become the document title. If the tree head entry has, or
12139 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
12143 Export as an OpenDocument Text file and open the resulting file.
12145 @vindex org-odt-preferred-output-format
12146 If @code{org-odt-preferred-output-format} is specified, open the converted
12147 file instead. @xref{x-export-to-other-formats, , Automatically exporting to
12151 @node Extending ODT export
12152 @subsection Extending ODT export
12154 The ODT exporter can interface with a variety of document
12155 converters and supports popular converters out of the box. As a result, you
12156 can use it to export to formats like @samp{doc} or convert a document from
12157 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
12159 @cindex @file{unoconv}
12160 @cindex LibreOffice
12161 If you have a working installation of LibreOffice, a document converter is
12162 pre-configured for you and you can use it right away. If you would like to
12163 use @file{unoconv} as your preferred converter, customize the variable
12164 @code{org-odt-convert-process} to point to @code{unoconv}. You can
12165 also use your own favorite converter or tweak the default settings of the
12166 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
12167 document converter}.
12169 @subsubheading Automatically exporting to other formats
12170 @anchor{x-export-to-other-formats}
12172 @vindex org-odt-preferred-output-format
12173 Very often, you will find yourself exporting to ODT format, only to
12174 immediately save the exported document to other formats like @samp{doc},
12175 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
12176 preferred output format by customizing the variable
12177 @code{org-odt-preferred-output-format}. This way, the export commands
12178 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
12179 format that is of immediate interest to you.
12181 @subsubheading Converting between document formats
12182 @anchor{x-convert-to-other-formats}
12184 There are many document converters in the wild which support conversion to
12185 and from various file formats, including, but not limited to the
12186 ODT format. LibreOffice converter, mentioned above, is one such
12187 converter. Once a converter is configured, you can interact with it using
12188 the following command.
12190 @vindex org-odt-convert
12193 @item M-x org-odt-convert RET
12194 Convert an existing document from one format to another. With a prefix
12195 argument, also open the newly produced file.
12198 @node Applying custom styles
12199 @subsection Applying custom styles
12200 @cindex styles, custom
12201 @cindex template, custom
12203 The ODT exporter ships with a set of OpenDocument styles
12204 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12205 output. These factory styles, however, may not cater to your specific
12206 tastes. To customize the output, you can either modify the above styles
12207 files directly, or generate the required styles using an application like
12208 LibreOffice. The latter method is suitable for expert and non-expert
12209 users alike, and is described here.
12211 @subsubheading Applying custom styles: the easy way
12215 Create a sample @file{example.org} file with the below settings and export it
12219 #+OPTIONS: H:10 num:t
12223 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
12224 to locate the target styles---these typically have the @samp{Org} prefix---and
12225 modify those to your taste. Save the modified file either as an
12226 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12229 @cindex #+ODT_STYLES_FILE
12230 @vindex org-odt-styles-file
12231 Customize the variable @code{org-odt-styles-file} and point it to the
12232 newly created file. For additional configuration options
12233 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12235 If you would like to choose a style on a per-file basis, you can use the
12236 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
12239 #+ODT_STYLES_FILE: "/path/to/example.ott"
12245 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12250 @subsubheading Using third-party styles and templates
12252 You can use third-party styles and templates for customizing your output.
12253 This will produce the desired output only if the template provides all
12254 style names that the @samp{ODT} exporter relies on. Unless this condition is
12255 met, the output is going to be less than satisfactory. So it is highly
12256 recommended that you only work with templates that are directly derived from
12257 the factory settings.
12259 @node Links in ODT export
12260 @subsection Links in ODT export
12261 @cindex links, in ODT export
12263 ODT exporter creates native cross-references for internal links. It creates
12264 Internet-style links for all other links.
12266 A link with no description and destined to a regular (un-itemized) outline
12267 heading is replaced with a cross-reference and section number of the heading.
12269 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
12270 with a cross-reference and sequence number of the labeled entity.
12271 @xref{Labels and captions in ODT export}.
12273 @node Tables in ODT export
12274 @subsection Tables in ODT export
12275 @cindex tables, in ODT export
12277 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12278 tables is supported. However, export of complex @file{table.el} tables---tables
12279 that have column or row spans---is not supported. Such tables are
12280 stripped from the exported document.
12282 By default, a table is exported with top and bottom frames and with rules
12283 separating row and column groups (@pxref{Column groups}). Furthermore, all
12284 tables are typeset to occupy the same width. If the table specifies
12285 alignment and relative width for its columns (@pxref{Column width and
12286 alignment}) then these are honored on export.@footnote{The column widths are
12287 interpreted as weighted ratios with the default weight being 1}
12290 You can control the width of the table by specifying @code{:rel-width}
12291 property using an @code{#+ATTR_ODT} line.
12293 For example, consider the following table which makes use of all the rules
12297 #+ATTR_ODT: :rel-width 50
12298 | Area/Month | Jan | Feb | Mar | Sum |
12299 |---------------+-------+-------+-------+-------|
12301 | <l13> | <r5> | <r5> | <r5> | <r6> |
12302 | North America | 1 | 21 | 926 | 948 |
12303 | Middle East | 6 | 75 | 844 | 925 |
12304 | Asia Pacific | 9 | 27 | 790 | 826 |
12305 |---------------+-------+-------+-------+-------|
12306 | Sum | 16 | 123 | 2560 | 2699 |
12309 On export, the table will occupy 50% of text area. The columns will be sized
12310 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
12311 and rest of the columns will be right-aligned. There will be vertical rules
12312 after separating the header and last columns from other columns. There will
12313 be horizontal rules separating the header and last rows from other rows.
12315 If you are not satisfied with the above formatting options, you can create
12316 custom table styles and associate them with a table using the
12317 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
12319 @node Images in ODT export
12320 @subsection Images in ODT export
12321 @cindex images, embedding in ODT
12322 @cindex embedding images in ODT
12324 @subsubheading Embedding images
12325 You can embed images within the exported document by providing a link to the
12326 desired image file with no link description. For example, to embed
12327 @samp{img.png} do either of the following:
12337 @subsubheading Embedding clickable images
12338 You can create clickable images by providing a link whose description is a
12339 link to an image file. For example, to embed a image
12340 @file{org-mode-unicorn.png} which when clicked jumps to
12341 @uref{http://Orgmode.org} website, do the following
12344 [[http://orgmode.org][./org-mode-unicorn.png]]
12347 @subsubheading Sizing and scaling of embedded images
12350 You can control the size and scale of the embedded images using the
12351 @code{#+ATTR_ODT} attribute.
12353 @cindex identify, ImageMagick
12354 @vindex org-odt-pixels-per-inch
12355 The exporter specifies the desired size of the image in the final document in
12356 units of centimeters. In order to scale the embedded images, the exporter
12357 queries for pixel dimensions of the images using one of a) ImageMagick's
12358 @file{identify} program or b) Emacs `create-image' and `image-size'
12359 APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you
12360 routinely produce documents that have large images or you export your Org
12361 files that has images using a Emacs batch script, then the use of
12362 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12363 converted in to units of centimeters using
12364 @code{org-odt-pixels-per-inch}. The default value of this variable is
12365 set to @code{display-pixels-per-inch}. You can tweak this variable to
12366 achieve the best results.
12368 The examples below illustrate the various possibilities.
12371 @item Explicitly size the image
12372 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12375 #+ATTR_ODT: :width 10 :height 10
12379 @item Scale the image
12380 To embed @file{img.png} at half its size, do the following:
12383 #+ATTR_ODT: :scale 0.5
12387 @item Scale the image to a specific width
12388 To embed @file{img.png} with a width of 10 cm while retaining the original
12389 height:width ratio, do the following:
12392 #+ATTR_ODT: :width 10
12396 @item Scale the image to a specific height
12397 To embed @file{img.png} with a height of 10 cm while retaining the original
12398 height:width ratio, do the following
12401 #+ATTR_ODT: :height 10
12406 @subsubheading Anchoring of images
12409 You can control the manner in which an image is anchored by setting the
12410 @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
12411 of the following three values for the @code{:anchor} property:
12412 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12414 To create an image that is anchored to a page, do the following:
12416 #+ATTR_ODT: :anchor "page"
12420 @node Math formatting in ODT export
12421 @subsection Math formatting in ODT export
12423 The ODT exporter has special support for handling math.
12426 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
12427 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
12430 @node Working with @LaTeX{} math snippets
12431 @subsubheading Working with @LaTeX{} math snippets
12433 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12434 document in one of the following ways:
12440 This option is activated on a per-file basis with
12446 With this option, @LaTeX{} fragments are first converted into MathML
12447 fragments using an external @LaTeX{}-to-MathML converter program. The
12448 resulting MathML fragments are then embedded as an OpenDocument Formula in
12449 the exported document.
12451 @vindex org-latex-to-mathml-convert-command
12452 @vindex org-latex-to-mathml-jar-file
12454 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12455 @code{org-latex-to-mathml-convert-command} and
12456 @code{org-latex-to-mathml-jar-file}.
12458 If you prefer to use @file{MathToWeb}@footnote{See
12459 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
12460 converter, you can configure the above variables as shown below.
12463 (setq org-latex-to-mathml-convert-command
12464 "java -jar %j -unicode -force -df %o %I"
12465 org-latex-to-mathml-jar-file
12466 "/path/to/mathtoweb.jar")
12469 You can use the following commands to quickly verify the reliability of
12470 the @LaTeX{}-to-MathML converter.
12473 @item M-x org-odt-export-as-odf RET
12474 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12476 @item M-x org-odt-export-as-odf-and-open RET
12477 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12478 and open the formula file with the system-registered application.
12482 @cindex imagemagick
12485 This option is activated on a per-file basis with
12488 #+OPTIONS: tex:dvipng
12494 #+OPTIONS: tex:imagemagick
12497 With this option, @LaTeX{} fragments are processed into PNG images and the
12498 resulting images are embedded in the exported document. This method requires
12499 that the @file{dvipng} program or @file{imagemagick} suite be available on
12503 @node Working with MathML or OpenDocument formula files
12504 @subsubheading Working with MathML or OpenDocument formula files
12506 For various reasons, you may find embedding @LaTeX{} math snippets in an
12507 ODT document less than reliable. In that case, you can embed a
12508 math equation by linking to its MathML (@file{.mml}) source or its
12509 OpenDocument formula (@file{.odf}) file as shown below:
12521 @node Labels and captions in ODT export
12522 @subsection Labels and captions in ODT export
12524 You can label and caption various category of objects---an inline image, a
12525 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12526 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
12527 each labeled or captioned object of a given category separately. As a
12528 result, each such object is assigned a sequence number based on order of it's
12529 appearance in the Org file.
12531 In the exported document, a user-provided caption is augmented with the
12532 category and sequence number. Consider the following inline image in an Org
12536 #+CAPTION: Bell curve
12537 #+LABEL: fig:SED-HR4049
12541 It could be rendered as shown below in the exported document.
12544 Figure 2: Bell curve
12547 @vindex org-odt-category-map-alist
12548 You can modify the category component of the caption by customizing the
12549 option @code{org-odt-category-map-alist}. For example, to tag all embedded
12550 images with the string @samp{Illustration} (instead of the default
12551 @samp{Figure}) use the following setting:
12554 (setq org-odt-category-map-alist
12555 (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12558 With this, previous image will be captioned as below in the exported
12562 Illustration 2: Bell curve
12565 @node Literal examples in ODT export
12566 @subsection Literal examples in ODT export
12568 Export of literal examples (@pxref{Literal examples}) with full fontification
12569 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
12570 generate all style definitions needed for a fancy listing.@footnote{Your
12571 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
12572 fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
12573 as prefix and inherit their color from the faces used by Emacs
12574 @code{font-lock} library for the source language.
12576 @vindex org-odt-fontify-srcblocks
12577 If you prefer to use your own custom styles for fontification, you can do
12578 so by customizing the option
12579 @code{org-odt-create-custom-styles-for-srcblocks}.
12581 @vindex org-odt-create-custom-styles-for-srcblocks
12582 You can turn off fontification of literal examples by customizing the
12583 option @code{org-odt-fontify-srcblocks}.
12585 @node Advanced topics in ODT export
12586 @subsection Advanced topics in ODT export
12588 If you rely heavily on ODT export, you may want to exploit the full
12589 set of features that the exporter offers. This section describes features
12590 that would be of interest to power users.
12593 * Configuring a document converter:: How to register a document converter
12594 * Working with OpenDocument style files:: Explore the internals
12595 * Creating one-off styles:: How to produce custom highlighting etc
12596 * Customizing tables in ODT export:: How to define and use Table templates
12597 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
12600 @node Configuring a document converter
12601 @subsubheading Configuring a document converter
12603 @cindex doc, docx, rtf
12606 The ODT exporter can work with popular converters with little or no
12607 extra configuration from your side. @xref{Extending ODT export}.
12608 If you are using a converter that is not supported by default or if you would
12609 like to tweak the default converter settings, proceed as below.
12612 @item Register the converter
12614 @vindex org-odt-convert-processes
12615 Name your converter and add it to the list of known converters by
12616 customizing the option @code{org-odt-convert-processes}. Also specify how
12617 the converter can be invoked via command-line to effect the conversion.
12619 @item Configure its capabilities
12621 @vindex org-odt-convert-capabilities
12622 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12623 converter can handle by customizing the variable
12624 @code{org-odt-convert-capabilities}. Use the default value for this
12625 variable as a guide for configuring your converter. As suggested by the
12626 default setting, you can specify the full set of formats supported by the
12627 converter and not limit yourself to specifying formats that are related to
12628 just the OpenDocument Text format.
12630 @item Choose the converter
12632 @vindex org-odt-convert-process
12633 Select the newly added converter as the preferred one by customizing the
12634 option @code{org-odt-convert-process}.
12637 @node Working with OpenDocument style files
12638 @subsubheading Working with OpenDocument style files
12639 @cindex styles, custom
12640 @cindex template, custom
12642 This section explores the internals of the ODT exporter and the
12643 means by which it produces styled documents. Read this section if you are
12644 interested in exploring the automatic and custom OpenDocument styles used by
12647 @anchor{x-factory-styles}
12648 @subsubheading a) Factory styles
12650 The ODT exporter relies on two files for generating its output.
12651 These files are bundled with the distribution under the directory pointed to
12652 by the variable @code{org-odt-styles-dir}. The two files are:
12655 @anchor{x-orgodtstyles-xml}
12657 @file{OrgOdtStyles.xml}
12659 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12660 document. This file gets modified for the following purposes:
12664 To control outline numbering based on user settings.
12667 To add styles generated by @file{htmlfontify.el} for fontification of code
12671 @anchor{x-orgodtcontenttemplate-xml}
12673 @file{OrgOdtContentTemplate.xml}
12675 This file contributes to the @file{content.xml} file of the final @samp{ODT}
12676 document. The contents of the Org outline are inserted between the
12677 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
12679 Apart from serving as a template file for the final @file{content.xml}, the
12680 file serves the following purposes:
12684 It contains automatic styles for formatting of tables which are referenced by
12688 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
12689 elements that control how various entities---tables, images, equations,
12690 etc.---are numbered.
12694 @anchor{x-overriding-factory-styles}
12695 @subsubheading b) Overriding factory styles
12696 The following two variables control the location from which the ODT
12697 exporter picks up the custom styles and content template files. You can
12698 customize these variables to override the factory styles used by the
12702 @anchor{x-org-odt-styles-file}
12704 @code{org-odt-styles-file}
12706 Use this variable to specify the @file{styles.xml} that will be used in the
12707 final output. You can specify one of the following values:
12710 @item A @file{styles.xml} file
12712 Use this file instead of the default @file{styles.xml}
12714 @item A @file{.odt} or @file{.ott} file
12716 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12719 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
12721 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12722 Template file. Additionally extract the specified member files and embed
12723 those within the final @samp{ODT} document.
12725 Use this option if the @file{styles.xml} file references additional files
12726 like header and footer images.
12730 Use the default @file{styles.xml}
12733 @anchor{x-org-odt-content-template-file}
12735 @code{org-odt-content-template-file}
12737 Use this variable to specify the blank @file{content.xml} that will be used
12738 in the final output.
12741 @node Creating one-off styles
12742 @subsubheading Creating one-off styles
12744 There are times when you would want one-off formatting in the exported
12745 document. You can achieve this by embedding raw OpenDocument XML in the Org
12746 file. The use of this feature is better illustrated with couple of examples.
12749 @item Embedding ODT tags as part of regular text
12751 You can inline OpenDocument syntax by enclosing it within
12752 @samp{@@@@odt:...@@@@} markup. For example, to highlight a region of text do
12756 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
12757 text</text:span>@@@@. But this is a regular text.
12760 @strong{Hint:} To see the above example in action, edit your
12761 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12762 custom @samp{Highlight} style as shown below.
12765 <style:style style:name="Highlight" style:family="text">
12766 <style:text-properties fo:background-color="#ff0000"/>
12770 @item Embedding a one-line OpenDocument XML
12772 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
12773 directive. For example, to force a page break do the following:
12776 #+ODT: <text:p text:style-name="PageBreak"/>
12779 @strong{Hint:} To see the above example in action, edit your
12780 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12781 custom @samp{PageBreak} style as shown below.
12784 <style:style style:name="PageBreak" style:family="paragraph"
12785 style:parent-style-name="Text_20_body">
12786 <style:paragraph-properties fo:break-before="page"/>
12790 @item Embedding a block of OpenDocument XML
12792 You can add a large block of OpenDocument XML using the
12793 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
12795 For example, to create a one-off paragraph that uses bold text, do the
12800 <text:p text:style-name="Text_20_body_20_bold">
12801 This paragraph is specially formatted and uses bold text.
12808 @node Customizing tables in ODT export
12809 @subsubheading Customizing tables in ODT export
12810 @cindex tables, in ODT export
12813 You can override the default formatting of the table by specifying a custom
12814 table style with the @code{#+ATTR_ODT} line. For a discussion on default
12815 formatting of tables @pxref{Tables in ODT export}.
12817 This feature closely mimics the way table templates are defined in the
12819 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12820 OpenDocument-v1.2 Specification}}
12822 @vindex org-odt-table-styles
12823 To have a quick preview of this feature, install the below setting and
12824 export the table that follows:
12827 (setq org-odt-table-styles
12828 (append org-odt-table-styles
12829 '(("TableWithHeaderRowAndColumn" "Custom"
12830 ((use-first-row-styles . t)
12831 (use-first-column-styles . t)))
12832 ("TableWithFirstRowandLastRow" "Custom"
12833 ((use-first-row-styles . t)
12834 (use-last-row-styles . t))))))
12838 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12839 | Name | Phone | Age |
12840 | Peter | 1234 | 17 |
12841 | Anna | 4321 | 25 |
12844 In the above example, you used a template named @samp{Custom} and installed
12845 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12846 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
12847 styles needed for producing the above template have been pre-defined for
12848 you. These styles are available under the section marked @samp{Custom
12849 Table Template} in @file{OrgOdtContentTemplate.xml}
12850 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
12851 additional templates you have to define these styles yourselves.
12853 To use this feature proceed as follows:
12857 Create a table template@footnote{See the @code{<table:table-template>}
12858 element of the OpenDocument-v1.2 specification}
12860 A table template is nothing but a set of @samp{table-cell} and
12861 @samp{paragraph} styles for each of the following table cell categories:
12875 The names for the above styles must be chosen based on the name of the table
12876 template using a well-defined convention.
12878 The naming convention is better illustrated with an example. For a table
12879 template with the name @samp{Custom}, the needed style names are listed in
12880 the following table.
12882 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12883 @headitem Table cell type
12884 @tab @code{table-cell} style
12885 @tab @code{paragraph} style
12890 @tab @samp{CustomTableCell}
12891 @tab @samp{CustomTableParagraph}
12893 @tab @samp{CustomFirstColumnTableCell}
12894 @tab @samp{CustomFirstColumnTableParagraph}
12896 @tab @samp{CustomLastColumnTableCell}
12897 @tab @samp{CustomLastColumnTableParagraph}
12899 @tab @samp{CustomFirstRowTableCell}
12900 @tab @samp{CustomFirstRowTableParagraph}
12902 @tab @samp{CustomLastRowTableCell}
12903 @tab @samp{CustomLastRowTableParagraph}
12905 @tab @samp{CustomEvenRowTableCell}
12906 @tab @samp{CustomEvenRowTableParagraph}
12908 @tab @samp{CustomOddRowTableCell}
12909 @tab @samp{CustomOddRowTableParagraph}
12911 @tab @samp{CustomEvenColumnTableCell}
12912 @tab @samp{CustomEvenColumnTableParagraph}
12914 @tab @samp{CustomOddColumnTableCell}
12915 @tab @samp{CustomOddColumnTableParagraph}
12918 To create a table template with the name @samp{Custom}, define the above
12920 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
12921 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
12925 Define a table style@footnote{See the attributes @code{table:template-name},
12926 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
12927 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
12928 @code{table:use-banding-rows-styles}, and
12929 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
12930 the OpenDocument-v1.2 specification}
12932 @vindex org-odt-table-styles
12933 To define a table style, create an entry for the style in the variable
12934 @code{org-odt-table-styles} and specify the following:
12937 @item the name of the table template created in step (1)
12938 @item the set of cell styles in that template that are to be activated
12941 For example, the entry below defines two different table styles
12942 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
12943 based on the same template @samp{Custom}. The styles achieve their intended
12944 effect by selectively activating the individual cell styles in that template.
12947 (setq org-odt-table-styles
12948 (append org-odt-table-styles
12949 '(("TableWithHeaderRowAndColumn" "Custom"
12950 ((use-first-row-styles . t)
12951 (use-first-column-styles . t)))
12952 ("TableWithFirstRowandLastRow" "Custom"
12953 ((use-first-row-styles . t)
12954 (use-last-row-styles . t))))))
12958 Associate a table with the table style
12960 To do this, specify the table style created in step (2) as part of
12961 the @code{ATTR_ODT} line as shown below.
12964 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12965 | Name | Phone | Age |
12966 | Peter | 1234 | 17 |
12967 | Anna | 4321 | 25 |
12971 @node Validating OpenDocument XML
12972 @subsubheading Validating OpenDocument XML
12974 Occasionally, you will discover that the document created by the
12975 ODT exporter cannot be opened by your favorite application. One of
12976 the common reasons for this is that the @file{.odt} file is corrupt. In such
12977 cases, you may want to validate the document against the OpenDocument RELAX
12978 NG Compact Syntax (RNC) schema.
12980 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
12981 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
12982 general help with validation (and schema-sensitive editing) of XML files:
12983 @inforef{Introduction,,nxml-mode}.
12985 @vindex org-odt-schema-dir
12986 If you have ready access to OpenDocument @file{.rnc} files and the needed
12987 schema-locating rules in a single folder, you can customize the variable
12988 @code{org-odt-schema-dir} to point to that directory. The ODT exporter
12989 will take care of updating the @code{rng-schema-locating-files} for you.
12991 @c end opendocument
12994 @section Org export
12997 @code{org} export back-end creates a normalized version of the Org document
12998 in current buffer. In particular, it evaluates Babel code (@pxref{Evaluating
12999 code blocks}) and removes other back-ends specific contents.
13001 @subheading Org export commands
13004 @orgcmd{C-c C-e O o,org-org-export-to-org}
13005 Export as an Org document. For an Org file, @file{myfile.org}, the resulting
13006 file will be @file{myfile.org.org}. The file will be overwritten without
13008 @orgcmd{C-c C-e O O,org-org-export-as-org}
13009 Export to a temporary buffer. Do not create a file.
13011 Export to an Org file, then open it.
13014 @node Texinfo export
13015 @section Texinfo export
13016 @cindex Texinfo export
13018 @samp{texinfo} export back-end generates Texinfo code and can compile it into
13022 * Texinfo export commands:: How to invoke Texinfo export
13023 * Document preamble:: File header, title and copyright page
13024 * Headings and sectioning structure:: Building document structure
13025 * Indices:: Creating indices
13026 * Quoting Texinfo code:: Incorporating literal Texinfo code
13027 * Texinfo specific attributes:: Controlling Texinfo output
13031 @node Texinfo export commands
13032 @subsection Texinfo export commands
13034 @vindex org-texinfo-info-process
13036 @orgcmd{C-c C-e i t,org-texinfo-export-to-texinfo}
13037 Export as a Texinfo file. For an Org file, @file{myfile.org}, the resulting
13038 file will be @file{myfile.texi}. The file will be overwritten without
13040 @orgcmd{C-c C-e i i,org-texinfo-export-to-info}
13041 Export to Texinfo and then process to an Info file@footnote{By setting
13042 @code{org-texinfo-info-process}, it is possible to generate other formats,
13043 including DocBook.}.
13046 @node Document preamble
13047 @subsection Document preamble
13049 When processing a document, @samp{texinfo} back-end generates a minimal file
13050 header along with a title page, a copyright page, and a menu. You control
13051 the latter through the structure of the document (@pxref{Headings and
13052 sectioning structure}). Various keywords allow to tweak the other parts. It
13053 is also possible to give directions to install the document in the @samp{Top}
13056 @subsubheading File header
13058 @cindex #+TEXINFO_FILENAME
13059 Upon creating the header of a Texinfo file, the back-end guesses a name for
13060 the Info file to be compiled. This may not be a sensible choice, e.g., if
13061 you want to produce the final document in a different directory. Specify an
13062 alternate path with @code{#+TEXINFO_FILENAME} keyword to override the default
13065 @vindex org-texinfo-coding-system
13066 @vindex org-texinfo-classes
13067 @cindex #+TEXINFO_HEADER
13068 @cindex #+TEXINFO_CLASS
13069 Along with the output file name, the header contains information about the
13070 language (@pxref{Export settings}) and current encoding used@footnote{See
13071 @code{org-texinfo-coding-system} for more information.}. Insert
13072 a @code{#+TEXINFO_HEADER} keyword for each additional command needed, e.g.,
13073 @@code@{@@synindex@}.
13075 If you happen to regularly install the same set of commands, it may be easier
13076 to define your own class in @code{org-texinfo-classes}, which see. Set
13077 @code{#+TEXINFO_CLASS} keyword accordingly in your document to activate it.
13079 @subsubheading Title and copyright page
13081 @cindex #+TEXINFO_PRINTED_TITLE
13083 The default template includes a title page for hard copy output. The title
13084 and author displayed on this page are extracted from, respectively,
13085 @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}). It is
13086 also possible to print a different, more specific, title with
13087 @code{#+TEXINFO_PRINTED_TITLE} keyword, and add subtitles with
13088 @code{#+SUBTITLE} keyword. Both expect raw Texinfo code in their value.
13090 @cindex #+SUBAUTHOR
13091 Likewise, information brought by @code{#+AUTHOR} may not be enough. You can
13092 include other authors with several @code{#+SUBAUTHOR} keywords. Values are
13093 also expected to be written in Texinfo code.
13096 #+AUTHOR: Jane Smith
13097 #+SUBAUTHOR: John Doe
13098 #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@}
13101 @cindex property, COPYING
13102 Copying material is defined in a dedicated headline with a non-nil
13103 @code{:COPYING:} property. The contents are inserted within
13104 a @code{@@copying} command at the beginning of the document whereas the
13105 heading itself does not appear in the structure of the document.
13107 Copyright information is printed on the back of the title page.
13115 This is a short example of a complete Texinfo file, version 1.0.
13117 Copyright \copy 2014 Free Software Foundation, Inc.
13120 @subsubheading The Top node
13122 @cindex #+TEXINFO_DIR_CATEGORY
13123 @cindex #+TEXINFO_DIR_TITLE
13124 @cindex #+TEXINFO_DIR_DESC
13125 You may ultimately want to install your new Info file to your system. You
13126 can write an appropriate entry in the top level directory specifying its
13127 category and title with, respectively, @code{#+TEXINFO_DIR_CATEGORY} and
13128 @code{#+TEXINFO_DIR_TITLE}. Optionally, you can add a short description
13129 using @code{#+TEXINFO_DIR_DESC}. The following example would write an entry
13130 similar to Org's in the @samp{Top} node.
13133 #+TEXINFO_DIR_CATEGORY: Emacs
13134 #+TEXINFO_DIR_TITLE: Org Mode: (org)
13135 #+TEXINFO_DIR_DESC: Outline-based notes management and organizer
13138 @node Headings and sectioning structure
13139 @subsection Headings and sectioning structure
13141 @vindex org-texinfo-classes
13142 @vindex org-texinfo-default-class
13143 @cindex #+TEXINFO_CLASS
13144 @samp{texinfo} uses a pre-defined scheme, or class, to convert headlines into
13145 Texinfo structuring commands. For example, a top level headline appears as
13146 @code{@@chapter} if it should be numbered or as @code{@@unnumbered}
13147 otherwise. If you need to use a different set of commands, e.g., to start
13148 with @code{@@part} instead of @code{@@chapter}, install a new class in
13149 @code{org-texinfo-classes}, then activate it with @code{#+TEXINFO_CLASS}
13150 keyword. Export process defaults to @code{org-texinfo-default-class} when
13151 there is no such keyword in the document.
13153 If a headline's level has no associated structuring command, or is below
13154 a certain threshold @pxref{Export settings}, that headline becomes a list in
13157 @cindex property, APPENDIX
13158 As an exception, a headline with a non-nil @code{:APPENDIX:} property becomes
13159 an appendix, independently on its level and the class used.
13161 @cindex property, DESCRIPTION
13162 Each regular sectioning structure creates a menu entry, named after the
13163 heading. You can provide a different, e.g., shorter, title in
13164 @code{:ALT_TITLE:} property (@pxref{Table of contents}). Optionally, you can
13165 specify a description for the item in @code{:DESCRIPTION:} property. E.g.,
13168 * Controlling Screen Display
13170 :ALT_TITLE: Display
13171 :DESCRIPTION: Controlling Screen Display
13176 @subsection Indices
13184 Index entries are created using dedicated keywords. @samp{texinfo} back-end
13185 provides one for each predefined type: @code{#+CINDEX}, @code{#+FINDEX},
13186 @code{#+KINDEX}, @code{#+PINDEX}, @code{#+TINDEX} and @code{#+VINDEX}. For
13187 custom indices, you can write raw Texinfo code (@pxref{Quoting Texinfo
13191 #+CINDEX: Defining indexing entries
13194 @cindex property, INDEX
13195 To generate an index, you need to set the @code{:INDEX:} property of
13196 a headline to an appropriate abbreviation (e.g., @samp{cp} or @samp{vr}).
13197 The headline is then exported as an unnumbered chapter or section command and
13198 the index is inserted after its contents.
13207 @node Quoting Texinfo code
13208 @subsection Quoting Texinfo code
13210 It is possible to insert raw Texinfo code using any of the following
13214 @cindex #+BEGIN_TEXINFO
13216 Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU.
13218 #+TEXINFO: @@need800
13219 This paragraph is preceded by...
13222 @@auindex Johnson, Mark
13223 @@auindex Lakoff, George
13227 @node Texinfo specific attributes
13228 @subsection Texinfo specific attributes
13230 @cindex #+ATTR_TEXINFO
13231 @samp{texinfo} back-end understands several attributes in plain lists and
13232 tables. They must be specified using an @code{#+ATTR_TEXINFO} keyword,
13233 written just above the list or table.
13235 @subsubheading Plain lists
13237 In Texinfo output, description lists appear as two-column tables, using the
13238 default command @code{@@table}. You can use @code{@@ftable} or
13239 @code{@@vtable}@footnote{For more information, @inforef{Two-column
13240 Tables,,texinfo}.} instead with @code{:table-type} attribute.
13242 @vindex org-texinfo-def-table-markup
13243 In any case, these constructs require a highlighting command for entries in
13244 the list. You can provide one with @code{:indic} attribute. If you do not,
13245 it defaults to the value stored in @code{org-texinfo-def-table-markup}, which
13249 #+ATTR_TEXINFO: :indic @@asis
13250 - foo :: This is the text for /foo/, with no highlighting.
13253 @subsubheading Tables
13255 When exporting a table, column widths are deduced from the longest cell in
13256 each column. You can also define them explicitly as fractions of the line
13257 length, using @code{:columns} attribute.
13260 #+ATTR_TEXINFO: :columns .5 .5
13261 | a cell | another cell |
13265 @subsection An example
13267 Here is a thorough example. @inforef{GNU Sample Texts,,texinfo} for an
13268 equivalent Texinfo code.
13271 #+MACRO: version 2.0
13272 #+MACRO: updated last updated 4 March 2014
13274 #+OPTIONS: ':t toc:t author:t email:t
13275 #+TITLE: GNU Sample @{@{@{version@}@}@}
13276 #+AUTHOR: A.U. Thor
13277 #+EMAIL: bug-sample@@gnu.org
13280 #+TEXINFO_FILENAME: sample.info
13281 #+TEXINFO_HEADER: @@syncodeindex pg cp
13283 #+TEXINFO_DIR_CATEGORY: Texinfo documentation system
13284 #+TEXINFO_DIR_TITLE: sample: (sample)
13285 #+TEXINFO_DIR_DESC: Invoking sample
13287 #+TEXINFO_PRINTED_TITLE: GNU Sample
13288 #+SUBTITLE: for version 2.0, last updated 4 March 2014
13295 This manual is for GNU Sample (version @{@{@{version@}@}@},
13296 @{@{@{updated@}@}@}), which is an example in the Texinfo documentation.
13298 Copyright @@@@texinfo:@@copyright@{@}@@@@ 2013 Free Software Foundation,
13302 Permission is granted to copy, distribute and/or modify this
13303 document under the terms of the GNU Free Documentation License,
13304 Version 1.3 or any later version published by the Free Software
13305 Foundation; with no Invariant Sections, with no Front-Cover Texts,
13306 and with no Back-Cover Texts. A copy of the license is included in
13307 the section entitled "GNU Free Documentation License".
13313 #+CINDEX: invoking @@command@{sample@}
13315 This is a sample manual. There is no sample program to invoke, but
13316 if there were, you could see its basic usage and command line
13319 * GNU Free Documentation License
13324 #+TEXINFO: @@include fdl.texi
13332 @node iCalendar export
13333 @section iCalendar export
13334 @cindex iCalendar export
13336 @vindex org-icalendar-include-todo
13337 @vindex org-icalendar-use-deadline
13338 @vindex org-icalendar-use-scheduled
13339 @vindex org-icalendar-categories
13340 @vindex org-icalendar-alarm-time
13341 Some people use Org mode for keeping track of projects, but still prefer a
13342 standard calendar application for anniversaries and appointments. In this
13343 case it can be useful to show deadlines and other time-stamped items in Org
13344 files in the calendar application. Org mode can export calendar information
13345 in the standard iCalendar format. If you also want to have TODO entries
13346 included in the export, configure the variable
13347 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
13348 and TODO items as VTODO@. It will also create events from deadlines that are
13349 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
13350 to set the start and due dates for the TODO entry@footnote{See the variables
13351 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
13352 As categories, it will use the tags locally defined in the heading, and the
13353 file/tree category@footnote{To add inherited tags or the TODO state,
13354 configure the variable @code{org-icalendar-categories}.}. See the variable
13355 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
13358 @vindex org-icalendar-store-UID
13359 @cindex property, ID
13360 The iCalendar standard requires each entry to have a globally unique
13361 identifier (UID). Org creates these identifiers during export. If you set
13362 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
13363 @code{:ID:} property of the entry and re-used next time you report this
13364 entry. Since a single entry can give rise to multiple iCalendar entries (as
13365 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
13366 prefixes to the UID, depending on what triggered the inclusion of the entry.
13367 In this way the UID remains unique, but a synchronization program can still
13368 figure out from which entry all the different instances originate.
13371 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
13372 Create iCalendar entries for the current buffer and store them in the same
13373 directory, using a file extension @file{.ics}.
13374 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
13375 @vindex org-agenda-files
13376 Like @kbd{C-c C-e c f}, but do this for all files in
13377 @code{org-agenda-files}. For each of these files, a separate iCalendar
13378 file will be written.
13379 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
13380 @vindex org-icalendar-combined-agenda-file
13381 Create a single large iCalendar file from all files in
13382 @code{org-agenda-files} and write it to the file given by
13383 @code{org-icalendar-combined-agenda-file}.
13386 @vindex org-use-property-inheritance
13387 @vindex org-icalendar-include-body
13388 @cindex property, SUMMARY
13389 @cindex property, DESCRIPTION
13390 @cindex property, LOCATION
13391 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
13392 property can be inherited from higher in the hierarchy if you configure
13393 @code{org-use-property-inheritance} accordingly.} properties if the selected
13394 entries have them. If not, the summary will be derived from the headline,
13395 and the description from the body (limited to
13396 @code{org-icalendar-include-body} characters).
13398 How this calendar is best read and updated, depends on the application
13399 you are using. The FAQ covers this issue.
13401 @node Other built-in back-ends
13402 @section Other built-in back-ends
13403 @cindex export back-ends, built-in
13404 @vindex org-export-backends
13406 On top of the aforementioned back-ends, Org comes with other built-in ones:
13409 @item @file{ox-man.el}: export to a man page.
13412 To activate these export back-end, customize @code{org-export-backends} or
13413 load them directly with e.g., @code{(require 'ox-man)}. This will add new
13414 keys in the export dispatcher (@pxref{The export dispatcher}).
13416 See the comment section of these files for more information on how to use
13419 @node Export in foreign buffers
13420 @section Export in foreign buffers
13422 Most built-in back-ends come with a command to convert the selected region
13423 into a selected format and replace this region by the exported output. Here
13424 is a list of such conversion commands:
13427 @item org-html-convert-region-to-html
13428 Convert the selected region into HTML.
13429 @item org-latex-convert-region-to-latex
13430 Convert the selected region into @LaTeX{}.
13431 @item org-texinfo-convert-region-to-texinfo
13432 Convert the selected region into @code{Texinfo}.
13433 @item org-md-convert-region-to-md
13434 Convert the selected region into @code{MarkDown}.
13437 This is particularly useful for converting tables and lists in foreign
13438 buffers. E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
13439 use Org commands for editing a list, and finally select and convert the list
13440 with @code{M-x org-html-convert-region-to-html RET}.
13442 @node Advanced configuration
13443 @section Advanced configuration
13447 @vindex org-export-before-processing-hook
13448 @vindex org-export-before-parsing-hook
13449 Two hooks are run during the first steps of the export process. The first
13450 one, @code{org-export-before-processing-hook} is called before expanding
13451 macros, Babel code and include keywords in the buffer. The second one,
13452 @code{org-export-before-parsing-hook}, as its name suggests, happens just
13453 before parsing the buffer. Their main use is for heavy duties, that is
13454 duties involving structural modifications of the document. For example, one
13455 may want to remove every headline in the buffer during export. The following
13456 code can achieve this:
13460 (defun my-headline-removal (backend)
13461 "Remove all headlines in the current buffer.
13462 BACKEND is the export back-end being used, as a symbol."
13464 (lambda () (delete-region (point) (progn (forward-line) (point))))))
13466 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
13470 Note that functions used in these hooks require a mandatory argument,
13471 a symbol representing the back-end used.
13473 @subheading Filters
13475 @cindex Filters, exporting
13476 Filters are lists of functions applied on a specific part of the output from
13477 a given back-end. More explicitly, each time a back-end transforms an Org
13478 object or element into another language, all functions within a given filter
13479 type are called in turn on the string produced. The string returned by the
13480 last function will be the one used in the final output.
13482 There are filter sets for each type of element or object, for plain text,
13483 for the parse tree, for the export options and for the final output. They
13484 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
13485 where @code{TYPE} is the type targeted by the filter. Valid types are:
13487 @multitable @columnfractions .33 .33 .33
13500 @item example-block
13502 @tab export-snippet
13505 @tab footnote-definition
13506 @item footnote-reference
13508 @tab horizontal-rule
13509 @item inline-babel-call
13510 @tab inline-src-block
13515 @item latex-environment
13516 @tab latex-fragment
13526 @tab property-drawer
13533 @item statistics-cookie
13534 @tab strike-through
13547 For example, the following snippet allows me to use non-breaking spaces in
13548 the Org buffer and get them translated into @LaTeX{} without using the
13549 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
13553 (defun my-latex-filter-nobreaks (text backend info)
13554 "Ensure \"Â \" are properly handled in LaTeX export."
13555 (when (org-export-derived-backend-p backend 'latex)
13556 (replace-regexp-in-string "Â " "~" text)))
13558 (add-to-list 'org-export-filter-plain-text-functions
13559 'my-latex-filter-nobreaks)
13563 Three arguments must be provided to a filter: the code being changed, the
13564 back-end used, and some information about the export process. You can safely
13565 ignore the third argument for most purposes. Note the use of
13566 @code{org-export-derived-backend-p}, which ensures that the filter will only
13567 be applied when using @code{latex} back-end or any other back-end derived
13568 from it (e.g., @code{beamer}).
13570 @subheading Defining filters for individual files
13572 You can customize the export for just a specific file by binding export
13573 filter variables using @code{#+BIND}. Here is an example where we introduce
13574 two filters, one to remove brackets from time stamps, and one to entirely
13575 remove any strike-through text. The functions doing the filtering are
13576 defined in an src block that allows the filter function definitions to exist
13577 in the file itself and ensures that the functions will be there when needed.
13580 #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
13581 #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
13582 #+begin_src emacs-lisp :exports results :results none
13583 (defun tmp-f-timestamp (s backend info)
13584 (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
13585 (defun tmp-f-strike-through (s backend info) "")
13589 @subheading Extending an existing back-end
13591 This is obviously the most powerful customization, since the changes happen
13592 at the parser level. Indeed, some export back-ends are built as extensions
13593 of other ones (e.g. Markdown back-end an extension of HTML back-end).
13595 Extending a back-end means that if an element type is not transcoded by the
13596 new back-end, it will be handled by the original one. Hence you can extend
13597 specific parts of a back-end without too much work.
13599 As an example, imagine we want the @code{ascii} back-end to display the
13600 language used in a source block, when it is available, but only when some
13601 attribute is non-@code{nil}, like the following:
13604 #+ATTR_ASCII: :language t
13607 Because that back-end is lacking in that area, we are going to create a new
13608 back-end, @code{my-ascii} that will do the job.
13612 (defun my-ascii-src-block (src-block contents info)
13613 "Transcode a SRC-BLOCK element from Org to ASCII.
13614 CONTENTS is nil. INFO is a plist used as a communication
13616 (if (not (org-export-read-attribute :attr_ascii src-block :language))
13617 (org-export-with-backend 'ascii src-block contents info)
13619 (format ",--[ %s ]--\n%s`----"
13620 (org-element-property :language src-block)
13621 (replace-regexp-in-string
13623 (org-element-normalize-string
13624 (org-export-format-code-default src-block info)))))))
13626 (org-export-define-derived-backend 'my-ascii 'ascii
13627 :translate-alist '((src-block . my-ascii-src-block)))
13631 The @code{my-ascii-src-block} function looks at the attribute above the
13632 element. If it isn't true, it gives hand to the @code{ascii} back-end.
13633 Otherwise, it creates a box around the code, leaving room for the language.
13634 A new back-end is then created. It only changes its behavior when
13635 translating @code{src-block} type element. Now, all it takes to use the new
13636 back-end is calling the following from an Org buffer:
13639 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
13642 It is obviously possible to write an interactive function for this, install
13643 it in the export dispatcher menu, and so on.
13647 @chapter Publishing
13650 Org includes a publishing management system that allows you to configure
13651 automatic HTML conversion of @emph{projects} composed of interlinked org
13652 files. You can also configure Org to automatically upload your exported HTML
13653 pages and related attachments, such as images and source code files, to a web
13656 You can also use Org to convert files into PDF, or even combine HTML and PDF
13657 conversion so that files are available in both formats on the server.
13659 Publishing has been contributed to Org by David O'Toole.
13662 * Configuration:: Defining projects
13663 * Uploading files:: How to get files up on the server
13664 * Sample configuration:: Example projects
13665 * Triggering publication:: Publication commands
13668 @node Configuration
13669 @section Configuration
13671 Publishing needs significant configuration to specify files, destination
13672 and many other properties of a project.
13675 * Project alist:: The central configuration variable
13676 * Sources and destinations:: From here to there
13677 * Selecting files:: What files are part of the project?
13678 * Publishing action:: Setting the function doing the publishing
13679 * Publishing options:: Tweaking HTML/@LaTeX{} export
13680 * Publishing links:: Which links keep working after publishing?
13681 * Sitemap:: Generating a list of all pages
13682 * Generating an index:: An index that reaches across pages
13685 @node Project alist
13686 @subsection The variable @code{org-publish-project-alist}
13687 @cindex org-publish-project-alist
13688 @cindex projects, for publishing
13690 @vindex org-publish-project-alist
13691 Publishing is configured almost entirely through setting the value of one
13692 variable, called @code{org-publish-project-alist}. Each element of the list
13693 configures one project, and may be in one of the two following forms:
13696 ("project-name" :property value :property value ...)
13697 @r{i.e., a well-formed property list with alternating keys and values}
13699 ("project-name" :components ("project-name" "project-name" ...))
13703 In both cases, projects are configured by specifying property values. A
13704 project defines the set of files that will be published, as well as the
13705 publishing configuration to use when publishing those files. When a project
13706 takes the second form listed above, the individual members of the
13707 @code{:components} property are taken to be sub-projects, which group
13708 together files requiring different publishing options. When you publish such
13709 a ``meta-project'', all the components will also be published, in the
13712 @node Sources and destinations
13713 @subsection Sources and destinations for files
13714 @cindex directories, for publishing
13716 Most properties are optional, but some should always be set. In
13717 particular, Org needs to know where to look for source files,
13718 and where to put published files.
13720 @multitable @columnfractions 0.3 0.7
13721 @item @code{:base-directory}
13722 @tab Directory containing publishing source files
13723 @item @code{:publishing-directory}
13724 @tab Directory where output files will be published. You can directly
13725 publish to a web server using a file name syntax appropriate for
13726 the Emacs @file{tramp} package. Or you can publish to a local directory and
13727 use external tools to upload your website (@pxref{Uploading files}).
13728 @item @code{:preparation-function}
13729 @tab Function or list of functions to be called before starting the
13730 publishing process, for example, to run @code{make} for updating files to be
13731 published. The project property list is scoped into this call as the
13732 variable @code{project-plist}.
13733 @item @code{:completion-function}
13734 @tab Function or list of functions called after finishing the publishing
13735 process, for example, to change permissions of the resulting files. The
13736 project property list is scoped into this call as the variable
13737 @code{project-plist}.
13741 @node Selecting files
13742 @subsection Selecting files
13743 @cindex files, selecting for publishing
13745 By default, all files with extension @file{.org} in the base directory
13746 are considered part of the project. This can be modified by setting the
13748 @multitable @columnfractions 0.25 0.75
13749 @item @code{:base-extension}
13750 @tab Extension (without the dot!) of source files. This actually is a
13751 regular expression. Set this to the symbol @code{any} if you want to get all
13752 files in @code{:base-directory}, even without extension.
13754 @item @code{:exclude}
13755 @tab Regular expression to match file names that should not be
13756 published, even though they have been selected on the basis of their
13759 @item @code{:include}
13760 @tab List of files to be included regardless of @code{:base-extension}
13761 and @code{:exclude}.
13763 @item @code{:recursive}
13764 @tab non-@code{nil} means, check base-directory recursively for files to publish.
13767 @node Publishing action
13768 @subsection Publishing action
13769 @cindex action, for publishing
13771 Publishing means that a file is copied to the destination directory and
13772 possibly transformed in the process. The default transformation is to export
13773 Org files as HTML files, and this is done by the function
13774 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
13775 export}). But you also can publish your content as PDF files using
13776 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
13777 using the corresponding functions.
13779 If you want to publish the Org file as an @code{.org} file but with the
13780 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
13781 function @code{org-org-publish-to-org}. This will produce @file{file.org}
13782 and put it in the publishing directory. If you want a htmlized version of
13783 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
13784 produce @file{file.org.html} in the publishing directory@footnote{If the
13785 publishing directory is the same than the source directory, @file{file.org}
13786 will be exported as @file{file.org.org}, so probably don't want to do this.}.
13788 Other files like images only need to be copied to the publishing destination.
13789 For this you can use @code{org-publish-attachment}. For non-org files, you
13790 always need to specify the publishing function:
13792 @multitable @columnfractions 0.3 0.7
13793 @item @code{:publishing-function}
13794 @tab Function executing the publication of a file. This may also be a
13795 list of functions, which will all be called in turn.
13796 @item @code{:htmlized-source}
13797 @tab non-@code{nil} means, publish htmlized source.
13800 The function must accept three arguments: a property list containing at least
13801 a @code{:publishing-directory} property, the name of the file to be published
13802 and the path to the publishing directory of the output file. It should take
13803 the specified file, make the necessary transformation (if any) and place the
13804 result into the destination folder.
13806 @node Publishing options
13807 @subsection Options for the exporters
13808 @cindex options, for publishing
13810 The property list can be used to set export options during the publishing
13811 process. In most cases, these properties correspond to user variables in
13812 Org. While some properties are available for all export back-ends, most of
13813 them are back-end specific. The following sections list properties along
13814 with the variable they belong to. See the documentation string of these
13815 options for details.
13817 @vindex org-publish-project-alist
13818 When a property is given a value in @code{org-publish-project-alist}, its
13819 setting overrides the value of the corresponding user variable (if any)
13820 during publishing. Options set within a file (@pxref{Export settings}),
13821 however, override everything.
13823 @subsubheading Generic properties
13825 @multitable {@code{:with-sub-superscript}} {@code{org-export-with-sub-superscripts}}
13826 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
13827 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
13828 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
13829 @item @code{:language} @tab @code{org-export-default-language}
13830 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
13831 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
13832 @item @code{:select-tags} @tab @code{org-export-select-tags}
13833 @item @code{:with-author} @tab @code{org-export-with-author}
13834 @item @code{:with-creator} @tab @code{org-export-with-creator}
13835 @item @code{:with-drawers} @tab @code{org-export-with-drawers}
13836 @item @code{:with-email} @tab @code{org-export-with-email}
13837 @item @code{:with-emphasize} @tab @code{org-export-with-emphasize}
13838 @item @code{:with-fixed-width} @tab @code{org-export-with-fixed-width}
13839 @item @code{:with-footnotes} @tab @code{org-export-with-footnotes}
13840 @item @code{:with-latex} @tab @code{org-export-with-latex}
13841 @item @code{:with-planning} @tab @code{org-export-with-planning}
13842 @item @code{:with-priority} @tab @code{org-export-with-priority}
13843 @item @code{:with-properties} @tab @code{org-export-with-properties}
13844 @item @code{:with-special-strings} @tab @code{org-export-with-special-strings}
13845 @item @code{:with-sub-superscript} @tab @code{org-export-with-sub-superscripts}
13846 @item @code{:with-tables} @tab @code{org-export-with-tables}
13847 @item @code{:with-tags} @tab @code{org-export-with-tags}
13848 @item @code{:with-tasks} @tab @code{org-export-with-tasks}
13849 @item @code{:with-timestamps} @tab @code{org-export-with-timestamps}
13850 @item @code{:with-toc} @tab @code{org-export-with-toc}
13851 @item @code{:with-todo-keywords} @tab @code{org-export-with-todo-keywords}
13854 @subsubheading ASCII specific properties
13856 @multitable {@code{:ascii-table-keep-all-vertical-lines}} {@code{org-ascii-table-keep-all-vertical-lines}}
13857 @item @code{:ascii-bullets} @tab @code{org-ascii-bullets}
13858 @item @code{:ascii-caption-above} @tab @code{org-ascii-caption-above}
13859 @item @code{:ascii-charset} @tab @code{org-ascii-charset}
13860 @item @code{:ascii-global-margin} @tab @code{org-ascii-global-margin}
13861 @item @code{:ascii-format-drawer-function} @tab @code{org-ascii-format-drawer-function}
13862 @item @code{:ascii-format-inlinetask-function} @tab @code{org-ascii-format-inlinetask-function}
13863 @item @code{:ascii-headline-spacing} @tab @code{org-ascii-headline-spacing}
13864 @item @code{:ascii-indented-line-width} @tab @code{org-ascii-indented-line-width}
13865 @item @code{:ascii-inlinetask-width} @tab @code{org-ascii-inlinetask-width}
13866 @item @code{:ascii-inner-margin} @tab @code{org-ascii-inner-margin}
13867 @item @code{:ascii-links-to-notes} @tab @code{org-ascii-links-to-notes}
13868 @item @code{:ascii-list-margin} @tab @code{org-ascii-list-margin}
13869 @item @code{:ascii-paragraph-spacing} @tab @code{org-ascii-paragraph-spacing}
13870 @item @code{:ascii-quote-margin} @tab @code{org-ascii-quote-margin}
13871 @item @code{:ascii-table-keep-all-vertical-lines} @tab @code{org-ascii-table-keep-all-vertical-lines}
13872 @item @code{:ascii-table-use-ascii-art} @tab @code{org-ascii-table-use-ascii-art}
13873 @item @code{:ascii-table-widen-columns} @tab @code{org-ascii-table-widen-columns}
13874 @item @code{:ascii-text-width} @tab @code{org-ascii-text-width}
13875 @item @code{:ascii-underline} @tab @code{org-ascii-underline}
13876 @item @code{:ascii-verbatim-format} @tab @code{org-ascii-verbatim-format}
13879 @subsubheading Beamer specific properties
13881 @multitable {@code{:beamer-frame-default-options}} {@code{org-beamer-frame-default-options}}
13882 @item @code{:beamer-theme} @tab @code{org-beamer-theme}
13883 @item @code{:beamer-column-view-format} @tab @code{org-beamer-column-view-format}
13884 @item @code{:beamer-environments-extra} @tab @code{org-beamer-environments-extra}
13885 @item @code{:beamer-frame-default-options} @tab @code{org-beamer-frame-default-options}
13886 @item @code{:beamer-outline-frame-options} @tab @code{org-beamer-outline-frame-options}
13887 @item @code{:beamer-outline-frame-title} @tab @code{org-beamer-outline-frame-title}
13890 @subsubheading HTML specific properties
13892 @multitable {@code{:html-table-use-header-tags-for-first-column}} {@code{org-html-table-use-header-tags-for-first-column}}
13893 @item @code{:html-allow-name-attribute-in-anchors} @tab @code{org-html-allow-name-attribute-in-anchors}
13894 @item @code{:html-checkbox-type} @tab @code{org-html-checkbox-type}
13895 @item @code{:html-container} @tab @code{org-html-container-element}
13896 @item @code{:html-divs} @tab @code{org-html-divs}
13897 @item @code{:html-doctype} @tab @code{org-html-doctype}
13898 @item @code{:html-extension} @tab @code{org-html-extension}
13899 @item @code{:html-footnote-format} @tab @code{org-html-footnote-format}
13900 @item @code{:html-footnote-separator} @tab @code{org-html-footnote-separator}
13901 @item @code{:html-footnotes-section} @tab @code{org-html-footnotes-section}
13902 @item @code{:html-format-drawer-function} @tab @code{org-html-format-drawer-function}
13903 @item @code{:html-format-headline-function} @tab @code{org-html-format-headline-function}
13904 @item @code{:html-format-inlinetask-function} @tab @code{org-html-format-inlinetask-function}
13905 @item @code{:html-head-extra} @tab @code{org-html-head-extra}
13906 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
13907 @item @code{:html-head-include-scripts} @tab @code{org-html-head-include-scripts}
13908 @item @code{:html-head} @tab @code{org-html-head}
13909 @item @code{:html-home/up-format} @tab @code{org-html-home/up-format}
13910 @item @code{:html-html5-fancy} @tab @code{org-html-html5-fancy}
13911 @item @code{:html-indent} @tab @code{org-html-indent}
13912 @item @code{:html-infojs-options} @tab @code{org-html-infojs-options}
13913 @item @code{:html-infojs-template} @tab @code{org-html-infojs-template}
13914 @item @code{:html-inline-image-rules} @tab @code{org-html-inline-image-rules}
13915 @item @code{:html-inline-images} @tab @code{org-html-inline-images}
13916 @item @code{:html-link-home} @tab @code{org-html-link-home}
13917 @item @code{:html-link-org-files-as-html} @tab @code{org-html-link-org-files-as-html}
13918 @item @code{:html-link-up} @tab @code{org-html-link-up}
13919 @item @code{:html-link-use-abs-url} @tab @code{org-html-link-use-abs-url}
13920 @item @code{:html-mathjax-options} @tab @code{org-html-mathjax-options}
13921 @item @code{:html-mathjax-template} @tab @code{org-html-mathjax-template}
13922 @item @code{:html-metadata-timestamp-format} @tab @code{org-html-metadata-timestamp-format}
13923 @item @code{:html-postamble-format} @tab @code{org-html-postamble-format}
13924 @item @code{:html-postamble} @tab @code{org-html-postamble}
13925 @item @code{:html-preamble-format} @tab @code{org-html-preamble-format}
13926 @item @code{:html-preamble} @tab @code{org-html-preamble}
13927 @item @code{:html-table-align-individual-fields} @tab @code{org-html-table-align-individual-fields}
13928 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
13929 @item @code{:html-table-caption-above} @tab @code{org-html-table-caption-above}
13930 @item @code{:html-table-data-tags} @tab @code{org-html-table-data-tags}
13931 @item @code{:html-table-header-tags} @tab @code{org-html-table-header-tags}
13932 @item @code{:html-table-row-tags} @tab @code{org-html-table-row-tags}
13933 @item @code{:html-table-use-header-tags-for-first-column} @tab @code{org-html-table-use-header-tags-for-first-column}
13934 @item @code{:html-tag-class-prefix} @tab @code{org-html-tag-class-prefix}
13935 @item @code{:html-text-markup-alist} @tab @code{org-html-text-markup-alist}
13936 @item @code{:html-todo-kwd-class-prefix} @tab @code{org-html-todo-kwd-class-prefix}
13937 @item @code{:html-toplevel-hlevel} @tab @code{org-html-toplevel-hlevel}
13938 @item @code{:html-use-infojs} @tab @code{org-html-use-infojs}
13939 @item @code{:html-use-unicode-chars} @tab @code{org-html-use-unicode-chars}
13940 @item @code{:html-validation-link} @tab @code{org-html-validation-link}
13941 @item @code{:html-xml-declaration} @tab @code{org-html-xml-declaration}
13944 @subsubheading @LaTeX{} specific properties
13946 @multitable {@code{:latex-link-with-unknown-path-format}} {@code{org-latex-link-with-unknown-path-format}}
13947 @item @code{:latex-active-timestamp-format} @tab @code{org-latex-active-timestamp-format}
13948 @item @code{:latex-caption-above} @tab @code{org-latex-caption-above}
13949 @item @code{:latex-classes} @tab @code{org-latex-classes}
13950 @item @code{:latex-class} @tab @code{org-latex-default-class}
13951 @item @code{:latex-custom-id-labels} @tab @code{org-latex-custom-id-as-label}
13952 @item @code{:latex-default-figure-position} @tab @code{org-latex-default-figure-position}
13953 @item @code{:latex-default-table-environment} @tab @code{org-latex-default-table-environment}
13954 @item @code{:latex-default-table-mode} @tab @code{org-latex-default-table-mode}
13955 @item @code{:latex-diary-timestamp-format} @tab @code{org-latex-diary-timestamp-format}
13956 @item @code{:latex-footnote-separator} @tab @code{org-latex-footnote-separator}
13957 @item @code{:latex-format-drawer-function} @tab @code{org-latex-format-drawer-function}
13958 @item @code{:latex-format-headline-function} @tab @code{org-latex-format-headline-function}
13959 @item @code{:latex-format-inlinetask-function} @tab @code{org-latex-format-inlinetask-function}
13960 @item @code{:latex-hyperref-template} @tab @code{org-latex-hyperref-template}
13961 @item @code{:latex-image-default-height} @tab @code{org-latex-image-default-height}
13962 @item @code{:latex-image-default-option} @tab @code{org-latex-image-default-option}
13963 @item @code{:latex-image-default-width} @tab @code{org-latex-image-default-width}
13964 @item @code{:latex-inactive-timestamp-format} @tab @code{org-latex-inactive-timestamp-format}
13965 @item @code{:latex-inline-image-rules} @tab @code{org-latex-inline-image-rules}
13966 @item @code{:latex-link-with-unknown-path-format} @tab @code{org-latex-link-with-unknown-path-format}
13967 @item @code{:latex-listings-langs} @tab @code{org-latex-listings-langs}
13968 @item @code{:latex-listings-options} @tab @code{org-latex-listings-options}
13969 @item @code{:latex-listings} @tab @code{org-latex-listings}
13970 @item @code{:latex-minted-langs} @tab @code{org-latex-minted-langs}
13971 @item @code{:latex-minted-options} @tab @code{org-latex-minted-options}
13972 @item @code{:latex-table-scientific-notation} @tab @code{org-latex-table-scientific-notation}
13973 @item @code{:latex-tables-booktabs} @tab @code{org-latex-tables-booktabs}
13974 @item @code{:latex-tables-centered} @tab @code{org-latex-tables-centered}
13975 @item @code{:latex-text-markup-alist} @tab @code{org-latex-text-markup-alist}
13976 @item @code{:latex-title-command} @tab @code{org-latex-title-command}
13977 @item @code{:latex-toc-command} @tab @code{org-latex-toc-command}
13980 @subsubheading Markdown specific properties
13982 @multitable {@code{:md-headline-style}} {@code{org-md-headline-style}}
13983 @item @code{:md-headline-style} @tab @code{org-md-headline-style}
13986 @subsubheading ODT specific properties
13988 @multitable {@code{:odt-format-inlinetask-function}} {@code{org-odt-format-inlinetask-function}}
13989 @item @code{:odt-content-template-file} @tab @code{org-odt-content-template-file}
13990 @item @code{:odt-display-outline-level} @tab @code{org-odt-display-outline-level}
13991 @item @code{:odt-fontify-srcblocks} @tab @code{org-odt-fontify-srcblocks}
13992 @item @code{:odt-format-drawer-function} @tab @code{org-odt-format-drawer-function}
13993 @item @code{:odt-format-headline-function} @tab @code{org-odt-format-headline-function}
13994 @item @code{:odt-format-inlinetask-function} @tab @code{org-odt-format-inlinetask-function}
13995 @item @code{:odt-inline-formula-rules} @tab @code{org-odt-inline-formula-rules}
13996 @item @code{:odt-inline-image-rules} @tab @code{org-odt-inline-image-rules}
13997 @item @code{:odt-pixels-per-inch} @tab @code{org-odt-pixels-per-inch}
13998 @item @code{:odt-styles-file} @tab @code{org-odt-styles-file}
13999 @item @code{:odt-table-styles} @tab @code{org-odt-table-styles}
14000 @item @code{:odt-use-date-fields} @tab @code{org-odt-use-date-fields}
14003 @subsubheading Texinfo specific properties
14005 @multitable {@code{:texinfo-link-with-unknown-path-format}} {@code{org-texinfo-link-with-unknown-path-format}}
14006 @item @code{:texinfo-active-timestamp-format} @tab @code{org-texinfo-active-timestamp-format}
14007 @item @code{:texinfo-classes} @tab @code{org-texinfo-classes}
14008 @item @code{:texinfo-class} @tab @code{org-texinfo-default-class}
14009 @item @code{:texinfo-def-table-markup} @tab @code{org-texinfo-def-table-markup}
14010 @item @code{:texinfo-diary-timestamp-format} @tab @code{org-texinfo-diary-timestamp-format}
14011 @item @code{:texinfo-filename} @tab @code{org-texinfo-filename}
14012 @item @code{:texinfo-format-drawer-function} @tab @code{org-texinfo-format-drawer-function}
14013 @item @code{:texinfo-format-headline-function} @tab @code{org-texinfo-format-headline-function}
14014 @item @code{:texinfo-format-inlinetask-function} @tab @code{org-texinfo-format-inlinetask-function}
14015 @item @code{:texinfo-inactive-timestamp-format} @tab @code{org-texinfo-inactive-timestamp-format}
14016 @item @code{:texinfo-link-with-unknown-path-format} @tab @code{org-texinfo-link-with-unknown-path-format}
14017 @item @code{:texinfo-node-description-column} @tab @code{org-texinfo-node-description-column}
14018 @item @code{:texinfo-table-scientific-notation} @tab @code{org-texinfo-table-scientific-notation}
14019 @item @code{:texinfo-tables-verbatim} @tab @code{org-texinfo-tables-verbatim}
14020 @item @code{:texinfo-text-markup-alist} @tab @code{org-texinfo-text-markup-alist}
14023 @node Publishing links
14024 @subsection Links between published files
14025 @cindex links, publishing
14027 To create a link from one Org file to another, you would use something like
14028 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
14029 (@pxref{Hyperlinks}). When published, this link becomes a link to
14030 @file{foo.html}. You can thus interlink the pages of your "org web" project
14031 and the links will work as expected when you publish them to HTML@. If you
14032 also publish the Org source file and want to link to it, use an @code{http:}
14033 link instead of a @code{file:} link, because @code{file:} links are converted
14034 to link to the corresponding @file{html} file.
14036 You may also link to related files, such as images. Provided you are careful
14037 with relative file names, and provided you have also configured Org to upload
14038 the related files, these links will work too. See @ref{Complex example}, for
14039 an example of this usage.
14042 @subsection Generating a sitemap
14043 @cindex sitemap, of published pages
14045 The following properties may be used to control publishing of
14046 a map of files for a given project.
14048 @multitable @columnfractions 0.35 0.65
14049 @item @code{:auto-sitemap}
14050 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
14051 or @code{org-publish-all}.
14053 @item @code{:sitemap-filename}
14054 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
14055 becomes @file{sitemap.html}).
14057 @item @code{:sitemap-title}
14058 @tab Title of sitemap page. Defaults to name of file.
14060 @item @code{:sitemap-function}
14061 @tab Plug-in function to use for generation of the sitemap.
14062 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
14063 of links to all files in the project.
14065 @item @code{:sitemap-sort-folders}
14066 @tab Where folders should appear in the sitemap. Set this to @code{first}
14067 (default) or @code{last} to display folders first or last,
14068 respectively. Any other value will mix files and folders.
14070 @item @code{:sitemap-sort-files}
14071 @tab How the files are sorted in the site map. Set this to
14072 @code{alphabetically} (default), @code{chronologically} or
14073 @code{anti-chronologically}. @code{chronologically} sorts the files with
14074 older date first while @code{anti-chronologically} sorts the files with newer
14075 date first. @code{alphabetically} sorts the files alphabetically. The date of
14076 a file is retrieved with @code{org-publish-find-date}.
14078 @item @code{:sitemap-ignore-case}
14079 @tab Should sorting be case-sensitive? Default @code{nil}.
14081 @item @code{:sitemap-file-entry-format}
14082 @tab With this option one can tell how a sitemap's entry is formatted in the
14083 sitemap. This is a format string with some escape sequences: @code{%t} stands
14084 for the title of the file, @code{%a} stands for the author of the file and
14085 @code{%d} stands for the date of the file. The date is retrieved with the
14086 @code{org-publish-find-date} function and formatted with
14087 @code{org-publish-sitemap-date-format}. Default @code{%t}.
14089 @item @code{:sitemap-date-format}
14090 @tab Format string for the @code{format-time-string} function that tells how
14091 a sitemap entry's date is to be formatted. This property bypasses
14092 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
14094 @item @code{:sitemap-sans-extension}
14095 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
14096 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
14097 Defaults to @code{nil}.
14101 @node Generating an index
14102 @subsection Generating an index
14103 @cindex index, in a publishing project
14105 Org mode can generate an index across the files of a publishing project.
14107 @multitable @columnfractions 0.25 0.75
14108 @item @code{:makeindex}
14109 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
14110 publish it as @file{theindex.html}.
14113 The file will be created when first publishing a project with the
14114 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
14115 "theindex.inc"}. You can then build around this include statement by adding
14116 a title, style information, etc.
14118 @node Uploading files
14119 @section Uploading files
14123 For those people already utilizing third party sync tools such as
14124 @command{rsync} or @command{unison}, it might be preferable not to use the built in
14125 @i{remote} publishing facilities of Org mode which rely heavily on
14126 Tramp. Tramp, while very useful and powerful, tends not to be
14127 so efficient for multiple file transfer and has been known to cause problems
14130 Specialized synchronization utilities offer several advantages. In addition
14131 to timestamp comparison, they also do content and permissions/attribute
14132 checks. For this reason you might prefer to publish your web to a local
14133 directory (possibly even @i{in place} with your Org files) and then use
14134 @file{unison} or @file{rsync} to do the synchronization with the remote host.
14136 Since Unison (for example) can be configured as to which files to transfer to
14137 a certain remote destination, it can greatly simplify the project publishing
14138 definition. Simply keep all files in the correct location, process your Org
14139 files with @code{org-publish} and let the synchronization tool do the rest.
14140 You do not need, in this scenario, to include attachments such as @file{jpg},
14141 @file{css} or @file{gif} files in the project definition since the 3rd party
14144 Publishing to a local directory is also much faster than to a remote one, so
14145 that you can afford more easily to republish entire projects. If you set
14146 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
14147 benefit of re-including any changed external files such as source example
14148 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
14149 Org is not smart enough to detect if included files have been modified.
14151 @node Sample configuration
14152 @section Sample configuration
14154 Below we provide two example configurations. The first one is a simple
14155 project publishing only a set of Org files. The second example is
14156 more complex, with a multi-component project.
14159 * Simple example:: One-component publishing
14160 * Complex example:: A multi-component publishing example
14163 @node Simple example
14164 @subsection Example: simple publishing configuration
14166 This example publishes a set of Org files to the @file{public_html}
14167 directory on the local machine.
14170 (setq org-publish-project-alist
14172 :base-directory "~/org/"
14173 :publishing-directory "~/public_html"
14174 :section-numbers nil
14176 :html-head "<link rel=\"stylesheet\"
14177 href=\"../other/mystyle.css\"
14178 type=\"text/css\"/>")))
14181 @node Complex example
14182 @subsection Example: complex publishing configuration
14184 This more complicated example publishes an entire website, including
14185 Org files converted to HTML, image files, Emacs Lisp source code, and
14186 style sheets. The publishing directory is remote and private files are
14189 To ensure that links are preserved, care should be taken to replicate
14190 your directory structure on the web server, and to use relative file
14191 paths. For example, if your Org files are kept in @file{~/org} and your
14192 publishable images in @file{~/images}, you would link to an image with
14195 file:../images/myimage.png
14198 On the web server, the relative path to the image should be the
14199 same. You can accomplish this by setting up an "images" folder in the
14200 right place on the web server, and publishing images to it.
14203 (setq org-publish-project-alist
14205 :base-directory "~/org/"
14206 :base-extension "org"
14207 :publishing-directory "/ssh:user@@host:~/html/notebook/"
14208 :publishing-function org-html-publish-to-html
14209 :exclude "PrivatePage.org" ;; regexp
14211 :section-numbers nil
14213 :html-head "<link rel=\"stylesheet\"
14214 href=\"../other/mystyle.css\" type=\"text/css\"/>"
14218 :base-directory "~/images/"
14219 :base-extension "jpg\\|gif\\|png"
14220 :publishing-directory "/ssh:user@@host:~/html/images/"
14221 :publishing-function org-publish-attachment)
14224 :base-directory "~/other/"
14225 :base-extension "css\\|el"
14226 :publishing-directory "/ssh:user@@host:~/html/other/"
14227 :publishing-function org-publish-attachment)
14228 ("website" :components ("orgfiles" "images" "other"))))
14231 @node Triggering publication
14232 @section Triggering publication
14234 Once properly configured, Org can publish with the following commands:
14237 @orgcmd{C-c C-e P x,org-publish}
14238 Prompt for a specific project and publish all files that belong to it.
14239 @orgcmd{C-c C-e P p,org-publish-current-project}
14240 Publish the project containing the current file.
14241 @orgcmd{C-c C-e P f,org-publish-current-file}
14242 Publish only the current file.
14243 @orgcmd{C-c C-e P a,org-publish-all}
14244 Publish every project.
14247 @vindex org-publish-use-timestamps-flag
14248 Org uses timestamps to track when a file has changed. The above functions
14249 normally only publish changed files. You can override this and force
14250 publishing of all files by giving a prefix argument to any of the commands
14251 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
14252 This may be necessary in particular if files include other files via
14253 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
14256 @node Working with source code
14257 @chapter Working with source code
14258 @cindex Schulte, Eric
14259 @cindex Davison, Dan
14260 @cindex source code, working with
14262 Source code can be included in Org mode documents using a @samp{src} block,
14266 #+BEGIN_SRC emacs-lisp
14267 (defun org-xor (a b)
14273 Org mode provides a number of features for working with live source code,
14274 including editing of code blocks in their native major-mode, evaluation of
14275 code blocks, converting code blocks into source files (known as @dfn{tangling}
14276 in literate programming), and exporting code blocks and their
14277 results in several formats. This functionality was contributed by Eric
14278 Schulte and Dan Davison, and was originally named Org-babel.
14280 The following sections describe Org mode's code block handling facilities.
14283 * Structure of code blocks:: Code block syntax described
14284 * Editing source code:: Language major-mode editing
14285 * Exporting code blocks:: Export contents and/or results
14286 * Extracting source code:: Create pure source code files
14287 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
14288 * Library of Babel:: Use and contribute to a library of useful code blocks
14289 * Languages:: List of supported code block languages
14290 * Header arguments:: Configure code block functionality
14291 * Results of evaluation:: How evaluation results are handled
14292 * Noweb reference syntax:: Literate programming in Org mode
14293 * Key bindings and useful functions:: Work quickly with code blocks
14294 * Batch execution:: Call functions from the command line
14298 @node Structure of code blocks
14299 @section Structure of code blocks
14300 @cindex code block, structure
14301 @cindex source code, block structure
14303 @cindex #+BEGIN_SRC
14305 Live code blocks can be specified with a @samp{src} block or
14306 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
14307 @ref{Easy templates} system} The structure of a @samp{src} block is
14311 #+BEGIN_SRC <language> <switches> <header arguments>
14316 The @code{#+NAME:} line is optional, and can be used to name the code
14317 block. Live code blocks require that a language be specified on the
14318 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
14319 @cindex source code, inline
14321 Live code blocks can also be specified inline using
14324 src_<language>@{<body>@}
14330 src_<language>[<header arguments>]@{<body>@}
14334 @item <#+NAME: name>
14335 This line associates a name with the code block. This is similar to the
14336 @code{#+NAME: Name} lines that can be used to name tables in Org mode
14337 files. Referencing the name of a code block makes it possible to evaluate
14338 the block from other places in the file, from other files, or from Org mode
14339 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
14340 and the behavior of Org mode when two or more blocks share the same name is
14344 The language of the code in the block (see @ref{Languages}).
14345 @cindex source code, language
14347 Optional switches control code block export (see the discussion of switches in
14348 @ref{Literal examples})
14349 @cindex source code, switches
14350 @item <header arguments>
14351 Optional header arguments control many aspects of evaluation, export and
14352 tangling of code blocks (see @ref{Header arguments}).
14353 Header arguments can also be set on a per-buffer or per-subtree
14354 basis using properties.
14355 @item source code, header arguments
14357 Source code in the specified language.
14361 @node Editing source code
14362 @section Editing source code
14363 @cindex code block, editing
14364 @cindex source code, editing
14366 @vindex org-edit-src-auto-save-idle-delay
14367 @vindex org-edit-src-turn-on-auto-save
14369 Use @kbd{C-c '} to edit the current code block. This brings up a language
14370 major-mode edit buffer containing the body of the code block. Manually
14371 saving this buffer with @key{C-x C-s} will write the contents back to the Org
14372 buffer. You can also set @code{org-edit-src-auto-save-idle-delay} to save the
14373 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
14374 to auto-save this buffer into a separate file using @code{auto-save-mode}.
14375 Use @kbd{C-c '} again to exit.
14377 The @code{org-src-mode} minor mode will be active in the edit buffer. The
14378 following variables can be used to configure the behavior of the edit
14379 buffer. See also the customization group @code{org-edit-structure} for
14380 further configuration options.
14383 @item org-src-lang-modes
14384 If an Emacs major-mode named @code{<lang>-mode} exists, where
14385 @code{<lang>} is the language named in the header line of the code block,
14386 then the edit buffer will be placed in that major-mode. This variable
14387 can be used to map arbitrary language names to existing major modes.
14388 @item org-src-window-setup
14389 Controls the way Emacs windows are rearranged when the edit buffer is created.
14390 @item org-src-preserve-indentation
14391 @cindex indentation, in source blocks
14392 By default, the value is @code{nil}, which means that when code blocks are
14393 evaluated during export or tangled, they are re-inserted into the code block,
14394 which may replace sequences of spaces with tab characters. When non-nil,
14395 whitespace in code blocks will be preserved during export or tangling,
14396 exactly as it appears. This variable is especially useful for tangling
14397 languages such as Python, in which whitespace indentation in the output is
14399 @item org-src-ask-before-returning-to-edit-buffer
14400 By default, Org will ask before returning to an open edit buffer. Set this
14401 variable to @code{nil} to switch without asking.
14404 To turn on native code fontification in the @emph{Org} buffer, configure the
14405 variable @code{org-src-fontify-natively}.
14408 @node Exporting code blocks
14409 @section Exporting code blocks
14410 @cindex code block, exporting
14411 @cindex source code, exporting
14413 It is possible to export the @emph{code} of code blocks, the @emph{results}
14414 of code block evaluation, @emph{both} the code and the results of code block
14415 evaluation, or @emph{none}. For most languages, the default exports code.
14416 However, for some languages (e.g., @code{ditaa}) the default exports the
14417 results of code block evaluation. For information on exporting code block
14418 bodies, see @ref{Literal examples}.
14420 The @code{:exports} header argument can be used to specify export
14421 behavior (note that these arguments are only relevant for code blocks, not
14424 @subsubheading Header arguments:
14427 @cindex @code{:exports}, src header argument
14428 @item :exports code
14429 The default in most languages. The body of the code block is exported, as
14430 described in @ref{Literal examples}.
14431 @item :exports results
14432 The code block will be evaluated each time to buffer is exported, and the
14433 results will be placed in the Org mode buffer for export, either updating
14434 previous results of the code block located anywhere in the buffer or, if no
14435 previous results exist, placing the results immediately after the code block.
14436 The body of the code block will not be exported.
14437 @item :exports both
14438 Both the code block and its results will be exported.
14439 @item :exports none
14440 Neither the code block nor its results will be exported.
14443 It is possible to inhibit the evaluation of code blocks during export.
14444 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
14445 ensure that no code blocks are evaluated as part of the export process. This
14446 can be useful in situations where potentially untrusted Org mode files are
14447 exported in an automated fashion, for example when Org mode is used as the
14448 markup language for a wiki. It is also possible to set this variable to
14449 @code{inline-only}. In that case, only inline code blocks will be
14450 evaluated, in order to insert their results. Non-inline code blocks are
14451 assumed to have their results already inserted in the buffer by manual
14452 evaluation. This setting is useful to avoid expensive recalculations during
14453 export, not to provide security.
14455 Code blocks in commented subtrees (@pxref{Comment lines}) are never evaluated
14456 on export. However, code blocks in subtrees excluded from export
14457 (@pxref{Export settings}) may be evaluated on export.
14459 @node Extracting source code
14460 @section Extracting source code
14462 @cindex source code, extracting
14463 @cindex code block, extracting source code
14465 Creating pure source code files by extracting code from source blocks is
14466 referred to as ``tangling''---a term adopted from the literate programming
14467 community. During ``tangling'' of code blocks their bodies are expanded
14468 using @code{org-babel-expand-src-block} which can expand both variable and
14469 ``noweb'' style references (see @ref{Noweb reference syntax}).
14471 @subsubheading Header arguments
14474 @cindex @code{:tangle}, src header argument
14476 The default. The code block is not included in the tangled output.
14478 Include the code block in the tangled output. The output file name is the
14479 name of the org file with the extension @samp{.org} replaced by the extension
14480 for the block language.
14481 @item :tangle filename
14482 Include the code block in the tangled output to file @samp{filename}.
14486 @subsubheading Functions
14489 @item org-babel-tangle
14490 Tangle the current file. Bound to @kbd{C-c C-v t}.
14492 With prefix argument only tangle the current code block.
14493 @item org-babel-tangle-file
14494 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
14497 @subsubheading Hooks
14500 @item org-babel-post-tangle-hook
14501 This hook is run from within code files tangled by @code{org-babel-tangle}.
14502 Example applications could include post-processing, compilation or evaluation
14503 of tangled code files.
14506 @subsubheading Jumping between code and Org
14508 When tangling code from an Org-mode buffer to a source code file, you'll
14509 frequently find yourself viewing the file of tangled source code (e.g., many
14510 debuggers point to lines of the source code file). It is useful to be able
14511 to navigate from the tangled source to the Org-mode buffer from which the
14514 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
14515 code to Org-mode functionality. Two header arguments are required for
14516 jumping to work, first the @code{padline} (@ref{padline}) option must be set
14517 to true (the default setting), second the @code{comments} (@ref{comments})
14518 header argument must be set to @code{links}, which will insert comments into
14519 the source code buffer which point back to the original Org-mode file.
14521 @node Evaluating code blocks
14522 @section Evaluating code blocks
14523 @cindex code block, evaluating
14524 @cindex source code, evaluating
14527 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
14528 potential for that code to do harm. Org mode provides safeguards to ensure
14529 that code is only evaluated after explicit confirmation from the user. For
14530 information on these safeguards (and on how to disable them) see @ref{Code
14531 evaluation security}.} and the results of evaluation optionally placed in the
14532 Org mode buffer. The results of evaluation are placed following a line that
14533 begins by default with @code{#+RESULTS} and optionally a cache identifier
14534 and/or the name of the evaluated code block. The default value of
14535 @code{#+RESULTS} can be changed with the customizable variable
14536 @code{org-babel-results-keyword}.
14538 By default, the evaluation facility is only enabled for Lisp code blocks
14539 specified as @code{emacs-lisp}. However, source code blocks in many languages
14540 can be evaluated within Org mode (see @ref{Languages} for a list of supported
14541 languages and @ref{Structure of code blocks} for information on the syntax
14542 used to define a code block).
14545 There are a number of ways to evaluate code blocks. The simplest is to press
14546 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
14547 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
14548 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
14549 @code{org-babel-execute-src-block} function to evaluate the block and insert
14550 its results into the Org mode buffer.
14553 It is also possible to evaluate named code blocks from anywhere in an Org
14554 mode buffer or an Org mode table. These named code blocks can be located in
14555 the current Org mode buffer or in the ``Library of Babel'' (@pxref{Library of
14556 Babel}). Named code blocks can be evaluated with a separate @code{#+CALL:}
14557 line or inline within a block of text. In both cases the result is wrapped
14558 according to the value of @code{org-babel-inline-result-wrap}, which by
14559 default is @code{"=%s="} for markup that produces verbatim text.
14561 The syntax of the @code{#+CALL:} line is
14564 #+CALL: <name>(<arguments>)
14565 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
14568 The syntax for inline evaluation of named code blocks is
14571 ... call_<name>(<arguments>) ...
14572 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
14577 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
14579 Arguments specified in this section will be passed to the code block. These
14580 arguments use standard function call syntax, rather than
14581 header argument syntax. For example, a @code{#+CALL:} line that passes the
14582 number four to a code block named @code{double}, which declares the header
14583 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
14584 @item <inside header arguments>
14585 Inside header arguments are passed through and applied to the named code
14586 block. These arguments use header argument syntax rather than standard
14587 function call syntax. Inside header arguments affect how the code block is
14588 evaluated. For example, @code{[:results output]} will collect the results of
14589 everything printed to @code{STDOUT} during execution of the code block.
14590 @item <end header arguments>
14591 End header arguments are applied to the calling instance and do not affect
14592 evaluation of the named code block. They affect how the results are
14593 incorporated into the Org mode buffer and how the call line is exported. For
14594 example, @code{:results html} will insert the results of the call line
14595 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
14597 For more examples of passing header arguments to @code{#+CALL:} lines see
14598 @ref{Header arguments in function calls}.
14601 @node Library of Babel
14602 @section Library of Babel
14603 @cindex babel, library of
14604 @cindex source code, library
14605 @cindex code block, library
14607 The ``Library of Babel'' consists of code blocks that can be called from any
14608 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
14609 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
14610 code blocks} for information on the syntax of remote code block evaluation).
14613 The central repository of code blocks in the ``Library of Babel'' is housed
14614 in an Org mode file located in the @samp{contrib} directory of Org mode.
14616 Users can add code blocks they believe to be generally useful to their
14617 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
14618 then loaded into the library with @code{org-babel-lob-ingest}.
14622 Code blocks located in any Org mode file can be loaded into the ``Library of
14623 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
14628 @cindex babel, languages
14629 @cindex source code, languages
14630 @cindex code block, languages
14632 Code blocks in the following languages are supported.
14634 @multitable @columnfractions 0.28 0.3 0.22 0.2
14635 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
14636 @item Asymptote @tab asymptote @tab Awk @tab awk
14637 @item Emacs Calc @tab calc @tab C @tab C
14638 @item C++ @tab C++ @tab Clojure @tab clojure
14639 @item CSS @tab css @tab ditaa @tab ditaa
14640 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
14641 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
14642 @item Java @tab java @tab @tab
14643 @item Javascript @tab js @tab LaTeX @tab latex
14644 @item Ledger @tab ledger @tab Lisp @tab lisp
14645 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
14646 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
14647 @item Octave @tab octave @tab Org mode @tab org
14648 @item Oz @tab oz @tab Perl @tab perl
14649 @item Plantuml @tab plantuml @tab Python @tab python
14650 @item R @tab R @tab Ruby @tab ruby
14651 @item Sass @tab sass @tab Scheme @tab scheme
14652 @item GNU Screen @tab screen @tab shell @tab sh
14653 @item SQL @tab sql @tab SQLite @tab sqlite
14656 Language-specific documentation is available for some languages. If
14657 available, it can be found at
14658 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
14660 The option @code{org-babel-load-languages} controls which languages are
14661 enabled for evaluation (by default only @code{emacs-lisp} is enabled). This
14662 variable can be set using the customization interface or by adding code like
14663 the following to your emacs configuration.
14666 The following disables @code{emacs-lisp} evaluation and enables evaluation of
14667 @code{R} code blocks.
14671 (org-babel-do-load-languages
14672 'org-babel-load-languages
14673 '((emacs-lisp . nil)
14677 It is also possible to enable support for a language by loading the related
14678 elisp file with @code{require}.
14681 The following adds support for evaluating @code{clojure} code blocks.
14685 (require 'ob-clojure)
14688 @node Header arguments
14689 @section Header arguments
14690 @cindex code block, header arguments
14691 @cindex source code, block header arguments
14693 Code block functionality can be configured with header arguments. This
14694 section provides an overview of the use of header arguments, and then
14695 describes each header argument in detail.
14698 * Using header arguments:: Different ways to set header arguments
14699 * Specific header arguments:: List of header arguments
14702 @node Using header arguments
14703 @subsection Using header arguments
14705 The values of header arguments can be set in several way. When the header
14706 arguments in each layer have been determined, they are combined in order from
14707 the first, least specific (having the lowest priority) up to the last, most
14708 specific (having the highest priority). A header argument with a higher
14709 priority replaces the same header argument specified at lower priority.
14711 * System-wide header arguments:: Set global default values
14712 * Language-specific header arguments:: Set default values by language
14713 * Header arguments in Org mode properties:: Set default values for a buffer or heading
14714 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
14715 * Code block specific header arguments:: The most common way to set values
14716 * Header arguments in function calls:: The most specific level
14720 @node System-wide header arguments
14721 @subsubheading System-wide header arguments
14722 @vindex org-babel-default-header-args
14723 System-wide values of header arguments can be specified by adapting the
14724 @code{org-babel-default-header-args} variable:
14726 @cindex @code{:session}, src header argument
14727 @cindex @code{:results}, src header argument
14728 @cindex @code{:exports}, src header argument
14729 @cindex @code{:cache}, src header argument
14730 @cindex @code{:noweb}, src header argument
14733 :results => "replace"
14739 For example, the following example could be used to set the default value of
14740 @code{:noweb} header arguments to @code{yes}. This would have the effect of
14741 expanding @code{:noweb} references by default when evaluating source code
14745 (setq org-babel-default-header-args
14746 (cons '(:noweb . "yes")
14747 (assq-delete-all :noweb org-babel-default-header-args)))
14750 @node Language-specific header arguments
14751 @subsubheading Language-specific header arguments
14752 Each language can define its own set of default header arguments in variable
14753 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
14754 of the language. See the language-specific documentation available online at
14755 @uref{http://orgmode.org/worg/org-contrib/babel}.
14757 @node Header arguments in Org mode properties
14758 @subsubheading Header arguments in Org mode properties
14760 Buffer-wide header arguments may be specified as properties through the use
14761 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
14762 @ref{Property syntax}).
14764 For example the following would set @code{session} to @code{*R*} (only for R
14765 code blocks), and @code{results} to @code{silent} for every code block in the
14766 buffer, ensuring that all execution took place in the same session, and no
14767 results would be inserted into the buffer.
14770 #+PROPERTY: header-args:R :session *R*
14771 #+PROPERTY: header-args :results silent
14774 Header arguments read from Org mode properties can also be set on a
14775 per-subtree basis using property drawers (see @ref{Property syntax}).
14776 @vindex org-use-property-inheritance
14777 When properties are used to set default header arguments, they are always
14778 looked up with inheritance, regardless of the value of
14779 @code{org-use-property-inheritance}. Properties are evaluated as seen by the
14780 outermost call or source block.@footnote{The deprecated syntax for default
14781 header argument properties, using the name of the header argument as a
14782 property name directly, evaluates the property as seen by the corresponding
14783 source block definition. This behavior has been kept for backwards
14786 In the following example the value of
14787 the @code{:cache} header argument will default to @code{yes} in all code
14788 blocks in the subtree rooted at the following heading:
14793 :header-args: :cache yes
14798 @vindex org-babel-default-header-args
14799 Properties defined in this way override the properties set in
14800 @code{org-babel-default-header-args} and are applied for all activated
14801 languages. It is convenient to use the @code{org-set-property} function
14802 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
14804 @node Language-specific header arguments in Org mode properties
14805 @subsubheading Language-specific header arguments in Org mode properties
14807 Language-specific header arguments are also read from properties
14808 @code{header-args:<lang>} where @code{<lang>} is the name of the language
14809 targeted. As an example
14814 :header-args:clojure: :session *clojure-1*
14815 :header-args:R: :session *R*
14819 :header-args:clojure: :session *clojure-2*
14823 would independently set a default session header argument for R and clojure
14824 for calls and source blocks under subtree ``Heading'' and change to a
14825 different clojure setting for evaluations under subtree ``Subheading'', while
14826 the R session is inherited from ``Heading'' and therefore unchanged.
14828 @node Code block specific header arguments
14829 @subsubheading Code block specific header arguments
14831 The most common way to assign values to header arguments is at the
14832 code block level. This can be done by listing a sequence of header
14833 arguments and their values as part of the @code{#+BEGIN_SRC} line.
14834 Properties set in this way override both the values of
14835 @code{org-babel-default-header-args} and header arguments specified as
14836 properties. In the following example, the @code{:results} header argument
14837 is set to @code{silent}, meaning the results of execution will not be
14838 inserted in the buffer, and the @code{:exports} header argument is set to
14839 @code{code}, meaning only the body of the code block will be
14840 preserved on export to HTML or @LaTeX{}.
14844 #+BEGIN_SRC haskell :results silent :exports code :var n=0
14846 fac n = n * fac (n-1)
14849 Similarly, it is possible to set header arguments for inline code blocks
14852 src_haskell[:exports both]@{fac 5@}
14855 Code block header arguments can span multiple lines using @code{#+HEADER:} or
14856 @code{#+HEADERS:} lines preceding a code block or nested between the
14857 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
14861 Multi-line header arguments on an un-named code block:
14864 #+HEADERS: :var data1=1
14865 #+BEGIN_SRC emacs-lisp :var data2=2
14866 (message "data1:%S, data2:%S" data1 data2)
14873 Multi-line header arguments on a named code block:
14876 #+NAME: named-block
14877 #+HEADER: :var data=2
14878 #+BEGIN_SRC emacs-lisp
14879 (message "data:%S" data)
14882 #+RESULTS: named-block
14886 @node Header arguments in function calls
14887 @subsubheading Header arguments in function calls
14889 At the most specific level, header arguments for ``Library of Babel'' or
14890 @code{#+CALL:} lines can be set as shown in the two examples below. For more
14891 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
14894 The following will apply the @code{:exports results} header argument to the
14895 evaluation of the @code{#+CALL:} line.
14898 #+CALL: factorial(n=5) :exports results
14901 The following will apply the @code{:session special} header argument to the
14902 evaluation of the @code{factorial} code block.
14905 #+CALL: factorial[:session special](n=5)
14908 @node Specific header arguments
14909 @subsection Specific header arguments
14910 Header arguments consist of an initial colon followed by the name of the
14911 argument in lowercase letters. The following header arguments are defined:
14914 * var:: Pass arguments to code blocks
14915 * Results:: Specify the type of results and how they will
14916 be collected and handled
14917 * file:: Specify a path for file output
14918 * file-desc:: Specify a description for file results
14919 * file-ext:: Specify an extension for file output
14920 * output-dir:: Specify a directory to write file output to
14921 * dir:: Specify the default (possibly remote)
14922 directory for code block execution
14923 * exports:: Export code and/or results
14924 * tangle:: Toggle tangling and specify file name
14925 * mkdirp:: Toggle creation of parent directories of target
14926 files during tangling
14927 * comments:: Toggle insertion of comments in tangled
14929 * padline:: Control insertion of padding lines in tangled
14931 * no-expand:: Turn off variable assignment and noweb
14932 expansion during tangling
14933 * session:: Preserve the state of code evaluation
14934 * noweb:: Toggle expansion of noweb references
14935 * noweb-ref:: Specify block's noweb reference resolution target
14936 * noweb-sep:: String used to separate noweb references
14937 * cache:: Avoid re-evaluating unchanged code blocks
14938 * sep:: Delimiter for writing tabular results outside Org
14939 * hlines:: Handle horizontal lines in tables
14940 * colnames:: Handle column names in tables
14941 * rownames:: Handle row names in tables
14942 * shebang:: Make tangled files executable
14943 * tangle-mode:: Set permission of tangled files
14944 * eval:: Limit evaluation of specific code blocks
14945 * wrap:: Mark source block evaluation results
14946 * post:: Post processing of code block results
14947 * prologue:: Text to prepend to code block body
14948 * epilogue:: Text to append to code block body
14951 Additional header arguments are defined on a language-specific basis, see
14955 @subsubsection @code{:var}
14956 @cindex @code{:var}, src header argument
14957 The @code{:var} header argument is used to pass arguments to code blocks.
14958 The specifics of how arguments are included in a code block vary by language;
14959 these are addressed in the language-specific documentation. However, the
14960 syntax used to specify arguments is the same across all languages. In every
14961 case, variables require a default value when they are declared.
14963 The values passed to arguments can either be literal values, references, or
14964 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
14965 References include anything in the Org mode file that takes a @code{#+NAME:}
14966 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
14967 other code blocks and the results of other code blocks.
14969 Note: When a reference is made to another code block, the referenced block
14970 will be evaluated unless it has current cached results (see @ref{cache}).
14972 Argument values can be indexed in a manner similar to arrays (see @ref{var,
14973 Indexable variable values}).
14975 The following syntax is used to pass arguments to code blocks using the
14976 @code{:var} header argument.
14982 The argument, @code{assign}, can either be a literal value, such as a string
14983 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
14984 literal example, another code block (with or without arguments), or the
14985 results of evaluating another code block.
14987 Here are examples of passing values by reference:
14992 an Org mode table named with either a @code{#+NAME:} line
14995 #+NAME: example-table
15001 #+NAME: table-length
15002 #+BEGIN_SRC emacs-lisp :var table=example-table
15006 #+RESULTS: table-length
15011 a simple list named with a @code{#+NAME:} line (note that nesting is not
15012 carried through to the source code block)
15015 #+NAME: example-list
15021 #+BEGIN_SRC emacs-lisp :var x=example-list
15029 @item code block without arguments
15030 a code block name (from the example above), as assigned by @code{#+NAME:},
15031 optionally followed by parentheses
15034 #+BEGIN_SRC emacs-lisp :var length=table-length()
15042 @item code block with arguments
15043 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
15044 optional arguments passed within the parentheses following the
15045 code block name using standard function call syntax
15049 #+BEGIN_SRC emacs-lisp :var input=8
15057 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
15065 @item literal example
15066 a literal example block named with a @code{#+NAME:} line
15069 #+NAME: literal-example
15075 #+NAME: read-literal-example
15076 #+BEGIN_SRC emacs-lisp :var x=literal-example
15077 (concatenate 'string x " for you.")
15080 #+RESULTS: read-literal-example
15081 : A literal example
15082 : on two lines for you.
15088 @subsubheading Indexable variable values
15089 It is possible to reference portions of variable values by ``indexing'' into
15090 the variables. Indexes are 0 based with negative values counting back from
15091 the end. If an index is separated by @code{,}s then each subsequent section
15092 will index into the next deepest nesting or dimension of the value. Note
15093 that this indexing occurs @emph{before} other table related header arguments
15094 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
15095 following example assigns the last cell of the first row the table
15096 @code{example-table} to the variable @code{data}:
15099 #+NAME: example-table
15105 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
15113 Ranges of variable values can be referenced using two integers separated by a
15114 @code{:}, in which case the entire inclusive range is referenced. For
15115 example the following assigns the middle three rows of @code{example-table}
15119 #+NAME: example-table
15126 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
15136 Additionally, an empty index, or the single character @code{*}, are both
15137 interpreted to mean the entire range and as such are equivalent to
15138 @code{0:-1}, as shown in the following example in which the entire first
15139 column is referenced.
15142 #+NAME: example-table
15148 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
15156 It is possible to index into the results of code blocks as well as tables.
15157 Any number of dimensions can be indexed. Dimensions are separated from one
15158 another by commas, as shown in the following example.
15162 #+BEGIN_SRC emacs-lisp
15163 '(((1 2 3) (4 5 6) (7 8 9))
15164 ((10 11 12) (13 14 15) (16 17 18))
15165 ((19 20 21) (22 23 24) (25 26 27)))
15168 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
15176 @subsubheading Emacs Lisp evaluation of variables
15178 Emacs lisp code can be used to initialize variable values. When a variable
15179 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
15180 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
15181 the variable value. The following example demonstrates use of this
15182 evaluation to reliably pass the file-name of the Org mode buffer to a code
15183 block---note that evaluation of header arguments is guaranteed to take place
15184 in the original Org mode file, while there is no such guarantee for
15185 evaluation of the code block body.
15188 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
15193 Note that values read from tables and lists will not be evaluated as
15194 Emacs Lisp, as shown in the following example.
15200 #+HEADERS: :var data=table[0,0]
15210 @subsubsection @code{:results}
15211 @cindex @code{:results}, src header argument
15213 There are four classes of @code{:results} header argument. Only one option
15214 per class may be supplied per code block.
15218 @b{collection} header arguments specify how the results should be collected
15219 from the code block
15221 @b{type} header arguments specify what type of result the code block will
15222 return---which has implications for how they will be processed before
15223 insertion into the Org mode buffer
15225 @b{format} header arguments specify what type of result the code block will
15226 return---which has implications for how they will be inserted into the
15229 @b{handling} header arguments specify how the results of evaluating the code
15230 block should be handled.
15233 @subsubheading Collection
15234 The following options are mutually exclusive, and specify how the results
15235 should be collected from the code block.
15239 This is the default. The result is the value of the last statement in the
15240 code block. This header argument places the evaluation in functional
15241 mode. Note that in some languages, e.g., Python, use of this result type
15242 requires that a @code{return} statement be included in the body of the source
15243 code block. E.g., @code{:results value}.
15244 @item @code{output}
15245 The result is the collection of everything printed to STDOUT during the
15246 execution of the code block. This header argument places the
15247 evaluation in scripting mode. E.g., @code{:results output}.
15250 @subsubheading Type
15252 The following options are mutually exclusive and specify what type of results
15253 the code block will return. By default, results are inserted as either a
15254 table or scalar depending on their value.
15257 @item @code{table}, @code{vector}
15258 The results should be interpreted as an Org mode table. If a single value is
15259 returned, it will be converted into a table with one row and one column.
15260 E.g., @code{:results value table}.
15262 The results should be interpreted as an Org mode list. If a single scalar
15263 value is returned it will be converted into a list with only one element.
15264 @item @code{scalar}, @code{verbatim}
15265 The results should be interpreted literally---they will not be
15266 converted into a table. The results will be inserted into the Org mode
15267 buffer as quoted text. E.g., @code{:results value verbatim}.
15269 The results will be interpreted as the path to a file, and will be inserted
15270 into the Org mode buffer as a file link. E.g., @code{:results value file}.
15273 @subsubheading Format
15275 The following options are mutually exclusive and specify what type of results
15276 the code block will return. By default, results are inserted according to the
15277 type as specified above.
15281 The results are interpreted as raw Org mode code and are inserted directly
15282 into the buffer. If the results look like a table they will be aligned as
15283 such by Org mode. E.g., @code{:results value raw}.
15285 The results are will be enclosed in a @code{BEGIN_SRC org} block.
15286 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
15287 in the block and/or if you export the file. E.g., @code{:results value org}.
15289 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
15290 block. E.g., @code{:results value html}.
15292 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
15293 E.g., @code{:results value latex}.
15295 Result are assumed to be parsable code and are enclosed in a code block.
15296 E.g., @code{:results value code}.
15298 The result is converted to pretty-printed code and is enclosed in a code
15299 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
15300 @code{:results value pp}.
15301 @item @code{drawer}
15302 The result is wrapped in a RESULTS drawer. This can be useful for
15303 inserting @code{raw} or @code{org} syntax results in such a way that their
15304 extent is known and they can be automatically removed or replaced.
15307 @subsubheading Handling
15308 The following results options indicate what happens with the
15309 results once they are collected.
15312 @item @code{silent}
15313 The results will be echoed in the minibuffer but will not be inserted into
15314 the Org mode buffer. E.g., @code{:results output silent}.
15315 @item @code{replace}
15316 The default value. Any existing results will be removed, and the new results
15317 will be inserted into the Org mode buffer in their place. E.g.,
15318 @code{:results output replace}.
15319 @item @code{append}
15320 If there are pre-existing results of the code block then the new results will
15321 be appended to the existing results. Otherwise the new results will be
15322 inserted as with @code{replace}.
15323 @item @code{prepend}
15324 If there are pre-existing results of the code block then the new results will
15325 be prepended to the existing results. Otherwise the new results will be
15326 inserted as with @code{replace}.
15330 @subsubsection @code{:file}
15331 @cindex @code{:file}, src header argument
15333 The header argument @code{:file} is used to specify an external file in which
15334 to save code block results. After code block evaluation an Org mode style
15335 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
15336 into the Org mode buffer. Some languages including R, gnuplot, dot, and
15337 ditaa provide special handling of the @code{:file} header argument
15338 automatically wrapping the code block body in the boilerplate code required
15339 to save output to the specified file. This is often useful for saving
15340 graphical output of a code block to the specified file.
15342 The argument to @code{:file} should be either a string specifying the path to
15343 a file, or a list of two strings in which case the first element of the list
15344 should be the path to a file and the second a description for the link.
15347 @subsubsection @code{:file-desc}
15349 The value of the @code{:file-desc} header argument is used to provide a
15350 description for file code block results which are inserted as Org mode links
15351 (see @ref{Link format}). If the @code{:file-desc} header argument is given
15352 with no value the link path will be placed in both the ``link'' and the
15353 ``description'' portion of the Org mode link.
15356 @subsubsection @code{:file-ext}
15357 @cindex @code{:file-ext}, src header argument
15359 The value of the @code{:file-ext} header argument is used to provide an
15360 extension to write the file output to. It is combined with the
15361 @code{#+NAME:} of the source block and the value of the @ref{output-dir}
15362 header argument to generate a complete file name.
15364 This header arg will be overridden by @code{:file}, and thus has no effect
15365 when the latter is specified.
15368 @subsubsection @code{:output-dir}
15369 @cindex @code{:output-dir}, src header argument
15371 The value of the @code{:output-dir} header argument is used to provide a
15372 directory to write the file output to. It may specify an absolute directory
15373 (beginning with @code{/}) or a relative directory (without @code{/}). It can
15374 be combined with the @code{#+NAME:} of the source block and the value of the
15375 @ref{file-ext} header argument to generate a complete file name, or used
15376 along with a @ref{file} header arg.
15379 @subsubsection @code{:dir} and remote execution
15380 @cindex @code{:dir}, src header argument
15382 While the @code{:file} header argument can be used to specify the path to the
15383 output file, @code{:dir} specifies the default directory during code block
15384 execution. If it is absent, then the directory associated with the current
15385 buffer is used. In other words, supplying @code{:dir path} temporarily has
15386 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
15387 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
15388 the value of the Emacs variable @code{default-directory}.
15390 When using @code{:dir}, you should supply a relative path for file output
15391 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
15392 case that path will be interpreted relative to the default directory.
15394 In other words, if you want your plot to go into a folder called @file{Work}
15395 in your home directory, you could use
15398 #+BEGIN_SRC R :file myplot.png :dir ~/Work
15399 matplot(matrix(rnorm(100), 10), type="l")
15403 @subsubheading Remote execution
15404 A directory on a remote machine can be specified using tramp file syntax, in
15405 which case the code will be evaluated on the remote machine. An example is
15408 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
15409 plot(1:10, main=system("hostname", intern=TRUE))
15413 Text results will be returned to the local Org mode buffer as usual, and file
15414 output will be created on the remote machine with relative paths interpreted
15415 relative to the remote directory. An Org mode link to the remote file will be
15418 So, in the above example a plot will be created on the remote machine,
15419 and a link of the following form will be inserted in the org buffer:
15422 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
15425 Most of this functionality follows immediately from the fact that @code{:dir}
15426 sets the value of the Emacs variable @code{default-directory}, thanks to
15427 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
15428 install tramp separately in order for these features to work correctly.
15430 @subsubheading Further points
15434 If @code{:dir} is used in conjunction with @code{:session}, although it will
15435 determine the starting directory for a new session as expected, no attempt is
15436 currently made to alter the directory associated with an existing session.
15438 @code{:dir} should typically not be used to create files during export with
15439 @code{:exports results} or @code{:exports both}. The reason is that, in order
15440 to retain portability of exported material between machines, during export
15441 links inserted into the buffer will @emph{not} be expanded against @code{default
15442 directory}. Therefore, if @code{default-directory} is altered using
15443 @code{:dir}, it is probable that the file will be created in a location to
15444 which the link does not point.
15448 @subsubsection @code{:exports}
15449 @cindex @code{:exports}, src header argument
15451 The @code{:exports} header argument specifies what should be included in HTML
15452 or @LaTeX{} exports of the Org mode file. Note that the @code{:exports}
15453 option is only relevant for code blocks, not inline code.
15457 The default. The body of code is included into the exported file. E.g.,
15458 @code{:exports code}.
15459 @item @code{results}
15460 The result of evaluating the code is included in the exported file. E.g.,
15461 @code{:exports results}.
15463 Both the code and results are included in the exported file. E.g.,
15464 @code{:exports both}.
15466 Nothing is included in the exported file. E.g., @code{:exports none}.
15470 @subsubsection @code{:tangle}
15471 @cindex @code{:tangle}, src header argument
15473 The @code{:tangle} header argument specifies whether or not the code
15474 block should be included in tangled extraction of source code files.
15477 @item @code{tangle}
15478 The code block is exported to a source code file named after the full path
15479 (including the directory) and file name (w/o extension) of the Org mode file.
15480 E.g., @code{:tangle yes}.
15482 The default. The code block is not exported to a source code file.
15483 E.g., @code{:tangle no}.
15485 Any other string passed to the @code{:tangle} header argument is interpreted
15486 as a path (directory and file name relative to the directory of the Org mode
15487 file) to which the block will be exported. E.g., @code{:tangle path}.
15491 @subsubsection @code{:mkdirp}
15492 @cindex @code{:mkdirp}, src header argument
15494 The @code{:mkdirp} header argument can be used to create parent directories
15495 of tangled files when missing. This can be set to @code{yes} to enable
15496 directory creation or to @code{no} to inhibit directory creation.
15499 @subsubsection @code{:comments}
15500 @cindex @code{:comments}, src header argument
15501 By default code blocks are tangled to source-code files without any insertion
15502 of comments beyond those which may already exist in the body of the code
15503 block. The @code{:comments} header argument can be set as follows to control
15504 the insertion of extra comments into the tangled code file.
15508 The default. No extra comments are inserted during tangling.
15510 The code block is wrapped in comments which contain pointers back to the
15511 original Org file from which the code was tangled.
15513 A synonym for ``link'' to maintain backwards compatibility.
15515 Include text from the Org mode file as a comment.
15516 The text is picked from the leading context of the tangled code and is
15517 limited by the nearest headline or source block as the case may be.
15519 Turns on both the ``link'' and ``org'' comment options.
15521 Turns on the ``link'' comment option, and additionally wraps expanded noweb
15522 references in the code block body in link comments.
15526 @subsubsection @code{:padline}
15527 @cindex @code{:padline}, src header argument
15528 Control in insertion of padding lines around code block bodies in tangled
15529 code files. The default value is @code{yes} which results in insertion of
15530 newlines before and after each tangled code block. The following arguments
15535 Insert newlines before and after each code block body in tangled code files.
15537 Do not insert any newline padding in tangled output.
15541 @subsubsection @code{:no-expand}
15542 @cindex @code{:no-expand}, src header argument
15544 By default, code blocks are expanded with @code{org-babel-expand-src-block}
15545 during tangling. This has the effect of assigning values to variables
15546 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
15547 references (see @ref{Noweb reference syntax}) with their targets. The
15548 @code{:no-expand} header argument can be used to turn off this behavior.
15549 Note: The @code{:no-expand} header argument has no impact on export,
15550 i.e. code blocks will irrespective of this header argument expanded for
15554 @subsubsection @code{:session}
15555 @cindex @code{:session}, src header argument
15557 The @code{:session} header argument starts a session for an interpreted
15558 language where state is preserved.
15560 By default, a session is not started.
15562 A string passed to the @code{:session} header argument will give the session
15563 a name. This makes it possible to run concurrent sessions for each
15564 interpreted language.
15567 @subsubsection @code{:noweb}
15568 @cindex @code{:noweb}, src header argument
15570 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
15571 references (see @ref{Noweb reference syntax}) when the code block is
15572 evaluated, tangled, or exported. The @code{:noweb} header argument can have
15573 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
15574 @code{no-export} @code{strip-export}.
15578 The default. ``Noweb'' syntax references in the body of the code block will
15579 not be expanded before the code block is evaluated, tangled or exported.
15581 ``Noweb'' syntax references in the body of the code block will be
15582 expanded before the code block is evaluated, tangled or exported.
15583 @item @code{tangle}
15584 ``Noweb'' syntax references in the body of the code block will be expanded
15585 before the code block is tangled. However, ``noweb'' syntax references will
15586 not be expanded when the code block is evaluated or exported.
15587 @item @code{no-export}
15588 ``Noweb'' syntax references in the body of the code block will be expanded
15589 before the block is evaluated or tangled. However, ``noweb'' syntax
15590 references will not be expanded when the code block is exported.
15591 @item @code{strip-export}
15592 ``Noweb'' syntax references in the body of the code block will be expanded
15593 before the block is evaluated or tangled. However, ``noweb'' syntax
15594 references will be removed when the code block is exported.
15596 ``Noweb'' syntax references in the body of the code block will only be
15597 expanded before the block is evaluated.
15600 @subsubheading Noweb prefix lines
15601 Noweb insertions are now placed behind the line prefix of the
15602 @code{<<reference>>}.
15603 This behavior is illustrated in the following example. Because the
15604 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
15605 each line of the expanded noweb reference will be commented.
15617 -- multi-line body of example
15620 Note that noweb replacement text that does not contain any newlines will not
15621 be affected by this change, so it is still possible to use inline noweb
15625 @subsubsection @code{:noweb-ref}
15626 @cindex @code{:noweb-ref}, src header argument
15627 When expanding ``noweb'' style references, the bodies of all code block with
15628 @emph{either} a block name matching the reference name @emph{or} a
15629 @code{:noweb-ref} header argument matching the reference name will be
15630 concatenated together to form the replacement text.
15632 By setting this header argument at the subtree or file level, simple code
15633 block concatenation may be achieved. For example, when tangling the
15634 following Org mode file, the bodies of code blocks will be concatenated into
15635 the resulting pure code file@footnote{(The example needs property inheritance
15636 to be turned on for the @code{noweb-ref} property, see @ref{Property
15640 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
15643 * the mount point of the fullest disk
15645 :noweb-ref: fullest-disk
15648 ** query all mounted disks
15653 ** strip the header row
15658 ** sort by the percent full
15660 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
15663 ** extract the mount point
15665 |awk '@{print $2@}'
15669 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
15670 used to separate accumulate noweb references like those above. By default a
15674 @subsubsection @code{:noweb-sep}
15675 @cindex @code{:noweb-sep}, src header argument
15677 The @code{:noweb-sep} header argument holds the string used to separate
15678 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
15682 @subsubsection @code{:cache}
15683 @cindex @code{:cache}, src header argument
15685 The @code{:cache} header argument controls the use of in-buffer caching of
15686 the results of evaluating code blocks. It can be used to avoid re-evaluating
15687 unchanged code blocks. Note that the @code{:cache} header argument will not
15688 attempt to cache results when the @code{:session} header argument is used,
15689 because the results of the code block execution may be stored in the session
15690 outside of the Org mode buffer. The @code{:cache} header argument can have
15691 one of two values: @code{yes} or @code{no}.
15695 The default. No caching takes place, and the code block will be evaluated
15696 every time it is called.
15698 Every time the code block is run a SHA1 hash of the code and arguments
15699 passed to the block will be generated. This hash is packed into the
15700 @code{#+RESULTS:} line and will be checked on subsequent
15701 executions of the code block. If the code block has not
15702 changed since the last time it was evaluated, it will not be re-evaluated.
15705 Code block caches notice if the value of a variable argument
15706 to the code block has changed. If this is the case, the cache is
15707 invalidated and the code block is re-run. In the following example,
15708 @code{caller} will not be re-run unless the results of @code{random} have
15709 changed since it was last run.
15713 #+BEGIN_SRC R :cache yes
15717 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
15721 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
15725 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
15730 @subsubsection @code{:sep}
15731 @cindex @code{:sep}, src header argument
15733 The @code{:sep} header argument can be used to control the delimiter used
15734 when writing tabular results out to files external to Org mode. This is used
15735 either when opening tabular results of a code block by calling the
15736 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
15737 or when writing code block results to an external file (see @ref{file})
15740 By default, when @code{:sep} is not specified output tables are tab
15744 @subsubsection @code{:hlines}
15745 @cindex @code{:hlines}, src header argument
15747 Tables are frequently represented with one or more horizontal lines, or
15748 hlines. The @code{:hlines} argument to a code block accepts the
15749 values @code{yes} or @code{no}, with a default value of @code{no}.
15753 Strips horizontal lines from the input table. In most languages this is the
15754 desired effect because an @code{hline} symbol is interpreted as an unbound
15755 variable and raises an error. Setting @code{:hlines no} or relying on the
15756 default value yields the following results.
15767 #+BEGIN_SRC python :var tab=many-cols
15771 #+RESULTS: echo-table
15778 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
15789 #+BEGIN_SRC python :var tab=many-cols :hlines yes
15793 #+RESULTS: echo-table
15803 @subsubsection @code{:colnames}
15804 @cindex @code{:colnames}, src header argument
15806 The @code{:colnames} header argument accepts the values @code{yes},
15807 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
15808 Note that the behavior of the @code{:colnames} header argument may differ
15813 If an input table looks like it has column names
15814 (because its second row is an hline), then the column
15815 names will be removed from the table before
15816 processing, then reapplied to the results.
15825 #+NAME: echo-table-again
15826 #+BEGIN_SRC python :var tab=less-cols
15827 return [[val + '*' for val in row] for row in tab]
15830 #+RESULTS: echo-table-again
15837 Please note that column names are not removed before the table is indexed
15838 using variable indexing @xref{var, Indexable variable values}.
15841 No column name pre-processing takes place
15844 Column names are removed and reapplied as with @code{nil} even if the table
15845 does not ``look like'' it has column names (i.e., the second row is not an
15850 @subsubsection @code{:rownames}
15851 @cindex @code{:rownames}, src header argument
15853 The @code{:rownames} header argument can take on the values @code{yes} or
15854 @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
15855 blocks ignore the @code{:rownames} header argument entirely given the ease
15856 with which tables with row names may be handled directly in Emacs Lisp.
15860 No row name pre-processing will take place.
15863 The first column of the table is removed from the table before processing,
15864 and is then reapplied to the results.
15867 #+NAME: with-rownames
15868 | one | 1 | 2 | 3 | 4 | 5 |
15869 | two | 6 | 7 | 8 | 9 | 10 |
15871 #+NAME: echo-table-once-again
15872 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
15873 return [[val + 10 for val in row] for row in tab]
15876 #+RESULTS: echo-table-once-again
15877 | one | 11 | 12 | 13 | 14 | 15 |
15878 | two | 16 | 17 | 18 | 19 | 20 |
15881 Please note that row names are not removed before the table is indexed using
15882 variable indexing @xref{var, Indexable variable values}.
15887 @subsubsection @code{:shebang}
15888 @cindex @code{:shebang}, src header argument
15890 Setting the @code{:shebang} header argument to a string value
15891 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
15892 first line of any tangled file holding the code block, and the file
15893 permissions of the tangled file are set to make it executable.
15897 @subsubsection @code{:tangle-mode}
15898 @cindex @code{:tangle-mode}, src header argument
15900 The @code{tangle-mode} header argument controls the permission set on tangled
15901 files. The value of this header argument will be passed to
15902 @code{set-file-modes}. For example, to set a tangled file as read only use
15903 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
15904 use @code{:tangle-mode (identity #o755)}. Blocks with @code{shebang}
15905 (@ref{shebang}) header arguments will automatically be made executable unless
15906 the @code{tangle-mode} header argument is also used. The behavior is
15907 undefined if multiple code blocks with different values for the
15908 @code{tangle-mode} header argument are tangled to the same file.
15911 @subsubsection @code{:eval}
15912 @cindex @code{:eval}, src header argument
15913 The @code{:eval} header argument can be used to limit the evaluation of
15914 specific code blocks. The @code{:eval} header argument can be useful for
15915 protecting against the evaluation of dangerous code blocks or to ensure that
15916 evaluation will require a query regardless of the value of the
15917 @code{org-confirm-babel-evaluate} variable. The possible values of
15918 @code{:eval} and their effects are shown below.
15922 The code block will not be evaluated under any circumstances.
15924 Evaluation of the code block will require a query.
15925 @item never-export or no-export
15926 The code block will not be evaluated during export but may still be called
15929 Evaluation of the code block during export will require a query.
15932 If this header argument is not set then evaluation is determined by the value
15933 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
15937 @subsubsection @code{:wrap}
15938 @cindex @code{:wrap}, src header argument
15939 The @code{:wrap} header argument is used to mark the results of source block
15940 evaluation. The header argument can be passed a string that will be appended
15941 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
15942 results. If not string is specified then the results will be wrapped in a
15943 @code{#+BEGIN/END_RESULTS} block.
15946 @subsubsection @code{:post}
15947 @cindex @code{:post}, src header argument
15948 The @code{:post} header argument is used to post-process the results of a
15949 code block execution. When a post argument is given, the results of the code
15950 block will temporarily be bound to the @code{*this*} variable. This variable
15951 may then be included in header argument forms such as those used in @ref{var}
15952 header argument specifications allowing passing of results to other code
15953 blocks, or direct execution via Emacs Lisp.
15955 The following example illustrates the usage of the @code{:post} header
15960 #+begin_src sh :var data="" :var width="\\textwidth" :results output
15961 echo "#+ATTR_LATEX :width $width"
15965 #+header: :file /tmp/it.png
15966 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
15976 #+ATTR_LATEX :width 5cm
15977 [[file:/tmp/it.png]]
15982 @subsubsection @code{:prologue}
15983 @cindex @code{:prologue}, src header argument
15984 The value of the @code{prologue} header argument will be prepended to the
15985 code block body before execution. For example, @code{:prologue "reset"} may
15986 be used to reset a gnuplot session before execution of a particular code
15987 block, or the following configuration may be used to do this for all gnuplot
15988 code blocks. Also see @ref{epilogue}.
15991 (add-to-list 'org-babel-default-header-args:gnuplot
15992 '((:prologue . "reset")))
15996 @subsubsection @code{:epilogue}
15997 @cindex @code{:epilogue}, src header argument
15998 The value of the @code{epilogue} header argument will be appended to the code
15999 block body before execution. Also see @ref{prologue}.
16001 @node Results of evaluation
16002 @section Results of evaluation
16003 @cindex code block, results of evaluation
16004 @cindex source code, results of evaluation
16006 The way in which results are handled depends on whether a session is invoked,
16007 as well as on whether @code{:results value} or @code{:results output} is
16008 used. The following table shows the table possibilities. For a full listing
16009 of the possible results header arguments see @ref{Results}.
16011 @multitable @columnfractions 0.26 0.33 0.41
16012 @item @tab @b{Non-session} @tab @b{Session}
16013 @item @code{:results value} @tab value of last expression @tab value of last expression
16014 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
16017 Note: With @code{:results value}, the result in both @code{:session} and
16018 non-session is returned to Org mode as a table (a one- or two-dimensional
16019 vector of strings or numbers) when appropriate.
16021 @subsection Non-session
16022 @subsubsection @code{:results value}
16023 @cindex @code{:results}, src header argument
16024 This is the default. Internally, the value is obtained by wrapping the code
16025 in a function definition in the external language, and evaluating that
16026 function. Therefore, code should be written as if it were the body of such a
16027 function. In particular, note that Python does not automatically return a
16028 value from a function unless a @code{return} statement is present, and so a
16029 @samp{return} statement will usually be required in Python.
16031 This is the only one of the four evaluation contexts in which the code is
16032 automatically wrapped in a function definition.
16034 @subsubsection @code{:results output}
16035 @cindex @code{:results}, src header argument
16036 The code is passed to the interpreter as an external process, and the
16037 contents of the standard output stream are returned as text. (In certain
16038 languages this also contains the error output stream; this is an area for
16041 @subsection Session
16042 @subsubsection @code{:results value}
16043 @cindex @code{:results}, src header argument
16044 The code is passed to an interpreter running as an interactive Emacs inferior
16045 process. Only languages which provide tools for interactive evaluation of
16046 code have session support, so some language (e.g., C and ditaa) do not
16047 support the @code{:session} header argument, and in other languages (e.g.,
16048 Python and Haskell) which have limitations on the code which may be entered
16049 into interactive sessions, those limitations apply to the code in code blocks
16050 using the @code{:session} header argument as well.
16052 Unless the @code{:results output} option is supplied (see below) the result
16053 returned is the result of the last evaluation performed by the
16054 interpreter. (This is obtained in a language-specific manner: the value of
16055 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
16058 @subsubsection @code{:results output}
16059 @cindex @code{:results}, src header argument
16060 The code is passed to the interpreter running as an interactive Emacs
16061 inferior process. The result returned is the concatenation of the sequence of
16062 (text) output from the interactive interpreter. Notice that this is not
16063 necessarily the same as what would be sent to @code{STDOUT} if the same code
16064 were passed to a non-interactive interpreter running as an external
16065 process. For example, compare the following two blocks:
16068 #+BEGIN_SRC python :results output
16079 In non-session mode, the `2' is not printed and does not appear.
16082 #+BEGIN_SRC python :results output :session
16094 But in @code{:session} mode, the interactive interpreter receives input `2'
16095 and prints out its value, `2'. (Indeed, the other print statements are
16098 @node Noweb reference syntax
16099 @section Noweb reference syntax
16100 @cindex code block, noweb reference
16101 @cindex syntax, noweb
16102 @cindex source code, noweb reference
16104 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
16105 Programming system allows named blocks of code to be referenced by using the
16106 familiar Noweb syntax:
16109 <<code-block-name>>
16112 When a code block is tangled or evaluated, whether or not ``noweb''
16113 references are expanded depends upon the value of the @code{:noweb} header
16114 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
16115 evaluation. If @code{:noweb no}, the default, then the reference is not
16116 expanded before evaluation. See the @ref{noweb-ref} header argument for
16117 a more flexible way to resolve noweb references.
16119 It is possible to include the @emph{results} of a code block rather than the
16120 body. This is done by appending parenthesis to the code block name which may
16121 optionally contain arguments to the code block as shown below.
16124 <<code-block-name(optional arguments)>>
16127 Note: the default value, @code{:noweb no}, was chosen to ensure that
16128 correct code is not broken in a language, such as Ruby, where
16129 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
16130 syntactically valid in languages that you use, then please consider setting
16133 Note: if noweb tangling is slow in large Org mode files consider setting the
16134 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
16135 This will result in faster noweb reference resolution at the expense of not
16136 correctly resolving inherited values of the @code{:noweb-ref} header
16139 @node Key bindings and useful functions
16140 @section Key bindings and useful functions
16141 @cindex code block, key bindings
16143 Many common Org mode key sequences are re-bound depending on
16146 Within a code block, the following key bindings
16149 @multitable @columnfractions 0.25 0.75
16151 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
16153 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
16155 @item @kbd{M-@key{up}} @tab @code{org-babel-load-in-session}
16157 @item @kbd{M-@key{down}} @tab @code{org-babel-switch-to-session}
16160 In an Org mode buffer, the following key bindings are active:
16162 @multitable @columnfractions 0.45 0.55
16164 @kindex C-c C-v C-p
16165 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
16167 @kindex C-c C-v C-n
16168 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
16170 @kindex C-c C-v C-e
16171 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
16173 @kindex C-c C-v C-o
16174 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
16176 @kindex C-c C-v C-v
16177 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
16179 @kindex C-c C-v C-u
16180 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
16182 @kindex C-c C-v C-g
16183 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
16185 @kindex C-c C-v C-r
16186 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
16188 @kindex C-c C-v C-b
16189 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16191 @kindex C-c C-v C-s
16192 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16194 @kindex C-c C-v C-d
16195 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
16197 @kindex C-c C-v C-t
16198 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16200 @kindex C-c C-v C-f
16201 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16203 @kindex C-c C-v C-c
16204 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
16206 @kindex C-c C-v C-j
16207 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
16209 @kindex C-c C-v C-l
16210 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
16212 @kindex C-c C-v C-i
16213 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
16215 @kindex C-c C-v C-I
16216 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
16218 @kindex C-c C-v C-z
16219 @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}
16221 @kindex C-c C-v C-a
16222 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16224 @kindex C-c C-v C-h
16225 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
16227 @kindex C-c C-v C-x
16228 @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}
16231 @c When possible these keybindings were extended to work when the control key is
16232 @c kept pressed, resulting in the following additional keybindings.
16234 @c @multitable @columnfractions 0.25 0.75
16235 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
16236 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
16237 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
16238 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
16239 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
16240 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
16241 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
16242 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
16245 @node Batch execution
16246 @section Batch execution
16247 @cindex code block, batch execution
16248 @cindex source code, batch execution
16250 It is possible to call functions from the command line. This shell
16251 script calls @code{org-babel-tangle} on every one of its arguments.
16253 Be sure to adjust the paths to fit your system.
16257 # -*- mode: shell-script -*-
16259 # tangle files with org-mode
16264 # wrap each argument in the code required to call tangle on it
16266 FILES="$FILES \"$i\""
16271 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
16272 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
16273 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
16274 (mapc (lambda (file)
16275 (find-file (expand-file-name file \"$DIR\"))
16277 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
16280 @node Miscellaneous
16281 @chapter Miscellaneous
16284 * Completion:: M-TAB knows what you need
16285 * Easy templates:: Quick insertion of structural elements
16286 * Speed keys:: Electric commands at the beginning of a headline
16287 * Code evaluation security:: Org mode files evaluate inline code
16288 * Customization:: Adapting Org to your taste
16289 * In-buffer settings:: Overview of the #+KEYWORDS
16290 * The very busy C-c C-c key:: When in doubt, press C-c C-c
16291 * Clean view:: Getting rid of leading stars in the outline
16292 * TTY keys:: Using Org on a tty
16293 * Interaction:: Other Emacs packages
16294 * org-crypt:: Encrypting Org files
16299 @section Completion
16300 @cindex completion, of @TeX{} symbols
16301 @cindex completion, of TODO keywords
16302 @cindex completion, of dictionary words
16303 @cindex completion, of option keywords
16304 @cindex completion, of tags
16305 @cindex completion, of property keys
16306 @cindex completion, of link abbreviations
16307 @cindex @TeX{} symbol completion
16308 @cindex TODO keywords completion
16309 @cindex dictionary word completion
16310 @cindex option keyword completion
16311 @cindex tag completion
16312 @cindex link abbreviations, completion of
16314 Emacs would not be Emacs without completion, and Org mode uses it whenever it
16315 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
16316 some of the completion prompts, you can specify your preference by setting at
16317 most one of the variables @code{org-completion-use-iswitchb}
16318 @code{org-completion-use-ido}.
16320 Org supports in-buffer completion. This type of completion does
16321 not make use of the minibuffer. You simply type a few letters into
16322 the buffer and use the key to complete text right there.
16325 @kindex M-@key{TAB}
16327 Complete word at point
16330 At the beginning of a headline, complete TODO keywords.
16332 After @samp{\}, complete @TeX{} symbols supported by the exporter.
16334 After @samp{*}, complete headlines in the current buffer so that they
16335 can be used in search links like @samp{[[*find this headline]]}.
16337 After @samp{:} in a headline, complete tags. The list of tags is taken
16338 from the variable @code{org-tag-alist} (possibly set through the
16339 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
16340 dynamically from all tags used in the current buffer.
16342 After @samp{:} and not in a headline, complete property keys. The list
16343 of keys is constructed dynamically from all keys used in the current
16346 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
16348 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
16349 @samp{OPTIONS} which set file-specific options for Org mode. When the
16350 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
16351 will insert example settings for this keyword.
16353 In the line after @samp{#+STARTUP: }, complete startup keywords,
16354 i.e., valid keys for this line.
16356 Elsewhere, complete dictionary words using Ispell.
16360 @node Easy templates
16361 @section Easy templates
16362 @cindex template insertion
16363 @cindex insertion, of templates
16365 Org mode supports insertion of empty structural elements (like
16366 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
16367 strokes. This is achieved through a native template expansion mechanism.
16368 Note that Emacs has several other template mechanisms which could be used in
16369 a similar way, for example @file{yasnippet}.
16371 To insert a structural element, type a @samp{<}, followed by a template
16372 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
16373 keystrokes are typed on a line by itself.
16375 The following template selectors are currently supported.
16377 @multitable @columnfractions 0.1 0.9
16378 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
16379 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
16380 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
16381 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
16382 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
16383 @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
16384 @item @kbd{L} @tab @code{#+LaTeX:}
16385 @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
16386 @item @kbd{H} @tab @code{#+HTML:}
16387 @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
16388 @item @kbd{A} @tab @code{#+ASCII:}
16389 @item @kbd{i} @tab @code{#+INDEX:} line
16390 @item @kbd{I} @tab @code{#+INCLUDE:} line
16393 For example, on an empty line, typing "<e" and then pressing TAB, will expand
16394 into a complete EXAMPLE template.
16396 You can install additional templates by customizing the variable
16397 @code{org-structure-template-alist}. See the docstring of the variable for
16398 additional details.
16401 @section Speed keys
16403 @vindex org-use-speed-commands
16404 @vindex org-speed-commands-user
16406 Single keys can be made to execute commands when the cursor is at the
16407 beginning of a headline, i.e., before the first star. Configure the variable
16408 @code{org-use-speed-commands} to activate this feature. There is a
16409 pre-defined list of commands, and you can add more such commands using the
16410 variable @code{org-speed-commands-user}. Speed keys not only speed up
16411 navigation and other commands, but they also provide an alternative way to
16412 execute commands bound to keys that are not or not easily available on a TTY,
16413 or on a small mobile device with a limited keyboard.
16415 To see which commands are available, activate the feature and press @kbd{?}
16416 with the cursor at the beginning of a headline.
16418 @node Code evaluation security
16419 @section Code evaluation and security issues
16421 Org provides tools to work with code snippets, including evaluating them.
16423 Running code on your machine always comes with a security risk. Badly
16424 written or malicious code can be executed on purpose or by accident. Org has
16425 default settings which will only evaluate such code if you give explicit
16426 permission to do so, and as a casual user of these features you should leave
16427 these precautions intact.
16429 For people who regularly work with such code, the confirmation prompts can
16430 become annoying, and you might want to turn them off. This can be done, but
16431 you must be aware of the risks that are involved.
16433 Code evaluation can happen under the following circumstances:
16436 @item Source code blocks
16437 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
16438 C-c} in the block. The most important thing to realize here is that Org mode
16439 files which contain code snippets are, in a certain sense, like executable
16440 files. So you should accept them and load them into Emacs only from trusted
16441 sources---just like you would do with a program you install on your computer.
16443 Make sure you know what you are doing before customizing the variables
16444 which take off the default security brakes.
16446 @defopt org-confirm-babel-evaluate
16447 When t (the default), the user is asked before every code block evaluation.
16448 When @code{nil}, the user is not asked. When set to a function, it is called with
16449 two arguments (language and body of the code block) and should return t to
16450 ask and @code{nil} not to ask.
16453 For example, here is how to execute "ditaa" code (which is considered safe)
16457 (defun my-org-confirm-babel-evaluate (lang body)
16458 (not (string= lang "ditaa"))) ; don't ask for ditaa
16459 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
16462 @item Following @code{shell} and @code{elisp} links
16463 Org has two link types that can directly evaluate code (@pxref{External
16464 links}). These links can be problematic because the code to be evaluated is
16467 @defopt org-confirm-shell-link-function
16468 Function to queries user about shell link execution.
16470 @defopt org-confirm-elisp-link-function
16471 Functions to query user for Emacs Lisp link execution.
16474 @item Formulas in tables
16475 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
16476 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
16479 @node Customization
16480 @section Customization
16481 @cindex customization
16482 @cindex options, for customization
16483 @cindex variables, for customization
16485 There are more than 500 variables that can be used to customize
16486 Org. For the sake of compactness of the manual, I am not
16487 describing the variables here. A structured overview of customization
16488 variables is available with @kbd{M-x org-customize RET}. Or select
16489 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
16490 settings can also be activated on a per-file basis, by putting special
16491 lines into the buffer (@pxref{In-buffer settings}).
16493 @node In-buffer settings
16494 @section Summary of in-buffer settings
16495 @cindex in-buffer settings
16496 @cindex special keywords
16498 Org mode uses special lines in the buffer to define settings on a
16499 per-file basis. These lines start with a @samp{#+} followed by a
16500 keyword, a colon, and then individual words defining a setting. Several
16501 setting words can be in the same line, but you can also have multiple
16502 lines for the keyword. While these settings are described throughout
16503 the manual, here is a summary. After changing any of these lines in the
16504 buffer, press @kbd{C-c C-c} with the cursor still in the line to
16505 activate the changes immediately. Otherwise they become effective only
16506 when the file is visited again in a new Emacs session.
16508 @vindex org-archive-location
16510 @item #+ARCHIVE: %s_done::
16511 This line sets the archive location for the agenda file. It applies for
16512 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
16513 of the file. The first such line also applies to any entries before it.
16514 The corresponding variable is @code{org-archive-location}.
16516 This line sets the category for the agenda file. The category applies
16517 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
16518 end of the file. The first such line also applies to any entries before it.
16519 @item #+COLUMNS: %25ITEM ...
16520 @cindex property, COLUMNS
16521 Set the default format for columns view. This format applies when
16522 columns view is invoked in locations where no @code{COLUMNS} property
16524 @item #+CONSTANTS: name1=value1 ...
16525 @vindex org-table-formula-constants
16526 @vindex org-table-formula
16527 Set file-local values for constants to be used in table formulas. This
16528 line sets the local variable @code{org-table-formula-constants-local}.
16529 The global version of this variable is
16530 @code{org-table-formula-constants}.
16531 @item #+FILETAGS: :tag1:tag2:tag3:
16532 Set tags that can be inherited by any entry in the file, including the
16534 @item #+LINK: linkword replace
16535 @vindex org-link-abbrev-alist
16536 These lines (several are allowed) specify link abbreviations.
16537 @xref{Link abbreviations}. The corresponding variable is
16538 @code{org-link-abbrev-alist}.
16539 @item #+PRIORITIES: highest lowest default
16540 @vindex org-highest-priority
16541 @vindex org-lowest-priority
16542 @vindex org-default-priority
16543 This line sets the limits and the default for the priorities. All three
16544 must be either letters A--Z or numbers 0--9. The highest priority must
16545 have a lower ASCII number than the lowest priority.
16546 @item #+PROPERTY: Property_Name Value
16547 This line sets a default inheritance value for entries in the current
16548 buffer, most useful for specifying the allowed values of a property.
16549 @cindex #+SETUPFILE
16550 @item #+SETUPFILE: file
16551 This line defines a file that holds more in-buffer setup. Normally this is
16552 entirely ignored. Only when the buffer is parsed for option-setting lines
16553 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
16554 settings line, or when exporting), then the contents of this file are parsed
16555 as if they had been included in the buffer. In particular, the file can be
16556 any other Org mode file with internal setup. You can visit the file the
16557 cursor is in the line with @kbd{C-c '}.
16560 This line sets options to be used at startup of Org mode, when an
16561 Org file is being visited.
16563 The first set of options deals with the initial visibility of the outline
16564 tree. The corresponding variable for global default settings is
16565 @code{org-startup-folded}, with a default value @code{t}, which means
16567 @vindex org-startup-folded
16568 @cindex @code{overview}, STARTUP keyword
16569 @cindex @code{content}, STARTUP keyword
16570 @cindex @code{showall}, STARTUP keyword
16571 @cindex @code{showeverything}, STARTUP keyword
16573 overview @r{top-level headlines only}
16574 content @r{all headlines}
16575 showall @r{no folding of any entries}
16576 showeverything @r{show even drawer contents}
16579 @vindex org-startup-indented
16580 @cindex @code{indent}, STARTUP keyword
16581 @cindex @code{noindent}, STARTUP keyword
16582 Dynamic virtual indentation is controlled by the variable
16583 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
16585 indent @r{start with @code{org-indent-mode} turned on}
16586 noindent @r{start with @code{org-indent-mode} turned off}
16589 @vindex org-startup-align-all-tables
16590 Then there are options for aligning tables upon visiting a file. This
16591 is useful in files containing narrowed table columns. The corresponding
16592 variable is @code{org-startup-align-all-tables}, with a default value
16594 @cindex @code{align}, STARTUP keyword
16595 @cindex @code{noalign}, STARTUP keyword
16597 align @r{align all tables}
16598 noalign @r{don't align tables on startup}
16601 @vindex org-startup-with-inline-images
16602 When visiting a file, inline images can be automatically displayed. The
16603 corresponding variable is @code{org-startup-with-inline-images}, with a
16604 default value @code{nil} to avoid delays when visiting a file.
16605 @cindex @code{inlineimages}, STARTUP keyword
16606 @cindex @code{noinlineimages}, STARTUP keyword
16608 inlineimages @r{show inline images}
16609 noinlineimages @r{don't show inline images on startup}
16612 @vindex org-startup-with-latex-preview
16613 When visiting a file, @LaTeX{} fragments can be converted to images
16614 automatically. The variable @code{org-startup-with-latex-preview} which
16615 controls this behavior, is set to @code{nil} by default to avoid delays on
16617 @cindex @code{latexpreview}, STARTUP keyword
16618 @cindex @code{nolatexpreview}, STARTUP keyword
16620 latexpreview @r{preview @LaTeX{} fragments}
16621 nolatexpreview @r{don't preview @LaTeX{} fragments}
16624 @vindex org-log-done
16625 @vindex org-log-note-clock-out
16626 @vindex org-log-repeat
16627 Logging the closing and reopening of TODO items and clock intervals can be
16628 configured using these options (see variables @code{org-log-done},
16629 @code{org-log-note-clock-out} and @code{org-log-repeat})
16630 @cindex @code{logdone}, STARTUP keyword
16631 @cindex @code{lognotedone}, STARTUP keyword
16632 @cindex @code{nologdone}, STARTUP keyword
16633 @cindex @code{lognoteclock-out}, STARTUP keyword
16634 @cindex @code{nolognoteclock-out}, STARTUP keyword
16635 @cindex @code{logrepeat}, STARTUP keyword
16636 @cindex @code{lognoterepeat}, STARTUP keyword
16637 @cindex @code{nologrepeat}, STARTUP keyword
16638 @cindex @code{logreschedule}, STARTUP keyword
16639 @cindex @code{lognotereschedule}, STARTUP keyword
16640 @cindex @code{nologreschedule}, STARTUP keyword
16641 @cindex @code{logredeadline}, STARTUP keyword
16642 @cindex @code{lognoteredeadline}, STARTUP keyword
16643 @cindex @code{nologredeadline}, STARTUP keyword
16644 @cindex @code{logrefile}, STARTUP keyword
16645 @cindex @code{lognoterefile}, STARTUP keyword
16646 @cindex @code{nologrefile}, STARTUP keyword
16647 @cindex @code{logdrawer}, STARTUP keyword
16648 @cindex @code{nologdrawer}, STARTUP keyword
16649 @cindex @code{logstatesreversed}, STARTUP keyword
16650 @cindex @code{nologstatesreversed}, STARTUP keyword
16652 logdone @r{record a timestamp when an item is marked DONE}
16653 lognotedone @r{record timestamp and a note when DONE}
16654 nologdone @r{don't record when items are marked DONE}
16655 logrepeat @r{record a time when reinstating a repeating item}
16656 lognoterepeat @r{record a note when reinstating a repeating item}
16657 nologrepeat @r{do not record when reinstating repeating item}
16658 lognoteclock-out @r{record a note when clocking out}
16659 nolognoteclock-out @r{don't record a note when clocking out}
16660 logreschedule @r{record a timestamp when scheduling time changes}
16661 lognotereschedule @r{record a note when scheduling time changes}
16662 nologreschedule @r{do not record when a scheduling date changes}
16663 logredeadline @r{record a timestamp when deadline changes}
16664 lognoteredeadline @r{record a note when deadline changes}
16665 nologredeadline @r{do not record when a deadline date changes}
16666 logrefile @r{record a timestamp when refiling}
16667 lognoterefile @r{record a note when refiling}
16668 nologrefile @r{do not record when refiling}
16669 logdrawer @r{store log into drawer}
16670 nologdrawer @r{store log outside of drawer}
16671 logstatesreversed @r{reverse the order of states notes}
16672 nologstatesreversed @r{do not reverse the order of states notes}
16675 @vindex org-hide-leading-stars
16676 @vindex org-odd-levels-only
16677 Here are the options for hiding leading stars in outline headings, and for
16678 indenting outlines. The corresponding variables are
16679 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
16680 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
16681 @cindex @code{hidestars}, STARTUP keyword
16682 @cindex @code{showstars}, STARTUP keyword
16683 @cindex @code{odd}, STARTUP keyword
16684 @cindex @code{even}, STARTUP keyword
16686 hidestars @r{make all but one of the stars starting a headline invisible.}
16687 showstars @r{show all stars starting a headline}
16688 indent @r{virtual indentation according to outline level}
16689 noindent @r{no virtual indentation according to outline level}
16690 odd @r{allow only odd outline levels (1,3,...)}
16691 oddeven @r{allow all outline levels}
16694 @vindex org-put-time-stamp-overlays
16695 @vindex org-time-stamp-overlay-formats
16696 To turn on custom format overlays over timestamps (variables
16697 @code{org-put-time-stamp-overlays} and
16698 @code{org-time-stamp-overlay-formats}), use
16699 @cindex @code{customtime}, STARTUP keyword
16701 customtime @r{overlay custom time format}
16704 @vindex constants-unit-system
16705 The following options influence the table spreadsheet (variable
16706 @code{constants-unit-system}).
16707 @cindex @code{constcgs}, STARTUP keyword
16708 @cindex @code{constSI}, STARTUP keyword
16710 constcgs @r{@file{constants.el} should use the c-g-s unit system}
16711 constSI @r{@file{constants.el} should use the SI unit system}
16714 @vindex org-footnote-define-inline
16715 @vindex org-footnote-auto-label
16716 @vindex org-footnote-auto-adjust
16717 To influence footnote settings, use the following keywords. The
16718 corresponding variables are @code{org-footnote-define-inline},
16719 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
16720 @cindex @code{fninline}, STARTUP keyword
16721 @cindex @code{nofninline}, STARTUP keyword
16722 @cindex @code{fnlocal}, STARTUP keyword
16723 @cindex @code{fnprompt}, STARTUP keyword
16724 @cindex @code{fnauto}, STARTUP keyword
16725 @cindex @code{fnconfirm}, STARTUP keyword
16726 @cindex @code{fnplain}, STARTUP keyword
16727 @cindex @code{fnadjust}, STARTUP keyword
16728 @cindex @code{nofnadjust}, STARTUP keyword
16730 fninline @r{define footnotes inline}
16731 fnnoinline @r{define footnotes in separate section}
16732 fnlocal @r{define footnotes near first reference, but not inline}
16733 fnprompt @r{prompt for footnote labels}
16734 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
16735 fnconfirm @r{offer automatic label for editing or confirmation}
16736 fnplain @r{create @code{[1]}-like labels automatically}
16737 fnadjust @r{automatically renumber and sort footnotes}
16738 nofnadjust @r{do not renumber and sort automatically}
16741 @cindex org-hide-block-startup
16742 To hide blocks on startup, use these keywords. The corresponding variable is
16743 @code{org-hide-block-startup}.
16744 @cindex @code{hideblocks}, STARTUP keyword
16745 @cindex @code{nohideblocks}, STARTUP keyword
16747 hideblocks @r{Hide all begin/end blocks on startup}
16748 nohideblocks @r{Do not hide blocks on startup}
16751 @cindex org-pretty-entities
16752 The display of entities as UTF-8 characters is governed by the variable
16753 @code{org-pretty-entities} and the keywords
16754 @cindex @code{entitiespretty}, STARTUP keyword
16755 @cindex @code{entitiesplain}, STARTUP keyword
16757 entitiespretty @r{Show entities as UTF-8 characters where possible}
16758 entitiesplain @r{Leave entities plain}
16761 @item #+TAGS: TAG1(c1) TAG2(c2)
16762 @vindex org-tag-alist
16763 These lines (several such lines are allowed) specify the valid tags in
16764 this file, and (potentially) the corresponding @emph{fast tag selection}
16765 keys. The corresponding variable is @code{org-tag-alist}.
16768 This line contains the formulas for the table directly above the line.
16770 Table can have multiple lines containing @samp{#+TBLFM:}. Note
16771 that only the first line of @samp{#+TBLFM:} will be applied when
16772 you recalculate the table. For more details see @ref{Using
16773 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
16775 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
16776 @itemx #+OPTIONS:, #+BIND:,
16777 @itemx #+DESCRIPTION:, #+KEYWORDS:,
16778 @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
16779 @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
16780 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
16781 These lines provide settings for exporting files. For more details see
16782 @ref{Export settings}.
16783 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
16784 @vindex org-todo-keywords
16785 These lines set the TODO keywords and their interpretation in the
16786 current file. The corresponding variable is @code{org-todo-keywords}.
16789 @node The very busy C-c C-c key
16790 @section The very busy C-c C-c key
16792 @cindex C-c C-c, overview
16794 The key @kbd{C-c C-c} has many purposes in Org, which are all
16795 mentioned scattered throughout this manual. One specific function of
16796 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
16797 other circumstances it means something like @emph{``Hey Org, look
16798 here and update according to what you see here''}. Here is a summary of
16799 what this means in different contexts.
16803 If there are highlights in the buffer from the creation of a sparse
16804 tree, or from clock display, remove these highlights.
16806 If the cursor is in one of the special @code{#+KEYWORD} lines, this
16807 triggers scanning the buffer for these lines and updating the
16810 If the cursor is inside a table, realign the table. This command
16811 works even if the automatic table editor has been turned off.
16813 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
16816 If the current buffer is a capture buffer, close the note and file it.
16817 With a prefix argument, file it, without further interaction, to the
16820 If the cursor is on a @code{<<<target>>>}, update radio targets and
16821 corresponding links in this buffer.
16823 If the cursor is in a property line or at the start or end of a property
16824 drawer, offer property commands.
16826 If the cursor is at a footnote reference, go to the corresponding
16827 definition, and @emph{vice versa}.
16829 If the cursor is on a statistics cookie, update it.
16831 If the cursor is in a plain list item with a checkbox, toggle the status
16834 If the cursor is on a numbered item in a plain list, renumber the
16837 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
16840 If the cursor is at a timestamp, fix the day name in the timestamp.
16844 @section A cleaner outline view
16845 @cindex hiding leading stars
16846 @cindex dynamic indentation
16847 @cindex odd-levels-only outlines
16848 @cindex clean outline view
16850 Some people find it noisy and distracting that the Org headlines start with a
16851 potentially large number of stars, and that text below the headlines is not
16852 indented. While this is no problem when writing a @emph{book-like} document
16853 where the outline headings are really section headings, in a more
16854 @emph{list-oriented} outline, indented structure is a lot cleaner:
16858 * Top level headline | * Top level headline
16859 ** Second level | * Second level
16860 *** 3rd level | * 3rd level
16861 some text | some text
16862 *** 3rd level | * 3rd level
16863 more text | more text
16864 * Another top level headline | * Another top level headline
16870 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
16871 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
16872 be achieved dynamically at display time using @code{org-indent-mode}. In
16873 this minor mode, all lines are prefixed for display with the necessary amount
16874 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
16875 property, such that @code{visual-line-mode} (or purely setting
16876 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
16877 }. Also headlines are prefixed with additional stars, so that the amount of
16878 indentation shifts by two@footnote{See the variable
16879 @code{org-indent-indentation-per-level}.} spaces per level. All headline
16880 stars but the last one are made invisible using the @code{org-hide}
16881 face@footnote{Turning on @code{org-indent-mode} sets
16882 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
16883 @code{nil}.}; see below under @samp{2.} for more information on how this
16884 works. You can turn on @code{org-indent-mode} for all files by customizing
16885 the variable @code{org-startup-indented}, or you can turn it on for
16886 individual files using
16892 If you want a similar effect in an earlier version of Emacs and/or Org, or if
16893 you want the indentation to be hard space characters so that the plain text
16894 file looks as similar as possible to the Emacs display, Org supports you in
16899 @emph{Indentation of text below headlines}@*
16900 You may indent text below each headline to make the left boundary line up
16901 with the headline, like
16905 more text, now indented
16908 @vindex org-adapt-indentation
16909 Org supports this with paragraph filling, line wrapping, and structure
16910 editing@footnote{See also the variable @code{org-adapt-indentation}.},
16911 preserving or adapting the indentation as appropriate.
16914 @vindex org-hide-leading-stars
16915 @emph{Hiding leading stars}@* You can modify the display in such a way that
16916 all leading stars become invisible. To do this in a global way, configure
16917 the variable @code{org-hide-leading-stars} or change this on a per-file basis
16921 #+STARTUP: hidestars
16922 #+STARTUP: showstars
16925 With hidden stars, the tree becomes:
16929 * Top level headline
16937 @vindex org-hide @r{(face)}
16938 The leading stars are not truly replaced by whitespace, they are only
16939 fontified with the face @code{org-hide} that uses the background color as
16940 font color. If you are not using either white or black background, you may
16941 have to customize this face to get the wanted effect. Another possibility is
16942 to set this font such that the extra stars are @i{almost} invisible, for
16943 example using the color @code{grey90} on a white background.
16946 @vindex org-odd-levels-only
16947 Things become cleaner still if you skip all the even levels and use only odd
16948 levels 1, 3, 5..., effectively adding two stars to go from one outline level
16949 to the next@footnote{When you need to specify a level for a property search
16950 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
16951 way we get the outline view shown at the beginning of this section. In order
16952 to make the structure editing and export commands handle this convention
16953 correctly, configure the variable @code{org-odd-levels-only}, or set this on
16954 a per-file basis with one of the following lines:
16961 You can convert an Org file from single-star-per-level to the
16962 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
16963 RET} in that file. The reverse operation is @kbd{M-x
16964 org-convert-to-oddeven-levels}.
16968 @section Using Org on a tty
16969 @cindex tty key bindings
16971 Because Org contains a large number of commands, by default many of
16972 Org's core commands are bound to keys that are generally not
16973 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
16974 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
16975 together with modifiers like @key{Meta} and/or @key{Shift}. To access
16976 these commands on a tty when special keys are unavailable, the following
16977 alternative bindings can be used. The tty bindings below will likely be
16978 more cumbersome; you may find for some of the bindings below that a
16979 customized workaround suits you better. For example, changing a timestamp
16980 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
16981 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
16983 @multitable @columnfractions 0.15 0.2 0.1 0.2
16984 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
16985 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
16986 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
16987 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
16988 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
16989 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
16990 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
16991 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
16992 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
16993 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
16994 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
16995 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
16996 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
16997 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
16998 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
16999 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
17000 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
17001 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
17002 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
17007 @section Interaction with other packages
17008 @cindex packages, interaction with other
17009 Org lives in the world of GNU Emacs and interacts in various ways
17010 with other code out there.
17013 * Cooperation:: Packages Org cooperates with
17014 * Conflicts:: Packages that lead to conflicts
17018 @subsection Packages that Org cooperates with
17021 @cindex @file{calc.el}
17022 @cindex Gillespie, Dave
17023 @item @file{calc.el} by Dave Gillespie
17024 Org uses the Calc package for implementing spreadsheet
17025 functionality in its tables (@pxref{The spreadsheet}). Org
17026 checks for the availability of Calc by looking for the function
17027 @code{calc-eval} which will have been autoloaded during setup if Calc has
17028 been installed properly. As of Emacs 22, Calc is part of the Emacs
17029 distribution. Another possibility for interaction between the two
17030 packages is using Calc for embedded calculations. @xref{Embedded Mode,
17031 , Embedded Mode, calc, GNU Emacs Calc Manual}.
17032 @item @file{constants.el} by Carsten Dominik
17033 @cindex @file{constants.el}
17034 @cindex Dominik, Carsten
17035 @vindex org-table-formula-constants
17036 In a table formula (@pxref{The spreadsheet}), it is possible to use
17037 names for natural constants or units. Instead of defining your own
17038 constants in the variable @code{org-table-formula-constants}, install
17039 the @file{constants} package which defines a large number of constants
17040 and units, and lets you use unit prefixes like @samp{M} for
17041 @samp{Mega}, etc. You will need version 2.0 of this package, available
17042 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
17043 the function @code{constants-get}, which has to be autoloaded in your
17044 setup. See the installation instructions in the file
17045 @file{constants.el}.
17046 @item @file{cdlatex.el} by Carsten Dominik
17047 @cindex @file{cdlatex.el}
17048 @cindex Dominik, Carsten
17049 Org mode can make use of the CD@LaTeX{} package to efficiently enter
17050 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
17051 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
17052 @cindex @file{imenu.el}
17053 Imenu allows menu access to an index of items in a file. Org mode
17054 supports Imenu---all you need to do to get the index is the following:
17056 (add-hook 'org-mode-hook
17057 (lambda () (imenu-add-to-menubar "Imenu")))
17059 @vindex org-imenu-depth
17060 By default the index is two levels deep---you can modify the depth using
17061 the option @code{org-imenu-depth}.
17062 @item @file{remember.el} by John Wiegley
17063 @cindex @file{remember.el}
17064 @cindex Wiegley, John
17065 Org used to use this package for capture, but no longer does.
17066 @item @file{speedbar.el} by Eric M. Ludlam
17067 @cindex @file{speedbar.el}
17068 @cindex Ludlam, Eric M.
17069 Speedbar is a package that creates a special frame displaying files and
17070 index items in files. Org mode supports Speedbar and allows you to
17071 drill into Org files directly from the Speedbar. It also allows you to
17072 restrict the scope of agenda commands to a file or a subtree by using
17073 the command @kbd{<} in the Speedbar frame.
17074 @cindex @file{table.el}
17075 @item @file{table.el} by Takaaki Ota
17077 @cindex table editor, @file{table.el}
17078 @cindex @file{table.el}
17079 @cindex Ota, Takaaki
17081 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
17082 and alignment can be created using the Emacs table package by Takaaki Ota
17083 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
17084 Org mode will recognize these tables and export them properly. Because of
17085 interference with other Org mode functionality, you unfortunately cannot edit
17086 these tables directly in the buffer. Instead, you need to use the command
17087 @kbd{C-c '} to edit them, similar to source code snippets.
17090 @orgcmd{C-c ',org-edit-special}
17091 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
17093 @orgcmd{C-c ~,org-table-create-with-table.el}
17094 Insert a @file{table.el} table. If there is already a table at point, this
17095 command converts it between the @file{table.el} format and the Org mode
17096 format. See the documentation string of the command
17097 @code{org-convert-table} for the restrictions under which this is
17100 @file{table.el} is part of Emacs since Emacs 22.
17101 @item @file{footnote.el} by Steven L. Baur
17102 @cindex @file{footnote.el}
17103 @cindex Baur, Steven L.
17104 Org mode recognizes numerical footnotes as provided by this package.
17105 However, Org mode also has its own footnote support (@pxref{Footnotes}),
17106 which makes using @file{footnote.el} unnecessary.
17110 @subsection Packages that lead to conflicts with Org mode
17114 @cindex @code{shift-selection-mode}
17115 @vindex org-support-shift-select
17116 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
17117 cursor motions combined with the shift key should start or enlarge regions.
17118 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
17119 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
17120 at such a location. By default, @kbd{S-@key{cursor}} commands outside
17121 special contexts don't do anything, but you can customize the variable
17122 @code{org-support-shift-select}. Org mode then tries to accommodate shift
17123 selection by (i) using it outside of the special contexts where special
17124 commands apply, and by (ii) extending an existing active region even if the
17125 cursor moves across a special context.
17127 @item @file{CUA.el} by Kim. F. Storm
17128 @cindex @file{CUA.el}
17129 @cindex Storm, Kim. F.
17130 @vindex org-replace-disputed-keys
17131 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
17132 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and
17133 extend the region. In fact, Emacs 23 has this built-in in the form of
17134 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
17135 23, you probably don't want to use another package for this purpose.
17136 However, if you prefer to leave these keys to a different package while
17137 working in Org mode, configure the variable @code{org-replace-disputed-keys}.
17138 When set, Org will move the following key bindings in Org files, and in the
17139 agenda buffer (but not during date selection).
17142 S-UP @result{} M-p S-DOWN @result{} M-n
17143 S-LEFT @result{} M-- S-RIGHT @result{} M-+
17144 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
17147 @vindex org-disputed-keys
17148 Yes, these are unfortunately more difficult to remember. If you want
17149 to have other replacement keys, look at the variable
17150 @code{org-disputed-keys}.
17152 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
17153 @cindex @file{ecomplete.el}
17155 Ecomplete provides ``electric'' address completion in address header
17156 lines in message buffers. Sadly Orgtbl mode cuts ecompletes power
17157 supply: No completion happens when Orgtbl mode is enabled in message
17158 buffers while entering text in address header lines. If one wants to
17159 use ecomplete one should @emph{not} follow the advice to automagically
17160 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
17161 instead---after filling in the message headers---turn on Orgtbl mode
17162 manually when needed in the messages body.
17164 @item @file{filladapt.el} by Kyle Jones
17165 @cindex @file{filladapt.el}
17167 Org mode tries to do the right thing when filling paragraphs, list items and
17168 other elements. Many users reported they had problems using both
17169 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
17173 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
17176 @item @file{yasnippet.el}
17177 @cindex @file{yasnippet.el}
17178 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
17179 @code{"\t"}) overrules YASnippet's access to this key. The following code
17180 fixed this problem:
17183 (add-hook 'org-mode-hook
17185 (org-set-local 'yas/trigger-key [tab])
17186 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
17189 The latest version of yasnippet doesn't play well with Org mode. If the
17190 above code does not fix the conflict, start by defining the following
17194 (defun yas/org-very-safe-expand ()
17195 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
17198 Then, tell Org mode what to do with the new function:
17201 (add-hook 'org-mode-hook
17203 (make-variable-buffer-local 'yas/trigger-key)
17204 (setq yas/trigger-key [tab])
17205 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
17206 (define-key yas/keymap [tab] 'yas/next-field)))
17209 @item @file{windmove.el} by Hovav Shacham
17210 @cindex @file{windmove.el}
17211 This package also uses the @kbd{S-<cursor>} keys, so everything written
17212 in the paragraph above about CUA mode also applies here. If you want make
17213 the windmove function active in locations where Org mode does not have
17214 special functionality on @kbd{S-@key{cursor}}, add this to your
17218 ;; Make windmove work in org-mode:
17219 (add-hook 'org-shiftup-final-hook 'windmove-up)
17220 (add-hook 'org-shiftleft-final-hook 'windmove-left)
17221 (add-hook 'org-shiftdown-final-hook 'windmove-down)
17222 (add-hook 'org-shiftright-final-hook 'windmove-right)
17225 @item @file{viper.el} by Michael Kifer
17226 @cindex @file{viper.el}
17228 Viper uses @kbd{C-c /} and therefore makes this key not access the
17229 corresponding Org mode command @code{org-sparse-tree}. You need to find
17230 another key for this command, or override the key in
17231 @code{viper-vi-global-user-map} with
17234 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
17242 @section org-crypt.el
17243 @cindex @file{org-crypt.el}
17244 @cindex @code{org-decrypt-entry}
17246 Org-crypt will encrypt the text of an entry, but not the headline, or
17247 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
17250 Any text below a headline that has a @samp{:crypt:} tag will be automatically
17251 be encrypted when the file is saved. If you want to use a different tag just
17252 customize the @code{org-crypt-tag-matcher} setting.
17254 To use org-crypt it is suggested that you have the following in your
17258 (require 'org-crypt)
17259 (org-crypt-use-before-save-magic)
17260 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
17262 (setq org-crypt-key nil)
17263 ;; GPG key to use for encryption
17264 ;; Either the Key ID or set to nil to use symmetric encryption.
17266 (setq auto-save-default nil)
17267 ;; Auto-saving does not cooperate with org-crypt.el: so you need
17268 ;; to turn it off if you plan to use org-crypt.el quite often.
17269 ;; Otherwise, you'll get an (annoying) message each time you
17272 ;; To turn it off only locally, you can insert this:
17274 ;; # -*- buffer-auto-save-file-name: nil; -*-
17277 Excluding the crypt tag from inheritance prevents already encrypted text
17278 being encrypted again.
17284 This appendix covers some areas where users can extend the functionality of
17288 * Hooks:: How to reach into Org's internals
17289 * Add-on packages:: Available extensions
17290 * Adding hyperlink types:: New custom link types
17291 * Adding export back-ends:: How to write new export back-ends
17292 * Context-sensitive commands:: How to add functionality to such commands
17293 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
17294 * Dynamic blocks:: Automatically filled blocks
17295 * Special agenda views:: Customized views
17296 * Speeding up your agendas:: Tips on how to speed up your agendas
17297 * Extracting agenda information:: Post-processing of agenda information
17298 * Using the property API:: Writing programs that use entry properties
17299 * Using the mapping API:: Mapping over all or selected entries
17306 Org has a large number of hook variables that can be used to add
17307 functionality. This appendix about hacking is going to illustrate the
17308 use of some of them. A complete list of all hooks with documentation is
17309 maintained by the Worg project and can be found at
17310 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
17312 @node Add-on packages
17313 @section Add-on packages
17314 @cindex add-on packages
17316 A large number of add-on packages have been written by various authors.
17318 These packages are not part of Emacs, but they are distributed as contributed
17319 packages with the separate release available at @uref{http://orgmode.org}.
17320 See the @file{contrib/README} file in the source code directory for a list of
17321 contributed files. You may also find some more information on the Worg page:
17322 @uref{http://orgmode.org/worg/org-contrib/}.
17324 @node Adding hyperlink types
17325 @section Adding hyperlink types
17326 @cindex hyperlinks, adding new types
17328 Org has a large number of hyperlink types built-in
17329 (@pxref{Hyperlinks}). If you would like to add new link types, Org
17330 provides an interface for doing so. Let's look at an example file,
17331 @file{org-man.el}, that will add support for creating links like
17332 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
17336 ;;; org-man.el - Support for links to manpages in Org
17340 (org-add-link-type "man" 'org-man-open)
17341 (add-hook 'org-store-link-functions 'org-man-store-link)
17343 (defcustom org-man-command 'man
17344 "The Emacs command to be used to display a man page."
17346 :type '(choice (const man) (const woman)))
17348 (defun org-man-open (path)
17349 "Visit the manpage on PATH.
17350 PATH should be a topic that can be thrown at the man command."
17351 (funcall org-man-command path))
17353 (defun org-man-store-link ()
17354 "Store a link to a manpage."
17355 (when (memq major-mode '(Man-mode woman-mode))
17356 ;; This is a man page, we do make this link
17357 (let* ((page (org-man-get-page-name))
17358 (link (concat "man:" page))
17359 (description (format "Manpage for %s" page)))
17360 (org-store-link-props
17363 :description description))))
17365 (defun org-man-get-page-name ()
17366 "Extract the page name from the buffer name."
17367 ;; This works for both `Man-mode' and `woman-mode'.
17368 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
17369 (match-string 1 (buffer-name))
17370 (error "Cannot create link to this man page")))
17374 ;;; org-man.el ends here
17378 You would activate this new link type in @file{.emacs} with
17385 Let's go through the file and see what it does.
17388 It does @code{(require 'org)} to make sure that @file{org.el} has been
17391 The next line calls @code{org-add-link-type} to define a new link type
17392 with prefix @samp{man}. The call also contains the name of a function
17393 that will be called to follow such a link.
17395 @vindex org-store-link-functions
17396 The next line adds a function to @code{org-store-link-functions}, in
17397 order to allow the command @kbd{C-c l} to record a useful link in a
17398 buffer displaying a man page.
17401 The rest of the file defines the necessary variables and functions.
17402 First there is a customization variable that determines which Emacs
17403 command should be used to display man pages. There are two options,
17404 @code{man} and @code{woman}. Then the function to follow a link is
17405 defined. It gets the link path as an argument---in this case the link
17406 path is just a topic for the manual command. The function calls the
17407 value of @code{org-man-command} to display the man page.
17409 Finally the function @code{org-man-store-link} is defined. When you try
17410 to store a link with @kbd{C-c l}, this function will be called to
17411 try to make a link. The function must first decide if it is supposed to
17412 create the link for this buffer type; we do this by checking the value
17413 of the variable @code{major-mode}. If not, the function must exit and
17414 return the value @code{nil}. If yes, the link is created by getting the
17415 manual topic from the buffer name and prefixing it with the string
17416 @samp{man:}. Then it must call the command @code{org-store-link-props}
17417 and set the @code{:type} and @code{:link} properties. Optionally you
17418 can also set the @code{:description} property to provide a default for
17419 the link description when the link is later inserted into an Org
17420 buffer with @kbd{C-c C-l}.
17422 When it makes sense for your new link type, you may also define a function
17423 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
17424 support for inserting such a link with @kbd{C-c C-l}. Such a function should
17425 not accept any arguments, and return the full link with prefix.
17427 @node Adding export back-ends
17428 @section Adding export back-ends
17429 @cindex Export, writing back-ends
17431 Org 8.0 comes with a completely rewritten export engine which makes it easy
17432 to write new export back-ends, either from scratch, or by deriving them
17433 from existing ones.
17435 Your two entry points are respectively @code{org-export-define-backend} and
17436 @code{org-export-define-derived-backend}. To grok these functions, you
17437 should first have a look at @file{ox-latex.el} (for how to define a new
17438 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
17439 back-end from an existing one.
17441 When creating a new back-end from scratch, the basic idea is to set the name
17442 of the back-end (as a symbol) and an an alist of elements and export
17443 functions. On top of this, you will need to set additional keywords like
17444 @code{:menu-entry} (to display the back-end in the export dispatcher),
17445 @code{:export-block} (to specify what blocks should not be exported by this
17446 back-end), and @code{:options-alist} (to let the user set export options that
17447 are specific to this back-end.)
17449 Deriving a new back-end is similar, except that you need to set
17450 @code{:translate-alist} to an alist of export functions that should be used
17451 instead of the parent back-end functions.
17453 For a complete reference documentation, see
17454 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
17455 Reference on Worg}.
17457 @node Context-sensitive commands
17458 @section Context-sensitive commands
17459 @cindex context-sensitive commands, hooks
17460 @cindex add-ons, context-sensitive commands
17461 @vindex org-ctrl-c-ctrl-c-hook
17463 Org has several commands that act differently depending on context. The most
17464 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
17465 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
17467 Add-ons can tap into this functionality by providing a function that detects
17468 special context for that add-on and executes functionality appropriate for
17469 the context. Here is an example from Dan Davison's @file{org-R.el} which
17470 allows you to evaluate commands based on the @file{R} programming language
17471 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
17472 described in @ref{Working with source code} and is now obsolete.}. For this
17473 package, special contexts are lines that start with @code{#+R:} or
17477 (defun org-R-apply-maybe ()
17478 "Detect if this is context for org-R and execute R commands."
17479 (if (save-excursion
17480 (beginning-of-line 1)
17481 (looking-at "#\\+RR?:"))
17482 (progn (call-interactively 'org-R-apply)
17483 t) ;; to signal that we took action
17484 nil)) ;; to signal that we did not
17486 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
17489 The function first checks if the cursor is in such a line. If that is the
17490 case, @code{org-R-apply} is called and the function returns @code{t} to
17491 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
17492 contexts. If the function finds it should do nothing locally, it returns
17493 @code{nil} so that other, similar functions can have a try.
17496 @node Tables in arbitrary syntax
17497 @section Tables and lists in arbitrary syntax
17498 @cindex tables, in other modes
17499 @cindex lists, in other modes
17500 @cindex Orgtbl mode
17502 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
17503 frequent feature request has been to make it work with native tables in
17504 specific languages, for example @LaTeX{}. However, this is extremely
17505 hard to do in a general way, would lead to a customization nightmare,
17506 and would take away much of the simplicity of the Orgtbl mode table
17509 This appendix describes a different approach. We keep the Orgtbl mode
17510 table in its native format (the @i{source table}), and use a custom
17511 function to @i{translate} the table to the correct syntax, and to
17512 @i{install} it in the right location (the @i{target table}). This puts
17513 the burden of writing conversion functions on the user, but it allows
17514 for a very flexible system.
17516 Bastien added the ability to do the same with lists, in Orgstruct mode. You
17517 can use Org's facilities to edit and structure lists by turning
17518 @code{orgstruct-mode} on, then locally exporting such lists in another format
17519 (HTML, @LaTeX{} or Texinfo.)
17523 * Radio tables:: Sending and receiving radio tables
17524 * A @LaTeX{} example:: Step by step, almost a tutorial
17525 * Translator functions:: Copy and modify
17526 * Radio lists:: Sending and receiving lists
17530 @subsection Radio tables
17531 @cindex radio tables
17533 To define the location of the target table, you first need to create two
17534 lines that are comments in the current mode, but contain magic words
17535 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find. Orgtbl mode will
17536 insert the translated table between these lines, replacing whatever was there
17537 before. For example in C mode where comments are between @code{/* ... */}:
17540 /* BEGIN RECEIVE ORGTBL table_name */
17541 /* END RECEIVE ORGTBL table_name */
17545 Just above the source table, we put a special line that tells
17546 Orgtbl mode how to translate this table and where to install it. For
17550 #+ORGTBL: SEND table_name translation_function arguments...
17554 @code{table_name} is the reference name for the table that is also used
17555 in the receiver lines. @code{translation_function} is the Lisp function
17556 that does the translation. Furthermore, the line can contain a list of
17557 arguments (alternating key and value) at the end. The arguments will be
17558 passed as a property list to the translation function for
17559 interpretation. A few standard parameters are already recognized and
17560 acted upon before the translation function is called:
17564 Skip the first N lines of the table. Hlines do count as separate lines for
17567 @item :skipcols (n1 n2 ...)
17568 List of columns that should be skipped. If the table has a column with
17569 calculation marks, that column is automatically discarded as well.
17570 Please note that the translator function sees the table @emph{after} the
17571 removal of these columns, the function never knows that there have been
17572 additional columns.
17576 The one problem remaining is how to keep the source table in the buffer
17577 without disturbing the normal workings of the file, for example during
17578 compilation of a C file or processing of a @LaTeX{} file. There are a
17579 number of different solutions:
17583 The table could be placed in a block comment if that is supported by the
17584 language. For example, in C mode you could wrap the table between
17585 @samp{/*} and @samp{*/} lines.
17587 Sometimes it is possible to put the table after some kind of @i{END}
17588 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
17591 You can just comment the table line-by-line whenever you want to process
17592 the file, and uncomment it whenever you need to edit the table. This
17593 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
17594 makes this comment-toggling very easy, in particular if you bind it to a
17598 @node A @LaTeX{} example
17599 @subsection A @LaTeX{} example of radio tables
17600 @cindex @LaTeX{}, and Orgtbl mode
17602 The best way to wrap the source table in @LaTeX{} is to use the
17603 @code{comment} environment provided by @file{comment.sty}. It has to be
17604 activated by placing @code{\usepackage@{comment@}} into the document
17605 header. Orgtbl mode can insert a radio table skeleton@footnote{By
17606 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
17607 variable @code{orgtbl-radio-table-templates} to install templates for other
17608 modes.} with the command @kbd{M-x orgtbl-insert-radio-table RET}. You will
17609 be prompted for a table name, let's say we use @samp{salesfigures}. You
17610 will then get the following template:
17612 @cindex #+ORGTBL, SEND
17614 % BEGIN RECEIVE ORGTBL salesfigures
17615 % END RECEIVE ORGTBL salesfigures
17617 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17623 @vindex @LaTeX{}-verbatim-environments
17624 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
17625 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
17626 into the receiver location with name @code{salesfigures}. You may now
17627 fill in the table---feel free to use the spreadsheet features@footnote{If
17628 the @samp{#+TBLFM} line contains an odd number of dollar characters,
17629 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
17630 example you can fix this by adding an extra line inside the
17631 @code{comment} environment that is used to balance the dollar
17632 expressions. If you are using AUC@TeX{} with the font-latex library, a
17633 much better solution is to add the @code{comment} environment to the
17634 variable @code{LaTeX-verbatim-environments}.}:
17637 % BEGIN RECEIVE ORGTBL salesfigures
17638 % END RECEIVE ORGTBL salesfigures
17640 #+ORGTBL: SEND salesfigures orgtbl-to-latex
17641 | Month | Days | Nr sold | per day |
17642 |-------+------+---------+---------|
17643 | Jan | 23 | 55 | 2.4 |
17644 | Feb | 21 | 16 | 0.8 |
17645 | March | 22 | 278 | 12.6 |
17646 #+TBLFM: $4=$3/$2;%.1f
17647 % $ (optional extra dollar to keep font-lock happy, see footnote)
17652 When you are done, press @kbd{C-c C-c} in the table to get the converted
17653 table inserted between the two marker lines.
17655 Now let's assume you want to make the table header by hand, because you
17656 want to control how columns are aligned, etc. In this case we make sure
17657 that the table translator skips the first 2 lines of the source
17658 table, and tell the command to work as a @i{splice}, i.e., to not produce
17659 header and footer commands of the target table:
17662 \begin@{tabular@}@{lrrr@}
17663 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
17664 % BEGIN RECEIVE ORGTBL salesfigures
17665 % END RECEIVE ORGTBL salesfigures
17669 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
17670 | Month | Days | Nr sold | per day |
17671 |-------+------+---------+---------|
17672 | Jan | 23 | 55 | 2.4 |
17673 | Feb | 21 | 16 | 0.8 |
17674 | March | 22 | 278 | 12.6 |
17675 #+TBLFM: $4=$3/$2;%.1f
17679 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
17680 Orgtbl mode. By default, it uses a @code{tabular} environment to typeset the
17681 table and marks horizontal lines with @code{\hline}. You can control the
17682 output through several parameters (see also @pxref{Translator functions}),
17683 including the following ones :
17686 @item :splice nil/t
17687 When non-nil, return only table body lines, don't wrap them into a tabular
17688 environment. Default is @code{nil}.
17691 A format to be used to wrap each field, it should contain @code{%s} for the
17692 original field value. For example, to wrap each field value in dollars,
17693 you could use @code{:fmt "$%s$"}. This may also be a property list with
17694 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
17695 A function of one argument can be used in place of the strings; the
17696 function must return a formatted string.
17699 Use this format to print numbers with exponentials. The format should have
17700 @code{%s} twice for inserting mantissa and exponent, for example
17701 @code{"%s\\times10^@{%s@}"}. This may also be a property list with column
17702 numbers and formats, for example @code{:efmt (2 "$%s\\times10^@{%s@}$"
17703 4 "$%s\\cdot10^@{%s@}$")}. After @code{efmt} has been applied to a value,
17704 @code{fmt} will also be applied. Similar to @code{fmt}, functions of two
17705 arguments can be supplied instead of strings. By default, no special
17706 formatting is applied.
17709 @node Translator functions
17710 @subsection Translator functions
17711 @cindex HTML, and Orgtbl mode
17712 @cindex translator function
17714 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
17715 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
17716 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, @code{orgtbl-to-texinfo},
17717 @code{orgtbl-to-unicode} and @code{orgtbl-to-orgtbl}. These all use
17718 a generic translator, @code{orgtbl-to-generic}, which, in turn, can delegate
17719 translations to various export back-ends (@pxref{Export back-ends}).
17721 In particular, properties passed into the function (i.e., the ones set by the
17722 @samp{ORGTBL SEND} line) take precedence over translations defined in the
17723 function. So if you would like to use the @LaTeX{} translator, but wanted
17724 the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you
17725 could just overrule the default with
17728 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
17731 For a new language, you can use the generic function to write your own
17732 converter function. For example, if you have a language where a table is
17733 started with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines
17734 are started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
17735 separator is a TAB, you could define your generic translator like this:
17738 (defun orgtbl-to-language (table params)
17739 "Convert the orgtbl-mode TABLE to language."
17742 (org-combine-plists
17743 '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
17748 Please check the documentation string of the function
17749 @code{orgtbl-to-generic} for a full list of parameters understood by
17750 that function, and remember that you can pass each of them into
17751 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
17752 using the generic function.
17754 Of course you can also write a completely new function doing complicated
17755 things the generic translator cannot do. A translator function takes
17756 two arguments. The first argument is the table, a list of lines, each
17757 line either the symbol @code{hline} or a list of fields. The second
17758 argument is the property list containing all parameters specified in the
17759 @samp{#+ORGTBL: SEND} line. The function must return a single string
17760 containing the formatted table. If you write a generally useful
17761 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
17762 others can benefit from your work.
17765 @subsection Radio lists
17766 @cindex radio lists
17767 @cindex org-list-insert-radio-list
17769 Sending and receiving radio lists works exactly the same way as sending and
17770 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
17771 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
17772 @code{org-list-insert-radio-list}.
17774 Here are the differences with radio tables:
17778 Orgstruct mode must be active.
17780 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
17782 The available translation functions for radio lists don't take
17785 @kbd{C-c C-c} will work when pressed on the first item of the list.
17788 Here is a @LaTeX{} example. Let's say that you have this in your
17793 % BEGIN RECEIVE ORGLST to-buy
17794 % END RECEIVE ORGLST to-buy
17796 #+ORGLST: SEND to-buy org-list-to-latex
17805 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
17806 @LaTeX{} list between the two marker lines.
17808 @node Dynamic blocks
17809 @section Dynamic blocks
17810 @cindex dynamic blocks
17812 Org documents can contain @emph{dynamic blocks}. These are
17813 specially marked regions that are updated by some user-written function.
17814 A good example for such a block is the clock table inserted by the
17815 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
17817 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
17818 to the block and can also specify parameters for the function producing
17819 the content of the block.
17821 @cindex #+BEGIN:dynamic block
17823 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
17828 Dynamic blocks are updated with the following commands
17831 @orgcmd{C-c C-x C-u,org-dblock-update}
17832 Update dynamic block at point.
17833 @orgkey{C-u C-c C-x C-u}
17834 Update all dynamic blocks in the current file.
17837 Updating a dynamic block means to remove all the text between BEGIN and
17838 END, parse the BEGIN line for parameters and then call the specific
17839 writer function for this block to insert the new content. If you want
17840 to use the original content in the writer function, you can use the
17841 extra parameter @code{:content}.
17843 For a block with name @code{myblock}, the writer function is
17844 @code{org-dblock-write:myblock} with as only parameter a property list
17845 with the parameters given in the begin line. Here is a trivial example
17846 of a block that keeps track of when the block update function was last
17850 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
17856 The corresponding block writer function could look like this:
17859 (defun org-dblock-write:block-update-time (params)
17860 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
17861 (insert "Last block update at: "
17862 (format-time-string fmt (current-time)))))
17865 If you want to make sure that all dynamic blocks are always up-to-date,
17866 you could add the function @code{org-update-all-dblocks} to a hook, for
17867 example @code{before-save-hook}. @code{org-update-all-dblocks} is
17868 written in a way such that it does nothing in buffers that are not in
17871 You can narrow the current buffer to the current dynamic block (like any
17872 other block) with @code{org-narrow-to-block}.
17874 @node Special agenda views
17875 @section Special agenda views
17876 @cindex agenda views, user-defined
17878 @vindex org-agenda-skip-function
17879 @vindex org-agenda-skip-function-global
17880 Org provides a special hook that can be used to narrow down the selection
17881 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
17882 @code{agenda*} view is the same as @code{agenda} except that it only
17883 considers @emph{appointments}, i.e., scheduled and deadline items that have a
17884 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
17885 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may
17886 specify a function that is used at each match to verify if the match should
17887 indeed be part of the agenda view, and if not, how much should be skipped.
17888 You can specify a global condition that will be applied to all agenda views,
17889 this condition would be stored in the variable
17890 @code{org-agenda-skip-function-global}. More commonly, such a definition is
17891 applied only to specific custom searches, using
17892 @code{org-agenda-skip-function}.
17894 Let's say you want to produce a list of projects that contain a WAITING
17895 tag anywhere in the project tree. Let's further assume that you have
17896 marked all tree headings that define a project with the TODO keyword
17897 PROJECT@. In this case you would run a TODO search for the keyword
17898 PROJECT, but skip the match unless there is a WAITING tag anywhere in
17899 the subtree belonging to the project line.
17901 To achieve this, you must write a function that searches the subtree for
17902 the tag. If the tag is found, the function must return @code{nil} to
17903 indicate that this match should not be skipped. If there is no such
17904 tag, return the location of the end of the subtree, to indicate that
17905 search should continue from there.
17908 (defun my-skip-unless-waiting ()
17909 "Skip trees that are not waiting"
17910 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
17911 (if (re-search-forward ":waiting:" subtree-end t)
17912 nil ; tag found, do not skip
17913 subtree-end))) ; tag not found, continue after end of subtree
17916 Now you may use this function in an agenda custom command, for example
17920 (org-add-agenda-custom-command
17921 '("b" todo "PROJECT"
17922 ((org-agenda-skip-function 'my-skip-unless-waiting)
17923 (org-agenda-overriding-header "Projects waiting for something: "))))
17926 @vindex org-agenda-overriding-header
17927 Note that this also binds @code{org-agenda-overriding-header} to get a
17928 meaningful header in the agenda view.
17930 @vindex org-odd-levels-only
17931 @vindex org-agenda-skip-function
17932 A general way to create custom searches is to base them on a search for
17933 entries with a certain level limit. If you want to study all entries with
17934 your custom search function, simply do a search for
17935 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
17936 level number corresponds to order in the hierarchy, not to the number of
17937 stars.}, and then use @code{org-agenda-skip-function} to select the entries
17938 you really want to have.
17940 You may also put a Lisp form into @code{org-agenda-skip-function}. In
17941 particular, you may use the functions @code{org-agenda-skip-entry-if}
17942 and @code{org-agenda-skip-subtree-if} in this form, for example:
17945 @item (org-agenda-skip-entry-if 'scheduled)
17946 Skip current entry if it has been scheduled.
17947 @item (org-agenda-skip-entry-if 'notscheduled)
17948 Skip current entry if it has not been scheduled.
17949 @item (org-agenda-skip-entry-if 'deadline)
17950 Skip current entry if it has a deadline.
17951 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
17952 Skip current entry if it has a deadline, or if it is scheduled.
17953 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
17954 Skip current entry if the TODO keyword is TODO or WAITING.
17955 @item (org-agenda-skip-entry-if 'todo 'done)
17956 Skip current entry if the TODO keyword marks a DONE state.
17957 @item (org-agenda-skip-entry-if 'timestamp)
17958 Skip current entry if it has any timestamp, may also be deadline or scheduled.
17959 @anchor{x-agenda-skip-entry-regexp}
17960 @item (org-agenda-skip-entry-if 'regexp "regular expression")
17961 Skip current entry if the regular expression matches in the entry.
17962 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
17963 Skip current entry unless the regular expression matches.
17964 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
17965 Same as above, but check and skip the entire subtree.
17968 Therefore we could also have written the search for WAITING projects
17969 like this, even without defining a special function:
17972 (org-add-agenda-custom-command
17973 '("b" todo "PROJECT"
17974 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
17975 'regexp ":waiting:"))
17976 (org-agenda-overriding-header "Projects waiting for something: "))))
17979 @node Speeding up your agendas
17980 @section Speeding up your agendas
17981 @cindex agenda views, optimization
17983 When your Org files grow in both number and size, agenda commands may start
17984 to become slow. Below are some tips on how to speed up the agenda commands.
17988 Reduce the number of Org agenda files: this will reduce the slowdown caused
17989 by accessing a hard drive.
17991 Reduce the number of DONE and archived headlines: this way the agenda does
17992 not need to skip them.
17994 @vindex org-agenda-dim-blocked-tasks
17995 Inhibit the dimming of blocked tasks:
17997 (setq org-agenda-dim-blocked-tasks nil)
18000 @vindex org-startup-folded
18001 @vindex org-agenda-inhibit-startup
18002 Inhibit agenda files startup options:
18004 (setq org-agenda-inhibit-startup nil)
18007 @vindex org-agenda-show-inherited-tags
18008 @vindex org-agenda-use-tag-inheritance
18009 Disable tag inheritance in agenda:
18011 (setq org-agenda-use-tag-inheritance nil)
18015 You can set these options for specific agenda views only. See the docstrings
18016 of these variables for details on why they affect the agenda generation, and
18017 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
18018 page} for further explanations.
18020 @node Extracting agenda information
18021 @section Extracting agenda information
18022 @cindex agenda, pipe
18023 @cindex Scripts, for agenda processing
18025 @vindex org-agenda-custom-commands
18026 Org provides commands to access agenda information for the command
18027 line in Emacs batch mode. This extracted information can be sent
18028 directly to a printer, or it can be read by a program that does further
18029 processing of the data. The first of these commands is the function
18030 @code{org-batch-agenda}, that produces an agenda view and sends it as
18031 ASCII text to STDOUT@. The command takes a single string as parameter.
18032 If the string has length 1, it is used as a key to one of the commands
18033 you have configured in @code{org-agenda-custom-commands}, basically any
18034 key you can use after @kbd{C-c a}. For example, to directly print the
18035 current TODO list, you could use
18038 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
18041 If the parameter is a string with 2 or more characters, it is used as a
18042 tags/TODO match string. For example, to print your local shopping list
18043 (all items with the tag @samp{shop}, but excluding the tag
18044 @samp{NewYork}), you could use
18047 emacs -batch -l ~/.emacs \
18048 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
18052 You may also modify parameters on the fly like this:
18055 emacs -batch -l ~/.emacs \
18056 -eval '(org-batch-agenda "a" \
18057 org-agenda-span (quote month) \
18058 org-agenda-include-diary nil \
18059 org-agenda-files (quote ("~/org/project.org")))' \
18064 which will produce a 30-day agenda, fully restricted to the Org file
18065 @file{~/org/projects.org}, not even including the diary.
18067 If you want to process the agenda data in more sophisticated ways, you
18068 can use the command @code{org-batch-agenda-csv} to get a comma-separated
18069 list of values for each agenda item. Each line in the output will
18070 contain a number of fields separated by commas. The fields in a line
18074 category @r{The category of the item}
18075 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
18076 type @r{The type of the agenda entry, can be}
18077 todo @r{selected in TODO match}
18078 tagsmatch @r{selected in tags match}
18079 diary @r{imported from diary}
18080 deadline @r{a deadline}
18081 scheduled @r{scheduled}
18082 timestamp @r{appointment, selected by timestamp}
18083 closed @r{entry was closed on date}
18084 upcoming-deadline @r{warning about nearing deadline}
18085 past-scheduled @r{forwarded scheduled item}
18086 block @r{entry has date block including date}
18087 todo @r{The TODO keyword, if any}
18088 tags @r{All tags including inherited ones, separated by colons}
18089 date @r{The relevant date, like 2007-2-14}
18090 time @r{The time, like 15:00-16:50}
18091 extra @r{String with extra planning info}
18092 priority-l @r{The priority letter if any was given}
18093 priority-n @r{The computed numerical priority}
18097 Time and date will only be given if a timestamp (or deadline/scheduled)
18098 led to the selection of the item.
18100 A CSV list like this is very easy to use in a post-processing script.
18101 For example, here is a Perl program that gets the TODO list from
18102 Emacs/Org and prints all the items, preceded by a checkbox:
18107 # define the Emacs command to run
18108 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
18110 # run it and capture the output
18111 $agenda = qx@{$cmd 2>/dev/null@};
18113 # loop over all lines
18114 foreach $line (split(/\n/,$agenda)) @{
18115 # get the individual values
18116 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
18117 $priority_l,$priority_n) = split(/,/,$line);
18118 # process and print
18119 print "[ ] $head\n";
18123 @node Using the property API
18124 @section Using the property API
18125 @cindex API, for properties
18126 @cindex properties, API
18128 Here is a description of the functions that can be used to work with
18131 @defun org-entry-properties &optional pom which
18132 Get all properties of the entry at point-or-marker POM.@*
18133 This includes the TODO keyword, the tags, time strings for deadline,
18134 scheduled, and clocking, and any additional properties defined in the
18135 entry. The return value is an alist. Keys may occur multiple times
18136 if the property key was used several times.@*
18137 POM may also be @code{nil}, in which case the current entry is used.
18138 If WHICH is @code{nil} or `all', get all properties. If WHICH is
18139 `special' or `standard', only get that subclass.
18141 @vindex org-use-property-inheritance
18142 @findex org-insert-property-drawer
18143 @defun org-entry-get pom property &optional inherit
18144 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@. By default,
18145 this only looks at properties defined locally in the entry. If @code{INHERIT}
18146 is non-@code{nil} and the entry does not have the property, then also check
18147 higher levels of the hierarchy. If @code{INHERIT} is the symbol
18148 @code{selective}, use inheritance if and only if the setting of
18149 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
18152 @defun org-entry-delete pom property
18153 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
18156 @defun org-entry-put pom property value
18157 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
18160 @defun org-buffer-property-keys &optional include-specials
18161 Get all property keys in the current buffer.
18164 @defun org-insert-property-drawer
18165 Insert a property drawer for the current entry.
18168 @defun org-entry-put-multivalued-property pom property &rest values
18169 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
18170 @code{VALUES} should be a list of strings. They will be concatenated, with
18171 spaces as separators.
18174 @defun org-entry-get-multivalued-property pom property
18175 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18176 list of values and return the values as a list of strings.
18179 @defun org-entry-add-to-multivalued-property pom property value
18180 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18181 list of values and make sure that @code{VALUE} is in this list.
18184 @defun org-entry-remove-from-multivalued-property pom property value
18185 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18186 list of values and make sure that @code{VALUE} is @emph{not} in this list.
18189 @defun org-entry-member-in-multivalued-property pom property value
18190 Treat the value of the property @code{PROPERTY} as a whitespace-separated
18191 list of values and check if @code{VALUE} is in this list.
18194 @defopt org-property-allowed-value-functions
18195 Hook for functions supplying allowed values for a specific property.
18196 The functions must take a single argument, the name of the property, and
18197 return a flat list of allowed values. If @samp{:ETC} is one of
18198 the values, use the values as completion help, but allow also other values
18199 to be entered. The functions must return @code{nil} if they are not
18200 responsible for this property.
18203 @node Using the mapping API
18204 @section Using the mapping API
18205 @cindex API, for mapping
18206 @cindex mapping entries, API
18208 Org has sophisticated mapping capabilities to find all entries satisfying
18209 certain criteria. Internally, this functionality is used to produce agenda
18210 views, but there is also an API that can be used to execute arbitrary
18211 functions for each or selected entries. The main entry point for this API
18214 @defun org-map-entries func &optional match scope &rest skip
18215 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
18217 @code{FUNC} is a function or a Lisp form. The function will be called
18218 without arguments, with the cursor positioned at the beginning of the
18219 headline. The return values of all calls to the function will be collected
18220 and returned as a list.
18222 The call to @code{FUNC} will be wrapped into a save-excursion form, so
18223 @code{FUNC} does not need to preserve point. After evaluation, the cursor
18224 will be moved to the end of the line (presumably of the headline of the
18225 processed entry) and search continues from there. Under some circumstances,
18226 this may not produce the wanted results. For example, if you have removed
18227 (e.g., archived) the current (sub)tree it could mean that the next entry will
18228 be skipped entirely. In such cases, you can specify the position from where
18229 search should continue by making @code{FUNC} set the variable
18230 @code{org-map-continue-from} to the desired buffer position.
18232 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
18233 view. Only headlines that are matched by this query will be considered
18234 during the iteration. When @code{MATCH} is @code{nil} or @code{t}, all
18235 headlines will be visited by the iteration.
18237 @code{SCOPE} determines the scope of this command. It can be any of:
18240 nil @r{the current buffer, respecting the restriction if any}
18241 tree @r{the subtree started with the entry at point}
18242 region @r{The entries within the active region, if any}
18243 file @r{the current buffer, without restriction}
18245 @r{the current buffer, and any archives associated with it}
18246 agenda @r{all agenda files}
18247 agenda-with-archives
18248 @r{all agenda files with any archive files associated with them}
18250 @r{if this is a list, all files in the list will be scanned}
18253 The remaining args are treated as settings for the skipping facilities of
18254 the scanner. The following items can be given here:
18256 @vindex org-agenda-skip-function
18258 archive @r{skip trees with the archive tag}
18259 comment @r{skip trees with the COMMENT keyword}
18260 function or Lisp form
18261 @r{will be used as value for @code{org-agenda-skip-function},}
18262 @r{so whenever the function returns t, FUNC}
18263 @r{will not be called for that entry and search will}
18264 @r{continue from the point where the function leaves it}
18268 The function given to that mapping routine can really do anything you like.
18269 It can use the property API (@pxref{Using the property API}) to gather more
18270 information about the entry, or in order to change metadata in the entry.
18271 Here are a couple of functions that might be handy:
18273 @defun org-todo &optional arg
18274 Change the TODO state of the entry. See the docstring of the functions for
18275 the many possible values for the argument @code{ARG}.
18278 @defun org-priority &optional action
18279 Change the priority of the entry. See the docstring of this function for the
18280 possible values for @code{ACTION}.
18283 @defun org-toggle-tag tag &optional onoff
18284 Toggle the tag @code{TAG} in the current entry. Setting @code{ONOFF} to
18285 either @code{on} or @code{off} will not toggle tag, but ensure that it is
18290 Promote the current entry.
18294 Demote the current entry.
18297 Here is a simple example that will turn all entries in the current file with
18298 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
18299 Entries in comment trees and in archive trees will be ignored.
18303 '(org-todo "UPCOMING")
18304 "+TOMORROW" 'file 'archive 'comment)
18307 The following example counts the number of entries with TODO keyword
18308 @code{WAITING}, in all agenda files.
18311 (length (org-map-entries t "/+WAITING" 'agenda))
18315 @appendix MobileOrg
18319 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
18320 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
18321 capture support for an Org mode system rooted on a ``real'' computer. It
18322 also allows you to record changes to existing entries. The
18323 @uref{https://github.com/MobileOrg/, iOS implementation} for the
18324 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
18325 and is now in the hands Sean Escriva. Android users should check out
18326 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
18327 by Matt Jones. The two implementations are not identical but offer similar
18330 This appendix describes the support Org has for creating agenda views in a
18331 format that can be displayed by @i{MobileOrg}, and for integrating notes
18332 captured and changes made by @i{MobileOrg} into the main system.
18334 For changing tags and TODO states in MobileOrg, you should have set up the
18335 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
18336 cover all important tags and TODO keywords, even if individual files use only
18337 part of these. MobileOrg will also offer you states and tags set up with
18338 in-buffer settings, but it will understand the logistics of TODO state
18339 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
18340 (@pxref{Setting tags}) only for those set in these variables.
18343 * Setting up the staging area:: Where to interact with the mobile device
18344 * Pushing to MobileOrg:: Uploading Org files and agendas
18345 * Pulling from MobileOrg:: Integrating captured and flagged items
18348 @node Setting up the staging area
18349 @section Setting up the staging area
18351 MobileOrg needs to interact with Emacs through a directory on a server. If
18352 you are using a public server, you should consider encrypting the files that
18353 are uploaded to the server. This can be done with Org mode 7.02 and with
18354 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
18355 installation on your system. To turn on encryption, set a password in
18356 @i{MobileOrg} and, on the Emacs side, configure the variable
18357 @code{org-mobile-use-encryption}@footnote{If you can safely store the
18358 password in your Emacs setup, you might also want to configure
18359 @code{org-mobile-encryption-password}. Please read the docstring of that
18360 variable. Note that encryption will apply only to the contents of the
18361 @file{.org} files. The file names themselves will remain visible.}.
18363 The easiest way to create that directory is to use a free
18364 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
18365 Dropbox, or if your version of MobileOrg does not support it, you can use a
18366 webdav server. For more information, check out the documentation of MobileOrg and also this
18367 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
18368 When MobileOrg first connects to your Dropbox, it will create a directory
18369 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
18373 (setq org-mobile-directory "~/Dropbox/MobileOrg")
18376 Org mode has commands to put files for @i{MobileOrg} into that directory,
18377 and to read captured notes from there.
18379 @node Pushing to MobileOrg
18380 @section Pushing to MobileOrg
18382 This operation copies all files currently listed in @code{org-mobile-files}
18383 to the directory @code{org-mobile-directory}. By default this list contains
18384 all agenda files (as listed in @code{org-agenda-files}), but additional files
18385 can be included by customizing @code{org-mobile-files}. File names will be
18386 staged with paths relative to @code{org-directory}, so all files should be
18387 inside this directory@footnote{Symbolic links in @code{org-directory} need to
18388 have the same name as their targets.}.
18390 The push operation also creates a special Org file @file{agendas.org} with
18391 all custom agenda view defined by the user@footnote{While creating the
18392 agendas, Org mode will force ID properties on all referenced entries, so that
18393 these entries can be uniquely identified if @i{MobileOrg} flags them for
18394 further action. If you do not want to get these properties in so many
18395 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
18396 to @code{nil}. Org mode will then rely on outline paths, in the hope that
18397 these will be unique enough.}.
18399 Finally, Org writes the file @file{index.org}, containing links to all other
18400 files. @i{MobileOrg} first reads this file from the server, and then
18401 downloads all agendas and Org files listed in it. To speed up the download,
18402 MobileOrg will only read files whose checksums@footnote{Checksums are stored
18403 automatically in the file @file{checksums.dat}} have changed.
18405 @node Pulling from MobileOrg
18406 @section Pulling from MobileOrg
18408 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
18409 files for viewing. It also appends captured entries and pointers to flagged
18410 and changed entries to the file @file{mobileorg.org} on the server. Org has
18411 a @emph{pull} operation that integrates this information into an inbox file
18412 and operates on the pointers to flagged entries. Here is how it works:
18416 Org moves all entries found in
18417 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
18418 operation.} and appends them to the file pointed to by the variable
18419 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
18420 will be a top-level entry in the inbox file.
18422 After moving the entries, Org will attempt to implement the changes made in
18423 @i{MobileOrg}. Some changes are applied directly and without user
18424 interaction. Examples are all changes to tags, TODO state, headline and body
18425 text that can be cleanly applied. Entries that have been flagged for further
18426 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
18427 again. When there is a problem finding an entry or applying the change, the
18428 pointer entry will remain in the inbox and will be marked with an error
18429 message. You need to later resolve these issues by hand.
18431 Org will then generate an agenda view with all flagged entries. The user
18432 should then go through these entries and do whatever actions are necessary.
18433 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
18434 will be displayed in the echo area when the cursor is on the corresponding
18440 Pressing @kbd{?} in that special agenda will display the full flagging note in
18441 another window and also push it onto the kill ring. So you could use @kbd{?
18442 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
18443 Pressing @kbd{?} twice in succession will offer to remove the
18444 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
18445 in a property). In this way you indicate that the intended processing for
18446 this flagged entry is finished.
18451 If you are not able to process all flagged entries directly, you can always
18452 return to this agenda view@footnote{Note, however, that there is a subtle
18453 difference. The view created automatically by @kbd{M-x org-mobile-pull RET}
18454 is guaranteed to search all files that have been addressed by the last pull.
18455 This might include a file that is not currently in your list of agenda files.
18456 If you later use @kbd{C-c a ?} to regenerate the view, only the current
18457 agenda files will be searched.} using @kbd{C-c a ?}.
18459 @node History and acknowledgments
18460 @appendix History and acknowledgments
18461 @cindex acknowledgments
18465 @section From Carsten
18467 Org was born in 2003, out of frustration over the user interface of the Emacs
18468 Outline mode. I was trying to organize my notes and projects, and using
18469 Emacs seemed to be the natural way to go. However, having to remember eleven
18470 different commands with two or three keys per command, only to hide and show
18471 parts of the outline tree, that seemed entirely unacceptable to me. Also,
18472 when using outlines to take notes, I constantly wanted to restructure the
18473 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
18474 cycling} and @emph{structure editing} were originally implemented in the
18475 package @file{outline-magic.el}, but quickly moved to the more general
18476 @file{org.el}. As this environment became comfortable for project planning,
18477 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
18478 @emph{table support}. These areas highlighted the two main goals that Org
18479 still has today: to be a new, outline-based, plain text mode with innovative
18480 and intuitive editing features, and to incorporate project planning
18481 functionality directly into a notes file.
18483 Since the first release, literally thousands of emails to me or to
18484 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
18485 reports, feedback, new ideas, and sometimes patches and add-on code.
18486 Many thanks to everyone who has helped to improve this package. I am
18487 trying to keep here a list of the people who had significant influence
18488 in shaping one or more aspects of Org. The list may not be
18489 complete, if I have forgotten someone, please accept my apologies and
18492 Before I get to this list, a few special mentions are in order:
18495 @item Bastien Guerry
18496 Bastien has written a large number of extensions to Org (most of them
18497 integrated into the core by now), including the @LaTeX{} exporter and the
18498 plain list parser. His support during the early days was central to the
18499 success of this project. Bastien also invented Worg, helped establishing the
18500 Web presence of Org, and sponsored hosting costs for the orgmode.org website.
18501 Bastien stepped in as maintainer of Org between 2011 and 2013, at a time when
18502 I desparately needed a break.
18503 @item Eric Schulte and Dan Davison
18504 Eric and Dan are jointly responsible for the Org-babel system, which turns
18505 Org into a multi-language environment for evaluating code and doing literate
18506 programming and reproducible research. This has become one of Org's killer
18507 features that define what Org is today.
18509 John has contributed a number of great ideas and patches directly to Org,
18510 including the attachment system (@file{org-attach.el}), integration with
18511 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
18512 items, habit tracking (@file{org-habits.el}), and encryption
18513 (@file{org-crypt.el}). Also, the capture system is really an extended copy
18514 of his great @file{remember.el}.
18515 @item Sebastian Rose
18516 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
18517 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
18518 higher level. He also wrote @file{org-info.js}, a Java script for displaying
18519 web pages derived from Org using an Info-like or a folding interface with
18520 single-key navigation.
18523 @noindent See below for the full list of contributions! Again, please
18524 let me know what I am missing here!
18526 @section From Bastien
18528 I (Bastien) have been maintaining Org between 2011 and 2013. This appendix
18529 would not be complete without adding a few more acknowledgements and thanks.
18531 I am first grateful to Carsten for his trust while handing me over the
18532 maintainership of Org. His unremitting support is what really helped me
18533 getting more confident over time, with both the community and the code.
18535 When I took over maintainership, I knew I would have to make Org more
18536 collaborative than ever, as I would have to rely on people that are more
18537 knowledgeable than I am on many parts of the code. Here is a list of the
18538 persons I could rely on, they should really be considered co-maintainers,
18539 either of the code or the community:
18543 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
18544 from worrying about possible bugs here and let me focus on other parts.
18546 @item Nicolas Goaziou
18547 Nicolas is maintaining the consistency of the deepest parts of Org. His work
18548 on @file{org-element.el} and @file{ox.el} has been outstanding, and it opened
18549 the doors for many new ideas and features. He rewrote many of the old
18550 exporters to use the new export engine, and helped with documenting this
18551 major change. More importantly (if that's possible), he has been more than
18552 reliable during all the work done for Org 8.0, and always very reactive on
18556 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
18557 into a flexible and conceptually clean process. He patiently coped with the
18558 many hiccups that such a change can create for users.
18561 The Org mode mailing list would not be such a nice place without Nick, who
18562 patiently helped users so many times. It is impossible to overestimate such
18563 a great help, and the list would not be so active without him.
18566 I received support from so many users that it is clearly impossible to be
18567 fair when shortlisting a few of them, but Org's history would not be
18568 complete if the ones above were not mentioned in this manual.
18570 @section List of contributions
18575 @i{Russel Adams} came up with the idea for drawers.
18577 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
18578 feedback on many features and several patches.
18580 @i{Luis Anaya} wrote @file{ox-man.el}.
18582 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
18584 @i{Michael Brand} helped by reporting many bugs and testing many features.
18585 He also implemented the distinction between empty fields and 0-value fields
18586 in Org's spreadsheets.
18588 @i{Christophe Bataillon} created the great unicorn logo that we use on the
18591 @i{Alex Bochannek} provided a patch for rounding timestamps.
18593 @i{Jan Böcker} wrote @file{org-docview.el}.
18595 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
18597 @i{Tom Breton} wrote @file{org-choose.el}.
18599 @i{Charles Cave}'s suggestion sparked the implementation of templates
18600 for Remember, which are now templates for capture.
18602 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
18605 @i{Gregory Chernov} patched support for Lisp forms into table
18606 calculations and improved XEmacs compatibility, in particular by porting
18607 @file{nouline.el} to XEmacs.
18609 @i{Sacha Chua} suggested copying some linking code from Planner, and helped
18610 make Org pupular through her blog.
18612 @i{Toby S. Cubitt} contributed to the code for clock formats.
18614 @i{Baoqiu Cui} contributed the first DocBook exporter. In Org 8.0, we go a
18615 different route: you can now export to Texinfo and export the @file{.texi}
18616 file to DocBook using @code{makeinfo}.
18618 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
18619 came up with the idea of properties, and that there should be an API for
18622 @i{Nick Dokos} tracked down several nasty bugs.
18624 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
18625 inspired some of the early development, including HTML export. He also
18626 asked for a way to narrow wide table columns.
18628 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
18629 several years now. He also sponsored the hosting costs until Rackspace
18630 started to host us for free.
18632 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
18633 the Org-Babel documentation into the manual.
18635 @i{Christian Egli} converted the documentation into Texinfo format, inspired
18636 the agenda, patched CSS formatting into the HTML exporter, and wrote
18637 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
18638 @file{ox-taskjuggler.el} for Org 8.0.
18640 @i{David Emery} provided a patch for custom CSS support in exported
18643 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
18645 @i{Nic Ferrier} contributed mailcap and XOXO support.
18647 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
18649 @i{John Foerch} figured out how to make incremental search show context
18650 around a match in a hidden outline tree.
18652 @i{Raimar Finken} wrote @file{org-git-line.el}.
18654 @i{Mikael Fornius} works as a mailing list moderator.
18656 @i{Austin Frank} works as a mailing list moderator.
18658 @i{Eric Fraga} drove the development of BEAMER export with ideas and
18661 @i{Barry Gidden} did proofreading the manual in preparation for the book
18662 publication through Network Theory Ltd.
18664 @i{Niels Giesen} had the idea to automatically archive DONE trees.
18666 @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote
18667 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
18668 in implementing a clean framework for Org exporters.
18670 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
18672 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
18675 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
18676 task state change logging, and the clocktable. His clear explanations have
18677 been critical when we started to adopt the Git version control system.
18679 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
18682 @i{Phil Jackson} wrote @file{org-irc.el}.
18684 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
18685 folded entries, and column view for properties.
18687 @i{Matt Jones} wrote @i{MobileOrg Android}.
18689 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
18691 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
18693 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
18694 provided frequent feedback and some patches.
18696 @i{Matt Lundin} has proposed last-row references for table formulas and named
18697 invisible anchors. He has also worked a lot on the FAQ.
18699 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
18700 and is a prolific contributor on the mailing list with competent replies,
18701 small fixes and patches.
18703 @i{Jason F. McBrayer} suggested agenda export to CSV format.
18705 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
18707 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
18710 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
18713 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
18715 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
18716 and being able to quickly restrict the agenda to a subtree.
18718 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
18720 @i{Greg Newman} refreshed the unicorn logo into its current form.
18722 @i{Tim O'Callaghan} suggested in-file links, search options for general
18723 file links, and TAGS.
18725 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
18726 version of the reference card.
18728 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
18731 @i{Oliver Oppitz} suggested multi-state TODO items.
18733 @i{Scott Otterson} sparked the introduction of descriptive text for
18734 links, among other things.
18736 @i{Pete Phillips} helped during the development of the TAGS feature, and
18737 provided frequent feedback.
18739 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
18742 @i{Martin Pohlack} provided the code snippet to bundle character insertion
18743 into bundles of 20 for undo.
18745 @i{Rackspace.com} is hosting our website for free. Thank you Rackspace!
18747 @i{T.V. Raman} reported bugs and suggested improvements.
18749 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
18752 @i{Paul Rivier} provided the basic implementation of named footnotes. He
18753 also acted as mailing list moderator for some time.
18755 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
18757 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
18758 conflict with @file{allout.el}.
18760 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
18763 @i{Philip Rooke} created the Org reference card, provided lots
18764 of feedback, developed and applied standards to the Org documentation.
18766 @i{Christian Schlauer} proposed angular brackets around links, among
18769 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
18770 enjoy folding in non-org buffers by using Org headlines in comments.
18772 @i{Paul Sexton} wrote @file{org-ctags.el}.
18774 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
18775 @file{organizer-mode.el}.
18777 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
18778 examples, and remote highlighting for referenced code lines.
18780 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
18781 now packaged into Org's @file{contrib} directory.
18783 @i{Daniel Sinder} came up with the idea of internal archiving by locking
18786 @i{Dale Smith} proposed link abbreviations.
18788 @i{James TD Smith} has contributed a large number of patches for useful
18789 tweaks and features.
18791 @i{Adam Spiers} asked for global linking commands, inspired the link
18792 extension system, added support for mairix, and proposed the mapping API.
18794 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
18795 @LaTeX{}, UTF-8, Latin-1 and ASCII.
18797 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
18798 with links transformation to Org syntax.
18800 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
18801 chapter about publishing.
18803 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
18805 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
18806 enabled source code highlighting in Gnus.
18808 @i{Stefan Vollmar} organized a video-recorded talk at the
18809 Max-Planck-Institute for Neurology. He also inspired the creation of a
18810 concept index for HTML export.
18812 @i{J@"urgen Vollmer} contributed code generating the table of contents
18815 @i{Samuel Wales} has provided important feedback and bug reports.
18817 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
18820 @i{David Wainberg} suggested archiving, and improvements to the linking
18823 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
18826 @i{Roland Winkler} requested additional key bindings to make Org
18829 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
18830 and contributed various ideas and code snippets.
18834 @node GNU Free Documentation License
18835 @appendix GNU Free Documentation License
18836 @include doclicense.texi
18840 @unnumbered Concept index
18845 @unnumbered Key index
18849 @node Command and Function Index
18850 @unnumbered Command and function index
18854 @node Variable Index
18855 @unnumbered Variable index
18857 This is not a complete index of variables and faces, only the ones that are
18858 mentioned in the manual. For a more complete list, use @kbd{M-x
18859 org-customize @key{RET}} and then click yourself through the tree.
18865 @c Local variables:
18867 @c indent-tabs-mode: nil
18868 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
18869 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
18873 @c LocalWords: webdavhost pre